Deployments

PollDeploymentsQueue

Polls the Pulumi Deployments queue for available work to execute. This endpoint is used by self-hosted deployment agents running in agent pools to pick up queued deployment jobs. Returns 200 with the next available deployment's workflow definition if work is available, or 204 No Content if the queue is empty. Agents should poll this endpoint repeatedly. Authenticated using an agent pool secret rather than a user access token.

get/api/deployments/poll

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/deployments/poll
  • Auth: none declared

Response

OK

deploymentIDstring

Deprecated: use typeSpecificID instead.

jobIDstring required

The unique identifier for the workflow job.

jobTokenstring required

Authentication token for the workflow agent to make API calls to the Pulumi Service.

oidcTokenstring required

OIDC token for authenticating with cloud providers during workflow execution.

runIDstring required

The unique identifier for the workflow run.

typeSpecificIDstring required

The unique identifier specific to the workflow type. For deployments, this is the deployment ID. For insights scans, this is the account ID.

Changes

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