Before going through the list of available APIs, review the prerequisite information provided in the following sections.
API keys are required to run the API calls. The API keys for a user are available in the Cloud Services Portal. To copy the API keys, complete the following:
- Log on to the Cloud Services Portal.
- Go to <User_Name> -> User Preferences.
- Go to the API Keys.
- Click Show Keys. This step is optional.
- Click Copy.
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.
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
BloxOne DDI uses Swagger to publish and deliver its APIs. For a list of available APIs, click the following link:
Below is a list of currently supported application APIs along with their descriptions.
- BloxOne Anycast API
Anycast capability enables HA (High Availability) configuration of BloxOne applications that run on equipment located on customer’s premises (on-prem hosts). Anycast supports DNS, as well as DNS-forwarding services.
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.
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)
The IPAM/DHCP application is a BloxOne 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 host 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)
The DNSconfig application is a BloxOne DDI service providing cloud-based DNS configuration with on-prem host 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)
The DNS Data is a BloxOne 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)
The DHCP Leases application is a BloxOne DDI service that stores information about leases. Please note, hosts 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/host_lease, or dhcp/lease represents a lease which is currently active. Fixed addresses do not have leases.
DDI Keys (DDI Keys API)
The DDI Keys application is a BloxOne DDI service for managing TSIG keys which are used by other BloxOne 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.
This page has no comments.