Chapter 1. About the Firepower Management Center REST API

The Firepower Management Center REST API provides a lightweight API to manage a Firepower Management Center.

- About the Firepower Management Center REST API

- Enabling the REST API

- Best Practices

- Additional Resources

About the Firepower Management Center REST API

With the release of Cisco’s Firepower Management Center 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.

Note

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 "Save Successful" dialog will display when the REST API is enabled.

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 CC or UCAPL mode you should disable REST API access to the Firepower Management Center and managed devices.

Additional Resources

Additional resources for the Firepower Management Center REST API can be found on Cisco DevNet at https://developer.cisco.com/firepower/.

Chapter 2. About the API Explorer

- About the API Explorer

- Authentication to the API Explorer

- Accessing the Legacy API Explorer

- Obtaining Sample Code with CodeGen

- Viewing API Parameters

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:

https://<management_center_IP_or_name>:<https_port>/api/api-explorer

Version 6.4 uses a new API Explorer, based on the OpenAPI Specification (OAS). You can still access the legacy API Explorer if you prefer.

As part of the OAS, you now use CodeGen to generate sample code.

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.

- Logging into API Explorer

- Setting the Domain

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: https://<management_center_IP_or_name>:<https_port>/api/api-explorer

If you experience an extended load time for the logon screen when using a Firefox browser, enter about:support in the search bar and click the Refresh Firefox option, then view the Firepower Management Center interface with self-signed certificates in the same Firefox browser. For more information, see https://support.mozilla.org/en-US/kb/refresh-firefox-reset-add-ons-and-settings.

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.

Accessing the Legacy API Explorer

The API Explorer has changed for 6.4.0. While the newer API Explorer retains nearly all of the previous functionality, some users may prefer the older interface.

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.

Log in to the API Explorer at https://<management_center_IP_or_name>:<https_port>/api/api-explorer.

Procedure

In the upper right-hand corner click on Legacy Explorer.

What to do next

Use the Legacy API Explorer as you would normally.

Obtaining Sample Code with CodeGen

You can use the CodeGen utility on the Open API Spec to generate sample code in a number of different languages. This utility is an open-source tool you can download online. The resultant code is meant primarily as an educational and bootstrapping tool.

The CodeGen utility creates sample code for the entire Open API Spec. As such, it generates sample code for every allowed method and endpoint in the REST API. The sample code can be in a variety of languages, including HTML, Perl, Python, and Java.

For complete documentation of the CodeGen utility go to https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/

- Downloading the Open API Spec

- Generating Sample Code with the CodeGen Utility

Downloading the Open API Spec

The Open API Spec is a standardized specification of a REST API. The Open API Spec for the Firepower Management Center REST API contains details about the endpoints, fields, parameters, and requirements of the API. You can use the API Spec to generate sample code as well as find specific information about API functionality.

The Open API Spec is a JSON file. It can be read by most text editors.

Before you begin

Have an account on the Firepower Management Center which is able to access the API Explorer.

Make sure that your browser is able to download from sites with self-signed certificates.

Procedure

Step 1

Navigate to the following URL: https://<management_center_IP_or_name>:<https_port>/api/api-explorer

Step 2

Click on Download Spec in the upper right corner. Depending on your browser configuration, you will either be given a prompt to save the file, or be shown the file directly.

Step 3

Save the file. Be sure to note the destination and filename.

What to do next

Run the CodeGen utility on the downloaded file.

Generating Sample Code with the CodeGen Utility

The Swagger CodeGen utility allows you to generate sample code from an Open API Spec. This sample code can be in a variety of languages including Java, HTML, Python, and Perl.

Before you begin

Download the Swagger CodeGen Utility. It can be found at https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/

Have a Jave Runtime Environment installed on your computer

Download the Firepower Managemenr Center REST API Open API Spec

Set environment variables to allow you to run the CodeGen utility

Procedure

From the command line, run the command java -jar ./swagger-codegen-cli-<VERSION>.jar generate -o <OUTPUT_PATH> -l <LANGUAGE> -i <OPEN_API_SPEC_FILE>

Example:

java -jar ./swagger-codegen-cli-2.3.1.jar generate -o C:\work\code\api_schema\html -l html -i fmc_swagger.json

<VERSION> is the specific version of the CodeGen utility you are using. It must match the filename of the CodeGen .jar file.

<OUTPUT_PATH> is the path to which you want to output the generated code.

<LANGUAGE> is the language which you want CodeGen to generate. Suggested options include html, java, perl, and python. Other options are possible, check the CodeGen documentation for the complete list of choices.

<OPEN_API_SPEC_FILE> is the Open API Spec file which you downloaded. This is the source from which CodeGen is generating example code. Without it, CodeGen cannot provide output.

What to do next

Find the generated code in the output path and use as desired. Generated code should be considered an example, and may not perform as desired unless modified to meet your needs.

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.

Procedure

Step 1

Select the desired resource.

Step 2

Select one of the supported operations for that resource.

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

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:

- Requesting an Authentication Token

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

Procedure

Step 1

Open your REST API Client.

Step 2

Set the client to make a POST command to the following URL: https://<management_center_IP_or_name>/api/fmc_platform/v1/auth/generatetoken.

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 Authentication from a REST API Client

Use the Domain_UUID from the authentication token in all REST requests to the server.

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: https://<management_center_IP_or_name>/api/fmc_platform/v1/auth/refreshtoken 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.

Chapter 4. Objects in the REST API

- Request Structure

- Bulk Rule Posting

- Response Structure

- Rate Limiting

- Payload Limiting

- Object Overrides

- Audit Services

- Deployment Services

- Device Group Services

- Device Clusters

- Device HA Pair Services

- Device Services

- Intelligence Services

- Integration Services

- Object Services

- Policy Services

- Policy Assignment Services

- Status Services

- System Information

- Update Packages

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

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

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

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

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.

Object Overrides

