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. 
  • GET ALL
    – GET ALL is a GET without an object id. Retrieves all objects of the requested type. 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 300 GET requests per minute from a single IP address.

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

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

If a client exceeds these limits, the API will give an HTTP 429 error.

Payload Limiting

The API cannot accept a message with a payload greater than 2048000 bytes. This applies to both the REST API and to API Explorer. This is not a configurable parameter.

If a message exceeds this limit, the API will give an HTTP 422 error.

Object Overrides

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

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

The URL for this feature is:

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

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

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

Optional:

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

GET:

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

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

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


Note

When overridden, the parent object value will never change.

Field Renaming

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

Table 2.

Name

URL

Previous Field Name

New Field Name
ftddevicecluster

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

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

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

 whitelist allowlist
Indicator

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

 whitelist allowlist
Incident

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

 whitelist allowlist
Source

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

 whitelist allowlist

Troubleshoot

GETALL details

Request Type: GETALL

Description: Get the packet details from a PCAP file.

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

Query Parameters

pcapFileName - The PCAP File Name under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST device

Request Type: POST

Description: Trigger troubleshooting for chassis models 3100 and 4200. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

DELETE files

Request Type: DELETE

Description: Delete all PCAP files from the Firewall Management Center. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

filter - To be used in conjunction with <code>bulk=true</code> for bulk deletion. Various filter criteria can be specified using the format:<br><code>pcapFileNames:file1,file2,file3...</code> will delete only the PCAP files provided in the list.<br><code>deleteAllFiles:true</code> will delete all the PCAP files.

domainUUID - Domain UUID

GET files

Request Type: GET

Description: Get the specified PCAP file from the Firewall Management Center.

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

Query Parameters

pcapFileName - Name of the PCAP file.

domainUUID - Domain UUID

GETALL files

Request Type: GETALL

Description: Get all PCAP files from the Firewall Management Center.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST files

Request Type: POST

Description: Create a PCAP file on the Firewall Management Center. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

GET modules

Request Type: GET

Description: Get the CPU Profiling data of Snort modules from the specified profiler file.

URL: /api/fmc_troubleshoot/v1/domain/{domainUUID}/cpuprofiler/{containerUUID}/modules/{profilerFileName}

Query Parameters

profilerFileName - The name of the file containing the CPU Profiling data.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL modules

Request Type: GETALL

Description: Get all CPU profiling data of a Snort3 module on a given device.

URL: /api/fmc_troubleshoot/v1/domain/{domainUUID}/cpuprofiler/{containerUUID}/modules

Query Parameters

filter - To be used in conjunction with <code>"latest:true"</code> in order to get the latest file of CPU Profiling for the Snort modules.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST modules

Request Type: POST

Description: Create the CPU profiling data of a Snort3 module on a given device. _Check the response section for applicable examples (if any)._

URL: /api/fmc_troubleshoot/v1/domain/{domainUUID}/cpuprofiler/{containerUUID}/modules

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

POST pcaptraces

Request Type: POST

Description: Get the Packet Tracer using a PCAP file command output for Firewall Threat Defense. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

GET rules

Request Type: GET

Description: Get the Snort rule profiling data from the specified profiler file.

URL: /api/fmc_troubleshoot/v1/domain/{domainUUID}/snortprofiler/{containerUUID}/rules/{profilerFileName}

Query Parameters

profilerFileName - The name of the file containing the Snort Rule Profiling data.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL rules

Request Type: GETALL

Description: Get all Snort Rule Profiling data for a given device.

URL: /api/fmc_troubleshoot/v1/domain/{domainUUID}/snortprofiler/{containerUUID}/rules

Query Parameters

filter - To be used in conjunction with <code>"latest:true"</code> in order to get the latest file with Snort Rule Profiling data.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST rules

Request Type: POST

Description: Create Snort Rule Profiling data for a given device. _Check the response section for applicable examples (if any)._

URL: /api/fmc_troubleshoot/v1/domain/{domainUUID}/snortprofiler/{containerUUID}/rules

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET services

Request Type: GET

Description: Get the RADKit Service data from the specified ID.

URL: /api/fmc_troubleshoot/v1/domain/{domainUUID}/radkit/services/{id}

Query Parameters

id - The ID of the RADKit Service.

domainUUID - Domain UUID

GETALL services

Request Type: GETALL

Description: Get all RADKit Service data from the FMC.

URL: /api/fmc_troubleshoot/v1/domain/{domainUUID}/radkit/services

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST services

Request Type: POST

Description: Create the RADKit Service on the FMC. _Check the response section for applicable examples (if any)._

URL: /api/fmc_troubleshoot/v1/domain/{domainUUID}/radkit/services

Query Parameters

domainUUID - Domain UUID

POST traces

Request Type: POST

Description: Get the Packet Tracer command output for a Firewall Threat Defense or Cluster. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

Network Map

DELETE hosts

Request Type: DELETE

Description: Delete the entire network map. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean value indicating whether this is performed as a bulk operation. <br>This field must be true in order to delete with a filter rather than an identifier.

filter - Filter to limit the deletion. Values can be: <code>ipAddress:{192.168.1.2|'::ffff:c0a8:0102'}</code>.

domainUUID - Domain UUID

GET hosts

Request Type: GET

Description: Get the host associated with the specified ID in the Network Map.

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

Query Parameters

objectId - UUID of the host.

includeOs - Boolean indicating whether to include the operating system of the host.

includeService - Boolean indicating whether to include the port, protocol, and confidence of the host.

includeApps - Boolean indicating whether to include the applications of the host.

domainUUID - Domain UUID

GETALL hosts

Request Type: GETALL

Description: Get the list of all hosts in the network map.

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

Query Parameters

filter - Values can be: <code>ipAddress:{192.168.1.2|'::ffff:c0a8:0102'}</code>.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST hosts

Request Type: POST

Description: Create a host in the network map. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean value indicating whether this is performed as a bulk operation.

domainUUID - Domain UUID

DELETE vulns

Request Type: DELETE

Description: Delete all the vulnerabilities in the network map. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean value indicating whether this is performed as a bulk operation. This field must be true in order to delete with a filter rather than an identifier.

filter - Filters for retrieve and delete operations. The <code>source</code> filter must be included for delete.<br>Values can be any of: <code>ipAddress:192.168.1.2;source:MySource;port:443;protocol:tcp;id:12345</code>.

domainUUID - Domain UUID

GET vulns

Request Type: GET

Description: Get the vulnerability in the network map with the specified ID.

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

Query Parameters

objectId - Unique identifier of the vulnerability.

domainUUID - Domain UUID

GETALL vulns

Request Type: GETALL

Description: Get the list of all vulnerabilities in the network map.

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

Query Parameters

filter - Filters for retrieve and delete operations. The <code>source</code> filter must be included for delete.<br>Values can be any of: <code>ipAddress:192.168.1.2;source:MySource;port:443;protocol:tcp;id:12345</code>.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST vulns

Request Type: POST

Description: Create a vulnerability in the network map. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean value indicating whether this is performed as a bulk operation.

domainUUID - Domain UUID

Analysis

DELETE activesessions

Request Type: DELETE

Description: Administratively logout active user session. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - should always be set to true

domainUUID - Domain UUID

GETALL activesessions

Request Type: GETALL

Description: Get active sessions.

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

Query Parameters

userId - Search based on user ID.Operator: <code>EQUALS</code>.

loginTime - Search based on the session login time, format: <code>{before|after}:{loginTime}</code> or <code>after:{loginTime},before:{loginTime}</code>, where loginTime takes Long value (Unix Timestamp).

lastSeen - Search based on the time when the user was last seen. Format and values as for loginTime.

username - Search based on user username. Operator: <code>CONTAINS</code> (i.e. search for ana will return users with usernames ana, banana, canada if they have active sessions)

email - Search based on user email. Operator: <code>CONTAINS</code>.

department - Search based on user department. Operator: <code>EQUALS</code>.

authenticationType - Search based on authentication type (passive, active). Operator: <code>EQUALS</code>.

device - Search based on device. Operator: <code>EQUALS</code>.

currentIP - Search based on IP of the session. Operator: <code>EQUALS</code>. Or search based on the subnet or range, example: 192.168.1.0/24, 192.168.0.1-192.168.0.5.

user - Search based on user common name in AD. Operator: <code>EQUALS</code>.

realmId - Search based on realm ID. Operator: <code>EQUALS</code>.

realmName - Search based on realm name. Operator: <code>EQUALS</code>.

firstName - Search based on user first name. Operator: <code>CONTAINS</code>.

lastName - Search based on user last name. Operator: <code>CONTAINS</code>.

phone - Search based on user phone. Operator: <code>EQUALS</code>.

discoveryApplication - Search based on realm type (LDAP, Microsoft Azure). Operator: <code>EQUALS</code>.

vpnClientApplication - Search based on vpn client application. Operator: <code>EQUALS</code>.

vpnClientOS - Search based on vpn client OS. Operator: <code>EQUALS</code>.

vpnClientPublicIP - Search based on vpn client public IP. Operator: <code>EQUALS</code>. Or search based on the subnet or range, example: 192.168.1.0/24, 192.168.0.1-192.168.0.5.

vpnConnectionProfile - Search based on vpn connection profile. Operator: <code>EQUALS</code>.

vpnGroupPolicy - Search based on vpn group policy. Operator: <code>EQUALS</code>.

vpnSessionType - Search based on vpn session type. Operator: <code>EQUALS</code>.

patRangeStart - Search based on pat range start. Operator: <code>EQUALS</code>.

userPatStart - Search based on user pat start. Operator: <code>EQUALS</code>.

userPatEnd - Search based on user pat end. Operator: <code>EQUALS</code>.

sort - Sort by specific field (ORDER BY), format:<code>{fieldName}:{asc|desc}</code>

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE identifiedusers

Request Type: DELETE

Description: Delete users. Use query parameters described below to narrow the deletion. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Required parameter, should be always set to <code>true</code>

deleteAll - Delete all users.

userIds - Delete users with given ids, format: <code>id1,id2,...</code>

id - Search based on user ID.

user - Search based on user.

lastSeen - Search based on last seen, format: {before|after}:{lastSeen} or after:{lastSeen},before:{lastSeen}, where lastSeen takes Long value (Unix Timestamp).

realmId - Search based on realm ID.

realmName - Search based on realm name.

username - Search based on username. Operator: CONTAINS (i.e. search for ana will return users with usernames ana, banana, canada).

firstName - Search based on first name.

lastName - Search based on last name.

email - Search based on email.

department - Search based on department.

phone - Search based on phone.

discoveryApplication - Search based on realm type (LDAP, AzureAD).

activeSessionCount - Search based on number of active sessions.

availableForPolicy - Search based on availability for policy.

domainUUID - Domain UUID

GETALL identifiedusers

Request Type: GETALL

Description: Get a list of identified users.

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

Query Parameters

sort - Sort by specific field (ORDER BY), format:<code>{fieldName}:{asc|desc}</code>

id - Search based on user ID.Operator: <code>EQUALS</code>.

user - Search based on user. Operator: <code>CONTAINS</code>.

lastSeen - Search based on last seen, format: <code>{before|after}:{lastSeen}</code> or <code>after:{lastSeen},before:{lastSeen}</code>, where lastSeen takes Long value (Unix Timestamp).

realmId - Search based on realm ID. Operator: <code>EQUALS</code>.

realmName - Search based on realm name. Operator: <code>EQUALS</code>.

username - Search based on username. Operator: <code>CONTAINS</code> (i.e. search for ana will return users with usernames ana, banana, canada)

firstName - Search based on first name. Operator: <code>CONTAINS</code>.

lastName - Search based on last name. Operator: <code>CONTAINS</code>.

email - Search based on email. Operator: <code>CONTAINS</code>.

department - Search based on department. Operator: <code>EQUALS</code>.

phone - Search based on phone. Operator: <code>EQUALS</code>.

discoveryApplication - Search based on realm type (LDAP, AzureAD). Operator: <code>EQUALS</code>.

activeSessionCount - Search based on number of active sessions. Operator: <code>EQUALS</code>.

availableForPolicy - Search based on availability for policy. Operator: <code>EQUALS</code>.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE useractivity

Request Type: DELETE

Description: Delete users. Use query parameters to limit which users will be deleted. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Required parameter, should be always set to <code>true</code>

deleteAll - Delete all user activities. When set to <code>true</code> event query parameters should be absent.

time - [DEV ERROR: Missing description]

event - [DEV ERROR: Missing description]

username - [DEV ERROR: Missing description]

realmName - [DEV ERROR: Missing description]

discoveryApplication - [DEV ERROR: Missing description]

authenticationType - [DEV ERROR: Missing description]

ipAddress - [DEV ERROR: Missing description]

startPort - [DEV ERROR: Missing description]

endPort - [DEV ERROR: Missing description]

description - [DEV ERROR: Missing description]

vpnSessionType - [DEV ERROR: Missing description]

vpnGroupPolicy - [DEV ERROR: Missing description]

vpnConnectionProfile - [DEV ERROR: Missing description]

vpnClientPublicIP - [DEV ERROR: Missing description]

vpnClientCountry - [DEV ERROR: Missing description]

vpnClientOS - [DEV ERROR: Missing description]

vpnClientApplication - [DEV ERROR: Missing description]

vpnConnectionDuration - [DEV ERROR: Missing description]

vpnBytesOut - [DEV ERROR: Missing description]

vpnBytesIn - [DEV ERROR: Missing description]

securityGroupTag - [DEV ERROR: Missing description]

endpointProfile - [DEV ERROR: Missing description]

endpointLocation - [DEV ERROR: Missing description]

device - [DEV ERROR: Missing description]

domainUUID - Domain UUID

GETALL useractivity

Request Type: GETALL

Description: Gets user activities.

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

Query Parameters

sort - Sort by specific field (ORDER BY), format:<code>{fieldName}:{asc|desc}</code>.

id - Search based on event. Operator: <code>EQUALS</code>.

time - Search based on the time, format: <code>{before|after}:{time}</code> or <code>after:{time},before:{time}</code>, where time takes Long value (Unix Timestamp).

event - Search based on event. Operator: <code>CONTAINS</code>.

username - Search based on username. Operator: <code>CONTAINS</code> (i.e. search for ana will return users with usernames ana, banana, canada).

realmName - Search based on realm. Operator: <code>EQUALS</code>.

discoveryApplication - Search based on realm type (LDAP, Microsoft Azure). Operator: <code>EQUALS</code>.

authenticationType - Search based on authentication type. Operator: <code>EQUALS</code>.

ipAddress - Search based on IP address. Operator: <code>EQUALS</code>. Or search based on the subnet or range, example: 192.168.1.0/24, 192.168.0.1-192.168.0.5.

startPort - Search based on start port. Operator: <code>EQUALS</code>.

endPort - Search based on end port. Operator: <code>EQUALS</code>.

description - Search based on description. Operator: <code>CONTAINS</code>

vpnSessionType - Search based on vpn session type. Operator: <code>EQUALS</code>.

vpnGroupPolicy - Search based on vpn group policy. Operator: <code>EQUALS</code>.

vpnConnectionProfile - Search based on vpn connection profile. Operator: <code>EQUALS</code>.

vpnClientPublicIP - Search based on vpn client public IP. Operator: <code>EQUALS</code>. Or search based on the subnet or range, example: 192.168.1.0/24, 192.168.0.1-192.168.0.5.

vpnClientCountry - Search based on vpn client country. Operator: <code>EQUALS</code>.

vpnClientOS - Search based on vpn client OS. Operator: <code>EQUALS</code>.

vpnClientApplication - Search based on vpn client application. Operator: <code>EQUALS</code>.

vpnConnectionDuration - Search based on vpn connection duration. Operator: <code>EQUALS</code>.

vpnBytesOut - Search based on vpn bytes transmitted. Operator: <code>EQUALS</code>.

vpnBytesIn - Search based on vpn received. Operator: <code>EQUALS</code>.

securityGroupTag - Search based on security group tag. Operator: <code>EQUALS</code>.

endpointProfile - Search based on endpoint profile. Operator: <code>EQUALS</code>.

endpointLocation - Search based on endpoint location. Operator: <code>EQUALS</code>. Or search based on the subnet or range, example: 192.168.1.0/24, 192.168.0.1-192.168.0.5.

device - Search based on device. Operator: <code>EQUALS</code>.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

Audit Services

GET auditrecords

Request Type: GET

Description: Get the audit record associated with the specified ID.

URL: /api/fmc_platform/v1/domain/{domainUUID}/audit/auditrecords/{objectId}

Query Parameters

objectId - Unique identifier of the specific object to be retrieved.

domainUUID - Domain UUID

GETALL auditrecords

Request Type: GETALL

Description: Get all audit records.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL configchanges

Request Type: GETALL

Description: Get configuration changes associated with audits.

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

Query Parameters

auditLogId - Unique identifier for a specific audit log.

snapshotId - Unique identifier for a specific audit snapshot.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

Change Management

GETALL previewchanges

Request Type: GETALL

Description: Get ticket-based changes.

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

Query Parameters

filter - The filter criteria for which the details have to be fetched - Only works when "expanded" is set to "true". Examples: ParentEntityTypes:AccessPolicy, EntityUUID:0050568C-35A0-0ed3-0000-004294969351.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET tickets

Request Type: GET

Description: Get information for the specified ticket.

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

Query Parameters

objectId - Ticket ID of ticket ID for which details are being retrieved.

history - Boolean identifier to fetch ticket history or ignore history. <code>false</code> is the default value.

domainUUID - Domain UUID

GETALL tickets

Request Type: GETALL

Description: Get all the tickets for the logged in user.

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

Query Parameters

filter - To filter by state of ticket use : <code>State:NEW</code>. For multiple states <code>State:NEW,IN_PROGRESS</code> and/or for free text search, use <code>fts:<search_string></code>

allUsers - Boolean indicating whether to include other users. Requires *review tickets* permission.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST tickets

Request Type: POST

Description: Create a change management ticket. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT tickets

Request Type: PUT

Description: Modify the specified ticket. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Ticket ID of ticket ID for which details are being modified.

domainUUID - Domain UUID

GETALL validationresults

Request Type: GETALL

Description: Get validation results for the specified ticket.

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

Users

GETALL authroles

Request Type: GETALL

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

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET duoconfigs

Request Type: GET

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

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

Query Parameters

objectId - Unique identifier of the Duo configuration.

domainUUID - Domain UUID

GETALL duoconfigs

Request Type: GETALL

Description: Get the list of all Duo configurations.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT duoconfigs

Request Type: PUT

Description: Modify the Duo configuration associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the Duo configuration.

domainUUID - Domain UUID

GET ssoconfigs

Request Type: GET

Description: Get the SSO configuration associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the SSO configuration.

domainUUID - Domain UUID

GETALL ssoconfigs

Request Type: GETALL

Description: Get the list of all SSO configurations.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT ssoconfigs

Request Type: PUT

Description: Modify the SSO configuration associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the SSO configuration.

domainUUID - Domain UUID

GET users

Request Type: GET

Description: Get the user associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the user.

domainUUID - Domain UUID

GETALL users

Request Type: GETALL

Description: Get the list of all users on the FMC.

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

Query Parameters

filter - List of user roles for filtering. Specify using the format <code>roles:user_role1,user_roleN</code>

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

Deployment Services

GETALL deployabledevices

Request Type: GETALL

Description: Get a list of all devices with configuration changes which are ready to be deployed.

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

Query Parameters

groupDependency - Boolean indicating whether the policies ready to deploy have group dependencies. Group dependency value helps to add dependent policies in Selective Policy Deployment. Results will be shown only when expanded is set to <code>true</code>. It may affect the performance of the API.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST deploymentrequests

Request Type: POST

Description: Create a request for deploying configuration changes to devices. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

GETALL deployments

Request Type: GETALL

Description: Get deployment details for a device.

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

Query Parameters

filter - Selects time range for the deployment.<br/>Value is of format <code>startTime:start_time_in_secs;endTime:end_time_in_secs;</code>. <br/><br/><code>startTime</code> -- start time in unix format (in seconds). startTime and endTime should be specified together.<br/><code>endTime</code> -- end time in unix format (in seconds). startTime and endTime should be specified together.<br/>

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL downloadreports

Request Type: GETALL

Description: Get the deployment job report for download.

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST emailreports

Request Type: POST

Description: Email the deployment job report. _Check the response section for applicable examples (if any)._

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET jobhistories

Request Type: GET

Description: Get the specified deployment job.

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

Query Parameters

objectId - UUID of the deployment job.

domainUUID - Domain UUID

GETALL jobhistories

Request Type: GETALL

Description: Gets all deployment jobs.

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

Query Parameters

filter - Various filter criteria can be specified using the format <code>deviceUUID:{uuid}; startTime:start_time_in_secs; endTime:end_time_in_secs; rollbackApplicable:true_or_false; status:job_status; jobType:job_type</code>. <br/><br/><code>startTime</code> -- start time in unix format (in seconds). startTime and endTime should be specified together.<br/><br/><code>endTime</code> -- end time in unix format (in seconds). startTime and endTime should be specified together.<br/><br/><code>rollbackApplicable</code> -- true/false. Not a mandatory field.<br/><br/><code>status</code> -- {DEPLOYING, DEPLOYED, FAILED, ABORTED, EDIT_INUSE}. Not a mandatory field.<br/><br/><code>jobType</code> -- {DEPLOYMENT, ROLLBACK, CERTIFICATE}. Not a mandatory field.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT jobhistories

Request Type: PUT

Description: Modify the specified deployment job. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - UUID of the deployment job.

domainUUID - Domain UUID

GETALL pendingchanges

Request Type: GETALL

Description: Get all policy and object changes.

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

Query Parameters

filter - The filter criteria for which the details have to be fetched - Only works when "expanded" is set to "true". Examples: ParentEntityTypes:AccessPolicy, EntityUUID:0050568C-35A0-0ed3-0000-004294969351.To fetch the historical data pass the left and right job UUID. Example LeftJobUUID:4b9fe31c-34cc-11ea-8b36-8eb5492fc3a5;RightJobUUID:4b9fe31c-34cc-11ea-8b36-8eb5492fc3a3.For filter based on User add a filter using key word UserList.Example: UserList : user1,user2.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST pendingchangesrequests

Request Type: POST

Description: Create a request for generating pending policy changes or pending CLI changes or both on devices. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

POST rollbackrequests

Request Type: POST

Description: Create a request for rollback configuration to devices. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

GETALL taskstatuses downloadreports

Request Type: GETALL

Description: Create a request to download the reports generated as a part of the task.

URL: /api/fmc_config/v1/domain/{domainUUID}/job/taskstatuses/{objectId}/operational/downloadreports

Query Parameters

objectId - ID of the task.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

Device Group Services

DELETE devicegrouprecords

Request Type: DELETE

Description: Delete the specified device group. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/devicegroups/devicegrouprecords/{objectId}

Query Parameters

objectId - UUID of the device group.

domainUUID - Domain UUID

GET devicegrouprecords

Request Type: GET

Description: Get the specified device group.

URL: /api/fmc_config/v1/domain/{domainUUID}/devicegroups/devicegrouprecords/{objectId}

Query Parameters

objectId - UUID of the device group.

domainUUID - Domain UUID

GETALL devicegrouprecords

Request Type: GETALL

Description: Get a list of all device groups.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST devicegrouprecords

Request Type: POST

Description: Create a device group. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT devicegrouprecords

Request Type: PUT

Description: Modify the specified device group. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/devicegroups/devicegrouprecords/{objectId}

Query Parameters

objectId - UUID of the device group.

domainUUID - Domain UUID

Device Clusters

GET clusterhealthmonitorsettings

Request Type: GET

Description: Get health check monitor settings of a Firewall Threat Defense cluster.

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

Query Parameters

clusterUuid - UUID of the Firewall Threat Defense cluster.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT clusterhealthmonitorsettings

Request Type: PUT

Description: Modify health check monitor settings of a Firewall Threat Defense cluster. _Check the response section for applicable examples (if any)._

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

Query Parameters

clusterUuid - UUID of the Firewall Threat Defense cluster.

partialUpdate - Boolean value which specifies whether to change the entire object or only certain attributes of the settings. If the value is true then only the attributes that are specified will change.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

POST ftdclusterdevicecommands

Request Type: POST

Description: Execute given command on the Firewall Threat Defense Cluster. _Check the response section for applicable examples (if any)._

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

Query Parameters

filter - Filter are <code>operation</code> and <code>deviceUUID</code>. Filter is of format:<code>deviceUUID:device uuid;operation:{enable|disable|control}</code>.<br/> <code>'deviceUUID'</code> is UUID of device and is a mandatory field.<br/> <code>'operation'</code> is the command that needs to be executed on device and is a mandatory field.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

POST ftdclusterreadinesscheck

Request Type: POST

Description: Check if cluster is ready to become control and if the data devices are compatible with that control. This readiness check is for platforms that support cluster bootstrap from Firewall Management Center. _Check the response section for applicable examples (if any)._

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

Query Parameters

skipControlReadiness - Boolean value, if set to "true" skips control readiness check and only checks data device compatibility with control.

domainUUID - Domain UUID

DELETE ftddevicecluster

Request Type: DELETE

Description: Delete the Firewall Threat Defense Cluster record associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Identifier of a Firewall Threat Defense Cluster.

filter - Filter clusters based on parameters. Value is of format <code>"dataDeviceIds:dataDeviceId1,dataDeviceId2,.."</code>. If no filter is provided, the entire cluster will be deleted from the Firewall Management Center.

domainUUID - Domain UUID

GET ftddevicecluster

Request Type: GET

Description: Get the Firewall Threat Defense Cluster record associated with the specified ID.

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

Query Parameters

objectId - Identifier of a Firewall Threat Defense Cluster.

liveStatus - Boolean to specify if live status of cluster nodes is required.

includeMTUValues - Boolean to specify if cluster control link and data interface MTU values are required.

domainUUID - Domain UUID

GETALL ftddevicecluster

Request Type: GETALL

Description: Get a list of all Firewall Threat Defense clusters.

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

Query Parameters

filter - Filter clusters based on parameters.<br />Value is of format <code>clusterBootstrapSupported:{true|false};analyticsOnly:{true|false}</code>.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ftddevicecluster

Request Type: POST

Description: Create a Firewall Threat Defense cluster. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT ftddevicecluster

Request Type: PUT

Description: Modify the Firewall Threat Defense Cluster record associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Identifier of a Firewall Threat Defense Cluster.

domainUUID - Domain UUID

Templates

POST apply

Request Type: POST

Description: Apply the given template resource on a list of devices. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/operational/apply

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE associations

Request Type: DELETE

Description: Removes the template association with the specified device. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/associations/{objectId}

Query Parameters

objectId - UUID of the device associated with the template.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL associations

Request Type: GETALL

Description: Get the list of devices associated with device templates.

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/associations

Query Parameters

filter - Filter devices by template.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET defaultmodelmappings

Request Type: GET

Description: Get the default model mapping for the specified device model name.

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/defaultmodelmappings/{modelName}

Query Parameters

modelName - Name of the device model.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE devicetemplates

Request Type: DELETE

Description: Delete the device template with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET devicetemplates

Request Type: GET

Description: Get the device template with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}

Query Parameters

addOnMetadata - Boolean indicating whether to include metadata in the response. Metadata includes associated variables, model mappins, and number of devices associated with the template.

validateForRegistration - Allowed values are <code>{SNOnboarding|RegKeyOnboarding}</code>.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL devicetemplates

Request Type: GETALL

Description: Get all device templates

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates

Query Parameters

filter - Filter by <code>includeOtherAssociatedPolicies </code> -- Allowed values are <code>{true|false}</code>. When set to <code>true</code>, will give following policies if assigned to device: [<code>HealthPolicy</code>, <code>RAVpn</code>, <code>FTDS2SVpn</code>, <code>PlatformSettingsPolicy</code>, <code>QosPolicy</code>, <code>NatPolicy</code>, <code>FlexConfigPolicy</code>]

addOnMetadata - Boolean indicating whether to include metadata in the response. Metadata includes associated variables, model mappins, and number of devices associated with the template.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST devicetemplates

Request Type: POST

Description: Add device template with the given payload. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates

Query Parameters

domainUUID - Domain UUID

PUT devicetemplates

Request Type: PUT

Description: Modify the device template with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

POST generatetemplate

Request Type: POST

Description: Generate a template based on a given device. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/operational/generatetemplate

Query Parameters

domainUUID - Domain UUID

DELETE modelmappings

Request Type: DELETE

Description: Remove the model mapping for the specified model mapping identifier. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/modelmappings/{objectId}

Query Parameters

objectId - Identifier of a model mapping resource.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET modelmappings

Request Type: GET

Description: Get the model mapping for the specified model mapping identifier.

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/modelmappings/{objectId}

Query Parameters

objectId - Identifier of a model mapping resource.

ticket-id - UUID of the ticket for tracking the configuration changes.

showValidationInfo - Boolean indicating whether to list the validation information if the validation state is invalid.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL modelmappings

Request Type: GETALL

Description: Get all model mappings associated with the specified device template.

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/modelmappings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

showValidationInfo - Boolean indicating whether to list the validation information if the validation state is invalid.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST modelmappings

Request Type: POST

Description: Create a new model mapping for the specified device template. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/modelmappings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT modelmappings

Request Type: PUT

Description: Modify the model mapping for the specified model mapping identifier. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/modelmappings/{objectId}

Query Parameters

objectId - Identifier of a model mapping resource.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET objectoverrides

Request Type: GET

Description: Get the object overrides list associated with the specified device template.

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/objectoverrides/{containerUUID}

Query Parameters

objectId - UUID of the device template.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT objectoverrides

Request Type: PUT

Description: Modify the object overrides list associated with the specified device template. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/objectoverrides/{containerUUID}

Query Parameters

objectId - UUID of the device template.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET supporteddevicemodels

Request Type: GET

Description: Get device template model details for the the model with the associated ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/supporteddevicemodels/{modelId}

Query Parameters

modelId - Unique identifier for the device template model.

domainUUID - Domain UUID

GETALL supporteddevicemodels

Request Type: GETALL

Description: Get the list of supported device models.

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/supporteddevicemodels

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE templateinterfaces

Request Type: DELETE

Description: Remove the specified physical interface from the device template. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/templateinterfaces/{objectId}

Query Parameters

objectId - UUID of the physical interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET templateinterfaces

Request Type: GET

Description: Get the physical interface associated with the specified ID on the device template.

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/templateinterfaces/{objectId}

Query Parameters

objectId - UUID of the physical interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL templateinterfaces

Request Type: GETALL

Description: Get all physical interfaces associated with the specified device template.

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/templateinterfaces

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST templateinterfaces

Request Type: POST

Description: Add physical interfaces to the device template. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/templateinterfaces

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL variables

Request Type: GETALL

Description: Get the variables associated with a given device template.

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/variables

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE vpnsettings

Request Type: DELETE

Description: Delete the VPN setting associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/vpnsettings/{objectId}

Query Parameters

objectId - UUID of the VPN setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET vpnsettings

Request Type: GET

