Release 2.13 API

November 26, 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?

Get a List of All Supported Mandates

New or Updated API	Updated
API Endpoint (Deprecation timeline - April 2025)	/cloudview-api/rest/v1/reports/mandates
API Endpoint (New)	/cloudview-api/rest/v1/mandates
Method	GET
DTD or XSD changes	Not Applicable

With this release, we bring improvements to mandate accessibility through our enhanced Get Mandates API. Now available to all TotalCloud users regardless of subscription tier, this API delivers streamlined access to retrieve comprehensive compliance data across 39 supported mandates.

We have relocated the API from the Reports collection to a dedicated endpoint, aligning with our vision for enhanced CSPM Mandate visibility while ensuring compatibility with all new mandate tokens introduced in version 2.13.

This enhancement grants faster access to security frameworks, regulatory standards, and industry guidelines across diverse geographies and sectors. The API provides detailed visibility into various compliance requirements, empowering organizations to navigate complex regulatory landscapes efficiently. By default, users can access the complete repository of currently supported mandates, simplifying compliance tracking and audit preparation processes.

Input ParametersInput Parameters

Parameter	Mandatory/Optional	Data Type	Description
query	Optional	String	Filter the required mandates using available query tokens. Currently supported tokens can be found at Search for Mandates tokens.

Parameter

Mandatory/Optional

Data Type

Description

query

Optional

String

Filter the required mandates using available query tokens.

Currently supported tokens can be found at Search for Mandates tokens.

Sample - Get all supported mandatesSample - Get all supported mandates

API Request

      curl --location '<qualys_base_url>/cloudview-api/rest/v1/mandates' --header 'Authorization: Basic cXVxxxxxxxxxxxxxxxxxxxxxxMTIz'

API Response

      {
    "content": [
        {
            "id": 2762,
            "name": "NESA UAE Information Assurance Standards (IAS)",
            "version": "Ver 1.0",
            "publisher": "National Electronic Security Authority (NESA), UAE",
            "releaseDate": "2017-03-30T00:00:00.000+00:00",
            "modifiedDate": "2018-05-28T12:40:08.000+00:00",
            "geography": "UAE",
            "industry": "All"
        }
    ],
    "pageable": {
        "pageSize": 50,
        "pageNumber": 0,
        "offset": 0,
        "paged": true
    },
    "totalElements": 39
}

Sample - Filter mandates using query parametersSample - Filter mandates using query parameters

API Request

      curl --location '<qualys_base_url>/cloudview-api/rest/v1/mandates?query=mandate.name%3Anist%20and%20mandate.publisher%3ANational' \
--header 'Authorization: Basic cXVxxxxxxxxxxxxxxxxxxxxxxMTIz'

API Response

   {   
    "content": [
        {
            "id": 5364,
            "name": "NIST 800-53 (Special Publication)",
            "version": "Rev 5",
            "publisher": "National Institute of Standards and Technology (NIST)",
            "releaseDate": "2022-01-04T00:00:00.000+00:00",
            "modifiedDate": "2022-01-04T05:20:15.000+00:00",
            "geography": "United States",
            "industry": "All"
        }
    ],
    "totalElements": 3,
    "pageSize": 50
}