Downtime Reasons

⚠️ Experimental — this resource is under active development and may change without notice.

Experimental

Get Downtime Reasons

get

Returns a list of downtime reasons in your organization.

Authorizations

Bearer

AuthorizationstringRequired

Query parameters

cursorstringOptional

uuidstring · uuid[] · max: 50 · nullableOptional

If not set, all downtime reasons will be considered.

catalogstring · uuid[] · max: 50 · nullableOptional

Only return reasons belonging to any of the given catalogs.

machinestring · uuid[] · max: 50 · nullableOptional

Only return reasons whose catalog is assigned to any of the given machines. If not set, reasons for all machines will be considered.

statestring · enum · nullableOptional

If not set, both active and archived reasons will be returned.

Possible values:

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get/v2/downtime-reasons

HTTPcURLJavaScriptPython

GET /api/v2/downtime-reasons HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "category": "PLANNED",
      "group": "text",
      "state": "active",
      "catalog": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "metadata": {
    "next_cursor": "text"
  }
}

Experimental

Create Downtime Reason

post

Create a downtime reason within a catalog.

Authorizations

Bearer

AuthorizationstringRequired

Body

application/json

catalogstring · uuidRequired

UUID of the active catalog to create the reason in.

namestring · min: 1Required

descriptionstring · nullableOptional

Free-text description of the downtime reason.

categorystring · enumRequired

One of: PLANNED, UNPLANNED, NOT_SCHEDULED, INVALID

Possible values:

groupstring · nullableOptional

Single-level, free-text group the reason belongs to.

Responses

201

Successful Response

application/json

uuidstring · uuidRequired

The UUID of the downtime reason.

namestringRequired

descriptionstring · nullableOptional

Free-text description of the downtime reason.

categorystring · enumRequired

Category of the downtime reason.

Possible values:

groupstring · nullableRequired

statestring · enumRequired

Lifecycle state of the downtime reason.

Possible values:

catalogstring · uuid · nullableOptional

UUID of the catalog this reason belongs to. Resolve it via GET /api/v2/downtime-catalogs/{uuid}. null for legacy reasons not yet migrated to a catalog (only reachable as an embedded reason on GET /api/v2/downtimes).

404

Not Found

application/json

409

Conflict

application/json

422

Validation Error

application/json

post/v2/downtime-reasons

HTTPcURLJavaScriptPython

POST /api/v2/downtime-reasons HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "catalog": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "category": "PLANNED",
  "group": "text"
}

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "category": "PLANNED",
  "group": "text",
  "state": "active",
  "catalog": "123e4567-e89b-12d3-a456-426614174000"
}

Experimental

Get Downtime Reason

get

Returns details for a specific downtime reason.

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

uuidstring · uuidRequired

Responses

200

Successful Response

application/json

uuidstring · uuidRequired

The UUID of the downtime reason.

namestringRequired

descriptionstring · nullableOptional

Free-text description of the downtime reason.

categorystring · enumRequired

Category of the downtime reason.

Possible values:

groupstring · nullableRequired

statestring · enumRequired

Lifecycle state of the downtime reason.

Possible values:

catalogstring · uuid · nullableOptional

UUID of the catalog this reason belongs to. Resolve it via GET /api/v2/downtime-catalogs/{uuid}. null for legacy reasons not yet migrated to a catalog (only reachable as an embedded reason on GET /api/v2/downtimes).

422

Validation Error

application/json

get/v2/downtime-reasons/{uuid}

HTTPcURLJavaScriptPython

GET /api/v2/downtime-reasons/{uuid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "category": "PLANNED",
  "group": "text",
  "state": "active",
  "catalog": "123e4567-e89b-12d3-a456-426614174000"
}

Experimental

Update Downtime Reason

patch

Update a downtime reason's name, description, or group.

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

uuidstring · uuidRequired

Body

application/json

namestring · min: 1Optional

descriptionstring · nullableOptional

groupstring · nullableOptional

Responses

200

Successful Response

application/json

uuidstring · uuidRequired

The UUID of the downtime reason.

namestringRequired

descriptionstring · nullableOptional

Free-text description of the downtime reason.

categorystring · enumRequired

Category of the downtime reason.

Possible values:

groupstring · nullableRequired

statestring · enumRequired

Lifecycle state of the downtime reason.

Possible values:

catalogstring · uuid · nullableOptional

UUID of the catalog this reason belongs to. Resolve it via GET /api/v2/downtime-catalogs/{uuid}. null for legacy reasons not yet migrated to a catalog (only reachable as an embedded reason on GET /api/v2/downtimes).

404

Not Found

application/json

409

Conflict

application/json

422

Validation Error

application/json

patch/v2/downtime-reasons/{uuid}

HTTPcURLJavaScriptPython

PATCH /api/v2/downtime-reasons/{uuid} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "name": "text",
  "description": "text",
  "group": "text"
}

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "category": "PLANNED",
  "group": "text",
  "state": "active",
  "catalog": "123e4567-e89b-12d3-a456-426614174000"
}