Description: Get the VPN setting associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/vpnsettings/{objectId}

Query Parameters

objectId - UUID of the VPN setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL vpnsettings

Request Type: GETALL

Description: Get the list of all VPN settings associated with a device template.

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/vpnsettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST vpnsettings

Request Type: POST

Description: Create a new VPN setting for a device template. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/vpnsettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT vpnsettings

Request Type: PUT

Description: Update the VPN setting associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/vpnsettings/{objectId}

Query Parameters

objectId - UUID of the VPN setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

Device HA Pair Services

DELETE failoverinterfacemacaddressconfigs

Request Type: DELETE

Description: Delete the Firewall Threat Defense High Availability failover policy interface MAC addresses record associated with the specified Firewall Threat Defense High Availability pair. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/devicehapairs/ftddevicehapairs/{containerUUID}/failoverinterfacemacaddressconfigs/{objectId}

Query Parameters

objectId - UUID of the Firewall Threat Defense High Availability failover policy interface MAC addresses record.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET failoverinterfacemacaddressconfigs

Request Type: GET

Description: Get the Firewall Threat Defense High Availability failover policy interface MAC addresses record associated with the specified Firewall Threat Defense High Availability pair.

URL: /api/fmc_config/v1/domain/{domainUUID}/devicehapairs/ftddevicehapairs/{containerUUID}/failoverinterfacemacaddressconfigs/{objectId}

Query Parameters

objectId - UUID of the Firewall Threat Defense High Availability failover policy interface MAC addresses record.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL failoverinterfacemacaddressconfigs

Request Type: GETALL

Description: Get a list of all Firewall Threat Defense High Availability failover policy interface MAC addresses records.

URL: /api/fmc_config/v1/domain/{domainUUID}/devicehapairs/ftddevicehapairs/{containerUUID}/failoverinterfacemacaddressconfigs

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST failoverinterfacemacaddressconfigs

Request Type: POST

Description: Create a Firewall Threat Defense High Availability failover policy interface MAC addresses record. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/devicehapairs/ftddevicehapairs/{containerUUID}/failoverinterfacemacaddressconfigs

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT failoverinterfacemacaddressconfigs

Request Type: PUT

Description: Modify the Firewall Threat Defense High Availability failover policy interface MAC addresses record associated with the specified Firewall Threat Defense HA pair. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/devicehapairs/ftddevicehapairs/{containerUUID}/failoverinterfacemacaddressconfigs/{objectId}

Query Parameters

objectId - UUID of the Firewall Threat Defense High Availability failover policy interface MAC addresses record.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE ftddevicehapairs

Request Type: DELETE

Description: Delete the Firewall Threat Defense High Availability record associated with the specified ID _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/devicehapairs/ftddevicehapairs/{objectId}

Query Parameters

objectId - UUID of the Firewall Threat Defense High Availability record.

domainUUID - Domain UUID

GET ftddevicehapairs

Request Type: GET

Description: Get the Firewall Threat Defense High Availability record associated with the specified ID

URL: /api/fmc_config/v1/domain/{domainUUID}/devicehapairs/ftddevicehapairs/{objectId}

Query Parameters

objectId - UUID of the Firewall Threat Defense High Availability record.

domainUUID - Domain UUID

GETALL ftddevicehapairs

Request Type: GETALL

Description: Get a list of all Firewall Threat Defense High Availability pairs.

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

Query Parameters

filter - Filter for analytics only HA<br/><code>analyticsOnly</code> -- Allowed values are <code>{true|false}</code><br/>

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ftddevicehapairs

Request Type: POST

Description: Create a Firewall Threat Defense High Availability pair. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT ftddevicehapairs

Request Type: PUT

Description: Modify the Firewall Threat Defense High Availability record associated with the specified ID _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/devicehapairs/ftddevicehapairs/{objectId}

Query Parameters

objectId - UUID of the Firewall Threat Defense High Availability record.

ticket-id - UUID of the ticket for tracking the configuration changes.<br/>Applicable only for <code>Failover Trigger Criteria</code><br/>

domainUUID - Domain UUID

GET monitoredinterfaces

Request Type: GET

Description: Get the Firewall Threat Defense High Availabiliy Monitored interface policy record associated with the specified Firewall Threat Defense High Availability pair.

URL: /api/fmc_config/v1/domain/{domainUUID}/devicehapairs/ftddevicehapairs/{containerUUID}/monitoredinterfaces/{objectId}

Query Parameters

objectId - UUID of the Firewall Threat Defense High Availabiliy Monitored interface policy record.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL monitoredinterfaces

Request Type: GETALL

Description: Get a list of all Firewall Threat Defense HA monitored interface policy records.

URL: /api/fmc_config/v1/domain/{domainUUID}/devicehapairs/ftddevicehapairs/{containerUUID}/monitoredinterfaces

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT monitoredinterfaces

Request Type: PUT

Description: Modify the Firewall Threat Defense High Availability Monitored interface policy record associated with the specified Firewall Threat Defense High Availability pair. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/devicehapairs/ftddevicehapairs/{containerUUID}/monitoredinterfaces/{objectId}

Query Parameters

objectId - UUID of the Firewall Threat Defense High Availabiliy Monitored interface policy record.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

Device Services

DELETE bfdpolicies

Request Type: DELETE

Description: Delete the BFD policy associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a BFD policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET bfdpolicies

Request Type: GET

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

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

Query Parameters

objectId - Unique identifier of a BFD policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL bfdpolicies

Request Type: GETALL

Description: Get the list of all BFD policies.

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

Query Parameters

filter - To filter BFD policies based on hop type, use <code>hopType:{hopType}</code>. Supported hop types are Single-Hop and Multi-Hop.<br/><br/>To filter BFD policies objects based on IP type, use <code>ipType:{ipType}</code>. Supported ip types are v4 and v6.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST bfdpolicies

Request Type: POST

Description: Create a BFD policy. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT bfdpolicies

Request Type: PUT

Description: Modify the BFD policy associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a BFD policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE bgp

Request Type: DELETE

Description: Delete the specified BGP model. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a BGP (ipv4 or ipv6) model.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET bgp

Request Type: GET

Description: Get the specified BGP model.

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

Query Parameters

objectId - Unique identifier of a BGP (ipv4 or ipv6) model.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL bgp

Request Type: GETALL

Description: Get the list of all BGP (ipv4 and ipv6) associated with the specified device. When device is in multi virtual router mode, this API is applicable to Global Virtual Router.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST bgp

Request Type: POST

Description: Create a BGP model. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT bgp

Request Type: PUT

Description: Modify the specified BGP model. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a BGP (ipv4 or ipv6) model.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE bgpgeneralsettings

Request Type: DELETE

Description: Delete the specified BGP General Setting. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a BGP general settings.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET bgpgeneralsettings

Request Type: GET

Description: Get the specified BGP General Setting.

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

Query Parameters

objectId - Unique identifier of a BGP general settings.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL bgpgeneralsettings

Request Type: GETALL

Description: Get BGP general settings associated with the specified device.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST bgpgeneralsettings

Request Type: POST

Description: Create a BGP General Setting. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT bgpgeneralsettings

Request Type: PUT

Description: Modify the specified BGP General Setting. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a BGP general settings.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE bridgegroupinterfaces

Request Type: DELETE

Description: Delete the bridge group interface associated with the specified NGFW device ID and interface ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a bridge group interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET bridgegroupinterfaces

Request Type: GET

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

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

Query Parameters

objectId - Unique identifier of a bridge group interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL bridgegroupinterfaces

Request Type: GETALL

Description: Get the list of all bridge group interfaces associated with the specified NGFW device ID.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST bgpgeneralsettings

Request Type: POST

Description: Create a BGP General Setting. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT bridgegroupinterfaces

Request Type: PUT

Description: Modify the bridge group interface associated with the specified NGFW device ID and interface ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a bridge group interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

POST bulkregistrations

Request Type: POST

Description: Enable bulk registration of devices using File upload. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

POST changemanagers

Request Type: POST

Description: Migrate configuration management of FTD from FMC to SCC. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

GETALL commands

Request Type: GETALL

Description: Get the show command output from the device. Make sure the minimum device version required for using commands api is >= 6.6.0. <br/> This api supports multi threading. Only 1 request can be handled per device concurrently and across devices upto 10 devices are supported by commands api concurrently.

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

Query Parameters

command - The command filter query parameter should have value of show commands. The maximum word size of this field is 2. For eg: show failover, show snmp-server, show logging etc.<br/><b>Note:- This API endpoint retrieves outputs from devices by executing specific CLIs which return small configurations. This endpoint should not be used to retrieve large configurations as this may not work as desired or impact performance. Specific CLI commands which should not be used include "show running-config all", "show running-config access-list", and similar commands which will provide large outputs.</b><br/><code>Supported CLIs:- </code><i>show version, show version <?-option>, show failover, show failover <?-option>, show dhcpd state, show ip, show ip <?-option>, show aaa-server, show aaa-server <?-option>, show logging, show logging <?-some_option_only>, show snmp-server <?-option>, show ssl, show ssl <?-option>, show firewall, show logging, show logging <?-some_option_only>, show route, show route <?-option>, show vpn-sessiondb, show vpn-sessiondb <?-option>, show crypto <?-option>, show rule <?-option>, show access-list <?-option>, show network, show ntp, show banner, show snort3 status</i>

parameters - The parameters filter query parameter should have values containing command values exceeding word size of 2 should be given as part of parameters field. For eg: history details, engineID, setting etc.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST copyconfigrequests

Request Type: POST

Description: Copy device configuration. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

GET ddnssettings

Request Type: GET

Description: Get the DNS setting associated with the specified ID for a particular chassis platform settings policy.

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

Query Parameters

objectId - Unique identifier of the DNS setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL ddnssettings

Request Type: GETALL

Description: Get all DNS settings for a particular chassis platform settings policy.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT dynamicdnssettings

Request Type: PUT

Description: Modify the dynamic DNS setting associated with the specified ID for a particular chassis platform settings policy. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the DNS setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE devicerecords

Request Type: DELETE

Description: Delete the device record associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Identifier for device.

domainUUID - Domain UUID

GET devicerecords

Request Type: GET

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

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

Query Parameters

objectId - Identifier for device.

domainUUID - Domain UUID

GETALL devicerecords

Request Type: GETALL

Description: Get the list of all device records.

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

Query Parameters

filter - Filter to retrieve all device records based upon filter parameters specified. <br/><br/>Filter criteria should be <code>name:{name}; hostName:{hostName}; serialNumber:{ABCXXXXX};containerType:{value}; version:{x.x.x}; clusterBootstrapSupported:{true|false}; analyticsOnly:{true|false}; includeOtherAssociatedPolicies:{true|false}; modelType:{NGFW|Chassis};isMCDManaged:{true|false}</code><br/> <br/><code>containerType</code> -- Allowed values are <code>{DeviceCluster|DeviceHAPair|DeviceStack}</code><br/> <br/><code>clusterBootstrapSupported</code> -- Allowed values are <code>{true|false}</code><br/> <br/><code>analyticsOnly</code> -- Allowed values are <code>{true|false}</code><br/> <br/><code>modelType</code> -- Allowed values are <code>{NGFW|Chassis}</code>. <code>NGFW</code> fetches all NGFW devices. <code>Chassis</code> fetches all FXOS chassis (also known as MIO). If you don't specify the type, then all devices and chassis are fetched.</br> </br><code>includeOtherAssociatedPolicies</code> -- Allowed values are <code>{true|false}</code>. When set to <code>true</code>, will give following policies if assigned to device: [<code>RAVpn</code>,<code>FTDS2SVpn</code>, <code>PlatformSettingsPolicy</code>, <code>QosPolicy</code>, <code>NatPolicy</code>, <code>FlexConfigPolicy</code>]<br/> <br/><code>isMCDManaged</code> -- Allowed values are <code>{true|false}</code>

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST devicerecords

Request Type: POST

Description: Register the device or devices. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean value indicating whether this is performed as a bulk operation.

skipEarlyTemplateApplyValidations - Boolean value indicating whether to skip the early validation of the template parameter values if provided. <code>false</code> by default.

domainUUID - Domain UUID

PUT devicerecords

Request Type: PUT

Description: Modify the device record associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Identifier for device.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET devicesettings

Request Type: GET

Description: Get the specific device setting.

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL devicesettings

Request Type: GETALL

Description: Get the device settings.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT domain_devicesettings

Request Type: PUT

Description: Create a specific device setting. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean value indicating whether this is performed as a bulk operation.

domainUUID - Domain UUID

GET dhcprelaysettings

Request Type: GET

Description: Get the DHCP relay settings associated with the specified device.

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

Query Parameters

objectId - Unique identifier of Device. Same as container UUID.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL dhcprelaysettings

Request Type: GETALL

Description: Get a list of DHCP relay settings.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT dhcprelaysettings

Request Type: PUT

Description: Modify the specified DHCP relay settings. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of Device. Same as container UUID.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET dhcpserver

Request Type: GET

Description: Get the specified DHCP server policy.

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

Query Parameters

objectId - Unique identifier of Device. Same as container UUID.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL dhcpserver

Request Type: GETALL

Description: Get a list of DHCP server policies.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT dhcpserver

Request Type: PUT

Description: Modify the specified DHCP server policy. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of Device. Same as container UUID.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL downloadsamplecsv

Request Type: GETALL

Description: Get sample csv for download. Sample csv contains the required header details that have to be used for the registration of devices using template.

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

Query Parameters

onboardingMethod - Specifies the onboarding method. Possible values are <code>SERIAL_NUMBER</code> and <code>REGISTRATION_KEY</code>.

templateUuid - UUID of the device template.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE ecmpzones

Request Type: DELETE

Description: Delete the ECMP Zone associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a ECMP Zone.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET ecmpzones

Request Type: GET

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

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

Query Parameters

objectId - Unique identifier of a ECMP Zone.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL ecmpzones

Request Type: GETALL

Description: Get the list of all ECMP Zones.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ecmpzones

Request Type: POST

Description: Create an ECMP Zone. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT ecmpzones

Request Type: PUT

Description: Modify the ECMP Zone associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a ECMP Zone.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE eigrproutes

Request Type: DELETE

Description: Delete the EIGRP entry associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a EIGRP.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET eigrproutes

Request Type: GET

Description: Get the EIGRP entry associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of a EIGRP.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL eigrproutes

Request Type: GETALL

Description: Get the list of all EIGRP entries.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST eigrproutes

Request Type: POST

Description: Create an EIGRP entry. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT eigrproutes

Request Type: PUT

Description: Modify the EIGRP entry associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a EIGRP.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE devices_etherchannelinterfaces

Request Type: DELETE

Description: Delete the specified ethernet channel interface. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a ethernet channel interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET etherchannelinterfaces

Request Type: GET

Description: Get the specified ethernet channel interface.

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

Query Parameters

objectId - Unique identifier of a ethernet channel interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL devices_etherchannelinterfaces

Request Type: GETALL

Description: Get the list of all ethernet channel interfaces associated with the specified NGFW device ID.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST devices_etherchannelinterfaces

Request Type: POST

Description: Create an ethernet channel interface. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT devices_etherchannelinterfaces

Request Type: PUT

Description: Modify the specified ethernet channel interface. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a ethernet channel interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

POST exports

Request Type: POST

Description: Migrate configuration management of FTD from FMC to CDO. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

GETALL fpinterfacestatistics

Request Type: GETALL

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

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE fplogicalinterfaces

Request Type: DELETE

Description: Delete the logical interface associated with the specified NGIPS device ID and interface ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a logical interface.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET fplogicalinterfaces

Request Type: GET

Description: Get the logical interface associated with the specified NGIPS device ID and interface ID.

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

Query Parameters

objectId - Unique identifier of a logical interface.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL fplogicalinterfaces

Request Type: GETALL

Description: Get the list of all logical interfaces associated with the specified NGIPS device ID.

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST fplogicalinterfaces

Request Type: POST

Description: Create a logical interface. _Check the response section for applicable examples (if any)._

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT fplogicalinterfaces

Request Type: PUT

Description: Modify the logical interface associated with the specified NGIPS device ID and interface ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a logical interface.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET fpphysicalinterfaces

Request Type: GET

Description: Get the physical interface associated with the specified NGIPS device ID and interface ID.

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

Query Parameters

objectId - Unique identifier of a physical interface.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL fpphysicalinterfaces

Request Type: GETALL

Description: Get the list of all physical interfaces associated with the specified NGIPS device ID.

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT fpphysicalinterfaces

Request Type: PUT

Description: Modify the physical interface associated with the specified NGIPS device ID and interface ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a physical interface.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL ftdallinterfaces

Request Type: GETALL

Description: Get all types of interfaces.

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

Query Parameters

filter - This is a query parameter to fetch specific type of interfaces. Supported Filter Criteria are : <code>cclEligibleInterface:{boolean}; interfaceMode:{mode}; virtualRouterId:{uuid}; named:{boolean}; clusterHealthCheckEligibleMonitorInterfaces:{boolean}; s2sVpnApplicableInterfaces:{boolean}; includeParentDomain:{boolean}; name:{string};</code> <br /> <code> cclEligibleInterface </code> : Filter to get ccl eligible interface, filter value should always be <code>true</code>. <br> <code> interfaceMode </code> : Filter using interface mode.Supported only for routed device. Allowed value is <code>ROUTED</code> Cannot be used with cclEligibleInterface filter. <br/> <code>virtualRouterId </code> : Supported only for routed device. Cannot be used with cclEligibleInterface filter. <br /> <code> named </code> : Supported only for routed device. Cannot be used with cclEligibleInterface filter.<br /> <code> clusterHealthCheckEligibleMonitorInterfaces </code> : Filter to get eligible interfaces for cluster health check monitoring/ un-monitoring, filter value should always be <code> true </code>. Cannot be used with cclEligibleInterface filter.<br /> <code> s2sVpnApplicableInterfaces </code> : Filter to get interfaces which are applicable in S2S VPN, filter value should always be true. Does not include VTI interfaces. Supported only for routed device. Cannot be used with other filters. <br/> <code> includeParentDomain </code> : Filter to fetch interfaces of a device in a parent/ ancestral domain, filter value must always be true.<br /> <code> name </code> : Filter to get interfaces with ifnames and hardware names that match the filter string passed.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST imports

Request Type: POST

Description: Package and export device configuration of specified Firewall Threat Defenses. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

DELETE inlinesets

Request Type: DELETE

Description: Delete the inline set associated with the specified NGIPS device ID and inline set ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the inline set.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET inlinesets

Request Type: GET

Description: Get the inline set associated with the specified NGIPS device ID and inline set ID.

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

Query Parameters

objectId - Unique identifier of the inline set.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL inlinesets

Request Type: GETALL

Description: Get the list of all inline sets associated with the specified NGIPS device ID.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST inlinesets

Request Type: POST

Description: Create an inline set on the specified NGIPS device. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT inlinesets

Request Type: PUT

Description: Modify the inline set associated with the specified NGIPS device ID and inline set ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the inline set.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL interfaceevents

Request Type: GETALL

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

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST interfaceevents

Request Type: POST

Description: Create a netmod event on the device. _Check the response section for applicable examples (if any)._

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE ipv4staticroutes

Request Type: DELETE

Description: Delete the IPv4 Static Route associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a IPv4 Static Route.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET ipv4staticroutes

Request Type: GET

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

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

Query Parameters

objectId - Unique identifier of a IPv4 Static Route.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL ipv4staticroutes

Request Type: GETALL

Description: Get the list of all IPv4 Static routes. When device is in multi virtual router mode, this API is applicable to Global Virtual Router.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ipv4staticroutes

Request Type: POST

Description: Create an IPv4 Static route. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean value indicating whether this is performed as a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT ipv4staticroutes

Request Type: PUT

Description: Modify the IPv4 Static Route associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a IPv4 Static Route.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE ipv6staticroutes

Request Type: DELETE

Description: Delete the IPv6 Static Route associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a IPv6 Static Route.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET ipv6staticroutes

Request Type: GET

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

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

Query Parameters

objectId - Unique identifier of a IPv6 Static Route.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL ipv6staticroutes

Request Type: GETALL

Description: Get the list of all IPv6 Static routes. When device is in multi virtual router mode, this API is applicable to Global Virtual Router.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ipv6staticroutes

Request Type: POST

Description: Create an IPv6 Static route. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean value indicating whether this is performed as a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT ipv6staticroutes

Request Type: PUT

Description: Modify the IPv6 Static Route associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a IPv6 Static Route.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE loopbackinterfaces

Request Type: DELETE

Description: Delete the specified loopback interface. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a loopback interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET loopbackinterfaces

Request Type: GET

Description: Get the specified loopback interface.

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

Query Parameters

objectId - Unique identifier of a loopback interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL loopbackinterfaces

Request Type: GETALL

Description: Get the list of all loopback interfaces on the NGFW device.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST loopbackinterfaces

Request Type: POST

Description: Create a loopback interface on the specified NGFW device. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT loopbackinterfaces

Request Type: PUT

Description: Modify the specified loopback interface. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a loopback interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE ltpdevicerecords

Request Type: DELETE

Description: Delete the Zero Touch Provisioned(ZTP) device associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/ltpdevicerecords/{objectId}

Query Parameters

objectId - Unique identifier of the ZTP device.

domainUUID - Domain UUID

GET ltpdevicerecords

Request Type: GET

Description: Get the Zero Touch Provisioned(ZTP) device associated with the specified ID. This API endpoint can be used to track the onboarding status of ZTP device until the ZTP onboarding transitions into device registration in the FMC.ILTPDeviceRecord.GET.objectId=Unique identifier of the ZTP device.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/ltpdevicerecords/{objectId}

Query Parameters

objectId - Unique identifier of the ZTP device.

domainUUID - Domain UUID

GETALL ltpdevicerecords

Request Type: GETALL

Description: Get the list of all devices onboarded through Zero Touch Provisioning(ZTP). This API endpoint can be used to track the onboarding status of ZTP devices until the ZTP onboarding transitions into device registration in the FMC.

URL: /api/fmc_config/v1/domain/{domainUUID}/devices/ltpdevicerecords

Query Parameters

filter - Filter to retrieve ZTP devices based on serialNumber or status. For example: serialNumber:JAD20001ADD,status:CLAIM_PENDING.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL managementconvergencemode

Request Type: GETALL

Description: Get the convergence state of the device.

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

Query Parameters

checkConvergenceReadiness - Boolean indicating to list all the usages of the Management interface when the device is non converged.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST managementconvergencemode

Request Type: POST

Description: Modify the convergence state of the device. _Check the response section for applicable examples (if any)._

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

Query Parameters

ignoreWarning - Boolean indicationg to merge the management interface even if there are warnings.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL metrics

Request Type: GETALL

Description: Get HealthMonitor metrics for the device.

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

Query Parameters

filter - The metric filter query parameter should have healthmonitor name. Currently supports only <code>metric:memory & metric:cpu</code>

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST modelmigrations

Request Type: POST

Description: Create a request to migrate configurations from Firepower Threat Defense 1100, 2100, 4100, or 9300 Series to Secure Firewall 3100 or 4200 Series. Check the response section for applicable examples (if any).

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

Query Parameters

validateOnly - Validates the migration request before migrating the configurations. If the value is true and the request is invalid then validation errors are displayed. If the value is false and the request is valid, the migration task will start. If the request is invalid, validation errors are displayed.

ignoreWarning - Ignore the warning messages for the model migration operation. If the value is true, the warning messages are ignored. If the value is false, the warning messages are displayed.

domainUUID - Domain UUID

DELETE ospfinterface

Request Type: DELETE

Description: Delete the specified OSPF interface. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a OSPF Interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET ospfinterface

Request Type: GET

Description: Get the OSPF interface associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of a OSPF Interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL ospfinterface

Request Type: GETALL

Description: Get the list of all OSPF interfaces. When device is in multi virtual router mode, this API is applicable to Global Virtual Router.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ospfinterface

Request Type: POST

Description: Create an OSPF interface. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT ospfinterface

Request Type: PUT

Description: Modify the specified OSPF interface. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

objectId - Unique identifier of a OSPF Interface.

DELETE virtual ospfv2routes

Request Type: DELETE

Description: Delete the specified virtual OSPFv2 route on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a OSPFv2 route.

ticket-id - UUID of the ticket for tracking the configuration changes.

virtualrouterUUID - UUID of the virtual router.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET ospfv2routes

Request Type: GET

Description: Get the OSPFv2 route associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of a OSPFv2 route.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL ospfv2routes

Request Type: GETALL

Description: Get the list of all OSPFv2 routes. When device is in multi virtual router mode, this API is applicable to Global Virtual Router.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ospfv2routes

Request Type: POST

Description: Create an OSPFv2 route. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT ospfv2routes

Request Type: PUT

Description: Modify the specified OSPFv2 route. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a OSPFv2 Route.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE ospfv3interfaces

Request Type: DELETE

Description: Delete the OSPFv3 interface associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of a OSPFv3 Interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET ospfv3interfaces

Request Type: GET

Description: Get the OSPFv3 interface associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of a OSPFv3 Interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL ospfv3interfaces

Request Type: GETALL

Description: Get the list of all OSPFv3 interfaces. When device is in multi virtual router mode, this API is applicable to Global Virtual Router.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ospfv3interfaces

Request Type: POST

Description: Create an OSPFv3 interface.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT ospfv3interfaces

Request Type: PUT

Description: Modify the OSPFv3 interface associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of a OSPFv3 Interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE ospfv3routes

Request Type: DELETE

Description: Delete the OSPFv3 route associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of a OSPFv3 Interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET ospfv3interfaces

Request Type: GET

Description: Get the OSPFv3 interface associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of a OSPFv3 Interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL ospfv3routes

Request Type: GETALL

Description: Get the list of all OSPFv3 routes. When device is in multi virtual router mode, this API is applicable to Global Virtual Router.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ospfv3routes

Request Type: POST

Description: Create an OSPFv3 route. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT ospfv3routes

Request Type: PUT

Description: Modify the OSPFv3 interface associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a OSPFv3 Interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL outofbandchanges

Request Type: GETALL

Description: Get out of band changes on the device.

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST outofbandchanges

Request Type: POST

Description: Trigger and acknowledge out of band changes on the device. _Check the response section for applicable examples (if any)._

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET physicalinterfaces

Request Type: GET

Description: Get the physical interface associated with the specified NGFW device ID and interface ID.

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

Query Parameters

objectId - Unique identifier of the NGFW physical interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL physicalinterfaces

Request Type: GETALL

Description: Get the list of all physical interfaces associated with the specified NGFW device ID.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT physicalinterfaces

Request Type: PUT

Description: Modify the physical interface associated with the specified NGFW device ID and interface ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the NGFW physical interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE policybasedroutes

Request Type: DELETE

Description: Delete the policy-based route associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a policy-based route.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET policybasedroutes

Request Type: GET

Description: Get the policy-based route associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of a policy-based route.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL policybasedroutes

Request Type: GETALL

Description: Get the list of all policy-based routes.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST policybasedroutes

Request Type: POST

Description: Create a policy-based route. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean value indicating whether this is performed as a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT policybasedroutes

Request Type: PUT

Description: Modify the policy-based route associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a policy-based route.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE redundantinterfaces

Request Type: DELETE

Description: Delete the redundant interface associated with the specified NGFW device ID and interface ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a redundant interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET redundantinterfaces

Request Type: GET

Description: Get the redundant interface associated with the specified NGFW device ID and interface ID.

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

Query Parameters

objectId - Unique identifier of a redundant interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL redundantinterfaces

Request Type: GETALL

Description: Get the list of all redundant interfaces associated with the specified NGFW device ID.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST redundantinterfaces

Request Type: POST

Description: Create a redundant interface on the NGFW device. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT redundantinterfaces

Request Type: PUT

Description: Modify the redundant interface associated with the specified NGFW device ID and interface ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a redundant interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET staticroutes

Request Type: GET

Description: Get the static route associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of a Static Route.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL staticroutes

Request Type: GETALL

Description: Get list of all Static routes (ipv4 and ipv6) associated with the specified device. When device is in multi virtual router mode, this API is applicable to Global Virtual Router.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE subinterfaces

Request Type: DELETE

Description: Delete the sub-interface associated with the specified NGFW device ID and interface ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a sub-interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET subinterfaces

Request Type: GET

Description: Get the sub-interface associated with the specified NGFW device ID and interface ID.

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

Query Parameters

objectId - Unique identifier of a sub-interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL subinterfaces

Request Type: GETALL

Description: Get the list of all sub-interfaces associated with the specified NGFW device ID.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST subinterfaces

Request Type: POST

Description: Create a subinterface on the specified NGFW device. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean value indicating whether this is performed as a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT subinterfaces

Request Type: PUT

Description: Modify the sub-interface associated with the specified NGFW device ID and interface ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a sub-interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL virtualaccessinterfaces

Request Type: GETALL

Description: [DEV ERROR: Missing description]

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

Query Parameters

filter - [DEV ERROR: Missing description]

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE virtual bfdpolicies

Request Type: DELETE

Description: Delete the BFD policy with the specified ID on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a BFD policy.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETvirtual bfdpolicies

Request Type: GET

Description: Get the BFD policy with the specified ID on the specified virtual router.

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

Query Parameters

objectId - Unique identifier of a BFD policy.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL virtual bfdpolicies

Request Type: GETALL

Description: Get the list of all BFD policies on the specified virtual router.

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

Query Parameters

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST virtual bfdpolicies

Request Type: POST

Description: Create a BFD policy on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT virtual bfdpolicies

Request Type: PUT

Description: Modify the BFD policy with the specified ID on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a BFD policy.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE virtual bgp

Request Type: DELETE

Description: Delete the specified BGP model on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a BGP (ipv4 or ipv6) model.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET virtual bgp

Request Type: GET

Description: Get the specified BGP model on the specified virtual router.

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

Query Parameters

objectId - Unique identifier of a BGP (ipv4 or ipv6) model.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL virtual bgp

Request Type: GETALL

Description: Get the list of all BGP (ipv4 and ipv6) on the specified virtual router.

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

Query Parameters

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST virtual bgp

Request Type: POST

Description: Create a BGP model on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT virtual bgp

Request Type: PUT

Description: Modify the specified BGP model on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a BGP (ipv4 or ipv6) model.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE virtual ecmpzones

Request Type: DELETE

Description: Delete the ECMP Zone associated with the specified ID on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the ECMP Zone.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET virtual ecmpzones

Request Type: GET

Description: Get the ECMP Zone associated with the specified ID on the specified virtual router.

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

Query Parameters

objectId - Unique identifier of a ECMP Zone.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL virtual ecmpzones

Request Type: GETALL

Description: Get the list of all ECMP Zones on the specified virtual router.

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

Query Parameters

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST virtual ecmpzones

Request Type: POST

Description: Create an ECMP Zone on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT virtual ecmpzones

Request Type: PUT

Description: Modify the ECMP Zone associated with the specified ID on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a ECMP Zone.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE virtual eigrproutes

