Skip to content

Create a maintenance window

POST
/organizations/{org_id}/maintenance-windows
curl --request POST \
--url https://api.perstat.io/organizations/example/maintenance-windows \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "body": "example", "monitors": [ "example" ], "public_visible": true, "scheduled_end": 1, "scheduled_start": 1, "title": "example" }'

Schedules a maintenance window with title, body, start and end (Unix seconds), and the affected monitors. Alerts are suppressed during the window; with public_visible false the window stays internal and is not shown on status pages. End must be after start (400 otherwise), and monitor ids that do not belong to the organization are ignored. Returns 201 with the created window. Requires project management rights.

org_id
required
string
Media typeapplication/json
object
body
string
monitors

Betroffene Monitore (public_ids; fremde IDs werden ignoriert).

Array<string>
public_visible

Auf den Status-Seiten anzeigen (Default true). false = internes Fenster: Alarme bleiben unterdrückt, aber die öffentliche Seite zeigt nichts.

boolean
scheduled_end
required
integer format: int64
scheduled_start
required

Unix-Sekunden (UTC).

integer format: int64
title
string
Examplegenerated
{
"body": "example",
"monitors": [
"example"
],
"public_visible": true,
"scheduled_end": 1,
"scheduled_start": 1,
"title": "example"
}
Media typeapplication/json
object
body
required
string
cancelled
required
boolean
id
required

Fenster-public_id.

string
monitors
required
Array<object>
object
id
required

Monitor-public_id.

string
name
required
string
public_visible
required

Erscheint das Fenster auf den Status-Seiten? (Alarm-Unterdrückung und SLA-Ausschluss gelten unabhängig davon.)

boolean
scheduled_end
required
integer format: int64
scheduled_start
required

Unix-Sekunden (UTC).

integer format: int64
title
required
string
Examplegenerated
{
"body": "example",
"cancelled": true,
"id": "example",
"monitors": [
{
"id": "example",
"name": "example"
}
],
"public_visible": true,
"scheduled_end": 1,
"scheduled_start": 1,
"title": "example"
}