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

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

Properties

• id string required
  Unique identifier for this deployment.
• updates array[UpdateInfo] required
  The list of updates related to this deployment.
• ↳ info AppUpdateInfo required
  The underlying update information from the Pulumi CLI.
• ↳ updateID string required
  UpdateID is the underlying Update’s ID on the PPC.
• ↳ githubCommitInfo GitHubCommitInfo optional

  If the update’s metadata indicates the update environment was from a GitHub based repo we try to lookup the commit that was HEAD at the time of the update.

  May not be set depending on which API is used to obtain the UpdateInfo object.

• ↳ version integer required
  Version of the stack that this UpdateInfo describe.
• ↳ latestVersion integer required
  LatestVersion of the stack in general. i.e. the latest when Version == LatestVersion.
• ↳ requestedBy UserInfo required
  The user who requested the update.
• ↳ policyPacks array[AppPolicyPackMetadata] optional
  The Policy Packs that were required for this update.
• ↳ requestedByToken string optional
  The access token used to request the update, if applicable.
• created string required
  Created defines when the Deployment was created.
• modified string required
  Created defines when the corresponding WorkflowRun was modified.
• status enum required
  The current execution status of the deployment. not-started means the deployment is waiting in the queue. The Pulumi Cloud console shows it as Queued, or as Paused when deployments are paused for the stack or the organization. accepted means the deployment has been taken off the queue for execution but has not started running yet. The console shows it alongside running. Webhook payloads report both not-started and accepted as queued. running means at least one step has started and no step has failed. failed covers, for example, a failed step, a timeout, or a cancellation, whether the deployment was queued or running. skipped means the deployment was removed from the queue without running, either because operationContext.options.skipIntermediateDeployments is enabled for it and a newer deployment of the same operation is queued right behind it for the same stack, or because it was still queued seven days after it was created. Once the deployment’s job has started, this matches the job’s status.
  Values:

  not-started — NotStarted

  The work has been created but has not started yet.

  accepted — Accepted

  The work has been picked up for execution but has not started running yet.

  running — Running

  The work is executing.

  failed — Failed

  The work finished without completing successfully. Failures, timeouts, and cancellations are all reported as failed, and there is no separate status for canceled work. This is a terminal status.

  succeeded — Succeeded

  The work completed successfully. This is a terminal status.

  skipped — Skipped

  The work was dropped without ever running. Only deployments report this status. This is a terminal status.

• 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 execution status of this job. A deployment reports the status of its job, so this is normally the same value as the deployment’s own status.
  Values:

  not-started — NotStarted

  The work has been created but has not started yet.

  accepted — Accepted

  The work has been picked up for execution but has not started running yet.

  running — Running

  The work is executing.

  failed — Failed

  The work finished without completing successfully. Failures, timeouts, and cancellations are all reported as failed, and there is no separate status for canceled work. This is a terminal status.

  succeeded — Succeeded

  The work completed successfully. This is a terminal status.

  skipped — Skipped

  The work was dropped without ever running. Only deployments report this status. This is a terminal status.

• ↳ 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