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

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. Should these thresholds be surpassed, clients will receive an HTTP 429 error.

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

Permissions: Devices > Troubleshoot

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}

Permissions: Devices > Troubleshoot > Packet Tracer > Modify Packet Tracer

POST task

Request Type: POST

Description: Creates a job or task.

URL: /api/fmc_troubleshoot/v1/domain/{domainUUID}/task

Permissions: Deploy Configuration to Devices.

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}

Permissions: Object Manager

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

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager > Modify Object Manager

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

Permissions: Policies > Network Discovery

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

Permissions: Policies > Network Discovery > Modify Network Discovery

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}

Permissions: Policies > Network Discovery > Modify Network Discovery

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

Permissions: Analysis > Users > Active Sessions

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

Permissions: Analysis > Users > Active Sessions

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

Permissions: Analysis > Users > Users

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

Permissions: Analysis > Users > Users > Modify Users

POST logout

Request Type: POST

Description: Administratively logout active user session.

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

Permissions: Analysis > Users > Active Sessions > Modify Active Sessions

GET useractivity

Request Type: GET

Description: Retrieves user activities.

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

Permissions: Analysis > Users > User Activity

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

Permissions: Analysis > Users > User Activity > Modify User Activity Events

Audit Services

GET auditrecords

Request Type: GET

Description: Retrieves audit records.

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

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

Permissions: System > Monitoring > Audit

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

GET configchanges

Request Type: GET

Description: Retrieves the configuration changes associated with audit.

URL: /api/fmc_platform/v1/domain/{domainUUID}/audit/configchanges

URL for GET by ID: /api/fmc_platform/v1/domain/{domainUUID}/audit/configchanges/{object_UUID}

Permissions: System > Configuration

Parameters Available for Filtering: auditLogId, snapshotId

Change Management

GET previewchanges

Request Type: GET

Description: Retrieves ticket based changes

URL: /api/fmc_config/v1/domain/{domainUUID}/changemanagement/tickets/{containerUUID}/previewchanges

Permissions: Deploy Configuration to Devices

Parameters available for filtering: ParentEntityTypes

GET tickets

Request Type: GET

Description: Retrieves the specified ticket. If no ID is specified, retrieves all the tickets for the logged in user.

URL: /api/fmc_config/v1/domain/{domainUUID}/changemanagement/tickets

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/changemanagement/tickets/{object_UUID}

Permissions: Deploy Configuration to Devices

PUT tickets

Request Type: PUT

Description: Modifies the specified ticket.

URL: /api/fmc_config/v1/domain/{domainUUID}/changemanagement/tickets/{objectId}

Permissions: Deploy Configuration to Devices

POST tickets

Request Type: POST

Description: Creates a ticket.

URL: /api/fmc_config/v1/domain/{domainUUID}/changemanagement/tickets

Permissions: Deploy Configuration to Devices

GET validationresults

Request Type: GET

Description: Retrieves validation result for the input ticket.

URL: /api/fmc_config/v1/domain/{domainUUID}/changemanagement/tickets/{containerUUID}/validationresults

Permissions: Deploy Configuration to Devices

Users

GET authroles

Request Type: GET

Description: Retrieves the list of all existing user roles in the system.

URL: /api/fmc_config/v1/domain/{domainUUID}/users/authroles

Permissions: System > User Management

Parameters available for filtering: none

GET duoconfigs

Request Type: GET

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

URL: /api/fmc_config/v1/domain/{domainUUID}/users/duoconfigs/

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/users/duoconfigs/{objectId}

Permissions: System > User Management > Users

PUT duoconfigs

Request Type: PUT

Description: Modifies the Duo configuration associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/users/duoconfigs/{objectId}

Permissions: System > User Management > Users

GET SSO Config

Request Type: GET

Description: Retrieves the Single Signon Configuration for the device.

URL: ​/api​/fmc_config​/v1​/domain​/{domainUUID}​/users​/ssoconfigs​/{objectId}

Permissions: System > User Management > Single Sign-On

Parameters available for filtering: none

PUT SSO Config

Request Type: PUT

Description: Modifies the Single Signon configuration for the device.

URL: ​/api​/fmc_config​/v1​/domain​/{domainUUID}​/users​/ssoconfigs​/{objectId}

Permissions: System > User Management > Single Sign-On

GET users

Request Type: GET

Description: Retrieves information for the user with the specified ID. If no ID is specified, retrieves the list of all users on FMC.

URL: /api/fmc_config/v1/domain/{domainUUID}/users/users

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

Permissions: System > User Management > Users

Deployment Services

GET deployabledevices

Request Type: GET

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

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

Permissions: Deploy Configuration to Devices

Parameters available for filtering: name

POST deploymentrequests

Request Type: POST

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

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

Permissions: Deploy Configuration to Devices

GET deployments

Request Type: GET

Description: Retrieves deployment details for device.

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

Permissions: Deploy Configuration to Devices

Parameters available for filtering: startTime, endTime

GET downloadreports

Request Type: GET

Description: Retrieves the report for download.

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

Permissions: Overview > Reporting

POST emailreports

Request Type: POST

Description: Emails the deployment report.

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

Permissions: Overview > Reporting

GET jobhistories

Request Type: GET

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

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

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

Permissions: Deploy Configuration to Devices

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/fmc_config/v1/domain/{domainUUID}/deployment/jobhistories/{objectId}

Permissions: Deploy Configuration to Devices

GET pendingchanges

Request Type: POST

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

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

Permissions: Deploy Configuration to Devices

POST pendingchangesrequests

Request Type: POST

Description: Creates a request for generating pending policy changes or pending CLI changes or both on devices.

URL: /api/fmc_config/v1/domain/{domainUUID}/deployment/pendingchangesrequests

Permissions: Deploy Configuration to Devices

POST rollbackrequests

Request Type: POST

Description: Creates a request for rollback configuration to devices.

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

Permissions: Deploy Configuration to Devices

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}

Permissions: Devices > Device Management > View Devices

PUT devicegrouprecords

Request Type: PUT

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

URL: /api/fmc_config/v1/domain/{domain_UUID}/devicegroups/devicegrouprecords/{object_UUID}

Permissions: Devices > Device Management > Modify Devices

POST devicegrouprecords

Request Type: POST

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

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

Permissions: Devices > Device Management > Modify Devices

DELETE devicegrouprecords

Request Type: DELETE

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

URL: /api/fmc_config/v1/domain/{domain_UUID}/devicegroups/devicegrouprecords/{object_UUID}

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management > View Devices

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}

Permissions: Devices > Device Management > Modify Devices

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/

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management > Modify Devices

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

Permissions: Devices > Device Management > Modify Devices

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.

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management > Modify Devices

POST ftddevicehapairs

Request Type: POST

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


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

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

Permissions: Devices > Device Management > Modify Devices

DELETE ftddevicehapair

Request Type: DELETE

Description: Deletes a device high availability pair with the specified object ID.

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

Permissions: Devices > Device Management > Modify Devices


Note

Run the configure high-availability disable command to remove the failover configurations from 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}

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management > Modify Devices

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

Permissions: Devices > Device Management > Modify Devices

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

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management

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

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Object Manager

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}

Permissions: Object Manager > Modify Objects

POST bfdpolicies

Request Type: POST

Description: Creates BFD Hops.

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

Permissions: Object Manager > Modify Objects

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}

Permissions: Object Manager > Modify Objects

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}

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management > Modify Devices

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

Permissions: Devices > Device Management > Modify Devices

DELETE bgp

Request Type: DELETE

Description: Deletes the specified bgp object.

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

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management > Modify Devices

POST bgpgeneralsettings

Request Type: POST

Description: Creates BGP general settings.

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

Permissions: Devices > Device Management > Modify Devices

DELETE bgpgeneralsettings

Request Type: DELETE

Description: Deletes the BGP general settings.

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

Permissions: Devices > Device Management > Modify Devices

GET bridgegroupinterfaces

Request Type: GET

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

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

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

Permissions: Devices > Device Management

PUT bridgegroupinterfaces

Request Type: PUT

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

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

Permissions: Devices > Device Management > Modify Device

POST bridgegroupinterfaces

Request Type: POST

Description: Creates bridge group interfaces associated with the specified NGFW device ID and interface ID.

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

Permissions: Devices > Device Management > Modify Device

DELETE bridgegroupinterfaces

Request Type: DELETE

Description: Deletes a bridge group interface associated with the specified NGFW device ID and interface ID.

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

Permissions: Devices > Device Management > Modify Device

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

Permissions: System > Configuration

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

Permissions: Devices > Device Management

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

Permissions: Devices > Device Management > Modify Devices

GET devicerecords

Request Type: GET

Description: Retrieves device information. If a device ID is specified, the information for the specificed device is retrieved. If no ID is specified, retrieves information for all devices.

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

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

Permissions: Devices > Device Management

Parameters available for filtering: hostName

PUT devicerecords

Request Type: PUT

Description: Modifies the device record associated with the specified ID.

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

Permissions: Devices > Device Management > Modify Devices

POST devicerecords

Request Type: POST

Description: Registers the specified device to the management center.

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

Permissions: Devices > Device Management > Modify Devices

DELETE devicerecords

Request Type: DELETE

Description: Unregisters the specified device.

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

Permissions: Devices > Device Management > Modify Devices

GET devicesettings

Request Type: GET

Description: Retrieves the Device Settings.

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

Permissions: Devices > Device Management

PUT devicesettings

Request Type: PUT

Description: Modifies the Device Settings.

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

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Policies > Network Discovery > Custom Topology

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}

Permissions: Policies > Network Discovery > Custom Topology > Modify Custom Topology

POST ecmpzones

Request Type: POST

Description: Creates an ECMP Zone.

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

Permissions: Policies > Network Discovery > Custom Topology > Modify Custom Topology

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}

Permissions: Policies > Network Discovery > Custom Topology > Modify Custom Topology

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}

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management > Modify Devices

POST eigrproutes

Request Type: POST

Description: Creates an EIGRP.

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

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management > Modify Devices

GET etherchannelinterfaces

Request Type: GET

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

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

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

Permissions: Devices > Device Management

Parameters available for filtering:

PUT etherchannelinterfaces

Request Type: PUT

Description: Modifies an ethernet channel interfaces on the specified device.

URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{containerUUID}/ethernetchannelinterfaces/

Permissions: Devices > Device Management > Modify Device

POST etherchannelinterfaces

Request Type: POST

Description: Creates ethernet channel interfaces on the specified device.

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

Permissions: Devices > Device Management > Modify Device

DELETE etherchannelinterfaces

Request Type: DELETE

Description: Removes ethernet channel interfaces from a specified device.

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

Permissions: Devices > Device Management

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

Permissions: System > Tools > Import/Export

GET fpinterfacestatistics

Request Type: GET

Description: Retrieves list of statistics for all interfaces associated with the specified NGIPS device ID.

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

Permissions: Devices > Device Management

Parameters available for filtering: name

GET fplogicalinterfaces

Request Type: GET

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

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

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

Permissions: Devices > Device Management

Parameters available for filtering: name

PUT fplogicalinterfaces

Request Type: PUT

Description: Modifies a logical interface on the specified device.

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

Permissions: Devices > Device Management > Modify Device

POST fplogicalinterfaces

Request Type: POST

Description: Creates logical interfaces on the specified device.

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

Permissions: Devices > Device Management > Modify Device

DELETE fplogicalinterfaces

Request Type: DELETE

Description: Deletes logical interfaces on the specified device.

URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{containerUUID}/ fplogicalinterfaces/{object_UUID}

Permissions: Devices > Device Management > Modify Device

GET fpphysicalinterfaces

Request Type: GET

Description: Retrieves information on the physical interface associated with the specified NGIPS device ID and interface ID. If no ID is specified, retrieves list of all physical interfaces associated with the specified NGIPS device ID.

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

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

Permissions: Devices > Device Management

Parameters available for filtering: name

PUT fpphysicalinterfaces

Request Type: PUT

Description: Modifies a physical interface on the specified device.

URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{containerUUID}/fpphysicalinterfaces/{object_UUID}

Permissions: Devices > Device Management > Modify Device

GET ftdallinterfaces

Request Type: GET

Description: Retrieves all types of interfaces.

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

Permissions: Devices > Device Management

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

Permissions: System > Tools > Import/Export

GET inlinesets

Request Type: GET

Description: Retrieves information on the inline set associated with the specified NGIPS device ID and inline set ID. If no inline set ID is specified, retrieves list of all inline sets associated with the specified NGIPS device ID.

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

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

Permissions: Devices > Device Management

Parameters available for filtering: name

PUT inlinesets

Request Type: PUT

Description: Modifies an inline set on the specified device.

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

Permissions: Devices > Device Management > Modify Device

POST inlinesets

Request Type: POST

Description: Creates inline sets on the specified device.

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

Permissions: Devices > Device Management > Modify Device

DELETE inlinesets

Request Type: DELETE

Description: Deletes inline sets on the specified device.

URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{containerUUID}/inlinesets/{object_UUID}

Permissions: Devices > Device Management > Modify Device

GET interfaceevents

Request Type: GET

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

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

Permissions: Devices > Device Management

POST interfaceevents

Request Type: POST

Description: Creates netmod events on the specified device.

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

Permissions: Devices > Device Management > Modify Device

