Skip to content

`POST /api/v1/maintenance-windows` — create a maintenance window (Admin only).

POST
/api/v1/maintenance-windows
curl --request POST \
--url https://example.com/api/v1/maintenance-windows \
--header 'Content-Type: application/json' \
--data '{ "ends_at": 1, "reason": "example", "starts_at": 1 }'
Media type application/json

Request body for POST /api/v1/maintenance-windows.

object
ends_at
required

UTC end time, Unix timestamp in seconds.

integer format: int64
reason
required

Operator-provided reason for the window.

string
starts_at
required

UTC start time, Unix timestamp in seconds.

integer format: int64
Example generated
{
"ends_at": 1,
"reason": "example",
"starts_at": 1
}

Maintenance window created

Media type application/json

Response body for a single maintenance window.

object
created_by
required
string
ends_at
required
integer format: int64
id
required
string
reason
required
string
starts_at
required
integer format: int64
Example generated
{
"created_by": "example",
"ends_at": 1,
"id": "example",
"reason": "example",
"starts_at": 1
}

Invalid request body

Admin role required