Objects in the REST API

• Request Structure, on page 1

• Bulk Rule Posting, on page 3
• Response Structure, on page 4
• Rate Limiting, on page 6
• Payload Limiting, on page 6
• Audit Services, on page 6
• Deployment Services, on page 7
• Device Group Services, on page 7
• Device HA Pair Services, on page 8
• Device Services, on page 9
• Intelligence Services, on page 20
• Object Services, on page 24
• Policy Services, on page 41
• Policy Assignment Services, on page 47
• Status Services, on page 47
• System Information, on page 48

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:
https://<management_center_IP_or_name>:<https_port>/<object_URL>/object_UUIDoptions

Where:
• <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>

Objects in the REST API

1
 Objects in the REST API
Request Structure

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 URIs include the domain UUID,
which can be found in the Authentication Token. When deleting or modifying an object, or requesting
information about a specific object, the URI 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. POST operations should be followed with a payload
consisting of the JSON object to be created, enclosed in braces:
{object]

Note The maximum number of rules you can use depends on memory of the device.
There is no set limit, because complex rules use more memory. For rule
performance and optimization guidelines, see the Firepower Management Center
Configuration Guide.

• 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. Some fields will only show if this flag is set to true.

Objects in the REST API

2
 Objects in the REST API
Bulk Rule Posting

• 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.

Bulk Rule Posting

Multiple access control rules can be added with a POST command using the bulk insert feature. This feature
allows as many as 1,000 rules to be addded at once.
This feature is only available for access rules.
The URL for this feature is:
https://{fmc_IP_or_name}:{https_port}/api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{policy_UUID}/accessrules?bulk=true

The option:
?bulk=true

indicates that that multiple rules will be used in the payload of this request.
All objects in the payload of the bulk POST request must be of the same type. You cannot mix different objects
in the same bulk request.
Unlike a normal POST operation, the bulk POST requires a list of JSON objects. This list may have as many
as 1,000 objects or as few as one. The individual JSON objects must be enclosed in braces. Each object must
be separated by commas, and the entire list is enclosed in brackets:
[{object}]
[{object1},{object2},{object3},{object4},{object5} …]

The following query parameters are supported in bulk POST requests:

• bulk=true
This parameter specifies that the bulk POST feature is being used in the query. This parameter is required
for bulk rule posting.
• section=mandatory/default
This parameter specifies the section into which the rules will be added. If this parameter is not used the
section will be the default section. Only mandatory and default are allowed values. If a section is
specified it must exist or the request will fail. If a section is specified, a category cannot be specified.
• category=<Name of the category>

This parameter specifies the category into which the rules will be added. If a category is specified it must
exist or the request will fail. If a category is specified, a section cannot be specified.
• insertAfter=<Index of rule>

This parameter specifies that the rules will be inserted after the specified rule index. If no section or
category is specified, the rules will be added to the section or category after the insertion point.

Objects in the REST API

3
 Objects in the REST API
Response Structure

• insertBefore=<Index of rule>

This parameter specifies that the rules will be inserted before the specified rule index.If no section or
category is specified, the rules will be added to the section or category before the insertion point.
insertBefore takes precedence over insertAfter - if both are specified, the insertBefore parameter will
apply.

When a rule or group of rules are inserted at an index which is part of either a section or a category, the
category or section parameter can be used along with index to specify the insertion location of the rule(s). If
an index is given along with a section or category, but the index is not in that section or category, you will
receive an error.
If no index is specified, rules will be inserted after the end of the access policy. If a category or section is
specified but no index is specified, rules will be inserted at the end of the category or section.
In any given POST all of the rules will be inserted at a single point. You cannot specify multiple insertion
locations in a POST request.

Note Rule order affects how orders are parsed by the Firepower Management Center.

Response Structure

Note The REST API will serve only 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.

Objects in the REST API

4
Objects in the REST API
Response Structure