GET ipv4staticroutes

Request Type: GET

Description: Retrieves the IPv4 Static Route associated with the specified ID. If no ID is specified, retrieves list of all IPv4 Static Routes.

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

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

Permissions: Devices > Devices Management

PUT ipv4staticroutes

Request Type: PUT

Description: Modifies the IPv4 Static Route associated with the specified ID.

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

Permissions: Devices > Devices Management > Modify Devices

POST ipv4staticroutes

Request Type: POST

Description: Creates an IPv4 Static Route.

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

Permissions: Devices > Device Management > Modify Devices

DELETE ipv4staticroutes

Request Type: DELETE

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

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

Permissions: Devices > Devices Management > Modify Devices

GET ipv6staticroutes

Request Type: GET

Description: Retrieves the IPv6 Static Route associated with the specified ID. If no ID is specified, retrieves list of all IPv6 Static Routes.

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

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

Permissions: Devices > Device Management

PUT ipv6staticroutes

Request Type: PUT

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

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

Permissions: Devices > Device Management > Modify Devices

POST ipv6staticroutes

Request Type: POST

Description: Creates an IPv6 Static Route.

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

Permissions: Devices > Device Management > Modify Devices

DELETE ipv6staticroutes

Request Type: DELETE

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

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

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management > Modify Devices

POST loopbackinterfaces

Request Type: POST

Description: Creates a loopback interface.

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

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management

POST managementconvergencemode

Request Type: POST

Description: Sets the convergence state of the device.

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

Permissions: Devices > Device Management > Modify Devices

GET Metrics

Request Type: GET

Description: Retrieves HealthMonitor metrics for the device.

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

Permissions: Devices > Device Management

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

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management

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

Permissions: Devices > Troubleshoot > Packet Tracer > Modify Packet Tracer

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

Permissions: Devices > Troubleshoot > Packet Capture > Modify Packet Capture

GET physicalinterfaces

Request Type: GET

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

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

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

Permissions: Devices > Device Management

PUT physicalinterfaces

Request Type: PUT

Description: Modifies physical interfaces on a specified device.

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

Permissions: Devices > Device Management > Modify Device

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

Permissions: Devices > Device Management

PUT policybasedroutes

Request Type: PUT

Description: Modifies the Policy Based Route.

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

Permissions: Devices > Device Management > Modify Devices

POST policybasedroutes

Request Type: POST

Description: Creates the Policy Based Route.

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

Permissions: Devices > Device Management > Modify Devices

DELETE policybasedroutes

Request Type: DELETE

Description: Deletes the Policy Based Route.

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

Permissions: Devices > Device Management > Modify Devices

GET redundantinterfaces

Request Type: GET

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

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

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

Permissions: Devices > Device Management

PUT redundantinterfaces

Request Type: PUT

Description: Modifies redundant interfaces on a specified device.

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

Permissions: Devices > Device Management > Modify Device

POST redundantinterfaces

Request Type: POST

Description: Creates redundant interfaces on a specified device.

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

Permissions: Devices > Device Management

DELETE redundantinterfaces

Request Type: DELETE

Description: Removes redundant interfaces on a specified device.

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

Permissions: Devices > Device Management

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

Permissions: Devices > Device Management

GET subinterfaces

Request Type: GET

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

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

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

Permissions: Devices > Device Management

PUT subinterfaces

Request Type: PUT

Description: Modifies a sub interface on the specified device.

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

Permissions: Devices > Device Management > Modify Device

POST subinterfaces

Request Type: POST

Description: Creates sub interfaces on a specified device.

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

Permissions: Devices > Device Management

DELETE subinterfaces

Request Type: DELETE

Description: Deletes sub interfaces on a specified device.

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

Permissions: Devices > Device Management

GET virtualaccessinterfaces

Request Type: GET

Description: Retrieves the Virtual Access Interfaces on all the managed Firewall Threat Defenses.

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

Permissions: Devices > Device Management

Parameters available for filtering: dvtiId

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}

Permissions: Object Manager

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}

Permissions: Object Manager > Modify Objects

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

Permissions: Object Manager > Modify Objects

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}

Permissions: Object Manager > Modify Objects

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}

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management > Modify Devices

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

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Policies > Network Discovery > Custom Topology

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}

Permissions: Policies > Network Discovery > Custom Topology > Modify Custom Topology

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/

Permissions: Policies > Network Discovery > Custom Topology > Modify Custom Topology

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}

Permissions: Policies > Network Discovery > Custom Topology > Modify Custom Topology

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.

Permissions: Devices > Device Management

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.

Permissions: Devices > Device Management > Modify Device

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.

Permissions: Devices > Device Management > Modify Device

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.

Permissions: Devices > Device Management > Modify Device

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.

Permissions: Devices > Device Management

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.

Permissions: Devices > Device Management > Modify Device

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.

Permissions: Devices > Device Management > Modify Device

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.

Permissions: Devices > Device Management > Modify Device

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}

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management > Modify Devices

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

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management > Modify Device

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

Permissions: Devices > Device Management > Modify Device

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}

Permissions: Devices > Device Management > Modify Device

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}

Permissions: Devices > Device Management

GET virtualswitches

Request Type: GET

Description: Retrieves virtual switch associated with the specified NGIPS device ID and virtual switch ID. If no virtual switch ID is specified, retrieves list of all virtual switches associated with the specified NGIPS device ID.

This method is only available on a Firepower 1010 device.

URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{containerUUID}/ virtualswitches

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

Permissions: Devices > Device Management

Parameters available for filtering: name

PUT virtualswitches

Request Type: PUT

Description: Modifies a virtual switch on the specified device.

This method is only available on a Firepower 1010 device.

URL: /api/fmc_config/v1/domain/{UUID}/devices/devicerecords/{containerUUID}/virtualswitches/{object_UUID}

Permissions: Devices > Device Management > Modify Device

POST virtualswitches

Request Type: POST

Description: Creates a virtual switch on the specified device.

This method is only available on a Firepower 1010 device.

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

Permissions: Devices > Device Management > Modify Device

DELETE virtualswitches

Request Type: DELETE

Description: Deletes a virtual switch on the specified device.

This method is only available on a Firepower 1010 device.

URL: /api/fmc_config/v1/domain/{domain_UUID}/devices/devicerecords/{containerUUID}/virtualswitches/{object_UUID}

Permissions: Devices > Device Management > Modify Device

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}

Permissions: Devices > VPN

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}

Permissions: Devices > VPN > Modify VPN

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

Permissions: Devices > VPN > Modify VPN

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}

Permissions: Devices > VPN > Modify VPN

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}

Permissions: Devices > VPN

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}

Permissions: Devices > VPN > Modify VPN

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

Permissions: Devices > VPN > Modify VPN

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}

Permissions: Devices > VPN > Modify VPN

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}

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management > Modify Devices

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

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management > Modify Devices

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

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management > Modify Devices

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

Permissions: System > Health > Health Policy

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

Permissions: System > Health > Health Policy > Modify Health Policy

GET Health Alerts

Request Type: GET

Description: Retrieves health alerts.

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

Permissions: System > Health > Health Events

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

Permissions: System > Health > Health Events

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

GET pathmonitoredinterfaces

Request Type: GET

Description: Retrieves the path monitored interfaces.

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

Permissions: System > Health

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}

Permissions: Devices > VPN

POST terminateravpnsessions

Request Type: POST

Description: Terminates Remote Access VPN Sessions.

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

Permissions: Devices > VPN > Modify VPN

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

Permissions: System > Health > Health Events

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

Permissions: Devices > Device Management

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

Permissions: Devices > Device Management

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

Permissions: System > Tools > Backup Management

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}

Permissions: System > Tools > Backup Management

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}

Permissions: System > Tools > Backup Management

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}

Permissions: System > Tools > Backup Management

Chassis

GET appinfo

Request Type: GET

Description: Retrieves all the Image versions available for instance creation on the chassis.

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

Permissions: Devices > Device Management

POST breakoutinterfaces

Request Type: POST

Description: Break interface.

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

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management

GET chassisinterfaceevents

Request Type: GET

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

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

Permissions: Devices > Device Management

POST chassisinterfaceevents

Request Type: POST

Description: Creates a netmod event on the device.

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

Permissions: Devices > Device Management > Modify Devices

GET etherchannelinterfaces

Request Type: GET

Description: Retrieves the Chassis Etherchannel interfaces configuration associated with the ID. If no ID is specified, retrieves list of all Etherchannel interface configurations.

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

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

Permissions: Devices > Device Management

PUT etherchannelinterfaces

Request Type: PUT

Description: Modifies the specified Chassis EtherChannel interface configuration.

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

Permissions: Devices > Device Management > Modify Devices

POST etherchannelinterfaces

Request Type: POST

Description: Creates an Etherchannel interfaces configuration.

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

Permissions: Devices > Device Management > Modify Devices

DELETE etherchannelinterfaces

Request Type: DELETE

Description: Deletes the specified Chassis EtherChannel interface configuration.

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

Permissions: Devices > Device Management > Modify Devices

GET evaluateoperation

Request Type: GET

Description: Validate interface usage.

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

Permissions: Devices > Device Management

GET faultsummary

Request Type: GET

Description: Retrieves Fault data from the chassis.

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

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management

POST fmcmanagedchassis

Request Type: POST

Description: Creates a chassis managed device on the Firewall Management Center.

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

Permissions: Devices > Device Management > Modify Devices

DELETE fmcmanagedchassis

Request Type: DELETE

Description: Deletes the specified chassis managed device on the Firewall Management Center.

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

Permissions: Devices > Device Management > Modify Devices

GET instancesummary

Request Type: GET

Description: Retrieves Instance summary data from the chassis.

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

Permissions: Devices > Device Management

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}

Permissions: Devices > Device Management

GET interfacesummary

Request Type: GET

Description: Retrieves Interface summary data from the chassis.

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

Permissions: Devices > Device Management

GET inventorysummary

Request Type: GET

Description: Retrieves Inventory summary data from the chassis.

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

Permissions: Devices > Device Management

POST joininterfaces

Request Type: POST

Description: Join interfaces.

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

Permissions: Devices > Device Management > Modify Devices

GET logicaldevices

Request Type: GET

Description: Retrieves the logical device associated with the specified ID. If no ID is specified, retrieves the list of all logical devices available on the specified chassis.

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

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

Permissions: Devices > Device Management

PUT logicaldevices

Request Type: PUT

Description: Modifies the specified logical devices.

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

Permissions: Devices > Device Management > Modify Devices

POST logicaldevices

Request Type: POST

Description: Creates a logical device on the specified chassis.

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

Permissions: Devices > Device Management > Modify Devices

DELETE logicaldevices

Request Type: DELETE

Description: Deletes the specified logical device.

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

Permissions: Devices > Device Management > Modify Devices

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}

Permissions: Devices > Device Management

PUT networkmodules

Request Type: PUT

Description: Modifies the specified network modules.

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

Permissions: Devices > Device Management > Modify Devices

GET physicalinterfaces

Request Type: GET

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

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

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

Permissions: Devices > Device Management

PUT physicalinterfaces

Request Type: PUT

Description: Modifies the chassis physical interface associated with the specified ID.

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

Permissions: Devices > Device Management> Modify Devices

GET snmpsettings

Request Type: GET

Description: Retrieves the specified SNMP settings policy associated with the ID. If no ID is specified, retrieves all SNMP settings policies for particular chassis .

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

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

Permissions: Devices > Device Management

PUT snmpsettings

Request Type: PUT

Description: Modifies the specified SNMP settings policy.

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

Permissions: Devices > Device Management > Modify Devices

GET subinterfaces

Request Type: GET

Description: Retrieves the Chassis Sub interface configuration associated with the ID. If no ID is specified, retrieves list of all Chassis Sub interface configurations.

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

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

Permissions: Devices > Device Management

PUT subinterfaces

Request Type: PUT

Description: Modifies the specified Chassis Sub interface configuration.

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

Permissions: Devices > Device Management > Modify Devices

POST subinterfaces

Request Type: POST

Description: Creates a Chassis Sub interface configuration.

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

Permissions: Devices > Device Management > Modify Devices

DELETE subinterfaces

Request Type: DELETE

Description: Deletes the specified Chassis Sub interface configuration.

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

Permissions: Devices > Device Management > Modify Devices

POST switchmode

Request Type: POST

Description: Operational API to convert a Chassis Mode from Native to Multi-Instance.

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

Permissions: Deploy Configuration to Devices

PUT syncnetworkmodule

Request Type: PUT

Description: Retrieve Network module data from FXOS and updates.

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

Permissions: Devices > Device Management > Modify Devices

Intelligence Services

POST collections

Request Type: POST

Description: Adds a collections from a TAXII source.

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

Permissions: Intelligence

POST discoveryinfo

Request Type: POST

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

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

Permissions: Intelligence

GET element

Request Type: GET

Description: Retrieves the intelligence-enabled sensor associated with the specified ID. If no ID is specified, retrieves list of all intelligence-enabled sensors.

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

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

Permissions: Intelligence

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}

Permissions: Intelligence

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}

Permissions: Intelligence

DELETE incident

Request Type: DELETE

Description: Deletes an incident.

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

Permissions: Intelligence

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}

Permissions: Intelligence

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}

Permissions: Intelligence

