Deployments

PatchDeploymentSettings

Creates or updates Pulumi Deployments settings for a stack using a merge operation. If no settings exist, they are created. If settings already exist, the request body is merged with the current settings using the following logic: for each property, start with the current value, remove it if the patch specifies null, or merge the new non-null value with the existing one. Non-object properties (strings, numbers, booleans) are replaced entirely. Settings include source context (git repository URL, branch, directory), operation context (environment variables, pre-run commands, OIDC configuration), executor context, GitHub integration settings, and cache options. Requires a Team Growth or higher subscription. Cannot be used to configure Pulumi Deployments for Terraform stacks.

post/api/stacks/{orgName}/{projectName}/{stackName}/deployments/settings

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

Path parameters

orgNamestring required

The organization name

projectNamestring required

The project name

stackNamestring required

The stack name

Request body

agentPoolIDstring

The identifier of the agent pool to use for deployments.

tagstring

A tag to identify the deployment settings configuration.

Response

OK

agentPoolIDstring

The identifier of the agent pool to use for deployments.

source'console' | 'api' | 'provider' | 'github-review-stack' | 'azure-devops-review-stack' | 'gitlab-review-stack' | 'bitbucket-review-stack' | 'github-gitops'

The source from which the deployment settings were created.

tagstring

A tag to identify the deployment settings configuration.

versioninteger

The version of the deployment settings.

Changes

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