Create a monitoring check
Name | Data Type | Status | Description |
auth-id | Integer | Required | Authentication parameter |
auth-password | String | Required | Authentication parameter |
name | String | Required | Name of the monitoring check |
check_type | Integer | Required |
Monitoring check types for this Failover:
|
ip | String | Optional | The IP address which will be monitored, it is required for all checks except the Heartbeat check. |
status_change_checks | Integer | Optional | The number of checks to confirm the change of status. By default, the value is 1. |
monitoring_region | String | Optional |
Parameter required if you would like to specify a monitoring region or country. Possible values:
You can also specify a single node to make the checks. To achieve this, you need to list the available nodes by using this API method. Find the ID of the node you want to use and write it in the monitoring_region parameter. Example: monitoring_region=270. Disclaimer: If the node is down the check status will be Unknown! |
host | String | Optional | Parameter required for HTTP, HTTPS, Custom HTTP, Custom HTTPS, DNS and TLS (SSL) certificate check types. It must contain a hostname (FQDN). |
port | Integer | Optional | Parameter required for HTTP, HTTPS, Custom HTTP, Custom HTTPS, TCP, UDP, TLS (SSL) certificate and SMTP check types. It must contain the port of the server. For TCP/UDP is a port on the Main IP. |
path | String | Optional | Parameter for HTTP, HTTPS, Custom HTTP and Custom HTTPS check types. If there is a specific path on the FQDN, it must be filled in this parameter. |
content | String | Optional | Parameter required for Custom HTTP and Custom HTTPS check types. In case you require a specific output to be returned, it must be filled in this parameter (e.g. OK). |
open_port | String | Optional |
Parameter required for TCP and UDP check types:
|
query_type | String | Optional | Parameter required for DNS check type. It must contain the record type (e.g. A). |
query_response | String | Optional | Parameter required for DNS check type. You must fill in the response of the DNS server for this specific record. |
check_period | Integer | Optional |
Time-frame between each monitoring check. Possible values:
|
state | Integer | Optional |
Default value is Active. Possible values:
|
http_status_code | Integer | Optional | HTTP status code the monitored server will return. It can be between 100 and 599. |
timeout | Integer | Optional | Seconds to wait for the server to reply. For Ping monitoring checks must be between 1 and 5. Default value is 2. For HTTP/HTTPS monitoring checks must be between 4 and 10. Default value is 5. |
content_match | String | Optional | Is the expected content an exact match or is it a keyword in the returned content from the server? The default value is - exact match. Possible values:
|
custom_header | String | Optional | Custom header name for HTTP/S check. The header name must contain only Latin letters (upper and/or lowercase), dash, and/or underscore (a-zA-Z-_). |
custom_header_value | String | Optional | Custom header value for HTTP/S check. |
latency_limit | Double | Optional | Only for Ping monitoring checks. If the latency of the check is above the limit, the check will be marked as DOWN. |
cacert | String | Optional |
Self Signed Root CA for TLS/SSL monitoring checks. Write your CA CERT. |
http_request_type | String | Optional |
Only for HTTP/S checks. The request type will be used for the check. The default value is GET. Possible values:
|
ip_type | Integer | Optional | If you have entered a hostname for the IP/Host of the monitoring check, you can specify what IP type to be checked, IPv4, IPv6 or both if present. The default value is 1 - IPv4 and IPv6. Possible values:
|
url | String | Optional | Used for Streaming monitoring check type. Write the URL of the streaming service you want to be checked. |
audio_threshold | Double | Optional | Used for Streaming monitoring check type. Enter a number between -91 and 0. If the volume is below that number the check will be marked as Down! If left empty the volume will not be considered! |
When the authentication of 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 you have entered a missing, or invalid name, the following status will be returned:
{"status":"Failed","statusDescription":"Name is mandatory, it should be no longer than 32 characters and can only contain a-z, A-Z, 0-9, -, ., and space characters."}
If the value for "check_type" is missing, or invalid, the following status will be returned:
{"status":"Failed","statusDescription":"This is invalid monitoring type."}
If the value for "ip" is missing, or invalid, the following status will be returned:
{"status":"Failed","statusDescription":"Invalid IP address"}
Note: These are example errors in JSON format, and these are not the only errors that can be displayed.
URL JSON: https://api.cloudns.net/monitoring/create.json
POST/GET: auth-id=0&auth-password=password&name=name&check_type=5&ip=127.0.0.1&host=cloudns.net&port=443&check_period=600
URL XML: https://api.cloudns.net/monitoring/create.xml
POST/GET: auth-id=0&auth-password=password&name=name&check_type=5&ip=127.0.0.1&host=cloudns.net&port=443&check_period=600