• 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.
This can indicate that the object was edited or deleted via REST API such that the corresponding policy
is invalidated.
• 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.
• 422 Unprocessable Entity

– The payload is too large. This will occur when you send a payload greater than 2048000 bytes.
– The payload contains an unprocessable or unreadable entity such as a invalid attribut name or incorrect
JSON syntax.
• 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.
– Too many concurrent requests. The system cannot accept more than 10 parallel requests from all clients.
– Too many write operations per server. The API will only allow one PUT, POST, or DELETE request
per user on a server at a time.
• 5xx - A five-hundred series code indicates a server-side error.

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:
{
"error": {
"category": "FRAMEWORK",
"messages": [
{
"description": "Action is mandatory to be specified."
}
],
"severity": "ERROR"
}
}

where the object properties are:

Objects in the REST API

5
 Objects in the REST API
Rate Limiting

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 Management Center REST API implements rate limiting to reduce network load.
The API will accept no more than 120 messages per minute from an individual IP address. 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.

Payload Limiting
The API cannot accept a message with a payload greater than 2048000 bytes. This applies to both the REST
API and to API Explorer. This is not a configurable parameter.
If a message exceeds this limit, the API will give an HTTP 422 error.

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

Objects in the REST API

6
 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
Description: Creates a device group with the specified object ID.

Objects in the REST API

7
 Objects in the REST API
GET devicegrouprecords

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 HA Pair Services

DELETE ftddevicehapair
Request Type: DELETE
Description: Deletes a device high availability pair with the specified object ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devicehapairs/ftddevicehapairs/{object_UUID}
Permissions: Devices > Device Management > Modify Devices

Note Run the configure high-availability disable command to remove the failover configurations from FTD devices.

PUT ftddevicehapair
Request Type: PUT
Description: Sets any one of the following actions for the Firepower Threat Defense high availability device:
• Sets the failover trigger criteria for the device
• Switches states within the device
• Breaks or force-breaks the device

URL:
/api/fmc_config/v1/domain/{domain_UUID}/devicehapairs/ftddevicehapairs/{ha_container_UUID}

Permissions: Devices > Device Management > Modify Devices

Objects in the REST API

8
 Objects in the REST API
POST ftddevicehapairs

POST ftddevicehapairs
Request Type: POST
Description: Creates a high availability device pair with the specified primary and secondary object IDs. Do
not perform the POST operation for more than one high availability pair at a time. Ensure that the current
POST operation is completed successfully before proceeding to the next POST operation.

Note Typically, the first POST operation responds within 60 seconds. Cisco recommends that you perform subsequent
POST operations at least 120 seconds after the first POST operation was initiated. The response of the POST
operation includes a task object, with a task ID and task status. You can monitor the completion of the task
by performing a GET operation on the task object with its task ID. For more information, see GET taskstatuses,
on page 47.

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

GET ftddevicehapairs
Request Type: GET
Description: Retrieves the details associated with the specified high availability container ID. If no ID is
specified, retrieves a list of all high availability container objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devicehapairs/ftddevicehapairs
URL for GET by ID:
/api/fmc_config/v1/domain/{domain_UUID}/devicehapairs/ftddevicehapairs/{ha_container_UUID}

Permissions: Devices > Device Management > Modify Devices

Device Services
POST copyconfigrequests
Request Type: POST
Description: Copies device configuration to the specified Firepower Threat Defense device.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/copyconfigrequests
Permissions: Devices > Device Management > Modify Devices

DELETE devicerecords
Request Type: DELETE
Description: Unregisters the specified device.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{object_UUID}

Objects in the REST API

9
 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

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

GET devicerecords
Request Type: GET
Description: Retrieves 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: Modifies 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.

Objects in the REST API

10
 Objects in the REST API
DELETE fplogicalinterfaces

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: Deletes 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

PUT fplogicalinterfaces
Request Type: PUT
Description: Modifies 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

Objects in the REST API

11
 Objects in the REST API
