For AI agents: A markdown version of this page is available at https://docs.datadoghq.com/api/latest/csm-settings/list-unified-host-facets.md. A documentation index is available at /llms.txt.

Language

English Français 日本語 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 UK1 US1-FED US2-FED

List unified host facets

copy Copy pageCopied

Note: This endpoint is in Preview and may be subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/csm/settings/hosts/facetshttps://api.ap2.datadoghq.com/api/v2/csm/settings/hosts/facetshttps://api.datadoghq.eu/api/v2/csm/settings/hosts/facetshttps://api.ddog-gov.com/api/v2/csm/settings/hosts/facetshttps://api.us2.ddog-gov.com/api/v2/csm/settings/hosts/facetshttps://api.uk1.datadoghq.com/api/v2/csm/settings/hosts/facetshttps://api.datadoghq.com/api/v2/csm/settings/hosts/facetshttps://api.us3.datadoghq.com/api/v2/csm/settings/hosts/facetshttps://api.us5.datadoghq.com/api/v2/csm/settings/hosts/facets

Overview

Get the list of available facets for filtering unified hosts.

Response

OK

The response returned when listing facets for unified hosts.

Expand All

Field

Type

Description

data [required]

[object]

The list of available facets for unified hosts.

attributes [required]

object

Attributes of an agentless host facet.

bounded [required]

boolean

Whether the facet has a bounded set of allowed values. true indicates a fixed value set and false indicates free-form values.

bundled [required]

boolean

Whether the facet is bundled as part of the default facet set. true indicates bundled and false indicates custom.

bundledAndUsed [required]

boolean

Whether the facet is both bundled and actively used. true indicates in use; false indicates unused.

defaultValues [required]

[string]

The list of default filter values for the facet.

description [required]

string

A human-readable description of what the facet represents.

editable [required]

boolean

Whether the facet can be edited by users. true indicates editable; false indicates read-only.

facetType [required]

string

The UI display type for the facet, such as list.

groups [required]

[string]

The list of UI groups that this facet belongs to.

name [required]

string

The display name of the facet.

path [required]

string

The field path used when filtering by this facet.

source [required]

string

The data source that provides the facet values.

type [required]

string

The data type of the facet values.

values [required]

[string]

The list of allowed filter values for bounded facets. Empty for unbounded facets.

id [required]

string

The identifier of the facet, corresponding to the field path.

type [required]

enum

The JSON:API type for unified host facet resources. The value should always be unified_host_facet. Allowed enum values: unified_host_facet

default: unified_host_facet

{
  "data": [
    {
      "attributes": {
        "bounded": true,
        "bundled": true,
        "bundledAndUsed": true,
        "defaultValues": [
          []
        ],
        "description": "The cloud provider of the resource",
        "editable": false,
        "facetType": "list",
        "groups": [
          "agentless"
        ],
        "name": "Cloud Provider",
        "path": "cloud_provider",
        "source": "core",
        "type": "string",
        "values": [
          "aws",
          "gcp"
        ]
      },
      "id": "cloud_provider",
      "type": "unified_host_facet"
    }
  ]
}

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.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/csm/settings/hosts/facets" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

                
"""
List unified host facets returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.csm_settings_api import CSMSettingsApi

configuration = Configuration()
configuration.unstable_operations["list_csm_unified_host_facets"] = True
with ApiClient(configuration) as api_client:
    api_instance = CSMSettingsApi(api_client)
    response = api_instance.list_csm_unified_host_facets()

    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.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# List unified host facets returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.unstable_operations["v2.list_csm_unified_host_facets".to_sym] = true
end
api_instance = DatadogAPIClient::V2::CSMSettingsAPI.new
p api_instance.list_csm_unified_host_facets()

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.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// List unified host facets 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()
	configuration.SetUnstableOperationEnabled("v2.ListCSMUnifiedHostFacets", true)
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewCSMSettingsApi(apiClient)
	resp, r, err := api.ListCSMUnifiedHostFacets(ctx)

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

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `CSMSettingsApi.ListCSMUnifiedHostFacets`:\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.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// List unified host facets returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.CsmSettingsApi;
import com.datadog.api.client.v2.model.CsmUnifiedHostFacetsResponse;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setUnstableOperationEnabled("v2.listCSMUnifiedHostFacets", true);
    CsmSettingsApi apiInstance = new CsmSettingsApi(defaultClient);

    try {
      CsmUnifiedHostFacetsResponse result = apiInstance.listCSMUnifiedHostFacets();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CsmSettingsApi#listCSMUnifiedHostFacets");
      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.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
// List unified host facets returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_csm_settings::CSMSettingsAPI;

#[tokio::main]
async fn main() {
    let mut configuration = datadog::Configuration::new();
    configuration.set_unstable_operation_enabled("v2.ListCSMUnifiedHostFacets", true);
    let api = CSMSettingsAPI::with_config(configuration);
    let resp = api.list_csm_unified_host_facets().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.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
 * List unified host facets returns "OK" response
 */

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

const configuration = client.createConfiguration();
configuration.unstableOperations["v2.listCSMUnifiedHostFacets"] = true;
const apiInstance = new v2.CSMSettingsApi(configuration);

apiInstance
  .listCSMUnifiedHostFacets()
  .then((data: v2.CsmUnifiedHostFacetsResponse) => {
    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.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"