Get the Count of Domains
This API helps you to get the total count of the unresolved and typosquatted domains.
Get the Count of Unresolved Domains
Input ParametersInput Parameters
|
Parameter |
Mandatory /Optional |
Data Type |
Description |
|---|---|---|---|
| domainType |
Optional |
String |
Provide the value UNRESOLVED_DOMAINS. If this value is not provided, this field fetches the unresolved domains by default. Ensure to enter the value in capital letters only. |
| domainFilterType |
Optional |
String |
Enter any of the following three values to filter the data:
If this value is not provided, this field fetches all unresolved domains by default. Ensure to enter the value in capital letters only. |
Important to Know!
- To filter the data, the filters that must be used in the API body are: asset.domain, whols.registrantOrg, asset.subdomain, whols.registrantEmailId, whols.registrar, tags.name, and whols.creationDate.
- The supported operators for asset.domain, whoIs.registrantOrg, asset.subdomain, whoIs.registrantEmailId, whoIs.registrar, and tags.name are CONTAINS, IN, EQUALS, and NOT_EQUALS.
- The supported operators for whoIs.creationDate are EQUALS, NOT_EQUALS, GREATER, LESSER, GREATER_THAN_EQUAL, and LESS_THAN_EQUAL.
Sample - Get the Total Count of Unresolved Domains (without filter)Sample - Get the Total Count of Unresolved Domains (without filter)
API Request
curl --location --request POST
'<qualys_base_url>/rest/2.0/am/domain/count' \
--header 'Authorization: <JWT Token>' \
--data ''
Response
{
"count": 658,
"responseCode": "SUCCESS",
"responseMessage": "Valid API Access"
}
Sample - Get the Total Count of Unresolved Domains
XML format (with filter)Sample - Get the Total Count of Unresolved Domains
XML format (with filter)
API Request
curl --location '<qualys_base_url>/rest/2.0/am/domain/count' \
--header 'Content-Type: application/xml' \
--header 'Authorization: <JWT Token>' \
--data '<FilterRequest>
<filters>
<Criteria field="asset.subdomain"
operator="EQUALS"><value>ota.dev.ssllabs.com</value></Criteria>
<Criteria field="whoIs.creationDate"
operator="EQUALS"><value>2009-1-1</value></Criteria>
</filters>
<operation>AND</operation>
</FilterRequest>'
Response
{
"count": 1,
"responseCode": "SUCCESS",
"responseMessage": "Valid API Access"
}
Get the Count of Typosquatted Domains
With this API, you can get the count of the typosquatted (look alike) and defamatory domains for the domain and organization seed values configured in the respective EASM profile.
Input ParametersInput Parameters
|
Parameter |
Mandatory |
Data Type |
Description |
|---|---|---|---|
|
domainType |
Mandatory |
String |
Provide the value TYPOSQUATTED_DOMAINS. If this value is not provided, you get the count of unresolved domains. Provide the value only in a capital case. |
|
domainFilterType |
Optional |
String |
If this parameter is not provided, you get the count of all Typosquatted Domains. Provide any one of the following two values to filter the data:
Provide the value only in a capital case. |
Important to Know
To filter data, the filters that must be used in the API body along with the supported operators are :
- asset.domain, permutation.name, permutation.category, permutation.types, whoIs.registrantCountry, whoIs.registrantOrg, whoIs.registrantEmailId, whoIs.registrar, and tags.name: The supported operators are CONTAINS, IN, EQUALS, NOT EQUALS.
- whoIs.creationDate, whoIs.expirationDate: The supported operators are EQUALS, NOT EQUALS, GREATER, LESSER, GREATER THAN EQUAL, and LESS THAN EQUAL.
Sample- Get Count of Typosquatted Domains (without filter)Sample- Get Count of Typosquatted Domains (without filter)
API Request
curl --location --request POST
'<qualys_base_url/rest/2.0/am/domain/count?domainType=TYPOSQUATTED_DOMAINS' \
--header 'Content-Type: application/xml' \
--header 'Authorization: <JWT Token>
--data ''
API Response
{
"count": 1656,
"responseCode": "SUCCESS",
"responseMessage": "Valid API Access"
}Sample - Get Count of Typosquatted Domains (with filter)Sample - Get Count of Typosquatted Domains (with filter)
API Request
curl --location
'<qualys_base_url>/rest/2.0/am/domain/count?domainType=TYPOSQUATTED_DOMAINS' \
--header 'Content-Type: application/xml' \
--header 'Authorization: <JWT Token>
--data '<FilterRequest>
<filters>
<Criteria field="permutation.name" operator="EQUALS"><value>qualgs.com</value></Criteria>
</filters>
</FilterRequest>'
API Response
{
"count": 1,
"responseCode": "SUCCESS",
"responseMessage": "Valid API Access"
}