Planned maintenances

Get ongoing planned maintenances

get

Get a list of ongoing maintenances

Authorizations

ApiKeyAuth

x-api-keystringRequired

Your API key. You can find this in your Spike dashboard under Settings > API.

Path parameters

status_page_idstringRequired

status_page_id parameter

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

404

Not found

application/json

get

/api/status-page/{status_page_id}/planned-maintenance

HTTPcURLJavaScriptPython

GET /api/status-page/{status_page_id}/planned-maintenance HTTP/1.1
Host: statuspage.spike.sh
x-api-key: YOUR_API_KEY
Accept: */*

{}

Get upcoming planned maintenances

get

Get a list of upcoming maintenances

Authorizations

ApiKeyAuth

x-api-keystringRequired

Your API key. You can find this in your Spike dashboard under Settings > API.

Path parameters

status_page_idstringRequired

status_page_id parameter

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

404

Not found

application/json

get

/api/status-page/{status_page_id}/planned-maintenance/upcoming

HTTPcURLJavaScriptPython

GET /api/status-page/{status_page_id}/planned-maintenance/upcoming HTTP/1.1
Host: statuspage.spike.sh
x-api-key: YOUR_API_KEY
Accept: */*

{}

Get a list of previous maintenances

get

Get a list of all the previous maintenanecs

Authorizations

ApiKeyAuth

x-api-keystringRequired

Your API key. You can find this in your Spike dashboard under Settings > API.

Path parameters

status_page_idstringRequired

status_page_id parameter

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

404

Not found

application/json

get

/api/status-page/{status_page_id}/planned-maintenance/previous

HTTPcURLJavaScriptPython

GET /api/status-page/{status_page_id}/planned-maintenance/previous HTTP/1.1
Host: statuspage.spike.sh
x-api-key: YOUR_API_KEY
Accept: */*

{}

Get a planned maintenance

get

Get a planned maintenance

Authorizations

ApiKeyAuth

x-api-keystringRequired

Your API key. You can find this in your Spike dashboard under Settings > API.

Path parameters

status_page_idstringRequired

status_page_id parameter

pm_idstringRequired

pm_id parameter

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

404

Not found

application/json

get

/api/status-page/{status_page_id}/planned-maintenance/{pm_id}

HTTPcURLJavaScriptPython

GET /api/status-page/{status_page_id}/planned-maintenance/{pm_id} HTTP/1.1
Host: statuspage.spike.sh
x-api-key: YOUR_API_KEY
Accept: */*

{}

Create a new planned maintenance

post

Create a new planned maintenance

{
	"title": "planned maintenance title",
	"desc": "Write a message to your subscribers.",
	"startDate": "10/03/2023",
	"endDate": "13/03/2023",
	"startTime": "10:00",
	"endTime": "05:00",
	"notify": true,
	"components": ["{{ _.component_id }}"],
	"notifyNow": true,
	"notifyOnEnd": true,
	"reminders": [
		{
			"time": 2,
			"unit": "days"
		}
	]
}

* ALL THE TIMESTAMPS SHOULD BE IN UTC

Params:

title: Title of the planned maintenanace

desc: Write a message to your subscribers.

startDate: Start date is mandatory. Strict form is DD/MM/YYYY.

endDate: End date is mandatory. Strict form is DD/MM/YYYY.

startTime: Start time format is HH:MM in 24-hour format. Please do not add AM or PM.

endTime: End time format is HH:MM in 24-hour format. Please do not add AM or PM.

notify: You can specify to notify the subscribers about the planned maintenance when planned maintenance starts. Type: Boolean

components: Components is the array of component ids which are going into planned maintenance.

notifyNow: Send a notification to you subscribers about planned maintenance schedule. Type: Boolean

notifyOnEnd: Send a notification on the end of planned maintenance. Type: Boolean

reminders: You can provide a list of reminders that will be sent before the planned maintenance starts. you can choose to send reminder days, hours or minutes before planned maintenance starts. all the units have a max limit of 30 days.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Your API key. You can find this in your Spike dashboard under Settings > API.