DELETE inlinesets

Parameters available for filtering: name

DELETE inlinesets
Request Type: DELETE
Description: Deletes 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
Description: Modifies 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

GET staticroutes
Request Type: GET
Description: Retrieves list of all IPv4 and IPv6 Static Routes associated with the specified device.

Objects in the REST API

12
 Objects in the REST API
DELETE ipv4staticroutes

URL:
/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/staticroutes

URL for GET ID::

/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/staticroutes/{object_UUID}

Permissions: Devices > Devices Management

DELETE ipv4staticroutes
Request Type: DELETE
Description: Deletes the IPv4 Static Route associated with the specified ID.
URL:
/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ipv4staticroutes/{object_UUID}

Permissions: Devices > Devices Management > Modify Devices

PUT ipv4staticroutes
Request Type: PUT
Description: Modifies the IPv4 Static Route associated with the specified ID.
URL:
/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ipv4staticroutes/{object_UUID}

Permissions: Devices > Devices Management > Modify Devices

POST ipv4staticroutes
Request Type: POST
Description: Creates an IPv4 Static Route.
URL:
/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ipv4staticroutes

Permissions: Devices > Device Management > Modify Devices

GET ipv4staticroutes
Request Type: GET
Description: Retrieves the IPv4 Static Route associated with the specified ID. If no ID is specified, retrieves
list of all IPv4 Static Routes.
URL:
/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ipv4staticroutes

URL for GET ID::

/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ipv4staticroutes/{object_UUID}

Permissions: Devices > Devices Management

Objects in the REST API

13
 Objects in the REST API
DELETE ipv6staticroutes

DELETE ipv6staticroutes
Request Type: DELETE
Description: Deletes the IPv6 Static Route associated with the specified ID.
URL:
/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ipv6staticroutes/{object_UUID}

Permissions: Devices > Device Management > Modify Devices

PUT ipv6staticroutes
Request Type: PUT
Description: Modifies the IPv6 Static Route associated with the specified ID.
URL:
/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ipv6staticroutes/{object_UUID}

Permissions: Devices > Device Management > Modify Devices

POST ipv6staticroutes
Request Type: POST
Description: Creates an IPv6 Static Route.
URL:
/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ipv6staticroutes

Permissions: Devices > Device Management > Modify Devices

GET ipv6staticroutes
Request Type: GET
Description: Retrieves the IPv6 Static Route associated with the specified ID. If no ID is specified, retrieves
list of all IPv6 Static Routes.
URL:
/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ipv6staticroutes

URL for GET ID:

/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ipv6staticroutes/{object_UUID}

Permissions: Devices > Device Management

DELETE virtualswitches
Request Type: DELETE
Description: Deletes a virtual switch on the specified device.
This method is only available on a Firepower 1010 device.

Objects in the REST API

14
 Objects in the REST API
PUT virtualswitches

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: Modifies a virtual switch on the specified device.
This method is only available on a Firepower 1010 device.
URL:
/api/fmc_config/v1/domain/{UUID}/devices/devicerecords/{containerUUID}/virtualswitches/{object_UUID}

Permissions: Devices > Device Management > Modify Device

POST virtualswitches
Request Type: POST
Description: Creates a virtual switch on the specified device.
This method is only available on a Firepower 1010 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.
This method is only available on a Firepower 1010 device.
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

PUT fpphysicalinterfaces
Request Type: PUT
Description: Modifies a physical interface on the specified device.

Objects in the REST API

15
 Objects in the REST API
GET fpphysicalinterfaces

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

PUT physicalinterfaces
Request Type: PUT
Description: Modifies physical interfaces on a specified device.
URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/
physicalinterfaces

Permissions: Devices > Device Management > Modify Device

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 bridgegroupinterfaces
Request Type: GET

Objects in the REST API

16
 Objects in the REST API
