For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/api/latest/status-pages/schedule-maintenance.md. A documentation index is available at /llms.txt.
Language
Datadog site

Schedule maintenance

POSThttps://api.datadoghq.com/api/v2/statuspages/{page_id}/maintenanceshttps://api.us3.datadoghq.com/api/v2/statuspages/{page_id}/maintenanceshttps://api.us5.datadoghq.com/api/v2/statuspages/{page_id}/maintenanceshttps://api.datadoghq.eu/api/v2/statuspages/{page_id}/maintenanceshttps://api.ap1.datadoghq.com/api/v2/statuspages/{page_id}/maintenanceshttps://api.ap2.datadoghq.com/api/v2/statuspages/{page_id}/maintenanceshttps://api.uk1.datadoghq.com/api/v2/statuspages/{page_id}/maintenanceshttps://api.ddog-gov.com/api/v2/statuspages/{page_id}/maintenanceshttps://api.us2.ddog-gov.com/api/v2/statuspages/{page_id}/maintenances

Overview

Schedules a new maintenance.

This endpoint requires the status_pages_incident_write permission.

OAuth apps require the status_pages_incident_write authorization scope to access this endpoint.

Arguments

Path Parameters

Name
Type
Description
page_id [required]
string

The ID of the status page.

Query Strings

Name
Type
Description
notify_subscribers
boolean

Whether to notify page subscribers of the maintenance.

Default: true
include
string

Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.

Request

Body Data (required)

Field
Type
Description
data
object

The data object for creating a maintenance.

Response

Created

Response object for a single maintenance.

Field
Type
Description
data
object

The data object for a maintenance.

included
[<oneOf>]

The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.

Code Example

# Path parameters
export page_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/maintenances" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "completed_date": "2026-02-18T19:51:13.332360075Z",
      "completed_description": "We have completed maintenance on the API to improve performance.",
      "components_affected": [
        {
          "id": "1234abcd-12ab-34cd-56ef-123456abcdef",
          "status": "operational"
        }
      ],
      "in_progress_description": "We are currently performing maintenance on the API to improve performance.",
      "scheduled_description": "We will be performing maintenance on the API to improve performance.",
      "start_date": "2026-02-18T19:21:13.332360075Z",
      "title": "API Maintenance"
    },
    "type": "maintenances"
  }
}
EOF
# Path parameters
export page_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/maintenances" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "completed_date": "2026-02-18T19:51:13.332360075Z",
      "completed_description": "We have completed maintenance on the API to improve performance.",
      "components_affected": [
        {
          "id": "1234abcd-12ab-34cd-56ef-123456abcdef",
          "status": "operational"
        }
      ],
      "in_progress_description": "We are currently performing maintenance on the API to improve performance.",
      "scheduled_description": "We will be performing maintenance on the API to improve performance.",
      "start_date": "2026-02-18T19:21:13.332360075Z",
      "title": "API Maintenance"
    },
    "type": "maintenances"
  }
}
EOF
# Path parameters
export page_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/maintenances" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "completed_date": "2026-02-18T19:51:13.332360075Z",
      "completed_description": "We have completed maintenance on the API to improve performance.",
      "components_affected": [
        {
          "id": "1234abcd-12ab-34cd-56ef-123456abcdef",
          "status": "operational"
        }
      ],
      "in_progress_description": "We are currently performing maintenance on the API to improve performance.",
      "scheduled_description": "We will be performing maintenance on the API to improve performance.",
      "start_date": "2026-02-18T19:21:13.332360075Z",
      "title": "API Maintenance"
    },
    "type": "maintenances"
  }
}
EOF
# Path parameters
export page_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/maintenances" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "completed_date": "2026-02-18T19:51:13.332360075Z",
      "completed_description": "We have completed maintenance on the API to improve performance.",
      "components_affected": [
        {
          "id": "1234abcd-12ab-34cd-56ef-123456abcdef",
          "status": "operational"
        }
      ],
      "in_progress_description": "We are currently performing maintenance on the API to improve performance.",
      "scheduled_description": "We will be performing maintenance on the API to improve performance.",
      "start_date": "2026-02-18T19:21:13.332360075Z",
      "title": "API Maintenance"
    },
    "type": "maintenances"
  }
}
EOF
# Path parameters
export page_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/maintenances" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "completed_date": "2026-02-18T19:51:13.332360075Z",
      "completed_description": "We have completed maintenance on the API to improve performance.",
      "components_affected": [
        {
          "id": "1234abcd-12ab-34cd-56ef-123456abcdef",
          "status": "operational"
        }
      ],
      "in_progress_description": "We are currently performing maintenance on the API to improve performance.",
      "scheduled_description": "We will be performing maintenance on the API to improve performance.",
      "start_date": "2026-02-18T19:21:13.332360075Z",
      "title": "API Maintenance"
    },
    "type": "maintenances"
  }
}
EOF
# Path parameters
export page_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/maintenances" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "completed_date": "2026-02-18T19:51:13.332360075Z",
      "completed_description": "We have completed maintenance on the API to improve performance.",
      "components_affected": [
        {
          "id": "1234abcd-12ab-34cd-56ef-123456abcdef",
          "status": "operational"
        }
      ],
      "in_progress_description": "We are currently performing maintenance on the API to improve performance.",
      "scheduled_description": "We will be performing maintenance on the API to improve performance.",
      "start_date": "2026-02-18T19:21:13.332360075Z",
      "title": "API Maintenance"
    },
    "type": "maintenances"
  }
}
EOF
# Path parameters
export page_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/maintenances" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "completed_date": "2026-02-18T19:51:13.332360075Z",
      "completed_description": "We have completed maintenance on the API to improve performance.",
      "components_affected": [
        {
          "id": "1234abcd-12ab-34cd-56ef-123456abcdef",
          "status": "operational"
        }
      ],
      "in_progress_description": "We are currently performing maintenance on the API to improve performance.",
      "scheduled_description": "We will be performing maintenance on the API to improve performance.",
      "start_date": "2026-02-18T19:21:13.332360075Z",
      "title": "API Maintenance"
    },
    "type": "maintenances"
  }
}
EOF
# Path parameters
export page_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/maintenances" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "completed_date": "2026-02-18T19:51:13.332360075Z",
      "completed_description": "We have completed maintenance on the API to improve performance.",
      "components_affected": [
        {
          "id": "1234abcd-12ab-34cd-56ef-123456abcdef",
          "status": "operational"
        }
      ],
      "in_progress_description": "We are currently performing maintenance on the API to improve performance.",
      "scheduled_description": "We will be performing maintenance on the API to improve performance.",
      "start_date": "2026-02-18T19:21:13.332360075Z",
      "title": "API Maintenance"
    },
    "type": "maintenances"
  }
}
EOF
# Path parameters
export page_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/maintenances" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "completed_date": "2026-02-18T19:51:13.332360075Z",
      "completed_description": "We have completed maintenance on the API to improve performance.",
      "components_affected": [
        {
          "id": "1234abcd-12ab-34cd-56ef-123456abcdef",
          "status": "operational"
        }
      ],
      "in_progress_description": "We are currently performing maintenance on the API to improve performance.",
      "scheduled_description": "We will be performing maintenance on the API to improve performance.",
      "start_date": "2026-02-18T19:21:13.332360075Z",
      "title": "API Maintenance"
    },
    "type": "maintenances"
  }
}
EOF