Skip to content

Changes a workspace's read-only host folders or DLP mode.

PATCH
/v1/m/sessions/workspaces/{ref}
curl --request PATCH \
--url https://example.com/v1/m/sessions/workspaces/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "dlp_mode": "", "read_only_folders": [ "example" ] }'

Changes a workspace’s read-only host folders or DLP mode. Requires workspace administrator permission; a setting left out is not changed and an empty folder array removes access.

ref
required
string

Path parameter ref.

X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Media type application/json

Name at least one setting with a value. A setting left out or null is not changed.

object
>= 1 properties
dlp_mode
Any of:

Empty selects off, as on registration.

string
Allowed values: "" label deny off
read_only_folders
Any of:

Additional read-only host folders for native sessions. Read-only folders protect file content and directory entries (no write, truncate, create, remove or rename); permissions, ownership, extended attributes and timestamps follow the host’s normal permissions. Must be absolute, existing directories outside protected engine folders. The server stores canonical paths. Omitted on create or an empty array grants no extra access.

Array<string>

OK

Media type application/json
object
Example generated
{}

Bad request

Media type application/json
object
Example generated
{}

Unauthenticated

Media type application/json
object
Example generated
{}

Forbidden

Media type application/json
object
Example generated
{}

Not found

Media type application/json
object
Example generated
{}

Conflict / setup required

Media type application/json
object
Example generated
{}

Rate limited

Media type application/json
object
Example generated
{}