POST/v1/checks/dns

Create a DNS check

Create a new DNS check to monitor DNS records

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 monitor
test_interval:integeroptional
Interval in seconds between checks
test_regions:string[]optional
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
user_alerts:string[]optional
slack_alerts:string[]optional
discord_alerts:string[]optional
incident_io_alerts:string[]optional
microsoft_teams_alerts:string[]optional
telegram_alerts:string[]optional
webhook_alerts:string[]optional
IDs of webhooks to associate with this check
oncall_alerts:string[]optional
IDs of on-call integrations (Grafana, PagerDuty, Opsgenie, Spike)
alert_priority:stringoptional
Alert Priority
Accepted values: "LOW" | "HIGH"
Default: "LOW"
confirmation_period_seconds:integeroptional
Confirmation period in seconds
Default: 60
recovery_period_seconds:integeroptional
Recovery period in seconds
Default: 180
reminder_alert_interval_minutes:integeroptional
Interval in minutes between reminders (-1 for never)
Default: 1440
timeout:integeroptional
Timeout in milliseconds
Default: 10000
type:stringoptional
Accepted values: "DNS_CHECK"
dns_domain:string
DNS name to query
dns_record_type:string
DNS record type to query
Accepted values: "A" | "AAAA" | "CNAME" | "MX" | "NS" | "SOA" | "TXT"
dns_resolver:stringnulloptional
Custom DNS resolver in host:port format. IPv6 must use bracket notation.
dns_protocol:stringoptional
DNS transport protocol
Accepted values: "UDP" | "TCP"
Default: "UDP"
assertions:object[]optional
DNS assertions to run on the response

Responses

StatusMeaningDescription
201CreatedCreate a new OnlineOrNot DNS Check
400Bad RequestValidation error
401UnauthorizedUnauthenticated
403ForbiddenForbidden
500Internal Server ErrorInternal Server Error

Response Schema

result:object
success:boolean
Whether the API call was successful
errors:object[]
messages:object[]

Request

POST
/v1/checks/dns
curl --request POST \
  --url https://api.onlineornot.com/v1/checks/dns \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"name":"DNS for example.com","dns_domain":"example.com","dns_record_type":"A","test_interval":60}'

Response

{
  "result": {
    "id": "a1b2c3d4",
    "name": "My landing page",
    "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,
    "script": "string",
    "alert_priority": "HIGH",
    "verify_ssl": true,
    "method": "GET",
    "body": "string",
    "follow_redirects": true,
    "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"
    ],
    "oncall_alerts": [
      "string"
    ],
    "webhook_alerts": [
      "string"
    ],
    "check_type": "DNS",
    "url": null,
    "version": "NODE24_DNS",
    "dns_domain": "example.com",
    "dns_record_type": "A",
    "dns_resolver": "8.8.8.8:53",
    "dns_protocol": "UDP",
    "assertions": [
      {
        "type": "DNS_JSON_ANSWER",
        "property": "$.answers[0].data",
        "comparison": "EQUALS",
        "expected": "93.184.216.34"
      }
    ]
  },
  "success": true,
  "errors": [],
  "messages": []
}
GET/v1/checks/dns/{check_id}

Retrieve a DNS check

Look up detailed information about a specific DNS 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

StatusMeaningDescription
200OKRetrieve the specified OnlineOrNot DNS Check
401UnauthorizedUnauthenticated
403ForbiddenForbidden
404Not FoundDNS check not found
500Internal Server ErrorInternal Server Error

Response Schema

result:object
success:boolean
Whether the API call was successful
errors:object[]
messages:object[]

Request

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

Response

{
  "result": {
    "id": "a1b2c3d4",
    "name": "My landing page",
    "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,
    "script": "string",
    "alert_priority": "HIGH",
    "verify_ssl": true,
    "method": "GET",
    "body": "string",
    "follow_redirects": true,
    "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"
    ],
    "oncall_alerts": [
      "string"
    ],
    "webhook_alerts": [
      "string"
    ],
    "check_type": "DNS",
    "url": null,
    "version": "NODE24_DNS",
    "dns_domain": "example.com",
    "dns_record_type": "A",
    "dns_resolver": "8.8.8.8:53",
    "dns_protocol": "UDP",
    "assertions": [
      {
        "type": "DNS_JSON_ANSWER",
        "property": "$.answers[0].data",
        "comparison": "EQUALS",
        "expected": "93.184.216.34"
      }
    ]
  },
  "success": true,
  "errors": [],
  "messages": []
}
PATCH/v1/checks/dns/{check_id}

