Organizations
PolicyGroups

UpdatePolicyGroup

Updates a Policy Group's configuration. This multi-purpose endpoint supports several operations in a single request via different body fields:

  • newName: rename the policy group
  • addStack / removeStack: add or remove stacks (with name and routingProject fields)
  • addPolicyPack / removePolicyPack: add or remove policy packs (with name, version, versionTag, and optional config)
  • addInsightsAccount / removeInsightsAccount: add or remove Insights accounts

Enforcement levels for policy packs are advisory, mandatory, or disabled.

An organization's default Policy Groups cannot be renamed: sending newName for the default stack Policy Group or the default accounts Policy Group returns a 400 error, and no other operation in the same request is applied.

A Policy Group's entity type (stacks or accounts) and enforcement mode (audit or preventative) are fixed when the group is created and cannot be changed here. To use a different entity type or mode, create a new Policy Group.

patch/api/orgs/{orgName}/policygroups/{policyGroup}

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/orgs/{orgName}/policygroups/{policyGroup}
  • Auth: none declared

Path parameters

orgNamestring required

The organization name

policyGroupstring required

The policy group name

Request body

insightsAccountsstring[]

When non-nil, replaces the full list of Insights accounts in the group.

newNamestring

The new name to assign to the policy group. Up to 100 characters, made up of letters, numbers, hyphens, underscores, periods, or spaces, and may not begin or end with a space. Rejected with a 400 error for an organization's default Policy Groups, which cannot be renamed.

agentPoolIdstring

Agent pool ID for audit policy evaluation. Set to empty string to clear, omit to leave unchanged.

Response

No Content

Changes

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