GET observable

Request Type: GET

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


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}

Permissions: Intelligence

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}

Permissions: Intelligence

GET settings

Request Type: GET

Description: Retrieves the on/off settings for the specified value. If no ID is specified, retrieves list of all TID settings.

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

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

Permissions: Intelligence

PUT settings

Request Type: PUT

Description: Activates or deactivates an intelligence setting.

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

Permissions: Intelligence

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

Permissions: Intelligence

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}

Permissions: Intelligence

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

Permissions: Intelligence

DELETE source

Request Type: DELETE

Description: Deletes an intelligence source from the device.

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

Permissions: Intelligence

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}

Permissions: System > Licenses > Smart Licenses

POST smartlicenses

Request Type: POST

Description: Updates device licenses.

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

Permissions: System > Licenses > Smart Licenses

GET devicelicenses

Request Type: GET

Description: Retrieves the Device Licenses.

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

Permissions: Devices > Device Management

PUT devicelicenses

Request Type: PUT

Description: Modifies the Device Licenses.

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

Permissions: Devices > Device Management > Modify Devices

Search

GET device

Request Type: GET

Description: Search for devices matching specified text.

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

Permissions: Devices

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

Permissions: Analysis > Search

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

Permissions: Analysis > Search

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

Permissions: Analysis > Search

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}

Permissions: Integration > Other Integrations > Cloud Services

POST cdfmcsnapshot

Request Type: POST

Description: Creates a cdfmcsnapshot object.

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

Permissions: Integration > Other Integrations > Cloud Services

GET cloudeventsconfigs

Request Type: GET

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

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

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

Permissions: Object Manager

PUT cloudeventsconfigs

Request Type: PUT

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

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

Permissions: Object Manager > Modify Object Manager

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

Permissions: System > Integration > Cloud Services

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}

Permissions: System > Integration > Cloud Services

GET datacenters

Request Type: GET

Description: Retrieves list of all the Umbrella data centers.

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

Permissions: Integration > Security Analytics & Logging

GET dynamicattributesfeeds

Request Type: GET

Description: Retrieves Dynamic Attributes Feeds.

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

Permissions: Devices > VPN

PUT dynamicattributesfeeds

Request Type: PUT

Description: Updates Dynamic Attributes Feeds.

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

Permissions: Devices > VPN > Modify VPN

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}

Permissions: Integration > Other Integrations

POST ebssnapshot

Request Type: POST

Description: Creates an EBS snapshot..

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

Permissions: Integration > Other Integrations

GET externallookups

GET externallookups

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

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

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

Permissions: Object Manager>Modify Object Manager

Parameters available for filtering:

PUT externallookups

Request Type: PUT

Description: Modifies externallookups objects.

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

Permissions: Object Manager>Modify Object Manager

POST externallookups

POST externallookups

Description: Creates externallookups objects with the specified parameters.

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

Permissions: Object Manager>Modify Object Manager

DELETE externallookups

DELETE externallookups

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

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

Permissions: Object Manager>Modify Object Manager

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}

Permissions: System > Integration

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}

Permissions: System > Integration

GET FMC HA Statuses

Request Type: GET

Description: Retrieves management center HA Statuses.

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

Permissions: System>Integration>High Availability

GET packetanlyzerdevices

Request Type: GET

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

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

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

Permissions: Object Manager>Modify Object Manager

Parameters available for filtering:

PUT packetanalyzerdevices

Request Type: PUT

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

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

Permissions: Object Manager>Modify Object Manager

POST packetanalyzerdevices

Request Type: POST

Description: Creates PKI enrollments objectswith the specified parameters.

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

Permissions: Object Manager

DELETE packetanalyzerdevices

Request Type: DELETE

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

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

Permissions: Object Manager>Modify Object Manager

POST refreshsecurexconfigs

Request Type: POST

Description: Refresh SecureX configurations.

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

Permissions: Integration > SecureX

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}

Permissions: System>SecureX

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}

Permissions: System>SecureX

POST testumbrellaconnections

Request Type: POST

Description: Tests connection to the umbrella cloud.

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

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

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}

Permissions: Integration > Security Analytics & Logging

GET tunneldeployments

Request Type: GET

Description: Retrieves Tunnel deployment data on Umbrella.

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

Permissions: Devices > VPN

POST tunneldeployments

Request Type: POST

Description: Creates a tunnel deployment.

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

Permissions: Devices > VPN > Modify VPN

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}

Permissions: Devices > VPN

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}

Permissions: Policies > Access Control > DNS Policy > Umbrella DNS Policy

PUT umbrellaconnections

Request Type: PUT

Description: Modifies the specified Umbrella connections configuration.

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

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

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

Permissions: Object Manager

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}

Permissions: Object Manager > Modify Object Manager

POST AnyConnect Custom Attributes

Request Type: POST

Description: Creates an AnyConnect Custom Attribute.

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

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager

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}

Permissions: Object Manager > Modify Object Manager

POST anyconnectpackages

Request Type: POST

Description: Creates an anyconnectpackages object.

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

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager

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}

Permissions: Object Manager > Modify Object Manager

POST anyconnectexternalbrowserpackages

Request Type: POST

Description: Creates an AnyConnect External Browser Package.

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

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager > Modify Object Manager

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

Permissions: Object Manager

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}

Permissions: Object Manager > Modify Object Manager

POST anyconnectprofiles

Request Type: POST

Description: Creates an AnyConnect Profile.

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

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager > Modify Object Manager

GET anyprotocolportobjects

Request Type: GET

Description: Retrieves the any protocol port object associated with the specified ID. If no ID is specified, retrieves list of all protocol port objects with the protocol set to All.

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

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

Permissions: Object Manager

GET applicationcategories

Request Type: GET

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

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

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

Permissions: Object Manager

GET applicationfilters

Request Type: GET

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

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

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

Permissions: Object Manager

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}

Permissions: Object Manager > Modify Object Manager > Modify Object Manager

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

Permissions: Object Manager > Modify Object Manager > Modify Object Manager

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}

Permissions: Object Manager > Modify Object Manager > Modify Object Manager

GET applicationproductivities

Request Type: GET

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

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

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

Permissions: Object Manager

GET applicationrisks

Request Type: GET

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

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

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

Permissions: Object Manager

GET applications

Request Type: GET

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

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

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

Permissions: Object Manager

GET applicationtags

Request Type: GET

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

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

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

Permissions: Object Manager

GET applicationtypes

Request Type: GET

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

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

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

Permissions: Object Manager

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

Permissions: Object Manager

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}

Permissions: Object Manager > Modify Object Manager

POST aspathlists

Request Type: POST

Description: Creates an AsPath List object.

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

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager

PUT azureadrealms

Request Type: PUT

Description: Modifies the specified Azure AD realms.

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

Permissions: Object Manager > Modify Object Manager

POST azureadrealms

Request Type: POST

Description: Creates an Azure AD Realm.

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

Permissions: Object Manager > Modify Object Manager

DELETE azureadrealms

Request Type: DELETE

Description: Deletes the specified Azure AD realm.

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

Permissions: Object Manager > Modify Object Manager

GET azureadstatuses

Request Type: GET

Description: Retrieves Azure AD realm statuses.

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

Permissions: Object Manager

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}

Permissions: Object Manager

PUT bfdtemplates

Request Type: PUT

Description: Modifies the specified bi-directional forwarding template.

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

Permissions: Object Manager > Modify Objects

POST bfdtemplates

Request Type: POST

Description: Creates a bi-directional forwarding template..

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

Permissions: Object Manager > Modify Objects

DELETE bfdtemplates

Request Type: DELETE

Description: Deletes the specified bi-directional forwarding template.

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

Permissions: Object Manager > Modify Objects

POST bulkdynamicobjects

Request Type: POST

Description: Adds Dynamic Object Mappings for specific Dynamic Objects.

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

Permissions: Devices > VPN > Modify VPN

GET certenrollments

Request Type: GET

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

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

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

Permissions: Devices > Device Management > View Devices

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}

Permissions: Devices > VPN > Modify VPN

POST certenrollments

Request Type: POST

Description: Creates a the Certificate Enrollment.

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

Permissions: Devices > VPN > Modify VPN

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}

Permissions: Devices > VPN > Modify VPN

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}

Permissions: Devices > Certificates

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}

Permissions: Devices > VPN > Modify VPN

POST certificatemaps

Request Type: POST

Description: Creates a Certificate Map.

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

Permissions: Devices > VPN > Modify VPN

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}

Permissions: Devices > VPN > Modify VPN

GET ciphersuitelists

Request Type: GET

Description: Retrieves cipher suite lists.

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

Permissions: Object Manager

POST ciphersuitelists

Request Type: POST

Description: Creates a cipher suite list.

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

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager

GET continents

Request Type: GET

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

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

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

Permissions: Object Manager

GET countries

Request Type: GET

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

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

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

Permissions: Object Manager

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

Permissions: Integration > Intelligence

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}

Permissions: Integration > Intelligence

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}

Permissions: Integration > Intelligence

POST customsiiplists

Request Type: POST

Description: Creates a custom Security Intelligence Network List object.

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

Permissions: Integration > Intelligence

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}

Permissions: Integration > Intelligence

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}

Permissions: Integration > Intelligence

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}

Permissions: Integration > Intelligence

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}

Permissions: Integration > Intelligence

POST customsiurllists

Request Type: POST

Description: Creates a custom Security Intelligence URL List object.

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

Permissions: Integration > Intelligence

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}

Permissions: Integration > Intelligence

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}

Permissions: Object Manager

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}

Permissions: Object Manager > Modify Object Manager

POST dhcpipv6pools

Request Type: POST

Description: Creates a DHCP IPv6 pool object.

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

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager > Modify Object Manager

GET distinguishednamegroups

Request Type: GET

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

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

Permissions: Devices > Certificates > Modify Certificates

GET distinguishednames

Request Type: GET

Description: Retrieves distinguished name objects.

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

Permissions: Devices > Certificates

POST distinguishednames

Request Type: POST

Description: Creates a distinguished names object.

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

Permissions: Devices > Certificates > Modify Certificates

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

Permissions: Devices > Device Management > View Devices

PUT dnsservergroups

Request Type: PUT

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

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

Permissions: Devices > Device Management > Modify Devices

POST dnsservergroups

Request Type: POST

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

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

Permissions: Devices > Device Management > Modify Devices

DELETE dnsservergroups

Request Type: DELETE

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

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

Permissions: Devices > Device Management > Modify Devices

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

Permissions: Object Manager

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

Permissions: Devices > Certificates > Modify Certificates

POST dynamicobjectmappings

Request Type: POST

Description: Adds Dynamic Object Mappings for specific Dynamic Objects

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

Permissions: Object Manager > Modify Object Manager

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

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager

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}

Permissions: Object Manager > Modify Object Manager

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

Permissions: Object Manager > Modify Object Manager

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

Permissions: Object Manager > Modify Object Manager

GET endpointdevicetypes

Request Type: GET

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

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

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

Permissions: Object Manager

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

Permissions: Object Manager

PUT expandedcommunitylists

Request Type: PUT

Description: Modifies the specified expanded community list.

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

Permissions: Object Manager > Modify Object Manager

POST expandedcommunitylists

Request Type: POST

Description: Creates an expanded community lists.

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

Permissions: Object Manager > Modify Object Manager

DELETE expandedcommunitylists

Request Type: DELETE

Description: Deletes the specified expanded community lists.

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

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Devices > Device Management > View Devices

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}

Permissions: Object Manager > Modify Object Manager

POST extendedaccesslists

Request Type: POST

Description: Creates an extended access lists.

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

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager

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}

Permissions: Object Manager > Modify Object Manager

POST extendedcommunitylists

Request Type: POST

Description: Creates an extended community list.

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

Permissions: Object Manager > Modify Object Manager

DELETE extendedcommunitylists

Request Type: DELETE

Description: Deletes extended community list with the specified ID.

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

Permissions: Object Manager > Modify Object Manager

GET externalcacertificategroups

Request Type: GET

Description: Retrieves the list of all trusted CA groups.

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

Permissions: Devices > Certificates

GET externalcacertificates

Request Type: GET

Description: Retrieves trusted CA objects.

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

Permissions: Devices > Certificates

POST externalcacertificates

Request Type: POST

Description: Creates a trusted CA object.

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

Permissions: Devices > Certificates > Modify Certificates

GET externalcertificategroups

Request Type: GET

Description: Retrieves list of all the external certificate groups.

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

Permissions: Devices > Certificates

GET externalcertificates

Request Type: GET

Description: Retrieves external certificate objects.

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

Permissions: Devices > Certificates

POST externalcertificates

Request Type: POST

Description: Creates an external certificates object.

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

Permissions: Devices > Certificates > Modify Certificates

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}

Permissions: Analysis > Files

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}

Permissions: Analysis > Files

POST findoverlaps

Request Type: POST

Description: Retrieve overlaps for the given network objects/literals and port objects/literals.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/operational/findoverlaps

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}

Permissions: Object Manager

PUT fqdns

Request Type: PUT

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

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

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

Permissions: Object Manager > Modify Object Manager

POST fqdns

Request Type: POST

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

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

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

Permissions: Object Manager > Modify Object Manager

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/

Permissions: Object Manager > Modify Object Manager

