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

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
      Status is the current status of the workflow runID.
      Values: not-started, accepted, running, failed, succeeded, skipped
    • 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
      IMPORTANT: The email address of the user is only included on a few admin-only APIs. For nearly all APIs that return a UserInfo object, this will not be provided. considered sensitive information.
    • jobs array[DeploymentJob] required
      Jobs make up all the Jobs of the Deployment.
    • status enum required
      The current status of the deployment job.
      Values: not-started, accepted, running, failed, succeeded, skipped
    • 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 required
      PulumiOperation is the operation that was performed.
      Values: update, preview, destroy, refresh, detect-drift, remediate-drift