Retrieving a list of Monitor resources or the details of a specific DSF Monitor 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.
In order for monitoring to occur on your account, please make sure the IP addresses included here (https://manage.dynect.net/help/agents.html) can reach all your network endpoints. The web page requires you to log-on to Dyn’s Managed DNS.
Understanding How The API Works »
REST Syntax
Click to view all REST Resources |
/REST/DSFMonitor/ GET — Retrieves a list of Monitor resources, or the details of the specified Monitor.
HTTP Action — GET
URIs:
Get one Monitor — https://api.dynect.net/REST/DSFMonitor/<dsf_monitor_id>/
Get Monitors — https://api.dynect.net/REST/DSFMonitor/
|
Arguments:
Get one Monitor — No Arguments.
Get Monitors — Click for More Info
string label — Services with the specified label. Can be wild carded.
string probe_interval — How often to run the monitor.
string retries — How many retries the monitor should attempt on failure before giving up.
string protocol — The protocol to monitor.
|
Response:
Get one Monitor — Click for More Info
- string
dsf_monitor_id — Identifier for the Monitor.
- string
label — The unique label for the Monitor.
- string
protocol — The protocol to monitor.
Valid values:
HTTP
HTTPS
PING
SMTP
TCP
- string
active — Indicates whether or not the Monitor is active.
- string
response_count – Minimum required ‘up’ agent responses to report response pool host as ‘up’. If ‘up’ responses are less than the minimum, host is set to failover.
Valid values: 0, 1, 2 or 3.
- string
probe_interval — How often to run the monitor.
Valid values:
60 – Every minute
300 – Every 5 minutes
600 – Every 10 minutes
900 – Every 15 minutes
- string
retries — How many retries the monitor should attempt on failure before giving up.
- hash
options — Options that pertain to the Monitor.
- string
timeout — Time (in seconds) before the connection attempt times out.
- string
port — For HTTP(S)/SMTP/TCP probes, an alternate connection port.
- string
path — For HTTP(S) probes, a specific path to request.
- string
host — For HTTP(S) probes, a value to pass in to the Host: header.
- string
header — For HTTP(S) probes, additional header fields/values to pass in, separated by the newline character (\n).
- string
expected — Designate the data expected in the protocol response while monitoring the host in the pool. Maximum length: 255 bytes. Exceeding the maximum size will result in an ‘Invalid_Data’ error at run time with the message ‘Too long’. Field is case-sensitive. Exact string match required to return ‘up’ status. For HTTP(S) probes, a case sensitive sub-string to search for in the response. For SMTP probes, a string to compare the banner against. Not used for PING, or TCP protocols.
- hash
host_override – Override host data for specific endpoint addresses.
- string
address – Address of an endpoint.
- string
host – Host to use when checking that endpoint.
- array
endpoints — Endpoints that are associated with the Monitor.
- string
active — Indicates whether or not the endpoint is active.
- string
label — A label to identify the endpoint.
- string
address — The address to monitor.
Get Monitors — array — Individual Monitor resources.
|
SOAP Syntax
Click to view all SOAP Commands |
GetOneDSFMonitor — Retrieves information about an existing Monitor.
GetDSFMonitors — Retrieves information for all Monitors.
|
Arguments:
GetOneDSFMonitor — Click for More Info
string dsf_monitor_id — Required. Identifier for a Monitor.
string token — Required. The session identifier.
GetDSFMonitors — Click for More Info
string dsf_monitor_id — Identifier for a Monitor.
string label — Services with the specified label. Can be wild carded.
string probe_interval — How often to run the monitor.
string retries — How many retries the monitor should attempt on failure before giving up.
string protocol — The protocol to monitor.
string token — Required. The session identifier.
|
Response:
GetOneDSFMonitor — Click for More Info
- hash
data
- string
dsf_monitor_id — Identifier for the Monitor.
- string
label — The unique label for the Monitor.
- string
protocol — The protocol to monitor.
Valid values:
HTTP
HTTPS
PING
SMTP
TCP
- string
active — Indicates whether or not the Monitor is active.
- string
response_count – Minimum required ‘up’ agent responses to report response pool host as ‘up’. If ‘up’ responses are less than the minimum, host is set to failover.
Valid values: 0, 1, 2 or 3.
- string
probe_interval — How often to run the monitor.
Valid values:
60 – Every minute
300 – Every 5 minutes
600 – Every 10 minutes
900 – Every 15 minutes
- string
retries — How many retries the monitor should attempt on failure before giving up.
- hash
options — Options that pertain to the Monitor.
- string
timeout — Time (in seconds) before the connection attempt times out.
- string
port — For HTTP(S)/SMTP/TCP probes, an alternate connection port.
- string
path — For HTTP(S) probes, a specific path to request.
- string
host — For HTTP(S) probes, a value to pass in to the Host: header.
- string
header — For HTTP(S) probes, additional header fields/values to pass in, separated by the newline character (\n).
- string
expected — Designate the data expected in the protocol response while monitoring the host in the pool. Maximum length: 255 bytes. Exceeding the maximum size will result in an ‘Invalid_Data’ error at run time with the message ‘Too long’. Field is case-sensitive. Exact string match required to return ‘up’ status. For HTTP(S) probes, a case sensitive sub-string to search for in the response. For SMTP probes, a string to compare the banner against. Not used for PING, or TCP protocols.
- hash
host_override – Override host data for specific endpoint addresses.
- string
address – Address of an endpoint.
- string
host – Host to use when checking that endpoint.
- array
endpoints — Endpoints that are associated with the Monitor.
- string
active — Indicates whether or not the endpoint is active.
- string
label — A label to identify the endpoint.
- string
address — The address to monitor.
GetDSFMonitors — Click for More Info
- array
data
- string
dsf_monitor_id — Identifier for the Monitor.
- string
label — The unique label for the Monitor.
- string
protocol — The protocol to monitor.
Valid values:
HTTP
HTTPS
PING
SMTP
TCP
- string
active — Indicates whether or not the Monitor is active.
- string
response_count – Minimum required ‘up’ agent responses to report response pool host as ‘up’. If ‘up’ responses are less than the minimum, host is set to failover.
Valid values: 0, 1, 2 or 3.
- string
probe_interval — How often to run the monitor.
Valid values:
60 – Every minute
300 – Every 5 minutes
600 – Every 10 minutes
900 – Every 15 minutes
- string
retries — How many retries the monitor should attempt on failure before giving up.
- hash
options — Options that pertain to the Monitor.
- string
timeout — Time (in seconds) before the connection attempt times out.
- string
port — For HTTP(S)/SMTP/TCP probes, an alternate connection port.
- string
path — For HTTP(S) probes, a specific path to request.
- string
host — For HTTP(S) probes, a value to pass in to the Host: header.
- string
header — For HTTP(S) probes, additional header fields/values to pass in, separated by the newline character (\n).
- string
expected — Designate the data expected in the protocol response while monitoring the host in the pool. Maximum length: 255 bytes. Exceeding the maximum size will result in an ‘Invalid_Data’ error at run time with the message ‘Too long’. Field is case-sensitive. Exact string match required to return ‘up’ status. For HTTP(S) probes, a case sensitive sub-string to search for in the response. For SMTP probes, a string to compare the banner against. Not used for PING, or TCP protocols.
- hash
host_override – Override host data for specific endpoint addresses.
- string
address – Address of an endpoint.
- string
host – Host to use when checking that endpoint.
- array
endpoints — Endpoints that are associated with the Monitor.
- string
active — Indicates whether or not the endpoint is active.
- string
label — A label to identify the endpoint.
- string
address — The address to monitor.
|
Example Request (GetOneDSFMonitor) — Click for More Info
{
'dsf_monitor_id' => 'ab32f...', # ID shortened...
'token' => 'asdlj34ot879834cdzjklfK'
}
Example Request (GetDSFMonitors) — Click for More Info
{
'dsf_monitor_id', => '0b95k...', # ID shortened...
'label' => 'Primary Monitor',
'probe_interval', => '300',
'retries', => '3',
'protocol', => 'HTTPS'
'token' => 'asdlkfjasl23j4879afa',
}
|
DNS API Knowledge Base