Service Map API: Model and Query Service Dependencies

The service map API gives you a programmatic interface to the dependency graph that underlies your infrastructure. By registering services and their relationships, you enable the platform to calculate blast radius when an incident occurs, surface downstream impact for any given service, and render an accurate topology view for your team. Changes made through the API are reflected in the visual service map immediately. All requests require a Bearer token in the Authorization header.

Get full topology

GET https://your-api-domain.com/api/v1/service-map/topology Returns the entire service dependency graph as a list of nodes and directed edges. Useful for rendering a complete topology visualization.

Response fields

object[]

required

All registered services.

Show node properties

string

required

Unique service identifier.

string

required

Human-readable service name.

string

Owning team slug.

object[]

required

Directed dependency relationships between services.

Show edge properties

string

required

Unique identifier for the dependency.

string

required

ID of the upstream (depended-upon) service.

string

required

ID of the downstream (dependent) service.

curl --request GET \
  --url https://your-api-domain.com/api/v1/service-map/topology \
  --header 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch(
  'https://your-api-domain.com/api/v1/service-map/topology',
  {
    headers: { Authorization: 'Bearer YOUR_TOKEN' },
  }
);
const data = await response.json();

import requests

response = requests.get(
    'https://your-api-domain.com/api/v1/service-map/topology',
    headers={'Authorization': 'Bearer YOUR_TOKEN'},
)
data = response.json()

List all services

GET https://your-api-domain.com/api/v1/service-map Returns a flat list of all registered services without edge data.

Response fields

object[]

required

Array of service objects.

Show service properties

string

required

Unique service identifier.

string

required

Service name.

string

Optional description of the service’s purpose.

string

Owning team slug.

string

required

ISO 8601 timestamp of the last modification.

curl --request GET \
  --url https://your-api-domain.com/api/v1/service-map \
  --header 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch(
  'https://your-api-domain.com/api/v1/service-map',
  {
    headers: { Authorization: 'Bearer YOUR_TOKEN' },
  }
);
const data = await response.json();

import requests

response = requests.get(
    'https://your-api-domain.com/api/v1/service-map',
    headers={'Authorization': 'Bearer YOUR_TOKEN'},
)
data = response.json()

Get a service

GET https://your-api-domain.com/api/v1/service-map/:id Retrieves the full record for a single service.

Path parameters

string

required

The unique identifier of the service.

curl --request GET \
  --url https://your-api-domain.com/api/v1/service-map/svc_payments \
  --header 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch(
  'https://your-api-domain.com/api/v1/service-map/svc_payments',
  {
    headers: { Authorization: 'Bearer YOUR_TOKEN' },
  }
);
const data = await response.json();

import requests

response = requests.get(
    'https://your-api-domain.com/api/v1/service-map/svc_payments',
    headers={'Authorization': 'Bearer YOUR_TOKEN'},
)
data = response.json()

Get downstream impact

GET https://your-api-domain.com/api/v1/service-map/:id/downstream-impact Returns all services that directly or transitively depend on the specified service. Use this before making changes to understand blast radius.

Path parameters

string

required

The unique identifier of the upstream service to analyze.

Response fields

object[]

required

Services that would be affected if the target service degrades or goes offline.

Show impacted service properties

string

required

Service identifier.

string

required

Service name.

number

required

Number of dependency hops from the target service. 1 means directly dependent.

curl --request GET \
  --url https://your-api-domain.com/api/v1/service-map/svc_payments/downstream-impact \
  --header 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch(
  'https://your-api-domain.com/api/v1/service-map/svc_payments/downstream-impact',
  {
    headers: { Authorization: 'Bearer YOUR_TOKEN' },
  }
);
const data = await response.json();

import requests

response = requests.get(
    'https://your-api-domain.com/api/v1/service-map/svc_payments/downstream-impact',
    headers={'Authorization': 'Bearer YOUR_TOKEN'},
)
data = response.json()

Create a service

POST https://your-api-domain.com/api/v1/service-map Registers a new service in the service map. After creation, add dependencies with POST /dependencies.

Request body

string

required

A unique, human-readable name for the service.

string

A short description of the service’s role.

string

The team slug responsible for this service.

Response fields

string

required

Server-assigned unique identifier for the new service.

string

required

The service name.

string

required

ISO 8601 creation timestamp.

curl --request POST \
  --url https://your-api-domain.com/api/v1/service-map \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Payment Service",
    "description": "Handles all payment processing and fraud checks.",
    "team": "payments-team"
  }'

const response = await fetch(
  'https://your-api-domain.com/api/v1/service-map',
  {
    method: 'POST',
    headers: {
      Authorization: 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'Payment Service',
      description: 'Handles all payment processing and fraud checks.',
      team: 'payments-team',
    }),
  }
);
const data = await response.json();

import requests

