Create notification

Description

Create failover notification


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
domain-name String Required The domain where the failover notification is
record-id Integer Required Record ID. You can see this ID with the method List records
type String Required The type of notification. It can be either webhook-up, webhook-down, mail, sms, telegram or discord
code String Required The phone code of your mobile number for SMS notifications. The Telegrams BotToken or the Discords Token.
value String Required The notification email,URL address, phone number or custom message
chat-id String Required The Telegrams chat Id, or Discords channel Id

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/dns/create-failover-notification.json
Domain POST/GET: auth-id=0&auth-password=password&domain-name=example.com&record-id=125&type=mail&value=example@example.com

URL XML: https://api.cloudns.net/dns/create-failover-notification.xml
Domain POST/GET: auth-id=0&auth-password=password&domain-name=example.com&record-id=125&type=webhook-up&value=https://example.com


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