Amazon API Gateway REST API Reference

ApiKey

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.


Relation Description Method Templated
self

A relation that refers to the current resource.

 GET No
apikey:update

Changes an API key properties, including the description, enabled, and name properties.

 PATCH No
apikey:delete

Deletes the API Key resource.

 DELETE No
usageplan:by-id

Gets the usage plan of a specified plan identifier associated with the API key.

This link relation offers the following templated variable(s):

  • usageplanId: Required.

    [Required] The identifier of the UsagePlan resource to be retrieved.

 GET Yes
apikey:usageplans

Gets all the usage plans associated with the API key.

This link relation offers the following templated variable(s):

  • keyId: Optional.

    The identifier of the API key associated with the usage plans.

  • limit: Optional.

    The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 GET Yes


Properties

{
  "id" : "String",
  "value" : "String",
  "name" : "String",
  "customerId" : "String",
  "description" : "String",
  "enabled" : "Boolean",
  "createdDate" : "Timestamp",
  "lastUpdatedDate" : "Timestamp",
  "stageKeys" : [ "String" ],
  "tags" : {
    "String" : "String"
  }
}

  • id

  • The identifier of the API Key.

  • value

  • The value of the API Key.

  • name

  • The name of the API Key.

  • customerId

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

  • description

  • The description of the API Key.

  • enabled

  • Specifies whether the API Key can be used by callers.

  • createdDate

  • The timestamp when the API Key was created.

  • lastUpdatedDate

  • The timestamp when the API Key was last updated.

  • stageKeys

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

  • tags

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

Remarks

See Also

Use API Keys