Skip to main content
POST
Complete a maintenance window

Authorizations

Authorization
string
header
required

Use a user token to access authenticated routes. The token must be specified in the Authorization HTTP header with the following format 'Authorization: Bearer '.

Headers

X-Phare-Project-Id
integer

A project header is required when using an organization-scoped API key.

Example:

1

X-Phare-Project-Slug
string

A project header is required when using an organization-scoped API key.

Example:

"luminous-guiding-tower"

Path Parameters

maintenanceWindowId
integer
required

ID of the maintenance window to complete

Response

Success, maintenance window completed

monitoring_mode
enum<string>
required
Available options:
pause,
mute,
normal
title
string
required

Maintenance window title

Example:

"Database upgrade"

starts_at
string<date-time>
required

Date and time when the maintenance window starts

ends_at
string<date-time>
required

Date and time when the maintenance window ends

id
integer

Maintenance window ID

Example:

1

project_id
integer

Parent project ID

Example:

1

state
enum<string>
Available options:
scheduled,
in_progress,
completed,
cancelled
description
string | null

Description of the maintenance window

Example:

"Planned database upgrade and maintenance"

monitors
integer[]

List of monitor IDs linked to the maintenance window

Example:
status_pages
integer[]

List of status page IDs linked to the maintenance window

Example:
created_at
string<date-time>

Date of creation for the entity

updated_at
string<date-time>

Date of last update for the entity

Last modified on August 30, 2026