How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cisco Secure Firewall Deployment API

The Deployment API from Cisco Secure Firewall — 10 operation(s) for deployment.

Cisco Secure Firewall Deployment API is one of 108 APIs that Cisco Secure Firewall publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Deployment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 11 operations across 10 paths, and defines 67 schemas. It is described by OpenAPI 3.2.0, at version 1.13.0.

Requests are made against 9 base URLs: https://api.us.security.cisco.com/firewall, https://api.eu.security.cisco.com/firewall, https://api.apj.security.cisco.com/firewall, https://api.au.security.cisco.com/firewall, https://api.in.security.cisco.com/firewall, https://api.int.security.cisco.com/firewall, https://scale.manage.security.cisco.com/api/rest, https://ci.manage.security.cisco.com/api/rest, https://manage.stg.secure.cisco/api/rest.

11 operations 10 paths 67 schemas 6 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.13.0
Base URL
https://api.us.security.cisco.com/firewall
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Cisco Secure Firewall Deployment API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 11

Across 10 paths, the API surfaces 11 operations — 6 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Deployment 11
GET
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/deployment/deployabledevices
Get a list of all devices with configuration changes which are ready to be deployed.
getDeployableDevice 7 params → 200default
GET
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/deployment/deployabledevices/{containerUUID}/deployments
Get deployment details for a device.
getDeploymentDetail 6 params → 200default
GET
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/deployment/deployabledevices/{containerUUID}/pendingchanges
Get all policy and object changes.
getPendingChanges 6 params → 200default
POST
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/deployment/deploymentrequests
Create a request for deploying configuration changes to devices. Check the response section for applicable examples (if any).
createDeploymentRequest 1 param body → 202default
GET
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/deployment/jobhistories
Gets all deployment jobs.
getAllJobHistory 5 params → 200default
GET
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/deployment/jobhistories/{containerUUID}/operational/downloadreports
Get the deployment job report for download.
getDownloadReport 5 params → 200default
POST
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/deployment/jobhistories/{containerUUID}/operational/emailreports
Email the deployment job report. Check the response section for applicable examples (if any).
createEmailReport 2 params body → 201default
GET
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/deployment/jobhistories/{objectId}
Get the specified deployment job.
getJobHistory 2 params → 200default
PUT
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/deployment/jobhistories/{objectId}
Modify the specified deployment job. Check the response section for applicable examples (if any).
updateJobHistory 2 params body → 200default
POST
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/deployment/pendingchangesrequests
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).
createPendingChangesRequest 1 param body → 202default
POST
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/deployment/rollbackrequests
Create a request for rollback configuration to devices. Check the response section for applicable examples (if any).
createRollbackRequest 1 param body → 201default

Schemas 67

The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are IDevice (43 properties), IDevice_2 (41 properties), DeviceMetadata (26 properties), IBaseDevice (19 properties). Each schema is shown below with its type and property counts.

DeployableDeviceListContainer
object
3 properties
DeviceInventoryData
object
4 properties
DeploymentRequest
object
Represents the deployment request object which will be used for policy deployment of a device.
14 properties
HealthAlertConfig
object
3 properties
HealthSetting
object
13 properties
LLUniversalZeroTrustSetting
object
IModifiedUserInfo
object
Modified User Information
2 properties
PendingChanges
object
Retrieves list changes between the last successful deployment and current saved configuration for the device,.
14 properties
DialHost
object
2 properties
JobHistory
object
10 properties
IAdvanced
object
1 property
IActionInfo
object
PendingChangesRequestMetadata
object
11 properties
DeployableDevice
object
Represents the Deployable Device Object.
15 properties
FailedDevices
object
Represents the devices which got failed during the deployment of a devices.
2 properties
IReadonly
object
2 properties
DeviceMetadata
object
26 properties 1 required
RollbackRequest
object
Represents the rollback request object which will be used for config rollback of a device.
3 properties
IDeviceChassisData
object
4 properties
DeploymentDetail
object
An object representing the deployment details on a device
11 properties
IValueUpdate
object
3 properties
IHybridZeroTrustDeviceSetting
object
3 properties
ISelectedPoliciesforDevices
object
Represents the object which is responsible for enabling the Selective Policy Deployment
2 properties
IDevice
object
43 properties 3 required
ILinks
object
This defines the self referencing links for the given resource.
2 properties
ErrorMessagesContainer
object
7 properties
IDevice_2
object
41 properties 3 required
IPolicyStatus
object
6 properties
IPolicyModel
object
7 properties
IDeviceGroup
object
8 properties
DeploymentDetailListContainer
object
3 properties
IRollbackDeviceListEntry
object
Part of request body which contains deployment job ids and list of devices for config rollback.
2 properties
IHybridZeroTrustFQDNConfig
object
3 properties
IDomain
object
4 properties
DownloadReport
object
Download Job report
IMetadataUser
object
4 properties
IValueAdd
object
2 properties
EmailReport
object
Email Job Report. Configure and test System-Configuration-Email Notification prior using this request
1 property
ISubTask
object
6 properties
Domain
object
The details about the domain.
5 properties
PagingContainer
object
4 properties
HealthModule
object
9 properties
HealthThreshold
object
2 properties
IValueDelete
object
2 properties
JobHistoryListContainer
object
3 properties
IPreDeployAction
object
2 properties
PendingChangesListContainer
object
3 properties
IDependentPolicy
object
Represents the inter-dependent out-of-date policies with the reason.
2 properties
IGroupDependencyDetailEntry
object
Represents the dependency information between out-of-date policies
3 properties
DeviceChassisData
object
4 properties
IReferenceUpdate
object
3 properties
ITarget
object
This is the target device.
7 properties
DownloadReportListContainer
object
3 properties
ReadOnly
object
Defines the read only conditions if the referenced resource is read only.
2 properties
TaskStatus
object
11 properties
ITaskStatus
object
10 properties
IMetadata
object
6 properties
MetadataUser
object
This object defines details about the user.
4 properties
IDeviceListEntry
object
7 properties
RollbackRequestMetadata
object
7 properties
DeploymentRequestMetadata
object
7 properties
IDeviceInventoryData
object
4 properties
IHealthPolicy
object
Description of Health Policy.
12 properties
PendingChangesRequest
object
Represents the pending changes request object which will be used to generate the delta of the changes pending on the device.
9 properties
IReference
object
Contains reference information.
4 properties
ErrorResponse
object
3 properties
IBaseDevice
object
19 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-secure-firewall-deployment-api-openapi.yml Raw ↑

Other APIs Cisco Secure Firewall publishes across the network.

Cisco Secure Firewall Access Groups API
Cisco Secure Firewall Access Token API
Cisco Secure Firewall Action API
Cisco Secure Firewall Adjacent Zone API
Cisco Secure Firewall AI Assistant API
Cisco Secure Firewall Analysis API
Cisco Secure Firewall API Entitlement API
Cisco Secure Firewall API Keys API
Cisco Secure Firewall App Group API
Cisco Secure Firewall ASA Access Rules API
Cisco Secure Firewall Audit API
Cisco Secure Firewall Audit Logs API
Where this information came from

This is an independent, third-party profile of Cisco Secure Firewall Deployment API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.