List Secure Client versions compatible with the specified FTD devices - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"List Secure Client versions compatible with the specified FTD devices","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/a91221fb628ca830434d3b4f6656a55cdd5fd776/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 a list of compatible Secure Client upgrade versions for the specified FTD devices, each with the packages available for it and their direct download URLs. When no device identifiers are supplied, returns every version in the Secure Client catalog that FTD devices support, without validating any devices.","operationId":"getFtdCompatibleSecureClientVersions","parameters":[{"description":"The unique identifiers, represented as UUIDs, of the FTD devices in Security Cloud Control. When omitted, every version in the Secure Client catalog that FTD devices support is returned.","in":"query","name":"deviceUids","required":false,"schema":{"items":{"format":"uuid","type":"string"},"maxItems":50,"minItems":0,"type":"array","uniqueItems":true}},{"description":"Number of results to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":"50","maximum":200,"minimum":0,"type":"string"}},{"description":"Offset of the results retrieved. The Security Cloud Control APIs use 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":{"default":"0","minimum":0,"type":"string"}}],"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":{"description":"The list of items retrieved.","properties":{"platforms":{"description":"The OS and CPU architecture combinations available for this version, each with the package that serves it.","items":{"description":"The OS and CPU architecture combinations available for this version, each with the package that serves it.","properties":{"cpuArchitecture":{"description":"The CPU architecture. One of: X86_64, ARM64, UNIVERSAL.","enum":["ARM64","X86_64","UNIVERSAL"],"type":"string"},"os":{"description":"The operating system. One of: LINUX, MACOS, WINDOWS.","enum":["LINUX","MACOS","WINDOWS"],"type":"string"},"package":{"description":"The Secure Client package available for this platform.","properties":{"downloadUrl":{"description":"Direct download URL for the package. Requires no authentication and does not expire.","type":"string"},"fileName":{"description":"The Secure Client package filename.","type":"string"}},"required":["downloadUrl","fileName"],"type":"object","$$ref":"#/components/schemas/CompatibleSecureClientPackageDto"}},"required":["cpuArchitecture","os","package"],"type":"object","$$ref":"#/components/schemas/CompatibleSecureClientPlatformDto"},"type":"array"},"version":{"description":"The Secure Client version string (e.g. \"5.1.15.287\", \"4.10.05095\").","type":"string"}},"required":["platforms","version"],"type":"object","$$ref":"#/components/schemas/CompatibleSecureClientVersionDto"},"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/SecureClientUpgradeVersionsPage"}}},"description":"A paginated list of compatible Secure Client versions"},"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"}},"type":"object","$$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"}},"type":"object","$$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"}},"type":"object","$$ref":"#/components/schemas/CommonApiError"}}},"description":"User does not have sufficient privileges to perform this operation.","$$ref":"#/components/responses/http403Forbidden"},"405":{"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":"Method not allowed.","$$ref":"#/components/responses/http405MethodNotAllowed"},"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."},"503":{"content":{"*/*":{"schema":{"properties":{"count":{"description":"The total number of results available.","example":100,"format":"int32","type":"integer"},"items":{"description":"The list of items retrieved.","items":{"description":"The list of items retrieved.","properties":{"platforms":{"description":"The OS and CPU architecture combinations available for this version, each with the package that serves it.","items":{"description":"The OS and CPU architecture combinations available for this version, each with the package that serves it.","properties":{"cpuArchitecture":{"description":"The CPU architecture. One of: X86_64, ARM64, UNIVERSAL.","enum":["ARM64","X86_64","UNIVERSAL"],"type":"string"},"os":{"description":"The operating system. One of: LINUX, MACOS, WINDOWS.","enum":["LINUX","MACOS","WINDOWS"],"type":"string"},"package":{"description":"The Secure Client package available for this platform.","properties":{"downloadUrl":{"description":"Direct download URL for the package. Requires no authentication and does not expire.","type":"string"},"fileName":{"description":"The Secure Client package filename.","type":"string"}},"required":["downloadUrl","fileName"],"type":"object","$$ref":"#/components/schemas/CompatibleSecureClientPackageDto"}},"required":["cpuArchitecture","os","package"],"type":"object","$$ref":"#/components/schemas/CompatibleSecureClientPlatformDto"},"type":"array"},"version":{"description":"The Secure Client version string (e.g. \"5.1.15.287\", \"4.10.05095\").","type":"string"}},"required":["platforms","version"],"type":"object","$$ref":"#/components/schemas/CompatibleSecureClientVersionDto"},"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/PageCompatibleSecureClientVersionDto"}}},"description":"Service temporarily unavailable"}},"security":[{"bearerAuth":[]}],"summary":"List Secure Client versions compatible with the specified FTD devices","tags":["Secure Client Management"],"x-beta":"true","__originalOperationId":"getFtdCompatibleSecureClientVersions","method":"get","path":"/v1/inventory/devices/ftds/secure-client/upgrades/versions"}}