CSM Coverage Analysis

Datadog Cloud Security Management (CSM) delivers real-time threat detection and continuous configuration audits across your entire cloud infrastructure, all in a unified view for seamless collaboration and faster remediation. Go to https://docs.datadoghq.com/security/cloud_security_management to learn more.

GET https://api.ap1.datadoghq.com/api/v2/csm/onboarding/coverage_analysis/cloud_accountshttps://api.datadoghq.eu/api/v2/csm/onboarding/coverage_analysis/cloud_accountshttps://api.ddog-gov.com/api/v2/csm/onboarding/coverage_analysis/cloud_accountshttps://api.datadoghq.com/api/v2/csm/onboarding/coverage_analysis/cloud_accountshttps://api.us3.datadoghq.com/api/v2/csm/onboarding/coverage_analysis/cloud_accountshttps://api.us5.datadoghq.com/api/v2/csm/onboarding/coverage_analysis/cloud_accounts

Overview

Get the CSM Coverage Analysis of your Cloud Accounts. This is calculated based on the number of your Cloud Accounts that are scanned for security issues.

Response

OK

CSM Cloud Accounts Coverage Analysis response.

Expand All

Field

Type

Description

data

object

CSM Cloud Accounts Coverage Analysis data.

attributes

object

CSM Cloud Accounts Coverage Analysis attributes.

aws_coverage

object

CSM Coverage Analysis.

configured_resources_count

int64

The number of fully configured resources.

coverage

double

The coverage percentage.

partially_configured_resources_count

int64

The number of partially configured resources.

total_resources_count

int64

The total number of resources.

azure_coverage

object

CSM Coverage Analysis.

configured_resources_count

int64

The number of fully configured resources.

coverage

double

The coverage percentage.

partially_configured_resources_count

int64

The number of partially configured resources.

total_resources_count

int64

The total number of resources.

gcp_coverage

object

CSM Coverage Analysis.

configured_resources_count

int64

The number of fully configured resources.

coverage

double

The coverage percentage.

partially_configured_resources_count

int64

The number of partially configured resources.

total_resources_count

int64

The total number of resources.

org_id

int64

The ID of your organization.

total_coverage

object

CSM Coverage Analysis.

configured_resources_count

int64

The number of fully configured resources.

coverage

double

The coverage percentage.

partially_configured_resources_count

int64

The number of partially configured resources.

total_resources_count

int64

The total number of resources.

id

string

The ID of your organization.

type

string

The type of the resource. The value should always be get_cloud_accounts_coverage_analysis_response_public_v0.

default: get_cloud_accounts_coverage_analysis_response_public_v0

{
  "data": {
    "attributes": {
      "aws_coverage": {
        "configured_resources_count": 8,
        "coverage": 0.8,
        "partially_configured_resources_count": 0,
        "total_resources_count": 10
      },
      "azure_coverage": {
        "configured_resources_count": 8,
        "coverage": 0.8,
        "partially_configured_resources_count": 0,
        "total_resources_count": 10
      },
      "gcp_coverage": {
        "configured_resources_count": 8,
        "coverage": 0.8,
        "partially_configured_resources_count": 0,
        "total_resources_count": 10
      },
      "org_id": 123456,
      "total_coverage": {
        "configured_resources_count": 8,
        "coverage": 0.8,
        "partially_configured_resources_count": 0,
        "total_resources_count": 10
      }
    },
    "id": "66b3c6b5-5c9a-457e-b1c3-f247ca23afa3",
    "type": "get_cloud_accounts_coverage_analysis_response_public_v0"
  }
}

Not Authorized

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/csm/onboarding/coverage_analysis/cloud_accounts" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

GET https://api.ap1.datadoghq.com/api/v2/csm/onboarding/coverage_analysis/hosts_and_containershttps://api.datadoghq.eu/api/v2/csm/onboarding/coverage_analysis/hosts_and_containershttps://api.ddog-gov.com/api/v2/csm/onboarding/coverage_analysis/hosts_and_containershttps://api.datadoghq.com/api/v2/csm/onboarding/coverage_analysis/hosts_and_containershttps://api.us3.datadoghq.com/api/v2/csm/onboarding/coverage_analysis/hosts_and_containershttps://api.us5.datadoghq.com/api/v2/csm/onboarding/coverage_analysis/hosts_and_containers

Overview

Get the CSM Coverage Analysis of your Hosts and Containers. This is calculated based on the number of agents running on your Hosts and Containers with CSM feature(s) enabled.

Response

OK

CSM Hosts and Containers Coverage Analysis response.

Expand All

Field

Type

Description

data

object

CSM Hosts and Containers Coverage Analysis data.

attributes

object

CSM Hosts and Containers Coverage Analysis attributes.