Modify a DNS check

Modify the configuration of an existing DNS 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 monitor
test_interval:integeroptional
Interval in seconds between checks
test_regions:string[]optional
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
user_alerts:string[]optional
slack_alerts:string[]optional
discord_alerts:string[]optional
incident_io_alerts:string[]optional
microsoft_teams_alerts:string[]optional
telegram_alerts:string[]optional
webhook_alerts:string[]optional
IDs of webhooks to associate with this check
oncall_alerts:string[]optional
IDs of on-call integrations (Grafana, PagerDuty, Opsgenie, Spike)
alert_priority:stringoptional
Alert Priority
Accepted values: "LOW" | "HIGH"
Default: "LOW"
confirmation_period_seconds:integeroptional
Confirmation period in seconds
recovery_period_seconds:integeroptional
Recovery period in seconds
reminder_alert_interval_minutes:integeroptional
Interval in minutes between reminders (-1 for never)
timeout:integeroptional
Timeout in milliseconds
paused:booleanoptional
Whether the monitor is paused (completely stops execution) or actively running
muted:booleanoptional
Whether the monitor is muted (continues running but suppresses alerts) or sending alerts normally
dns_domain:stringoptional
dns_record_type:stringoptional
Accepted values: "A" | "AAAA" | "CNAME" | "MX" | "NS" | "SOA" | "TXT"
dns_resolver:stringnulloptional
Custom DNS resolver in host:port format. IPv6 must use bracket notation.
dns_protocol:stringoptional
Accepted values: "UDP" | "TCP"
assertions:object[]optional

Responses

StatusMeaningDescription
200OKModify an OnlineOrNot DNS Check
400Bad RequestValidation error
401UnauthorizedUnauthenticated
403ForbiddenForbidden
404Not FoundDNS check not found
500Internal Server ErrorInternal Server Error

Response Schema

result:object
success:boolean
Whether the API call was successful
errors:object[]
messages:object[]

Request

PATCH
/v1/checks/dns/{check_id}
curl --request PATCH \
  --url https://api.onlineornot.com/v1/checks/dns/a1b2c3d4 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"dns_domain":"example.org","dns_record_type":"TXT","dns_resolver":"1.1.1.1:53","dns_protocol":"TCP"}'

Response

{
  "result": {
    "id": "a1b2c3d4",
    "name": "My landing page",
    "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,
    "script": "string",
    "alert_priority": "HIGH",
    "verify_ssl": true,
    "method": "GET",
    "body": "string",
    "follow_redirects": true,
    "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"
    ],
    "oncall_alerts": [
      "string"
    ],
    "webhook_alerts": [
      "string"
    ],
    "check_type": "DNS",
    "url": null,
    "version": "NODE24_DNS",
    "dns_domain": "example.com",
    "dns_record_type": "A",
    "dns_resolver": "8.8.8.8:53",
    "dns_protocol": "UDP",
    "assertions": [
      {
        "type": "DNS_JSON_ANSWER",
        "property": "$.answers[0].data",
        "comparison": "EQUALS",
        "expected": "93.184.216.34"
      }
    ]
  },
  "success": true,
  "errors": [],
  "messages": []
}
DELETE/v1/checks/dns/{check_id}

Delete a DNS check

Permanently delete a DNS 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

StatusMeaningDescription
200OKReturns the deleted OnlineOrNot DNS Check's ID
400Bad RequestValidation error
401UnauthorizedUnauthenticated
403ForbiddenForbidden
404Not FoundDNS check not found
500Internal Server ErrorInternal Server Error

Response Schema

result:object
success:boolean
Whether the API call was successful
errors:object[]
messages:object[]

Request

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

Response

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

Was this page helpful?