Stack Tags

Creates a new tag on the specified stack. Tags are key-value metadata pairs that can be used for organization, filtering, and storing additional information about stacks. The request body must include both a tag name and value. Returns 400 if the tag name is invalid or the tag already exists. The ‘pulumi:’, ‘gitHub:’ and ‘vcs:’ name prefixes are reserved for built-in tags that Pulumi manages automatically: deploys refresh them from project metadata, so a value written directly is overwritten by the next update. In particular, a stack’s description is the ‘description’ field in the project’s Pulumi.yaml, surfaced as the ‘pulumi:description’ tag — set it by editing Pulumi.yaml rather than by creating the tag.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name

Request Body

Responses

Replaces all tags on the specified stack with the tags provided in the request body. This is a wholesale replacement operation: any existing tags not included in the request will be removed. The request body is a JSON map of tag name-value pairs. Returns 400 if the operation would change the project name tag or if any tags are invalid. Tags with the built-in ‘pulumi:’, ‘gitHub:’ and ‘vcs:’ name prefixes are managed automatically by Pulumi and refreshed from project metadata on every deploy; include them unchanged in the replacement map rather than modifying them — a stack’s description comes from the ‘description’ field in the project’s Pulumi.yaml, not from a direct write of the ‘pulumi:description’ tag.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name

Request Body

Responses

Updates the value of an existing tag on the specified stack. The tag is identified by its name in the URL path. Built-in tags (those automatically managed by the Pulumi CLI, such as project name tags) cannot be updated and will return a 400 error. Returns 404 if the specified tag does not exist on the stack.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name
• tagName string path required
  The tag name

Request Body

Responses

Removes a specific tag from the stack, identified by the tag name in the URL path. Built-in tags (those automatically managed by the Pulumi CLI) cannot be deleted and will return a 400 error. Returns 404 if the specified tag does not exist on the stack. Returns 204 with no content on success.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name
• tagName string path required
  The tag name

Responses