About the Firewall Management Center REST API

With the release of Firewall Management Center REST API, you now have light-weight, easy-to-use option for managing devices through the cloud-delivered Firewall Firewall Management Center.

The REST API is enabled by default in the cloud-delivered managemenr center.

After installing a REST client, you can contact the specific Firewall Management Center's REST agent and use standard HTTP methods to access current configuration information, and issue additional configuration parameters.

What's New

In these What's New tables, spaces have been added to the URLs to aid in readability. When using the URLs, remove the spaces.

What's New in 2025

March 12, 2025

Table 1. Changes to Methods and Endpoints: June 19, 2025

Name

Methods

URL

Devices

Certificates GET ALL /api/fmc_config/v1/domain/{domainUUID} /devices/certificates
Certificates Export Data GET /api/fmc_config/v1/domain/{domainUUID} /devices/certificatesexportdata /{objectId}
Manage Certificates POST /api/fmc_config/v1/domain/{domainUUID} /devices/operational/managecertificates

Policy

Security Intelligence Policies PUT /api/fmc_config/v1/domain/{domainUUID} /policy/accesspolicies/{containerUUID} /securityintelligencepolicies/{objectId}

Templates

VPN Settings GET ALL /api/fmc_config/v1/domain/{domainUUID} /templates/devicetemplates/{containerUUID} /vpnsettings

GET ALL is now being treated as a separate method from GET. A GET ALL request is a GET request without an object id, and will return all objects of the requested type.

Table 2. Changes to Methods and Endpoints: March 5, 2025

Name

Methods

URL

Devices

Out of Band Changes GET ALL, POST /api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID} /operational/outofbandchanges
OSPFv2 Routes POST, PUT, DELETE /api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID} /routing/ospfv2routes
OSPFv3 Interfaces POST, PUT, DELETE /api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID} /routing/ospfv3interfaces
OSPFv3 Routes POST, PUT, DELETE /api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID} /routing/ospfv3routes
OSPF Virtual Interface POST, PUT, DELETE /api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID}/routing /virtualrouters/{virtualrouterUUID}/ospfinterface
OSPFv2 Virtual Routes POST, PUT, DELETE /api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID}/routing /virtualrouters/{virtualrouterUUID}/ospfv2routes

Health

Aggregate Metrics GET ALL /api/fmc_config/v1/domain/{domainUUID} /health/aggregatemetrics

Integration

AI Configuration GET ALL, POST /api/fmc_config/v1/domain/{domainUUID} /integration/aiops/configure
TSDB Upload POST /api/fmc_config/v1/domain/{domainUUID} /integration/aiops/tsdbupload
TSDB Upload Status GET ALL /api/fmc_config/v1/domain/{domainUUID} /integration/aiops/tsdbupload/status
Cloud Integrations GET ALL /api/fmc_config/v1/domain/{domainUUID} /integration/cloudintegrations/cloudintegrations

Object

Certificate Enrollment Overrides GET ALL /api/fmc_config/v1/domain/{domainUUID} /object/certenrollments/{containerUUID}/overrides
Service Access Objects GET ALL, GET, POST, PUT, DELETE /api/fmc_config/v1/domain/{domainUUID} /object/serviceaccessobjects
Service Access Object Overries GET ALL /api/fmc_config/v1/domain/{domainUUID} /object/serviceaccessobjects/{containerUUID} /overrides

Policy

Banner Settings GET ALL, GET, PUT /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /bannersettings
Basic Logging Settings GET ALL, GET, PUT /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /syslog/basicloggingsetups
FTD DNS Settings GET ALL, GET, PUT /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /dnssettings
Event Lists GET ALL, GET, PUT, POST, DELETE /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /syslog/eventlists
ICMP Settings GET ALL, GET, PUT /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /icmpsetting
Logging Destinations GET ALL, GET, PUT, POST, DELETE /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /syslog/loggingdestinations
Logging Email Setups GET ALL, GET, PUT /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /syslog/loggingemailsetups
NTP Settings GET ALL, GET, PUT /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /ntpsettings
Rate Limits GET ALL, GET, POST, PUT, DELETE /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /syslog/ratelimits
SSH Access Settings GET, GET ALL, PUT, POST, DELETE /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /sshaccesssettings
Syslog Servers GET ALL, GET, PUT /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /syslog/servers
Syslog Settings GET ALL, GET, PUT /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /syslog/syslogsettings
Syslog IDs GET ALL, GET, POST, DELETE /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /syslog/syslogsettings /{syslogSettingsUUID}/syslogids
Trusted DNS Settings GET ALL, GET, PUT /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /trusteddnssettings

