/v2/apis/{apiId}/deployments

POST

Creates a Deployment for an API.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v2/apis//deployments' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "string",
    "stageName": "string"
}'

Response Example

201 - Example 1

{
  "AutoDeployed": true,
  "CreatedDate": "string",
  "DeploymentId": "string",
  "DeploymentStatus": "PENDING",
  "DeploymentStatusMessage": "string",
  "Description": "string"
}

Request

Path Params

apiId

string

required

The API identifier.

Body Params application/json

description

string

optional

A string with a length between [0-1024].

stageName

string

optional

A string with a length between [1-128].

Examples

Responses

🟢201Success

application/json

Body

AutoDeployed

boolean

optional

Specifies whether a deployment was automatically released.

CreatedDate

string <date-time>

optional

The date and time when the Deployment resource was created.

DeploymentId

string

optional

The identifier for the deployment.

DeploymentStatus

enum<string>

optional

The status of the deployment: PENDING, FAILED, or SUCCEEDED.

Allowed values:

PENDINGFAILEDDEPLOYED

DeploymentStatusMessage

string

optional

May contain additional feedback on the status of an API deployment.

Description

string

optional

The description for the deployment.

🟠480NotFoundException

🟠481TooManyRequestsException

🟠482BadRequestException

🟠483ConflictException

Modified at 2023-08-15 05:49:07

/v2/apis/{apiId}/authorizers

/v2/apis/{apiId}/deployments