Get MSP-managed device by UID - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get MSP-managed device by UID","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/241e37f202cf9838405f7ca5ed9f7d31d807d7bd/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control Firewall Manager API","version":"1.22.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.uae.security.cisco.com/firewall","description":"UAE"},{"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://devfed.cdo.cisco.com/api/rest","description":"Devfed"},{"url":"https://manage.dev.secure.cisco/api/rest","description":"Devf9"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"},{"url":"https://manage.secure.cisco/api/rest","description":"ProdF9"},{"url":"https://manage.securitydod.cisco/api/rest","description":"IL5"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"description":"Get the device managed by the MSP portal using its UID.","operationId":"getMspManagedDevice","parameters":[{"description":"The unique identifier of MSP-managed device.","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 \u003ccode\u003ehost:port\u003c/code\u003e 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.","enum":["OFF","ACTIVE_STANDBY","ACTIVE_ACTIVE"],"example":"ACTIVE_STANDBY","type":"string","$$ref":"#/components/schemas/AsaFailoverMode"},"asaFailoverState":{"description":"(High Availability ASAs only) Failover state of this device.","example":"Primary - Active","type":"string"},"asdmVersion":{"description":"(ASAs only) Version of the ASDM device manager running on the device.","example":"7.6(2)","type":"string"},"certificateExpiryDate":{"description":"(ASAs and FDM-managed FTDs only) Expiration date of the certificate used on the management interface of the device.","example":"2033-12-13T05:15:44Z","format":"date-time","type":"string"},"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 distinct config states for the devices in the Security Cloud Control tenant.","enum":["NO_CONFIG","SYNCED","NOT_SYNCED","UNKNOWN"],"type":"string","$$ref":"#/components/schemas/ConfigState"},"conflictDetectionState":{"description":"The distinct conflict detection states for the devices in the Security Cloud Control tenant.","enum":["CONFLICT_DETECTED","NO_CONFLICTS"],"type":"string","$$ref":"#/components/schemas/ConflictDetectionState"},"connectivityState":{"description":"The distinct connectivity states for the devices in the Security Cloud Control tenant.","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).","enum":["SDC","CDG"],"example":"CDG","type":"string","$$ref":"#/components/schemas/ConnectorType"},"contextMode":{"description":"The operating context mode of the ASA device.","enum":["MULTI_CONTEXT_ADMIN","MULTI_CONTEXT_NON_ADMIN","SINGLE_CONTEXT"],"example":"SINGLE_CONTEXT","type":"string"},"deviceMaintenanceWindow":{"description":"The maintenance window configuration for the device.","properties":{"currentEnd":{"description":"End time of the current maintenance window in ISO 8601 format. Note: This field is only populated when isMaintenanceWindowOpen is true.","example":"2025-06-21T04:00:00Z","type":"string"},"currentStart":{"description":"Start time of the current maintenance window in ISO 8601 format. Note: This field is only populated when isMaintenanceWindowOpen is true.","example":"2025-06-21T02:00:00Z","type":"string"},"durationMinutes":{"description":"Duration of the maintenance window in minutes.","example":120,"format":"int32","type":"integer"},"isOpen":{"description":"Indicates whether the maintenance window is currently open.","example":true,"type":"boolean"},"nextEnd":{"description":"End time of the next scheduled maintenance window in ISO 8601 format.","example":"2025-06-28T04:00:00Z","type":"string"},"nextStart":{"description":"Start time of the next scheduled maintenance window in ISO 8601 format.","example":"2025-06-28T02:00:00Z","type":"string"},"startCron":{"description":"CRON expression defining the scheduled start time of the maintenance window in format: Minute, Hour, Day of Month, Month, Day of Week.","example":"* 12 * * *","type":"string"}},"type":"object","$$ref":"#/components/schemas/DeviceMaintenanceWindow"},"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"},"deviceRoles":{"description":"The roles that this device performs on the network.","example":"ASA_RA_VPN_HEADEND","items":{"description":"The distinct device roles for the devices in the Security Cloud Control tenant.","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.","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"],"example":"CDFMC_MANAGED_FTD","type":"string","$$ref":"#/components/schemas/EntityType"},"firewallMode":{"description":"(ASAs only) The firewall operating mode of the device.","example":"routed","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 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.","properties":{"chassisSerial":{"description":"The serial number of the chassis on the device.","example":"FTX20131xxx","type":"string"},"name":{"description":"The name of the node on the device.","example":"node-a","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 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":{"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.","properties":{"chassisSerial":{"description":"The serial number of the chassis on the device.","example":"FTX20131xxx","type":"string"},"name":{"description":"The name of the node on the device.","example":"node-a","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 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":["SINGLE","ACTIVE","STANDBY","SUSPENDED","FAILED","CONFIGURATION_SYNC","NEGOTIATING","DISABLED","UNKNOWN","UNDETERMINED"],"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 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"},"name":{"description":"The name of the node on the device.","example":"node-a","type":"string"},"role":{"description":"(cdFMC-managed FTDs only) Information on the current role of the node in the HA Pair.","enum":["SINGLE","ACTIVE","STANDBY","SUSPENDED","FAILED","CONFIGURATION_SYNC","NEGOTIATING","DISABLED","UNKNOWN","UNDETERMINED"],"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"},"name":{"description":"The name of the node on the device.","example":"node-a","type":"string"},"role":{"description":"(cdFMC-managed FTDs only) Information on the current role of the node in the HA Pair.","enum":["SINGLE","ACTIVE","STANDBY","SUSPENDED","FAILED","CONFIGURATION_SYNC","NEGOTIATING","DISABLED","UNKNOWN","UNDETERMINED"],"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"},"hardwareModel":{"description":"(ASAs, FDM-managed FTDs, and FMC-managed FTDs only) The hardware model of the device","type":"string"},"labels":{"description":"Labels used to identify/tag Security Cloud Control entities.","nullable":true,"properties":{"groupedLabels":{"additionalProperties":{"description":"Groups of labels used to identify/tag Security Cloud Control entities.","example":{"group1":["label-1","label-2"],"group2":["label-1","label-2"]},"items":{"description":"Groups of labels used to identify/tag Security Cloud Control entities.","example":"{\"group1\":[\"label-1\",\"label-2\"],\"group2\":[\"label-1\",\"label-2\"]}","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":{"description":"Set of free-labels used to identify/tag Security Cloud Control entities.","example":"[\"label-a\",\"label-b\",\"label-c\"]","type":"string"},"type":"array","uniqueItems":true}},"type":"object","$$ref":"#/components/schemas/Labels"},"managedSccOrganizationUid":{"description":"The unique identifier, represented as a UUID, of the managed organization on Security Cloud Control that this device belongs to.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"managedTenantDisplayName":{"description":"The display name of the managed tenant in CDO.","example":"my-example-tenant","type":"string"},"managedTenantName":{"description":"The name of the managed tenant in CDO.","example":"my-example-tenant","type":"string"},"managedTenantRegion":{"description":"The region of the managed tenant in CDO. This is the region where the device is located.","example":"us1","type":"string"},"managedTenantUid":{"description":"The unique identifier, represented as a UUID, of the managed tenant in Security Cloud Control Firewall Manager that this device belongs to.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"merakiPhysicalDevices":{"description":"(Meraki devices only) The physical devices associated with the Meraki appliance.","items":{"description":"Physical device information for a Meraki MX appliance.","properties":{"lanIp":{"description":"The LAN IP address assigned to the Meraki Security Appliance.","example":"192.168.128.1","type":"string"},"latitude":{"description":"The latitude of the location of the Meraki Security Appliance.","format":"double","type":"number"},"longitude":{"description":"The longitude of the location of the Meraki Security Appliance.","format":"double","type":"number"},"model":{"description":"The model of the Meraki Security Appliance.","example":"MX68","type":"string"},"notes":{"description":"Freeform text notes describing the Meraki Security Appliance.","type":"string"},"serial":{"description":"The serial number of the Meraki Security Appliance.","example":"Q2WI-XXXX-YY12-ZZ23","type":"string"},"wan1Ip":{"description":"The IP address assigned to the first WAN link of the Meraki Security Appliance.","example":"1.2.3.4","type":"string"},"wan2Ip":{"description":"(Only dual-WAN capable and configured devices) The IP address assigned to the second WAN link of the Meraki Security Appliance.","example":"5.6.7.8","type":"string"}},"type":"object","$$ref":"#/components/schemas/MerakiPhysicalDevice"},"type":"array"},"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 in CDO. Device names are unique in Security Cloud Control.","example":"my-example-device","type":"string"},"raVpnCertificateExpiryDate":{"description":"(Remote Access VPN headends — ASA, FDM-managed FTD, and cdFMC-managed FTD — only) Expiration date of the Secure Client certificate installed on the device.","example":"2026-12-13T05:15:44Z","format":"date-time","type":"string"},"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"},"softwareVersion":{"description":"The version of the software running on the device.","example":"7.4.1","type":"string"},"tenantUid":{"format":"uuid","type":"string"},"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"}},"required":["name"],"type":"object","$$ref":"#/components/schemas/MspManagedDevice"}}},"description":"MSP-managed device"},"404":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"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":"Human-readable error description in English.","example":"sample error","type":"string"}},"type":"object","$$ref":"#/components/schemas/CommonApiError"}}},"description":"Entity not found.","$$ref":"#/components/responses/http404NotFound"},"500":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"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":"Human-readable error description in English.","example":"sample error","type":"string"}},"type":"object","$$ref":"#/components/schemas/CommonApiError"}}},"description":"Internal server error."}},"security":[{"bearerAuth":[]}],"summary":"Get MSP-managed device by UID","tags":["MSP Inventory"],"__originalOperationId":"getMspManagedDevice","method":"get","path":"/v1/msp/inventory/devices/{deviceUid}"}}