An override defines an alternate value for an object, which the system uses for the device or domain specified. In a single request user can create multiple overrides for multiple objects using bulk operation.

When an object is overriden, the alternate values will be provided for that object when it is requested. This does not overwrite the original values, which will return if the override is removed. The override gives alternate values for all fields in the object except for the Name and Description fields.

The URL for this feature is:

https://:{fmc_ip_or_name}:{https_port}/api/fmc_config/v1/domain/{Domain_uuid} /object/hosts

Request payload to create an override for object “testhost” on domain “"Global \\ RETAIL" with the override value being "1.2.3.5":

{
"type": "Host",
"value": "1.2.3.5",
"overrides": {
"parent": {
"id": <Parent UUID>
"type": "Host"
},
"target": {
"name": "Global \\ RETAIL",
"id": <target domain UUID>,
"type": "Domain"
}
},
"overridable": true,
"description": " ",
"name": "testhost",
}

Optional:

?bulk=true
indicates the override creation for more than one object.

GET:

URL to list all overrides on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/hosts/{host_UUID}/overrides

URL for override for an object on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/hosts/{host_UUID}?overrideTargetId={target_UUID}

URL for all the overrides on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/hosts?overrideTargetId={target_UUID}

Note

When overridden, the parent object value will never change.

Audit Services

- GET auditrecords

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

Deployment Services

- GET deployabledevices

- POST deploymentrequests

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

- PUT devicegrouprecords

- POST devicegrouprecords

- GET devicegrouprecords

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.

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 Clusters

- GET ftddevicecluster

GET ftddevicecluster

Request Type: GET

Description: Retrieves or modifies the FTD Cluster record associated with the specified ID. If no ID is specified for a GET, retrieves list of all FTD Clusters.

URL: /api/fmc_config/v1/domain/{domainUUID}/deviceclusters/ftddevicecluster/

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/deviceclusters/ftddevicecluster/{objectId}

Permissions: Devices > Device Management > View Devices

Device HA Pair Services

- DELETE ftddevicehapair

- PUT ftddevicehapair

- POST ftddevicehapairs

- GET ftddevicehapairs

- DELETE failoverinterfacemacaddressconfigs

- GET failoverinterfacemacaddressconfigs

- POST failoverinterfacemacaddressconfigs

- PUT failoverinterfacemacaddressconfigs

- GET monitoredinterfaces

- PUT monitoredinterfaces

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

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.

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

DELETE failoverinterfacemacaddressconfigs

Request Type: DELETE

Description: Deletes the Firepower Threat Defense high availability failover policy interface MAC addresses record associated with the specified Firepower Threat Defense high availability pair.

URL:

/api/fmc_config/v1/domain/{domain_UUID}/devicehapairs/ftddevicehapairs/
{hacontainer_UUID}/failoverinterfacemacaddressconfigs

Permissions: Devices > Device Management > Modify Devices

GET failoverinterfacemacaddressconfigs

Request Type: GET

Description: Retrieves the Firepower Threat Defense high availability failover policy interface MAC addresses record associated with the specified FTD HA pair. If no ID is specified for a GET, it retrieves the list of all Firepower Threat Defense high availability failover policy interface MAC addresses records.

URL:

/api/fmc_config/v1/domain/{domain_UUID}/devicehapairs/ftddevicehapairs/
{hacontainer_UUID}/failoverinterfacemacaddressconfigs

URL for GET by ID :

/api/fmc_config/v1/domain/{domain_UUID}/devicehapairs/ftddevicehapairs/
{hacontainer_UUID}/failoverinterfacemacaddressconfigs/{object_UUID}

Permissions: Devices > Device Management

POST failoverinterfacemacaddressconfigs

Request Type: POST

Description: Creates the Firepower Threat Defense high availability failover policy interface MAC addresses record associated with the specified Firepower Threat Defense high availability pair.

URL:

/api/fmc_config/v1/domain/{domain_UUID}/devicehapairs/ftddevicehapairs/
{hacontainer_UUID}/failoverinterfacemacaddressconfigs

Permissions: Devices > Device Management > Modify Devices

PUT failoverinterfacemacaddressconfigs

Request Type: PUT

Description: Modifies the Firepower Threat Defense high availability failover policy interface MAC addresses record associated with the specified Firepower Threat Defense high availability pair.

URL:

/api/fmc_config/v1/domain/{domain_UUID}/devicehapairs/ftddevicehapairs/
{hacontainer_UUID}/failoverinterfacemacaddressconfigs/{object_UUID}

Permissions: Devices > Device Management > Modify Devices

GET monitoredinterfaces

Request Type: GET

Description: Retrieves the Firepower Threat Defense high availability Monitored interface policy record associated with the specified FTD HA pair. If no ID is specified for a GET, it retrieves the list of all Firepower Threat Defense high availability monitored interface policy records.

URL:

/api/fmc_config/v1/domain/{domain_UUID}/devicehapairs/ftddevicehapairs/
{hacontainer_UUID}/monitoredinterfaces

URL for GET by ID :

/api/fmc_config/v1/domain/{domain_UUID}/devicehapairs/ftddevicehapairs/
{hacontainer_UUID}/monitoredinterfaces/{object_UUID}

Permissions: Devices > Device Management

PUT monitoredinterfaces

Request Type: PUT

Description: Modifies the Firepower Threat Defense high availability Monitored interface policy record associated with the specified Firepower Threat Defense high availability pair.

URL:

/api/fmc_config/v1/domain/{domain_UUID}/devicehapairs/ftddevicehapairs/
{hacontainer_UUID}/monitoredinterfaces

Permissions: Devices > Device Management > Modify Devices

Device Services

- POST copyconfigrequests

- DELETE devicerecords

- PUT devicerecords

- POST devicerecords

- GET devicerecords

- PUT fpphysicalinterfaces

- GET fpphysicalinterfaces

- DELETE fplogicalinterfaces

