workspace

create a new protection rule

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

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
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required

Request body

namestring required

Unique name for the protection rule

rulesProtectionRuleKind[] required

Configuration of protection restrictions

bypass_groupsstring[] required

Groups that can bypass this ruleset

bypass_usersstring[] required

Users that can bypass this ruleset

Example request

{
  "name": "Production Protection"
}

Response

protection rule created successfully

Changes