Resource

Status Page Resource

Add resources like monitors to your status page

The Status Page Resource 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
statusPage
Type
Status Page
Description
Relation to Status Page Resource in which this object belongs
Name
statusPageId
Type
Object IDRequired
Description
ID of your Status Page resource where this object belongs
Name
monitor
Type
Monitor
Description
Relation to Monitor Resource in which this object belongs
Name
monitorId
Type
Object ID
Description
Relation to Monitor ID Resource in which this object belongs
Name
monitorGroup
Type
Monitor Group
Description
Relation to Monitor Group Resource in which this object belongs
Name
monitorGroupId
Type
Object ID
Description
Relation to Monitor Group ID Resource in which this object belongs
Name
statusPageGroup
Type
Status Page Group
Description
Does this monitor belong to a status page group? If so - which one is it?
Name
statusPageGroupId
Type
Object ID
Description
Does this monitor belong to a status page group?
Name
displayName
Type
TextRequired
Description
Display name of the monitor on the Status Page
Name
displayDescription
Type
Markdown
Description
Display description of the monitor on the Status Page. This is in markdown format.
Name
displayTooltip
Type
Long Text
Description
Tooltip of the monitor on the Status Page
Name
showCurrentStatus
Type
Boolean
Description
Show current status like offline, operational or degraded.
Name
showUptimePercent
Type
Boolean
Description
Show uptime percent of this monitor for the last 90 days
Name
uptimePercentPrecision
Type
Text
Description
Precision of uptime percent of this monitor for the last 90 days
Name
showStatusHistoryChart
Type
Boolean
Description
Show a 90 day uptime history of this monitor
Name
createdByUser
Type
User
Description
Relation to User who created this object (if this object was created by a User)
Name
createdByUserId
Type
Object ID
Description
User ID who created this object (if this object was created by a User)
Name
order
Type
Number
Description
Order / Priority of this resource

GETorPOST/api/status-page-resource/get-list

List

This endpoint allows you to retrieve a paginated list of all your Status Page Resource. By default, a maximum of ten Status Page Resource 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 Resource. 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-resource/get-list?skip=0&limit=10

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "select": {
    "displayName": true,
    "projectId": true,
    "statusPageId": true,
    "createdByUserId": true,
    "displayDescription": true
  },
  "query": {
    "displayName": "API Server"
  },
  "sort": {
    "createdAt": -1
  }
}

Response

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377cdc50-28fe-11f1-b591-3fdcef396aba",
      "displayName": "API Server",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "statusPageId": "f6a7b8c9-d0e1-2345-6789-abcdef012345",
      "createdByUserId": "d0e1f2a3-b4c5-6789-abcd-ef0123456789",
      "displayDescription": "Main API server handling all REST requests"
    },
    {
      "_id": "377cdc51-28fe-11f1-b591-3fdcef396aba",
      "displayName": "API Server",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "statusPageId": "f6a7b8c9-d0e1-2345-6789-abcdef012345",
      "createdByUserId": "d0e1f2a3-b4c5-6789-abcd-ef0123456789",
      "displayDescription": "Main API server handling all REST requests"
    },
    {
      "_id": "377cdc52-28fe-11f1-b591-3fdcef396aba",
      "displayName": "API Server",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "statusPageId": "f6a7b8c9-d0e1-2345-6789-abcdef012345",
      "createdByUserId": "d0e1f2a3-b4c5-6789-abcd-ef0123456789",
      "displayDescription": "Main API server handling all REST requests"
    }
  ]
}

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

Get item by ID

This endpoint allows you to retrieve Status Page Resource 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-resource/:id/get-item

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "select": {
    "displayName": true,
    "projectId": true,
    "statusPageId": true,
    "createdByUserId": true,
    "displayDescription": true
  }
}

Response

{
  "_id": "377cdc50-28fe-11f1-b591-3fdcef396aba",
  "displayName": "API Server",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "statusPageId": "f6a7b8c9-d0e1-2345-6789-abcdef012345",
  "createdByUserId": "d0e1f2a3-b4c5-6789-abcd-ef0123456789",
  "displayDescription": "Main API server handling all REST requests"
}

POST/api/status-page-resource/count

Count

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

Optional Request Body

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

Count Request

POST

/api/status-page-resource/count

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "query": {
    "displayName": "API Server"
  }
}

Response

{
  "count": 107
}

POST/api/status-page-resource

Create Status Page Resource

This endpoint allows you to create a new object.

Create Request

POST

/api/status-page-resource

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "data": {
    "displayName": "API Server",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "statusPageId": "f6a7b8c9-d0e1-2345-6789-abcdef012345",
    "createdByUserId": "d0e1f2a3-b4c5-6789-abcd-ef0123456789",
    "displayDescription": "Main API server handling all REST requests"
  }
}

Response

{
  "_id": "377cdc50-28fe-11f1-b591-3fdcef396aba",
  "displayName": "API Server",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "statusPageId": "f6a7b8c9-d0e1-2345-6789-abcdef012345",
  "createdByUserId": "d0e1f2a3-b4c5-6789-abcd-ef0123456789",
  "displayDescription": "Main API server handling all REST requests"
}

PUT/api/status-page-resource/: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-resource/:id/update-item

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

Update Request

PUT

/api/status-page-resource/:id

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "data": {
    "displayName": "API Server",
    "displayDescription": "Main API server handling all REST requests",
    "monitorGroupId": "b8c9d0e1-f2a3-4567-89ab-cdef01234567"
  }
}

Response

{}

DELETE/api/status-page-resource/: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-resource/:id/delete-item

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

Delete Request

DELETE

/api/status-page-resource/: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 Resource

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

Create Permissions

Required to create Status Page Resource

Project Owner
Project Admin
Project Member
Create Status Page Resource

Update Permissions

Required to update Status Page Resource

Project Owner
Project Admin
Project Member
Edit Status Page Resource

Delete Permissions

Required to delete Status Page Resource

Project Owner
Project Admin
Project Member
Delete Status Page Resource