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

The Health API from Cisco Secure Firewall — 12 operation(s) for health.

Cisco Secure Firewall Health 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 Health. 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 12 operations across 12 paths, and defines 84 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 10 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, https://api.int.security.cisco.com/provisioning.

12 operations 12 paths 84 schemas 11 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 3

Cisco Secure Firewall Health API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). It supports OAuth 2.0 (EnterpriseAdminBearerAuth) using the clientCredentials flow, exposing 1 scope. It supports OAuth 2.0 (ServiceTokenBearerAuth) using the clientCredentials flow, exposing 2 scopes.

Paths & Operations 12

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

Health 12
GET
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/health/aggregatemetrics
Get metrics related to the health of the device and interface attributes.
getAggregateMetrics 5 params → 200default
GET
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/health/alerts
Get health alerts.
getHealthAlertModel 5 params → 200default
GET
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/health/events
Get health events.
getHealthEventModel 5 params → 200default
GET
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/health/metrics
Get HealthMonitor metrics for the device. The metrics are governed by the respective health modules in the health policy. Ensure that you enable the health module before fetching the metrics using th…
getHealthMetric 5 params → 200default
GET
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/health/pathmonitoredinterfaces
Get path-monitored interfaces.
getAllPathMonitoredInterface 4 params → 200default
GET
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/health/ravpngateways
Get the Remote Access VPN Gateway Details. This includes RA VPN Certificate expiry dates and maximum sessions supported.
getRaVpnGateway 4 params → 200default
POST
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/health/ravpnsessions/operational/terminateravpnsessions
Terminate active VPN sessions Check the response section for applicable examples (if any).
createTerminateRAVPNSession 1 param body → 201default
GET
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/health/tunnelstatuses
Get tunnel status for the Site-to-Site VPN on all managed Firewall Threat Defense devices.
getAllTunnelStatus 5 params → 200default
GET
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/health/tunnelstatuses/{containerUUID}/tunneldetails
Get tunnel details for Site-to-Site VPN by executing show commands on managed peers.
getAllTunnelDetail 5 params → 200default
GET
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/health/tunnelstatuses/{objectId}
Get status for the specified Firewall Threat Defense Site-to-Site VPN topology.
getTunnelStatus 2 params → 200default
GET
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/health/tunnelsummaries
Get aggregated summary of tunnel status for S2S VPN on all managed Firewall Threat Defense devices.
getTunnelSummary 5 params → 200default
GET
/ping
Get Server Health
ping → 200400

Schemas 84

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

DeviceInventoryData
object
4 properties
HealthEventModel
object
An object representing the health event.
13 properties
PathMonitoredInterface
object
9 properties
HealthAlertConfig
object
3 properties
IRouteDistributeConnectedNetwork
object
3 properties
IDeviceChassisData
object
4 properties
IDevice
object
43 properties 3 required
IDeviceGroup
object
8 properties
IHybridZeroTrustFQDNConfig
object
3 properties
HealthModule
object
9 properties
HealthAlertModel
object
An object representing the health alert.
14 properties
Domain
object
The details about the domain.
5 properties
model.Error
object
2 properties
IReference_1
object
43 properties 3 required
CertificateInfo
object
3 properties
IMetadata
object
6 properties
IAutoVpnRouteSettings
object
7 properties
IReference_2
object
43 properties 3 required
TerminateRAVPNSession
object
11 properties
IHealthPolicy
object
Description of Health Policy.
12 properties
IVpnAddresses
object
3 properties
CertEnrollmentStatus
object
2 properties
HealthSetting
object
13 properties
LLUniversalZeroTrustSetting
object
model.Health
object
4 properties
IReadonly
object
2 properties
CPUHealthMetrics
object
Represents device CPU metrics in percentage values.
3 properties
FanRpmAvg
object
2 properties
ISubTask
object
6 properties
MemoryHealthMetrics
object
Represents device memory metrics in percentage values.
3 properties
AggregateMetricsListContainer
object
3 properties
ReadOnly
object
Defines the read only conditions if the referenced resource is read only.
2 properties
ITaskStatus
object
10 properties
TunnelDetail
object
9 properties
MetadataUser
object
This object defines details about the user.
4 properties
HealthEventModelListContainer
object
3 properties
IDeviceInventoryData
object
4 properties
RaVpnGatewayListContainer
object
3 properties
IReference
object
Contains reference information.
4 properties
ErrorResponse
object
3 properties
TunnelDetailListContainer
object
3 properties
DialHost
object
2 properties
ISecurityAssociation
object
8 properties
IAdvanced
object
1 property
IActionInfo
object
HealthMetric
object
11 properties
TunnelSummaryListContainer
object
3 properties
IVpnPeerDetail_1
object
9 properties
IHybridZeroTrustDeviceSetting
object
3 properties
IpAddresses
object
2 properties
ISPI
object
3 properties
IVpnCliOutput
object
2 properties
IPolicyModel
object
7 properties
IMetadataUser
object
4 properties
PagingContainer
object
4 properties
DiskHealthMetrics
object
Represents device disk metrics in percentage values.
1 property
IPreDeployAction
object
2 properties
ITarget
object
This is the target device.
7 properties
ChassisStatsHealthMetrics
object
Represents chassis status health metrics such as fan speed in RPM values.
1 property
HealthMetricListContainer
object
3 properties
IVpnInterface
object
4 properties
IPathMonitoredInterfaceDetails
object
2 properties
RaVpnGateway
object
11 properties
IBaseDevice
object
19 properties
HealthAlertModelListContainer
object
3 properties
TunnelStatus
object
Represents status of all S2S VPN tunnels.
13 properties
TunnelStatusListContainer
object
3 properties
IFTDS2SVpnModel
object
16 properties
IAutoVpnSettings
object
2 properties
DeviceMetadata
object
26 properties 1 required
ILinks
object
This defines the self referencing links for the given resource.
2 properties
ErrorMessagesContainer
object
7 properties
IDomain
object
4 properties
HealthThreshold
object
2 properties
DeviceChassisData
object
4 properties
IVpnPeer
object
7 properties
IVpnPeerDetail
object
9 properties
InterfaceHealthMetrics
object
Represents various interface metrics. Average counter values are displayed for metrics such as buffer runs and packet drops.
16 properties
AggregateMetrics
object
Represents various device health metrics in an aggregated format.
15 properties
HAInfo
object
Represents the role and status of a high availability device.
2 properties
Metadata
object
Defines read only details about the object - whether it is system defined, last user who modified the object etc.
6 properties
PathMonitoredInterfaceListContainer
object
3 properties
IModel
object
7 properties
TunnelSummary
object
Represents an aggregated summary of the status of all S2S VPN tunnels.
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-secure-firewall-health-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 Health 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.