response = requests.post(
    'https://your-api-domain.com/api/v1/service-map',
    headers={'Authorization': 'Bearer YOUR_TOKEN'},
    json={
        'name': 'Payment Service',
        'description': 'Handles all payment processing and fraud checks.',
        'team': 'payments-team',
    },
)
data = response.json()

Add a dependency

POST https://your-api-domain.com/api/v1/service-map/dependencies Declares a dependency relationship between two registered services. The sourceId service depends on the targetId service.

Request body

string

required

The ID of the downstream (dependent) service.

string

required

The ID of the upstream (depended-upon) service.

Response fields

string

required

Unique identifier for the new dependency record.

string

required

The dependent service ID.

string

required

The upstream service ID.

curl --request POST \
  --url https://your-api-domain.com/api/v1/service-map/dependencies \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "sourceId": "svc_checkout",
    "targetId": "svc_payments"
  }'

const response = await fetch(
  'https://your-api-domain.com/api/v1/service-map/dependencies',
  {
    method: 'POST',
    headers: {
      Authorization: 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      sourceId: 'svc_checkout',
      targetId: 'svc_payments',
    }),
  }
);
const data = await response.json();

import requests

response = requests.post(
    'https://your-api-domain.com/api/v1/service-map/dependencies',
    headers={'Authorization': 'Bearer YOUR_TOKEN'},
    json={
        'sourceId': 'svc_checkout',
        'targetId': 'svc_payments',
    },
)
data = response.json()

Update a service

PATCH https://your-api-domain.com/api/v1/service-map/:id Partially updates a service record. Only fields included in the request body are modified.

Path parameters

string

required

The unique identifier of the service to update.

Request body

string

New name for the service.

string

Updated description.

string

Updated owning team slug.

curl --request PATCH \
  --url https://your-api-domain.com/api/v1/service-map/svc_payments \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "Handles payments, fraud checks, and refund processing."
  }'

const response = await fetch(
  'https://your-api-domain.com/api/v1/service-map/svc_payments',
  {
    method: 'PATCH',
    headers: {
      Authorization: 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      description: 'Handles payments, fraud checks, and refund processing.',
    }),
  }
);
const data = await response.json();

import requests

response = requests.patch(
    'https://your-api-domain.com/api/v1/service-map/svc_payments',
    headers={'Authorization': 'Bearer YOUR_TOKEN'},
    json={'description': 'Handles payments, fraud checks, and refund processing.'},
)
data = response.json()

Delete a service

DELETE https://your-api-domain.com/api/v1/service-map/:id Removes a service and all of its dependency relationships from the service map.

Path parameters

string

required

The unique identifier of the service to delete.

curl --request DELETE \
  --url https://your-api-domain.com/api/v1/service-map/svc_payments \
  --header 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch(
  'https://your-api-domain.com/api/v1/service-map/svc_payments',
  {
    method: 'DELETE',
    headers: { Authorization: 'Bearer YOUR_TOKEN' },
  }
);

import requests

requests.delete(
    'https://your-api-domain.com/api/v1/service-map/svc_payments',
    headers={'Authorization': 'Bearer YOUR_TOKEN'},
)

Delete a dependency

DELETE https://your-api-domain.com/api/v1/service-map/dependencies/:depId Removes a single dependency relationship. The services themselves are not affected.

Path parameters

string

required

The unique identifier of the dependency to remove.

curl --request DELETE \
  --url https://your-api-domain.com/api/v1/service-map/dependencies/dep_abc123 \
  --header 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch(
  'https://your-api-domain.com/api/v1/service-map/dependencies/dep_abc123',
  {
    method: 'DELETE',
    headers: { Authorization: 'Bearer YOUR_TOKEN' },
  }
);

import requests

requests.delete(
    'https://your-api-domain.com/api/v1/service-map/dependencies/dep_abc123',
    headers={'Authorization': 'Bearer YOUR_TOKEN'},
)

Overview

Incidents & Tickets

Intelligence

Operations

Platform

Service Map API: Model and Query Service Dependencies

Get full topology

Response fields

List all services

Response fields

Get a service

Path parameters

Get downstream impact

Path parameters

Response fields

Create a service

Request body

Response fields

Add a dependency

Request body

Response fields

Update a service

Path parameters

Request body

Delete a service

Path parameters

Delete a dependency

Path parameters

​Get full topology

​Response fields

​List all services

​Response fields

​Get a service

​Path parameters

​Get downstream impact

​Path parameters

​Response fields

​Create a service

​Request body

​Response fields

​Add a dependency

​Request body

​Response fields

​Update a service

​Path parameters

​Request body

​Delete a service

​Path parameters

​Delete a dependency

​Path parameters

Get full topology

Response fields

List all services

Response fields

Get a service

Path parameters

Get downstream impact

Path parameters

Response fields

Create a service

Request body

Response fields

Add a dependency

Request body

Response fields

Update a service

Path parameters

Request body

Delete a service

Path parameters

Delete a dependency

Path parameters