How to Enter a Secure Firewall Threat Defense REST API Request

You can select an FDM-managed device and specify a single command or execute commands that need additional parameters.

If you want to determine the syntax of a REST API request, log on to the device's API Explorer page, such as https://ftd.example.com/#/api-explorer, and click the required resource groups to see the syntax of the command to be executed. For example, https://10.10.5.84/#/api-explorer.

The following figure shows an example of a single REST API request in Security Cloud Control:

The following figure shows an example of a REST API request that needs additional parameters. You need manually specify the data in the Request Body. If you want to determine the syntax of a command, log on to the device's API Explorer page.

Note	The device must be in the synced state to execute the POST request.

Procedure

Step 1

In the left pane, click Security Devices.

Step 2

Click the Devices tab to locate your device.

Step 3

Click the FTD tab.

Step 4

Select an FDM-managed device you want to manage using the REST API, and in Device Actions on the right, click API Tool.

Step 5

Select the request method from the drop-down and type/api/fdm/latest/and then the command that you want to execute. If you are executing a POST or PUT command, enter the request body.

Step 6

Click Send. The Response Body shows the response of the executed command.

Important

The POST request usually makes changes to the staged configuration on the device. Click Commit Changes in FDM to send the changes to the FDM-managed device.