Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14120262383.5 KB

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

post/restapis/{restapi_id}/deployments

Path parameters

restapi_idstring required

The string identifier of the associated RestApi.

Request body

stageNamestring

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

stageDescriptionstring

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

descriptionstring

The description for the Deployment resource to create.

cacheClusterEnabledboolean

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

cacheClusterSize'0.5' | '1.6' | '6.1' | '13.5' | '28.4' | '58.2' | '118' | '237'

Returns the size of the CacheCluster.

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>.

tracingEnabledboolean

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

Response

Success

idstring

The identifier for the deployment resource.

descriptionstring

The description for the deployment resource.

createdDatestring date-time

The date and time that the deployment resource was created.

apiSummaryobject

A summary of the RestApi at the date and time that the deployment resource was created.