POST

/restapis/{restapi_id}/deployments

http://apigateway.{region}.amazonaws.com/restapis/{restapi_id}/deployments

Creates a Deployment resource, which makes a specified RestApi callable over the internet.

Access Token Required: API Key

Path Parameters

restapi_idstringrequired

The string identifier of the associated RestApi.

Body Params

stageNamestring

The name of the Stage resource for the Deployment resource to create.

variablesobject

A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match <code>[A-Za-z0-9-._~:/?#&=,]+</code>.

descriptionstring

The description for the Deployment resource to create.

canarySettingsobject

The input configuration for a canary deployment.

tracingEnabledboolean

Specifies whether active tracing with X-ray is enabled for the Stage.

cacheClusterSizestring

Returns the size of the CacheCluster.

stageDescriptionstring

The description of the Stage resource for the Deployment resource to create.

cacheClusterEnabledboolean

Enables a cache cluster for the Stage resource specified in the input.

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://apigateway.{region}.amazonaws.com/restapis/{restapi_id}/deployments' \
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}