Request Type: DELETE

Description: Delete the EIGRP entry associated with the specified ID on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a EIGRP.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET virtual eigrproutes

Request Type: GET

Description: Get the EIGRP entry associated with the specified ID on the specified virtual router.

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

Query Parameters

objectId - Unique identifier of a EIGRP.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL virtual eigrproutes

Request Type: GETALL

Description: Get the list of all EIGRP entries on the specified virtual router.

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

Query Parameters

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST virtual eigrproutes

Request Type: POST

Description: Create an EIGRP entry on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT virtual eigrproutes

Request Type: PUT

Description: Modify the EIGRP entry associated with the specified ID on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a EIGRP.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE virtual ipv4staticroutes

Request Type: DELETE

Description: Delete the IPv4 Static Route associated with the specified ID on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a IPv4 Static Route.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET virtual ipv4staticroutes

Request Type: GET

Description: Get the IPv4 Static Route associated with the specified ID on the specified virtual router.

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

Query Parameters

objectId - Unique identifier of a IPv4 Static Route.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL virtual ipv4staticroutes

Request Type: GETALL

Description: Get the list of all IPv4 Static routes on the specified virtual router.

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

Query Parameters

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST virtual ipv4staticroutes

Request Type: POST

Description: Create an IPv4 Static route on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT virtual ipv4staticroutes

Request Type: PUT

Description: Modify the IPv4 Static Route associated with the specified ID on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a IPv4 Static Route.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE virtual ipv6staticroutes

Request Type: DELETE

Description: Delete the IPv6 Static Route associated with the specified ID on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a IPv6 Static Route.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET virtual ipv6staticroutes

Request Type: GET

Description: Get the IPv6 Static Route associated with the specified ID on the specified virtual router.

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

Query Parameters

objectId - Unique identifier of a IPv6 Static Route.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL virtual ipv6staticroutes

Request Type: GETALL

Description: Get the list of all IPv6 Static routes on the specified virtual router.

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

Query Parameters

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST virtual ipv6staticroutes

Request Type: POST

Description: Create an IPv6 Static route on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT virtual ipv6staticroutes

Request Type: PUT

Description: Modify the IPv6 Static Route associated with the specified ID on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a IPv6 Static Route.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE virtualospfinterface

Request Type: DELETE

Description: Delete the specified OSP interface on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

objectId - Unique identifier of a OSPF Interface.

GET virtual ospfinterface

Request Type: GET

Description: Get the OSPF interface associated with the specified ID on the specified virtual router.

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

Query Parameters

objectId - Unique identifier of a OSPF Interface Policy.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL virtual ospfinterface

Request Type: GETALL

Description: Get the list of all OSPF interfaces on the specified virtual router.

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

Query Parameters

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST virtual ospfinterface

Request Type: POST

Description: Create an OSPF interface on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT virtual ospfinterface

Request Type: PUT

Description: Modify the OSPF interface associated with the specified ID on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a OSPF Interface Policy.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE virtual ospfv2routes

Request Type: DELETE

Description: Delete the specified OSPFv2 route on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a OSPFv2 Route.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET virtual ospfv2routes

Request Type: GET

Description: Get the OSPFv2 route associated with the specified ID on the specified virtual router.

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

Query Parameters

objectId - Unique identifier of a OSPFv2 route.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL virtual ospfv2routes

Request Type: GETALL

Description: Get the list of all OSPFv2 routes on the specified virtual router.

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

Query Parameters

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST virtual ospfv2routes

Request Type: POST

Description: Create an OSPFv2 route on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT virtual ospfv2routes

Request Type: PUT

Description: Modify the OSPFv2 Route associated with the specified ID on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a OSPFv2 Route.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE virtual policybasedroutes

Request Type: DELETE

Description: Delete the policy-based route associated with the specified ID on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a policy-based route.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET virtual policybasedroutes

Request Type: GET

Description: Get the policy-based route associated with the specified ID on the specified virtual router.

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

Query Parameters

objectId - Unique identifier of a policy-based route.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL virtual policybasedroutes

Request Type: GETALL

Description: Get the list of all policy-based routes on the specified virtual router.

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

Query Parameters

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST virtual policybasedroutes

Request Type: POST

Description: Create a policy-based route on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT virtual policybasedroutes

Request Type: PUT

Description: Modify the policy-based route associated with the specified ID on the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a policy-based route.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE virtualrouters

Request Type: DELETE

Description: Delete the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET virtualrouters

Request Type: GET

Description: Get the specified virtual router.

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

Query Parameters

objectId - Unique identifier of a virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL virtualrouters

Request Type: GETALL

Description: Get the list of all virtual routers created in the specified device.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST virtualrouters

Request Type: POST

Description: Create a virtual router on the specified device. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT virtualrouters

Request Type: PUT

Description: Modify the specified virtual router. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET virtual staticroutes

Request Type: GET

Description: Get the static route associated with the specified ID on the specified virtual router.

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

Query Parameters

objectId - Unique identifier of a Static Route.

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL virtual staticroutes

Request Type: GETALL

Description: Get the list of all Static routes (ipv4 and ipv6) associated with the specified device on the specified virtual router.

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

Query Parameters

virtualrouterUUID - UUID of the virtual router.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE virtualswitches

Request Type: DELETE

Description: Delete the virtual switch associated with the specified NGIPS device ID and virtual switch ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a virtual switch.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET virtualswitches

Request Type: GET

Description: Get the virtual switch associated with the specified NGIPS device ID and virtual switch ID.

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

Query Parameters

objectId - Unique identifier of a virtual switch.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL virtualswitches

Request Type: GETALL

Description: Get the list of all virtual switches associated with the specified NGIPS device ID.

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST virtualswitches

Request Type: POST

Description: Create a virtual switch on the specified NGIPS device. _Check the response section for applicable examples (if any)._

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT virtualswitches

Request Type: PUT

Description: Modify the virtual switch associated with the specified NGIPS device ID and virtual switch ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a virtual switch.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE virtualtunnelinterfaces

Request Type: DELETE

Description: Delete the virtual tunnel interface associated with the specified NGFW device and interface ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a virtual tunnel interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET virtualtunnelinterfaces

Request Type: GET

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

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

Query Parameters

objectId - Unique identifier of a virtual tunnel interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL virtualtunnelinterfaces

Request Type: GETALL

Description: Get the list of virtual tunnel interfaces associated with the specified NGFW device.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST virtualtunnelinterfaces

Request Type: POST

Description: Create a virtual tunnel interface on the specified NGFW device. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean value indicating whether this is performed as a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT virtualtunnelinterfaces

Request Type: PUT

Description: Modify the virtual tunnel interface associated with the specified NGFW device and interface ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a virtual tunnel interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE vlaninterfaces

Request Type: DELETE

Description: Delete the VLAN interface associated with the specified NGFW device and interface ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a VLAN interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET vlaninterfaces

Request Type: GET

Description: Get the VLAN interface associated with the specified NGFW device and interface ID.

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

Query Parameters

objectId - Unique identifier of a VLAN interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL vlaninterfaces

Request Type: GETALL

Description: Get the list of VLAN interfaces associated with the specified NGFW device.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST vlaninterfaces

Request Type: POST

Description: Create a VLAN interface on the specified NGFW device. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT vlaninterfaces

Request Type: PUT

Description: Modify the VLAN interface associated with the specified NGFW device and interface ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a VLAN interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE vniinterfaces

Request Type: DELETE

Description: Delete the VNII interface associated with the specified NGFW device and interface ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a VNII interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET vniinterfaces

Request Type: GET

Description: Get the VNII interface associated with the specified NGFW device and interface ID.

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

Query Parameters

objectId - Unique identifier of a VNII interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL vniinterfaces

Request Type: GETALL

Description: Get the list of VNII interfaces associated with the specified NGFW device.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST vniinterfaces

Request Type: POST

Description: Create a VNII interface on the specified NGFW device. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT vniinterfaces

Request Type: PUT

Description: Modify the VNII interface associated with the specified NGFW device and interface ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a VNII interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE vteppolicies

Request Type: DELETE

Description: Delete the specified VTEP policy. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a VTEP policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET vteppolicies

Request Type: GET

Description: Get the specified VTEP policy.

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

Query Parameters

objectId - Unique identifier of a VTEP policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL vteppolicies

Request Type: GETALL

Description: Get the list of VTEP policies on the specified NGFW device.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST vteppolicies

Request Type: POST

Description: Create a VTEP policy on the specified NGFW device. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT vteppolicies

Request Type: PUT

Description: Modify the specified VTEP policy. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of a VTEP policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

Health Services

GETALL aggregatemetrics

Request Type: GETALL

Description: Get metrics related to the health of the device and interface attributes.

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

Query Parameters

filter - Metrics are governed by health policies deployed on the FTD. If the health module is disabled, there is a chance that metric data wont be available or is incomplete.<br/>Filter criteria can be specified using the format <code>device_uuid:deviceUuid; metric:metric_name; timeRange:range.</code><br/><br/><code>device_uuid</code> -- Identifier for device. There can only be one device offered per request. This is a mandatory parameter in the filter query.<br/><code>metric</code> -- Indicates the metric to be queried. Possible values are CPU, MEM, INTERFACE, DISK_STATS, and CHASSIS_STATS. If this filter is not used, all available metrics are retrieved.<br><code>timeRange</code> -- Enum which aids in retrieving the average metrics for time intervals. Possible values are 5m, 15m, 30m, and 1h. If this filter is not used, the average of the last five minutes will be shown by default.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL alerts

Request Type: GETALL

Description: Get health alerts.

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

Query Parameters

filter - Various filter criteria can be specified using the format <code>startTime:start_time_in_secs;endTime:end_time_in_secs;deviceUUIDs:List_of_device_uuids; status:List_of_statuses; moduleIDs:List_of_moduleIDs.</code><br/> <br/><code>startTime</code> -- start time in unix format - startTime and endTime should be specified together<br/><code>endTime</code> -- end time in unix format - startTime and endTime should be specified together<br/><code>deviceUUIDs</code> -- List of device UUIDs (UUID is 0 for Firewall Management Center).<br/> <code>status</code> -- List of status codes to filter delimited by comma, e.g. green,red,yellow.<br/> <code>moduleIDs</code> -- List of module ids to filter, delimited by comma.<br/>.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL events

Request Type: GETALL

Description: Get health events.

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

Query Parameters

filter - Various filter criteria can be specified using the format <code>startTime:start_time_in_secs; endTime:end_time_in_secs; deviceUUIDs:List_of_device_uuids; status:List_of_statuses; moduleIDs:List_of_moduleIDs or "all". </code><br/><br/><code>startTime</code> -- start time in unix format - startTime and endTime should be specified together<br/><code>endTime</code> -- end time in unix format - startTime and endTime should be specified together<br/><code>deviceUUIDs</code> -- List of device UUIDs (UUID is 0 for Firewall Management Center).<br/><code>status</code> -- List of status codes to filter delimited by comma, e.g. NORMAL,CRITICAL,WARNING.<br/><code>moduleIDs</code> -- List of module ids to filter, delimited by comma or "all" (without the quotes) to get descriptive events for all modules per device.<br/>.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL metrics

Request Type: GETALL

Description: Get health metrics for the device. The metrics are governed by respective health modules under Health policy.The health module should be enabled before trying to fetch the metric with this API.

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

Query Parameters

filter - Various filter criteria can be specified using the format <code>deviceUUIDs:uuid1,uuid2;metric:metric_name;startTime:start_time_in_secs; endTime:end_time_in_secs;step:step_in_secs; regexFilter:filter_on_metric</code><br/> <br/><code>deviceUUIDs</code> --List UUID of the device to be queried.<br/><code>metric</code> -- name of the prometheus metric to be queried. This is mandatory parameter in the filter query. Possible values are <code>1)cpu 2)mem 3)interface 4)asp_drops 5)disk_stats 6)critical_process etc. For detailed metric information contact HM team.</code><br/> <code>startTime</code> -- start time in unix format seconds.This is mandatory parameter in the filter query.<br/><code>endTime</code> -- end time in unix format seconds.This is mandatory parameter in the filter query.<br/><code>step</code> -- step interval in seconds over which the data is returned.This is mandatory parameter in the filter query.<br/> <code>regexFilter</code> -- filter to be applied on the metric names. Supports GO style regex e.g snort.&#42; &#124; lina.&#42; Optional parameter in the filter query. <br/> <code>queryFunction</code> -- optional query function which has to be applied to the query, can be one of <code>"avg", "rate", "min", "max"</code><br/> <code>rateFunctionInterval</code> -- optional interval which has to be applied to the rate function, for e.g five minutes should be specified as <code>5m</code><br/>. For e.g. to query all the memory metrics for LINA the filter parameter should be <code>deviceUUID:<uuid>;metric:mem;startTime:<time>;endTime:<time>;step:60; regexFilter:used_percentage_lina</code>

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL pathmonitoredinterfaces

Request Type: GETALL

Description: Get path-monitored interfaces.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL ravpngateways

Request Type: GETALL

Description: Get the Remote Access VPN Gateway Details. This includes RA VPN Certificate expiry dates and maximum sessions supported.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST terminateravpnsessions

Request Type: POST

Description: Terminate active VPN sessions _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

GETALL tunneldetails

Request Type: GETALL

Description: Get tunnel details for Site-to-Site VPN by executing show commands on managed peers.

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET tunnelstatuses

Request Type: GET

Description: Get status for the specified Firewall Threat Defense Site-to-Site VPN topology.

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

Query Parameters

objectId - Identifier for Firewall Threat Defense Site to Site VPN topology.

domainUUID - Domain UUID

GETALL tunnelstatuses

Request Type: GETALL

Description: Get tunnel status for the Site-to-Site VPN on all managed Firewall Threat Defense devices.

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

Query Parameters

filter - The allowed filters are <code>"vpnTopologyId:{uuid}"</code> which filters the tunnel statuses by S2S VPN Topology id, <code>"deviceId:{UUID}"</code> which filters the tunnel statuses by Device id, <code>status:{TUNNEL_UP|TUNNEL_DOWN|UNKNOWN}</code> which filters the tunnel statuses by Tunnel Status, <code>"deployedStatus:{Deployed|Configured|Both}"</code> which is filters the tunnel status by it's deployed state and <code>"sortBy{:|<|>}{Topology|Device|Status|LastChange}"</code>. Filter operators `:` and `<` sorts in ascending order and `>` sorts in descending order.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL tunnelsummaries

Request Type: GETALL

Description: Get aggregated summary of tunnel status for S2S VPN on all managed Firewall Threat Defense devices.

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

Query Parameters

filter - The allowed filters are <code>"vpnTopologyId:{uuid}"</code> which filters the tunnel summary by S2S VPN Topology id, <code>"deviceId:{UUID}"</code> which filters the tunnel summary by Device id and groupBy <code>"groupBy:Topology|Device"</code> which groups tunnel summary by Topology or Device.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

List of Health Modules

Available Health Modules for all Device Health endpoints

Name Description
APPLICATION_BYPASS Bypass Alerts
CARD_RESET Network Card Reset
CPU CPU Core alerts
CPU_LINA CPU LINA alerts
CPU_SNORT CPU Snort Alerts
CPU_SYSTEM System CPU Alerts
DISK_USAGE Disk Usage related Alerts
EVENT_STREAM Event Stream Alerts
HEALTH_MONITOR Devices sending alerts correctly or not
HEARTBEAT NA
INTERFACE Interface related Alerts
HARDWARE_ALARM Hardware Alarms
POWER_SUPPLY Hardware Power Supply Alerts
LICENSE NA
LICENSE_MONITOR Classic Licence alerts
LINKSTATE_PROPAGATION Link State Propagation Alerts
MEMORY_USAGE Memory Usage Alerts
MEMORY_USAGE_LINA Memory Usage for Lina Alerts
MEMORY_USAGE_SNORT Memory Usage for Snort Alerts
PEP NA
PROCESS NA
DISCOVERY_HEALTH NA
HOST_LIMIT Host limit alerts
RRD_SERVER RRD disk alerts
APPLIANCE_HEARTBEAT Device Connectivity with FMC
INTRUSION_FILE_STATS NA
TIME_SYNC Time Synchronization issues with Device and FMC
TIME_SERIES_DATA_MONITOR NA
URLFILTER URL Filter Alerts
SECURITY_INTELLIGENCE Security intelligence Alerts
AMP_FOR_ENDPOINTS NA
USER_AGENT NA
SMART_LICENSE Smart Licence Alerts
VPN VPN related Alerts
HIGH_AVAILABILITY FMC HA sync Alerts
DATABASE DB related Alerts
PLATFORM_FAULTS Platform Faults Alerts
THREAT_DATA_UPDATES Threat Data Alerts
REALM Realm Alerts
ISE NA
SNORT_IDENTITY_MEMORY_USAGE NA
AMP_FOR_FIREPOWER_STATUS NA
DISK_STATUS NA
BACKLOG NA
LOCAL_MALWARE_ANALYSIS Malware Alerts
CLUSTER Cluster and FTD HA Sync alerts
INLINELINK_ALARM NA
RECONFIG_DETECTION NA
CONNECTIONS NA
CRITICAL_PROCESS Critical Process Alerts
DEPLOYED_CONFIGURATION Deployment Configuration Alerts
SNORT_STATS NA
FTD_HA FTD HA Alerts
FILE_SYSTEM_INTEGRITY_CHECK File System Integrity Check
ASP_DROP NA
HIT_COUNT NA
NTP_SERVER NTPD Server Alerts
ROUTING_STATS Routing Stats Alerts
UNRESOLVED_GROUPS_MONITOR NA
CONN_STATUS_SSE NA
CONN_STATUS_AMP NA
FLOW_OFFLOAD NA
CHASSIS_STATUS_FTD Chassis Status Alerts
ADVANCED_SNORT_STATS NA
OUT_OF_BAND_CHANGES OOB Changes
FTD_CONFIG_RESOURCE_UTILISATION NA
SYBASE_STATUS NA
MYSQL NA
VPN_STATS NA
RABBITMQ NA
EVENT NA
HARDWARE_STATISTICS_FMC Hardware Alerts for FMC
X_TLS_COUNTER NA
CSDAC_STATUS CSDAC alerts
CERTIFICATE NA
THREAT_GRID_MAP NA
WEB_SERVER_STATS Web Server User limit
NTPD NA
SD_WAN_MONITORING NA
PASSIVE_AD_MONITOR NA
FXOS_HEALTH FXOS process running or not Alert

Supported Filters

Name Values
startTime epoch time e.g 169826072
endTime epoch Time e.g 169826072
deviceUUIDs list of comma-separated device UUIDs (0 for Firewall Management Centre)e.g 0, 3c9ea042-350e-11ee-86cd-8ca924ebd925
status

based on the severity of the alert acceptable value - red,green or yellow

e.g red
moduleIDs

list of modules for which alerts needs to be fetched. (Table list below)

e.g MEMORY_USAGE

Examples:

Retrieve all alerts for a specified time range:

/health/alerts?filter=startTime%3A1698275629%3BendTime%3A1698295629

Retrieve all alerts for a specified time range and with the severity as critical:

/health/alerts?filter=startTime%3A1698275629%3BendTime%3A1698295629%3Bstatus%3Ared

Retrieve latest alerts on the Secure Firewall Management Center:

/health/alerts?filter=deviceUUIDs%3A0

Retrieve all DISK_USAGE alterts with a severity level of "Warning":

/health/alerts?filter=moduleIDs%3ADISK_USAGE%3Bstatus%3Ayellow%3B

Retrieve DISK_USAGE alerts with a severity level of "Critical" on a specified device:

/health/alerts?filter=moduleIDs%3ADISK_USAGE%3Bstatus%3red%3BdeviceUUIDs %3A3c9ea042-350e-11ee-86cd-8ca924ebd925 %2Cbb87e572-61c2-11ee-b0ba-dd635e115b34%3B

Chassis

GETALL appinfo

Request Type: GETALL

Description: Get all image versions available for instance creation on the chassis.

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST breakoutinterfaces

Request Type: POST

Description: Perform an interface breakout. _Check the response section for applicable examples (if any)._

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

Query Parameters

ignoreWarning - Boolean indicating whether to ignore warning alerts for the breakout operation.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET chassisinterfaces

Request Type: GET

Description: Retrieve chassis interfaces. (deprecated) Please use /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/interfaces and /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/interfaces/{interfaceUUID} instead

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

Query Parameters

interfaceUUID - Unique identifier of a chassis interface.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL chassisinterfaces

Request Type: GETALL

Description: Retrieve chassis interfaces. (deprecated) Please use /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/interfaces and /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/interfaces/{interfaceUUID} instead

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL chassisinterfaceevents

Request Type: GETALL

Description: Get a list of all NetMod events on the device.

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST chassisinterfaceevents

Request Type: POST

Description: Create a NetMod event on the device. _Check the response section for applicable examples (if any)._

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE etherchannelinterfaces

Request Type: DELETE

Description: Delete the specified chassis EtherChannel configuration _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - UUID of the EtherChannel interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET etherchannelinterfaces

Request Type: GET

Description: Get the specified chassis EtherChannel configuration.

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

Query Parameters

interfaceUUID - UUID of the EtherChannel interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL etherchannelinterfaces

Request Type: GETALL

Description: Get a list of chassis EtherChannel interface configurations.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST etherchannelinterfaces

Request Type: POST

Description: Create an EtherChannel interface configuration. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT etherchannelinterfaces

Request Type: PUT

Description: Modify the specified chassis EtherChannel configuration _Check the response section for applicable examples (if any)._

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

Query Parameters

interfaceUUID - UUID of the EtherChannel interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL evaluateoperation

Request Type: GETALL

Description: Validate Interface usage.

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

Query Parameters

interfaceUUID - UUID of the chassis interface.

operationType - The specific chassis operation to be evaluated. Possible values are BREAKOUT and JOIN.

breakoutType - The specific breakout type to be evaluated.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL faultsummary

Request Type: GETALL

Description: Get fault data from the chassis.

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET fmcmanagedchassis

Request Type: GET

Description: Get a list of all chassis managed devices from the Firewall Management Center

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

Query Parameters

objectId - UUID of a chassis.

domainUUID - Domain UUID

GETALL fmcmanagedchassis

Request Type: GETALL

Description: Get a list of all chassis managed devices from the Firewall Management Center

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL instancesummary

Request Type: GETALL

Description: Get instance summary data from the chassis.

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET interfaces

Request Type: GET

Description: Get information for the specified chassis interface.

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

Query Parameters

interfaceUUID - UUID of the chassis interface.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL interfaces

Request Type: GETALL

Description: Get all chassis interfaces.

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

Query Parameters

filter - Query parameter used to search interfaces by name or port type. Use <code>"name:{name}"</code> to search by hardware name of interface. <br /> Use <code>"type:{type1,type2}"</code> to search by interface type. Type can be <code>PhysicalInterface,SubInterface or EtherChannelInterface</code> <br/> Use <code>"portType:{portType1,portType2}"</code> to search by interface port type. Port type can be <code>DATA,MANAGEMENT,DATA_SHARING or CLUSTER</code>

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL interfacesummary

Request Type: GETALL

Description: Get interface summary data from the chassis.

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL inventorysummary

Request Type: GETALL

Description: Get Inventory summary data from the chassis.

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST joininterfaces

Request Type: POST

Description: Join an interface. _Check the response section for applicable examples (if any)._

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

Query Parameters

ignoreWarning - Boolean indicating whether to ignore warning alerts for the join operation.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE logicaldevices

Request Type: DELETE

Description: Delete the specified logical device. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - UUID of the logical device.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET logicaldevices

Request Type: GET

Description: Get information on the specified logical device.

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

Query Parameters

objectId - UUID of the logical device.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL logicaldevices

Request Type: GETALL

Description: Get the list of all logical devices available on the specified chassis.

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

Query Parameters

useCache - Data from cache. This only applies to the UI.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST logicaldevices

Request Type: POST

Description: Create a logical device on the chassis. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT logicaldevices

Request Type: PUT

Description: Modify the specified logical device. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - UUID of the logical device.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET networkmodules

Request Type: GET

Description: Get information on the specified network module.

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

Query Parameters

objectId - UUID of the network module.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL networkmodules

Request Type: GETALL

Description: Get a list of all network modules on the specified device.

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT networkmodules

Request Type: PUT

Description: Modify the specified network module. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - UUID of the network module.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET physicalinterfaces

Request Type: GET

Description: Get information on the specified physical interface.

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

Query Parameters

interfaceUUID - UUID of the chassis physical interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL physicalinterfaces

Request Type: GETALL

Description: Get the chassis Physical interface configurations.

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT physicalinterfaces

Request Type: PUT

Description: Modify the specified physical interface. _Check the response section for applicable examples (if any)._

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

Query Parameters

interfaceUUID - UUID of the chassis physical interface.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET snmpsettings

Request Type: GET

Description: Get detailed information for an SNMP settings policy.

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

Query Parameters

objectId - UUID for the SNMP settings policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL snmpsettings

Request Type: GETALL

Description: Get SNMP settings for a chassis.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT snmpsettings

Request Type: PUT

Description: Modify the specified SNMP settings policy. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - UUID for the SNMP settings policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE subinterfaces

Request Type: DELETE

Description: Delete the specified chassis subinterface configuration. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - UUID of the chassis subinterface configuration.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET subinterfaces

Request Type: GET

Description: Get information on the specified chassis subinterface configuration.

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

Query Parameters

interfaceUUID - UUID of the chassis subinterface configuration.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL subinterfaces

Request Type: GETALL

Description: Get the chassis subinterface configurations.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST subinterfaces

Request Type: POST

Description: Create a subinterface configuration on the chassis. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT subinterfaces

Request Type: PUT

Description: Modify the specified chassis subinterface configuration. _Check the response section for applicable examples (if any)._

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

Query Parameters

interfaceUUID - UUID of the chassis subinterface configuration.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

POST switchmode

Request Type: POST

Description: Operational API to convert a Chassis Mode from Native to Multi-Instance _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

POST switchmodereadinesscheck

Request Type: POST

Description: Check if a device or devices are ready to convert to multi-instance mode. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT syncnetworkmodule

Request Type: PUT

Description: Get network module data from FXOS and update Firewall Management Center. _Check the response section for applicable examples (if any)._

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

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

Intelligence Services

POST collections

Request Type: POST

Description: API Operations on Taxii Collection objects. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

POST discoveryinfo

Request Type: POST

Description: API Operations on Discovery Info objects. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

GET element

Request Type: GET

Description: API Operations on Element objects.

URL: /api/fmc_tid/v1/domain/{domainUUID}/tid/element/{objectId}

Query Parameters

objectId - Unique identifier of the Element.

domainUUID - Domain UUID

GETALL element

Request Type: GETALL

Description: API Operations on Element objects.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE incident

Request Type: DELETE

Description: API Operations on Incident objects. _Check the response section for applicable examples (if any)._

URL: /api/fmc_tid/v1/domain/{domainUUID}/tid/incident/{objectId}

Query Parameters

objectId - Unique identifier of the Incident.

domainUUID - Domain UUID

GET incident

Request Type: GET

Description: API Operations on Incident objects.

URL: /api/fmc_tid/v1/domain/{domainUUID}/tid/incident/{objectId}

Query Parameters

objectId - Unique identifier of the Incident.

domainUUID - Domain UUID

GETALL incident

Request Type: GETALL

Description: API Operations on Incident objects.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT incident

Request Type: PUT

Description: API Operations on Incident objects. _Check the response section for applicable examples (if any)._

URL: /api/fmc_tid/v1/domain/{domainUUID}/tid/incident/{objectId}

Query Parameters

objectId - Unique identifier of the Incident.

domainUUID - Domain UUID

GET indicator

Request Type: GET

Description: API Operations on Indicator objects.

URL: /api/fmc_tid/v1/domain/{domainUUID}/tid/indicator/{objectId}

Query Parameters

objectId - Unique identifier of the Indicator.

domainUUID - Domain UUID

GETALL indicator

Request Type: GETALL

Description: API Operations on Indicator objects.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT indicator

Request Type: PUT

Description: API Operations on Indicator objects. _Check the response section for applicable examples (if any)._

URL: /api/fmc_tid/v1/domain/{domainUUID}/tid/indicator/{objectId}

Query Parameters

objectId - Unique identifier of the Indicator.

domainUUID - Domain UUID

GET observable

Request Type: GET

Description: API Operations on Observable objects.

URL: /api/fmc_tid/v1/domain/{domainUUID}/tid/observable/{objectId}

Query Parameters

objectId - Unique identifier of the Observable.

domainUUID - Domain UUID

GETALL observable

Request Type: GETALL

Description: API Operations on Observable objects.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT observable

Request Type: PUT

Description: API Operations on Observable objects. _Check the response section for applicable examples (if any)._

URL: /api/fmc_tid/v1/domain/{domainUUID}/tid/observable/{objectId}

Query Parameters

objectId - Unique identifier of the Observable.

domainUUID - Domain UUID

GET settings

Request Type: GET

Description: API Operations on Settings objects.

URL: /api/fmc_tid/v1/domain/{domainUUID}/tid/settings/{objectId}

Query Parameters

objectId - Unique identifier of the Settings object.

domainUUID - Domain UUID

PUT settings

Request Type: PUT

Description: API Operations on Settings objects. _Check the response section for applicable examples (if any)._

URL: /api/fmc_tid/v1/domain/{domainUUID}/tid/settings/{objectId}

Query Parameters

objectId - Unique identifier of the Settings object.

domainUUID - Domain UUID

DELETE source

Request Type: DELETE

Description: API Operations on Source objects. _Check the response section for applicable examples (if any)._

URL: /api/fmc_tid/v1/domain/{domainUUID}/tid/source/{objectId}

Query Parameters

objectId - Unique identifier of the Source.

domainUUID - Domain UUID

GET source

Request Type: GET

Description: API Operations on Source objects.

URL: /api/fmc_tid/v1/domain/{domainUUID}/tid/source/{objectId}

Query Parameters

objectId - Unique identifier of the Source.

domainUUID - Domain UUID

GETALL source

Request Type: GETALL

Description: API Operations on Source objects.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST source

Request Type: POST

Description: API Operations on Source objects. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT source

Request Type: PUT

Description: API Operations on Source objects. _Check the response section for applicable examples (if any)._

URL: /api/fmc_tid/v1/domain/{domainUUID}/tid/source/{objectId}

Query Parameters

objectId - Unique identifier of the Source.

domainUUID - Domain UUID

License

GET devicelicenses

Request Type: GET

Description: Get the device license associated with the specified ID.

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

Query Parameters

objectId - Unique identifier associated with the device license.

GETALL devicelicenses

Request Type: GETALL

Description: Get all device licenses.

URL: /api/fmc_platform/v1/license/devicelicenses

Query Parameters

filter - [DEV ERROR: Missing description]

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT devicelicenses

Request Type: PUT

Description: Modify the device license associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier associated with the device license.

GETALL smartlicenses

Request Type: GETALL

Description: Get all smart licenses.

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

