POST/v1/status_pages/{status_page_id}/components

Create a component

Security: Bearer Auth

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

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
200OKReturns the newly created status page component
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"
  },
  "success": true,
  "errors": [],
  "messages": []
}
GET/v1/status_pages/{status_page_id}/components

List all components

Security: Bearer Auth

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Path parameters

status_page_id:string
Status Page ID

Query parameters

page:stringoptional
Page number of paginated results.
Default: "1"
per_page:stringoptional
Number of items per page.
Default: "20"

Responses

StatusMeaningDescription
200OKReturns a list of components for a status page
500Internal Server ErrorInternal Server Error

Response Schema

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

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"
    }
  ],
  "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

Security: Bearer Auth

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

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
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"
  },
  "success": true,
  "errors": [],
  "messages": []
}
POST/v1/status_pages/{status_page_id}/components/{status_page_component_id}

Update a component

Security: Bearer Auth

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Path parameters

status_page_id:string
Status Page ID
status_page_component_id:string
Status Page Component 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
200OKReturns the updated status page component
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/{status_page_component_id}
curl --request POST \
  --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}'

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"
  },
  "success": true,
  "errors": [],
  "messages": []
}
DELETE/v1/status_pages/{status_page_id}/components/{status_page_component_id}

Delete a component

Security: Bearer Auth

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

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
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": []
}

Was this page helpful?