NOTICE: On February 28, 2017, Dyn will implement changes to how Alerts are managed. Learn more.

Welcome to the Internet Performance Alerts API Quick-Start Guide! This guide is meant to be a non-programming look at Dyn’s Internet Performance Alerts API and will cover the conceptual steps needed to use the API.

Note for Users who also use Internet Intelligence’s UI: Performance Monitoring status does not display on the Inventory view in the UI. The Monitor toggle switch is accurate for Routing Alerts only.

Connected to Internet Routing Alerts

Internet Performance Alerts API works with Internet Routing Alerts API. Both of these products are components of Dyn’s Internet Intelligence. Any inventory created by either Internet Routing Alerts or Internet Performance Alerts is created in the Internet Intelligence Portfolio. Internet Performance Alerts can be setup to monitor any IP address contained in an Internet Intelligence Portfolio Inventory.  Some commands in the APIs are shared between Internet Routing Alerts and Internet Performance Alerts.

Express Configuration Option

Express Configuration provides a simple semi-automated setup that is sufficient for most customers.

To Manually Setup Performance Alerts:

Most customers find that the Express Configuration suits their needs, However, if you need to configure Internet Performance Alerts manually, use these instructions.

  1. Find / obtain your username and password for your Internet Performance Alerts account with Dyn.
  2. Create a Internet Performance Alerts Inventory (API) or use a currently existing Internet Routing Alerts Inventory, if you have both products.
  3. Use the instructions in Update Email Settings (API) to send the alerts to your email inbox.
  4. Make sure that you Enable Performance Monitoring (API) on each Inventory to monitor.
  5. Add one or more IP addresses (API) to your Inventory. Only IP addresses that are listed as inventory assets are monitored by the Internet Performance Alerts API.
  6. Finally, you can Configure (Add) Internet Performance Alerts (API) on each IP address to monitor.

Authentication

To invoke the Routing Alerts API, each request requires an API-DynID and a API-Key combination for authentication.

These fields are separated by a colon for basic authentication, e.g. API-DynID:API-Key.

Typically, the API-Key will contain many special characters and you should wrap the API-DynID:API-Key in single quotes if using curl on the command line:

e.g. curl -u '{API-DynID}:{API-Key}' {URL}.

You can generate the API DynID and API Key using the instructions found here: Create Internet Intelligence API Users and Keys (API Key Creation).

Legacy Authentication

Older Internet Intelligence users may use this method of
The API uses HTTPS with Basic Authentication, so make sure that your HTTP client library or tool supports basic auth.

For example, this document uses the cURL command-line tool, which supports basic auth using -u:

curl -u 'you@example.com:yourpassword' ...

where you@example.com is your DII username.

In the rest of this document, we’ll use username:password as the login credentials.

Legacy URL

If you do not have a DynID, or login to Internet Intelligence with Renesys credentials, you will need to access the Internet Intelligence API via a different URL. Instead of using https://dii.dynapis.com/, you will use https://api.renesys.com/ to access the API.

EXAMPLE: For the call GET /portfolio/monitoring/types

DynID users: https://dii.dynapis.com/portfolio/monitoring/types
Renesys users: https://api.renesys.com/portfolio/monitoring/types

Response Status Codes

The following status codes will be used in responses from calls to the API:

Status Code Definition Meaning
200 OK Successful API call. Seen when requesting the current settings, for example.
201 Created Your request successfully created a new resource or updated an existing resource. Should only be a PUT or POST request.
204 No Content Your request succeeded, but there is no information to return. Typically seen in response to DELETE, PUT, or POST requests.
400 Bad Request There is an error in your request: typically either the request body or request parameters are invalid. With 400 errors, the response body is a JSON object with a ‘message’ member that explains the error. Check the documentation, fix your error, and try again.
401 Unauthorized You did not supply HTTP Basic Authentication credentials (username and password) in your request.
403 Forbidden Your username and/or password were incorrect.
405 Method Not Allowed You sent a request for a resource using an unsupported HTTP method. For example, you tried to DELETE a resource that only supports GET, or POST to a resource that only supports PUT and GET.
500 Internal Server Error There’s a problem on our end. Please wait a moment and try again. If the error persists, please contact Dyn’s support (concierge@dyn.com).