Release 3.2 API

October 03, 2024

Before understanding the API release highlights, learn more about the API server URL to be used in your API requests by referring to the Know Your Qualys API Server URL section. For this API Release Notes, <qualys_base_url> is mentioned in the sample API requests.

What's New?

New API - Unresolved Domains Count API

New or Updated API	New
API Endpoint	/rest/2.0/am/domain/count
Method	POST
DTD or XSD changes	Not Applicable

Before this release, the total count of unresolved domains was visible only through CSAM UI. With this release, we have introduced a new Unresolved Domains Count API that fetches the total count of the 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, by default, this field fetches the unresolved domains.
Note: Enter the value in Capital case only.

domainFilterType

Optional

String

Enter any of the following three values to filter the data:

ALL
DOMAIN
SUBDOMAIN

If no value is provided for this parameter, by default, the API fetches ALL unresolved domains.
Note: Enter the values in Capital case only.

Sample - Get Total Count of Unresolved Domains Sample - Get Total Count of Unresolved Domains

API Request

 curl --location --request POST '<qualys_base_url>/rest/2.0/am/domain/count' \
--header 'Authorization: <JWT Token>' \
--data ''

API Response

{
"count": 658,
    "responseCode": "SUCCESS",
    "responseMessage": "Valid API Access"
}

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, whols.creationDate.
The supported operators for asset.domain, whoIs.registrantOrg, asset.subdomain, whoIs.registrantEmailId, whoIs.registrar, tags.name are CONTAINS, IN, EQUALS, NOT_EQUALS.
The supported operators for whoIs.creationDate are EQUALS, NOT_EQUALS, GREATER, LESSER, GREATER_THAN_EQUAL, LESS_THAN_EQUAL.

Sample - XML format (with filter)Sample - 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>'

API Response

{
    "count": 1,
    "responseCode": "SUCCESS",
    "responseMessage": "Valid API Access"
}