Status Page Sections API

Manage your status page sections using a simple HTTP API.

Do you need help with the integration?

Let us know at [email protected]

Obtaining an API token

Please, see Obtaining an API token.

get
Listing existing sections of a status page

https://betteruptime.com/api/v2/status-pages/:status_page_id/sections
Returns a list of the sections of your status page.
Request
Response
Request
Path Parameters
status_page_id
required
string
The ID of your status page
Headers
Authorization
required
string
Bearer YOUR_API_TOKEN
Response
200: OK
Returns a list of the resources of your status page.
{
"data": [
{
"id": "12345",
"type": "status_page_section",
"attributes": {
"name": "Current status by service",
"position": 0
}
},
{
"id": "12345",
"type": "status_page_section",
"attributes": {
"name": "EU datacenter",
"position": 1
}
},
],
"pagination": {
"first": "https://betteruptime.com/api/v2/status-pages/123456789/sections?page=1",
"last": "https://betteruptime.com/api/v2/status-pages/123456789/sections?page=1",
"prev": null,
"next": null
}
}
Example cURL
Example cURL
curl --request GET \
--url https://betteruptime.com/api/v2/status-pages/123456789/sections \
--header 'Authorization: Bearer YOUR_API_TOKEN'

get
Getting a single status page section

https://betteruptime.com/api/v2/status-pages/:status_page_id/sections/:section_id
Returns a single status page section
Request
Response
Request
Path Parameters
status_page_id
required
string
The ID of your status page
section_id
required
string
The ID of the section you want to get
Headers
Authorization
required
string
Bearer YOUR_API_TOKEN
Response
200: OK
Returns a single status page resource
{
"data": {
"id": "12345",
"type": "status_page_section",
"attributes": {
"name": "Current status by service",
"position": 0
}
}
}
Example cURL
Example cURL
curl --request GET \
--url https://betteruptime.com/api/v2/status-pages/123456789/sections/12345 \
--header 'Authorization: Bearer YOUR_API_TOKEN'

post
Creating a new status page section

https://betteruptime.com/api/v2/status-pages/:status_page_id/sections
Returns a newly created status page section.
Request
Response
Request
Path Parameters
status_page_id
required
string
The ID of your status page
Headers
Authorization
required
string
Bearer YOUR_API_TOKEN
Content-Type
required
string
application/json
Form Data Parameters
name
optional
string
The name of the section. Leave blank to hide the section header.
position
optional
integer
The position of this resource on your status page, indexed from zero. If you don't specify a position, we add the resource to the end of the status page. When you specify a position of an existing resource, we add the resource to this position and shift resources below to accommodate.
Response
201: Created
{
"id": "12345",
"type": "status_page_section",
"attributes": {
"name": "EU Datacenter",
"position": 0
}
}
Example cURL
Example cURL
curl --request POST \
--url https://betteruptime.com/api/v2/status-pages/123456789/sections \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"name": "EU Datacenter",
"position": 0
}'

patch
Updating an existing status page section

https://betteruptime.com/api/v2/status-pages/:status_page_id/sections/:section_id
Update an existing status page section. Send only the parameters you wish to change (e.g. name)
Request
Response
Request
Path Parameters
status_page_id
required
string
The ID of your status page
section_id
required
string
The section you want to update
Headers
Authorization
required
string
Bearer YOUR_API_TOKEN
Content-Type
required
string
application/json
Form Data Parameters
name
optional
integer
The name of the section. Leave blank to hide the section header.
position
optional
integer
The position of this resource on your status page, indexed from zero. If you don't specify a position, we add the resource to the end of the status page. When you specify a position of an existing resource, we add the resource to this position and shift resources below to accommodate.
Response
200: OK
{
"id": "12345",
"type": "status_page_section",
"attributes": {
"name": "EU datacenter 2",
"position": 0
}
}
Example cURL
Example cURL
curl --request PATCH \
--url https://betteruptime.com/api/v2/status-pages/123456789/sections/12345 \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"name": "EU datacenter 2"
}'

delete
Deleting an existing status page resource

https://betteruptime.com/api/v2/status-pages/:status_page_id/sections/:section_id
Permanently deletes a status page section.
Request
Response
Request
Path Parameters
status_page_id
required
string
The ID of your status page
section_id
required
string
The ID of the section you want to delete
Headers
Authorization
required
string
Bearer YOUR_API_TOKEN
Response
204: No Content
Returns empty body
Example cURL
Example cURL
curl --request DELETE \
--url https://betteruptime.com/api/v2/status-pages/123456789/sections/12345 \
--header 'Authorization: Bearer YOUR_API_TOKEN'