GetUsagePlanKeys - Amazon API Gateway


Gets all the usage plan keys representing the API keys added to a specified usage plan.

Request Syntax

GET /usageplans/usageplanId/keys?limit=limit&name=nameQuery&position=position HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


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


A query parameter specifying the name of the to-be-returned usage plan keys.


The current pagination position in the paged result set.


The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "item": [ { "id": "string", "name": "string", "type": "string", "value": "string" } ], "position": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The current page of elements from this collection.

Type: Array of UsagePlanKey objects


The current pagination position in the paged result set.

Type: String


For information about the errors that are common to all actions, see Common Errors.


The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

HTTP Status Code: 400


The requested resource is not found. Make sure that the request URI is correct.

HTTP Status Code: 404


The request has reached its throttling limit. Retry after the specified time period.

HTTP Status Code: 429


The request is denied because the caller has insufficient permissions.

HTTP Status Code: 401


Retrieve usage plan keys

This example illustrates one usage of GetUsagePlanKeys.

Sample Request

GET /usageplans/n371pt/keys HTTP/1.1 Content-Type: application/json Host: Content-Length: 58 X-Amz-Date: 20160805T185459Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160805/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sigv4_hash} Response

Sample Response

{ "_links": { "self": { "href": "/usageplans/n371pt/keys" }, "item": { "href": "/usageplans/n371pt/keys/4wj0d1lt91" } }, "_embedded": { "item": { "_links": { "self": { "href": "/usageplans/n371pt/keys/4wj0d1lt91" } }, "id": "4wj0d1lt91", "name": "MyApiKey", "type": "API_KEY" } } }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: