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

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	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

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