Deployments

StackDeploymentsMetadata

Returns metadata about the Pulumi Deployments state for a specific stack. The response distinguishes the source of any pause:

  • paused: overall pause status (true if either stack or org is paused)
  • stackPaused: whether the stack itself is paused
  • organizationPaused: whether the containing organization is paused

This is useful for determining whether new deployments will be processed or held in the queue.

get/api/stacks/{orgName}/{projectName}/{stackName}/deployments/metadata

Request

  • Base URL: https://api.pulumi.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pulumi.com/api/stacks/{orgName}/{projectName}/{stackName}/deployments/metadata
  • Auth: none declared

Path parameters

orgNamestring required

The organization name

projectNamestring required

The project name

stackNamestring required

The stack name

Response

OK

hasSchedulesboolean required

HasSchedules is true if the stack has at least one schedule.

organizationPausedboolean required

OrgPaused is true if all deployments are paused for the org.

pausedboolean required

Paused is true if new deployments for this stack right now would be paused. This could be due to a stack-level or org-level pause.

stackPausedboolean required

StackPaused is true if deployments for this stack specifically are paused.

Changes

No recorded changes to this operation across all 1 revision of this API.