POST bridgegroupinterfaces

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 bridgegroupinterfaces
Request Type: POST
Description: Creates bridge group interfaces associated with the specified NGFW device ID and interface ID.
URL:
/api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/bridgegroupinterfaces

Permissions: Devices > Device Management > Modify Device

PUT bridgegroupinterfaces
Request Type: PUT
Description: Modifies a bridge group interface on the specified device.
URL:
/api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/bridgegroupinterfaces

Permissions: Devices > Device Management > Modify Device

DELETE bridgegroupinterfaces
Request Type: DELETE
Description: Deletes a bridge group interface associated with the specified NGFW device ID and interface
ID.
URL:
/api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/bridgegroupinterfaces

Permissions: Devices > Device Management > Modify Device

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

Objects in the REST API

17
 Objects in the REST API
POST redundantinterfaces

URL for GET by ID:

/api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/redundantinterfaces/{object_UUID}

Permissions: Devices > Device Management

POST redundantinterfaces
Request Type: POST
Description: Creates redundant interfaces on a specified device.
URL:
/api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/redundantinterfaces

Permissions: Devices > Device Management

PUT redundantinterfaces
Request Type: PUT
Description: Modifies redundant interfaces on a specified device.
URL:
/api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/redundantinterfaces

Permissions: Devices > Device Management > Modify Device

DELETE redundantinterfaces
Request Type: DELETE
Description: Removes redundant interfaces on a specified device.
URL:
/api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/redundantinterfaces

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:

Objects in the REST API

18
 Objects in the REST API
POST etherchannelinterfaces

POST etherchannelinterfaces
Request Type: POST
Description: Creates ethernet channel interfaces on the specified device.
URL:
/api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/ethernetchannelinterfaces

Permissions: Devices > Device Management > Modify Device

PUT etherchannelinterfaces
Request Type: PUT
Description: Modifies an ethernet channel interfaces on the specified device.
URL:
/api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{containerUUID}/ethernetchannelinterfaces/

Permissions: Devices > Device Management > Modify Device

DELETE etherchannelinterfaces
Request Type: DELETE
Description: Removes ethernet channel interfaces from a specified device.
URL:
/api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/ethernetchannelinterfaces

Permissions: Devices > Device Management

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/{container_UUID}/subinterfaces

URL for GET by ID:

/api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/subinterfaces/{object_UUID}

Permissions: Devices > Device Management

POST subinterfaces
Request Type: POST
Description: Creates sub interfaces on a specified device.
URL:
/api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/subinterfaces

Objects in the REST API

19
 Objects in the REST API
PUT subinterfaces

Permissions: Devices > Device Management

PUT subinterfaces
Request Type: PUT
Description: Modifies a sub interface on the specified device.
URL:
/api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/subinterfaces/

Permissions: Devices > Device Management > Modify Device

DELETE subinterfaces
Request Type: DELETE
Description: Deletes sub interfaces on a specified device.
URL:
/api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/subinterfaces

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

Intelligence Services
POST collections
Request Type: POST
Description: Adds a collections from a TAXII source.
URL: /api/fmc_tid/v1/domain/{domain_UUID}/taxiiconfig/collections
Permissions: Intelligence

POST discoveryinfo
Request Type: POST

Objects in the REST API

20
 Objects in the REST API
GET element

Description: Adds information about TAXII collections available from a source.

URL: /api/fmc_tid/v1/domain/{domain_UUID}/taxiiconfig/discoveryinfo
Permissions: Intelligence

GET element
Request Type: GET
Description: Retrieves the intelligence-enabled sensor associated with the specified ID. If no ID is specified,
retrieves list of all intelligence-enabled sensors.
URL: /api/fmc_tid/v1/domain/{domain_UUID}/tid/element
URL for GET by ID: /api/fmc_tid/v1/domain/{domain_UUID}/tid/element/{object_UUID}
Permissions: Intelligence

