Edit a key collection

put

https://{hostname}/apikey-manager-api/v2/collections/{collectionId}

Updates a collection.

Path Params

collectionId

int64

required

Identifies the collection. Run the List key collections operation to select one.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Contains information about a collection.

aclEntries

object

Specifies a set of ACL endpoint resources.

collectionDescription

string | null

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.

collectionName

string

required

length between 1 and 200

Name of the collection.

quotaConfig

object

Contains information about quota settings for the collection.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200The response provides the updated collection.

400Bad request. The request contains invalid data.

401Unauthorized. You are not authorized to perform the action.

403Forbidden. You don't have permission to the resource.

404Not found. The resource doesn't exist.

405Method not allowed.

500Internal server error.