Menu
Amazon API Gateway
Developer Guide

Deploy an API with the Amazon API Gateway Console

Prerequisites

Deploy an API with the API Gateway Console

Note

If you want to change a stage in API Gateway to use a different deployment, see Change a Stage to Use a Different Deployment with the API Gateway Console instead.

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

  2. In the box that contains the name of the API you want to deploy, choose Resources.

  3. In the Resources pane, choose Deploy API.

  4. For Deployment stage, do one of the following:

    • To deploy the API to an existing stage, choose the name of the stage.

    • To deploy the API to a new stage, choose New Stage. For Stage name, type the name of the stage you want to use for the deployment.

      Tip

      The stage name should be meaningful, but short enough to be easy and fast to type. Your users will specify this name as part of the URL they will use to invoke the API.

  5. (Optional) For Stage description, type a description for the stage.

  6. (Optional) For Deployment description, type a description for the deployment.

  7. Choose Deploy.

Update deployment configuration with the API Gateway Console

After an API is deployed to a stage, you can, optionally, modify the deployment by updating the stage settings or stage variables. After making any changes, you must redeploy the API. The following procedure demonstrates how to accomplish with the API Gateway Console.

  1. If needed, choose the Settings tab in the Stage Editor pane of the API Gateway Console.

    You can then choose to use or not use API cache, to enable or disable CloudWatch logs, to change throttling settings, or to select or deselect a client certificate.

  2. If needed, choose the Stage Variables tab in the Stage Editor pane of the API Gateway Console.

    You can then choose to update the values of selected stage variables.

  3. If you made any change, choose the Save Changes button; go back to the Resources window; and then choose Deploy API again.

Note

If the updated settings, such as enabling logging, requires a new IAM role, you can add the required IAM role without redeploying the API. However, it can take a few minutes before the new IAM role takes effect. Before that happens, traces of your API calls will not be logged even if you have enabled the logging option.

Change a Stage to Use a Different Deployment with the API Gateway Console

Once you have deployed an API more than once, you can choose a specific deployment for a given stage. The following procedure shows how to do this.

  1. You must have deployed to the stage at least twice. Follow the instructions in Deploy an API with the API Gateway Console.

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

  3. In the box that contains the name of the API with the stage you want to change, choose Stages.

  4. Choose the stage you want to update the deployment.

  5. On the Deployment History tab, choose the option button next to the deployment you want the stage to use.

  6. Choose Change Deployment.