Status Pages - OnlineOrNot API Documentation

GET/v1/status_pages/{status_page_id}

Retrieve a status page

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

Responses

Status	Meaning	Description
200	OK	Retrieve the specified OnlineOrNot 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 ID
»» name	string	true	Name of the Status Page
»» subdomain	string	true	The subdomain your status page will be hosted at. For example "status" would become "status.yourdomain.com"
»» custom_domain	string(uri)	false	The custom domain your status page is hosted at. For example "https://status.yourdomain.com"
» 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

GET

/v1/status_pages/{status_page_id}

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

Response

{
  "result": {
    "id": "a1b2c3d4",
    "name": "My Example SaaS",
    "subdomain": "status",
    "custom_domain": "https://status.yourdomain.com"
  },
  "success": true,
  "errors": [],
  "messages": []
}

POST/v1/status_pages/{status_page_id}

Update a status page

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
Name of the Status Page
Name
» subdomain
Type
string
Description
The subdomain your status page will be hosted at. For example "status" would become "status.onlineornot.com"

Optional parameters

Name
body
Type
object
Description
undefined
Name
» custom_domain
Type
string(uri)
Description
The custom domain your status page is hosted at.
Name
» password
Type
string
Description
The password that will be required to view your status page

Body parameter

{
  "name": "My Example SaaS",
  "subdomain": "status",
  "custom_domain": "https://status.yourdomain.com",
  "password": "string"
}

Responses

Status	Meaning	Description
200	OK	Update an existing OnlineOrNot 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 ID
»» name	string	true	Name of the Status Page
»» subdomain	string	true	The subdomain your status page will be hosted at. For example "status" would become "status.yourdomain.com"
»» custom_domain	string(uri)	false	The custom domain your status page is hosted at. For example "https://status.yourdomain.com"
» 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

POST

/v1/status_pages/{status_page_id}

curl --request POST \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"name":"My Example SaaS","subdomain":"status","custom_domain":"https://status.yourdomain.com","password":"string"}'

Response

{
  "result": {
    "id": "a1b2c3d4",
    "name": "My Example SaaS",
    "subdomain": "status",
    "custom_domain": "https://status.yourdomain.com"
  },
  "success": true,
  "errors": [],
  "messages": []
}

DELETE/v1/status_pages/{status_page_id}

Delete a status page

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

Responses

Status	Meaning	Description
200	OK	Returns the deleted OnlineOrNot Check'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 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}

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

Response

{
  "result": {
    "id": "a1b2c3d4"
  },
  "success": true,
  "errors": [],
  "messages": []
}

GET/v1/status_pages/{status_page_subdomain}/summary

Get a status page's summary of its overall status, components, active incidents, and scheduled maintenance.

This operation does not require authentication

Required parameters

Name
status_page_subdomain
Type
string
Description
The subdomain part of a status page's URL

Responses

Status	Meaning	Description
200	OK	Retrieve the specified OnlineOrNot status page summary
404	Not Found	Not found
500	Internal Server Error	Internal Server Error

Response Schema

Status Code 200

