How can we help?

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

Follow

Auvik can use the Cisco Secure Firewall Threat Defense (FTD) REST API to collect inventory and monitoring information from your firewall.

These instructions apply to:

  • Cisco Secure Firewall Threat Defense (FTD)
  • Firepower Device Manager (FDM)-managed devices

Note: Auvik uses the same username and password that you use to log in to the FTD management interface. No separate API token needs to be manually created.

Add Device API Credentials in Auvik

  1. Navigate to Admin > Manage Credentials.

.Screenshot 2024-08-19 at 9.43.11 AM.png

  1. Click Device API Credentials.

Screenshot 2024-08-19 at 9.52.27 AM.png

  1. Hover over Add Device API Credentials.
  2. Select Firepower.

Screenshot 2024-08-19 at 9.55.16 AM.png

  1. Enter the device information.

Screenshot 2024-08-19 at 10.00.21 AM.png

Complete the following fields:

FieldDescription
NameA descriptive name used within Auvik.
DeviceThe firewall device the credentials will be assigned to.
UsernameThe FTD administrator username.
PasswordThe password associated with the administrator account.
PortThe HTTPS management port used by the FTD REST API. The default is 443. Change this only if your management interface uses a different port.
  1. Click Test Connection.
  2. Verify the test succeeds.
  3. Click Save.

Prerequisites

Before testing the connection, verify the following:

  • HTTPS access to the FTD management interface is enabled.
  • The Auvik collector can reach the management IP address.
  • TCP port 443 (or the configured management port) is accessible.
  • The administrator account is active and not locked.
  • The account has sufficient permissions to access the FTD management API.
  • Local or external authentication services (LDAP, RADIUS, TACACS+) are functioning correctly if used for administrator authentication.

Troubleshooting API Authentication

If the test connection fails, verify that API authentication is functioning correctly using the API Explorer.

Open API Explorer

  1. Open a web browser and navigate to the FTD management interface.

Example:

https://ftd.example.com
  1. Log in to Firepower Device Manager.

For FTD 6.4 and earlier:

Append the following path to the URL:

/#/api-explorer

For FTD 6.5 and later:

  1. Click the More Options menu.
  2. Select API Explorer.

The API Explorer opens in a new browser tab or window.

Test Token Authentication

  1. Search for Token within API Explorer.
  2. Select Example Value.

FTD_2.png

The request body will be populated automatically.

Modify the request:

  • Change "grant_type" from "custom_token" to "password".
  • Enter the same username and password configured in Auvik.

Example:

{
  "grant_type": "password",
  "username": "admin",
  "password": "password"
}
  1. Scroll to the Try It Out section.
  2. Execute the request.

FTD_3.png

Verify the Response

A successful authentication returns:

Response Code: 200

A response code of 200 confirms:

  • The username and password are valid.
  • The API service is functioning correctly.
  • Auvik should be able to authenticate using the same credentials.

If you receive a different response code:

Response CodePossible Cause
401Invalid username or password
403Insufficient permissions
404Incorrect API endpoint
500Internal FTD error

Additional Troubleshooting

If authentication continues to fail:

  • Verify the management IP address configured in Auvik is correct.
  • Confirm the management interface allows HTTPS connections from the Auvik collector.
  • Verify any firewalls or access control policies allow communication between the collector and the FTD.
  • Check whether administrator authentication is handled through an external identity provider.
  • Review FTD system logs for authentication or API-related errors.

Authentication Successful

Once the credentials have been successfully validated and saved, Auvik will begin collecting available information from the firewall through the FTD REST API.

Depending on polling intervals, newly collected information may take several minutes to appear within Auvik.



 

Was this article helpful?
0 out of 10 found this helpful
Have more questions? Submit a request