DELETE incident
Request Type: DELETE
Description: Deletes an incident.
URL: /api/fmc_tid/v1/domain/{domain_UUID}/taxiiconfig/incident/{object_UUID}
Permissions: Intelligence

PUT incident
Request Type: PUT
Description: Modifies an intelligence incident with the specified object ID.
URL: /api/fmc_tid/v1/domain/{domain_UUID}/tid/incident/{object_UUID}
Permissions: Intelligence

GET incident
Request Type: GET
Description: Retrieves the intelligence incident associated with the specified ID. If no ID is specified, retrieves
list of all intelligence incidents. By default 25 results will be displayed on each page, this can be increased up
to 40 using the limit parameter.
URL: /api/fmc_tid/v1/domain/{domain_UUID}/tid/incident
URL for GET by ID: /api/fmc_tid/v1/domain/{domain_UUID}/tid/incident/{object_UUID}
Permissions: Intelligence

PUT indicator
Request Type: PUT

Objects in the REST API

21
 Objects in the REST API
GET indicator

Description: Modifies an indicator with the specified object ID.

URL: /api/fmc_tid/v1/domain/{domain_UUID}/tid/indicator/{object_UUID}
Permissions: Intelligence

GET indicator
Request Type: GET
Description: Retrieves the indicator associated with the specified ID. If no ID is specified, retrieves list of all
indicators. By default 25 results will be displayed on each page, this can be increased up to 40 using the limit
parameter.
URL: /api/fmc_tid/v1/domain/{domain_UUID}/tid/indicator
URL for GET by ID: /api/fmc_tid/v1/domain/{domain_UUID}/tid/indicator/{object_UUID}
Permissions: Intelligence

PUT observable
Request Type: PUT
Description: Modifies an observable with the specified object ID.
URL: /api/fmc_tid/v1/domain/{domain_UUID}/tid/observable/{object_UUID}
Permissions: Intelligence

GET observable
Request Type: GET
Description: Retrieves the observable associated with the specified ID. If no ID is specified, retrieves list of
all observables. By default 25 results will be displayed on each page, this can be increased up to 40 using the
limit parameter.

URL: /api/fmc_tid/v1/domain/{domain_UUID}/tid/observable
URL for GET by ID: /api/fmc_tid/v1/domain/{domain_UUID}/tid/observable/{object_UUID}
Permissions: Intelligence

PUT settings
Request Type: PUT
Description: Activates or deactivates an intelligence setting.
URL: /api/fmc_tid/v1/domain/{domain_UUID}/tid/settings/{value}
Permissions: Intelligence

Objects in the REST API

22
 Objects in the REST API
GET settings

GET settings
Request Type: GET
Description: Retrieves the on/off settings for the specified value. If no ID is specified, retrieves list of all TID
settings.
URL: /api/fmc_tid/v1/domain/{domain_UUID}/tid/settings
URL for GET by value: /api/fmc_tid/v1/domain/{domain_UUID}/tid/settings/{value}
Permissions: Intelligence

DELETE source
Request Type: DELETE
Description: Deletes an intelligence source from the device.
URL: /api/fmc_tid/v1/domain/{domain_UUID}/taxiiconfig/source/{object_UUID}
Permissions: Intelligence

PUT source
Request Type: PUT
Description: Modifies an intelligence source with the specified object ID.
URL: /api/fmc_tid/v1/domain/{domain_UUID}/tid/source/{object_UUID}
Permissions: Intelligence

POST source
Request Type: POST
Description: Adds a source for intelligence information.
URL: /api/fmc_tid/v1/domain/{domain_UUID}/tid/source
Permissions: Intelligence

GET source
Request Type: GET
Description: Retrieves the intelligence source associated with the specified ID. If no ID is specified, retrieves
list of all intelligence sources. By default 25 results will be displayed on each page, this can be increased up
to 40 using the limit parameter.
URL: /api/fmc_tid/v1/domain/{domain_UUID}/tid/source
URL for GET by ID: /api/fmc_tid/v1/domain/{domain_UUID}/tid/source/{object_UUID}
Permissions: Intelligence

