List monitoring checks

Description

List of monitoring checks


Parameters

Name Data Type Status Description
auth-id or sub-auth-id or sub-auth-user Integer Required Authentication parameter
auth-password String Required Authentication parameter
rows-per-page Integer Required Results per page. Can be 10, 20, 30, 50 or 100
page Integer Required The page number you want to check
check_type Integer Optional

Monitoring check types:

  • 17 - Ping
  • 18 - Web
  • 8 - TCP
  • 9 - UDP
  • 10 - DNS
  • 12 - Heartbeat
  • 13 - TLS (SSL) certificate
  • 15 - SMTP
  • 16 - Streaming
state Integer Optional

Possible values:

  • 0 - Paused
  • 1 - Active
status Integer Optional

Possible values:

  • -1 - UNKNOWN
  •  0 - DOWN
  •  1 - UP

Response: Array with monitoring checks.


Errors

When the authentication of the API user is not correct, any API request will fail with the following status and statusDescription:

{"status":"Failed","statusDescription":"Invalid authentication, incorrect auth-id or auth-password."}

If there is no value for "rows-per-page", the following status will be returned:

{"status":"Failed","statusDescription":"Wrong or missing required parameter 'rows-per-page'."}

If there is no value for "page", the following status will be returned:

{"status":"Failed","statusDescription":"Missing or invalid required parameter 'page'."}

If you use the API call as a sub-user and your Monitoring check limit is 0, the following status will be returned:

{"status":"Failed","statusDescription":"You don't have permission to do that."}

Note: These are example errors in JSON format.


Example

URL JSON: https://api.cloudns.net/monitoring/get-records.json
POST/GET:
auth-id=0&auth-password=password&rows-per-page=10&page=1
sub-auth-id=0&auth-password=password&rows-per-page=10&page=1

URL XML: https://api.cloudns.net/monitoring/get-records.xml
POST/GET:
auth-id=0&auth-password=password&rows-per-page=10&page=1
sub-auth-id=0&auth-password=password&rows-per-page=10&page=1


Last modified: 2025-06-03
Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more