Objects in the REST API

Request Structure

Request Structure:

Requests are sent to the 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 management center
  • <https_port>
    is the port number used by the 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 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 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 200
    – "OK". Standard response for successful requests.
  • 201 201
    – "Created". Request completed; new resource created.
  • 202 202
    – "Accepted". Request accepted, but processing not complete.
  • 204 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 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. 

  • 401 Invalid Session
    – Invalid session.
  • 404 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 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 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 Writes
    – Parallel add/update/delete operations are blocked. Please retry the request.
  • 429 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:

Table 1. Object Properties

Property

Type

Description

messages

List of Dictionaries

List of error or warning messages

code

String

Error/Warning/Info code

details

String

Detailed message corresponding to Error/Warning/Info

CDO Permissions

CDO has six permission types: Read_Only, Edit_Only, Deploy_Only, Admin and Super_Admin, and VPN Sessions Manager. To perform requests, a REST API user must have the necessary permissions as described below:

  • Read_Only: GET requests

  • Edit_Only: PUT, POST, and DELETE requests except as below

  • Deploy_Only: Deployment APIs

  • Admin or Super_Admin: System Information APIs

  • VPN Sessions Manager: Not used for API requests

Rate Limiting

The management center REST API implements rate limiting to reduce network load.

The FMC REST API employs rate limiting to mitigate network congestion. The API is designed to accept up to 120 GET requests per minute from a single IP address.

The API will only allow a single non-GET (PUT, POST, or DELETE) request at a time on a device.

Additionally, it permits a maximum of 10 concurrent connections for each IP address. These parameters are fixed and cannot be modified.

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.

Field Renaming

The following fields have been renamed to remove biased terminology in the documentation. Note that the old fields are entirely replaced as of version 7.1 and no longer exist.

Table 2.

Name

URL

Previous Field Name

New Field Name
ftddevicecluster

/fmc_config/v1/domain/DomainUUID/deviceclusters/ftddevicecluster

masterDevice controlDevice
master_device_UUID control_device_UUID
slaveDevices dataDevices
slave1_device_UUID data1_device_UUID
slave2_device_UUID data2_device_UUID
slave3_device_UUID data3_device_UUID
Observable

/api/fmc_tid/v1/domain/{domainUUID}/tid/observable

 whitelist allowlist
Indicator

/api/fmc_tid/v1/domain/{domainUUID}/tid/indicator

 whitelist allowlist
Incident

/api/fmc_tid/v1/domain/{domainUUID}/tid/incident

 whitelist allowlist
Source

/api/fmc_tid/v1/domain/{domainUUID}/tid/source

 whitelist allowlist

Troubleshoot

POST device

Request Type: POST

Description: Triggers the troubleshoot for a TPK Chassis.

URL: /api/fmc_troubleshoot/v1/domain/{domainUUID}/troubleshoot/device

DELETE packettracerfiles

Request Type: DELETE

Description: Deletes PCAP files from management center. If no ID is specified, deletes all packet tracer files from the management center.

URL: /api/fmc_troubleshoot/v1/domain/{domainUUID}/packettracer/files/

URL for Delete by ID: /api/fmc_troubleshoot/v1/domain/{domainUUID}/packettracer/files/{pcapFileName}

Network Map

GET netmaphosts

Request Type: GET

Description: Retrieves a host associated with the ID in the Network Map. If no ID is specified, retrieves list of all hosts in the Network Map.

URL: /api/fmc_netmap/v1/domain/{domainUUID}/hosts/{objectId}

URL for GET by ID: /api/fmc_netmap/v1/domain/{domainUUID}/hosts/{objectId}/{object_UUID}

Parameters available for filtering: ipAddress

POST netmaphosts

Request Type: POST

Description: Creates a host in the Network Map.

URL: /api/fmc_netmap/v1/domain/{domainUUID}/hosts

DELETE netmaphosts

Request Type: DELETE

Description: Deletes the specified host in the Network Map. If no ID is specified, deletes the entire Network Map.

URL: /api/fmc_netmap/v1/domain/{domainUUID}/hosts/

URL to delete a specific host: /api/fmc_netmap/v1/domain/{domainUUID}/hosts/{objectId}

GET vulns

Request Type: GET

Description: Retrieves the vulnerability in the Network Map with the specified ID. If no ID is specified, retrieves list of all vulnerabilities in the Network Map.

URL: /api/fmc_netmap/v1/domain/{domainUUID}/vulns/

URL for GET by ID: /api/fmc_netmap/v1/domain/{domainUUID}/vulns/{objectId}/

Parameters available for filtering: ipAddress, source, port, protocol, id

POST vulns

Request Type: POST

Description: Creates a vulnerability in the Network Map.

URL: /api/fmc_netmap/v1/domain/{domainUUID}/vulns

DELETE vulns

Request Type: DELETE

Description: Deletes the the vulnerability in the Network Map with the specified ID. If no ID is specified, deletes all vulnerabilities in the Network Map.

URL: /api/fmc_netmap/v1/domain/{domainUUID}/vulns

URL for DELETE by ID: /api/fmc_netmap/v1/domain/{domainUUID}/vulns/{objectId}

Parameters available for filtering: ipAddress, source, port, protocol, id

source must be included for DELETE

Analysis

GET activesessions

Request Type: GET

Description: Retrieve active sessions.

URL: /api/fmc_config/v1/domain/{domainUUID}/analysis/activesessions

Parameters available for filtering: userid, loginTime, lastSeen, username, email, department, authenticationType, currentIP, user, realmiId, realmName, firstName, lastName, phone, discoveryApplication

DELETE activesessions

Request Type: GET

Description: Delete active sessions.

URL: /api/fmc_config/v1/domain/{domainUUID}/analysis/activesessions

Parameters available for filtering: ids of sessions to logout, separated by commas

GET analysisusers

Request Type: GET

Description: Retrieves users.

URL: /api/fmc_config/v1/domain/{domainUUID}/analysis/analysisusers

Parameters available for filtering: userid, user, lastSeen, realmiId, realmName, username, firstName, lastName, email, department, phone, discoveryApplication, activeSessioncount, availableForPolicy

DELETE analysisusers

Request Type: DELETE

Description: Deletes users.

URL: /api/fmc_config/v1/domain/{domainUUID}/analysis/analysisusers

POST logout

Request Type: POST

Description: Administratively logout active user session.

URL: /api/fmc_config/v1/domain/{domainUUID}/analysis/activesessions/logout

GET useractivity

Request Type: GET

Description: Retrieves user activities.

URL: /api/fmc_config/v1/domain/{domainUUID}/analysis/useractivity

Parameters available for filtering: eventId, time, event, username, realmName, discoveryApplication, authenticationType, ipAddress, startPort, endPort, description, vpnSessionType, vpngroupPolicy, vpnConnectionProfile, vpnClientPublicIP, vpnClientCountry, vpnClientOS, vpnClientApplication, vpnConnectionDuration, vpnbytesOut, vpnbytesIn, securityGroupTag, endpointProfile, endpointLocation, device

DELETE useractivity

Request Type: DELETE

Description: Deletes user activities.

URL: /api/fmc_config/v1/domain/{domainUUID}/analysis/useractivity

Audit Services

GET auditrecords

Request Type: GET

Description: Retrieves audit records.

URL: /api/fmc_config/v1/domain/{domain_UUID}/audit/auditrecords

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/audit/auditrecords/{objectID}

Parameters available for filtering: username, subsystem, source, starttime, endtime

Deployment Services

GET deployabledevices

Request Type: GET

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

URL: /api/cdo_config/v1/domain/{domain_UUID}/deployment/deployabledevices

Parameters available for filtering: name

POST deploymentrequests

Request Type: POST

Description: Creates a request for deploying configuration changes to the specified device.

URL: /api/cdo_config/v1/domain/{domain_UUID}/deployment/deploymentrequests/{object_UUID}

GET deployments

Request Type: GET

Description: Retrieves deployment details for device.

URL: /api/cdo_config/v1/domain/{domainUUID}/deployment/deployabledevices/{containerUUID}/deployments

Parameters available for filtering: startTime, endTime

GET downloadreports

Request Type: GET

Description: Retrieves the report for download.

URL: /api/cdo_config/v1/domain/{domainUUID}/deployment/jobhistories/{containerUUID}/operational/downloadreports

POST emailreports

Request Type: POST

Description: Emails the deployment report.

URL: /api/cdo_config/v1/domain/{domainUUID}/deployment/jobhistories/{containerUUID}/operational/emailreports

GET jobhistories

Request Type: GET

Description: Retrieves the specified deployment job. If no ID is provided, retrieves all the deployment jobs.

URL: /api/cdo_config/v1/domain/{domainUUID}/deployment/jobhistories

URL for GET by ID: /api/cdo_config/v1/domain/{domainUUID}/deployment/jobhistories/{objectId}

Parameters available for filtering: Various filter criteria can be specified using the format deviceUUID:{uuid};startTime:start_time_in_secs;endTime:end_time_in_secs;rollbackApplicable:true_or_false

PUT jobhistories

Request Type: PUT

Description: Modifies the the deployment job with the specified ID.

URL: /api/cdo_config/v1/domain/{domainUUID}/deployment/jobhistories/{objectId}

GET pendingchanges

Request Type: POST

Description: Retrieves all the policy and object changes for the selected device.

URL: /api/cdo_config/v1/domain/{domainUUID}/deployment/deployabledevices/{containerUUID}/pendingchanges

POST rollbackrequests

Request Type: POST

Description: Creates a request for rollback configuration to devices.

URL: /api/cdo_config/v1/domain/{domainUUID}/deployment/rollbackrequest

Device Group Services

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}

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}

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

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}

Device Clusters

GET ftddevicecluster

Request Type: GET

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

The following fields have been replaced as of 7.1.0:

Previous Field Name New Field Name
masterDevice controlDevice
master_device_UUID control_device_UUID
slaveDevices dataDevices
slave1_device_UUID data1_device_UUID
slave2_device_UUID data2_device_UUID
slave3_device_UUID data3_device_UUID

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

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

PUT ftddevicecluster

Request Type: PUT

Description: Modifies the threat defense Cluster record associated with the specified ID.

The following fields have been replaced as of 7.1.0:

Previous Field Name New Field Name
masterDevice controlDevice
master_device_UUID control_device_UUID
slaveDevices dataDevices
slave1_device_UUID data1_device_UUID
slave2_device_UUID data2_device_UUID
slave3_device_UUID data3_device_UUID

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

POST ftddevicecluster

Request Type: POST

Description: Creates an threat defense Cluster record.

The following fields have been replaced as of 7.1.0:

Previous Field Name New Field Name
masterDevice controlDevice
master_device_UUID control_device_UUID
slaveDevices dataDevices
slave1_device_UUID data1_device_UUID
slave2_device_UUID data2_device_UUID
slave3_device_UUID data3_device_UUID

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

DELETE ftddevicecluster

Request Type: DELETE

Description: Deletes the threat defense Cluster record associated with the specified ID.

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

POST ftdclusterreadinesscheck

Request Type: POST

Description: Represents Cluster compatibility status for control(Readiness to become control) and data devices(compatible with control). This Readiness check is for platforms that support cluster bootstrap from management center (for e.g.4200).

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

Parameters available for filtering: skipControlReadiness: This is a query parameter, if given as true (skipControlReadiness=true) skips control readiness check and performs data devices compatibility with control.

POST ftdclusterdevicecommands

Request Type: POST

Description: Executes given command on the threat defense Cluster.

URL: /api/fmc_config/v1/domain/{domainUUID}/deviceclusters/{containerUUID}/operational/ftdclusterdevicecommands

Filters available for use: Filter are operation and deviceUUID. Value of filter is of format:
deviceUUID:device
          uuid;operation:{enable|disable|control}
. deviceUUID is UUID of device and is a mandatory field. operation is the command that needs to be executed on device and is a mandatory field.

GET clusterhealthmonitorsettings

Request Type: GET

Description: Retrieves the health check monitor settings of the Firewall Threat Defense Cluster.

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/deviceclusters/ftddevicecluster/{containerUUID}/clusterhealthmonitorsettings/{clusterUuid}/{object_UUID}

PUT clusterhealthmonitorsettings

Request Type: PUT

Description: Modifies the health check monitor settings of the Firewall Threat Defense Cluster.

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

Device HA Pair Services

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}

PUT ftddevicehapair

Request Type: PUT

Description: Sets any one of the following actions for the 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}

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

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}


Note

Run the configure high-availability disable command to remove the failover configurations from threat defense devices.

GET failoverinterfacemacaddressconfigs

Request Type: GET

Description: Retrieves the threat defense high availability failover policy interface MAC addresses record associated with the specified threat defense HA pair. If no ID is specified for a GET, it retrieves the list of all 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}

PUT failoverinterfacemacaddressconfigs

Request Type: PUT

Description: Modifies the threat defense high availability failover policy interface MAC addresses record associated with the specified threat defense high availability pair.

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

POST failoverinterfacemacaddressconfigs

Request Type: POST

Description: Creates the threat defense high availability failover policy interface MAC addresses record associated with the specified threat defense high availability pair.

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

DELETE failoverinterfacemacaddressconfigs

Request Type: DELETE

Description: Deletes the threat defense high availability failover policy interface MAC addresses record associated with the specified threat defense high availability pair.

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

GET monitoredinterfaces

Request Type: GET

Description: Retrieves the threat defense high availability Monitored interface policy record associated with the specified threat defense HA pair. If no ID is specified for a GET, it retrieves the list of all 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}

PUT monitoredinterfaces

Request Type: PUT

Description: Modifies the threat defense high availability Monitored interface policy record associated with the specified threat defense high availability pair.

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

Device Services

GET bfdpolicies

Request Type: GET

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

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/bfdpolicies

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/bfdpolicies/{object_UUID}

PUT bfdpolicies

Request Type: PUT

Description: Modifies the BFD Hops associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/bfdpolicies/{objectId}

POST bfdpolicies

Request Type: POST

Description: Creates BFD Hops.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/bfdpolicies

DELETE bfdpolicies

Request Type: DELETE

Description: Deletes the BFD Hops associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/bfdpolicies/{objectId}

GET bgp routing

Request Type: GET

Description: Retrieves list of all BGP (ipv4 and ipv6) associated with the specified device for specified vrf. If no device is specified, retrieves list of all BGP.

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

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/bgp/{objectId}

PUT bgp

Request Type: PUT

Description: Modifies BGP (ipv4 and ipv6) associated with the specified device for specified vrf.

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

POST bgp

Request Type: POST

Description: Creates BGP (ipv4 and ipv6) associated with the specified device for specified vrf.

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

DELETE bgp

Request Type: DELETE

Description: Deletes the specified bgp object.

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

GET bgp general settings

Request Type: GET

Description: Retrieves BGP general settings associated with the specified device. If no device is specified, retrieves list of all BGP general settings.

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

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/bgpgeneralsettings/{objectId}

PUT bgpgeneralsettings

Request Type: PUT

Description: Modifies the specified BGP general settings.

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

POST bgpgeneralsettings

Request Type: POST

Description: Creates BGP general settings.

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

DELETE bgpgeneralsettings

Request Type: DELETE

Description: Deletes the BGP general settings.

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

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}

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

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

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

POST changemanagers

Request Type: POST

Description: API to support migrating configuration management of FTD from FMC to CDO.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/operational/changemanagers

GET commands

Request Type: GET

Description: Retrieves the output for supported show commands on the device. Executes the command in the payload and retrieves the output of that command. If there is no command in the payload, returns an HTTP 500 error.

When specifying a command to execute, the payload must contain the command in the following format:

show {command}

This can include additional optional parameters. The parameters are separated by spaces after the first one:

show {command}&parameter={parameter1} {parameter2} {parameter3}...

The below table lists the commands which can be used with the commands service.

Command
show aaa-server
show aaa-server&parameter={parameters}
show access-list&parameter={parameters}
show banner
show crypto
show crypto&parameter={parameters}
show dhcpd state
show failover
show failover&parameter={parameters}
show firewall
show ip
show ip&parameter={parameters}
show logging
show logging&parameter={parameters}
show network
show ntp
show route
show route&parameter={parameters}
show rule&parameter={parameters}
show snmp-server&parameter={parameters}
show snort3 status
show ssl
show ssl&parameter={parameters}
show version
show version&parameter={parameters}
show von-sessiondb
show vpn-sessiondb&parameter={parameters}

The commands service will only work on devices running version 6.6 or greater. It only allows ten concurrent requests in total, and only one per device.

Pagination is not supported. If there is any output beyond the first page it will be truncated. As such, do not attempt any command which will yield more output than one page.

Some specific commands should not be used, specifically show running-config all, show running-config access-list and similar commands, as they may not work as desired or may impact performance.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/operational/commands

POST copyconfigrequests

Request Type: POST

Description: Copies device configuration to the specified threat defense device.

URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/copyconfigrequests

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}

Parameters available for filtering: hostName

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}

GET devicesettings

Request Type: GET

Description: Retrieves the Device Settings.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicesettings/{containerUUID}

PUT devicesettings

Request Type: PUT

Description: Modifies the Device Settings.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicesettings/{containerUUID}

GET ddnssettings

Request Type: GET

Description: Retrieves the DDNS policy associated with the specified container and device ID. If no ID is specified, retrieves list of all DDNS policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/dhcp/ddnssettings

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/dhcp/ddnssettings/{object_UUID}

PUT ddnssettings

Request Type: PUT

Description: Modifies the DDNS policy associated with the specified container and device ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/dhcp/ddnssettings/{objectId}

GET dhcprelaysettings

Request Type: GET

Description: Retrieves the Device DHCP Relay associated with the specified container and device Id. If no device ID is specified, retrieves list of all DHCP Relays.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/dhcp/dhcprelaysettings

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/dhcp/dhcprelaysettings/{object_UUID}

PUT dhcprelaysettings

Request Type: PUT

Description: Modifies the Device DHCP Relay associated with the specified container and device ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/dhcp/dhcprelaysettings/{objectId}

GET dhcpserver

Request Type: GET

Description: Retrieves the DHCP Server policy associated with the specified container and device ID. If no device ID is specified, retrieves list of all DHCP Server policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/dhcp/dhcpserver

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/dhcp/dhcpserver/{object_UUID}

PUT dhcpserver

Request Type: PUT

Description: Modifies the DHCP Server policy associated with the specified container and device ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/dhcp/dhcpserver/{objectId}

GET ecmpzones

Request Type: GET

Description: Retrieves the ECMP Zone associated with the specified ID. If no ID is specified, retrieves list of all ECMP Zones.

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

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ecmpzones/{objectId}

PUT ecmpzones

Request Type: PUT

Description: Modifies the ECMP Zone associated with the specified ID.

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

POST ecmpzones

Request Type: POST

Description: Creates an ECMP Zone.

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

DELETE ecmpzones

Request Type: DELETE

