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
edge_style'Straight' | 'SmoothStep' | 'Bezier' required
namestring required
network_idstring uuid required
tagsstring[] required
created_atstring date-time required
idstring uuid required
lineage_idstring uuid nullable
updated_atstring date-time required
valid_fromstring date-time
valid_tostring date-time nullable

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
successboolean required

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

Changes