- PUT fplogicalinterfaces

- POST fplogicalinterfaces

- GET fplogicalinterfaces

- DELETE inlinesets

- PUT inlinesets

- POST inlinesets

- GET inlinesets

- GET staticroutes

- DELETE ipv4staticroutes

- PUT ipv4staticroutes

- POST ipv4staticroutes

- GET ipv4staticroutes

- DELETE ipv6staticroutes

- PUT ipv6staticroutes

- POST ipv6staticroutes

- GET ipv6staticroutes

- DELETE virtualswitches

- PUT virtualswitches

- POST virtualswitches

- GET virtualswitches

- PUT fpphysicalinterfaces

- GET fpphysicalinterfaces

- PUT physicalinterfaces

- GET physicalinterfaces

- GET bridgegroupinterfaces

- POST bridgegroupinterfaces

- PUT bridgegroupinterfaces

- DELETE bridgegroupinterfaces

- GET redundantinterfaces

- POST redundantinterfaces

- PUT redundantinterfaces

- DELETE redundantinterfaces

- GET etherchannelinterfaces

- POST etherchannelinterfaces

- PUT etherchannelinterfaces

- DELETE etherchannelinterfaces

- GET subinterfaces

- POST subinterfaces

- PUT subinterfaces

- DELETE subinterfaces

- GET fpinterfacestatistics

- POST interfaceevents

- GET interfaceevents

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}

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.

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

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.

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

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.

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.

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

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

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:

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

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

POST interfaceevents

Request Type: POST

Description: Creates netmod events on the specified device.

URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/interfaceevents

Permissions: Devices > Device Management > Modify Device

GET interfaceevents

Request Type: GET

Description: Retrieves list of all netmod events on the device.

URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{container_UUID}/interfaceevents

Permissions: Devices > Device Management

Intelligence Services

- POST collections

- POST discoveryinfo

- GET element

- DELETE incident

- PUT incident

- GET incident

- PUT indicator

- GET indicator

- PUT observable

- GET observable

- PUT settings

- GET settings

- DELETE source

- PUT source

- POST source

- GET source

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

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

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

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

Integration Services

- PUT cloudeventsconfigs

- GET cloudeventsconfigs

- DELETE externallookups

- PUT externallookups

- POST externallookups

- GET externallookups

- DELETE packetanalyzerdevices

- PUT packetanalyzerdevices

- POST packetanalyzerdevices

- GET packetanlyzerdevices

PUT cloudeventsconfigs

Request Type: PUT

Description: Modifies the cloud event configuration associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/integration/cloudeventsconfigs/{objectId}

Permissions: Object Manager > Modify Object Manager

GET cloudeventsconfigs

Request Type: GET

Description: Retrieves the cloud event configuration associated with the specified ID. If no ID is specified for a GET, retrieves a list of all cloud event configuration objects.

URL for listing: /api/fmc_config/v1/domain/{domainUUID}/integration/cloudeventsconfigs

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/integration/cloudeventsconfigs/{objectId}

Permissions: Object Manager

DELETE externallookups

DELETE externallookups

Description: Deletes the external lookup objects with the specified UUID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/integration/externallookups/{object_UUID}

Permissions: Object Manager>Modify Object Manager

PUT externallookups

Request Type: PUT

Description: Modifies externallookups objects.

URL: /api/fmc_config/v1/domain/{domain_UUID}/integration/externallookups/{object_UUID}

Permissions: Object Manager>Modify Object Manager

POST externallookups

POST externallookups

Description: Creates externallookups objects with the specified parameters.

URL: /api/fmc_config/v1/domain/{domain_UUID}/integration/externallookups

Permissions: Object Manager>Modify Object Manager

GET externallookups

GET externallookups

Retrieves the externallookups object associated with the specified ID. If no ID, retrieves list of all externallookups objects.

URL: /api/fmc_config/v1/domain/{domain_UUID}/integration/externallookups

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/integration/externallookups/{object_UUID}

Permissions: Object Manager>Modify Object Manager

Parameters available for filtering:

DELETE packetanalyzerdevices

Request Type: DELETE

Description: Deletes the packet analyzer object with the specified UUID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/integration/packetanalyzerdevices/{object_UUID}

Permissions: Object Manager>Modify Object Manager

PUT packetanalyzerdevices

Request Type: PUT

Description: Modifies the packet analyzer object with the specified UUID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/integration/packetanalyzerdevices/{object_UUID}

Permissions: Object Manager>Modify Object Manager

POST packetanalyzerdevices

Request Type: POST

Description: Creates PKI enrollments objectswith the specified parameters.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/packetanalyzerdevices

Permissions: Object Manager

GET packetanlyzerdevices

Request Type: GET

Description: Retrieves the packetanlayzerdevices object associated with the specified ID. If no ID, retrieves list of all packetanalyzerdevices objects.

URL: /api/fmc_config/v1/domain/{domain_UUID}/integration/packetanalyzerdevices

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/integration/packetanalyzerdevices/{object_UUID}

Permissions: Object Manager>Modify Object Manager

Parameters available for filtering:

Object Services

- GET anyprotocolportobjects

- GET applicationcategories

- GET applicationfilters

- GET applicationproductivities

- GET applicationrisks

- GET applications

- GET applicationtags

- GET applicationtypes

- GET certenrollments

- GET continents

- GET countries

- DELETE dnsservergroups

- PUT dnsservergroups

- POST dnsservergroups

- GET dnsservergroups

- GET endpointdevicetypes

- GET extendedaccesslist

- DELETE fqdns

- PUT fqdns

- POST fqdns

- GET fqdns

- GET geolocation

- DELETE hosts

- PUT hosts

- POST hosts

- GET hosts

- DELETE icmpv4objects

- PUT icmpv4objects

- POST icmpv4objects

- GET icmpv4objects

- DELETE icmpv6objects

- PUT icmpv6objects