Description: Deletes the ECMP Zone associated with the specified ID.

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

GET eigrproutes

Request Type: GET

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

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/eigrproutes/{objectId}

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/eigrproutes/{objectId}/{object_UUID}

PUT eigrproutes

Request Type: PUT

Description: Modifies the EIGRP associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/eigrproutes/{objectId}

POST eigrproutes

Request Type: POST

Description: Creates an EIGRP.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/eigrproutes

DELETE eigrproutes

Request Type: DELETE

Description: Deletes the specified EIGRP.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/eigrproutes/{objectId}

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}

Parameters available for filtering:

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/

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

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

POST exports

Request Type: POST

Description: Package and export device configuration of specified threat defenses

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/operational/exports

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

Parameters available for filtering: name

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}

Parameters available for filtering: name

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}

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

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}

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}

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}

GET ftdallinterfaces

Request Type: GET

Description: Retrieves all types of interfaces.

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

Parameters available for filtering: filter: This is a query parameter to fetch specific type of interfaces. Supported Filter Criteria are : cclEligibleInterface:{boolean};interfaceMode:{mode};virtualRouterId:{uuid};named:{boolean}; cclEligibleInterface : Filter to get ccl eligible interface, filter value should always be true. interfaceMode : Filter using interface mode.Supported only for routed device. Allowed value is ROUTED Cannot be used with cclEligibleInterface filter. virtualRouterId : Supported only for routed device. Cannot be used with cclEligibleInterface filter. named : Supported only for routed device. Cannot be used with cclEligibleInterface filter.

POST imports

Request Type: POST

Description: Import device configuration from specified source for threat defenses.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/operational/imports

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}

Parameters available for filtering: name

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}

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

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}

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

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

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}

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}

POST ipv4staticroutes

Request Type: POST

Description: Creates an IPv4 Static Route.

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

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}

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}

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}

POST ipv6staticroutes

Request Type: POST

Description: Creates an IPv6 Static Route.

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

DELETE ipv6staticroutes

Request Type: DELETE

Description: Deletes the IPv6 Static Route associated with the specified ID.

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

GET loopbackinterfaces

Request Type: GET

Description: Retrieves the loopback interface associated with the specified NGFW device ID and/or interface ID. If no ID is specified, retrieves list of all loopback interfaces.

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

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/loopbackinterfaces/{object_UUID}

PUT loopbackinterfaces

Request Type: PUT

Description: Modifies the loopback interface associated with the specified NGFW device ID and/or interface ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/loopbackinterfaces/{objectId}

POST loopbackinterfaces

Request Type: POST

Description: Creates a loopback interface.

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

DELETE loopbackinterfaces

Request Type: DELETE

Description: Deletes the loopback interface associated with the specified NGFW device ID and/or interface ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/loopbackinterfaces/{objectId}

GET managementconvergencemode

Request Type: GET

Description: Retrieves the convergence state of the device

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

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/managementconvergencemode/{object_UUID}

POST managementconvergencemode

Request Type: POST

Description: Sets the convergence state of the device.

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

GET Metrics

Request Type: GET

Description: Retrieves HealthMonitor metrics for the device.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/operational/metrics

Parameters available for filtering: metric

POST modelmigrations

Request Type: POST

Description: Creates a modelmigrations object.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/operational/modelmigrations

GET ospf interface

Request Type: GET

Description: Retrieves the OSPF interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all OSPF interfaces associated with the specified NGFW device ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ospfinterface

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ospfinterface/{objectId}

GET ospfv2routes

Request Type: GET

Description: Retrieves OSPF V2 routes associated with the specified ID. If no ID is specified, retrieves list of all OSPF v2 routes.

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

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ospfv2routes/{objectId}

GET ospfv3interfaces

Request Type: GET

Description: Retrieves OSPF v3 interface associated with the specified ID. If no ID is specified, retrieves a lit of all OSPF v3 interfaces.

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

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ospfv3interfaces/{objectId}

GET ospfv3routes

Request Type: GET

Description: Retrieves the OSPfv3 process associated with the specified ID. If no ID is specified, retrieves list of all OSPFv3 processes.

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

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ospfv3routes/{objectID}

POST packettracer

Request Type: POST

Description: Retrieves the Packet Tracer command output for a threat defense or Cluster.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/operational/packettracer

POST packettracerpcap

Request Type: POST

Description: Retrieves the Packet Tracer using a PCAP file command output for a device.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/operational/packettracerpcap

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}

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

GET policybasedroutes

Request Type: GET

Description: Retrieves the specified Policy Based Route. If no ID is specified, retrieves a list of all Policy Based Routes.

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

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/policybasedroutes/{objectId}

PUT policybasedroutes

Request Type: PUT

Description: Modifies the Policy Based Route.

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

POST policybasedroutes

Request Type: POST

Description: Creates the Policy Based Route.

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

DELETE policybasedroutes

Request Type: DELETE

Description: Deletes the Policy Based Route.

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

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}

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

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

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

GET staticroutes

Request Type: GET

Description: Retrieves the static route associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all static routes associated with the specified NGFW device ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/staticroute

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/staticroutes/{objectId}

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}

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/

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

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

GET Virtual BFD Policies

Request Type: GET

Description: Retrieves the BFD Policy associated with the specified ID. If no ID is specified for a GET, retrieves list of all BFD Policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/bfdpolicies/

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/bfdpolicies/{objectId}

PUT Virtual BFD Policies

Request Type: PUT

Description: Modifies the BFD policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/bfdpolicies/{objectId}

POST Virtual BFD Policies

Request Type: POST

Description: Creates a a BFD Policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/bfdpolicies

DELETE Virtual BFD Policies

Request Type: DELETE

Description: Deletes the BFD Policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/bfdpolicies/{objectId}

GET virtual BGP

Request Type: GET

Description: Retrieves specified BGP (ipv4 and ipv6) on the specified virtual router. If no ID is specified, retrieves list of all BGP on the virtual router.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ipv6staticroutes

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ipv6staticroutes/{objectId}

PUT virtual bgp

Request Type: PUT

Description: Modifies BGP (ipv4 and ipv6) associated with the specified device for specified vrf.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/bgp/{objectId}

POST virtual bgp

Request Type: POST

Description: Creates BGP (ipv4 and ipv6) associated with the specified device for specified vrf.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/bgp

DELETE virtual bgp

Request Type: DELETE

Description: Deletes BGP (ipv4 and ipv6) associated with the specified device for specified vrf.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/bgp/{objectId}

GET virtual ecmpzones

Request Type: GET

Description: Retrieves the ECMP Zone for the specified virtual router associated with the specified ID. If no ID is specified, retrieves list of all ECMP Zones.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ecmpzones

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ecmpzones/{objectId}

PUT virtual ecmpzones

Request Type: PUT

Description: Modifies the ECMP Zone for the specified virtual router associated with the specified ID.

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

POST virtual ecmpzones

Request Type: POST

Description: Creates an ECMP Zone for the specified virtual router.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ecmpzones/

DELETE virtual ecmpzones

Request Type: DELETE

Description: Deletes the ECMP Zone for the specified virtual router associated with the specified ID.

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

GET virtual ipv4staticroutes

Request Type: GET

Description: Retrieves specified IPv4 static route on the specified virtual router. If no ID is specified, retrieves list of all IPv4 static routes on the virtual router.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ipv4staticroutes

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ipv4staticroutes/{objectId}


Note

The methods and payload are same as for static route endpoints. If there is a route leak, a warning is returned with response code 400. However, if you make the REST call with query parameter ignoreWarning=true, the warning is ignored. This behavior is applicable with Global VRF static route as well.

PUT virtual ipv4 static routes

Request Type: PUT

Description: Modifies an IPv4 static route on the specified device.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ipv4staticroutes/{objectId}


Note

The methods and payload are same as for static route endpoints. If there is a route leak, a warning is returned with response code 400. However, if you make the REST call with query parameter ignoreWarning=true, the warning is ignored. This behavior is applicable with Global VRF static route as well.

POST virtual ipv4 static routes

Request Type: POST

Description: Creates IPv4 static routes associated with the specified virtual router.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ipv4staticroutes


Note

For static routes (IPv4), the methods and payload are same as for static route endpoints. If there is a route leak, a warning is returned with response code 400. However, if you make the REST call with query parameter ignoreWarning=true, the warning is ignored. This behavior is applicable with Global VRF static route as well.

DELETE virtual ipv4 static routes

Request Type: DELETE

Description: Deletes the specified IPv4 static route.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ipv4staticroutes/{objectId}


Note

The methods and payload are same as for static route endpoints. If there is a route leak, a warning is returned with response code 400. However, if you make the REST call with query parameter ignoreWarning=true, the warning is ignored. This behavior is applicable with Global VRF static route as well.

GET virtual ipv6staticroutes

Request Type: GET

Description: Retrieves specified IPv6 static route on the specified virtual router. If no ID is specified, retrieves list of all IPv6 static routes on the virtual router.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ipv6staticroutes

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ipv6staticroutes/{objectId}


Note

The methods and payload are same as for static route endpoints. If there is a route leak, a warning is returned with response code 400. However, if you make the REST call with query parameter ignoreWarning=true, the warning is ignored. This behavior is applicable with Global VRF static route as well.

PUT virtual ipv6 static routes

Request Type: PUT

Description: Modifies a bridge group interface on the specified device.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ipv6staticroutes/{objectId}


Note

The methods and payload are same as for static route endpoints. If there is a route leak, a warning is returned with response code 400. However, if you make the REST call with query parameter ignoreWarning=true, the warning is ignored. This behavior is applicable with Global VRF static route as well.

