How can we help?

How to enable the Cisco Firepower Threat Defence firewall using the Device API

Follow

For the Cisco Firepower Threat Defence firewall, follow these instructions to enable the Device API.

Note: These instructions are valid for FTD or FDM.

For the Device API credentials, use your admin username and password that you use to login into the user interface of Firepower. 

  1. Go to Admin
  2. Click on Manage Credentials
    Screenshot 2024-08-19 at 9.43.11 AM.png
  3. Click on Device API Credentials
    Screenshot 2024-08-19 at 9.52.27 AM.png
  4. Mouse over Add Device API Credentials
  5. On the drop down that appears, click Firepower
    Screenshot 2024-08-19 at 9.55.16 AM.png
  6. Enter credentials for your Firepower
    Screenshot 2024-08-19 at 10.00.21 AM.png
    1. Name - a name or description for use in Auvik only
    2. Device - the device name that the API key is for
    3. Username - add admin account username 
    4. Password - admin’s password
    5. Port - the port that the API/HTTP service is running
      • This will auto fill with 443 - only change if you know you are using a different port.
  7. Click Test Connection to confirm your settings are accurate.
  8. Click Save.

If you are getting errors or the device failed in test connection you can try the following troubleshooting steps. You can check the authentication from API-Explorer.

  1. Using a browser, open the homepage of the system, for example, https://ftd.example.com.
  2. Log into Firepower Device Manager.
  3. (6.4 and earlier.) Edit the URL to point to /#/api-explorer, for example, https://ftd.example.com/#/api-explorer.
  4. (6.5 and later.) Click the more options button (More options button.) and choose API Explorer.
    The system opens the API Explorer in a separate tab or window, depending on your browser settings.
  5. Once you are in the API Explorer, search for Token and click on Example Value
    FTD_2.png
  6. This will update the Body. Change the “grant_type” from “custom_token” to    “password” 
  7. Update the username and password to the credentials that you used to login.
    FTD_3.png
  8. Scroll down to the Try it out option and look for ​​Response Code. It must be 200 in order to work.
Was this article helpful?
0 out of 8 found this helpful
Have more questions? Submit a request