workspace

list all protection rules for a workspace

Changed on
get/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

Response

list of protection rules

namestring required

Unique name for the protection rule

workspace_idstring
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 response

[
  {
    "name": "Production Protection"
  }
]

Changes

  • d25bf4c71250Revision changes
    • warning

      added the new RestrictGuestAppDeployment enum value to the // response property for the response status

  • 966123aa8b8bRevision changes
    • warning

      added the new RestrictPublicRunSharing enum value to the // response property for the response status