export const metadata = {
title: "Checks - OnlineOrNot API Documentation",
description:
"Create and manage uptime checks, retrieve check results and status history",
}
## List all checks {{ tag: 'GET', label: '/v1/checks' }}
*Retrieve a paginated list of all uptime checks*
### 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 Checks|
|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 GET \
--url https://api.onlineornot.com/v1/checks \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/checks", {
"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")
.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');
$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")
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"
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",
"check_type": "UPTIME",
"last_queued": "2021-01-01T00:00:00.000Z",
"status": "UP",
"dns_domain": "example.com",
"dns_record_type": "A",
"dns_resolver": "8.8.8.8:53",
"dns_protocol": "UDP",
"tcp_hostname": "tcpbin.com",
"tcp_port": 4242,
"tcp_ip_family": "IPv4"
}
],
"result_info": {
"page": 1,
"per_page": 20,
"count": 1,
"total_count": 1
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Create a check {{ tag: 'POST', label: '/v1/checks' }}
*Create a new 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`
{\n await page.goto('https://example.com');\n await expect(page.locator('h1')).toContainText('Example');\n});","description":"Playwright Test script for scripted browser checks. Required for script-based checks, optional for URL-based checks."}},"required":["name"]},"name":"body","required":true,"exampleValues":{"object":{"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,"url":"https://example.com","text_to_search_for":"Example Domain","type":"UPTIME_CHECK","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"},{"type":"HTML_BODY","property":"meta[name=\"description\"]","comparison":"NOT_EMPTY","expected":""}],"verify_ssl":false,"auth_username":"username","auth_password":"password","version":"NODE24_PLAYWRIGHT","script":"import { test, expect } from '@playwright/test';\ntest('check homepage', async ({ page }) => {\n await page.goto('https://example.com');\n await expect(page.locator('h1')).toContainText('Example');\n});"},"json":"{\n \"name\": \"My monitor\",\n \"test_interval\": 60,\n \"test_regions\": [\n \"aws:us-east-1\",\n \"aws:eu-central-1\"\n ],\n \"user_alerts\": [\n \"string\"\n ],\n \"slack_alerts\": [\n \"string\"\n ],\n \"discord_alerts\": [\n \"string\"\n ],\n \"incident_io_alerts\": [\n \"string\"\n ],\n \"microsoft_teams_alerts\": [\n \"string\"\n ],\n \"telegram_alerts\": [\n \"string\"\n ],\n \"pushover_alerts\": [\n \"string\"\n ],\n \"webhook_alerts\": [\n \"string\"\n ],\n \"oncall_alerts\": [\n \"string\"\n ],\n \"alert_priority\": \"LOW\",\n \"confirmation_period_seconds\": 60,\n \"recovery_period_seconds\": 180,\n \"reminder_alert_interval_minutes\": 1440,\n \"timeout\": 10000,\n \"url\": \"https://example.com\",\n \"text_to_search_for\": \"Example Domain\",\n \"type\": \"UPTIME_CHECK\",\n \"headers\": {\n \"X-My-Header\": \"My Value\"\n },\n \"method\": \"GET\",\n \"body\": \"Hello World\",\n \"follow_redirects\": true,\n \"assertions\": [\n {\n \"type\": \"JSON_BODY\",\n \"property\": \"$.data.name\",\n \"comparison\": \"EQUALS\",\n \"expected\": \"John Doe\"\n },\n {\n \"type\": \"HTML_BODY\",\n \"property\": \"meta[name=\\\"description\\\"]\",\n \"comparison\": \"NOT_EMPTY\",\n \"expected\": \"\"\n }\n ],\n \"verify_ssl\": false,\n \"auth_username\": \"username\",\n \"auth_password\": \"password\",\n \"version\": \"NODE24_PLAYWRIGHT\",\n \"script\": \"import { test, expect } from '@playwright/test';\\ntest('check homepage', async ({ page }) => {\\n await page.goto('https://example.com');\\n await expect(page.locator('h1')).toContainText('Example');\\n});\"\n}"},"originalType":"object","safeType":"object"},{"in":"body","schema":{"type":"string","example":"My monitor","description":"Name of the monitor"},"name":"» name","required":true,"description":"Name of the monitor","safeType":"string","depth":1,"exampleValues":{"object":"My monitor","json":"'My monitor'"},"shortDesc":"Name of the monitor"},{"in":"body","schema":{"type":"integer","minimum":30,"example":60,"description":"Interval in seconds between checks"},"name":"» test_interval","required":false,"description":"Interval in seconds between checks","safeType":"integer","depth":1,"exampleValues":{"object":60,"json":"'60'"},"shortDesc":"Interval in seconds between checks"},{"in":"body","schema":{"type":"array","items":{"type":"string","description":"Region identifier in format aws:{region}"},"example":["aws:us-east-1","aws:eu-central-1"],"description":"Regions to run checks from. Valid regions: aws:us-east-1, aws:us-east-2, aws:us-west-1, aws:eu-central-1, aws:eu-west-2, aws:ap-south-1, aws:ap-southeast-2, aws:ap-northeast-1"},"name":"» test_regions","required":false,"description":"Regions to run checks from. Valid regions: aws:us-east-1, aws:us-east-2, aws:us-west-1, aws:eu-central-1, aws:eu-west-2, aws:ap-south-1, aws:ap-southeast-2, aws:ap-northeast-1","safeType":"string[]","depth":1,"exampleValues":{"object":["aws:us-east-1","aws:eu-central-1"],"json":"[\n \"aws:us-east-1\",\n \"aws:eu-central-1\"\n]"},"shortDesc":"Regions to run checks from. Valid regions: aws:us-east-1, aws:us-east-2, aws:us-west-1, aws:eu-central-1, aws:eu-west-2, aws:ap-south-1, aws:ap-southeast-2, aws:ap-northeast-1"},{"in":"body","schema":{"type":"array","items":{"type":"string"}},"name":"» user_alerts","required":false,"safeType":"string[]","depth":1,"exampleValues":{"object":["string"],"json":"[\n \"string\"\n]"}},{"in":"body","schema":{"type":"array","items":{"type":"string"}},"name":"» slack_alerts","required":false,"safeType":"string[]","depth":1,"exampleValues":{"object":["string"],"json":"[\n \"string\"\n]"}},{"in":"body","schema":{"type":"array","items":{"type":"string"}},"name":"» discord_alerts","required":false,"safeType":"string[]","depth":1,"exampleValues":{"object":["string"],"json":"[\n \"string\"\n]"}},{"in":"body","schema":{"type":"array","items":{"type":"string"}},"name":"» incident_io_alerts","required":false,"safeType":"string[]","depth":1,"exampleValues":{"object":["string"],"json":"[\n \"string\"\n]"}},{"in":"body","schema":{"type":"array","items":{"type":"string"}},"name":"» microsoft_teams_alerts","required":false,"safeType":"string[]","depth":1,"exampleValues":{"object":["string"],"json":"[\n \"string\"\n]"}},{"in":"body","schema":{"type":"array","items":{"type":"string"}},"name":"» telegram_alerts","required":false,"safeType":"string[]","depth":1,"exampleValues":{"object":["string"],"json":"[\n \"string\"\n]"}},{"in":"body","schema":{"type":"array","items":{"type":"string"}},"name":"» pushover_alerts","required":false,"safeType":"string[]","depth":1,"exampleValues":{"object":["string"],"json":"[\n \"string\"\n]"}},{"in":"body","schema":{"type":"array","items":{"type":"string"},"description":"IDs of webhooks to associate with this check"},"name":"» webhook_alerts","required":false,"description":"IDs of webhooks to associate with this check","safeType":"string[]","depth":1,"exampleValues":{"object":["string"],"json":"[\n \"string\"\n]"},"shortDesc":"IDs of webhooks to associate with this check"},{"in":"body","schema":{"type":"array","items":{"type":"string"},"description":"IDs of on-call integrations (Grafana, PagerDuty, Opsgenie, Spike)"},"name":"» oncall_alerts","required":false,"description":"IDs of on-call integrations (Grafana, PagerDuty, Opsgenie, Spike)","safeType":"string[]","depth":1,"exampleValues":{"object":["string"],"json":"[\n \"string\"\n]"},"shortDesc":"IDs of on-call integrations (Grafana, PagerDuty, Opsgenie, Spike)"},{"in":"body","schema":{"type":"string","enum":["LOW","HIGH"],"default":"LOW","example":"LOW","description":"Alert Priority"},"name":"» alert_priority","required":false,"description":"Alert Priority","safeType":"string","depth":1,"exampleValues":{"object":"LOW","json":"'LOW'"},"shortDesc":"Alert Priority"},{"in":"body","schema":{"type":"integer","minimum":0,"default":60,"example":60,"description":"Confirmation period in seconds"},"name":"» confirmation_period_seconds","required":false,"description":"Confirmation period in seconds","safeType":"integer","depth":1,"exampleValues":{"object":60,"json":"'60'"},"shortDesc":"Confirmation period in seconds"},{"in":"body","schema":{"type":"integer","minimum":0,"default":180,"example":180,"description":"Recovery period in seconds"},"name":"» recovery_period_seconds","required":false,"description":"Recovery period in seconds","safeType":"integer","depth":1,"exampleValues":{"object":180,"json":"'180'"},"shortDesc":"Recovery period in seconds"},{"in":"body","schema":{"type":"integer","minimum":-1,"default":1440,"example":1440,"description":"Interval in minutes between reminders (-1 for never)"},"name":"» reminder_alert_interval_minutes","required":false,"description":"Interval in minutes between reminders (-1 for never)","safeType":"integer","depth":1,"exampleValues":{"object":1440,"json":"'1440'"},"shortDesc":"Interval in minutes between reminders (-1 for never)"},{"in":"body","schema":{"type":"integer","minimum":1000,"default":10000,"example":10000,"description":"Timeout in milliseconds"},"name":"» timeout","required":false,"description":"Timeout in milliseconds","safeType":"integer","depth":1,"exampleValues":{"object":10000,"json":"'10000'"},"shortDesc":"Timeout in milliseconds"},{"in":"body","schema":{"type":["string","null"],"format":"uri","example":"https://example.com","description":"URL to check. Required for URL-based checks, optional for script-based checks."},"name":"» url","required":false,"description":"URL to check. Required for URL-based checks, optional for script-based checks.","safeType":"string,null(uri)","depth":1,"exampleValues":{"object":"https://example.com","json":"'https://example.com'"},"shortDesc":"URL to check. Required for URL-based checks, optional for script-based checks."},{"in":"body","schema":{"type":"string","maxLength":4000,"example":"Example Domain","description":"Text to search for in the response"},"name":"» text_to_search_for","required":false,"description":"Text to search for in the response","safeType":"string","depth":1,"exampleValues":{"object":"Example Domain","json":"'Example Domain'"},"shortDesc":"Text to search for in the response"},{"in":"body","schema":{"type":"string","enum":["UPTIME_CHECK","BROWSER_CHECK"],"default":"UPTIME_CHECK","example":"UPTIME_CHECK","description":"Type of check"},"name":"» type","required":false,"description":"Type of check","safeType":"string","depth":1,"exampleValues":{"object":"UPTIME_CHECK","json":"'UPTIME_CHECK'"},"shortDesc":"Type of check"},{"in":"body","schema":{"type":"object","additionalProperties":{"type":"string","example":"My Value","description":"Header value"},"example":{"X-My-Header":"My Value"},"description":"Headers to send with the request"},"name":"» headers","required":false,"description":"Headers to send with the request","safeType":"object","depth":1,"exampleValues":{"object":{"X-My-Header":"My Value"},"json":"{\n \"X-My-Header\": \"My Value\"\n}"},"shortDesc":"Headers to send with the request"},{"in":"body","schema":{"type":"string","example":"My Value","description":"Header value"},"name":"»» **additionalProperties**","required":false,"description":"Header value","safeType":"string","depth":2,"exampleValues":{"object":"My Value","json":"'My Value'"},"shortDesc":"Header value"},{"in":"body","schema":{"type":"string","enum":["GET","HEAD","POST","PUT","PATCH","DELETE"],"default":"GET","example":"GET","description":"HTTP Method"},"name":"» method","required":false,"description":"HTTP Method","safeType":"string","depth":1,"exampleValues":{"object":"GET","json":"'GET'"},"shortDesc":"HTTP Method"},{"in":"body","schema":{"type":"string","example":"Hello World"},"name":"» body","required":false,"safeType":"string","depth":1,"exampleValues":{"object":"Hello World","json":"'Hello World'"}},{"in":"body","schema":{"type":"boolean","default":true,"example":true,"description":"Whether to follow redirects"},"name":"» follow_redirects","required":false,"description":"Whether to follow redirects","safeType":"boolean","depth":1,"exampleValues":{"object":true,"json":"'true'"},"shortDesc":"Whether to follow redirects"},{"in":"body","schema":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["JSON_BODY","TEXT_BODY","RESPONSE_HEADERS","HTML_BODY"],"example":"JSON_BODY","description":"Type of assertion"},"property":{"type":"string","example":"$.data.name","description":"Property to assert on (JSONPath for JSON_BODY, header name for RESPONSE_HEADERS, CSS selector for HTML_BODY; unused for TEXT_BODY)"},"comparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","LESS_THAN","NULL","NOT_NULL","EMPTY","NOT_EMPTY","CONTAINS","NOT_CONTAINS","FALSE","TRUE"],"example":"EQUALS","description":"Comparison operator"},"expected":{"type":"string","example":"John Doe","description":"Expected value"}},"required":["type","property","comparison","expected"]},"example":[{"type":"JSON_BODY","property":"$.data.name","comparison":"EQUALS","expected":"John Doe"},{"type":"HTML_BODY","property":"meta[name=\"description\"]","comparison":"NOT_EMPTY","expected":""}],"description":"Assertions to run on the response"},"name":"» assertions","required":false,"description":"Assertions to run on the response","safeType":"object[]","depth":1,"exampleValues":{"object":[{"type":"JSON_BODY","property":"$.data.name","comparison":"EQUALS","expected":"John Doe"},{"type":"HTML_BODY","property":"meta[name=\"description\"]","comparison":"NOT_EMPTY","expected":""}],"json":"[\n {\n \"type\": \"JSON_BODY\",\n \"property\": \"$.data.name\",\n \"comparison\": \"EQUALS\",\n \"expected\": \"John Doe\"\n },\n {\n \"type\": \"HTML_BODY\",\n \"property\": \"meta[name=\\\"description\\\"]\",\n \"comparison\": \"NOT_EMPTY\",\n \"expected\": \"\"\n }\n]"},"shortDesc":"Assertions to run on the response"},{"in":"body","schema":{"type":"string","enum":["JSON_BODY","TEXT_BODY","RESPONSE_HEADERS","HTML_BODY"],"example":"JSON_BODY","description":"Type of assertion"},"name":"»» type","required":true,"description":"Type of assertion","safeType":"string","depth":2,"exampleValues":{"object":"JSON_BODY","json":"'JSON_BODY'"},"shortDesc":"Type of assertion"},{"in":"body","schema":{"type":"string","example":"$.data.name","description":"Property to assert on (JSONPath for JSON_BODY, header name for RESPONSE_HEADERS, CSS selector for HTML_BODY; unused for TEXT_BODY)"},"name":"»» property","required":true,"description":"Property to assert on (JSONPath for JSON_BODY, header name for RESPONSE_HEADERS, CSS selector for HTML_BODY; unused for TEXT_BODY)","safeType":"string","depth":2,"exampleValues":{"object":"$.data.name","json":"'$.data.name'"},"shortDesc":"Property to assert on (JSONPath for JSON_BODY, header name for RESPONSE_HEADERS, CSS selector for HTML_BODY; unused for TEXT_BODY)"},{"in":"body","schema":{"type":"string","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","LESS_THAN","NULL","NOT_NULL","EMPTY","NOT_EMPTY","CONTAINS","NOT_CONTAINS","FALSE","TRUE"],"example":"EQUALS","description":"Comparison operator"},"name":"»» comparison","required":true,"description":"Comparison operator","safeType":"string","depth":2,"exampleValues":{"object":"EQUALS","json":"'EQUALS'"},"shortDesc":"Comparison operator"},{"in":"body","schema":{"type":"string","example":"John Doe","description":"Expected value"},"name":"»» expected","required":true,"description":"Expected value","safeType":"string","depth":2,"exampleValues":{"object":"John Doe","json":"'John Doe'"},"shortDesc":"Expected value"},{"in":"body","schema":{"type":"boolean","default":false,"example":false,"description":"Whether to fail a check if SSL verification fails"},"name":"» verify_ssl","required":false,"description":"Whether to fail a check if SSL verification fails","safeType":"boolean","depth":1,"exampleValues":{"object":false,"json":"'false'"},"shortDesc":"Whether to fail a check if SSL verification fails"},{"in":"body","schema":{"type":"string","example":"username","description":"Username to use for URLs behind HTTP Basic Auth"},"name":"» auth_username","required":false,"description":"Username to use for URLs behind HTTP Basic Auth","safeType":"string","depth":1,"exampleValues":{"object":"username","json":"'username'"},"shortDesc":"Username to use for URLs behind HTTP Basic Auth"},{"in":"body","schema":{"type":"string","example":"password","description":"Password to use for URLs behind HTTP Basic Auth"},"name":"» auth_password","required":false,"description":"Password to use for URLs behind HTTP Basic Auth","safeType":"string","depth":1,"exampleValues":{"object":"password","json":"'password'"},"shortDesc":"Password to use for URLs behind HTTP Basic Auth"},{"in":"body","schema":{"type":"string","enum":["NODE24_PLAYWRIGHT"],"example":"NODE24_PLAYWRIGHT","description":"Runtime version for browser checks."},"name":"» version","required":false,"description":"Runtime version for browser checks.","safeType":"string","depth":1,"exampleValues":{"object":"NODE24_PLAYWRIGHT","json":"'NODE24_PLAYWRIGHT'"},"shortDesc":"Runtime version for browser checks."},{"in":"body","schema":{"type":"string","example":"import { test, expect } from '@playwright/test';\ntest('check homepage', async ({ page }) => {\n await page.goto('https://example.com');\n await expect(page.locator('h1')).toContainText('Example');\n});","description":"Playwright Test script for scripted browser checks. Required for script-based checks, optional for URL-based checks."},"name":"» script","required":false,"description":"Playwright Test script for scripted browser checks. Required for script-based checks, optional for URL-based checks.","safeType":"string","depth":1,"exampleValues":{"object":"import { test, expect } from '@playwright/test';\ntest('check homepage', async ({ page }) => {\n await page.goto('https://example.com');\n await expect(page.locator('h1')).toContainText('Example');\n});","json":"'import { test, expect } from '@playwright/test';\ntest('check homepage', async ({ page }) => {\n await page.goto('https://example.com');\n await expect(page.locator('h1')).toContainText('Example');\n});'"},"shortDesc":"Playwright Test script for scripted browser checks. Required for script-based checks, optional for URL-based checks."}]} title="Body parameters" />
Responses
|Status|Meaning|Description|
|---|---|---|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Create a new OnlineOrNot 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 \
--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", {
"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")
.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');
$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")
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"
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",
"check_type": "UPTIME",
"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"
]
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Retrieve a check {{ tag: 'GET', label: '/v1/checks/{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 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)|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/a1b2c3d4 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/checks/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/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/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/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/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": []
}
```
---
## Delete a check {{ tag: 'DELETE', label: '/v1/checks/{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 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)|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/a1b2c3d4 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/checks/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/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/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/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/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": []
}
```
---
## Modify a check {{ tag: 'PATCH', label: '/v1/checks/{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`
{\n await page.goto('https://example.com');\n await expect(page.locator('h1')).toContainText('Example');\n});","description":"Playwright Test script to run. Must import from @playwright/test and contain at least one test() block."}}},"name":"body","required":true,"exampleValues":{"object":{"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","type":"UPTIME_CHECK","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","version":"NODE24_PLAYWRIGHT","script":"import { test, expect } from '@playwright/test';\ntest('check homepage', async ({ page }) => {\n await page.goto('https://example.com');\n await expect(page.locator('h1')).toContainText('Example');\n});"},"json":"{\n \"name\": \"My monitor\",\n \"test_interval\": 60,\n \"test_regions\": [\n \"aws:us-east-1\",\n \"aws:eu-central-1\"\n ],\n \"user_alerts\": [\n \"string\"\n ],\n \"slack_alerts\": [\n \"string\"\n ],\n \"discord_alerts\": [\n \"string\"\n ],\n \"incident_io_alerts\": [\n \"string\"\n ],\n \"microsoft_teams_alerts\": [\n \"string\"\n ],\n \"telegram_alerts\": [\n \"string\"\n ],\n \"pushover_alerts\": [\n \"string\"\n ],\n \"webhook_alerts\": [\n \"string\"\n ],\n \"oncall_alerts\": [\n \"string\"\n ],\n \"alert_priority\": \"LOW\",\n \"confirmation_period_seconds\": 60,\n \"recovery_period_seconds\": 180,\n \"reminder_alert_interval_minutes\": 1440,\n \"timeout\": 10000,\n \"paused\": false,\n \"muted\": false,\n \"url\": \"https://example.com\",\n \"text_to_search_for\": \"Example Domain\",\n \"type\": \"UPTIME_CHECK\",\n \"headers\": {\n \"X-My-Header\": \"My Value\"\n },\n \"method\": \"GET\",\n \"body\": \"Hello World\",\n \"follow_redirects\": true,\n \"assertions\": [\n {\n \"type\": \"JSON_BODY\",\n \"property\": \"$.data.name\",\n \"comparison\": \"EQUALS\",\n \"expected\": \"John Doe\"\n }\n ],\n \"verify_ssl\": false,\n \"auth_username\": \"username\",\n \"auth_password\": \"password\",\n \"version\": \"NODE24_PLAYWRIGHT\",\n \"script\": \"import { test, expect } from '@playwright/test';\\ntest('check homepage', async ({ page }) => {\\n await page.goto('https://example.com');\\n await expect(page.locator('h1')).toContainText('Example');\\n});\"\n}"},"originalType":"object","safeType":"object"},{"in":"body","schema":{"type":"string","example":"My monitor","description":"Name of the monitor"},"name":"» name","required":false,"description":"Name of the monitor","safeType":"string","depth":1,"exampleValues":{"object":"My monitor","json":"'My monitor'"},"shortDesc":"Name of the monitor"},{"in":"body","schema":{"type":"integer","minimum":30,"example":60,"description":"Interval in seconds between checks"},"name":"» test_interval","required":false,"description":"Interval in seconds between checks","safeType":"integer","depth":1,"exampleValues":{"object":60,"json":"'60'"},"shortDesc":"Interval in seconds between checks"},{"in":"body","schema":{"type":"array","items":{"type":"string","description":"Region identifier in format aws:{region}"},"example":["aws:us-east-1","aws:eu-central-1"],"description":"Regions to run checks from. Valid regions: aws:us-east-1, aws:us-east-2, aws:us-west-1, aws:eu-central-1, aws:eu-west-2, aws:ap-south-1, aws:ap-southeast-2, aws:ap-northeast-1"},"name":"» test_regions","required":false,"description":"Regions to run checks from. Valid regions: aws:us-east-1, aws:us-east-2, aws:us-west-1, aws:eu-central-1, aws:eu-west-2, aws:ap-south-1, aws:ap-southeast-2, aws:ap-northeast-1","safeType":"string[]","depth":1,"exampleValues":{"object":["aws:us-east-1","aws:eu-central-1"],"json":"[\n \"aws:us-east-1\",\n \"aws:eu-central-1\"\n]"},"shortDesc":"Regions to run checks from. Valid regions: aws:us-east-1, aws:us-east-2, aws:us-west-1, aws:eu-central-1, aws:eu-west-2, aws:ap-south-1, aws:ap-southeast-2, aws:ap-northeast-1"},{"in":"body","schema":{"type":"array","items":{"type":"string"}},"name":"» user_alerts","required":false,"safeType":"string[]","depth":1,"exampleValues":{"object":["string"],"json":"[\n \"string\"\n]"}},{"in":"body","schema":{"type":"array","items":{"type":"string"}},"name":"» slack_alerts","required":false,"safeType":"string[]","depth":1,"exampleValues":{"object":["string"],"json":"[\n \"string\"\n]"}},{"in":"body","schema":{"type":"array","items":{"type":"string"}},"name":"» discord_alerts","required":false,"safeType":"string[]","depth":1,"exampleValues":{"object":["string"],"json":"[\n \"string\"\n]"}},{"in":"body","schema":{"type":"array","items":{"type":"string"}},"name":"» incident_io_alerts","required":false,"safeType":"string[]","depth":1,"exampleValues":{"object":["string"],"json":"[\n \"string\"\n]"}},{"in":"body","schema":{"type":"array","items":{"type":"string"}},"name":"» microsoft_teams_alerts","required":false,"safeType":"string[]","depth":1,"exampleValues":{"object":["string"],"json":"[\n \"string\"\n]"}},{"in":"body","schema":{"type":"array","items":{"type":"string"}},"name":"» telegram_alerts","required":false,"safeType":"string[]","depth":1,"exampleValues":{"object":["string"],"json":"[\n \"string\"\n]"}},{"in":"body","schema":{"type":"array","items":{"type":"string"}},"name":"» pushover_alerts","required":false,"safeType":"string[]","depth":1,"exampleValues":{"object":["string"],"json":"[\n \"string\"\n]"}},{"in":"body","schema":{"type":"array","items":{"type":"string"},"description":"IDs of webhooks to associate with this check"},"name":"» webhook_alerts","required":false,"description":"IDs of webhooks to associate with this check","safeType":"string[]","depth":1,"exampleValues":{"object":["string"],"json":"[\n \"string\"\n]"},"shortDesc":"IDs of webhooks to associate with this check"},{"in":"body","schema":{"type":"array","items":{"type":"string"},"description":"IDs of on-call integrations (Grafana, PagerDuty, Opsgenie, Spike)"},"name":"» oncall_alerts","required":false,"description":"IDs of on-call integrations (Grafana, PagerDuty, Opsgenie, Spike)","safeType":"string[]","depth":1,"exampleValues":{"object":["string"],"json":"[\n \"string\"\n]"},"shortDesc":"IDs of on-call integrations (Grafana, PagerDuty, Opsgenie, Spike)"},{"in":"body","schema":{"type":"string","enum":["LOW","HIGH"],"default":"LOW","example":"LOW","description":"Alert Priority"},"name":"» alert_priority","required":false,"description":"Alert Priority","safeType":"string","depth":1,"exampleValues":{"object":"LOW","json":"'LOW'"},"shortDesc":"Alert Priority"},{"in":"body","schema":{"type":"integer","minimum":0,"example":60,"description":"Confirmation period in seconds"},"name":"» confirmation_period_seconds","required":false,"description":"Confirmation period in seconds","safeType":"integer","depth":1,"exampleValues":{"object":60,"json":"'60'"},"shortDesc":"Confirmation period in seconds"},{"in":"body","schema":{"type":"integer","minimum":0,"example":180,"description":"Recovery period in seconds"},"name":"» recovery_period_seconds","required":false,"description":"Recovery period in seconds","safeType":"integer","depth":1,"exampleValues":{"object":180,"json":"'180'"},"shortDesc":"Recovery period in seconds"},{"in":"body","schema":{"type":"integer","minimum":-1,"example":1440,"description":"Interval in minutes between reminders (-1 for never)"},"name":"» reminder_alert_interval_minutes","required":false,"description":"Interval in minutes between reminders (-1 for never)","safeType":"integer","depth":1,"exampleValues":{"object":1440,"json":"'1440'"},"shortDesc":"Interval in minutes between reminders (-1 for never)"},{"in":"body","schema":{"type":"integer","minimum":1000,"example":10000,"description":"Timeout in milliseconds"},"name":"» timeout","required":false,"description":"Timeout in milliseconds","safeType":"integer","depth":1,"exampleValues":{"object":10000,"json":"'10000'"},"shortDesc":"Timeout in milliseconds"},{"in":"body","schema":{"type":"boolean","example":false,"description":"Whether the monitor is paused (completely stops execution) or actively running"},"name":"» paused","required":false,"description":"Whether the monitor is paused (completely stops execution) or actively running","safeType":"boolean","depth":1,"exampleValues":{"object":false,"json":"'false'"},"shortDesc":"Whether the monitor is paused (completely stops execution) or actively running"},{"in":"body","schema":{"type":"boolean","example":false,"description":"Whether the monitor is muted (continues running but suppresses alerts) or sending alerts normally"},"name":"» muted","required":false,"description":"Whether the monitor is muted (continues running but suppresses alerts) or sending alerts normally","safeType":"boolean","depth":1,"exampleValues":{"object":false,"json":"'false'"},"shortDesc":"Whether the monitor is muted (continues running but suppresses alerts) or sending alerts normally"},{"in":"body","schema":{"type":["string","null"],"format":"uri","example":"https://example.com","description":"URL to check"},"name":"» url","required":false,"description":"URL to check","safeType":"string,null(uri)","depth":1,"exampleValues":{"object":"https://example.com","json":"'https://example.com'"},"shortDesc":"URL to check"},{"in":"body","schema":{"type":"string","maxLength":4000,"example":"Example Domain","description":"Text to search for in the response"},"name":"» text_to_search_for","required":false,"description":"Text to search for in the response","safeType":"string","depth":1,"exampleValues":{"object":"Example Domain","json":"'Example Domain'"},"shortDesc":"Text to search for in the response"},{"in":"body","schema":{"type":"string","enum":["UPTIME_CHECK","BROWSER_CHECK"],"example":"UPTIME_CHECK","description":"Type of check"},"name":"» type","required":false,"description":"Type of check","safeType":"string","depth":1,"exampleValues":{"object":"UPTIME_CHECK","json":"'UPTIME_CHECK'"},"shortDesc":"Type of check"},{"in":"body","schema":{"type":"object","additionalProperties":{"type":"string","example":"My Value","description":"Header value"},"example":{"X-My-Header":"My Value"},"description":"Headers to send with the request"},"name":"» headers","required":false,"description":"Headers to send with the request","safeType":"object","depth":1,"exampleValues":{"object":{"X-My-Header":"My Value"},"json":"{\n \"X-My-Header\": \"My Value\"\n}"},"shortDesc":"Headers to send with the request"},{"in":"body","schema":{"type":"string","example":"My Value","description":"Header value"},"name":"»» **additionalProperties**","required":false,"description":"Header value","safeType":"string","depth":2,"exampleValues":{"object":"My Value","json":"'My Value'"},"shortDesc":"Header value"},{"in":"body","schema":{"type":"string","enum":["GET","HEAD","POST","PUT","PATCH","DELETE"],"example":"GET","description":"HTTP Method"},"name":"» method","required":false,"description":"HTTP Method","safeType":"string","depth":1,"exampleValues":{"object":"GET","json":"'GET'"},"shortDesc":"HTTP Method"},{"in":"body","schema":{"type":"string","example":"Hello World"},"name":"» body","required":false,"safeType":"string","depth":1,"exampleValues":{"object":"Hello World","json":"'Hello World'"}},{"in":"body","schema":{"type":"boolean","example":true,"description":"Whether to follow redirects"},"name":"» follow_redirects","required":false,"description":"Whether to follow redirects","safeType":"boolean","depth":1,"exampleValues":{"object":true,"json":"'true'"},"shortDesc":"Whether to follow redirects"},{"in":"body","schema":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["JSON_BODY","TEXT_BODY","RESPONSE_HEADERS","HTML_BODY"],"example":"JSON_BODY","description":"Type of assertion"},"property":{"type":"string","example":"$.data.name","description":"Property to assert on (JSONPath for JSON_BODY, header name for RESPONSE_HEADERS, CSS selector for HTML_BODY; unused for TEXT_BODY)"},"comparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","LESS_THAN","NULL","NOT_NULL","EMPTY","NOT_EMPTY","CONTAINS","NOT_CONTAINS","FALSE","TRUE"],"example":"EQUALS","description":"Comparison operator"},"expected":{"type":"string","example":"John Doe","description":"Expected value"}},"required":["type","property","comparison","expected"]}},"name":"» assertions","required":false,"safeType":"object[]","depth":1,"exampleValues":{"object":[{"type":"JSON_BODY","property":"$.data.name","comparison":"EQUALS","expected":"John Doe"}],"json":"[\n {\n \"type\": \"JSON_BODY\",\n \"property\": \"$.data.name\",\n \"comparison\": \"EQUALS\",\n \"expected\": \"John Doe\"\n }\n]"}},{"in":"body","schema":{"type":"string","enum":["JSON_BODY","TEXT_BODY","RESPONSE_HEADERS","HTML_BODY"],"example":"JSON_BODY","description":"Type of assertion"},"name":"»» type","required":true,"description":"Type of assertion","safeType":"string","depth":2,"exampleValues":{"object":"JSON_BODY","json":"'JSON_BODY'"},"shortDesc":"Type of assertion"},{"in":"body","schema":{"type":"string","example":"$.data.name","description":"Property to assert on (JSONPath for JSON_BODY, header name for RESPONSE_HEADERS, CSS selector for HTML_BODY; unused for TEXT_BODY)"},"name":"»» property","required":true,"description":"Property to assert on (JSONPath for JSON_BODY, header name for RESPONSE_HEADERS, CSS selector for HTML_BODY; unused for TEXT_BODY)","safeType":"string","depth":2,"exampleValues":{"object":"$.data.name","json":"'$.data.name'"},"shortDesc":"Property to assert on (JSONPath for JSON_BODY, header name for RESPONSE_HEADERS, CSS selector for HTML_BODY; unused for TEXT_BODY)"},{"in":"body","schema":{"type":"string","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","LESS_THAN","NULL","NOT_NULL","EMPTY","NOT_EMPTY","CONTAINS","NOT_CONTAINS","FALSE","TRUE"],"example":"EQUALS","description":"Comparison operator"},"name":"»» comparison","required":true,"description":"Comparison operator","safeType":"string","depth":2,"exampleValues":{"object":"EQUALS","json":"'EQUALS'"},"shortDesc":"Comparison operator"},{"in":"body","schema":{"type":"string","example":"John Doe","description":"Expected value"},"name":"»» expected","required":true,"description":"Expected value","safeType":"string","depth":2,"exampleValues":{"object":"John Doe","json":"'John Doe'"},"shortDesc":"Expected value"},{"in":"body","schema":{"type":"boolean","example":false,"description":"Whether to fail a check if SSL verification fails"},"name":"» verify_ssl","required":false,"description":"Whether to fail a check if SSL verification fails","safeType":"boolean","depth":1,"exampleValues":{"object":false,"json":"'false'"},"shortDesc":"Whether to fail a check if SSL verification fails"},{"in":"body","schema":{"type":"string","example":"username","description":"Username to use for URLs behind HTTP Basic Auth"},"name":"» auth_username","required":false,"description":"Username to use for URLs behind HTTP Basic Auth","safeType":"string","depth":1,"exampleValues":{"object":"username","json":"'username'"},"shortDesc":"Username to use for URLs behind HTTP Basic Auth"},{"in":"body","schema":{"type":"string","example":"password","description":"Password to use for URLs behind HTTP Basic Auth"},"name":"» auth_password","required":false,"description":"Password to use for URLs behind HTTP Basic Auth","safeType":"string","depth":1,"exampleValues":{"object":"password","json":"'password'"},"shortDesc":"Password to use for URLs behind HTTP Basic Auth"},{"in":"body","schema":{"type":"string","enum":["NODE20_PLAYWRIGHT","NODE24_PLAYWRIGHT"],"example":"NODE24_PLAYWRIGHT","description":"Runtime version for browser checks. NODE20_PLAYWRIGHT is deprecated; existing checks can keep this version but new checks should use NODE24_PLAYWRIGHT."},"name":"» version","required":false,"description":"Runtime version for browser checks. NODE20_PLAYWRIGHT is deprecated; existing checks can keep this version but new checks should use NODE24_PLAYWRIGHT.","safeType":"string","depth":1,"exampleValues":{"object":"NODE24_PLAYWRIGHT","json":"'NODE24_PLAYWRIGHT'"},"shortDesc":"Runtime version for browser checks. NODE20_PLAYWRIGHT is deprecated; existing checks can keep this version but new checks should use NODE24_PLAYWRIGHT."},{"in":"body","schema":{"type":"string","example":"import { test, expect } from '@playwright/test';\ntest('check homepage', async ({ page }) => {\n await page.goto('https://example.com');\n await expect(page.locator('h1')).toContainText('Example');\n});","description":"Playwright Test script to run. Must import from @playwright/test and contain at least one test() block."},"name":"» script","required":false,"description":"Playwright Test script to run. Must import from @playwright/test and contain at least one test() block.","safeType":"string","depth":1,"exampleValues":{"object":"import { test, expect } from '@playwright/test';\ntest('check homepage', async ({ page }) => {\n await page.goto('https://example.com');\n await expect(page.locator('h1')).toContainText('Example');\n});","json":"'import { test, expect } from '@playwright/test';\ntest('check homepage', async ({ page }) => {\n await page.goto('https://example.com');\n await expect(page.locator('h1')).toContainText('Example');\n});'"},"shortDesc":"Playwright Test script to run. Must import from @playwright/test and contain at least one test() block."}]} title="Body parameters" />
Responses
|Status|Meaning|Description|
|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Modify an OnlineOrNot 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)|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/a1b2c3d4 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--data '{"muted":true,"headers":{"X-Custom-Header":"new-value"}}'
```
```javascript
fetch("https://api.onlineornot.com/v1/checks/a1b2c3d4", {
"method": "PATCH",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
},
"body": "{\"muted\":true,\"headers\":{\"X-Custom-Header\":\"new-value\"}}"
})
.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, "{\"muted\":true,\"headers\":{\"X-Custom-Header\":\"new-value\"}}");
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/checks/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/a1b2c3d4');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
$request->setBody('{"muted":true,"headers":{"X-Custom-Header":"new-value"}}');
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/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 = "{\"muted\":true,\"headers\":{\"X-Custom-Header\":\"new-value\"}}"
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/checks/a1b2c3d4"
payload = {
"muted": True,
"headers": {"X-Custom-Header": "new-value"}
}
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",
"check_type": "UPTIME",
"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"
]
},
"success": true,
"errors": [],
"messages": []
}
```
---