About the API Explorer

About the API Explorer

The API Explorer provides a limited interface for the REST API as well as giving a view of the abilities of the REST API.

The API Explorer resides on the Firepower Management Center, and can be accessed via the Firepower Management Center at:

https://<management_center_IP_or_name>:<https_port>/api/api-explorer

This explorer provides the list of APIs available on the Firepower Management Center, and their details.

Authentication to the API Explorer

The REST API relies on the same authentication as the Firepower Management Center. Each function in the REST API maps to permissions in the Firepower Management Center.

You can log into the API Explorer using any account on the Firepower Management Center, but you will only be able to perform the functions for which the account has permissions. For more information on setting permissions for user roles, see the Firepower Management Center Configuration Guide.

The first time you connect to the API Explorer you may receive an error that the connection is not secure due to an invalid certificate. You will need to add an exception in your browser to use the certificate and accept the connection.

Setting the Domain

The REST API can perform functions globally, in the default domain, or in specific domains.

Before You Begin

You must have a configured Firepower Management Center, an account with permissions to access the REST API in one or more domains configured on your FMC.

In the upper right, drop down the Domains menu and select the desired domain.

What to Do Next

Locate the desired resource and request type.

Obtaining Sample Code

You can use the Export Operation button in API Explorer to save the displayed method example as a Python or Perl script file to your local host. This script can be used to make that REST call, and can be integrated into your application. This is meant primarily as an educational and bootstrapping tool.

Python: The Python scripts require you to install Python, available from https://www.python.org/. Once you’ve installed Python, you can run your script with python script.py username password.

Perl: Using the Perl scripts requires some additional set-up—you need five components:

Perl package, found at http://www.perl.org/

Bundle::CPAN, found at http://search.cpan.org/~andk/Bundle-CPAN-1.861/CPAN.pm

REST::Client, found at http://search.cpan.org/~mcrawfor/REST-Client-88/lib/REST/Client.pm