ServiceDependencyStatus data model

The ServiceDependencyStatus shape in the Visual Sentinel REST API.

Fields

Field	Type	Required	Description
`available`	constant `true`	Yes
`serviceName`	string	Yes	The service's name (the monitor itself is named "<Service> dependency").
`statusUrl`	string (uri)	Yes	The provider's public status page.
`source`	string	No	One of: `atlassian-statuspage`.
`apiUrl`	string (uri)	No	The feed this status was read from.
`status`	string	Yes	One of: `operational`, `maintenance`, `degraded`, `partial_outage`, `major_outage`, `unknown`.
`description`	string	No	The provider's own summary line.
`checkedAt`	string (date-time)	No
`components`	array of object	Yes
`components[].id`	string	No
`components[].name`	string	No
`components[].status`	string	No	One of: `operational`, `maintenance`, `degraded`, `partial_outage`, `major_outage`, `unknown`.
`components[].groupId`	string or null	No
`components[].isGroup`	boolean	No	A group heading rather than a part; groups cannot be followed.
`incidents`	array of object	Yes
`incidents[].id`	string	No
`incidents[].name`	string	No
`incidents[].status`	string	No	The provider's own wording, e.g. investigating, identified, monitoring, scheduled, in_progress.
`incidents[].impact`	string	No
`incidents[].shortlink`	string (uri) or null (uri)	No	The event's own page; null when the provider gives none (link to `statusUrl` instead).
`incidents[].updatedAt`	string (date-time)	No
`incidents[].componentIds`	array of string	No	Parts this event affects.
`maintenance`	array of object	Yes
`maintenance[].id`	string	No
`maintenance[].name`	string	No
`maintenance[].status`	string	No	The provider's own wording, e.g. investigating, identified, monitoring, scheduled, in_progress.
`maintenance[].impact`	string	No
`maintenance[].shortlink`	string (uri) or null (uri)	No	The event's own page; null when the provider gives none (link to `statusUrl` instead).
`maintenance[].updatedAt`	string (date-time)	No
`maintenance[].componentIds`	array of string	No	Parts this event affects.
`maintenance[].scheduledFor`	string (date-time) or null (date-time)	No
`maintenance[].scheduledUntil`	string (date-time) or null (date-time)	No

Used by

Get a service's provider status: GET /api/dependencies/{slug}

Generated from the OpenAPI 3.1 specification at https://docs.visualsentinel.com/openapi.json.