Secure Firewall Management Center REST API Quick Start Guide, Version 7.3.0

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Book Contents
Find Matches in This Book
Available Languages
Download Options

Book Title

Secure Firewall Management Center REST API Quick Start Guide, Version 7.3.0

Chapter Title

About the Management Center REST API

Results

Updated:
November 29, 2022

Chapter: About the Management Center REST API

About the Management Center REST API

The management center REST API provides a lightweight API to manage a management center.

About the Management Center REST API

The REST API is an application programming interface (API), based on “RESTful” principles, which you can quickly enable on any management center running version 6.1 or higher, and use with a REST client.

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

Whats New in 7.1

The following new features and functionality were added in version 7.1.

  • Added error 
    401 Invalid Session
  • Added error 
    429 Too Many Writes

  • Removed biased terminology from field names and descriptions

  • Added the following new sections in API Explorer:

    Troubleshoot

    Network Map

    Chassis

New API endpoints and Methods

Table 1. New Endpoints: these are new endpoints and methods.

Name

Methods

URL

Troubleshoot
Packet Tracer Files

DELETE, DELETE by ID

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

Network Map

Netmap Hosts

GET, GET by ID, POST, DELETE

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

Vulns

GET, GET by ID, POST, DELETE

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

Users

Duo Configs

GET, GET by ID, PUT

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

Deployment Services

Job Histories

GET, GET by ID, PUT

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

Download Reports

GET

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

Email Reports

POST

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

Device Clusters

Threat Defense Cluster Readiness Check

POST

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

Threat Defense Cluster Device Commands

POST

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

Health Services

Tunnel Statuses

GET

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

Tunnel Summaries

GET

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

Chassis

Management Center Managed Chassis

GET, GET by ID

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

Network Modules

GET, GET by ID, PUT

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

Sync Network Module

PUT

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

Chassis Interfaces

GET, GET by ID

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

Device Services

ECMP Zones

GET, GET by ID, PUT, POST, DELETE

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

Virtual ECMP Zones

GET, GET by ID, PUT, POST, DELETE

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

Packet Tracer

POST

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

Packet Tracer PCAP

POST

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

Policy Based Routes

GET, GET by ID, PUT, POST, DELETE

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

Virtual Policy Based Routes

GET, GET by ID, PUT, POST, DELETE

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

VTEP Policies

GET, GET by ID, PUT, POST, DELETE

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

VNI Interfaces

GET, GET by ID, PUT, POST, DELETE

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

Threat Defense All Interfaces

GET

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

Integration

Dynamic Attributes Feeds

GET, PUT

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

Object

Anyconnect External Browser Packages

GET, GET by ID

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

Bulk Dynamic Objects

POST

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

Extended Community Lists

GET, GET by ID, GET overrides, GET overrides by ID, OUT, POST, DELETE

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

Packet Tracer PCAP List

GET

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

Packet Tracer PCAP Upload

POST

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

Updates

Revert Upgrades

POST

 /api/fmc_platform/v1/updates/revertupgrades

New Methods for existing endpoints

Table 2. New Methods for Existing Endpoints: these provide additional functionality for existing endpoints

Name

Methods

URL

Device Clusters

Threat Defense Device Cluster (existing)

PUT, POST, DELETE

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

Device Services

BGP

PUT, POST, DELETE

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

BGP General Settings

PUT, POST, DELETE

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

Object

