API Documentation

Update restrictions

put https://api.split.io/internal/api/v2/restrictions

Access requirements

The Authorization Bearer (Admin API Key authorizing the request) must have one of the following roles and scopes:

Admin API Key roles accepted

  • API_ALL_GRANTED
  • API_ADMIN
  • API_WORKSPACE_ADMIN*

Admin API Key scopes accepted

  • GLOBAL
  • WORKSPACE*

To learn more about Admin API Key roles and scopes, see API keys overview.

JSON Payload

supported resource's type

workspace

  • supported operation: view restricting access to the project (formerly known as workspace) for both viewing and editing.
  • If the operation is restricted ("view": true), the Administrators group is required as part of the allowed subjects (resourcePermissions.view set).
  • The admin API Key used to configure the restrictions needs to be included as part of the allowed subjects, otherwise, the key will loose the access to the project (formerly known as workspace).
  • To include an admin API Key as part of the allowed users, the value to use as id field is the id field returned in the create API Key response and not the token used to execute requests.
{
  "resource": {
    "id": "string",
    "type": "workspace"
  },
  "operations": {
    "view": true
  },
  "resourcePermissions": {
    "view": [
      {
        "id": "string",
        "type": "user"
      },
      {
        "id": "string",
        "type": "group"
      },
      {
        "id": "string",
        "type": "api_key"
      }
    ]
  }
}
Language