Downtime Catalogs

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

Experimental

Get Downtime Catalogs

get

Returns a list of downtime catalogs in your organization.

Authorizations

Bearer

AuthorizationstringRequired

Query parameters

cursorstringOptional

uuidstring · uuid[] · max: 50 · nullableOptional

If not set, all downtime catalogs will be considered.

machinestring · uuid[] · max: 50 · nullableOptional

Only return catalogs assigned to any of the given machines. If not set, catalogs for all machines (including unassigned catalogs) will be considered.

unassignedboolean · nullableOptional

If true, only return catalogs that are not assigned to any machine. If not set, return catalogs irrespective if they're assigned to a machine or not.

statestring · enum · nullableOptional

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

Possible values:

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get/v2/downtime-catalogs

HTTPcURLJavaScriptPython

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

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

Experimental

Create Downtime Catalog

post

Create a downtime catalog.

Authorizations

Bearer

AuthorizationstringRequired

Body

application/json

namestring · min: 1Required

descriptionstring · nullableOptional

Free-text description of the downtime catalog.

Responses

201

Successful Response

application/json

uuidstring · uuidRequired

The UUID of the downtime catalog.

namestringRequired

Name of the downtime catalog.

descriptionstring · nullableOptional

Free-text description of the downtime catalog.

statestring · enumRequired

Lifecycle state of the downtime catalog.

Possible values:

409

Conflict

application/json

422

Validation Error

application/json

post/v2/downtime-catalogs

HTTPcURLJavaScriptPython

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

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

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

Experimental

Get Downtime Catalog

get

Returns details for a specific downtime catalog.

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

uuidstring · uuidRequired

Responses

200

Successful Response

application/json

uuidstring · uuidRequired

The UUID of the downtime catalog.

namestringRequired

Name of the downtime catalog.

descriptionstring · nullableOptional

Free-text description of the downtime catalog.

statestring · enumRequired

Lifecycle state of the downtime catalog.

Possible values:

422

Validation Error

application/json

get/v2/downtime-catalogs/{uuid}

HTTPcURLJavaScriptPython

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

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

Experimental

Update Downtime Catalog

patch

Update a downtime catalog's name or description.

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

uuidstring · uuidRequired

Body

application/json

namestring · min: 1Optional

descriptionstring · nullableOptional

Responses

200

Successful Response

application/json

uuidstring · uuidRequired

The UUID of the downtime catalog.

namestringRequired

Name of the downtime catalog.

descriptionstring · nullableOptional

Free-text description of the downtime catalog.

statestring · enumRequired

Lifecycle state of the downtime catalog.

Possible values:

404

Not Found

application/json

409

Conflict

application/json

422

Validation Error

application/json

patch/v2/downtime-catalogs/{uuid}

HTTPcURLJavaScriptPython

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

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

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