POST virtual ipv6 static routes

Request Type: POST

Description: Creates IPv6 static routes associated with the specified virtual router.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ipv6staticroutes


Note

The methods and payload are same as for static route endpoints. If there is a route leak, a warning is returned with response code 400. However, if you make the REST call with query parameter ignoreWarning=true, the warning is ignored. This behavior is applicable with Global VRF static route as well.

DELETE virtual ipv6 static routes

Request Type: DELETE

Description: Deletes the specified IPv6 static route.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ipv6staticroutes/{objectId}


Note

The methods and payload are same as for static route endpoints. If there is a route leak, a warning is returned with response code 400. However, if you make the REST call with query parameter ignoreWarning=true, the warning is ignored. This behavior is applicable with Global VRF static route as well.

GET virtual ospf interface

Request Type: GET

Description: Retrieves specified OSPF interface associated with the specified virtual router. If no ID is specified, retrieves list of all OSPF interfaces associated with the specified virtual router.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ospfinterface

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ospfinterface/{objectId}

GET virtual ospfv2 routes

Request Type: GET

Description: Retrieves specified OSPFV2 process associated with the specified virtual router. If no ID is specified, retrieves list of all OSPF v2 process associated with the specified virtual router.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ospfv2routes

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ospfv2routes/{objectId}

GET virtualpolicybasedroutes

Request Type: GET

Description: Retrieves the specified Policy Based Route associated for the specified virtual router. If no ID is specified, retrieves a list of all Policy Based Routes.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/policybasedroutes

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/policybasedroutes/{objectId}

PUT virtualpolicybasedroutes

Request Type: PUT

Description: Modifies the Policy Based Route associated for the specified virtual router.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/policybasedroutes/{objectId}

POST virtualpolicybasedroutes

Request Type: POST

Description: Creates the Policy Based Route associated for the specified virtual router.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/policybasedroutes

DELETE virtualpolicybasedroutes

Request Type: DELETE

Description: Deletes the Policy Based Route associated for the specified virtual router.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/policybasedroutes/{objectId}

GET virtualrouters

Request Type: GET

Description: Retrieves the the virtual router with the specified ID. If no ID is specified, retrieves list of all virtual routers.

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

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{objectId}

PUT virtual routers

Request Type: PUT

Description: Modifies a virtual router on the specified device.

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

POST virtual routers

Request Type: POST

Description: Creates virtual routers associated with the specified container.

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

DELETE virtual routers

Request Type: DELETE

Description: Deletes the specified virtual router.

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

GET virtual static routes

Request Type: GET

Description: Retrieves specified static routes (ipv4 and ipv6) associated with the specified virtual router. If no ID is specified, retrieves list of all Static routes (ipv4 and ipv6) associated with the specified virtual router.

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

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/staticroutes/{objectId}

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}

Parameters available for filtering: name

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}

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

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}

GET Virtual Tunnel Interfaces

Request Type: GET

Description: Retrieves the virtual tunnel interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all virtual tunnel interfaces associated with the specified NGFW device ID.

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

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/virtualtunnelinterfaces/{objectId}

Parameters available for filtering: none

PUT Virtual Tunnel Interfaces

Request Type: PUT

Description: modifies the virtual tunnel interface associated with the specified NGFW device ID and/or interface ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/virtualtunnelinterfaces/{objectId}

POST Virtual Tunnel Interfaces

Request Type: POST

Description: Creates a virtual tunnel interface on the NGFW device.

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

DELETE Virtual Tunnel Interfaces

Request Type: DELETE

Description: Deletes the virtual tunnel interface associated with the specified NGFW device ID and interface ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/virtualtunnelinterfaces/{objectId}

GET vlaninterfaces

Request Type: GET

Description: Retrieves the vlan interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves list of all vlan interfaces associated with the specified NGFW device ID.

This method is only available on a Firepower 1010 device.

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

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

Parameters available for filtering: name

PUT vlaninterfaces

Request Type: PUT

Description: Modifies the vlan interface associated with the specified NGFW device ID and interface ID.

This method is only available on a Firepower 1010 device.

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

POST vlaninterfaces

Request Type: POST

Description: Creates a vlan interface on the NGFW device.

This method is only available on a Firepower 1010 device.

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

DELETE vlaninterfaces

Request Type: DELETE

Description: Deletes the vlan interface associated with the specified NGFW device ID and interface ID.

This method is only available on a Firepower 1010 device.

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

GET vniinterfaces

Request Type: GET

Description: Retrieves the VNI interface associated with the specified NGFW device ID and interface ID. If no interface ID is specified, retrieves a list of all VNI interfaces on the NGFW device.

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

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/vniinterfaces/{objectId}

PUT vniinterfaces

Request Type: PUT

Description: Modifies the VNI interface associated with the specified NGFW device ID and interface ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/vniinterfaces/{objectId}

POST vniinterfaces

Request Type: POST

Description: Creates a VNI interface on the specified NGFW device.

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

DELETE vniinterfaces

Request Type: DELETE

Description: Retrieves the VNI interface associated with the specified NGFW device ID and interface ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/vniinterfaces/{objectId}

GET vteppolicies

Request Type: GET

Description: Retrieves the VTEP Policy associated with the specified NGFW device ID and policy ID. If no ID is specified, retrieves list of all VTEP Policies associated with the specified NGFW device ID.

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

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/vteppolicies/{objectId}

PUT vteppolicies

Request Type: PUT

Description: Modifies the VTEP Policy associated with the specified NGFW device ID and policy ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/vteppolicies/{objectId}

POST vteppolicies

Request Type: POST

Description: Creates a VTEP Policy on the specified NGFW device I.

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

DELETE vteppolicies

Request Type: DELETE

Description: Deletes the VTEP Policy associated with the specified NGFW device ID and policy ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/vteppolicies/{objectId}

Health Services

GET csdac

Request Type: GET

Description: Retrieves the Cisco Secure Dynamic Attributes Connector status for the device.

URL: /api/fmc_config/v1/domain/{domainUUID}/health/csdac

POST csdac

Request Type: POST

Description: Updates the Cisco Secure Dynamic Attributes Connector status for the device.

URL: /api/fmc_config/v1/domain/{domainUUID}/health/csdac

GET Health Alerts

Request Type: GET

Description: Retrieves health alerts.

URL: /api/fmc_config/v1/domain/{domainUUID}/health/alerts

Parameters available for filtering: startTime, endTime, deviceUUIDs, status, moduleIDs

GET Health Metrics

Request Type: GET

Description: Retrieves health monitor metrics for the device.

URL: /api/fmc_config/v1/domain/{domainUUID}/health/metrics

Parameters available for filtering: deviceUUIDs, metric, startTime, endTime, step, regexFilter, queryFunction

GET ravpngateways

Request Type: GET

Description: Retrieves the RA VPN Gateway Details. This includes RA VPN Certificate expiry dates, maximum sessions supported.

URL: /api/fmc_config/v1/domain/{domainUUID}/health/ravpngateways

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/health/ravpngateways/{object_UUID}

POST terminateravpnsessions

Request Type: POST

Description: Terminates Remote Access VPN Sessions.

URL: /api/fmc_config/v1/domain/{domainUUID}/health/ravpnsessions/operational/terminateravpnsessions

GET tunneldetails

Request Type: GET

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

URL: /api/fmc_config/v1/domain/{domainUUID}/health/tunnelstatuses/{containerUUID}/tunneldetails

GET tunnelstatuses

Request Type: GET

Description: Retrieves tunnel status for S2S VPN on all managed threat defenses.

URL: /api/fmc_config/v1/domain/{domainUUID}/health/tunnelstatuses

Parameters available for filtering: vpnTopologyId:{uuid} which filters the tunnel statuses by S2S VPN Topology id, deviceId:{UUID} which filters the tunnel statuses by Device id, status:{TUNNEL_UP|TUNNEL_DOWN|UNKNOWN} which filters the tunnel statuses by Tunnel Status and sortBy{:|<|>}{Topology|Device|Status|LastChange}. Filter operators : and < sorts in ascending order and > sorts in descending order.

GET tunnelsummaries

Request Type: GET

Description: Retrieves aggregated summary of tunnel status for S2S VPN on all managed threat defenses.

URL: /api/fmc_config/v1/domain/{domainUUID}/health/tunnelsummaries

Parameters available for filtering:vpnTopologyId:{uuid} which filters the tunnel summary by S2S VPN Topology id, deviceId:{UUID} which filters the tunnel summary by Device id and groupBy groupBy:Topology|Device which groups tunnel summary by Topology or Device.,

Backup

POST devicebackup

Request Type: POST

Description: Creates the backup associated with the specified UUID.

URL: /api/fmc_config/v1/domain/{domainUUID}/backup/operational/devicebackup

GET downloadbackup

Request Type: GET

Description: Downloads the backup associated with the specified UUID (In case of FMC the manager identifier should be entered in place of UUID). If no filter is specified for a GET, downloads the latest backup.

URL: /api/fmc_config/v1/domain/{domainUUID}/backup/downloadbackup/{targetId}

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/backup/downloadbackup/{targetId}/{object_UUID}

GET files

Request Type: GET

Description: Retrieves the backup associated with the specified UUID (In case of FMC the manager identifier should be entered in place of UUID). If no filter is specified for a GET, retrieves the latest backup.

URL: /api/fmc_config/v1/domain/{domainUUID}/backup/files

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/backup/files/{object_UUID}

DELETE files

