Sign in

v1

latestOpenAPI 3.1.02026-08-06360288.3 KB
Maintenance

Create Historic Maintenance

Create a historic maintenance.

post/maintenance/history/create

Headers

x-api-idstring required
x-api-keystring required

Request body

statuspage_idstring required

ID of the status page

all_infrastructure_affectedstring required

Apply to all components and containers. Set to 1 to affect all infrastructure, 0 to use specific infrastructure_affected list (default: 0).

infrastructure_affectedstring[] required
maintenance_namestring required

Descriptive title for the maintenance event

maintenance_details_schedulestring required

Message describing the scheduling of this maintenance

maintenance_details_startstring required

Message describing the start of this maintenance

maintenance_details_endstring required

Message describing the end of this maintenance

maintenance_start_datestring required

Maintenance start date in MM/dd/yyyy format

maintenance_start_timestring required

Maintenance start time in HH:mm format (24-hour)

maintenance_end_datestring required

Maintenance end date in MM/dd/yyyy format

maintenance_end_timestring required

Maintenance end time in HH:mm format (24-hour)

Example request

{
  "all_infrastructure_affected": "0",
  "infrastructure_affected": [
    "53d746c0383cd493cf00001a-53d746c0383cd493cf00001b",
    "53d746c0383cd493cf00001a-53d746c8383cd493cf00001e"
  ],
  "maintenance_details_end": "Maintenance has been completed successfully. All database servers are operating normally with improved performance and capacity.",
  "maintenance_details_schedule": "We will be upgrading hardware for the main database server to improve performance and capacity. No service downtime is expected during this maintenance window.",
  "maintenance_details_start": "Scheduled maintenance has begun. We are performing hardware upgrades on the database server infrastructure.",
  "maintenance_end_date": "05/01/2015",
  "maintenance_end_time": "03:15",
  "maintenance_name": "Database Server Hardware Upgrade",
  "maintenance_start_date": "05/01/2015",
  "maintenance_start_time": "03:00",
  "statuspage_id": "52e5e0e0893548543700000b"
}

Response

OK

resultstring

Example response

{
  "result": "52e5e0e3290548543700000b",
  "status": {
    "error": "no",
    "message": "OK"
  }
}