Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14120262383.5 KB

Gets information about the current ApiKey resource.

get/apikeys/{api_Key}

Path parameters

api_Keystring required

The identifier of the ApiKey resource.

Query parameters

includeValueboolean

A boolean flag to specify whether (<code>true</code>) or not (<code>false</code>) the result contains the key value.

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.