Status Page Components - OnlineOrNot API Documentation

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

Required parameters

Name
status_page_id
Type
string
Description
Status Page ID
Name
» name
Type
string
Description
a name for the component

Optional parameters

Name
body
Type
object
Description
undefined
Name
» status
Type
string - enum
Description
Status of the component
Default: "OPERATIONAL"
Enum: "OPERATIONAL" "MAJOR_OUTAGE" "PARTIAL_OUTAGE" "DEGRADED_PERFORMANCE" "NO_IMPACT" "MAINTENANCE"
Name
» display_uptime
Type
boolean
Description
Show this component's uptime and historical incidents on the status page.
Default: true
Name
» display_metrics
Type
boolean
Description
Show this component's response time metrics on the status page.
Default: true

Body parameter

{
  "name": "Website",
  "status": "MAJOR_OUTAGE",
  "display_uptime": true,
  "display_metrics": true
}

Responses

Status	Meaning	Description
200	OK	Returns the newly created status page component
500	Internal Server Error	Internal Server Error

Response Schema

Status Code 200

Name	Type	Required	Description
» result	object	true	none
»» id	string	true	Status Page Component ID
»» name	string	true	a name for the component
»» status	string,null	true	Status of the component
»» display_uptime	boolean	true	Show this component's uptime and historical incidents on the status page.
»» display_metrics	boolean	true	Show this component's response time metrics on the status page.
»» created_at	string	true	When the component was created
»» updated_at	string	true	When the component was last updated
» success	boolean	true	Whether the API call was successful
» errors	[object]	true	none
»» code	number	true	none
»» message	string	true	none
»» type	string	false	none
» messages	[object]	true	none
»» code	number	true	none
»» message	string	true	none
»» type	string	false	none

Enumerated Values

Property	Value
status	OPERATIONAL
status	MAJOR_OUTAGE
status	PARTIAL_OUTAGE
status	DEGRADED_PERFORMANCE
status	NO_IMPACT
status	MAINTENANCE

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

Required parameters

Name
status_page_id
Type
string
Description
Status Page ID

Optional parameters

Name
page
Type
string
Description
Page number of paginated results.
Default: "1"
Name
per_page
Type
string
Description
Number of items per page.
Default: "20"

Responses

Status	Meaning	Description
200	OK	Returns a list of components for a status page
500	Internal Server Error	Internal Server Error

Response Schema

Status Code 200

Name	Type	Required	Description
» result	[object]	true	none
»» id	string	true	Status Page Component ID
»» name	string	true	a name for the component
»» status	string,null	true	Status of the component
»» display_uptime	boolean	true	Show this component's uptime and historical incidents on the status page.
»» display_metrics	boolean	true	Show this component's response time metrics on the status page.
»» created_at	string	true	When the component was created
»» updated_at	string	true	When the component was last updated
» result_info	object	true	none
»» page	number	true	Page number of paginated results.
»» per_page	number	true	Number of items per page.
»» count	number	true	Number of items on the current page.
»» total_count	number	true	Total number of items.
» success	boolean	true	Whether the API call was successful
» errors	[object]	true	none
»» code	number	true	none
»» message	string	true	none
»» type	string	false	none
» messages	[object]	true	none
»» code	number	true	none
»» message	string	true	none
»» type	string	false	none

Enumerated Values

Property	Value
status	OPERATIONAL
status	MAJOR_OUTAGE
status	PARTIAL_OUTAGE
status	DEGRADED_PERFORMANCE
status	NO_IMPACT
status	MAINTENANCE

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

Required parameters

Name
status_page_id
Type
string
Description
Status Page ID
Name
status_page_component_id
Type
string
Description
Status Page Component ID

Responses

Status	Meaning	Description
200	OK	Returns a status page component
500	Internal Server Error	Internal Server Error

Response Schema

Status Code 200

Name	Type	Required	Description
» result	object	true	none
»» id	string	true	Status Page Component ID
»» name	string	true	a name for the component
»» status	string,null	true	Status of the component
»» display_uptime	boolean	true	Show this component's uptime and historical incidents on the status page.
»» display_metrics	boolean	true	Show this component's response time metrics on the status page.
»» created_at	string	true	When the component was created
»» updated_at	string	true	When the component was last updated
» success	boolean	true	Whether the API call was successful
» errors	[object]	true	none
»» code	number	true	none
»» message	string	true	none
»» type	string	false	none
» messages	[object]	true	none
»» code	number	true	none
»» message	string	true	none
»» type	string	false	none

Enumerated Values

Property	Value
status	OPERATIONAL
status	MAJOR_OUTAGE
status	PARTIAL_OUTAGE
status	DEGRADED_PERFORMANCE
status	NO_IMPACT
status	MAINTENANCE

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

Required parameters

Name
status_page_id
Type
string
Description
Status Page ID
Name
status_page_component_id
Type
string
Description
Status Page Component ID
Name
» name
Type
string
Description
a name for the component

Optional parameters

Name
body
Type
object
Description
undefined
Name
» status
Type
string - enum
Description
Status of the component
Default: "OPERATIONAL"
Enum: "OPERATIONAL" "MAJOR_OUTAGE" "PARTIAL_OUTAGE" "DEGRADED_PERFORMANCE" "NO_IMPACT" "MAINTENANCE"
Name
» display_uptime
Type
boolean
Description
Show this component's uptime and historical incidents on the status page.
Default: true
Name
» display_metrics
Type
boolean
Description
Show this component's response time metrics on the status page.
Default: true

Body parameter

{
  "name": "Website",
  "status": "MAJOR_OUTAGE",
  "display_uptime": true,
  "display_metrics": true
}

Responses

Status	Meaning	Description
200	OK	Returns the updated status page component
500	Internal Server Error	Internal Server Error

Response Schema

Status Code 200

Name	Type	Required	Description
» result	object	true	none
»» id	string	true	Status Page Component ID
»» name	string	true	a name for the component
»» status	string,null	true	Status of the component
»» display_uptime	boolean	true	Show this component's uptime and historical incidents on the status page.
»» display_metrics	boolean	true	Show this component's response time metrics on the status page.
»» created_at	string	true	When the component was created
»» updated_at	string	true	When the component was last updated
» success	boolean	true	Whether the API call was successful
» errors	[object]	true	none
»» code	number	true	none
»» message	string	true	none
»» type	string	false	none
» messages	[object]	true	none
»» code	number	true	none
»» message	string	true	none
»» type	string	false	none

Enumerated Values

Property	Value
status	OPERATIONAL
status	MAJOR_OUTAGE
status	PARTIAL_OUTAGE
status	DEGRADED_PERFORMANCE
status	NO_IMPACT
status	MAINTENANCE

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

Required parameters

Name
status_page_id
Type
string
Description
Status Page ID
Name
status_page_component_id
Type
string
Description
Status Page Component ID

Responses

Status	Meaning	Description
200	OK	Returns the deleted component's ID
500	Internal Server Error	Internal Server Error

Response Schema

Status Code 200

Name	Type	Required	Description
» result	object	true	none
»» id	string	true	Status Page Component ID
» success	boolean	true	Whether the API call was successful
» errors	[object]	true	none
»» code	number	true	none
»» message	string	true	none
»» type	string	false	none
» messages	[object]	true	none
»» code	number	true	none
»» message	string	true	none
»» type	string	false	none

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