Introduction
Cisco Umbrella provide an API to dynamically update your registered network IP address. The API is available at updates.opendns.com.
The API is a simple way to keep your Umbrella Network IP addresses up to date when using a dynamic public IP address. This method is widely supported by many clients including third-party routers.
NOTE: We do not recommend using DNS-O-Matic for Umbrella customers, instead, using this API is a more robust and easily used way to achieve the same thing for most customers.
Performing Dynamic Updates
Many third-party routers and other devices will automatically perform Dynamic Updates for you. Simply configure the device with the following Dynamic Update settings:
- Server: updates.opendns.com
- Protocol: HTTPS
- Port: 443
- Hostname: <Umbrella Network Name>
- User: Umbrella username (e-mail)
- Password: Umbrella password
By default you authenticate using the normal username/password used to login to your Umbrella account. Optionally, Umbrella support can generate a secondary password to use for Dynamic Updates only. The secondary password will be required if your organization is configured for SSO/SAML.
API Information
The URL used for manual or scripted updates is as follows:
https://<user>:<password>@updates.opendns.com/nic/update?hostname=<Umbrella Network Name>
This is an implementation of the Remote Access Update API designed by Dyn. All clients that support this API completely and communicate over SSL will properly update Umbrella network IP address information.
For complete documentation regarding the API please see the Dyn Website.
Umbrella uses the standard Dynamic DNS result codes, but we have modified the use of some of these codes to add key functionality. The meaning of each result code is documented below.
| Dynamic DNS Result Code | Umbrella Interpretation | Use According to Specification |
|---|---|---|
| badauth | Username and password credentials are invalid or do not match an existing Umbrella account. | The username and password pair do not match a real user. |
| nohost | Umbrella account specified does not have a network enabled for dynamic IP updates. Follow this link for more information. | The hostname specified does not exist in this user account (or is not in the service specified in the system parameter). |
| good | The update was successful or not needed (the IP address has not changed since last update). Umbrella filtering and security settings are applied as configured on this network. | The update was successful, and the hostname is now updated. |
| !yours | The IP address provided is part of a larger block of addresses managed by another Umbrella administrator or the IP address is being used by someone else. Please see Error Messages for more information. | The hostname specified exists, but not under the username specified. |
| abuse | Umbrella received more than one update per minute for a set period of time. | The hostname specified is blocked for update abuse. |
| 911 | There is a problem or scheduled maintenance on the server side. Please contact Umbrella support. | There is a problem or scheduled maintenance on the server side. |
Comments
0 comments
Article is closed for comments.