POST/v1/status_pages/{status_page_id}/components

Create a component

Requires STATUS_PAGES:EDIT.

Header parameters

X-OnlineOrNot-Organisation:stringoptional
Public organization ID to select from an OAuth grant. Required for grants authorizing multiple organizations. Omit for single-organization grants and API tokens.

Path parameters

status_page_id:string
Status Page ID

Body parameters

name:string
a name for the component
status:stringoptional
Status of the component
Accepted values: "OPERATIONAL" | "MAJOR_OUTAGE" | "PARTIAL_OUTAGE" | "DEGRADED_PERFORMANCE" | "NO_IMPACT" | "MAINTENANCE"
Default: "OPERATIONAL"
display_uptime:booleanoptional
Show this component's uptime and historical incidents on the status page.
Default: true
display_metrics:booleanoptional
Show this component's response time metrics on the status page.
Default: true

Responses

StatusMeaningDescription
201CreatedReturns the newly created status page component
400Bad RequestInvalid request
401UnauthorizedMissing or invalid credentials
403ForbiddenInsufficient permissions
500Internal Server ErrorInternal Server Error

Response Schema

result:object
success:boolean
Whether the API call was successful
errors:object[]
messages:object[]

Request

POST
/v1/status_pages/{status_page_id}/components
curl --request POST \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/components \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Website","status":"MAJOR_OUTAGE","display_uptime":true,"display_metrics":true}'

Response

{
  "result": {
    "id": "a1b2c3d4",
    "name": "Website",
    "status": "MAJOR_OUTAGE",
    "display_uptime": true,
    "display_metrics": true,
    "created_at": "2021-01-01T00:00:00.000Z",
    "updated_at": "2021-02-01T00:00:00.000Z",
    "group_id": "a1b2c3d4",
    "sort_order": 0,
    "is_external_component": false
  },
  "success": true,
  "errors": [],
  "messages": []
}
GET/v1/status_pages/{status_page_id}/components

List all components

Requires STATUS_PAGES:READ.

Header parameters

X-OnlineOrNot-Organisation:stringoptional
Public organization ID to select from an OAuth grant. Required for grants authorizing multiple organizations. Omit for single-organization grants and API tokens.

Path parameters

status_page_id:string
Status Page ID

Query parameters

page:integeroptional
Page number of paginated results, starting at 1.
Default: 1
per_page:integeroptional
Number of items per page. Defaults to 20. Continue requesting subsequent pages until the accumulated item count reaches result_info.total_count or a page is empty.
Default: 20

Responses

StatusMeaningDescription
200OKReturns a list of components for a status page. May also return a canonical failure envelope with success: false at HTTP200.
400Bad RequestInvalid request
401UnauthorizedMissing or invalid credentials
403ForbiddenInsufficient permissions
500Internal Server ErrorInternal Server Error

Response Schema

success:boolean
false
result:null
errors:object[]
messages:[any]

Request

GET
/v1/status_pages/{status_page_id}/components
curl --request GET \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/components \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

Response

{
  "result": [
    {
      "id": "a1b2c3d4",
      "name": "Website",
      "status": "MAJOR_OUTAGE",
      "display_uptime": true,
      "display_metrics": true,
      "created_at": "2021-01-01T00:00:00.000Z",
      "updated_at": "2021-02-01T00:00:00.000Z",
      "group_id": "a1b2c3d4",
      "sort_order": 0,
      "is_external_component": false
    }
  ],
  "result_info": {
    "page": 1,
    "per_page": 20,
    "count": 1,
    "total_count": 1
  },
  "success": true,
  "errors": [],
  "messages": []
}
GET/v1/status_pages/{status_page_id}/components/{status_page_component_id}

Retrieve a component

Requires STATUS_PAGES:READ.

Header parameters

X-OnlineOrNot-Organisation:stringoptional
Public organization ID to select from an OAuth grant. Required for grants authorizing multiple organizations. Omit for single-organization grants and API tokens.

Path parameters

status_page_id:string
Status Page ID
status_page_component_id:string
Status Page Component ID

Responses

StatusMeaningDescription
200OKReturns a status page component
400Bad RequestInvalid request
401UnauthorizedMissing or invalid credentials
403ForbiddenInsufficient permissions
404Not FoundResource not available or request rejected
500Internal Server ErrorInternal Server Error

Response Schema

result:object
success:boolean
Whether the API call was successful
errors:object[]
messages:object[]

Request

GET
/v1/status_pages/{status_page_id}/components/{status_page_component_id}
curl --request GET \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/components/a1b2c3d4 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

Response

{
  "result": {
    "id": "a1b2c3d4",
    "name": "Website",
    "status": "MAJOR_OUTAGE",
    "display_uptime": true,
    "display_metrics": true,
    "created_at": "2021-01-01T00:00:00.000Z",
    "updated_at": "2021-02-01T00:00:00.000Z",
    "group_id": "a1b2c3d4",
    "sort_order": 0,
    "is_external_component": false
  },
  "success": true,
  "errors": [],
  "messages": []
}
PATCH/v1/status_pages/{status_page_id}/components/{status_page_component_id}

