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

{"type":"api","title":"Get MSP-managed cloud service by UID","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 the cloud service managed by the MSP portal using its UID.","operationId":"getMspManagedCloudService","parameters":[{"description":"The unique identifier of MSP-managed cloud service.","in":"path","name":"cloudServiceUid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"address":{"description":"The address of the cloud service (if applicable), in \u003ccode\u003ehost:port\u003c/code\u003e format. Security Cloud Control connects to the cloud service at this address.","example":"my-example-duo.example.com:443","type":"string"},"cloudServiceType":{"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 cloud service.","example":"UMBRELLA"},"configState":{"enum":["NO_CONFIG","SYNCED","NOT_SYNCED","UNKNOWN"],"type":"string","$$ref":"#/components/schemas/ConfigState","description":"The state of the cloud service configuration in CDO. CDO stages configuration changes which have to be manually applied to the cloud service; this field indicates whether the configuration on CDO does not match the configuration on the cloud service, which indicates whether there are changes to be deployed from Security Cloud Control to the cloud service.","example":"SYNCED"},"conflictDetectionState":{"enum":["CONFLICT_DETECTED","NO_CONFLICTS"],"type":"string","$$ref":"#/components/schemas/ConflictDetectionState","description":"Indicates whether there have been changes made to the cloud service's configuration outside of Security Cloud Control.","example":"NO_CONFLICTS"},"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 cloud service to CDO. A connectivity state that is not ONLINE can indicate either a problem with the cloud service, or the communication pathways between the cloud service and Security Cloud Control.","example":"ONLINE"},"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 cloud service 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 cloud service belongs to.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"name":{"description":"The name of the cloud service in CDO. Cloud service names are unique in Security Cloud Control.","example":"my-example-duo-admin-panel","type":"string"},"tenantUid":{"format":"uuid","type":"string"},"uid":{"description":"The unique identifier, represented as a UUID, of the cloud service in Security Cloud Control.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"required":["name"],"type":"object","$$ref":"#/components/schemas/MspManagedCloudService"}}},"description":"MSP-managed cloud service"},"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"},"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 cloud service by UID","tags":["MSP Inventory"],"__originalOperationId":"getMspManagedCloudService","method":"get","path":"/v1/msp/inventory/services/{cloudServiceUid}"}}