Sign in
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

Query parameters

network_idstring uuid nullable

Filter by network ID

host_idstring uuid nullable

Filter by host ID

idsstring[] nullable

Filter by specific entity IDs (for selective loading)

tag_idsstring[] nullable

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

group_by'created_at' | 'name' | 'updated_at' | 'host' | 'network_id' | 'position'

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' | 'network_id' | 'position'

Fields that services can be ordered/grouped by.

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

order_direction'asc' | 'desc'

Direction for ORDER BY clauses.

Direction for order_by field (group_by always uses ASC).

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.

Response

List of services

errorstring nullable
successboolean required

Example response

{
  "data": [
    {
      "bindings": [
        {
          "created_at": "2026-04-20T04:23:43.722486Z",
          "id": "ed137dab-0150-4707-a961-d9d482598102",
          "ip_address_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-04-20T04:23:43.722486Z"
        }
      ],
      "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": "APC",
      "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.16.1"
  }
}

Changes