Objects in the REST API

23
 Objects in the REST API
Object Services

Object Services
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
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

Objects in the REST API

24
 Objects in the REST API
GET applicationrisks

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}
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}

Objects in the REST API

25
 Objects in the REST API
GET continents

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

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

Objects in the REST API

26
 Objects in the REST API
DELETE hosts

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: Modifies 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: Creates or overrides the host objects with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/hosts
URL for Bulk Post: /api/fmc_config/v1/domain/{domain_UUID}/object/hosts?bulk=true
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 for listing: /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

Objects in the REST API

27
 Objects in the REST API
PUT icmpv4objects

PUT icmpv4objects
Request Type: PUT
Description: Modifies 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: Creates or overrides the 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 for listing: /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}
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: Modifies 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

Objects in the REST API

28
 Objects in the REST API
GET icmpv6objects

Description: Creates or overrides the 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 for listing: /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}
URL to list all overrides on a particular object:
/api/fmc_config/v1/domain/{domain_UUID}/object/icmp6objects/{icmpv6object_UUID}/overrides

Permissions: Object Manager

GET isesecuritygrouptags
Request Type: GET
Description: 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
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}
URL to DELETE overrides on a particular object:
/api/fmc_config/v1/domain/{domain_UUID}/object/networkgroups/{object_UUID}?overrideTargetId={target_UUID}

Permissions: Object Manager > Modify Object Manager

Objects in the REST API

29
 Objects in the REST API
PUT networkgroups

PUT networkgroups
Request Type: PUT
Description: Modifies 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: Creates or overrides the 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 for listing: /api/fmc_config/v1/domain/{domain_UUID}/object/networkgroups
URL for all the overrides on a particular domain or device:
/api/fmc_config/v1/domain/{domain_UUID}/object/networkgroups?overrideTargetId={target_UUID}

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/networkgroups/{object_UUID}

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}
URL to DELETE overrides on a particular object:
/api/fmc_config/v1/domain/{domain_UUID}/object/networks/{object_UUID}?overrideTargetId={target_UUID}

Permissions: Object Manager > Modify Object Manager

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

Objects in the REST API

30
 Objects in the REST API
POST networks

POST networks
Request Type: POST
Description: Creates or overrides the network objects with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/networks
URL for Bulk Post: /api/fmc_config/v1/domain/{domain_UUID}/object/networks?bulk=true
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 for listing: /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}
URL to DELETE overrides on a particular object:
/api/fmc_config/v1/domain/{domain_UUID}/object/portobjectgroups/{object_UUID}?overrideTargetId={target_UUID}

Permissions: Object Manager > Modify Object Manager

PUT portobjectgroups
Request Type: PUT
Description: Modifies 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: Creates or overrides the port object groups with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/portobjectgroups
Permissions: Object Manager > Modify Object Manager

Objects in the REST API

31
 Objects in the REST API
GET portobjectgroups

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 for listing: /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}

URL to list all overrides on a particular object:

/api/fmc_config/v1/domain/{domain_UUID}/object/portobjectgroups/{portobjectgroup_UUID}/overrides

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}
URL to DELETE overrides on a particular object:
/api/fmc_config/v1/domain/{domain_UUID}/object/protocolportobjects/{object_UUID}?overrideTargetId={target_UUID}

Permissions: Object Manager > Modify Object Manager

PUT protocolportobjects
Request Type: PUT
Description: Modifies 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: Creates or overrides the protocol port objects with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/protocolportobjects

Objects in the REST API

32
 Objects in the REST API
GET 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 for listing:: /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}
URL to DELETE overrides on a particular object:
/api/fmc_config/v1/domain/{domain_UUID}/object/ranges/{object_UUID}?overrideTargetId={target_UUID}

Permissions: Object Manager > Modify Object Manager

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

