Skip to main content

GET /cspm/checks_overview

This API returns an overview of the numbers of checks that have been made on your company. Only the latest checks made are included in the response.

Request

Format

GET /cspm/checks_overview?scans=<string>&scan_groups=<string>&rules=<string>&resources=<string>&resource_types=<string>&system_compliance=<string>

Parameters

Parameter

Type

Optional

Description

scans

Array of Strings

Yes

Return checks that have resulted in scans made on these scan accounts.

scan_groups

Array of Strings

Yes

Return checks that have resulted in scans made on scan accounts belonging to this scan group.

rules

Array of Strings

Yes

Return checks that have resulted in scans made based on this rule.

resources

Array of Strings

Yes

Return checks that involved this resource.

resource_types

Array of Strings

Yes

Return checks that involved resources of this type.

system_compliance

Array of Strings

Yes

Return checks related to these compliance standards.

Note

You can use the GET /setting/scans, GET /setting/scan_groups, GET /cspm/rules, GET/cspm/resources, and GET /cspm/system_compliance APIs to get the IDs required to use this request.

Examples

Request an overview of all checks recently performed on your scan accounts:

GET /cspm/checks_overview

Request an overview of checks made on scan group 16beea3e-d011-4c0c-932c-8d8e5******c and related to the mas-trm and cis-aws-1-4 compliance standards.

GET /cspm/checks_overview?scan_groups=16beea3e-d011-4c0c-932c-8d8e5******c&system_compliance=mas-trm,cis-aws-1-4

Response

Format

{
  "data": {
    "checks_overview": {
      "score": Integer,
      "total": Integer,
      "pass": Integer,
      "fail": Integer,
      "suppressed": Integer
    },
    "open_checks_by_severity": {
      "critical": Integer,
      "high": Integer,
      "medium": Integer,
      "low": Integer,
      "informational": Integer
    }
  }
}

Attributes

Attribute

Type

Description

data

Array

A list of attributes providing information on a specific check.

    checks_overview

Array

A list of attributes displaying overall information and numbers regarding the checks made on your scan accounts.

        score

Integer

The overall check score of your scan accounts, based on the number of fail and pass statuses returned.

        total

Integer

The total number of checks made on your scan accounts.

        pass

Integer

The total number of checks with pass status.

        fail

Integer

The total number of checks with a fail status.

        suppressed

Integer

The total number of checks with a suppressed status.

    open_checks_by_severity

Array

A list of attributes displaying the total number of checks of a specific severity.

        critical

Integer

The total number of open checks with critical severity.

        high

Integer

The total number of open checks with high severity.

        medium

Integer

The total number of open checks with medium severity.

        low

Integer

The total number of open checks with low severity.

        informational

Integer

The total number of open checks with informational severity.

Examples

An overview was requested for all checks recently made on your scan accounts:

{
    "data": {
        "checks_overview": {
            "score": 0.7941442255557564,
            "total": 16599,
            "pass": 13182,
            "fail": 3417,
            "suppressed": 4
        },
        "open_checks_by_severity": {
            "critical": 42,
            "high": 950,
            "medium": 2272,
            "low": 153,
            "informational": 0
        }
    }
}

An overview was requested for checks made on scan group 16beea3e-d011-4c0c-932c-8d8e5******c and related to the mas-trm and cis-aws-1-4 compliance standards:

{
    "data": {
        "checks_overview": {
            "score": 0.8511421231687842,
            "total": 14403,
            "pass": 12259,
            "fail": 2144,
            "suppressed": 3
        },
        "open_checks_by_severity": {
            "critical": 36,
            "high": 687,
            "medium": 1383,
            "low": 38,
            "informational": 0
        }
    }
}