Get available regions

Description

This API method returns information about the available regions for a specific monitoring type.


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
check_type Integer Required

Monitoring check types:

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

Response: Array with the available monitoring intervals


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 "check_type" or it is missing, the following status will be returned:

{"status":"Failed","statusDescription":"This is invalid monitoring type."}

Note: These are example errors in JSON format.


Example

URL JSON: https://api.cloudns.net/get-available-regions.json
POST/GET:
auth-id=0&auth-password=password&check_type=17
sub-auth-id=0&auth-password=password&check_type=17

URL XML: https://api.cloudns.net/get-available-regions.xml
POST/GET:
auth-id=0&auth-password=password&check_type=17
sub-auth-id=0&auth-password=password&check_type=17


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