workspace

update an existing protection rule

Changed on
post/w/{workspace}/workspaces/protection_rules/{rule_name}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/workspaces/protection_rules/{rule_name}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required
rule_namestring required

Name of the protection rule to update

Request body

namestring

New name for the rule. Omit, or pass the current name, to leave it unchanged. The reserved dev_workspace_lock rule cannot be renamed, nor can another rule be renamed onto it.

rulesProtectionRuleKind[] required

Configuration of protection restrictions

bypass_groupsstring[] required

Groups that can bypass this ruleset

bypass_usersstring[] required

Users that can bypass this ruleset

Response

protection rule updated successfully

Changes