v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14120262383.5 KB

Create an ApiKey resource.

post/apikeys

Request body

namestring

The name of the ApiKey.

descriptionstring

The description of the ApiKey.

enabledboolean

Specifies whether the ApiKey can be used by callers.

generateDistinctIdboolean

Specifies whether (<code>true</code>) or not (<code>false</code>) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

valuestring

Specifies a value of the API key.

customerIdstring

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

tagsobject

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.

Response

Success

idstring

The identifier of the API Key.

valuestring

The value of the API Key.

namestring

The name of the API Key.

customerIdstring

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

descriptionstring

The description of the API Key.

enabledboolean

Specifies whether the API Key can be used by callers.

createdDatestring date-time

The timestamp when the API Key was created.

lastUpdatedDatestring date-time

The timestamp when the API Key was last updated.

stageKeysString[]

A list of Stage resources that are associated with the ApiKey resource.

tagsobject

The collection of tags. Each tag element is associated with a given resource.