Sign in

v62

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

Update a Dependency

put/api/v1/dependencies/{id}

Path parameters

idstring uuid required

Dependency ID

Request body

color'Pink' | 'Rose' | 'Red' | 'Amber' | 'Orange' | 'Green' | 'Emerald' | 'Teal' | 'Cyan' | 'Blue' | 'Indigo' | 'Purple' | 'Fuchsia' | 'Violet' | 'Sky' | 'Gray' | 'Lime' | 'Yellow' required
dependency_type'RequestPath' | 'HubAndSpoke' required
descriptionstring nullable

Free-text notes about the dependency.

edge_style'Straight' | 'SmoothStep' | 'Bezier' required
namestring required

Human-facing name for this dependency.

network_idstring uuid required

The network this entity belongs to.

tagsstring[] required

Tags assigned to this entity.

created_atstring date-time required

When this record was first created.

idstring uuid required

Server-assigned unique identifier.

lineage_idstring uuid nullable

Stable identifier shared by every revision of the same entity across its history.

updated_atstring date-time required

When this record was last modified.

valid_fromstring date-time

Start of the interval this revision was current for (SCD2 history).

valid_tostring date-time nullable

End of the interval this revision was current for. null while it is the live revision.

Example request

{
  "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
}

Response

Dependency updated successfully

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,
    "server_version": "0.17.7"
  }
}