Retrieving one or more notifiers 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.
Understanding How The API Works
Understanding Notifications
REST Syntax
Click to view all REST Resources |
/REST/Notifier/ GET – Retrieve one or more Notifier resources.
HTTP Action — GET
URIs:
Get One Notifier — https://api.dynect.net/REST/Notifier/<notifier_id>/
Get Notifiers — https://api.dynect.net/REST/Notifier/
|
Arguments:
Get One Notifier: Retrieves the details of the specified Notifier.
Get Notifiers: Retrieves a list of Notifier resources.
- string
label — The label used to identify the Notifier object. Can be wildcarded.
NOTE: The wildcard character is an asterisk ( * ). For example, searching on ( test* ) will return any value with the word test followed by other characters. Some examples are: miketest123, test123, and testcase.
- string
format — Search for type of recipient
- string
recipient — Search on the recipient email or contact.
- string
recipient_active — Search for active or inactive recipients.
- string
service_class — Notify when the monitored object has recovered. Defaults to ‘true’.
- string
service_id — service_id of the service_class item to search for. MUST be paired with service_class.
- string
service_active — Search for active or inactive services.
- string
active — Search for active or inactive notifiers
|
Response:
Get One Notifier — 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.
Get Notifiers: Array of Individual Notifier resources.
|
SOAP Syntax
Click to view all SOAP Commands |
GetOneNotifier — Retrieve the identified Notifier.
GetNotifiers — Retrieve Notifiers based on the given criteria.
|
Arguments:
GetOneNotifier:
- notifier_id — Required. Identifier for the Notifier.
- token — Required. Session identifier.
GetNotifiers — Click for More Info
- string
label — The label used to identify the Notifier object. Can be wildcarded.
NOTE: The wildcard character is an asterisk ( * ). For example, searching on ( test* ) will return any value with the word test followed by other characters. Some examples are: miketest123, test123, and testcase.
- string
format — Search for type of recipient
- string
recipient — Search on the recipient email or contact.
- string
recipient_active — Search for active or inactive recipients.
- string
service_class — Notify when the monitored object ha recovered. Defaults to ‘true’.
- string
service_id — service_id of the service_class item to search for. MUST be paired with service_class.
- string
service_active — Search for active or inactive services.
- string
active — Search for active or inactive notifiers
- token — Required. Session identifier.
|
Response:
GetOneNotifier — 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.
GetNotifiers — 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.
- 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 Requests:
GetOneNotifier — Click for More Info
{
'notifier_id' => '2389b...',
'token' => 'asdlj34ot879834cdzjklfK'
}
GetNotifiers — Click for More Info
{
'notifier_id' => '2389b...',
'label' => 'Default*',
'format' => 'email',
'token' => 'asdlj34ot879834cdzjklfK'
}
|
<< DNS API Knowledge Base