Checks - OnlineOrNot API Documentation

GET/v1/checks

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

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 Checks
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/checks

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

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"
    }
  ],
  "result_info": {
    "page": 1,
    "per_page": 20,
    "count": 1,
    "total_count": 1
  },
  "success": true,
  "errors": [],
  "messages": []
}

POST/v1/checks

Create a check

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

Body parameters

name:string

Name of the check

url:string(uri)

URL to check

text_to_search_for:stringoptional

Text to search for in the response

test_interval:integeroptional

Interval in seconds between checks

reminder_alert_interval_minutes:integeroptional

Interval in minutes between reminders (-1 for never)

Default: 1440

test_regions:string[]optional

user_alerts:string[]optional

slack_alerts:string[]optional

incident_io_alerts:string[]optional

microsoft_teams_alerts:string[]optional

webhook_alerts:string[]optional

confirmation_period_seconds:integeroptional

Confirmation period in seconds

Default: 60

recovery_period_seconds:integeroptional

Recovery period in seconds

Default: 180

timeout:integeroptional

Timeout in milliseconds

Default: 10000

type:stringoptional

Type of check

Accepted values: "UPTIME_CHECK" | "BROWSER_CHECK"

Default: "UPTIME_CHECK"

alert_priority:stringoptional

Alert Priority

Accepted values: "LOW" | "HIGH"

Default: "LOW"

headers:objectoptional

Headers to send with the request

method:stringoptional

HTTP Method

Default: "GET"

body:stringoptional

follow_redirects:booleanoptional

Whether to follow redirects

Default: true

assertions:object[]optional

Assertions to run on the response

verify_ssl:booleanoptional

Whether to fail a check if SSL verification fails

Default: false

auth_username:stringoptional

Username to use for URLs behind HTTP Basic Auth

auth_password:stringoptional

Password to use for URLs behind HTTP Basic Auth

version:stringoptional

Version of the Browser Check

Accepted values: "NODE14_PUPPETEER" | "NODE20_PLAYWRIGHT"

Responses

Status	Meaning	Description
200	OK	Create a new OnlineOrNot Check
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/checks

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

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

GET/v1/checks/{check_id}

Retrieve a check

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

Path parameters

check_id:string

Uptime Check ID

Responses

Status	Meaning	Description
200	OK	Retrieve the specified OnlineOrNot Check
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/checks/{check_id}

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

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

DELETE/v1/checks/{check_id}

Delete a check

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

Path parameters

check_id:string

Uptime Check ID

Responses

Status	Meaning	Description
200	OK	Returns the deleted OnlineOrNot Check'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/checks/{check_id}

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

Response

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

PATCH/v1/checks/{check_id}

Modify a check

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

Path parameters

check_id:string

Uptime Check ID

Body parameters

name:stringoptional

Name of the check

url:string(uri)optional

URL to check

text_to_search_for:stringoptional

Text to search for in the response

test_interval:integeroptional

Interval in seconds between checks

type:stringoptional

Type of check

Accepted values: "UPTIME_CHECK" | "BROWSER_CHECK"

alert_priority:stringoptional

Alert Priority

Accepted values: "LOW" | "HIGH"

headers:objectoptional

Headers to send with the request

method:stringoptional

HTTP Method

body:stringoptional

follow_redirects:booleanoptional

Whether to follow redirects

assertions:object[]optional

verify_ssl:booleanoptional

Whether to fail a check if SSL verification fails

auth_username:stringoptional

Username to use for URLs behind HTTP Basic Auth

auth_password:stringoptional

Password to use for URLs behind HTTP Basic Auth

timeout:integeroptional

Timeout in milliseconds

version:stringoptional

Version of the Browser Check

Accepted values: "NODE14_PUPPETEER" | "NODE20_PLAYWRIGHT"

reminder_alert_interval_minutes:integeroptional

Interval in minutes between reminders (-1 for never)

confirmation_period_seconds:integeroptional

Confirmation period in seconds

recovery_period_seconds:integeroptional

Recovery period in seconds

test_regions:string[]optional

user_alerts:string[]optional

slack_alerts:string[]optional

incident_io_alerts:string[]optional

microsoft_teams_alerts:string[]optional

webhook_alerts:string[]optional

paused:booleanoptional

Whether the check is paused (completely stops execution) or actively running

muted:booleanoptional

Whether the check is muted (continues running but suppresses alerts) or sending alerts normally

Responses

Status	Meaning	Description
200	OK	Modify an OnlineOrNot Check
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/checks/{check_id}

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","My-Unused-Header":null}}'

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