Universal DDI API Guide

Before going through the list of available APIs, review the prerequisite information provided in the following sections.

API Keys

API keys are required to run the API calls. The API keys for a user are available in the Infoblox Portal. To copy the API keys, complete the following:

1. Log on to the Infoblox Portal.
2. Go to <User_Name> > User Profile.
3. Go to User API Keys page.
4. Click Create to create a new API key. Specify the following:
   • Name: Specify the name of the key.
   • Expires at: Specify the expiry.
5. Click Save & Close. The API Access Key Generated dialog is shown.
6. Click Copy. 

Once an API key is created, you can perform the following actions:

• Disable: Select the API key and click Disable. When an API key is disabled, it cannot be used unless it is enabled. 
• Enable: Select the API key and click Enable. When a key is created, it is enabled by default.
• Delete: Select the API key and click Delete. 

Base URL and Operation Specific URL

The base URL (/ddi/v1) is to indicate the API version and the product name, while the following part(/dhcp/filter) is the application/object_name. To perform a complete API call you need both parts. The exact path will depend on which cluster you are issuing the call against. 

Inheritance

When performing an API call, the local values are returned by default. To include the inherited values in the output, use _inherit=full with the API call. 

Example Curl commands

Here are some examples of the curl command to make the API call:

Get all DHCP fixed addresses:

curl -H "AUTHORIZATION:TOKEN <$API_KEY>" -X GET https://csp.infoblox.com/api/ddi/v1/dhcp/fixed_address

List all subnets (local values are returned by default):

curl -H "AUTHORIZATION:TOKEN <$API_KEY>" -X GET https://csp.infoblox.com/api/ddi/v1/ipam/subnet

List all subnets (return values inherited from a parent):

curl -H "AUTHORIZATION:TOKEN <$API_KEY>" -X GET https://csp.infoblox.com/api/ddi/v1/ipam/subnet?_inherit=full

Universal DDI uses Swagger to publish and deliver its APIs. For a list of available APIs, click the following link:

https://csp.infoblox.com/apidoc. 

Below is a list of currently supported application APIs along with their descriptions.

•  BloxOne Anycast API 

https://csp.infoblox.com/apidoc/?url=https%3A%2F%2Fcsp.infoblox.com%2Fapidoc%2Fdocs%2FAnycast

Anycast-enabled application setups use multiple on-premises installations for one particular application type. Multiple application instances are configured to use the same endpoint address. Anycast capability is collocated with such application instance, monitoring the local application instance and advertising to the upstream router (a customer equipment) a per-instance, local route to the common application endpoint address, as long as the local application instance is available. Depending on the type of the upstream router, the customer may configure local route advertisement via either BGP (Boarder Gateway Protocol) or OSPF (Open Shortest Path First) routing protocols. Both protocols may be enabled as well. Multiple routes to the common application service address provide redundancy without the need to reconfigure application clients.Anycast capability enables HA (High Availability) configuration of BloxOne applications that run on equipment located on customer’s premises (on-prem NIOS-X Servers). Anycast supports DNS, DHCP, as well as DNS-forwarding services.

Should an application instance become unavailable, the local route advertisements stop, resulting in withdrawal of the route (in the upstream router) to the application instance that has gone out of service and ensuring that subsequent application requests thus get routed to the remaining available application instances.

• IP Address Management (Ipamsvc API)

https://csp.infoblox.com/apidoc/?url=https://csp.infoblox.com/apidoc/docs/Ipamsvc

The IPAM/DHCP application is a Universal DDI service providing IP address management and DHCP protocol features. The IPAM component provides visibility and provisioning tools to manage networking spaces, monitoring and reporting of entire IP address infrastructures, and integration with DNS and DHCP protocols. The DHCP component provides DHCP protocol configuration service with on-prem NIOS-X Server serving DHCP protocol. It is part of the full-featured, DDI cloud solution enabling customers to deploy large numbers of protocol servers in delivering DNS and DHCP throughout their enterprise network.

• DNS Configuration (DNSConfig API)

https://csp.infoblox.com/apidoc/?url=https://csp.infoblox.com/apidoc/docs/DnsConfig

The DNSconfig application is a Universal DDI service providing cloud-based DNS configuration with on-prem NIOS-X Server serving DNS protocol. It is part of the full-featured, DDI cloud solution enabling customers to  deploy large numbers of protocol servers in the delivery of DNS and DHCP throughout their enterprise network.

• DNS Data (DnsData API)

https://csp.infoblox.com/apidoc/?url=https://csp.infoblox.com/apidoc/docs/DnsData

The DNS Data is a Universal DDI service providing primary authoritative zone support. DNS Data is authoritative for all DNS resource records and is acting as a primary DNS server. It is part of the full-featured, DDI cloud solution that enables customers to deploy large numbers of protocol servers to deliver DNS and DHCP throughout their enterprise network.

• DHCP Leases (DHCP Leases API)

https://csp.infoblox.com/apidoc/?url=https://csp.infoblox.com/apidoc/docs/DhcpLeases

The DHCP Leases application is a Universal DDI service that stores information about leases. Please note, NIOS-X Servers are authoritative for their lease data. Changes to leases are periodically replicated to the cloud  and stored by this service for display purposes. There is no lease history, so only current leases are available; i.e., every dhcp/NIOS-X Server_lease, or dhcp/lease represents a lease which is currently active. Fixed  addresses do not have leases.

• DDI Keys (DDI Keys API)

 https://csp.infoblox.com/apidoc/?url=https://csp.infoblox.com/apidoc/docs/DDIKeys

The DDI Keys application is a Universal DDI service for managing TSIG keys and GSS-TSIG (Kerberos) keys which are used by other Universal DDI applications. It is part of the full-featured, DDI cloud solution that enables customers to deploy large numbers of protocol servers to deliver DNS and DHCP throughout their enterprise network.