Login
Control Plane APIMaintenance windows
POST
/v1/maintenance-windows

Create a new maintenance window.

Query Parameters

title?string

Title @example "Scheduled PostgreSQL upgrade"

customerMessage?string

Customer-facing banner message @example "The billing API will be down for maintenance"

internalDescription?string

SRE details @example "RDS version upgrade"

applicationIds?array<string>

Targeted application IDs

scheduledStartAt?string

Maintenance scheduled start timestamp

Formatdate-time
scheduledEndAt?string

Maintenance scheduled end timestamp

Formatdate-time

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/maintenance-windows"
{  "maintenanceWindow": {    "createdAt": "2019-08-24T14:15:22Z",    "customerMessage": "string",    "endedAt": "2019-08-24T14:15:22Z",    "id": "string",    "impactedApplications": [      {        "applicationId": "string",        "applicationName": "string",        "capabilities": [          {            "id": "string",            "name": "string"          }        ]      }    ],    "internalDescription": "string",    "scheduledEndAt": "2019-08-24T14:15:22Z",    "scheduledStartAt": "2019-08-24T14:15:22Z",    "startedAt": "2019-08-24T14:15:22Z",    "status": "MAINTENANCE_STATUS_UNSPECIFIED",    "title": "string",    "updatedAt": "2019-08-24T14:15:22Z",    "version": "string"  }}

Cancel Maintenance Window POST POST

Cancel a specific maintenance window.

Get Maintenance Window GET GET

Retrieve details for a specific maintenance window.