Amazon API Gateway REST API Reference

ApiKeys

Represents a collection of API keys as represented by an ApiKeys resource.


Relation Description Method Templated
self

A relation that refers to the current resource.

GET No
apikey:by-key

Gets the ApiKey resource with the specified key identifier.

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

  • api_Key: Required.

    The identifier of the ApiKey resource.

  • includeValue: Optional.

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

GET Yes
apikey:create

Creates a new ApiKey resource to represent an API key.

POST No
apikey:delete

Deletes an ApiKey resource.

DELETE No
apikey:import

Imports one or more API keys.

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

  • format: Required.

    A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.

  • failonwarnings: Optional.

    A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered.

POST Yes
next

The next page of any ApiKey resources in the collection of ApiKey resources. This is not valid for the last item in a collection.

GET No
first

The first page of any ApiKey resources in the collection of ApiKey resources.

GET No
item

The current page of any ApiKey resources in the collection of ApiKey resources.

GET No


Properties

{
  "warnings" : [ "String" ]
}

  • warnings
  • A list of warning messages logged during the import of API keys when the failOnWarnings option is set to true.

Remarks

See Also

Use API Keys