cspm_coverage

object

CSM Coverage Analysis.

configured_resources_count

int64

The number of fully configured resources.

coverage

double

The coverage percentage.

partially_configured_resources_count

int64

The number of partially configured resources.

total_resources_count

int64

The total number of resources.

cws_coverage

object

CSM Coverage Analysis.

configured_resources_count

int64

The number of fully configured resources.

coverage

double

The coverage percentage.

partially_configured_resources_count

int64

The number of partially configured resources.

total_resources_count

int64

The total number of resources.

org_id

int64

The ID of your organization.

total_coverage

object

CSM Coverage Analysis.

configured_resources_count

int64

The number of fully configured resources.

coverage

double

The coverage percentage.

partially_configured_resources_count

int64

The number of partially configured resources.

total_resources_count

int64

The total number of resources.

vm_coverage

object

CSM Coverage Analysis.

configured_resources_count

int64

The number of fully configured resources.

coverage

double

The coverage percentage.

partially_configured_resources_count

int64

The number of partially configured resources.

total_resources_count

int64

The total number of resources.

id

string

The ID of your organization.

type

string

The type of the resource. The value should always be get_hosts_and_containers_coverage_analysis_response_public_v0.

default: get_hosts_and_containers_coverage_analysis_response_public_v0

{
  "data": {
    "attributes": {
      "cspm_coverage": {
        "configured_resources_count": 8,
        "coverage": 0.8,
        "partially_configured_resources_count": 0,
        "total_resources_count": 10
      },
      "cws_coverage": {
        "configured_resources_count": 8,
        "coverage": 0.8,
        "partially_configured_resources_count": 0,
        "total_resources_count": 10
      },
      "org_id": 123456,
      "total_coverage": {
        "configured_resources_count": 8,
        "coverage": 0.8,
        "partially_configured_resources_count": 0,
        "total_resources_count": 10
      },
      "vm_coverage": {
        "configured_resources_count": 8,
        "coverage": 0.8,
        "partially_configured_resources_count": 0,
        "total_resources_count": 10
      }
    },
    "id": "66b3c6b5-5c9a-457e-b1c3-f247ca23afa3",
    "type": "get_hosts_and_containers_coverage_analysis_response_public_v0"
  }
}

Not Authorized

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/csm/onboarding/coverage_analysis/hosts_and_containers" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

GET https://api.ap1.datadoghq.com/api/v2/csm/onboarding/coverage_analysis/serverlesshttps://api.datadoghq.eu/api/v2/csm/onboarding/coverage_analysis/serverlesshttps://api.ddog-gov.com/api/v2/csm/onboarding/coverage_analysis/serverlesshttps://api.datadoghq.com/api/v2/csm/onboarding/coverage_analysis/serverlesshttps://api.us3.datadoghq.com/api/v2/csm/onboarding/coverage_analysis/serverlesshttps://api.us5.datadoghq.com/api/v2/csm/onboarding/coverage_analysis/serverless

Overview

Get the CSM Coverage Analysis of your Serverless Resources. This is calculated based on the number of agents running on your Serverless Resources with CSM feature(s) enabled.

Response

OK

CSM Serverless Resources Coverage Analysis response.

Expand All

Field

Type

Description

data

object

CSM Serverless Resources Coverage Analysis data.

attributes

object

CSM Serverless Resources Coverage Analysis attributes.

cws_coverage

object

CSM Coverage Analysis.

configured_resources_count

int64

The number of fully configured resources.

coverage

double

The coverage percentage.

partially_configured_resources_count

int64

The number of partially configured resources.

total_resources_count

int64

The total number of resources.

org_id

int64

The ID of your organization.

total_coverage

object

CSM Coverage Analysis.

configured_resources_count

int64

The number of fully configured resources.

coverage

double

The coverage percentage.

partially_configured_resources_count

int64

The number of partially configured resources.

total_resources_count

int64

The total number of resources.

id

string

The ID of your organization.

type

string

The type of the resource. The value should always be get_serverless_coverage_analysis_response_public_v0.

default: get_serverless_coverage_analysis_response_public_v0

{
  "data": {
    "attributes": {
      "cws_coverage": {
        "configured_resources_count": 8,
        "coverage": 0.8,
        "partially_configured_resources_count": 0,
        "total_resources_count": 10
      },
      "org_id": 123456,
      "total_coverage": {
        "configured_resources_count": 8,
        "coverage": 0.8,
        "partially_configured_resources_count": 0,
        "total_resources_count": 10
      }
    },
    "id": "66b3c6b5-5c9a-457e-b1c3-f247ca23afa3",
    "type": "get_serverless_coverage_analysis_response_public_v0"
  }
}

Not Authorized

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/csm/onboarding/coverage_analysis/serverless" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"