GET geolocation

Request Type: GET

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

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

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

Permissions: Object Manager

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}

Permissions: Object Manager > Modify Object Manager

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

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager

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}

Permissions: Devices > VPN

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}

Permissions: Devices > VPN > Modify VPN

POST grouppolicies

Request Type: POST

Description: Creates a VPN group policy

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

Permissions: Devices > VPN > Modify VPN

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}

Permissions: Devices > VPN > Modify VPN

GET hosts

Request Type: GET

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

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

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

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

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

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

Permissions: Object Manager

PUT hosts

Request Type: PUT

Description: Modifies a host object.

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

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

Permissions: Object Manager > Modify Object Manager

POST hosts

Request Type: POST

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

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

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

Permissions: Object Manager > Modify Object Manager

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/

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Devices

PUT hostscanpackages

Request Type: PUT

Description: Modifies the HostScan package with the specified ID.

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

Permissions: Devices > Device Management > Modify Devices

POST hostscanpackages

Request Type: POST

Description: Creates a HostScan package.

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

Permissions: Devices > Device Management > Modify Devices

DELETE hostscanpackages

Request Type: DELETE

Description: Deletes the HostScan package with the specified ID.

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

Permissions: Devices > Device Management > Modify Devices

GET icmpv4objects

Request Type: GET

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

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

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

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

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

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

Permissions: Object Manager

PUT icmpv4objects

Request Type: PUT

Description: Modifies ICMPv4 port objects.

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

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

Permissions: Object Manager > Modify Object Manager

POST icmpv4objects

Request Type: POST

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

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

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

Permissions: Object Manager > Modify Object Manager

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/

Permissions: Object Manager > Modify Object Manager

GET icmpv6objects

Request Type: GET

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

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

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

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

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

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

Permissions: Object Manager

PUT icmpv6objects

Request Type: PUT

Description: Modifies ICMPv6 port objects.

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

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

Permissions: Object Manager > Modify Object Manager

POST icmpv6objects

Request Type: POST

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

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

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

Permissions: Object Manager > Modify Object Manager

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/

Permissions: Object Manager > Modify Object Manager

GET ikev1ipsecproposals

Request Type: GET

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

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

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

Permissions: Object Manager

PUT ikev1ipsecproposals

Request Type: PUT

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

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

Permissions: Object Manager > Modify Object Manager

POST ikev1ipsecproposals

Request Type: POST

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

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

Permissions: Object Manager > Modify Object Manager

DELETE ikev1ipsecproposals

Request Type: DELETE

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

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

Permissions: Object Manager > Modify Object Manager

GET ikev1policies

Request Type: GET

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

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

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

Permissions: Object Manager

PUT ikev1policies

Request Type: PUT

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

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

Permissions: Object Manager > Modify Object Manager

POST ikev1policies

Request Type: POST

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

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

Permissions: Object Manager > Modify Object Manager

DELETE ikev1policies

Request Type: DELETE

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

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

Permissions: Object Manager > Modify Object Manager

GET ikev2ipsecproposals

Request Type: GET

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

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

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

Permissions: Object Manager

PUT ikev2ipsecproposals

Request Type: PUT

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

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

Permissions: Object Manager > Modify Object Manager

POST ikev2ipsecproposals

Request Type: POST

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

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

Permissions: Object Manager > Modify Object Manager

DELETE ikev2ipsecproposals

Request Type: DELETE

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

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

Permissions: Object Manager > Modify Object Manager

GET ikev2policies

Request Type: GET

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

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

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

Permissions: Object Manager

PUT ikev2policies

Request Type: PUT

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

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

Permissions: Object Manager > Modify Object Manager

POST ikev2policies

Request Type: POST

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

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

Permissions: Object Manager > Modify Object Manager

DELETE ikev2policies

Request Type: DELETE

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

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

Permissions: Object Manager > Modify Object Manager

GET interfacegroups

Request Type: GET

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

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

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

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

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

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

Permissions: Object Manager

PUT interfacegroups

Request Type: PUT

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

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

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

Permissions: Object Manager > Modify Object Manager

POST interfacegroups

Request Type: POST

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

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

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

Permissions: Object Manager > Modify Object Manager

DELETE interfacegroups

Request Type: DELETE

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

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

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

Permissions: Object Manager > Modify Object Manager

GET interfaceobjects

Request Type: GET

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

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

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

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

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

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

Permissions: Object Manager

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

Permissions: Devices > Certificates

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}

Permissions: Devices > Certificates > Modify Certificates

POST internalcas

Request Type: POST

Description: Creates an Internal CA.

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

Permissions: Devices > Certificates > Modify Certificates

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}

Permissions: Devices > Certificates > Modify Certificates

GET internalcertgroups

Request Type: GET

Description: Retrieves the list of all Internal Certificate Groups.

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

Permissions: Object Manager

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}

Permissions: Devices > Certificates

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}

Permissions: Devices > Certificates > Modify Certificates

POST internalcertificates

Request Type: POST

Description: Creates an Internal Certificate.

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

Permissions: Devices > Certificates > Modify Certificates

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}

Permissions: Devices > Certificates > Modify Certificates

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}

Permissions: Policies > Access Control > Intrusion Policy

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}

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

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

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

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}

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

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}

Permissions: Policies > Access Control > Intrusion Policy

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}

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

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

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

DELETE intrusionrules

Request Type: DELETE

Description: Deletes the specified Snort3 rule.

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

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

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}

Permissions: Object Manager

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}

Permissions: Object Manager > Modify Object Manager

POST ipv4addresspools

Request Type: POST

Description: Creates an IPv4 Address Pool object.

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

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager

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}

Permissions: Object Manager > Modify Object Manager

POST ipv6addresspools

Request Type: POST

Description: Creates an IPv6 Address Pool object.

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

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager

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}

Permissions: Object Manager > Modify Object Manager

POST ipv4prefixlists

Request Type: POST

Description: Creates an IPv4 Prefix List.

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

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager

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}

Permissions: Object Manager > Modify Object Manager

POST ipv6prefixlists

Request Type: POST

Description: Creates an IPv6 Prefix List.

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

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager > Modify Object Manager

GET isesecuritygrouptags

Request Type: GET

Description: Retrieves the ISE security group tag object with the specified ID. If no ID is specified, retrieves list of all ISE security group tag objects.

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

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

Permissions: Object Manager

GET keychain

Request Type: GET

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

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

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

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

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

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

Note

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

Permissions: Object Manager

PUT keychain

Request Type: PUT

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

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

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

Permissions: Object Manager > Modify Object Manager

POST keychain

Request Type: POST

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

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

URL for Bulk Post:

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

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

Attention

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

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

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

Permissions: Object Manager > Modify Object Manager

DELETE keychain

Request Type: DELETE

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

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

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

Note

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

Permissions: Object Manager > Modify Object Manager

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}

Permissions: System > Integration > Realms

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}

Permissions: System > Integration > Realms > Modify Realms

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

Permissions: System > Integration > Realms > Modify Realms

POST localrealmusers

Request Type: DELETE

Description: Deletes the specified local realm user object.

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

Permissions: Object Manager > Modify Object Manager

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

Permissions: Object Manager

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

Permissions: Object Manager > Modify Object Manager

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

Permissions: Object Manager > Modify Object Manager

GET networkaddresses

Request Type: GET

Description: Retrieves list of all network and host objects.

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

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}

Permissions: Object Manager

GET networkgroups

Request Type: GET

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

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

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

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

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

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

Permissions: Object Manager

PUT networkgroups

Request Type: PUT

Description: Modifies a Network Group.

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

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

Permissions: Object Manager > Modify Object Manager

POST networkgroups

Request Type: POST

Description: Creates or overrides the network group with the specified parameters.

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

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

Permissions: Object Manager > Modify Object Manager

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/

Permissions: Object Manager > Modify Object Manager

GET networks

Request Type: GET

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

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

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

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

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

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

Permissions: Object Manager

PUT networks

Request Type: PUT

Description: Modifies network objects.

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

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

Permissions: Object Manager > Modify Object Manager

POST networks

Request Type: POST

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

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

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

Permissions: Object Manager > Modify Object Manager

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/

Permissions: Object Manager > Modify Object Manager

GET ntpservers

Request Type: GET

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

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

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

Permissions: Object Manager

PUT ntpservers

Request Type: PUT

Description: Modifies the specified NTP Server object.

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

Permissions: Object Manager > Modify Object Manager

POST ntpservers

Request Type: POST

Description: Creates an NTP Server object.

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

Permissions: Object Manager > Modify Object Manager

DELETE ntpservers

Request Type: DELETE

Description: Deletes the NTP Server object associated with the specified ID.

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

Permissions: Object Manager > Modify Object Manager

POST overlaps

Request Type: POST

Description: Creates an overlaps object.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/operational/overlaps

Permissions: Object Manager > Modify Object Manager

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

Permissions: Devices > Troubleshoot > Packet Capture

POST packettracerpcapupload

Request Type: POST

Description: Imports a PCAP file from Packet Tracer.

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

Permissions: Devices > Troubleshoot > Packet Capture > Modify Packet Capture

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}

Permissions: Object Manager

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}

Permissions: Object Manager > Modify Objects

POST policylists

Request Type: POST

Description: Creates a Policy List.

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

Permissions: Object Manager > Modify Objects

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}

Permissions: Object Manager > Modify Objects

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}

Permissions: Object Manager

PUT portobjectgroups

Request Type: PUT

Description: Modifies port object groups.

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

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

Permissions: Object Manager > Modify Object Manager

POST portobjectgroups

Request Type: POST

Description: Creates or overrides the port object groups with the specified parameters.

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

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

Permissions: Object Manager > Modify Object Manager

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/

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager

GET protocolportobjects

Request Type: GET

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

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

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

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

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

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

Permissions: Object Manager

PUT protocolportobjects

Request Type: PUT

Description: Modifies protocol port objects.

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

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

Permissions: Object Manager > Modify Object Manager

POST protocolportobjects

Request Type: POST

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

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

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

Permissions: Object Manager > Modify Object Manager

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/

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager

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}

Permissions: Object Manager > Modify Object Manager

POST radiusservergroups

Request Type: POST

Description: Creates a Radius Server Group.

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

Permissions: Object Manager > Modify Object Manager

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}

Permissions: Object Manager > Modify Object Manager

GET ranges

Request Type: GET

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

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

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

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

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

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

Permissions: Object Manager

PUT ranges

Request Type: PUT

Description: Modifies an address range.

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

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

Permissions: Object Manager > Modify Object Manager

POST ranges

Request Type: POST

Description: Creates or overrides an address range with the specified parameters.

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

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

Permissions: Object Manager > Modify Object Manager

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/

Permissions: Object Manager > Modify Object Manager

GET realms

Request Type: GET

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

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

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

Permissions: System > Integration > Realms

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}

Permissions: System > Integration > Realms > Modify Realms

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

Permissions: System > Integration > Realms > Modify Realms

DELETE realms

Request Type: DELETE

Description: Deletes the specified realm object.

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

Permissions: System > Integration > Realms > Modify Realms

GET realmusergroups

Request Type: GET

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

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

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

Permissions: Object Manager

Parameters available for filtering: realmUuid


Note

This is a required parameter.

GET realmusers

Request Type: GET

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

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

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

Permissions: Object Manager

Parameters available for filtering: realmUuid


Note

This is a required parameter.

GET resourceprofiles

Request Type: GET

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

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

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

Permissions: Object Manager

PUT resourceprofiles

Request Type: PUT

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

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

Permissions: Object Manager > Modify Object Manager

POST resourceprofiles

Request Type: POST

Description: Creates a ResourceProfile object.

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

Permissions: Object Manager > Modify Object Manager

DELETE resourceprofiles

Request Type: DELETE

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

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

Permissions: Object Manager > Modify Object Manager

GET route maps

Request Type: GET

Description: Retrieves the route map associated with the specified ID. If no ID is specified, retrieves list of all rooute maps.

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

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

Permissions: Object Manager

PUT routemaps

Request Type: PUT

Description: Modifies the RouteMap with the specified ID.

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

Permissions: Object Manager > Modify Objects

POST routemaps

Request Type: POST

Description: Creates a RouteMap.

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

Permissions: Object Manager > Modify Objects

DELETE routemaps

Request Type: DELETE

Description: Deletes the RouteMap with the specified ID.

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

Permissions: Object Manager > Modify Objects

GET secureclientcustomizations

Request Type: GET

Description: Retrieves Secure Client Customization with the specified ID. If no ID is specified, retrieves list of all AnyConnect Customization Objects.

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

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

Permissions: Object Manager

PUT secureclientcustomizations

Request Type: PUT

Description: Modifies the specified AnyConnect Customization object.

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

Permissions: Object Manager > Modify Object Manager

POST secureclientcustomizations

Request Type: POST

Description: Creates an AnyConnect Customization object.

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

Permissions: Object Manager > Modify Object Manager

DELETE secureclientcustomizations

Request Type: DELETE

Description: Deletes the specified AnyConnect Customization object.

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

Permissions: Object Manager > Modify Object Manager

GET securitygrouptags

Request Type: GET

Description: Retrieves the custom security group tag object associated with the specified ID. If no ID is specified, retrieves list of all custom security group tag objects.

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

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

Permissions: Object Manager

