Heartbeats - OnlineOrNot API Documentation

GET/{heartbeat_id}

Send a heartbeat (GET)

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

Path parameters

heartbeat_id:string

Heartbeat ID

Responses

Status	Meaning	Description
200	OK	Heartbeat received successfully
500	Internal Server Error	Internal Server Error

Request

GET

/{heartbeat_id}

curl --request GET \
  --url https://oonchk.com/a1b2c3d4

POST/{heartbeat_id}

Send a heartbeat (POST)

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

Path parameters

heartbeat_id:string

Heartbeat ID

Responses

Status	Meaning	Description
200	OK	Heartbeat received successfully
500	Internal Server Error	Internal Server Error

Request

POST

/{heartbeat_id}

curl --request POST \
  --url https://oonchk.com/a1b2c3d4

GET/v1/heartbeats

List all 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

Query parameters

page:stringoptional

Page number of paginated results.

Default: "1"

per_page:stringoptional

Number of items per page.

Default: "20"

Responses

Status	Meaning	Description
200	OK	Returns a list of OnlineOrNot Heartbeats
500	Internal Server Error	Internal Server Error

Response Schema

result:object[]

result_info:object

success:boolean

Whether the API call was successful

errors:object[]

messages:object[]

Request

GET

/v1/heartbeats

curl --request GET \
  --url https://api.onlineornot.com/v1/heartbeats \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

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": []
}

POST/v1/heartbeats

Create a heartbeat

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

Body parameters

name:string

Name of the heartbeat monitor

report_period:integeroptional

Expected interval in seconds between heartbeat pings (for simple schedule)

report_period_cron:stringoptional

Cron expression for expected heartbeat schedule

timezone:stringoptional

Timezone for cron schedule

grace_period:integer

Grace period in seconds to wait after missed heartbeat before alerting

reminder_alert_interval_minutes:integeroptional

Interval in minutes between reminder alerts (-1 for never)

Default: 1440

user_alerts:string[]optional

Array of user IDs to alert

slack_alerts:string[]optional

Array of Slack integration IDs to alert

discord_alerts:string[]optional

Array of Discord integration IDs to alert

webhook_alerts:string[]optional

IDs of webhooks to associate with this heartbeat

oncall_alerts:string[]optional

IDs of on-call integrations (Grafana, PagerDuty, Opsgenie, Spike)

incident_io_alerts:string[]optional

Array of incident.io integration IDs to alert

microsoft_teams_alerts:string[]optional

Array of Microsoft Teams integration IDs to alert

alert_priority:stringoptional

Alert priority level

Accepted values: "LOW" | "HIGH"

Default: "LOW"

Responses

Status	Meaning	Description
201	Created	Create a new OnlineOrNot Heartbeat
500	Internal Server Error	Internal Server Error

Response Schema

result:object

success:boolean

Whether the API call was successful

errors:object[]

messages:object[]

Request

POST

/v1/heartbeats

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}'

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"
    ]
  },
  "success": true,
  "errors": [],
  "messages": []
}

GET/v1/heartbeats/{heartbeat_id}

Retrieve a heartbeat

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

Path parameters

heartbeat_id:string

Heartbeat ID

Responses

Status	Meaning	Description
200	OK	Retrieve the specified OnlineOrNot Heartbeat
500	Internal Server Error	Internal Server Error

Response Schema

result:object

success:boolean

Whether the API call was successful

errors:object[]

messages:object[]

Request

GET

/v1/heartbeats/{heartbeat_id}

curl --request GET \
  --url https://api.onlineornot.com/v1/heartbeats/a1b2c3d4 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

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"
    ]
  },
  "success": true,
  "errors": [],
  "messages": []
}

PATCH/v1/heartbeats/{heartbeat_id}

Modify a heartbeat

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

Path parameters

heartbeat_id:string

Heartbeat ID

Body parameters

name:stringoptional

Name of the heartbeat monitor

report_period:integernulloptional

Expected interval in seconds between heartbeat pings (for simple schedule)

report_period_cron:stringnulloptional

Cron expression for expected heartbeat schedule

timezone:stringnulloptional

Timezone for cron schedule

grace_period:integeroptional

Grace period in seconds to wait after missed heartbeat before alerting

reminder_alert_interval_minutes:integeroptional

Interval in minutes between reminder alerts (-1 for never)

user_alerts:string[]optional

Array of user IDs to alert

slack_alerts:string[]optional

Array of Slack integration IDs to alert

discord_alerts:string[]optional

Array of Discord integration IDs to alert

webhook_alerts:string[]optional

IDs of webhooks to associate with this heartbeat

oncall_alerts:string[]optional

IDs of on-call integrations (Grafana, PagerDuty, Opsgenie, Spike)

incident_io_alerts:string[]optional

Array of incident.io integration IDs to alert

microsoft_teams_alerts:string[]optional

Array of Microsoft Teams integration IDs to alert

alert_priority:stringoptional

Alert priority level

Accepted values: "LOW" | "HIGH"

paused:booleanoptional

Whether the heartbeat is paused

muted:booleanoptional

Whether the heartbeat is muted (continues monitoring but suppresses alerts)

Responses

Status	Meaning	Description
200	OK	Modify an OnlineOrNot Heartbeat
500	Internal Server Error	Internal Server Error

Response Schema

result:object

success:boolean

Whether the API call was successful

errors:object[]

messages:object[]

Request

PATCH

/v1/heartbeats/{heartbeat_id}

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}'

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"
    ]
  },
  "success": true,
  "errors": [],
  "messages": []
}

DELETE/v1/heartbeats/{heartbeat_id}

Delete a heartbeat

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

Path parameters

heartbeat_id:string

Heartbeat ID

Responses

Status	Meaning	Description
200	OK	Returns the deleted OnlineOrNot Heartbeat's ID
500	Internal Server Error	Internal Server Error

Response Schema

result:object

success:boolean

Whether the API call was successful

errors:object[]

messages:object[]

Request

DELETE

/v1/heartbeats/{heartbeat_id}

curl --request DELETE \
  --url https://api.onlineornot.com/v1/heartbeats/a1b2c3d4 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

Response

{
  "result": {
    "id": "a1b2c3d4"
  },
  "success": true,
  "errors": [],
  "messages": []
}