export const metadata = {
title: "Status Pages - OnlineOrNot API Documentation",
description:
"Create and manage public status pages for communicating service health",
}
## Retrieve a status page {{ tag: 'GET', label: '/v1/status_pages/{status_page_id}' }}
### Security: Bearer Auth
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: `Authorization: Bearer 123`
Responses
|Status|Meaning|Description|
|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Retrieve the specified OnlineOrNot Status Page|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal Server Error|
```bash {{ title: 'cURL' }}
curl --request GET \
--url https://api.onlineornot.com/v1/status_pages/a1b2c3d4 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/status_pages/a1b2c3d4", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
```
```java
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/status_pages/a1b2c3d4")
.get()
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Bearer {access-token}")
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://api.onlineornot.com/v1/status_pages/a1b2c3d4');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
```
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.onlineornot.com/v1/status_pages/a1b2c3d4")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Authorization"] = 'Bearer {access-token}'
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/status_pages/a1b2c3d4"
headers = {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("GET", url, headers=headers)
print(response.text)
```
```json {{ title: 'Response' }}
{
"result": {
"id": "a1b2c3d4",
"name": "My Example SaaS",
"subdomain": "status",
"custom_domain": "https://status.yourdomain.com",
"status": "ALL_SYSTEMS_OPERATIONAL",
"favicon_url": "https://example.com/favicon.ico",
"logo_url": "https://example.com/logo.png",
"dark_logo_url": "https://example.com/logo-dark.png",
"description": "Real-time status updates for My Example SaaS",
"hide_from_search_engines": false,
"has_password": false,
"allowed_ips": [
"192.168.1.1",
"10.0.0.0/8"
]
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Update a status page {{ tag: 'POST', label: '/v1/status_pages/{status_page_id}' }}
### Security: Bearer Auth
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: `Authorization: Bearer 123`
Responses
|Status|Meaning|Description|
|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Update an existing OnlineOrNot Status Page|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal Server Error|
```bash {{ title: 'cURL' }}
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","description":"Real-time status updates for My Example SaaS","hide_from_search_engines":false,"allowed_ips":["192.168.1.1","10.0.0.0/8"]}'
```
```javascript
fetch("https://api.onlineornot.com/v1/status_pages/a1b2c3d4", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
},
"body": "{\"name\":\"My Example SaaS\",\"subdomain\":\"status\",\"custom_domain\":\"https://status.yourdomain.com\",\"password\":\"string\",\"description\":\"Real-time status updates for My Example SaaS\",\"hide_from_search_engines\":false,\"allowed_ips\":[\"192.168.1.1\",\"10.0.0.0/8\"]}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
```
```java
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"name\":\"My Example SaaS\",\"subdomain\":\"status\",\"custom_domain\":\"https://status.yourdomain.com\",\"password\":\"string\",\"description\":\"Real-time status updates for My Example SaaS\",\"hide_from_search_engines\":false,\"allowed_ips\":[\"192.168.1.1\",\"10.0.0.0/8\"]}");
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/status_pages/a1b2c3d4")
.post(body)
.addHeader("Content-Type", "application/json")
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Bearer {access-token}")
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://api.onlineornot.com/v1/status_pages/a1b2c3d4');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
$request->setBody('{"name":"My Example SaaS","subdomain":"status","custom_domain":"https://status.yourdomain.com","password":"string","description":"Real-time status updates for My Example SaaS","hide_from_search_engines":false,"allowed_ips":["192.168.1.1","10.0.0.0/8"]}');
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
```
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.onlineornot.com/v1/status_pages/a1b2c3d4")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Authorization"] = 'Bearer {access-token}'
request.body = "{\"name\":\"My Example SaaS\",\"subdomain\":\"status\",\"custom_domain\":\"https://status.yourdomain.com\",\"password\":\"string\",\"description\":\"Real-time status updates for My Example SaaS\",\"hide_from_search_engines\":false,\"allowed_ips\":[\"192.168.1.1\",\"10.0.0.0/8\"]}"
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/status_pages/a1b2c3d4"
payload = {
"name": "My Example SaaS",
"subdomain": "status",
"custom_domain": "https://status.yourdomain.com",
"password": "string",
"description": "Real-time status updates for My Example SaaS",
"hide_from_search_engines": False,
"allowed_ips": ["192.168.1.1", "10.0.0.0/8"]
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("POST", url, json=payload, headers=headers)
print(response.text)
```
```json {{ title: 'Response' }}
{
"result": {
"id": "a1b2c3d4",
"name": "My Example SaaS",
"subdomain": "status",
"custom_domain": "https://status.yourdomain.com",
"status": "ALL_SYSTEMS_OPERATIONAL",
"favicon_url": "https://example.com/favicon.ico",
"logo_url": "https://example.com/logo.png",
"dark_logo_url": "https://example.com/logo-dark.png",
"description": "Real-time status updates for My Example SaaS",
"hide_from_search_engines": false,
"has_password": false,
"allowed_ips": [
"192.168.1.1",
"10.0.0.0/8"
]
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Delete a status page {{ tag: 'DELETE', label: '/v1/status_pages/{status_page_id}' }}
### Security: Bearer Auth
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: `Authorization: Bearer 123`
Responses
|Status|Meaning|Description|
|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Returns the deleted OnlineOrNot Check's ID|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal Server Error|
```bash {{ title: 'cURL' }}
curl --request DELETE \
--url https://api.onlineornot.com/v1/status_pages/a1b2c3d4 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/status_pages/a1b2c3d4", {
"method": "DELETE",
"headers": {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
```
```java
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/status_pages/a1b2c3d4")
.delete(null)
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Bearer {access-token}")
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://api.onlineornot.com/v1/status_pages/a1b2c3d4');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
```
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.onlineornot.com/v1/status_pages/a1b2c3d4")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Delete.new(url)
request["Accept"] = 'application/json'
request["Authorization"] = 'Bearer {access-token}'
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/status_pages/a1b2c3d4"
headers = {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("DELETE", url, headers=headers)
print(response.text)
```
```json {{ title: 'Response' }}
{
"result": {
"id": "a1b2c3d4"
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Get a status page's overview. {{ tag: 'GET', label: '/v1/status_pages/{status_page_subdomain}/summary' }}
This operation does not require authentication
Responses
|Status|Meaning|Description|
|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Retrieve the specified OnlineOrNot status page summary|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal Server Error|
```bash {{ title: 'cURL' }}
curl --request GET \
--url https://api.onlineornot.com/v1/status_pages/hackernews/summary \
--header 'Accept: application/json'
```
```javascript
fetch("https://api.onlineornot.com/v1/status_pages/hackernews/summary", {
"method": "GET",
"headers": {
"Accept": "application/json"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
```
```java
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/status_pages/hackernews/summary")
.get()
.addHeader("Accept", "application/json")
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://api.onlineornot.com/v1/status_pages/hackernews/summary');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'Accept' => 'application/json'
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
```
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.onlineornot.com/v1/status_pages/hackernews/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/status_pages/hackernews/summary"
headers = {"Accept": "application/json"}
response = requests.request("GET", url, headers=headers)
print(response.text)
```
```json {{ title: 'Response' }}
{
"result": {
"status": {
"description": "All Systems Operational"
},
"status_page": {
"id": "a1b2c3d4",
"name": "My Example SaaS",
"subdomain": "status",
"custom_domain": "https://status.yourdomain.com",
"status": "ALL_SYSTEMS_OPERATIONAL",
"favicon_url": "https://example.com/favicon.ico",
"logo_url": "https://example.com/logo.png",
"dark_logo_url": "https://example.com/logo-dark.png",
"description": "Real-time status updates for My Example SaaS",
"hide_from_search_engines": false,
"has_password": false,
"allowed_ips": [
"192.168.1.1",
"10.0.0.0/8"
]
},
"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",
"is_external_component": false
}
],
"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,
"notifications": {
"an_hour_before": false,
"at_start": true,
"at_end": true
},
"components": [
{
"id": "comp123",
"name": "API Server"
}
]
}
]
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Create a status page {{ tag: 'POST', label: '/v1/status_pages' }}
### Security: Bearer Auth
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: `Authorization: Bearer 123`
Responses
|Status|Meaning|Description|
|---|---|---|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Create a new OnlineOrNot Status Page|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal Server Error|
```bash {{ title: 'cURL' }}
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","description":"Real-time status updates for My Example SaaS","hide_from_search_engines":false,"allowed_ips":["192.168.1.1","10.0.0.0/8"]}'
```
```javascript
fetch("https://api.onlineornot.com/v1/status_pages", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
},
"body": "{\"name\":\"My Example SaaS\",\"subdomain\":\"status\",\"custom_domain\":\"https://status.yourdomain.com\",\"password\":\"string\",\"description\":\"Real-time status updates for My Example SaaS\",\"hide_from_search_engines\":false,\"allowed_ips\":[\"192.168.1.1\",\"10.0.0.0/8\"]}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
```
```java
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"name\":\"My Example SaaS\",\"subdomain\":\"status\",\"custom_domain\":\"https://status.yourdomain.com\",\"password\":\"string\",\"description\":\"Real-time status updates for My Example SaaS\",\"hide_from_search_engines\":false,\"allowed_ips\":[\"192.168.1.1\",\"10.0.0.0/8\"]}");
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/status_pages")
.post(body)
.addHeader("Content-Type", "application/json")
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Bearer {access-token}")
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://api.onlineornot.com/v1/status_pages');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
$request->setBody('{"name":"My Example SaaS","subdomain":"status","custom_domain":"https://status.yourdomain.com","password":"string","description":"Real-time status updates for My Example SaaS","hide_from_search_engines":false,"allowed_ips":["192.168.1.1","10.0.0.0/8"]}');
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
```
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.onlineornot.com/v1/status_pages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Authorization"] = 'Bearer {access-token}'
request.body = "{\"name\":\"My Example SaaS\",\"subdomain\":\"status\",\"custom_domain\":\"https://status.yourdomain.com\",\"password\":\"string\",\"description\":\"Real-time status updates for My Example SaaS\",\"hide_from_search_engines\":false,\"allowed_ips\":[\"192.168.1.1\",\"10.0.0.0/8\"]}"
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/status_pages"
payload = {
"name": "My Example SaaS",
"subdomain": "status",
"custom_domain": "https://status.yourdomain.com",
"password": "string",
"description": "Real-time status updates for My Example SaaS",
"hide_from_search_engines": False,
"allowed_ips": ["192.168.1.1", "10.0.0.0/8"]
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("POST", url, json=payload, headers=headers)
print(response.text)
```
```json {{ title: 'Response' }}
{
"result": {
"id": "a1b2c3d4",
"name": "My Example SaaS",
"subdomain": "status",
"custom_domain": "https://status.yourdomain.com",
"status": "ALL_SYSTEMS_OPERATIONAL",
"favicon_url": "https://example.com/favicon.ico",
"logo_url": "https://example.com/logo.png",
"dark_logo_url": "https://example.com/logo-dark.png",
"description": "Real-time status updates for My Example SaaS",
"hide_from_search_engines": false,
"has_password": false,
"allowed_ips": [
"192.168.1.1",
"10.0.0.0/8"
]
},
"success": true,
"errors": [],
"messages": []
}
```
---
## List all status pages {{ tag: 'GET', label: '/v1/status_pages' }}
### Security: Bearer Auth
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: `Authorization: Bearer 123`
Responses
|Status|Meaning|Description|
|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Returns a list of OnlineOrNot Status Pages|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal Server Error|
```bash {{ title: 'cURL' }}
curl --request GET \
--url https://api.onlineornot.com/v1/status_pages \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/status_pages", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
```
```java
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/status_pages")
.get()
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Bearer {access-token}")
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://api.onlineornot.com/v1/status_pages');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
```
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.onlineornot.com/v1/status_pages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Authorization"] = 'Bearer {access-token}'
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/status_pages"
headers = {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("GET", url, headers=headers)
print(response.text)
```
```json {{ title: 'Response' }}
{
"result": [
{
"id": "a1b2c3d4",
"name": "My Example SaaS",
"subdomain": "status",
"custom_domain": "https://status.yourdomain.com",
"status": "ALL_SYSTEMS_OPERATIONAL",
"favicon_url": "https://example.com/favicon.ico",
"logo_url": "https://example.com/logo.png",
"dark_logo_url": "https://example.com/logo-dark.png",
"description": "Real-time status updates for My Example SaaS",
"hide_from_search_engines": false,
"has_password": false,
"allowed_ips": [
"192.168.1.1",
"10.0.0.0/8"
]
}
],
"result_info": {
"page": 1,
"per_page": 20,
"count": 1,
"total_count": 1
},
"success": true,
"errors": [],
"messages": []
}
```
---