Sign In to the Console
AWS AppSync
API Reference (API Version 2017-07-25)

AWS Documentation » AWS AppSync » API Reference » Actions » CreateApiKey

CreateApiKey

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

Request Syntax

POST /v1/apis/apiId/apikeys HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "expires": number
}

URI Request Parameters

The request requires the following URI parameters.

apiId

The ID for your GraphQL API.

Request Body

The request accepts the following data in JSON format.

description

A description of the purpose of the API key.

Type: String

Required: No

expires

The time from creation 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 ApiKey.

Type: Long

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "apiKey": { 
      "description": "string",
      "expires": number,
      "id": "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.

apiKey

The API key.

Type: ApiKey object

Errors

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

ApiKeyLimitExceededException

The API key exceeded a limit. Try your request again.

HTTP Status Code: 400

ApiKeyValidityOutOfBoundsException

The API key expiration must be set to a value between 1 and 365 days from creation (for CreateApiKey) or from update (for UpdateApiKey).

HTTP Status Code: 400

BadRequestException

The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

HTTP Status Code: 400

InternalFailureException

An internal AWS AppSync error occurred. Try your request again.

HTTP Status Code: 500

LimitExceededException

The request exceeded a limit. Try your request again.

HTTP Status Code: 429

LimitExceededException

The request exceeded a limit. Try your request again.

HTTP Status Code: 429

NotFoundException

The resource specified in the request was not found. Check the resource, and then try again.

HTTP Status Code: 404

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401

See Also

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