Resource

Status Page

Manage status pages for your project.

The Status Page Model

Properties

Name
_id
Type
Object ID
Description
ID of this object
Name
createdAt
Type
Date
Description
Date and Time when the object was created.
Name
updatedAt
Type
Date
Description
Date and Time when the object was updated.
Name
project
Type
Project
Description
Relation to Project Resource in which this object belongs
Name
projectId
Type
Object IDRequired
Description
ID of your Project in which this object belongs
Name
name
Type
TextRequired
Description
Any friendly name of this object
Name
pageTitle
Type
Text
Description
Title of your Status Page. This is used for SEO.
Name
pageDescription
Type
Long Text
Description
Description of your Status Page. This is used for SEO.
Name
description
Type
Long Text
Description
Friendly description that will help you remember
Name
slug
Type
SlugRequired
Description
Friendly globally unique name for your object
Name
createdByUser
Type
User
Description
Relation to User who created this object (if this object was created by a User)
Name
labels
Type
Label
Description
Relation to Labels Array where this object is categorized in.
Name
createdByUserId
Type
Object ID
Description
User ID who created this object (if this object was created by a User)
Name
faviconFile
Type
File
Description
Status Page Favicon
Name
faviconFileId
Type
Object ID
Description
Status Page Favicon File ID
Name
logoFile
Type
File
Description
Status Page Logo
Name
logoFileId
Type
Object ID
Description
Status Page Logo File ID
Name
coverImageFile
Type
File
Description
Status Page Cover Image
Name
coverImageFileId
Type
Object ID
Description
Status Page Cover Image ID
Name
headerHTML
Type
HTML
Description
Status Page Custom HTML Header
Name
footerHTML
Type
HTML
Description
Status Page Custom HTML Footer
Name
customCSS
Type
CSS
Description
Status Page Custom CSS Header
Name
customJavaScript
Type
JavaSCript
Description
Status Page Custom JavaScript. This runs when the status page is loaded.
Name
isPublicStatusPage
Type
Boolean
Description
Is this status page public?
Name
enableMasterPassword
Type
Boolean
Description
Require visitors to enter a master password before viewing a private status page.
Name
masterPassword
Type
Hashed String
Description
Password required to unlock a private status page. This value is stored as a secure hash.
Name
showIncidentLabelsOnStatusPage
Type
Boolean
Description
Show Incident Labels on Status Page?
Name
showScheduledEventLabelsOnStatusPage
Type
Boolean
Description
Show Scheduled Event Labels on Status Page?
Name
enableSubscribers
Type
Boolean
Description
Can subscribers subscribe to this Status Page?
Name
enableEmailSubscribers
Type
Boolean
Description
Can email subscribers subscribe to this Status Page?
Name
allowSubscribersToChooseResources
Type
Boolean
Description
Can subscribers choose which resources to subscribe to?
Name
allowSubscribersToChooseEventTypes
Type
Boolean
Description
Can subscribers choose which event type like Announcements, Incidents, Scheduled Events to subscribe to?
Name
enableSmsSubscribers
Type
Boolean
Description
Can SMS subscribers subscribe to this Status Page?
Name
enableSlackSubscribers
Type
Boolean
Description
Can Slack subscribers subscribe to this Status Page?
Name
enableMicrosoftTeamsSubscribers
Type
Boolean
Description
Can Microsoft Teams subscribers subscribe to this Status Page?
Name
copyrightText
Type
Text
Description
Copyright Text
Name
customFields
Type
JSON
Description
Custom Fields on this resource.
Name
requireSsoForLogin
Type
BooleanRequired
Description
Should SSO be required to login to Private Status Page
Name
smtpConfig
Type
Entity
Description
Relation to SMTP Config Resource which is used to send email to subscribers.
Name
smtpConfigId
Type
Object ID
Description
ID of your SMTP Config Resource which is used to send email to subscribers.
Name
callSmsConfig
Type
Entity
Description
Relation to Call/SMS Config Resource which is used to send SMS to subscribers.
Name
callSmsConfigId
Type
Object ID
Description
ID of your Call/SMS Config Resource which is used to send SMS to subscribers.
Name
showIncidentHistoryInDays
Type
NumberRequired
Description
How many days of incident history should be shown on the status page (in days)?
Name
showAnnouncementHistoryInDays
Type
NumberRequired
Description
How many days of announcement history should be shown on the status page (in days)?
Name
showScheduledEventHistoryInDays
Type
NumberRequired
Description
How many days of scheduled event history should be shown on the status page (in days)?
Name
overviewPageDescription
Type
Markdown
Description
Overview Page description for your status page. This is a markdown field.
Name
hidePoweredByBranding
Type
Boolean
Description
Hide Powered By Branding?
Name
defaultBarColor
Type
Color
Description
Default color of the bar on the overview page
Name
downtimeMonitorStatuses
Type
Monitor Status
Description
List of monitors statuses that are considered as "down" for this status page.
Name
subscriberTimezones
Type
JSON
Description
Timezones of subscribers to this status page.
Name
isReportEnabled
Type
Boolean
Description
Is Report Enabled for this Status Page?
Name
reportStartDateTime
Type
Date
Description
When would you like to send the first report?
Name
reportRecurringInterval
Type
JSON
Description
How often would you like to send the report?
Name
sendNextReportBy
Type
Date
Description
When should the next report be sent?
Name
reportDataInDays
Type
Number
Description
How many days of data should be included in the report?
Name
showOverallUptimePercentOnStatusPage
Type
Boolean
Description
Show Overall Uptime Percent on Status Page?
Name
overallUptimePercentPrecision
Type
Text
Description
Overall Precision of uptime percent for this status page.
Name
subscriberEmailNotificationFooterText
Type
Very Long Text
Description
Text to send to subscribers in the footer of the email.
Name
enableCustomSubscriberEmailNotificationFooterText
Type
Boolean
Description
Enable custom footer text in subscriber email notifications.
Name
showIncidentsOnStatusPage
Type
Boolean
Description
Show Incidents on Status Page?
Name
showAnnouncementsOnStatusPage
Type
Boolean
Description
Show Announcements on Status Page?
Name
showEpisodesOnStatusPage
Type
Boolean
Description
Show Incident Episodes on Status Page?
Name
showEpisodeHistoryInDays
Type
Number
Description
How many days of episode history to show on the status page
Name
showEpisodeLabelsOnStatusPage
Type
Boolean
Description
Show Episode Labels on Status Page?
Name
showScheduledMaintenanceEventsOnStatusPage
Type
Boolean
Description
Show Scheduled Maintenance Events on Status Page?
Name
showSubscriberPageOnStatusPage
Type
Boolean
Description
Show Subscriber Page on Status Page?
Name
ipWhitelist
Type
Very Long Text
Description
IP Whitelist for this Status Page. One IP per line. Only used if the status page is private.
Name
enableEmbeddedOverallStatus
Type
Boolean
Description
Enable embedded overall status badge that can be displayed on external websites?
Name
embeddedOverallStatusToken
Type
Text
Description
Security token required to access the embedded overall status badge. This token must be provided in the URL.