Parameters available for filtering: name

PUT securitygrouptags

Request Type: PUT

Description: Modifies the custom security group tag object associated with the specified ID.

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

Permissions: Object Manager > Modify Object Manager

DELETE securitygrouptags

Request Type: DELETE

Description: Deletes the custom security group tag object associated with the specified ID.

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

Permissions: Object Manager > Modify Object Manager

POST securitygrouptags

Request Type: POST

Description: Creates a custom security group tag object.

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

Permissions: Object Manager > Modify Object Manager

GET securityzones

Request Type: GET

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

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

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

Permissions: Object Manager

Parameters available for filtering: name

PUT securityzones

Request Type: PUT

Description: Modifies a securityzone object.

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

Permissions: Object Manager>Modify Object Manager

POST securityzones

Request Type: POST

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

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

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

Permissions: Object Manager > Modify Object Manager

DELETE securityzones

Request Type: DELETE

Description: Deletes the specified securityzone objects.

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

Permissions: Object Manager>Modify Object Manager

GET SI DNS Feeds

Request Type: GET

Description: Retrieves the Security Intelligence DNS feed objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all Security Intelligence DNS feed objects.

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

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

Permissions: Object Manager

GET SI DNS Lists

Request Type: GET

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

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

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

Permissions: Object Manager

GET sinetworkfeeds

Request Type: GET

Description: Retrieves the Security Intelligence Network Feed objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all Security Intelligence Network Feed objects.

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

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

Permissions: Object Manager

PUT sinetworkfeeds

Request Type: PUT

Description: Modifies the specified Security Intelligence network feed.

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

Permissions: Object Manager > Modify Object Manager

POST sinetworkfeeds

Request Type: POST

Description: Creates a Security Intelligence network feed.

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

Permissions: Object Manager > Modify Object Manager

DELETE sinetworkfeeds

Request Type: DELETE

Description: Deletes the specified Security Intelligence network feed.

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

Permissions: Object Manager > Modify Object Manager

GET SI Network Lists

Request Type: GET

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

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

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

Permissions: Object Manager

GET Sinkholes

Request Type: GET

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

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

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

Permissions: Object Manager

GET siurlfeeds

Request Type: GET

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

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

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

Permissions: Object Manager

PUT siurlfeeds

Request Type: PUT

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

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

Permissions: Object Manager > Modify Object Manager

POST siurlfeeds

Request Type: POST

Description: Creates a Security Intelligence URL Feed object.

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

Permissions: Object Manager > Modify Object Manager

DELETE siurlfeeds

Request Type: DELETE

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

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

Permissions: Object Manager > Modify Object Manager

GET siurllists

Request Type: GET

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

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

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

Permissions: Object Manager

PUT siurllists

Request Type: PUT

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

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

Permissions: Object Manager > Modify Object Manager

POST siurllists

Request Type: POST

Description: Creates a Security Intelligence URL List object.

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

Permissions: Object Manager > Modify Object Manager

DELETE siurllists

Request Type: DELETE

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

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

Permissions: Object Manager > Modify Object Manager

GET slamonitors

Request Type: GET

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

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

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

Permissions: Object Manager

PUT slamonitors

Request Type: PUT

Description: Modifies the sla monitor object associated with the specified ID.

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

Permissions: Object Manager > Modify Object Manager

POST slamonitors

Request Type: POST

Description: Creates or overrides a SLA monitor with the specified parameters.

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

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

Permissions: Object Manager > Modify Object Manager

DELETE slamonitors

Request Type: DELETE

Description: Deletes the sla monitor object associated with the specified ID.

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

Permissions: Object Manager > Modify Object Manager

GET SSO Servers

Request Type: GET

Description: Retrieves the SSO Server Policy Object associated with the specified ID. If no ID is specified, retrieves list of all SSO Server Policy Objects.

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

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

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

Permissions: System > User Management> Single Sign-On (SSO)

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

POST ssoservers

Request Type: POST

Description: Creates an SSO Server Policy Object.

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

Permissions: System > User Management> Single Sign-On (SSO)

PUT ssoservers

Request Type: PUT

Description: Modifies SSO Server Policy Object associated with the specified ID.

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

Permissions: System > User Management> Single Sign-On (SSO)

DELETE ssoservers

Request Type: DELETE

Description: Deletes SSO Server Policy Object associated with the specified ID.

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

Permissions: System > User Management> Single Sign-On (SSO)

GET standard access lists

Request Type: GET

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

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

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

Permissions: Object Manager

PUT standardaccesslists

Request Type: PUT

Description: Modifies the Standard Access List associated with the specified ID.

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

Permissions: Object Manager > Modify Objects

POST standardaccesslists

Request Type: POST

Description: Creates a Standard Access List.

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

Permissions: Object Manager > Modify Objects

DELETE standardaccesslists

Request Type: DELETE

Description: Deletes the Standard Access List associated with the specified ID.

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

Permissions: Object Manager > Modify Objects

GET standard community lists

Request Type: GET

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

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

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

Permissions: Object Manager

PUT standardcommunitylists

Request Type: PUT

Description: Modifies the Standard Community List associated with the specified ID.

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

Permissions: Object Manager > Modify Objects

POST standardcommunitylists

Request Type: POST

Description: Creates a Standard Community List.

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

Permissions: Object Manager > Modify Objects

DELETE standardcommunitylists

Request Type: DELETE

Description: Deletes the Standard Community List associated with the specified ID.

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

Permissions: Object Manager > Modify Objects

POST testazureadrealms

Request Type: POST

Description: Tests Azure AD Realm connectivity.

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

Permissions: Object Manager > Modify Object Manager

GET time ranges

Request Type: GET

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

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

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

Permissions: Object Manager

PUT time ranges

Request Type: PUT

Description: Modifies a time range object.

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

Permissions: Object Manager

POST time ranges

Request Type: POST

Description: Creates or overrides a time range object with the specified parameters.

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

Permissions: Object Manager > Modify Object Manager

DELETE time ranges

Request Type: DELETE

Description: Deletes the time range object associated with the specified ID.

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

Permissions: Object Manager > Modify Object Manager

GET time zone objects

Request Type: GET

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

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

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

URL to list all overrides: /api/fmc_config/v1/domain/{domainUUID}/object/timezoneobjects/{containerUUID}/overrides

Permissions: Object Manager

PUT time zone objects

Request Type: PUT

Description: Modifies a time zone object.

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

Permissions: Object Manager

POST time zone objects

Request Type: POST

Description: Creates or overrides a time zone object with the specified parameters.

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

Permissions: Object Manager > Modify Object Manager

DELETE time zone objects

Request Type: DELETE

Description: Deletes the time zone object associated with the specified ID.

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

Permissions: Object Manager > Modify Object Manager

GET tunneltags

Request Type: GET

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

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

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

Permissions: Object Manager

PUT tunneltags

Request Type: PUT

Description: Modifies the tunnel tag object associated with the specified ID.

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

Permissions: Object Manager > Modify Object Manager

POST tunneltags

Request Type: POST

Description: Creates or overrides a tunnel tag with the specified parameters.

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

Permissions: Object Manager > Modify Object Manager

DELETE tunneltags

Request Type: DELETE

Description: Deletes the tunnel tag object associated with the specified ID.

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

Permissions: Object Manager > Modify Object Manager

GET umbrellaprotectionpolicies

Request Type: GET

Description: Retrieves the umbrella protection policiy associated with the specified ID from the umbrella cloud. If no ID is specified, retrieves list of all umbrella protection policies from the umbrella cloud.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/operational/umbrellaprotectionpolicies

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

Permissions: Policies > Access Control > DNS Policy > Umbrella DNS Policy

POST umbrellaprotectionpolicies

Request Type: POST

Description: Creates an umbrella protection policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/operational/umbrellaprotectionpolicies

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

GET urlcategories

Request Type: GET

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

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

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

Permissions: Object Manager

GET urlgroups

Request Type: GET

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

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

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

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

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

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

Permissions: Object Manager > Modify Object Manager

PUT urlgroups

Request Type: PUT

Description: Modifies urlgroup objects.

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

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

Permissions: Object Manager > Modify Object Manager

POST urlgroups

Request Type: POST

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

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

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

Permissions: Object Manager > Modify Object Manager

DELETE urlgroups

Request Type: DELETE

Description: Deletes the specified urlgroup objects.

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

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

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

Permissions: Object Manager > Modify Object Manager

GET urls

Request Type: GET

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

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

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

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

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

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

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

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

Permissions: Object Manager

PUT urls

Request Type: PUT

Description: Modifies a URL.

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

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

Permissions: Object Manager

POST urls

Request Type: POST

Description: Creates or overrides the URLs with the specified parameters.

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

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

Permissions: Object Manager > Modify Object Manager

DELETE urls

Request Type: GET

Description: Deletes the specified URL.

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

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

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

Permissions: Object Manager > Modify Object Manager

GET Usage

Request Type: GET

Description:

Find usage of specified object uuid and type across objects and policies. Supported object types:

Type

 Value
Network NetworkAddress, Host, Network, Range, FQDN, NetworkGroup
Port Port, ProtocolPortObject, PortObjectGroup, ICMPV4Object, ICMPV6Object, AnyProtocolPortObject
VLAN tag VlanTag, VlanGroupTag
URL Url, UrlGroup

URL: /api/fmc_config/v1/domain/{domainUUID}/object/operational/usage

Parameters available for filtering: Specify uuid "uuid:object-uuid" and "type:object-type" and type of object.

Permissions: Object Manager

GET usersandgroups

Request Type: GET

Description: Retrieves users and groups associated with the specified Azure AD Realm.

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

Permissions: Object Manager

POST validatecertfile

Request Type: POST

Description: Uploads and parses a given certificate/key file.

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

Permissions: Devices > Certificates > Modify Certificates

GET variablesets

Request Type: GET

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

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

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

Permissions: Object Manager

GET vlangrouptags

Request Type: GET

Description: Retrieves the vlan group tag objects associated with the specified ID. If no ID is specified, retrieves list of all vlan group tag objects.

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

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

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

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

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

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

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

Permissions: Object Manager > Modify Object Manager

PUT vlangrouptags

Request Type: PUT

Description: Modifies vlangrouptag objects.

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

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

Permissions: Object Manager > Modify Object Manager

POST vlangrouptags

Request Type: POST

Description: Creates or overrides the VLAN group tags with the specified parameters.

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

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

Permissions: Object Manager > Modify Object Managers

DELETE vlangrouptags

Request Type: DELETE

Description: Deletes the specified vlan group tag object.

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

Permissions:

GET vlantags

Request Type: GET

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

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

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

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

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

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

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

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

Permissions: Object Manager

DELETE vlangrouptags

Request Type: DELETE

Description: Deletes the specified vlan group tag object.

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

Permissions:

PUT vlantags

Request Type: PUT

Description: Modifies VLAN tag objects.

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

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

Permissions: Object Manager > Modify Object Manager

POST vlantags

Request Type: POST

Description: Creates or overrides the VLAN tags with the specified parameters.

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

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

Permissions: Object Manager > Modify Object Manager

DELETE vlantags

Request Type: DELETE

Description: Deletes the specified VLAN tag objects.

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

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

URL to delete all VLAN tags: /api/fmc_config/v1/domain/{domain_UUID}/object/vlantags/

Permissions: Object Manager > Modify Object Manager

Policy Services

GET accesslistsettings

Request Type: GET

Description: Retrieves Access List policies for a particular Chassis Platform Settings Policy from the Management Center.

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

Permissions: Policies > Access Control > Access Control Policy

Parameters available for filtering: ticket-id

PUT accesslistsettings

Request Type: PUT

Description: Modifies Access List policies for a particular Chassis Platform Settings Policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/accesslistsettings/{objectId}

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

GET accesspolicies

Request Type: GET

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

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

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

Permissions: Policies

PUT accesspolicies

Request Type: PUT

Description: Modifies an access control policy.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{object_UUID}

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

POST accesspolicies

Request Type: POST

Description: Creates an access control policy with the specified parameters.

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

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

DELETE accesspolicies

Request Type: DELETE

Description: Deletes the access control policy with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{object_UUID}

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

DELETE accessrules

Request Type: DELETE

Description: Deletes an access control rule in the specified access control policy.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/accessrules/{object_UUID}

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

PUT accessrules

Request Type: PUT

Description: Modifies an access control rule in the specified access control policy.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/accessrules/{object_UUID}

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

POST accessrules

Request Type: POST

Description: Creates an access control rule in the specified access control policy.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/accessrules

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

GET accessrules

Request Type: GET

Description: Retrieves the access control rule associated with the specified policy ID and rule ID. If no rule ID is specified, retrieves list of all access rules associated with the specified policy ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/accessrules

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/accessrules/{object_UUID}

Permissions: Policies>Access Control>Access Control Policy

GET addressassignmentsettings

Request Type: GET

Description: Retrieves Address Assignment Setting inside a VPN RA Topology.

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/addressassignmentsettings/{objectId}

Permissions: Devices > VPN

PUT addressassignmentsettings

Request Type: PUT

Description: Modifies Address Assignment Setting inside a VPN RA Topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/addressassignmentsettings/{objectId}

Permissions: Devices > VPN > Modify VPN

GET advancedsettings

Request Type: GET

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

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

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

