Get MSP-managed devices - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get MSP-managed devices","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/cdbcd64e8c81b1f572dff1a1b687b52867178d60/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control Firewall Manager API","version":"1.15.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 devices, across all tenants, managed by the MSP portal.","operationId":"getMspManagedDevices","parameters":[{"description":"The number of results to retrieve.","in":"query","name":"limit","required":false,"schema":{"maximum":200,"minimum":0,"type":"string"}},{"description":"The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"string"}},{"description":"The query to execute. Use the Lucene Query Syntax to construct your query.","example":"fieldName:fieldValue","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"The fields to sort results by.","example":"name:DESC","in":"query","name":"sort","required":false,"schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of results available.","example":100,"format":"int32","type":"integer"},"items":{"description":"The list of items retrieved.","items":{"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.","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"},"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 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"},"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"},"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"},"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"},"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 that this device belongs to.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"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"},"type":"array"},"limit":{"description":"The number of results retrieved.","example":50,"format":"int32","type":"integer"},"offset":{"description":"The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.","example":0,"format":"int32","type":"integer"}},"type":"object","$$ref":"#/components/schemas/MspManagedDevicePage"}}},"description":"List of MSP-managed devices"},"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 MSP-managed devices","tags":["MSP Inventory"],"__originalOperationId":"getMspManagedDevices","method":"get","path":"/v1/msp/inventory/devices"}}