AS Path Lists (existing

PUT, POST, DELETE

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

Expanded Community Lists

PUT, POST, DELETE

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

Extended Access Lists

PUT, POST, DELETE

 /api/fmc_config/v1/domain/{domain_UUID}/object/extendedaccesslists

IPv4 Prefix Lists (existing)

PUT, POST, DELETE

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

IPv6 Prefix Lists

PUT, POST, DELETE

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

Policy Lists

PUT, POST, DELETE

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

Route Maps

PUT, POST, DELETE

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

Standard Access Lists

PUT, POST, DELETE

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

Standard Community Lists

PUT, POST, DELETE

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

Whats New in 7.2

No new features or functionality were added in version 7.2.

New API endpoints and Methods

Table 3. New Methods and Endpoints:

Name

Methods

URL

Chassis
Evaluate Operation

GET

/api/fmc_config/v1/domain/{domainUUID}/chassis/ fmcmanagedchassis/{containerUUID}/chassisinterfaces/ {interfaceUUID}/evaluateoperation
Breakout Interfaces

POST

/api/fmc_config/v1/domain/{domainUUID}/chassis/ fmcmanagedchassis/{containerUUID}/operational/ breakoutinterfaces
Join Interfaces

POST

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

Deployment

Download Reports

GET

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

Email Reports

GET

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

Devices

EIGRP Routes

GET, GET by ID, PUT, POST, DELETE

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

Virtual EIGRP Routes

GET, GET by ID, PUT, POST, DELETE

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

Device Settings

GET, PUT

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

Change Managers

POST

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

Integration

EBS Snapshot

GET by ID, POST

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

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

Status

Task Statuses

GET

/api/fmc_config/v1/domain/{domainUUID}/job/ taskstatuses

Object

AnyConnect External Browser Packages

PUT, POST, DELETE

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

AnyConnect Packages

PUT, POST, DELETE

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

AnyConnect Profiles

PUT, POST, DELETE

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

Certificate Enrollments

PUT, POST, DELETE

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

Certificate Maps

PUT, POST, DELETE

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

Group Policies

PUT, POST, DELETE

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

Host Scan Packages

PUT, POST, DELETE

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

IPv4 Address Pools

PUT, POST, DELETE

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

IPv6 Address Pools

PUT, POST, DELETE

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

Umbrella Protection Policies

GET, POST

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

Radius Server Groups

PUT, POST, DELETE

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

SSO Servers

PUT, POST, DELETE

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

Policy

Auto NAT Rules

PUT, DELETE

/api/fmc_config/v1/domain/{domainUUID}/policy/ ftdnatpolicies/{containerUUID}/autonatrules

Manual NAT Rules

PUT, DELETE

/api/fmc_config/v1/domain/{domainUUID}/policy/ ftdnatpolicies/{containerUUID}/manualnatrules

NAT Rules

DELETE

/api/fmc_config/v1/domain/{domainUUID}/policy/ ftdnatpolicies/{containerUUID}/natrules

Health Policies

GET, GET by ID

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

Policy Locks

GET, POST

/api/fmc_config/v1/domain/{domainUUID}/policy/ operational/policylocks

RA VPNs

PUT, POST, DELETE

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

Address Assignment Settings

PUT

/api/fmc_config/v1/domain/{domainUUID}/policy/ ravpns/{containerUUID}/addressassignmentsettings/{objectId}

Certificate Map Settings

PUT

/api/fmc_config/v1/domain/{domainUUID}/policy/ ravpns/{containerUUID}/certificatemapsettings/{objectId}

Connection Profiles

PUT, POST, DELETE

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

IPSec Advanced Settings

GET, GET by ID, PUT

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

IPSec Crypto Maps

GET, GET by ID, PUT

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

LDAP Attribute Maps

GET, GET by ID, PUT

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

S2S VPN Summaries

GET

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

Umbrella DNS Policies

GET, GET by ID, PUT, POST, DELETE

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

Umbrella DNS Rules

GET, GET by ID, PUT

/api/fmc_config/v1/domain/{domainUUID}/policy/ umbrelladnspolicies/{containerUUID}/umbrelladnsrules

Search

Device

GET

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

License

Device Licenses

GET, GET by ID, PUT, PUT by ID

/api/fmc_platform/v1/license/ devicelicenses

Smart Licenses

GET, POST

/api/fmc_platform/v1/license/ smartlicenses

Updates

Upgrade Snapshot

POST

/api/fmc_platform/v1/updates/ upgradesnapshot

Troubleshoot

Task

POST

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

Note

Spaces have been added to the URLs to aid in readability. When using the URLs, remove the spaces.

What's New in 7.3

Backup section has been added in 7.3.

New API endpoints and Methods

Table 4. New Methods and Endpoints:

Name

Methods

URL

Backup

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

Bi-Directional 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

Path Monitored Interfaces

GET

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

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}

Data Centers

GET

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

Umbrella Transcripts

GET by ID

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

Object

Bi-Directional 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

Flex Config 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

Flexconfig Migration

POST

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

Note

Spaces have been added to the URLs to aid in readability. When using the URLs, remove the spaces.

Enabling the REST API

In management center, the REST API is enabled by default. However, if you are intending to use the REST API, you should confirm that it is enabled.


Note
If you are using UCAPL mode, check that the REST API is not enabled.

Procedure

Step 1

Navigate to the gear icon for the System menu. Under that menu select Configuration and then REST API Preferences.

Step 2

Check the box marked Enable REST API.

Step 3

Click "Save". A "Save Successful" dialog will display when the REST API is enabled.

Best Practices

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

  • Keep UI users and 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.

  • If you are using CC or UCAPL mode you should disable REST API access to the management center and managed devices.

Was this Document Helpful?

FeedbackFeedback

Contact Cisco