Generate keys

post

https://{hostname}/apikey-manager-api/v2/keys/generate

Creates a collection of keys with assigned values. To create keys and assign your own values, use the Create keys operation.

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

collectionId

int64

required

≥ 0

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

count

integer

required

1 to 10000

Number of keys to generate.

incrementLabel

boolean

Defaults to false

Appends 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.

keyDescription

string

length between 0 and 4000

Description for the key.

label

string

length between 0 and 200

Label assigned to the key.

201The response provides the newly generated API keys.

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.