Troubleshoot

RADKit Services GET ALL, GET, POST /api/fmc_troubleshoot/v1/domain/{domainUUID} /radkit/services

What's New in 2024

August 23, 2024

Maximum number of GET requests increased from 120.

Table 3. Changes to Methods and Endpoints: August 23, 2024

Name

Methods

URL

Analysis

Identified Users

DELETE, GET /api/fmc_config/v1/domain/ {domainUUID}/analysis/identifiedusers

Backup

All

All endpoints removed

Chassis

Switch Mode Readiness Check

POST

/api/fmc_config/v1/domain/ {domainUUID}/chassis/fmcmanagedchassis/ operational/switchmodereadinesscheck

Devices

Bulk Registrations

POST

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

Download Sample CSV

GET

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

LTP Device Records

DELETE, GET, GET by ID

/api/fmc_config/v1/domain/ {domainUUID}/devices/ ltpdevicerecords/{objectId}

Health

Events

GET

/api/fmc_config/v1/domain/ {domainUUID}/health/events

All

Added table of available Health modules

Object

Download Realms

POST

/api/fmc_config/v1/domain/ {domainUUID}/object/realms/ operational/download

MAC Address Pools

DELETE, GET, GET by ID POST, PUT

/api/fmc_config/v1/domain/{domainUUID}/ object/ macaddresspools

Network Address Overrides

GET, GET by ID

/api/fmc_config/v1/domain/ {domainUUID}/object/ networkaddressoverrides

Realm Statuses

GET

/api/fmc_config/v1/domain/ {domainUUID}/object/ operational/realmstatuses

SAML Realm USers and Groups

GET

/api/fmc_config/v1/domain/ {domainUUID}/object/ samlrealmusersandgroups

Test Realms

POST

/api/fmc_config/v1/domain/ {domainUUID}/object/ operational/testrealms

Variables

DELETE, GET, GET by ID POST, PUT

/api/fmc_config/v1/domain/ {domainUUID}/object/variables

Policy

Health Policies

DELETE, POST, PUT

/api/fmc_config/v1/domain/ {domainUUID}/policy/ healthpolicies

Templates

Apply

POST

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

DELETE, GET

/api/fmc_config/v1/domain/ {domainUUID}/templates/ devicetemplates/{containerUUID}/ associations
Default Model Mappings

GET, GET by ID

/api/fmc_config/v1/domain/ {domainUUID}/templates/ devicetemplates/{containerUUID}/ defaultmodelmappings/{modelName}
Device Templates

DELETE, GET, GET by ID, POST, PUT

/api/fmc_config/v1/domain/ {domainUUID}/templates/ devicetemplates
Model Mappings

DELETE, GET, GET by ID, POST, PUT

/api/fmc_config/v1/domain/ {domainUUID}/templates/ devicetemplates/{containerUUID}/ modelmappings
Object Overrides

GET by ID, PUT

/api/fmc_config/v1/domain/ {domainUUID}/templates/ devicetemplates/{containerUUID}/ objectoverrides/{containerUUID}/{object_UUID}
Supported Device Models

GET

/api/fmc_config/v1/domain/ {domainUUID}/templates/ supporteddevicemodels
Template Interfaces

DELETE, GET, GET by ID, POST

/api/fmc_config/v1/domain/ {domainUUID}/templates/ devicetemplates/{containerUUID}/ templateinterfaces
VPN Settings

DELETE, GET, GET by ID, POST

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

Troubleshoot

Modules

GET, GET by ID, POST

/api/fmc_troubleshoot/v1/domain/ {domainUUID}/cpuprofiler/ {containerUUID}/modules
Rules

GET, GET by ID, POST

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

What's New in 2023

October 19, 2023

Table 4. New Methods and Endpoints: October 19, 2023

Name

Methods

URL

Chassis

Switchmode

POST

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

Deployment

Pending Changes Requests

POST

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

Devices

Virtual Access Interfaces

GET

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

Policy

Access List Settings

GET, PUT

/api/fmc_config/v1/domain/{domainUUID} /policy/chassisplatformsettingspolicies /{containerUUID}/accesslistsettings /{object_UUID}

VPN Tunnel Statuses

GET

/api/fmc_config/v1/domain/{domainUUID} /policy/vpntunnelstatuses

Status

Download Reports

GET

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

System Configuration

Change Management Configurations

GET, PUT

/api/fmc_platform/v1/systemconfiguration /changemanagementconfigs
Table 5. New Methods and Endpoints: October 19, 2023

Name

Methods

URL

Analysis (NEW)

Active Sessions

GET, DELETE

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

Logout

POST

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

User Activity

GET, DELETE

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

Audit

Configuration Changes

GET

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

Chassis

App Information

GET

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

Chassis Interface Events

GET, PUT, POST, DELETE

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

Etherchannel Interfaces

GET, PUT, POST, DELETE

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

Fault Summary

GET

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

Instance Summary

GET

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

Interfaces

GET

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

Interface Summary

GET

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

Inventory Summary

GET

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

Logical Devices

GET, PUT, POST, DELETE

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

SNMP Settings

GET, PUT

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

Subinterfaces

GET, PUT, POST, DELETE

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

Devices

DDNS Settings

GET, PUT

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

DHCP Relay Settings

GET, PUT

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

DHCP Server

GET, PUT

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

Management Convergence Mode

GET, PUT

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

Model Migrations

POST

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

Virtual BiDirectional Forwarding Policies

GET, PUT, POST, DELETE

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

Health

Tunnel Details

GET

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

Integration

CD FMC Snapshot

GET, POST

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

Refresh SecureX Configurations

POST

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

Object

Azure AD Realms

GET, PUT, POST, DELETE

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

Azure AD Statuses

GET

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

Cipher Suite Lists

GET, POST

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

Custom SI IP List Download

GET

/api/fmc_config/v1/domain/{domainUUID} /object/customsiiplistdownload/{objectId}

Custom SI IP Lists

GET, PUT, POST, DELETE

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

Custom SI URL Lists Download

GET

/api/fmc_config/v1/domain/{domainUUID} /object/customsiurllistdownload/{objectId}

Custom SI URL Lists

GET, PUT, POST, DELETE

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

Distinguished Name Groups

GET /api/fmc_config/v1/domain/{domainUUID} /object/distinguishednamegroups

Distinguished Names

GET, POST

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

Download Azure Ad Realms

POST

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

External CA Certificate Groups

GET

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

External CA Certificates

GET, POST

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

External Certificate Groups

GET

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

External Certificates

GET, POST

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

File Categories

GET

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

File Types

GET

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

Internal Certificate Groups

GET

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

NTP Servers

GET, PUT, POST, DELETE

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

Overlaps

POST

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

Resource Profiles

GET, PUT, POST, DELETE

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

Secure Client Customizations

GET, PUT, POST, DELETE

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

SI Network Feeds

PUT, POST, DELETE

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

SI URL Feeds

PUT, POST, DELETE

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

Test Azure AD Realms

POST

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

Users and Groups

GET

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

VLAN Group Tags

DELETE

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

Policy

Application Groups

GET, PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/ztnapolicies/{containerUUID}/applicationgroups

Applications

GET, PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/ztnapolicies/{containerUUID}/applications

Chassis Platform Settings Policies

GET, PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/chassisplatformsettingspolicies

Decryption Policies

GET, PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/decryptionpolicies

Decryption Policy Rules

