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

GET

Gets a Deployment.

Response Example

200 - Example 1

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

Request

Path Params

apiId

string

required

The API identifier.

deploymentId

string

required

The deployment ID.

Responses

🟢200Success

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

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

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