Document toolboxDocument toolbox

The Infoblox API

Infoblox APIs are RESTful web services that allow users to interact with the Infoblox Platform. APIs are available for the two primary applications powered by the Infoblox Platform and include the following:

  • Infoblox Threat Defense APIs—these enable organizations to manage the network security aspect of the Infoblox Threat Defense infrastructure.

  • Universal DDI APIs— these are used to manage and automate Infoblox DDI services in the cloud.

Getting Started with the Infoblox API

To begin using the Infoblox API, complete the following:

  1. Set up your Infoblox account [optional]
    If you have not already set up a Infoblox account, then contact your sales representative at Infoblox to get a Infoblox account.

  2. Create service accounts
    For integrations, enable third-party applications to access the Infoblox Portal through the API. This is accomplished by establishing service account users. By design, service account users are not allowed to sign in to the Infoblox Portal. Instead, you will create API keys for their use that grant access. Each service API key is associated with a service account user. A service account user can be associated with up to 10 service API keys. For information, see Configuring Service API Keys.

  3. Understand authentication of API requests
    An API key is an authentication token that is passed on to the Infoblox API to facilitate user (interactive or service) authentication in an API request. The API key acts as a secret token for authentication, and is assigned a set of access that is specific to a user. Any users that are allowed to log in to the Infoblox Portal can create user API keys for themselves. The user API key can be used to track and control how the API is being used, such as preventing malicious use or abuse of the API.

    To authenticate API requests, you should pass an HTTP “Authorization” header with the API key and the prefix “Token.”

    The following is an example API request using curl commands in JSON format:
    curl -k -i -H "Authorization: Token <YOUR API Key>" "https://csp.infoblox.com/api/dnsdata/v2/dns_event?source=rpz&t0=1483228800&t1=1514764799"

  4. Create your API key
    To create an API key, perform the following:
    1. Inside the Infoblox Portal, navigate to the User Profile page ( your username> User Profile).


    The User Profile
    Image: User Profile

    2. On the User Profile page, click User API Keys followed by Create.
    3. In the Create User API Key pane, specify the Name (required) and the Expiry Date. Ensure that the expiry date is set to a later date from the day you create this API key.

    The Create User API Key dialogue
    Image: The Create User API Key dialogue

    4. Click Save & Close to execute the API call.

Setting Up Your Infoblox Account

To set up your Infoblox account for use with Infoblox API, complete the following

  1. If you have not already set up a Infoblox account, then contact your sales representative at Infoblox to get a Infoblox account.

  2. Create your API key. Infoblox APIs require a key to be provided for authentication.