Permissions: Devices > VPN

PUT advancedsettings

Request Type: PUT

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

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

Permissions: Devices > VPN > Modify VPN

GET allowdnsrules

Request Type: GET

Description: Retrieves all the allow rules for a given DNS Policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/dnspolicies/{containerUUID}/allowdnsrules

Permissions: Policies > Access Control > DNS Policy

Parameters available for filtering: name

GET applicationgroups

Request Type: GET

Description: Retrieves the Zero Trust Application Groups associated with the specified ID.. If no ID is specified, retrieves list of all Zero Trust Application Groups.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{containerUUID}/applicationgroups

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

Permissions: Policies > Access Control > Zero Trust Application Policy

Parameters available for filtering: ticket-id

PUT applicationgroups

Request Type: PUT

Description: Modifies the Zero Trust Application Groups associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{containerUUID}/applicationgroups/{objectId}

Permissions: Policies > Access Control > Zero Trust Application Policy > Modify Zero Trust Application Policy

POST applicationgroups

Request Type: POST

Description: Creates Zero Trust Application Groups

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{containerUUID}/applicationgroups

Permissions: Policies > Access Control > Zero Trust Application Policy > Modify Zero Trust Application Policy

DELETE applicationgroups

Request Type: DELETE

Description: Deletes the Zero Trust Application Groups associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{containerUUID}/applicationgroups/{objectId}

Permissions: Policies > Access Control > Zero Trust Application Policy > Modify Zero Trust Application Policy

GET applications

Request Type: GET

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

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{containerUUID}/applications

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

Permissions: Policies > Access Control > Zero Trust Application Policy

Parameters available for filtering: ticket-id

PUT applications

Request Type: PUT

Description: Modifies the Zero Trust Applications associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{containerUUID}/applications

Permissions: Policies > Access Control > Zero Trust Application Policy > Modify Zero Trust Application Policy

POST applications

Request Type: POST

Description: Creates Zero Trust Applications.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{containerUUID}/applications

Permissions: Policies > Access Control > Zero Trust Application Policy > Modify Zero Trust Application Policy

DELETE applications

Request Type: DELETE

Description: Deletes the Zero Trust Applications associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{containerUUID}/applications

Permissions: Policies > Access Control > Zero Trust Application Policy > Modify Zero Trust Application Policy

GET autonatrules

Request Type: GET

Description: Retrieves the NAT rule associated with the specific ID. If no ID is specified, retrieves a list of all NAT rules.

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

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies{container_UUID}/autonatrules/{object_UUID}

Permissions: Devices>NAT>NAT List

PUT autonatrules

Request Type: PUT

Description: Modifies a NAT rule with the specified parameters.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies/{container_UUID}/autonatrules/{autonatrule_UUID)

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

POST autonatrules

Request Type: POST

Description: Creates a NAT policy with the specified parameters.

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

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

DELETE autonatrules

Request Type: DELETE

Description: Deletes the Auto NAT rule associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/autonatrules

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

GET blockdnsrules

Request Type: GET

Description: Retrieves all the block rules for a given DNS Policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/dnspolicies/{containerUUID}/blockdnsrules

Permissions: Policies > Access Control > DNS Policy

Parameters available for filtering: name

DELETE categories

Request Type: DELETE

Description: Deletes a category associated with the specified policy ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/categories/{object_UUID}

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

PUT categories

Request Type: PUT

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

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/categories/{object_UUID}

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

POST categories

Request Type: POST

Description: Creates a category for access control policies.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/categories

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

GET categories

Request Type: GET

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

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/categories

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/categories/{object_UUID}

Permissions: Policies > Access Control > Access Control Policy

GET chassisplatformsettingspolicies

Request Type: GET

Description: Retrieves the chassis platform settings policy associated with the ID. If no ID is specified, retrieves list of all chassis platform settings policies.

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

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

Permissions: Policies > Actions > Scanners

PUT chassisplatformsettingspolicies

Request Type: PUT

Description: Modifies the specified chassis platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{objectId}

Permissions: Policies > Actions > Scanners > Modify Scanners

POST chassisplatformsettingspolicies

Request Type: POST

Description: Creates a chassis platform settings policy.

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

Permissions: Policies > Actions > Scanners > Modify Scanners

DELETE chassisplatformsettingspolicies

Request Type: DELETE

Description: Deletes the specified chassis platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{objectId}

Permissions: Policies > Actions > Scanners > Modify Scanners

GET connectionprofiles

Request Type: GET

Description: Retrieves Connection Profile data inside a VPN RA Topology. If no ID is specified, retrieves a list of all connection profiles for the VPN RA topology.

URL for GET: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/connectionprofiles/

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/connectionprofiles/{objectId}

Permissions: Devices > VPN

PUT connectionprofiles

Request Type: PUT

Description: Modifies the Connection Profile data with the associated ID inside a VPN RA Topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/connectionprofiles/{objectId}

Permissions: Devices > VPN > Modify VPN

POST connectionprofiles

Request Type: POST

Description: Creates a Connection Profile inside a VPN RA Topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/connectionprofiles

Permissions: Devices > VPN > Modify VPN

DELETE connectionprofiles

Request Type: DELETE

Description: Deletes the Connection Profile data with the associated ID inside a VPN RA Topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/connectionprofiles/{objectId}

Permissions: Devices > VPN > Modify VPN

GET decryptionpolicies

Request Type: GET

Description: Retrieves the decryption policy associated with the specified ID. If no ID is specified, retrieves list of all Decryption Policies.

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

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

Permissions: Policies > Application Detectors

Parameters available for filtering: Name

PUT decryptionpolicies

Request Type: PUT

Description: Modifies the specified decryption policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies/{objectId}

Permissions: Policies > Application Detectors > Modify Application Detectors

POST decryptionpolicies

Request Type: POST

Description: Creates a decryption policy.

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

Permissions: Policies > Application Detectors > Modify Application Detectors

DELETE decryptionpolicies

Request Type: DELETE

Description: Deletes the specified decryption policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies/{objectId}

Permissions: Policies > Application Detectors > Modify Application Detectors

GET decryptionpolicyrules

Request Type: GET

Description: Retrieves the decryption policy rule associated with the specified ID. If no ID is specified, retrieves list of all Decryption Policy Rules.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies/{containerUUID}/decryptionpolicyrules

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

Permissions: Policies > Application Detectors

PUT decryptionpolicyrules

Request Type: PUT

Description: Modifies the specified decryption policy rule.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies/{containerUUID}/decryptionpolicyrules/{objectId}

Permissions: Policies > Application Detectors > Modify Application Detectors

POST decryptionpolicyrules

Request Type: POST

Description: Creates a decryption policy rule.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies/{containerUUID}/decryptionpolicyrules

Permissions: Policies > Application Detectors > Modify Application Detectors

DELETE decryptionpolicyrules

Request Type: DELETE

Description: Deletes the specified decryption policy rule.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies/{containerUUID}/decryptionpolicyrules/{objectId}

Permissions: Policies > Application Detectors > Modify Application Detectors

PUT defaultactions

Request Type: PUT

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

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/defaultactions/{object_UUID}

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

GET defaultactions

Request Type: GET

Description: Retrieves the default action associated with the specified access control policy ID and default action ID. If no default action ID is specified, retrieves list of all default actions associated with the specified access control policy ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/defaultactions

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/defaultactions/{object_UUID}

Permissions: Policies>Access Control>Access Control Policy

GET dnspolicies

Request Type: GET

Description: Retrieves the DNS Policy. If no ID is specified, retrieves a list of all DNS policies.

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

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/dnspolicies/{objectId}

Permissions: Policies > Access Control > DNS Policy

Parameters available for filtering: name.

GET dnssettings

Request Type: GET

Description: Retrieves dns settings policy for a particular chassis platform settings policy. If no ID is specified, retrieves all dns settings for a particular chassis platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/dnssettings

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

Permissions: Policies > Network Discovery

PUT dnssettings

Request Type: PUT

Description: Modifies the specified dns settings policy for a particular chassis platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/dnssettings/{objectId}

Permissions: Policies > Network Discovery > Modify Network Discovery

GET dynamicaccesspolicies

Request Type: GET

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

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

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/dynamicaccesspolicies/{objectId}

Permissions: Devices > VPN

PUT dynamicaccesspolicies

Request Type: PUT

Description: Modifies the Dynamic Access Policy associated with the specified rule ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/dynamicaccesspolicies/{objectId}

Permissions: Devices > VPN > Modify VPN

POST dynamicaccesspolicies

Request Type: POST

Description: Creates a Dynamic Access policy associated.

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

Permissions: Devices > VPN > Modify VPN

DELETE dynamicaccesspolicies

Request Type: DELETE

Description: Deletes the Dynamic Access Policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/dynamicaccesspolicies/{objectId}

Permissions: Devices > VPN > Modify VPN

GET endpoints

Request Type: GET

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

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

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

Permissions: Devices > VPN

PUT endpoints

Request Type: PUT

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

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

Permissions: Devices > VPN > Modify VPN

POST endpoints

Request Type: POST

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

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

Permissions: Devices > VPN > Modify VPN

DELETE endpoints

Request Type: DELETE

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

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

Permissions: Devices > VPN > Modify VPN

GET filepolicies

Request Type: GET

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

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

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/filepolicies/{object_UUID}

Permissions: Policies>Access Control>Malware & File Policy

PUT filepolicies

Request Type: PUT

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

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies/{objectId}

Permissions: Policies>Access Control>Malware & File Policy>Modify Malware & File Policy

POST filepolicies

Request Type: POST

Description: Creates a File Policy.

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

Permissions: Policies>Access Control>Malware & File Policy>Modify Malware & File Policy

DELETE filepolicies

Request Type: DELETE

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

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies/{objectId}

Permissions: Policies>Access Control>Malware & File Policy>Modify Malware & File Policy

GET filerules

Request Type: GET

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

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies/{containerUUID}/filerules

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

Permissions: Policies>Access Control>Malware & File Policy

PUT filepolicies

Request Type: PUT

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

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies/{objectId}

Permissions: Policies>Access Control>Malware & File Policy>Modify Malware & File Policy

POST filerules

Request Type: POST

Description: Creates a file rules.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies/{containerUUID}/filerules

Permissions: Policies>Access Control>Malware & File Policy>Modify Malware & File Policy

DELETE filerules

Request Type: DELETE

Description: Deletes the file rule associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies/{containerUUID}/filerules/{objectId}

Permissions: Policies>Access Control>Malware & File Policy>Modify Malware & File Policy

GET flexconfigpolicies

Request Type: GET

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

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

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

Permissions: Devices > Flexconfig Policy

POST flexconfigpolicies

Request Type: POST

Description: Creates a Flexconfig Policy.

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

Permissions: Devices > Flexconfig Policy > Modify Flexconfig Policy

GET ftdnatpolicies

Request Type: GET

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

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

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies/{object_UUID}

Permissions: Devices>NAT>NAT List

PUT ftdnatpolicies

Request Type: PUT

Description: Modifies an threat defense NAT policy with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies/{object_UUID}

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

POST ftdnatpolicies

Request Type: POST

Description: Creates a threat defense device NAT policy with the specified parameters.

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

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

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

DELETE ftdnatpolicies

Request Type: DELETE

Description: Deletes the threat defense NAT policy with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies/{object_UUID}

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

GET ftdplatformsettingspolicies

Request Type: GET

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

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

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

Permissions: Devices > Device Management

PUT ftdplatformsettingspolicies

Request Type: PUT

Description: Modifies the FTDPlatformSettings Policy with the associated ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{objectId}

Permissions: Devices > Device Management > Modify Devices

POST ftdplatformsettingspolicies

Request Type: POST

Description: Creates an FTDPlatformSettings Policy.

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

Permissions: Devices > Device Management > Modify Devices

DELETE ftdplatformsettingspolicies

Request Type: DELETE

Description: Deletes the FTDPlatformSettings Policy with the associated ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{objectId}

Permissions: Devices > Device Management > Modify Devices

GET ftds2svpns

Request Type: GET

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

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

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

Permissions: Devices > VPN

PUT ftds2svpns

Request Type: PUT

Description: Modifies a threat defense Site to Site VPN topology associated with the specified ID.

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

Permissions: Devices > VPN > Modify VPN

POST ftds2svpns

Request Type: POST

Description: Creates a threat defense Site to Site VPN topology with the specified parameters.

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

Permissions: Devices > VPN > Modify VPN

DELETE ftds2svpns

Request Type: DELETE

Description: Deletes the threat defense Site to Site VPN topology associated with the specified ID.

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

Permissions: Devices > VPN > Modify VPN

GET healthpolicies

Request Type: GET

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

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/healthpolicies/{objectId}

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

Permissions: System > Health > Health Policy

GET hitcounts

Request Type: GET

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

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

URLs:

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

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

Permissions:

  • Policies>Access Control Policy>Modify Access Control Policy

  • Policies>Prefilter Policy>Modify Prefilter Policy

PUT hitcounts

Request Type: PUT

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

URLs:

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

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

Permisssions:

  • Policies>Access Control Policy>Modify Access Control Policy

  • Policies>Prefilter Policy>Modify Prefilter Policy

DELETE hitcounts

