IDevice_2 - 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":{"accessPolicy":{"type":"object","properties":{"description":{"type":"string"},"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"},"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"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/IPolicyModel"},"actions":{"items":{"type":"object","properties":{"actionInfo":{"type":"object","$$ref":"#/components/schemas/IActionInfo"},"actionType":{"enum":["APPLY_TEMPLATE"],"type":"string"}},"$$ref":"#/components/schemas/IPreDeployAction"},"type":"array"},"advanced":{"type":"object","properties":{"enableOGS":{"type":"boolean"}},"$$ref":"#/components/schemas/IAdvanced"},"analyticsOnly":{"type":"boolean"},"changeManager":{"type":"boolean"},"cloudDeviceId":{"type":"string"},"deploymentStatus":{"type":"string"},"description":{"type":"string"},"deviceGroup":{"type":"object","properties":{"description":{"type":"string"},"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"},"members":{"items":{"type":"object","properties":{"accessPolicy":{"type":"object","properties":{"description":{"type":"string"},"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"},"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"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/IPolicyModel"},"advanced":{"type":"object","properties":{"enableOGS":{"type":"boolean"}},"$$ref":"#/components/schemas/IAdvanced"},"description":{"type":"string"},"healthMessage":{"type":"string"},"healthPolicy":{"type":"object","description":"Description of Health Policy.","properties":{"basePolicyID":{"type":"string"},"defaultPolicy":{"type":"boolean"},"description":{"description":"Description of Health Policy.","type":"string"},"healthModules":{"items":{"type":"object","properties":{"alertConfig":{"items":{"type":"object","properties":{"enabled":{"type":"boolean"},"name":{"type":"string"},"thresholds":{"items":{"type":"object","properties":{"type":{"type":"string"},"value":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/HealthThreshold"},"type":"array"}},"$$ref":"#/components/schemas/HealthAlertConfig"},"type":"array"},"alertEnabled":{"type":"boolean"},"criticalThreshold":{"format":"int32","type":"integer"},"customThresholds":{"items":{"type":"object","properties":{"type":{"type":"string"},"value":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/HealthThreshold"},"type":"array"},"enabled":{"type":"boolean"},"moduleId":{"type":"string"},"severity":{"type":"string"},"type":{"type":"string"},"warningThreshold":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/HealthModule"},"type":"array"},"id":{"description":"Unique identifier (UUID) representing the Health policy.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","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"},"metadata":{"description":"Object representing metadata attributes for the Health policy.","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":{"description":"User-specified name of the Health policy.","type":"string"},"policyType":{"type":"string"},"setting":{"type":"object","properties":{"alertEvaluationInterval":{"format":"int32","type":"integer"},"certFileContent":{"type":"string"},"certFileName":{"type":"string"},"certFileType":{"type":"string"},"certPassphrase":{"type":"string"},"configType":{"type":"string"},"dataCollectionInterval":{"format":"int32","type":"integer"},"dialInHosts":{"items":{"type":"object","properties":{"host":{"type":"string"},"port":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/DialHost"},"type":"array"},"dialOutHosts":{"items":{"type":"object","properties":{"host":{"type":"string"},"port":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/DialHost"},"type":"array"},"enabledOpenConfig":{"type":"boolean"},"grpcPassword":{"type":"string"},"grpcUsername":{"type":"string"},"readOnly":{"type":"boolean"}},"$$ref":"#/components/schemas/HealthSetting"},"type":{"description":"Type of the Health policy; this value is always HealthPolicy.","type":"string"},"version":{"description":"Version number of the response object.","type":"string"}},"$$ref":"#/components/schemas/IHealthPolicy"},"healthStatus":{"type":"string"},"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"},"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"},"model":{"type":"string"},"modelId":{"type":"string"},"modelNumber":{"type":"string"},"modelType":{"type":"string"},"name":{"type":"string"},"role":{"type":"string"},"status":{"type":"string"},"sw_version":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/IBaseDevice"},"type":"array"},"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"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/IDeviceGroup"},"ftdMode":{"enum":["ROUTED","TRANSPARENT"],"type":"string"},"healthMessage":{"type":"string"},"healthPolicy":{"type":"object","description":"Description of Health Policy.","properties":{"basePolicyID":{"type":"string"},"defaultPolicy":{"type":"boolean"},"description":{"description":"Description of Health Policy.","type":"string"},"healthModules":{"items":{"type":"object","properties":{"alertConfig":{"items":{"type":"object","properties":{"enabled":{"type":"boolean"},"name":{"type":"string"},"thresholds":{"items":{"type":"object","properties":{"type":{"type":"string"},"value":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/HealthThreshold"},"type":"array"}},"$$ref":"#/components/schemas/HealthAlertConfig"},"type":"array"},"alertEnabled":{"type":"boolean"},"criticalThreshold":{"format":"int32","type":"integer"},"customThresholds":{"items":{"type":"object","properties":{"type":{"type":"string"},"value":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/HealthThreshold"},"type":"array"},"enabled":{"type":"boolean"},"moduleId":{"type":"string"},"severity":{"type":"string"},"type":{"type":"string"},"warningThreshold":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/HealthModule"},"type":"array"},"id":{"description":"Unique identifier (UUID) representing the Health policy.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","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"},"metadata":{"description":"Object representing metadata attributes for the Health policy.","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":{"description":"User-specified name of the Health policy.","type":"string"},"policyType":{"type":"string"},"setting":{"type":"object","properties":{"alertEvaluationInterval":{"format":"int32","type":"integer"},"certFileContent":{"type":"string"},"certFileName":{"type":"string"},"certFileType":{"type":"string"},"certPassphrase":{"type":"string"},"configType":{"type":"string"},"dataCollectionInterval":{"format":"int32","type":"integer"},"dialInHosts":{"items":{"type":"object","properties":{"host":{"type":"string"},"port":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/DialHost"},"type":"array"},"dialOutHosts":{"items":{"type":"object","properties":{"host":{"type":"string"},"port":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/DialHost"},"type":"array"},"enabledOpenConfig":{"type":"boolean"},"grpcPassword":{"type":"string"},"grpcUsername":{"type":"string"},"readOnly":{"type":"boolean"}},"$$ref":"#/components/schemas/HealthSetting"},"type":{"description":"Type of the Health policy; this value is always HealthPolicy.","type":"string"},"version":{"description":"Version number of the response object.","type":"string"}},"$$ref":"#/components/schemas/IHealthPolicy"},"healthStatus":{"type":"string"},"hostName":{"type":"string"},"id":{"type":"string"},"isConnected":{"type":"boolean"},"isMCDManaged":{"type":"boolean"},"keepLocalEvents":{"type":"boolean"},"license_caps":{"items":{"type":"string"},"type":"array"},"licenseType":{"enum":["BYOL","SAAS","PAYG"],"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"},"managementState":{"enum":["MANAGED","UNMANAGED"],"type":"string"},"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"},"model":{"type":"string"},"modelId":{"type":"string"},"modelNumber":{"type":"string"},"modelType":{"type":"string"},"name":{"type":"string"},"natID":{"type":"string"},"performanceTier":{"type":"string"},"prohibitPacketTransfer":{"type":"boolean"},"regKey":{"type":"string"},"role":{"type":"string"},"secondaryHostname":{"type":"string"},"serialNumber":{"type":"string"},"skipDeployment":{"type":"boolean"},"snortEngine":{"enum":["SNORT2","SNORT3"],"type":"string"},"status":{"type":"string"},"sw_version":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"required":["hostName","license_caps","regKey"],"type":"object","title":"IDevice_2"}}