GET, PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/decryptionpolicies/{containerUUID} /decryptionpolicyrules/{

File Policies

PUT, POST,DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/filepolicies

File Rules

GET, PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/filepolicies/{containerUUID}/filerules

FTD Platform Settings Policies

PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies

HTTP Access Settings

GET, PUT

/api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /httpaccesssettings/{

NAT Exempt Rules

GET

/api/fmc_config/v1/domain/{domainUUID} /policy/natexemptrules/{deviceId}

Netflow Policies

GET, PUT

/api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /netflowpolicies/{

Secure Client Customization Settings

GET, PUT

/api/fmc_config/v1/domain/{domainUUID} /policy/ravpns/{containerUUID} /secureclientcustomizationsettings

SSH Client Settings

GET, PUT

/api/fmc_config/v1/domain/{domainUUID} /policy/chassisplatformsettingspolicies/{containerUUID} /sshclientsettings

SSH Server Settings

GET, PUT

/api/fmc_config/v1/domain/{domainUUID} /policy/chassisplatformsettingspolicies/{containerUUID} /sshserversettings

SNMP Settings

GET, PUT

/api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID}/snmpsettings

Syslog Settings

GET, PUT

/api/fmc_config/v1/domain/{domainUUID} /policy/chassisplatformsettingspolicies/{containerUUID}/syslogsettings/{

Zero Trust Applications

GET, PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/zerotrustpolicies/{containerUUID}/applications

Zero Trust Application Groups

GET, PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/zerotrustpolicies

Zero Trust Policies

GET, PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/zerotrustpolicies/{containerUUID}/applicationgroups

ZTNA Policies

GET, PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/ztnapolicies

System Configuration

Remote Management Access

GET, PUT

api/fmc_platform/v1/systemconfiguration /remotemanagementaccess

Troubleshoot

Device

POST

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

Users

Users

GET

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

What's New in 2022

December 13, 2022

Table 6. New Methods and Endpoints: December 13, 2022

Name

Methods

URL

Backup (NEW)

Device Backup

POST

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

Download Backup

GET, GET by ID

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

Backup Files

GET, GET by ID, DELETE

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

Chassis

Chassis Physical Interface

GET, GET by ID, PUT

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

Devices

Device Records

PUT

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

Bidirectional Forwarding Policies

GET, GET by ID, PUT, POST, DELETE

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

Loopback Interfaces

GET, GET by ID, PUT, POST, DELETE

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

Device Clusters

Cluster Health Monitor Settings

GET by ID, PUT

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

Health

Remote Access VPN Gateways

GET, GET by ID

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

Terminate VPN Sessions

POST

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

Cisco Secure Dynamic Attributes Connector

GET, POST

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

Integration

Tunnel Deployments

GET, POST

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

Tunnel Transcripts

GET by ID

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

Test Umbrella Connections

POST

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

Umbrella Connections

GET, GET by ID, PUT, POST

/api/fmc_config/v1/domain/{domainUUID}/integration/ umbrellaconnections

Data Centers

GET

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

Object

AnyConnect Custom Attributes

PUT, POST, DELETE

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

Bidirectional Forwarding Templates

GET, GET by ID, PUT, POST, DELETE

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

DHCP IPv6 Pools

GET, GET by ID, PUT, POST, DELETE

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

Download Internal CA

POST

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

Internal Certificate Authorities

GET, GET by ID, PUT, POST, DELETE

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

Internal Certificates

GET, GET by ID, PUT, POST, DELETE

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

Security Group Tags

PUT, POST, DELETE

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

SI URL Lists

PUT, POST, DELETE

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

Validate Certificate File

POST

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

Policy

FlexConfig Policies

GET, GET by ID, POST

/api/fmc_config/v1/domain/{domainUUID}/policy/ flexconfigpolicies

FTD Platform Settings

GET, GET by ID

/api/fmc_config/v1/domain/{domainUUID}/policy/ ftdplatformsettingspolicies

Load Balance Settings

GET, GET by ID, PUT

/api/fmc_config/v1/domain/{domainUUID}/policy/ ravpns/{containerUUID}/loadbalancesettings

Enabling the REST API

The Firewall Management Center REST API is enabled by default.

Procedure


Step 1

Choose System (system gear icon) > Configuration > REST API Preferences.

Step 2

Check Enable REST API.

Step 3

Click Save.


Best Practices

Cisco recommends the following best practices for optimal results with the REST API:

  • Keep UI users and API users separate when possible. Especially do not use an admin account as an API user unless specifically necessary.

  • Do not give API users more privilege than needed.

  • Always validate the content coming from the server.

  • Validate/sanitize JSON content, as it may include embedded executable code.

What's New

In these What's New tables, spaces have been added to the URLs to aid in readability. When using the URLs, remove the spaces.

What's New in 2025

March 12, 2025

Table 7. Changes to Methods and Endpoints: June 19, 2025

Name

Methods

URL

Devices

Certificates GET ALL /api/fmc_config/v1/domain/{domainUUID} /devices/certificates
Certificates Export Data GET /api/fmc_config/v1/domain/{domainUUID} /devices/certificatesexportdata /{objectId}
Manage Certificates POST /api/fmc_config/v1/domain/{domainUUID} /devices/operational/managecertificates

Policy

Security Intelligence Policies PUT /api/fmc_config/v1/domain/{domainUUID} /policy/accesspolicies/{containerUUID} /securityintelligencepolicies/{objectId}

Templates

VPN Settings GET ALL /api/fmc_config/v1/domain/{domainUUID} /templates/devicetemplates/{containerUUID} /vpnsettings

GET ALL is now being treated as a separate method from GET. A GET ALL request is a GET request without an object id, and will return all objects of the requested type.

Table 8. Changes to Methods and Endpoints: March 5, 2025

Name

Methods

URL

Devices

Out of Band Changes GET ALL, POST /api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID} /operational/outofbandchanges
OSPFv2 Routes POST, PUT, DELETE /api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID} /routing/ospfv2routes
OSPFv3 Interfaces POST, PUT, DELETE /api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID} /routing/ospfv3interfaces
OSPFv3 Routes POST, PUT, DELETE /api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID} /routing/ospfv3routes
OSPF Virtual Interface POST, PUT, DELETE /api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID}/routing /virtualrouters/{virtualrouterUUID}/ospfinterface
OSPFv2 Virtual Routes POST, PUT, DELETE /api/fmc_config/v1/domain/{domainUUID} /devices/devicerecords/{containerUUID}/routing /virtualrouters/{virtualrouterUUID}/ospfv2routes