Request Type: DELETE

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

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

URLs:

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

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

Permisssions:

  • Policies>Access Control Policy>Modify Access Control Policy

  • Policies>Prefilter Policy>Modify Prefilter Policy

GET httpaccesssettings

Request Type: GET

Description: Retrieves the FTD HTTP access settings associated with the ID. If no ID is specified, retrieves list of all FTD HTTP access settings.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/httpaccesssettings

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

Permissions: Policies > Network Discovery

PUT httpaccesssettings

Request Type: PUT

Description: Modifies the specified FTD HTTP access settings.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/httpaccesssettings/{objectId}

Permissions: Policies > Network Discovery > Modify Network Discovery

GET identitypolicies

Request Type: GET

Description: Retrieves the Identity Policy associated with the specified ID. If no ID is specified, retrieves all Identity Policies.

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

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/identitypolicies/{objectId}

Permissions: Policies > Access Control > Identity Policy

GET ikesettings

Request Type: GET

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

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

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

Permissions: Devices > VPN

PUT ikesettings

Request Type: PUT

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

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

Permissions: Devices > VPN > Modify VPN

GET inheritancesettings

Request Type: GET

Description: Retrieves the inheritance settings associated with specified Access Policy. If no ID is specified, retrieves a list of all inheritance settings.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/inheritancesettings/

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/inheritancesettings/{object_UUID}

Permissions: Policies > Access Control Policy

PUT inheritancesettings

Request Type: PUT

Description: Modifies the inheritance settings associated with specified Access Policy.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/accesspolicies/{container_UUID}/inheritancesettings/{object_UUID}

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

GET Inspector Configurations

Request Type: GET

Description: Retrieves the Snort3 custom NAP.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/networkanalysispolicies/{containerUUID}/inspectorconfigs

Permissions: Policies > Access Control > Access Control Policy

GET inspectoroverrideconfigs

Request Type: GET

Description: Retrieves the Snort3 custom NAP override.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/networkanalysispolicies/{containerUUID}/inspectoroverrideconfigs

Permissions: Policies > Access Control > Access Control Policy

PUT inspectoroverrideconfigs

Request Type: GET

Description: Modifies the Snort3 custom NAP override.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/networkanalysispolicies/{containerUUID}/inspectorconfigs

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

GET intrusionpolicies

Request Type: GET

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

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

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/intrusionpolicies/{object_UUID}

Permissions: Policies > Access Control > Intrusion Policy

PUT intrusionpolicies

Request Type: PUT

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

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/intrusionpolicies/{objectId}

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

POST intrusionpolicies

Request Type: POST

Description: Creates an intrusion policy with the specified parameters.

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

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

DELETE intrusionpolicies

Request Type: DELETE

Description: Deletes the intrusion policy associated with the specified ID.

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/intrusionpolicies/{object_UUID}

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

GET intrusionrulegroups

Request Type: GET

Description: Retrieves the per-policy behaviour of the specified intrusion rule ID for the target intrusion policy ID. If no rule ID is specified for a GET, retrieves list of all Snort 3 intrusion rulegroups associated with the policy ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/intrusionpolicies/{containerUUID}/intrusionrulegroups/

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

Permissions: Policies > Access Control > Intrusion Policy

PUT intrusionrulegroups

Request Type: PUT

Description: Modifies the per-policy behaviour of the specified intrusion rule ID for the target intrusion policy ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/intrusionpolicies/{containerUUID}/intrusionrulegroups/{objectId}

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

POST intrusionrulegroups

Request Type: PUT

Description: Modifies the per-policy behaviour of the specified intrusion rule ID for the target intrusion policy ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/intrusionpolicies/{containerUUID}/intrusionrulegroups/{objectId}

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

GET intrusionrules

Request Type: GET

Description: Retrieves the per-policy behaviour of the specified intrusion rule ID for the target intrusion policy ID. If no rule ID is specified for a GET, retrieves list of all Snort 3 intrusion rules associated with the policy ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/intrusionpolicies/{containerUUID}/intrusionrules

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

Permissions: Policies > Access Control > Intrusion Policy

PUT intrusionrules

Request Type: PUT

Description: Modifies the per-policy behaviour of the specified intrusion rule ID for the target intrusion policy ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/intrusionpolicies/{containerUUID}/intrusionrules/{objectId}

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

GET ipsecadvancedsettings

Request Type: GET

Description: Retrieves IPSec Advance Setting inside a VPN RA Topology. If no ID is specified for a GET, retrieves list containing a single IPSEC Advance Setting entry of the topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/ipsecadvancedsettings/{objectId}

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/ipsecadvancedsettings/{objectId}/{object_UUID}

Permissions: Object Manager

PUT ipsecadvancedsettings

Request Type: PUT

Description: Modifies IPSec Advance Setting inside a VPN RA Topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/ipsecadvancedsettings/{objectId}

Permissions: Object Manager > Modify Object Manager

GET ipseccryptomaps

Request Type: GET

Description: Retrieves IPSec Crypto Map Setting inside a VPN RA Topology. If no ID is specified, retrieves list containing a single IPSEC Crypto Map Setting entry of the topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/ipseccryptomaps/{objectId}

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/ipseccryptomaps/{objectId}/{object_UUID}

Permissions: Object Manager

PUT ipseccryptomaps

Request Type: PUT

Description: Modifies IPSec Crypto Map Setting inside a VPN RA Topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/ipseccryptomaps/{objectId}

Permissions: Object Manager > Modify Object Manager

GET ipsecsettings

Request Type: GET

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

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

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

Permissions: Devices > VPN

PUT ipsecsettings

Request Type: PUT

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

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

Permissions: Devices > VPN > Modify VPN

GET ldapattributemaps

Request Type: GET

Description: Retrieves LDAP Attribute Maps inside a VPN RA Topology. If no ID is specified for a GET, retrieves list containing a single LDAP Attribute Maps of the topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/ldapattributemaps/{objectId}

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/ldapattributemaps/{objectId}/{object_UUID}

Permissions: Devices > VPN

PUT ldapattributemaps

Request Type: PUT

Description: Modifies the LDAP Attribute Map with the specified ID inside a VPN RA Topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/ldapattributemaps/{objectId}

Permissions: Devices > VPN > Modifiy VPN

GET loadbalancesettings

Request Type: GET

Description: Retrieves Load Balance Setting inside a VPN RA Topology. If no ID is specified for a GET, retrieves list containing a single Load Balance Setting entry of the topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/loadbalancesettings

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

Permissions: Devices > VPN

PUT loadbalancesettings

Request Type: PUT

Description: Modifies Load Balance Setting inside a VPN RA Topology.t.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/loadbalancesettings/{objectId}

Permissions: Devices > VPN > Modify VPN

GET loggingsettings

Request Type: GET

Description: Retrieves the logging setting associated with the specified access control policy ID and default action ID. If no default action ID is specified, retrieves list of all default actions associated with the specified access control policy ID.

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

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

Permissions: Policies

PUT loggingsettings

Request Type: PUT

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

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

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

GET manualnatrules

Request Type: GET

Description: Retrieves the manual NAT rule associated with the specified ID. If no ID is specified, retrieves a list of all manual NAT rules.

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

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies/{container_UUID}/manualnatrules/{object_UUID}

Permissions: Devices>NAT>NAT List

PUT manualnatrules

Request Type: PUT

Description: Modifies the Auto NAT rule associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/manualnatrules/{objectId}

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

POST manualnatrules

Request Type: POST

Description: Creates manual NAT rules with the specified parameters.

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

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

DELETE manualnatrules

Request Type: POST

Description: Deletes a manual NAT rule in the specified NAT policy.

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

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

POST migrate

Request Type: POST

Description: Initiates the flexConfig migration for specified devices.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/flexconfigpolicies/{containerUUID}/migrate

Permissions: Devices > Flexconfig Policy > Modify Flexconfig Policy

GET natexemptrules

Request Type: GET

Description: Retrieves the VPN NatExempt Rules generated by the Site To Site VPN Topology for a device.

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/natexemptrules/{deviceId}

Permissions: Devices > NAT

GET natrules

Request Type: GET

Description: Retrieves the list of all NAT rules (manual and auto) associated with the specified NAT policy.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/ftdnatpolicies/{container_UUID}/natrules

Permissions: Devices>NAT>NAT List

GET netflowpolicies

Request Type: GET

Description: Retrieves the Netflow Policy associated with the ID. If no ID is specified, retrieves list of all Netflow policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/netflowpolicies

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/netflowpolicies/{object_UUID}

Permissions: Policies > Network Discovery

PUT netflowpolicies

Request Type: PUT

Description: Modifies the Netflow Policy associated with the ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/netflowpolicies/{objectId}

Permissions: Policies > Network Discovery > Modify Network Discovery

GET networkanalysispolicies

Request Type: GET

Description: Retrieves the network analysis policy with the specified ID. If no ID is specified, retrieves list of all network analysis policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/networkanalysispolicies

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/networkanalysispolicies/{objectId}

Permissions: Policies > Access Control > Access Control Policy

PUT networkanalysispolicies

Request Type: PUT

Description: Modifies the network analysis policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/networkanalysispolicies/{objectId}

Permissions: Policies > Access Control > Access Control Policy > Modify Access Control Policy

POST networkanalysispolicies

Request Type: POST

Description: Creates a network analysis policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/networkanalysispolicies

Permissions: Policies > Access Control > Access Control Policy > Modify Access Control Policy

DELETE networkanalysispolicies

Request Type: DELETE

Description: Deletes the network analysis policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/networkanalysispolicies/{objectId}

Permissions: Policies > Access Control > Access Control Policy > Modify Access Control Policy

DELETE natrules

Request Type: DELETE

Description: Deletes the NAT rule (manual or auto) associated with the specified policy ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/natrules

Permissions: Devices > NAT > NAT List > Modify NAT policy

GET policylocks

Request Type: GET

Description: Retrieves the policy lock statues for access policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/operational/policylocks

Permissions: Policies > Access Control > Access Control Policy

POST policylocks

Request Type: POST

Description: Locks or unlocks the specified Access Control policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/operational/policylocks

Permissions: Policies > Access Control > Access Control Policy > Modify Access Control Policy

GET prefilterpolicies

Request Type: GET

Description: Retrieves the prefilter policy associated with the specified ID. If no ID is specified, retrieves a list of all prefilter policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{object_UUID}

Permissions: Policies > Access Control > Prefilter Policy

PUT prefilterpolicies

Request Type: PUT

Description: Modifies a prefilter policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/prefilterpolicies/{object_UUID}

Permissions: Policies > Access Control > Prefilter Policy > Modify Prefilter Policy

POST prefilterpolicies

Request Type: POST

Description: Creates a prefilter policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/prefilterpolicies/{object_UUID}

Permissions: Policies > Access Control > Prefilter Policy > Modify Prefilter Policy

DELETE prefilterpolicies

Request Type: DELETE

Description: Deletes a prefilter policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/prefilterpolicies/{object_UUID}

Permissions: Policies > Access Control > Prefilter Policy > Modify Prefilter Policy

GET prefilterrules

Request Type: GET

Description: Retrieves the prefilter rule associated with the specified rule ID. If no ID is specified, retrieves list of all prefilter rules.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/prefilterpolicies/{container_UUID}/prefilterrules/

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/prefilterpolicies/{container_UUID}/prefilterrules/{object_UUID}

Permissions: Policies > Access Control > Prefilter Policy

PUT prefilterrules

Request Type: PUT

Description: Modifies the prefilter rule associated with the specified rule ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/prefilterpolicies/{container_UUID}/prefilterrules/{object_UUID}

Permissions: Policies > Access Control > Prefilter Policy > Modify Prefilter Policy

POST prefilterrules

Request Type: POST

Description: Creates a prefilter rule.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/prefilterpolicies/{container_UUID}/prefilterrules

Permissions: Policies > Access Control > Prefilter Policy > Modify Prefilter Policy

DELETE prefilterrules

Request Type: DELETE

Description: Deletes the prefilter rule associated with the specified rule ID.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/prefilterpolicies/{container_UUID}/prefilterrules/{object_UUID}

Permissions: Policies > Access Control > Prefilter Policy > Modify Prefilter Policy

GET remoteaccessvpns

Request Type: GET

Description: Retrieves the threat defense RA VPN topology associated with the specified ID. If no ID is specified for a GET, retrieves list of all threat defense RA VPN topologies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{objectId}

Permissions: Devices > VPN

PUT ravpns

Request Type: PUT

Description: Modifies Firewall Threat Defense RA VPN topology associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{objectId}

Permissions: Devices > VPN > Modify VPN

POST ravpns

Request Type: POST

Description: Creates a Firewall Threat Defense RA VPN topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns

Permissions: Devices > VPN > Modify VPN

DELETE ravpns

Request Type: DELETE

Description: Deletes Firewall Threat Defense RA VPN topology associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{objectId}

Permissions: Devices > VPN > Modify VPN

GET s2svpnsummaries

Request Type: GET

Description: Retrieves all the configured S2S VPN in the system , with short summary along with the health of the tunnels

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/s2svpnsummaries

Permissions: Devices > VPN

GET secureclientcustomizationsettings

Request Type: GET

