RESTTidSource - Security Cloud Control Firewall Manager API Documentation - Cisco DevNet

{"type":"model","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"properties":{"availableCollections":{"items":{"type":"object","properties":{"collectionAddress":{"type":"string"},"collectionContentBinding":{"type":"string"},"collectionDescription":{"type":"string"},"collectionMessageBinding":{"type":"string"},"collectionName":{"type":"string"},"collectionPollIntervalInMinutes":{"format":"int32","type":"integer"},"collectionProtocolBinding":{"type":"string"},"collectionSubType":{"type":"string"},"llcollectionTopic":{"type":"object","properties":{"address":{"type":"string"},"contentBindings":{"type":"string"},"description":{"type":"string"},"hashMap":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLHashMap"},"messageBinding":{"type":"string"},"name":{"type":"string"},"pollIntervalInMinutes":{"format":"int32","type":"integer"},"protocolBinding":{"type":"string"},"subType":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/LLCollectionTopic"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/RESTCollectionTopic"},"type":"array"},"caCert":{"type":"string"},"checksum":{"type":"string"},"clientCert":{"type":"string"},"clientPrivateKey":{"type":"string"},"consumedIndicators":{"format":"int32","type":"integer"},"consumedObservables":{"format":"int32","type":"integer"},"consumedUnsupportedObservables":{"format":"int32","type":"integer"},"delivery":{"type":"string"},"description":{"type":"string"},"discardedIndicators":{"format":"int32","type":"integer"},"discoveryInfo":{"items":{"type":"object","properties":{"collectionAddress":{"type":"string"},"collectionContentBinding":{"type":"string"},"collectionDescription":{"type":"string"},"collectionMessageBinding":{"type":"string"},"collectionName":{"type":"string"},"collectionPollIntervalInMinutes":{"format":"int32","type":"integer"},"collectionProtocolBinding":{"type":"string"},"collectionSubType":{"type":"string"},"llcollectionTopic":{"type":"object","properties":{"address":{"type":"string"},"contentBindings":{"type":"string"},"description":{"type":"string"},"hashMap":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLHashMap"},"messageBinding":{"type":"string"},"name":{"type":"string"},"pollIntervalInMinutes":{"format":"int32","type":"integer"},"protocolBinding":{"type":"string"},"subType":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/LLCollectionTopic"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/RESTCollectionTopic"},"type":"array"},"downloadOn":{"type":"boolean"},"feedConfig":{"type":"object","properties":{"availableCollections":{"items":{"type":"object","properties":{"address":{"type":"string"},"contentBindings":{"type":"string"},"description":{"type":"string"},"hashMap":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLHashMap"},"messageBinding":{"type":"string"},"name":{"type":"string"},"pollIntervalInMinutes":{"format":"int32","type":"integer"},"protocolBinding":{"type":"string"},"subType":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/LLCollectionTopic"},"type":"array"},"caCert":{"type":"string"},"checksum":{"type":"string"},"clientCert":{"type":"string"},"clientPrivateKey":{"type":"string"},"consumedIndicators":{"format":"int32","type":"integer"},"consumedObservables":{"format":"int32","type":"integer"},"consumedUnsupportedObservables":{"format":"int32","type":"integer"},"delivery":{"type":"string"},"description":{"type":"string"},"discardedIndicators":{"format":"int32","type":"integer"},"discardedObservables":{"format":"int32","type":"integer"},"discoveryInfo":{"items":{"type":"object","properties":{"address":{"type":"string"},"contentBindings":{"type":"string"},"description":{"type":"string"},"hashMap":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLHashMap"},"messageBinding":{"type":"string"},"name":{"type":"string"},"pollIntervalInMinutes":{"format":"int32","type":"integer"},"protocolBinding":{"type":"string"},"subType":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/LLCollectionTopic"},"type":"array"},"downloadOn":{"type":"boolean"},"feedContent":{"type":"string"},"feedStatus":{"type":"string"},"feedType":{"type":"string"},"finishTime":{"format":"int32","type":"integer"},"id":{"type":"string"},"inRunningState":{"type":"boolean"},"lastRun":{"format":"int32","type":"integer"},"name":{"type":"string"},"nextRun":{"format":"int32","type":"integer"},"params":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLParams"},"passwd":{"type":"string"},"passwdAsIs":{"type":"string"},"password":{"type":"string"},"property":{"type":"object","properties":{"action":{"type":"string"},"allowlist":{"type":"boolean"},"expirationTime":{"format":"int32","type":"integer"},"publish":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLTags"},"ttl":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/LLFeedProperty"},"proxyURL":{"type":"string"},"recurring":{"type":"boolean"},"refresh":{"format":"int32","type":"integer"},"refreshMin":{"format":"int32","type":"integer"},"refreshSec":{"format":"int32","type":"integer"},"runNow":{"type":"boolean"},"safeToDelete":{"type":"boolean"},"safeToUpdate":{"type":"boolean"},"startHour":{"format":"int32","type":"integer"},"statusMsg":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLAdditionalProperties"},"$$ref":"#/components/schemas/LLStatusMsg"},"subscribedCollections":{"items":{"type":"object","properties":{"address":{"type":"string"},"contentBindings":{"type":"string"},"description":{"type":"string"},"hashMap":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLHashMap"},"messageBinding":{"type":"string"},"name":{"type":"string"},"pollIntervalInMinutes":{"format":"int32","type":"integer"},"protocolBinding":{"type":"string"},"subType":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/LLCollectionTopic"},"type":"array"},"totalConsumedIndicators":{"format":"int32","type":"integer"},"totalConsumedObservables":{"format":"int32","type":"integer"},"totalDiscardedIndicators":{"format":"int32","type":"integer"},"totalDiscardedObservables":{"format":"int32","type":"integer"},"totalIndicators":{"format":"int32","type":"integer"},"totalObservables":{"format":"int32","type":"integer"},"totalUnsupportedObservables":{"format":"int32","type":"integer"},"totalUpdatedIndicators":{"format":"int32","type":"integer"},"totalUpdatedObservables":{"format":"int32","type":"integer"},"type":{"type":"string"},"updatedIndicators":{"format":"int32","type":"integer"},"updatedObservables":{"format":"int32","type":"integer"},"uri":{"type":"string"},"username":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/LLFeedConfig"},"feedContent":{"type":"string"},"feedStatus":{"type":"string"},"feedType":{"type":"string"},"finishTime":{"format":"int32","type":"integer"},"id":{"type":"string"},"invalidObservables":{"format":"int32","type":"integer"},"lastRun":{"format":"int32","type":"integer"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"llfeedConfig":{"type":"object","properties":{"availableCollections":{"items":{"type":"object","properties":{"address":{"type":"string"},"contentBindings":{"type":"string"},"description":{"type":"string"},"hashMap":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLHashMap"},"messageBinding":{"type":"string"},"name":{"type":"string"},"pollIntervalInMinutes":{"format":"int32","type":"integer"},"protocolBinding":{"type":"string"},"subType":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/LLCollectionTopic"},"type":"array"},"caCert":{"type":"string"},"checksum":{"type":"string"},"clientCert":{"type":"string"},"clientPrivateKey":{"type":"string"},"consumedIndicators":{"format":"int32","type":"integer"},"consumedObservables":{"format":"int32","type":"integer"},"consumedUnsupportedObservables":{"format":"int32","type":"integer"},"delivery":{"type":"string"},"description":{"type":"string"},"discardedIndicators":{"format":"int32","type":"integer"},"discardedObservables":{"format":"int32","type":"integer"},"discoveryInfo":{"items":{"type":"object","properties":{"address":{"type":"string"},"contentBindings":{"type":"string"},"description":{"type":"string"},"hashMap":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLHashMap"},"messageBinding":{"type":"string"},"name":{"type":"string"},"pollIntervalInMinutes":{"format":"int32","type":"integer"},"protocolBinding":{"type":"string"},"subType":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/LLCollectionTopic"},"type":"array"},"downloadOn":{"type":"boolean"},"feedContent":{"type":"string"},"feedStatus":{"type":"string"},"feedType":{"type":"string"},"finishTime":{"format":"int32","type":"integer"},"id":{"type":"string"},"inRunningState":{"type":"boolean"},"lastRun":{"format":"int32","type":"integer"},"name":{"type":"string"},"nextRun":{"format":"int32","type":"integer"},"params":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLParams"},"passwd":{"type":"string"},"passwdAsIs":{"type":"string"},"password":{"type":"string"},"property":{"type":"object","properties":{"action":{"type":"string"},"allowlist":{"type":"boolean"},"expirationTime":{"format":"int32","type":"integer"},"publish":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLTags"},"ttl":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/LLFeedProperty"},"proxyURL":{"type":"string"},"recurring":{"type":"boolean"},"refresh":{"format":"int32","type":"integer"},"refreshMin":{"format":"int32","type":"integer"},"refreshSec":{"format":"int32","type":"integer"},"runNow":{"type":"boolean"},"safeToDelete":{"type":"boolean"},"safeToUpdate":{"type":"boolean"},"startHour":{"format":"int32","type":"integer"},"statusMsg":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLAdditionalProperties"},"$$ref":"#/components/schemas/LLStatusMsg"},"subscribedCollections":{"items":{"type":"object","properties":{"address":{"type":"string"},"contentBindings":{"type":"string"},"description":{"type":"string"},"hashMap":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLHashMap"},"messageBinding":{"type":"string"},"name":{"type":"string"},"pollIntervalInMinutes":{"format":"int32","type":"integer"},"protocolBinding":{"type":"string"},"subType":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/LLCollectionTopic"},"type":"array"},"totalConsumedIndicators":{"format":"int32","type":"integer"},"totalConsumedObservables":{"format":"int32","type":"integer"},"totalDiscardedIndicators":{"format":"int32","type":"integer"},"totalDiscardedObservables":{"format":"int32","type":"integer"},"totalIndicators":{"format":"int32","type":"integer"},"totalObservables":{"format":"int32","type":"integer"},"totalUnsupportedObservables":{"format":"int32","type":"integer"},"totalUpdatedIndicators":{"format":"int32","type":"integer"},"totalUpdatedObservables":{"format":"int32","type":"integer"},"type":{"type":"string"},"updatedIndicators":{"format":"int32","type":"integer"},"updatedObservables":{"format":"int32","type":"integer"},"uri":{"type":"string"},"username":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/LLFeedConfig"},"metadata":{"type":"object","properties":{"domain":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMetadata"},"name":{"type":"string"},"nextRun":{"format":"int32","type":"integer"},"params":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLParams"},"passwd":{"type":"string"},"property":{"type":"object","properties":{"action":{"type":"string"},"allowlist":{"type":"boolean"},"expirationTime":{"format":"int32","type":"integer"},"llfeedProperty":{"type":"object","properties":{"action":{"type":"string"},"allowlist":{"type":"boolean"},"expirationTime":{"format":"int32","type":"integer"},"publish":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLTags"},"ttl":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/LLFeedProperty"},"publish":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLTags"},"ttl":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/RESTFeedProperty"},"refresh":{"format":"int32","type":"integer"},"runNow":{"type":"boolean"},"startHour":{"format":"int32","type":"integer"},"statusMsg":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLAdditionalProperties"},"$$ref":"#/components/schemas/LLStatusMsg"},"subscribedCollections":{"items":{"type":"object","properties":{"collectionAddress":{"type":"string"},"collectionContentBinding":{"type":"string"},"collectionDescription":{"type":"string"},"collectionMessageBinding":{"type":"string"},"collectionName":{"type":"string"},"collectionPollIntervalInMinutes":{"format":"int32","type":"integer"},"collectionProtocolBinding":{"type":"string"},"collectionSubType":{"type":"string"},"llcollectionTopic":{"type":"object","properties":{"address":{"type":"string"},"contentBindings":{"type":"string"},"description":{"type":"string"},"hashMap":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLHashMap"},"messageBinding":{"type":"string"},"name":{"type":"string"},"pollIntervalInMinutes":{"format":"int32","type":"integer"},"protocolBinding":{"type":"string"},"subType":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/LLCollectionTopic"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/RESTCollectionTopic"},"type":"array"},"totalDiscardedIndicators":{"format":"int32","type":"integer"},"totalIndicators":{"format":"int32","type":"integer"},"totalInvalidObservables":{"format":"int32","type":"integer"},"totalObservables":{"format":"int32","type":"integer"},"totalUnsupportedObservables":{"format":"int32","type":"integer"},"type":{"type":"string"},"uri":{"type":"string"},"username":{"type":"string"},"version":{"type":"string"}},"type":"object","title":"RESTTidSource"}}