Path parameters

status_page_idstringRequired

status_page_id parameter

Body

application/json

titlestringOptional

descstringOptional

startDatestringOptional

endDatestringOptional

startTimestringOptional

endTimestringOptional

notifybooleanOptional

componentsstring[]Optional

notifyNowbooleanOptional

notifyOnEndbooleanOptional

Responses

200

Successful response

application/json

objectOptional

400

Bad request

application/json

401

Unauthorized

application/json

404

Not found

application/json

post

/api/status-page/{status_page_id}/planned-maintenance/create

HTTPcURLJavaScriptPython

POST /api/status-page/{status_page_id}/planned-maintenance/create HTTP/1.1
Host: statuspage.spike.sh
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 291

{
  "title": "planned maintenance title edited",
  "desc": "description of the maintenance",
  "startDate": "10/03/2023",
  "endDate": "13/03/2023",
  "startTime": "10:00",
  "endTime": "05:00",
  "notify": true,
  "components": [
    "<component-id>"
  ],
  "notifyNow": true,
  "notifyOnEnd": true,
  "reminders": [
    {
      "time": 2,
      "unit": "days"
    }
  ]
}

{}

Edit a planned maintenance

post

Edit a planned maintenance

{
	"title": "planned maintenance title",
	"desc": "Write a message to your subscribers.",
	"startDate": "10/03/2023",
	"endDate": "13/03/2023",
	"startTime": "10:00",
	"endTime": "05:00",
	"notify": true,
	"components": ["{{ _.component_id }}"],
	"notifyNow": true,
	"notifyOnEnd": true,
	"reminders": [
			{
					"time": 2,
					"unit": "days"
			}
	]
}

* ALL THE TIMESTAMPS SHOULD BE IN UTC

Params:

title: Title of the planned maintenanace

desc: Write a message to your subscribers.

startDate: Start date is mandatory. Strict form is DD/MM/YYYY.

endDate: End date is mandatory. Strict form is DD/MM/YYYY.

startTime: Start time format is HH:MM in 24-hour format. Please do not add AM or PM.

endTime: End time format is HH:MM in 24-hour format. Please do not add AM or PM.

notify: You can specify to notify the subscribers about the planned maintenance when planned maintenance starts. Type: Boolean

components: Components is the array of component ids which are going into planned maintenance.

notifyNow: Send a notification to you subscribers about planned maintenance schedule. Type: Boolean

notifyOnEnd: Send a notification on the end of planned maintenance. Type: Boolean

reminders: You can provide a list of reminders that will be sent before the planned maintenance starts. you can choose to send reminder days, hours or minutes before planned maintenance starts. all the units have a max limit of 30 days.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Your API key. You can find this in your Spike dashboard under Settings > API.

Path parameters

status_page_idstringRequired

status_page_id parameter

pm_idstringRequired

pm_id parameter

Body

application/json

titlestringOptional

descstringOptional

startDatestringOptional

endDatestringOptional

startTimestringOptional

endTimestringOptional

notifybooleanOptional

componentsstring[]Optional

notifyNowbooleanOptional

notifyOnEndbooleanOptional

Responses

200

Successful response

application/json

objectOptional

400

Bad request

application/json

401

Unauthorized

application/json

404

Not found

application/json

post

/api/status-page/{status_page_id}/planned-maintenance/{pm_id}/update

HTTPcURLJavaScriptPython

POST /api/status-page/{status_page_id}/planned-maintenance/{pm_id}/update HTTP/1.1
Host: statuspage.spike.sh
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 293

{
  "title": "planned maintenance edited title 2",
  "desc": "description of the maintenance",
  "startDate": "12/03/2023",
  "endDate": "15/03/2023",
  "startTime": "10:00",
  "endTime": "05:00",
  "notify": true,
  "components": [
    "<component-id>"
  ],
  "notifyNow": true,
  "notifyOnEnd": true,
  "reminders": [
    {
      "time": 2,
      "unit": "days"
    }
  ]
}

{}