POST ranges
Request Type: POST
Description: Creates or overrides 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.

Objects in the REST API

33
 Objects in the REST API
GET realms

URL for listing: /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.

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.

Objects in the REST API

34
 Objects in the REST API
GET securitygrouptags

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

POST securityzones
Request Type: POST
Description: Creates or overrides the 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

Objects in the REST API

35
 Objects in the REST API
GET siurlfeeds

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

DELETE slamonitors
Request Type: DELETE
Description: Deletes the sla monitor object associated with the specified ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/slamonitors/{object_UUID}
Permissions: Object Manager > Modify Object Manager

PUT slamonitors
Request Type: PUT
Description: Modifies the sla monitor object associated with the specified ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/slamonitors/{object_UUID}
Permissions: Object Manager > Modify Object Manager

POST slamonitors
Request Type: POST
Description: Creates or overrides a SLA monitor with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/slamonitors
Permissions: Object Manager > Modify Object Manager

Objects in the REST API

36
 Objects in the REST API
GET slamonitors

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

GET tunneltags
Request Type: GET
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}
URL to DELETE overrides on a particular object:
/api/fmc_config/v1/domain/{domain_UUID}/object/urlgroups/{object_UUID}?overrideTargetId={target_UUID}

Permissions: Object Manager > Modify Object Manager

PUT urlgroups
Request Type: PUT
Description: Modifies urlgroup objects.

Objects in the REST API

37
 Objects in the REST API
POST urlgroups

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

POST urlgroups
Request Type: POST
Description: Creates or overrides the 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
Description: Retrieves the url group objects associated with the specified ID. If no ID is specified, retrieves
list of all url group objects.
URL for listing: /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

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

POST urls
Request Type: POST
Description: Creates or overrides the URLs with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/urls
Permissions: Object Manager > Modify 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.

Objects in the REST API

38
 Objects in the REST API
GET variablesets

URL for listing: /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
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}
URL to DELETE overrides on a particular object:
/api/fmc_config/v1/domain/{domain_UUID}/object/vlangrouptags/{object_UUID}?overrideTargetId={target_UUID}

Permissions: Object Manager > Modify Object Manager

PUT vlangrouptags
Request Type: PUT
Description: Modifies 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: Creates or overrides the 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

Objects in the REST API

39
 Objects in the REST API
DELETE vlantags

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 for listing: /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
Description: Deletes the specified VLAN tag objects.
URL: /api/fmc_config/v1/domain/{domain_UUID}/object/vlantags/{object_UUID}
URL to DELETE overrides on a particular object:
/api/fmc_config/v1/domain/{domain_UUID}/object/vlantags/{object_UUID}?overrideTargetId={target_UUID}

Permissions: Object Manager > Modify Object Manager

PUT vlantags
Request Type: PUT
Description: Modifies 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: Creates or overrides the 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 for listing: /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

Objects in the REST API

40
 Objects in the REST API
Policy Services

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

PUT accesspolicies
Request Type: PUT
Description: Modifies 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: Creates 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: Deletes 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}

Objects in the REST API

41
 Objects in the REST API
PUT accessrules

Permissions: Policies>Access Control>Access Control Policy>Modify Access Control Policy

PUT accessrules
Request Type: PUT
Description: Modifies 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

POST accessrules
Request Type: POST
Description: Creates 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

Objects in the REST API

42
 Objects in the REST API
GET filepolicies

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

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

DELETE ftdnatpolicies
Request Type: DELETE
Description: Deletes the Firepower Threat Defense NAT policy with the specified ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies/{object_UUID}
Permissions: Devices>NAT>NAT List >Modify NAT policy

PUT ftdnatpolicies
Request Type: PUT
Description: Modifies an Firepower Threat Defense NAT policy with the specified ID.
URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies/{object_UUID}
Permissions: Devices>NAT>NAT List >Modify NAT policy

