Get an EASM Profile Data

This API helps you get the EASM profile data. You can get the data for one specified profile or all profiles when multiple profiles are configured.

[GET] /easm/v2/profile

Input ParametersInput Parameters

Parameter

Mandatory

/Optional

Data Type

Description

pageNumber

Optional

Integer

Provide the page number. If the page number is not provided, page no 0 is fetched by default.

 You can get the data for a maximum of 20 profiles. But if you want to get the data for more than 20 profiles, you need to provide the pagination
query parameter, which is pageNumber=Numericvalue.

profileName

Optional

String

Provide the profile name only if you want to get the data for the individual profile.

Sample: Get Data of an Individual EASM ProfileSample: Get Data of an Individual EASM Profile

API Request

curl --location 
'<qualys_base_url>/easm/v2/profile?profileName=typo improvement'
--header 'Authorization: Bearer <JWT_Token>'
--data ''

Response

{
  "hasNextPage": false,
  "profile": [
    {
      "name": "typo improvement",
      "includeSeeds": [
        {
          "seedType": "DOMAIN",
          "seedValue": "qualys.com",
          "seedHeading": null,
          "enumerateSubsidiary": true,
          "horizontalEnumeration": true,
          "seedFilters": [],
          "verticalEnumeration": false,
          "seedFileName": null
        }
      ],
      "excludeSeeds": [],
      "enableIFAScan": false,
      "active": true,
      "profileTagName": "typo improvement 2",
      "enableEASMScan": false,
      "includeVMAssets": false,
      "excludeCDNAssets": true,
      "defaultPurgeRuleFrequency": 3,
      "excludeDefamatoryDomain": false,
      "enableTyposquattedDomainGeneration": true,
      "enableDomainSecurity": false
    }
  ]
}

Sample: Get Data for Multiple EASM ProfilesSample: Get Data for Multiple EASM Profiles

API Request

curl --location --request GET  
'<qualys_base_url>/easm/v2/profile' \ 
--header 'Authorization: Bearer <JWT_Token>' \ 
--data ''

Response

{
  "hasNextPage": false,
  "profile": [
    {
      "name": "qualys123",
      "includeSeeds": [
        {
          "seedType": "ORGANIZATION",
          "seedValue": "Qualys, Inc",
          "seedHeading": null,
          "enumerateSubsidiary": true,
          "horizontalEnumeration": true,
          "seedFilters": [],
          "verticalEnumeration": false,
          "seedFileName": null
        },
        {
          "seedType": "DOMAIN",
          "seedValue": "qualys.com",
          "seedHeading": null,
          "enumerateSubsidiary": true,
          "horizontalEnumeration": true,
          "seedFilters": [],
          "verticalEnumeration": true,
          "seedFileName": null
        }
      ],
      "excludeSeeds": [
        {
          "seedType": "COUNTRY",
          "seedValue": "IN"
        }
      ],
      "enableIFAScan": false,
      "active": false,
      "profileTagName": "qualys123",
      "enableEASMScan": false,
      "includeVMAssets": false,
      "excludeCDNAssets": true,
      "defaultPurgeRuleFrequency": 3,
      "excludeDefamatoryDomain": false,
      "enableTyposquattedDomainGeneration": false,
      "enableDomainSecurity": false
    },
    {
      "name": "MultipleIPS",
      "includeSeeds": [
        {
          "seedType": "NETBLOCK",
          "seedValue": "184.27.107.6;104.75.45.207;99.83.253.77",
          "seedHeading": null,
          "enumerateSubsidiary": false,
          "horizontalEnumeration": false,
          "seedFilters": [],
          "verticalEnumeration": false,
          "seedFileName": null
        }
      ],
      "excludeSeeds": [],
      "enableIFAScan": false,
      "active": true,
      "profileTagName": "MultipleIPS",
      "enableEASMScan": false,
      "includeVMAssets": false,
      "excludeCDNAssets": true,
      "defaultPurgeRuleFrequency": 2,
      "excludeDefamatoryDomain": false,
      "enableTyposquattedDomainGeneration": false,
      "enableDomainSecurity": false
    }
  ]
}

Sample with enableEASMScan and includeVMAssets Fields

See the following prerequisites before you go through the subsequent sample.

  • EASM scan must be enabled for your subscription from the back office so that you can set the EASM scan to true for an EASM profile.

  • You can't set the includeVMAssets value to true unless you set the enableEASMScan value to true.

Field 

Value

Details

enableEASMScan

true

Indicates that you enabled the EASM scan for the EASM profile.

enableEASMScan

false

Indicates that you didn't enable the EASM scan for the EASM profile.

includeVMAssets

false

Indicates that you choose to include all EASM assets in the EASM scan.

includeVMAssets

false

Indicates that you choose to include unmanaged EASM assets in the EASM scan.

Sample: Get Data of Multiple EASM Profiles
(with enableEASMScan and includeVMAssets Fields)
Sample: Get Data of Multiple EASM Profiles
(with enableEASMScan and includeVMAssets Fields)

API Request

curl --location --request GET  
'<qualys_base_url>/easm/v2/profile' \ 
--header 'Authorization: Bearer <Auth Token>' \ 
--data ''

Response

{
 "hasNextPage": false,
 "profile": [
 {
 "name": "NewProfile",
 "includeSeeds": [
 {
 "seedType": "DOMAIN",
 "seedValue": "qualys.com",
 "seedHeading": null,
 "enumerateSubsidiary": true,
 "horizontalEnumeration": true,
 "verticalEnumeration": false,
 "seedFilters": []
}
 ],
 "excludeSeeds": [
 {
 "seedType": "CITY",
 "seedValue": "string"
 }
 ],
 "enableIFAScan": false,
 "active": true
 "profileTagName": "NewProfile2"
 "enableEASMScan": true,
 "includeVMAssets": false
 },
 {
 "name": "NewProfile2",
 "includeSeeds": [
 {
 "seedType": "DOMAIN",
 "seedValue": "qualys.com",
 "seedHeading": null,
 "enumerateSubsidiary": true,
 "horizontalEnumeration": true,
 "verticalEnumeration": false,
 "seedFilters": []
 }
 ],
"excludeSeeds": [],
 "enableIFAScan": false,
 "active": true
 "profileTagName": "NewProfile2"
 "enableEASMScan": false,
 "includeVMAssets": false
 }
 ]
} 
   

Sample: Get Data of Individual EASM Profile
(with enableEASMScan and includeVMAssets Fields)
Sample: Get Data of Individual EASM Profile
(with enableEASMScan and includeVMAssets Fields)

API Request

curl -X GET
'<qualys_base_url>/easm/v2/profile?profileName=NewProfile'
--header 'Authorization: Bearer <Auth Token>'
--data ''      
    

Response

{
 "hasNextPage": false,
 "profile": [
 {
 "name": "NewProfile",
"includeSeeds": [
 {
 "seedType": "DOMAIN",
 "seedValue": "qualys.com",
 "seedHeading": null,
 "enumerateSubsidiary": true,
 "horizontalEnumeration": true,
 "verticalEnumeration": false,
 "seedFilters": []
 }
 ],
 "excludeSeeds": [
 {
 "seedType": "CITY",
 "seedValue": "string"
 }
 ],
 "enableIFAScan": false,
 "active": true
 "profileTagName": "NewProfile"
 "enableEASMScan": true,
 "includeVMAssets": false
 }
 ]
}