curl --request POST \
--url https://api.getmonitor.io/api/v1/heartbeats \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Organization-Id: <x-organization-id>' \
--data '
{
"name": "Nightly backup",
"description": "Customer-facing status",
"intervalSeconds": 300,
"gracePeriodSeconds": 60
}
'import requests
url = "https://api.getmonitor.io/api/v1/heartbeats"
payload = {
"name": "Nightly backup",
"description": "Customer-facing status",
"intervalSeconds": 300,
"gracePeriodSeconds": 60
}
headers = {
"X-Organization-Id": "<x-organization-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Organization-Id': '<x-organization-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Nightly backup',
description: 'Customer-facing status',
intervalSeconds: 300,
gracePeriodSeconds: 60
})
};
fetch('https://api.getmonitor.io/api/v1/heartbeats', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getmonitor.io/api/v1/heartbeats",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Nightly backup',
'description' => 'Customer-facing status',
'intervalSeconds' => 300,
'gracePeriodSeconds' => 60
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Organization-Id: <x-organization-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getmonitor.io/api/v1/heartbeats"
payload := strings.NewReader("{\n \"name\": \"Nightly backup\",\n \"description\": \"Customer-facing status\",\n \"intervalSeconds\": 300,\n \"gracePeriodSeconds\": 60\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Organization-Id", "<x-organization-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getmonitor.io/api/v1/heartbeats")
.header("X-Organization-Id", "<x-organization-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Nightly backup\",\n \"description\": \"Customer-facing status\",\n \"intervalSeconds\": 300,\n \"gracePeriodSeconds\": 60\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmonitor.io/api/v1/heartbeats")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Organization-Id"] = '<x-organization-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Nightly backup\",\n \"description\": \"Customer-facing status\",\n \"intervalSeconds\": 300,\n \"gracePeriodSeconds\": 60\n}"
response = http.request(request)
puts response.read_body{
"id": "cpcu2gq1jp4v772oy6uxhm16",
"organizationId": "k2p9x7w4m1n8b3v6c5z0q2r7",
"userId": "u7Kp2Qm9Xa4Lr8Tn1Vb6Zc3Wd5Ye0Hf",
"name": "Nightly backup",
"isActive": true,
"currentStatus": "unknown",
"createdAt": "2026-09-27T14:19:22.103Z",
"updatedAt": "2026-09-27T14:19:22.103Z",
"description": "Customer-facing status",
"intervalSeconds": 300,
"gracePeriodSeconds": 60,
"token": "hb_3f9c2a7e5b1d4c8f",
"heartbeatStatus": "WAITING",
"lastPingAt": null,
"lastPingStatus": null,
"pausedUntil": null
}{
"message": [
"name must be longer than or equal to 1 characters",
"regions must be an array"
],
"error": "Bad Request",
"statusCode": 400
}{
"message": "Unauthorized",
"statusCode": 401
}{
"message": "No access to this organization",
"error": "Forbidden",
"statusCode": 403
}Create heartbeat
Creates a heartbeat monitor. The response includes the token your job uses to ping it.
Authentication: API key with the monitors:write scope, or a user session. Role: member, admin or owner. Records who created the resource, so organization keys (gm_api_) receive 403; use a personal key or a session.
curl --request POST \
--url https://api.getmonitor.io/api/v1/heartbeats \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Organization-Id: <x-organization-id>' \
--data '
{
"name": "Nightly backup",
"description": "Customer-facing status",
"intervalSeconds": 300,
"gracePeriodSeconds": 60
}
'import requests
url = "https://api.getmonitor.io/api/v1/heartbeats"
payload = {
"name": "Nightly backup",
"description": "Customer-facing status",
"intervalSeconds": 300,
"gracePeriodSeconds": 60
}
headers = {
"X-Organization-Id": "<x-organization-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Organization-Id': '<x-organization-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Nightly backup',
description: 'Customer-facing status',
intervalSeconds: 300,
gracePeriodSeconds: 60
})
};
fetch('https://api.getmonitor.io/api/v1/heartbeats', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getmonitor.io/api/v1/heartbeats",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Nightly backup',
'description' => 'Customer-facing status',
'intervalSeconds' => 300,
'gracePeriodSeconds' => 60
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Organization-Id: <x-organization-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getmonitor.io/api/v1/heartbeats"
payload := strings.NewReader("{\n \"name\": \"Nightly backup\",\n \"description\": \"Customer-facing status\",\n \"intervalSeconds\": 300,\n \"gracePeriodSeconds\": 60\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Organization-Id", "<x-organization-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getmonitor.io/api/v1/heartbeats")
.header("X-Organization-Id", "<x-organization-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Nightly backup\",\n \"description\": \"Customer-facing status\",\n \"intervalSeconds\": 300,\n \"gracePeriodSeconds\": 60\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmonitor.io/api/v1/heartbeats")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Organization-Id"] = '<x-organization-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Nightly backup\",\n \"description\": \"Customer-facing status\",\n \"intervalSeconds\": 300,\n \"gracePeriodSeconds\": 60\n}"
response = http.request(request)
puts response.read_body{
"id": "cpcu2gq1jp4v772oy6uxhm16",
"organizationId": "k2p9x7w4m1n8b3v6c5z0q2r7",
"userId": "u7Kp2Qm9Xa4Lr8Tn1Vb6Zc3Wd5Ye0Hf",
"name": "Nightly backup",
"isActive": true,
"currentStatus": "unknown",
"createdAt": "2026-09-27T14:19:22.103Z",
"updatedAt": "2026-09-27T14:19:22.103Z",
"description": "Customer-facing status",
"intervalSeconds": 300,
"gracePeriodSeconds": 60,
"token": "hb_3f9c2a7e5b1d4c8f",
"heartbeatStatus": "WAITING",
"lastPingAt": null,
"lastPingStatus": null,
"pausedUntil": null
}{
"message": [
"name must be longer than or equal to 1 characters",
"regions must be an array"
],
"error": "Bad Request",
"statusCode": 400
}{
"message": "Unauthorized",
"statusCode": 401
}{
"message": "No access to this organization",
"error": "Forbidden",
"statusCode": 403
}Authorizations
API key sent as Authorization: Bearer <key>. Personal keys (gm_pat_) act as you, limited by your role and the key's scopes; organization keys (gm_api_) act for one organization. Send X-Organization-Id with every org-scoped request.
Headers
ID of the organization to act in. Required with API keys. A user session may omit it and acts in its active organization.
"k2p9x7w4m1n8b3v6c5z0q2r7"
Body
Display name.
1 - 255"Nightly backup"
Expected time between pings, in seconds (1 minute to 7 days).
60 <= x <= 6048003600
Extra time allowed after the interval before the heartbeat is marked down.
0 <= x <= 3600300
Optional description.
1000Response
Created