GETorPOST/api/status-page/get-list

List

This endpoint allows you to retrieve a paginated list of all your Status Page. By default, a maximum of ten Status Page are shown per page.

Optional Query Params

limit
number
Number of objects to fetch. By default 10, you can increase this count up to 100
skip
number
Number of objects to skip. This can be useful in pagination

Optional Request Body

query
If you would like to filter on Status Page. You can specify include a query here. For more information, please check out writing queries here.
select
By default you will only retrieve ID of objects, to retrieve more fields you need to select them. For more information, please check how to select here.
sort
Objects will be sorted based on created date by default. You can change the sort order — see Data Types: Sort.

List Request

POST

/api/status-page/get-list?skip=0&limit=10

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "select": {
    "name": true,
    "projectId": true,
    "description": true,
    "pageDescription": true,
    "pageTitle": true
  },
  "query": {
    "name": "Acme Corp Status Page"
  },
  "sort": {
    "createdAt": -1
  }
}

Response

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377b7cc0-28fe-11f1-b591-3fdcef396aba",
      "name": "Acme Corp Status Page",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "description": "Public status page for Acme Corp customer-facing services",
      "pageDescription": "Current status and uptime information for all Acme Corp services and infrastructure.",
      "pageTitle": "Acme Corp System Status"
    },
    {
      "_id": "377b7cc1-28fe-11f1-b591-3fdcef396aba",
      "name": "Acme Corp Status Page",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "description": "Public status page for Acme Corp customer-facing services",
      "pageDescription": "Current status and uptime information for all Acme Corp services and infrastructure.",
      "pageTitle": "Acme Corp System Status"
    },
    {
      "_id": "377b7cc2-28fe-11f1-b591-3fdcef396aba",
      "name": "Acme Corp Status Page",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "description": "Public status page for Acme Corp customer-facing services",
      "pageDescription": "Current status and uptime information for all Acme Corp services and infrastructure.",
      "pageTitle": "Acme Corp System Status"
    }
  ]
}