POST ftdnatpolicies
Request Type: POST
Description: Creates a Firepower Threat Defense device NAT policy with the specified parameters.
URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies
Permissions: Devices>NAT>NAT List >Modify NAT policy

Objects in the REST API

43
 Objects in the REST API
GET ftdnatpolicies

GET ftdnatpolicies
Request Type: GET
Description: Retrieves the Firepower Threat Defense NAT policy associated with the specified ID. If no ID
is specified, retrieves a list of all Firepower Threat Defense NAT policies.
URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies/{object_UUID}
Permissions: Devices>NAT>NAT List

DELETE autonatrules
Request Type: DELETE
Description: Deletes a NAT rule with the specified parameters.
URL:
/api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies/{container_UUID}/autonatrules/{object_UUID}

Permissions: Devices>NAT>NAT List >Modify NAT policy

PUT autonatrules
Request Type: PUT
Description: Modifies a NAT rule with the specified parameters.
URL:
/api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies/{container_UUID}/autonatrules/{autonatrule_UUID)

Permissions: Devices>NAT>NAT List >Modify NAT policy

POST autonatrules
Request Type: POST
Description: Creates a NAT policy with the specified parameters.
URL:
/api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies/{container_UUID}/autonatrules

Permissions: Devices>NAT>NAT List >Modify NAT policy

GET autonatrules
Request Type: GET
Description: Retrieves the NAT rule associated with the specific ID. If no ID is specified, retrieves a list of
all NAT rules.
URL:
/api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies/{container_UUID}/autonatrules

Objects in the REST API

44
 Objects in the REST API
DELETE manualnatrules

URL for GET by ID:

/api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies{container_UUID}/autonatrules/{object_UUID}

Permissions: Devices>NAT>NAT List

DELETE manualnatrules
Request Type: POST
Description: Deletes a manual NAT rule in the specified NAT policy.
URL:
/api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies/{container_UUID}/manualnatrules/{object_UUID}

Permissions: Devices>NAT>NAT List >Modify NAT policy

PUT manualnatrules
Request Type: PUT
Description: Modify a manual NAT rule in the specified NAT policy.
URL:
/api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies/{container_UUID}/manualnatrules/{object_UUID}

Permissions: Devices>NAT>NAT List >Modify NAT policy

POST manualnatrules
Request Type: POST
Description: Creates manual NAT rules with the specified parameters.
URL:
/api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies/{container_UUID}/manualnatrules

Permissions: Devices>NAT>NAT List >Modify NAT policy

GET manualnatrules
Request Type: GET
Description: Retrieves the manual NAT rule associated with the specified ID. If no ID is specified, retrieves
a list of all manual NAT rules.
URL:
/api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies/{container_UUID}/manualnatrules

URL for GET by ID:

/api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies/{container_UUID}/manualnatrules/{object_UUID}

Permissions: Devices>NAT>NAT List

Objects in the REST API

45
 Objects in the REST API
GET natrules

GET natrules
Request Type: GET
Description: Retrieves the list of all NAT rules (manual and auto) associated with the specified NAT policy.
URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies/{container_UUID}/natrules
Permissions: Devices>NAT>NAT List

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

Objects in the REST API

46
 Objects in the REST API
Policy Assignment Services

Policy Assignment Services

PUT policyassignments
Request Type: PUT
Description: Modifies 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
Description: Retrieves information about a previously submitted pending job/task with the specified ID. This
is currently supported for device registration and deployment jobs.
URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/job/taskstatuses/{object_UUID}
Permissions: Modify Devices/Deployment

Objects in the REST API

47
 Objects in the REST API
System Information

System Information
GET serverversion
Request Type: GET
Description: Requests version information for the server. If no ID is specified, retrieves a list of all servers.
URL: /api/fmc_platform/v1/info/serverversion
URL for GET by ID: /api/fmc_platform/v1/info/serverversion/{objectID}
Permissions:

Objects in the REST API

48