List the values of a Host field
Every distinct value of one Host field across the Hosts the caller can list, with how many hold each. Takes the list's filters; ignores pagination, search and ordering.
User API key (Bearer scp_u_...). Create in Platform > API Keys.
In: header
Path Parameters
The field whose values to count
Query Parameters
Filter by site ID. Repeat the parameter to pass several.
Filter by specific entity IDs (for selective loading)
Filter by the service virtualizing the host. Repeat for several.
Filter by the name of the service virtualizing the host, the value "Virtualized By" groups on. Repeat for several.
true also returns hosts nothing virtualizes. Set on its own it returns
only those — the "Not Virtualized" choice in the UI's filter.
Filter to hosts running a service with one of these names.
Filter by how the host came to exist (source.type). Repeat for several;
Inferred alone lists the hosts only a neighbour advertised.
Filter by hardware manufacturer. Repeat for several.
Filter by hardware model. Repeat for several.
Filter by SNMP sysLocation. Repeat for several.
Filter by operating system family. Repeat for several.
Filter to hosts assigned one of these credentials. Repeat for several.
Filter by tag IDs (returns hosts that have ANY of the specified tags)
Tag sets the host must hold one tag from each of. Each entry is a comma-separated list of tag ids; a host matches when it holds at least one tag of every entry. One entry per tag group the list is filtered by.
Free-text search. Case-insensitive substring match against the host's name, hostname, sysName, chassis id, serial number, asset tag and description, and against its IP addresses and the names of services running on it.
sysName and chassis id are in there because they are rungs of the title ladder: a host with no name of its own is shown under one of them, and a title you can read but cannot search for is a dead end.
Primary ordering field (used for grouping). Always sorts ASC to keep groups together.
Secondary ordering field (sorting within groups or standalone sort).
Group by the tag each row holds from this tag group, in the group's tag order. Takes
the place of group_by.
Sort by the position of the tag each row holds from this tag group. Takes the place of
order_by.
Direction for order_by field (group_by always uses ASC).
Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.
Number of results to skip. Default: 0.
As-of timestamp (ISO 8601). When set, returns SCD2 state as of this instant (snapshot view) instead of live state.
true returns only hosts discovery hasn't observed within their
site's staleness window; false returns only those it has. Omit for
both. Evaluated per row against the host's own site's window.
false returns hosts with empty ports/services/interfaces.
ip_addresses is always populated: the host's title can come from its
address. The children dominate the payload, so callers that only need
host identity — name pickers, id→name lookups, counts — should pass
false. Defaults to true, so existing callers are unaffected.
Response Body
application/json
application/json
curl -X GET "https://example.com/api/v1/hosts/field-values/created_at"{
"meta": {
"api_version": 1,
"server_version": "0.18.1"
},
"success": true,
"data": [
{
"count": 0,
"value": "string"
}
],
"error": "string"
}{
"meta": {
"api_version": 1,
"server_version": "0.18.1"
},
"success": true,
"code": "string",
"error": "string",
"params": {
"property1": null,
"property2": null
}
}