GETorPOST/api/status-page/:id/get-item

Get item by ID

This endpoint allows you to retrieve Status Page by ID.

id
text
ID of the Object

Optional Request Body

select
By default you will only retrieve ID of objects, to retrieve more fields you need to select them. For more information, please check how to select here.

Get Item Request

POST

/api/status-page/:id/get-item

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "select": {
    "name": true,
    "projectId": true,
    "description": true,
    "pageDescription": true,
    "pageTitle": true
  }
}

Response

{
  "_id": "377b7cc0-28fe-11f1-b591-3fdcef396aba",
  "name": "Acme Corp Status Page",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "description": "Public status page for Acme Corp customer-facing services",
  "pageDescription": "Current status and uptime information for all Acme Corp services and infrastructure.",
  "pageTitle": "Acme Corp System Status"
}

POST/api/status-page/count

Count

This endpoint allows you to retrieve the count of all your Status Page.

Optional Request Body

query
If you would like to filter on Status Page. You can specify include a query here. For more information, please check out writing queries here.

Count Request

POST

/api/status-page/count

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "query": {
    "name": "Acme Corp Status Page"
  }
}

Response

{
  "count": 107
}

POST/api/status-page

Create Status Page

This endpoint allows you to create a new object.

Create Request

POST

/api/status-page

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "data": {
    "name": "Acme Corp Status Page",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "description": "Public status page for Acme Corp customer-facing services",
    "pageDescription": "Current status and uptime information for all Acme Corp services and infrastructure.",
    "pageTitle": "Acme Corp System Status"
  }
}

Response

{
  "_id": "377b7cc0-28fe-11f1-b591-3fdcef396aba",
  "name": "Acme Corp Status Page",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "description": "Public status page for Acme Corp customer-facing services",
  "pageDescription": "Current status and uptime information for all Acme Corp services and infrastructure.",
  "pageTitle": "Acme Corp System Status"
}

PUT/api/status-page/:id

Update by ID

This endpoint allows you to update object by its ID.

Alternative Methods

For clients that do not support PUT requests, you can use POST or GET with the same request headers and body:

POST/api/status-page/:id/update-item

GET/api/status-page/:id/update-item

Update Request

PUT

/api/status-page/:id

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "data": {
    "name": "Acme Corp Status Page",
    "description": "Public status page for Acme Corp customer-facing services",
    "pageDescription": "Current status and uptime information for all Acme Corp services and infrastructure."
  }
}

Response

{}

DELETE/api/status-page/:id

Delete by ID

This endpoint allows you to delete object by its ID.

Alternative Methods

For clients that do not support DELETE requests, you can use POST or GET with the same request headers and body:

POST/api/status-page/:id/delete-item

GET/api/status-page/:id/delete-item

Delete Request

DELETE

/api/status-page/:id

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Response

{}

Permissions

Your API Token needs permissions to create, update, read or delete this resource. If you do not have permissions to make a request a 4xx status will be sent as response.

Read Permissions

Required to read Status Page

Project Owner
Project Admin
Project Member
Read Status Page
Read All Project Resources

Create Permissions

Required to create Status Page

Project Owner
Project Admin
Project Member
Create Status Page

Update Permissions

Required to update Status Page

Project Owner
Project Admin
Project Member
Edit Status Page

Delete Permissions

Required to delete Status Page

Project Owner
Project Admin
Project Member
Delete Status Page