Get Device - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get Device","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/24eb19cd1b39c04dd059253315ca187eaa01947f/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control Firewall Manager API","version":"1.13.0","description":"Use the documentation to explore the endpoints Security Cloud Control Firewall Manager has to offer","contact":{"name":"Cisco Security Cloud Control TAC","email":"cdo.tac@cisco.com"}},"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":{"description":"Get a device by UID in the Security Cloud Control tenant","operationId":"getDevice","parameters":[{"description":"The unique identifier, represented as a UUID, of the device in Security Cloud Control.","in":"path","name":"deviceUid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"address":{"description":"The address of the device, in `host:port` format. Security Cloud Control connects to the device at this address.","example":"my-example-device.example.com:443","type":"string"},"asaFailoverMate":{"description":"(High Availability ASAs only) Information on the failover mate of this device.","properties":{"chassisSerial":{"description":"(High Availability ASAs only) The serial number of the chassis.","example":"FTX20131xxx","type":"string"},"failoverState":{"description":"(High Availability ASAs only) Failover state of this device.","example":"Primary - Active","type":"string"},"serial":{"description":"(High Availability ASAs only) The serial number of the device. This is typically used for licensing, and is not the same as the chassis' serial number.","example":"JAD24500xxx","type":"string"},"softwareVersion":{"description":"(High Availability ASAs only) The version of the software running on the device.","example":"9.18.8","type":"string"}},"type":"object","$$ref":"#/components/schemas/AsaFailoverMate"},"asaFailoverMode":{"description":"(ASAs only) Failover mode of the device.","example":"ACTIVE_STANDBY","enum":["OFF","ACTIVE_STANDBY","ACTIVE_ACTIVE"],"type":"string","$$ref":"#/components/schemas/AsaFailoverMode"},"asaFailoverState":{"description":"(High Availability ASAs only) Failover state of this device.","example":"Primary - Active","type":"string"},"asaLicenseEntitlements":{"additionalProperties":{"type":"string"},"description":"(ASAs only) Map of ASA License entitlements.","type":"object"},"asdmVersion":{"description":"(ASAs only) Version of the ASDM device manager running on the device.","example":"7.6(2)","type":"string"},"cdFmcInfo":{"description":"(FTDs managed by cdFMC only) Information on the cloud-delivered FMC managing this FTD. This information is not available for FTDs managed using FDM or on-prem FMCs.","properties":{"cliKey":{"description":"The CLI key to paste into the FTD CLI to register the FTD with a cdFMC. You need to paste this value in only once, when the FTD is being onboarded. Refer to the [Security Cloud Control Documentation](https://www.cisco.com/c/en/us/td/docs/security/cdo/cloud-delivered-firewall-management-center-in-cdo/managing-firewall-threat-defense-services-with-cisco-defense-orchestrator/m-onboard-for-ftd-management.html) for details.","example":"configure manager add acme.app.us.cdo.cisco.com E2jsyiZggyeCfFfCUaMK2kD1a1bxxx 5Do6FwUaXY4EFlyraC2yVnxodLxhuxxx acme.app.us.cdo.cisco.com","type":"string"},"link":{"description":"The endpoint to access this resource from.","example":"https://us.manage.security.cisco.com/api/rest/v1/inventory/managers/7e9789b4-8389-4029-933f-ec7e385335ef","type":"string"},"natId":{"description":"The Registration Key of this FTD. Refer to the [Security Cloud Control Documentation](https://www.cisco.com/c/en/us/td/docs/security/cdo/cloud-delivered-firewall-management-center-in-cdo/managing-firewall-threat-defense-services-with-cisco-defense-orchestrator/m-onboard-for-ftd-management.html) for details.","example":"5Do6FwUaXY4EFlyraC2yVnxodLxhuxxx","type":"string"},"regKey":{"description":"The Network Address Translation (NAT) ID of this FTD. Refer to the [Security Cloud Control Documentation](https://www.cisco.com/c/en/us/td/docs/security/cdo/cloud-delivered-firewall-management-center-in-cdo/managing-firewall-threat-defense-services-with-cisco-defense-orchestrator/m-onboard-for-ftd-management.html) for details.","example":"E2jsyiZggyeCfFfCUaMK2kD1a1bxxx","type":"string"},"uid":{"description":"The unique identifier, represented as a UUID, of the cdFMC that manages this device.","example":"my-example-fmc","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/CdFmcInfo"},"chassisSerial":{"description":"The serial number on the chassis of the device (ASA-only). This is typically used to type up to Cisco SmartNet, and is not the same as the serial number.","example":"JMX2450Xxxx","type":"string"},"configState":{"description":"The state of the device configuration in CDO. CDO stages configuration changes which have to be manually applied to the device; this field indicates whether the configuration on CDO does not match the configuration on the device, which indicates whether there are changes to be deployed from Security Cloud Control to the device.","example":"SYNCED","enum":["NO_CONFIG","SYNCED","NOT_SYNCED","UNKNOWN"],"type":"string","$$ref":"#/components/schemas/ConfigState"},"conflictDetectionState":{"description":"Indicates whether there have been changes made to the device's configuration outside of Security Cloud Control.","example":"NO_CONFLICTS","enum":["CONFLICT_DETECTED","NO_CONFLICTS"],"type":"string","$$ref":"#/components/schemas/ConflictDetectionState"},"connectivityState":{"description":"The connectivity state of the device to CDO. A connectivity state that is not ONLINE can indicate either a problem with the device, or the communication pathways between the device and Security Cloud Control.","example":"ONLINE","enum":["ONLINE","UNREACHABLE","BAD_CREDENTIALS","UNKNOWN","PENDING_SETUP","PENDING","NEW_CERT_DETECTED"],"type":"string","$$ref":"#/components/schemas/ConnectivityState"},"connectorType":{"description":"The type of the connector that will be used to communicate with the device. Security Cloud Control can communicate with your device using either a Cloud Connector (CDG) or a Secure Device Connector (SDC).","example":"CDG","enum":["SDC","CDG"],"type":"string","$$ref":"#/components/schemas/ConnectorType"},"connectorUid":{"description":"The unique identifier, represented as a UUID, of the Secure Device Connector (SDC) that will be used to communicate with the device. This value is not required if the connector type selected is Cloud Connector (CDG)The name of the Secure Device Connector (SDC) that will be used to communicate with the device. This value is not required if the connector type selected is Cloud Connector (CDG).","example":"3af473a8-d70f-4090-bcdb-853981696478","format":"uuid","type":"string"},"deviceMetadata":{"description":"Metadata for the device. This field contains a combination of structured service-specific metadata persisted by other Cisco services and arbitrary metadata.","properties":{"additional":{"additionalProperties":{"type":"string"},"description":"Additional metadata as a map of key-value pairs.","type":"object"},"secureAccess":{"description":"Structured [Cisco Secure Access](https://www.cisco.com/site/uk/en/products/security/secure-access/index.html) metadata (applicable to UZTNA-enabled FTDs only).","properties":{"commitStatus":{"description":"The deployment status of the Secure Access configuration associated with the device.","enum":["CREATED","VALIDATION_FAILED","QUEUED","IN_PROGRESS","SKIPPED","PARTIALLY_SUCCESSFUL","SUCCESSFULLY_COMPLETED","FAILED","UNKNOWN"],"type":"string"},"numResources":{"description":"The number of private Cisco Secure Access resources associated with the device.","format":"int32","type":"integer"},"numRules":{"description":"The number of Cisco Secure Access rules associated with the device.","format":"int32","type":"integer"}},"type":"object","$$ref":"#/components/schemas/SecureAccessMetadata"}},"type":"object","$$ref":"#/components/schemas/DeviceMetadata"},"deviceRecordOnFmc":{"description":"(FMC-managed FTDs only) The device record in FMC. A FMC-managed device on SCC can also be accessed directly using the FMC APIs; this field provides details.","properties":{"link":{"description":"The endpoint to access this resource from on the FMC.","example":"https://fmc.example.com/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/devicerecords/6131daad-e813-4b8f-8f42-be1e241e8cdb","type":"string"},"uid":{"description":"The unique identifier, represented as a UUID, of the device on the FMC.","example":"6131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/FmcDeviceRecord"},"deviceRole":{"deprecated":true,"description":"The role this device performs on the network.","example":"ASA_RA_VPN_HEADEND","enum":["FTD_RA_VPN_HEADEND","ASA_RA_VPN_HEADEND","MFA_PROVIDER","ZTNA_PROVIDER","ANYCONNECT_VPN_HEAD_END","UNIVERSAL_ZTNA_HEADEND"],"type":"string","$$ref":"#/components/schemas/DeviceRole"},"deviceRoles":{"description":"The roles that this device performs on the network.","example":"ASA_RA_VPN_HEADEND","items":{"enum":["FTD_RA_VPN_HEADEND","ASA_RA_VPN_HEADEND","MFA_PROVIDER","ZTNA_PROVIDER","ANYCONNECT_VPN_HEAD_END","UNIVERSAL_ZTNA_HEADEND"],"type":"string","$$ref":"#/components/schemas/DeviceRole"},"type":"array"},"deviceType":{"description":"The type of the device.","example":"CDFMC_MANAGED_FTD","enum":["ASA","CDFMC_MANAGED_FTD","ONPREM_FMC_MANAGED_FTD","ONPREM_FMC_MANAGED_FIREPOWER","ONPREM_FMC_NGIPS","FDM_MANAGED_FTD","IOS","ISR","SSH_DEVICE","GENERIC_DEVICE","MERAKI_MX","CLOUD_DNG","SFCN","SFCN_DNG","SFCN_STS","ONPREM_FMC","CDFMC","AWS_VPC","AZURE_VNET","DUO_ADMIN_PANEL","UMBRELLA_ORGANIZATION"],"type":"string","$$ref":"#/components/schemas/EntityType"},"fmcAccessPolicy":{"description":"(FMC-managed FTDs only) The FMC Access Policy applied to the device.","example":"6131daad-e813-4b8f-8f42-be1e241e8cdb","properties":{"link":{"description":"The endpoint to access this resource from.","example":"https://us.manage.security.cisco.com/api/rest/v1/cdfmc/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/accesspolicies/0276f012-3875-0ed3-0000-004294981364","type":"string"},"uid":{"description":"The unique identifier, represented as a UUID, of the FMC Access Policy in Security Cloud Control.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/FmcAccessPolicyReference"},"fmcDomainUid":{"description":"(FMC device managers only) The unique identifier, represented as a UUID, of the [FMC domain](https://www.cisco.com/c/en/us/td/docs/security/secure-firewall/management-center/admin/740/management-center-admin-74/system-domains.html).","format":"uuid","type":"string"},"ftdClusterInfo":{"description":"(Device Clusters managed by FMC only) Clustering information. Note: Security Cloud Control represents all of the nodes on an FTD cluster in a single device record with the UID of the cluster control node.","properties":{"clusterName":{"description":"The name of the cluster on the FMC.","type":"string"},"clusterNodeStatus":{"description":"(on-prem FMC-managed FTDs only) Information on the type of this node in the FTD cluster. Note: Each node in an on-prem-FMC-managed FTD cluster is represented as a separate device entry in the API.","enum":["ADDED_OUT_OF_BOX","DISABLED","JOINING","NORMAL","NOT_AVAILABLE","UNKNOWN"],"type":"string"},"clusterNodeType":{"description":"(on-prem FMC-managed FTDs only) Information on the type of this node in the FTD cluster. Note: Each node in an on-prem-FMC-managed FTD cluster is represented as a separate device entry in the API.","enum":["CONTROL","DATA"],"type":"string"},"clusterUid":{"description":"The unique identifier, represented as a UUID, of the cluster, on the FMC","format":"uuid","type":"string"},"controlNode":{"description":"(cdFMC-managed FTDs only) Information on the control node, which is responsible for managing, coordinating, and synchronizing the operations of multiple firewall units within the cluster.","properties":{"serial":{"description":"The serial number of the node on the device. This is typically used for licensing, and is not the same as the chassis' serial number.","example":"JAD24500xxx","type":"string"},"softwareVersion":{"description":"The version of the software running on the device.","example":"7.4.1","type":"string"},"status":{"description":"The status of the cluster node.","enum":["ADDED_OUT_OF_BOX","DISABLED","JOINING","NORMAL","NOT_AVAILABLE","UNKNOWN"],"example":"NORMAL","type":"string"},"uidOnFmc":{"description":"The unique identifier, represented as a UUID, of the device on the FMC.","example":"6131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/ClusterNode"},"dataNodes":{"description":"(cdFMC-managed FTDs only) Information on the data nodes, which are individual units within a cluster that process and forward network traffic based on policies and configurations managed by the control node.","items":{"properties":{"serial":{"description":"The serial number of the node on the device. This is typically used for licensing, and is not the same as the chassis' serial number.","example":"JAD24500xxx","type":"string"},"softwareVersion":{"description":"The version of the software running on the device.","example":"7.4.1","type":"string"},"status":{"description":"The status of the cluster node.","enum":["ADDED_OUT_OF_BOX","DISABLED","JOINING","NORMAL","NOT_AVAILABLE","UNKNOWN"],"example":"NORMAL","type":"string"},"uidOnFmc":{"description":"The unique identifier, represented as a UUID, of the device on the FMC.","example":"6131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/ClusterNode"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/FtdClusterInfo"},"ftdHaInfo":{"description":"(High Availability Devices managed by FMC only) High-Available information information. Note: Security Cloud Control represents all of the nodes on an FTD cluster in a single device record with the UID of the cluster control node.","properties":{"currentRole":{"description":"(on-prem FMC-managed FTDs only) Information on the current role of the node in the HA Pair. Note: Each node in an on-prem-FMC-managed FTD HA Pair is represented as a separate device entry in the API response.","enum":["ACTIVE","STANDBY"],"type":"string"},"haNodeType":{"description":"(on-prem FMC-managed FTDs only) Information on the type of this node in the HA Pair. Note: Each node in an on-prem-FMC-managed FTD HA Pair is represented as a separate device entry in the API response.","enum":["PRIMARY","SECONDARY"],"type":"string"},"haPairName":{"description":"The name of the HA Pair on the FMC.","type":"string"},"haPairUid":{"description":"The unique identifier, represented as a UUID, of the HA Pair, on the FMC","format":"uuid","type":"string"},"primaryNode":{"description":"Information on the primary unit in the FTD HA Pair. Note: for an on-prem FMC managed FTD, this information is available only if the `cdfmc_and_onprem_fmc_enhanced_flow` feature flag is enabled on your tenant.","properties":{"chassisSerial":{"description":"The serial number of the chassis on the device.","example":"FTX20131xxx","type":"string"},"serial":{"description":"The serial number of the node on the device. This is typically used for licensing, and is not the same as the chassis' serial number.","example":"JAD24500xxx","type":"string"},"softwareVersion":{"description":"The version of the software running on the device.","example":"7.4.1","type":"string"},"status":{"description":"The status of the HA node.","enum":["NORMAL","ERROR","WARNING","DISABLED","UNKNOWN"],"example":"NORMAL","type":"string"},"uidOnFmc":{"description":"The unique identifier, represented as a UUID, of the device on the FMC.","example":"6131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/HaNode"},"secondaryNode":{"description":"Information on the secondary unit in the FTD HA Pair. Note: for an on-prem FMC managed FTD, this information is available only if the `cdfmc_and_onprem_fmc_enhanced_flow` feature flag is enabled on your tenant.","properties":{"chassisSerial":{"description":"The serial number of the chassis on the device.","example":"FTX20131xxx","type":"string"},"serial":{"description":"The serial number of the node on the device. This is typically used for licensing, and is not the same as the chassis' serial number.","example":"JAD24500xxx","type":"string"},"softwareVersion":{"description":"The version of the software running on the device.","example":"7.4.1","type":"string"},"status":{"description":"The status of the HA node.","enum":["NORMAL","ERROR","WARNING","DISABLED","UNKNOWN"],"example":"NORMAL","type":"string"},"uidOnFmc":{"description":"The unique identifier, represented as a UUID, of the device on the FMC.","example":"6131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/HaNode"}},"type":"object","$$ref":"#/components/schemas/FtdHaInfo"},"ftdLicenses":{"description":"(FTDs only) List of FTD License entitlements.","items":{"type":"string"},"type":"array"},"ftdPerformanceTier":{"description":"(FTDvs only) The FTDv supports performance-tiered licensing that provides different throughput levels and VPN connection limits based on deployment requirements. This field specifies the performance tier of the FTD.","type":"string"},"hardwareModel":{"description":"(ASAs, FDM-managed FTDs, and FMC-managed FTDs only) The hardware model of the device","type":"string"},"labels":{"description":"The labels associated with the device.","properties":{"groupedLabels":{"additionalProperties":{"items":{"type":"string"},"type":"array","uniqueItems":true},"description":"Groups of labels used to identify/tag Security Cloud Control entities.","example":{"group1":["label-1","label-2"],"group2":["label-1","label-2"]},"type":"object"},"ungroupedLabels":{"description":"Set of free-labels used to identify/tag Security Cloud Control entities.","example":["label-a","label-b","label-c"],"items":{"type":"string"},"type":"array","uniqueItems":true}},"type":"object","$$ref":"#/components/schemas/Labels"},"merakiDeploymentMode":{"description":"(Meraki devices only) The deployment mode of the Meraki device.","example":"ROUTED","enum":["ROUTED","PASSTHROUGH"],"type":"string","$$ref":"#/components/schemas/MerakiDeploymentMode"},"merakiNetwork":{"description":"(Meraki devices only) The [Dashboard Network](https://documentation.meraki.com/General_Administration/Organizations_and_Networks/Creating_and_Deleting_Dashboard_Networks) the device is deployed in.","properties":{"id":{"description":"The unique identifier, represented as a UUID, of the Meraki Dashboard Network.","example":"L_583779101697901532","type":"string"},"name":{"description":"The name of the Meraki Dashboard Network.","example":"meraki-network","type":"string"},"timezone":{"description":"The timezone of the Meraki Dashboard Network.","example":"UTC +0","type":"string"}},"type":"object","$$ref":"#/components/schemas/Network"},"modelNumber":{"description":"The hardware, or virtualized hardware platform, that the device is running on (ASA-only). This field can be missing in the case of a partially onboarded device.","type":"string"},"name":{"description":"The name of the device. Device names are unique in Security Cloud Control.","example":"my-example-device","type":"string"},"notes":{"description":"Free-form notes on the device.","example":"This is an example note on the device.","type":"string"},"onPremFmcInfo":{"description":"(Devices managed by on-prem FMC only) Information on the on-prem FMC managing this device.","properties":{"link":{"description":"The endpoint to access this resource from.","example":"https://us.manage.security.cisco.com/api/rest/v1/inventory/managers/7e9789b4-8389-4029-933f-ec7e385335ef","type":"string"},"location":{"description":"The fully-qualified domain name or IP address of the on-prem FMC managing this device.","example":"my-example-fmc.example.com","type":"string"},"uid":{"description":"The unique identifier, represented as a UUID, of the on-prem FMC that manages this device.","example":"7e9789b4-8389-4029-933f-ec7e385335ef","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/OnPremFmcInfo"},"optedInToAsaHealthMetrics":{"description":"Indicates whether the device has been opted in to collect ASA health metrics (SDC-managed ASAs only).","example":true,"type":"boolean"},"redundancyMode":{"description":"The redundancy mode this firewall is running in. Note: for High Availability pairs and clusters, Security Cloud Control represents all of the devices as part of one record.","enum":["HA","CLUSTER","STANDALONE"],"type":"string"},"serial":{"description":"The serial number of the device. This is typically used for licensing, and is not the same as the chassis' serial number.","example":"JAD24500xxx","type":"string"},"snortVersion":{"description":"(FTDs only) List of FTD License entitlements.","type":"string"},"softwareVersion":{"description":"The version of the software running on the device.","example":"7.4.1","type":"string"},"sseDeviceData":{"description":"SSX related info for the registered device","properties":{"sseDeviceId":{"type":"string"},"sseProtocolVersion":{"enum":["ONE","TWO"],"type":"string"}},"type":"object","$$ref":"#/components/schemas/SseDeviceData"},"state":{"description":"The device state.","type":"string"},"stateMachineDetails":{"deprecated":true,"description":"The device state machine details.","properties":{"identifier":{"type":"string"},"lastError":{"properties":{"actionIdentifier":{"type":"string"},"errorCode":{"type":"string"},"errorMessage":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/StateMachineError"}},"type":"object","$$ref":"#/components/schemas/StateMachineDetails"},"uid":{"description":"The unique identifier, represented as a UUID, of the device in Security Cloud Control.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"uidOnFmc":{"deprecated":true,"description":"(FMC-managed FTDs only) The unique identifier, represented as a UUID, of the device on a cdFMC. This field is deprecated. Please see `deviceRecordOnFmc`.","example":"6131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"universalZtnaSettings":{"description":"(FMC-managed FTDs only) Universal Zero-Trust Network Access (ZTNA) configuration.","properties":{"deployed":{"description":"Indicates that the settings have been successfully configured and deployed.","properties":{"autoDeployEnabled":{"description":"Specifies whether changes to ZTNA settings are automatically deployed to the device. Note: This applies only to ZTNA-specific changes and does not affect the deployment of other pending changes.","example":false,"type":"boolean"},"domainSettings":{"description":"Configuration that defines how Secure Client communicates with the device.","items":{"properties":{"certificate":{"description":"Reference to the Public Key Infrastructure (PKI) certificate object on the FMC. This certificate is used to authenticate communication between the Secure Client and the device.","properties":{"link":{"description":"The endpoint to access this resource from.","example":"https://us.manage.security.cisco.com/api/rest/v1/cdfmc/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/networks/0276f012-3875-0ed3-0000-004294981364","type":"string"},"name":{"description":"The name of the FMC Object.","type":"string"},"type":{"description":"The type of the FMC Object.","example":"PhysicalInterface","type":"string"},"uid":{"description":"The unique identifier, represented as a UUID, of the FMC Object.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/FmcObjectReference"},"fqdn":{"description":"The fully qualified domain name (FQDN) of the device. Secure Client uses this to communicate with the device.","example":"myftd.cisco.com","type":"string"},"interfaces":{"description":"List of references to interface objects on the FMC, which defines the interfaces on the device that are used for ZTNA.","items":{"properties":{"link":{"description":"The endpoint to access this resource from.","example":"https://us.manage.security.cisco.com/api/rest/v1/cdfmc/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/networks/0276f012-3875-0ed3-0000-004294981364","type":"string"},"name":{"description":"The name of the FMC Object.","type":"string"},"type":{"description":"The type of the FMC Object.","example":"PhysicalInterface","type":"string"},"uid":{"description":"The unique identifier, represented as a UUID, of the FMC Object.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/FmcObjectReference"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/DomainSettings"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/Deployed"},"staged":{"description":"Indicates that the settings have been configured but are not yet deployed.","properties":{"autoDeployEnabled":{"description":"Specifies whether changes to ZTNA settings are automatically deployed to the device. Note: This applies only to ZTNA-specific changes and does not affect the deployment of other pending changes.","example":false,"type":"boolean"},"domainSettings":{"description":"Configuration that defines how Secure Client communicates with the device.","items":{"properties":{"certificate":{"description":"Reference to the Public Key Infrastructure (PKI) certificate object on the FMC. This certificate is used to authenticate communication between the Secure Client and the device.","properties":{"link":{"description":"The endpoint to access this resource from.","example":"https://us.manage.security.cisco.com/api/rest/v1/cdfmc/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/networks/0276f012-3875-0ed3-0000-004294981364","type":"string"},"name":{"description":"The name of the FMC Object.","type":"string"},"type":{"description":"The type of the FMC Object.","example":"PhysicalInterface","type":"string"},"uid":{"description":"The unique identifier, represented as a UUID, of the FMC Object.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/FmcObjectReference"},"fqdn":{"description":"The fully qualified domain name (FQDN) of the device. Secure Client uses this to communicate with the device.","example":"myftd.cisco.com","type":"string"},"interfaces":{"description":"List of references to interface objects on the FMC, which defines the interfaces on the device that are used for ZTNA.","items":{"properties":{"link":{"description":"The endpoint to access this resource from.","example":"https://us.manage.security.cisco.com/api/rest/v1/cdfmc/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/networks/0276f012-3875-0ed3-0000-004294981364","type":"string"},"name":{"description":"The name of the FMC Object.","type":"string"},"type":{"description":"The type of the FMC Object.","example":"PhysicalInterface","type":"string"},"uid":{"description":"The unique identifier, represented as a UUID, of the FMC Object.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/FmcObjectReference"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/DomainSettings"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/Staged"},"universalZtnaConfigured":{"description":"Indicates whether a device is configured for Zero Trust Network Access (ZTNA).","example":true,"type":"boolean"},"universalZtnaEnabled":{"description":"Indicates whether a device is enabled for Zero Trust Network Access (ZTNA).","example":true,"type":"boolean"},"universalZtnaSupported":{"description":"Indicates whether a device supports Zero Trust Network Access (ZTNA).","example":true,"type":"boolean"}},"type":"object","$$ref":"#/components/schemas/UniversalZtnaSettings"},"ztpOnboardingJobId":{"description":"The unique identifier, represented as a UUID, for an internal job that orchestrates the onboarding of devices through Zero-Touch Provisioning. This applies to devices managed by both on-premises and Cloud-delivered FMC.","example":"7e9789b4-8389-4029-933f-ec7e385335ef","format":"uuid","type":"string"}},"required":["deviceType","name"],"type":"object","$$ref":"#/components/schemas/Device"}}},"description":"Device object"},"400":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, on the error","example":{},"type":"object"},"description":"Additional details, if any, on the error","example":{},"type":"object"},"errorCode":{"description":"A unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"A human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Invalid input provided. Check the response for details.","$$ref":"#/components/responses/http400BadRequest"},"401":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A human-readable error description in English.","example":"invalid_token","type":"string"},"errorDescription":{"description":"A human-readable error description in English.","example":"Your token is invalid","type":"string"}},"$$ref":"#/components/schemas/AuthenticationError"}}},"description":"Request not authorized.","$$ref":"#/components/responses/http401Unauthorised"},"403":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, on the error","example":{},"type":"object"},"description":"Additional details, if any, on the error","example":{},"type":"object"},"errorCode":{"description":"A unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"A human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"User does not have sufficient privileges to perform this operation.","$$ref":"#/components/responses/http403Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, on the error","example":{},"type":"object"},"description":"Additional details, if any, on the error","example":{},"type":"object"},"errorCode":{"description":"A unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"A human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Entity not found.","$$ref":"#/components/responses/http404NotFound"},"405":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, on the error","example":{},"type":"object"},"description":"Additional details, if any, on the error","example":{},"type":"object"},"errorCode":{"description":"A unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"A human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Method not allowed.","$$ref":"#/components/responses/http405MethodNotAllowed"},"500":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, on the error","example":{},"type":"object"},"description":"Additional details, if any, on the error","example":{},"type":"object"},"errorCode":{"description":"A unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"A human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Internal server error."}},"security":[{"bearerAuth":[]}],"summary":"Get Device","tags":["Inventory"],"__originalOperationId":"getDevice","method":"get","path":"/v1/inventory/devices/{deviceUid}"}}