Request Type: DELETE

Description: Deletes the backup associated with the specified UUID (In case of FMC the manager identifier should be entered in place of UUID).

URL: /api/fmc_config/v1/domain/{domainUUID}/backup/files/{targetId}

Chassis

POST breakoutinterfaces

Request Type: POST

Description: Break interface.

URL: /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/operational/breakoutinterfaces

GET chassisinterfaces

Request Type: GET

Description: Retrieves the chassis interfaces associated with the ID. If no ID is specified, retrieves list of all chassis interfaces.

URL: /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/chassisinterfaces

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/chassisinterfaces/{interfaceUUID}

GET evaluateoperation

Request Type: GET

Description: Validate interface usage.

URL: /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/chassisinterfaces/{interfaceUUID}/evaluateoperation

GET fmcmanagedchassis

Request Type: GET

Description: Retrieves information on the specified chassis managed device. If no ID is given, retrieves list of all chassis managed devices.

URL: /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{objectId}

GET interfaces

Request Type: GET

Description: Retrieves all chassis interfaces. If an interface UUID is provided, retrives specific information for that interface.

URL: /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/interfaces

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/interfaces/{interface_UUID}

POST joininterfaces

Request Type: POST

Description: Join interfaces.

URL: /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/operational/joininterfaces

GET networkmodules

Request Type: GET

Description: Retrieves the information about the network module object associated with the ID. If no ID is specified, retrieves list of all network modules.

URL: /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/networkmodules

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/networkmodules/{objectId}

PUT networkmodules

Request Type: PUT

Description: Modifies the specified network modules.

URL: /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/networkmodules/{objectId}

PUT syncnetworkmodule

Request Type: PUT

Description: Retrieve Network module data from FXOS and updates.

URL: /api/cdo_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/operational/syncnetworkmodule

Intelligence Services

POST collections

Request Type: POST

Description: Adds a collections from a TAXII source.

URL: /api/fmc_tid/v1/domain/{domain_UUID}/taxiiconfig/collections

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

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}

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.


Note
As of 7.1.0 whitelist is now allowlist

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}

PUT incident

Request Type: PUT

Description: Modifies an intelligence incident with the specified object ID.


Note
As of 7.1.0 whitelist is now allowlist

URL: /api/fmc_tid/v1/domain/{domain_UUID}/tid/incident/{object_UUID}

DELETE incident

Request Type: DELETE

Description: Deletes an incident.

URL: /api/fmc_tid/v1/domain/{domain_UUID}/taxiiconfig/incident/{object_UUID}

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.


Note
As of 7.1.0 whitelist is now allowlist

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}

PUT indicator

Request Type: PUT

Description: Modifies an indicator with the specified object ID.


Note
As of 7.1.0 whitelist is now allowlist

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

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.


Note
As of 7.1.0 whitelist is now allowlist

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}

PUT observable

Request Type: PUT

Description: Modifies an observable with the specified object ID.


Note
As of 7.1.0 whitelist is now allowlist

URL: /api/fmc_tid/v1/domain/{domain_UUID}/tid/observable/{object_UUID}

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}

PUT settings

Request Type: PUT

Description: Activates or deactivates an intelligence setting.

URL: /api/fmc_tid/v1/domain/{domain_UUID}/tid/settings/{value}

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.


Note
As of 7.1.0 whitelist is now allowlist

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}

PUT source

Request Type: PUT

Description: Modifies an intelligence source with the specified object ID.


Note
As of 7.1.0 whitelist is now allowlist

URL: /api/fmc_tid/v1/domain/{domain_UUID}/tid/source/{object_UUID}

POST source

Request Type: POST

Description: Adds a source for intelligence information.


Note
As of 7.1.0 whitelist is now allowlist

URL: /api/fmc_tid/v1/domain/{domain_UUID}/tid/source

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}

License

GET smartlicenses

Request Type: GET

Description: Retrieves the retrieving assigned device licenses associated with the ID. If no ID is specified, retrieves list of all assigned device licenses.

URL: /api/fmc_platform/v1/license/smartlicenses

URL for GET by ID: /api/fmc_platform/v1/license/smartlicenses/{object_UUID}

POST smartlicenses

Request Type: POST

Description: Updates device licenses.

URL: /api/fmc_platform/v1/license/smartlicenses

GET devicelicenses

Request Type: GET

Description: Retrieves the Device Licenses.

URL: /api/fmc_platform/v1/license/devicelicenses/{objectId}

PUT devicelicenses

Request Type: PUT

Description: Modifies the Device Licenses.

URL: /api/fmc_platform/v1/license/devicelicenses/{objectId}

Search

GET device

Request Type: GET

Description: Search for devices matching specified text.

URL: /api/fmc_config/v1/domain/{domainUUID}/search/device

GET globalsearch

Request Type: GET

Description: Search for objects and policies matching specified text or IP address.

URL: /api/fmc_config/v1/domain/{domainUUID}/search/globalsearch

Parameters available for filtering: Text or IP address used for filtering.

GET objectsearch

Request Type: GET

Description: Search for objects matching specified text or IP address.

URL: /api/fmc_config/v1/domain/{domainUUID}/search/object

Parameters available for filtering: Text or IP address used for filtering.

GET policysearch

Request Type: GET

Description: Search for policies matching specified text or IP address (literal values in policies).

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

Parameters available for filtering: Text or IP address used for filtering.

Integration Services

GET cdfmcsnapshot

Request Type: GET

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

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

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

POST cdfmcsnapshot

Request Type: POST

Description: Creates a cdfmcsnapshot object.

URL: /api/fmc_config/v1/domain/{domainUUID}/integration/cdfmcsnapshot

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}

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}

GET cloudregions

Request Type: GET

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

URL for listing: /api/fmc_config/v1/domain/{domain_UUID}/integration/cloudregions/

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

PUT cloudregions

Request Type: PUT

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

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

GET datacenters

Request Type: GET

Description: Retrieves list of all the Umbrella data centers.

URL: /api/fmc_config/v1/domain/{domainUUID}/integration/umbrella/datacenters

GET dynamicattributesfeeds

Request Type: GET

Description: Retrieves Dynamic Attributes Feeds.

URL: /api/fmc_config/v1/domain/{domainUUID}/integration/dynamicattributesfeeds

PUT dynamicattributesfeeds

Request Type: PUT

Description: Updates Dynamic Attributes Feeds.

URL: /api/fmc_config/v1/domain/{domainUUID}/integration/dynamicattributesfeeds

GET ebssnapshot

Request Type: GET

Description: Retrieves the EBS snapshot. associated with the specified ID. If no ID is specified, retrieves list of all EBS snapshots.

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

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

POST ebssnapshot

Request Type: POST

Description: Creates an EBS snapshot..

URL: /api/fmc_config/v1/domain/{domainUUID}/integration/ebssnapshot

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}

Parameters available for filtering:

PUT externallookups

Request Type: PUT

Description: Modifies externallookups objects.

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

POST externallookups

POST externallookups

Description: Creates externallookups objects with the specified parameters.

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

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}

GET External Storage

Request Type: GET

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

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

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

Parameters available for filtering: None

PUT External Storage

Request Type: PUT

Description: Modifies the external event storage configuration associated with the specified ID.

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

GET FMC HA Statuses

Request Type: GET

Description: Retrieves management center HA Statuses.

URL: /api/fmc_config/v1/domain/{domainUUID}/integration/fmchastatuses

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}

Parameters available for filtering:

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}

POST packetanalyzerdevices

Request Type: POST

Description: Creates PKI enrollments objectswith the specified parameters.

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

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}

POST refreshsecurexconfigs

Request Type: POST

Description: Refresh SecureX configurations.

URL: /api/fmc_config/v1/domain/{domainUUID}/integration/operational/refreshsecurexconfigs

GET SecureX Configs

Request Type: GET

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

URL: /api/fmc_config/v1/domain/{domainUUID}/integration/securexconfigs

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

PUT SecureX Configs

Request Type: PUT

Description: Modifies the SecureX configuration associated with the specified ID

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

POST testumbrellaconnections

Request Type: POST

Description: Tests connection to the umbrella cloud.

URL: /api/fmc_config/v1/domain/{domainUUID}/integration/operational/testumbrellaconnections

GET transcripts

Request Type: GET

Description: Retrieves Transcript for Umbrella deployment for a given device and topology.

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/integration/umbrella/tunneldeployments/{containerUUID}/transcripts/{objectId}/{object_UUID}

GET tunneldeployments

Request Type: GET

Description: Retrieves Tunnel deployment data on Umbrella.

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

POST tunneldeployments

Request Type: POST

Description: Creates a tunnel deployment.

URL: /api/fmc_config/v1/domain/{domainUUID}/integration/umbrella/tunneldeployments

GET tunneltranscripts

Request Type: GET

Description: Retrieves Transcript for Umbrella deployment for a given device and topology..

URL: /api/fmc_config/v1/domain/{domainUUID}/integration/umbrella/tunneldeployments/{containerUUID}/transcripts/{objectId}

GET umbrellaconnections

Request Type: GET

Description: Retrieves the Umbrella connection configuration associated with the specified ID. If no ID is specified, retrieves a list of all Umbrella connections.

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

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

PUT umbrellaconnections

Request Type: PUT

Description: Modifies the specified Umbrella connections configuration.

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

Object Services

GET AnyConnect Custom Attributes

Request Type: GET

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

URL for listing: /api/fmc_config/v1/domain/{domainUUID}/object/anyconnectcustomattributes

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/anyconnectcustomattributes/{objectId}

URL to list all overrides:

