export const metadata = {
title: "Heartbeats - OnlineOrNot API Documentation",
description:
"Monitor cron jobs and scheduled tasks with heartbeat pings",
}
## Send a heartbeat (GET) {{ tag: 'GET', label: '/{heartbeat_id}' }}
*Send a heartbeat ping (GET). Use this from scripts or cron jobs to signal completion. Note: This endpoint uses oonchk.com, not api.onlineornot.com.*
This operation does not require authentication
Responses
|Status|Meaning|Description|
|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Heartbeat received successfully|
|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://oonchk.com/a1b2c3d4
```
```javascript
fetch("https://oonchk.com/a1b2c3d4", {
"method": "GET",
"headers": {}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
```
```java
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://oonchk.com/a1b2c3d4")
.get()
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://oonchk.com/a1b2c3d4');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
```
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://oonchk.com/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)
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://oonchk.com/a1b2c3d4"
response = requests.request("GET", url)
print(response.text)
```
---
## Send a heartbeat (POST) {{ tag: 'POST', label: '/{heartbeat_id}' }}
*Send a heartbeat ping (POST). Use this from scripts or cron jobs to signal completion. Note: This endpoint uses oonchk.com, not api.onlineornot.com.*
This operation does not require authentication
Responses
|Status|Meaning|Description|
|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Heartbeat received successfully|
|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://oonchk.com/a1b2c3d4
```
```javascript
fetch("https://oonchk.com/a1b2c3d4", {
"method": "POST",
"headers": {}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
```
```java
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://oonchk.com/a1b2c3d4")
.post(null)
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://oonchk.com/a1b2c3d4');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
```
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://oonchk.com/a1b2c3d4")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://oonchk.com/a1b2c3d4"
response = requests.request("POST", url)
print(response.text)
```
---
## List all heartbeats {{ tag: 'GET', label: '/v1/heartbeats' }}
*Retrieve a paginated list of all heartbeat monitors*
### 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 Heartbeats|
|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/heartbeats \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/heartbeats", {
"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/heartbeats")
.get()
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Bearer {access-token}")
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://api.onlineornot.com/v1/heartbeats');
$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/heartbeats")
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/heartbeats"
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": "Daily backup job",
"status": "UP",
"last_seen": "2021-01-01T00:00:00.000Z",
"report_period": 3600,
"report_period_cron": "0 0 * * *",
"timezone": "America/New_York",
"grace_period": 300,
"reminder_alert_interval_minutes": 1440,
"alert_priority": "LOW",
"created_at": "2021-01-01T00:00:00.000Z",
"updated_at": "2021-01-01T00:00:00.000Z"
}
],
"result_info": {
"page": 1,
"per_page": 20,
"count": 1,
"total_count": 1
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Create a heartbeat {{ tag: 'POST', label: '/v1/heartbeats' }}
*Create a new heartbeat monitor for cron jobs or scheduled tasks*
### 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 Heartbeat|
|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/heartbeats \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--data '{"name":"Daily backup job","report_period":86400,"grace_period":300}'
```
```javascript
fetch("https://api.onlineornot.com/v1/heartbeats", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
},
"body": "{\"name\":\"Daily backup job\",\"report_period\":86400,\"grace_period\":300}"
})
.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\":\"Daily backup job\",\"report_period\":86400,\"grace_period\":300}");
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/heartbeats")
.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/heartbeats');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
$request->setBody('{"name":"Daily backup job","report_period":86400,"grace_period":300}');
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/heartbeats")
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\":\"Daily backup job\",\"report_period\":86400,\"grace_period\":300}"
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/heartbeats"
payload = {
"name": "Daily backup job",
"report_period": 86400,
"grace_period": 300
}
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": "Daily backup job",
"status": "UP",
"last_seen": "2021-01-01T00:00:00.000Z",
"report_period": 3600,
"report_period_cron": "0 0 * * *",
"timezone": "America/New_York",
"grace_period": 300,
"reminder_alert_interval_minutes": 1440,
"alert_priority": "LOW",
"created_at": "2021-01-01T00:00:00.000Z",
"updated_at": "2021-01-01T00:00:00.000Z",
"user_alerts": [
"string"
],
"slack_alerts": [
"string"
],
"discord_alerts": [
"string"
],
"webhook_alerts": [
"string"
],
"oncall_alerts": [
"string"
],
"incident_io_alerts": [
"string"
],
"microsoft_teams_alerts": [
"string"
],
"telegram_alerts": [
"string"
],
"pushover_alerts": [
"string"
]
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Retrieve a heartbeat {{ tag: 'GET', label: '/v1/heartbeats/{heartbeat_id}' }}
*Look up detailed information about a specific heartbeat monitor*
### 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 Heartbeat|
|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/heartbeats/a1b2c3d4 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/heartbeats/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/heartbeats/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/heartbeats/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/heartbeats/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/heartbeats/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": "Daily backup job",
"status": "UP",
"last_seen": "2021-01-01T00:00:00.000Z",
"report_period": 3600,
"report_period_cron": "0 0 * * *",
"timezone": "America/New_York",
"grace_period": 300,
"reminder_alert_interval_minutes": 1440,
"alert_priority": "LOW",
"created_at": "2021-01-01T00:00:00.000Z",
"updated_at": "2021-01-01T00:00:00.000Z",
"user_alerts": [
"string"
],
"slack_alerts": [
"string"
],
"discord_alerts": [
"string"
],
"webhook_alerts": [
"string"
],
"oncall_alerts": [
"string"
],
"incident_io_alerts": [
"string"
],
"microsoft_teams_alerts": [
"string"
],
"telegram_alerts": [
"string"
],
"pushover_alerts": [
"string"
]
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Modify a heartbeat {{ tag: 'PATCH', label: '/v1/heartbeats/{heartbeat_id}' }}
*Modify the configuration of an existing heartbeat monitor*
### 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 Heartbeat|
|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/heartbeats/a1b2c3d4 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--data '{"report_period":7200,"grace_period":600}'
```
```javascript
fetch("https://api.onlineornot.com/v1/heartbeats/a1b2c3d4", {
"method": "PATCH",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
},
"body": "{\"report_period\":7200,\"grace_period\":600}"
})
.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, "{\"report_period\":7200,\"grace_period\":600}");
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/heartbeats/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/heartbeats/a1b2c3d4');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
$request->setBody('{"report_period":7200,"grace_period":600}');
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/heartbeats/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 = "{\"report_period\":7200,\"grace_period\":600}"
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/heartbeats/a1b2c3d4"
payload = {
"report_period": 7200,
"grace_period": 600
}
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": "Daily backup job",
"status": "UP",
"last_seen": "2021-01-01T00:00:00.000Z",
"report_period": 3600,
"report_period_cron": "0 0 * * *",
"timezone": "America/New_York",
"grace_period": 300,
"reminder_alert_interval_minutes": 1440,
"alert_priority": "LOW",
"created_at": "2021-01-01T00:00:00.000Z",
"updated_at": "2021-01-01T00:00:00.000Z",
"user_alerts": [
"string"
],
"slack_alerts": [
"string"
],
"discord_alerts": [
"string"
],
"webhook_alerts": [
"string"
],
"oncall_alerts": [
"string"
],
"incident_io_alerts": [
"string"
],
"microsoft_teams_alerts": [
"string"
],
"telegram_alerts": [
"string"
],
"pushover_alerts": [
"string"
]
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Delete a heartbeat {{ tag: 'DELETE', label: '/v1/heartbeats/{heartbeat_id}' }}
*Permanently delete a heartbeat monitor*
### 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 Heartbeat'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/heartbeats/a1b2c3d4 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/heartbeats/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/heartbeats/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/heartbeats/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/heartbeats/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/heartbeats/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": []
}
```
---