Health

Aggregate Metrics GET ALL /api/fmc_config/v1/domain/{domainUUID} /health/aggregatemetrics

Integration

AI Configuration GET ALL, POST /api/fmc_config/v1/domain/{domainUUID} /integration/aiops/configure
TSDB Upload POST /api/fmc_config/v1/domain/{domainUUID} /integration/aiops/tsdbupload
TSDB Upload Status GET ALL /api/fmc_config/v1/domain/{domainUUID} /integration/aiops/tsdbupload/status
Cloud Integrations GET ALL /api/fmc_config/v1/domain/{domainUUID} /integration/cloudintegrations/cloudintegrations

Object

Certificate Enrollment Overrides GET ALL /api/fmc_config/v1/domain/{domainUUID} /object/certenrollments/{containerUUID}/overrides
Service Access Objects GET ALL, GET, POST, PUT, DELETE /api/fmc_config/v1/domain/{domainUUID} /object/serviceaccessobjects
Service Access Object Overries GET ALL /api/fmc_config/v1/domain/{domainUUID} /object/serviceaccessobjects/{containerUUID} /overrides

Policy

Banner Settings GET ALL, GET, PUT /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /bannersettings
Basic Logging Settings GET ALL, GET, PUT /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /syslog/basicloggingsetups
FTD DNS Settings GET ALL, GET, PUT /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /dnssettings
Event Lists GET ALL, GET, PUT, POST, DELETE /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /syslog/eventlists
ICMP Settings GET ALL, GET, PUT /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /icmpsetting
Logging Destinations GET ALL, GET, PUT, POST, DELETE /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /syslog/loggingdestinations
Logging Email Setups GET ALL, GET, PUT /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /syslog/loggingemailsetups
NTP Settings GET ALL, GET, PUT /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /ntpsettings
Rate Limits GET ALL, GET, POST, PUT, DELETE /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /syslog/ratelimits
SSH Access Settings GET, GET ALL, PUT, POST, DELETE /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /sshaccesssettings
Syslog Servers GET ALL, GET, PUT /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /syslog/servers
Syslog Settings GET ALL, GET, PUT /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /syslog/syslogsettings
Syslog IDs GET ALL, GET, POST, DELETE /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /syslog/syslogsettings /{syslogSettingsUUID}/syslogids
Trusted DNS Settings GET ALL, GET, PUT /api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /trusteddnssettings

