Downtimes

Get Downtimes

get

Returns a list of downtimes in your organization.

Autorisierungen

AuthorizationstringErforderlich

Abfrageparameter

uuidstring · uuid[] · max: 50 · nullableOptional

Matches downtimes with any of these UUIDs.

machinestring · uuid[] · max: 50 · nullableOptional

Matches downtimes on any of these machines.

startstring · date-time · nullableOptional

Matches downtimes observed at or after this time.

Example: 2023-07-19T19:39:46.735269+02:00

endstring · date-time · nullableOptional

Matches downtimes observed up to this time.

reason_statestring · enum · nullableOptional

active matches downtimes whose reason is active, archived those whose reason is archived. Neither matches unlabeled downtimes.

Mögliche Werte:

cursorstringOptional

limitinteger · min: 1 · max: 1000Optional

Caps the page size. Defaults to 1000, which is also the maximum; a value below 1 or above 1000 is rejected.

Default: 1000

Antworten

200

Successful Response

application/json

422

Validation Error

application/json

get/v2/downtimes

GET /api/v2/downtimes HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "machine": "123e4567-e89b-12d3-a456-426614174000",
      "comment": "text",
      "type": "THRESHOLD",
      "updated": {
        "first_name": "text",
        "last_name": "text",
        "timestamp": "2026-01-01T00:00:00.000Z"
      },
      "reason": {
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "category": "PLANNED",
        "group": "text",
        "state": "active",
        "catalog": "123e4567-e89b-12d3-a456-426614174000"
      },
      "start": "2026-01-01T00:00:00.000Z",
      "end": "2026-01-01T00:00:00.000Z"
    }
  ],
  "metadata": {
    "next_cursor": "text"
  }
}

Experimental

Bulk Update Downtimes

patch

Apply a downtime reason to every downtime matching filters (the same filters as GET /downtimes — e.g. reason_state=archived to target downtimes whose reason was archived). The response reports how many downtimes were relabeled and which machines they belong to. Pass dry_run=true to preview that scope without changing anything.

Autorisierungen

AuthorizationstringErforderlich

Abfrageparameter

dry_runbooleanOptional

If true, nothing is changed; the response reports what a real update would affect.

Default: false

Body

Antworten

200

Successful Response

application/json

affected_countintegerErforderlich

Number of downtimes the reason was applied to.

affected_machinesstring · uuid[]Erforderlich

The machines those downtimes belong to — the scope of the change.

400

Bad Request

application/json

404

Not Found

application/json

409

Conflict

application/json

422

Validation Error

application/json

patch/v2/downtimes/bulk

PATCH /api/v2/downtimes/bulk HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 321

{
  "filters": {
    "uuid": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "machine": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "start": "2023-07-19T19:39:46.735269+02:00",
    "end": "2026-01-01T00:00:00.000Z",
    "reason": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "reason_state": "active"
  },
  "update": {
    "reason": "123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "affected_count": 1,
  "affected_machines": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}