Query Parameters

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST smartlicenses

Request Type: POST

Description: Update Smart Licenses. _Check the response section for applicable examples (if any)._

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

Query Parameters

Search

GETALL device

Request Type: GETALL

Description: Search for devices matching the specified text.

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

Query Parameters

filter - Text used for filtering.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL global

Request Type: GETALL

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

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

Query Parameters

filter - Text or IP address used for filtering.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL object

Request Type: GETALL

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

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

Query Parameters

filter - Text or IP address used for filtering <br/>To search for objects that contain groups, follow this format:<br/> <code>"text:searchText;types:Networks,Ports,etc;isAcpGlobalSearch:true;"</code> <br/>To perform multiple searches simultaneously, follow this format:<br/> <code>"text:searchText1,searchText2;types:Networks,Ports,etc;isAcpGlobalSearch:true;isMultiObjectSearch:true;"</code>

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL policy

Request Type: GETALL

Description: Search for policies matching specified text or IP address, including values found in policies.

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

Query Parameters

filter - Text or IP address used for filtering.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

Integration Services

GET cloudeventsconfigs

Request Type: GET

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

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

Query Parameters

objectId - Identifier for the cloud event configuration.

domainUUID - Domain UUID

GETALL cloudeventsconfigs

Request Type: GETALL

Description: Get the list of the singleton cloud event configuration objects.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT cloudeventsconfigs

Request Type: PUT

Description: Modify the the cloud event configuration associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Identifier for the cloud event configuration.

domainUUID - Domain UUID

GETALL cloudintegrations

Request Type: GETALL

Description:

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET cloudregions

Request Type: GET

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

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

Query Parameters

objectId - Identifier for the cloud region.

domainUUID - Domain UUID

GETALL cloudregions

Request Type: GETALL

Description: Get the list of all cloud regions.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT cloudregions

Request Type: PUT

Description: Modify the the cloud region configuration associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Identifier for the cloud region.

domainUUID - Domain UUID

GETALL configure

Request Type: GETALL

Description:

URL: /api/fmc_config/v1/domain/{domainUUID}/integration/aiops/configure

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST configure

Request Type: POST

Description: _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/integration/aiops/configure

Query Parameters

domainUUID - Domain UUID

GETALL datacenters

Request Type: GETALL

Description: Get the list of all Umbrella data centers.

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

Query Parameters

useCache - Boolean value, if set to false, Data Center list will be fetched from the Umbrella site ignoring the cached data.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE externallookups

Request Type: DELETE

Description: Delete the external lookup associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Identifier for the external lookup.

domainUUID - Domain UUID

GET externallookups

Request Type: GET

Description: Get the external lookup associated with the specified ID.

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

Query Parameters

objectId - Identifier for the external lookup.

domainUUID - Domain UUID

GETALL externallookups

Request Type: GETALL

Description: Get the list of all external lookups.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST externallookups

Request Type: POST

Description: Create an external lookup. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT externallookups

Request Type: PUT

Description: Modify the external lookup associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Identifier for the external lookup.

domainUUID - Domain UUID

GET externalstorage

Request Type: GET

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

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

Query Parameters

objectId - Identifier for the external event storage.

domainUUID - Domain UUID

GETALL externalstorage

Request Type: GETALL

Description: Get the list of external event storage configurations.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT externalstorage

Request Type: PUT

Description: Modify the external event storage configuration associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Identifier for the external event storage.

domainUUID - Domain UUID

GETALL fmchastatuses

Request Type: GETALL

Description: Get information about the High Availability status of the Secure Firewall Management Center.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST refreshsecurexconfigs

Request Type: POST

Description: Refresh SecureX configurations. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

GETALL status

Request Type: GETALL

Description:

URL: /api/fmc_config/v1/domain/{domainUUID}/integration/aiops/tsdbupload/status

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST testumbrellaconnections

Request Type: POST

Description: Test connection to the Umbrella cloud _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET transcripts

Request Type: GET

Description: Get transcript for Umbrella deployment from a given device and topology.

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

Query Parameters

objectId - Unique identifier of the Device from which to fetch the Umbrella transcript.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

POST tsdbupload

Request Type: POST

Description: _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/integration/aiops/tsdbupload

Query Parameters

domainUUID - Domain UUID

GET tunneldeployments

Request Type: GET

Description: Get tunnel deployment data on Umbrella.

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

Query Parameters

objectId - Unique identifier of the Umbrella topology being deployed.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

POST tunneldeployments

Request Type: POST

Description: Create a tunnel deployment. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET umbrellaconnections

Request Type: GET

Description: Get the specified Umbrella connection configuration.

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

Query Parameters

objectId - Unique identifier of the Umbrella connection configuration.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL umbrellaconnections

Request Type: GETALL

Description: Get the list of Umbrella connection configurations.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT umbrellaconnections

Request Type: PUT

Description: Modify the specified Umbrella connection configuration. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the Umbrella connection configuration.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

Object Services

DELETE anyconnectcustomattributes

Request Type: DELETE

Description: Delete the AnyConnect Custom Attribute associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the AnyConnect Custom Attribute.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET anyconnectcustomattributes

Request Type: GET

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

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

Query Parameters

objectId - Unique identifier of the AnyConnect Custom Attribute.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL anyconnectcustomattributes

Request Type: GETALL

Description: Get the list of all AnyConnect Custom Attribute objects.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST anyconnectcustomattributes

Request Type: POST

Description: Create an AnyConnect Custom Attribute. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT anyconnectcustomattributes

Request Type: PUT

Description: Modify the AnyConnect Custom Attribute associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the AnyConnect Custom Attribute.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE anyconnectexternalbrowserpackages

Request Type: DELETE

Description: Delete the AnyConnect External Browser Package associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the AnyConnect Browser Package.

domainUUID - Domain UUID

GET anyconnectexternalbrowserpackages

Request Type: GET

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

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

Query Parameters

objectId - Unique identifier of the AnyConnect Browser Package.

domainUUID - Domain UUID

GETALL anyconnectexternalbrowserpackages

Request Type: GETALL

Description: Get list of all AnyConnect External Browser Package objects.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST anyconnectexternalbrowserpackages

Request Type: POST

Description: Create an AnyConnect External Browser Package. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT anyconnectexternalbrowserpackages

Request Type: PUT

Description: Modify the AnyConnect External Browser Package associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the AnyConnect Browser Package.

domainUUID - Domain UUID

DELETE anyconnectpackages

Request Type: DELETE

Description: Delete the AnyConnect Package associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the AnyConnect Package.

domainUUID - Domain UUID

GET anyconnectpackages

Request Type: GET

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

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

Query Parameters

objectId - Unique identifier of the AnyConnect Package.

domainUUID - Domain UUID

GETALL anyconnectpackages

Request Type: GETALL

Description: Get the list of all AnyConnect Packages.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST anyconnectpackages

Request Type: POST

Description: Create an AnyConnect Package. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT anyconnectpackages

Request Type: PUT

Description: Modify the AnyConnect Package associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the AnyConnect Package.

domainUUID - Domain UUID

DELETE anyconnectprofiles

Request Type: DELETE

Description: Delete the AnyConnect Profile associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the AnyConnect Profile.

domainUUID - Domain UUID

GET anyconnectprofiles

Request Type: GET

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

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

Query Parameters

objectId - Unique identifier of the AnyConnect Profile.

domainUUID - Domain UUID

GETALL anyconnectprofiles

Request Type: GETALL

Description: Get the list of all AnyConnect Profiles.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST anyconnectprofiles

Request Type: POST

Description: Create an AnyConnect Profile. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT anyconnectprofiles

Request Type: PUT

Description: Modify the AnyConnect Profile associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the AnyConnect Profile.

domainUUID - Domain UUID

GET anyprotocolportobjects

Request Type: GET

Description: Get any protocol port object associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the protocol port object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL anyprotocolportobjects

Request Type: GETALL

Description: Get the list of all protocol port objects (all port objects with a protocol value of All).

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET applicationcategories

Request Type: GET

Description: Get the application category with the specified ID.

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

Query Parameters

objectId - Unique identifier of the application category.

domainUUID - Domain UUID

GETALL applicationcategories

Request Type: GETALL

Description: Get the list of all application categories.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE applicationfilters

Request Type: DELETE

Description: Delete the application filter associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the application filter.

domainUUID - Domain UUID

GET applicationfilters

Request Type: GET

Description: Get the application filter associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the application filter.

domainUUID - Domain UUID

GETALL applicationfilters

Request Type: GETALL

Description: Get the list of all application filters.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST applicationfilters

Request Type: POST

Description: Create an application filter. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT applicationfilters

Request Type: PUT

Description: Modify the application filter associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the application filter.

domainUUID - Domain UUID

GET applicationproductivities

Request Type: GET

Description: Get the application productivity with the specified ID.

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

Query Parameters

objectId - Unique identifier of the application productivity.

domainUUID - Domain UUID

GETALL applicationproductivities

Request Type: GETALL

Description: Get the list of all application producticvities.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET applicationrisks

Request Type: GET

Description: Get the application risk with the specified ID.

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

Query Parameters

objectId - Unique identifier of the application risk.

domainUUID - Domain UUID

GETALL applicationrisks

Request Type: GETALL

Description: Get the list of all application risks.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL applications

Request Type: GETALL

Description: Get the list of all applications.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET applicationtags

Request Type: GET

Description: Get the application tag with the specified ID.

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

Query Parameters

objectId - Unique identifier of the application tag.

domainUUID - Domain UUID

GETALL applicationtags

Request Type: GETALL

Description: Get the list of all application tags.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET applicationtypes

Request Type: GET

Description: Get the application type with the specified ID.

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

Query Parameters

objectId - Unique identifier of the application type.

domainUUID - Domain UUID

GETALL applicationtypes

Request Type: GETALL

Description: Get the list of all application types.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE aspathlists

Request Type: DELETE

Description: Delete the Autonomous System Path list associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the Autonomous System Path list.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET aspathlists

Request Type: GET

Description: Get the Autonomous System Path list associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the Autonomous System Path list.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL aspathlists

Request Type: GETALL

Description: Get the list of all Autonomous System Path lists.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST aspathlists

Request Type: POST

Description: Create an Autonomous System Path list. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT aspathlists

Request Type: PUT

Description: Modify the Autonomous System Path list associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the Autonomous System Path list.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE azureadrealms

Request Type: DELETE

Description: Delete the Azure AD Realm associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the Azure AD Realm.

domainUUID - Domain UUID

GET azureadrealms

Request Type: GET

Description: Get the Azure AD Realm associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the Azure AD Realm.

domainUUID - Domain UUID

GETALL azureadrealms

Request Type: GETALL

Description: Get the list of all Azure AD Realms.

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

Query Parameters

filter - Filter by any of the following fields: name, tenantId, clientId.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST azureadrealms

Request Type: POST

Description: Create an Azure AD Realm. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT azureadrealms

Request Type: PUT

Description: Modify the Azure AD Realm associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the Azure AD Realm.

domainUUID - Domain UUID

GETALL azureadstatuses

Request Type: GETALL

Description: Get Azure AD realm statuses.

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

Query Parameters

ids - Identifiers of realms whose statuses will be received. The values are separated by commas.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE bfdtemplates

Request Type: DELETE

Description: Delete the Bidirectional Forwarding Detection routing template associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the Bidirectional Forwarding Detection routing template.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET bfdtemplates

Request Type: GET

Description: Get the Bidirectional Forwarding Detection routing template associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the Bidirectional Forwarding Detection routing template.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL bfdtemplates

Request Type: GETALL

Description: Get the list of all Bidirectional Forwarding Detection routing templates.

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

Query Parameters

filter - To filter BFD templates based on hop type, use <code>hopType:{hopType}</code>. Supported hop types are Single-Hop and Multi-Hop.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST bfdtemplates

Request Type: POST

Description: Create a Bidirectional Forwarding Detection routing template. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT bfdtemplates

Request Type: PUT

Description: Modify the Bidirectional Forwarding Detection routing template associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the Bidirectional Forwarding Detection routing template.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

POST bulkdynamicobjects

Request Type: POST

Description: Add or remove Dynamic Object Mappings for specific Dynamic Objects. _Check the response section for applicable examples (if any)._

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

Query Parameters

propagate - Boolean value indicating whether to propagate dynamic object mappings. Default value is TRUE.

domainUUID - Domain UUID

DELETE certenrollments

Request Type: DELETE

Description: Delete the specified certificate enrollment. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the certificate enrollment.

overrideTargetId - UUID of the target on which the object override is present.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET certenrollments

Request Type: GET

Description: Get the specified certificate enrollment.

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

Query Parameters

objectId - Unique identifier of the certificate enrollment.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL certenrollments

Request Type: GETALL

Description: Get the list of all certificate enrollments.

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

Query Parameters

filter - Filter to retrieve cert enrollment objects based on name.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST certenrollments

Request Type: POST

Description: Create a certificate enrollment. A certificate enrollment can be of types PKCS12, SCEP, EST, Self-Signed, or Manual with Only CA. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT certenrollments

Request Type: PUT

Description: Modify the specified certificate enrollment. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the certificate enrollment.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE certificatemaps

Request Type: DELETE

Description: Delete the certificate map associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the certificate map.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET certificatemaps

Request Type: GET

Description: Get the certificate map associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the certificate map.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL certificatemaps

Request Type: GETALL

Description: Get the list of all certificate maps.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST certificatemaps

Request Type: POST

Description: Create a certificate map. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT certificatemaps

Request Type: PUT

Description: Modify the certificate map associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the certificate map.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL ciphersuitelists

Request Type: GETALL

Description: Get all cipher suite lists.

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

Query Parameters

filter - Filter by name of the cipher suite list is supported.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ciphersuitelists

Request Type: POST

Description: Create a cipher suite list. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET communitylists

Request Type: GET

Description: Get the specified community list.

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

Query Parameters

objectId - Unique identifier of the community list.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL communitylists

Request Type: GETALL

Description: Get all community lists.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET continents

Request Type: GET

Description: Get the continent associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the continent.

domainUUID - Domain UUID

GETALL continents

Request Type: GETALL

Description: Get the list of all continents.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET countries

Request Type: GET

Description: Get the country associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the country.

domainUUID - Domain UUID

GETALL countries

Request Type: GETALL

Description: Get the list of all countries.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET customsiurllistdownload

Request Type: GET

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

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

Query Parameters

objectId - Unique identifier of the custom Security Intelligence URL List.

domainUUID - Domain UUID

DELETE customsiiplists

Request Type: DELETE

Description: Delete the custom Security Intelligence Network List associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the custom Security Intelligence Network List.

domainUUID - Domain UUID

GET customsiiplists

Request Type: GET

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

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

Query Parameters

objectId - Unique identifier of the custom Security Intelligence Network List.

domainUUID - Domain UUID

GETALL customsiiplists

Request Type: GETALL

Description: Get the list of all custom Security Intelligence Network List

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST customsiiplists

Request Type: POST

Description: Create a custom Security Intelligence Network List. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT customsiiplists

Request Type: PUT

Description: Modify the custom Security Intelligence Network List associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the custom Security Intelligence Network List.

domainUUID - Domain UUID

GET customsiurllistdownload

Request Type: GET

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

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

Query Parameters

objectId - Unique identifier of the custom Security Intelligence URL List.

domainUUID - Domain UUID

DELETE customsiurllists

Request Type: DELETE

Description: Delete the custom Security Intelligence URL List associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the custom Security Intelligence URL List.

domainUUID - Domain UUID

GET customsiurllists

Request Type: GET

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

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

Query Parameters

objectId - Unique identifier of the custom Security Intelligence URL List.

domainUUID - Domain UUID

GETALL customsiurllists

Request Type: GETALL

Description: Get the list of all custom Security Intelligence URL Lists.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST customsiurllists

Request Type: POST

Description: Create a custom Security Intelligence URL List. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT customsiurllists

Request Type: PUT

Description: Modify the custom Security Intelligence URL List associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the custom Security Intelligence URL List.

domainUUID - Domain UUID

DELETE dhcpipv6pools

Request Type: DELETE

Description: Get the DHCP IPv6 pool associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the DHCP IPv6 pool.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET dhcpipv6pools

Request Type: GET

Description: Get the DHCP IPv6 pool associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the DHCP IPv6 pool.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL dhcpipv6pools

Request Type: GETALL

Description: Get the list of all DHCP IPv6 pools.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST dhcpipv6pools

Request Type: POST

Description: Create a DHCP IPv6 pool. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT dhcpipv6pools

Request Type: PUT

Description: Modify the DHCP IPv6 pool associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the DHCP IPv6 pool.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL distinguishednamegroups

Request Type: GETALL

Description: Get the list of all Distinguished Name groups.

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

Query Parameters

filter - Name of the Distinguished Name Group.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL distinguishednames

Request Type: GETALL

Description: Get Distinguished Names.

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

Query Parameters

filter - [DEV ERROR: Missing description]

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST distinguishednames

Request Type: POST

Description: Create a Distinguished Name. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE dnsservergroups

Request Type: DELETE

Description: Delete the the DNS Server Group associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Identifier for the DNS Server Group.

overrideTargetId - Get the override(s) associated with the object on given target ID.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET dnsservergroups

Request Type: GET

Description: Get the the DNS Server Group associated with the specified ID.

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

Query Parameters

objectId - Identifier for the DNS Server Group.

overrideTargetId - Get the override(s) associated with the object on given target ID.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL dnsservergroups

Request Type: GETALL

Description: Get the list of all DNS Server Groups.

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

Query Parameters

overrideTargetId - Get the override(s) associated with the object on given target ID.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST dnsservergroups

Request Type: POST

Description: Create a list of all DNS Server Group. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT dnsservergroups

Request Type: PUT

Description: Modify the the DNS Server Group associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Identifier for the DNS Server Group.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

POST download

Request Type: POST

Description: Download users and groups of the specified SAML realm. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

POST Azure AD download

Request Type: POST

Description: Download users and groups of the specific Azure AD Realm. _Check the response section for applicable examples (if any)._

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

Query Parameters

realmId - Unique identifier of the Azure AD Realm.

domainUUID - Domain UUID

POST downloadinternalca

Request Type: POST

Description: Get and download the Internal Certificate Authority object in a PKCS12 file encrypted using the provided password. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

DELETE dynamicobjectmappings

Request Type: DELETE

Description: Remove Dynamic Object Mappings for specific Dynamic Objects. _Check the response section for applicable examples (if any)._

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

Query Parameters

filter - Specify filter criteria<ul><li>Object with ids: <code>"ids:id1,id2,..."</code></li><li>Unused objects: <code>"unusedOnly:true"</code></li><li>Name starts with: <code>"nameStartsWith:{name-pattern}"</code></li><li>Agent ID: <code>"agentId:{Agent ID}"</code></li></ul>

bulk - Enables bulk removal of mappings

propagate - Boolean value indicating whether to propagate dynamic object mappings. Default value is TRUE.

domainUUID - Domain UUID

POST dynamicobjectmappings

Request Type: POST

Description: Add Dynamic Object Mappings for specific Dynamic Objects. _Check the response section for applicable examples (if any)._

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

Query Parameters

propagate - Boolean value indicating whether to propagate dynamic object mappings. Default value is TRUE.

domainUUID - Domain UUID

DELETE dynamicobjects

Request Type: DELETE

Description: Delete all Dynamic Objects. Filter to specify which Dynamic Objects will be deleted. _Check the response section for applicable examples (if any)._

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

Query Parameters

filter - Specify filter criteria<ul><li>Object with ids: <code>"ids:id1,id2,..."</code></li><li>Unused objects: <code>"unusedOnly:true"</code></li><li>Name starts with: <code>"nameStartsWith:{name-pattern}"</code></li></ul>

bulk - =Enables bulk delete of Dynamic Objects.

domainUUID - Domain UUID

GET dynamicobjects

Request Type: GET

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

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

Query Parameters

objectId - Identifier or name of the Dynamic Object.

includeCount - Boolean indicating whether to add mappingsCount field to the metadata. Can be used if object ID is specified in path.

domainUUID - Domain UUID

GETALL dynamicobjects

Request Type: GETALL

Description: Get list of all Dynamic Objects.

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

Query Parameters

name - Only the Dynamic Objects matching with the specified name will be displayed. Cannot be used if object ID is specified in path.

includeCount - Boolean indicating whether to add mappingsCount field to the metadata. Can be used if object ID is specified in path.

filter - Specify filter criteria<ul><li>Object with ids: <code>"ids:id1,id2,..."</code></li><li>Unused objects: <code>"unusedOnly:true"</code></li><li>Name starts with: <code>"nameStartsWith:{name-pattern}"</code></li></ul>

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST dynamicobjects

Request Type: POST

Description: Create a Dynamic Object. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - =Enables bulk create of Dynamic Objects.

domainUUID - Domain UUID

PUT dynamicobjects

Request Type: PUT

Description: Modify the Dynamic Object associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Identifier or name of the Dynamic Object.

domainUUID - Domain UUID

GET endpointdevicetypes

Request Type: GET

Description: Get the endpoint device type associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the endpoint device type.

domainUUID - Domain UUID

GETALL endpointdevicetypes

Request Type: GETALL

Description: Get the list of all endpoint device types.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE expandedcommunitylists

Request Type: DELETE

Description: Delete the Expanded Community List associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the Expanded Community List.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET expandedcommunitylists

Request Type: GET

Description: Get the Expanded Community List associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the Expanded Community List.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL expandedcommunitylists

Request Type: GETALL

Description: Get the list of Expanded Community Lists.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST expandedcommunitylists

Request Type: POST

Description: Create an Expanded Community List. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT expandedcommunitylists

Request Type: PUT

Description: Modify the Expanded Community List associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the Expanded Community List.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE extendedaccesslists

Request Type: DELETE

Description: Delete the Extended Access associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the Extended Access List.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET extendedaccesslists

Request Type: GET

Description: Get the Extended Access List associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the Extended Access List.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL extendedaccesslists

Request Type: GETALL

Description: Get the list of Extended Access Lists.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST extendedaccesslists

Request Type: POST

Description: Create an Extended Access List. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT extendedaccesslists

Request Type: PUT

Description: Modify the Extended Access associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the Extended Access List.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE extendedcommunitylists

Request Type: DELETE

Description: Delete the Extended Community List associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the Extended Community List.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET extendedcommunitylists

Request Type: GET

Description: Get the Extended Community List associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the Extended Community List.

overrideTargetId - Get the overrides associated with the specified Extended Community List.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL extendedcommunitylists

Request Type: GETALL

Description: Get the list of all Extended Community Lists.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value and <code>"type:{type}"</code> to search for specific type of the object.For ExtendedCommunityLists supported types are Standard and Expanded.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST extendedcommunitylists

Request Type: POST

Description: Create an Extended Community List. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT extendedcommunitylists

Request Type: PUT

Description: Modify the Extended Community List associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the Extended Community List.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL externalcertificategroups

Request Type: GETALL

Description: Get the list of all external certificate groups.

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

Query Parameters

filter - Filter by name of the external certificate group.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL externalcacertificates

Request Type: GETALL

Description: Get the list of trusted certificate authorities.

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

Query Parameters

filter - Filter by name of the trusted Certificate Authority.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST externalcacertificates

Request Type: POST

Description: Create a trusted Certificate Authority. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL externalcertificategroups

Request Type: GETALL

Description: Get the list of all external certificate groups.

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

Query Parameters

filter - Filter by name of the external certificate group.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL externalcertificates

Request Type: GETALL

Description: Get the list of external certificates.

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

Query Parameters

filter - Filter by name of the certificate.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST externalcertificates

Request Type: POST

Description: Create an external certificate. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET filecategories

Request Type: GET

Description: Get the file category associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the file category.

domainUUID - Domain UUID

GETALL filecategories

Request Type: GETALL

Description: Get the list of all file categories.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET filetypes

Request Type: GET

Description: Get the file type associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the file type.

domainUUID - Domain UUID

GETALL filetypes

Request Type: GETALL

Description: Get the list of all file types.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST findoverlaps

Request Type: POST

Description: Get overlaps for the given network objects/literals and port objects/literals. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

DELETE domain_fqdns

Request Type: DELETE

Description: Delete all fully-qualified domain names. Use filtering to limit the deleted names. _Check the response section for applicable examples (if any)._

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.<br/><code>"ids:id1,id2,..."</code>.<code>ids</code> is a comma-separated list of rule IDs to be deleted.

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET fqdns

Request Type: GET

Description: Get the fully-qualified domain name associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the fully-qualified domain name.

overrideTargetId - Get the overrides associated with the specified fully-qualified domain name.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL fqdns

Request Type: GETALL

Description: Get the list of all fully-qualified domain names.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.<br/><code>"ids:id1,id2,..."</code>.<code>ids</code> is a comma-separated list of rule IDs.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST fqdns

Request Type: POST

Description: Create a fully-qualified domain name. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT fqdns

Request Type: PUT

Description: Modify the fully-qualified domain name associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the fully-qualified domain name.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE geolocations

Request Type: DELETE

Description: Delete the geolocation associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the geolocation.

domainUUID - Domain UUID

GET geolocations

Request Type: GET

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

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

Query Parameters

objectId - Unique identifier of the geolocation.

domainUUID - Domain UUID

GETALL geolocations

Request Type: GETALL

Description: Get the list of all geolocation objects.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST geolocations

Request Type: POST

Description: Create a geolocation object. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT geolocations

Request Type: PUT

Description: Modify the geolocation associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the geolocation.

domainUUID - Domain UUID

GET globaltimezones

Request Type: GET

Description: Get the IANA global time zone associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the global time zone as per the IANA tz database.

domainUUID - Domain UUID

GETALL globaltimezones

Request Type: GETALL

Description: Get all the global time zones in the IANA tz database.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE grouppolicies

Request Type: DELETE

Description: Delete the VPN group policy associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the VPN group policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET grouppolicies

Request Type: GET

Description: Get the VPN group policy associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the VPN group policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL grouppolicies

Request Type: GETALL

Description: Get the list of VPN group policies.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST grouppolicies

Request Type: POST

Description: Create a VPN group policy. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Enables bulk create for Group Policy object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT grouppolicies

Request Type: PUT

Description: Modify the VPN group policy associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the VPN group policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE hosts

Request Type: DELETE

Description: Delete the host associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the host.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET hosts

Request Type: GET

Description: Get the host associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the host.

overrideTargetId - Get the overrides associated with the specified host.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL hosts

Request Type: GETALL

Description: Get the list of hosts.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.<br/><code>"ids:id1,id2,..."</code>.<code>ids</code> is a comma-separated list of rule IDs.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST hosts

Request Type: POST

Description: Create a host. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT hosts

Request Type: PUT

Description: Modify the host associated with the specified host. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the host.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE hostscanpackages

Request Type: DELETE

Description: Delete the host scan package associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the host scan package.

domainUUID - Domain UUID

GET hostscanpackages

Request Type: GET

Description: Get the host scan package associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the host scan package.

domainUUID - Domain UUID

GETALL hostscanpackages

Request Type: GETALL

Description: Get the list of all host scan packages.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST hostscanpackages

Request Type: POST

Description: Create a host scan package. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT hostscanpackages

Request Type: PUT

Description: Modify the host scan package associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the host scan package.

domainUUID - Domain UUID

DELETE icmpv4objects

Request Type: DELETE

Description: Delete all ICMPv4 objects. Use filtering to limit the deleted ICMPv4 objects. _Check the response section for applicable examples (if any)._

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET icmpv4objects

Request Type: GET

Description: Get the ICMPv4 object associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the ICMPv4 object.

ticket-id - UUID of the ticket for tracking the configuration changes.

overrideTargetId - Get the overrides associated with the specified ICMPv4 object.

domainUUID - Domain UUID

GETALL icmpv4objects

Request Type: GETALL

Description: Get the list of all ICMPv4 objects.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST icmpv4objects

Request Type: POST

Description: Create an ICMPv4 object. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

bulk - Boolean indicating whether this is a bulk operation.

domainUUID - Domain UUID

PUT icmpv4objects

Request Type: PUT

Description: Modify the ICMPv4 object associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the ICMPv4 object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE icmpv6objects

Request Type: DELETE

Description: Delete all ICMPv6 objects. Use filtering to limit the deleted ICMPv4 objects. _Check the response section for applicable examples (if any)._

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET icmpv6objects

Request Type: GET

Description: Get the ICMPv6 object associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the ICMPv6 object.

overrideTargetId - Get the overrides associated with the specified ICMPv6 object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL icmpv6objects

Request Type: GETALL

Description: Get the list of all ICMPv6 objects.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST icmpv6objects

Request Type: POST

Description: Create an ICMPv6 object. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT icmpv6objects

Request Type: PUT

Description: Modify the ICMPv6 object associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the ICMPv6 object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE ikev1ipsecproposals

Request Type: DELETE

Description: Delete the IKEv1 IPSec Proposal associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier for the IKEv1 IPSec Proposal.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET ikev1ipsecproposals

Request Type: GET

Description: Get the IKEv1 IPSec Proposal associated with the specified ID.

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

Query Parameters

objectId - Unique identifier for the IKEv1 IPSec Proposal.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL ikev1ipsecproposals

Request Type: GETALL

Description: Get the list of all IKEv1 IPSec Proposals.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ikev1ipsecproposals

Request Type: POST

Description: Create an IKEv1 IPSec Proposal. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT ikev1ipsecproposals

Request Type: PUT

Description: Modify the IKEv1 IPSec Proposal associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier for the IKEv1 IPSec Proposal.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE ikev1policies

Request Type: DELETE

Description: Delete the IKEv1 policy associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier for the IKEv1 policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET ikev1policies

Request Type: GET

Description: Get the IKEv1 policy associated with the specified ID.

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

Query Parameters

objectId - Unique identifier for the IKEv1 policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL ikev1policies

Request Type: GETALL

Description: Get the list of all IKEv1 policies.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ikev1policies

Request Type: POST

Description: Create an IKEv1 policy. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT ikev1policies

Request Type: PUT

Description: Modify the IKEv1 policy associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier for the IKEv1 policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE ikev2ipsecproposals

Request Type: DELETE

Description: Delete the IKEv2 IPSec Proposal associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier for the IKEv2 IPSec Proposal.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET ikev2ipsecproposals

Request Type: GET

Description: Get the IKEv2 IPSec Proposal associated with the specified ID.

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

Query Parameters

objectId - Unique identifier for the IKEv2 IPSec Proposal.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL ikev2ipsecproposals

Request Type: GETALL

Description: Get the list of all IKEv2 IPSec Proposals.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ikev2ipsecproposals

Request Type: POST

Description: Create an IKEv2 IPSec Proposal. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT ikev2ipsecproposals

Request Type: PUT

Description: Modify the IKEv2 IPSec Proposal associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier for the IKEv2 IPSec Proposal.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE ikev2policies

Request Type: DELETE

