Can't create API Gateway stage/deployment: Missing required key 'deploymentId' in params

Question

I'm trying to configure a new stage in a new API Gateway API in the Console. This API is fresh new. When I try to create a new stage, I'm getting the "Missing required key 'deploymentId' in params error". At the same, I can't find a way to create a deployment in the Console. All docs suggest using CLI but I don't have it. Moreover, the deployment creation command requires a stage id. So I can't create a deployment without a stage, and at the same time, can't create a stage without deployment. What to do?

Deeksha · Answer

1. Create a Deployment First:
    In API Gateway, you need to deploy your API before you can create a stage. The deployment process essentially takes the current state 
    of your API and prepares it for use in a specific stage.
2. Steps to Create a Deployment:
    Go to API Gateway Console: Navigate to the API Gateway service in the AWS Management Console.
    Select Your API: Click on the API that you want to deploy.
    Actions Menu: In the left-hand menu, find the Stages section. Before creating a stage, go to the Actions dropdown and select Deploy 
    API.
3. Deploy API:
   Deployment Stage: You'll be asked to either select an existing stage or create a new one.
  Deployment Description: Optionally, add a description for the deployment.
4. Create a New Stage: If you haven't created a stage yet, you'll need to choose [New Stage] and give it a name (e.g., dev, prod).
    Deploy: Click Deploy to create the deployment and the stage simultaneously.
5. Access the Stage:
   Once the deployment is done, you should see your new stage under the Stages section, and you can interact with it.
6. Check the Deployed API:
    Now, you can access your deployed API via the stage's URL, and it should work as expected

Can't create API Gateway stage/deployment: Missing required key 'deploymentId' in params

Add your answer

Relevant content