--- updatedAt: 2026-03-01T18:23:07.000Z agentTools: siteIndex: https://techdocs.akamai.com/llms.txt projectIndex: https://techdocs.akamai.com/etp-config/llms.txt --- # List client versions Provides client versions. # OpenAPI definition ```json { "externalDocs": { "description": "See documentation for Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference" }, "info": { "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Client Configurations", "version": "v3" }, "openapi": "3.0.0", "paths": { "/configs/{configId}/client-versions": { "get": { "description": "Provides client versions.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/get-client-versions" }, "operationId": "get-client-versions", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "approvalStatus": "PENDING", "autoupgradeEnabled": true, "osId": 61, "osName": "Windows", "releaseDate": "2020-03-14T00:00:00.000+0000", "releaseStatus": "Security Patch", "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429", "supportedUntil": "2021-01-14T00:00:00Z", "unsupported": false, "versionId": 273, "versionName": "3.2.1" }, { "approvalStatus": "PENDING", "autoupgradeEnabled": true, "osId": 61, "osName": "Windows", "releaseDate": "2020-03-14T00:00:00.000+0000", "releaseStatus": "Beta", "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429", "supportedUntil": "2021-01-14T00:00:00Z", "unsupported": false, "versionId": 271, "versionName": "3.2.0" }, { "approvalStatus": "PENDING", "autoupgradeEnabled": true, "osId": 45, "osName": "Mac", "releaseDate": "2020-03-14T00:00:00.000+0000", "releaseStatus": "Beta", "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429", "supportedUntil": "2021-01-14T00:00:00Z", "unsupported": false, "versionId": 272, "versionName": "3.2.0" }, { "approvalStatus": "PENDING", "autoupgradeEnabled": true, "osId": 45, "osName": "Mac", "releaseDate": "2020-03-14T00:00:00.000+0000", "releaseStatus": "Security Patch", "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429", "supportedUntil": "2021-01-14T00:00:00Z", "unsupported": false, "versionId": 270, "versionName": "3.1.5" }, { "approvalStatus": "PENDING", "autoupgradeEnabled": true, "osId": 61, "osName": "Windows", "releaseDate": "2020-03-14T00:00:00.000+0000", "releaseStatus": "Security Patch", "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429", "supportedUntil": "2021-01-14T00:00:00Z", "unsupported": false, "versionId": 269, "versionName": "3.1.3" }, { "approvalStatus": "PENDING", "autoupgradeEnabled": true, "osId": 45, "osName": "Mac", "releaseDate": "2020-03-14T00:00:00.000+0000", "releaseStatus": "Security Patch", "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429", "supportedUntil": "2021-01-14T00:00:00Z", "unsupported": false, "versionId": 267, "versionName": "3.1.2" }, { "approvalStatus": "PENDING", "autoupgradeEnabled": true, "osId": 61, "osName": "Windows", "releaseDate": "2020-03-14T00:00:00.000+0000", "releaseStatus": "Security Patch", "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429", "supportedUntil": "2021-01-14T00:00:00Z", "unsupported": false, "versionId": 268, "versionName": "3.1.2" } ], "schema": { "description": "Lists client version details.", "items": { "additionalProperties": false, "description": "Lists client version detail object parameters.", "properties": { "approvalDate": { "description": "The approval date of version.", "format": "date-time", "type": "string" }, "approvalStatus": { "description": "Identifies the version approval status. Either `PENDING`, `APPROVED_ON_DEMAND`, or `APPROVED_FORCE_UPGRADE`.\n`APPROVED_ON_DEMAND` means the client version can be upgraded on-demand.\n`APPROVED_FORCE_UPGRADE` means the admin has forced an upgrade to this client version.", "enum": [ "PENDING", "APPROVED_ON_DEMAND", "APPROVED_FORCE_UPGRADE" ], "type": "string" }, "autoupgradeEnabled": { "description": "Enables auto upgrade for the version.", "type": "boolean" }, "downloadDate": { "description": "The download date of version.", "format": "date-time", "type": "string" }, "expirationDate": { "description": "The version's expiration date.", "format": "date-time", "type": "string" }, "osId": { "description": "The unique identifier of the OS installed on client version.", "minimum": 1, "type": "integer" }, "osName": { "description": "The name of OS installed on client.", "minLength": 1, "type": "string" }, "packageLocation": { "description": "Location of version package.", "minLength": 0, "type": "string" }, "releaseDate": { "description": "The release date of version.", "format": "date-time", "type": "string" }, "releaseStatus": { "description": "The status of the version release.", "minLength": 1, "type": "string" }, "restrictedVersion": { "description": "Marks the version as restricted.", "type": "boolean" }, "sha256": { "description": "The SHA-256 representation of the version.", "minLength": 1, "type": "string" }, "supportedUntil": { "description": "The date of expiry of the version.", "minLength": 1, "type": "string" }, "trialVersionConfigIds": { "description": "Config IDs using trial versions.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "unsupported": { "description": "Marks the version as unsupported.", "type": "boolean" }, "versionId": { "description": "The unique identifier of the version.", "minimum": 1, "type": "integer" }, "versionName": { "description": "The name of the specified version.", "minLength": 1, "type": "string" } }, "required": [ "versionId", "versionName", "osId", "osName", "sha256", "supportedUntil", "approvalStatus", "autoupgradeEnabled", "unsupported", "releaseDate" ], "type": "object", "x-akamai": { "file-path": "schemas/client-version-details.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/client-versions.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } } }, "summary": "List client versions", "tags": [ "Client versions" ] }, "parameters": [ { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/client-versions.yaml", "path-info": "/configs/{configId}/client-versions" } } }, "servers": [ { "url": "https://{hostname}/etp-config/v3" } ], "tags": [ { "description": "Tracks the client software versions deployed.", "name": "Client versions" } ], "x-akamai": { "auth-type": "EDGE_GRID", "file-path": "09-client-configurations.yaml" }, "x-readme": { "samples-languages": [ "curl", "python", "node" ], "explorer-enabled": true, "proxy-enabled": true } } ``` # Sibling pages * [Rotate the client version entitlement code](https://techdocs.akamai.com/etp-config/reference/post-rotate-entitlement-code.md) * [Update a client version](https://techdocs.akamai.com/etp-config/reference/put-client-version.md) * [Download a client version](https://techdocs.akamai.com/etp-config/reference/get-client-version-download.md)