Troubleshoot

RADKit Services GET ALL, GET, POST /api/fmc_troubleshoot/v1/domain/{domainUUID} /radkit/services

What's New in 2024

August 23, 2024

Maximum number of GET requests increased from 120.

Table 9. Changes to Methods and Endpoints: August 23, 2024

Name

Methods

URL

Analysis

Identified Users

DELETE, GET /api/fmc_config/v1/domain/ {domainUUID}/analysis/identifiedusers

Backup

All

All endpoints removed

Chassis

Switch Mode Readiness Check

POST

/api/fmc_config/v1/domain/ {domainUUID}/chassis/fmcmanagedchassis/ operational/switchmodereadinesscheck

Devices

Bulk Registrations

POST

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

Download Sample CSV

GET

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

LTP Device Records

DELETE, GET, GET by ID

/api/fmc_config/v1/domain/ {domainUUID}/devices/ ltpdevicerecords/{objectId}

Health

Events

GET

/api/fmc_config/v1/domain/ {domainUUID}/health/events

All

Added table of available Health modules

Object

Download Realms

POST

/api/fmc_config/v1/domain/ {domainUUID}/object/realms/ operational/download

MAC Address Pools

DELETE, GET, GET by ID POST, PUT

/api/fmc_config/v1/domain/{domainUUID}/ object/ macaddresspools

Network Address Overrides

GET, GET by ID

/api/fmc_config/v1/domain/ {domainUUID}/object/ networkaddressoverrides

Realm Statuses

GET

/api/fmc_config/v1/domain/ {domainUUID}/object/ operational/realmstatuses

SAML Realm USers and Groups

GET

/api/fmc_config/v1/domain/ {domainUUID}/object/ samlrealmusersandgroups

Test Realms

POST

/api/fmc_config/v1/domain/ {domainUUID}/object/ operational/testrealms

Variables

DELETE, GET, GET by ID POST, PUT

/api/fmc_config/v1/domain/ {domainUUID}/object/variables

Policy

Health Policies

DELETE, POST, PUT

/api/fmc_config/v1/domain/ {domainUUID}/policy/ healthpolicies

Templates

Apply

POST

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

DELETE, GET

/api/fmc_config/v1/domain/ {domainUUID}/templates/ devicetemplates/{containerUUID}/ associations
Default Model Mappings

GET, GET by ID

/api/fmc_config/v1/domain/ {domainUUID}/templates/ devicetemplates/{containerUUID}/ defaultmodelmappings/{modelName}
Device Templates

DELETE, GET, GET by ID, POST, PUT

/api/fmc_config/v1/domain/ {domainUUID}/templates/ devicetemplates
Model Mappings

DELETE, GET, GET by ID, POST, PUT

/api/fmc_config/v1/domain/ {domainUUID}/templates/ devicetemplates/{containerUUID}/ modelmappings
Object Overrides

GET by ID, PUT

/api/fmc_config/v1/domain/ {domainUUID}/templates/ devicetemplates/{containerUUID}/ objectoverrides/{containerUUID}/{object_UUID}
Supported Device Models

GET

/api/fmc_config/v1/domain/ {domainUUID}/templates/ supporteddevicemodels
Template Interfaces

DELETE, GET, GET by ID, POST

/api/fmc_config/v1/domain/ {domainUUID}/templates/ devicetemplates/{containerUUID}/ templateinterfaces
VPN Settings

DELETE, GET, GET by ID, POST

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

Troubleshoot

Modules

GET, GET by ID, POST

/api/fmc_troubleshoot/v1/domain/ {domainUUID}/cpuprofiler/ {containerUUID}/modules
Rules

GET, GET by ID, POST

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

What's New in 2023

October 19, 2023

Table 10. New Methods and Endpoints: October 19, 2023

Name

Methods

URL

Chassis

Switchmode

POST

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

Deployment

Pending Changes Requests

POST

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

Devices

Virtual Access Interfaces

GET

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

Policy

Access List Settings

GET, PUT

