Cisco Secure Firewall Devices 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 Devices. 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
223 operations
across 108 paths,
and defines 370 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.
The identity and technical contract details declared by the specification.
DeviceInventoryData
object
4 properties
IOspfv3NeighborPriority
object
2 properties
IRouteMap
object
10 properties
2 required
VrfIPv6StaticRouteModelListContainer
object
3 properties
IBGPGSGracefulRestart
object
7 properties
IOverrideDefaultFragmentSetting
object
3 properties
ISLAMonitorModel
object
17 properties
3 required
IChangeConfigManagerFTDInfo
object
9 properties
INetworkObjectContainer
object
2 properties
IHybridZeroTrustFQDNConfig
object
3 properties
HealthModule
object
9 properties
Ospfv3RedistributionEntry
object
30 properties
IStaticArpEntry
object
2 properties
IOspfv3GracefulRestart
object
1 property
IEigrpProtocolConfigModel
object
Contains Eigrp Protocol parameters.
3 properties
IStaticIPContainer
object
4 properties
INetworkAddressLiteral
object
2 properties
IHealthMonitorMetric
object
6 properties
OspfInterfacePolicyModelListContainer
object
3 properties
VrfOspfPolicyModelListContainer
object
3 properties
VrfStaticRouteModel
object
12 properties
4 required
VrfOspfInterfacePolicyModelListContainer
object
3 properties
IEigrpAdvancedConfigModel
object
Contains EIGRP advanced configurations.
10 properties
IIPv6ClientPdContainer
object
2 properties
EigrpPolicyModel
object
13 properties
IApplicationProductivity
object
Represents an ApplicationProductivity.
9 properties
FPInterfaceStatistics
object
11 properties
Device
object
A model representing a Device.
43 properties
3 required
HealthSetting
object
13 properties
IIPv4AddressPool
object
17 properties
1 required
DeviceCopyConfigRequest
object
Copy configuration operation on device
3 properties
IDHCPIPv6OtherServerOptions
object
3 properties
IPv4StaticRouteModel
object
13 properties
4 required
IApplicationCategory
object
Represents an ApplicationCategory.
9 properties
IIntrusionPolicyModel
object
11 properties
IOspfVirtualLinks
object
10 properties
FTDVTIInterfaceListContainer
object
3 properties
IFPPhysicalInterface
object
14 properties
IMaximumPaths
object
6 properties
ReadOnly
object
Defines the read only conditions if the referenced resource is read only.
2 properties
INeighborRoutes
object
7 properties
OutOfBandChanges
object
15 properties
FTDAllInterfacesModelListContainer
object
3 properties
Duration
object
2 properties
IOspfAreaType
object
7 properties
Ospfv3SummaryPrefixEntry
object
20 properties
IOspfDefaultInfoOriginate
object
3 properties
Ospfv3AreaEntry
object
27 properties
IBgpNetworks
object
7 properties
IPv6StaticRouteModel
object
12 properties
4 required
DeviceListContainer
object
3 properties
IStaticMacEntry
object
2 properties
IPolicyModel
object
7 properties
IIPv4VerifyAvailabilityModel
object
3 properties
PBRPolicyModelListContainer
object
3 properties
IApplicationModel
object
Represents an ApplicationModel containing Application Types, Tags, Productivity, Risk, and Categories.
16 properties
ITarget
object
This is the target device.
7 properties
IDDNSInterfaceSettingModel
object
14 properties
ECMPZoneModel
object
Equal-Cost Multi-Path (ECMP)
8 properties
IOspfRouteMetric
object
2 properties
IDHCPRelayServerConfig
object
10 properties
OspfInterfacePolicyModel
object
9 properties
BulkRegistration
object
An object that represents the details for bulk registration of devices.
13 properties
ITargetInterface
object
6 properties
IStandardACLEntry
object
Standard Access List entry
2 properties
2 required
IOspfMD5Auth
object
3 properties
VrfEigrpPolicyModelListContainer
object
3 properties
IPv6StaticRouteModelListContainer
object
3 properties
IApplicationMonitoring
object
2 properties
Ospfv3InterfacePolicyModelListContainer
object
3 properties
IBGPAddressFamilyModel
object
25 properties
IHost
object
10 properties
FTDLoopbackInterface
object
A model representing loopback Interface type definition under device records.
31 properties
IRuleRecommendation
object
5 properties
VrfBGPIPvAddressFamilyModelListContainer
object
3 properties
INeighborAdvertiseMaps
object
7 properties
IOspfDeadIntervalMechanism
object
3 properties
Ospfv3AreaRouteSummaryEntry
object
20 properties
IAggregateAddresses
object
11 properties
IAccessPolicyModel
object
13 properties
1 required
StaticRouteModel
object
12 properties
4 required
OspfPolicyModel
object
16 properties
IApplicationType
object
Represents an ApplicationType.
9 properties
ModelMigration
object
14 properties
DeviceCertificateExportData
object
7 properties
IARPConfigContainer
object
3 properties
InterfaceEventListContainer
object
3 properties
HealthAlertConfig
object
3 properties
FTDLoopbackInterfaceListContainer
object
3 properties
VirtualSwitchListContainer
object
3 properties
IDHCPIPv6Pool
object
10 properties
IBGPGSBestPath
object
9 properties
BGPGeneralSettingModel
object
BGP is an inter and intra autonomous system routing protocol.
25 properties
2 required
Ospfv3PolicyModel
object
15 properties
1 required
Ospfv3AreaVirtualLinkEntry
object
23 properties
IDHCPIPv6DNSServer
object
2 properties
IAddressContainer
object
4 properties
IFMCAccessConfig
object
2 properties
OutOfBoundChangesRequestMetadata
object
10 properties
INetworkBase
object
9 properties
IOspfTimers
object
6 properties
IOspfv3Timers
object
6 properties
IRouteMapEntry
object
List of route maps entries already configured for this route map object.
51 properties
2 required
Commands
object
9 properties
FTDPhysicalInterface
object
40 properties
DeviceDDNSSettingModelListContainer
object
3 properties
IOspfFilterList
object
2 properties
IChangeConfigManagerFTDReportOptions
object
6 properties
VRFPolicyEntry
object
16 properties
EigrpDistributionListModel
object
Contains criteria for filtering EIGRP updates.
6 properties
IFTDInterface
object
8 properties
CommandsListContainer
object
3 properties
VrfBGPIPvAddressFamilyModel
object
BGP is an inter and intra autonomous system routing protocol.
14 properties
2 required
IChangeConfigManagerFTDReportDeviceInfo
object
11 properties
IAccessPolicyPrefilterPolicySettingModel
object
Object representing the association of prefilter policy to specified access policy. When access policy is created, the attribute will refer to Default Prefilte…
7 properties
IOspfv3NeighborConfiguration
object
2 properties
2 required
IOspfProcessModel
object
15 properties
INeighborTransportConnectionMode
object
5 properties
DeviceExport
object
An object that represents the details for device configuration export.
9 properties
IOverride
object
Defines the override details for this object.
2 properties
SelectedInterface
object
5 properties
VRFInterfaceEntry
object
7 properties
DownloadSampleCsvListContainer
object
3 properties
IBGPGSTimers
object
7 properties
IOspfNeighbors
object
2 properties
Ospfv3InterfaceNeighborEntry
object
24 properties
ISubTask
object
6 properties
IIPv6PrefixContainer
object
2 properties
VrfIPv4StaticRouteModel
object
13 properties
4 required
VrfPBRPolicyModel
object
9 properties
IOspfv3LogAdjacencyChanges
object
1 property
FTDVNIInterfaceListContainer
object
3 properties
IDDNSUpdateMethodModel
object
12 properties
ITaskStatus
object
10 properties
IDHCPRelayAgent
object
11 properties
VrfPBRPolicyModelListContainer
object
3 properties
ILsaThrottleTimer
object
3 properties
LTPDeviceRecordListContainer
object
3 properties
DeviceCertificateModelListContainer
object
3 properties
IAccessPolicyDefaultAction
object
17 properties
1 required
VrfIPv4StaticRouteModelListContainer
object
3 properties
ISwitchPortConfig
object
5 properties
ISpfThrottleTimer
object
3 properties
IChangeConfigManagerFTDReportJobSummary
object
7 properties
HybridZeroTrustSetting
object
12 properties
FTDSubInterface
object
32 properties
IInterfaceObjectModel
object
11 properties
IKeyChainObject
object
8 properties
PreferLifeTime
object
2 properties
BGPIPvAddressFamilyModelListContainer
object
3 properties
IVTEPEntry
object
6 properties
DeviceSettings
object
8 properties
IKeyObject
object
5 properties
DeviceDHCPServerSettingsListContainer
object
3 properties
VrfOspfInterfacePolicyModel
object
9 properties
IOspfv3GracefulRestartHelper
object
1 property
VrfIPv6StaticRouteModel
object
12 properties
4 required
IApplicationRisk
object
Represents an ApplicationRisk.
9 properties
ManagementInterfaceConvergence
object
10 properties
IOspfAreaAuth
object
3 properties
IBaseDevice
object
19 properties
DeviceImportExportMetadata
object
9 properties
VrfBFDPolicyModelListContainer
object
3 properties
INeighborGeneral
object
10 properties
IOspfAdministrativeDistance
object
3 properties
FPPhysicalInterface
object
14 properties
ReferenceObject
object
4 properties
VirtualAccessInterfaceListContainer
object
3 properties
IPPPoEContianer
object
8 properties
IDHCPServers
object
11 properties
IDomain
object
4 properties
FTDBridgeGroupInterfaceListContainer
object
3 properties
IOspfv3ProcessModel
object
16 properties
VrfECMPZoneModelListContainer
object
3 properties
IPoeConfig
object
2 properties
VrfOspfPolicyModel
object
16 properties
IEigrpStub
object
Contains attributes required to designate the router as Stub router.
2 properties
ModelMigrationRequestMetadata
object
7 properties
ManagementInterfaceConvergenceListContainer
object
3 properties
StaticRouteModelListContainer
object
3 properties
FTDEtherChannelInterfaceListContainer
object
3 properties
INeighborTransportPathMTUDiscovery
object
5 properties
ExpirationLifeTime
object
2 properties
FTDEtherChannelInterface
object
42 properties
FPInterfaceStatisticsListContainer
object
3 properties
IIPv6Container
object
17 properties
IAuthTypeAndString
object
2 properties
IDeviceChassisData
object
4 properties
ChangeConfigManagerFTDRequest
object
11 properties
IDeviceImportExportOptions
object
8 properties
ChangeConfigManagerFTDMetadata
object
7 properties
FTDVlanInterfaceListContainer
object
3 properties
IACPolicyIdentityPolicySettings
object
8 properties
IAdvertisement
object
3 properties
TaskStatus
object
11 properties
EigrpNeighborModel
object
Contains EIGRP neighbor attributes.
3 properties
IHostObjectContainer
object
2 properties
IHealthPolicy
object
Description of Health Policy.
12 properties
ILifeTime
object
4 properties
IStandardACL
object
10 properties
2 required
INeighborHops
object
7 properties
PBRPolicyModel
object
9 properties
IEnrolledCertificate
object
10 properties
INetworkAddress
object
9 properties
BFDPolicyModelListContainer
object
3 properties
ECMPZoneModelListContainer
object
3 properties
IDistributeLists
object
6 properties
IOspfv3InterfaceAuthenticationBase
object
1 property
1 required
Ospfv3PassiveInterfaceEntry
object
19 properties
FPPhysicalInterfaceListContainer
object
3 properties
FTDVlanInterface
object
32 properties
FTDSubInterfaceListContainer
object
3 properties
INetworkObjectsContainer
object
2 properties
UZTNADeviceSettingsMetadata
object
7 properties
IOspfv3NeighborProperties
object
2 properties
MetadataUser
object
This object defines details about the user.
4 properties
IRouteImportExport
object
6 properties
IDeviceMappingOptions
object
3 properties
IDeviceInventoryData
object
4 properties
DeviceImport
object
An object that represents the details for device configuration import.
12 properties
SseProxyData
object
2 properties
ICertificateDetails
object
2 properties
VTEPPolicy
object
9 properties
ErrorResponse
object
3 properties
IPv4StaticRouteModelListContainer
object
3 properties
DeviceImportExportOptions
object
8 properties
IOspfv3DefaultInfoOriginate
object
3 properties
FTDPhysicalInterfaceListContainer
object
3 properties
INeighborTimers
object
7 properties
IEigrpAdministrativeDistance
object
Used for configuring the administrative distance for a route.
2 properties
IDHCPContainer
object
2 properties
IInterface
object
7 properties
IMetadataUser
object
4 properties
TaskMetadata
object
7 properties
IVirtualSwitch
object
15 properties
INeighbors
object
18 properties
INeighborLocalAs
object
8 properties
IFilterProtocol
object
6 properties
VrfEigrpPolicyModel
object
13 properties
DDNSUpdateIntervalModel
object
4 properties
IOspfv3SummaryPrefix
object
3 properties
INeighborAdvanced
object
13 properties
IOspfArea
object
8 properties
INeighborDistributeLists
object
6 properties
IEigrpBasicConfigModel
object
Basic configurations contains the most common configurations for any EIGRP process.
3 properties
DeviceMetadata
object
26 properties
1 required
DeviceCertificateModel
object
9 properties
IIpvPrefixListFilter
object
7 properties
ErrorMessagesContainer
object
7 properties
DeviceDDNSSettingModel
object
14 properties
BFDPolicyModelMetaData
object
8 properties
IOspfv3NeighborCost
object
2 properties
IAccessPolicyDecryptionPolicySetting
object
8 properties
IDHCPOptions
object
13 properties
FTDRedundantInterfaceListContainer
object
3 properties
IFileWrapper
object
6 properties
IOspfv3NsfGracefulRestart
object
2 properties
IPrefixContainer
object
4 properties
ObjectEntry
object
6 properties
InlineSetListContainer
object
3 properties
IOspfInterval
object
2 properties
INeighborDefaultOriginate
object
5 properties
INeighborHaMode
object
5 properties
LLDPContainer
object
2 properties
HealthMonitorModelListContainer
object
3 properties
BGPGeneralSettingModelListContainer
object
3 properties
VirtualRouterModelListContainer
object
3 properties
IOspfHelloMultiplierMechanism
object
2 properties
OspfPolicyModelListContainer
object
3 properties
EigrpInterfaceModel
object
Contains the EIGRP interface attributes.
3 properties
IOspfLogAdjChanges
object
1 property
IDeviceGroup
object
8 properties
Domain
object
The details about the domain.
5 properties
FTDVNIInterface
object
40 properties
IRedistributeProtocolBase
object
5 properties
IOspfAuthentication
object
4 properties
IMetadata
object
6 properties
DeviceDHCPServerSettings
object
17 properties
LTPDeviceRecord
object
12 properties
1 required
FPLogicalInterfaceListContainer
object
3 properties
VTEPPolicyListContainer
object
3 properties
IEigrpRouteMetric
object
It contains the bandwidth, load, delay, reliability and MTU values which are used by routing algorithm for selecting or rejecting a routing path for transferri…
5 properties
INeighborFilterList
object
6 properties
IDistance
object
7 properties
BGPIPvAddressFamilyModel
object
BGP is an inter and intra autonomous system routing protocol.
14 properties
2 required
DeviceSettingsInterface
object
4 properties
IOspfv3Neighbor
object
2 properties
2 required
IEigrpAdvertise
object
Contains information about advertised routes.
4 properties
LLUniversalZeroTrustSetting
object
HealthMonitorModel
object
10 properties
DeviceDHCPRelaySettingsListContainer
object
3 properties
DeviceDHCPRelaySettings
object
12 properties
INeighborMaximumPrefix
object
8 properties
IEigrpPassiveInterfaceModel
object
Contains attributes related to Passive interfaces.
2 properties
IReadonly
object
2 properties
FTDBridgeGroupInterface
object
33 properties
IDeviceCertificate
object
2 properties
INeighborRouteMap
object
6 properties
Links
object
2 properties
FTDVTIInterface
object
38 properties
OutOfBandChangesListContainer
object
3 properties
VrfStaticRouteModelListContainer
object
3 properties
ManageDeviceCertificatesRequestModel
object
9 properties
IEigrpInterfaceAuthentication
object
Contains EIGRP Interface Authenticatin information
4 properties
IOverrideableInterfaceAttributes
object
4 properties
IReference
object
Contains reference information.
4 properties
IDeviceConfigInterfaceMapping
object
2 properties
EigrpPolicyModelListContainer
object
3 properties
IPathMonitoring
object
3 properties
DialHost
object
2 properties
IAdvanced
object
1 property
HybridZeroTrustSettingListContainer
object
3 properties
IOspfNsfGracefulRestart
object
6 properties
IHybridZeroTrustDeviceSetting
object
3 properties
IDeviceImportExportRequestOptions
object
3 properties
IEigrpInterfaceTimer
object
Contains EIGRP Interface timer information
3 properties
IInlinePair
object
2 properties
IOspfPasswdAuth
object
2 properties
VrfBFDPolicyModel
object
13 properties
IIPv6DHCPContainer
object
5 properties
EigrpRedistributionModel
object
Send (redistribute) routes in EIGRP table based on selected criteria
10 properties
PagingContainer
object
4 properties
IPreDeployAction
object
2 properties
IRouteInjection
object
7 properties
IOspfAreaRanges
object
2 properties
FTDRedundantInterface
object
34 properties
VrfECMPZoneModel
object
Equal-Cost Multi-Path (ECMP)
8 properties
VirtualRouterModel
object
9 properties
IPbrForwardingActionModel
object
14 properties
IDeviceCertificateExportOptions
object
2 properties
VirtualSwitch
object
15 properties
IIPv4Container
object
3 properties
IOspfFilterRule
object
5 properties
1 required
Snort3IPSReferenceObject
object
5 properties
DeviceSettingsListContainer
object
3 properties
Ospfv3ProcessEntry
object
54 properties
IInterfaceDeviceModel
object
8 properties
Ospfv3PolicyModelListContainer
object
3 properties
EigrpSummaryAddressModel
object
4 properties
IOspfProtocolConfiguration
object
10 properties
ILinks
object
This defines the self referencing links for the given resource.
2 properties
FPLogicalInterface
object
19 properties
IOspfv3InterfaceConfiguration
object
12 properties
BFDPolicyModel
object
13 properties
IOspfSummaryAddresses
object
3 properties
InlineSet
object
21 properties
IDeploymentSettings
object
2 properties
HealthThreshold
object
2 properties
VirtualAccessInterface
object
48 properties
Ospfv3InterfaceCommonEntry
object
45 properties
DeviceChassisData
object
4 properties
FTDAllInterfacesModel
object
30 properties
IDHCPIPv6DomainName
object
2 properties
Ospfv3InterfacePolicyModel
object
14 properties
1 required
Metadata
object
Defines read only details about the object - whether it is system defined, last user who modified the object etc.
6 properties
INeighborFiltering
object
11 properties
IOspfv3VirtualLinks
object
6 properties
IOspfKeyChainAuth
object
2 properties
InterfaceEvent
object
11 properties
IApplicationTag
object
Represents an ApplicationTag.
9 properties
IOspfv3Area
object
5 properties
IOspfv3RouteSummary
object
3 properties
ISecurityZoneObjectModel
object
13 properties
IHardwareContainer
object
5 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Cisco Secure Firewall publishes across the network.