Create notification

Description

Create monitoring notification


Parameters

Name Data Type Status Description
auth-id Integer Required Authentication parameter
auth-password String Required Authentication parameter
id Integer Required The ID of the monitoring check
type String Required The type of notification. It can be either webhook-up, webhook-down, or mail
value String Required The notification email or URL address

Response: Status and message.


Errors

When the authenctication 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."}

When the record-id is incorrect or missing, any API request will fail with the following status and statusDescription:

{"status":"Failed","statusDescription":"Invalid request."}

When the type of the notification is incorrect, any API request will fail with the following status and statusDescription:

{"status":"Failed","statusDescription":"Invalid notification type."}

Note: These are example errors in JSON format.


Example

URL JSON: https://api.cloudns.net/monitoring/add-notification.json
Domain POST/GET: auth-id=0&auth-password=password&id=125&type=webhook-up&value=https://example.com

URL XML: https://api.cloudns.net/monitoring/add-notification.xml
Domain POST/GET: auth-id=0&auth-password=password&id=125&type=webhook-up&value=https://example.com


Last modified: 2022-04-28
Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more