Update a component

Requires STATUS_PAGES:EDIT.

Header parameters

X-OnlineOrNot-Organisation:stringoptional
Public organization ID to select from an OAuth grant. Required for grants authorizing multiple organizations. Omit for single-organization grants and API tokens.

Path parameters

status_page_id:string
Status Page ID
status_page_component_id:string
Status Page Component ID

Body parameters

name:stringoptional
a name for the component
status:stringoptional
Status of the component
Accepted values: "OPERATIONAL" | "MAJOR_OUTAGE" | "PARTIAL_OUTAGE" | "DEGRADED_PERFORMANCE" | "NO_IMPACT" | "MAINTENANCE"
display_uptime:booleanoptional
Show this component's uptime and historical incidents on the status page.
display_metrics:booleanoptional
Show this component's response time metrics on the status page.
group_id:string | nulloptional
Component group ID to associate this component with. Set to null to remove from group.
check_ids:string[]optional
Array of uptime check IDs to associate with this component
heartbeat_id:string | nulloptional
Heartbeat ID to associate with this component. Set to null to remove.
override_status:booleanoptional
Override the automatic status from external status page. When true, status can be manually set.

Responses

StatusMeaningDescription
200OKReturns the updated status page component
400Bad RequestInvalid request
401UnauthorizedMissing or invalid credentials
403ForbiddenInsufficient permissions
404Not FoundResource not available or request rejected
500Internal Server ErrorInternal Server Error

Response Schema

result:object
success:boolean
Whether the API call was successful
errors:object[]
messages:object[]

Request

PATCH
/v1/status_pages/{status_page_id}/components/{status_page_component_id}
curl --request PATCH \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/components/a1b2c3d4 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Website","status":"MAJOR_OUTAGE","display_uptime":true,"display_metrics":true,"group_id":"a1b2c3d4","check_ids":["abc123","def456"],"heartbeat_id":"hb123456","override_status":false}'

Response

{
  "result": {
    "id": "a1b2c3d4",
    "name": "Website",
    "status": "MAJOR_OUTAGE",
    "display_uptime": true,
    "display_metrics": true,
    "created_at": "2021-01-01T00:00:00.000Z",
    "updated_at": "2021-02-01T00:00:00.000Z",
    "group_id": "a1b2c3d4",
    "sort_order": 0,
    "is_external_component": false
  },
  "success": true,
  "errors": [],
  "messages": []
}
DELETE/v1/status_pages/{status_page_id}/components/{status_page_component_id}

Delete a component

Requires STATUS_PAGES:EDIT.

Header parameters

X-OnlineOrNot-Organisation:stringoptional
Public organization ID to select from an OAuth grant. Required for grants authorizing multiple organizations. Omit for single-organization grants and API tokens.

Path parameters

status_page_id:string
Status Page ID
status_page_component_id:string
Status Page Component ID

Responses

StatusMeaningDescription
200OKReturns the deleted component's ID
400Bad RequestInvalid request
401UnauthorizedMissing or invalid credentials
403ForbiddenInsufficient permissions
404Not FoundResource not available or request rejected
500Internal Server ErrorInternal Server Error

Response Schema

result:object
success:boolean
Whether the API call was successful
errors:object[]
messages:object[]

Request

DELETE
/v1/status_pages/{status_page_id}/components/{status_page_component_id}
curl --request DELETE \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/components/a1b2c3d4 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

Response

{
  "result": {
    "id": "a1b2c3d4"
  },
  "success": true,
  "errors": [],
  "messages": []
}
PUT/v1/status_pages/{status_page_id}/components/sort-order

Update the sort order of ungrouped components

Requires STATUS_PAGES:EDIT.

Header parameters

X-OnlineOrNot-Organisation:stringoptional
Public organization ID to select from an OAuth grant. Required for grants authorizing multiple organizations. Omit for single-organization grants and API tokens.

Path parameters

status_page_id:string
Status Page ID

Body parameters

component_ids:string[]
Ordered list of ungrouped component IDs

Responses

StatusMeaningDescription
200OKSort order updated successfully
400Bad RequestInvalid request
401UnauthorizedMissing or invalid credentials
403ForbiddenInsufficient permissions
404Not FoundResource not available or request rejected
500Internal Server ErrorInternal Server Error

Response Schema

result:object
success:boolean
Whether the API call was successful
errors:object[]
messages:object[]

Request

PUT
/v1/status_pages/{status_page_id}/components/sort-order
curl --request PUT \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/components/sort-order \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"component_ids":["a1b2c3d4","e5f6g7h8"]}'

Response

{
  "result": {
    "message": "Sort order updated successfully"
  },
  "success": true,
  "errors": [],
  "messages": []
}

Was this page helpful?