Understanding How The API Works
Understanding Notifications
Creating a notifier using the API requires specific syntax depending on whether you are using REST or SOAP. Use this table to find the syntax for your command.
REST Syntax
| Click to view all REST Resources |
| /REST/Notifier/ POST — Create a new Notifier.
HTTP Action — POST
URIs — https://api.dynect.net/REST/Notifier/ |
Arguments — Click for More Info
- string
label — Required. The label used to identify the Notifier object.
- array
recipients — List of Recipients attached to the Notifier.
- string
format — Required. Type of endpoint.
Valid values:
email
- string
recipient — Required. Varies dependent uponformat.
Email = valid address or contact name.
- array
features — List of string. For emailformat, use ‘detailed’.
- array
services — List of services attached to the Notifier.
- string
service_class — Required. Must be specified with service_id.
Type of service attached:
Traffic Director (DSF)
Monitor
- string
service_id — Required. ID of the service to attach.
- string
active — Indicates whether or not the service should be notified.
|
Response — Click for More Info
- string
notifier_id — The id of the Notifier object.
- string
label — The label used to identify the Notifier object.
- array
recipients — List of Recipients attached to the Notifier.
- string
format — Type of endpoint.
Valid values:
email
- string
recipient — Varies dependent upon the type.
Email = valid address or contact name.
- array
features — List of string. For emailformat, use ‘detailed’.
- array
services — List of services attached to the Notifier.
- string
service_class Type of service attached:
Traffic Director (DSF)
Monitor
- string
service_id — ID of the service to attach.
- string
active — Indicates whether or not the service should be notified.
- string
active — Indicates whether or not the Notifier is active.
|
SOAP Syntax
| Click to view all SOAP Commands |
| CreateNotifier — Creates a new Notifier. |
Arguments — Click for More Info
- string
label — Required. The label used to identify the Notifier object.
- array
recipients — List of Recipients attached to the Notifier.
- string
format — Required. Type of endpoint.
Valid values:
email
- string
recipient — Required. Varies dependent uponformat.
Email = valid address or contact name.
- array
features — List of string. For emailformat, use ‘detailed’.
- array
services — List of services attached to the Notifier.
- string
service_class — Required. Must be specified with service_id.
Type of service attached:
Traffic Director (DSF)
Monitor
- string
service_id — Required. ID of the service to attach.
- string
active — Indicates whether or not the service should be notified.
string token — Required. The session identifier.
|
Response — Click for More Info
- hash
data
- string
notifier_id — The id of the Notifier object.
- string
label — The label used to identify the Notifier object.
- array
recipients — List of Recipients attached to the Notifier.
- string
format — Type of endpoint.
Valid values:
email
- string
recipient — Varies dependent upon the type.
Email = valid address or contact name.
- array
features — List of string. For emailformat, use ‘detailed’.
- array
services — List of services attached to the Notifier.
- string
service_class Type of service attached:
Traffic Director (DSF)
Monitor
- string
service_id — ID of the service to attach.
- string
active — Indicates whether or not the service should be notified.
- string
active — Indicates whether or not the Notifier is active.
|
Example Request — Click for More Info
{
'label' => 'Default Notifier',
'recipients' => [{
'format' => 'email',
'recipient' => 'bob@example.com'
}],
'services' => [{
'service_class' => 'DSF',
'service_id' => 'a82ba...', # ID Shortened
'active' => 'N'
}]
'token' => 'asdlj34ot879834cdzjklfK'
}
|
<< DNS API Knowledge Base
