Get the CSM Hosts and Containers Coverage Analysis

GET https://api.ap1.datadoghq.com/api/v2/csm/onboarding/coverage_analysis/hosts_and_containershttps://api.ap2.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.us2.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.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.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 the CSM Hosts and Containers Coverage Analysis returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.csm_coverage_analysis_api import CSMCoverageAnalysisApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = CSMCoverageAnalysisApi(api_client)
    response = api_instance.get_csm_hosts_and_containers_coverage_analysis()

    print(response)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# Get the CSM Hosts and Containers Coverage Analysis returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::CSMCoverageAnalysisAPI.new
p api_instance.get_csm_hosts_and_containers_coverage_analysis()

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// Get the CSM Hosts and Containers Coverage Analysis returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)

func main() {
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewCSMCoverageAnalysisApi(apiClient)
	resp, r, err := api.GetCSMHostsAndContainersCoverageAnalysis(ctx)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CSMCoverageAnalysisApi.GetCSMHostsAndContainersCoverageAnalysis`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `CSMCoverageAnalysisApi.GetCSMHostsAndContainersCoverageAnalysis`:\n%s\n", responseContent)
}

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Get the CSM Hosts and Containers Coverage Analysis returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.CsmCoverageAnalysisApi;
import com.datadog.api.client.v2.model.CsmHostsAndContainersCoverageAnalysisResponse;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    CsmCoverageAnalysisApi apiInstance = new CsmCoverageAnalysisApi(defaultClient);

    try {
      CsmHostsAndContainersCoverageAnalysisResponse result =
          apiInstance.getCSMHostsAndContainersCoverageAnalysis();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println(
          "Exception when calling CsmCoverageAnalysisApi#getCSMHostsAndContainersCoverageAnalysis");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Instructions

First install the library and its dependencies and then save the example to Example.java and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
// Get the CSM Hosts and Containers Coverage Analysis returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_csm_coverage_analysis::CSMCoverageAnalysisAPI;

#[tokio::main]
async fn main() {
    let configuration = datadog::Configuration::new();
    let api = CSMCoverageAnalysisAPI::with_config(configuration);
    let resp = api.get_csm_hosts_and_containers_coverage_analysis().await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Instructions

First install the library and its dependencies and then save the example to src/main.rs and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
 * Get the CSM Hosts and Containers Coverage Analysis returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v2.CSMCoverageAnalysisApi(configuration);

apiInstance
  .getCSMHostsAndContainersCoverageAnalysis()
  .then((data: v2.CsmHostsAndContainersCoverageAnalysisResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

Instructions

First install the library and its dependencies and then save the example to example.ts and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"