v62

latestOpenAPI 3.1.0Dual (AGPL3.0, Commercial License Available)raw.githubusercontent.com2026-08-03211303932.5 KB

Dependencies

List all Dependencies

Returns all dependencies 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/dependencies

Query parameters

network_idstring uuid nullable

Filter by network ID

group_by'created_at' | 'name' | 'dependency_type' | 'updated_at' | 'network_id'

Fields that dependencies can be ordered/grouped by.

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

order_by'created_at' | 'name' | 'dependency_type' | 'updated_at' | 'network_id'

Fields that dependencies 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).

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.

Response

List of dependencies

errorstring nullable

Human-readable failure message. Omitted on success.

successboolean required

true when the request succeeded. false responses carry error instead of data.

Example response

{
  "data": [
    {
      "color": "Blue",
      "created_at": "2026-01-15T10:30:00Z",
      "dependency_type": "RequestPath",
      "description": "HTTP/HTTPS services dependency",
      "edge_style": "Bezier",
      "id": "550e8400-e29b-41d4-a716-446655440008",
      "lineage_id": null,
      "members": {
        "service_ids": [],
        "type": "Services"
      },
      "name": "Web Services",
      "network_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
    }
  ],
  "meta": {
    "api_version": 1,
    "pagination": {
      "has_more": true,
      "limit": 50,
      "offset": 0,
      "total_count": 142
    },
    "server_version": "0.17.7"
  }
}