{ "openapi": "3.0.0", "externalDocs": { "description": "See documentation for Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference" }, "info": { "title": "Akamai: API Keys and Traffic Management API", "version": "1", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" } }, "paths": { "/collections": { "post": { "description": "Creates an empty collection under the selected contract and group.", "operationId": "post-collection", "summary": "Create a key collection", "tags": [ "Key collections" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/post-collection" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "contractId": "K-0N7RAK71", "description": "A collection with API keys for use by the Bookstore API premium users.", "groupId": 110202, "name": "Bookstore Premium Access" }, "schema": { "additionalProperties": false, "description": "Contains information about a collection.", "type": "object", "required": [ "name", "groupId", "contractId" ], "properties": { "contractId": { "description": "The unique identifier for the contract with Akamai under which you provision the collection.", "example": "{{contractId}}", "minLength": 1, "type": "string" }, "description": { "description": "The description that you provide for the collection. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "example": "{{description}}", "minLength": 0, "nullable": true, "type": "string" }, "dirty": { "description": "Whether the collection contains changes that are being propagated to the Akamai network.", "example": "{{dirty}}", "readOnly": true, "type": "boolean" }, "dirtyACL": { "description": "The endpoints or resources with ACL changes that are being propagated to the Akamai network.", "minItems": 0, "readOnly": true, "type": "array", "items": { "minLength": 1, "type": "string" } }, "grantedACL": { "description": "The endpoints, resources, and HTTP methods accessible to API consumers that identify with keys included in the collection.", "minItems": 0, "readOnly": true, "type": "array", "items": { "minLength": 1, "type": "string" } }, "groupId": { "description": "The unique identifier for the group in Control Center under which you provision the collection.", "example": "{{groupId}}", "minimum": 0, "type": "integer" }, "id": { "description": "The unique identifier for the collection.", "example": "{{id}}", "minimum": 0, "readOnly": true, "type": "integer" }, "keyCount": { "description": "The number of keys included in the collection.", "example": "{{keyCount}}", "minimum": 0, "nullable": true, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the collection.", "example": "{{name}}", "minLength": 1, "type": "string" }, "quota": { "additionalProperties": false, "description": "Contains information about quota settings for the collection.", "readOnly": true, "type": "object", "required": [ "value", "headers", "enabled", "interval" ], "properties": { "enabled": { "description": "Whether you enabled quota settings in the collection.", "type": "boolean" }, "headers": { "additionalProperties": false, "description": "Contains information about the criteria for sending the quota limit response headers.", "type": "object", "required": [ "allowLimitHeaderShown", "allowRemainingHeaderShown", "allowResetHeaderShown", "denyLimitHeaderShown", "denyNextHeaderShown", "denyRemainingHeaderShown" ], "properties": { "allowLimitHeaderShown": { "description": "Whether to send the `X-RateLimit-Limit` header in a response when the quota remains.", "type": "boolean" }, "allowRemainingHeaderShown": { "description": "Whether to send the `X-RateLimit-Remaining` header in a response when the quota remains.", "type": "boolean" }, "allowResetHeaderShown": { "description": "Whether to send the `X-RateLimit-Reset` header in a response when the quota remains.", "type": "boolean" }, "denyLimitHeaderShown": { "description": "Whether to send the `X-RateLimit-Limit` header in a response when the quota is full.", "type": "boolean" }, "denyNextHeaderShown": { "description": "Whether to send the `X-RateLimit-Next` header in a response when the quota is full.", "type": "boolean" }, "denyRemainingHeaderShown": { "description": "Whether to send the `X-RateLimit-Remaining` header in a response when the quota is full.", "type": "boolean" } } }, "interval": { "description": "The time period for the quota limit in UTC, either `HOUR_1` to reset at the start of each hour, `HOUR_6` at the start of each sixth hour, `HOUR_12` for twice daily, `DAY` for midnight each day, `WEEK` for midnight on each Monday, or `MONTH` for midnight on the first day of each month.", "type": "string", "enum": [ "HOUR_1", "HOUR_6", "HOUR_12", "DAY", "WEEK", "MONTH" ] }, "value": { "description": "The number of requests that each key from the collection can send to an API within the specified time period.", "maximum": 1000000000, "minimum": 100, "type": "integer" } } } }, "x-akamai": { "file-path": "schemas/keyCollectionDto.yaml" } } } } }, "responses": { "201": { "description": "The collection has been created.", "content": { "application/json": { "example": { "contractId": "K-0N7RAK7", "description": "A collection with API keys for use by the Bookstore API premium users.", "dirty": false, "groupId": 110202, "id": 108053, "keyCount": 0, "name": "Bookstore Premium Access", "dirtyACL": [], "grantedACL": [], "quota": { "enabled": false, "interval": "HOUR_1", "value": 100, "headers": { "allowLimitHeaderShown": true, "allowRemainingHeaderShown": true, "allowResetHeaderShown": true, "denyLimitHeaderShown": true, "denyNextHeaderShown": true, "denyRemainingHeaderShown": true } } }, "schema": { "additionalProperties": false, "description": "Contains information about a collection.", "type": "object", "required": [ "name", "groupId", "contractId" ], "properties": { "contractId": { "description": "The unique identifier for the contract with Akamai under which you provision the collection.", "minLength": 1, "type": "string" }, "description": { "description": "The description that you provide for the collection. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "minLength": 0, "nullable": true, "type": "string" }, "dirty": { "description": "Whether the collection contains changes that are being propagated to the Akamai network.", "readOnly": true, "type": "boolean" }, "dirtyACL": { "description": "The endpoints or resources with ACL changes that are being propagated to the Akamai network.", "minItems": 0, "readOnly": true, "type": "array", "items": { "minLength": 1, "type": "string" } }, "grantedACL": { "description": "The endpoints, resources, and HTTP methods accessible to API consumers that identify with keys included in the collection.", "minItems": 0, "readOnly": true, "type": "array", "items": { "minLength": 1, "type": "string" } }, "groupId": { "description": "The unique identifier for the group in Control Center under which you provision the collection.", "minimum": 0, "type": "integer" }, "id": { "description": "The unique identifier for the collection.", "minimum": 0, "readOnly": true, "type": "integer" }, "keyCount": { "description": "The number of keys included in the collection.", "minimum": 0, "nullable": true, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the collection.", "minLength": 1, "type": "string" }, "quota": { "additionalProperties": false, "description": "Contains information about quota settings for the collection.", "readOnly": true, "type": "object", "required": [ "value", "headers", "enabled", "interval" ], "properties": { "enabled": { "description": "Whether you enabled quota settings in the collection.", "type": "boolean" }, "headers": { "additionalProperties": false, "description": "Contains information about the criteria for sending the quota limit response headers.", "type": "object", "required": [ "allowLimitHeaderShown", "allowRemainingHeaderShown", "allowResetHeaderShown", "denyLimitHeaderShown", "denyNextHeaderShown", "denyRemainingHeaderShown" ], "properties": { "allowLimitHeaderShown": { "description": "Whether to send the `X-RateLimit-Limit` header in a response when the quota remains.", "type": "boolean" }, "allowRemainingHeaderShown": { "description": "Whether to send the `X-RateLimit-Remaining` header in a response when the quota remains.", "type": "boolean" }, "allowResetHeaderShown": { "description": "Whether to send the `X-RateLimit-Reset` header in a response when the quota remains.", "type": "boolean" }, "denyLimitHeaderShown": { "description": "Whether to send the `X-RateLimit-Limit` header in a response when the quota is full.", "type": "boolean" }, "denyNextHeaderShown": { "description": "Whether to send the `X-RateLimit-Next` header in a response when the quota is full.", "type": "boolean" }, "denyRemainingHeaderShown": { "description": "Whether to send the `X-RateLimit-Remaining` header in a response when the quota is full.", "type": "boolean" } } }, "interval": { "description": "The time period for the quota limit in UTC, either `HOUR_1` to reset at the start of each hour, `HOUR_6` at the start of each sixth hour, `HOUR_12` for twice daily, `DAY` for midnight each day, `WEEK` for midnight on each Monday, or `MONTH` for midnight on the first day of each month.", "type": "string", "enum": [ "HOUR_1", "HOUR_6", "HOUR_12", "DAY", "WEEK", "MONTH" ] }, "value": { "description": "The number of requests that each key from the collection can send to an API within the specified time period.", "maximum": 1000000000, "minimum": 100, "type": "integer" } } } }, "x-akamai": { "file-path": "schemas/keyCollectionDto.yaml" } } } }, "headers": { "Location": { "description": "A URI that points to the location of the newly created collection.", "schema": { "type": "string" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/key-traffic-mgmt/reference/400). The request contains invalid data.", "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "6ca7b4e8-a437-4082-87e0-7eddffa7f38d", "status": 400, "title": "Validation error", "type": "/apikey-manager-api/error-types/validation-error", "errors": [ { "detail": "This field must contain a non-blank value.", "field": "name", "title": "Empty field", "type": "/apikey-manager-api/error-types/not-empty" } ] }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to create a collection.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The collection could not be created.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "get": { "description": "Returns information about all collections available for the current contract and group.", "operationId": "get-collections", "summary": "List key collections", "tags": [ "Key collections" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collections" }, "responses": { "200": { "description": "The collections have been returned.", "content": { "application/json": { "schema": { "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Contains information about a collection.", "type": "object", "required": [ "name", "groupId", "contractId" ], "properties": { "contractId": { "description": "The unique identifier for the contract with Akamai under which you provision the collection.", "minLength": 1, "type": "string" }, "description": { "description": "The description that you provide for the collection. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "minLength": 0, "nullable": true, "type": "string" }, "dirty": { "description": "Whether the collection contains changes that are being propagated to the Akamai network.", "readOnly": true, "type": "boolean" }, "dirtyACL": { "description": "The endpoints or resources with ACL changes that are being propagated to the Akamai network.", "minItems": 0, "readOnly": true, "type": "array", "items": { "minLength": 1, "type": "string" } }, "grantedACL": { "description": "The endpoints, resources, and HTTP methods accessible to API consumers that identify with keys included in the collection.", "minItems": 0, "readOnly": true, "type": "array", "items": { "minLength": 1, "type": "string" } }, "groupId": { "description": "The unique identifier for the group in Control Center under which you provision the collection.", "minimum": 0, "type": "integer" }, "id": { "description": "The unique identifier for the collection.", "minimum": 0, "readOnly": true, "type": "integer" }, "keyCount": { "description": "The number of keys included in the collection.", "minimum": 0, "nullable": true, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the collection.", "minLength": 1, "type": "string" }, "quota": { "additionalProperties": false, "description": "Contains information about quota settings for the collection.", "readOnly": true, "type": "object", "required": [ "value", "headers", "enabled", "interval" ], "properties": { "enabled": { "description": "Whether you enabled quota settings in the collection.", "type": "boolean" }, "headers": { "additionalProperties": false, "description": "Contains information about the criteria for sending the quota limit response headers.", "type": "object", "required": [ "allowLimitHeaderShown", "allowRemainingHeaderShown", "allowResetHeaderShown", "denyLimitHeaderShown", "denyNextHeaderShown", "denyRemainingHeaderShown" ], "properties": { "allowLimitHeaderShown": { "description": "Whether to send the `X-RateLimit-Limit` header in a response when the quota remains.", "type": "boolean" }, "allowRemainingHeaderShown": { "description": "Whether to send the `X-RateLimit-Remaining` header in a response when the quota remains.", "type": "boolean" }, "allowResetHeaderShown": { "description": "Whether to send the `X-RateLimit-Reset` header in a response when the quota remains.", "type": "boolean" }, "denyLimitHeaderShown": { "description": "Whether to send the `X-RateLimit-Limit` header in a response when the quota is full.", "type": "boolean" }, "denyNextHeaderShown": { "description": "Whether to send the `X-RateLimit-Next` header in a response when the quota is full.", "type": "boolean" }, "denyRemainingHeaderShown": { "description": "Whether to send the `X-RateLimit-Remaining` header in a response when the quota is full.", "type": "boolean" } } }, "interval": { "description": "The time period for the quota limit in UTC, either `HOUR_1` to reset at the start of each hour, `HOUR_6` at the start of each sixth hour, `HOUR_12` for twice daily, `DAY` for midnight each day, `WEEK` for midnight on each Monday, or `MONTH` for midnight on the first day of each month.", "type": "string", "enum": [ "HOUR_1", "HOUR_6", "HOUR_12", "DAY", "WEEK", "MONTH" ] }, "value": { "description": "The number of requests that each key from the collection can send to an API within the specified time period.", "maximum": 1000000000, "minimum": 100, "type": "integer" } } } }, "x-akamai": { "file-path": "schemas/keyCollectionDto.yaml" } }, "x-akamai": { "file-path": "schemas/keyCollectionListDto.yaml" } }, "example": [ { "contractId": "K-0N7RAK71", "description": "A collection with API keys for use by the Bookstore API standard users.", "dirty": false, "groupId": 110202, "id": 108051, "keyCount": 21, "name": "Bookstore Access", "dirtyACL": [ "ENDPOINT-418250", "ENDPOINT-447203", "METHOD-106349", "RESOURCE-79491", "METHOD-106350" ], "grantedACL": [ "ENDPOINT-418250", "ENDPOINT-447203", "METHOD-106349", "RESOURCE-79491", "METHOD-106350" ], "quota": { "enabled": true, "interval": "HOUR_1", "value": 100, "headers": { "allowLimitHeaderShown": true, "allowRemainingHeaderShown": true, "allowResetHeaderShown": true, "denyLimitHeaderShown": true, "denyNextHeaderShown": true, "denyRemainingHeaderShown": true } } }, { "contractId": "C-0N7RAC71", "description": "A collection with API keys for use by the Bookstore API premium users.", "dirty": false, "groupId": 110202, "id": 108052, "keyCount": 2, "name": "Bookstore Premium Access", "dirtyACL": [], "grantedACL": [ "ENDPOINT-418250", "ENDPOINT-447203", "ENDPOINT-447205", "ENDPOINT-447210", "METHOD-106349", "METHOD-106350", "METHOD-106351", "METHOD-106352" ], "quota": { "enabled": false, "interval": "HOUR_1", "value": 100, "headers": { "allowLimitHeaderShown": true, "allowRemainingHeaderShown": true, "allowResetHeaderShown": true, "denyLimitHeaderShown": true, "denyNextHeaderShown": true, "denyRemainingHeaderShown": true } } } ] } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to get the collections.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The collections list is empty.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/collections/{collectionId}": { "get": { "description": "Returns information about a collection.", "operationId": "get-collection", "summary": "Get a key collection", "tags": [ "Key collections" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collection" }, "responses": { "200": { "description": "The collection has been returned.", "content": { "application/json": { "example": { "contractId": "K-0N7RAK7", "description": "A collection with API keys for use by the Bookstore API standard users.", "dirty": false, "groupId": 110202, "id": 108051, "keyCount": 21, "name": "Bookstore Access", "dirtyACL": [ "ENDPOINT-418250", "ENDPOINT-447203", "METHOD-106349", "RESOURCE-79491", "METHOD-106350" ], "grantedACL": [ "ENDPOINT-418250", "ENDPOINT-447203", "METHOD-106349", "RESOURCE-79491", "METHOD-106350" ], "quota": { "enabled": true, "interval": "HOUR_1", "value": 100, "headers": { "allowLimitHeaderShown": true, "allowRemainingHeaderShown": true, "allowResetHeaderShown": true, "denyLimitHeaderShown": true, "denyNextHeaderShown": true, "denyRemainingHeaderShown": true } } }, "schema": { "additionalProperties": false, "description": "Contains information about a collection.", "type": "object", "required": [ "name", "groupId", "contractId" ], "properties": { "contractId": { "description": "The unique identifier for the contract with Akamai under which you provision the collection.", "minLength": 1, "type": "string" }, "description": { "description": "The description that you provide for the collection. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "minLength": 0, "nullable": true, "type": "string" }, "dirty": { "description": "Whether the collection contains changes that are being propagated to the Akamai network.", "readOnly": true, "type": "boolean" }, "dirtyACL": { "description": "The endpoints or resources with ACL changes that are being propagated to the Akamai network.", "minItems": 0, "readOnly": true, "type": "array", "items": { "minLength": 1, "type": "string" } }, "grantedACL": { "description": "The endpoints, resources, and HTTP methods accessible to API consumers that identify with keys included in the collection.", "minItems": 0, "readOnly": true, "type": "array", "items": { "minLength": 1, "type": "string" } }, "groupId": { "description": "The unique identifier for the group in Control Center under which you provision the collection.", "minimum": 0, "type": "integer" }, "id": { "description": "The unique identifier for the collection.", "minimum": 0, "readOnly": true, "type": "integer" }, "keyCount": { "description": "The number of keys included in the collection.", "minimum": 0, "nullable": true, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the collection.", "minLength": 1, "type": "string" }, "quota": { "additionalProperties": false, "description": "Contains information about quota settings for the collection.", "readOnly": true, "type": "object", "required": [ "value", "headers", "enabled", "interval" ], "properties": { "enabled": { "description": "Whether you enabled quota settings in the collection.", "type": "boolean" }, "headers": { "additionalProperties": false, "description": "Contains information about the criteria for sending the quota limit response headers.", "type": "object", "required": [ "allowLimitHeaderShown", "allowRemainingHeaderShown", "allowResetHeaderShown", "denyLimitHeaderShown", "denyNextHeaderShown", "denyRemainingHeaderShown" ], "properties": { "allowLimitHeaderShown": { "description": "Whether to send the `X-RateLimit-Limit` header in a response when the quota remains.", "type": "boolean" }, "allowRemainingHeaderShown": { "description": "Whether to send the `X-RateLimit-Remaining` header in a response when the quota remains.", "type": "boolean" }, "allowResetHeaderShown": { "description": "Whether to send the `X-RateLimit-Reset` header in a response when the quota remains.", "type": "boolean" }, "denyLimitHeaderShown": { "description": "Whether to send the `X-RateLimit-Limit` header in a response when the quota is full.", "type": "boolean" }, "denyNextHeaderShown": { "description": "Whether to send the `X-RateLimit-Next` header in a response when the quota is full.", "type": "boolean" }, "denyRemainingHeaderShown": { "description": "Whether to send the `X-RateLimit-Remaining` header in a response when the quota is full.", "type": "boolean" } } }, "interval": { "description": "The time period for the quota limit in UTC, either `HOUR_1` to reset at the start of each hour, `HOUR_6` at the start of each sixth hour, `HOUR_12` for twice daily, `DAY` for midnight each day, `WEEK` for midnight on each Monday, or `MONTH` for midnight on the first day of each month.", "type": "string", "enum": [ "HOUR_1", "HOUR_6", "HOUR_12", "DAY", "WEEK", "MONTH" ] }, "value": { "description": "The number of requests that each key from the collection can send to an API within the specified time period.", "maximum": 1000000000, "minimum": 100, "type": "integer" } } } }, "x-akamai": { "file-path": "schemas/keyCollectionDto.yaml" } } } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to get the collection.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The collection could not be found.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "put": { "description": "Updates the name and description of a collection.", "operationId": "put-collection", "summary": "Edit a key collection", "tags": [ "Key collections" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/put-collection" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "contractId": "K-0N7RAK71", "description": "A collection with API keys for use by the Bookstore API standard users.", "dirty": false, "groupId": 110202, "id": 108051, "keyCount": 21, "name": "Bookstore Access", "dirtyACL": [ "ENDPOINT-418250", "ENDPOINT-447203", "METHOD-106349", "RESOURCE-79491", "METHOD-106350" ], "grantedACL": [ "ENDPOINT-418250", "ENDPOINT-447203", "METHOD-106349", "RESOURCE-79491", "METHOD-106350" ], "quota": { "enabled": true, "interval": "HOUR_1", "value": 100, "headers": { "allowLimitHeaderShown": true, "allowRemainingHeaderShown": true, "allowResetHeaderShown": true, "denyLimitHeaderShown": true, "denyNextHeaderShown": true, "denyRemainingHeaderShown": true } } }, "schema": { "additionalProperties": false, "description": "Contains information about a collection.", "type": "object", "required": [ "name", "groupId", "contractId" ], "properties": { "contractId": { "description": "The unique identifier for the contract with Akamai under which you provision the collection.", "example": "{{contractId}}", "minLength": 1, "type": "string" }, "description": { "description": "The description that you provide for the collection. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "example": "{{description}}", "minLength": 0, "nullable": true, "type": "string" }, "dirty": { "description": "Whether the collection contains changes that are being propagated to the Akamai network.", "example": "{{dirty}}", "readOnly": true, "type": "boolean" }, "dirtyACL": { "description": "The endpoints or resources with ACL changes that are being propagated to the Akamai network.", "minItems": 0, "readOnly": true, "type": "array", "items": { "minLength": 1, "type": "string" } }, "grantedACL": { "description": "The endpoints, resources, and HTTP methods accessible to API consumers that identify with keys included in the collection.", "minItems": 0, "readOnly": true, "type": "array", "items": { "minLength": 1, "type": "string" } }, "groupId": { "description": "The unique identifier for the group in Control Center under which you provision the collection.", "example": "{{groupId}}", "minimum": 0, "type": "integer" }, "id": { "description": "The unique identifier for the collection.", "example": "{{id}}", "minimum": 0, "readOnly": true, "type": "integer" }, "keyCount": { "description": "The number of keys included in the collection.", "example": "{{keyCount}}", "minimum": 0, "nullable": true, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the collection.", "example": "{{name}}", "minLength": 1, "type": "string" }, "quota": { "additionalProperties": false, "description": "Contains information about quota settings for the collection.", "readOnly": true, "type": "object", "required": [ "value", "headers", "enabled", "interval" ], "properties": { "enabled": { "description": "Whether you enabled quota settings in the collection.", "type": "boolean" }, "headers": { "additionalProperties": false, "description": "Contains information about the criteria for sending the quota limit response headers.", "type": "object", "required": [ "allowLimitHeaderShown", "allowRemainingHeaderShown", "allowResetHeaderShown", "denyLimitHeaderShown", "denyNextHeaderShown", "denyRemainingHeaderShown" ], "properties": { "allowLimitHeaderShown": { "description": "Whether to send the `X-RateLimit-Limit` header in a response when the quota remains.", "type": "boolean" }, "allowRemainingHeaderShown": { "description": "Whether to send the `X-RateLimit-Remaining` header in a response when the quota remains.", "type": "boolean" }, "allowResetHeaderShown": { "description": "Whether to send the `X-RateLimit-Reset` header in a response when the quota remains.", "type": "boolean" }, "denyLimitHeaderShown": { "description": "Whether to send the `X-RateLimit-Limit` header in a response when the quota is full.", "type": "boolean" }, "denyNextHeaderShown": { "description": "Whether to send the `X-RateLimit-Next` header in a response when the quota is full.", "type": "boolean" }, "denyRemainingHeaderShown": { "description": "Whether to send the `X-RateLimit-Remaining` header in a response when the quota is full.", "type": "boolean" } } }, "interval": { "description": "The time period for the quota limit in UTC, either `HOUR_1` to reset at the start of each hour, `HOUR_6` at the start of each sixth hour, `HOUR_12` for twice daily, `DAY` for midnight each day, `WEEK` for midnight on each Monday, or `MONTH` for midnight on the first day of each month.", "type": "string", "enum": [ "HOUR_1", "HOUR_6", "HOUR_12", "DAY", "WEEK", "MONTH" ] }, "value": { "description": "The number of requests that each key from the collection can send to an API within the specified time period.", "maximum": 1000000000, "minimum": 100, "type": "integer" } } } }, "x-akamai": { "file-path": "schemas/keyCollectionDto.yaml" } } } } }, "responses": { "200": { "description": "The collection has been updated.", "content": { "application/json": { "example": { "contractId": "C-0N7RAC71", "description": "A collection with API keys for use by the Bookstore API standard users.", "dirty": false, "groupId": 110202, "id": 108051, "keyCount": 21, "name": "Bookstore Access", "dirtyACL": [ "ENDPOINT-418250", "ENDPOINT-447203", "METHOD-106349", "RESOURCE-79491", "METHOD-106350" ], "grantedACL": [ "ENDPOINT-418250", "ENDPOINT-447203", "METHOD-106349", "RESOURCE-79491", "METHOD-106350" ], "quota": { "enabled": true, "interval": "HOUR_1", "value": 100, "headers": { "allowLimitHeaderShown": true, "allowRemainingHeaderShown": true, "allowResetHeaderShown": true, "denyLimitHeaderShown": true, "denyNextHeaderShown": true, "denyRemainingHeaderShown": true } } }, "schema": { "additionalProperties": false, "description": "Contains information about a collection.", "type": "object", "required": [ "name", "groupId", "contractId" ], "properties": { "contractId": { "description": "The unique identifier for the contract with Akamai under which you provision the collection.", "minLength": 1, "type": "string" }, "description": { "description": "The description that you provide for the collection. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "minLength": 0, "nullable": true, "type": "string" }, "dirty": { "description": "Whether the collection contains changes that are being propagated to the Akamai network.", "readOnly": true, "type": "boolean" }, "dirtyACL": { "description": "The endpoints or resources with ACL changes that are being propagated to the Akamai network.", "minItems": 0, "readOnly": true, "type": "array", "items": { "minLength": 1, "type": "string" } }, "grantedACL": { "description": "The endpoints, resources, and HTTP methods accessible to API consumers that identify with keys included in the collection.", "minItems": 0, "readOnly": true, "type": "array", "items": { "minLength": 1, "type": "string" } }, "groupId": { "description": "The unique identifier for the group in Control Center under which you provision the collection.", "minimum": 0, "type": "integer" }, "id": { "description": "The unique identifier for the collection.", "minimum": 0, "readOnly": true, "type": "integer" }, "keyCount": { "description": "The number of keys included in the collection.", "minimum": 0, "nullable": true, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the collection.", "minLength": 1, "type": "string" }, "quota": { "additionalProperties": false, "description": "Contains information about quota settings for the collection.", "readOnly": true, "type": "object", "required": [ "value", "headers", "enabled", "interval" ], "properties": { "enabled": { "description": "Whether you enabled quota settings in the collection.", "type": "boolean" }, "headers": { "additionalProperties": false, "description": "Contains information about the criteria for sending the quota limit response headers.", "type": "object", "required": [ "allowLimitHeaderShown", "allowRemainingHeaderShown", "allowResetHeaderShown", "denyLimitHeaderShown", "denyNextHeaderShown", "denyRemainingHeaderShown" ], "properties": { "allowLimitHeaderShown": { "description": "Whether to send the `X-RateLimit-Limit` header in a response when the quota remains.", "type": "boolean" }, "allowRemainingHeaderShown": { "description": "Whether to send the `X-RateLimit-Remaining` header in a response when the quota remains.", "type": "boolean" }, "allowResetHeaderShown": { "description": "Whether to send the `X-RateLimit-Reset` header in a response when the quota remains.", "type": "boolean" }, "denyLimitHeaderShown": { "description": "Whether to send the `X-RateLimit-Limit` header in a response when the quota is full.", "type": "boolean" }, "denyNextHeaderShown": { "description": "Whether to send the `X-RateLimit-Next` header in a response when the quota is full.", "type": "boolean" }, "denyRemainingHeaderShown": { "description": "Whether to send the `X-RateLimit-Remaining` header in a response when the quota is full.", "type": "boolean" } } }, "interval": { "description": "The time period for the quota limit in UTC, either `HOUR_1` to reset at the start of each hour, `HOUR_6` at the start of each sixth hour, `HOUR_12` for twice daily, `DAY` for midnight each day, `WEEK` for midnight on each Monday, or `MONTH` for midnight on the first day of each month.", "type": "string", "enum": [ "HOUR_1", "HOUR_6", "HOUR_12", "DAY", "WEEK", "MONTH" ] }, "value": { "description": "The number of requests that each key from the collection can send to an API within the specified time period.", "maximum": 1000000000, "minimum": 100, "type": "integer" } } } }, "x-akamai": { "file-path": "schemas/keyCollectionDto.yaml" } } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/key-traffic-mgmt/reference/400). The request contains invalid data.", "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "6ca7b4e8-a437-4082-87e0-7eddffa7f38d", "status": 400, "title": "Validation error", "type": "/apikey-manager-api/error-types/validation-error", "errors": [ { "detail": "This field must contain a non-blank value.", "field": "name", "title": "Empty field", "type": "/apikey-manager-api/error-types/not-empty" } ] }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to update the collection.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The collection could not be found.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "delete": { "description": "Deletes a collection and all keys included in the collection.", "operationId": "delete-collection", "summary": "Delete a key collection", "tags": [ "Key collections" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/delete-collection" }, "responses": { "204": { "description": "The collection has been deleted.", "content": { "*/*": {} } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to delete the collection.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The collection could not be found.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "The unique identifier for the collection.", "example": "{{collectionId}}", "in": "path", "name": "collectionId", "required": true, "schema": { "example": 12345, "type": "integer" }, "x-akamai": { "file-path": "parameters/collectionId-path.yaml" } } ] }, "/collections/{collectionId}/acl": { "put": { "description": "Updates the access control list of a collection by adding or removing endpoint, resource, and HTTP method information from the ACL.", "operationId": "put-collection-acl", "summary": "Edit an ACL", "tags": [ "ACLs" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/put-collection-acl" }, "requestBody": { "required": true, "content": { "application/json": { "example": [ "ENDPOINT-183165", "ENDPOINT-200159", "RESOURCE-9218", "METHOD-124320", "METHOD-124321" ], "schema": { "description": "The endpoints, resources, and HTTP methods in an access control list. An endpoint item is composed of the `ENDPOINT-` prefix and the `apiEndpointId` value. A resource item is composed of the `RESOURCE-` prefix and the `apiResourceLogicId` value. A method item is composed of the `METHOD-` prefix and the `apiResourceMethodLogicId` value.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" }, "x-akamai": { "file-path": "schemas/aclList.yaml" } } } } }, "responses": { "200": { "description": "The ACL has been updated.", "content": { "application/json": { "example": { "contractId": "K-0N7RAK71", "description": "A collection with API keys for use by the Bookstore API standard users.", "dirty": false, "groupId": 110202, "id": 108051, "keyCount": 21, "name": "Bookstore Access", "dirtyACL": [ "ENDPOINT-418250", "ENDPOINT-447203", "METHOD-106349", "RESOURCE-79491", "METHOD-106350" ], "grantedACL": [ "ENDPOINT-418250", "ENDPOINT-447203", "METHOD-106349", "RESOURCE-79491", "METHOD-106350" ], "quota": { "enabled": true, "interval": "HOUR_1", "value": 100, "headers": { "allowLimitHeaderShown": true, "allowRemainingHeaderShown": true, "allowResetHeaderShown": true, "denyLimitHeaderShown": true, "denyNextHeaderShown": true, "denyRemainingHeaderShown": true } } }, "schema": { "additionalProperties": false, "description": "Contains information about a collection.", "type": "object", "required": [ "name", "groupId", "contractId" ], "properties": { "contractId": { "description": "The unique identifier for the contract with Akamai under which you provision the collection.", "minLength": 1, "type": "string" }, "description": { "description": "The description that you provide for the collection. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "minLength": 0, "nullable": true, "type": "string" }, "dirty": { "description": "Whether the collection contains changes that are being propagated to the Akamai network.", "readOnly": true, "type": "boolean" }, "dirtyACL": { "description": "The endpoints or resources with ACL changes that are being propagated to the Akamai network.", "minItems": 0, "readOnly": true, "type": "array", "items": { "minLength": 1, "type": "string" } }, "grantedACL": { "description": "The endpoints, resources, and HTTP methods accessible to API consumers that identify with keys included in the collection.", "minItems": 0, "readOnly": true, "type": "array", "items": { "minLength": 1, "type": "string" } }, "groupId": { "description": "The unique identifier for the group in Control Center under which you provision the collection.", "minimum": 0, "type": "integer" }, "id": { "description": "The unique identifier for the collection.", "minimum": 0, "readOnly": true, "type": "integer" }, "keyCount": { "description": "The number of keys included in the collection.", "minimum": 0, "nullable": true, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the collection.", "minLength": 1, "type": "string" }, "quota": { "additionalProperties": false, "description": "Contains information about quota settings for the collection.", "readOnly": true, "type": "object", "required": [ "value", "headers", "enabled", "interval" ], "properties": { "enabled": { "description": "Whether you enabled quota settings in the collection.", "type": "boolean" }, "headers": { "additionalProperties": false, "description": "Contains information about the criteria for sending the quota limit response headers.", "type": "object", "required": [ "allowLimitHeaderShown", "allowRemainingHeaderShown", "allowResetHeaderShown", "denyLimitHeaderShown", "denyNextHeaderShown", "denyRemainingHeaderShown" ], "properties": { "allowLimitHeaderShown": { "description": "Whether to send the `X-RateLimit-Limit` header in a response when the quota remains.", "type": "boolean" }, "allowRemainingHeaderShown": { "description": "Whether to send the `X-RateLimit-Remaining` header in a response when the quota remains.", "type": "boolean" }, "allowResetHeaderShown": { "description": "Whether to send the `X-RateLimit-Reset` header in a response when the quota remains.", "type": "boolean" }, "denyLimitHeaderShown": { "description": "Whether to send the `X-RateLimit-Limit` header in a response when the quota is full.", "type": "boolean" }, "denyNextHeaderShown": { "description": "Whether to send the `X-RateLimit-Next` header in a response when the quota is full.", "type": "boolean" }, "denyRemainingHeaderShown": { "description": "Whether to send the `X-RateLimit-Remaining` header in a response when the quota is full.", "type": "boolean" } } }, "interval": { "description": "The time period for the quota limit in UTC, either `HOUR_1` to reset at the start of each hour, `HOUR_6` at the start of each sixth hour, `HOUR_12` for twice daily, `DAY` for midnight each day, `WEEK` for midnight on each Monday, or `MONTH` for midnight on the first day of each month.", "type": "string", "enum": [ "HOUR_1", "HOUR_6", "HOUR_12", "DAY", "WEEK", "MONTH" ] }, "value": { "description": "The number of requests that each key from the collection can send to an API within the specified time period.", "maximum": 1000000000, "minimum": 100, "type": "integer" } } } }, "x-akamai": { "file-path": "schemas/keyCollectionDto.yaml" } } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/key-traffic-mgmt/reference/400). The request contains invalid data.", "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "6ca7b4e8-a437-4082-87e0-7eddffa7f38d", "status": 400, "title": "Validation error", "type": "/apikey-manager-api/error-types/validation-error", "errors": [ { "detail": "This field must contain a non-blank value.", "field": "name", "title": "Empty field", "type": "/apikey-manager-api/error-types/not-empty" } ] }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to update an ACL.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The requested ACL could not be found.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "The unique identifier for the collection.", "example": "{{collectionId}}", "in": "path", "name": "collectionId", "required": true, "schema": { "example": 12345, "type": "integer" }, "x-akamai": { "file-path": "parameters/collectionId-path.yaml" } } ] }, "/collections/{collectionId}/endpoints": { "get": { "description": "Returns information about all endpoints assigned to the contract and group under which you created the collection. The format of the response data for this operation is managed by the [API Endpoints API](https://techdocs.akamai.com/api-gateway/reference/api).", "operationId": "get-collection-endpoints", "summary": "List collection endpoints", "tags": [ "Collection endpoints" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collection-endpoints" }, "responses": { "200": { "description": "The endpoints have been returned.", "content": { "application/json": { "schema": { "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "apiEndPointId": { "description": "The unique identifier for the endpoint.", "minimum": 0, "type": "integer" }, "apiEndPointName": { "description": "The name of the endpoint, unique within the account.", "minLength": 1, "type": "string" }, "apiResourceBaseInfo": { "description": "The collection of resource objects associated with the endpoint.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Basic information about endpoint resource.", "type": "object", "properties": { "apiResourceId": { "description": "The unique identifier for the resource.", "minimum": 0, "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across different endpoint versions.", "minimum": 0, "type": "integer" }, "apiResourceName": { "description": "The name of the resource.", "minLength": 1, "type": "string" }, "methods": { "description": "The collection of method objects associated with the resource.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Basic information about resource method.", "type": "object", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "type": "string", "enum": [ "GET", "POST", "PUT", "DELETE", "HEAD", "PATCH", "OPTIONS" ] }, "apiResourceMethodId": { "description": "The unique identifier for the resource's allowed method.", "minimum": 0, "type": "integer" }, "apiResourceMethodLogicId": { "description": "The unique identifier for the resource's method across all endpoint versions.", "minimum": 0, "type": "integer" }, "private": { "description": "Whether the resource method is private. API consumers can access resources with private method only if they identify with an appropriate API key.", "type": "boolean" }, "productionVersion": { "additionalProperties": false, "description": "Contains information about an endpoint version's activation status on the staging network.", "type": "object", "required": [ "versionNumber", "status" ], "properties": { "status": { "description": "The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "nullable": true, "type": "string", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ] }, "versionNumber": { "description": "The endpoint version number.", "minimum": 1, "nullable": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/activationStatus.yaml" } }, "stagingVersion": { "additionalProperties": false, "description": "Contains information about an endpoint version's activation status on the staging network.", "type": "object", "required": [ "versionNumber", "status" ], "properties": { "status": { "description": "The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "nullable": true, "type": "string", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ] }, "versionNumber": { "description": "The endpoint version number.", "minimum": 1, "nullable": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/activationStatus.yaml" } } }, "x-akamai": { "file-path": "schemas/endpointResourceMethod.yaml" } } }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "productionVersion": { "additionalProperties": false, "description": "Contains information about an endpoint version's activation status on the staging network.", "type": "object", "required": [ "versionNumber", "status" ], "properties": { "status": { "description": "The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "nullable": true, "type": "string", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ] }, "versionNumber": { "description": "The endpoint version number.", "minimum": 1, "nullable": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/activationStatus.yaml" } }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides.", "format": "uri", "type": "string" }, "stagingVersion": { "additionalProperties": false, "description": "Contains information about an endpoint version's activation status on the staging network.", "type": "object", "required": [ "versionNumber", "status" ], "properties": { "status": { "description": "The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "nullable": true, "type": "string", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ] }, "versionNumber": { "description": "The endpoint version number.", "minimum": 1, "nullable": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/activationStatus.yaml" } } }, "x-akamai": { "file-path": "schemas/endpointResourceBaseInfo.yaml" } } }, "basePath": { "description": "The URL path that serves as a root prefix for all resources `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string.", "minLength": 0, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "Contains information about an endpoint version's activation status on the staging network.", "type": "object", "required": [ "versionNumber", "status" ], "properties": { "status": { "description": "The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "nullable": true, "type": "string", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ] }, "versionNumber": { "description": "The endpoint version number.", "minimum": 1, "nullable": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/activationStatus.yaml" } }, "protectedByApiKey": { "description": "Either API endpoint is protected by API key.", "type": "boolean" }, "stagingVersion": { "additionalProperties": false, "description": "Contains information about an endpoint version's activation status on the staging network.", "type": "object", "required": [ "versionNumber", "status" ], "properties": { "status": { "description": "The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "nullable": true, "type": "string", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ] }, "versionNumber": { "description": "The endpoint version number.", "minimum": 1, "nullable": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/activationStatus.yaml" } }, "versionNumber": { "description": "The endpoint version number.", "minimum": 1, "type": "integer" } } }, "x-akamai": { "file-path": "schemas/endpoints.yaml" } }, "example": [ { "apiEndPointId": 814151, "apiEndPointName": "Bookstore API", "basePath": "/bookstore", "protectedByApiKey": false, "versionNumber": 4, "productionVersion": { "status": "DEACTIVATED", "versionNumber": 3 }, "stagingVersion": { "status": null, "versionNumber": null }, "apiResourceBaseInfo": [ { "apiResourceId": 4138863, "apiResourceLogicId": 170182, "apiResourceName": "book", "private": false, "resourcePath": "/book", "productionVersion": { "status": "DEACTIVATED", "versionNumber": 3 }, "stagingVersion": { "status": null, "versionNumber": null }, "methods": [ { "apiResourceMethod": "GET", "apiResourceMethodId": 878418, "apiResourceMethodLogicId": 238341, "private": false, "productionVersion": { "status": "DEACTIVATED", "versionNumber": 3 }, "stagingVersion": { "status": null, "versionNumber": null } }, { "apiResourceMethod": "POST", "apiResourceMethodId": 878417, "apiResourceMethodLogicId": 238344, "private": false, "productionVersion": { "status": "DEACTIVATED", "versionNumber": 3 }, "stagingVersion": { "status": null, "versionNumber": null } } ] } ] } ] } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to list endpoints.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The requested endpoints could not be found.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "The unique identifier for the collection.", "example": "{{collectionId}}", "in": "path", "name": "collectionId", "required": true, "schema": { "example": 12345, "type": "integer" }, "x-akamai": { "file-path": "parameters/collectionId-path.yaml" } } ] }, "/collections/{collectionId}/quota": { "put": { "description": "Updates the quota settings in a collection.", "operationId": "put-collection-quota", "summary": "Edit quota settings", "tags": [ "Quota settings" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/put-collection-quota" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "enabled": true, "interval": "HOUR_1", "value": 177, "headers": { "allowLimitHeaderShown": true, "allowRemainingHeaderShown": true, "allowResetHeaderShown": true, "denyLimitHeaderShown": true, "denyNextHeaderShown": true, "denyRemainingHeaderShown": true } }, "schema": { "additionalProperties": false, "description": "Contains information about quota settings.", "type": "object", "required": [ "enabled", "headers", "interval", "value" ], "properties": { "enabled": { "description": "Whether you enabled quota settings in the collection.", "example": "{{enabled}}", "type": "boolean" }, "headers": { "additionalProperties": false, "description": "Contains information about the criteria for sending the quota limit response headers.", "type": "object", "required": [ "allowLimitHeaderShown", "allowRemainingHeaderShown", "allowResetHeaderShown", "denyLimitHeaderShown", "denyNextHeaderShown", "denyRemainingHeaderShown" ], "properties": { "allowLimitHeaderShown": { "description": "Whether to send the `X-RateLimit-Limit` header in a response when the quota remains.", "type": "boolean" }, "allowRemainingHeaderShown": { "description": "Whether to send the `X-RateLimit-Remaining` header in a response when the quota remains.", "type": "boolean" }, "allowResetHeaderShown": { "description": "Whether to send the `X-RateLimit-Reset` header in a response when the quota remains.", "type": "boolean" }, "denyLimitHeaderShown": { "description": "Whether to send the `X-RateLimit-Limit` header in a response when the quota is full.", "type": "boolean" }, "denyNextHeaderShown": { "description": "Whether to send the `X-RateLimit-Next` header in a response when the quota is full.", "type": "boolean" }, "denyRemainingHeaderShown": { "description": "Whether to send the `X-RateLimit-Remaining` header in a response when the quota is full.", "type": "boolean" } } }, "interval": { "description": "The time period for the quota limit in UTC, either `HOUR_1` to reset at the start of each hour, `HOUR_6` at the start of each sixth hour, `HOUR_12` for twice daily, `DAY` for midnight each day, `WEEK` for midnight on each Monday, or `MONTH` for midnight on the first day of each month.", "example": "{{interval}}", "type": "string", "enum": [ "HOUR_1", "HOUR_6", "HOUR_12", "DAY", "WEEK", "MONTH" ] }, "value": { "description": "The number of requests that each key from the collection can send to an API within the specified time period.", "example": "{{value}}", "maximum": 1000000000, "minimum": 100, "type": "integer" } }, "x-akamai": { "file-path": "schemas/quotaCommand.yaml" } } } } }, "responses": { "200": { "description": "The quota has been updated.", "content": { "application/json": { "example": { "contractId": "K-0N7RAK7", "description": "A collection with API keys for use by the Bookstore API standard users.", "dirty": false, "groupId": 110202, "id": 108051, "keyCount": 21, "name": "Bookstore Access", "dirtyACL": [ "ENDPOINT-418250", "ENDPOINT-447203", "METHOD-106349", "RESOURCE-79491", "METHOD-106350" ], "grantedACL": [ "ENDPOINT-418250", "ENDPOINT-447203", "METHOD-106349", "RESOURCE-79491", "METHOD-106350" ], "quota": { "enabled": true, "interval": "HOUR_1", "value": 100, "headers": { "allowLimitHeaderShown": true, "allowRemainingHeaderShown": true, "allowResetHeaderShown": true, "denyLimitHeaderShown": true, "denyNextHeaderShown": true, "denyRemainingHeaderShown": true } } }, "schema": { "additionalProperties": false, "description": "Contains information about a collection.", "type": "object", "required": [ "name", "groupId", "contractId" ], "properties": { "contractId": { "description": "The unique identifier for the contract with Akamai under which you provision the collection.", "minLength": 1, "type": "string" }, "description": { "description": "The description that you provide for the collection. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "minLength": 0, "nullable": true, "type": "string" }, "dirty": { "description": "Whether the collection contains changes that are being propagated to the Akamai network.", "readOnly": true, "type": "boolean" }, "dirtyACL": { "description": "The endpoints or resources with ACL changes that are being propagated to the Akamai network.", "minItems": 0, "readOnly": true, "type": "array", "items": { "minLength": 1, "type": "string" } }, "grantedACL": { "description": "The endpoints, resources, and HTTP methods accessible to API consumers that identify with keys included in the collection.", "minItems": 0, "readOnly": true, "type": "array", "items": { "minLength": 1, "type": "string" } }, "groupId": { "description": "The unique identifier for the group in Control Center under which you provision the collection.", "minimum": 0, "type": "integer" }, "id": { "description": "The unique identifier for the collection.", "minimum": 0, "readOnly": true, "type": "integer" }, "keyCount": { "description": "The number of keys included in the collection.", "minimum": 0, "nullable": true, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the collection.", "minLength": 1, "type": "string" }, "quota": { "additionalProperties": false, "description": "Contains information about quota settings for the collection.", "readOnly": true, "type": "object", "required": [ "value", "headers", "enabled", "interval" ], "properties": { "enabled": { "description": "Whether you enabled quota settings in the collection.", "type": "boolean" }, "headers": { "additionalProperties": false, "description": "Contains information about the criteria for sending the quota limit response headers.", "type": "object", "required": [ "allowLimitHeaderShown", "allowRemainingHeaderShown", "allowResetHeaderShown", "denyLimitHeaderShown", "denyNextHeaderShown", "denyRemainingHeaderShown" ], "properties": { "allowLimitHeaderShown": { "description": "Whether to send the `X-RateLimit-Limit` header in a response when the quota remains.", "type": "boolean" }, "allowRemainingHeaderShown": { "description": "Whether to send the `X-RateLimit-Remaining` header in a response when the quota remains.", "type": "boolean" }, "allowResetHeaderShown": { "description": "Whether to send the `X-RateLimit-Reset` header in a response when the quota remains.", "type": "boolean" }, "denyLimitHeaderShown": { "description": "Whether to send the `X-RateLimit-Limit` header in a response when the quota is full.", "type": "boolean" }, "denyNextHeaderShown": { "description": "Whether to send the `X-RateLimit-Next` header in a response when the quota is full.", "type": "boolean" }, "denyRemainingHeaderShown": { "description": "Whether to send the `X-RateLimit-Remaining` header in a response when the quota is full.", "type": "boolean" } } }, "interval": { "description": "The time period for the quota limit in UTC, either `HOUR_1` to reset at the start of each hour, `HOUR_6` at the start of each sixth hour, `HOUR_12` for twice daily, `DAY` for midnight each day, `WEEK` for midnight on each Monday, or `MONTH` for midnight on the first day of each month.", "type": "string", "enum": [ "HOUR_1", "HOUR_6", "HOUR_12", "DAY", "WEEK", "MONTH" ] }, "value": { "description": "The number of requests that each key from the collection can send to an API within the specified time period.", "maximum": 1000000000, "minimum": 100, "type": "integer" } } } }, "x-akamai": { "file-path": "schemas/keyCollectionDto.yaml" } } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/key-traffic-mgmt/reference/400). The request contains invalid data.", "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "6ca7b4e8-a437-4082-87e0-7eddffa7f38d", "status": 400, "title": "Validation error", "type": "/apikey-manager-api/error-types/validation-error", "errors": [ { "detail": "This field must contain a non-blank value.", "field": "name", "title": "Empty field", "type": "/apikey-manager-api/error-types/not-empty" } ] }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to update quota.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The requested quota settings could not be found.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "The unique identifier for the collection.", "example": "{{collectionId}}", "in": "path", "name": "collectionId", "required": true, "schema": { "example": 12345, "type": "integer" }, "x-akamai": { "file-path": "parameters/collectionId-path.yaml" } } ] }, "/counters": { "post": { "description": "Creates a new throttling counter under the selected contract and group.", "operationId": "post-counter", "summary": "Create a throttling counter", "tags": [ "Throttling counters" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/post-counter" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "contractId": "C-0N7RAC7", "description": "A counter for requests to the books resource within the Bookstore API.", "dirty": false, "enabled": true, "groupId": 105425, "id": 61, "name": "Books counter", "onOverLimit": "WARN", "status": "ACTIVE", "throttling": 1000, "errorResponse": { "body": null, "overrideDefaults": true, "statusCode": 429, "headers": [] }, "headers": { "sendLimitToClient": false, "sendLimitToOrigin": false, "sendRateToClient": false, "sendRateToOrigin": true }, "rules": [ { "id": 64, "type": "ACL_ENTRY", "values": [ "ENDPOINT-290100", "RESOURCE-9946", "METHOD-43226", "METHOD-43227" ] }, { "id": 61, "type": "KEY", "values": [ 316013, 314095, 314097, 314098 ] }, { "id": 62, "type": "KEY_COLLECTION", "values": [ 416013, 414095, 414097, 414098 ] } ] }, "schema": { "additionalProperties": false, "description": "Contains information about a throttling counter.", "type": "object", "required": [ "enabled", "name", "contractId", "groupId", "throttling", "onOverLimit" ], "properties": { "contractId": { "description": "The unique identifier for the contract with Akamai under which you created the throttling counter.", "example": "{{contractId}}", "minLength": 0, "type": "string" }, "description": { "description": "The description that you provide for the throttling counter. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "example": "{{description}}", "maxLength": 4000, "minLength": 0, "nullable": true, "type": "string" }, "enabled": { "description": "Whether you enabled the throttling counter.", "example": "{{enabled}}", "type": "boolean" }, "errorResponse": { "additionalProperties": false, "description": "Contains information about a customizable error response.", "nullable": true, "type": "object", "required": [ "statusCode", "overrideDefaults" ], "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`). If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "minLength": 0, "nullable": true, "type": "string" }, "headers": { "description": "The list of HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` member indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "minItems": 0, "nullable": true, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "name", "value" ], "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "minLength": 1, "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "minLength": 1, "type": "string" } } } }, "overrideDefaults": { "description": "Whether you overrode the default error response.", "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "maximum": 599, "minimum": 200, "type": "integer" } }, "x-akamai": { "file-path": "schemas/errorResponseDto-schema.yaml" } }, "groupId": { "description": "The unique identifier for the group in Control Center under which you created the throttling counter.", "example": "{{groupId}}", "minimum": 0, "type": "integer" }, "headers": { "additionalProperties": false, "description": "Contains information about the criteria for sending the throttling limit and rate HTTP headers. This value may appear as `null` if you don't specify any throttling headers.", "nullable": true, "type": "object", "properties": { "sendLimitToClient": { "default": false, "description": "Whether to send the `X-Throttling-Limit` header in a response to a client.", "type": "boolean" }, "sendLimitToOrigin": { "default": false, "description": "Whether to send the `X-Throttling-Limit` header to your origin.", "type": "boolean" }, "sendRateToClient": { "default": false, "description": "Whether to send the `X-Throttling-Rate` header in a response to a client.", "type": "boolean" }, "sendRateToOrigin": { "default": false, "description": "Whether to send the `X-Throttling-Rate` header to your origin.", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/counterHeaders-schema.yaml" } }, "id": { "description": "The unique identifier for the throttling counter.", "example": "{{id}}", "minimum": 0, "readOnly": true, "type": "integer" }, "name": { "description": "The name that you provide for the throttling counter.", "example": "{{name}}", "maxLength": 200, "minLength": 1, "type": "string" }, "onOverLimit": { "description": "The instruction for edge servers on how to handle excessive requests when a throttling limit is reached. Either `DENY` to reject excessive requests, or `WARN` to send an alert when excessive requests reach edge servers.", "example": "{{onOverLimit}}", "type": "string", "enum": [ "DENY", "WARN" ] }, "ownerInfo": { "additionalProperties": false, "description": "Contains information about the owner of the counter.", "readOnly": true, "type": "object", "properties": { "accountId": { "description": "A unique identifier for an account.", "minLength": 1, "type": "string" }, "contractTypeId": { "description": "A unique identifier for a contract type.", "minLength": 1, "type": "string" }, "identity": { "description": "A unique identifier for a user.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/ownerInfo.yaml" } }, "rules": { "description": "The throttling conditions that cause the counter to increment.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Contains information about a set of throttling conditions that cause the throttling counter to increment. This value may appear as `null` if you don't specify any conditions.", "nullable": true, "type": "object", "required": [ "type", "values" ], "properties": { "id": { "description": "The unique identifier for the throttling condition.", "minimum": 0, "readOnly": true, "type": "integer" }, "type": { "description": "The type of the throttling condition. Either `KEY` for conditions associated with API keys, `KEY_COLLECTION` for conditions associated with API collections, or `ACL_ENTRY` for conditions associated with API endpoints, resources, or HTTP methods.", "type": "string", "enum": [ "KEY", "KEY_COLLECTION", "ACL_ENTRY" ] }, "values": { "description": "The specific values that trigger the throttling condition. If you selected `KEY` for the `type` member, specify API key integer IDs. If you selected `ACL_ENTRY` for the `type` member, specify strings that represent API endpoints, resources, or HTTP methods.", "maxItems": 10000, "minItems": 1, "type": "array", "items": { "oneOf": [ { "title": "Integer", "type": "integer" }, { "title": "String", "type": "string" } ] } } }, "x-akamai": { "file-path": "schemas/counterRule-schema.yaml" } } }, "status": { "description": "Specifies the status of throttling counter changes propagated on the Akamai network. `PENDING` means that changes are waiting to be propagated, `DIRTY` means that propagation of changes is in progress but has not yet finished, `ACTIVE` means that all changes have been propagated and counter settings are active throughout the Akamai network.", "example": "{{status}}", "readOnly": true, "type": "string", "enum": [ "PENDING", "DIRTY", "ACTIVE" ] }, "throttling": { "description": "The value of the request-per-second limit associated with the throttling counter. If the request count reaches the defined limit, API Gateway rejects any excessive requests with a 429 response until the moving average for this throttling counter diminishes to the set threshold. This usually takes up to ten seconds.", "example": "{{throttling}}", "maximum": 1000000, "minimum": 10, "type": "integer" } }, "x-akamai": { "file-path": "schemas/counter.yaml" } } } } }, "responses": { "201": { "description": "The counter has been created.", "content": { "application/json": { "example": { "contractId": "C-0N7RAC71", "description": "A counter for requests to the books resource within the Bookstore API.", "dirty": false, "enabled": true, "groupId": 105425, "id": 61, "name": "Books counter", "onOverLimit": "WARN", "status": "ACTIVE", "throttling": 1000, "errorResponse": { "body": null, "overrideDefaults": true, "statusCode": 429, "headers": [] }, "headers": { "sendLimitToClient": false, "sendLimitToOrigin": false, "sendRateToClient": false, "sendRateToOrigin": true }, "rules": [ { "id": 64, "type": "ACL_ENTRY", "values": [ "ENDPOINT-290100", "RESOURCE-9946", "METHOD-43226", "METHOD-43227" ] }, { "id": 61, "type": "KEY", "values": [ 316013, 314095, 314097, 314098 ] }, { "id": 62, "type": "KEY_COLLECTION", "values": [ 416013, 414095, 414097, 414098 ] } ] }, "schema": { "additionalProperties": false, "description": "Contains information about a throttling counter.", "type": "object", "required": [ "enabled", "name", "contractId", "groupId", "throttling", "onOverLimit" ], "properties": { "contractId": { "description": "The unique identifier for the contract with Akamai under which you created the throttling counter.", "minLength": 0, "type": "string" }, "description": { "description": "The description that you provide for the throttling counter. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "maxLength": 4000, "minLength": 0, "nullable": true, "type": "string" }, "enabled": { "description": "Whether you enabled the throttling counter.", "type": "boolean" }, "errorResponse": { "additionalProperties": false, "description": "Contains information about a customizable error response.", "nullable": true, "type": "object", "required": [ "statusCode", "overrideDefaults" ], "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`). If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "minLength": 0, "nullable": true, "type": "string" }, "headers": { "description": "The list of HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` member indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "minItems": 0, "nullable": true, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "name", "value" ], "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "minLength": 1, "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "minLength": 1, "type": "string" } } } }, "overrideDefaults": { "description": "Whether you overrode the default error response.", "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "maximum": 599, "minimum": 200, "type": "integer" } }, "x-akamai": { "file-path": "schemas/errorResponseDto-schema.yaml" } }, "groupId": { "description": "The unique identifier for the group in Control Center under which you created the throttling counter.", "minimum": 0, "type": "integer" }, "headers": { "additionalProperties": false, "description": "Contains information about the criteria for sending the throttling limit and rate HTTP headers. This value may appear as `null` if you don't specify any throttling headers.", "nullable": true, "type": "object", "properties": { "sendLimitToClient": { "default": false, "description": "Whether to send the `X-Throttling-Limit` header in a response to a client.", "type": "boolean" }, "sendLimitToOrigin": { "default": false, "description": "Whether to send the `X-Throttling-Limit` header to your origin.", "type": "boolean" }, "sendRateToClient": { "default": false, "description": "Whether to send the `X-Throttling-Rate` header in a response to a client.", "type": "boolean" }, "sendRateToOrigin": { "default": false, "description": "Whether to send the `X-Throttling-Rate` header to your origin.", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/counterHeaders-schema.yaml" } }, "id": { "description": "The unique identifier for the throttling counter.", "minimum": 0, "readOnly": true, "type": "integer" }, "name": { "description": "The name that you provide for the throttling counter.", "maxLength": 200, "minLength": 1, "type": "string" }, "onOverLimit": { "description": "The instruction for edge servers on how to handle excessive requests when a throttling limit is reached. Either `DENY` to reject excessive requests, or `WARN` to send an alert when excessive requests reach edge servers.", "type": "string", "enum": [ "DENY", "WARN" ] }, "ownerInfo": { "additionalProperties": false, "description": "Contains information about the owner of the counter.", "readOnly": true, "type": "object", "properties": { "accountId": { "description": "A unique identifier for an account.", "minLength": 1, "type": "string" }, "contractTypeId": { "description": "A unique identifier for a contract type.", "minLength": 1, "type": "string" }, "identity": { "description": "A unique identifier for a user.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/ownerInfo.yaml" } }, "rules": { "description": "The throttling conditions that cause the counter to increment.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Contains information about a set of throttling conditions that cause the throttling counter to increment. This value may appear as `null` if you don't specify any conditions.", "nullable": true, "type": "object", "required": [ "type", "values" ], "properties": { "id": { "description": "The unique identifier for the throttling condition.", "minimum": 0, "readOnly": true, "type": "integer" }, "type": { "description": "The type of the throttling condition. Either `KEY` for conditions associated with API keys, `KEY_COLLECTION` for conditions associated with API collections, or `ACL_ENTRY` for conditions associated with API endpoints, resources, or HTTP methods.", "type": "string", "enum": [ "KEY", "KEY_COLLECTION", "ACL_ENTRY" ] }, "values": { "description": "The specific values that trigger the throttling condition. If you selected `KEY` for the `type` member, specify API key integer IDs. If you selected `ACL_ENTRY` for the `type` member, specify strings that represent API endpoints, resources, or HTTP methods.", "maxItems": 10000, "minItems": 1, "type": "array", "items": { "oneOf": [ { "title": "Integer", "type": "integer" }, { "title": "String", "type": "string" } ] } } }, "x-akamai": { "file-path": "schemas/counterRule-schema.yaml" } } }, "status": { "description": "Specifies the status of throttling counter changes propagated on the Akamai network. `PENDING` means that changes are waiting to be propagated, `DIRTY` means that propagation of changes is in progress but has not yet finished, `ACTIVE` means that all changes have been propagated and counter settings are active throughout the Akamai network.", "readOnly": true, "type": "string", "enum": [ "PENDING", "DIRTY", "ACTIVE" ] }, "throttling": { "description": "The value of the request-per-second limit associated with the throttling counter. If the request count reaches the defined limit, API Gateway rejects any excessive requests with a 429 response until the moving average for this throttling counter diminishes to the set threshold. This usually takes up to ten seconds.", "maximum": 1000000, "minimum": 10, "type": "integer" } }, "x-akamai": { "file-path": "schemas/counter.yaml" } } } }, "headers": { "Location": { "description": "A URI that points to the location of the newly created counter.", "schema": { "type": "string" } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/key-traffic-mgmt/reference/400). The request contains invalid data.", "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "6ca7b4e8-a437-4082-87e0-7eddffa7f38d", "status": 400, "title": "Validation error", "type": "/apikey-manager-api/error-types/validation-error", "errors": [ { "detail": "This field must contain a non-blank value.", "field": "name", "title": "Empty field", "type": "/apikey-manager-api/error-types/not-empty" } ] }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to create a counter.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "get": { "description": "Returns all existing throttling counters available for the current contract and group.", "operationId": "get-counters", "summary": "List throttling counters", "tags": [ "Throttling counters" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/get-counters" }, "responses": { "200": { "description": "The counters have been returned.", "content": { "application/json": { "schema": { "description": "A list of throttling counters.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Contains information about a throttling counter.", "type": "object", "required": [ "enabled", "name", "contractId", "groupId", "throttling", "onOverLimit" ], "properties": { "contractId": { "description": "The unique identifier for the contract with Akamai under which you created the throttling counter.", "minLength": 0, "type": "string" }, "description": { "description": "The description that you provide for the throttling counter. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "maxLength": 4000, "minLength": 0, "nullable": true, "type": "string" }, "enabled": { "description": "Whether you enabled the throttling counter.", "type": "boolean" }, "errorResponse": { "additionalProperties": false, "description": "Contains information about a customizable error response.", "nullable": true, "type": "object", "required": [ "statusCode", "overrideDefaults" ], "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`). If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "minLength": 0, "nullable": true, "type": "string" }, "headers": { "description": "The list of HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` member indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "minItems": 0, "nullable": true, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "name", "value" ], "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "minLength": 1, "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "minLength": 1, "type": "string" } } } }, "overrideDefaults": { "description": "Whether you overrode the default error response.", "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "maximum": 599, "minimum": 200, "type": "integer" } }, "x-akamai": { "file-path": "schemas/errorResponseDto-schema.yaml" } }, "groupId": { "description": "The unique identifier for the group in Control Center under which you created the throttling counter.", "minimum": 0, "type": "integer" }, "headers": { "additionalProperties": false, "description": "Contains information about the criteria for sending the throttling limit and rate HTTP headers. This value may appear as `null` if you don't specify any throttling headers.", "nullable": true, "type": "object", "properties": { "sendLimitToClient": { "default": false, "description": "Whether to send the `X-Throttling-Limit` header in a response to a client.", "type": "boolean" }, "sendLimitToOrigin": { "default": false, "description": "Whether to send the `X-Throttling-Limit` header to your origin.", "type": "boolean" }, "sendRateToClient": { "default": false, "description": "Whether to send the `X-Throttling-Rate` header in a response to a client.", "type": "boolean" }, "sendRateToOrigin": { "default": false, "description": "Whether to send the `X-Throttling-Rate` header to your origin.", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/counterHeaders-schema.yaml" } }, "id": { "description": "The unique identifier for the throttling counter.", "minimum": 0, "readOnly": true, "type": "integer" }, "name": { "description": "The name that you provide for the throttling counter.", "maxLength": 200, "minLength": 1, "type": "string" }, "onOverLimit": { "description": "The instruction for edge servers on how to handle excessive requests when a throttling limit is reached. Either `DENY` to reject excessive requests, or `WARN` to send an alert when excessive requests reach edge servers.", "type": "string", "enum": [ "DENY", "WARN" ] }, "ownerInfo": { "additionalProperties": false, "description": "Contains information about the owner of the counter.", "readOnly": true, "type": "object", "properties": { "accountId": { "description": "A unique identifier for an account.", "minLength": 1, "type": "string" }, "contractTypeId": { "description": "A unique identifier for a contract type.", "minLength": 1, "type": "string" }, "identity": { "description": "A unique identifier for a user.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/ownerInfo.yaml" } }, "rules": { "description": "The throttling conditions that cause the counter to increment.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Contains information about a set of throttling conditions that cause the throttling counter to increment. This value may appear as `null` if you don't specify any conditions.", "nullable": true, "type": "object", "required": [ "type", "values" ], "properties": { "id": { "description": "The unique identifier for the throttling condition.", "minimum": 0, "readOnly": true, "type": "integer" }, "type": { "description": "The type of the throttling condition. Either `KEY` for conditions associated with API keys, `KEY_COLLECTION` for conditions associated with API collections, or `ACL_ENTRY` for conditions associated with API endpoints, resources, or HTTP methods.", "type": "string", "enum": [ "KEY", "KEY_COLLECTION", "ACL_ENTRY" ] }, "values": { "description": "The specific values that trigger the throttling condition. If you selected `KEY` for the `type` member, specify API key integer IDs. If you selected `ACL_ENTRY` for the `type` member, specify strings that represent API endpoints, resources, or HTTP methods.", "maxItems": 10000, "minItems": 1, "type": "array", "items": { "oneOf": [ { "title": "Integer", "type": "integer" }, { "title": "String", "type": "string" } ] } } }, "x-akamai": { "file-path": "schemas/counterRule-schema.yaml" } } }, "status": { "description": "Specifies the status of throttling counter changes propagated on the Akamai network. `PENDING` means that changes are waiting to be propagated, `DIRTY` means that propagation of changes is in progress but has not yet finished, `ACTIVE` means that all changes have been propagated and counter settings are active throughout the Akamai network.", "readOnly": true, "type": "string", "enum": [ "PENDING", "DIRTY", "ACTIVE" ] }, "throttling": { "description": "The value of the request-per-second limit associated with the throttling counter. If the request count reaches the defined limit, API Gateway rejects any excessive requests with a 429 response until the moving average for this throttling counter diminishes to the set threshold. This usually takes up to ten seconds.", "maximum": 1000000, "minimum": 10, "type": "integer" } }, "x-akamai": { "file-path": "schemas/counter.yaml" } }, "x-akamai": { "file-path": "schemas/counterList.yaml" } }, "example": [ { "contractId": "K-0N7RAK7", "createdAt": "2021-02-05T08:31:32.659081Z", "createdBy": "jperez", "description": "A counter for requests to the books resource within the Bookstore API.", "dirty": false, "enabled": true, "groupId": 105425, "id": 61, "name": "Books counter", "onOverLimit": "WARN", "status": "ACTIVE", "throttling": 1000, "updatedAt": "2021-02-15T20:12:01.197694Z", "updatedBy": "bookstore_admin", "errorResponse": { "body": null, "overrideDefaults": true, "statusCode": 429, "headers": [] }, "headers": { "sendLimitToClient": false, "sendLimitToOrigin": false, "sendRateToClient": false, "sendRateToOrigin": true }, "rules": [ { "id": 64, "type": "ACL_ENTRY", "values": [ "ENDPOINT-290100", "RESOURCE-9946", "METHOD-43226", "METHOD-43227" ] }, { "id": 61, "type": "KEY", "values": [ 316013, 314095, 314097, 314098 ] }, { "id": 62, "type": "KEY_COLLECTION", "values": [ 416013, 414095, 414097, 414098 ] } ] } ] } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to get the counters.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/counters/{counterId}": { "get": { "description": "Returns information about a throttling counter.", "operationId": "get-counter", "summary": "Get a throttling counter", "tags": [ "Throttling counters" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/get-counter" }, "responses": { "200": { "description": "The counter has been returned.", "content": { "application/json": { "example": { "contractId": "C-0N7RAC71", "description": "A counter for requests to the books resource within the Bookstore API.", "dirty": false, "enabled": true, "groupId": 105425, "id": 61, "name": "Books counter", "onOverLimit": "WARN", "status": "ACTIVE", "throttling": 1000, "errorResponse": { "body": null, "overrideDefaults": true, "statusCode": 429, "headers": [] }, "headers": { "sendLimitToClient": false, "sendLimitToOrigin": false, "sendRateToClient": false, "sendRateToOrigin": true }, "rules": [ { "id": 64, "type": "ACL_ENTRY", "values": [ "ENDPOINT-290100", "RESOURCE-9946", "METHOD-43226", "METHOD-43227" ] }, { "id": 61, "type": "KEY", "values": [ 316013, 314095, 314097, 314098 ] }, { "id": 62, "type": "KEY_COLLECTION", "values": [ 416013, 414095, 414097, 414098 ] } ] }, "schema": { "additionalProperties": false, "description": "Contains information about a throttling counter.", "type": "object", "required": [ "enabled", "name", "contractId", "groupId", "throttling", "onOverLimit" ], "properties": { "contractId": { "description": "The unique identifier for the contract with Akamai under which you created the throttling counter.", "minLength": 0, "type": "string" }, "description": { "description": "The description that you provide for the throttling counter. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "maxLength": 4000, "minLength": 0, "nullable": true, "type": "string" }, "enabled": { "description": "Whether you enabled the throttling counter.", "type": "boolean" }, "errorResponse": { "additionalProperties": false, "description": "Contains information about a customizable error response.", "nullable": true, "type": "object", "required": [ "statusCode", "overrideDefaults" ], "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`). If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "minLength": 0, "nullable": true, "type": "string" }, "headers": { "description": "The list of HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` member indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "minItems": 0, "nullable": true, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "name", "value" ], "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "minLength": 1, "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "minLength": 1, "type": "string" } } } }, "overrideDefaults": { "description": "Whether you overrode the default error response.", "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "maximum": 599, "minimum": 200, "type": "integer" } }, "x-akamai": { "file-path": "schemas/errorResponseDto-schema.yaml" } }, "groupId": { "description": "The unique identifier for the group in Control Center under which you created the throttling counter.", "minimum": 0, "type": "integer" }, "headers": { "additionalProperties": false, "description": "Contains information about the criteria for sending the throttling limit and rate HTTP headers. This value may appear as `null` if you don't specify any throttling headers.", "nullable": true, "type": "object", "properties": { "sendLimitToClient": { "default": false, "description": "Whether to send the `X-Throttling-Limit` header in a response to a client.", "type": "boolean" }, "sendLimitToOrigin": { "default": false, "description": "Whether to send the `X-Throttling-Limit` header to your origin.", "type": "boolean" }, "sendRateToClient": { "default": false, "description": "Whether to send the `X-Throttling-Rate` header in a response to a client.", "type": "boolean" }, "sendRateToOrigin": { "default": false, "description": "Whether to send the `X-Throttling-Rate` header to your origin.", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/counterHeaders-schema.yaml" } }, "id": { "description": "The unique identifier for the throttling counter.", "minimum": 0, "readOnly": true, "type": "integer" }, "name": { "description": "The name that you provide for the throttling counter.", "maxLength": 200, "minLength": 1, "type": "string" }, "onOverLimit": { "description": "The instruction for edge servers on how to handle excessive requests when a throttling limit is reached. Either `DENY` to reject excessive requests, or `WARN` to send an alert when excessive requests reach edge servers.", "type": "string", "enum": [ "DENY", "WARN" ] }, "ownerInfo": { "additionalProperties": false, "description": "Contains information about the owner of the counter.", "readOnly": true, "type": "object", "properties": { "accountId": { "description": "A unique identifier for an account.", "minLength": 1, "type": "string" }, "contractTypeId": { "description": "A unique identifier for a contract type.", "minLength": 1, "type": "string" }, "identity": { "description": "A unique identifier for a user.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/ownerInfo.yaml" } }, "rules": { "description": "The throttling conditions that cause the counter to increment.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Contains information about a set of throttling conditions that cause the throttling counter to increment. This value may appear as `null` if you don't specify any conditions.", "nullable": true, "type": "object", "required": [ "type", "values" ], "properties": { "id": { "description": "The unique identifier for the throttling condition.", "minimum": 0, "readOnly": true, "type": "integer" }, "type": { "description": "The type of the throttling condition. Either `KEY` for conditions associated with API keys, `KEY_COLLECTION` for conditions associated with API collections, or `ACL_ENTRY` for conditions associated with API endpoints, resources, or HTTP methods.", "type": "string", "enum": [ "KEY", "KEY_COLLECTION", "ACL_ENTRY" ] }, "values": { "description": "The specific values that trigger the throttling condition. If you selected `KEY` for the `type` member, specify API key integer IDs. If you selected `ACL_ENTRY` for the `type` member, specify strings that represent API endpoints, resources, or HTTP methods.", "maxItems": 10000, "minItems": 1, "type": "array", "items": { "oneOf": [ { "title": "Integer", "type": "integer" }, { "title": "String", "type": "string" } ] } } }, "x-akamai": { "file-path": "schemas/counterRule-schema.yaml" } } }, "status": { "description": "Specifies the status of throttling counter changes propagated on the Akamai network. `PENDING` means that changes are waiting to be propagated, `DIRTY` means that propagation of changes is in progress but has not yet finished, `ACTIVE` means that all changes have been propagated and counter settings are active throughout the Akamai network.", "readOnly": true, "type": "string", "enum": [ "PENDING", "DIRTY", "ACTIVE" ] }, "throttling": { "description": "The value of the request-per-second limit associated with the throttling counter. If the request count reaches the defined limit, API Gateway rejects any excessive requests with a 429 response until the moving average for this throttling counter diminishes to the set threshold. This usually takes up to ten seconds.", "maximum": 1000000, "minimum": 10, "type": "integer" } }, "x-akamai": { "file-path": "schemas/counter.yaml" } } } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to get the counter.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The counter could not be found.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "put": { "description": "Updates information about a throttling counter.", "operationId": "put-counter", "summary": "Edit a throttling counter", "tags": [ "Throttling counters" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/put-counter" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "contractId": "K-0N7RAK71", "description": "A counter for requests to the books resource within the Bookstore API.", "dirty": false, "enabled": true, "groupId": 105425, "id": 61, "name": "Books counter", "onOverLimit": "WARN", "status": "ACTIVE", "throttling": 1000, "errorResponse": { "body": null, "overrideDefaults": true, "statusCode": 429, "headers": [] }, "headers": { "sendLimitToClient": false, "sendLimitToOrigin": false, "sendRateToClient": false, "sendRateToOrigin": true }, "rules": [ { "id": 64, "type": "ACL_ENTRY", "values": [ "ENDPOINT-290100", "RESOURCE-9946", "METHOD-43226", "METHOD-43227" ] }, { "id": 61, "type": "KEY", "values": [ 316013, 314095, 314097, 314098 ] }, { "id": 62, "type": "KEY_COLLECTION", "values": [ 416013, 414095, 414097, 414098 ] } ] }, "schema": { "additionalProperties": false, "description": "Contains information about a throttling counter.", "type": "object", "required": [ "enabled", "name", "contractId", "groupId", "throttling", "onOverLimit" ], "properties": { "contractId": { "description": "The unique identifier for the contract with Akamai under which you created the throttling counter.", "example": "{{contractId}}", "minLength": 0, "type": "string" }, "description": { "description": "The description that you provide for the throttling counter. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "example": "{{description}}", "maxLength": 4000, "minLength": 0, "nullable": true, "type": "string" }, "enabled": { "description": "Whether you enabled the throttling counter.", "example": "{{enabled}}", "type": "boolean" }, "errorResponse": { "additionalProperties": false, "description": "Contains information about a customizable error response.", "nullable": true, "type": "object", "required": [ "statusCode", "overrideDefaults" ], "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`). If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "minLength": 0, "nullable": true, "type": "string" }, "headers": { "description": "The list of HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` member indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "minItems": 0, "nullable": true, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "name", "value" ], "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "minLength": 1, "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "minLength": 1, "type": "string" } } } }, "overrideDefaults": { "description": "Whether you overrode the default error response.", "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "maximum": 599, "minimum": 200, "type": "integer" } }, "x-akamai": { "file-path": "schemas/errorResponseDto-schema.yaml" } }, "groupId": { "description": "The unique identifier for the group in Control Center under which you created the throttling counter.", "example": "{{groupId}}", "minimum": 0, "type": "integer" }, "headers": { "additionalProperties": false, "description": "Contains information about the criteria for sending the throttling limit and rate HTTP headers. This value may appear as `null` if you don't specify any throttling headers.", "nullable": true, "type": "object", "properties": { "sendLimitToClient": { "default": false, "description": "Whether to send the `X-Throttling-Limit` header in a response to a client.", "type": "boolean" }, "sendLimitToOrigin": { "default": false, "description": "Whether to send the `X-Throttling-Limit` header to your origin.", "type": "boolean" }, "sendRateToClient": { "default": false, "description": "Whether to send the `X-Throttling-Rate` header in a response to a client.", "type": "boolean" }, "sendRateToOrigin": { "default": false, "description": "Whether to send the `X-Throttling-Rate` header to your origin.", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/counterHeaders-schema.yaml" } }, "id": { "description": "The unique identifier for the throttling counter.", "example": "{{id}}", "minimum": 0, "readOnly": true, "type": "integer" }, "name": { "description": "The name that you provide for the throttling counter.", "example": "{{name}}", "maxLength": 200, "minLength": 1, "type": "string" }, "onOverLimit": { "description": "The instruction for edge servers on how to handle excessive requests when a throttling limit is reached. Either `DENY` to reject excessive requests, or `WARN` to send an alert when excessive requests reach edge servers.", "example": "{{onOverLimit}}", "type": "string", "enum": [ "DENY", "WARN" ] }, "ownerInfo": { "additionalProperties": false, "description": "Contains information about the owner of the counter.", "readOnly": true, "type": "object", "properties": { "accountId": { "description": "A unique identifier for an account.", "minLength": 1, "type": "string" }, "contractTypeId": { "description": "A unique identifier for a contract type.", "minLength": 1, "type": "string" }, "identity": { "description": "A unique identifier for a user.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/ownerInfo.yaml" } }, "rules": { "description": "The throttling conditions that cause the counter to increment.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Contains information about a set of throttling conditions that cause the throttling counter to increment. This value may appear as `null` if you don't specify any conditions.", "nullable": true, "type": "object", "required": [ "type", "values" ], "properties": { "id": { "description": "The unique identifier for the throttling condition.", "minimum": 0, "readOnly": true, "type": "integer" }, "type": { "description": "The type of the throttling condition. Either `KEY` for conditions associated with API keys, `KEY_COLLECTION` for conditions associated with API collections, or `ACL_ENTRY` for conditions associated with API endpoints, resources, or HTTP methods.", "type": "string", "enum": [ "KEY", "KEY_COLLECTION", "ACL_ENTRY" ] }, "values": { "description": "The specific values that trigger the throttling condition. If you selected `KEY` for the `type` member, specify API key integer IDs. If you selected `ACL_ENTRY` for the `type` member, specify strings that represent API endpoints, resources, or HTTP methods.", "maxItems": 10000, "minItems": 1, "type": "array", "items": { "oneOf": [ { "title": "Integer", "type": "integer" }, { "title": "String", "type": "string" } ] } } }, "x-akamai": { "file-path": "schemas/counterRule-schema.yaml" } } }, "status": { "description": "Specifies the status of throttling counter changes propagated on the Akamai network. `PENDING` means that changes are waiting to be propagated, `DIRTY` means that propagation of changes is in progress but has not yet finished, `ACTIVE` means that all changes have been propagated and counter settings are active throughout the Akamai network.", "example": "{{status}}", "readOnly": true, "type": "string", "enum": [ "PENDING", "DIRTY", "ACTIVE" ] }, "throttling": { "description": "The value of the request-per-second limit associated with the throttling counter. If the request count reaches the defined limit, API Gateway rejects any excessive requests with a 429 response until the moving average for this throttling counter diminishes to the set threshold. This usually takes up to ten seconds.", "example": "{{throttling}}", "maximum": 1000000, "minimum": 10, "type": "integer" } }, "x-akamai": { "file-path": "schemas/counter.yaml" } } } } }, "responses": { "200": { "description": "The counter has been updated.", "content": { "application/json": { "example": { "contractId": "K-0N7RAK71", "description": "A counter for requests to the books resource within the Bookstore API.", "dirty": false, "enabled": true, "groupId": 105425, "id": 61, "name": "Books counter", "onOverLimit": "WARN", "status": "ACTIVE", "throttling": 1000, "errorResponse": { "body": null, "overrideDefaults": true, "statusCode": 429, "headers": [] }, "headers": { "sendLimitToClient": false, "sendLimitToOrigin": false, "sendRateToClient": false, "sendRateToOrigin": true }, "rules": [ { "id": 64, "type": "ACL_ENTRY", "values": [ "ENDPOINT-290100", "RESOURCE-9946", "METHOD-43226", "METHOD-43227" ] }, { "id": 61, "type": "KEY", "values": [ 316013, 314095, 314097, 314098 ] }, { "id": 62, "type": "KEY_COLLECTION", "values": [ 416013, 414095, 414097, 414098 ] } ] }, "schema": { "additionalProperties": false, "description": "Contains information about a throttling counter.", "type": "object", "required": [ "enabled", "name", "contractId", "groupId", "throttling", "onOverLimit" ], "properties": { "contractId": { "description": "The unique identifier for the contract with Akamai under which you created the throttling counter.", "minLength": 0, "type": "string" }, "description": { "description": "The description that you provide for the throttling counter. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "maxLength": 4000, "minLength": 0, "nullable": true, "type": "string" }, "enabled": { "description": "Whether you enabled the throttling counter.", "type": "boolean" }, "errorResponse": { "additionalProperties": false, "description": "Contains information about a customizable error response.", "nullable": true, "type": "object", "required": [ "statusCode", "overrideDefaults" ], "properties": { "body": { "description": "The response body to return in case of the error. The value should have the proper formatting to reflect the content type. For example, in case of a JSON body format, enclose the text in curly brackets (`{}`). If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "minLength": 0, "nullable": true, "type": "string" }, "headers": { "description": "The list of HTTP headers to return in case of the error. By default, API Gateway returns the `Content-Type` header with a value of `application/problem+json` which reflects the default response body. If the `body` member indicates a different content type, set the `Content-Type` header to the appropriate value. For example, in case of an XML body, the value could be `application/problem+xml`.", "minItems": 0, "nullable": true, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "name", "value" ], "properties": { "name": { "description": "The name of the HTTP header to return in case of the error.", "minLength": 1, "type": "string" }, "value": { "description": "The value of the HTTP header to return in case of the error.", "minLength": 1, "type": "string" } } } }, "overrideDefaults": { "description": "Whether you overrode the default error response.", "type": "boolean" }, "statusCode": { "description": "The status code to return in case of the error.", "maximum": 599, "minimum": 200, "type": "integer" } }, "x-akamai": { "file-path": "schemas/errorResponseDto-schema.yaml" } }, "groupId": { "description": "The unique identifier for the group in Control Center under which you created the throttling counter.", "minimum": 0, "type": "integer" }, "headers": { "additionalProperties": false, "description": "Contains information about the criteria for sending the throttling limit and rate HTTP headers. This value may appear as `null` if you don't specify any throttling headers.", "nullable": true, "type": "object", "properties": { "sendLimitToClient": { "default": false, "description": "Whether to send the `X-Throttling-Limit` header in a response to a client.", "type": "boolean" }, "sendLimitToOrigin": { "default": false, "description": "Whether to send the `X-Throttling-Limit` header to your origin.", "type": "boolean" }, "sendRateToClient": { "default": false, "description": "Whether to send the `X-Throttling-Rate` header in a response to a client.", "type": "boolean" }, "sendRateToOrigin": { "default": false, "description": "Whether to send the `X-Throttling-Rate` header to your origin.", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/counterHeaders-schema.yaml" } }, "id": { "description": "The unique identifier for the throttling counter.", "minimum": 0, "readOnly": true, "type": "integer" }, "name": { "description": "The name that you provide for the throttling counter.", "maxLength": 200, "minLength": 1, "type": "string" }, "onOverLimit": { "description": "The instruction for edge servers on how to handle excessive requests when a throttling limit is reached. Either `DENY` to reject excessive requests, or `WARN` to send an alert when excessive requests reach edge servers.", "type": "string", "enum": [ "DENY", "WARN" ] }, "ownerInfo": { "additionalProperties": false, "description": "Contains information about the owner of the counter.", "readOnly": true, "type": "object", "properties": { "accountId": { "description": "A unique identifier for an account.", "minLength": 1, "type": "string" }, "contractTypeId": { "description": "A unique identifier for a contract type.", "minLength": 1, "type": "string" }, "identity": { "description": "A unique identifier for a user.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/ownerInfo.yaml" } }, "rules": { "description": "The throttling conditions that cause the counter to increment.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Contains information about a set of throttling conditions that cause the throttling counter to increment. This value may appear as `null` if you don't specify any conditions.", "nullable": true, "type": "object", "required": [ "type", "values" ], "properties": { "id": { "description": "The unique identifier for the throttling condition.", "minimum": 0, "readOnly": true, "type": "integer" }, "type": { "description": "The type of the throttling condition. Either `KEY` for conditions associated with API keys, `KEY_COLLECTION` for conditions associated with API collections, or `ACL_ENTRY` for conditions associated with API endpoints, resources, or HTTP methods.", "type": "string", "enum": [ "KEY", "KEY_COLLECTION", "ACL_ENTRY" ] }, "values": { "description": "The specific values that trigger the throttling condition. If you selected `KEY` for the `type` member, specify API key integer IDs. If you selected `ACL_ENTRY` for the `type` member, specify strings that represent API endpoints, resources, or HTTP methods.", "maxItems": 10000, "minItems": 1, "type": "array", "items": { "oneOf": [ { "title": "Integer", "type": "integer" }, { "title": "String", "type": "string" } ] } } }, "x-akamai": { "file-path": "schemas/counterRule-schema.yaml" } } }, "status": { "description": "Specifies the status of throttling counter changes propagated on the Akamai network. `PENDING` means that changes are waiting to be propagated, `DIRTY` means that propagation of changes is in progress but has not yet finished, `ACTIVE` means that all changes have been propagated and counter settings are active throughout the Akamai network.", "readOnly": true, "type": "string", "enum": [ "PENDING", "DIRTY", "ACTIVE" ] }, "throttling": { "description": "The value of the request-per-second limit associated with the throttling counter. If the request count reaches the defined limit, API Gateway rejects any excessive requests with a 429 response until the moving average for this throttling counter diminishes to the set threshold. This usually takes up to ten seconds.", "maximum": 1000000, "minimum": 10, "type": "integer" } }, "x-akamai": { "file-path": "schemas/counter.yaml" } } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/key-traffic-mgmt/reference/400). The request contains invalid data.", "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "6ca7b4e8-a437-4082-87e0-7eddffa7f38d", "status": 400, "title": "Validation error", "type": "/apikey-manager-api/error-types/validation-error", "errors": [ { "detail": "This field must contain a non-blank value.", "field": "name", "title": "Empty field", "type": "/apikey-manager-api/error-types/not-empty" } ] }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to update the counter.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The counter could not be found.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "delete": { "description": "Removes a throttling counter.", "operationId": "delete-counter", "summary": "Delete a throttling counter", "tags": [ "Throttling counters" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/delete-counter" }, "responses": { "204": { "description": "The counter has been deleted.", "content": { "*/*": {} } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to update the counter.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The counter could not be found.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "The unique identifier for the throttling counter.", "example": "{{counterId}}", "in": "path", "name": "counterId", "required": true, "schema": { "example": 54321, "type": "integer" }, "x-akamai": { "file-path": "parameters/counterId-path.yaml" } } ] }, "/counters/{counterId}/endpoints": { "get": { "description": "Returns information about all endpoints assigned to the contract and group under which you created the throttling counter. The format of the response data for this operation is managed by the [API Endpoints API](https://techdocs.akamai.com/api-gateway/reference/api). Search the response data for the relevant `ACL_ENTRY` members (API endpoint IDs, resource IDs, or HTTP methods) to use when running the [Create a throttling counter](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-counter) or [Update a throttling counter](https://techdocs.akamai.com/key-traffic-mgmt/reference/put-counter) operation.", "operationId": "get-counter-endpoints", "summary": "List counter endpoints", "tags": [ "Counter endpoints" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/get-counter-endpoints" }, "responses": { "200": { "description": "The endpoints have been returned.", "content": { "application/json": { "schema": { "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "apiEndPointId": { "description": "The unique identifier for the endpoint.", "minimum": 0, "type": "integer" }, "apiEndPointName": { "description": "The name of the endpoint, unique within the account.", "minLength": 1, "type": "string" }, "apiResourceBaseInfo": { "description": "The collection of resource objects associated with the endpoint.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Basic information about endpoint resource.", "type": "object", "properties": { "apiResourceId": { "description": "The unique identifier for the resource.", "minimum": 0, "type": "integer" }, "apiResourceLogicId": { "description": "The unique identifier for the resource across different endpoint versions.", "minimum": 0, "type": "integer" }, "apiResourceName": { "description": "The name of the resource.", "minLength": 1, "type": "string" }, "methods": { "description": "The collection of method objects associated with the resource.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Basic information about resource method.", "type": "object", "properties": { "apiResourceMethod": { "description": "The core HTTP method to which the resource may respond, either `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `PATCH`, or `OPTIONS`.", "type": "string", "enum": [ "GET", "POST", "PUT", "DELETE", "HEAD", "PATCH", "OPTIONS" ] }, "apiResourceMethodId": { "description": "The unique identifier for the resource's allowed method.", "minimum": 0, "type": "integer" }, "apiResourceMethodLogicId": { "description": "The unique identifier for the resource's method across all endpoint versions.", "minimum": 0, "type": "integer" }, "private": { "description": "Whether the resource method is private. API consumers can access resources with private method only if they identify with an appropriate API key.", "type": "boolean" }, "productionVersion": { "additionalProperties": false, "description": "Contains information about an endpoint version's activation status on the staging network.", "type": "object", "required": [ "versionNumber", "status" ], "properties": { "status": { "description": "The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "nullable": true, "type": "string", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ] }, "versionNumber": { "description": "The endpoint version number.", "minimum": 1, "nullable": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/activationStatus.yaml" } }, "stagingVersion": { "additionalProperties": false, "description": "Contains information about an endpoint version's activation status on the staging network.", "type": "object", "required": [ "versionNumber", "status" ], "properties": { "status": { "description": "The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "nullable": true, "type": "string", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ] }, "versionNumber": { "description": "The endpoint version number.", "minimum": 1, "nullable": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/activationStatus.yaml" } } }, "x-akamai": { "file-path": "schemas/endpointResourceMethod.yaml" } } }, "private": { "description": "Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.", "type": "boolean" }, "productionVersion": { "additionalProperties": false, "description": "Contains information about an endpoint version's activation status on the staging network.", "type": "object", "required": [ "versionNumber", "status" ], "properties": { "status": { "description": "The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "nullable": true, "type": "string", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ] }, "versionNumber": { "description": "The endpoint version number.", "minimum": 1, "nullable": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/activationStatus.yaml" } }, "resourcePath": { "description": "The URL path relative to the hostnames on which the resource resides.", "format": "uri", "type": "string" }, "stagingVersion": { "additionalProperties": false, "description": "Contains information about an endpoint version's activation status on the staging network.", "type": "object", "required": [ "versionNumber", "status" ], "properties": { "status": { "description": "The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "nullable": true, "type": "string", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ] }, "versionNumber": { "description": "The endpoint version number.", "minimum": 1, "nullable": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/activationStatus.yaml" } } }, "x-akamai": { "file-path": "schemas/endpointResourceBaseInfo.yaml" } } }, "basePath": { "description": "The URL path that serves as a root prefix for all resources `resourcePath` values. This is `/` if empty. Don't append a `/` character to the path. If you specify `null` in the request or omit this member from the object, the JSON response reflects it as an empty string.", "minLength": 0, "type": "string" }, "productionVersion": { "additionalProperties": false, "description": "Contains information about an endpoint version's activation status on the staging network.", "type": "object", "required": [ "versionNumber", "status" ], "properties": { "status": { "description": "The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "nullable": true, "type": "string", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ] }, "versionNumber": { "description": "The endpoint version number.", "minimum": 1, "nullable": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/activationStatus.yaml" } }, "protectedByApiKey": { "description": "Either API endpoint is protected by API key.", "type": "boolean" }, "stagingVersion": { "additionalProperties": false, "description": "Contains information about an endpoint version's activation status on the staging network.", "type": "object", "required": [ "versionNumber", "status" ], "properties": { "status": { "description": "The activation status on the production network, either `PENDING` if the version contains changes that are being propagated to the network, `ACTIVE` if the version is active, `DEACTIVATED` if the version had been active once but has been deactivated, or `FAILED` if an activation or deactivation attempt for this version has failed. The value is `null` for versions that have never been activated on this network.", "nullable": true, "type": "string", "enum": [ "PENDING", "ACTIVE", "DEACTIVATED", "FAILED" ] }, "versionNumber": { "description": "The endpoint version number.", "minimum": 1, "nullable": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/activationStatus.yaml" } }, "versionNumber": { "description": "The endpoint version number.", "minimum": 1, "type": "integer" } } }, "x-akamai": { "file-path": "schemas/endpoints.yaml" } }, "example": [ { "apiEndPointId": 814151, "apiEndPointName": "Bookstore API", "basePath": "/bookstore", "protectedByApiKey": false, "versionNumber": 4, "productionVersion": { "status": "DEACTIVATED", "versionNumber": 3 }, "stagingVersion": { "status": null, "versionNumber": null }, "apiResourceBaseInfo": [ { "apiResourceId": 4138863, "apiResourceLogicId": 170182, "apiResourceName": "book", "private": false, "resourcePath": "/book", "productionVersion": { "status": "DEACTIVATED", "versionNumber": 3 }, "stagingVersion": { "status": null, "versionNumber": null }, "methods": [ { "apiResourceMethod": "GET", "apiResourceMethodId": 878418, "apiResourceMethodLogicId": 238341, "private": false, "productionVersion": { "status": "DEACTIVATED", "versionNumber": 3 }, "stagingVersion": { "status": null, "versionNumber": null } }, { "apiResourceMethod": "POST", "apiResourceMethodId": 878417, "apiResourceMethodLogicId": 238344, "private": false, "productionVersion": { "status": "DEACTIVATED", "versionNumber": 3 }, "stagingVersion": { "status": null, "versionNumber": null } } ] } ] } ] } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "The unique identifier for the throttling counter.", "example": "{{counterId}}", "in": "path", "name": "counterId", "required": true, "schema": { "example": 54321, "type": "integer" }, "x-akamai": { "file-path": "parameters/counterId-path.yaml" } } ] }, "/counters/{counterId}/keys": { "get": { "description": "Returns information about all API keys assigned to the contract and group under which you created the throttling counter. Search the response data for the relevant `KEY` ID members to use when running the [Create a throttling counter](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-counter) or [Update a throttling counter](https://techdocs.akamai.com/key-traffic-mgmt/reference/put-counter) operation.", "operationId": "get-counter-keys", "summary": "List counter keys", "tags": [ "Counter keys" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/get-counter-keys" }, "responses": { "200": { "description": "The endpoints have been returned.", "content": { "application/json": { "schema": { "description": "A list of keys.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Contains information about a key.", "type": "object", "required": [ "value" ], "properties": { "collectionId": { "description": "The unique identifier for the collection that includes the key.", "minimum": 0, "readOnly": true, "type": "integer" }, "collectionName": { "description": "The name of the collection that includes the key.", "minLength": 1, "readOnly": true, "type": "string" }, "createdAt": { "description": "Indicates when the key was created, in ISO 8601 format.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "The description that you provide for the key.", "minLength": 0, "nullable": true, "type": "string" }, "dirty": { "description": "Whether changes to the key's status are being propagated to the Akamai network.", "readOnly": true, "type": "boolean" }, "id": { "description": "The unique identifier for the key.", "minimum": 0, "readOnly": true, "type": "integer" }, "label": { "description": "The label that you assign to the key. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "minLength": 0, "nullable": true, "type": "string" }, "quotaUpdateState": { "description": "The key's quota reset status. Either `NONE` if no quota reset is in progress, `QUEUED` if the key is awaiting a quota reset, or `PROCESSING` if the key's quota is currently being reset. When the quota resets, the status automatically changes from `PROCESSING` to `NONE`.", "readOnly": true, "type": "string", "enum": [ "NONE", "QUEUED", "PROCESSING" ] }, "quotaUsage": { "description": "The current quota usage for the key. The value is `-1` if the current usage is unknown.", "minimum": 0, "readOnly": true, "type": "integer" }, "quotaUsageTimestamp": { "description": "Indicates when the key's quota was updated, in ISO 8601 format.", "format": "date-time", "readOnly": true, "type": "string" }, "revoked": { "description": "Whether you revoked the key.", "readOnly": true, "type": "boolean" }, "revokedAt": { "description": "Indicates when the key was revoked, in ISO 8601 format.", "minLength": 1, "nullable": true, "readOnly": true, "type": "string" }, "tags": { "description": "The additional categories assigned to the key that you can use as filters.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "terminationAt": { "description": "Indicates when to delete the key, in ISO 8601 format.", "minLength": 1, "nullable": true, "readOnly": true, "type": "string" }, "value": { "description": "The value of the key.", "maxLength": 10000, "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/keyDto.yaml" } }, "x-akamai": { "file-path": "schemas/keyList.yaml" } }, "example": [ { "collectionId": 108051, "collectionName": "Bookstore Access", "createdAt": "2021-05-30T10:36:33.265221Z", "description": "A key for external bookstore users.", "dirty": true, "id": 403040, "label": "external", "quotaUpdateState": "PROCESSING", "quotaUsage": -1, "quotaUsageTimestamp": "1970-01-01T00:00:00Z", "revoked": false, "revokedAt": null, "terminationAt": null, "value": "62e6b236-5eab-42c9-8cc1-a71d01536cc0", "tags": [ "standard", "external" ] }, { "collectionId": 108051, "collectionName": "Bookstore Access", "createdAt": "2021-05-30T10:36:33.265221Z", "description": "A key for external bookstore users.", "dirty": true, "id": 403041, "label": "external", "quotaUpdateState": "PROCESSING", "quotaUsage": -1, "quotaUsageTimestamp": "1970-01-01T00:00:00Z", "revoked": false, "revokedAt": null, "terminationAt": null, "value": "62e6b236-5eab-42c9-8cc1-a71d01536cc0", "tags": [ "standard", "external" ] } ] } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "The unique identifier for the throttling counter.", "example": "{{counterId}}", "in": "path", "name": "counterId", "required": true, "schema": { "example": 54321, "type": "integer" }, "x-akamai": { "file-path": "parameters/counterId-path.yaml" } } ] }, "/keys": { "post": { "description": "Creates a collection of keys with unassigned values. To generate keys with assigned values, use the [Generate keys](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-keys-generate) operation.", "operationId": "post-keys", "summary": "Create keys", "tags": [ "Keys" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/post-keys" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "collectionId": 108051, "description": "A key for standard user access.", "label": "standard", "value": "87e2a500-649b-49d6-98be-cf278c5ebbb5", "tags": [ "external" ] }, "schema": { "additionalProperties": false, "description": "Contains information about keys to create with manually assigned values.", "type": "object", "required": [ "value", "collectionId" ], "properties": { "collectionId": { "description": "The unique identifier for the collection that includes the key.", "example": "{{collectionId}}", "minimum": 0, "type": "integer" }, "collectionName": { "description": "The name of the collection that includes the key.", "example": "{{collectionName}}", "minLength": 1, "readOnly": true, "type": "string" }, "createdAt": { "description": "Indicates when the key was created, in ISO 8601 format.", "example": "{{createdAt}}", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "The description that you provide for the key.", "example": "{{description}}", "maxLength": 4000, "minLength": 0, "type": "string" }, "dirty": { "description": "Whether changes to the key's status are being propagated to the Akamai network.", "example": "{{dirty}}", "readOnly": true, "type": "boolean" }, "id": { "description": "The unique identifier for the key.", "example": "{{id}}", "minimum": 0, "readOnly": true, "type": "integer" }, "incrementLabel": { "default": false, "description": "Whether to append an automatic increment to the label of each key. A label's increment starts with an underscore character followed by a numerical value based on the number of keys that you create. For example, if you create eight keys, the increments range from `_1` to `_8`. If you create 125 keys, the increments range from `_001` to `_125`.", "example": "{{incrementLabel}}", "type": "boolean", "writeOnly": true }, "label": { "description": "The label that you assign to the key. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "example": "{{label}}", "maxLength": 200, "minLength": 0, "nullable": true, "type": "string" }, "revoked": { "description": "Whether you revoked the key.", "example": "{{revoked}}", "readOnly": true, "type": "boolean" }, "revokedAt": { "description": "Indicates when the key was revoked, in ISO 8601 format.", "example": "{{revokedAt}}", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "tags": { "description": "The additional categories assigned to the key that you can use as filters.", "minItems": 0, "type": "array", "items": { "maxLength": 50, "minLength": 1, "type": "string" } }, "terminationAt": { "description": "Indicates when to delete the key, in ISO 8601 format.", "example": "{{terminationAt}}", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "value": { "description": "The values of the keys. If you want to create more than one key, separate the values by commas, semicolons, or newline sequences (`\\n`). The maximum length of the string is 10000 characters, but each individual key inside it can be up to 64 characters long.", "example": "{{value}}", "maxLength": 10000, "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/createNewKeyCommand.yaml" } } } } }, "responses": { "201": { "description": "The key has been created.", "content": { "application/json": { "example": { "collectionId": 108051, "collectionName": "Bookstore Access", "createdAt": "2021-05-30T10:36:33.265221Z", "description": "A key for external bookstore users.", "dirty": true, "id": 403040, "label": "external", "quotaUpdateState": "PROCESSING", "quotaUsage": -1, "quotaUsageTimestamp": "1970-01-01T00:00:00Z", "revoked": false, "revokedAt": null, "terminationAt": null, "value": "62e6b236-5eab-42c9-8cc1-a71d01536cc0", "tags": [ "standard", "external" ] }, "schema": { "additionalProperties": false, "description": "Contains information about a key.", "type": "object", "required": [ "value" ], "properties": { "collectionId": { "description": "The unique identifier for the collection that includes the key.", "minimum": 0, "readOnly": true, "type": "integer" }, "collectionName": { "description": "The name of the collection that includes the key.", "minLength": 1, "readOnly": true, "type": "string" }, "createdAt": { "description": "Indicates when the key was created, in ISO 8601 format.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "The description that you provide for the key.", "minLength": 0, "nullable": true, "type": "string" }, "dirty": { "description": "Whether changes to the key's status are being propagated to the Akamai network.", "readOnly": true, "type": "boolean" }, "id": { "description": "The unique identifier for the key.", "minimum": 0, "readOnly": true, "type": "integer" }, "label": { "description": "The label that you assign to the key. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "minLength": 0, "nullable": true, "type": "string" }, "quotaUpdateState": { "description": "The key's quota reset status. Either `NONE` if no quota reset is in progress, `QUEUED` if the key is awaiting a quota reset, or `PROCESSING` if the key's quota is currently being reset. When the quota resets, the status automatically changes from `PROCESSING` to `NONE`.", "readOnly": true, "type": "string", "enum": [ "NONE", "QUEUED", "PROCESSING" ] }, "quotaUsage": { "description": "The current quota usage for the key. The value is `-1` if the current usage is unknown.", "minimum": 0, "readOnly": true, "type": "integer" }, "quotaUsageTimestamp": { "description": "Indicates when the key's quota was updated, in ISO 8601 format.", "format": "date-time", "readOnly": true, "type": "string" }, "revoked": { "description": "Whether you revoked the key.", "readOnly": true, "type": "boolean" }, "revokedAt": { "description": "Indicates when the key was revoked, in ISO 8601 format.", "minLength": 1, "nullable": true, "readOnly": true, "type": "string" }, "tags": { "description": "The additional categories assigned to the key that you can use as filters.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "terminationAt": { "description": "Indicates when to delete the key, in ISO 8601 format.", "minLength": 1, "nullable": true, "readOnly": true, "type": "string" }, "value": { "description": "The value of the key.", "maxLength": 10000, "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/keyDto.yaml" } } } }, "headers": { "Location": { "description": "A URI that points to the location of the newly created key.", "schema": { "type": "string" } } } }, "207": { "description": "The multiple keys have been created.", "content": { "*/*": {} } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/key-traffic-mgmt/reference/400). The request contains invalid data.", "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "6ca7b4e8-a437-4082-87e0-7eddffa7f38d", "status": 400, "title": "Validation error", "type": "/apikey-manager-api/error-types/validation-error", "errors": [ { "detail": "This field must contain a non-blank value.", "field": "name", "title": "Empty field", "type": "/apikey-manager-api/error-types/not-empty" } ] }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to create a key.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The key couldn't be created.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "get": { "description": "Returns keys included in a collection based on the specified criteria.", "operationId": "get-keys", "summary": "List keys", "tags": [ "Keys" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/get-keys" }, "responses": { "200": { "description": "The keys have been returned.", "content": { "application/json": { "example": { "filter": "external", "pageNumber": 1, "pageSize": 2, "sortColumn": "id", "sortDirection": "desc", "totalItems": 100, "items": [ { "collectionId": 108051, "collectionName": "Bookstore Access", "createdAt": "2021-05-30T10:36:33.265221Z", "description": "A key for external bookstore users.", "dirty": true, "id": 403041, "label": "external", "quotaUpdateState": "PROCESSING", "quotaUsage": -1, "quotaUsageTimestamp": "1970-01-01T00:00:00Z", "revoked": false, "revokedAt": null, "terminationAt": null, "value": "62e6b236-5eab-42c9-8cc1-a71d01536cc0", "tags": [ "standard", "external" ] }, { "collectionId": 108051, "collectionName": "Bookstore Access", "createdAt": "2021-05-30T10:36:33.265221Z", "description": "A key for external bookstore users.", "dirty": true, "id": 403040, "label": "external", "quotaUpdateState": "PROCESSING", "quotaUsage": -1, "quotaUsageTimestamp": "1970-01-01T00:00:00Z", "revoked": false, "revokedAt": null, "terminationAt": null, "value": "62e6b236-5eab-42c9-8cc1-a71d01536cc0", "tags": [ "standard", "external" ] } ] }, "schema": { "additionalProperties": false, "description": "Contains information about a single page of keys.", "type": "object", "properties": { "filter": { "description": "The search phrase by which the keys are filtered.", "minLength": 1, "type": "string" }, "items": { "description": "Contains information about a key.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Contains information about a key.", "readOnly": true, "type": "object", "required": [ "value" ], "properties": { "collectionId": { "description": "The unique identifier for the collection that includes the key.", "minimum": 0, "readOnly": true, "type": "integer" }, "collectionName": { "description": "The name of the collection that includes the key.", "minLength": 1, "readOnly": true, "type": "string" }, "createdAt": { "description": "Indicates when the key was created, in ISO 8601 format.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "The description that you provide for the key.", "minLength": 0, "nullable": true, "type": "string" }, "dirty": { "description": "Whether changes to the key's status are being propagated to the Akamai network.", "readOnly": true, "type": "boolean" }, "id": { "description": "The unique identifier for the key.", "minimum": 0, "readOnly": true, "type": "integer" }, "label": { "description": "The label that you assign to the key. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "minLength": 0, "nullable": true, "type": "string" }, "quotaUpdateState": { "description": "The key's quota reset status. Either `NONE` if no quota reset is in progress, `QUEUED` if the key is awaiting a quota reset, or `PROCESSING` if the key's quota is currently being reset. When the quota resets, the status automatically changes from `PROCESSING` to `NONE`.", "readOnly": true, "type": "string", "enum": [ "NONE", "QUEUED", "PROCESSING" ] }, "quotaUsage": { "description": "The current quota usage for the key. The value is `-1` if the current usage is unknown.", "minimum": 0, "readOnly": true, "type": "integer" }, "quotaUsageTimestamp": { "description": "Indicates when the key's quota was updated, in ISO 8601 format.", "format": "date-time", "readOnly": true, "type": "string" }, "revoked": { "description": "Whether you revoked the key.", "readOnly": true, "type": "boolean" }, "revokedAt": { "description": "Indicates when the key was revoked, in ISO 8601 format.", "minLength": 1, "nullable": true, "readOnly": true, "type": "string" }, "tags": { "description": "The additional categories assigned to the key that you can use as filters.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "terminationAt": { "description": "Indicates when to delete the key, in ISO 8601 format.", "minLength": 1, "nullable": true, "readOnly": true, "type": "string" }, "value": { "description": "The value of the key.", "maxLength": 10000, "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/keyDto.yaml" } } }, "pageNumber": { "description": "The number of the current page that displays results.", "minimum": 0, "type": "integer" }, "pageSize": { "description": "The size of the current page that displays results.", "minimum": 0, "type": "integer" }, "sortColumn": { "description": "The name of the column by which the keys are sorted.", "minLength": 1, "type": "string" }, "sortDirection": { "description": "The ascending or descending order of displayed results.", "minLength": 1, "type": "string" }, "totalItems": { "description": "The total number of keys on a page.", "minimum": 0, "type": "integer" } }, "x-akamai": { "file-path": "schemas/keyPage.yaml" } } } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to get the keys.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The requested keys could not be found.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "parameters": [ { "description": "The unique identifier for the collection that includes the keys.", "example": "{{collectionId}}", "in": "query", "name": "collectionId", "schema": { "example": 12345, "type": "integer" }, "x-akamai": { "file-path": "parameters/collectionId-query.yaml" } }, { "description": "The search phrase to filter the keys by. The phrase can be a part of the description, tags, or label.", "example": "{{filter}}", "in": "query", "name": "filter", "schema": { "example": "test", "type": "string" }, "x-akamai": { "file-path": "parameters/filter-query.yaml" } }, { "description": "The page number index.", "example": "{{pageNumber}}", "in": "query", "name": "pageNumber", "schema": { "example": 3, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageNumber-query.yaml" } }, { "description": "__Enum__ The type of keys to return, either `All` for all keys in the collection, `Active` for keys that can be used to access resources and endpoints associated with the collection, `Revoked` for keys that cannot be used to access resources and endpoints associated with the collection, or `Pending` for keys with changes that are being propagated to the Akamai network.", "example": "{{keyType}}", "in": "query", "name": "keyType", "schema": { "example": "Active", "type": "string", "enum": [ "All", "Active", "Revoked", "Pending" ] }, "x-akamai": { "file-path": "parameters/keyType-query.yaml" } }, { "description": "The number of keys on each page of results.", "example": "{{pageSize}}", "in": "query", "name": "pageSize", "schema": { "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageSize-query.yaml" } }, { "description": "__Enum__ The order in which the keys are to be sorted, either `asc` for ascending or `desc` for descending. This only works in conjunction with `sortColumn`. If `sortColumn` is not specified, the keys will not be sorted.", "example": "{{sortDirection}}", "in": "query", "name": "sortDirection", "schema": { "example": "asc", "type": "string", "enum": [ "asc", "desc" ] }, "x-akamai": { "file-path": "parameters/sortDirection-query.yaml" } }, { "description": "__Enum__ The name of the column to sort the keys by. The keys can be sorted by their unique `id`, `label`, or `description`.", "example": "{{sortColumn}}", "in": "query", "name": "sortColumn", "schema": { "example": "id", "type": "string", "enum": [ "id", "label", "description" ] }, "x-akamai": { "file-path": "parameters/sortColumn-query.yaml" } }, { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/keys/generate": { "post": { "description": "Creates a collection of keys with assigned values. To create keys and assign your own values, use the [Create keys](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-keys) operation.", "operationId": "post-keys-generate", "summary": "Generate keys", "tags": [ "Keys" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/post-keys-generate" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "collectionId": 108051, "count": 20, "description": "A temporary key for trial users.", "incrementLabel": false, "label": "temporary", "tags": [ "temp", "external" ] }, "schema": { "additionalProperties": false, "description": "Contains information about keys to generate with automatically assigned values.", "type": "object", "required": [ "collectionId", "count" ], "properties": { "collectionId": { "description": "The unique identifier for the collection that includes the key.", "example": "{{collectionId}}", "minimum": 0, "type": "integer" }, "collectionName": { "description": "The name of the collection that includes the key.", "example": "{{collectionName}}", "minLength": 1, "readOnly": true, "type": "string" }, "count": { "description": "The number of keys to generate.", "example": "{{count}}", "minimum": 1, "type": "integer" }, "createdAt": { "description": "Indicates when the key was created, in ISO 8601 format.", "example": "{{createdAt}}", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "The description that you provide for the key.", "example": "{{description}}", "maxLength": 4000, "minLength": 0, "type": "string" }, "dirty": { "description": "Whether changes to the key's status are being propagated to the Akamai network.", "example": "{{dirty}}", "readOnly": true, "type": "boolean" }, "id": { "description": "The unique identifier for the key.", "example": "{{id}}", "minimum": 0, "readOnly": true, "type": "integer" }, "incrementLabel": { "default": false, "description": "Whether to append an automatic increment to the label of each key. A label's increment starts with an underscore character followed by a numerical value based on the number of keys that you create. For example, if you create eight keys, the increments range from `_1` to `_8`. If you create 125 keys, the increments range from `_001` to `_125`.", "example": "{{incrementLabel}}", "type": "boolean", "writeOnly": true }, "label": { "description": "The label that you assign to the key. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "example": "{{label}}", "minLength": 0, "nullable": true, "type": "string" }, "revoked": { "description": "Whether you revoked the key.", "example": "{{revoked}}", "readOnly": true, "type": "boolean" }, "revokedAt": { "description": "Indicates when the key was revoked, in ISO 8601 format.", "example": "{{revokedAt}}", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "tags": { "description": "The additional categories assigned to the key that you can use as filters.", "minItems": 0, "type": "array", "items": { "maxLength": 50, "minLength": 1, "type": "string" } }, "terminationAt": { "description": "Indicates when to delete the key, in ISO 8601 format.", "example": "{{terminationAt}}", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" } }, "x-akamai": { "file-path": "schemas/generateKeysCommand.yaml" } } } } }, "responses": { "204": { "description": "The keys have been created.", "content": { "*/*": {} } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/key-traffic-mgmt/reference/400). The request contains invalid data.", "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "6ca7b4e8-a437-4082-87e0-7eddffa7f38d", "status": 400, "title": "Validation error", "type": "/apikey-manager-api/error-types/validation-error", "errors": [ { "detail": "This field must contain a non-blank value.", "field": "name", "title": "Empty field", "type": "/apikey-manager-api/error-types/not-empty" } ] }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to create keys.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The keys could not be created.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/keys/import": { "post": { "description": "Imports keys from a CSV, XML, or JSON file to a collection. When making a request to import keys, embed the data structure that defines the contents of the import file in a JSON object. For details, see [Import keys in different formats](https://techdocs.akamai.com/key-traffic-mgmt/reference/import-keys-different-formats).", "operationId": "post-keys-import", "summary": "Import keys", "tags": [ "Keys" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/post-keys-import" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "collectionId": 58002, "content": "[{\"value\":\"cf527010-63e8-45ae-91e2-29757180631e\",\"label\":\"premium\",\"tags\":[\"external\",\"premium\"]},{\"value\":\"cf557010-63e8-45fg-94e2-29757180631e\",\"label\":\"premium\",\"tags\":[\"premium\",\"temp\"]}]", "name": "import.json" }, "schema": { "additionalProperties": false, "description": "Contains information about an import file with details about API keys.", "type": "object", "required": [ "name", "content", "collectionId" ], "properties": { "collectionId": { "description": "The unique identifier for the collection where keys should be imported.", "example": "{{collectionId}}", "minimum": 0, "type": "integer" }, "content": { "description": "The XML, CSV, or JSON data structure with details about keys to import, encoded within a single string value. See how you can [import keys in different formats](https://techdocs.akamai.com/key-traffic-mgmt/reference/import-keys-different-formats).", "example": "{{content}}", "minLength": 1, "type": "string" }, "name": { "description": "The name of the file with keys to import.", "example": "{{name}}", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/importKeysCommand.yaml" } } } } }, "responses": { "204": { "description": "The import has completed successfully.", "content": { "*/*": {} } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/key-traffic-mgmt/reference/400). The import file is invalid. The error details are described in the response.", "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "6ca7b4e8-a437-4082-87e0-7eddffa7f38d", "status": 400, "title": "Validation error", "type": "/apikey-manager-api/error-types/validation-error", "errors": [ { "detail": "This field must contain a non-blank value.", "field": "name", "title": "Empty field", "type": "/apikey-manager-api/error-types/not-empty" } ] }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to perform the import.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/keys/move": { "post": { "description": "Moves keys from one collection to another. For details, see move keys to a new collection or move keys to an existing collection.", "operationId": "post-keys-move", "summary": "Move keys", "tags": [ "Keys" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/post-keys-move" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "collectionId": 108052, "keys": [ 404001, 403048 ] }, "schema": { "additionalProperties": false, "description": "Contains information about keys to move from one collection to another.", "type": "object", "required": [ "keys" ], "properties": { "collectionId": { "description": "The unique identifier for the existing destination collection.", "example": "{{collectionId}}", "minimum": 0, "type": "integer" }, "keys": { "description": "The unique identifiers for the keys to move.", "minItems": 1, "type": "array", "items": { "minimum": 0, "type": "integer" } }, "newCollectionContractId": { "description": "The unique identifier for the contract with Akamai under which you provision the new destination collection.", "example": "{{newCollectionContractId}}", "minLength": 1, "type": "string" }, "newCollectionDescription": { "description": "The description that you provide for the new destination collection.", "example": "{{newCollectionDescription}}", "minLength": 0, "type": "string" }, "newCollectionGroupId": { "description": "The unique identifier for the group in Control Center under which you provision the new destination collection.", "example": "{{newCollectionGroupId}}", "minimum": 0, "type": "integer" }, "newCollectionName": { "description": "The name that you assign to the new destination collection.", "example": "{{newCollectionName}}", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/moveKeysCommand.yaml" } } } } }, "responses": { "204": { "description": "The keys have been moved.", "content": { "*/*": {} } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/key-traffic-mgmt/reference/400). The request contains invalid data.", "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "6ca7b4e8-a437-4082-87e0-7eddffa7f38d", "status": 400, "title": "Validation error", "type": "/apikey-manager-api/error-types/validation-error", "errors": [ { "detail": "This field must contain a non-blank value.", "field": "name", "title": "Empty field", "type": "/apikey-manager-api/error-types/not-empty" } ] }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to move keys.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The keys could not be moved.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/keys/quota-reset": { "post": { "description": "Resets the quota limit for selected keys.", "operationId": "post-keys-quota-reset", "summary": "Reset key quota", "tags": [ "Reset" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/post-keys-quota-reset" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "keys": [ 1324149, 1324150, 1324151 ] }, "schema": { "additionalProperties": false, "description": "Contains information about the keys to reset the quota for.", "type": "object", "required": [ "keys" ], "properties": { "keys": { "description": "The unique identifiers for the keys.", "minItems": 0, "type": "array", "items": { "minimum": 0, "type": "integer" } } }, "x-akamai": { "file-path": "schemas/keysList.yaml" } } } } }, "responses": { "204": { "description": "The quota has been reset.", "content": { "*/*": {} } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/key-traffic-mgmt/reference/400). Some of user input is invalid.", "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "6ca7b4e8-a437-4082-87e0-7eddffa7f38d", "status": 400, "title": "Validation error", "type": "/apikey-manager-api/error-types/validation-error", "errors": [ { "detail": "This field must contain a non-blank value.", "field": "name", "title": "Empty field", "type": "/apikey-manager-api/error-types/not-empty" } ] }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to reset the quota.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The quota could not be reset.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/keys/restore": { "post": { "description": "Restores previously revoked keys in a collection. This operation is only available in the 120 days following the revocation.", "operationId": "post-keys-restore", "summary": "Restore revoked keys", "tags": [ "Keys" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/post-keys-restore" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "keys": [ 89011, 89012, 89013 ] }, "schema": { "additionalProperties": false, "description": "Contains information about keys to revoke or restore.", "type": "object", "required": [ "keys" ], "properties": { "keys": { "description": "The unique identifiers for the keys to revoke or restore.", "minItems": 1, "type": "array", "items": { "minimum": 0, "type": "integer" } } }, "x-akamai": { "file-path": "schemas/revokeKeysCommand.yaml" } } } } }, "responses": { "204": { "description": "The keys have been restored.", "content": { "*/*": {} } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/key-traffic-mgmt/reference/400). The request contains invalid data.", "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "6ca7b4e8-a437-4082-87e0-7eddffa7f38d", "status": 400, "title": "Validation error", "type": "/apikey-manager-api/error-types/validation-error", "errors": [ { "detail": "This field must contain a non-blank value.", "field": "name", "title": "Empty field", "type": "/apikey-manager-api/error-types/not-empty" } ] }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to restore keys.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The keys could not be restored.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/keys/revoke": { "post": { "description": "Revokes keys in a collection and marks them as revoked. The revoked keys can be restored within the next 120 days and after this period they're deleted.", "operationId": "post-keys-revoke", "summary": "Revoke keys", "tags": [ "Keys" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/post-keys-revoke" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "keys": [ 89011, 89012, 89013 ] }, "schema": { "additionalProperties": false, "description": "Contains information about keys to revoke or restore.", "type": "object", "required": [ "keys" ], "properties": { "keys": { "description": "The unique identifiers for the keys to revoke or restore.", "minItems": 1, "type": "array", "items": { "minimum": 0, "type": "integer" } } }, "x-akamai": { "file-path": "schemas/revokeKeysCommand.yaml" } } } } }, "responses": { "204": { "description": "The keys have been revoked.", "content": { "*/*": {} } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/key-traffic-mgmt/reference/400). The request contains invalid data.", "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "6ca7b4e8-a437-4082-87e0-7eddffa7f38d", "status": 400, "title": "Validation error", "type": "/apikey-manager-api/error-types/validation-error", "errors": [ { "detail": "This field must contain a non-blank value.", "field": "name", "title": "Empty field", "type": "/apikey-manager-api/error-types/not-empty" } ] }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to revoke keys.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The keys could not be revoked.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/keys/{keyId}": { "get": { "description": "Returns information about a key.", "operationId": "get-key", "summary": "Get a key", "tags": [ "Keys" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/get-key" }, "responses": { "200": { "description": "The key has been returned.", "content": { "application/json": { "example": { "collectionId": 108051, "collectionName": "Bookstore Access", "createdAt": "2021-05-30T10:36:33.265221Z", "description": "A key for external bookstore users.", "dirty": true, "id": 403040, "label": "external", "quotaUpdateState": "PROCESSING", "quotaUsage": -1, "quotaUsageTimestamp": "1970-01-01T00:00:00Z", "revoked": false, "revokedAt": null, "terminationAt": null, "value": "62e6b236-5eab-42c9-8cc1-a71d01536cc0", "tags": [ "standard", "external" ] }, "schema": { "additionalProperties": false, "description": "Contains information about a key.", "type": "object", "required": [ "value" ], "properties": { "collectionId": { "description": "The unique identifier for the collection that includes the key.", "minimum": 0, "readOnly": true, "type": "integer" }, "collectionName": { "description": "The name of the collection that includes the key.", "minLength": 1, "readOnly": true, "type": "string" }, "createdAt": { "description": "Indicates when the key was created, in ISO 8601 format.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "The description that you provide for the key.", "minLength": 0, "nullable": true, "type": "string" }, "dirty": { "description": "Whether changes to the key's status are being propagated to the Akamai network.", "readOnly": true, "type": "boolean" }, "id": { "description": "The unique identifier for the key.", "minimum": 0, "readOnly": true, "type": "integer" }, "label": { "description": "The label that you assign to the key. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "minLength": 0, "nullable": true, "type": "string" }, "quotaUpdateState": { "description": "The key's quota reset status. Either `NONE` if no quota reset is in progress, `QUEUED` if the key is awaiting a quota reset, or `PROCESSING` if the key's quota is currently being reset. When the quota resets, the status automatically changes from `PROCESSING` to `NONE`.", "readOnly": true, "type": "string", "enum": [ "NONE", "QUEUED", "PROCESSING" ] }, "quotaUsage": { "description": "The current quota usage for the key. The value is `-1` if the current usage is unknown.", "minimum": 0, "readOnly": true, "type": "integer" }, "quotaUsageTimestamp": { "description": "Indicates when the key's quota was updated, in ISO 8601 format.", "format": "date-time", "readOnly": true, "type": "string" }, "revoked": { "description": "Whether you revoked the key.", "readOnly": true, "type": "boolean" }, "revokedAt": { "description": "Indicates when the key was revoked, in ISO 8601 format.", "minLength": 1, "nullable": true, "readOnly": true, "type": "string" }, "tags": { "description": "The additional categories assigned to the key that you can use as filters.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "terminationAt": { "description": "Indicates when to delete the key, in ISO 8601 format.", "minLength": 1, "nullable": true, "readOnly": true, "type": "string" }, "value": { "description": "The value of the key.", "maxLength": 10000, "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/keyDto.yaml" } } } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to get the key.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The key could not be found.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "put": { "description": "Updates information about a key.", "operationId": "put-key", "summary": "Edit a key", "tags": [ "Keys" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/put-key" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "collectionId": 108051, "collectionName": "Bookstore Access", "createdAt": "2021-05-30T10:36:33.265221Z", "description": "A key for external bookstore users.", "dirty": true, "id": 403040, "label": "external", "quotaUpdateState": "PROCESSING", "quotaUsage": -1, "quotaUsageTimestamp": "1970-01-01T00:00:00Z", "revoked": false, "revokedAt": null, "terminationAt": null, "value": "62e6b236-5eab-42c9-8cc1-a71d01536cc0", "tags": [ "standard", "external" ] }, "schema": { "additionalProperties": false, "description": "Contains information about a key.", "type": "object", "required": [ "value" ], "properties": { "collectionId": { "description": "The unique identifier for the collection that includes the key.", "example": "{{collectionId}}", "minimum": 0, "readOnly": true, "type": "integer" }, "collectionName": { "description": "The name of the collection that includes the key.", "example": "{{collectionName}}", "minLength": 1, "readOnly": true, "type": "string" }, "createdAt": { "description": "Indicates when the key was created, in ISO 8601 format.", "example": "{{createdAt}}", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "The description that you provide for the key.", "example": "{{description}}", "minLength": 0, "nullable": true, "type": "string" }, "dirty": { "description": "Whether changes to the key's status are being propagated to the Akamai network.", "example": "{{dirty}}", "readOnly": true, "type": "boolean" }, "id": { "description": "The unique identifier for the key.", "example": "{{id}}", "minimum": 0, "readOnly": true, "type": "integer" }, "label": { "description": "The label that you assign to the key. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "example": "{{label}}", "minLength": 0, "nullable": true, "type": "string" }, "quotaUpdateState": { "description": "The key's quota reset status. Either `NONE` if no quota reset is in progress, `QUEUED` if the key is awaiting a quota reset, or `PROCESSING` if the key's quota is currently being reset. When the quota resets, the status automatically changes from `PROCESSING` to `NONE`.", "example": "{{quotaUpdateState}}", "readOnly": true, "type": "string", "enum": [ "NONE", "QUEUED", "PROCESSING" ] }, "quotaUsage": { "description": "The current quota usage for the key. The value is `-1` if the current usage is unknown.", "example": "{{quotaUsage}}", "minimum": 0, "readOnly": true, "type": "integer" }, "quotaUsageTimestamp": { "description": "Indicates when the key's quota was updated, in ISO 8601 format.", "example": "{{quotaUsageTimestamp}}", "format": "date-time", "readOnly": true, "type": "string" }, "revoked": { "description": "Whether you revoked the key.", "example": "{{revoked}}", "readOnly": true, "type": "boolean" }, "revokedAt": { "description": "Indicates when the key was revoked, in ISO 8601 format.", "example": "{{revokedAt}}", "minLength": 1, "nullable": true, "readOnly": true, "type": "string" }, "tags": { "description": "The additional categories assigned to the key that you can use as filters.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "terminationAt": { "description": "Indicates when to delete the key, in ISO 8601 format.", "example": "{{terminationAt}}", "minLength": 1, "nullable": true, "readOnly": true, "type": "string" }, "value": { "description": "The value of the key.", "example": "{{value}}", "maxLength": 10000, "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/keyDto.yaml" } } } } }, "responses": { "200": { "description": "The key has been updated.", "content": { "application/json": { "example": { "collectionId": 108051, "collectionName": "Bookstore Access", "createdAt": "2021-05-30T10:36:33.265221Z", "description": "A key for external bookstore users.", "dirty": true, "id": 403040, "label": "external", "quotaUpdateState": "PROCESSING", "quotaUsage": -1, "quotaUsageTimestamp": "1970-01-01T00:00:00Z", "revoked": false, "revokedAt": null, "terminationAt": null, "value": "62e6b236-5eab-42c9-8cc1-a71d01536cc0", "tags": [ "standard", "external" ] }, "schema": { "additionalProperties": false, "description": "Contains information about a key.", "type": "object", "required": [ "value" ], "properties": { "collectionId": { "description": "The unique identifier for the collection that includes the key.", "minimum": 0, "readOnly": true, "type": "integer" }, "collectionName": { "description": "The name of the collection that includes the key.", "minLength": 1, "readOnly": true, "type": "string" }, "createdAt": { "description": "Indicates when the key was created, in ISO 8601 format.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "The description that you provide for the key.", "minLength": 0, "nullable": true, "type": "string" }, "dirty": { "description": "Whether changes to the key's status are being propagated to the Akamai network.", "readOnly": true, "type": "boolean" }, "id": { "description": "The unique identifier for the key.", "minimum": 0, "readOnly": true, "type": "integer" }, "label": { "description": "The label that you assign to the key. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as `null`.", "minLength": 0, "nullable": true, "type": "string" }, "quotaUpdateState": { "description": "The key's quota reset status. Either `NONE` if no quota reset is in progress, `QUEUED` if the key is awaiting a quota reset, or `PROCESSING` if the key's quota is currently being reset. When the quota resets, the status automatically changes from `PROCESSING` to `NONE`.", "readOnly": true, "type": "string", "enum": [ "NONE", "QUEUED", "PROCESSING" ] }, "quotaUsage": { "description": "The current quota usage for the key. The value is `-1` if the current usage is unknown.", "minimum": 0, "readOnly": true, "type": "integer" }, "quotaUsageTimestamp": { "description": "Indicates when the key's quota was updated, in ISO 8601 format.", "format": "date-time", "readOnly": true, "type": "string" }, "revoked": { "description": "Whether you revoked the key.", "readOnly": true, "type": "boolean" }, "revokedAt": { "description": "Indicates when the key was revoked, in ISO 8601 format.", "minLength": 1, "nullable": true, "readOnly": true, "type": "string" }, "tags": { "description": "The additional categories assigned to the key that you can use as filters.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "terminationAt": { "description": "Indicates when to delete the key, in ISO 8601 format.", "minLength": 1, "nullable": true, "readOnly": true, "type": "string" }, "value": { "description": "The value of the key.", "maxLength": 10000, "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/keyDto.yaml" } } } } }, "400": { "description": "[Validation error](https://techdocs.akamai.com/key-traffic-mgmt/reference/400). The request contains invalid data.", "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "6ca7b4e8-a437-4082-87e0-7eddffa7f38d", "status": 400, "title": "Validation error", "type": "/apikey-manager-api/error-types/validation-error", "errors": [ { "detail": "This field must contain a non-blank value.", "field": "name", "title": "Empty field", "type": "/apikey-manager-api/error-types/not-empty" } ] }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to update the key.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The key could not be found.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "The unique identifier for the key.", "example": "{{keyId}}", "in": "path", "name": "keyId", "required": true, "schema": { "example": 54321, "type": "integer" }, "x-akamai": { "file-path": "parameters/keyId-path.yaml" } } ] }, "/reports/{reportName}/versions/{reportVersion}/report-data": { "post": { "description": "Creates a report in a JSON format for a specific version of a report. You can specify the `start` and `end` date for the report data and the aggregation `interval` for each record.", "operationId": "post-report", "summary": "Generate a report", "tags": [ "Reports" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/post-report" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "filters": { "api_key": [ "403040" ] } }, "schema": { "additionalProperties": false, "description": "Contains information about the available report filters and objects to report on.", "type": "object", "properties": { "filters": { "additionalProperties": false, "description": "Contains information about the custom quota reports filter, with the filter's name keying an array containing the filter's set of values.", "type": "object", "required": [ "api_key" ], "properties": { "api_key": { "description": "The list of API key identifiers.", "minItems": 1, "type": "array", "items": { "minLength": 1, "type": "string" } } } } }, "x-akamai": { "file-path": "schemas/ReportRequest.yaml" } } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "example": { "metadata": { "availableDataEnds": "2021-05-17T09:00:50.771902Z", "end": "2021-05-18T00:00:00Z", "interval": "FIVE_MINUTES", "name": "rapidkey-by-quota", "objectType": "rapidfile", "rowCount": 17, "start": "2021-05-16T00:00:00Z", "suggestedRetryTime": null, "version": "1", "groupBy": [ "api_key" ], "objectIds": [ "ymdfile" ], "columns": [ { "label": "api_key", "name": "groupBy" }, { "label": "Quota Used", "name": "quotaUsage" } ], "filters": [ { "name": "api_key", "values": [ "219002", "245001" ] } ] }, "summaryStatistics": {}, "data": [ { "api_key": " (244253)", "apikeyCollection": "100/hour", "quotaUsage": "0", "time_interval": "0" }, { "api_key": " (244250)", "apikeyCollection": "100/twelve hours", "quotaUsage": "0", "time_interval": "2" }, { "api_key": " (224173)", "apikeyCollection": "1000/month", "quotaUsage": "0", "time_interval": "5" } ] }, "schema": { "additionalProperties": false, "description": "Contains the response report, including aggregated data and reflecting details on the request.", "type": "object", "required": [ "data", "metadata", "summaryStatistics" ], "properties": { "data": { "description": "The list of report data rows suitable for aggregation. The value of the `groupBy` array serves as a key for each row to indicate the metric by which the row is grouped and sorted.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Contains information about the report data rows suitable for aggregation. The value of the `groupBy` array serves as a key for each row to indicate the metric by which the row is grouped and sorted.", "type": "object", "required": [ "startdatetime", "api_key", "apikeyCollection", "time_interval", "quotaUsage" ], "properties": { "api_key": { "description": "The API key description and the API key identifier in parentheses.", "minLength": 1, "type": "string" }, "apikeyCollection": { "description": "The maximum quota allowed per API key and the quota interval in a given key collection.", "minLength": 1, "type": "string" }, "quotaUsage": { "description": "The quota used by an API key in a given period.", "minLength": 1, "type": "string" }, "startdatetime": { "description": "Indicates the start of each record in a report, in ISO 8601 format.", "minLength": 1, "type": "string" }, "time_interval": { "description": "The identifier for the quota interval, either `0` for an hour, `1` for six hours, `2` for twelve hours, `3` for a day, `4` for a week, or `5` for a month.", "type": "string", "enum": [ "0", "1", "2", "3", "4", "5" ] } }, "x-akamai": { "file-path": "schemas/data-row-schema.yaml" } } }, "metadata": { "additionalProperties": false, "description": "Contains information about the requested data set based on the request's parameters and the contents of the query object. Provides information for use in the report output.", "type": "object", "properties": { "availableDataEnds": { "description": "For unfinalized report data, the ISO 8601 timestamp indicating when the data is available. Otherwise, the value is `null` for finalized data.", "minLength": 1, "nullable": true, "type": "string" }, "columns": { "description": "The list of interface labels for the `data` member.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "label": { "description": "The interface label to assign to the corresponding `name` member.", "minLength": 1, "type": "string" }, "name": { "description": "The name of the corresponding `data` member.", "minLength": 1, "type": "string" } } } }, "end": { "description": "The ISO 8601 timestamp indicating the end date for the requested data. This reflects the value of the [Generate a report](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-report) operation's `end` parameter.", "minLength": 1, "type": "string" }, "filters": { "description": "The list of filters explicitly provided by the user and implicitly resolved, used when retrieving the report data.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "name": { "description": "The name of the filter specified in the request or included in the default set for a given report type.", "minLength": 1, "type": "string" }, "value": { "description": "The list of requested filter values.", "minItems": 1, "type": "array", "items": { "minLength": 1, "type": "string" } } } } }, "groupBy": { "description": "The list of fields by which `data` is grouped and sorted. The `groupBy` field is specified in each `data` row.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" } }, "interval": { "description": "The duration of each record in the report, either `FIVE_MINUTES`, `HOUR`, `DAY`, `WEEK`, or `MONTH`. This reflects the value of the [Generate a report](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-report) operation's `interval` parameter.", "type": "string", "enum": [ "FIVE_MINUTES", "HOUR", "DAY", "WEEK", "MONTH" ] }, "name": { "description": "The name of the current report type.", "minLength": 1, "type": "string" }, "objectIds": { "description": "The list of internal identifiers related to reports. For quota reports, the array always contains a single entry: `ymdfile`.", "minItems": 1, "type": "array", "items": { "minLength": 1, "type": "string" } }, "objectType": { "description": "The internal identifier related to reports. For quota reports, the value is always `rapidfile`.", "minLength": 1, "type": "string" }, "rowCount": { "description": "The total number of `data` records included in the report.", "minimum": 0, "type": "integer" }, "start": { "description": "Indicates the start date for the requested data, in ISO 8601 format. This reflects the value of the [Generate a report](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-report) operation's `start` parameter.", "minLength": 1, "type": "string" }, "suggestedRetryTime": { "description": "For unfinalized report data, indicates the estimated report completion date, in ISO 8601 format. Otherwise, the value is `null` for finalized data.", "minLength": 1, "nullable": true, "type": "string" }, "uri": { "description": "The URL called to get the report data.", "minLength": 1, "type": "string" }, "version": { "description": "The version of the current report type.", "minLength": 1, "type": "string" } } }, "summaryStatistics": { "description": "Contains summary statistics for a report. This isn't applicable for quota reports and is always empty.", "type": "object" } }, "x-akamai": { "file-path": "schemas/ReportResponse.yaml" } } } } }, "400": { "description": "Invalid report request. Appropriate message is returned.", "content": { "*/*": {} } } }, "parameters": [ { "description": "Indicates the start date for the report, in ISO 8601 format.", "example": "{{start}}", "in": "query", "name": "start", "required": true, "schema": { "example": "2021-07-01T00:00:00Z", "type": "string" }, "x-akamai": { "file-path": "parameters/start-query.yaml" } }, { "description": "Indicates the end date for the report data, in ISO 8601 format. Any data that matches the `end` value's timestamp is excluded from the `rapidkey-by-time` report. The `rapidkey-by-quota` report displays data only for the date indicated by this timestamp.", "example": "{{end}}", "in": "query", "name": "end", "required": true, "schema": { "example": "2021-07-02T00:00:00Z", "type": "string" }, "x-akamai": { "file-path": "parameters/end-query.yaml" } }, { "description": "__Enum__ The duration of each data record, either `FIVE_MINUTES`, `HOUR`, `DAY`, `WEEK`, or `MONTH`. The support for specific interval values may vary depending on the report type.", "example": "{{interval}}", "in": "query", "name": "interval", "required": true, "schema": { "example": "DAY", "type": "string", "enum": [ "FIVE_MINUTES", "HOUR", "DAY", "WEEK", "MONTH" ] }, "x-akamai": { "file-path": "parameters/interval-query.yaml" } }, { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "The version of a report.", "example": "{{reportVersion}}", "in": "path", "name": "reportVersion", "required": true, "schema": { "example": 1, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/reportVersion-path.yaml" } }, { "description": "__Enum__ The type of report that you want to generate. Either `rapidkey-by-quota` or `rapidkey-by-time`.", "example": "{{reportName}}", "in": "path", "name": "reportName", "required": true, "schema": { "example": "rapidkey-by-quota", "type": "string", "enum": [ "rapidkey-by-quota", "rapidkey-by-time" ] }, "x-akamai": { "file-path": "parameters/reportName-path.yaml" } } ] }, "/tags": { "get": { "description": "Returns all existing tags. You can add new tags during the key creation. See either the [Create keys](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-keys) or [Generate keys](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-keys-generate) operation.", "operationId": "get-tags", "summary": "List tags", "tags": [ "Tags" ], "externalDocs": { "description": "See documentation for this operation in Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference/get-tags" }, "responses": { "200": { "description": "The tags have been returned.", "content": { "application/json": { "example": [ "external", "standard", "temp", "premium" ], "schema": { "description": "The additional categories assigned to the key that you can use as filters.", "minItems": 0, "type": "array", "items": { "minLength": 1, "type": "string" }, "x-akamai": { "file-path": "schemas/TagList.yaml" } } } } }, "403": { "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have the required permissions to get tags.", "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions set in Identity and Access Management.", "instance": "c7cd4a53-cbb7-46a1-84ae-d53c9ac7ed10", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } }, "404": { "description": "[Resource not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The requested tags could not be found.", "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '2137'. Provide a valid ID and try again.", "instance": "2a956b9f-e678-4035-8b27-5665350f2720", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "required": [ "type", "title" ], "properties": { "detail": { "description": "The detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "minItems": 0, "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/httpProblemDetails-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "maximum": 599, "minimum": 400, "type": "integer" }, "title": { "description": "The title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "The URL for the error type description.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/httpProblemDetails.yaml" } } } } } }, "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } } }, "x-readme": { "samples-languages": [ "curl", "python", "node" ] }, "servers": [ { "url": "https://{hostname}/apikey-manager-api/v1" } ] }