Set up API keys using the API Gateway console - Amazon API Gateway
Require an API key on a methodCreate an API keyImport API keys

Set up API keys using the API Gateway console

To set up API keys, do the following:

  • Configure API methods to require an API key.

  • Create or import an API key for the API in a region.

Before setting up API keys, you must have created an API and deployed it to a stage. After you create an API key value, it cannot be changed.

For instructions on how to create and deploy an API by using the API Gateway console, see Develop REST APIs in API Gateway and Deploy REST APIs in API Gateway, respectively.

After you create an API key, you must associate it with a usage plan. For more information, see Create, configure, and test usage plans with the API Gateway console.

Note

For best practices to consider, see Best practices for API keys and usage plans.

Require an API key on a method

The following procedure describes how to configure an API method to require an API key.

To configure an API method to require an API key

  1. Sign in to the API Gateway console at https://console.aws.amazon.com/apigateway.

  2. Choose a REST API.

  3. In the API Gateway main navigation pane, choose Resources.

  4. Under Resources, create a new method or choose an existing one.

  5. On the Method request tab, under Method request settings, choose Edit.

    Add an API key to a method

  6. Select API key required.

  7. Choose Save.

  8. Deploy or redeploy the API for the requirement to take effect.

If the API key required option is set to false and you don't execute the previous steps, any API key that's associated with an API stage isn't used for the method.

Create an API key

If you've already created or imported API keys for use with usage plans, you can skip this and the next procedure.

To create an API key

  1. Sign in to the API Gateway console at https://console.aws.amazon.com/apigateway.

  2. Choose a REST API.

  3. In the API Gateway main navigation pane, choose API keys.

  4. Choose Create API key.

    Create API keys for usage plans

  5. For Name, enter a name.

  6. (Optional) For Description, enter a description.

  7. For API key, choose Auto generate to have API Gateway generate the key value, or choose Custom to create your own key value.

  8. Choose Save.

Import API keys

The following procedure describes how to import API keys to use with usage plans.

To import API keys

  1. Sign in to the API Gateway console at https://console.aws.amazon.com/apigateway.

  2. Choose a REST API.

  3. In the main navigation pane, choose API keys.

  4. Choose the Actions dropdown menu, and then choose Import API keys.

  5. To load a comma-separated key file, choose Choose file. You can also enter the keys in the text editor. For information about the file format, see API Gateway API key file format.

  6. Choose Fail on warnings to stop the import when there's an error, or choose Ignore warnings to continue to import valid key entries when there's an warning.

  7. Choose Import to import your API keys.