export const metadata = {
title: "Uptime Checks - OnlineOrNot API Documentation",
description:
"Documentation for OnlineOrNot's Uptime Checks endpoints.",
}
## Create an uptime check {{ tag: 'POST', label: '/v1/checks/uptime' }}
*Create a new HTTP uptime check to monitor a URL*
### 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 Uptime Check|
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Validation error|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthenticated|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|
|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/checks/uptime \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--data '{"name":"My Website Check","url":"https://example.com","test_interval":60}'
```
```javascript
fetch("https://api.onlineornot.com/v1/checks/uptime", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
},
"body": "{\"name\":\"My Website Check\",\"url\":\"https://example.com\",\"test_interval\":60}"
})
.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 Website Check\",\"url\":\"https://example.com\",\"test_interval\":60}");
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/checks/uptime")
.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/checks/uptime');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
$request->setBody('{"name":"My Website Check","url":"https://example.com","test_interval":60}');
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/checks/uptime")
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 Website Check\",\"url\":\"https://example.com\",\"test_interval\":60}"
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/checks/uptime"
payload = {
"name": "My Website Check",
"url": "https://example.com",
"test_interval": 60
}
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 landing page",
"url": "https://example.com",
"last_queued": "2021-01-01T00:00:00.000Z",
"status": "UP",
"headers": {
"X-My-Header": "My Value"
},
"text_to_search_for": "string",
"reminder_alert_interval_minutes": 1440,
"confirmation_period_seconds": 60,
"recovery_period_seconds": 180,
"test_interval": 60,
"timeout": 10000,
"version": "NODE24_PLAYWRIGHT",
"script": "string",
"alert_priority": "HIGH",
"verify_ssl": true,
"method": "GET",
"body": "string",
"follow_redirects": true,
"assertions": [
{
"type": "JSON_BODY",
"property": "$.data.name",
"comparison": "EQUALS",
"expected": "John Doe"
}
],
"auth_username": "string",
"auth_password": "string",
"test_regions": [
"aws:us-east-1",
"aws:eu-central-1"
],
"user_alerts": [
"string"
],
"slack_alerts": [
"string"
],
"discord_alerts": [
"string"
],
"incident_io_alerts": [
"string"
],
"microsoft_teams_alerts": [
"string"
],
"telegram_alerts": [
"string"
],
"pushover_alerts": [
"string"
],
"oncall_alerts": [
"string"
],
"webhook_alerts": [
"string"
],
"check_type": "UPTIME"
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Retrieve an uptime check {{ tag: 'GET', label: '/v1/checks/uptime/{check_id}' }}
*Look up detailed information about a specific uptime check*
### Security: Bearer Auth
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: `Authorization: Bearer 123`
|Status|Meaning|Description|
|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Retrieve the specified OnlineOrNot Uptime Check|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthenticated|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Uptime check 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/checks/uptime/a1b2c3d4 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/checks/uptime/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/checks/uptime/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/checks/uptime/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/checks/uptime/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/checks/uptime/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 landing page",
"url": "https://example.com",
"last_queued": "2021-01-01T00:00:00.000Z",
"status": "UP",
"headers": {
"X-My-Header": "My Value"
},
"text_to_search_for": "string",
"reminder_alert_interval_minutes": 1440,
"confirmation_period_seconds": 60,
"recovery_period_seconds": 180,
"test_interval": 60,
"timeout": 10000,
"version": "NODE24_PLAYWRIGHT",
"script": "string",
"alert_priority": "HIGH",
"verify_ssl": true,
"method": "GET",
"body": "string",
"follow_redirects": true,
"assertions": [
{
"type": "JSON_BODY",
"property": "$.data.name",
"comparison": "EQUALS",
"expected": "John Doe"
}
],
"auth_username": "string",
"auth_password": "string",
"test_regions": [
"aws:us-east-1",
"aws:eu-central-1"
],
"user_alerts": [
"string"
],
"slack_alerts": [
"string"
],
"discord_alerts": [
"string"
],
"incident_io_alerts": [
"string"
],
"microsoft_teams_alerts": [
"string"
],
"telegram_alerts": [
"string"
],
"pushover_alerts": [
"string"
],
"oncall_alerts": [
"string"
],
"webhook_alerts": [
"string"
],
"check_type": "UPTIME"
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Modify an uptime check {{ tag: 'PATCH', label: '/v1/checks/uptime/{check_id}' }}
*Modify the configuration of an existing uptime check*
### 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)|Modify an OnlineOrNot Uptime Check|
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Validation error|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthenticated|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Uptime check not found|
|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/checks/uptime/a1b2c3d4 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--data '{"name":"My monitor","test_interval":60,"test_regions":["aws:us-east-1","aws:eu-central-1"],"user_alerts":["string"],"slack_alerts":["string"],"discord_alerts":["string"],"incident_io_alerts":["string"],"microsoft_teams_alerts":["string"],"telegram_alerts":["string"],"pushover_alerts":["string"],"webhook_alerts":["string"],"oncall_alerts":["string"],"alert_priority":"LOW","confirmation_period_seconds":60,"recovery_period_seconds":180,"reminder_alert_interval_minutes":1440,"timeout":10000,"paused":false,"muted":false,"url":"https://example.com","text_to_search_for":"Example Domain","headers":{"X-My-Header":"My Value"},"method":"GET","body":"Hello World","follow_redirects":true,"assertions":[{"type":"JSON_BODY","property":"$.data.name","comparison":"EQUALS","expected":"John Doe"}],"verify_ssl":false,"auth_username":"username","auth_password":"password"}'
```
```javascript
fetch("https://api.onlineornot.com/v1/checks/uptime/a1b2c3d4", {
"method": "PATCH",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
},
"body": "{\"name\":\"My monitor\",\"test_interval\":60,\"test_regions\":[\"aws:us-east-1\",\"aws:eu-central-1\"],\"user_alerts\":[\"string\"],\"slack_alerts\":[\"string\"],\"discord_alerts\":[\"string\"],\"incident_io_alerts\":[\"string\"],\"microsoft_teams_alerts\":[\"string\"],\"telegram_alerts\":[\"string\"],\"pushover_alerts\":[\"string\"],\"webhook_alerts\":[\"string\"],\"oncall_alerts\":[\"string\"],\"alert_priority\":\"LOW\",\"confirmation_period_seconds\":60,\"recovery_period_seconds\":180,\"reminder_alert_interval_minutes\":1440,\"timeout\":10000,\"paused\":false,\"muted\":false,\"url\":\"https://example.com\",\"text_to_search_for\":\"Example Domain\",\"headers\":{\"X-My-Header\":\"My Value\"},\"method\":\"GET\",\"body\":\"Hello World\",\"follow_redirects\":true,\"assertions\":[{\"type\":\"JSON_BODY\",\"property\":\"$.data.name\",\"comparison\":\"EQUALS\",\"expected\":\"John Doe\"}],\"verify_ssl\":false,\"auth_username\":\"username\",\"auth_password\":\"password\"}"
})
.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 monitor\",\"test_interval\":60,\"test_regions\":[\"aws:us-east-1\",\"aws:eu-central-1\"],\"user_alerts\":[\"string\"],\"slack_alerts\":[\"string\"],\"discord_alerts\":[\"string\"],\"incident_io_alerts\":[\"string\"],\"microsoft_teams_alerts\":[\"string\"],\"telegram_alerts\":[\"string\"],\"pushover_alerts\":[\"string\"],\"webhook_alerts\":[\"string\"],\"oncall_alerts\":[\"string\"],\"alert_priority\":\"LOW\",\"confirmation_period_seconds\":60,\"recovery_period_seconds\":180,\"reminder_alert_interval_minutes\":1440,\"timeout\":10000,\"paused\":false,\"muted\":false,\"url\":\"https://example.com\",\"text_to_search_for\":\"Example Domain\",\"headers\":{\"X-My-Header\":\"My Value\"},\"method\":\"GET\",\"body\":\"Hello World\",\"follow_redirects\":true,\"assertions\":[{\"type\":\"JSON_BODY\",\"property\":\"$.data.name\",\"comparison\":\"EQUALS\",\"expected\":\"John Doe\"}],\"verify_ssl\":false,\"auth_username\":\"username\",\"auth_password\":\"password\"}");
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/checks/uptime/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/checks/uptime/a1b2c3d4');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
$request->setBody('{"name":"My monitor","test_interval":60,"test_regions":["aws:us-east-1","aws:eu-central-1"],"user_alerts":["string"],"slack_alerts":["string"],"discord_alerts":["string"],"incident_io_alerts":["string"],"microsoft_teams_alerts":["string"],"telegram_alerts":["string"],"pushover_alerts":["string"],"webhook_alerts":["string"],"oncall_alerts":["string"],"alert_priority":"LOW","confirmation_period_seconds":60,"recovery_period_seconds":180,"reminder_alert_interval_minutes":1440,"timeout":10000,"paused":false,"muted":false,"url":"https://example.com","text_to_search_for":"Example Domain","headers":{"X-My-Header":"My Value"},"method":"GET","body":"Hello World","follow_redirects":true,"assertions":[{"type":"JSON_BODY","property":"$.data.name","comparison":"EQUALS","expected":"John Doe"}],"verify_ssl":false,"auth_username":"username","auth_password":"password"}');
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/checks/uptime/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\":\"My monitor\",\"test_interval\":60,\"test_regions\":[\"aws:us-east-1\",\"aws:eu-central-1\"],\"user_alerts\":[\"string\"],\"slack_alerts\":[\"string\"],\"discord_alerts\":[\"string\"],\"incident_io_alerts\":[\"string\"],\"microsoft_teams_alerts\":[\"string\"],\"telegram_alerts\":[\"string\"],\"pushover_alerts\":[\"string\"],\"webhook_alerts\":[\"string\"],\"oncall_alerts\":[\"string\"],\"alert_priority\":\"LOW\",\"confirmation_period_seconds\":60,\"recovery_period_seconds\":180,\"reminder_alert_interval_minutes\":1440,\"timeout\":10000,\"paused\":false,\"muted\":false,\"url\":\"https://example.com\",\"text_to_search_for\":\"Example Domain\",\"headers\":{\"X-My-Header\":\"My Value\"},\"method\":\"GET\",\"body\":\"Hello World\",\"follow_redirects\":true,\"assertions\":[{\"type\":\"JSON_BODY\",\"property\":\"$.data.name\",\"comparison\":\"EQUALS\",\"expected\":\"John Doe\"}],\"verify_ssl\":false,\"auth_username\":\"username\",\"auth_password\":\"password\"}"
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/checks/uptime/a1b2c3d4"
payload = {
"name": "My monitor",
"test_interval": 60,
"test_regions": ["aws:us-east-1", "aws:eu-central-1"],
"user_alerts": ["string"],
"slack_alerts": ["string"],
"discord_alerts": ["string"],
"incident_io_alerts": ["string"],
"microsoft_teams_alerts": ["string"],
"telegram_alerts": ["string"],
"pushover_alerts": ["string"],
"webhook_alerts": ["string"],
"oncall_alerts": ["string"],
"alert_priority": "LOW",
"confirmation_period_seconds": 60,
"recovery_period_seconds": 180,
"reminder_alert_interval_minutes": 1440,
"timeout": 10000,
"paused": False,
"muted": False,
"url": "https://example.com",
"text_to_search_for": "Example Domain",
"headers": {"X-My-Header": "My Value"},
"method": "GET",
"body": "Hello World",
"follow_redirects": True,
"assertions": [
{
"type": "JSON_BODY",
"property": "$.data.name",
"comparison": "EQUALS",
"expected": "John Doe"
}
],
"verify_ssl": False,
"auth_username": "username",
"auth_password": "password"
}
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": "My landing page",
"url": "https://example.com",
"last_queued": "2021-01-01T00:00:00.000Z",
"status": "UP",
"headers": {
"X-My-Header": "My Value"
},
"text_to_search_for": "string",
"reminder_alert_interval_minutes": 1440,
"confirmation_period_seconds": 60,
"recovery_period_seconds": 180,
"test_interval": 60,
"timeout": 10000,
"version": "NODE24_PLAYWRIGHT",
"script": "string",
"alert_priority": "HIGH",
"verify_ssl": true,
"method": "GET",
"body": "string",
"follow_redirects": true,
"assertions": [
{
"type": "JSON_BODY",
"property": "$.data.name",
"comparison": "EQUALS",
"expected": "John Doe"
}
],
"auth_username": "string",
"auth_password": "string",
"test_regions": [
"aws:us-east-1",
"aws:eu-central-1"
],
"user_alerts": [
"string"
],
"slack_alerts": [
"string"
],
"discord_alerts": [
"string"
],
"incident_io_alerts": [
"string"
],
"microsoft_teams_alerts": [
"string"
],
"telegram_alerts": [
"string"
],
"pushover_alerts": [
"string"
],
"oncall_alerts": [
"string"
],
"webhook_alerts": [
"string"
],
"check_type": "UPTIME"
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Delete an uptime check {{ tag: 'DELETE', label: '/v1/checks/uptime/{check_id}' }}
*Permanently delete an uptime check*
### 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 Uptime Check's ID|
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Validation error|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthenticated|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Uptime check not found|
|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/checks/uptime/a1b2c3d4 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/checks/uptime/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/checks/uptime/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/checks/uptime/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/checks/uptime/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/checks/uptime/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": []
}
```
---
## List incidents for an uptime check {{ tag: 'GET', label: '/v1/checks/uptime/{check_id}/incidents' }}
*Review recent failures and recoveries for a specific uptime check*
### 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)|A page of incidents for the check|
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Invalid query parameters|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthenticated|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Check 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/checks/uptime/a1b2c3d4/incidents \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/checks/uptime/a1b2c3d4/incidents", {
"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/checks/uptime/a1b2c3d4/incidents")
.get()
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Bearer {access-token}")
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://api.onlineornot.com/v1/checks/uptime/a1b2c3d4/incidents');
$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/checks/uptime/a1b2c3d4/incidents")
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/checks/uptime/a1b2c3d4/incidents"
headers = {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("GET", url, headers=headers)
print(response.text)
```
```json {{ title: 'Response' }}
{
"success": true,
"result": [
{
"id": "string",
"check_id": "string",
"started_at": "2019-08-24T14:15:22Z",
"ended_at": "2019-08-24T14:15:22Z"
}
],
"result_info": {
"page": 0,
"per_page": 1,
"count": 0,
"total_count": 0
},
"errors": [
null
],
"messages": [
null
]
}
```
---
## List results for an uptime check {{ tag: 'GET', label: '/v1/checks/uptime/{check_id}/results' }}
*Review raw uptime check results over a bounded time range*
### 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)|A chronological page of raw check results|
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Invalid query parameters|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthenticated|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Check not found|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error|
|503|[Service Unavailable](https://tools.ietf.org/html/rfc7231#section-6.6.4)|Required result storage unavailable|
```bash {{ title: 'cURL' }}
curl --request GET \
--url 'https://api.onlineornot.com/v1/checks/uptime/a1b2c3d4/results?from=2026-08-25T10%3A00%3A00Z&to=2026-08-25T11%3A00%3A00Z' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/checks/uptime/a1b2c3d4/results?from=2026-08-25T10%3A00%3A00Z&to=2026-08-25T11%3A00%3A00Z", {
"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/checks/uptime/a1b2c3d4/results?from=2026-08-25T10%3A00%3A00Z&to=2026-08-25T11%3A00%3A00Z")
.get()
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Bearer {access-token}")
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://api.onlineornot.com/v1/checks/uptime/a1b2c3d4/results');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'from' => '2026-08-25T10:00:00Z',
'to' => '2026-08-25T11:00:00Z'
]);
$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/checks/uptime/a1b2c3d4/results?from=2026-08-25T10%3A00%3A00Z&to=2026-08-25T11%3A00%3A00Z")
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/checks/uptime/a1b2c3d4/results"
querystring = {"from":"2026-08-25T10:00:00Z","to":"2026-08-25T11:00:00Z"}
headers = {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)
```
```json {{ title: 'Response' }}
{
"success": true,
"result": {
"check_id": "string",
"check_type": "UPTIME",
"window": {
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
},
"results": [
{
"id": "string",
"checked_at": "2019-08-24T14:15:22Z",
"checked_from": "aws:us-east-1",
"passing": true,
"response_time_ms": 0,
"attempt_number": 0,
"is_final_attempt": true,
"dispatched_at_ms": 0,
"response_body": "string",
"body_availability": "AVAILABLE",
"response_code": 100,
"result_summary": "string",
"has_stored_response": true
}
],
"result_info": {
"page": 0,
"per_page": 1,
"count": 0,
"total_count": 0
}
},
"errors": [
null
],
"messages": [
null
]
}
```
---