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 Support API

The Support API from Cisco Secure Firewall — 14 operation(s) for support.

Cisco Secure Firewall Support 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 Support. 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 14 operations across 14 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version 6.0.0.

Requests are made against a single base URL, https://api.security.cisco.com/pinacl/api.

14 operations 14 paths 35 schemas 2 DELETE7 GET2 PATCH1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Cisco Secure Firewall Support API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (jwt) (BearerJWT). By default, every request must be authenticated.

Paths & Operations 14

Across 14 paths, the API surfaces 14 operations — 2 DELETE, 7 GET, 2 PATCH, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Support 14
DELETE
/support/all-pinacl-candidate-policies
Delete all gateway set policies
clearGwSetPolicyResults → 204401403404405500
PATCH
/support/gateway-set/{gwSetId}/reset-lock-counter
Reset lock counter for gateway set id to allow policy push. Resetting the locks acquired by different systems internally, can lead to unexpected behaviour.
resetLockCounterForGatewaySet 1 param → 204401403404500
PUT
/support/gateway-set/{gwSetId}/sub-request/priority/{priority}
Update the priority value of sub-requests for gateway set
updatePriorityForSubRequestsByGatewaySetId 2 params → 200401403404500
GET
/support/pinacl-candidate-policy/{gwSetId}
Retrieve latest policy by gateway set id
retrieveLatestPolicyByGwSetId 1 param → 200401403404405500
POST
/support/push-gateway-set/{id}
Push latest policy for gateway set
pushGatewaySet 1 param → 202400401403404500
GET
/support/requests
Get Requests
getRequests 8 params → 200400401403404500
GET
/support/requests/{requestId}
Get request details
getRequest2 1 param → 200400401403404500
PATCH
/support/requests/{requestId}/gateway-sets/{gatewaySetId}/status/complete
Complete sub-request status
completeSubRequestStatus 2 params → 204400401403404500
GET
/support/requests/{requestId}/parent
Get parent request for child request
getParentRequest 1 param → 200400401403404500
GET
/support/requests/{requestId}/status
Get request status
getRequestStatus2 1 param → 200400401403404500
PUT
/support/reviveSubRequestsByGatewaySetId/{gwSetId}
Revive the sub-request count for gateway set id
reviveSubRequestsByGatewaySetId 1 param → 200401403404500
GET
/support/sub-requests/queue
Get sub-requests queue - sorted by priority value and queued time
getSubRequestsQueue 4 params → 200400401403404500
GET
/topology/support/decommission-queue
Get all gwset entries in decommission queue
getDecommissionQueueEntries 2 params → 200400401403404500
DELETE
/topology/support/decommission-queue/{gwSetId}
Delete gwset entry from decommission queue
deleteEntryFromDecomQueue 1 param → 204400401403404500

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are SubRequestInQueue (11 properties), MpmRequest (11 properties), PcmRequest (10 properties), RequestStatusResponse (9 properties). Each schema is shown below with its type and property counts.

PcmRequest
object
10 properties
GwSetPolicyResponse
object
4 properties
PushGatewayRequest
object
5 properties
Policy
object
3 properties
IpV4Address
object
8 properties
ProtocolWithPort
object
5 properties
GatewaySetDetails
object
3 properties
DecomGwQueueEntry
object
3 properties
MpmRequest
object
11 properties
NatRule
object
3 properties
SubRequestsInQueueByGatewaySet
object
2 properties
SdiRequest
object
8 properties
ServiceNat
object
4 properties
PushGatewaySetResponse
object
3 properties
RequestsResponsePage
object
2 properties
RuleOptions
object
2 properties
SubRequestInQueue
object
11 properties
MpmGovernancePolicyDynamicGroupRequest
object
5 properties
SubRequestQueueResponse
object
2 properties
ZoneTopologyRequest
object
8 properties
RequestingSystemRequestDetails
object
8 properties
Rule
object
5 properties
Services
object
6 properties
SourceNat
object
3 properties
ParentChildRequestPair
object
2 properties
ApplicationProtocolImpl
object
2 properties
Icmp
object
4 properties
RequestStatusResponse
object
9 properties
TopologyChangeRequest
object
5 properties
FullRequestDetails
object
7 properties
OtherInternetProtocol
object
2 properties
ReqIdAndSystem
object
2 properties
RequestQueryApiResponse
object
6 properties
DestinationNat
object
3 properties
LongRange
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-secure-firewall-support-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 Support 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.