ScanopyScanopy
Services

List services

Returns all services the authenticated user has access to. Supports pagination via limit and offset query parameters, and ordering via group_by, order_by, and order_direction.

GET
/api/v1/services

Authorization

Authorization<token>

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

In: header

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.

guest_states?array<>|

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

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

curl -X GET "https://example.com/api/v1/services"
{
  "data": [
    {
      "bindings": [
        {
          "created_at": "2026-11-03T22:25:05.951710Z",
          "first_discovery_id": null,
          "id": "398acd11-ccfb-46f3-bd1c-a48904de1237",
          "ip_address_id": "550e8400-e29b-41d4-a716-446655440005",
          "last_discovery_id": null,
          "last_seen_at": "2026-11-03T22:25:05.951710Z",
          "lineage_id": null,
          "port_id": "550e8400-e29b-41d4-a716-446655440006",
          "service_id": "550e8400-e29b-41d4-a716-446655440007",
          "site_id": "550e8400-e29b-41d4-a716-446655440002",
          "type": "Port",
          "updated_at": "2026-11-03T22:25:05.951710Z",
          "valid_from": "2026-11-03T22:25:05.951710Z",
          "valid_to": null
        }
      ],
      "created_at": "2026-01-15T10:30:00Z",
      "first_discovery_id": null,
      "host_id": "550e8400-e29b-41d4-a716-446655440003",
      "id": "550e8400-e29b-41d4-a716-446655440007",
      "last_discovery_id": null,
      "last_seen_at": "2026-01-15T10:30:00Z",
      "lineage_id": null,
      "name": "nginx",
      "position": 0,
      "service_definition": "Grafana",
      "site_id": "550e8400-e29b-41d4-a716-446655440002",
      "source": {
        "type": "Manual"
      },
      "tags": [],
      "updated_at": "2026-01-15T10:30:00Z",
      "valid_from": "2026-01-15T10:30:00Z",
      "valid_to": null,
      "virtualization_metadata": null,
      "virtualization_service_id": null
    }
  ],
  "meta": {
    "api_version": 1,
    "pagination": {
      "has_more": true,
      "limit": 50,
      "offset": 0,
      "total_count": 142
    },
    "server_version": "0.19.6"
  },
  "success": true,
  "error": "string"
}

Product names and logos are trademarks of their respective owners. See credits.