URI HTTP methods Schemas Properties See also

Deployment

Represents an API deployment.

URI

/v2/apis/apiId/deployments/deploymentId

HTTP methods

GET

Operation ID: GetDeployment

Gets a Deployment.

Path parameters
Name	Type	Required	Description
`apiId`	String	True	The API identifier.
`deploymentId`	String	True	The deployment ID.

Responses
Status code	Response model	Description
`200`	`Deployment`	Success
`404`	`NotFoundException`	The resource specified in the request was not found.
`429`	`LimitExceededException`	The client is sending more than the allowed number of requests per unit of time.

DELETE

Operation ID: DeleteDeployment

Deletes a Deployment.

Path parameters
Name	Type	Required	Description
`apiId`	String	True	The API identifier.
`deploymentId`	String	True	The deployment ID.

Responses
Status code	Response model	Description
`204`	None	The request has succeeded, and there is no additional content to send in the response payload body.
`404`	`NotFoundException`	The resource specified in the request was not found.
`429`	`LimitExceededException`	The client is sending more than the allowed number of requests per unit of time.

PATCH

Operation ID: UpdateDeployment

Updates a Deployment.

Path parameters
Name	Type	Required	Description
`apiId`	String	True	The API identifier.
`deploymentId`	String	True	The deployment ID.

Responses
Status code	Response model	Description
`200`	`Deployment`	Success
`400`	`BadRequestException`	One of the parameters in the request is invalid.
`404`	`NotFoundException`	The resource specified in the request was not found.
`409`	`ConflictException`	The resource already exists.
`429`	`LimitExceededException`	The client is sending more than the allowed number of requests per unit of time.

Schemas

Request bodies


{
  "description": "string"
}

Response bodies


{
  "deploymentId": "string",
  "description": "string",
  "createdDate": "string",
  "deploymentStatus": enum,
  "deploymentStatusMessage": "string",
  "autoDeployed": boolean
}


{
  "message": "string"
}


{
  "message": "string",
  "resourceType": "string"
}


{
  "message": "string"
}


{
  "message": "string",
  "limitType": "string"
}

Properties

BadRequestException

The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

Property	Type	Required	Description
`message`	string	False	Describes the error encountered.

ConflictException

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

Property	Type	Required	Description
`message`	string	False	Describes the error encountered.

Deployment

An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.

Property	Type	Required	Description
`autoDeployed`	boolean	False	Specifies whether a deployment was automatically released.
`createdDate`	string Format: date-time	False	The date and time when the `Deployment` resource was created.
`deploymentId`	string	False	The identifier for the deployment.
`deploymentStatus`	DeploymentStatus	False	The status of the deployment: `PENDING`, `FAILED`, or `SUCCEEDED`.
`deploymentStatusMessage`	string	False	May contain additional feedback on the status of an API deployment.
`description`	string	False	The description for the deployment.

DeploymentStatus

Represents a deployment status.

PENDING
FAILED
DEPLOYED

LimitExceededException

A limit has been exceeded. See the accompanying error message for details.

Property	Type	Required	Description
`limitType`	string	False	The limit type.
`message`	string	False	Describes the error encountered.

NotFoundException

The resource specified in the request was not found. See the message field for more information.

Property	Type	Required	Description
`message`	string	False	Describes the error encountered.
`resourceType`	string	False	The resource type.

UpdateDeploymentInput

Represents the input parameters for an UpdateDeployment request.

Property	Type	Required	Description
`description`	string	False	The description for the deployment resource.