Sign in
ApprovalRules

Modifies an existing approval rule in the specified Octopus Deploy space.

put/{spaceId}/approvalrules/{id}

Path parameters

spaceIdstring required
idstring required

Request body

AllowSelfApprovalboolean

Whether deployment creators are allowed to approve their own deployments

ApprovingTeamIdsstring[]

A list of team ids who are authorized to approve deployments

ApprovingUserIdsstring[]

A list of user ids who are authorized to approve deployments

Descriptionstring
Idstring required
IsDisabledboolean

Whether this approval rule is disabled

MinimumApproversRequiredinteger

Set a number of minimum approvers required to authorize the deployment

Namestring required
ScopingStrategystring

How to scope this approval rule. ["Tag", "Id"]

SpaceIdstring required
TenantApprovalStrategystring

Example request

{
  "ApprovingTeamIds": [
    "Teams-1",
    "..."
  ],
  "ApprovingUserIds": [
    "Users-1",
    "..."
  ],
  "IdScopes": [
    {
      "EnvironmentIds": [
        "Environments-1",
        "..."
      ],
      "ProjectId": "Projects-1"
    }
  ],
  "SpaceId": "Spaces-1"
}

Response

Success

AllowSelfApprovalboolean
ApprovingTeamIdsstring[]
ApprovingUserIdsstring[]
Descriptionstring
Idstring required
IsDisabledboolean
MinimumApproversRequiredinteger
Namestring required
ScopingStrategystring
SpaceIdstring required
TenantApprovalStrategystring

Example response

{
  "ApprovingTeamIds": [
    "Teams-1",
    "..."
  ],
  "ApprovingUserIds": [
    "Users-1",
    "..."
  ],
  "IdScopes": [
    {
      "EnvironmentIds": [
        "Environments-1",
        "..."
      ],
      "ProjectId": "Projects-1"
    }
  ],
  "SpaceId": "Spaces-1"
}

Changes