/api/fmc_config/v1/domain/{domainUUID}/object/anyconnectcustomattributes/{containerUUID}/override

Parameters available for filtering: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}" to search for both name and value

PUT AnyConnect Custom Attributes

Request Type: PUT

Description: Modifies the AnyConnect Custom Attribute associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/anyconnectcustomattributes/{objectId}

POST AnyConnect Custom Attributes

Request Type: POST

Description: Creates an AnyConnect Custom Attribute.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/anyconnectcustomattributes

DELETE AnyConnect Custom Attributes

Request Type: DELETE

Description: Deletes the AnyConnect Custom Attribute associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/anyconnectcustomattributes/{objectId}

GET AnyConnect Packages

Request Type: GET

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

URL for listing: /api/fmc_config/v1/domain/{domainUUID}/object/anyconnectpackages

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/anyconnectpackages/{objectId}

PUT anyconnectpackages

Request Type: PUT

Description: Modifies the AnyConnect Package associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/anyconnectpackages/{objectId}

POST anyconnectpackages

Request Type: POST

Description: Creates an anyconnectpackages object.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/anyconnectpackages

DELETE anyconnectpackages

Request Type: DELETE

Description: Deletes the AnyConnect Package associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/anyconnectpackages/{objectId}

GET anyconnectexternalbrowserpackages

Request Type: GET

Description: Retrieves the AnyConnect External Browser Package associated with the specified ID. If no ID is specified for a GET, retrieves list of all AnyConnect External Browser Package objects.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/anyconnectexternalbrowserpackages

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/anyconnectexternalbrowserpackages/{objectId}

Parameters available for filtering: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}" to search for both name and value.

PUT anyconnectexternalbrowserpackages

Request Type: PUT

Description: Modifies the AnyConnect External Browser Package associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/anyconnectexternalbrowserpackages/{objectId}

POST anyconnectexternalbrowserpackages

Request Type: POST

Description: Creates an AnyConnect External Browser Package.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/anyconnectexternalbrowserpackages

DELETE anyconnectexternalbrowserpackages

Request Type: DELETE

Description: Deletes the AnyConnect External Browser Package associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/anyconnectexternalbrowserpackages/{objectId}

GET AnyConnect Profiles

Request Type: GET

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

URL: /api/fmc_config/v1/domain/{domainUUID}/object/anyconnectprofiles

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/anyconnectprofiles/{objectId

Parameters available for filter: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}" to search for both name and value.

Parameters available for filter: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}" to search for both name and value.

PUT anyconnectprofiles

Request Type: PUT

Description: Modifies the AnyConnect Profile associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/anyconnectprofiles/{objectId}

POST anyconnectprofiles

Request Type: POST

Description: Creates an AnyConnect Profile.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/anyconnectprofiles

DELETE anyconnectprofiles

Request Type: DELETE

Description: Deletes the AnyConnect Profile associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/anyconnectprofiles/{objectId}

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}

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}

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}

PUT applicationfilters

Request Type: PUT

Description: Modifies the application filter object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/applicationfilters/{objectId}

POST applicationfilters

Request Type: POST

Description: Creates or overrides the application filter object with the specified parameters.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/applicationfilters

DELETE applicationfilters

Request Type: DELETE

Description: Deletes the application filter object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/applicationfilters/{objectId}

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}

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}

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}

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}

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}

GET aspathlists

Request Type: GET

Description: Retrieves the autonoous system path list associated with the specified ID. If no ID is specified, retrieves list of all autonomous system paths.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/aspathlists

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/aspathlists/{objectId}

PUT aspathlists

Request Type: PUT

Description: Modifies the AsPath List associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/aspathlists/{objectId}

POST aspathlists

Request Type: POST

Description: Creates an AsPath List object.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/aspathlists

DELETE aspathlists

Request Type: DELETE

Description: Deletes the AsPath List associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/aspathlists/{objectId}

GET azureadrealms

Request Type: GET

Description: Retrieves the Azure AD Realm associated with the specified ID. If no ID is specified, retrieves list of all Azure AD Realms.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/azureadrealms

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/azureadrealms/{object_UUID}

PUT azureadrealms

Request Type: PUT

Description: Modifies the specified Azure AD realms.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/azureadrealms/{objectId}

POST azureadrealms

Request Type: POST

Description: Creates an Azure AD Realm.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/azureadrealms

DELETE azureadrealms

Request Type: DELETE

Description: Deletes the specified Azure AD realm.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/azureadrealms/{objectId}

GET azureadstatuses

Request Type: GET

Description: Retrieves Azure AD realm statuses.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/azureadstatuses

GET bfdtemplates

Request Type: GET

Description: Retrieves the bi-directional forwarding template associated with the ID. If no ID is specified, retrieves list of all bi-directional forwarding templates.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/bfdtemplates

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/bfdtemplates/{object_UUID}

PUT bfdtemplates

Request Type: PUT

Description: Modifies the specified bi-directional forwarding template.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/bfdtemplates/{objectId}

POST bfdtemplates

Request Type: POST

Description: Creates a bi-directional forwarding template..

URL: /api/fmc_config/v1/domain/{domainUUID}/object/bfdtemplates

DELETE bfdtemplates

Request Type: DELETE

Description: Deletes the specified bi-directional forwarding template.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/bfdtemplates/{objectId}

POST bulkdynamicobjects

Request Type: POST

Description: Adds Dynamic Object Mappings for specific Dynamic Objects.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/bulkdynamicobjects

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}

PUT certenrollments

Request Type: PUT

Description: Modifies the Certificate Enrollment associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId}

POST certenrollments

Request Type: POST

Description: Creates a the Certificate Enrollment.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/certenrollments

DELETE certenrollments

Request Type: DELETE

Description: Deletes the Certificate Enrollment associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/certenrollments/{objectId}

GET Certificate Maps

Request Type: GET

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

URL: /api/fmc_config/v1/domain/{domainUUID}/object/certificatemaps

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/certificatemaps/{objectId}

Parameters available for filtering: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}" to search for both name and value.

PUT certificatemaps

Request Type: PUT

Description: Modifies the Certificate Map associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/certificatemaps/{objectId}

POST certificatemaps

Request Type: POST

Description: Creates a Certificate Map.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/certificatemaps

DELETE certificatemaps

Request Type: DELETE

Description: Deletes the Certificate Map associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/certificatemaps/{objectId}

GET ciphersuitelists

Request Type: GET

Description: Retrieves cipher suite lists.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/ciphersuitelists

POST ciphersuitelists

Request Type: POST

Description: Creates a cipher suite list.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/ciphersuitelists

GET communitylists

Request Type: GET

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

URL: /api/fmc_config/v1/domain/{domainUUID}/object/communitylists

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/communitylists/{objectId}

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}

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}

GET customsiiplistdownload

Request Type: GET

Description: Retrieves the custom Security Intelligence IP List with the specified UUID.

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/customsiiplistdownload/{objectId}/{object_UUID}

GET customsiiplists

Request Type: GET

Description: Retrieves the custom Security Intelligence Network List object associated with the specified ID. If no ID is specified, retrieves list of all custom Security Intelligence Network List objects.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/customsiiplists

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/customsiiplists/{object_UUID}

PUT customsiiplists

Request Type: PUT

Description: Modifies the custom Security Intelligence Network List object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/customsiiplists/{objectId}

POST customsiiplists

Request Type: POST

Description: Creates a custom Security Intelligence Network List object.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/customsiiplists

DELETE customsiiplists

Request Type: DELETE

Description: Deletes the custom Security Intelligence Network List object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/customsiiplists/{objectId}

GET customsiurllistdownload

Request Type: GET

Description: Retrieves the custom Security Intelligence URL List with the specified UUID.

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/customsiurllistdownload/{objectId}/{object_UUID}

GET customsiurllists

Request Type: GET

Description: Retrieves the custom Security Intelligence URL List object associated with the specified ID. If no ID is specified, retrieves list of all custom Security Intelligence URL List objects.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/customsiurllists

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/customsiurllists/{object_UUID}

PUT customsiurllists

Request Type: PUT

Description: Modifies the custom Security Intelligence URL List object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/customsiurllists/{objectId}

POST customsiurllists

Request Type: POST

Description: Creates a custom Security Intelligence URL List object.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/customsiurllists

DELETE customsiurllists

Request Type: DELETE

Description: Deletes the custom Security Intelligence URL List object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/customsiurllists/{objectId}

GET dhcpipv6pools

Request Type: GET

Description: Retrieves the DHCP IPv6 pool object associated with the specified ID. If no ID is specified, retrieves list of all DHCP IPv6 Pool objects.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/dhcpipv6pools

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/dhcpipv6pools/{object_UUID}

PUT dhcpipv6pools

Request Type: PUT

Description: Modifies the DHCP IPv6 pool object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/dhcpipv6pools/{objectId}

POST dhcpipv6pools

Request Type: POST

Description: Creates a DHCP IPv6 pool object.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/dhcpipv6pools

DELETE dhcpipv6pools

Request Type: DELETE

Description: Deletes the DHCP IPv6 pool object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/dhcpipv6pools/{objectId}

GET distinguishednamegroups

Request Type: GET

Description: Retrieves the list of all Distinguished Name group objects.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/distinguishednamegroups

GET distinguishednames

Request Type: GET

Description: Retrieves distinguished name objects.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/distinguishednames

POST distinguishednames

Request Type: POST

Description: Creates a distinguished names object.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/distinguishednames

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}

