GET

/apikeys

http://apigateway.{region}.amazonaws.com/apikeys

Gets information about the current ApiKeys resource.

Access Token Required: API Key

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

The name of queried API keys.

customerIdstring

The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.

includeValuesboolean

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

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/apikeys' \
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}