Downtime Catalogs
⚠️ Experimental — this resource is under active development and may change without notice.
Returns a list of downtime catalogs in your organization.
Caps the page size. Defaults to 1000, which is also the maximum; a value below 1 or above 1000 is rejected.
1000If not set, all downtime catalogs will be considered.
Only return catalogs assigned to any of the given machines. If not set, catalogs for all machines (including unassigned catalogs) will be considered.
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.
If not set, both active and archived catalogs will be returned.
Successful Response
Validation Error
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"
}
}Create a downtime catalog.
Free-text description of the downtime catalog.
Successful Response
The UUID of the downtime catalog.
Name of the downtime catalog.
Free-text description of the downtime catalog.
Lifecycle state of the downtime catalog.
Conflict
Validation Error
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"
}Returns details for a specific downtime catalog.
Successful Response
The UUID of the downtime catalog.
Name of the downtime catalog.
Free-text description of the downtime catalog.
Lifecycle state of the downtime catalog.
Validation Error
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"
}Delete a downtime catalog and all of its reasons (both active and archived). Downtimes labeled with those reasons are kept, but lose their reason. Any machine assignments of the catalog are removed. Works on active and archived catalogs. Pass dry_run=true to see how many reasons and downtimes would be affected, without deleting anything.
If true, nothing is deleted; the response reports what a real delete would affect.
falseSuccessful Response
Number of downtime reasons deleted along with the catalog (a dry run reports how many would be deleted).
Number of downtimes that lose their reason; the downtimes themselves are kept (a dry run reports how many would be unlabeled).
Not Found
Validation Error
DELETE /api/v2/downtime-catalogs/{uuid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"deleted_reasons": 1,
"unlabeled_downtimes": 1
}Update a downtime catalog's name or description.
Successful Response
The UUID of the downtime catalog.
Name of the downtime catalog.
Free-text description of the downtime catalog.
Lifecycle state of the downtime catalog.
Not Found
Conflict
Validation Error
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"
}Archive or restore a downtime catalog. Archiving cascades the state to all of the catalog's reasons; both directions are reversible. Setting the state the catalog is already in is a no-op.
Lifecycle state to transition the catalog to.
Successful Response
The UUID of the downtime catalog.
Name of the downtime catalog.
Free-text description of the downtime catalog.
Lifecycle state of the downtime catalog.
Not Found
Validation Error
PUT /api/v2/downtime-catalogs/{uuid}/state HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"state": "active"
}{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"state": "active"
}Assign this downtime catalog to the specified machine.
Successful Response
Kein Inhalt
Not Found
Conflict
Validation Error
POST /api/v2/downtime-catalogs/{uuid}/machines/{machine_uuid} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2
{}Kein Inhalt
Unassign this downtime catalog from the specified machine.
Successful Response
Kein Inhalt
Not Found
Conflict
Validation Error
DELETE /api/v2/downtime-catalogs/{uuid}/machines/{machine_uuid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
Kein Inhalt
List the machines this downtime catalog is assigned to.
Caps the page size. Defaults to 1000, which is also the maximum; a value below 1 or above 1000 is rejected.
1000Successful Response
Not Found
Validation Error
GET /api/v2/downtime-catalogs/{uuid}/machines HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"machine": "123e4567-e89b-12d3-a456-426614174000"
}
],
"metadata": {
"next_cursor": "text"
}
}Zuletzt aktualisiert