Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Servicings

Get servicing external status

Returns a servicing enriched with an externally fetched status. A malformed UUID yields 422 (schema error), distinct from the 404.

get/api/v1/servicings/{id}/status

Path parameters

idstring uuid required

Servicing identifier.

Example:550e8400-e29b-41d4-a716-446655440000

Servicing identifier.

Response

OK

createdAtstring required

ISO-8601 creation timestamp (RFC 3339, UTC).

descriptionstring

Optional servicing description; omitted when empty.

externalStatusstring required

Health status fetched from the external provider (e.g. "healthy", "recovered"); distinct from the lifecycle status field.

idstring required

Servicing UUID.

namestring required

Servicing display name.

statusstring required

Lifecycle status. One of "active" or "inactive".

updatedAtstring required

ISO-8601 last-update timestamp (RFC 3339, UTC).

Example response

{
  "createdAt": "2026-06-14T12:00:00Z",
  "externalStatus": "healthy",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "active",
  "updatedAt": "2026-06-14T12:00:00Z"
}