POST

/v1/apis/{apiId}/apikeys

http://appsync.{region}.amazonaws.com/v1/apis/{apiId}/apikeys

Creates a unique key that you can distribute to clients who invoke your API.

Access Token Required: API Key

Path Parameters

apiIdstringrequired

The ID for your GraphQL API.

Body Params

expiresinteger

From the creation time, the time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time. For more information, see .

descriptionstring

A description of the purpose of the API key.

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 POST \
2     --url 'http://appsync.{region}.amazonaws.com/v1/apis/{apiId}/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}