Skip to main content
PUT
Set profile
See error examples and recovery steps. The complete OpenAPI contract includes every response schema.

Authorizations

Authorization
string
header
required

The server's token (MIRAGE_AUTH_TOKEN) or a JWT. A daemon in the default local mode with no token accepts requests without one.

Path Parameters

workspace_id
string
required

Workspace ID.

name
string
required

Body

application/json

Permissions and initial settings for a session. Unspecified settings add no restrictions beyond the workspace configuration.

Use commands, paths, and mounts to control access, and policy for custom rules. For command rules without paths, deny takes precedence over approval requests and allow rules. More specific path rules take precedence over broader rules. See permissions profiles for rule examples.

cwd
string | null
env
Env · object | null
mounts
Mounts · object | null
paths
PathsBlock · object | null

Control which paths a session can access. hide makes matching paths appear not to exist. show exposes more specific paths inside hidden regions, optionally with reduced permissions. Exact paths include their descendants; patterns support *, ?, and character classes.

vars
VarsBlock · object | null

Environment variable names or glob patterns to hide from the session. Hidden variables appear unset.

commands
CommandsBlock · object | null

Command access rules. allow restricts available commands to matching patterns. ask requires approval, and deny blocks matching commands with a reason. If allow is omitted, it adds no restriction.

policy
Policy · object | null
command_limits
Command Limits · object | null
processes
ProcessPermissions · object | null

Control which processes a session can list or stop, and the maximum number it can run. Sessions always have access to their own processes. The stop scope cannot exceed the list scope. Profile settings override workspace defaults.

network

Response

200 - application/json

OK

{key}
string