v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
CSM Settings

Get unified host facet info

Get the value distribution for a specific unified host facet, with optional search and filtering.

get/api/v2/csm/settings/hosts/facet_info

Query parameters

facetstring required
Example:cloud_provider

The facet identifier to retrieve value distribution for. Valid values include resource_name, account_id, resource_type, cloud_provider, agentless_vulnerability_scanning, agentless_posture_management, hostname, agent_version, os, cluster_name, agent_posture_management, agent_cws_enabled, agent_csm_vm_hosts_enabled, and agent_csm_vm_containers_enabled.

searchstring
Example:aws

A search string to filter the facet values.

querystring
Example:cloud_provider:aws

A filter query to scope the facet value counts.

Response

OK

Example response

{
  "data": {
    "attributes": {
      "items": [
        {
          "count": 100,
          "value": "aws"
        }
      ]
    },
    "id": "cloud_provider",
    "meta": {
      "total_count": 4
    },
    "type": "facet_info"
  }
}