Description: Retrieves all(Domain and Device) overrides on a ICMPV4 object.Response will always be in expanded form. If passed, the "expanded" query parameter will be ignored.

URL to list all overrides on a particular object: /api/fmc_config/v1/domain/{domainUUID}/object/dnsservergroups/{containerUUID}/overrides/{objectId}

URL for override for an object on a particular domain or device: /api/fmc_config/v1/domain/{domainUUID}/object/dnsservergroups/{containerUUID}/overrides

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

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

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}

POST Download Azure AD Realms

Request Type: GET

Description: Download users and groups of the specific Azure AD Realm.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/azureadrealms/{realmId}/download

POST downloadinternalca

Request Type: POST

Description: Retrieves and downloads the Internal Certificate Authority object in a PKCS12 file encrypted using the provided password.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/downloadinternalca

POST dynamicobjectmappings

Request Type: POST

Description: Adds Dynamic Object Mappings for specific Dynamic Objects

URL: /api/fmc_config/v1/domain/{domainUUID}/object/dynamicobjectmappings

DELETE dynamicobjectmappings

Request Type: DELETE

Description: Removes Dynamic Object Mappings for specific Dynamic Objects.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/dynamicobjectmappings

Parameters available for filtering:

Parameter

 Values
Objects with ids: "ids:id1,id2,..."
Unused objects: "unusedOnly:true"
Name starts with: "nameStartsWith:{name-pattern}"
Agent ID: "agentId:{Agent ID}"

GET dynamicobjects

Request Type: GET

Description: Retrieves the Dynamic Object associated with the specified ID. If no ID is specified for a GET, retrieves list of all Dynamic Objects.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/dynamicobjects

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/dynamicobjects/{objectIdOrName}

Parameters available for filtering: name (Cannot be used if object ID is specified in path.)

PUT dynamicobjects

Request Type: PUT

Description: Modifies the Dynamic Object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/dynamicobjects/{objectId}

POST dynamicobjects

Request Type: POST

Description: Creates or overrides the Dynamic Objects with the specified parameters.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/dynamicobjects

DELETE dynamicobjects

Request Type: DELETE

Description: Deletes the Dynamic Object associated with the specified ID. If used without an ID, deletes objects selected by filtering.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/dynamicobjects/

URL for DELETE by ID: /api/fmc_config/v1/domain/{domainUUID}/object/dynamicobjects/{objectIdOrName}

Parameters available for filtering:

Parameter

 Values
Objects with ids: "ids:id1,id2,..."
Unused objects: "unusedOnly:true"
Name starts with: "nameStartsWith:{name-pattern}"

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}

GET expanded community lists

Request Type: GET

Description: Retrieves the expanded community list associated with the specified ID. If no ID is specified, retrieves all community lists.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/expandedcommunitylists

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/expandedcommunitylists/{objectId}

PUT expandedcommunitylists

Request Type: PUT

Description: Modifies the specified expanded community list.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/expandedcommunitylists/{objectId}

POST expandedcommunitylists

Request Type: POST

Description: Creates an expanded community lists.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/expandedcommunitylists

DELETE expandedcommunitylists

Request Type: DELETE

Description: Deletes the specified expanded community lists.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/expandedcommunitylists/{objectId}

GET extended access lists

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/extendedaccesslists

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

PUT extendedaccesslists

Request Type: PUT

Description: Modifies the extended access list associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/extendedaccesslists/{objectId}

POST extendedaccesslists

Request Type: POST

Description: Creates an extended access lists.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/extendedaccesslists

DELETE extendedaccesslists

Request Type: DELETE

Description: Deletes the extended access list associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/extendedaccesslists/{objectId}

GET extendedcommunitylists

Request Type: GET

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

URL: /api/fmc_config/v1/domain/{domainUUID}/object/extendedcommunitylists

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/extendedcommunitylists/{objectId}

URL for GET overrides: /api/fmc_config/v1/domain/{domainUUID}/object/extendedcommunitylists/{containerUUID}/overrides

URL for GET overrides by ID: /api/fmc_config/v1/domain/{domainUUID}/object/extendedcommunitylists/{containerUUID}/overrides/{objectId}

Parameters available for filtering: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}" to search for both name and value and "type:{type}" to search for specific type of the object.For ExtendedCommunityLists supported types are Standard and Expanded.

PUT extendedcommunitylists

Request Type: PUT

Description: Modifies the extended community list with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/extendedcommunitylists/{objectId}

POST extendedcommunitylists

Request Type: POST

Description: Creates an extended community list.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/extendedcommunitylists

DELETE extendedcommunitylists

Request Type: DELETE

Description: Deletes extended community list with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/extendedcommunitylists/{objectId}

GET externalcacertificategroups

Request Type: GET

Description: Retrieves the list of all trusted CA groups.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/externalcacertificategroups

GET externalcacertificates

Request Type: GET

Description: Retrieves trusted CA objects.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/externalcacertificates

POST externalcacertificates

Request Type: POST

Description: Creates a trusted CA object.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/externalcacertificates

GET externalcertificategroups

Request Type: GET

Description: Retrieves list of all the external certificate groups.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/externalcertificategroups

GET externalcertificates

Request Type: GET

Description: Retrieves external certificate objects.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/externalcertificates

POST externalcertificates

Request Type: POST

Description: Creates an external certificates object.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/externalcertificates

GET filecategories

Request Type: GET

Description: Retrieves the file category associated with the specified ID. If no ID is specified, retrieves a list of all the file categories.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/filecategories

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/filecategories/{object_UUID}

GET filetypes

Request Type: GET

Description: Retrieves the file type associated with the specified ID. If no ID is specified, retrieves a list of all the file types.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/filetypes

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/filetypes/{object_UUID}

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

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}

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

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}

URL to delete all FQDN objects: /api/fmc_config/v1/domain/{domain_UUID}/object/fqdns/

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}

PUT geolocations

Request Type: PUT

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

URL: /api/fmc_config/v1/domain/{domainUUID}/object/geolocations/{objectId}

POST geolocations

Request Type: POST

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

URL: /api/fmc_config/v1/domain/{domainUUID}/object/geolocations

DELETE geolocations

Request Type: DELETE

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

URL: /api/fmc_config/v1/domain/{domainUUID}/object/geolocations/{objectId}

GET global time zones

Request Type: GET

Description: Retrieves the global time zone object associated with the specified ID. If no ID is specified, retrieves list of all global time zone objects.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/globaltimezones

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/globaltimezones/{objectId}

GET grouppolicies

Request Type: GET

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

URL: /api/fmc_config/v1/domain/{domainUUID}/object/grouppolicies

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/grouppolicies/{objectId}

PUT grouppolicies

Request Type: PUT

Description: Modifies the VPN group policies associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/grouppolicies/{objectId}

POST grouppolicies

Request Type: POST

Description: Creates a VPN group policy

URL: /api/fmc_config/v1/domain/{domainUUID}/object/grouppolicies

DELETE grouppolicies

Request Type: DELETE

Description: Deletes the VPN group policies associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/grouppolicies/{objectId}

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}

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}

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

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}

URL to delete all hosts: /api/fmc_config/v1/domain/{domain_UUID}/object/hosts/

GET hostscanpackages

Request Type: GET

Description: Retrieves HostScan packages. If no ID is specified for a GET, retrieves list of all HostScan packages.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/hostscanpackages

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/hostscanpackages/{objectId}

PUT hostscanpackages

Request Type: PUT

Description: Modifies the HostScan package with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/hostscanpackages/{objectId}

POST hostscanpackages

Request Type: POST

Description: Creates a HostScan package.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/hostscanpackages

DELETE hostscanpackages

Request Type: DELETE

Description: Deletes the HostScan package with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/hostscanpackages/{objectId}

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}

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}

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

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}

URL to delete all ICMPv4 objects: /api/fmc_config/v1/domain/{domain_UUID}/object/icmpv4objects/

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}

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}

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

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}

URL to delete all ICMPv6 objects: /api/fmc_config/v1/domain/{domain_UUID}/object/icmpv6objects/

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}

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}

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

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}

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}

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}

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

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}

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}

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}

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

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}

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}

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}

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

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}

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}

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}

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

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}

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}

GET internalcas

Request Type: GET

Description: Retrieves the Internal CA associated with the specified ID. If no ID is specified, retrieves list of all Internal CAs.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/internalcas

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/internalcas/{object_UUID}

PUT internalcas

Request Type: PUT

Description: Modifies the Internal CA associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/internalcas/{objectId}

POST internalcas

Request Type: POST

Description: Creates an Internal CA.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/internalcas

DELETE internalcas

Request Type: DELETE

Description: Deletes the Internal CA associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/internalcas/{objectId}

GET internalcertgroups

Request Type: GET

Description: Retrieves the list of all Internal Certificate Groups.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/internalcertgroups

GET internalcertificates

Request Type: GET

Description: Retrieves the Internal Certificate associated with the specified ID. If no ID is specified, retrieves list of all Internal Certificates.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/internalcertificates

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/internalcertificates/{object_UUID}

PUT internalcertificates

Request Type: PUT

Description: Modifies the Internal Certificate associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/internalcertificates/{objectId}

POST internalcertificates

Request Type: POST

Description: Creates an Internal Certificate.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/internalcertificates

DELETE internalcertificates

Request Type: DELETE

Description: Deletes the Internal Certificate associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/internalcertificates/{objectId}

GET intrusionrulegroups

Request Type: GET

Description: Retrieves the Snort3 Intrusion rule group. If no ID is specified, retrieves a list of all Snort3 Intrusion rule groups.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/intrusionrulegroups

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/intrusionrulegroups/{objectId}

