--- updatedAt: 2026-03-01T18:46:26.000Z agentTools: siteIndex: https://techdocs.akamai.com/llms.txt projectIndex: https://techdocs.akamai.com/key-traffic-mgmt/llms.txt --- # Edit a key collection Updates a collection. # OpenAPI definition ```json { "externalDocs": { "description": "See documentation for Akamai's API Keys and Traffic Management API", "url": "https://techdocs.akamai.com/key-traffic-mgmt/reference" }, "info": { "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Key collections", "version": "2" }, "openapi": "3.0.0", "paths": { "/collections/{collectionId}": { "put": { "description": "Updates a collection.", "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" }, "operationId": "put-collection", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "aclEntries": { "endpointIds": [], "methodIds": [], "resourceIds": [] }, "collectionName": "Collection Demo", "quotaConfig": { "headersConfig": { "sendOnExceedingQuota": [], "sendOnRemainingQuota": [] }, "isEnabled": false, "requestLimit": 10000, "resetInterval": "HOUR_12" } }, "schema": { "additionalProperties": false, "description": "Contains information about a collection.", "properties": { "aclEntries": { "additionalProperties": false, "description": "Specifies a set of ACL endpoint resources.", "properties": { "endpointIds": { "description": "Unique set of endpoint identifiers. Run the [List collection endpoints](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collection-endpoints) operation to get them.", "items": { "format": "int64", "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "methodIds": { "description": "Unique set of endpoint resource method identifiers. Run the [List collection endpoints](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collection-endpoints) operation to get them.", "items": { "format": "int64", "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "resourceIds": { "description": "Unique set of endpoint resource identifiers. Run the [List collection endpoints](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collection-endpoints) operation to get them.", "items": { "format": "int64", "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" } }, "required": [ "endpointIds", "resourceIds", "methodIds" ], "type": "object", "x-akamai": { "file-path": "schemas/acl-entries.yaml" } }, "collectionDescription": { "description": "Description 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`.", "maxLength": 4000, "minLength": 0, "nullable": true, "type": "string" }, "collectionId": { "description": "__Read-only__ Identifies the collection. Run the [List key collections](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collections) operation to select one.", "format": "int64", "minimum": 0, "readOnly": true, "type": "integer" }, "collectionName": { "description": "Name of the collection.", "maxLength": 200, "minLength": 1, "type": "string" }, "collectionStatus": { "description": "__Read-only__ Indicates whether the collection contains changes that are being propagated to the Akamai network, either `PENDING` or `ACTIVE`.", "enum": [ "PENDING", "ACTIVE" ], "readOnly": true, "type": "string" }, "contractId": { "description": "__Read-only__ Identifies the contract you assign to the new collection.", "minLength": 1, "readOnly": true, "type": "string" }, "groupId": { "description": "__Read-only__ Identifies the group where to create the new collection.", "format": "int64", "minimum": 0, "readOnly": true, "type": "integer" }, "hasMultiCollectionKey": { "description": "__Read-only__ Whether the collection contains a key that's also assigned to other collection.", "readOnly": true, "type": "boolean" }, "keyCount": { "description": "__Read-only__ Number of keys included in the collection.", "format": "int64", "minimum": 0, "readOnly": true, "type": "integer" }, "pendingAclEntries": { "allOf": [ { "additionalProperties": false, "description": "Specifies a set of ACL endpoint resources.", "properties": { "endpointIds": { "description": "Unique set of endpoint identifiers. Run the [List collection endpoints](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collection-endpoints) operation to get them.", "items": { "format": "int64", "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "methodIds": { "description": "Unique set of endpoint resource method identifiers. Run the [List collection endpoints](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collection-endpoints) operation to get them.", "items": { "format": "int64", "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "resourceIds": { "description": "Unique set of endpoint resource identifiers. Run the [List collection endpoints](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collection-endpoints) operation to get them.", "items": { "format": "int64", "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" } }, "required": [ "endpointIds", "resourceIds", "methodIds" ], "type": "object", "x-akamai": { "file-path": "schemas/acl-entries.yaml" } } ], "readOnly": true, "type": "object" }, "quotaConfig": { "additionalProperties": false, "description": "Contains information about quota settings for the collection.", "properties": { "headersConfig": { "additionalProperties": false, "description": "Contains information about the criteria for sending the quota limit response headers.", "properties": { "sendOnExceedingQuota": { "description": "Specifies the headers sent in a response when the quota is full. Any set of `LIMIT_HEADER` to send `X-RateLimit-Limit`, `NEXT_HEADER` to send `X-RateLimit-Next`, and `REMAINING_HEADER` to send `X-RateLimit-Remaining`. If you leave the array empty, the responses don't include the quota exceeding data.", "items": { "enum": [ "LIMIT_HEADER", "NEXT_HEADER", "REMAINING_HEADER" ], "type": "string" }, "minItems": 0, "type": "array" }, "sendOnRemainingQuota": { "description": "Specifies the headers sent in a response when the quota remains. Any set of `RESET_HEADER` to send `X-RateLimit-Reset`, `REMAINING_HEADER` to send `X-RateLimit-Remaining`, and `LIMIT_HEADER` to send `X-RateLimit-Limit`. If you leave the array empty, the responses don't include the quota remaining data.", "items": { "enum": [ "RESET_HEADER", "REMAINING_HEADER", "LIMIT_HEADER" ], "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "sendOnExceedingQuota", "sendOnRemainingQuota" ], "type": "object", "x-akamai": { "file-path": "schemas/quota-headers.yaml" } }, "isEnabled": { "description": "Enables quota settings in the collection.", "type": "boolean" }, "requestLimit": { "description": "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" }, "resetInterval": { "description": "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.", "enum": [ "HOUR_1", "HOUR_6", "HOUR_12", "DAY", "WEEK", "MONTH" ], "type": "string" } }, "required": [ "isEnabled", "requestLimit", "resetInterval" ], "type": "object", "x-akamai": { "file-path": "schemas/quota.yaml" } } }, "required": [ "collectionName" ], "type": "object", "x-akamai": { "file-path": "schemas/collection.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "aclEntries": { "endpointIds": [], "methodIds": [], "resourceIds": [] }, "collectionDescription": "", "collectionId": 39932, "collectionName": "Collection Demo", "collectionStatus": "PENDING", "contractId": "C-0N7RAC7", "groupId": 32145, "hasMultiCollectionKey": false, "keyCount": 0, "pendingAclEntries": { "endpointIds": [], "methodIds": [], "resourceIds": [] }, "quotaConfig": { "headersConfig": { "sendOnExceedingQuota": [], "sendOnRemainingQuota": [] }, "isEnabled": false, "requestLimit": 100, "resetInterval": "HOUR_1" } }, "schema": { "additionalProperties": false, "description": "Contains information about a collection.", "properties": { "aclEntries": { "additionalProperties": false, "description": "Specifies a set of ACL endpoint resources.", "properties": { "endpointIds": { "description": "Unique set of endpoint identifiers. Run the [List collection endpoints](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collection-endpoints) operation to get them.", "items": { "format": "int64", "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "methodIds": { "description": "Unique set of endpoint resource method identifiers. Run the [List collection endpoints](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collection-endpoints) operation to get them.", "items": { "format": "int64", "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "resourceIds": { "description": "Unique set of endpoint resource identifiers. Run the [List collection endpoints](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collection-endpoints) operation to get them.", "items": { "format": "int64", "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" } }, "required": [ "endpointIds", "resourceIds", "methodIds" ], "type": "object", "x-akamai": { "file-path": "schemas/acl-entries.yaml" } }, "collectionDescription": { "description": "Description 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`.", "maxLength": 4000, "minLength": 0, "nullable": true, "type": "string" }, "collectionId": { "description": "__Read-only__ Identifies the collection. Run the [List key collections](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collections) operation to select one.", "format": "int64", "minimum": 0, "readOnly": true, "type": "integer" }, "collectionName": { "description": "Name of the collection.", "maxLength": 200, "minLength": 1, "type": "string" }, "collectionStatus": { "description": "__Read-only__ Indicates whether the collection contains changes that are being propagated to the Akamai network, either `PENDING` or `ACTIVE`.", "enum": [ "PENDING", "ACTIVE" ], "readOnly": true, "type": "string" }, "contractId": { "description": "__Read-only__ Identifies the contract you assign to the new collection.", "minLength": 1, "readOnly": true, "type": "string" }, "groupId": { "description": "__Read-only__ Identifies the group where to create the new collection.", "format": "int64", "minimum": 0, "readOnly": true, "type": "integer" }, "hasMultiCollectionKey": { "description": "__Read-only__ Whether the collection contains a key that's also assigned to other collection.", "readOnly": true, "type": "boolean" }, "keyCount": { "description": "__Read-only__ Number of keys included in the collection.", "format": "int64", "minimum": 0, "readOnly": true, "type": "integer" }, "pendingAclEntries": { "allOf": [ { "additionalProperties": false, "description": "Specifies a set of ACL endpoint resources.", "properties": { "endpointIds": { "description": "Unique set of endpoint identifiers. Run the [List collection endpoints](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collection-endpoints) operation to get them.", "items": { "format": "int64", "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "methodIds": { "description": "Unique set of endpoint resource method identifiers. Run the [List collection endpoints](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collection-endpoints) operation to get them.", "items": { "format": "int64", "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "resourceIds": { "description": "Unique set of endpoint resource identifiers. Run the [List collection endpoints](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collection-endpoints) operation to get them.", "items": { "format": "int64", "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" } }, "required": [ "endpointIds", "resourceIds", "methodIds" ], "type": "object", "x-akamai": { "file-path": "schemas/acl-entries.yaml" } } ], "readOnly": true, "type": "object" }, "quotaConfig": { "additionalProperties": false, "description": "Contains information about quota settings for the collection.", "properties": { "headersConfig": { "additionalProperties": false, "description": "Contains information about the criteria for sending the quota limit response headers.", "properties": { "sendOnExceedingQuota": { "description": "Specifies the headers sent in a response when the quota is full. Any set of `LIMIT_HEADER` to send `X-RateLimit-Limit`, `NEXT_HEADER` to send `X-RateLimit-Next`, and `REMAINING_HEADER` to send `X-RateLimit-Remaining`. If you leave the array empty, the responses don't include the quota exceeding data.", "items": { "enum": [ "LIMIT_HEADER", "NEXT_HEADER", "REMAINING_HEADER" ], "type": "string" }, "minItems": 0, "type": "array" }, "sendOnRemainingQuota": { "description": "Specifies the headers sent in a response when the quota remains. Any set of `RESET_HEADER` to send `X-RateLimit-Reset`, `REMAINING_HEADER` to send `X-RateLimit-Remaining`, and `LIMIT_HEADER` to send `X-RateLimit-Limit`. If you leave the array empty, the responses don't include the quota remaining data.", "items": { "enum": [ "RESET_HEADER", "REMAINING_HEADER", "LIMIT_HEADER" ], "type": "string" }, "minItems": 0, "type": "array" } }, "required": [ "sendOnExceedingQuota", "sendOnRemainingQuota" ], "type": "object", "x-akamai": { "file-path": "schemas/quota-headers.yaml" } }, "isEnabled": { "description": "Enables quota settings in the collection.", "type": "boolean" }, "requestLimit": { "description": "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" }, "resetInterval": { "description": "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.", "enum": [ "HOUR_1", "HOUR_6", "HOUR_12", "DAY", "WEEK", "MONTH" ], "type": "string" } }, "required": [ "isEnabled", "requestLimit", "resetInterval" ], "type": "object", "x-akamai": { "file-path": "schemas/quota.yaml" } } }, "required": [ "collectionName" ], "type": "object", "x-akamai": { "file-path": "schemas/collection.yaml" } } } }, "description": "The response provides the updated collection." }, "400": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "errors": [ { "detail": "The 'groupId' field must contain a not-null value.", "title": "Null field", "type": "/apikey-manager-api/error-types/not-null" } ], "instance": "2c3a7d43-cd2f-4ac0-8d44-7cea20203513", "status": 400, "title": "Validation error", "type": "/apikey-manager-api/error-types/validation-error" }, "schema": { "additionalProperties": true, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "items": { "additionalProperties": true, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "Summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "HTTP status code of the error response.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "Title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "URL for the error type description.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/key-traffic-mgmt/reference/400). The request contains invalid data.", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "You are not authorized to perform this action. Try logging in again.", "instance": "5ca8ba84-1319-4399-b106-f34812ed9c57", "status": 401, "title": "Unauthorized", "type": "/apikey-manager-api/error-types/unauthorized" }, "schema": { "additionalProperties": true, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "items": { "additionalProperties": true, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "Summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "HTTP status code of the error response.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "Title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "URL for the error type description.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/key-traffic-mgmt/reference/401). You are not authorized to perform the action.", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "You have insufficient permissions to perform this action. Ensure that you have the correct permissions...", "instance": "c656aade-8352-407c-9d8c-49a38b942e64", "status": 403, "title": "Forbidden", "type": "/apikey-manager-api/error-types/forbidden" }, "schema": { "additionalProperties": true, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "items": { "additionalProperties": true, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "Summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "HTTP status code of the error response.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "Title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "URL for the error type description.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/key-traffic-mgmt/reference/403). You don't have permission to the resource.", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "The system couldn't find a resource with ID '1'. Provide a valid ID and try again.", "instance": "25e8a2a1-696f-4a64-8001-531d97c17229", "status": 404, "title": "Resource not found", "type": "/apikey-manager-api/error-types/resource-not-found" }, "schema": { "additionalProperties": true, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "items": { "additionalProperties": true, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "Summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "HTTP status code of the error response.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "Title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "URL for the error type description.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/key-traffic-mgmt/reference/404). The resource doesn't exist.", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The request you submitted is invalid. Modify the request and try again.", "instance": "007ca75f-5ef3-478b-8a63-ddbe30a5de83", "status": 405, "title": "Method Not Allowed", "type": "/apikey-manager-api/error-types/bad-request" }, "schema": { "additionalProperties": true, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "items": { "additionalProperties": true, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "Summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "HTTP status code of the error response.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "Title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "URL for the error type description.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/key-traffic-mgmt/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "The server encountered an internal error. Try again in a while.", "instance": "46f66985-bbe7-4a60-867a-5242be138ef2", "status": 500, "title": "Internal server error", "type": "/apikey-manager-api/error-types/internal-server-error" }, "schema": { "additionalProperties": true, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Detailed error message.", "minLength": 1, "type": "string" }, "errors": { "description": "Further nested problem objects.", "items": { "additionalProperties": true, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "Summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Non-referenceable URI indicating an error instance.", "minLength": 1, "type": "string" }, "status": { "description": "HTTP status code of the error response.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "Title of the error response.", "minLength": 1, "type": "string" }, "type": { "description": "URL for the error type description.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/key-traffic-mgmt/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Edit a key collection", "tags": [ "Key collections" ] }, "parameters": [ { "description": "Identifies the collection. Run the [List key collections](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collections) operation to select one.", "in": "path", "name": "collectionId", "required": true, "schema": { "example": 2356234, "format": "int64", "type": "integer" }, "x-akamai": { "file-path": "parameters/collection-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/collection.yaml", "path-info": "/collections/{collectionId}" } } }, "servers": [ { "url": "https://{hostname}/apikey-manager-api/v2" } ], "x-akamai": { "auth-type": "EDGE_GRID", "file-path": "02-collections.yaml" }, "x-readme": { "samples-languages": [ "curl", "python", "node" ], "explorer-enabled": true, "proxy-enabled": true } } ``` # Sibling pages * [Create a key collection](https://techdocs.akamai.com/key-traffic-mgmt/reference/post-collection.md) * [List key collections](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collections.md) * [Get a key collection](https://techdocs.akamai.com/key-traffic-mgmt/reference/get-collection.md) * [Delete a key collection](https://techdocs.akamai.com/key-traffic-mgmt/reference/delete-collection.md)