export const metadata = {
title: "Status Page Components - OnlineOrNot API Documentation",
description:
"Add and manage individual service components displayed on status pages",
}
## Create a component {{ tag: 'POST', label: '/v1/status_pages/{status_page_id}/components' }}
### 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)|Returns the newly created status page component|
|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/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}'
```
```javascript
fetch("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/components", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
},
"body": "{\"name\":\"Website\",\"status\":\"MAJOR_OUTAGE\",\"display_uptime\":true,\"display_metrics\":true}"
})
.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\":\"Website\",\"status\":\"MAJOR_OUTAGE\",\"display_uptime\":true,\"display_metrics\":true}");
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/components")
.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/components');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
$request->setBody('{"name":"Website","status":"MAJOR_OUTAGE","display_uptime":true,"display_metrics":true}');
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/components")
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\":\"Website\",\"status\":\"MAJOR_OUTAGE\",\"display_uptime\":true,\"display_metrics\":true}"
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/status_pages/a1b2c3d4/components"
payload = {
"name": "Website",
"status": "MAJOR_OUTAGE",
"display_uptime": True,
"display_metrics": True
}
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": "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
},
"success": true,
"errors": [],
"messages": []
}
```
---
## List all components {{ tag: 'GET', label: '/v1/status_pages/{status_page_id}/components' }}
### 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 components for a 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/components \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/components", {
"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/components")
.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/components');
$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/components")
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/components"
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": "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
}
],
"result_info": {
"page": 1,
"per_page": 20,
"count": 1,
"total_count": 1
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Retrieve a component {{ tag: 'GET', label: '/v1/status_pages/{status_page_id}/components/{status_page_component_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 a status page component|
|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/components/a1b2c3d4 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/components/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/components/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/components/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/components/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/components/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": "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
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Update a component {{ tag: 'PATCH', label: '/v1/status_pages/{status_page_id}/components/{status_page_component_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 updated status page component|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal Server Error|
```bash {{ title: 'cURL' }}
curl --request PATCH \
--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,"group_id":"a1b2c3d4","check_ids":["abc123","def456"],"heartbeat_id":"hb123456","override_status":false}'
```
```javascript
fetch("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/components/a1b2c3d4", {
"method": "PATCH",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
},
"body": "{\"name\":\"Website\",\"status\":\"MAJOR_OUTAGE\",\"display_uptime\":true,\"display_metrics\":true,\"group_id\":\"a1b2c3d4\",\"check_ids\":[\"abc123\",\"def456\"],\"heartbeat_id\":\"hb123456\",\"override_status\":false}"
})
.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\":\"Website\",\"status\":\"MAJOR_OUTAGE\",\"display_uptime\":true,\"display_metrics\":true,\"group_id\":\"a1b2c3d4\",\"check_ids\":[\"abc123\",\"def456\"],\"heartbeat_id\":\"hb123456\",\"override_status\":false}");
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/components/a1b2c3d4")
.patch(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/components/a1b2c3d4');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
$request->setBody('{"name":"Website","status":"MAJOR_OUTAGE","display_uptime":true,"display_metrics":true,"group_id":"a1b2c3d4","check_ids":["abc123","def456"],"heartbeat_id":"hb123456","override_status":false}');
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/components/a1b2c3d4")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Authorization"] = 'Bearer {access-token}'
request.body = "{\"name\":\"Website\",\"status\":\"MAJOR_OUTAGE\",\"display_uptime\":true,\"display_metrics\":true,\"group_id\":\"a1b2c3d4\",\"check_ids\":[\"abc123\",\"def456\"],\"heartbeat_id\":\"hb123456\",\"override_status\":false}"
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/status_pages/a1b2c3d4/components/a1b2c3d4"
payload = {
"name": "Website",
"status": "MAJOR_OUTAGE",
"display_uptime": True,
"display_metrics": True,
"group_id": "a1b2c3d4",
"check_ids": ["abc123", "def456"],
"heartbeat_id": "hb123456",
"override_status": False
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("PATCH", url, json=payload, headers=headers)
print(response.text)
```
```json {{ title: '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",
"is_external_component": false
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Delete a component {{ tag: 'DELETE', label: '/v1/status_pages/{status_page_id}/components/{status_page_component_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 component'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/components/a1b2c3d4 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/components/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/components/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/components/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/components/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/components/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": []
}
```
---
## Update the sort order of ungrouped components {{ tag: 'PUT', label: '/v1/status_pages/{status_page_id}/components/sort-order' }}
### 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)|Sort order updated successfully|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal Server Error|
```bash {{ title: 'cURL' }}
curl --request PUT \
--url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/components/sort-order \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--data '{"component_ids":["a1b2c3d4","e5f6g7h8"]}'
```
```javascript
fetch("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/components/sort-order", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
},
"body": "{\"component_ids\":[\"a1b2c3d4\",\"e5f6g7h8\"]}"
})
.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, "{\"component_ids\":[\"a1b2c3d4\",\"e5f6g7h8\"]}");
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/status_pages/a1b2c3d4/components/sort-order")
.put(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/components/sort-order');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
$request->setBody('{"component_ids":["a1b2c3d4","e5f6g7h8"]}');
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/components/sort-order")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Authorization"] = 'Bearer {access-token}'
request.body = "{\"component_ids\":[\"a1b2c3d4\",\"e5f6g7h8\"]}"
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/status_pages/a1b2c3d4/components/sort-order"
payload = {"component_ids": ["a1b2c3d4", "e5f6g7h8"]}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("PUT", url, json=payload, headers=headers)
print(response.text)
```
```json {{ title: 'Response' }}
{
"result": {
"message": "Sort order updated successfully"
},
"success": true,
"errors": [],
"messages": []
}
```
---