Skip to main content

 

 

Cisco Defense Orchestrator

How to Enter FTD REST API Request

You can select an FTD 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 CDO. 

Example_REST_API_Command.jpg

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.

Example_REST_API_Command_POST.jpg

  1. On the CDO navigation bar, click Devices & Services.
  2. Select an FTD device you want to manage using the REST API, and in Device Actions on the right, click API Tool.
  3. 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.
  4. 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 FTD device.

  • Was this article helpful?