Description: Delete the IKEv2 policy associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier for the IKEv2 policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET ikev2policies

Request Type: GET

Description: Get the IKEv2 policy associated with the specified ID.

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

Query Parameters

objectId - Unique identifier for the IKEv2 policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL ikev2policies

Request Type: GETALL

Description: Get the list of all IKEv2 policies.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ikev2policies

Request Type: POST

Description: Create an IKEv2 policy. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT ikev2policies

Request Type: PUT

Description: Modify the IKEv2 policy associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier for the IKEv2 policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE interfacegroups

Request Type: DELETE

Description: Delete the interface group associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the interface group.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET interfacegroups

Request Type: GET

Description: Get the interface group associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the interface group.

groupByDevice - Boolean indicating whether to group by devices rather than by interfaces.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL interfacegroups

Request Type: GETALL

Description: Get the list of all interface groups.

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

Query Parameters

filter - Query Param to return interface groups of specified InterfaceModeIG type based on the filter. Value is of format <code>interfaceMode:ROUTED or interfaceMode:PASSIVE or interfaceMode:INLINE or interfaceMode:SWITCHED or interfaceMode:MANAGEMENT or interfaceMode:LOOPBACK</code>.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST interfacegroups

Request Type: POST

Description: Create an interface group. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT interfacegroups

Request Type: PUT

Description: Modify the interface group associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the interface group.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET interfaceobjects

Request Type: GET

Description: Get the security zone or interface group associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the security zone or interface group.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL interfaceobjects

Request Type: GETALL

Description: Get the list of all security zones and interface groups.

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

Query Parameters

filter - Query Param to return security zones and interface groups of specified InterfaceMode type based on the filter. The interface mode type passed should be common to both security zones and interface groups. Value is of format <code>interfaceMode:ROUTED or interfaceMode:PASSIVE or interfaceMode:INLINE or interfaceMode:SWITCHED</code>.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE internalcas

Request Type: DELETE

Description: Delete the internal certificate authority associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the internal certificate authority.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET internalcas

Request Type: GET

Description: Get the internal certificate authority associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the internal certificate authority.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL internalcas

Request Type: GETALL

Description: Get the list of all internal certificate authorities.

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

Query Parameters

filter - Filter by name of the certifcate authority.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST internalcas

Request Type: POST

Description: Create an internal certificate authority. _Check the response section for applicable examples (if any)._

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

Query Parameters

isCSR - Boolean parameter to specify if the request is to create a Certificate Signing Request(CSR) or not. <code>false</code> by default. When <code>false</code>, if a certificate/key pair is provided, the certificate/key pair is imported. Else, a self-signed certificate is generated. When <code>true</code>, a CSR is generated.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT internalcas

Request Type: PUT

Description: Modify the internal certificate authority associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the internal certificate authority.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL internalcertgroups

Request Type: GETALL

Description: Get the list of all internal certificate groups.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE internalcertificates

Request Type: DELETE

Description: Delete the internal certificate associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the internal certificate.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET internalcertificates

Request Type: GET

Description: Get the internal certificate associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the internal certificate.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL internalcertificates

Request Type: GETALL

Description: Get the list of all internal certificates.

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

Query Parameters

filter - Filter by name of certificate is supported.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST internalcertificates

Request Type: POST

Description: Create an internal certificate. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT internalcertificates

Request Type: PUT

Description: Modify the internal certificate associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the internal certificate.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE intrusionrulegroups

Request Type: DELETE

Description: Delete the Snort3 intrusion rule group associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

cascadeDeleteOrphanedRules - Boolean indicating whether to delete orphan rules. Mandatory if a custom rulegroup has unique/unshared rules which becomes orphan after the custom rule Group is deleted.

objectId - Unique identifier of the Snort3 intrusion rule group.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET intrusionrulegroups

Request Type: GET

Description: Get the Snort3 intrusion rule group associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the Snort3 intrusion rule group.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL intrusionrulegroups

Request Type: GETALL

Description: Get the list of all Snort3 intrusion rule groups.

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

Query Parameters

filter - Value can be any of the formats (including quotes): <code>"name:Browser/Firefox"</code> or <code>"currentSecurityLevel:DISABLED"</code> or <code>"showonlyparents:{true/false}"</code> or <code>"isSystemDefined:{true/false}"</code> or <code>"includeCount:true"</code>.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST intrusionrulegroups

Request Type: POST

Description: Create a Snort3 intrusion rule group. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT intrusionrulegroups

Request Type: PUT

Description: Modify the Snort3 intrusion rule group associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the Snort3 intrusion rule group.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE intrusionrules

Request Type: DELETE

Description: Delete all Snort3 intrusion rules. Use filtering to specify which rules will be deleted. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean indicating whether this is a bulk operation. This parameter is required for bulk Snort 3 intrusion rule operations.

filter - Value can be any of the formats (including quotes): <code>"gid:123;sid:456"</code> or <code>"overrides:true;ipspolicy:{uuid1,uuid2,...}</code> or <code>"fts:789"</code> or <code>"isSystemDefined:{true/false}"</code>. <code>ipspolicy</code> is a comma-separated list of Snort 3 Intrusion Policy IDs.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET intrusionrules

Request Type: GET

Description: Get the Snort3 intrusion rule associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the Snort3 intrusion rule.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL intrusionrules

Request Type: GETALL

Description: Get the list of all Snort3 intrusion rules.

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

Query Parameters

filter - Value can be any of the formats (including quotes): <code>"gid:123;sid:456"</code> or <code>"overrides:true;ipspolicy:{uuid1,uuid2,...}</code> or <code>"fts:789"</code> or <code>"isSystemDefined:{true/false}"</code>. <code>ipspolicy</code> is a comma-separated list of Snort 3 Intrusion Policy IDs.

sort - Parameters to sort the list. Values can include sid, -sid, gid, -gid, msg, and -msg.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST intrusionrules

Request Type: POST

Description: Create a Snort3 intrusion rule. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean indicating whether this is a bulk operation. This parameter is required for bulk Snort 3 intrusion rule operations.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT intrusionrules

Request Type: PUT

Description: Modify all snort3 intrusion rules. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean indicating whether this is a bulk operation. This parameter is required for bulk Snort 3 intrusion rule operations.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

POST intrusionrulesupload

Request Type: POST

Description: Import custom Snort3 intrusion rules. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE ipv4addresspools

Request Type: DELETE

Description: Delete the IPv4 address pool associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the IPv4 address pool.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET ipv4addresspools

Request Type: GET

Description: Get the IPv4 address pool associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the IPv4 address pool.

overrideTargetId - Get the overrides associated with the specified IPv4 Address Pool object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL ipv4addresspools

Request Type: GETALL

Description: Get the list of all IPv4 address pools.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ipv4addresspools

Request Type: POST

Description: Create an IPv4 address pool. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT ipv4addresspools

Request Type: PUT

Description: Modify the IPv4 address pool associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the IPv4 address pool.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE ipv4prefixlists

Request Type: DELETE

Description: Delete the IPv4 prefix list associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the IPv4 prefix list.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET ipv4prefixlists

Request Type: GET

Description: Get the IPv4 prefix list associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the IPv4 prefix list.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL ipv4prefixlists

Request Type: GETALL

Description: Get the list of all IPv4 prefix lists.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ipv4prefixlists

Request Type: POST

Description: Create an IPv4 prefix list. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT ipv4prefixlists

Request Type: PUT

Description: Modify the IPv4 prefix list associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the IPv4 prefix list.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE ipv6addresspools

Request Type: DELETE

Description: Delete the IPv6 address pool associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the IPv6 address pool.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET ipv6addresspools

Request Type: GET

Description: Get the IPv4 address pool associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the IPv6 address pool.

overrideTargetId - Get the overrides associated with the specified IPv6 Address Pool object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL ipv6addresspools

Request Type: GETALL

Description: Get the list of all IPv6 address pools.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ipv6addresspools

Request Type: POST

Description: Create an IPv6 address pool. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT ipv6addresspools

Request Type: PUT

Description: Modify the IPv6 address pool associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the IPv6 address pool.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE ipv6prefixlists

Request Type: DELETE

Description: Delete the IPv6 prefix list associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the IPv6 prefix list.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET ipv6prefixlists

Request Type: GET

Description: Get the IPv6 prefix list associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the IPv6 prefix list.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL ipv6prefixlists

Request Type: GETALL

Description: Get the list of all IPv6 prefix lists.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ipv6prefixlists

Request Type: POST

Description: Create an IPv6 prefix list. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT ipv6prefixlists

Request Type: PUT

Description: Modify the IPv6 prefix list associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the IPv6 prefix list.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET isesecuritygrouptags

Request Type: GET

Description: Get the ISE security group tag with the specified ID.

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

Query Parameters

objectId - Unique identifier of the ISE security group tag.

domainUUID - Domain UUID

GETALL isesecuritygrouptags

Request Type: GETALL

Description: Get the list of all ISE security group tags.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE keychains

Request Type: DELETE

Description: Delete the keychain object associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the keychain object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET keychains

Request Type: GET

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

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

Query Parameters

objectId - Unique identifier of the keychain object.

overrideTargetId - Get the overrides associated with the specified Key chain object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL keychains

Request Type: GETALL

Description: Get the list of all keychain objects.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST keychains

Request Type: POST

Description: Create a keychain object. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT keychains

Request Type: PUT

Description: Modify the keychain object associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the keychain object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE localrealmusers

Request Type: DELETE

Description: Delete the local realm user associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the local realm user.

domainUUID - Domain UUID

GET localrealmusers

Request Type: GET

Description: Get the local realm user associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the local realm user.

domainUUID - Domain UUID

GETALL localrealmusers

Request Type: GETALL

Description: Get the list of all local realm users.

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

Query Parameters

filter - To filter users by realm, use <code>realm:{realmUUID}</code><br/><br/>To filter users by name, use <code>name:{name}</code>

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST localrealmusers

Request Type: POST

Description: Create a local realm user. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

domainUUID - Domain UUID

PUT localrealmusers

Request Type: PUT

Description: Modify the local realm user associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the local realm user.

domainUUID - Domain UUID

DELETE macaddresspools

Request Type: DELETE

Description: Delete the MAC address pool associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the MAC address pool.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET macaddresspools

Request Type: GET

Description: Get the MAC address pool associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the MAC address pool.

overrideTargetId - Get the overrides associated with the specified MAC address pool.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL macaddresspools

Request Type: GETALL

Description: Get the list of all MAC address pools.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST macaddresspools

Request Type: POST

Description: Create a MAC address pool. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT macaddresspools

Request Type: PUT

Description: Modify the MAC address pool associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the MAC address pool.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL mappings

Request Type: GETALL

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

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

Query Parameters

objectId - Identifier or name of the Dynamic Object.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT mappings

Request Type: PUT

Description: Modify the Dynamic Object Mappings associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Identifier or name of the Dynamic Object.

action - Specify action for dynamic object mappings. It can be one of ["add", "remove", "remove_all"]. Default value is "add".

propagate - Control propagating dynamic object mappings. It can be ["true", "false"]. Default value is "true".

domainUUID - Domain UUID

GETALL networkaddresses

Request Type: GETALL

Description: Get the list of all types of network objects including Network, Host, Range, and FQDN.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value and <code>"type:{subType}"</code> to search for specific subType of the network object. <code>"type:{FQDN,RANGE,HOST,NETWORK}"</code> is for include and <code>"type!{FQDN,RANGE,HOST,NETWORK}"</code> is for exclude. To search for wildcard object type:NETWORK;includeWildcard:true.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL networkaddressoverrides

Request Type: GETALL

Description: Get overrides for all types of network objects including Network, Host, Range, and FQDN.

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

Query Parameters

networkType - Type of network object selected. Possible values are Host, Network, Range, and FQDN.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE networkgroups

Request Type: DELETE

Description: Delete all network groups. Use filtering to specify which network groups will be deleted. _Check the response section for applicable examples (if any)._

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.<code>"ids:id1,id2,..."</code>.<br/><code>ids</code> is a comma-separated list of rule IDs to be deleted.

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET networkgroups

Request Type: GET

Description: Get the network group associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the network group.

overrideTargetId - Get the overrides associated with the specified network group.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL networkgroups

Request Type: GETALL

Description: Get the list of all network groups.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.<code>"ids:id1,id2,..."</code>.<br/><code>ids</code> is a comma-separated list of rule IDs to be deleted.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST networkgroups

Request Type: POST

Description: Create a network group. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT networkgroups

Request Type: PUT

Description: Modify the network group associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the network group.

ticket-id - UUID of the ticket for tracking the configuration changes.

action - Indicates whether the network objects will be added or removed from the network group. Possible values are *add* and *remove*.

domainUUID - Domain UUID

DELETE networks

Request Type: DELETE

Description: Delete all network objects. Use filtering to specify which network objects will be deleted. _Check the response section for applicable examples (if any)._

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.<br/><code>"ids:id1,id2,..."</code>.<code>ids</code> is a comma-separated list of rule IDs to be deleted.

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET networks

Request Type: GET

Description: Get the network object associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the network object.

overrideTargetId - Get the overrides associated with the specified network object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL networks

Request Type: GETALL

Description: Get the list of all network objects.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.<br/><code>"ids:id1,id2,..."</code>.<code>ids</code> is a comma-separated list of rule IDs to be deleted.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST networks

Request Type: POST

Description: Create a network object. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT networks

Request Type: PUT

Description: Modify the network object associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the network object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE ntpservers

Request Type: DELETE

Description: Delete the NTP server associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the NTP server.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET ntpservers

Request Type: GET

Description: Get the NTP server associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the NTP server.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL ntpservers

Request Type: GETALL

Description: Get the list of all NTP servers.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ntpservers

Request Type: POST

Description: Create an NTP server. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT ntpservers

Request Type: PUT

Description: Modify the NTP server associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the NTP server.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE policylists

Request Type: DELETE

Description: Delete the policy list associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the policy list.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET policylists

Request Type: GET

Description: Get the policy list associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the policy list.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL policylists

Request Type: GETALL

Description: Get the list of all policy lists.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST policylists

Request Type: POST

Description: Create a policy list. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT policylists

Request Type: PUT

Description: Modify the policy list associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the policy list.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE portobjectgroups

Request Type: DELETE

Description: Delete all port object groups. Use filtering to specify which port object groups will be deleted. _Check the response section for applicable examples (if any)._

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET portobjectgroups

Request Type: GET

Description: Get the port object group associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the port object group.

overrideTargetId - Get the overrides associated with the specified port object group.

showProtocolNames - Boolean indicating whether the protocol will be show in the metadata. This should be used in conjunction with "expanded:true".

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL portobjectgroups

Request Type: GETALL

Description: Get the list of all port object groups.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

showProtocolNames - Boolean indicating whether the protocol will be show in the metadata. This should be used in conjunction with "expanded:true".

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST portobjectgroups

Request Type: POST

Description: Create a port object group. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT portobjectgroups

Request Type: PUT

Description: Modify the port object group associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the port object group.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL ports

Request Type: GETALL

Description: Get list of all ports.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE protocolportobjects

Request Type: DELETE

Description: Delete all protocol port objects. Use filtering to specify which protocol port objects will be deleted. _Check the response section for applicable examples (if any)._

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET protocolportobjects

Request Type: GET

Description: Get the protocol port object associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the protocol port object.

overrideTargetId - Get the overrides associated with the specified protocol port object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL protocolportobjects

Request Type: GETALL

Description: Get the list of all protocol port objects.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST protocolportobjects

Request Type: POST

Description: Create a protocol port object. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT protocolportobjects

Request Type: PUT

Description: Modify the protocol port object associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the protocol port object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE radiusservergroups

Request Type: DELETE

Description: Delete the Radius server group associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the Radius server group.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET radiusservergroups

Request Type: GET

Description: Get the Radius server group associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the Radius server group.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL radiusservergroups

Request Type: GETALL

Description: Get the list of all Radius server groups.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST radiusservergroups

Request Type: POST

Description: Create a Radius server group. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT radiusservergroups

Request Type: PUT

Description: Modify the Radius server group associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the Radius server group.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE ranges

Request Type: DELETE

Description: Delete all range objects. Use filtering to specify which range objects will be deleted. _Check the response section for applicable examples (if any)._

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET ranges

Request Type: GET

Description: Get the range object associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the range object.

overrideTargetId - Get the overrides associated with the specified range object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL ranges

Request Type: GETALL

Description: Get the list of all range objects.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST realms

Request Type: POST

Description: Create a realm. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT ranges

Request Type: PUT

Description: Modify the range object associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the range object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE realms

Request Type: DELETE

Description: Delete the realm associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the realm.

domainUUID - Domain UUID

GET realms

Request Type: GET

Description: Get the realm associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the realm.

domainUUID - Domain UUID

GETALL realms

Request Type: GETALL

Description: Get the list of all realms.

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

Query Parameters

filter - Filter criteria can be specified using the format <code>name:name;realmType:realmType;enabled:enabled</code><br/><br/><code>name</code> -- Name of the realm to be queried. May start with ^ to indicate filtering by names starting with, rather than containing.<br/><code>realmType</code> -- Type of the realm to be queried. A comma seperated list of realm types.<br/><code>enabled</code> -- Either <code>true</code> or <code>false</code>.<br/>

name - Name of the realm to be queried.

realmType - Type of the realm. Possible values are: <code>AD</code>, <code>LDAP</code>, <code>Local</code> and <code>SAML</code>.

enabled - Either <code>true</code> or <code>false</code>.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST realms

Request Type: POST

Description: Create a realm. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT realms

Request Type: PUT

Description: Modify the realm associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the realm.

domainUUID - Domain UUID

GETALL realmstatuses

Request Type: GETALL

Description: Get SAML realm status information.

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

Query Parameters

ids - Comma-separated list of identifiers of requested SAML realms.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET realmusergroups

Request Type: GET

Description: Get the realm user group associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the realm user group.

domainUUID - Domain UUID

GETALL realmusergroups

Request Type: GETALL

Description: Get the list of all realm user groups.

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

Query Parameters

filter - Filter criteria can be specified using the format <code>name:name;realm:realm;userId:userId</code><br/><br/><code>name</code> -- Name of the group to be queried starting with....<br/><code>realm</code> -- Realm uuid for the group.<br/><code>userId</code> -- Groups with the user id. <br/>

name - Name or part of the name of the group.

realm - UUID of the realm user group.

userId - Searches for realms containing the given userid.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET realmusers

Request Type: GET

Description: Get the realm user associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the user.

domainUUID - Domain UUID

GETALL realmusers

Request Type: GETALL

Description: Get the list of all realm users.

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

Query Parameters

filter - Filter criteria can be specified using the format <code>name:name;realm:realm;groupId:groupId;resolved:resolved</code><br/><br/><code>name</code> -- Name of the user to be queried starting with...<br/><code>realm</code> -- Realm uuid for the user.<br/><code>groupId</code> -- Users with the group id. <br/><code>resolved</code> -- Either <code>true</code> or <code>false</code>.<br/>

name - Name or part of the name of the user.

realm - Realm uuid for the user.

resolved - Either <code>true</code> or <code>false</code>.

groupId - Users with the group id.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE resourceprofiles

Request Type: DELETE

Description: Delete the resource profile associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the resource profile.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET resourceprofiles

Request Type: GET

Description: Get the resource profile associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the resource profile.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL resourceprofiles

Request Type: GETALL

Description: Get the list of all resource profiles.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST resourceprofiles

Request Type: POST

Description: Create a resource profile. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT resourceprofiles

Request Type: PUT

Description: Modify the resource profile associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the resource profile.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE routemaps

Request Type: DELETE

Description: Delete the route map associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the route map.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET routemaps

Request Type: GET

Description: Get the route map associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the route map.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL routemaps

Request Type: GETALL

Description: Get the list of all route maps.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST routemaps

Request Type: POST

Description: Create a route map. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT routemaps

Request Type: PUT

Description: Modify the route map associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the route map.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL samlrealmusersandgroups

Request Type: GETALL

Description: Get users and groups associated with the Azure AD realm specified in the parameters.

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

Query Parameters

filter - Filter criteria can be specified using the format <code>name:name;realm:realm;</code><br/><br/><code>name</code> -- Name of the user to be queried starting with...<br/><code>realm</code> -- Realm uuid for the user.<br/>

name - Name or part of the name of the user or group.

realm - Required parameter. Realm uuid for the users and groups.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE secureclientcustomizations

Request Type: DELETE

Description: Delete the AnyConnect Customization object associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the AnyConnect Customization object.

domainUUID - Domain UUID

GET secureclientcustomizations

Request Type: GET

Description: Get the AnyConnect Customization object associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the AnyConnect Customization object.

domainUUID - Domain UUID

GETALL secureclientcustomizations

Request Type: GETALL

Description: Get the list of all AnyConnect Customization objects.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST secureclientcustomizations

Request Type: POST

Description: Create an AnyConnect Customization object. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT secureclientcustomizations

Request Type: PUT

Description: Modify the AnyConnect Customization object associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the AnyConnect Customization object.

domainUUID - Domain UUID

DELETE securitygrouptags

Request Type: DELETE

Description: Delete the custom security group tag associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the custom security group tag.

domainUUID - Domain UUID

GET securitygrouptags

Request Type: GET

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

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

Query Parameters

objectId - Unique identifier of the custom security group tag.

domainUUID - Domain UUID

GETALL securitygrouptags

Request Type: GETALL

Description: Get the list of all custom security group tags.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST securitygrouptags

Request Type: POST

Description: Create a custom security group tag. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT securitygrouptags

Request Type: PUT

Description: Modify the custom security group tag associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the custom security group tag.

domainUUID - Domain UUID

DELETE securityzones

Request Type: DELETE

Description: Delete the security zone associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the security zone.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET securityzones

Request Type: GET

Description: Get the security zone associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the security zone.

groupByDevice - Boolean indicating whether to group interfaces by device and return as devices attribute instead of interfaces.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL securityzones

Request Type: GETALL

Description: Get the list of all security zones.

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

Query Parameters

filter - Specify the desired InterfaceMore. Value is of format interfaceMode:ROUTED or interfaceMode:PASSIVE or interfaceMode:INLINE or interfaceMode:SWITCHED or interfaceMode:ASA.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST securityzones

Request Type: POST

Description: Create a security zone. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT securityzones

Request Type: PUT

Description: Modify the security zone associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the security zone.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE serviceaccessobjects

Request Type: DELETE

Description: Delete the service access objection associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the service access object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET serviceaccessobjects

Request Type: GET

Description: Get the service access objection associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the service access object.

overrideTargetId - Get the overrides associated with the specified service access object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL serviceaccessobjects

Request Type: GETALL

Description: Get the list of all service access objects.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST serviceaccessobjects

Request Type: POST

Description: Create a service access object. _Check the response section for applicable examples (if any)._

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT serviceaccessobjects

Request Type: PUT

Description: Modify the service access objection associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the service access object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL serviceaccessobjectsoverrides

Request Type: GETALL

Description: Get all overrides on the specified service access object. Response will always be in expanded form. If passed, the "expanded" query parameter will be ignored..

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET sidnsfeeds

Request Type: GET

Description: Get the security intelligence DNS feed associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the security intelligence DNS feed.

domainUUID - Domain UUID

GETALL sidnsfeeds

Request Type: GETALL

Description: Get the list of all security intelligence DNS feeds.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET sidnslists

Request Type: GET

Description: Get the security intelligence DNS list associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the security intelligence DNS list.

domainUUID - Domain UUID

GETALL sidnslists

Request Type: GETALL

Description: Get the list of all security intelligence DNS lists.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE sinetworkfeeds

Request Type: DELETE

Description: Delete the security intelligence network feed associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the security intelligence network feed.

domainUUID - Domain UUID

GET sinetworkfeeds

Request Type: GET

Description: Get the security intelligence network feed associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the security intelligence network feed.

domainUUID - Domain UUID

GETALL sinetworkfeeds

Request Type: GETALL

Description: Get the list of all security intelligence network feeds.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST sinetworkfeeds

Request Type: POST

Description: Create a security intelligence network feed. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT sinetworkfeeds

Request Type: PUT

Description: Modify the security intelligence network feed associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the security intelligence network feed.

domainUUID - Domain UUID

GET sinetworklists

Request Type: GET

Description: Get the security intelligence network list associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the security intelligence network list.

domainUUID - Domain UUID

GETALL sinetworklists

Request Type: GETALL

Description: Get the list of all security intelligence network lists.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET sinkholes

Request Type: GET

Description: Get the sinkhole associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the sinkhole.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL sinkholes

Request Type: GETALL

Description: Get the list of all sinkholes.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE siurlfeeds

Request Type: DELETE

Description: Delete the security intelligence url feed associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the security intelligence url feed.

domainUUID - Domain UUID

GET siurlfeeds

Request Type: GET

Description: Get the security intelligence url feed associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the security intelligence url feed.

domainUUID - Domain UUID

GETALL siurlfeeds

Request Type: GETALL

Description: Get the list of all security intelligence url feeds.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST siurlfeeds

Request Type: POST

Description: Create a security intelligence url feed. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT siurlfeeds

Request Type: PUT

Description: Modify the security intelligence url feed associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the security intelligence url feed.

domainUUID - Domain UUID

DELETE siurllists

Request Type: DELETE

Description: Delete the security intelligence url list associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the security intelligence url list.

domainUUID - Domain UUID

GET siurllists

Request Type: GET

Description: Get the security intelligence url list associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the security intelligence url list.

domainUUID - Domain UUID

GETALL siurllists

Request Type: GETALL

Description: Get the list of all security intelligence url lists.

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

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST siurllists

Request Type: POST

Description: Create a security intelligence url list. _Check the response section for applicable examples (if any)._

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

Query Parameters

domainUUID - Domain UUID

PUT siurllists

Request Type: PUT

Description: Modify the security intelligence url list associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the security intelligence url list.

domainUUID - Domain UUID

DELETE slamonitors

Request Type: DELETE

Description: Delete the service level agreement monitor associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the service level agreement monitor.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET slamonitors

Request Type: GET

Description: Get the service level agreement monitor associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the service level agreement monitor.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL slamonitors

Request Type: GETALL

Description: Get the list of all service level agreement monitors.

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

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST slamonitors

Request Type: POST

Description: Create a service level agreement monitor. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT slamonitors

Request Type: PUT

Description: Modify the service level agreement monitor associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the service level agreement monitor.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE ssoservers

Request Type: DELETE

Description: Delete the SSO server policy associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the SSO server policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET ssoservers

Request Type: GET

Description: Get the SSO server policy associated with the specified ID.

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

Query Parameters

objectId - Unique identifier of the SSO server policy.

overrideTargetId - Get the overrides associated with the specified SSO server policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL ssoservers

Request Type: GETALL

Description: Get the list of all SSO server policies.

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

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ssoservers

Request Type: POST

Description: Create an SSO server policy. _Check the response section for applicable examples (if any)._

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

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT ssoservers

Request Type: PUT

Description: Modify the SSO server policy associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the SSO server policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE standardaccesslists

Request Type: DELETE

Description: Delete the standard access list associated with the specified ID. _Check the response section for applicable examples (if any)._

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

Query Parameters

objectId - Unique identifier of the standard access list.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET standardaccesslists

Request Type: GET

Description: Get the standard access list associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/standardaccesslists/{objectId}

Query Parameters

objectId - Unique identifier of the standard access list.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL standardaccesslists

Request Type: GETALL

Description: Get the list of all standard access lists.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/standardaccesslists

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST standardaccesslists

Request Type: POST

Description: Create a standard access list. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/standardaccesslists

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT standardaccesslists

Request Type: PUT

Description: Modify the standard access list associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/standardaccesslists/{objectId}

Query Parameters

objectId - Unique identifier of the standard access list.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE standardcommunitylists

Request Type: DELETE

Description: Delete the standard community list associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/standardcommunitylists/{objectId}

Query Parameters

objectId - Unique identifier of the standard community list.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET standardcommunitylists

Request Type: GET

Description: Get the standard community list associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/standardcommunitylists/{objectId}

Query Parameters

objectId - Unique identifier of the standard community list.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL standardcommunitylists

Request Type: GETALL

Description: Get the list of all standard community lists.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/standardcommunitylists

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST standardcommunitylists

Request Type: POST

Description: Create a standard community list. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/standardcommunitylists

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT standardcommunitylists

Request Type: PUT

Description: Modify the standard community list associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/standardcommunitylists/{objectId}

Query Parameters

objectId - Unique identifier of the standard community list.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

POST testazureadrealms

Request Type: POST

Description: Test Azure AD realm connectivity. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/testazureadrealms

Query Parameters

domainUUID - Domain UUID

POST testrealms

Request Type: POST

Description: Test realm connectivity. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/operational/testrealms

Query Parameters

domainUUID - Domain UUID

DELETE timeranges

Request Type: DELETE

Description: Delete the time range associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/timeranges/{objectId}

Query Parameters

objectId - Unique identifier of the time range.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET timeranges

Request Type: GET

Description: Get the time range associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/timeranges/{objectId}

Query Parameters

objectId - Unique identifier of the time range.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL timeranges

Request Type: GETALL

Description: Get the list of all time ranges.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/timeranges

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST timeranges

Request Type: POST

Description: Create a time range. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/timeranges

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT timeranges

Request Type: PUT

Description: Modify the time range associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/timeranges/{objectId}

Query Parameters

objectId - Unique identifier of the time range.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE timezoneobjects

Request Type: DELETE

Description: Delete the time zone object associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/timezoneobjects/{objectId}

Query Parameters

objectId - Unique identifier of the time zone object.

overrideTargetId - Get the overrides associated with the specified time zone object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET timezoneobjects

Request Type: GET

Description: Get the time zone object associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/timezoneobjects/{objectId}

Query Parameters

objectId - Unique identifier of the time zone object.

overrideTargetId - Get the overrides associated with the specified time zone object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL timezoneobjects

Request Type: GETALL

Description: Get the list of all time zone objects.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/timezoneobjects

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST timezoneobjects

Request Type: POST

Description: Create a time zone object. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/timezoneobjects

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT timezoneobjects

Request Type: PUT

Description: Modify the time zone object associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/timezoneobjects/{objectId}

Query Parameters

objectId - Unique identifier of the time zone object.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE tunneltags

Request Type: DELETE

Description: Delete the tunnel tag associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/tunneltags/{objectId}

Query Parameters

objectId - Unique identifier of the tunnel tag.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET tunneltags

Request Type: GET

Description: Get the tunnel tag associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/tunneltags/{objectId}

Query Parameters

objectId - Unique identifier of the tunnel tag.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL tunneltags

Request Type: GETALL

Description: Get the list of all tunnel tags.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/tunneltags

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST tunneltags

Request Type: POST