Name	Type	Required	Description
» result	object	true	none
»» status	object	true	none
»»» description	string	true	The overall system's current status
»» status_page	object	true	none
»»» id	string	true	Status Page ID
»»» name	string	true	Name of the Status Page
»»» subdomain	string	true	The subdomain your status page will be hosted at. For example "status" would become "status.yourdomain.com"
»»» custom_domain	string(uri)	false	The custom domain your status page is hosted at. For example "https://status.yourdomain.com"
»» components	[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
»»» group_id	string	true	Status Page Group ID
»» active_incidents	[object]	true	none
»»» id	string	true	Status Page Incident ID
»»» title	string	true	a title for the incident
»»» impact	string,null	true	Impact of the incident
»»» started	string	true	When the incident started
»»» ended	string	false	When the incident was resolved
»»» created_at	string	true	When the incident was created
»»» updated_at	string	true	When the incident was last updated
»» scheduled_maintenance	[object]	true	none
»»» id	string	true	Status Page Incident ID
»»» title	string	true	a title for the incident
»»» impact	string,null	true	Impact of the incident
»»» started	string	true	When the incident started
»»» ended	string	false	When the incident was resolved
»»» created_at	string	true	When the incident was created
»»» updated_at	string	true	When the incident was last updated
»»» start_date	string	true	When the scheduled maintenance is expected to start
»»» duration_minutes	integer	true	How long (in minutes) the scheduled maintenance should be displayed on your status page before being resolved automatically
» 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
description	Major System Outage
description	Minor Service Outage
description	Partially Degraded Service
description	Service Under Maintenance
description	All Systems Operational
status	OPERATIONAL
status	MAJOR_OUTAGE
status	PARTIAL_OUTAGE
status	DEGRADED_PERFORMANCE
status	NO_IMPACT
status	MAINTENANCE
impact	MAJOR_OUTAGE
impact	PARTIAL_OUTAGE
impact	DEGRADED_PERFORMANCE
impact	NO_IMPACT
impact	MAINTENANCE
impact	MAJOR_OUTAGE
impact	PARTIAL_OUTAGE
impact	DEGRADED_PERFORMANCE
impact	NO_IMPACT
impact	MAINTENANCE

Request

GET

/v1/status_pages/{status_page_subdomain}/summary

curl --request GET \
  --url https://api.onlineornot.com/v1/status_pages/hackernews/summary \
  --header 'Accept: application/json'

Response

{
  "result": {
    "status": {
      "description": "All Systems Operational"
    },
    "status_page": {
      "id": "a1b2c3d4",
      "name": "My Example SaaS",
      "subdomain": "status",
      "custom_domain": "https://status.yourdomain.com"
    },
    "components": [
      {
        "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"
      }
    ],
    "active_incidents": [
      {
        "id": "a1b2c3d4",
        "title": "API is inaccessible",
        "impact": "MAJOR_OUTAGE",
        "started": "2021-01-01T00:00:00.000Z",
        "ended": "2021-02-01T00:00:00.000Z",
        "created_at": "2021-01-01T00:00:00.000Z",
        "updated_at": "2021-02-01T00:00:00.000Z"
      }
    ],
    "scheduled_maintenance": [
      {
        "id": "a1b2c3d4",
        "title": "API is inaccessible",
        "impact": "MAJOR_OUTAGE",
        "started": "2021-01-01T00:00:00.000Z",
        "ended": "2021-02-01T00:00:00.000Z",
        "created_at": "2021-01-01T00:00:00.000Z",
        "updated_at": "2021-02-01T00:00:00.000Z",
        "start_date": "2021-01-01T00:00:00.000Z",
        "duration_minutes": 60
      }
    ]
  },
  "success": true,
  "errors": [],
  "messages": []
}

POST/v1/status_pages

Create a status page

Security: Bearer Auth

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

Example: Authorization: Bearer 123

Required parameters

Name
» name
Type
string
Description
Name of the Status Page
Name
» subdomain
Type
string
Description
The subdomain your status page will be hosted at. For example "status" would become "status.onlineornot.com"

Optional parameters

Name
body
Type
object
Description
undefined
Name
» custom_domain
Type
string(uri)
Description
The custom domain your status page is hosted at.
Name
» password
Type
string
Description
The password that will be required to view your status page

Body parameter

{
  "name": "My Example SaaS",
  "subdomain": "status",
  "custom_domain": "https://status.yourdomain.com",
  "password": "string"
}

Responses

Status	Meaning	Description
200	OK	Create a new OnlineOrNot 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 ID
»» name	string	true	Name of the Status Page
»» subdomain	string	true	The subdomain your status page will be hosted at. For example "status" would become "status.yourdomain.com"
»» custom_domain	string(uri)	false	The custom domain your status page is hosted at. For example "https://status.yourdomain.com"
» 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

POST

/v1/status_pages

curl --request POST \
  --url https://api.onlineornot.com/v1/status_pages \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"name":"My Example SaaS","subdomain":"status","custom_domain":"https://status.yourdomain.com","password":"string"}'

Response

{
  "result": {
    "id": "a1b2c3d4",
    "name": "My Example SaaS",
    "subdomain": "status",
    "custom_domain": "https://status.yourdomain.com"
  },
  "success": true,
  "errors": [],
  "messages": []
}

GET/v1/status_pages

List all status pages

Security: Bearer Auth

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

Example: Authorization: Bearer 123

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 OnlineOrNot Status Pages
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 ID
»» name	string	true	Name of the Status Page
»» subdomain	string	true	The subdomain your status page will be hosted at. For example "status" would become "status.yourdomain.com"
»» custom_domain	string(uri)	false	The custom domain your status page is hosted at. For example "https://status.yourdomain.com"
» result_info	object	true	none
»» page	number	false	Page number of paginated results.
»» per_page	number	false	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

Request

GET

/v1/status_pages

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

Response

{
  "result": [
    {
      "id": "a1b2c3d4",
      "name": "My Example SaaS",
      "subdomain": "status",
      "custom_domain": "https://status.yourdomain.com"
    }
  ],
  "result_info": {
    "page": 1,
    "per_page": 20,
    "count": 1,
    "total_count": 1
  },
  "success": true,
  "errors": [],
  "messages": []
}