- POST icmpv6objects

- GET icmpv6objects

- DELETE ikev1ipsecproposals

- PUT ikev1ipsecproposals

- POST ikev1ipsecproposals

- GET ikev1ipsecproposals

- DELETE ikev1policies

- PUT ikev1policies

- POST ikev1policies

- GET ikev1policies

- DELETE ikev2ipsecproposals

- PUT ikev2ipsecproposals

- POST ikev2ipsecproposals

- GET ikev2ipsecproposals

- DELETE ikev2policies

- PUT ikev2policies

- POST ikev2policies

- GET ikev2policies

- DELETE interfacegroups

- PUT interfacegroups

- POST interfacegroups

- GET interfacegroups

- GET interfaceobjects

- GET isesecuritygrouptags

- GET keychain

- DELETE keychain

- PUT keychain

- POST keychain

- GET networkaddresses

- DELETE networkgroups

- PUT networkgroups

- POST networkgroups

- GET networkgroups

- DELETE networks

- PUT networks

- POST networks

- GET networks

- DELETE portobjectgroups

- PUT portobjectgroups

- POST portobjectgroups

- GET portobjectgroups

- GET ports

- DELETE protocolportobjects

- PUT protocolportobjects

- POST protocolportobjects

- GET protocolportobjects

- DELETE ranges

- PUT ranges

- POST ranges

- GET ranges

- GET realms

- GET realmusergroups

- GET realmusers

- GET securitygrouptags

- DELETE securityzones

- PUT securityzones

- POST securityzones

- GET securityzones

- GET siurlfeeds

- GET siurllists

- DELETE slamonitors

- PUT slamonitors

- POST slamonitors

- GET slamonitors

- GET tunneltags

- GET urlcategories

- DELETE urlgroups

- PUT urlgroups

- POST urlgroups

- GET urlgroups

- DELETE urls

- PUT urls

- POST urls

- GET urls

- GET variablesets

- DELETE vlangrouptags

- PUT vlangrouptags

- POST vlangrouptags

- GET vlangrouptags

- DELETE vlantags

- PUT vlantags

- POST vlantags

- GET vlantags

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

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}

Permissions: Object Manager

GET certenrollments

Request Type: GET

Description: Retrieves the PKI enrollments object associated with the specified ID. If no ID is specified for a GET, retrieves list of all PKI enrollment objects.

URL: /api/fmc_config/v1/domain/{domain_UUID}/devicegroups/certenrollments

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/devicegroups/certenrollments/{parent_object_UUID}

Permissions: Devices > Device Management > View Devices

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

DELETE dnsservergroups

Request Type: DELETE

Description: Deletes a DNS server group with the specified object ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/dnsservergroups/{object_UUID}

Permissions: Devices > Device Management > Modify Devices

PUT dnsservergroups

Request Type: PUT

Description: Modifies a DNS server group with the specified object ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/dnsservergroups

Permissions: Devices > Device Management > Modify Devices

POST dnsservergroups

Request Type: POST

Description: Creates a DNS server group group with the specified object ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/dnsservergroups

Permissions: Devices > Device Management > Modify Devices

GET dnsservergroups

Request Type: GET

Description: Retrieves the DNS server group associated with the specified ID. If no ID is specified, retrieves list of all dns server groups.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/dnsservergroups

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

Permissions: Devices > Device Management > View Devices

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 extendedaccesslist

Request Type: GET

Description: Retrieves extended access list associated with the specified ID. If no ID is specified, retrieves list of all extended access lists.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/extendedaccesslist

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

Permissions: Devices > Device Management > View Devices

DELETE fqdns

Request Type: DELETE

Description: Deletes the FQDN object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/fqdns/{object_UUID}

URL to DELETE overrides on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/fqdns/{object_UUID}?overrideTargetId={target_UUID}

Permissions: Object Manager > Modify Object Manager

PUT fqdns

Request Type: PUT

Description: Modifies the FQDN object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/fqdns/{object_UUID}

URL to edit or update an override on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/fqdns/{parent_object_UUID}

Permissions: Object Manager > Modify Object Manager

POST fqdns

Request Type: POST

Description: Creates or overrides the FQDN objects with the specified parameters.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/fqdns

URL for Bulk Post: /api/fmc_config/v1/domain/{domain_UUID}/object/fqdns?bulk=true

Permissions: Object Manager > Modify Object Manager

GET fqdns

Request Type: GET

Description: Retrieves the FQDN object associated with the specified ID. If no ID is specified for a GET, retrieves list of all FQDN objects.

URL for listing: /api/fmc_config/v1/domain/{domain_UUID}/object/fqdns

URL for all the overrides on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/fqdns?overrideTargetId={target_UUID}

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

URL to list all overrides on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/fqdns/{fqdn_UUID}/overrides

URL for override for an object on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/fqdns/{object_UUID}?overrideTargetId={target_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}

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