Parameters vailable for filtering: Value is of format (including quotes): filter=name:Browser OR filter=name:Browser/Firefox OR filter=showonlyparents:true OR filter=showonlyparents:false OR filter=issystemdefined:true OR issystemdefined:false.

PUT intrusionrulegroups

Request Type: PUT

Description: Modifies the Snort3 Intrusion rule group with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/intrusionrulegroups/{objectId}

POST Intrusion Rule Groups

Request Type: POST

Description: Creates or overrides the Snort3 Intrusion rule group with the specified parameters.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/intrusionrulegroups

DELETE Intrusion Rule Groups

Request Type: DELETE

Description: Deletes the specified Snort3 intrusion rule group.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/intrusionrulegroups/{objectId}

GET intrusionrules

Request Type: GET

Description: Retrieves the specified Snort3 rule. If no ID is specified, retrieves a list of all Snort3 rules.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/intrusionrules

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/intrusionrules/{objectId}

Parameters available for filtering:

filter=gid:123 OR filter=sid:123 OR filter=gid:123;sid:456 OR filter=overrides:true OR filter=overrides:true;ipspolicy:UUID1,UUID2,UUID3 OR filter=fts:123. ipspolicy is comma separated Snort3 Intrusion Policy UUID.

PUT intrusionrules

Request Type: PUT

Description: Creates or modifies the Snort3 rule with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/intrusionrules

URL for PUT by ID: /api/fmc_config/v1/domain/{domainUUID}/object/intrusionrules/{objectID}

POST intrusionrules

Request Type: POST

Description: Creates or overrides the Snort3 rules with the specified parameters.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/intrusionrules

DELETE intrusionrules

Request Type: DELETE

Description: Deletes the specified Snort3 rule.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/intrusionrules/{objectId}

GET ipv4addresspools

Request Type: GET

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

URL: /api/fmc_config/v1/domain/{domainUUID}/object/ipv4addresspools

URL for overrides: /api/fmc_config/v1/domain/{domainUUID}/object/ipv4addresspools/{containerUUID}/overrides

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/ipv4addresspools/{objectId}

Parameters available for filtering: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}" to search for both name and value.

PUT ipv4addresspools

Request Type: PUT

Description: Modifies the IPv4 Address Pool object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/ipv4addresspools/{objectId}

POST ipv4addresspools

Request Type: POST

Description: Creates an IPv4 Address Pool object.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/ipv4addresspools

DELETE ipv4addresspools

Request Type: DELETE

Description: Deletes the IPv4 Address Pool object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/ipv4addresspools/{objectId}

GET ipv6addresspools

Request Type: GET

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

URL: /api/fmc_config/v1/domain/{domainUUID}/object/ipv6addresspools

URL for overrides: /api/fmc_config/v1/domain/{domainUUID}/object/ipv6addresspools/{containerUUID}/overrides

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/ipv6addresspools/{objectId}

Parameters available for filtering: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}" to search for both name and value.

PUT ipv6addresspools

Request Type: PUT

Description: Modifies the IPv6 Address Pool object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/ipv6addresspools/{objectId}

POST ipv6addresspools

Request Type: POST

Description: Creates an IPv6 Address Pool object.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/ipv6addresspools

DELETE ipv6addresspools

Request Type: DELETE

Description: Deletes the IPv6 Address Pool object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/ipv6addresspools/{objectId}

GET ipv4prefixlists

Request Type: GET

Description: Retrieves the IPv4 prefix list associated with the specified ID. If no ID is specified, retrieves all IPv4 prefix lists.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/ipv4prefixlists

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/ipv4prefixlists/{objectId}

PUT ipv4prefixlists

Request Type: PUT

Description: Modifies the IPv4 Prefix List associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/ipv4prefixlists/{objectId}

POST ipv4prefixlists

Request Type: POST

Description: Creates an IPv4 Prefix List.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/ipv4prefixlists

DELETE ipv4prefixlists

Request Type: DELETE

Description: Deletes the IPv4 Prefix List associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/ipv4prefixlists/{objectId}

GET ipv6prefixlists

Request Type: GET

Description: Retrieves the IPv6 prefix list associated with the specified ID. If no ID is specified, retrieves all IPv6 prefix lists.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/ipv6prefixlists

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/ipv6prefixlists/{objectId}

PUT ipv6prefixlists

Request Type: PUT

Description: Modifies the IPv6 Prefix List associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/ipv6prefixlists/{objectId}

POST ipv6prefixlists

Request Type: POST

Description: Creates an IPv6 Prefix List.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/ipv6prefixlists

DELETE ipv6prefixlists

Request Type: DELETE

Description: Deletes the IPv6 Prefix List associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/ipv6prefixlists/{objectId}

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}

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.

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}

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.

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.

GET localrealmusers

Request Type: GET

Description: Retrieves the local realm user object associated with the specified ID. If no ID is specified, retrieves list of all local realm user objects.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/localrealmusers

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/localrealmusers/{objectId}

Parameters vailable for filtering: To filter users by realm, use realm:{realmUUID}. To filter users by name, use name:{name}

PUT localrealmusers

Request Type: PUT

Description: Modifies the local realm user object with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/localrealmusers/{objectId}

POST localrealmusers

Request Type: POST

Description: Creates or overrides the local realm user objects with the specified parameters.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/localrealmusers

POST localrealmusers

Request Type: DELETE

Description: Deletes the specified local realm user object.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/localrealmusers/{objectId}

GET mappings

Request Type: GET

Description: Retrieves the Dynamic Object Mappings associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/dynamicobjects/{objectIdOrName}/mappings

PUT mappings

Request Type: PUT

Description: Adds Dynamic Object Mappings associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/dynamicobjects/{objectId}/mappings

DELETE mappings

Request Type: DELETE

Description: Removes the Dynamic Object Mappings associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/dynamicobjects/{objectId}/mappings

Parameters available for filtering:

Parameter

 Values
Objects with ids: "ids:id1,id2,..."
Unused objects: "unusedOnly:true"
Name starts with: "nameStartsWith:{name-pattern}"
Agent ID: "agentId:{Agent ID}"

GET networkaddresses

Request Type: GET

Description: Retrieves list of all network and host objects.

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

URL for listing only unused objects: /api/fmc_config/v1/domain/{domain_UUID}/object/networkaddresses?filter=unusedOnly:true

URL for searching by name or value: /api/fmc_config/v1/domain/{domain_UUID}/object/networkaddresses?filter=nameOrValue:{name_or_value}

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}

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}

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

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}

URL to delete all network groups: /api/fmc_config/v1/domain/{domain_UUID}/object/networkgroups/

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}

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}

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

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}

URL to delete all networks: /api/fmc_config/v1/domain/{domain_UUID}/object/networks/

GET packettracerpcaplist

Request Type: GET

Description: Retrieves all the PCAP files in the most recently uploaded fashion.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/packettracerpcaplist

POST packettracerpcapupload

Request Type: POST

Description: Imports a PCAP file from Packet Tracer.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/packettracerpcapupload

GET policy lists

Request Type: GET

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

URL: /api/fmc_config/v1/domain/{domainUUID}/object/policylists

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/policylists/{objectId}

PUT policylists

Request Type: PUT

Description: Modifies the Policy List associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/policylists/{objectId}

POST policylists

Request Type: POST

Description: Creates a Policy List.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/policylists

DELETE policylists

Request Type: DELETE

Description: Deletes the Policy List associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/policylists/{objectId}

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}

URL for listing only unused objects: /api/fmc_config/v1/domain/{domain_UUID}/object/portobjectgroups?filter=unusedOnly:true

URL for searching by name or value: /api/fmc_config/v1/domain/{domain_UUID}/object/portobjectgroups?filter=nameOrValue:{name_or_value}

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}

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

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}

URL to delete all port object groups: /api/fmc_config/v1/domain/{domain_UUID}/object/portobjectgroups/

GET ports

Request Type: GET

Description: Retrieves list of all port objects.

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

URL for listing only unused objects: /api/fmc_config/v1/domain/{domain_UUID}/object/ports?filter=unusedOnly:true

URL for searching by name or value: /api/fmc_config/v1/domain/{domain_UUID}/object/ports?filter=nameOrValue:{name_or_value}

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}

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}

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

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}

URL to delete all protocol port objects: /api/fmc_config/v1/domain/{domain_UUID}/object/protocolportobjects/

GET radiusservergroups

Request Type: GET

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

URL: /api/fmc_config/v1/domain/{domainUUID}/object/radiusservergroups

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/object/radiusservergroups/{objectId}

Parameters available for filtering: To be used in conjunction with "unusedOnly:true" to search for unused objects and "nameOrValue:{nameOrValue}" to search for both name and value.

PUT radiusservergroups

Request Type: PUT

Description: Modifies the Radius Server Group associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/radiusservergroups/{objectId}

POST radiusservergroups

Request Type: POST

Description: Creates a Radius Server Group.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/radiusservergroups

DELETE radiusservergroups

Request Type: DELETE

Description: Deletes the Radius Server Group associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/radiusservergroups/{objectId}

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}

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}

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

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}

URL to delete all address ranges: /api/fmc_config/v1/domain/{domain_UUID}/object/ranges/

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}

PUT realms

Request Type: PUT

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

URL: /api/fmc_config/v1/domain/{domainUUID}/object/realms/{objectId}

POST realms

Request Type: POST

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

URL: /api/fmc_config/v1/domain/{domainUUID}/object/realms

DELETE realms