GET

/usageplans/{usageplanId}/keys

http://apigateway.{region}.amazonaws.com/usageplans/{usageplanId}/keys

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

Access Token Required: API Key

Path Parameters

usageplanIdstringrequired

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

Query Params

positionstring

The current pagination position in the paged result set.

limitinteger

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

namestring

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://apigateway.{region}.amazonaws.com/usageplans/{usageplanId}/keys' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}