Description: Create a tunnel tag. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/tunneltags

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT tunneltags

Request Type: PUT

Description: Modify the tunnel tag associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/tunneltags/{objectId}

Query Parameters

objectId - Unique identifier of the tunnel tag.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL umbrellaprotectionpolicies

Request Type: GETALL

Description: Get Umbrella protection policy from Umbrella cloud.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/operational/umbrellaprotectionpolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST umbrellaprotectionpolicies

Request Type: POST

Description: Create Umbrella protection policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/operational/umbrellaprotectionpolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET urlcategories

Request Type: GET

Description: Get the URL category associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/urlcategories/{objectId}

Query Parameters

objectId - Unique identifier of the URL category.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL urlcategories

Request Type: GETALL

Description: Get the list of all URL categories.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/urlcategories

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE urlgroups

Request Type: DELETE

Description: Delete all URL groups. Use filtering to specfiy which URL groups will be deleted. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/urlgroups

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.<br/><code>"ids:id1,id2,..."</code>.<code>ids</code> is a comma-separated list of rule IDs to be deleted.

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET urlgroups

Request Type: GET

Description: Get the URL group associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/urlgroups/{objectId}

Query Parameters

objectId - Unique identifier of the URL group.

overrideTargetId - Get the overrides associated with the specified URL group.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL urlgroups

Request Type: GETALL

Description: Get the list of all URL groups.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/urlgroups

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.<br/><code>"ids:id1,id2,..."</code>.<code>ids</code> is a comma-separated list of rule IDs to be deleted.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST urlgroups

Request Type: POST

Description: Create a URL group. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/urlgroups

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT urlgroups

Request Type: PUT

Description: Modify the URL group associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/urlgroups/{objectId}

Query Parameters

objectId - Unique identifier of the URL group.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE urls

Request Type: DELETE

Description: Delete all URLs. Use filtering to specfiy which URLs will be deleted. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/urls

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.<br/><code>"ids:id1,id2,..."</code>.<code>ids</code> is a comma-separated list of rule IDs to be deleted.

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET urls

Request Type: GET

Description: Get the URL associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/urls/{objectId}

Query Parameters

objectId - Unique identifier of the URL.

overrideTargetId - Get the overrides associated with the specified URL.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL urls

Request Type: GETALL

Description: Get the list of all URLs.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/urls

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.<br/><code>"ids:id1,id2,..."</code>.<code>ids</code> is a comma-separated list of rule IDs to be deleted.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST urls

Request Type: POST

Description: Create a URL. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/urls

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT urls

Request Type: PUT

Description: Modify the URL associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/urls/{objectId}

Query Parameters

objectId - Unique identifier of the URL.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL usage

Request Type: GETALL

Description: Find usage of specified object uuid and type across objects and policies.<br><br>Supported object types:<ul><li>Network: NetworkAddress, Host, Network, Range, FQDN, NetworkGroup</li><li>Port: Port, ProtocolPortObject, PortObjectGroup, ICMPV4Object, ICMPV6Object, AnyProtocolPortObject</li><li>VLAN tag: VlanTag, VlanGroupTag</li><li>URL: Url, UrlGroup</li></ul>

URL: /api/fmc_config/v1/domain/{domainUUID}/object/operational/usage

Query Parameters

filter - Specify uuid <code>"uuid:object-uuid"</code> and <code>"type:object-type"</code> and type of object

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST validatecertfile

Request Type: POST

Description: Upload and parse a given certificate/key file. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/validatecertfile

Query Parameters

domainUUID - Domain UUID

DELETE variables

Request Type: DELETE

Description: Delete the specified device template variable. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/variables/{objectId}

Query Parameters

objectId - Unique identifier of the device template variable.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET variables

Request Type: GET

Description: Get the specified device template variable.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/variables/{objectId}

Query Parameters

objectId - Unique identifier of the device template variable.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL variables

Request Type: GETALL

Description: Get the list of all variables for device templates.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/variables

Query Parameters

filter - Name or part of the name of the variables.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST variables

Request Type: POST

Description: Create a variable for device templates. A variable defines specific configuration values in a template and can be of types AS number, FQDN, IPv4/IPv6 host, IPv4/IPv6 network, IPv4 range, password, router ID, and custom strings. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/variables

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT variables

Request Type: PUT

Description: Modify the specified device template variable. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/variables/{objectId}

Query Parameters

objectId - Unique identifier of the device template variable.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET variablesets

Request Type: GET

Description: Get the variable set associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/variablesets/{objectId}

Query Parameters

objectId - Unique identifier of the variable set.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL variablesets

Request Type: GETALL

Description: Get the list of all variable sets.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/variablesets

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE vlangrouptags

Request Type: DELETE

Description: Delete all VLAN group tags. Use filtering to specfiy which VLAN group tags will be deleted. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/vlangrouptags

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.<br/><code>"ids:id1,id2,..."</code>.<code>ids</code> is a comma-separated list of rule IDs to be deleted.

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET vlangrouptags

Request Type: GET

Description: Get the VLAN group tag associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/vlangrouptags/{objectId}

Query Parameters

objectId - Unique identifier of the VLAN group tag.

overrideTargetId - Get the overrides associated with the specified VLAN group tag.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL vlangrouptags

Request Type: GETALL

Description: Get the list of all VLAN group tags.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/vlangrouptags

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.<br/><code>"ids:id1,id2,..."</code>.<code>ids</code> is a comma-separated list of rule IDs to be deleted.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST vlangrouptags

Request Type: POST

Description: Create a VLAN group tag. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/vlangrouptags

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT vlangrouptags

Request Type: PUT

Description: Modify the VLAN group tag associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/vlangrouptags/{objectId}

Query Parameters

objectId - Unique identifier of the VLAN group tag.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE vlantags

Request Type: DELETE

Description: Delete all VLAN tags. Use filtering to specify which VLAN tags will be deleted. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/vlantags

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.<br/><code>"ids:id1,id2,..."</code>.<code>ids</code> is a comma-separated list of rule IDs to be deleted.

bulk - Enables bulk create for vlan tag objects.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET vlantags

Request Type: GET

Description: Get the VLAN tag associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/vlantags/{objectId}

Query Parameters

objectId - Unique identifier of the VLAN tag.

overrideTargetId - Get the overrides associated with the specified VLAN tag.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL vlantags

Request Type: GETALL

Description: Get the list of all VLAN tags.

URL: /api/fmc_config/v1/domain/{domainUUID}/object/vlantags

Query Parameters

filter - To be used in conjunction with <code>"unusedOnly:true"</code> to search for unused objects and <code>"nameOrValue:{nameOrValue}"</code> to search for both name and value.<br/><code>"ids:id1,id2,..."</code>.<code>ids</code> is a comma-separated list of rule IDs to be deleted.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST vlantags

Request Type: POST

Description: Create a VLAN tag. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/vlantags

Query Parameters

bulk - Enables bulk create for vlan tag objects.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT vlantags

Request Type: PUT

Description: Modify the VLAN tag associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/vlantags/{objectId}

Query Parameters

objectId - Unique identifier of the VLAN tag.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

Policy Services

GET accesslistsettings

Request Type: GET

Description: Get the access list policy setting associated with the specified ID for the specified chassis platform settings policy from the management center.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/accesslistsettings/{objectId}

Query Parameters

objectId - Unique identifier of the access list policy setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL accesslistsettings

Request Type: GETALL

Description: Get access list policy settings for the specified chassis platform settings policy from the management center.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/accesslistsettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT accesslistsettings

Request Type: PUT

Description: Modify the access list policy setting associated with the specified ID for the specified chassis platform settings policy from the management center. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/accesslistsettings/{objectId}

Query Parameters

objectId - Unique identifier of the access list policy setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE accesspolicies

Request Type: DELETE

Description: Delete the access control policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{objectId}

Query Parameters

objectId - Unique identifier of the access control policy.

ignoreWarning - Shows any warnings when deleting an access policy, if set to false. If not specified, value is set to true and warnings are ignored. Allowed values are true and false.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET accesspolicies

Request Type: GET

Description: Get the access control policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{objectId}

Query Parameters

objectId - Unique identifier of the access control policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL accesspolicies

Request Type: GETALL

Description: Get the list of all access control policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies

Query Parameters

name - Only show the policy matching the specified name.

filter - Value is of format (including quotes): <code>"locked:{true|false}"</code><br/><code>locked</code>query parameter when set to 'true' returns list of Access Policies which are locked and when set to 'false' returns policies which are unlocked.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST accesspolicies

Request Type: POST

Description: Create an access control policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT accesspolicies

Request Type: PUT

Description: Modify the access control policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{objectId}

Query Parameters

objectId - Unique identifier of the access control policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE accessrules

Request Type: DELETE

Description: Delete the access rule associated with the specified policy ID and rule ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/accessrules/{objectId}

Query Parameters

objectId - Unique identifier of the access rule.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE accessrules bulk

Request Type: DELETE

Description: Delete all access rules. Use filtering to specify which access rules will be deleted. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/accessrules

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

filter - For bulk delete needs the filter="ids:" and with <code>bulk=true</code> flag, Value is of format (including quotes): <code>"ids:id1,id2,..."</code>. <br/><code>ids</code> is a comma-separated list of rule IDs to be deleted.<br/> Supported filter criteria are "name", "timeRange", "action", "sourceNetworks", "destinationNetworks", "sourcePorts", "destinationPorts", "sourceZones", "destinationZones", "applications", "sourceDynamicObjects", "destinationDynamicObjects", "vlanTags", "comments", "users", "urls", "intrusionPolicy", "sourceSecurityGroupTags", "fts".

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET accessrules

Request Type: GET

Description: Get the access rule associated with the specified policy ID and rule ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/accessrules/{objectId}

Query Parameters

objectId - Unique identifier of the access rule.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL accessrules

Request Type: GETALL

Description: Get the list of all access rules associated with the specified policy ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/accessrules

Query Parameters

filter - For GetAll Filter criteria can be specified using the format <code>"name:filterName; timeRange:true;action:filterAction;sourceNetworks:filterValue1,filterValue2...."</code>. <br/>Supported filter criteria are "name", "timeRange", "action", "sourceNetworks", "originalClientIP", "destinationNetworks", "sourcePorts", "destinationPorts", "sourceZones", "destinationZones", "applications", "sourceDynamicObjects", "destinationDynamicObjects", "vlanTags", "comments", "users", "urls", "intrusionPolicy", "sourceSecurityGroupTags", "fts".

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST accessrules

Request Type: POST

Description: Create access rules. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/accessrules

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

insertAfter - 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 takes precedence over insertAfter - if both are specified, the insertBefore parameter will apply.

insertBefore - 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.

section - 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, a category cannot be specified.

category - 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 section is specified, a category cannot be specified.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT accessrules

Request Type: PUT

Description: Modify all access rules. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/accessrules

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

partialUpdate - Boolean indicating whether to change the entire object or only certain attributes of it. The default value is FALSE.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET addressassignmentsettings

Request Type: GET

Description: Get the specified address assignment setting inside a remote access VPN topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/addressassignmentsettings/{objectId}

Query Parameters

objectId - Identifier for the address assignment Setting in a remote access VPN topology.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL addressassignmentsettings

Request Type: GETALL

Description: Get list containing a single Address Assignment Setting entry of the topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/addressassignmentsettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT addressassignmentsettings

Request Type: PUT

Description: Modify the specified address assignment setting inside a remote access VPN topology. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/addressassignmentsettings/{objectId}

Query Parameters

objectId - Identifier for the address assignment Setting in a remote access VPN topology.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET advancedsettings

Request Type: GET

Description: Get the advanced setting associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/advancedsettings/{objectId}

Query Parameters

objectId - Identifier for the advanced setting in a Site to Site VPN topology.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL advancedsettings

Request Type: GETALL

Description: Get advanced settings inside a VPN Site To Site Topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/advancedsettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT advancedsettings

Request Type: PUT

Description: Modify the advanced setting associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/advancedsettings/{objectId}

Query Parameters

objectId - Identifier for the advanced setting in a Site to Site VPN topology.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL allowdnsrules

Request Type: GETALL

Description: Get the allow rules for a DNS policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/dnspolicies/{containerUUID}/allowdnsrules

Query Parameters

filter - [DEV ERROR: Missing description]

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE applicationgroups

Request Type: DELETE

Description: Delete the Zero Trust Application Group associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{containerUUID}/applicationgroups/{objectId}

Query Parameters

objectId - Unique identifier of the Zero Trust application group.

ignoreWarning - Shows any warnings when deleting a zero trust application group policy, if set to false. If not specified, value is set to true and warnings are ignored. Allowed values are true and false.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET applicationgroups

Request Type: GET

Description: Get the Zero Trust Application Group associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{containerUUID}/applicationgroups/{objectId}

Query Parameters

objectId - Unique identifier of the Zero Trust application group.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL applicationgroups

Request Type: GETALL

Description: Get the list of all Zero Trust application groups.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{containerUUID}/applicationgroups

Query Parameters

filter - To filter policies.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST applicationgroups

Request Type: POST

Description: Create a Zero Trust application group. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{containerUUID}/applicationgroups

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT applicationgroups

Request Type: PUT

Description: Modify the Zero Trust Application Group associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{containerUUID}/applicationgroups/{objectId}

Query Parameters

objectId - Unique identifier of the Zero Trust application group.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE autonatrules

Request Type: DELETE

Description: Delete all Auto NAT rules. Use filtering to specify which rules will be deleted. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/autonatrules

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

filter - Value is of format : <code>"ids:id1,id2,...; sourceInterface:name1,name2,...;destinationInterface:name1,name2,...; <br/>originalSource:name1/value1,name2/value2,...;translatedSource:name1/value1,name2/value2,...; <br/>originalSourcePort:name1/value1,name2/value2,...;translatedSourcePort:name1/value1,name2/value2,...; "</code><br/> <br/>ids:id1,id2,...etc. This ids is a comma-separated list of rule ids to delete</br>sourceInterface:SecurityZone/Interface group name (sec_zone_name1) can be given as value to fetch/delete NAT rule<br/>destinationInterface:SecurityZone/Interface group name (sec_zone_name1) can be given as value to delete NAT rule<br/>originalSource: Network object configured as Original source object name (object_name) or the value (10.1.2.3) of the object can be given<br/>translatedSource:Network object configured as translated source object name (object_name) or the value (10.1.2.3) of the object can be given<br/>originalSourcePort:Port object configured as Original Source Port object name (http) or value of the object as port no or protocol (tcp/80) can be given<br/>translatedSourcePort:Port object configured as Translated Source Port object name (http) or value of the object as port no or protocol (tcp/80) can be given<br/>

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET autonatrules

Request Type: GET

Description: Get the Auto NAT rule associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/autonatrules/{objectId}

Query Parameters

objectId - Unique identifier of the Auto NAT rule.

section - Section from which to get the Auto NAT rule. Can be set to "auto".

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL autonatrules

Request Type: GETALL

Description: Get the list of all Auto NAT rules.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/autonatrules

Query Parameters

filter - Value is of format : <code>"ids:id1,id2,...;sourceInterface:name1,name2,...; destinationInterface:name1,name2,...; <br/>originalSource:name1/value1,name2/value2,...; translatedSource:name1/value1,name2/value2,...; <br/>originalSourcePort:name1/value1,name2/value2,...; translatedSourcePort:name1/value1,name2/value2,...; "</code><br/> <br/>ids:id1,id2,...etc. This ids is a comma-separated list of rule ids to fetch</br>sourceInterface:SecurityZone/Interface group name (sec_zone_name1) can be given as value to fetch NAT rule<br/>destinationInterface:SecurityZone/Interface group name (sec_zone_name1) can be given as value to fetch/delete NAT rule<br/>originalSource: Network object configured as Original source object name (object_name) or the value (10.1.2.3) of the object can be given<br/>translatedSource:Network object configured as translated source object name (object_name) or the value (10.1.2.3) of the object can be given<br/>originalSourcePort:Port object configured as Original Source Port object name (http) or value of the object as port no or protocol (tcp/80) can be given<br/>translatedSourcePort:Port object configured as Translated Source Port object name (http) or value of the object as port no or protocol (tcp/80) can be given<br/>

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST autonatrules

Request Type: POST

Description: Create an Auto NAT rule. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/autonatrules

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

section - Section in which to create the Auto NAT rule. Can be set to "auto".

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT autonatrules

Request Type: PUT

Description: Modify the Auto NAT rule associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/autonatrules/{objectId}

Query Parameters

objectId - Unique identifier of the Auto NAT rule.

partialUpdate - Boolean indicating whether to change the entire object or only certain attributes of it. The default value is FALSE.

section - Section of the Auto NAT rule. Can be set to "auto".

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET bannersettings

Request Type: GET

Description: Get the login banner policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/bannersettings/{objectId}

Query Parameters

objectId - Unique identifier of the container Threat Defense Platform Settings policy to which this Login banner policy belongs. Same as container UUID.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL bannersettings

Request Type: GETALL

Description: Get all login banner policies for the given platform settings.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/bannersettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT bannersettings

Request Type: PUT

Description: Modify the login banner policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/bannersettings/{objectId}

Query Parameters

objectId - Unique identifier of the container Threat Defense Platform Settings policy to which this Login banner policy belongs. Same as container UUID.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET basicloggingsetups

Request Type: GET

Description: Get the basic Syslog logging setting associated with a given Platform Setting policy and specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/basicloggingsetups/{objectId}

Query Parameters

objectId - The identifier of the platform settings policy to which this Syslog setting belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL basicloggingsetups

Request Type: GETALL

Description: Get the basic Syslog logging setup associated with a given Platform Setting policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/basicloggingsetups

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT basicloggingsetups

Request Type: PUT

Description: Modify the basic Syslog logging setting associated with a given Platform Setting policy and specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/basicloggingsetups/{objectId}

Query Parameters

objectId - The identifier of the platform settings policy to which this Syslog setting belongs.

partialUpdate - Boolean indicating whether to change the entire object or only certain attributes of it. The default value is FALSE.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL blockdnsrules

Request Type: GETALL

Description: Get the block rules for a DNS policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/dnspolicies/{containerUUID}/blockdnsrules

Query Parameters

filter - [DEV ERROR: Missing description]

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE categories

Request Type: DELETE

Description: Delete the category associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/categories/{objectId}

Query Parameters

objectId - Unique identifier of the category.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET categories

Request Type: GET

Description: Get the category associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/categories/{objectId}

Query Parameters

objectId - Unique identifier of the category.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL categories

Request Type: GETALL

Description: Get the list of all categories associated with the specified policy ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/categories

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST categories

Request Type: POST

Description: Create a list of all categories associated with the specified policy ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/categories

Query Parameters

section - Get, create or modify category in given section. Allowed values are mandatory or default.

aboveCategory - Create the category above the specified category.

insertBefore - Create the category above the given rule index.

insertAfter - Create the category given the given rule index.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT categories

Request Type: PUT

Description: Modify the category associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/categories/{objectId}

Query Parameters

objectId - Unique identifier of the category.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE chassisplatformsettingspolicies

Request Type: DELETE

Description: Delete the chassis platform settings policies associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{objectId}

Query Parameters

objectId - Unique identifier of the chassis platform settings policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET chassisplatformsettingspolicies

Request Type: GET

Description: Get the chassis platform settings policies associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{objectId}

Query Parameters

objectId - Unique identifier of the chassis platform settings policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL chassisplatformsettingspolicies

Request Type: GETALL

Description: Get the chassis platform settings policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST chassisplatformsettingspolicies

Request Type: POST

Description: Create chassis platform settings policies. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT chassisplatformsettingspolicies

Request Type: PUT

Description: Modify the chassis platform settings policies associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{objectId}

Query Parameters

objectId - Unique identifier of the chassis platform settings policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE connectionprofiles

Request Type: DELETE

Description: Delete connection profile data inside a remote access VPN topology. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/connectionprofiles/{objectId}

Query Parameters

objectId - Unique identifier for the connection profile in a remote access VPN topology.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET decryptionpolicies

Request Type: GET

Description: Get the decryption policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies/{objectId}

Query Parameters

objectId - Unique identifier of the decryption policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL connectionprofiles

Request Type: GETALL

Description: Get the list containing a single Connection Profile entry of the topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/connectionprofiles

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST connectionprofiles

Request Type: POST

Description: Create connection profile data inside the remote access VPN topology. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/connectionprofiles

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT connectionprofiles

Request Type: PUT

Description: Modify connection profile data inside a remote access VPN topology. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/connectionprofiles/{objectId}

Query Parameters

objectId - Unique identifier for the connection profile in a remote access VPN topology.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE decryptionpolicies

Request Type: DELETE

Description: Delete the decryption policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies/{objectId}

Query Parameters

objectId - Unique identifier of the decryption policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET decryptionpolicyrules

Request Type: GET

Description: Get the decryption policy rule associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies/{containerUUID}/decryptionpolicyrules/{objectId}

Query Parameters

objectId - Unique identifier of the decryption policy rule.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL decryptionpolicyrules

Request Type: GETALL

Description: Get the list of all decryption policy rules.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies/{containerUUID}/decryptionpolicyrules

Query Parameters

filter - Filter by full text search over all rule attributes.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST decryptionpolicyrules

Request Type: POST

Description: Create a decryption policy rule. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies/{containerUUID}/decryptionpolicyrules

Query Parameters

bulk - Enables bulk creation of decryption policy rules.

insertAfter - Specifies that the rule will be inserted after the specified rule index. insertBefore takes precedence over insertAfter - if both are specified, the insertBefore parameter will apply.

insertBefore - Specifies that the rule will be inserted before the specified rule index. insertBefore takes precedence over insertAfter - if both are specified, the insertBefore parameter will apply.

category - Specifies the category into which the rule will be added. If a category is specified it must exist or the request will fail.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT decryptionpolicies

Request Type: PUT

Description: Modify the decryption policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies/{objectId}

Query Parameters

objectId - Unique identifier of the decryption policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE decryptionpolicyrules

Request Type: DELETE

Description: Delete the decryption policy rule associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies/{containerUUID}/decryptionpolicyrules/{objectId}

Query Parameters

objectId - Unique identifier of the decryption policy rule.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET decryptionpolicyrules

Request Type: GET

Description: Get the decryption policy rule associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies/{containerUUID}/decryptionpolicyrules/{objectId}

Query Parameters

objectId - Unique identifier of the decryption policy rule.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL decryptionpolicyrules

Request Type: GETALL

Description: Get the list of all decryption policy rules.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies/{containerUUID}/decryptionpolicyrules

Query Parameters

filter - Filter by full text search over all rule attributes.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST decryptionpolicyrules

Request Type: POST

Description: Create a decryption policy rule. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies/{containerUUID}/decryptionpolicyrules

Query Parameters

bulk - Enables bulk creation of decryption policy rules.

insertAfter - Specifies that the rule will be inserted after the specified rule index. insertBefore takes precedence over insertAfter - if both are specified, the insertBefore parameter will apply.

insertBefore - Specifies that the rule will be inserted before the specified rule index. insertBefore takes precedence over insertAfter - if both are specified, the insertBefore parameter will apply.

category - Specifies the category into which the rule will be added. If a category is specified it must exist or the request will fail.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT decryptionpolicyrules

Request Type: PUT

Description: Modifiy the decryption policy rule associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies/{containerUUID}/decryptionpolicyrules/{objectId}

Query Parameters

objectId - Unique identifier of the decryption policy rule.

insertAfter - Specifies that the rule will be inserted after the specified rule index. insertBefore takes precedence over insertAfter - if both are specified, the insertBefore parameter will apply.

insertBefore - Specifies that the rule will be inserted before the specified rule index. insertBefore takes precedence over insertAfter - if both are specified, the insertBefore parameter will apply.

category - Specifies the category into which the rule will be added. If a category is specified it must exist or the request will fail.

partialUpdate - This field specifies whether to change the entire object or only certain attributes of it. When its value is false the whole object will change, and if the value is true then only the attributes that are specified will change. The default value of this field is false.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET defaultactions

Request Type: GET

Description: Get the default action associated with the specified access control policy ID and default action ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/defaultactions/{objectId}

Query Parameters

objectId - Unique identifier of the default action.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL defaultactions

Request Type: GETALL

Description: Get the list of all default actions associated with the specified access control policy ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/defaultactions

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT defaultactions

Request Type: PUT

Description: Modify the default action associated with the specified access control policy ID and default action ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/defaultactions/{objectId}

Query Parameters

objectId - Unique identifier of the default action.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET dnspolicies

Request Type: GET

Description: Get the DNS policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/dnspolicies/{objectId}

Query Parameters

objectId - Unique identifier of the DNS policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL dnspolicies

Request Type: GETALL

Description: Get all DNS policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/dnspolicies

Query Parameters

filter - Filter criteria can be specified using the format <code>name:policy_name</code><br/><br/><code>policy_name</code> -- Name of the DNS Policy to be queried.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET dnssettings

Request Type: GET

Description: Get the DNS settings platform settings policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/dnssettings/{objectId}

Query Parameters

objectId - The identifier of the settings policy to which the DNS settings policy belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL dnssettings

Request Type: GETALL

Description: Get all DNS settings policies for a device.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/dnssettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT dnssettings

Request Type: PUT

Description: Modify the DNS settings platform settings policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/dnssettings/{objectId}

Query Parameters

objectId - The identifier of the settings policy to which the DNS settings policy belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE dynamicaccesspolicies

Request Type: DELETE

Description: Delete the dynamic access policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/dynamicaccesspolicies/{objectId}

Query Parameters

objectId - Unique identifier of the dynamic access policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET dynamicaccesspolicies

Request Type: GET

Description: Get the dynamic access policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/dynamicaccesspolicies/{objectId}

Query Parameters

objectId - Unique identifier of the dynamic access policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL dynamicaccesspolicies

Request Type: GETALL

Description: Get the list of all dynamic access policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/dynamicaccesspolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST dynamicaccesspolicies

Request Type: POST

Description: Create a dynamic access policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/dynamicaccesspolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT dynamicaccesspolicies

Request Type: PUT

Description: Modify the dynamic access policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/dynamicaccesspolicies/{objectId}

Query Parameters

objectId - Unique identifier of the dynamic access policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE endpoints

Request Type: DELETE

Description: Delete an endpoint associated with the specified ID in a Site to Site VPN topology. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/endpoints/{objectId}

Query Parameters

objectId - Unique identifier of the endpoint in a Site to Site VPN topology.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET endpoints

Request Type: GET

Description: Get an endpoint associated with the specified ID in a Site to Site VPN topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/endpoints/{objectId}

Query Parameters

objectId - Unique identifier of the endpoint in a Site to Site VPN topology.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL endpoints

Request Type: GETALL

Description: Get the list of all endpoints in a Site to Site VPN topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/endpoints

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

filter -

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST endpoints

Request Type: POST

Description: Create an endpoint in a Site to Site VPN topology. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/endpoints

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT endpoints

Request Type: PUT

Description: Modify an endpoint associated with the specified ID in a Site to Site VPN topology. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/endpoints/{objectId}

Query Parameters

objectId - Unique identifier of the endpoint in a Site to Site VPN topology.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE eventlists

Request Type: DELETE

Description: Delete the Syslog EventList settings policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/eventlists/{objectId}

Query Parameters

objectId - The identifier of the platform settings policy to which this Syslog EventList setting belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE ftdplatformsettingspolicies eventlists

Request Type: DELETE

Description: Delete all of the Syslog EventList Platform settings policies for a particular device. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/eventlists

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

filter - To be used in conjunction with <code>bulk=true</code> for bulk deletion. Value is of format (including quotes): <code>"ids:id1,id2,..."</code>.<br/><code>ids</code> is a comma-separated list of IDs to be deleted.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET eventlists

Request Type: GET

Description: Get the Syslog EventList settings policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/eventlists/{objectId}

Query Parameters

objectId - The identifier of the platform settings policy to which this Syslog EventList setting belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL eventlists

Request Type: GETALL

Description: Get all Syslog EventList settings policies for a particular device.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/eventlists

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST eventlists

Request Type: POST

Description: Create a Syslog EventList policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/eventlists

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT eventlists

Request Type: PUT

Description: Modify the Syslog EventList settings policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/eventlists/{objectId}

Query Parameters

objectId - The identifier of the platform settings policy to which this Syslog EventList setting belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE filepolicies

Request Type: DELETE

Description: Delete the file policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies/{objectId}

Query Parameters

objectId - Unique identifier of the file policy.

ticket-id - The ticket ID corresponding to which the configuration changes are done

domainUUID - Domain UUID

GET filepolicies

Request Type: GET

Description: Get the file policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies/{objectId}

Query Parameters

objectId - Unique identifier of the file policy.

ticket-id - The ticket ID corresponding to which the configuration changes are done

domainUUID - Domain UUID

GETALL filepolicies

Request Type: GETALL

Description: Get the list of all file policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST filepolicies

Request Type: POST

Description: Create a file policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies

Query Parameters

ticket-id - The ticket ID corresponding to which the configuration changes are done

domainUUID - Domain UUID

PUT filepolicies

Request Type: PUT

Description: Modify the file policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies/{objectId}

Query Parameters

objectId - Unique identifier of the file policy.

ticket-id - The ticket ID corresponding to which the configuration changes are done

domainUUID - Domain UUID

DELETE filerules

Request Type: DELETE

Description: Delete the file rule associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies/{containerUUID}/filerules/{objectId}

Query Parameters

objectId - Unique identifier of the file rule.

ticket-id - The ticket ID corresponding to which the configuration changes are done

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET filerules

Request Type: GET

Description: Get the file rule associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies/{containerUUID}/filerules/{objectId}

Query Parameters

objectId - Unique identifier of the file rule.

ticket-id - The ticket ID corresponding to which the configuration changes are done

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL filerules

Request Type: GETALL

Description: Get the list of all file rules.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies/{containerUUID}/filerules

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST filerules

Request Type: POST

Description: Modify all file rules. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies/{containerUUID}/filerules

Query Parameters

ticket-id - The ticket ID corresponding to which the configuration changes are done

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT filerules

Request Type: PUT

Description: Modify the file rule associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies/{containerUUID}/filerules/{objectId}

Query Parameters

objectId - Unique identifier of the file rule.

ticket-id - The ticket ID corresponding to which the configuration changes are done

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET flexconfigpolicies

Request Type: GET

Description: Get the FlexConfig Policy with the associated ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/flexconfigpolicies/{objectId}

Query Parameters

objectId - Unique identifier of the FlexConfig policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL flexconfigpolicies

Request Type: GETALL

Description: Get the list of all FlexConfig policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/flexconfigpolicies

Query Parameters

filter - Filter criteria can be specified using the format <code>name:policy_name</code><br/><br/><code>policy_name</code> -- Name of the FlexConfig Policy to be queried.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST flexconfigpolicies

Request Type: POST

Description: Create a FlexConfig policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/flexconfigpolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET FTD dnssettings

Request Type: GET

Description: Get the Threat Defense DNS-Settings Platform settings policy for the specified FTD platform.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/dnssettings/{objectId}

Query Parameters

objectId - The identifier of the container Threat Defense Platform Settings policy to which this DNS-Settings singleton policy belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL FTD dnssettings

Request Type: GETALL

Description: Get all DNS-Settings policies for a particular FTD .

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/dnssettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT FTD dnssettings

Request Type: PUT

Description: Modify the Threat Defense DNS-Settings Platform settings policy for the specified FTD platform. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/dnssettings/{objectId}

Query Parameters

objectId - The identifier of the container Threat Defense Platform Settings policy to which this DNS-Settings singleton policy belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE ftdnatpolicies

Request Type: DELETE

Description: Delete the NAT policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{objectId}

Query Parameters

objectId - Unique identifier of the NAT policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET ftdnatpolicies

Request Type: GET

Description: Get the NAT policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{objectId}

Query Parameters

objectId - Unique identifier of the NAT policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL ftdnatpolicies

Request Type: GETALL

Description: Get the list of all NAT policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ftdnatpolicies

Request Type: POST

Description: Create a NAT policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT ftdnatpolicies

Request Type: PUT

Description: Modify the NAT policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{objectId}

Query Parameters

objectId - Unique identifier of the NAT policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE ftdplatformsettingspolicies

Request Type: DELETE

Description: Delete the platform settings policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{objectId}

Query Parameters

objectId - Unique identiier of the platform settings policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET ftdplatformsettingspolicies

Request Type: GET

Description: Get the platform settings policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{objectId}

Query Parameters

objectId - Unique identiier of the platform settings policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL ftdplatformsettingspolicies

Request Type: GETALL

Description: Get the list of all FTD platform settings policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies

Query Parameters

filter - Filter criteria can be specified using the format <code>name:policy_name</code><br/><br/><code>policy_name</code> -- Name of the FTDPlatformSettings Policy to be queried.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ftdplatformsettingspolicies

Request Type: POST

Description: Create an FTD platform settings policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT ftdplatformsettingspolicies

Request Type: PUT

Description: Modify the platform settings policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{objectId}

Query Parameters

objectId - Unique identiier of the platform settings policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE ftds2svpns

Request Type: DELETE

Description: Delete the Firewall Threat Defense Site to Site VPN topology associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{objectId}

Query Parameters

objectId - Unique identifier for the Firewall Threat Defense Site to Site topology.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET ftds2svpns

Request Type: GET

Description: Get the Firewall Threat Defense Site to Site VPN topology associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{objectId}

Query Parameters

objectId - Unique identifier for the Firewall Threat Defense Site to Site topology.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL ftds2svpns

Request Type: GETALL

Description: Get the list of all Firewall Threat Defense Site to Site VPN topologies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

filter -

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ftds2svpns

Request Type: POST

Description: Create a Firewall Threat Defense Site to Site VPN topology. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT ftds2svpns

Request Type: PUT

Description: Modify the Firewall Threat Defense Site to Site VPN topology associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{objectId}

Query Parameters

objectId - Unique identifier for the Firewall Threat Defense Site to Site topology.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET FTD syslogsettings

Request Type: GET

Description: Get the FTD Syslog Settings policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/syslogsettings/{objectId}

Query Parameters

objectId - Unique identifier of the platform settings policy to which this Syslog Settings policy belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL FTD syslogsettings

Request Type: GETALL

Description: Get all FTD Syslog Settings policies for the platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/syslogsettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT FTD syslogsettings

Request Type: PUT

Description: Modify the FTD Syslog Settings policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/syslogsettings/{objectId}

Query Parameters

objectId - Unique identifier of the platform settings policy to which this Syslog Settings policy belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE healthpolicies

Request Type: DELETE

Description: Get the health policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/healthpolicies/{objectId}

Query Parameters

objectId - Unique identifier of the health policy.

domainUUID - Domain UUID

GET healthpolicies

Request Type: GET

Description: Get the health policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/healthpolicies/{objectId}

Query Parameters

objectId - Unique identifier of the health policy.

domainUUID - Domain UUID

GETALL healthpolicies

Request Type: GETALL

Description: Get a list of Health policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/healthpolicies

Query Parameters

filter - Filter criteria can be specified using the format <code>name:policy_name; policyType:{DevicePolicy|ManagementCenterPolicy}</code><br/> <br/><code>policy_name</code> -- Name of the Health policy to be queried.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST healthpolicies

Request Type: POST

Description: Create a health policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/healthpolicies

Query Parameters

domainUUID - Domain UUID

PUT healthpolicies

Request Type: PUT

Description: Get the health policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/healthpolicies/{objectId}

Query Parameters

objectId - Unique identifier of the health policy.

domainUUID - Domain UUID

DELETE hitcounts

Request Type: DELETE

Description: Clear the hit count values. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/operational/hitcounts

Query Parameters

filter - Value is of format (including quotes): <code>"deviceId:{uuid}; ids:{uuid1,uuid2,..}; fetchZeroHitCount:{true|false};name:{rule or policy name}; lastHit:{number of days as per unit}; lastHitUnit:{DAYS|WEEKS|MONTHS|YEARS}"</code><br/> <br/><code>deviceId</code> is UUID of device and is a mandatory field.<br/><code>ids</code> returns hitcounts of access rules if set to list of rule UUIDs. If this key is not used, all access rules will be returned.<br/><code>fetchZeroHitCount</code> returns only access rules whose hit count is zero if <code>true</code>. <br/><code>name</code> returns only access rule name or policy name matches<code>name</code>.<br/><code>lastHit</code> returns only access rules hit in last specified number of days as per <code>lastHitUnit</code> unit.<br/><code>lastHitUnit</code> unit of number of last hit days - DAYS, WEEKS, MONTHS or YEARS.<br/> <br/>(Note that <code>fetchZeroHitCount</code>,<code>name</code>,<code>lastHit</code>,<code>lastHitUnit</code> filters are applicable only in GET operation and if <code>ids</code> filter is not used)

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL hitcounts

Request Type: GETALL

Description: Get all hit count values.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/operational/hitcounts

Query Parameters

filter - Value is of format (including quotes): <code>"deviceId:{uuid}; ids:{uuid1,uuid2,..}; fetchZeroHitCount:{true|false};name:{rule or policy name}; lastHit:{number of days as per unit}; lastHitUnit:{DAYS|WEEKS|MONTHS|YEARS}"</code><br/> <br/><code>deviceId</code> is UUID of device and is a mandatory field.<br/><code>ids</code> returns hitcounts of access rules if set to list of rule UUIDs. If this key is not used, all access rules will be returned.<br/><code>fetchZeroHitCount</code> returns only access rules whose hit count is zero if <code>true</code>. <br/><code>name</code> returns only access rule name or policy name matches<code>name</code>.<br/><code>lastHit</code> returns only access rules hit in last specified number of days as per <code>lastHitUnit</code> unit.<br/><code>lastHitUnit</code> unit of number of last hit days - DAYS, WEEKS, MONTHS or YEARS.<br/> <br/>(Note that <code>fetchZeroHitCount</code>,<code>name</code>,<code>lastHit</code>,<code>lastHitUnit</code> filters are applicable only in GET operation and if <code>ids</code> filter is not used)

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT hitcounts

Request Type: PUT

Description: Refresh the hit count values. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/operational/hitcounts

Query Parameters

filter - Value is of format (including quotes): <code>"deviceId:{uuid}; ids:{uuid1,uuid2,..}; fetchZeroHitCount:{true|false};name:{rule or policy name}; lastHit:{number of days as per unit}; lastHitUnit:{DAYS|WEEKS|MONTHS|YEARS}"</code><br/> <br/><code>deviceId</code> is UUID of device and is a mandatory field.<br/><code>ids</code> returns hitcounts of access rules if set to list of rule UUIDs. If this key is not used, all access rules will be returned.<br/><code>fetchZeroHitCount</code> returns only access rules whose hit count is zero if <code>true</code>. <br/><code>name</code> returns only access rule name or policy name matches<code>name</code>.<br/><code>lastHit</code> returns only access rules hit in last specified number of days as per <code>lastHitUnit</code> unit.<br/><code>lastHitUnit</code> unit of number of last hit days - DAYS, WEEKS, MONTHS or YEARS.<br/> <br/>(Note that <code>fetchZeroHitCount</code>,<code>name</code>,<code>lastHit</code>,<code>lastHitUnit</code> filters are applicable only in GET operation and if <code>ids</code> filter is not used)

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET httpaccesssettings

Request Type: GET

Description: Get the Threat Defense HTTP access settings policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/httpaccesssettings/{objectId}

Query Parameters

objectId - Unique identifier of the Threat Defense Platform Settings Policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL httpaccesssettings

Request Type: GETALL

Description: Get all Threat Defense HTTP access settings.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/httpaccesssettings

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT httpaccesssettings

Request Type: PUT

Description: Modify the Threat Defense HTTP access settings policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/httpaccesssettings/{objectId}

Query Parameters

objectId - Unique identifier of the Threat Defense Platform Settings Policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET icmpsettings

Request Type: GET

Description: Get the ICMP access policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/icmpsettings/{objectId}

Query Parameters

objectId - The identifier of the settings policy to which the ICMP access policy belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL icmpsettings

Request Type: GETALL

Description: Get all ICMP access policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/icmpsettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT icmpsettings

Request Type: PUT

Description: Modify the ICMP access policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/icmpsettings/{objectId}

Query Parameters

objectId - The identifier of the settings policy to which the ICMP access policy belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET identitypolicies

Request Type: GET

Description: Get the identity policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/identitypolicies/{objectId}

Query Parameters

objectId - Unique identifier of an Identity Policy.

domainUUID - Domain UUID

GETALL identitypolicies

Request Type: GETALL

Description: Get the list of identity policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/identitypolicies

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET ikesettings

Request Type: GET

Description: Get the IKE setting associated with the specified ID inside a VPN Site to Site topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/ikesettings/{objectId}

Query Parameters

objectId - Identifier for an IKE setting in a Site to Site VPN topology.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL ikesettings

Request Type: GETALL

Description: Get IKE settings of a VPN Site to SIte topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/ikesettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT ikesettings

Request Type: PUT

Description: Modify the IKE settings associated with the specified ID inside a VPN Site to Site topology. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/ikesettings/{objectId}

Query Parameters

objectId - Identifier for an IKE setting in a Site to Site VPN topology.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET inheritancesettings

Request Type: GET

Description: Get the specified inheritance setting associated with the specified access policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/inheritancesettings/{objectId}

Query Parameters

objectId - Unique identifier of the access policy inheritance setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL inheritancesettings

Request Type: GETALL

Description: Get all inheritance settings associated with specified access policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/inheritancesettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT inheritancesettings

Request Type: PUT

Description: Modify the specified inheritance setting associated with the specified access policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/inheritancesettings/{objectId}

Query Parameters

objectId - Unique identifier of the access policy inheritance setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL inspectorconfigs

Request Type: GETALL

Description: Get the inspector configuration associated with the specified network analysis policy. The effective behaviour of the inspector configuration can be modified by modifying the inspector override configuration for the specified policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/networkanalysispolicies/{containerUUID}/inspectorconfigs

Query Parameters

inspectors - Comma-separated list of desired inspector names.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GETALL inspectoroverrideconfigs

Request Type: GETALL

Description: Get the inspector override configuration associated with the specified policy. An inspector override allows the user to modify behaviour specified in the base policy inspector configuration.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/networkanalysispolicies/{containerUUID}/inspectoroverrideconfigs

Query Parameters

inspectors - Comma-separated list of desired inspector names.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT inspectoroverrideconfigs

Request Type: PUT

Description: Modify the inspector override configuration associated with the specified policy. An inspector override allows the user to modify behaviour specified in the base policy inspector configuration. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/networkanalysispolicies/{containerUUID}/inspectoroverrideconfigs

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE intrusionpolicies

Request Type: DELETE

Description: Delete the intrusion policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/intrusionpolicies/{objectId}

Query Parameters

objectId - Identifier of the Snort3 intrusion policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET intrusionpolicies

Request Type: GET

Description: Get the intrusion policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/intrusionpolicies/{objectId}

Query Parameters

includeCount - Boolean value indicating whether to include the count of rules in the response.

ruleFilter - Return rule counts based on the filter. Value is of format <code>fts:browser</code>.

objectId - Identifier of the Snort3 intrusion policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL intrusionpolicies

Request Type: GETALL

Description: Get the list of all intrusion policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/intrusionpolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST intrusionpolicies

Request Type: POST

Description: Create an intrusion policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/intrusionpolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT intrusionpolicies

Request Type: PUT

Description: Modify the intrusion policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/intrusionpolicies/{objectId}

Query Parameters

objectId - Identifier of the Snort3 intrusion policy.

replicateInspectionMode - Flag to replicate inspection mode from Snort 3 version to Snort 2 version.

ruleRecommendationAction - This is a query parameter. Based on this value, the rule recommendation configuration is set against Snort3 Intrusion Policy.<br/>GENERATE - Generates the rule recommendation for the given recommendedSecurityLevel value and network objects per Snort3 Intrusion Policy.<br/> GENERATE_AND_ACCEPT - Generates the rule recommendation for the given recommendedSecurityLevel value and network objects per Snort3 Intrusion Policy and accepts it against the Snort3 Intrusion Policy. <br/> REFRESH - Refreshes the rule recommendation for already given recommendedSecurityLevel value and network objects per Snort3 Intrusion Policy. <br/> REMOVE - Removes all rule recommendations and ruleRecommendation config per Snort3 Intrusion Policy. <br/> ACCEPT - Accepts the rule recommendation for which rule recommendation is already generated for the given recommendedSecurityLevel value and network objects against the given Snort3 Intrusion Policy

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET intrusionrulegroups

Request Type: GET

Description: Get 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}

Query Parameters

objectId - Identifier of the Snort3 rule group.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL intrusionrulegroups

Request Type: GETALL

Description: Get the list of all Snort3 intrusion rule groups.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/intrusionpolicies/{containerUUID}/intrusionrulegroups

Query Parameters

includeCount - Boolean value indicating whether to include the count of rules in the response.

filter - Value can be any of the formats (including quotes): <code>"name:Browser/Firefox"</code> or <code>"currentSecurityLevel:DISABLED"</code> or <code>"showonlyparents:{true/false}"</code> or <code>"isSystemDefined:{true/false}"</code> or <code>"includeCount:true"</code>.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT intrusionrulegroups

Request Type: PUT

Description: Modify all the Snort3 intrusion rule groups. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/intrusionpolicies/{containerUUID}/intrusionrulegroups

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE intrusionrules

Request Type: DELETE

Description: Delete all Snort3 intrusion rules. Use filtering to specify which rules will be deleted. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/intrusionrules

Query Parameters

bulk - Boolean indicating whether this is a bulk operation. This parameter is required for bulk Snort 3 intrusion rule operations.

filter - Value can be any of the formats (including quotes): <code>"gid:123;sid:456"</code> or <code>"overrides:true;ipspolicy:{uuid1,uuid2,...}</code> or <code>"fts:789"</code> or <code>"isSystemDefined:{true/false}"</code>. <code>ipspolicy</code> is a comma-separated list of Snort 3 Intrusion Policy IDs.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET intrusionrules

Request Type: GET

Description: Get 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}

Query Parameters

objectId - Identifier of a Snort 3 intrusion rule.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL intrusionrules

Request Type: GETALL

Description: Get a list of all Snort 3 intrusion rules.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/intrusionpolicies/{containerUUID}/intrusionrules

Query Parameters

filter - Value can be any of the formats (including quotes): <code>"gid:123;sid:456"</code> or <code>"overrides:true;ipspolicy:{uuid1,uuid2,...}</code> or <code>"fts:789"</code> or <code>"isSystemDefined:{true/false}"</code>. <code>ipspolicy</code> is a comma-separated list of Snort 3 Intrusion Policy IDs.

sort - Sorting parameters to be provided e.g. sid,-sid,gid,-gid,msg,-msg.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST intrusionrules

Request Type: POST

Description: Create a Snort3 intrusion rule. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/object/intrusionrules

Query Parameters

bulk - Boolean indicating whether this is a bulk operation. This parameter is required for bulk Snort 3 intrusion rule operations.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT intrusionrules

Request Type: PUT

Description: Modifiy the per-policy behaviour of the specified intrusion rule ID for the target intrusion policy ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/intrusionpolicies/{containerUUID}/intrusionrules/{objectId}

Query Parameters

objectId - Identifier of a Snort 3 intrusion rule.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET ipsecadvancedsettings

Request Type: GET

Description: Get the IPSec advanced setting associated with the specified ID inside a remote access VPN topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/ipsecadvancedsettings/{objectId}

Query Parameters

objectId - Unique identifier of the IPSec advanced setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL ipsecadvancedsettings

Request Type: GETALL

Description: Get the list containing all IPSec advanced settings of the remote access VPN topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/ipsecadvancedsettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT ipsecadvancedsettings

Request Type: PUT

Description: Modify the IPSec advanced setting associated with the specified ID inside a remote access VPN topology. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/ipsecadvancedsettings/{objectId}

Query Parameters

objectId - Unique identifier of the IPSec advanced setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET ipseccryptomaps

Request Type: GET

Description: Get the IPSec Crypto Map Setting associated with the specified ID inside a remote access VPN Topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/ipseccryptomaps/{objectId}

Query Parameters

objectId - Unique identifier for the IPSec Crypto Map setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL ipseccryptomaps

Request Type: GETALL

Description: Get the list containing a single IPSEC Crypto Map Setting entry of the remote access VPN topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/ipseccryptomaps

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT ipseccryptomaps

Request Type: PUT

Description: Modify the IPSec Crypto Map Setting associated with the specified ID inside a remote access VPN Topology. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/ipseccryptomaps/{objectId}

Query Parameters

objectId - Unique identifier for the IPSec Crypto Map setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET ipsecsettings

Request Type: GET

Description: Get the IPSec Proposal setting associated with the specified ID inside a VPN Site to Site topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/ipsecsettings/{objectId}

Query Parameters

objectId - Identifier for an IPSec Proposal setting in a Site to Site VPN topology.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL ipsecsettings

Request Type: GETALL

Description: Get IPSec Proposal settings of a VPN Site to Site topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/ipsecsettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT ipsecsettings

Request Type: PUT

Description: Modify the IPSec Proposal settings associated with the specified ID inside a VPN Site to Site topology. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/ipsecsettings/{objectId}

Query Parameters

objectId - Identifier for an IPSec Proposal setting in a Site to Site VPN topology.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET ldapattributemaps

Request Type: GET

Description: Get the LDAP attribute map associated with the specified ID inside a remote access VPN Topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/ldapattributemaps/{objectId}

Query Parameters

objectId - Unique identifier for the LDAP attribute map.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL ldapattributemaps

Request Type: GETALL

Description: Get the list containing all LDAP attribute maps inside a remote access VPN topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/ldapattributemaps

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT ldapattributemaps

Request Type: PUT

Description: Modify the LDAP attribute map associated with the specified ID inside a remote access VPN Topology. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/ldapattributemaps/{objectId}

Query Parameters

objectId - Unique identifier for the LDAP attribute map.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET loadbalancesettings

Request Type: GET

Description: Get the load balance setting associated with the specified ID inside a remote access VPN topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/loadbalancesettings/{objectId}

Query Parameters

objectId - Unique identifier of the load balance setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL loadbalancesettings

Request Type: GETALL

Description: Get load balance settings inside the remote access VPN topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/loadbalancesettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT loadbalancesettings

Request Type: PUT

Description: Modify the load balance setting associated with the specified ID inside a remote access VPN topology. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/loadbalancesettings/{objectId}

Query Parameters

objectId - Unique identifier of the load balance setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE loggingdestinations

Request Type: DELETE

Description: Delete all of the Syslog EventList Platform settings policies for a particular device. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/loggingdestinations

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

filter - To be used in conjunction with <code>bulk=true</code> for bulk deletion. Value is of format (including quotes): <code>"ids:id1,id2,..."</code>.<br/><code>ids</code> is a comma-separated list of IDs to be deleted.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET loggingdestinations

Request Type: GET

Description: Get the Syslog logging destination settings policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/loggingdestinations/{objectId}

Query Parameters

objectId - The identifier of the settings policy to which the Syslog policy belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL loggingdestinations

Request Type: GETALL

Description: Get all Syslog EventList settings policies for a particular device.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/loggingdestinations

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST loggingdestinations

Request Type: POST

Description: Create a Syslog EventList policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/loggingdestinations

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT loggingdestinations

Request Type: PUT

Description: Modify all of the Syslog EventList Platform settings policies for a particular device. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/loggingdestinations

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET loggingemailsetups

Request Type: GET

Description: Get the Syslog Email setup policy setting with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/loggingemailsetups/{objectId}

Query Parameters

objectId - The identifier of the settings policy to which the Syslog Email setup policy belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL loggingemailsetups

Request Type: GETALL

Description: Get the Syslog Email setup policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/loggingemailsetups

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT loggingemailsetups

Request Type: PUT

Description: Modify the Syslog Email setup policy setting with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/loggingemailsetups/{objectId}

Query Parameters

objectId - The identifier of the settings policy to which the Syslog Email setup policy belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET loggingsettings

Request Type: GET

Description: Get the logging setting associated with the specified access control policy ID and logging setting ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/loggingsettings/{objectId}

Query Parameters

objectId - Unique identifier of the logging setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL loggingsettings

Request Type: GETALL

Description: Get list of all logging settings associated with the specified access control policy ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/loggingsettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT loggingsettings

Request Type: PUT

Description: Modify the logging setting associated with the specified access control policy ID and logging setting ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/loggingsettings/{objectId}

Query Parameters

objectId - Unique identifier of the logging setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE manualnatrules

Request Type: DELETE

Description: Delete all manual NAT rules. Use filtering to specify which rules will be deleted. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/manualnatrules

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

filter - Value is of format : <code>"ids:id1,id2,...; sourceInterface:name1,name2,...;destinationInterface:name1,name2,...; <br/>originalSource:name1/value1,name2/value2,...; originalDestination:name1/value1,name2/value2,...; <br/>translatedSource:name1/value1,name2/value2,...; translatedDestination:name1/value1,name2/value2,...; <br/>originalSourcePort:name1/value1,name2/value2,...; originalDestinationPort:name1/value1,name2/value2,...; <br/>translatedSourcePort:name1/value1,name2/value2,...;translatedDestinationPort:name1/value1,name2/value2,...; "</code><br/><br/>ids:id1,id2,...etc. This ids is a comma-separated list of rule ids to fetch/delete</br>sourceInterface:SecurityZone/Interface group name (sec_zone_name1) can be given as value to fetch/delete NAT rule<br/> destinationInterface:SecurityZone/Interface group name (sec_zone_name1) can be given as value to fetch/delete NAT rule<br/> originalSource: Network object configured as Original source object name (object_name) or the value (10.1.2.3) of the object can be given<br/> originalDestination:Network object configured as Destination source object name (object_name) or the value (10.1.2.3) of the object can be given<br/>translatedSource:Network object configured as translated source object name (object_name) or the value (10.1.2.3) of the object can be given<br/>translatedDestination:Network object configured as translated Destination object name (object_name) or the value (10.1.2.3) of the object can be given<br/> originalSourcePort:Port object configured as Original Source Port object name (http) or value of the object as port no or protocol (tcp/80) can be given<br/>originalDestinationPort:Port object configured as Original Destination Port object name (http) or value of the object as port no or protocol (tcp/80) can be given<br/>translatedSourcePort:Port object configured as Translated Source Port object name (http) or value of the object as port no or protocol (tcp/80) can be given<br/>translatedDestinationPort:Port object configured as Translated Destination Port object name (http) or value of the object as port no or protocol (tcp/80) can be given"<br/>

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET manualnatrules

Request Type: GET

Description: Get the manual NAT rule associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/manualnatrules/{objectId}

Query Parameters

objectId - Unique identifier of the manual NAT rule.

section - Section from which to get the manual NAT rule. Can be set to before_auto and after_auto.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL manualnatrules

Request Type: GETALL

Description: Get the list of all manual NAT rules.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/manualnatrules

Query Parameters

filter - Value is of format : <code>"ids:id1,id2,...; sourceInterface:name1,name2,...;destinationInterface:name1,name2,...; <br/>originalSource:name1/value1,name2/value2,...; originalDestination:name1/value1,name2/value2,...; <br/>translatedSource:name1/value1,name2/value2,...; translatedDestination:name1/value1,name2/value2,...; <br/>originalSourcePort:name1/value1,name2/value2,...; originalDestinationPort:name1/value1,name2/value2,...; <br/>translatedSourcePort:name1/value1,name2/value2,...;translatedDestinationPort:name1/value1,name2/value2,...; "</code><br/><br/>ids:id1,id2,...etc. This ids is a comma-separated list of rule ids to fetch/delete</br>sourceInterface:SecurityZone/Interface group name (sec_zone_name1) can be given as value to fetch/delete NAT rule<br/> destinationInterface:SecurityZone/Interface group name (sec_zone_name1) can be given as value to fetch/delete NAT rule<br/> originalSource: Network object configured as Original source object name (object_name) or the value (10.1.2.3) of the object can be given<br/> originalDestination:Network object configured as Destination source object name (object_name) or the value (10.1.2.3) of the object can be given<br/>translatedSource:Network object configured as translated source object name (object_name) or the value (10.1.2.3) of the object can be given<br/>translatedDestination:Network object configured as translated Destination object name (object_name) or the value (10.1.2.3) of the object can be given<br/> originalSourcePort:Port object configured as Original Source Port object name (http) or value of the object as port no or protocol (tcp/80) can be given<br/>originalDestinationPort:Port object configured as Original Destination Port object name (http) or value of the object as port no or protocol (tcp/80) can be given<br/>translatedSourcePort:Port object configured as Translated Source Port object name (http) or value of the object as port no or protocol (tcp/80) can be given<br/>translatedDestinationPort:Port object configured as Translated Destination Port object name (http) or value of the object as port no or protocol (tcp/80) can be given"<br/>

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST manualnatrules

Request Type: POST

Description: Create a manual NAT rule. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/manualnatrules

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

section - Section in which to create the manual NAT rule. Can be set to before_auto and after_auto.

targetIndex - Creates manual NAT rule at given targetIndex. It takes an integer value.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT manualnatrules

Request Type: PUT

Description: Modify multiple manual NAT rules. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/manualnatrules

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

partialUpdate - Boolean indicating whether to change the entire object or only certain attributes of it. The default value is FALSE.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

POST migrate

Request Type: POST

Description: Initiate a FlexConfig migration for the specified devices. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/flexconfigpolicies/{containerUUID}/migrate

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET natexemptrules

Request Type: GET

Description: Get the VPN Nat Exempt rules generated by the Site To Site VPN Topology for a device.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/natexemptrules/{deviceId}

Query Parameters

deviceId - Unique identifier for the device.

domainUUID - Domain UUID

DELETE natrules

Request Type: DELETE

Description: Delete all NAT rules, both auto and manual. Use filtering to specify which rules will be deleted. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/natrules

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

filter - Value is of format : <code>"ids:id1,id2,...; sourceInterface:name1,name2,...;destinationInterface:name1,name2,...; <br/>originalSource:name1/value1,name2/value2,...; originalDestination:name1/value1,name2/value2,...; <br/>translatedSource:name1/value1,name2/value2,...; translatedDestination:name1/value1,name2/value2,...; <br/>originalSourcePort:name1/value1,name2/value2,...;originalDestinationPort:name1/value1,name2/value2,...; <br/>translatedSourcePort:name1/value1,name2/value2,...; translatedDestinationPort:name1/value1,name2/value2,...; "</code><br/><br/>ids:id1,id2,...etc. This ids is a comma-separated list of rule ids to fetch/delete</br>sourceInterface:SecurityZone/Interface group name (sec_zone_name1) can be given as value to fetch/delete NAT rule<br/>destinationInterface:SecurityZone/Interface group name (sec_zone_name1) can be given as value to fetch/delete NAT rule<br/>originalSource: Network object configured as Original source object name (object_name) or the value (10.1.2.3) of the object can be given<br/>originalDestination:Network object configured as Destination source object name (object_name) or the value (10.1.2.3) of the object can be given<br/>translatedSource:Network object configured as translated source object name (object_name) or the value (10.1.2.3) of the object can be given<br/>translatedDestination:Network object configured as translated Destination object name (object_name) or the value (10.1.2.3) of the object can be given<br/>originalSourcePort:Port object configured as Original Source Port object name (http) or value of the object as port no or protocol (tcp/80) can be given<br/>originalDestinationPort:Port object configured as Original Destination Port object name (http) or value of the object as port no or protocol (tcp/80) can be given<br/>translatedSourcePort:Port object configured as Translated Source Port object name (http) or value of the object as port no or protocol (tcp/80) can be given<br/>translatedDestinationPort:Port object configured as Translated Destination Port object name (http) or value of the object as port no or protocol (tcp/80) can be given"<br/>

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET natrules

Request Type: GET

Description: Get the NAT rule associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/natrules/{objectId}

Query Parameters

objectId - Unique identifier of the NAT rule.

section - Retrieves NAT rule in given section. Allowed value is before_auto, auto and after_auto.

filter - Value is of format : <code>"ids:id1,id2,...;sourceInterface:name1,name2,...;destinationInterface:name1,name2,...; <br/>originalSource:name1/value1,name2/value2,...; originalDestination:name1/value1,name2/value2,...; <br/>translatedSource:name1/value1,name2/value2,...; translatedDestination:name1/value1,name2/value2,...;<br/>originalSourcePort:name1/value1,name2/value2,...; originalDestinationPort:name1/value1,name2/value2,...;<br/>translatedSourcePort:name1/value1,name2/value2,...; translatedDestinationPort:name1/value1,name2/value2,...;"</code><br/><br/>ids:id1,id2,...etc. This ids is a comma-separated list of rule ids to fetch/delete</br>sourceInterface:SecurityZone/Interface group name (sec_zone_name1) can be given as value to fetch/delete NAT rule<br/>destinationInterface:SecurityZone/Interface group name (sec_zone_name1) can be given as value to fetch/delete NAT rule<br/>originalSource: Network object configured as Original source object name (object_name) or the value (10.1.2.3) of the object can be given<br/>originalDestination:Network object configured as Destination source object name (object_name) or the value (10.1.2.3) of the object can be given<br/>translatedSource:Network object configured as translated source object name (object_name) or the value (10.1.2.3) of the object can be given<br/>translatedDestination:Network object configured as translated Destination object name (object_name) or the value (10.1.2.3) of the object can be given<br/>originalSourcePort:Port object configured as Original Source Port object name (http) or value of the object as port no or protocol (tcp/80) can be given<br/>originalDestinationPort:Port object configured as Original Destination Port object name (http) or value of the object as port no or protocol (tcp/80) can be given<br/>translatedSourcePort:Port object configured as Translated Source Port object name (http) or value of the object as port no or protocol (tcp/80) can be given<br/>translatedDestinationPort:Port object configured as Translated Destination Port object name (http) or value of the object as port no or protocol (tcp/80) can be given"<br/>

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL natrules

