Skip to content

sessions module route (requires sessions:workspace:admin)

POST
/v1/m/sessions/workspaces
curl --request POST \
--url https://example.com/v1/m/sessions/workspaces \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "allow_subpaths": [ "example" ], "container_target": "example", "dlp_mode": "", "max_read_bytes": 1, "mount_mode": "", "name": "example", "root_path": "example" }'

Creates one session workspace from the posted parameters, and answers 503 when the workspace registry is not available.

X-Olivares-Tenant
string format: uuid

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

Media type application/json
object
allow_subpaths
Any of:

Relative, NUL-free paths that cannot escape the workspace root.

Array
container_target
Any of:

Must be absolute after trimming; empty/null selects the default container target.

string
dlp_mode
Any of:

Empty/null defaults to label.

string
Allowed values: "" label deny off
max_read_bytes
Any of:
integer format: int64
mount_mode
Any of:

Empty/null defaults to rw.

string
Allowed values: "" rw ro
name
Any of:

Trimmed workspace display name.

string
root_path
required

After trimming, must be an absolute, existing directory; the server stores its canonical real path.

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
{}