{ "components": { "parameters": { "revocation-list-id-path": { "description": "Uniquely identifies each [revocation list](https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-lists). This corresponds to the revocation list object's `id` member.", "in": "path", "name": "revocationListId", "required": true, "schema": { "example": 120964235098767, "type": "integer" }, "x-akamai": { "file-path": "parameters/revocation-list-id-path.yaml" } }, "token-id-path": { "description": "The token identifier portion of the complete Akamai token. A token identifier can contain a maximum of 64 alphanumeric characters, hyphens, or underscores.", "in": "path", "name": "tokenId", "required": true, "schema": { "example": "sqwoieksjbsdf3455-abc123_456jkl", "maxLength": 64, "type": "string" }, "x-akamai": { "file-path": "parameters/token-id-path.yaml" } } }, "responses": { "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid body", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/adaptive-media-delivery/reference/400). You provided bad parameter data or formatted the request body incorrectly.", "x-akamai": { "file-path": "errors/400.yaml" } }, "400-list": { "content": { "application/problem+json": { "example": { "detail": "Invalid Revocation list Id", "instance": "48be0c06-066f-43cf-9fd6-eba4b32f20ac", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/adaptive-media-delivery/reference/400). You provided bad parameter data or formatted the request body incorrectly.", "x-akamai": { "file-path": "errors/400-list.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/adaptive-media-delivery/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials) is invalid or it has expired.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Access forbidden](https://techdocs.akamai.com/adaptive-media-delivery/reference/403). You lack permission for this operation, such as having read-only access.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/adaptive-media-delivery/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Not allowed](https://techdocs.akamai.com/adaptive-media-delivery/reference/405). You used an unsupported method with this operation. For example, you set the method to GET for a PUT operation.", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "Unsupported media type", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 415, "title": "Unsupported Media Type", "type": "unsupported_media_type" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Unsupported media type](https://techdocs.akamai.com/adaptive-media-delivery/reference/415). You've used an unsupported request or response content type, such as `application/xml`. Try the operation again using `application/json`.", "x-akamai": { "file-path": "errors/415.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/adaptive-media-delivery/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "x-akamai": { "file-path": "errors/500.yaml" } } }, "schemas": { "error": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } }, "identifier-200": { "additionalProperties": false, "description": "Parameters set for a unique token authentication token.", "properties": { "id": { "description": "The unique identifier assigned to the token.", "minLength": 1, "type": "string" }, "ttl": { "description": "The time to live (TTL) for the revocation list, in seconds. After this time elapses, Akamai removes this token from the revocation list.", "minimum": 1800, "type": "integer" } }, "required": [ "id", "ttl" ], "type": "object", "x-akamai": { "file-path": "schemas/identifier-200.yaml" } }, "identifiers-200": { "description": "All token authentication tokens, and the parameters set for each.", "items": { "additionalProperties": false, "description": "All token authentication tokens, and the parameters set for each.", "properties": { "id": { "description": "The unique identifier assigned to the token.", "minLength": 1, "type": "string" }, "ttl": { "description": "The time to live (TTL) set for tokens in the revocation list, in seconds. After this time elapses, Akamai removes this token from the revocation list.", "minimum": 1800, "type": "integer" } }, "required": [ "id", "ttl" ], "type": "object", "x-akamai": { "file-path": "schemas/token-id-details.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/identifiers-200.yaml" } }, "meta-info-200": { "additionalProperties": false, "description": "The number of token identifiers in a revocation list and the maximum number it can house.", "properties": { "count": { "description": "The number of token identifiers currently in the revocation list.", "minimum": 0, "type": "integer" }, "limit": { "description": "The number of token identifiers you can still add to the revocation list.", "maximum": 50000, "minimum": 0, "type": "integer" } }, "required": [ "count", "limit" ], "type": "object", "x-akamai": { "file-path": "schemas/meta-info-200.yaml" } }, "post-identifiers": { "description": "The `session_id` set in the access token used with Token Authentication. The `session_id` serves as each token's `tokenId`.", "items": { "additionalProperties": false, "description": "The `session_id` set in the access token used with Token Authentication. The `session_id` serves as each token's `tokenId`.", "properties": { "durationSeconds": { "description": "Akamai revokes the token for this number of seconds. After this time, Akamai marks it as unrevoked so requests can use it again. The minimum value is `1800`, or 30 minutes. If you set it to anything less, it resets to `1800`.", "minimum": 1800, "type": "integer" }, "id": { "description": "Uniquely identifies each token, corresponding to the `tokenId` parameter when you run [Get an identifier](https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-list-token).", "minLength": 1, "type": "string" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/token-id.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/post-identifiers.yaml" } }, "post-revocation-list": { "additionalProperties": false, "description": "Parameters assigned to a revocation list during its creation.", "properties": { "contractId": { "description": "Include the Akamai-assigned contract ID for your instance of Access Revocation.", "minLength": 1, "type": "string" }, "name": { "description": "Set a friendly name for the revocation list. The name can only contain alphanumeric and dash characters.", "minLength": 1, "type": "string" } }, "required": [ "name", "contractId" ], "type": "object", "x-akamai": { "file-path": "schemas/post-revocation-list.yaml" } }, "post-revocation-list-202": { "additionalProperties": false, "description": "The API returns this response after it successfully creates a revocation list.", "properties": { "contractId": { "description": "The Akamai-assigned contract ID for your instance of Access Revocation.", "minLength": 1, "type": "string" }, "id": { "description": "The unique numeric identifier that the API assigned to a revocation list.", "minimum": 1, "type": "integer" }, "name": { "description": "A friendly name for the revocation list. The name can only contain alphanumeric and dash characters.", "minLength": 1, "type": "string" } }, "required": [ "id", "name", "contractId" ], "type": "object", "x-akamai": { "file-path": "schemas/post-revocation-list-202.yaml" } }, "revocation-list-details": { "additionalProperties": false, "description": "Use a revocation list to group token identifiers to block their use. You could create a revocation list for a specific event to block specific tokens from accessing content.", "properties": { "contractId": { "description": "The Akamai-assigned contract ID for your instance of Access Revocation.", "minLength": 1, "type": "string" }, "createdBy": { "description": "The Control Center login ID used to create the revocation list.", "minLength": 1, "type": "string" }, "createdTime": { "description": "The Unix epoch time that represents when you created the revocation list.", "minimum": 1, "type": "integer" }, "id": { "description": "A unique numeric identifier assigned to a revocation list.", "minimum": 1, "type": "integer" }, "name": { "description": "A friendly name for the revocation list. The name can only contain alphanumeric and dash characters.", "minLength": 1, "type": "string" } }, "required": [ "id", "name", "contractId", "createdBy", "createdTime" ], "type": "object", "x-akamai": { "file-path": "schemas/revocation-list-details.yaml" } }, "revocation-list-properties-200": { "description": "Information for each AMD property that uses a revocation list.", "items": { "additionalProperties": false, "description": "File information for each AMD property that uses a revocation list.", "properties": { "arlFileId": { "description": "The unique file identifier for the AMD property that's using access revocation.", "minimum": 1, "type": "integer" }, "propertyId": { "description": "The unique property ID assigned to the AMD property.", "minimum": 1, "type": "integer" }, "propertyName": { "description": "The property name set for the AMD property.", "minLength": 1, "type": "string" } }, "required": [ "arlFileId", "propertyId", "propertyName" ], "type": "object", "x-akamai": { "file-path": "schemas/revocation-list-property-details.yaml" } }, "minItems": 1, "type": "array", "x-akamai": { "file-path": "schemas/revocation-list-properties-200.yaml" } }, "revocation-list-property-details": { "additionalProperties": false, "description": "File information for each AMD property that uses a revocation list.", "properties": { "arlFileId": { "description": "The unique file identifier for the AMD property that's using access revocation.", "minimum": 1, "type": "integer" }, "propertyId": { "description": "The unique property ID assigned to the AMD property.", "minimum": 1, "type": "integer" }, "propertyName": { "description": "The property name set for the AMD property.", "minLength": 1, "type": "string" } }, "required": [ "arlFileId", "propertyId", "propertyName" ], "type": "object", "x-akamai": { "file-path": "schemas/revocation-list-property-details.yaml" } }, "revocation-lists-200": { "description": "Use revocation lists to group token identifiers to block their use. Create a revocation list for an event to block specific tokens from accessing content.", "items": { "additionalProperties": false, "description": "Use a revocation list to group token identifiers to block their use. You could create a revocation list for a specific event to block specific tokens from accessing content.", "properties": { "contractId": { "description": "The Akamai-assigned contract ID for your instance of Access Revocation.", "minLength": 1, "type": "string" }, "createdBy": { "description": "The Control Center login ID used to create the revocation list.", "minLength": 1, "type": "string" }, "createdTime": { "description": "The Unix epoch time that represents when you created the revocation list.", "minimum": 1, "type": "integer" }, "id": { "description": "A unique numeric identifier assigned to a revocation list.", "minimum": 1, "type": "integer" }, "name": { "description": "A friendly name for the revocation list. The name can only contain alphanumeric and dash characters.", "minLength": 1, "type": "string" } }, "required": [ "id", "name", "contractId", "createdBy", "createdTime" ], "type": "object", "x-akamai": { "file-path": "schemas/revocation-list-details.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/revocation-lists-200.yaml" } }, "token-id": { "additionalProperties": false, "description": "The `session_id` set in the access token used with Token Authentication. The `session_id` serves as each token's `tokenId`.", "properties": { "durationSeconds": { "description": "Akamai revokes the token for this number of seconds. After this time, Akamai marks it as unrevoked so requests can use it again. The minimum value is `1800`, or 30 minutes. If you set it to anything less, it resets to `1800`.", "minimum": 1800, "type": "integer" }, "id": { "description": "Uniquely identifies each token, corresponding to the `tokenId` parameter when you run [Get an identifier](https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-list-token).", "minLength": 1, "type": "string" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/token-id.yaml" } }, "token-id-details": { "additionalProperties": false, "description": "All token authentication tokens, and the parameters set for each.", "properties": { "id": { "description": "The unique identifier assigned to the token.", "minLength": 1, "type": "string" }, "ttl": { "description": "The time to live (TTL) set for tokens in the revocation list, in seconds. After this time elapses, Akamai removes this token from the revocation list.", "minimum": 1800, "type": "integer" } }, "required": [ "id", "ttl" ], "type": "object", "x-akamai": { "file-path": "schemas/token-id-details.yaml" } }, "unrevoke-identifiers": { "description": "Token identifiers the API removes from your revocation list.", "items": { "minLength": 1, "type": "string" }, "maxItems": 50000, "minItems": 1, "type": "array", "x-akamai": { "file-path": "schemas/unrevoke-identifiers.yaml" } } } }, "externalDocs": { "description": "See documentation for Akamai's Access Revocation API", "url": "https://techdocs.akamai.com/adaptive-media-delivery/reference" }, "info": { "description": "Recognize and flag authentication tokens that have been hijacked, and block requests that include them.\n", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Akamai: Access Revocation API", "version": "v2" }, "openapi": "3.0.0", "paths": { "/revocation-lists": { "post": { "description": "Add a new list to house token identifiers that you want revoked from access. You can have a total of 10 revocation lists. You can't modify these settings for a revocation list, so be sure you provide the proper details when adding one. However, you can [revoke](https://techdocs.akamai.com/adaptive-media-delivery/reference/post-revocation-list-ids) or [unrevoke](https://techdocs.akamai.com/adaptive-media-delivery/reference/post-unrevoke-revocation-list-ids) token identifiers from each revocation list, as necessary.", "externalDocs": { "description": "See documentation for this operation in Akamai's Access Revocation API", "url": "https://techdocs.akamai.com/adaptive-media-delivery/reference/post-revocation-list" }, "operationId": "post-revocation-list", "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" } } ], "requestBody": { "content": { "application/json": { "example": { "contractId": "C-0N7RAC7", "name": "Baseball-ws-2022" }, "schema": { "additionalProperties": false, "description": "Parameters assigned to a revocation list during its creation.", "properties": { "contractId": { "description": "Include the Akamai-assigned contract ID for your instance of Access Revocation.", "minLength": 1, "type": "string" }, "name": { "description": "Set a friendly name for the revocation list. The name can only contain alphanumeric and dash characters.", "minLength": 1, "type": "string" } }, "required": [ "name", "contractId" ], "type": "object", "x-akamai": { "file-path": "schemas/post-revocation-list.yaml" } } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "example": { "contractId": "K-0N7RAK7", "id": 1, "name": "Baseball-ws-2019" }, "schema": { "additionalProperties": false, "description": "The API returns this response after it successfully creates a revocation list.", "properties": { "contractId": { "description": "The Akamai-assigned contract ID for your instance of Access Revocation.", "minLength": 1, "type": "string" }, "id": { "description": "The unique numeric identifier that the API assigned to a revocation list.", "minimum": 1, "type": "integer" }, "name": { "description": "A friendly name for the revocation list. The name can only contain alphanumeric and dash characters.", "minLength": 1, "type": "string" } }, "required": [ "id", "name", "contractId" ], "type": "object", "x-akamai": { "file-path": "schemas/post-revocation-list-202.yaml" } } } }, "description": "The API accepted your request to create a revocation list." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid Revocation list Id", "instance": "48be0c06-066f-43cf-9fd6-eba4b32f20ac", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/adaptive-media-delivery/reference/400). You provided bad parameter data or formatted the request body incorrectly.", "x-akamai": { "file-path": "errors/400-list.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/adaptive-media-delivery/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials) is invalid or it has expired.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Access forbidden](https://techdocs.akamai.com/adaptive-media-delivery/reference/403). You lack permission for this operation, such as having read-only access.", "x-akamai": { "file-path": "errors/403.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Not allowed](https://techdocs.akamai.com/adaptive-media-delivery/reference/405). You used an unsupported method with this operation. For example, you set the method to GET for a PUT operation.", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "Unsupported media type", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 415, "title": "Unsupported Media Type", "type": "unsupported_media_type" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Unsupported media type](https://techdocs.akamai.com/adaptive-media-delivery/reference/415). You've used an unsupported request or response content type, such as `application/xml`. Try the operation again using `application/json`.", "x-akamai": { "file-path": "errors/415.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/adaptive-media-delivery/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Add a revocation list", "tags": [ "Revocation lists" ] }, "get": { "description": "List all of your revocation lists and view details about them.", "externalDocs": { "description": "See documentation for this operation in Akamai's Access Revocation API", "url": "https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-lists" }, "operationId": "get-revocation-lists", "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": [ { "contractId": "C-0N7RAC7", "createdBy": "mrossi", "createdTime": 1569238487, "id": 1, "name": "customer-revocation-list1" }, { "contractId": "C-0N7RAC71", "createdBy": "tyamada", "createdTime": 1569238504, "id": 2, "name": "customer-revocation-list2" } ], "schema": { "description": "Use revocation lists to group token identifiers to block their use. Create a revocation list for an event to block specific tokens from accessing content.", "items": { "additionalProperties": false, "description": "Use a revocation list to group token identifiers to block their use. You could create a revocation list for a specific event to block specific tokens from accessing content.", "properties": { "contractId": { "description": "The Akamai-assigned contract ID for your instance of Access Revocation.", "minLength": 1, "type": "string" }, "createdBy": { "description": "The Control Center login ID used to create the revocation list.", "minLength": 1, "type": "string" }, "createdTime": { "description": "The Unix epoch time that represents when you created the revocation list.", "minimum": 1, "type": "integer" }, "id": { "description": "A unique numeric identifier assigned to a revocation list.", "minimum": 1, "type": "integer" }, "name": { "description": "A friendly name for the revocation list. The name can only contain alphanumeric and dash characters.", "minLength": 1, "type": "string" } }, "required": [ "id", "name", "contractId", "createdBy", "createdTime" ], "type": "object", "x-akamai": { "file-path": "schemas/revocation-list-details.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/revocation-lists-200.yaml" } } } }, "description": "The response provides the revocation lists." }, "401": { "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/adaptive-media-delivery/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials) is invalid or it has expired.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Access forbidden](https://techdocs.akamai.com/adaptive-media-delivery/reference/403). You lack permission for this operation, such as having read-only access.", "x-akamai": { "file-path": "errors/403.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Not allowed](https://techdocs.akamai.com/adaptive-media-delivery/reference/405). You used an unsupported method with this operation. For example, you set the method to GET for a PUT operation.", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "Unsupported media type", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 415, "title": "Unsupported Media Type", "type": "unsupported_media_type" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Unsupported media type](https://techdocs.akamai.com/adaptive-media-delivery/reference/415). You've used an unsupported request or response content type, such as `application/xml`. Try the operation again using `application/json`.", "x-akamai": { "file-path": "errors/415.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/adaptive-media-delivery/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "List revocation lists", "tags": [ "Revocation lists" ] }, "x-akamai": { "file-path": "paths/revocation-lists.yaml", "path-info": "/revocation-lists" } }, "/revocation-lists/{revocationListId}": { "delete": { "description": "Delete a specific revocation list. This removes support for Access Revocation in any AMD property that may have this revocation list currently selected for use.", "externalDocs": { "description": "See documentation for this operation in Akamai's Access Revocation API", "url": "https://techdocs.akamai.com/adaptive-media-delivery/reference/delete-revocation-list" }, "operationId": "delete-revocation-list", "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": { "204": { "content": {}, "description": "The delete operation completed successfully." }, "401": { "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/adaptive-media-delivery/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials) is invalid or it has expired.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Access forbidden](https://techdocs.akamai.com/adaptive-media-delivery/reference/403). You lack permission for this operation, such as having read-only access.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/adaptive-media-delivery/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Not allowed](https://techdocs.akamai.com/adaptive-media-delivery/reference/405). You used an unsupported method with this operation. For example, you set the method to GET for a PUT operation.", "x-akamai": { "file-path": "errors/405.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/adaptive-media-delivery/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Delete a revocation list", "tags": [ "Revocation lists" ] }, "parameters": [ { "description": "Uniquely identifies each [revocation list](https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-lists). This corresponds to the revocation list object's `id` member.", "in": "path", "name": "revocationListId", "required": true, "schema": { "example": 120964235098767, "type": "integer" }, "x-akamai": { "file-path": "parameters/revocation-list-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/revocation-list.yaml", "path-info": "/revocation-lists/{revocationListId}" } }, "/revocation-lists/{revocationListId}/identifiers": { "get": { "description": "List all identifiers for a specific revocation list to review their details.", "externalDocs": { "description": "See documentation for this operation in Akamai's Access Revocation API", "url": "https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-list-ids" }, "operationId": "get-revocation-list-ids", "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": [ { "id": "sqwoieksjbsdf3455", "ttl": 86400 }, { "id": "9082349u534589824", "ttl": 21600 }, { "id": "68sd899ff09sdf8787", "ttl": 25200 } ], "schema": { "description": "All token authentication tokens, and the parameters set for each.", "items": { "additionalProperties": false, "description": "All token authentication tokens, and the parameters set for each.", "properties": { "id": { "description": "The unique identifier assigned to the token.", "minLength": 1, "type": "string" }, "ttl": { "description": "The time to live (TTL) set for tokens in the revocation list, in seconds. After this time elapses, Akamai removes this token from the revocation list.", "minimum": 1800, "type": "integer" } }, "required": [ "id", "ttl" ], "type": "object", "x-akamai": { "file-path": "schemas/token-id-details.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/identifiers-200.yaml" } } } }, "description": "The response provides the identifiers." }, "401": { "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/adaptive-media-delivery/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials) is invalid or it has expired.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Access forbidden](https://techdocs.akamai.com/adaptive-media-delivery/reference/403). You lack permission for this operation, such as having read-only access.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/adaptive-media-delivery/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Not allowed](https://techdocs.akamai.com/adaptive-media-delivery/reference/405). You used an unsupported method with this operation. For example, you set the method to GET for a PUT operation.", "x-akamai": { "file-path": "errors/405.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/adaptive-media-delivery/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "List identifiers", "tags": [ "Identifiers" ] }, "parameters": [ { "description": "Uniquely identifies each [revocation list](https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-lists). This corresponds to the revocation list object's `id` member.", "in": "path", "name": "revocationListId", "required": true, "schema": { "example": 120964235098767, "type": "integer" }, "x-akamai": { "file-path": "parameters/revocation-list-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/identifiers.yaml", "path-info": "/revocation-lists/{revocationListId}/identifiers" } }, "/revocation-lists/{revocationListId}/identifiers/add": { "post": { "description": "Add a set of token identifiers to a revocation list to revoke them. Add up to 5,000 token identifiers in a single operation.", "externalDocs": { "description": "See documentation for this operation in Akamai's Access Revocation API", "url": "https://techdocs.akamai.com/adaptive-media-delivery/reference/post-revocation-list-ids" }, "operationId": "post-revocation-list-ids", "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" } } ], "requestBody": { "content": { "application/json": { "example": [ { "durationSeconds": 18000, "id": "sdasd345466dg" }, { "durationSeconds": 3600, "id": "utrfhasdf8990" } ], "schema": { "description": "The `session_id` set in the access token used with Token Authentication. The `session_id` serves as each token's `tokenId`.", "items": { "additionalProperties": false, "description": "The `session_id` set in the access token used with Token Authentication. The `session_id` serves as each token's `tokenId`.", "properties": { "durationSeconds": { "description": "Akamai revokes the token for this number of seconds. After this time, Akamai marks it as unrevoked so requests can use it again. The minimum value is `1800`, or 30 minutes. If you set it to anything less, it resets to `1800`.", "minimum": 1800, "type": "integer" }, "id": { "description": "Uniquely identifies each token, corresponding to the `tokenId` parameter when you run [Get an identifier](https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-list-token).", "minLength": 1, "type": "string" } }, "required": [ "id" ], "type": "object", "x-akamai": { "file-path": "schemas/token-id.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/post-identifiers.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "count": 500, "limit": 50000 }, "schema": { "additionalProperties": false, "description": "The number of token identifiers in a revocation list and the maximum number it can house.", "properties": { "count": { "description": "The number of token identifiers currently in the revocation list.", "minimum": 0, "type": "integer" }, "limit": { "description": "The number of token identifiers you can still add to the revocation list.", "maximum": 50000, "minimum": 0, "type": "integer" } }, "required": [ "count", "limit" ], "type": "object", "x-akamai": { "file-path": "schemas/meta-info-200.yaml" } } } }, "description": "The API added the tokens to the revocation list." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid body", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/adaptive-media-delivery/reference/400). You provided bad parameter data or formatted the request body incorrectly.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/adaptive-media-delivery/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials) is invalid or it has expired.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Access forbidden](https://techdocs.akamai.com/adaptive-media-delivery/reference/403). You lack permission for this operation, such as having read-only access.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/adaptive-media-delivery/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Not allowed](https://techdocs.akamai.com/adaptive-media-delivery/reference/405). You used an unsupported method with this operation. For example, you set the method to GET for a PUT operation.", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "Unsupported media type", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 415, "title": "Unsupported Media Type", "type": "unsupported_media_type" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Unsupported media type](https://techdocs.akamai.com/adaptive-media-delivery/reference/415). You've used an unsupported request or response content type, such as `application/xml`. Try the operation again using `application/json`.", "x-akamai": { "file-path": "errors/415.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/adaptive-media-delivery/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Revoke tokens", "tags": [ "Identifiers" ] }, "parameters": [ { "description": "Uniquely identifies each [revocation list](https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-lists). This corresponds to the revocation list object's `id` member.", "in": "path", "name": "revocationListId", "required": true, "schema": { "example": 120964235098767, "type": "integer" }, "x-akamai": { "file-path": "parameters/revocation-list-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/identifiers-add.yaml", "path-info": "/revocation-lists/{revocationListId}/identifiers/add" } }, "/revocation-lists/{revocationListId}/identifiers/remove": { "post": { "description": "Remove token identifiers from a revocation list.", "externalDocs": { "description": "See documentation for this operation in Akamai's Access Revocation API", "url": "https://techdocs.akamai.com/adaptive-media-delivery/reference/post-unrevoke-revocation-list-ids" }, "operationId": "post-unrevoke-revocation-list-ids", "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" } } ], "requestBody": { "content": { "application/json": { "example": [ "sqwoieksjbsdf3455", "9082349u534589824", "68sd899ff09sdf8787" ], "schema": { "description": "Token identifiers the API removes from your revocation list.", "items": { "minLength": 1, "type": "string" }, "maxItems": 50000, "minItems": 1, "type": "array", "x-akamai": { "file-path": "schemas/unrevoke-identifiers.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "count": 500, "limit": 50000 }, "schema": { "additionalProperties": false, "description": "The number of token identifiers in a revocation list and the maximum number it can house.", "properties": { "count": { "description": "The number of token identifiers currently in the revocation list.", "minimum": 0, "type": "integer" }, "limit": { "description": "The number of token identifiers you can still add to the revocation list.", "maximum": 50000, "minimum": 0, "type": "integer" } }, "required": [ "count", "limit" ], "type": "object", "x-akamai": { "file-path": "schemas/meta-info-200.yaml" } } } }, "description": "The API removed the tokens from the revocation list." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid body", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/adaptive-media-delivery/reference/400). You provided bad parameter data or formatted the request body incorrectly.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/adaptive-media-delivery/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials) is invalid or it has expired.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Access forbidden](https://techdocs.akamai.com/adaptive-media-delivery/reference/403). You lack permission for this operation, such as having read-only access.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/adaptive-media-delivery/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/adaptive-media-delivery/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials) is invalid or it has expired.", "x-akamai": { "file-path": "errors/401.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "Unsupported media type", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 415, "title": "Unsupported Media Type", "type": "unsupported_media_type" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Unsupported media type](https://techdocs.akamai.com/adaptive-media-delivery/reference/415). You've used an unsupported request or response content type, such as `application/xml`. Try the operation again using `application/json`.", "x-akamai": { "file-path": "errors/415.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/adaptive-media-delivery/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Unrevoke tokens", "tags": [ "Identifiers" ] }, "parameters": [ { "description": "Uniquely identifies each [revocation list](https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-lists). This corresponds to the revocation list object's `id` member.", "in": "path", "name": "revocationListId", "required": true, "schema": { "example": 120964235098767, "type": "integer" }, "x-akamai": { "file-path": "parameters/revocation-list-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/identifiers-remove.yaml", "path-info": "/revocation-lists/{revocationListId}/identifiers/remove" } }, "/revocation-lists/{revocationListId}/identifiers/{tokenId}": { "get": { "description": "Get a specific identifier that belongs to a revocation list and review its details.", "externalDocs": { "description": "See documentation for this operation in Akamai's Access Revocation API", "url": "https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-list-token" }, "operationId": "get-revocation-list-token", "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": { "id": "sqwoieksjbsdf3455", "ttl": 86400 }, "schema": { "additionalProperties": false, "description": "Parameters set for a unique token authentication token.", "properties": { "id": { "description": "The unique identifier assigned to the token.", "minLength": 1, "type": "string" }, "ttl": { "description": "The time to live (TTL) for the revocation list, in seconds. After this time elapses, Akamai removes this token from the revocation list.", "minimum": 1800, "type": "integer" } }, "required": [ "id", "ttl" ], "type": "object", "x-akamai": { "file-path": "schemas/identifier-200.yaml" } } } }, "description": "The response provides the revocation list." }, "401": { "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/adaptive-media-delivery/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials) is invalid or it has expired.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Access forbidden](https://techdocs.akamai.com/adaptive-media-delivery/reference/403). You lack permission for this operation, such as having read-only access.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/adaptive-media-delivery/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Not allowed](https://techdocs.akamai.com/adaptive-media-delivery/reference/405). You used an unsupported method with this operation. For example, you set the method to GET for a PUT operation.", "x-akamai": { "file-path": "errors/405.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/adaptive-media-delivery/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Get an identifier", "tags": [ "Identifiers" ] }, "parameters": [ { "description": "The token identifier portion of the complete Akamai token. A token identifier can contain a maximum of 64 alphanumeric characters, hyphens, or underscores.", "in": "path", "name": "tokenId", "required": true, "schema": { "example": "sqwoieksjbsdf3455-abc123_456jkl", "maxLength": 64, "type": "string" }, "x-akamai": { "file-path": "parameters/token-id-path.yaml" } }, { "description": "Uniquely identifies each [revocation list](https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-lists). This corresponds to the revocation list object's `id` member.", "in": "path", "name": "revocationListId", "required": true, "schema": { "example": 120964235098767, "type": "integer" }, "x-akamai": { "file-path": "parameters/revocation-list-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/identifier.yaml", "path-info": "/revocation-lists/{revocationListId}/identifiers/{tokenId}" } }, "/revocation-lists/{revocationListId}/meta": { "get": { "description": "Get the current count and maximum number of identifiers allowed in the revocation list.", "externalDocs": { "description": "See documentation for this operation in Akamai's Access Revocation API", "url": "https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-list-meta" }, "operationId": "get-revocation-list-meta", "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": { "count": 500, "limit": 50000 }, "schema": { "additionalProperties": false, "description": "The number of token identifiers in a revocation list and the maximum number it can house.", "properties": { "count": { "description": "The number of token identifiers currently in the revocation list.", "minimum": 0, "type": "integer" }, "limit": { "description": "The number of token identifiers you can still add to the revocation list.", "maximum": 50000, "minimum": 0, "type": "integer" } }, "required": [ "count", "limit" ], "type": "object", "x-akamai": { "file-path": "schemas/meta-info-200.yaml" } } } }, "description": "The response shows revocation list count information." }, "401": { "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/adaptive-media-delivery/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials) is invalid or it has expired.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Access forbidden](https://techdocs.akamai.com/adaptive-media-delivery/reference/403). You lack permission for this operation, such as having read-only access.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/adaptive-media-delivery/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Not allowed](https://techdocs.akamai.com/adaptive-media-delivery/reference/405). You used an unsupported method with this operation. For example, you set the method to GET for a PUT operation.", "x-akamai": { "file-path": "errors/405.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/adaptive-media-delivery/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Get a revocation list's identifier count", "tags": [ "Identifiers" ] }, "parameters": [ { "description": "Uniquely identifies each [revocation list](https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-lists). This corresponds to the revocation list object's `id` member.", "in": "path", "name": "revocationListId", "required": true, "schema": { "example": 120964235098767, "type": "integer" }, "x-akamai": { "file-path": "parameters/revocation-list-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/revocation-list-meta.yaml", "path-info": "/revocation-lists/{revocationListId}/meta" } }, "/revocation-lists/{revocationListId}/properties": { "get": { "description": "Get Property Manager-specific information for AMD properties that use this revocation list.", "externalDocs": { "description": "See documentation for this operation in Akamai's Access Revocation API", "url": "https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-list-properties" }, "operationId": "get-revocation-list-properties", "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": [ { "arlFileId": 12345, "propertyId": 3456789, "propertyName": "baseball-highlights.com" }, { "arlFileId": 56789, "propertyId": 12345678, "propertyName": "docsassociates.com" } ], "schema": { "description": "Information for each AMD property that uses a revocation list.", "items": { "additionalProperties": false, "description": "File information for each AMD property that uses a revocation list.", "properties": { "arlFileId": { "description": "The unique file identifier for the AMD property that's using access revocation.", "minimum": 1, "type": "integer" }, "propertyId": { "description": "The unique property ID assigned to the AMD property.", "minimum": 1, "type": "integer" }, "propertyName": { "description": "The property name set for the AMD property.", "minLength": 1, "type": "string" } }, "required": [ "arlFileId", "propertyId", "propertyName" ], "type": "object", "x-akamai": { "file-path": "schemas/revocation-list-property-details.yaml" } }, "minItems": 1, "type": "array", "x-akamai": { "file-path": "schemas/revocation-list-properties-200.yaml" } } } }, "description": "The response provides the AMD properties that use the revocation list." }, "401": { "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/adaptive-media-delivery/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials) is invalid or it has expired.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Access forbidden](https://techdocs.akamai.com/adaptive-media-delivery/reference/403). You lack permission for this operation, such as having read-only access.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/adaptive-media-delivery/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Not allowed](https://techdocs.akamai.com/adaptive-media-delivery/reference/405). You used an unsupported method with this operation. For example, you set the method to GET for a PUT operation.", "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "Unsupported media type", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 415, "title": "Unsupported Media Type", "type": "unsupported_media_type" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Unsupported media type](https://techdocs.akamai.com/adaptive-media-delivery/reference/415). You've used an unsupported request or response content type, such as `application/xml`. Try the operation again using `application/json`.", "x-akamai": { "file-path": "errors/415.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": true, "description": "Specific error details for the action.", "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ], "type": "integer" }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error. Possible values: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `not_allowed`, `unsupported_media_type`, `too_many_requests` or `internal_server_error`.", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "not_allowed", "unsupported_media_type", "too_many_requests", "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "status", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/adaptive-media-delivery/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "List revocation list ARL properties", "tags": [ "Properties" ] }, "parameters": [ { "description": "Uniquely identifies each [revocation list](https://techdocs.akamai.com/adaptive-media-delivery/reference/get-revocation-lists). This corresponds to the revocation list object's `id` member.", "in": "path", "name": "revocationListId", "required": true, "schema": { "example": 120964235098767, "type": "integer" }, "x-akamai": { "file-path": "parameters/revocation-list-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/properties.yaml", "path-info": "/revocation-lists/{revocationListId}/properties" } } }, "servers": [ { "url": "https://{hostname}/taas/v2" } ], "tags": [], "x-readme": { "samples-languages": [ "curl", "python", "node" ] } }