/api/fmc_config/v1/domain/{domainUUID} /policy/chassisplatformsettingspolicies /{containerUUID}/accesslistsettings /{object_UUID}

VPN Tunnel Statuses

GET

/api/fmc_config/v1/domain/{domainUUID} /policy/vpntunnelstatuses

Status

Download Reports

GET

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

System Configuration

Change Management Configurations

GET, PUT

/api/fmc_platform/v1/systemconfiguration /changemanagementconfigs
Table 11. New Methods and Endpoints: October 19, 2023

Name

Methods

URL

Analysis (NEW)

Active Sessions

GET, DELETE

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

Logout

POST

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

User Activity

GET, DELETE

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

Audit

Configuration Changes

GET

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

Chassis

App Information

GET

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

Chassis Interface Events

GET, PUT, POST, DELETE

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

Etherchannel Interfaces

GET, PUT, POST, DELETE

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

Fault Summary

GET

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

Instance Summary

GET

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

Interfaces

GET

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

Interface Summary

GET

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

Inventory Summary

GET

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

Logical Devices

GET, PUT, POST, DELETE

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

SNMP Settings

GET, PUT

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

Subinterfaces

GET, PUT, POST, DELETE

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

Devices

DDNS Settings

GET, PUT

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

DHCP Relay Settings

GET, PUT

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

DHCP Server

GET, PUT

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

Management Convergence Mode

GET, PUT

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

Model Migrations

POST

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

Virtual BiDirectional Forwarding Policies

GET, PUT, POST, DELETE

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

Health

Tunnel Details

GET

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

Integration

CD FMC Snapshot

GET, POST

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

Refresh SecureX Configurations

POST

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

Object

Azure AD Realms

GET, PUT, POST, DELETE

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

Azure AD Statuses

GET

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

Cipher Suite Lists

GET, POST

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

Custom SI IP List Download

GET

/api/fmc_config/v1/domain/{domainUUID} /object/customsiiplistdownload/{objectId}

Custom SI IP Lists

GET, PUT, POST, DELETE

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

Custom SI URL Lists Download

GET

/api/fmc_config/v1/domain/{domainUUID} /object/customsiurllistdownload/{objectId}

Custom SI URL Lists

GET, PUT, POST, DELETE

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

Distinguished Name Groups

GET /api/fmc_config/v1/domain/{domainUUID} /object/distinguishednamegroups

Distinguished Names

GET, POST

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

Download Azure Ad Realms

POST

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

External CA Certificate Groups

GET

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

External CA Certificates

GET, POST

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

External Certificate Groups

GET

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

External Certificates

GET, POST

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

File Categories

GET

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

File Types

GET

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

Internal Certificate Groups

GET

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

NTP Servers

GET, PUT, POST, DELETE

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

Overlaps

POST

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

Resource Profiles

GET, PUT, POST, DELETE

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

Secure Client Customizations

GET, PUT, POST, DELETE

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

SI Network Feeds

PUT, POST, DELETE

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

SI URL Feeds

PUT, POST, DELETE

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

Test Azure AD Realms

POST

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

Users and Groups

GET

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

VLAN Group Tags

DELETE

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

Policy

Application Groups

GET, PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/ztnapolicies/{containerUUID}/applicationgroups

Applications

GET, PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/ztnapolicies/{containerUUID}/applications

Chassis Platform Settings Policies

GET, PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/chassisplatformsettingspolicies

Decryption Policies

GET, PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/decryptionpolicies

Decryption Policy Rules

