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

{"type":"api","title":"Get MSP-managed device managers","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 device managers, across all tenants, managed by the MSP portal.","operationId":"getMspManagedDeviceManagers","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"},"connectivityState":{"enum":["ONLINE","UNREACHABLE","BAD_CREDENTIALS","UNKNOWN","PENDING_SETUP","PENDING","NEW_CERT_DETECTED"],"type":"string","$$ref":"#/components/schemas/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"},"deviceManagerType":{"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","description":"The type of the device manager.","example":"CDFMC"},"fmcDomainUid":{"description":"(FMC-only) The Domain UID of the FMC.","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 manager 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 manager belongs to.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"name":{"description":"The name of the device manager in CDO. Device manager names are unique in Security Cloud Control.","example":"my-example-device","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 manager in Security Cloud Control.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"required":["name"],"type":"object","$$ref":"#/components/schemas/MspManagedDeviceManager"},"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/MspManagedDeviceManagersPage"}}},"description":"List of MSP-managed device managers"},"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 device managers","tags":["MSP Inventory"],"__originalOperationId":"getMspManagedDeviceManagers","method":"get","path":"/v1/msp/inventory/managers"}}