SCscanopy
Services
internal

List service field values

Changed on

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}

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/services/field-values/{field}
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Path parameters

field'created_at' | 'name' | 'updated_at' | 'host' | 'site_id' | 'position' | 'service_definition' | 'last_seen_at' | 'containerized_by' | 'match_confidence' | 'source' required

Fields that services can be ordered/grouped by.

The field whose values to count

Query parameters

site_idsstring[] nullable

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

host_idsstring[] nullable

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

idsstring[] nullable

Filter by specific entity IDs (for selective loading)

service_definitionsstring[] nullable

Only services with one of these definitions.

virtualization_service_idsstring[] nullable

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

virtualization_service_namesstring[] nullable

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

include_uncontainerizedboolean nullable

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

sourcesEntitySourceDiscriminants[] nullable

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

match_confidencesMatchConfidence[] nullable

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

guest_statesGuestState[] nullable

Filter by the run state of the container a service is, at the last scan. Repeat for several.

tag_idsstring[] nullable

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

tag_setsstring[] nullable

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.

searchstring nullable

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'created_at' | 'name' | 'updated_at' | 'host' | 'site_id' | 'position' | 'service_definition' | 'last_seen_at' | 'containerized_by' | 'match_confidence' | 'source'

Fields that services can be ordered/grouped by.

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

order_by'created_at' | 'name' | 'updated_at' | 'host' | 'site_id' | 'position' | 'service_definition' | 'last_seen_at' | 'containerized_by' | 'match_confidence' | 'source'

Fields that services can be ordered/grouped by.

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

group_by_tag_groupstring uuid nullable

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_groupstring uuid nullable

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

order_direction'asc' | 'desc'

Direction for ORDER BY clauses.

Direction for order_by field (group_by always uses ASC).

portsinteger[] nullable

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

exclude_categoriesServiceCategory[] nullable

Exclude services belonging to these categories.

limitinteger nullable

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

offsetinteger nullable

Number of results to skip. Default: 0.

atstring date-time nullable

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

staleboolean nullable

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

Distinct values and their Service counts

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes