Firepower REST API Quick Start Guide, Version 6.

1
First Published:
Last Modified:

Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
[Link]
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,
INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH
THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY,
CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version
of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS" WITH ALL FAULTS.
CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT
LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS
HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network
topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional
and coincidental.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http://
[Link]/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership
relationship between Cisco and any other company. (1110R)

© 2016 Cisco Systems, Inc. All rights reserved.

 CONTENTS

CHAPTER 1 About the Firepower REST API 1

About the Firepower REST API 1
Enabling the REST API 1
Best Practices 2

CHAPTER 2 About the API Explorer 3

About the API Explorer 3
Authentication to the API Explorer 3
Logging into API Explorer 4
Setting the Domain 4
Obtaining Sample Code 4
Obtaining Sample Code 5
Viewing API Parameters 5

CHAPTER 3 Connecting with a Client 7

Authentication from a REST API Client 7
Requesting an Authentication Token 8
Refreshing an Authentication Token 9

CHAPTER 4 Objects in the REST API 11

Request Structure 11
Response Structure 13
Rate Limiting 14
Audit Services 14
GET auditrecords 14
Deployment Services 15
GET deployabledevices 15
POST deploymentrequests 15

Firepower REST API Quick Start Guide, Version 6.1

iii
 Contents

Device Group Services 15

DELETE devicegrouprecords 15
PUT devicegrouprecords 15
POST devicegrouprecords 15
GET devicegrouprecords 16
Device Services 16
DELETE devicerecords 16
PUT devicerecords 16
POST devicerecords 16
GET devicerecords 17
PUT fpphysicalinterfaces 17
GET fpphysicalinterfaces 17
DELETE fplogicalinterfaces 17
PUT fplogicalinterfaces 18
POST fplogicalinterfaces 18
GET fplogicalinterfaces 18
DELETE inlinesets 18
PUT inlinesets 18
POST inlinesets 19
GET inlinesets 19
DELETE virtualswitches 19
PUT virtualswitches 19
POST virtualswitches 20
GET virtualswitches 20
GET fpphysicalinterfaces 20
GET physicalinterfaces 20
GET bridgegroupinterfaces 21
GET redundantinterfaces 21
GET etherchannelinterfaces 21
GET subinterfaces 22
GET fpinterfacestatistics 22
Object 22
GET anyprotocolportobjects 22
GET applicationcategories 22
GET applicationfilters 23

Firepower REST API Quick Start Guide, Version 6.1

iv
Contents

GET applicationproductivities 23
GET applicationrisks 23
GET applications 23
GET applicationtags 24
GET applicationtypes 24
GET continents 24
GET countries 24
GET endpointdevicetypes 25
GET geolocation 25
DELETE hosts 25
PUT hosts 25
POST hosts 25
GET hosts 26
DELETE icmpv4objects 26
PUT icmpv4objects 26
POST icmpv4objects 26
GET icmpv4objects 26
DELETE icmpv6objects 27
PUT icmpv6objects 27
POST icmpv6objects 27
GET icmpv6objects 27
GET isesecuritygrouptags 27
GET networkaddresses 28
DELETE networkgroups 28
PUT networkgroups 28
POST networkgroups 28
GET networkgroups 28
DELETE networks 29
PUT networks 29
POST networks 29
GET networks 29
DELETE portobjectgroups 29
PUT portobjectgroups 30
POST portobjectgroups 30
GET portobjectgroups 30

Firepower REST API Quick Start Guide, Version 6.1

v
 Contents

GET ports 30
DELETE protocolportobjects 30
PUT protocolportobjects 31
POST protocolportobjects 31
GET protocolportobjects 31
DELETE ranges 31
PUT ranges 31
POST ranges 32
GET ranges 32
GET realms 32
GET realmusergroups 32
GET realmusers 33
GET securitygrouptags 33
DELETE securityzones 33
PUT securityzones 33
POST securityzones 34
GET securityzones 34
GET siurlfeeds 34
GET siurllists 34
GET tunneltags 34
GET urlcategories 35
DELETE urlgroups 35
PUT urlgroups 35
POST urlgroups 35
GET urlgroups 35
DELETE urls 36
PUT urls 36
POST urls 36
GET urls 36
GET variablesets 36
DELETE vlangrouptags 37
PUT vlangrouptags 37
POST vlangrouptags 37
GET vlangrouptags 37
DELETE vlantags 37

Firepower REST API Quick Start Guide, Version 6.1

vi
Contents

PUT vlantags 38
POST vlantags 38
GET vlantags 38
Policy Services 38
DELETE accesspolicies 38
PUT accesspolicies 39
POST accesspolicies 39
GET accesspolicies 39
DELETE accessrules 39
PUT accessrules 39
POST accessrules 40
GET accessrules 40
PUT defaultactions 40
GET defaultactions 40
GET filepolicies 41
GET intrusionpolicies 41
GET snmpalerts 41
GET syslogalerts 41
Policy Assignment Services 42
PUT policyassignments 42
POST policyassignments 42
GET policyassignments 42
Status Services 42
GET taskstatuses 42
System Information 43
GET serverversion 43
Services Available in Firepower Threat Defense 43
GET physicalinterfaces 43
GET redundantinterfaces 43
GET etherchannelinterfaces 44
GET subinterfaces 44
GET bridgegroupinterfaces 44
POST devicerecords 44
PUT devicerecords 45
GET devicegrouprecords 45

Firepower REST API Quick Start Guide, Version 6.1

vii
 Contents

DELETE devicerecords 45
POST devicegrouprecords 45
PUT devicegrouprecords 45
GET devicegrouprecords 46
DELETE devicegrouprecords 46
POST securityzones 46
PUT securityzones 46
GET securityzones 46
DELETE securityzones 47
POST policyassignments 47
PUT policyassignments 47
GET policyassignments 47
GET deployabledevices 47
POST deploymentrequests 48

Firepower REST API Quick Start Guide, Version 6.1

viii
 CHAPTER 1
About the Firepower REST API
The Firepower REST API provides a lightweight API to manage a Firepower Management Center.

• About the Firepower REST API, page 1

• Enabling the REST API, page 1
• Best Practices, page 2

About the Firepower REST API

With the release of Cisco’s Firepower REST API, you now have light-weight, easy-to-use option for managing
Firepower Threat Defense and legacy Firepower devices through a Firepower Management Center.
The REST API is an application programming interface (API), based on “RESTful” principles, which you can
quickly enable on any Firepower Management Center running version 6.1 or higher, and use with a REST
client.
After installing a REST client, you can contact the specific Firepower Management Center's REST agent and
use standard HTTP methods to access current configuration information, and issue additional configuration
parameters.

Enabling the REST API

In Firepower Management Center, the REST API is enabled by default. However, if you are intending to use
the REST API, you should confirm that it is enabled.
If you are using UCAPL mode, check that the REST API is not enabled.

Procedure

Step 1 Navigate to System>Configuration>REST API Preferences>Enable REST API

Step 2 Check the "Enable REST API" checkbox.

Step 3 Click "Save". A box saying "Save Successful" will display when the REST API is enabled.

Firepower REST API Quick Start Guide, Version 6.1

1
 About the Firepower REST API
Best Practices

Best Practices
Cisco recommends the following best practices for optimal results with the REST API:
• Keep UI users and script users separate. Especially do not use the admin account as an API user.
• Do not give script users more privilege than needed.
• Always validate the content coming from the server.
• Validate/sanitize JSON content, as it may include embedded executable code.
• If you are using UCAPL mode you should disable REST API access to the Firepower Management
Center

Firepower REST API Quick Start Guide, Version 6.1

2
 CHAPTER 2
About the API Explorer
• About the API Explorer, page 3
• Authentication to the API Explorer, page 3
• Obtaining Sample Code, page 4
• Viewing API Parameters, page 5

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:
[Link]
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.

Firepower REST API Quick Start Guide, Version 6.1

3
 About the API Explorer
Logging into API Explorer

Logging into API Explorer

The REST API uses the same authentication and permission model as the Firepower Management Center.
See the Firepower Management Center Configuration Guide for more information.

Before You Begin

Make sure you have an account on your Firepower Management Center with the required permissions to
perform the tasks you want to perform using the REST API.

Procedure

Step 1 Navigate to the following URL: [Link]

Step 2 Log in with your username and password and click "Sign In"

What to Do Next
Locate the desired resource and request.

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.

Procedure

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 [Link] Once
you’ve installed Python, you can run your script with python [Link] username password.
• Perl: Using the Perl scripts requires some additional set-up—you need five components:

Firepower REST API Quick Start Guide, Version 6.1

4
 About the API Explorer
Obtaining Sample Code

• Perl package, found at [Link]

• Bundle::CPAN, found at [Link]
• REST::Client, found at [Link]
• MIME::Base64, found at [Link]
• JSON, found at [Link]

Obtaining Sample Code

The API Explorer can create sample code in Python and Perl to aid in creating a REST API client.

Before You Begin

You must have a configured Firepower Management Center and an account on that center with the permissions
required to use the desired REST API functions.

Procedure

Step 1 Select the resource where you want to obtain sample code from the API INFO menu.

Step 2 Locate the desired function and select DELETE, PUT, POST, or GET.

Step 3 Select and input all other parameters for the desired function. This will vary depending on the function.

Step 4 On the right, drop down the menu for "Export operation in" and select "Python script" or "Perl script".

Step 5 The sample code will pop up in a new window. Cut and paste this code to use in your REST API client.

What to Do Next
Use this sample code to implement your own REST API client.

Viewing API Parameters

Each resource has a set of parameters and fields associated with it. You can view the parameters and fields
by performing any of the supported operations for that resource within API Explorer.

Before You Begin

You must have a configured Firepower Management Center and an account on that center with the permissions
required to use the desired REST API functions.

Firepower REST API Quick Start Guide, Version 6.1

5
 About the API Explorer
Viewing API Parameters

Procedure

Step 1 Select the desired resource.

Step 2 Select one of the supported operations for that resource.

Firepower REST API Quick Start Guide, Version 6.1

6
 CHAPTER 3
Connecting with a Client
You can access the REST API using any REST API client. Typically REST API clients are available as
browser plugins, but any REST API client is allowed.

Note If connecting to the REST API for the first time, you will receive a certificate warning. You need to accept
the certificate in order to use the REST API.

• Authentication from a REST API Client, page 7

Authentication from a REST API Client

Cisco recommends that you use different accounts for interfacing with the API and the Firepower User
Interface. Credentials cannot be used for both interfaces simultaneously, and will be logged out without
warning if used for both.
The first time you connect to the REST API you may receive an error that the connection is not secure due
to an invalid certificate. Add an exception in your browser to use the certificate and accept the connection.
With Token Based Authentication you obtain a token by providing your username and password. You use
this token to access an HTTP service for a limited time period without the need for the username and password
with every request. In other words, to eliminate the need for authenticating with your username and password
with each request, you replace user credentials with a uniquely generated access token, which you use for
accessing resources for up to 30 minutes and can refresh up to three times.
The diagram below illustrates the concept of token-based authentication:

Firepower REST API Quick Start Guide, Version 6.1

7
 Connecting with a Client
Requesting an Authentication Token

Requesting an Authentication Token

The Token Generation Utility provides an authentication token which can be used in your REST API client.

Before You Begin

You must have a configured Firepower Management Center and an account on that center with credentials
to use the REST API. You must also have a REST API Client which can perform basic authentication.

Firepower REST API Quick Start Guide, Version 6.1

8
 Connecting with a Client
Refreshing an Authentication Token

Procedure

Step 1 Open your REST API Client.

Step 2 Set the client to make a POST command to the following URL:
[Link]

Step 3 Include the username and password as a basic authentication header. The POST body should be blank.

What to Do Next
Add the header X-auth-access-token:<authentication token value> in requests to the API.
Add the headers X-auth-access-token:<authentication token value> and X-auth-refresh-token:<refresh
token value> in requests to refresh the token as described in Refreshing an Authentication Token, on page
9

Refreshing an Authentication Token

Firepower Management Center REST API authentication tokens are valid for 30 minutes, and can be refreshed
up to three times.

Before You Begin

Obtain valid authentication and refresh tokens from the Firepower Management Center REST API. Ensure
these tokens have been refreshed less than three times.

Procedure

Step 1 Open your REST API Client.

Step 2 Set the client to make a POST command to the following URL:
[Link] with the headers
X-auth-access-token:<authentication token value> and X-auth-refresh-token:<refresh token value>.

What to Do Next
Add the header X-auth-access-token:<new authentication token value> in requests to the API.
Add the header X-auth-refresh-token:<new refresh token value> in requests to refresh the token.

Firepower REST API Quick Start Guide, Version 6.1

9
 Connecting with a Client
Refreshing an Authentication Token

Firepower REST API Quick Start Guide, Version 6.1

10
 CHAPTER 4
Objects in the REST API
• Request Structure, page 11
• Response Structure, page 13
• Rate Limiting, page 14
• Audit Services, page 14
• Deployment Services, page 15
• Device Group Services, page 15
• Device Services, page 16
• Object, page 22
• Policy Services, page 38
• Policy Assignment Services, page 42
• Status Services, page 42
• System Information, page 43
• Services Available in Firepower Threat Defense, page 43

Request Structure
Request Structure:
Requests are sent to the Firepower Management Center as HTTPS requests with the Uniform Resource
Identifier (URI) of the form described below:
[Link]
Where:

Firepower REST API Quick Start Guide, Version 6.1

11
 Objects in the REST API
Request Structure

• <management_center_IP_or_name>
is the IP address or Fully Qualified Domain Name of the Firepower Management Center
• <https_port>
is the port number used by the Firepower Management Center for HTTPS connections. This port is
always 443.
• <object_URL>
is the specific URL for the desired resource. These URLs are unique for each resource and are given
below.
• options
are the options given with the request. Options can be used to modify the output and filter results.
• {UUID}
Many URLs contain one or more UUIDs which must be specified. Most URLs include the domain
UUID, which can be found in the API Explorer. When deleting or modifying an object, or requesting
information about a specific object, the URL will end with the object UUID.

Available request methods are:

• GET
– Retrieves data from the specified object. GET is a read-only operation.
• PUT
– Adds the supplied information to the specified object; returns a 404 Resource Not Found error if the
object does not exist.

Note Currently PUT may be used to create a new object, but this ability may be removed in
later releases. Use POST to create new objects and PUT to modify existing objects.

• POST
– Creates the object with the supplied information.
• DELETE
– Deletes the specified object.
• PATCH
– Not supported.

The API supports query parameters for almost all requests. For GET requests, the following query parameters
can be used to control the number of of returned objects and the pagination:
• expanded
- This is a True/False value which indicates whether you get a full listing of an item in a list or only a
reference.
• offset
- Indicates the position in the list where you want to start.
• limit
- Indicates the number of items you want to retrieve in a page.

The API supports filtering on the basis of query parameters passed with a request. Filtering can be done based
on specific attributes in a model. The parameters available for filtering vary by object, and are listed with the
request below.

Firepower REST API Quick Start Guide, Version 6.1

12
 Objects in the REST API
Response Structure

Response Structure

Note The REST API will only serve 25 results per page. This can be increased up to 1000 using the limit query
parameter.

The response structure can be:

• LOCATION – Newly created resource ID; for POST only—holds the new resource ID (as a URI
representation).
• CONTENT-TYPE – Media type describing the response message body; describes the representation
and syntax of the response message body.
• Each response includes an HTTP status or error code. Available codes fall into these categories:
• 20x - A two-hundred series code indicates successful operation, including:
• 200 OK
– Standard response for successful requests.
• 201 Created
– Request completed; new resource created.
• 202 Accepted
– Request accepted, but processing not complete.
• 204 No Content
– Server successfully processed request; no content is being returned.
• 4xx - A four-hundred series code indicates a client-side error, including:
• 400 Bad Request
– Invalid query parameters, including unrecognized parameters, missing parameters, or invalid values.
• 404 Not Found
– The provided URL does not match an existing resource. For example, an HTTP DELETE may fail
because the resource is unavailable.
• 405 Method not Allowed
– An HTTP request was presented that is not allowed on the resource; for example, a POST on a read-only
resource.
• 429 Too Many Requests
– Too many requests were sent to the API. This error will occur if you send more than 120 requests per
minute.
• 5xx - A five-hundred series code indicates a server-side error.

Firepower REST API Quick Start Guide, Version 6.1

13
 Objects in the REST API
Rate Limiting

In the case of an error, in addition to the error code, the return response may include an error object containing
more details about the error. The JSON error/warning response schema is as follows:
[
{ “code” : “string”,
“details”: “string”,
“context”: attribute name,
“level” : <Error/Warning/Info>
},

...
]
where the object properties are:

Table 1: Object Properties

Property Type Description

messages List of Dictionaries List of error or warning messages

code String Error/Warning/Info code

details String Detailed message corresponding to

Error/Warning/Info

Rate Limiting
The Firepower REST API implements rate limiting to reduce network load.
The API will accept no more than 120 messages in a minute. It will only allow 10 simultaneous connections
per IP address. These are not configurable parameters.
If a client exceeds these limits, the API will give an HTTP 429 error.

Audit Services

GET auditrecords
Request Type: GET
Description: Retrieves audit records.
URL: /api/fmc_config/v1/domain/{domain_UUID}/audit/auditrecords
Permissions: System > Monitoring > Audit
Parameters available for filtering: username, subsystem, source, starttime, endtime

Firepower REST API Quick Start Guide, Version 6.1

14
 Objects in the REST API
Deployment Services

Deployment Services

GET deployabledevices
Request Type: GET
Description: Retrieves list of all devices with configuration changes, ready to be deployed.
URL: /api/fmc_config/v1/domain/{domain_UUID}/deployment/deployabledevices
Permissions: Deploy Configuration to Devices
Parameters available for filtering: name

POST deploymentrequests
Request Type: POST
Description: Creates a request for deploying configuration changes to the specified device.
URL: /api/fmc_config/v1/domain/{domain_UUID}/deployment/deploymentrequests/{object_UUID}
Permissions: Deploy Configuration to Devices

Device Group Services

DELETE devicegrouprecords
Request Type: DELETE
Description: Deletes a device group with the specified object ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devicegroups/devicegrouprecords/{object_UUID}
Permissions: Devices > Device Management > Modify Devices

PUT devicegrouprecords
Request Type: PUT
Description: Modifies a device group with the specified object ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devicegroups/devicegrouprecords/{object_UUID}
Permissions: Devices > Device Management > Modify Devices

POST devicegrouprecords
Request Type: POST

Firepower REST API Quick Start Guide, Version 6.1

15
 Objects in the REST API
GET devicegrouprecords

Description: Create a device group with the specified object ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/devicegroups/devicegrouprecords
Permissions: Devices > Device Management > Modify Devices

GET devicegrouprecords
Request Type: GET
Description: Retrieves the device group associated with the specified ID. If no ID is specified, retrieves list
of all device groups.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devicegroups/devicegrouprecords
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/devicegroups/devicegrouprecords/{object_
UUID}
Permissions: Devices > Device Management > View Devices

Device Services

DELETE devicerecords
Request Type: DELETE
Description: Unregisters the specified device.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{object_UUID}
Permissions: Devices > Device Management > Modify Devices

PUT devicerecords
Request Type: PUT
Description: Modifies the device record associated with the specified ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{object_UUID}
Permissions: Devices > Device Management > Modify Devices

POST devicerecords
Request Type: POST
Description: Registers the specified device to the Firepower Managemenr Center.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords
Permissions: Devices > Device Management > Modify Devices

Firepower REST API Quick Start Guide, Version 6.1

16
 Objects in the REST API
GET devicerecords

GET devicerecords
Request Type: GET
Description: Retrieve device information. If a device ID is specified, the information for the specificed device
is retrieved. If no ID is specified, retrieves information for all devices.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{object_UUID}
Permissions: Devices > Device Management
Parameters available for filtering: hostName

PUT fpphysicalinterfaces
Request Type: PUT
Description: Modify a physical interface on the specified device.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{containerUUID}/
fpphysicalinterfaces/{object_UUID}
Permissions: Devices > Device Management > Modify Device

GET fpphysicalinterfaces
Request Type: GET
Description: Retrieves information on the physical interface associated with the specified NGIPS device ID
and interface ID. If no ID is specified, retrieves list of all physical interfaces associated with the specified
NGIPS device ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
fpphysicalinterfaces
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
fpphysicalinterfaces/{object_UUID}
Permissions: Devices > Device Management
Parameters available for filtering: name

DELETE fplogicalinterfaces
Request Type: DELETE
Description: Delete logical interfaces on the specified device.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{containerUUID}/
fplogicalinterfaces/{object_UUID}
Permissions: Devices > Device Management > Modify Device

Firepower REST API Quick Start Guide, Version 6.1

17
 Objects in the REST API
PUT fplogicalinterfaces

PUT fplogicalinterfaces
Request Type: PUT
Description: Modify a logical interface on the specified device.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
fplogicalinterfaces/{object_UUID}
Permissions: Devices > Device Management > Modify Device

POST fplogicalinterfaces
Request Type: POST
Description: Creates logical interfaces on the specified device.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
fplogicalinterfaces
Permissions: Devices > Device Management > Modify Device

GET fplogicalinterfaces
Request Type: GET
Description: Retrieves the logical interface associated with the specified NGIPS device ID and interface ID.
If no ID is specified, retrieves list of all logical interfaces associated with the specified NGIPS device ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
fplogicalinterfaces
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
fplogicalinterfaces/{obect_UUID}
Permissions: Devices > Device Management
Parameters available for filtering: name

DELETE inlinesets
Request Type: DELETE
Description: Delete inline sets on the specified device.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{containerUUID}/inlinesets/
{object_UUID}
Permissions: Devices > Device Management > Modify Device

PUT inlinesets
Request Type: PUT

Firepower REST API Quick Start Guide, Version 6.1

18
 Objects in the REST API
POST inlinesets

Description: Modify an inline set on the specified device.

URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/inlinesets/
{object_UUID}
Permissions: Devices > Device Management > Modify Device

POST inlinesets
Request Type: POST
Description: Creates inline sets on the specified device.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/inlinesets
Permissions: Devices > Device Management > Modify Device

GET inlinesets
Request Type: GET
Description: Retrieves information on the inline set associated with the specified NGIPS device ID and inline
set ID. If no inline set ID is specified, retrieves list of all inline sets associated with the specified NGIPS device
ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/inlinesets
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
inlinesets/{object_UUID}
Permissions: Devices > Device Management
Parameters available for filtering: name

DELETE virtualswitches
Request Type: DELETE
Description: Delete a virtual switch on the specified device.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{containerUUID}/virtualswitches/
{object_UUID}
Permissions: Devices > Device Management > Modify Device

PUT virtualswitches
Request Type: PUT
Description: Modify a virtual switch on the specified device.
URL: /api/fmc_config/v1/domain/{UUID}/devices/devicerecords/{containerUUID}/virtualswitches/{object_
UUID}
Permissions: Devices > Device Management > Modify Device

Firepower REST API Quick Start Guide, Version 6.1

19
 Objects in the REST API
POST virtualswitches

POST virtualswitches
Request Type: POST
Description: Create a virtual switch on the specified device.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/virtualswitches
Permissions: Devices > Device Management > Modify Device

GET virtualswitches
Request Type: GET
Description: Retrieves virtual switch associated with the specified NGIPS device ID and virtual switch ID.
If no virtual switch ID is specified, retrieves list of all virtual switches associated with the specified NGIPS
device ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{containerUUID}/ virtualswitches
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{containerUUID}/
virtualswitches/{object_UUID}
Permissions: Devices > Device Management
Parameters available for filtering: name

GET fpphysicalinterfaces
Request Type: GET
Description: Retrieves information on the physical interface associated with the specified NGIPS device ID
and interface ID. If no ID is specified, retrieves list of all physical interfaces associated with the specified
NGIPS device ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
fpphysicalinterfaces
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
fpphysicalinterfaces/{object_UUID}
Permissions: Devices > Device Management
Parameters available for filtering: name

GET physicalinterfaces
Request Type: GET
Description: Retrieves the physical interface associated with the specified NGFW device ID and interface ID.
If no interface ID is specified, retrieves list of all physical interfaces associated with the specified NGFW
device ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/physicalinterfaces

Firepower REST API Quick Start Guide, Version 6.1

20
 Objects in the REST API
GET bridgegroupinterfaces

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/

physicalinterfaces/{object_UUID}
Permissions: Devices > Device Management

GET bridgegroupinterfaces
Request Type: GET
Description: Retrieves the bridge group interface associated with the specified NGFW device ID and interface
ID. If no interface ID is specified, retrieves list of all bridge group interfaces associated with the specified
NGFW device ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
bridgegroupinterfaces
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
bridgegroupinterfaces/{object_UUID}
Permissions: Devices > Device Management

GET redundantinterfaces
Request Type: GET
Description: Retrieves the redundant interface associated with the specified NGFW device ID and interface
ID. If no interface ID is specified, retrieves list of all redundant interfaces associated with the specified NGFW
device ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
redundantinterfaces
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
redundantinterfaces/{object_UUID}
Permissions: Devices > Device Management

GET etherchannelinterfaces
Request Type: GET
Description: Retrieves the ethernet channel interface associated with the specified NGFW device ID and
interface ID. If no ID is specified, retrieves list of all ethernet channel interfaces associated with the specified
NGFW device ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
etherchannelinterfaces
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
etherchannelinterfaces/{object_UUID}
Permissions: Devices > Device Management
Parameters available for filtering:

Firepower REST API Quick Start Guide, Version 6.1

21
 Objects in the REST API
GET subinterfaces

GET subinterfaces
Request Type: GET
Description: Retrieves the sub-interface associated with the specified NGFW device ID and interface ID. If
no interface ID is specified, retrieves list of all sub-interfaces associated with the specified NGFW device ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{containerUUID}/subinterfaces
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{containerUUID}/
subinterfaces/{object_UUID}
Permissions: Devices > Device Management

GET fpinterfacestatistics
Request Type: GET
Description: Retrieves list of statistics for all interfaces associated with the specified NGIPS device ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/ devicerecords/{container_UUID}/
fpinterfacestatistics
Permissions: Devices > Device Management
Parameters available for filtering: name

Object

GET anyprotocolportobjects
Request Type: GET
Description: Retrieves the any protocol port object associated with the specified ID. If no ID is specified,
retrieves list of all protocol port objects with the protocol set to All.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/anyprotocolportobjects
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/anyprotocolportobjects/{object_
UUID}
Permissions: Object Manager

GET applicationcategories
Request Type: GET
Description: Retrieves the application category object associated with the specified ID. If no ID is specified,
retrieves list of all application category objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/applicationcategories

Firepower REST API Quick Start Guide, Version 6.1

22
 Objects in the REST API
GET applicationfilters

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/applicationcategories/{object_

UUID}
Permissions: Object Manager

GET applicationfilters
Request Type: GET
Description: Retrieves the application filter object associated with the specified ID. If no ID is specified,
retrieves list of all application filter objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/applicationfilters
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/applicationfilters/{object_UUID}
Permissions: Object Manager

GET applicationproductivities
Request Type: GET
Description: Retrieves the application productivity object associated with the specified ID. If no ID is specified,
retrieves list of all application productivity objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/applicationproductivities
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/applicationproductivities/{object_
UUID}
Permissions: Object Manager

GET applicationrisks
Request Type: GET
Description: Retrieves the application risk object associated with the specified ID. If no ID is specified,
retrieves list of all application risk objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/applicationrisks
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/applicationrisks/{object_UUID}
Permissions: Object Manager

GET applications
Request Type: GET
Description: Retrieves the application object associated with the specified ID. If no ID is specified, retrieves
list of all application objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/applications
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/applications/{object_UUID}

Firepower REST API Quick Start Guide, Version 6.1

23
 Objects in the REST API
GET applicationtags

Permissions: Object Manager

GET applicationtags
Request Type: GET
Description: Retrieves the application tag object associated with the specified ID. If no ID is specified, retrieves
list of all application tag objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/applicationtags
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/applicationtags/{object_UUID}
Permissions: Object Manager

GET applicationtypes
Request Type: GET
Description: Retrieves the application type object associated with the specified ID. If no ID is specified,
retrieves list of all application type objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/applicationtypes
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/applicationtypes/{object_UUID}
Permissions: Object Manager

GET continents
Request Type: GET
Description: Retrieves the continent object associated with the specified ID. If no ID is specified, retrieves
list of all continent objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/continents
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/continents/{object_UUID}
Permissions: Object Manager

GET countries
Request Type: GET
Description: Retrieves the country object associated with the specified ID. If no ID is specified, retrieves list
of all country objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/countries
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/countries/{object_UUID}
Permissions: Object Manager

Firepower REST API Quick Start Guide, Version 6.1

24
 Objects in the REST API
GET endpointdevicetypes

GET endpointdevicetypes
Request Type: GET
Description: Retrieves the endpoint device type object associated with the specified ID. If no ID is specified,
retrieves list of all endpoint device type objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/endpointdevicetypes
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/endpointdevicetypes/{object_
UUID}
Permissions: Object Manager

GET geolocation
Request Type: GET
Description: Retrieves the geolocation object associated with the specified ID. If no ID is specified, retrieves
list of all geolocation objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/geolocations
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/geolocations/{object_UUID}
Permissions: Object Manager

DELETE hosts
Request Type: DELETE
Description: Deletes the specified host object.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/hosts/{object_UUID}
Permissions: Object Manager>Modify Object Manager

PUT hosts
Request Type: PUT
Description: Modify a host object.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/hosts/{object_UUID}
Permissions: Object Manager>Modify Object Manager

POST hosts
Request Type: POST
Description: Create a host object with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/hosts

Firepower REST API Quick Start Guide, Version 6.1

25
 Objects in the REST API
GET hosts

Permissions: Object Manager>Modify Object Manager

GET hosts
Request Type: GET
Description: Retrieves the host object associated with the specified ID. If no ID is specified, retrieves list of
all host objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/hosts
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/hosts/{object_UUID}
Permissions: Object Manager

DELETE icmpv4objects
Request Type: DELETE
Description: Deletes the specified ICMPv4 port.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/icmpv4objects/{object_UUID}
Permissions: Object Manager>Modify Object Manager

PUT icmpv4objects
Request Type: PUT
Description: Modify ICMPv4 port objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/icmpv4objects/{object_UUID}
Permissions: Object Manager>Modify Object Manager

POST icmpv4objects
Request Type: POST
Description: Create ICMPv4 port objects with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/icmpv4objects
Permissions: Object Manager>Modify Object Manager

GET icmpv4objects
Request Type: GET
Description: Retrieves the ICMPv4 object associated with the specified ID. If no ID, retrieves list of all
ICMPv4 objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/icmpv4objects
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/icmpv4objects/{object_UUID}

Firepower REST API Quick Start Guide, Version 6.1

26
 Objects in the REST API
DELETE icmpv6objects

Permissions: Object Manager

DELETE icmpv6objects
Request Type: DELETE
Description: Deletes the specified ICMPv6 port objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/icmpv6objects/{object_UUID}
Permissions: Object Manager>Modify Object Manager

PUT icmpv6objects
Request Type: PUT
Description: Modify ICMPv6 port objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/icmpv6objects/{object_UUID}
Permissions: Object Manager>Modify Object Manager

POST icmpv6objects
Request Type: POST
Description: Create ICMPv6 port objects with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/icmpv6objects
Permissions: Object Manager>Modify Object Manager

GET icmpv6objects
Request Type: GET
Description: Retrieves the ICMPv6 object associated with the specified ID. If no ID is specified, retrieves list
of all ICMPv6 objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/icmpv6objects
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/icmpv6objects/{object_UUID}
Permissions: Object Manager

GET isesecuritygrouptags
Request Type: GET
Retrieves the ISE security group tag object with the specified ID. If no ID is specified, retrieves list of all ISE
security group tag objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/isesecuritygrouptags

Firepower REST API Quick Start Guide, Version 6.1

27
 Objects in the REST API
GET networkaddresses

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/isesecuritygrouptags/{object_

UUID}
Permissions: Object Manager

GET networkaddresses
Request Type: GET
Description: Retrieves list of all network and host objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/networkaddresses
Permissions: Object Manager

DELETE networkgroups
Request Type: DELETE
Description: Deletes the specified Network Group.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/networkgroups/{object_UUID}
Permissions: Object Manager>Modify Object Manager

PUT networkgroups
Request Type: PUT
Description: Modify a Network Group.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/networkgroups/{object_UUID}
Permissions: Object Manager>Modify Object Manager

POST networkgroups
Request Type: POST
Description: Create network group with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/networkgroups
Permissions: Object Manager>Modify Object Manager

GET networkgroups
Request Type: GET
Description: Retrieves the network group object associated with the specified ID. If no ID is specified, retrieves
list of all network group objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/networkgroups
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/networkgroups/{object_UUID}

Firepower REST API Quick Start Guide, Version 6.1

28
 Objects in the REST API
DELETE networks

Permissions: Object Manager

DELETE networks
Request Type: DELETE
Description: Deletes the specified network objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/networks/{object_UUID}
Permissions: Object Manager>Modify Object Manager

PUT networks
Request Type: PUT
Description: Modify network objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/networks/{object_UUID}
Permissions: Object Manager>Modify Object Manager

POST networks
Request Type: POST
Description: Create network objects with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/networks
Permissions: Object Manager>Modify Object Manager

GET networks
Request Type: GET
Description: Retrieves the network objects associated with the specified ID. If no ID is specified, retrieves
list of all network objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/networks
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/networks/{object_UUID}
Permissions: Object Manager

DELETE portobjectgroups
Request Type: DELETE
Description: Deletes the specified port object groups.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/portobjectgroups/{object_UUID}
Permissions: Object Manager>Modify Object Manager

Firepower REST API Quick Start Guide, Version 6.1

29
 Objects in the REST API
PUT portobjectgroups

PUT portobjectgroups
Request Type: PUT
Description: Modify port object groups.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/portobjectgroups/{object_UUID}
Permissions: Object Manager>Modify Object Manager

POST portobjectgroups
Request Type: POST
Description: Create port object groups with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/portobjectgroups
Permissions: Object Manager>Modify Object Manager

GET portobjectgroups
Request Type: GET
Description: Retrieves the port object group object associated with the specified ID. If no ID is specified,
retrieves list of all port object group objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/portobjectgroups
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/portobjectgroups/{object_UUID}
Permissions: Object Manager

GET ports
Request Type: GET
Description: Retrieves list of all port objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/ports
Permissions: Object Manager

DELETE protocolportobjects
Request Type: DELETE
Description: Deletes the specified protocol port objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/protocolportobjects/{object_UUID}
Permissions: Object Manager>Modify Object Manager

Firepower REST API Quick Start Guide, Version 6.1

30
 Objects in the REST API
PUT protocolportobjects

PUT protocolportobjects
Request Type: PUT
Description: Modify protocol port objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/protocolportobjects/{object_UUID}
Permissions: Object Manager>Modify Object Manager

POST protocolportobjects
Request Type: POST
Description: Create protocol port objects with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/protocolportobjects
Permissions: Object Manager>Modify Object Manager

GET protocolportobjects
Request Type: GET
Description: Retrieves the protocol port object associated with the specified ID. If no ID is specified, retrieves
list of all protocol port objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/protocolportobjects
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/protocolportobjects/{object_UUID}
Permissions: Object Manager

DELETE ranges
Request Type: DELETE
Description: Deletes the specified address range.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/ranges/{object_UUID}
Permissions: Object Manager>Modify Object Manager

PUT ranges
Request Type: PUT
Description: Modify a an address range.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/ranges/{object_UUID}
Permissions: Object Manager>Modify Object Manager

Firepower REST API Quick Start Guide, Version 6.1

31
 Objects in the REST API
POST ranges

POST ranges
Request Type: POST
Description: Create an address range with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/ranges
Permissions: Object Manager>Modify Object Manager

GET ranges
Request Type: GET
Description: Retrieves the address range object associated with the specified ID. If no ID is specified, retrieves
list of all address range objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/ranges
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/ranges/{object_UUID}
Permissions: Object Manager

GET realms
Request Type: GET
Description: Retrieves the realm object associated with the specified ID. If no ID is specified, retrieves list
of all realm objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/realms
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/realms/{object_UUID}
Permissions: Object Manager

GET realmusergroups
Request Type: GET
Description: Retrieves the realm user group object associated with the specified ID. If no ID is specified,
retrieves list of all realm user group objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/realmusergroups
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/realmusergroups/{object_UUID}
Permissions: Object Manager
Parameters available for filtering: realmUuid

Note This is a required parameter.

Firepower REST API Quick Start Guide, Version 6.1

32
 Objects in the REST API
GET realmusers

GET realmusers
Request Type: GET
Description: Retrieves the realm user object associated with the specified ID. If no ID is specified, retrieves
list of all realm user objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/realmusers
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/realmusers/{object_UUID}
Permissions: Object Manager
Parameters available for filtering: realmUuid

Note This is a required parameter.

GET securitygrouptags
Request Type: GET
Description: Retrieves the custom security group tag object associated with the specified ID. If no ID is
specified, retrieves list of all custom security group tag objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/securitygrouptags
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/securitygrouptags/{object_UUID}
Permissions: Object Manager
Parameters available for filtering: name

DELETE securityzones
Request Type: DELETE
Description: Deletes the specified securityzone objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/securityzones/{object_UUID}
Permissions: Object Manager>Modify Object Manager

PUT securityzones
Request Type: PUT
Description: Modifies a securityzone object.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/securityzones/{object_UUID}
Permissions: Object Manager>Modify Object Manager

Firepower REST API Quick Start Guide, Version 6.1

33
 Objects in the REST API
POST securityzones

POST securityzones
Request Type: POST
Description: Create securityzone objects with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/securityzones
Permissions: Object Manager>Modify Object Manager

GET securityzones
Request Type: GET
Description: Retrieves the security zone objects associated with the specified ID. If no ID is specified, retrieves
list of all security zone objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/securityzones
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/securityzones/{object_UUID}
Permissions: Object Manager
Parameters available for filtering: name

GET siurlfeeds
Request Type: GET
Description: Retrieves the Security Intelligence url feed object associated with the specified ID. If no ID is
specified, retrieves list of all Security Intelligence url feed objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/siurlfeeds
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/siurlfeeds/{object_UUID}
Permissions: Object Manager

GET siurllists
Request Type: GET
Description: Retrieves the Security Intelligence url list object associated with the specified ID. If no ID is
specified, retrieves list of all Security Intelligence url list objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/siurllists
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/siurllists/{object_UUID}
Permissions: Object Manager

GET tunneltags
Request Type: GET

Firepower REST API Quick Start Guide, Version 6.1

34
 Objects in the REST API
GET urlcategories

Description: Retrieves the tunnel tag object associated with the specified ID. If no ID is specified, retrieves
list of all tunnel tag objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/tunneltags
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/tunneltags/{object_UUID}
Permissions: Object Manager

GET urlcategories
Request Type: GET
Description: Retrieves the url category object associated with the specified ID. If no ID is specified, retrieves
list of all url category objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/urlcategories
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/urlcategories/{object_UUID}
Permissions: Object Manager

DELETE urlgroups
Request Type: DELETE
Description: Deletes the specified urlgroup objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/urlgroups/{object_UUID}
Permissions: Object Manager>Modify Object Manager

PUT urlgroups
Request Type: PUT
Description: Modify urlgroup objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/urlgroups/{object_UUID}
Permissions: Object Manager>Modify Object Manager

POST urlgroups
Request Type: POST
Description: Create urlgroup objects with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/urlgroups
Permissions: Object Manager>Modify Object Manager

GET urlgroups
Request Type: GET

Firepower REST API Quick Start Guide, Version 6.1

35
 Objects in the REST API
DELETE urls

Description: Retrieves the url group objects associated with the specified ID. If no ID is specified, retrieves
list of all url group objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/urlgroups
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/urlgroups/{object_UUID}
Permissions: Object Manager>Modify Object Manager

DELETE urls
Request Type: GET
Description: Deletes the specified URL.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/urls/{object_UUID}
Permissions: Object Manager

PUT urls
Request Type: PUT
Description: Modify a URL.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/urls/{object_UUID}
Permissions: Object Manager

POST urls
Request Type: POST
Description: Create URLs with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/urls
Permissions: Object Manager

GET urls
Request Type: GET
Description: Retrieves the url objects associated with the specified ID. If no ID is specified, retrieves list of
all url objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/urls
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/urls/{object_UUID}
Permissions: Object Manager

GET variablesets
Request Type: GET

Firepower REST API Quick Start Guide, Version 6.1

36
 Objects in the REST API
DELETE vlangrouptags

Description: Retrieves the variable set object associated with the specified ID. If no ID is specified, retrieves
list of all variable set objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/variablesets
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/variablesets/{object_UUID}
Permissions: Object Manager

DELETE vlangrouptags
Request Type: DELETE
Description: Deletes the specified vlangrouptag objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/vlangrouptags/{object_UUID}
Permissions: Object Manager>Modify Object Manager

PUT vlangrouptags
Request Type: PUT
Description: Modify vlangrouptag objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/vlangrouptags/{object_UUID}
Permissions: Object Manager>Modify Object Manager

POST vlangrouptags
Request Type: POST
Description: Create VLAN group tags with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/vlangrouptags
Permissions: Object Manager>Modify Object Managers

GET vlangrouptags
Request Type: GET
Description: Retrieves the vlan group tag objects associated with the specified ID. If no ID is specified,
retrieves list of all vlan group tag objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/vlangrouptags
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/vlangrouptags/{object_UUID}
Permissions: Object Manager>Modify Object Manager

DELETE vlantags
Request Type: DELETE

Firepower REST API Quick Start Guide, Version 6.1

37
 Objects in the REST API
PUT vlantags

Description: Deletes the specified VLAN tag objects.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/vlantags/{object_UUID}
Permissions: Object Manager>Modify Object Manager

PUT vlantags
Request Type: PUT
Description: Modify VLAN tag objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/vlantags/{object_UUID}
Permissions: Object Manager>Modify Object Manager

POST vlantags
Request Type: POST
Description: Create VLAN tags with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/vlantags
Permissions: Object Manager>Modify Object Manager

GET vlantags
Request Type: GET
Description: Retrieves the vlantag objects associated with the specified ID. If no ID is specified, retrieves list
of all vlantag objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/vlantags
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/vlantags/{object_UUID}
Permissions: Object Manager

Policy Services

DELETE accesspolicies
Request Type: DELETE
Description: Deletes the access control policy with the specified ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{object_UUID}
Permissions: Policies>Access Control Policy>Modify Access Control Policy

Firepower REST API Quick Start Guide, Version 6.1

38
 Objects in the REST API
PUT accesspolicies

PUT accesspolicies
Request Type: PUT
Description: Modify an access control policy.
URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{object_UUID}
Permissions: Policies>Access Control Policy>Modify Access Control Policy

POST accesspolicies
Request Type: POST
Description: Create an access control policy with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies
Permissions: Policies>Access Control Policy>Modify Access Control Policy

GET accesspolicies
Request Type: GET
Description: Retrieves the access control policy associated with the specified ID. If no ID is specified, retrieves
a list of all access control policies.
URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{object_UUID}
Permissions: Policies

DELETE accessrules
Request Type: DELETE
Description: Delete an access control rule in the specified access control policy.
URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/accessrules/
{object_UUID}
Permissions: Policies>Access Control>Access Control Policy>Modify Access Control Policy

PUT accessrules
Request Type: PUT
Description: Modify an access control rule in the specified access control policy.
URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/accessrules/
{object_UUID}
Permissions: Policies>Access Control>Access Control Policy>Modify Access Control Policy

Firepower REST API Quick Start Guide, Version 6.1

39
 Objects in the REST API
POST accessrules

POST accessrules
Request Type: POST
Description: Create an access control rule in the specified access control policy.
URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/accessrules
Permissions: Policies>Access Control>Access Control Policy>Modify Access Control Policy

GET accessrules
Request Type: GET
Description: Retrieves the access control rule associated with the specified policy ID and rule ID. If no rule
ID is specified, retrieves list of all access rules associated with the specified policy ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/accessrules
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/
accessrules/{object_UUID}
Permissions: Policies>Access Control>Access Control Policy

PUT defaultactions
Request Type: PUT
Description: Modifies the default action associated with the specified access control policy ID and default
action ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/defaultactions/
{object_UUID}
Permissions: Policies>Access Control>Access Control Policy>Modify Access Control Policy

GET defaultactions
Request Type: GET
Description: Retrieves the default action associated with the specified access control policy ID and default
action ID. If no default action ID is specified, retrieves list of all default actions associated with the specified
access control policy ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/defaultactions
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/
defaultactions/{object_UUID}
Permissions: Policies>Access Control>Access Control Policy

Firepower REST API Quick Start Guide, Version 6.1

40
 Objects in the REST API
GET filepolicies

GET filepolicies
Request Type: GET
Description: Retrieves the file policy object associated with the specified ID. If no ID is specified, retrieves
list of all file policy objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/filepolicies
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/filepolicies/{object_UUID}
Permissions: Policies>Access Control>Malware & File Policy

GET intrusionpolicies
Request Type: GET
Description: Retrieves the intrusion policy associated with the specified ID. If no ID is specified, retrieves
list of all intrusion policies.
URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/intrusionpolicies
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/intrusionpolicies/{object_UUID}
Permissions: Policies>Access Control>Intrusion Policy

GET snmpalerts
Request Type: GET
Description: Retrieves the SNMP alert object associated with the specified ID. If no ID is specified, retrieves
a list of all SNMP alert objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/snmpalerts
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/snmpalerts/{object_UUID}
Permissions: Policies > Actions > Alerts > View Alerts

GET syslogalerts
Request Type: GET
Description: Retrieves the syslog alert object associated with the specified ID. If no ID is specified, retrieves
a list of all syslog alert objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/syslogalerts
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/syslogalerts/{object_UUID}
Permissions: Policies > Actions > Alerts

Firepower REST API Quick Start Guide, Version 6.1

41
 Objects in the REST API
Policy Assignment Services

Policy Assignment Services

PUT policyassignments
Request Type: PUT
Description: Modify an assigned access policy to add a new device or a new device group.
URL: /api/fmc_config/v1/domain/{domain_UUID}/assignment/policyassignments/{object_UUID}
Permissions:

POST policyassignments
Request Type: POST
Description: Assigns an unassigned access policy to devices or device groups.
URL: /api/fmc_config/v1/domain/{domain_UUID}/assignment/policyassignments
Permissions:

GET policyassignments
Request Type: GET
Description: Retrieves the policy assignment associated with the specified ID. If no ID is specified, retrieves
a list of all policy assignments to target devices.
URL: /api/fmc_config/v1/domain/{domain_UUID}/assignment/policyassignments
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/assignment/policyassignments/{object_
UUID}
Permissions:
Parameters available for filtering: name

