Introduction to the FXOS REST API

You can use the FXOS REpresentational State Transfer (REST) Application Programming Interface (API), over HTTPS, to interact with FXOS device services through a client program. The REST API uses JavaScript Object Notation (JSON) format to represent objects.

The “FXOS API” encompasses both Platform and Firepower Chassis Services APIs, including both Configuration and Monitoring APIs. These APIs are solely for the Platform services provided by the Firepower eXtensible OS (FXOS).

The FXOS API includes an API Explorer that describes the resources and JSON objects available for your programmatic use. The Explorer provides detailed information about the attribute-value pairs in each object, and you can experiment with the various HTTP methods to ensure you understand the use of each resource. The API Explorer also provides examples of the URLs required for each resource.

You can also find reference information and examples online at https://developer.cisco.com/docs/cisco-firepower-chassis-manager-rest-api-reference/#!cisco-firepower-chassis-manager-rest-api-reference/introduction.

Accessing the FXOS API Explorer

The FXOS API Explorer describes the resources and JSON objects available for your programmatic use. The Explorer provides detailed information about the attribute-value pairs in each object, and you can experiment with the various HTTP methods to ensure you understand the coding required to use each resource.

Procedure

Step 1

Using a browser, open the home page of the system, for example, https://fcm.example.com.

Step 2

Log into Firepower Chassis Manager.
Step 3

Open the FXOS API Explorer by performing either of the following:

  1. Edit the URL to point to /api/api-explorer/index.html.

    For example, https://fcm.example.com/api/api-explorer/index.html.

  2. Open the FCM Help menu and choose API Explorer.

The FXOS API Explorer opens in a separate window.

Audience for This API Guide

This guide assumes you have a general knowledge of programming and a specific understanding of REST APIs and JSON. If you are new to these technologies, please refer to some general REST API reference materials.