GET, PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/decryptionpolicies/{containerUUID} /decryptionpolicyrules/{

File Policies

PUT, POST,DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/filepolicies

File Rules

GET, PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/filepolicies/{containerUUID}/filerules

FTD Platform Settings Policies

PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies

HTTP Access Settings

GET, PUT

/api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /httpaccesssettings/{

NAT Exempt Rules

GET

/api/fmc_config/v1/domain/{domainUUID} /policy/natexemptrules/{deviceId}

Netflow Policies

GET, PUT

/api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID} /netflowpolicies/{

Secure Client Customization Settings

GET, PUT

/api/fmc_config/v1/domain/{domainUUID} /policy/ravpns/{containerUUID} /secureclientcustomizationsettings

SSH Client Settings

GET, PUT

/api/fmc_config/v1/domain/{domainUUID} /policy/chassisplatformsettingspolicies/{containerUUID} /sshclientsettings

SSH Server Settings

GET, PUT

/api/fmc_config/v1/domain/{domainUUID} /policy/chassisplatformsettingspolicies/{containerUUID} /sshserversettings

SNMP Settings

GET, PUT

/api/fmc_config/v1/domain/{domainUUID} /policy/ftdplatformsettingspolicies/{containerUUID}/snmpsettings

Syslog Settings

GET, PUT

/api/fmc_config/v1/domain/{domainUUID} /policy/chassisplatformsettingspolicies/{containerUUID}/syslogsettings/{

Zero Trust Applications

GET, PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/zerotrustpolicies/{containerUUID}/applications

Zero Trust Application Groups

GET, PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/zerotrustpolicies

Zero Trust Policies

GET, PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/zerotrustpolicies/{containerUUID}/applicationgroups

ZTNA Policies

GET, PUT, POST, DELETE

/api/fmc_config/v1/domain/{domainUUID} /policy/ztnapolicies

System Configuration

Remote Management Access

GET, PUT

api/fmc_platform/v1/systemconfiguration /remotemanagementaccess

Troubleshoot

Device

POST

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

Users

Users

GET

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

What's New in 2022

December 13, 2022

Table 12. New Methods and Endpoints: December 13, 2022

Name

Methods

URL

Backup (NEW)

Device Backup

POST

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

Download Backup

GET, GET by ID

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

Backup Files

GET, GET by ID, DELETE

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

Chassis

Chassis Physical Interface

GET, GET by ID, PUT

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

Devices

Device Records

PUT

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

Bidirectional Forwarding Policies

GET, GET by ID, PUT, POST, DELETE

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

Loopback Interfaces

GET, GET by ID, PUT, POST, DELETE

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

Device Clusters

Cluster Health Monitor Settings

GET by ID, PUT

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

Health

Remote Access VPN Gateways

GET, GET by ID

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

Terminate VPN Sessions

POST

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

Cisco Secure Dynamic Attributes Connector

GET, POST

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

Integration

Tunnel Deployments

GET, POST

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

Tunnel Transcripts

GET by ID

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

Test Umbrella Connections

POST

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

Umbrella Connections

GET, GET by ID, PUT, POST

/api/fmc_config/v1/domain/{domainUUID}/integration/ umbrellaconnections

Data Centers

GET

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

Object

AnyConnect Custom Attributes

PUT, POST, DELETE

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

Bidirectional Forwarding Templates

GET, GET by ID, PUT, POST, DELETE

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

DHCP IPv6 Pools

GET, GET by ID, PUT, POST, DELETE

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

Download Internal CA

POST

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

Internal Certificate Authorities

GET, GET by ID, PUT, POST, DELETE

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

Internal Certificates

GET, GET by ID, PUT, POST, DELETE

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

Security Group Tags

PUT, POST, DELETE

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

SI URL Lists

PUT, POST, DELETE

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

Validate Certificate File

POST

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

Policy

FlexConfig Policies

GET, GET by ID, POST

/api/fmc_config/v1/domain/{domainUUID}/policy/ flexconfigpolicies

FTD Platform Settings

GET, GET by ID

/api/fmc_config/v1/domain/{domainUUID}/policy/ ftdplatformsettingspolicies

Load Balance Settings

GET, GET by ID, PUT

/api/fmc_config/v1/domain/{domainUUID}/policy/ ravpns/{containerUUID}/loadbalancesettings

Enabling the REST API

The Firewall Management Center REST API is enabled by default.

Procedure


Step 1

Choose System (system gear icon) > Configuration > REST API Preferences.

Step 2

Check Enable REST API.

Step 3

Click Save.


Best Practices

Cisco recommends the following best practices for optimal results with the REST API:

  • Keep UI users and API users separate when possible. Especially do not use an admin account as an API user unless specifically necessary.

  • Do not give API users more privilege than needed.

  • Always validate the content coming from the server.

  • Validate/sanitize JSON content, as it may include embedded executable code.