Status Services

GET taskstatuses
Request Type: GET
Description: Retrieves information about a previously submitted pending job/task with the specified ID. This
is currently supported for device registration and deployment jobs. If no ID is specified, retrieves list of all
previously submitted pending Job/Tasks.
URL: /api/fmc_config/v1/domain/{domain_UUID}/job/taskstatuses
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/job/taskstatuses/{object_UUID}

Firepower REST API Quick Start Guide, Version 6.1

42
 Objects in the REST API
System Information

Permissions: Modify Devices/Deployment

System Information

GET serverversion
Request Type: GET
Description: Request version information for the server.
URL: /api/fmc_platform/v1/info/serverversion
Permissions:

Services Available in Firepower Threat Defense

GET physicalinterfaces
Request Type: GET
Description: Retrieves the physical interface associated with the specified NGFW device ID and interface ID.
If no interface ID is specified, retrieves list of all physical interfaces associated with the specified NGFW
device ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/physicalinterfaces
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
physicalinterfaces/{object_UUID}
Permissions: Devices > Device Management

GET redundantinterfaces
Request Type: GET
Description: Retrieves the redundant interface associated with the specified NGFW device ID and interface
ID. If no interface ID is specified, retrieves list of all redundant interfaces associated with the specified NGFW
device ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
redundantinterfaces
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
redundantinterfaces/{object_UUID}
Permissions: Devices > Device Management

Firepower REST API Quick Start Guide, Version 6.1

43
 Objects in the REST API
GET etherchannelinterfaces

GET etherchannelinterfaces
Request Type: GET
Description: Retrieves the ethernet channel interface associated with the specified NGFW device ID and
interface ID. If no ID is specified, retrieves list of all ethernet channel interfaces associated with the specified
NGFW device ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
etherchannelinterfaces
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
etherchannelinterfaces/{object_UUID}
Permissions: Devices > Device Management
Parameters available for filtering:

GET subinterfaces
Request Type: GET
Description: Retrieves the sub-interface associated with the specified NGFW device ID and interface ID. If
no interface ID is specified, retrieves list of all sub-interfaces associated with the specified NGFW device ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{containerUUID}/subinterfaces
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{containerUUID}/
subinterfaces/{object_UUID}
Permissions: Devices > Device Management

GET bridgegroupinterfaces
Request Type: GET
Description: Retrieves the bridge group interface associated with the specified NGFW device ID and interface
ID. If no interface ID is specified, retrieves list of all bridge group interfaces associated with the specified
NGFW device ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
bridgegroupinterfaces
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
bridgegroupinterfaces/{object_UUID}
Permissions: Devices > Device Management

POST devicerecords
Request Type: POST
Description: Registers the specified device to the Firepower Managemenr Center.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords

Firepower REST API Quick Start Guide, Version 6.1

44
 Objects in the REST API
PUT devicerecords

Permissions: Devices > Device Management > Modify Devices

PUT devicerecords
Request Type: PUT
Description: Modifies the device record associated with the specified ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{object_UUID}
Permissions: Devices > Device Management > Modify Devices

GET devicegrouprecords
Request Type: GET
Description: Retrieves the device group associated with the specified ID. If no ID is specified, retrieves list
of all device groups.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devicegroups/devicegrouprecords
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/devicegroups/devicegrouprecords/{object_
UUID}
Permissions: Devices > Device Management > View Devices

DELETE devicerecords
Request Type: DELETE
Description: Unregisters the specified device.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{object_UUID}
Permissions: Devices > Device Management > Modify Devices

POST devicegrouprecords
Request Type: POST
Description: Create a device group with the specified object ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devicegroups/devicegrouprecords
Permissions: Devices > Device Management > Modify Devices

PUT devicegrouprecords
Request Type: PUT
Description: Modifies a device group with the specified object ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devicegroups/devicegrouprecords/{object_UUID}
Permissions: Devices > Device Management > Modify Devices

Firepower REST API Quick Start Guide, Version 6.1

45
 Objects in the REST API
GET devicegrouprecords

GET devicegrouprecords
Request Type: GET
Description: Retrieves the device group associated with the specified ID. If no ID is specified, retrieves list
of all device groups.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devicegroups/devicegrouprecords
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/devicegroups/devicegrouprecords/{object_
UUID}
Permissions: Devices > Device Management > View Devices

DELETE devicegrouprecords
Request Type: DELETE
Description: Deletes a device group with the specified object ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devicegroups/devicegrouprecords/{object_UUID}
Permissions: Devices > Device Management > Modify Devices

POST securityzones
Request Type: POST
Description: Create securityzone objects with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/securityzones
Permissions: Object Manager>Modify Object Manager

PUT securityzones
Request Type: PUT
Description: Modifies a securityzone object.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/securityzones/{object_UUID}
Permissions: Object Manager>Modify Object Manager

GET securityzones
Request Type: GET
Description: Retrieves the security zone objects associated with the specified ID. If no ID is specified, retrieves
list of all security zone objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/securityzones
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/securityzones/{object_UUID}

Firepower REST API Quick Start Guide, Version 6.1

46
 Objects in the REST API
DELETE securityzones

Permissions: Object Manager

Parameters available for filtering: name

DELETE securityzones
Request Type: DELETE
Description: Deletes the specified securityzone objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/securityzones/{object_UUID}
Permissions: Object Manager>Modify Object Manager

POST policyassignments
Request Type: POST
Description: Assigns an unassigned access policy to devices or device groups.
URL: /api/fmc_config/v1/domain/{domain_UUID}/assignment/policyassignments
Permissions:

PUT policyassignments
Request Type: PUT
Description: Modify an assigned access policy to add a new device or a new device group.
URL: /api/fmc_config/v1/domain/{domain_UUID}/assignment/policyassignments/{object_UUID}
Permissions:

GET policyassignments
Request Type: GET
Description: Retrieves the policy assignment associated with the specified ID. If no ID is specified, retrieves
a list of all policy assignments to target devices.
URL: /api/fmc_config/v1/domain/{domain_UUID}/assignment/policyassignments
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/assignment/policyassignments/{object_
UUID}
Permissions:
Parameters available for filtering: name

GET deployabledevices
Request Type: GET
Description: Retrieves list of all devices with configuration changes, ready to be deployed.

Firepower REST API Quick Start Guide, Version 6.1

47
 Objects in the REST API
POST deploymentrequests

URL: /api/fmc_config/v1/domain/{domain_UUID}/deployment/deployabledevices
Permissions: Deploy Configuration to Devices
Parameters available for filtering: name

POST deploymentrequests
Request Type: POST
Description: Creates a request for deploying configuration changes to the specified device.
URL: /api/fmc_config/v1/domain/{domain_UUID}/deployment/deploymentrequests/{object_UUID}
Permissions: Deploy Configuration to Devices

Firepower REST API Quick Start Guide, Version 6.1

48