ScanopyScanopy
Services

List all 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<token>

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

In: header

Query Parameters

network_id?string|null

Filter by network ID

Formatuuid
host_id?string|null

Filter by host ID

Formatuuid
ids?|null

Filter by specific entity IDs (for selective loading)

tag_ids?|null

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

group_by?null|ServiceOrderField

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

order_by?null|ServiceOrderField

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

order_direction?null|OrderDirection

Direction for order_by field (group_by always uses ASC).

limit?integer|null

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

Formatint32
Range0 <= value <= 1000
offset?integer|null

Number of results to skip. Default: 0.

Formatint32
Range0 <= value

Response Body

application/json

curl -X GET "https://loading/api/v1/services"
{
  "data": [
    {
      "bindings": [
        {
          "created_at": "2026-01-12T14:59:13.664130Z",
          "id": "a74f332b-035b-43d1-85d0-ab28a619fa28",
          "interface_id": "550e8400-e29b-41d4-a716-446655440005",
          "network_id": "550e8400-e29b-41d4-a716-446655440002",
          "port_id": "550e8400-e29b-41d4-a716-446655440006",
          "service_id": "550e8400-e29b-41d4-a716-446655440007",
          "type": "Port",
          "updated_at": "2026-01-12T14:59:13.664130Z"
        }
      ],
      "created_at": "2026-01-15T10:30:00Z",
      "host_id": "550e8400-e29b-41d4-a716-446655440003",
      "id": "550e8400-e29b-41d4-a716-446655440007",
      "name": "nginx",
      "network_id": "550e8400-e29b-41d4-a716-446655440002",
      "position": 0,
      "service_definition": "Remote Desktop",
      "source": {
        "type": "Manual"
      },
      "tags": [],
      "updated_at": "2026-01-15T10:30:00Z",
      "virtualization": null
    }
  ],
  "meta": {
    "api_version": 1,
    "pagination": {
      "has_more": true,
      "limit": 50,
      "offset": 0,
      "total_count": 142
    },
    "server_version": "0.13.5"
  },
  "success": true,
  "error": "string"
}