Get Device - Security Cloud Control Firewall Manager API Documentation - Cisco DevNet

{"type":"api","title":"Get Device","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":{"deprecated":false,"description":"**Get the device record associated with the specified ID.**","operationId":"getDevice","parameters":[{"description":"Identifier for device.","in":"path","name":"objectId","required":true,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : GET /fmc_config/v1/domain/DomainUUID/devices/devicerecords/device_uuid ( Test GET of device for a uuid )":{"value":{"hostName":"\u003chost name\u003e","id":"device_uuid","license_caps":["PROTECT","MALWARE"],"metadata":{"containerDetails":{"id":"container_uuid","name":"cotainer_name","type":"DeviceHAPair | DeviceStack | DeviceCluster"},"deviceSerialNumber":"string","domain":"object","isPartOfContainer":true,"readOnly":"object","snortEngine":"SNORT2 | SNORT3","snortVersion":"string","sruVersion":"string","task":"object","vdbVersion":"string"},"name":"nachos","performanceTier":"FTDv50","type":"Device"}}},"schema":{"type":"object","description":"A model representing a Device.","properties":{"accessPolicy":{"description":"Object representing the currently assigned access control policy. You need to specify an existing access control policy when registering a device.","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":{"description":"Object representing Device Advanced Configuration.","type":"object","properties":{"enableOGS":{"type":"boolean"}},"$$ref":"#/components/schemas/IAdvanced"},"analyticsOnly":{"description":"Boolean representing whether to register the device only for analytics/events.","type":"boolean"},"changeManager":{"type":"boolean"},"cloudDeviceId":{"type":"string"},"deploymentStatus":{"description":"Device deployment status","type":"string"},"description":{"description":"User-specified description of the registered device.","type":"string"},"deviceGroup":{"description":"Object representing the device group.","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":{"description":"FTD mode (Example: ROUTED or TRANSPARENT)","enum":["ROUTED","TRANSPARENT"],"type":"string"},"healthMessage":{"description":"Current health description of the device","type":"string"},"healthPolicy":{"description":"Object representing the system health policy applied to the registered device.","type":"object","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":{"description":"Current health status of the device.","type":"string"},"hostName":{"description":"Hostname or IP address of the device. If the device is behind NAT, you can leave the host name as blank, and enter the NAT_ID string in the 'Unique NAT ID' text box. Use the same NAT_ID string that you used while configuring FMC on the device.","type":"string"},"id":{"description":"Unique identifier (UUID) representing the registered device.","type":"string"},"isAWSDevice":{"type":"boolean"},"isAzureDevice":{"type":"boolean"},"isConnected":{"description":"Device connection status","type":"boolean"},"isMCDManaged":{"description":"Boolean indicating whether the device is managed by MCD Controller. Only applicable for cdFMC.","type":"boolean"},"keepLocalEvents":{"description":"Boolean indicating whether local events are recorded and kept on the device.","type":"boolean"},"license_caps":{"description":"Array of strings representing the license capabilities on the managed device. For registering FTD, the allowed values are: ESSENTIALS (mandatory), IPS, URL, MALWARE_DEFENSE, CARRIER, SECURE_CLIENT_PREMIER, SECURE_CLIENT_PREMIER_ADVANTAGE, SECURE_CLIENT_VPNOnly. For Firepower ASA or NGIPSv devices, allowed values are: BASE, THREAT, PROTECT, CONTROL, URLFilter, MALWARE, VPN, SSL. ","items":{"type":"string"},"type":"array"},"licenseType":{"description":"License types for devices controlled externally (MCD).","enum":["BYOL","SAAS","PAYG"],"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"},"managementState":{"description":"Device management status.","enum":["MANAGED","UNMANAGED"],"type":"string"},"metadata":{"description":"Object representing metadata attributes of the Device.","type":"object","properties":{"chassisData":{"description":"This field holds information related to chassis.","type":"object","properties":{"chassisSerialNo":{"type":"string"},"chassisUrl":{"type":"string"},"securityModuleNo":{"format":"int32","type":"integer"},"securityModuleSN":{"type":"string"}},"$$ref":"#/components/schemas/DeviceChassisData"},"chassisDetails":{"type":"object","properties":{"chassisSerialNo":{"type":"string"},"chassisUrl":{"type":"string"},"securityModuleNo":{"format":"int32","type":"integer"},"securityModuleSN":{"type":"string"}},"$$ref":"#/components/schemas/IDeviceChassisData"},"clusterBootstrapSupported":{"type":"boolean"},"containerDetails":{"description":"If 'isPartOfContainer' field is true then this field will hold the information of container.","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"},"coreProfile":{"type":"string"},"deviceSerialNumber":{"type":"string"},"domain":{"description":"Lists the domains to which this instance belongs if applicable.","type":"object","properties":{"id":{"description":"Unique UUID of this domain","type":"string"},"links":{"description":"Links to the domain resource URLs.","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"},"name":{"description":"Name of the domain.","type":"string"},"type":{"description":"Domain type definition (fixed).","type":"string"},"uuid":{"type":"string"}},"$$ref":"#/components/schemas/Domain"},"dummyDevice":{"type":"boolean"},"inventoryData":{"description":"Inventory details of the device.","type":"object","properties":{"cpuCores":{"type":"string"},"cpuType":{"type":"string"},"memoryInMB":{"type":"string"},"storageInGB":{"type":"string"}},"$$ref":"#/components/schemas/DeviceInventoryData"},"inventoryDetails":{"type":"object","properties":{"cpuCores":{"type":"string"},"cpuType":{"type":"string"},"memoryInMB":{"type":"string"},"storageInGB":{"type":"string"}},"$$ref":"#/components/schemas/IDeviceInventoryData"},"isDummyDevice":{"type":"boolean"},"isLocked":{"type":"boolean"},"isMultiInstance":{"description":"Indicated if the device is in multiinstance or native mode.","type":"boolean"},"isPartOfContainer":{"description":"This field indicates whether it is part of any cluster. This will be true for a device which is part of NGFWHA, NGFW cluster and firepower devices which is part of Stack.","type":"boolean"},"isSnort3":{"type":"boolean"},"lastUser":{"description":"The last user who modified this instance.","type":"object","properties":{"id":{"description":"The unique UUID of the user","type":"string"},"links":{"description":"Contains the self referencing 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"},"name":{"description":"Name of the user.","type":"string"},"type":{"description":"The user type (fixed).","type":"string"}},"$$ref":"#/components/schemas/MetadataUser"},"lspVersion":{"type":"string"},"matches":{"items":{"type":"string"},"type":"array"},"otherAssociatedPolicies":{"description":"assigned policies to device other than Access Policy","items":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","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"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"type":"array"},"readOnly":{"description":"Details regarding the read only status of this instance.","type":"object","properties":{"reason":{"description":"Reason the resource is read only - SYSTEM (if it is system defined), RBAC (if user RBAC permissions make it read only) or DOMAIN (if resource is read only in current domain).","enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"description":"True if this resource us read only and false otherwise.","type":"boolean"}},"$$ref":"#/components/schemas/ReadOnly"},"snortVersion":{"description":"Snort version of a particular device.","type":"string"},"sruVersion":{"description":"SRU version of a particular device.","type":"string"},"task":{"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"},"message":{"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"},"name":{"type":"string"},"status":{"type":"string"},"subTasks":{"items":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"message":{"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"},"status":{"type":"string"},"target":{"type":"object","description":"This is the target device.","properties":{"description":{"type":"string"},"id":{"description":"Unique ID of the device.","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":{"description":"Name of the device.","type":"string"},"type":{"description":"Device","type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/ITarget"}},"$$ref":"#/components/schemas/ISubTask"},"type":"array"},"taskType":{"enum":["DEVICE_REGISTRATION","SMART_LICENSE","DEVICE_DEPLOYMENT","DEVICE_ROLLBACK","NGFWHA_OPERATIONS","COPY_CONFIG_REQUEST","HIT_COUNT_REFRESH","FTD_CLUSTER_BOOTSTRAP","FTD_CLUSTER_CREATE","FTD_CLUSTER_BREAK","FTD_CLUSTER_ADD_NODES","FTD_CLUSTER_REMOVE_NODES","DEVICE_BACKUP","FTD_CLUSTER_UPDATE_BOOTSTRAP","FTD_CLUSTER_COMMAND","SSP_EPM_OIR","SSP_EPM_BREAKOUT_DEPLOY","DEVICE_EXPORT","DEVICE_IMPORT","POLICY_EXPORT","CHASSIS_REGISTRATION","CHANGE_MANAGER","CONFIGURE_DEVICE_VALIDATE","CONFIGURE_DEVICE","CONFIGURE_MANAGER","CONFIGURE_MANAGER_ADD","CONFIGURE_MANAGER_DELETE","INITIATE_MIGRATION","DISCARD_MIGRATION","SWITCH_TO_ANALYTICS","DELETE_DEVICE","GENERATE_REPORTS","FLEXCONFIG_MIGRATION","DEVICE_UNREGISTRATION","PENDING_CHANGES_REQUEST","DEVICE_TROUBLESHOOT","DEVICE_MODEL_MIGRATION","DEVICE_TEMPLATE_CREATION","CHASSIS_CONVERSION_REQUEST","SNORT_PROFILER","CPU_PROFILER","POLICY_REPORT_GENERATION","DEVICE_TEMPLATE_APPLY","LTP_ONBOARDING","POLICY_CLONE_OPERATION","DEVICE_CERTIFICATE_MANAGEMENT","OOB_CHANGES_REQUEST","UPLOAD_TROUBLESHOOT","EXECUTE_BULK_COMMANDS","FA_TELEMETRY_DATA_GENERATION"],"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/ITaskStatus"},"timestamp":{"description":"The last updated timestamp.","format":"int32","type":"integer"},"universalZeroTrustSetting":{"type":"object","additionalProperties":{"type":"object","properties":{"autoDeployEnabled":{"type":"boolean"},"domainSettings":{"items":{"type":"object","properties":{"FQDN":{"type":"string"},"certificate":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","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"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"interfaces":{"items":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","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"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"type":"array"}},"$$ref":"#/components/schemas/IHybridZeroTrustFQDNConfig"},"type":"array"},"universalZeroTrustEnabled":{"type":"boolean"}},"$$ref":"#/components/schemas/IHybridZeroTrustDeviceSetting"},"$$ref":"#/components/schemas/LLUniversalZeroTrustSetting"},"universalZeroTrustSupported":{"type":"boolean"},"vdbVersion":{"description":"VDB version of a particular device.","type":"string"}},"required":["otherAssociatedPolicies"],"$$ref":"#/components/schemas/DeviceMetadata"},"model":{"description":"Model name of the registered device.","type":"string"},"modelId":{"description":"Model ID of the registered device.","type":"string"},"modelNumber":{"description":"Model number of the registered device.","type":"string"},"modelType":{"description":"Model type of the registered device.","type":"string"},"name":{"description":"User-specified name of the registered device. (Example: Device 01 - 192.168.0.152.)","type":"string"},"natID":{"description":"Unique ID for a Network address translation (NAT) device (optional; used for device registration). If the device to be registered and the Firepower Management Center are separated by a NAT device, enter a unique NAT ID.","type":"string"},"performanceTier":{"description":"Performance tier for the managed device ( applicable only for vFTD's from 6.8.0 with possible values FTDv5 | FTDv10 | FTDv20 | FTDv30 | FTDv50 | Legacy ).","type":"string"},"prohibitPacketTransfer":{"description":"Boolean indicating whether to prohibit the registered device from sending packet data with events to the Firepower Management Center (true) or to allow transfer (false). If this field is set to false (the default), the device transfers packets when a certain event is triggered. Not all traffic data is sent; connection events do not include a payload, only connection metadata.","type":"boolean"},"regKey":{"description":"Registration Key that you entered while configuring FMC on the device.","type":"string"},"role":{"description":"device role in case of container(HA, Cluster). (Example: Primary/Control ","type":"string"},"secondaryHostname":{"description":"Secondary hostname or IP address of the device (Applicable only from 7.3.0 onwards).","type":"string"},"serialNumber":{"type":"string"},"skipDeployment":{"description":"Boolean representing whether to skip initial deployment during registration of a device.","type":"boolean"},"snortEngine":{"enum":["SNORT2","SNORT3"],"type":"string"},"status":{"description":"device status in case of container(HA, Cluster). (Example: Active/Standby) ","type":"string"},"sw_version":{"description":"Device version","type":"string"},"type":{"description":"Type of the device; this value is always Device.","type":"string"},"version":{"description":"Version number of the response object.","type":"string"}},"required":["hostName","license_caps","regKey"],"$$ref":"#/components/schemas/Device"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Devices"],"__originalOperationId":"getDevice","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{objectId}"}}