Request Type: GETALL

Description: Get the list of all NAT rules, both auto and manual.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/natrules

Query Parameters

filter - Value is of format : <code>"ids:id1,id2,...; sourceInterface:name1,name2,...;destinationInterface:name1,name2,...; <br/>originalSource:name1/value1,name2/value2,...; originalDestination:name1/value1,name2/value2,...; <br/>translatedSource:name1/value1,name2/value2,...; translatedDestination:name1/value1,name2/value2,...; <br/>originalSourcePort:name1/value1,name2/value2,...;originalDestinationPort:name1/value1,name2/value2,...; <br/>translatedSourcePort:name1/value1,name2/value2,...; translatedDestinationPort:name1/value1,name2/value2,...; "</code><br/><br/>ids:id1,id2,...etc. This ids is a comma-separated list of rule ids to fetch/delete</br>sourceInterface:SecurityZone/Interface group name (sec_zone_name1) can be given as value to fetch/delete NAT rule<br/>destinationInterface:SecurityZone/Interface group name (sec_zone_name1) can be given as value to fetch/delete NAT rule<br/>originalSource: Network object configured as Original source object name (object_name) or the value (10.1.2.3) of the object can be given<br/>originalDestination:Network object configured as Destination source object name (object_name) or the value (10.1.2.3) of the object can be given<br/>translatedSource:Network object configured as translated source object name (object_name) or the value (10.1.2.3) of the object can be given<br/>translatedDestination:Network object configured as translated Destination object name (object_name) or the value (10.1.2.3) of the object can be given<br/>originalSourcePort:Port object configured as Original Source Port object name (http) or value of the object as port no or protocol (tcp/80) can be given<br/>originalDestinationPort:Port object configured as Original Destination Port object name (http) or value of the object as port no or protocol (tcp/80) can be given<br/>translatedSourcePort:Port object configured as Translated Source Port object name (http) or value of the object as port no or protocol (tcp/80) can be given<br/>translatedDestinationPort:Port object configured as Translated Destination Port object name (http) or value of the object as port no or protocol (tcp/80) can be given"<br/>

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET netflowpolicies

Request Type: GET

Description: Get the NetFlow policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/netflowpolicies/{objectId}

Query Parameters

objectId - The identifier of the settings policy to which the NetFlow policy belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL netflowpolicies

Request Type: GETALL

Description: Get the list of all NetFlow policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/netflowpolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT netflowpolicies

Request Type: PUT

Description: Modify the NetFlow policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/netflowpolicies/{objectId}

Query Parameters

objectId - The identifier of the settings policy to which the NetFlow policy belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE networkanalysispolicies

Request Type: DELETE

Description: Delete the network analysis policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/networkanalysispolicies/{objectId}

Query Parameters

objectId - Unique identifier of the network analysis policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET networkanalysispolicies

Request Type: GET

Description: Get the network analysis policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/networkanalysispolicies/{objectId}

Query Parameters

objectId - Unique identifier of the network analysis policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL networkanalysispolicies

Request Type: GETALL

Description: Get list of all network analysis policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/networkanalysispolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST networkanalysispolicies

Request Type: POST

Description: Create a network analysis policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/networkanalysispolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT networkanalysispolicies

Request Type: PUT

Description: Modify the network analysis policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/networkanalysispolicies/{objectId}

Query Parameters

objectId - Unique identifier of the network analysis policy.

replicateInspectionMode - Flag to replicate inspection mode from Snort 3 version to Snort 2 version.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET ntpsettings

Request Type: GET

Description: Get the NTP setting associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/ntpsettings/{objectId}

Query Parameters

objectId - The identifier of the settings policy to which the NTP setting belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL ntpsettings

Request Type: GETALL

Description: Get the list of all NTP settings.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/ntpsettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT ntpsettings

Request Type: PUT

Description: Modify the NTP setting associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/ntpsettings/{objectId}

Query Parameters

objectId - The identifier of the settings policy to which the NTP setting belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL policylocks

Request Type: GETALL

Description: Get the shallow lock details of the Policy. Currently only supports Access policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/operational/policylocks

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST policylocks

Request Type: POST

Description: Update the lock status for the policy specified in the payload. This overwrites the current lock value with the value specified in the payload. This currently only supports Access policies. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/operational/policylocks

Query Parameters

domainUUID - Domain UUID

GET prefilter defaultactions

Request Type: GET

Description: Get the default action associated with the specified prefilter control policy ID and default action ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{containerUUID}/defaultactions/{objectId}

Query Parameters

objectId - Unique identifier of the default action.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL prefilter defaultactions

Request Type: GETALL

Description: Get the list of all default actions associated with the specified prefilter policy ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{containerUUID}/defaultactions

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT prefilter defaultactions

Request Type: PUT

Description: Modify the default action associated with the specified prefilter control policy ID and default action ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{containerUUID}/defaultactions/{objectId}

Query Parameters

objectId - Unique identifier of the default action.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE prefilter hitcounts

Request Type: DELETE

Description: Clear prefilter hit counts. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{containerUUID}/operational/hitcounts

Query Parameters

filter - Value is of format (including quotes): <code>"deviceId:{uuid};ids:{uuid1,uuid2,..}; fetchZeroHitCount:{true|false}; name:{rule or policy name}; lastHit:{number of days as per unit}; lastHitUnit:{DAYS|WEEKS|MONTHS|YEARS}"</code><br/> <br/><code>deviceId</code> is UUID of device and is a mandatory field.<br/><code>ids</code> returns hitcounts of access rules if set to list of rule UUIDs. If this key is not used, all access rules will be returned.<br/><code>fetchZeroHitCount</code> returns only access rules whose hit count is zero if <code>true</code>.<br/> <code>name</code> returns only access rule name or policy name matches<code>name</code>. <br/><code>lastHit</code> returns only access rules hit in last specified number of days as per <code>lastHitUnit</code> unit.<br/> <code>lastHitUnit</code> unit of number of last hit days - DAYS, WEEKS, MONTHS or YEARS.<br/> <br/>(Note that <code>fetchZeroHitCount</code>,<code>name</code>,<code>lastHit</code>,<code>lastHitUnit</code> filters are applicable only in GET operation and if <code>ids</code> filter is not used)

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL prefilter hitcounts

Request Type: GETALL

Description: Get the prefilter hit count.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{containerUUID}/operational/hitcounts

Query Parameters

filter - Value is of format (including quotes): <code>"deviceId:{uuid};ids:{uuid1,uuid2,..}; fetchZeroHitCount:{true|false}; name:{rule or policy name}; lastHit:{number of days as per unit}; lastHitUnit:{DAYS|WEEKS|MONTHS|YEARS}"</code><br/> <br/><code>deviceId</code> is UUID of device and is a mandatory field.<br/><code>ids</code> returns hitcounts of access rules if set to list of rule UUIDs. If this key is not used, all access rules will be returned.<br/><code>fetchZeroHitCount</code> returns only access rules whose hit count is zero if <code>true</code>.<br/> <code>name</code> returns only access rule name or policy name matches<code>name</code>. <br/><code>lastHit</code> returns only access rules hit in last specified number of days as per <code>lastHitUnit</code> unit.<br/> <code>lastHitUnit</code> unit of number of last hit days - DAYS, WEEKS, MONTHS or YEARS.<br/> <br/>(Note that <code>fetchZeroHitCount</code>,<code>name</code>,<code>lastHit</code>,<code>lastHitUnit</code> filters are applicable only in GET operation and if <code>ids</code> filter is not used)

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT prefilter hitcounts

Request Type: PUT

Description: Refresh the prefilter hit count. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{containerUUID}/operational/hitcounts

Query Parameters

filter - Value is of format (including quotes): <code>"deviceId:{uuid};ids:{uuid1,uuid2,..}; fetchZeroHitCount:{true|false}; name:{rule or policy name}; lastHit:{number of days as per unit}; lastHitUnit:{DAYS|WEEKS|MONTHS|YEARS}"</code><br/> <br/><code>deviceId</code> is UUID of device and is a mandatory field.<br/><code>ids</code> returns hitcounts of access rules if set to list of rule UUIDs. If this key is not used, all access rules will be returned.<br/><code>fetchZeroHitCount</code> returns only access rules whose hit count is zero if <code>true</code>.<br/> <code>name</code> returns only access rule name or policy name matches<code>name</code>. <br/><code>lastHit</code> returns only access rules hit in last specified number of days as per <code>lastHitUnit</code> unit.<br/> <code>lastHitUnit</code> unit of number of last hit days - DAYS, WEEKS, MONTHS or YEARS.<br/> <br/>(Note that <code>fetchZeroHitCount</code>,<code>name</code>,<code>lastHit</code>,<code>lastHitUnit</code> filters are applicable only in GET operation and if <code>ids</code> filter is not used)

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE prefilterpolicies

Request Type: DELETE

Description: Delete the prefilter policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{objectId}

Query Parameters

objectId - Unique identifier of the prefilter policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET prefilterpolicies

Request Type: GET

Description: Get the prefilter policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{objectId}

Query Parameters

objectId - Unique identifier of the prefilter policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL prefilterpolicies

Request Type: GETALL

Description: Get the list of all prefilter policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST prefilterpolicies

Request Type: POST

Description: Create a prefilter policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT prefilterpolicies

Request Type: PUT

Description: Modify the prefilter policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{objectId}

Query Parameters

objectId - Unique identifier of the prefilter policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

DELETE policy_prefilterrules

Request Type: DELETE

Description: Delete prefilter rules. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{containerUUID}/prefilterrules

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

filter - To be used in conjunction with <code>bulk=true</code> for bulk deletion. Value is of format (including quotes): <code>"ids:id1,id2,..."</code>.<br/><code>ids</code> is a comma-separated list of rule IDs to be deleted.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET prefilterrules

Request Type: GET

Description: Get the prefilter rule associated with the specified policy ID and rule ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{containerUUID}/prefilterrules/{objectId}

Query Parameters

objectId - Unique identifier of the prefilter rule.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL prefilterrules

Request Type: GETALL

Description: Get the list of all prefilter rules.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{containerUUID}/prefilterrules

Query Parameters

ruleType - Only show the policies with the specified <code>ruleType</code>. Allowed values are PREFILTER and TUNNEL.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST prefilterrules

Request Type: POST

Description: Create a prefilter rule. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{containerUUID}/prefilterrules

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

insertAfter - Specifies that the rules will be inserted after the specified rule index. insertBefore takes precedence over insertAfter - if both are specified, the insertBefore parameter will apply.

insertBefore - Specifies that the rules will be inserted before the specified rule index. insertBefore takes precedence over insertAfter - if both are specified, the insertBefore parameter will apply.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT prefilterrules

Request Type: PUT

Description: Modify the prefilter rules. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/prefilterpolicies/{containerUUID}/prefilterrules

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE ratelimits

Request Type: DELETE

Description: Delete all Syslog Rate limit settings for the threat defense policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/ratelimits

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

filter - To be used in conjunction with <code>bulk=true</code> for bulk deletion. Value is of format (including quotes): <code>"ids:id1,id2,..."</code>.<br/><code>ids</code> is a comma-separated list of IDs to be deleted.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET ratelimits

Request Type: GET

Description: Get the Syslog Rate limit platform settings policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/ratelimits/{objectId}

Query Parameters

objectId - The identifier of the platform settings policy to which this Syslog Rate limit platform settings policy belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL ratelimits

Request Type: GETALL

Description: Get all Syslog Rate limit settings for the threat defense policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/ratelimits

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ratelimits

Request Type: POST

Description: Create a Syslog Rate limit policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/ratelimits

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT ratelimits

Request Type: PUT

Description: Modify all Syslog Rate limit settings for the threat defense policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/ratelimits

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE ravpns

Request Type: DELETE

Description: Delete the Firewall Threat Defense RA VPN topology associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{objectId}

Query Parameters

objectId - Identifier for Firewall Threat Defense RA VPN topology.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET ravpns

Request Type: GET

Description: Get the Firewall Threat Defense RA VPN topology associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{objectId}

Query Parameters

objectId - Identifier for Firewall Threat Defense RA VPN topology.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL ravpns

Request Type: GETALL

Description: Get the list of all Firewall Threat Defense remote access VPN topologies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST ravpns

Request Type: POST

Description: Create a Firewall Threat Defense RA VPN topologies. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT ravpns

Request Type: PUT

Description: Modify all Firewall Threat Defense remote access VPN topologies. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{objectId}

Query Parameters

objectId - Identifier for Firewall Threat Defense RA VPN topology.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL s2svpnsummaries

Request Type: GETALL

Description: Get 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

Query Parameters

filter - The filter criteria for which the details have to be fetched. The following filters are supported - device:{deviceId};name:{Topology name};routeBased:{true|false};includeSubDomains:{true|false}. User can enter one or many filters.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET secureclientcustomizationsettings

Request Type: GET

Description: Get the secure client customization setting associated with the specified ID inside a remote access VPN topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/secureclientcustomizationsettings/{objectId}

Query Parameters

objectId - Unique identifier of the secure client customization setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL secureclientcustomizationsettings

Request Type: GETALL

Description: Get secure client customization settings inside the remote access VPN topology.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/secureclientcustomizationsettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT secureclientcustomizationsettings

Request Type: PUT

Description: Modify the secure client customization setting associated with the specified ID inside a remote access VPN topology. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/secureclientcustomizationsettings/{objectId}

Query Parameters

objectId - Unique identifier of the secure client customization setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET securityintelligencepolicies

Request Type: GET

Description: Get the security intelligence policy associated with the specified access policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/securityintelligencepolicies/{objectId}

Query Parameters

objectId - Unique identifier of the security intelligence policy associated with an access policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL securityintelligencepolicies

Request Type: GETALL

Description: Get all security intelligence policies associated with the specified access policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/securityintelligencepolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET servers

Request Type: GET

Description: Get the Syslog Server policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/servers/{objectId}

Query Parameters

objectId - Unique identifier of the platform settings policy to which this Syslog Server policy belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL servers

Request Type: GETALL

Description: Get all Syslog Server policies for the platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/servers

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT servers

Request Type: PUT

Description: Modify the Syslog Server policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/servers/{objectId}

Query Parameters

objectId - Unique identifier of the platform settings policy to which this Syslog Server policy belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET snmpalerts

Request Type: GET

Description: Get the SNMP alert associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/snmpalerts/{objectId}

Query Parameters

objectId - Unique identifier of an SNMP alert.

domainUUID - Domain UUID

GETALL snmpalerts

Request Type: GETALL

Description: Get the list of all SNMP alerts.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/snmpalerts

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET snmpsettings

Request Type: GET

Description: Get the SNMP platform settings policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/snmpsettings/{objectId}

Query Parameters

objectId - The identifier of the settings policy to which the SNMP setting belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL snmpsettings

Request Type: GETALL

Description: Get the list of all SNMP settings policies for a particular chassis.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/snmpsettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT snmpsettings

Request Type: PUT

Description: Modify the SNMP platform settings policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/snmpsettings/{objectId}

Query Parameters

objectId - The identifier of the settings policy to which the SNMP setting belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE sshaccesssettings

Request Type: DELETE

Description: Delete all SSH access settings policies for a particular device. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/sshaccesssettings

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

filter - To be used in conjunction with <code>bulk=true</code> for bulk deletion. Value is of format (including quotes): <code>"ids:id1,id2,..."</code>.<br/><code>ids</code> is a comma-separated list of IDs to be deleted.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET sshaccesssettings

Request Type: GET

Description: Get the SSH access settings policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/sshaccesssettings/{objectId}

Query Parameters

objectId - The identifier of the platform settings policy to which this SSH access policy belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL sshaccesssettings

Request Type: GETALL

Description: Get all SSH access settings policies for a particular device.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/sshaccesssettings

Query Parameters

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST sshaccesssettings

Request Type: POST

Description: Create a SSH access settings policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/sshaccesssettings

Query Parameters

bulk - This parameter specifies that bulk post operation is being used in the query. This parameter is required for bulk save operations.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT sshaccesssettings

Request Type: PUT

Description: Modify all SSH access settings policies for a particular device. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/sshaccesssettings

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET sshclientsettings

Request Type: GET

Description: Get the SSH client setting associated with the specified ID for a particular chassis platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshclientsettings/{objectId}

Query Parameters

objectId - Unique identifier of the SSH client setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL sshclientsettings

Request Type: GETALL

Description: Get all SSH client settings for a particular chassis platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshclientsettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT sshclientsettings

Request Type: PUT

Description: Modify the SSH client setting associated with the specified ID for a particular chassis platform settings policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshclientsettings/{objectId}

Query Parameters

objectId - Unique identifier of the SSH client setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET sshserversettings

Request Type: GET

Description: Get the SSH server setting associated with the specified ID for a particular chassis platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshserversettings/{objectId}

Query Parameters

objectId - Unique identifier of the SSH server setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL sshserversettings

Request Type: GETALL

Description: Get all SSH server settings for a particular chassis platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshserversettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT sshserversettings

Request Type: PUT

Description: Modify the SSH server setting associated with the specified ID for a particular chassis platform settings policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshserversettings/{objectId}

Query Parameters

objectId - Unique identifier of the SSH server setting.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET syslogalerts

Request Type: GET

Description: Get the syslog alert associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/syslogalerts/{objectId}

Query Parameters

objectId - Unique identifier of an syslog alert.

domainUUID - Domain UUID

GETALL syslogalerts

Request Type: GETALL

Description: Get the list of all syslog alerts.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/syslogalerts

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE syslogids

Request Type: DELETE

Description: Delete all Syslog Logging ID settings policies. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/syslogsettings/{syslogSettingsUUID}/syslogids

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

filter - To be used in conjunction with <code>bulk=true</code> for bulk deletion. Value is of format (including quotes): <code>"ids:id1,id2,..."</code>.<br/><code>ids</code> is a comma-separated list of IDs to be deleted.

syslogSettingsUUID - The syslogSettingsUUID under which this specific resource is contained.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET syslogids

Request Type: GET

Description: Get all Syslog Logging ID settings for the device.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/ {containerUUID}/syslog/syslogsettings/{syslogSettingsUUID}/syslogids/{syslogId}

Query Parameters

syslogId - Comma-separated list of syslog setting IDs for filtering.

syslogSettingsUUID - The syslogSettingsUUID under which this specific recourse is contained.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL syslogids

Request Type: GETALL

Description: Get all Syslog Logging Id settings policies for a particular FTD .

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/ {containerUUID}/syslog/syslogsettings/{syslogSettingsUUID}/syslogids

Query Parameters

syslogSettingsUUID - The syslogSettingsUUID under which this specific resource is contained.

syslogId - Value is of format <code>id1,id2,id3...</code>.<br/><code>syslogIds</code> is a comma-separated list of IDs to be filtered.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST syslogids

Request Type: POST

Description: Create a Syslog Logging ID settings policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/ {containerUUID}/syslog/syslogsettings/{syslogSettingsUUID}/syslogids

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

syslogSettingsUUID - The syslogSettingsUUID under which this specific recourse is contained.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT syslogids

Request Type: PUT

Description: Modify all Syslog Logging ID settings on the device. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/ {containerUUID}/syslog/syslogsettings/{syslogSettingsUUID}/syslogids

Query Parameters

bulk - Boolean indicating whether this is a bulk operation.

syslogSettingsUUID - The syslogSettingsUUID under which this specific recourse is contained.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET syslogsettings

Request Type: GET

Description: Get the syslog settings policy associated with the specified ID for a particular chassis platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/syslogsettings/{objectId}

Query Parameters

objectId - Unique identifier of the syslog settings policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL syslogsettings

Request Type: GETALL

Description: Get all syslog settings policies for a particular chassis platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/syslogsettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT syslogsettings

Request Type: PUT

Description: Modify the syslog settings policy associated with the specified ID for a particular chassis platform settings policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/syslogsettings/{objectId}

Query Parameters

objectId - Unique identifier of the syslog settings policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET timesynchronizationsettings

Request Type: GET

Description: Get the time synchronization settings policy associated with the specified ID for a particular chassis platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timesynchronizationsettings/{objectId}

Query Parameters

objectId - Unique identifier of the time synchronization settings policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL timesynchronizationsettings

Request Type: GETALL

Description: Get all time synchronization settings policies for a particular chassis platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timesynchronizationsettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT timesynchronizationsettings

Request Type: PUT

Description: Modify the time synchronization settings policy associated with the specified ID for a particular chassis platform settings policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timesynchronizationsettings/{objectId}

Query Parameters

objectId - Unique identifier of the time synchronization settings policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET timezonesettings

Request Type: GET

Description: Get the time zone settings policy associated with the specified ID for a particular chassis platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timezonesettings/{objectId}

Query Parameters

objectId - Unique identifier of the time zone settings policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL timezonesettings

Request Type: GETALL

Description: Get all time zone settings policies for a particular chassis platform settings policy.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timezonesettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT timezonesettings

Request Type: PUT

Description: Modify the time zone settings policy associated with the specified ID for a particular chassis platform settings policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timezonesettings/{objectId}

Query Parameters

objectId - Unique identifier of the time zone settings policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET trusteddnssettings

Request Type: GET

Description: Get the trusted DNS Server policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/trusteddnssettings/{objectId}

Query Parameters

objectId - Unique identifier of the platform settings policy to which this trusted DNS server policy belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL trusteddnssettings

Request Type: GETALL

Description: Get all trusted DNS Servers policies on the device.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/trusteddnssettings

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT trusteddnssettings

Request Type: PUT

Description: Modify the trusted DNS Server policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/trusteddnssettings/{objectId}

Query Parameters

objectId - Unique identifier of the platform settings policy to which this trusted DNS server policy belongs.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE umbrelladnspolicies

Request Type: DELETE

Description: Delete the umbrella DNS policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/umbrelladnspolicies/{objectId}

Query Parameters

objectId - Unique identifier of the umbrella DNS policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET umbrelladnspolicies

Request Type: GET

Description: Get the umbrella DNS policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/umbrelladnspolicies/{objectId}

Query Parameters

objectId - Unique identifier of the umbrella DNS policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL umbrelladnspolicies

Request Type: GETALL

Description: Get the list of all umbrella DNS policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/umbrelladnspolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST umbrelladnspolicies

Request Type: POST

Description: Create an umbrella DNS policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/umbrelladnspolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT umbrelladnspolicies

Request Type: PUT

Description: Modify the umbrella DNS policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/umbrelladnspolicies/{objectId}

Query Parameters

objectId - Unique identifier of the umbrella DNS policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET umbrelladnsrules

Request Type: GET

Description: Get the umbrella DNS rule associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/umbrelladnspolicies/{containerUUID}/umbrelladnsrules/{objectId}

Query Parameters

objectId - Unique identifier of the umbrella rule.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL umbrelladnsrules

Request Type: GETALL

Description: Get the list of all umbrella DNS rules.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/umbrelladnspolicies/{containerUUID}/umbrelladnsrules

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

PUT umbrelladnsrules

Request Type: PUT

Description: Modify the umbrella DNS rule associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/umbrelladnspolicies/{containerUUID}/umbrelladnsrules/{objectId}

Query Parameters

objectId - Unique identifier of the umbrella rule.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL vpntunnelstatuses

Request Type: GETALL

Description: Get the list of all VPN tunnel statuses.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/vpntunnelstatuses

Query Parameters

filter - Criteria for filtering. Supported options are - deviceId:{deviceId};vpnTopologyId:{topologyId};deployedStatus:{deployedStatus};status:{status}.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

DELETE zero trust applications

Request Type: DELETE

Description: Delete all the Zero Trust Applications. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{containerUUID}/applications

Query Parameters

bulk - Required parameter, should be always set to <code>true</code>

filter - To filter policies.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GET zero trust applications

Request Type: GET

Description: Get the Zero Trust application associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{containerUUID}/applications/{objectId}

Query Parameters

objectId - Unique identifier of the Zero Trust application.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

GETALL zero trust applications

Request Type: GETALL

Description: Get all Zero Trust Applications.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{containerUUID}/applications

Query Parameters

filter - To filter policies.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST zero trust applications

Request Type: POST

Description: Create Zero Trust Applications. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{containerUUID}/applications

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

PUT zero trust applications

Request Type: PUT

Description: Modify the Zero Trust application associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{containerUUID}/applications/{objectId}

Query Parameters

objectId - Unique identifier of the Zero Trust application.

ticket-id - UUID of the ticket for tracking the configuration changes.

containerUUID - The container id under which this specific resource is contained.

domainUUID - Domain UUID

DELETE zerotrustpolicies

Request Type: DELETE

Description: Delete the Zero Trust policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{objectId}

Query Parameters

objectId - Unique identifier of the Zero Trust policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GET zerotrustpolicies

Request Type: GET

Description: Get the Zero Trust policy associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{objectId}

Query Parameters

objectId - Unique identifier of the Zero Trust policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

GETALL zerotrustpolicies

Request Type: GETALL

Description: Get list of all Zero Trust policies.

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies

Query Parameters

filter - To filter policies.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST zerotrustpolicies

Request Type: POST

Description: Create a Zero Trust policy. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies

Query Parameters

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

PUT zerotrustpolicies

Request Type: PUT

Description: Modify the Zero Trust policy associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/policy/zerotrustpolicies/{objectId}

Query Parameters

objectId - Unique identifier of the Zero Trust policy.

ticket-id - UUID of the ticket for tracking the configuration changes.

domainUUID - Domain UUID

Policy Assignment Services

GET policyassignments

Request Type: GET

Description: Get the policy assignment associated with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/assignment/policyassignments/{objectId}

Query Parameters

objectId - Unique identifier of the policy assignment.

domainUUID - Domain UUID

GETALL policyassignments

Request Type: GETALL

Description: Get the list of all policy assignments to target devices.

URL: /api/fmc_config/v1/domain/{domainUUID}/assignment/policyassignments

Query Parameters

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST policyassignments

Request Type: POST

Description: Create a policy assignment. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/assignment/policyassignments

Query Parameters

domainUUID - Domain UUID

PUT policyassignments

Request Type: PUT

Description: Modify the policy assignment associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_config/v1/domain/{domainUUID}/assignment/policyassignments/{objectId}

Query Parameters

objectId - Unique identifier of the policy assignment.

domainUUID - Domain UUID

Status Services

GET taskstatuses

Request Type: GET

Description: Get information about a previously submitted pending job or task with the specified ID.

URL: /api/fmc_config/v1/domain/{domainUUID}/job/taskstatuses/{objectId}

Query Parameters

objectId - UUID of the job or task.

showDetailedDeviceStatus - Boolean indicating whether to show the detailed status for the device for type : DEVICE_DEPLOYMENT and DEVICE_ROLLBACK

domainUUID - Domain UUID

GETALL taskstatuses

Request Type: GETALL

Description: Get information about pending jobs or tasks.

URL: /api/fmc_config/v1/domain/{domainUUID}/job/taskstatuses

Query Parameters

filter - Filter criteria can be specified using the format <code>type:{type};status:{status};</code>. <br/><br/><code>type</code> -- Type of task to be returned. It is mandatory field. Allowed values are <code>"{Deployment | Registration | Unregistration | PendingChangesRequest}"</code>. <br/><br/><code>status</code> -- Filter based on the status of the task. It is mandatory field.<br/><br/>&emsp;Allowed values for <code>Deployment</code> task are <code>"{Deploying | Cancelled | Failed | Succeeded}"</code>.<br/><br/>&emsp;Allowed values for <code>Registration</code> task are <code>"{Pending | Running | Success | Failed}"</code>.<br/><br/>&emsp;Allowed values for <code>Unregistration</code> task are <code>"{Running | Success | Failed}"</code>.<br/>&emsp;Allowed values for <code>PendingChangesRequest</code> task are <code>"{Running | Success | Failed}"</code>.

domainUUID - Domain UUID

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

System Information

GET domain

Request Type: GET

Description: Get version information for the specified domain.

URL: /api/fmc_platform/v1/info/domain/{domainUUID}/{objectId}

Query Parameters

objectId - Unique identifier of the domain.

domainUUID - Domain UUID

GETALL domain

Request Type: GETALL

Description: Get a list of all domains.

URL: /api/fmc_platform/v1/info/domain

Query Parameters

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

GET serverversion

Request Type: GET

Description: Get version information for the specified server.

URL: /api/fmc_platform/v1/info/serverversion/{objectId}

Query Parameters

objectId - Unique identifier of the server.

GETALL serverversion

Request Type: GETALL

Description: Get a list of all servers.

URL: /api/fmc_platform/v1/info/serverversion

Query Parameters

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

Update Packages

GETALL applicabledevices

Request Type: GETALL

Description: Get the list of devices available for the specified upgrade package.

URL: /api/fmc_platform/v1/updates/upgradepackages/{containerUUID}/applicabledevices

Query Parameters

containerUUID - The container id under which this specific resource is contained.

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST cancelupgrades

Request Type: POST

Description: Cancel a failed upgrade. _Check the response section for applicable examples (if any)._

URL: /api/fmc_platform/v1/updates/cancelupgrades

Query Parameters

POST retryupgrades

Request Type: POST

Description: Retry a failed upgrade. _Check the response section for applicable examples (if any)._

URL: /api/fmc_platform/v1/updates/retryupgrades

Query Parameters

POST revertupgrades

Request Type: POST

Description: Trigger reversion of an upgrade. _Check the response section for applicable examples (if any)._

URL: /api/fmc_platform/v1/updates/revertupgrades

Query Parameters

DELETE upgradepackages

Request Type: DELETE

Description: Delete the upgrade package associated with the specified ID. _Check the response section for applicable examples (if any)._

URL: /api/fmc_platform/v1/updates/upgradepackages/{objectId}

Query Parameters

objectId - Unique identifier of the upgrade package.

GET upgradepackages

Request Type: GET

Description: Get the upgrade package associated with the specified ID.

URL: /api/fmc_platform/v1/updates/upgradepackages/{objectId}

Query Parameters

objectId - Unique identifier of the object.

GETALL upgradepackages

Request Type: GETALL

Description: Get the list of all upgrade packages.

URL: /api/fmc_platform/v1/updates/upgradepackages

Query Parameters

offset - Index of first item to return.

limit - Number of items to return.

expanded - If set to true, the GET response displays a list of objects with additional attributes.

POST upgrades

Request Type: POST

Description: Create a task to trigger a Threat Defense upgrade/readiness check on a list of devices or push an upgrade file to a list of devices. _Check the response section for applicable examples (if any)._

URL: /api/fmc_platform/v1/updates/upgrades

Query Parameters

toggleToSnort3 - Boolean for Snort version. When TRUE the device is set to Snort3, when FALSE the device is set to Snort2