Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1472221377.0 KB

Updates a Deployment.

patch/v2/apis/{apiId}/deployments/{deploymentId}

Path parameters

apiIdstring required

The API identifier.

deploymentIdstring required

The deployment ID.

Request body

descriptionstring

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

Response

Success

AutoDeployedboolean

Specifies whether a deployment was automatically released.

CreatedDatestring date-time

The date and time when the Deployment resource was created.

DeploymentIdstring

The identifier for the deployment.

DeploymentStatus'PENDING' | 'FAILED' | 'DEPLOYED'

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

DeploymentStatusMessagestring

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

Descriptionstring

The description for the deployment.