URL to edit or update an override on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/hosts/{parent_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 all the overrides on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/hosts?overrideTargetId={target_UUID}

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

URL to list all overrides on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/hosts/{host_UUID}/overrides

URL for override for an object on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/hosts/{host_UUID}?overrideTargetId={target_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}

URL to DELETE overrides on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/icmpv4objects/{object_UUID}?overrideTargetId={target_UUID}

Permissions: Object Manager > Modify Object Manager

PUT icmpv4objects

Request Type: PUT

Description: Modifies ICMPv4 port objects.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/icmpv4objects/{object_UUID}

URL to edit or update an override on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/icmpv4objects/{parent_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

URL for Bulk Post : /api/fmc_config/v1/domain/{domain_UUID}/object/icmpv4objects?bulk=true

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 all the overrides on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/icmp4objects?overrideTargetId={target_UUID}

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

URL to list all overrides on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/icmp4objects/{icmpv4object_UUID}/overrides

URL for override for an object on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/icmp4objects/{icmp4object_UUID}?overrideTargetId={target_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}

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

URL to edit or update an override on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/icmpv6objects/{parent_object_UUID}

Permissions: Object Manager > Modify Object Manager

POST icmpv6objects

Request Type: POST

Description: Creates or overrides the ICMPv6 port objects with the specified parameters.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/icmpv6objects

URL for Bulk Post: /api/fmc_config/v1/domain/{domain_UUID}/object/icmpv6objects?bulk=true

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 all the overrides on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/icmp6objects?overrideTargetId={target_UUID}

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

URL for override for an object on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/icmp6objects/{icmp6object_UUID}?overrideTargetId={target_UUID}

Permissions: Object Manager

DELETE ikev1ipsecproposals

Request Type: DELETE

Description: Deletes the IKEv1 IPsec Proposal associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/ikev1ipsecproposals/{ikev1ipsecproposal_UUID}

Permissions: Object Manager > Modify Object Manager

PUT ikev1ipsecproposals

Request Type: PUT

Description: Modifies the IKEv1 IPsec Proposal associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/ikev1ipsecproposals/ {ikev1ipsecproposal_UUID}

Permissions: Object Manager > Modify Object Manager

POST ikev1ipsecproposals

Request Type: POST

Description: Creates the IKEv1 IPsec Proposal associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/ikev1ipsecproposals

Permissions: Object Manager > Modify Object Manager

GET ikev1ipsecproposals

Request Type: GET

Description: Retrieves the IKEv1 IPsec Proposal associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv1 IPsec Proposal objects.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ikev1ipsecproposals

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/ikev1ipsecproposals/{ ikev1ipsecproposal_UUID}

Permissions: Object Manager

DELETE ikev1policies

Request Type: DELETE

Description: Deletes the IKEv1 policy object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/ikev1policies/{ikev1policy_UUID}

Permissions: Object Manager > Modify Object Manager

PUT ikev1policies

Request Type: PUT

Description: Modifies the IKEv1 policy object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/ikev1policies/{ikev1policy_UUID}

Permissions: Object Manager > Modify Object Manager

POST ikev1policies

Request Type: POST

Description: Creates the IKEv1 policy object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/ikev1policies

Permissions: Object Manager > Modify Object Manager

GET ikev1policies

Request Type: GET

Description: Retrieves the IKEv1 policy object associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv1 policy objects.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ikev1policies

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/ikev1policies/{ikev1policy_UUID}

Permissions: Object Manager

DELETE ikev2ipsecproposals

Request Type: DELETE

Description: Deletes the IKEv2 IPsec Proposal associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/ikev2ipsecproposals/{ikev2ipsecproposal_UUID}

Permissions: Object Manager > Modify Object Manager

PUT ikev2ipsecproposals

Request Type: PUT

Description: Modifies the IKEv2 IPsec Proposal associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/ikev2ipsecproposals/{ikev2ipsecproposal_UUID}

Permissions: Object Manager > Modify Object Manager

POST ikev2ipsecproposals

Request Type: POST

Description: Creates the IKEv2 IPsec Proposal associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/ikev2ipsecproposals

Permissions: Object Manager > Modify Object Manager

GET ikev2ipsecproposals

Request Type: GET

Description: Retrieves the IKEv2 IPsec Proposal associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv2 IPSec Proposal objects.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ikev2ipsecproposals

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/ikev2ipsecproposals/{ikev2ipsecproposal_UUID}

Permissions: Object Manager

DELETE ikev2policies

Request Type: DELETE

Description: Deletes the IKEv2 object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/ikev2policies/{ikev2policy_UUID}

Permissions: Object Manager > Modify Object Manager

PUT ikev2policies

Request Type: PUT

Description: Modifies the IKEv2 object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/ikev2policies/{ikev2policy_UUID}

Permissions: Object Manager > Modify Object Manager

POST ikev2policies

Request Type: POST

Description: Creates the IKEv2 object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/ikev2policies

Permissions: Object Manager > Modify Object Manager

GET ikev2policies

Request Type: GET

Description: Retrieves the IKEv2 object associated with the specified ID. If no ID is specified for a GET, retrieves list of all IKEv2 IPSec Proposal objects.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ikev2policies

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/ikev2policies/{ikev2policy_UUID}

Permissions: Object Manager

DELETE interfacegroups

Request Type: DELETE

Description: Deletes the Interface group objects associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/interfacegroups/{object_UUID}

URL on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/interfacegroups/{object_UUID}?overrideTargetId={target_UUID}

Permissions: Object Manager > Modify Object Manager

PUT interfacegroups

Request Type: PUT

Description: Modifies the Interface group objects associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/interfacegroups/{object_UUID}

URL to edit or update an override on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/interfacegroups/{parent_object_UUID}

Permissions: Object Manager > Modify Object Manager

POST interfacegroups

Request Type: POST

Description: Creates or overrides the Interface group objects associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/interfacegroups

URL for Bulk Post: /api/fmc_config/v1/domain/{domain_UUID}/object/interfacegroups?bulk=true

Permissions: Object Manager > Modify Object Manager

GET interfacegroups

Request Type: GET

Description: Retrieves the Interface group objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all interface group objects.

URL for listing: /api/fmc_config/v1/domain/{domain_UUID}/object/interfacegroups

URL for all the overrides on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/interfacegroups?overrideTargetId={target_UUID}

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

URL to list all overrides on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/interfacegroups/{interfacegroups_UUID}/overrides

URL for override for an object on a particular domain or device: /api/fmc_config/v1/domain/{domainUUID}/object/interfacegroups/{interfacegroups_UUID}?overrideTargetId={target_UUID}

Permissions: Object Manager

GET interfaceobjects

Request Type: GET

Description: Retrieves list of all the interface objects both security zones and interface groups.

URL for listing: /api/fmc_config/v1/domain/{domain_UUID}/object/interfaceobjects

URL for all the overrides on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/interfaceobjects?overrideTargetId={target_UUID}

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

URL to list all overrides on a particular object:: /api/fmc_config/v1/domain/{domain_UUID}/object/interfaceobjects/{interfaceobjects_UUID}/overrides

URL for override for an object on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/interfaceobjects/{interfaceobjects_UUID}?overrideTargetId={target_UUID}

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 keychain

Request Type: GET

Description: Retrieves the keychain object associated with the specified ID. If no ID is specified for a GET, retrieves list of all keychain objects.

URL for listing: /api/fmc_config/v1/domain/{domain_UUID}/object/keychains

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/object/keychains/{keychain_UUID}

URL to list all overrides on a particular object. If the object ID is not specified, displays all keychain objects: /api/fmc_config/v1/domain/{domain_UUID}/object/keychains/{keychains_UUID}/overrides/{objectId}

URL for all the overrides on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/keychains?overrideTargetId={target_UUID}

URL for override for an object on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/keychains/{keychain_UUID}?overrideTargetId={target_UUID}

Note

The target UUID could be that of a domain or a device.

Permissions: Object Manager

DELETE keychain

Request Type: DELETE

Description: Deletes the keychain object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/keychains/{keychain_UUID}

URL to DELETE overrides on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/keychains/{keychain_UUID}?overrideTargetId={target_UUID}

Note

The target UUID could be that of a domain or a device.

Permissions: Object Manager > Modify Object Manager

PUT keychain

Request Type: PUT

Description: Modifies the keychain object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/keychains/{keychain_UUID}

URL to edit or update an override on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/keychains/{keychain_UUID}

Permissions: Object Manager > Modify Object Manager

POST keychain

Request Type: POST

Description: Creates or overrides the keychain objects with the specified parameters.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/keychains

URL for Bulk Post:

/api/fmc_config/v1/domain/{domain_UUID}/object/keychains?bulk=true

URL to create an override on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/keychains

Attention

If override was not set when creating the key chain object:

1. Using PUT, update the override property of the key chain object to "true".

2. Create the POST override for the key chain object.

Permissions: Object Manager > Modify 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

PUT networkgroups

Request Type: PUT

Description: Modifies a Network Group.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/networkgroups/{object_UUID}

URL to edit or update an override on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/networkgroups/{parent_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

URL for Bulk Post: /api/fmc_config/v1/domain/{domain_UUID}/object/networkgroups?bulk=true

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}

URL to list all overrides on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/networkgroups/{networkgroups_UUID}/overrides

URL for override for an object on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/networkgroups/{networkgroups _UUID}?overrideTargetId={target_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}

URL to edit or update an override on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/networks/{parent_object_UUID}

Permissions: Object Manager > Modify Object Manager

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 all the overrides on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/networks?overrideTargetId={target_UUID}

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

URL to list all overrides on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/networks/{network_UUID}/overrides

URL for override for an object on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/networks/{network_UUID}?overrideTargetId={target_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}

URL to edit or update an override on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/portobjectgroups/{parent_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

URL for Bulk Post: /api/fmc_config/v1/domain/{domain_UUID}/object/portobjectgroups?bulk=true

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 for listing: /api/fmc_config/v1/domain/{domain_UUID}/object/portobjectgroups

URL for all the overrides on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/portobjectgroups?overrideTargetId={target_UUID}

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

URL for override for an object on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/portobjectgroups/{portobjectgroup_UUID}?overrideTargetId={target_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}

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}

URL to edit or update an override on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/protocolportobjects/{parent_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

URL for Bulk Post : /api/fmc_config/v1/domain/{domain_UUID}/object/protocolportobjects?bulk=true

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 all the overrides on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/protocolportobjects?overrideTargetId={target_UUID}

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

URL to list all overrides on a particular object:: /api/fmc_config/v1/domain/{domain_UUID}/object/protocolportobjects/{protocolportobject_UUID}/overrides

URL for override for an object on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/protocolportobjects/{protocolportobject_UUID}?overrideTargetId={target_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}

URL to edit or update an override on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/ranges/{parent_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

URL for Bulk Post: /api/fmc_config/v1/domain/{domain_UUID}/object/ranges?bulk=true

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 for listing: /api/fmc_config/v1/domain/{domain_UUID}/object/ranges

URL for all the overrides on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/ranges?overrideTargetId={target_UUID}

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

URL to list all overrides on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/ranges/{range_UUID}/overrides

URL for override for an object on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/ranges/{range_UUID}?overrideTargetId={target_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.

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

URL for Bulk Post: /api/fmc_config/v1/domain/{domain_UUID}/object/securityzones?bulk=true

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

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

URL for Bulk Post: /api/fmc_config/v1/domain/{domain_UUID}/object/slamonitors?bulk=true

Permissions: Object Manager > Modify Object Manager

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.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/urlgroups/{object_UUID}

URL to edit or update an override on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/urlgroups/{parent_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

URL for Bulk Post : /api/fmc_config/v1/domain/{domain_UUID}/object/urlgroups?bulk=true

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 all the overrides on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/urlgroups?overrideTargetId={target_UUID}

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

URL to list all overrides on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/urlgroups/{urlgroup_UUID}/overrides

URL for override for an object on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/urlgroups/{urlgroup_UUID}?overrideTargetId={target_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}

URL to DELETE overrides on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/urls/{object_UUID}?overrideTargetId={target_UUID}

Permissions: Object Manager > Modify Object Manager

PUT urls

Request Type: PUT

Description: Modifies a URL.

URL: /api/fmc_config/v1/domain/{domain_UUID}/object/urls/{object_UUID}

URL to edit or update an override on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/urls/{parent_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

URL for Bulk Post : /api/fmc_config/v1/domain/{domain_UUID}/object/urls?bulk=true

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.

URL for listing: /api/fmc_config/v1/domain/{domain_UUID}/object/urls

URL for all the overrides on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/urls?overrideTargetId={target_UUID}

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

URL to list all overrides on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/urls/{url_UUID}/overrides

URL for override for an object on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/urls/{url_UUID}?overrideTargetId={target_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}

URL to edit or update an override on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/vlangrouptags/{parent_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

URL for Bulk Post : /api/fmc_config/v1/domain/{domain_UUID}/object/vlangrouptags?bulk=true

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 for listing: /api/fmc_config/v1/domain/{domain_UUID}/object/vlangrouptags

URL for all the overrides on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/vlangrouptags?overrideTargetId={target_UUID}

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

URL to list all overrides on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/vlangrouptags/{vlangrouptag_UUID}/overrides

URL for override for an object on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/vlangrouptags/{vlangrouptag_UUID}?overrideTargetId={target_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}

URL to edit or update an override on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/vlantags/{parent_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

URL for Bulk Post : /api/fmc_config/v1/domain/{domain_UUID}/object/vlantags?bulk=true

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 all the overrides on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/vlantags?overrideTargetId={target_UUID}

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

URL to list all overrides on a particular object: /api/fmc_config/v1/domain/{domain_UUID}/object/vlantags/{vlantag_UUID}/overrides

URL for override for an object on a particular domain or device: /api/fmc_config/v1/domain/{domain_UUID}/object/vlantags/{vlantag_UUID}?overrideTargetId={target_UUID}

Permissions: Object Manager

Policy Services

- DELETE accesspolicies

- PUT accesspolicies

- POST accesspolicies

- GET accesspolicies

- DELETE accessrules

- PUT accessrules

- POST accessrules

- GET accessrules

- PUT defaultactions

- GET defaultactions

- GET loggingsettings

- PUT loggingsettings

- GET filepolicies

- DELETE ftdnatpolicies

- PUT ftdnatpolicies

- POST ftdnatpolicies

- GET ftdnatpolicies

- DELETE ftds2svpns

- PUT ftds2svpns

- POST ftds2svpns

- GET ftds2svpns

- PUT advancedsettings

- GET advancedsettings

- DELETE endpoints

- PUT endpoints

- POST endpoints

- GET endpoints

- PUT ikesettings

- GET ikesettings

- PUT ipsecsettings

- GET ipsecsettings

- DELETE autonatrules

- PUT autonatrules

- POST autonatrules

- GET autonatrules

- DELETE manualnatrules

- PUT manualnatrules

- POST manualnatrules

- GET manualnatrules

- GET natrules

- GET intrusionpolicies

- GET prefilterpolicies

- DELETE hitcounts

- PUT hitcounts

- GET hitcounts

- GET snmpalerts

- GET syslogalerts

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}

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

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 loggingsettings

Request Type: GET

Description: Retrieves the logging setting 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/{domainUUID}/policy/accesspolicies/{containerUUID}/loggingsettings

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/loggingsettings/{object_UUID}

Permissions: Policies

PUT loggingsettings

Request Type: PUT

Description: Modifies the logging setting associated with the specified access control policy ID and default action ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/loggingsettings/{objectId}

Permissions: Policies>Access Control Policy>Modify 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

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 ftds2svpns

Request Type: DELETE

Description: Deletes the Firepower Threat Defense Site to Site VPN topology associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftds2svpns/{topology_UUID}

Permissions: Devices > VPN > Modify VPN

PUT ftds2svpns

Request Type: PUT

Description: Modifies a Firepower Threat Defense Site to Site VPN topology associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftds2svpns/{topology_UUID}

Permissions: Devices > VPN > Modify VPN

POST ftds2svpns

Request Type: POST

Description: Creates a Firepower Threat Defense Site to Site VPN topology with the specified parameters.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftds2svpns

Permissions: Devices > VPN > Modify VPN

GET ftds2svpns

Request Type: GET

Description: Retrieves the Firepower Threat Defense Site to Site VPN topology associated with the specified ID. If no ID is specified, retrieves a list of all Firepower Threat Defense Site to Site VPN topologies.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftds2svpns

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftds2svpns/{topology_UUID}

Permissions: Devices > VPN

PUT advancedsettings

Request Type: PUT

Description: Modifies advanced settings inside a VPN Site to Site Topology.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftds2svpns/{topology_UUID}/ advancedsettings/{advancedsetting_UUID}

Permissions: Devices > VPN > Modify VPN

GET advancedsettings

Request Type: GET

Description: Retrieves an advanced settings inside a VPN Site to Site Topology. If no ID is specified for a GET, retrieves list containing a single AdvancedSettings entry of the topology.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftds2svpns/{topology_UUID}/ advancedsettings

URL for GET by ID: /api/fmc_config/v1/domain/domain_UUID/policy/ftds2svpns/{topology_UUID}/ advancedsettings/{advancedSetting_UUID}

Permissions: Devices > VPN

DELETE endpoints

Request Type: DELETE

Description: Deletes all endpoints in a topology or a specific endpoint associated with the specified ID inside a VPN Site to Site Topology.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftds2svpns/{topology_UUID}/endpoints/{endpoint_UUID}

Permissions: Devices > VPN > Modify VPN

PUT endpoints

Request Type: PUT

Description: Modifies all endpoints in a topology or a specific endpoint associated with the specified ID inside a VPN Site to Site Topology.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftds2svpns/{topology_UUID}/endpoints/{endpoint_UUID}

Permissions: Devices > VPN > Modify VPN

POST endpoints

Request Type: POST

Description: Creates all endpoints in a topology or a specific endpoint associated with the specified ID inside a VPN Site to Site Topology.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftds2svpns/{topology_UUID}/endpoints

Permissions: Devices > VPN > Modify VPN

GET endpoints

Request Type: GET

Description: Retrieves all endpoints in a topology or a specific endpoint associated with the specified ID inside a VPN Site to Site Topology. If no ID is specified for a GET, retrieves list of all Endpoints of a topology.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftds2svpns/{topology_UUID}/endpoints

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftds2svpns/{topology_UUID}/endpoints/{endpoint_UUID}

Permissions: Devices > VPN

PUT ikesettings

Request Type: PUT

Description: Modifies the IKE Settings associated with the specified ID inside a VPN Site to Site Topology.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftds2svpns/{topology_UUID}/ ikesettings/{ikesetting_UUID}

Permissions: Devices > VPN > Modify VPN

GET ikesettings

Request Type: GET

Description: Retrieves the IKE Settings associated with the specified ID inside a VPN Site to Site Topology. If no ID is specified for a GET, retrieves IKE Settings of a topology.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftds2svpns/{topology_UUID}/ikesettings

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftds2svpns/{topology_UUID}/ikesettings/{ikesetting_UUID}

Permissions: Devices > VPN

PUT ipsecsettings

Request Type: PUT

Description: Modifies an IPsec Proposal settings inside a VPN Site to Site Topology.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftds2svpns/{topology_UUID}/ipsecsettings/{ipsecsetting_UUID}

Permissions: Devices > VPN > Modify VPN

GET ipsecsettings

Request Type: GET

Description: Retrieves an IPsec Proposal Settings inside a VPN Site To Site Topology. If no ID is specified for a GET, retrieves list containing a single IPsec Settings entry of the topology.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftds2svpns/{topology_UUID}/ipsecsettings

URL for GET by ID: /api/fmc_config/v1/domain/DomainUUID/policy/ftds2svpns/{topology_UUID }/ipsecsettings/{ipsecsetting_UUID}

Permissions: Devices > VPN

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

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

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 prefilterpolicies

Request Type: GET

Description: Retrieves the prefilter policy associated with the specified ID. If no ID is specified, retrieves a list of all prefilter policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{object_UUID}

Permissions: Policies > Access Control > Prefilter Policy

DELETE hitcounts

Request Type: DELETE

Description: Deletes the hit count information and resets the hit count to zero for an assigned policy or rule in a device, from the Firepower Management Center.

Note that the DELETE operation returns a 200 (OK) message upon successful completion of the operation.

URLs:

- /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/operational/hitcounts?filter="{filterString}"

- /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{containerUUID}/operational/hitcounts?filter="{filterString}"

Permisssions:

- Policies>Access Control Policy>Modify Access Control Policy

- Policies>Prefilter Policy>Modify Prefilter Policy

PUT hitcounts

Request Type: PUT

Description: Retrieves the latest hit count information for a device against an assigned policy, and stores it in the Firepower Management Center.

URLs:

- /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/operational/hitcounts?filter="{filterString}"

- /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{containerUUID}/operational/hitcounts?filter="{filterString}"

Permisssions:

- Policies>Access Control Policy>Modify Access Control Policy

- Policies>Prefilter Policy>Modify Prefilter Policy

GET hitcounts

Request Type: GET

Description: Retrieves the last collected hit count information for a device against an assigned policy or its rules, from the Firepower Management Center.

Note that during the GET operation, hit counts will be automatically pre-fetched from the device if it is the first retrieval being done against a specific device.

URLs:

- /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/operational/hitcounts?filter="{filterString}"

- /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{containerUUID}/operational/hitcounts?filter="{filterString}"

Permissions:

- Policies>Access Control Policy>Modify Access Control Policy

- Policies>Prefilter Policy>Modify Prefilter 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

Policy Assignment Services

- PUT policyassignments

- POST policyassignments

- GET policyassignments

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

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

System Information

- GET serverversion

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:

Update Packages

- DELETE upgradepackages

- GET upgradepackages

- GET listapplicabledevices

- POST upgradepackage

- GET upgradepackages: Monitor

DELETE upgradepackages

Request Type: DELETE

Description: Deletes a specific Firepower Threat Defense upgrade package from the managing Firepower Management Center.

URL: /api/fmc_platform/v1/updates/upgradepackages/{package_UUID}

GET upgradepackages

Request Type: GET

Description: Retrieves a list of locally available Firepower Threat Defense upgrade packages, including major upgrades, maintenances release upgrades, and hotfixes.

URL: /api/fmc_platform/v1/updates/upgradepackages

URL for GET by ID: /api/fmc_platform/v1/updates/upgradepackages/{package_UUID}

GET listapplicabledevices

Request Type: GET

Description: Lists registered device containers that support the specific upgrade package.

URL: /api/fmc_platform/v1/updates/upgradepackages/{container_UUID}/applicabledevices

POST upgradepackage

Request Type: POST

Description: Dependent on the parameters, this POST operation either pushes available software upgrade packages to applicable devices running Firepower Threat Defense or initiates the upgrade process for applicable devices running Firepower Threat Defense. This process is applicable for standalone, clustered, or high availability pairs with the following limitations:

- For all configurations, ensure that the current POST operation is completed successfully before proceeding to the next POST operation.

- Perform the POST operation on the primary node of a high availability pair. Do not perform the POST operation for more than one high availability pair at a time.

- Perform the POST operation on the

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.

URL:/api/fmc_platform/v1/updates/upgrades/

GET upgradepackages: Monitor

Request Type: GET

Description: Monitors the upgrade process once you have executed the POST upgrade task.

URL: /api/fmc_platform/v1/domain/{domain_UUID}/job/taskstatuses/{task_ID}

Full Cisco Trademarks with Software License

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.

All printed copies and duplicate soft copies of this document are considered uncontrolled. See the current online version for the latest version.

Cisco has more than 200 offices worldwide. Addresses and phone numbers are listed on the Cisco website at www.cisco.com/go/offices.

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://www.cisco.com/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. (1721R)

Insert concept topicref

Insert task topicref

Insert reference topicref

Insert concept topicref

Insert task topicref

Insert reference topicref

Insert concept topicref

Insert task topicref

Insert reference topicref