Get compatible ASA upgrade versions - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get compatible ASA upgrade versions","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/830d1f62208c73e8aeba17d0e26773e8902a279e/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control Firewall Manager API","version":"1.18.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://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"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"description":"Get a list of compatible upgrade versions for a list of ASA devices across multiple managed tenants.","operationId":"getMspAsaCompatibleUpgradeVersions","parameters":[{"description":"A list of unique identifiers, represented as UUIDs, of the devices in Security Cloud Control. Note: All the specified devices must be in tenants managed by the MSP portal.","in":"query","name":"deviceUids","required":true,"schema":{"items":{"format":"uuid","type":"string"},"maxItems":50,"minItems":1,"type":"array","uniqueItems":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Compatible ASA upgrade versions for MSP managed devices across multiple tenants.","properties":{"compatibleVersions":{"description":"List of compatible ASA upgrade versions available for the specified devices.","items":{"description":"Information about a compatible ASA upgrade version and the devices that support it.","properties":{"asdmImageUrl":{"description":"The ASDM image URL","example":"https://../asdm-openjre-7204.bin","type":"string"},"asdmVersion":{"description":"The ASDM version","example":"7.20(4).openjre","type":"string"},"compatibleDevices":{"description":"List of devices that are compatible with this upgrade version","items":{"description":"Information about a device that is compatible with a specific ASA upgrade version.","properties":{"currentSoftwareVersion":{"description":"The software version currently running on the device","type":"string"},"hardwareModel":{"description":"The hardware model of the device","example":"ASAv (V01)","type":"string"},"managedTenantDisplayName":{"description":"The display name of the managed tenant in CDO.","example":"My Tenant","type":"string"},"managedTenantName":{"description":"The name of the managed tenant in CDO.","example":"my-tenant","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":"9ab5b2d0-f032-46f7-8b47-4ef10e598bf8","format":"uuid","type":"string"},"name":{"description":"The name of the device","example":"ASA-Device-1","type":"string"},"uid":{"description":"The unique identifier, represented as a UUID, of the device in Security Cloud Control.","example":"8da12556-748a-4d67-8b6b-d3dcf5af9a30","format":"uuid","type":"string"}},"required":["hardwareModel","managedTenantUid","name","uid"],"type":"object","$$ref":"#/components/schemas/CompatibleDevice"},"type":"array"},"softwareImageUrl":{"description":"The ASA software image URL","example":"https://../asa9-20-3-20-smp-k8.bin","type":"string"},"softwareVersion":{"description":"The software version","example":"9.20(3.20)","type":"string"}},"required":["asdmVersion","compatibleDevices","softwareVersion"],"type":"object","$$ref":"#/components/schemas/CompatibleVersionInfo"},"type":"array"}},"required":["compatibleVersions"],"type":"object","$$ref":"#/components/schemas/MspAsaCompatibleVersionsDto"}}},"description":"Compatible upgrade versions for MSP managed ASA devices across multiple tenants."},"400":{"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"}},"$$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, 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"}},"$$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, 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"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Entity not found.","$$ref":"#/components/responses/http404NotFound"},"422":{"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"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Unprocessable entity.","$$ref":"#/components/responses/http422UnprocessableEntity"},"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"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Internal server error."}},"security":[{"bearerAuth":[]}],"summary":"Get compatible ASA upgrade versions","tags":["MSP Device Upgrades"],"__originalOperationId":"getMspAsaCompatibleUpgradeVersions","method":"get","path":"/v1/msp/inventory/devices/asas/upgrades/versions"}}