ScanopyScanopy
Services

List the values of a Service field

Every distinct value of one Service field across the Services the caller can list, with how many hold each. Takes the list's filters; ignores pagination, search and ordering.

GET
/api/v1/services/field-values/{field}

Authorization

Authorization<token>

User API key (Bearer scp_u_...). Create in Platform > API Keys.

In: header

Path Parameters

field*string

The field whose values to count

Query Parameters

site_ids?array<>|

Filter by site ID. Repeat the parameter to pass several.

host_ids?array<>|

Filter by host ID. Repeat the parameter to pass several.

ids?array<>|

Filter by specific entity IDs (for selective loading)

service_definitions?array<string>|

Only services with one of these definitions.

virtualization_service_ids?array<>|

Filter by the service containerizing this one. Repeat for several.

virtualization_service_names?array<string>|

Filter by the name of the service containerizing this one, the value "Containerized" groups on. Repeat for several.

include_uncontainerized?|

true also returns services nothing containerizes. Set on its own it returns only those — the "Not Containerized" choice in the UI's filter.

sources?array<>|

Filter by how the service came to exist (source.type). Repeat for several.

match_confidences?array<>|

Filter by match confidence (source.details.confidence). Repeat for several. Only services discovery matched to a definition carry one.

tag_ids?array<>|

Filter by tag IDs (returns services that have ANY of the specified tags)

tag_sets?array<string>|

Tag sets the service must hold one tag from each of. Each entry is a comma-separated list of tag ids; a service matches when it holds at least one tag of every entry. One entry per tag group the list is filtered by.

search?|

Free-text search. Case-insensitive substring match against the service's name and definition, and against the name of the host it runs on.

group_by?|

Primary ordering field (used for grouping). Always sorts ASC to keep groups together.

order_by?|

Secondary ordering field (sorting within groups or standalone sort).

group_by_tag_group?|

Group by the tag each row holds from this tag group, in the group's tag order. Takes the place of group_by.

order_by_tag_group?|

Sort by the position of the tag each row holds from this tag group. Takes the place of order_by.

order_direction?|

Direction for order_by field (group_by always uses ASC).

ports?array<>|

Only services exposed on one of these port numbers, over either protocol.

exclude_categories?array<>|

Exclude services belonging to these categories.

limit?|

Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.

offset?|

Number of results to skip. Default: 0.

at?|

As-of timestamp (ISO 8601). When set, returns SCD2 state as of this instant (snapshot view) instead of live state.

stale?|

true returns only services discovery hasn't observed within their site's staleness window; false returns only those it has. Omit for both. Evaluated per row against the service's own site's window.

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/services/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
  }
}