Using the API Tool

Security Cloud Control provides the API Tool interface to execute the FDM-managed device REpresentational State Transfer (REST) Application Programming (API) requests for performing advanced actions on an FDM-managed device. The REST API uses JavaScript Object Notation (JSON) format to represent objects.

The interface provides system-defined or user-defined API macros. System-defined macros are provided by Security Cloud Control and can not be edited or deleted. User-defined macros are created by you and can be edited or deleted. You can use all the resource groups supported in the Secure Firewall device manager API Explorer.

Note	Security Cloud Control supports only API endpoints that return JSON.

Assumption

It is assumed that you have a general knowledge of programming and a specific understanding of REST APIs and JSON. If you are new to these technologies, please first read a general guide on REST APIs.

Supported Documents

• You can refer to the Cisco Firepower Threat Defense REST API Guide for detailed information.

• You can also find reference information and examples online at Cisco DevNet Site.

Supported HTTP Methods

You can use the following HTTP methods only.

Important

A user with the Read-Only role can perform only the GET operation.

Attribute	Description
GET	To read data from the device.
POST	To create new objects for a type of resource. For example, use POST to create a new network object.
PUT	To change the attributes of an existing resource. When using PUT, you must include the entire JSON object. You cannot selectively update individual attributes within an object. For example, use PUT to modify the address contained within an existing network object.
DELETE	To remove a resource that you, or another user, created. For example, use DELETE to remove a network object that you no longer use.