1. Docs
2. Reference
3. REST API Docs
4. Schema
5. GetDeploymentResponse

GetDeploymentResponse is the response from the API when getting a single Deployment.

Properties

• id string required
  Unique identifier for this deployment.
• created string required
  Created defines when the Deployment was created.
• modified string required
  Created defines when the corresponding WorkflowRun was modified.
• status enum required
  Status is the current status of the workflow runID.
  Values:

  not-started — NotStarted

  JobStatusNotStarted indicates that a job has not yet started.

  accepted — Accepted

  JobStatusAccepted indicates that a job has been accepted for execution, but is not yet running.

  running — Running

  JobStatusRunning indicates that a job is running.

  failed — Failed

  JobStatusFailed indicates that a job has failed.

  succeeded — Succeeded

  JobStatusSucceeded indicates that a job has succeeded.

  skipped — Skipped

  JobStatusSkipped indicates that a job has skipped as there are fresher deployments to execute in the queue.

• version integer required
  Version is the ordinal ID for the stack
• requestedBy UserInfo required
  RequestedBy contains the user information about the user who created the Deployment
• ↳ name string required
  The user’s display name.
• ↳ githubLogin string required
  The user’s login name.
• ↳ avatarUrl string required
  The URL of the user’s avatar image.
• ↳ email string optional
  The user’s email address. It is only populated on selected endpoints and is omitted from most responses. Treat it as sensitive information.
• jobs array[DeploymentJob] optional
  Jobs make up all the Jobs of the Deployment. Omitted for deployments that have not started yet.
• ↳ status enum required
  The current status of the deployment job.
  Values:

  not-started — NotStarted

  JobStatusNotStarted indicates that a job has not yet started.

  accepted — Accepted

  JobStatusAccepted indicates that a job has been accepted for execution, but is not yet running.

  running — Running

  JobStatusRunning indicates that a job is running.

  failed — Failed

  JobStatusFailed indicates that a job has failed.

  succeeded — Succeeded

  JobStatusSucceeded indicates that a job has succeeded.

  skipped — Skipped

  JobStatusSkipped indicates that a job has skipped as there are fresher deployments to execute in the queue.

• ↳ started string optional
  The timestamp when the job started.
• ↳ lastUpdated string optional
  The timestamp when the job was last updated.
• ↳ steps array[StepRun] required
  The list of steps in the deployment job.
• latestVersion integer required
  LatestVersion is the most recent version number for deployments for the given programID
• configuration DeploymentConfiguration optional
  Configuration contains the environment variables and source information for a deployment
• ↳ environmentVariables array[EnvironmentVariable] required
  The list of environment variables for the deployment.
• ↳ source DeploymentSource optional
  The source configuration for the deployment.
• initiator string optional
  Initiator is the initiation source of the deployment.
• pulumiOperation enum optional
  PulumiOperation is the operation that was performed. Omitted for historical deployments that predate this field.
  Values:

  update — Update

  preview — Preview

  destroy — Destroy

  refresh — Refresh

  detect-drift — DetectDrift

  remediate-drift — RemediateDrift