Description: Retrieves Secure Client Customization Setting inside a VPN RA Topology. If no ID is specified for a GET, retrieves list containing a single Secure Client Customoization Setting entry of the topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/secureclientcustomizationsettings

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/secureclientcustomizationsettings/{object_UUID}

Permissions: Policies > Access Control > SSL Policy

PUT secureclientcustomizationsettings

Request Type: PUT

Description: Modifies the specified Secure Client Customization Setting inside a VPN RA Topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/secureclientcustomizationsettings/{objectId}

Permissions: Policies > Access Control > SSL Policy > Modify SSL Policy

GET securityintelligencepolicies

Request Type: GET

Description: Retrieves the security intelligence policy associated with the specified Access Policy. If no ID is specified for a GET, retrieves all security intelligence policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/securityintelligencepolicies

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/securityintelligencepolicies/{objectId}

Permissions: Intelligence

GET sshclientsettings

Request Type: GET

Description: Retrieves ssh client setting policy for particular chassis platform settings policies associated with the ID. If no ID is specified, retrieves list of all ssh client setting policy for particular chassis platform settings policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshclientsettings

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshclientsettings/{object_UUID}

Permissions: Policies > Access Control > SSL Policy

PUT sshclientsettings

Request Type: PUT

Description: Modifies the specified ssh client setting policy for particular chassis platform settings policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshclientsettings/{objectId}

Permissions: Policies > Access Control > SSL Policy > Modify SSL Policy

GET sshserversettings

Request Type: GET

Description: Retrieves the ssh server setting policy for particular chassis platform settings policies associated with the ID. If no ID is specified, retrieves list of all ssh server setting policies for that particular chassis platform setting.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshserversettings

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshserversettings/{object_UUID}

Permissions: Policies > Access Control > SSL Policy

PUT sshserversettings

Request Type: PUT

Description: Modifies the specified ssh server setting policy for a particular chassis platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshserversettings/{objectId}

Permissions: Policies > Access Control > SSL Policy > Modify SSL Policy

GET snmpalerts

Request Type: GET

Description: Retrieves the SNMP alert object associated with the specified ID. If no ID is specified, retrieves a list of all SNMP alert objects.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/snmpalerts

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/snmpalerts/{object_UUID}

Permissions: Policies > Actions > Alerts > View Alerts

GET SNMP Settings

Request Type: GET

Description: Retrieves the FTD SNMP Platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/snmpsettings

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/snmpsettings/{objectId}

Permissions: Policies > Access Control

PUT SNMP Settings

Request Type: PUT

Description: Modifies the FTD SNMP Platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/snmpsettings

Permissions: Policies > Access Control

GET syslogalerts

Request Type: GET

Description: Retrieves the syslog alert object associated with the specified ID. If no ID is specified, retrieves a list of all syslog alert objects.

URL: /api/fmc_config/v1/domain/{domain_UUID}/policy/syslogalerts

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/policy/syslogalerts/{object_UUID}

Permissions: Policies > Actions > Alerts

GET syslogsettings

Request Type: GET

Description: Retrieves the syslog settings policy for a particular chassis platform settings policy associated with the ID. If no ID is specified, retrieves list of all syslog settings policies for that particular chassis platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/syslogsettings

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/syslogsettings/{object_UUID}

Permissions: System > Monitoring > Syslog

PUT syslogsettings

Request Type: PUT

Description: Modifies the specified syslog settings policy for a particular chassis platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/syslogsettings/{objectId}

Permissions: System > Monitoring > Syslog

GET timesynchronizationsettings

Request Type: GET

Description: Retrieves the specified time synchronization settings policy for particular chassis platform settings policies. If no ID is specified, retrieves list of all time synchronization settings policy for particular chassis platform settings policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timesynchronizationsettings

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timesynchronizationsettings/{object_UUID}

Permissions: Devices > Device Management

PUT timesynchronizationsettings

Request Type: PUT

Description: Modifies the specified time synchronization settings policy for particular chassis platform settings policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timesynchronizationsettings/{objectId}

Permissions: Devices > Device Management > Modify Devices

GET timezonesettings

Request Type: GET

Description: Retrieves time zone settings policy for particular chassis platform settings policies associated with the ID. If no ID is specified, retrieves list of all timezone settings policies for those particular chassis platform settings.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timezonesettings

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timezonesettings/{object_UUID}

Permissions: Devices > Device Management

PUT timezonesettings

Request Type: PUT

Description: Modifies the time zone settings policy for particular chassis platform settings policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timezonesettings/{objectId}

Permissions: Devices > Device Management > Modify Devices

GET umbrelladnspolicies

Request Type: GET

Description: Retrieves the umbrella DNS policy associated with the specified ID. If no ID is specified, retrieves list of all umbrella DNS policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/umbrelladnspolicies/{objectId}

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/umbrelladnspolicies/{objectId}/{object_UUID}

Permissions: Policies > Access Control > DNS Policy > Umbrella DNS Policy

PUT umbrelladnspolicies

Request Type: PUT

Description: Modifies the umbrella DNS policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/umbrelladnspolicies/{objectId}

Permissions: Policies > Access Control > DNS Policy > Umbrella DNS Policy > Modify Umbrella DNS Policy

POST umbrelladnspolicies

Request Type: POST

Description: Creates an umbrella DNS policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/umbrelladnspolicies

Permissions: Policies > Access Control > DNS Policy > Umbrella DNS Policy > Modify Umbrella DNS Policy

DELETE umbrelladnspolicies

Request Type: DELETE

Description: Deletes the umbrella DNS policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/umbrelladnspolicies/{objectId}

Permissions: Policies > Access Control > DNS Policy > Umbrella DNS Policy > Modify Umbrella DNS Policy

GET umbrelladnsrules

Request Type: GET

Description: Retrieves the the umbrella DNS Rule associated with the specified ID. If no ID is specified, retrieves list of all umbrella DNS rules.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/umbrelladnspolicies/{containerUUID}/umbrelladnsrules/{objectId}

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/umbrelladnspolicies/{containerUUID}/umbrelladnsrules/{objectId}/{object_UUID}

Permissions: Policies > Access Control > DNS Policy > Umbrella DNS Policy

PUT umbrelladnsrules

Request Type: PUT

Description: Modifies the umbrella DNS Rule associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/umbrelladnspolicies/{containerUUID}/umbrelladnsrules/{objectId}

Permissions: Policies > Access Control > DNS Policy > Umbrella DNS Policy > Modify Umbrella DNS Policy

GET vpntunnelstatuses

Request Type: GET

Description: Retrieves the VPN Tunnel statuses.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/vpntunnelstatuses

Permissions: Devices > VPN

Parameters available for filtering: ticket-id

GET zerotrustpolicies

Request Type: GET

Description: Retrieves the Zero Trust policy associated with the specified ID. If no ID is specified, retrieves list of all Zero Trust policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{object_UUID}

Permissions: Policies > Access Control > Zero Trust Application Policy

PUT zerotrustpolicies

Request Type: PUT

Description: Modifies the Zero Trust policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{objectId}

Permissions: Policies > Access Control > Zero Trust Application Policy > Modify Zero Trust Application Policy

POST zerotrustpolicies

Request Type: POST

Description: Creates a Zero Trust policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies

Permissions: Policies > Access Control > Zero Trust Application Policy > Modify Zero Trust Application Policy

DELETE zerotrustpolicies

Request Type: DELETE

Description: Deletes the specified Zero Trust policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{objectId}

Permissions: Policies > Access Control > Zero Trust Application Policy > Modify Zero Trust Application Policy

GET ztnapolicies

Request Type: GET

Description: Retrieves the ZTNA policy associated with the specified ID. If no ID is specified, retrieves list of all ZTNA policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ztnapolicies

URL for GET by ID: /api/fmc_config/v1/domain/{domainUUID}/policy/ztnapolicies/{object_UUID}

Permissions: Policies > Access Control > Zero Trust Application Policy

PUT ztnapolicies

Request Type: PUT

Description: Modifies the ZTNA policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ztnapolicies/{objectId}

Permissions: Policies > Access Control > Zero Trust Application Policy > Modify Zero Trust Application Policy

POST ztnapolicies

Request Type: POST

Description: Creates a ZTNA policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ztnapolicies

Permissions: Policies > Access Control > Zero Trust Application Policy > Modify Zero Trust Application Policy

DELETE ztnapolicies

Request Type: DELETE

Description: Deletes the ZTNA policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ztnapolicies/{objectId}

Permissions: Policies > Access Control > Zero Trust Application Policy > Modify Zero Trust Application Policy

Policy Assignment Services

PUT policyassignments

Request Type: PUT

Description: Modifies an assigned access policy to add a new device or a new device group.

URL: /api/fmc_config/v1/domain/{domain_UUID}/assignment/policyassignments/{object_UUID}

Permissions: Policies > Access Control > Access Control Policy > Modify Access Control Policy

POST policyassignments

Request Type: POST

Description: Assigns an unassigned access policy to devices or device groups.

URL: /api/fmc_config/v1/domain/{domain_UUID}/assignment/policyassignments

Permissions: Policies > Access Control > Access Control Policy > Modify Access Control Policy

GET policyassignments

Request Type: GET

Description: Retrieves the policy assignment associated with the specified ID. If no ID is specified, retrieves a list of all policy assignments to target devices.

URL: /api/fmc_config/v1/domain/{domain_UUID}/assignment/policyassignments

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/assignment/policyassignments/{object_UUID}

Permissions: Policies > Access Control > Access Control Policy

Parameters available for filtering: name

Status Services

GET taskstatuses

Description: Retrieves information about a previously submitted pending job/task with the specified ID. This is currently supported for device registration and deployment jobs.

URL for GET by ID: /api/fmc_config/v1/domain/{domain_UUID}/job/taskstatuses/{object_UUID}

Permissions: Modify Devices/Deployment

System Information

GET domain

Request Type: GET

Description: Requests version information for the domain. If no ID is specified, retrieves a list of all domains.

URL: /api/fmc_platform/v1/info/domain/{domain_UUID}/

URL for GET by ID: /api/fmc_platform/v1/info/domain/{domain_UUID}/{object_UUID}

Permissions: System > Domains

GET serverversion

Request Type: GET

Description: Requests version information for the server. If no ID is specified, retrieves a list of all servers.

URL: /api/fmc_platform/v1/info/serverversion

URL for GET by ID: /api/fmc_platform/v1/info/serverversion/{objectID}

Permissions:

Update Packages

POST Cancel Upgrades

Request Type: POST

Description: This POST operation cancels software upgrade packages to applicable devices running threat defense.

URL:/api/fmc_platform/v1/updates/cancelupgrades

Permissions: System > Tools > Scheduling

POST Retry Ugrades

Request Type: POST

Description: This POST operation retries software upgrade packages to applicable devices running threat defense.

URL:/api/fmc_platform/v1/updates/retryupgrades

Permissions: System > Updates

DELETE upgradepackages

Request Type: DELETE

Description: Deletes a specific threat defense upgrade package from the managing management center.

URL: /api/fmc_platform/v1/updates/upgradepackages/{package_UUID}

Permissions: System > Tools > Scheduling

GET upgradepackages

Request Type: GET

Description: Retrieves a list of locally available threat defense upgrade packages, including major upgrades, maintenances release upgrades, and hotfixes.

URL: /api/fmc_platform/v1/updates/upgradepackages

URL for GET by ID: /api/fmc_platform/v1/updates/upgradepackages/{package_UUID}

Permissions: System > Tools

GET listapplicabledevices

Request Type: GET

Description: Lists registered device containers that support the specific upgrade package.

URL: /api/fmc_platform/v1/updates/upgradepackages/{container_UUID}/applicabledevices

Permissions: System > Tools > Scheduling

POST upgradepackage

Request Type: POST

Description: Dependent on the parameters, this POST operation either pushes available software upgrade packages to applicable devices running threat defense or initiates the upgrade process for applicable devices running threat defense. This process is applicable for standalone, clustered, or high availability pairs with the following limitations:

  • For all configurations, ensure that the current POST operation is completed successfully before proceeding to the next POST operation.

  • Perform the POST operation on the primary node of a high availability pair. Do not perform the POST operation for more than one high availability pair at a time.

  • Perform the POST operation on the


Note
Typically, the first POST operation responds within 60 seconds. Cisco recommends that you perform subsequent POST operations at least 120 seconds after the first POST operation was initiated. The response of the POST operation includes a task object, with a task ID and task status. You can monitor the completion of the task by performing a GET operation on the task object with its task ID. For more information, see GET taskstatuses.

URL:/api/fmc_platform/v1/updates/upgrades/

Permissions: System > Tools > Scheduling

POST revertupgrades

Request Type: POST

Description: Triggers reversion of an upgrade.

URL: /api/fmc_platform/v1/updates/revertupgrades

Permissions: System > Tools > Scheduling

GET upgradepackages: Monitor

Request Type: GET

Description: Monitors the upgrade process once you have executed the POST upgrade task.

URL: /api/fmc_platform/v1/domain/{domain_UUID}/job/taskstatuses/{task_ID}

Permissions: System > Tools > Scheduling

POST upgradesnapshot

Request Type: POST

Description: Creates an upgrade snapshot.

URL: /api/fmc_platform/v1/updates/upgradesnapshot

Permissions: System > Tools