Skip to main content
POST
Write file
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.

Query Parameters

session_id
string

Session ID to use. If omitted, the default session is used.

explain
boolean
default:false

Return what the call would do without running it.

Body

application/json
path
string
required
data
string
required

The bytes, base64-encoded.

Response

200 - application/json

What the call returns; with explain=true, its explanation

Policy evaluation for a request without executing it. Returned when explain=true.

outcome
enum<string>
required
Available options:
ALLOW,
DENY,
ASK
type
string

line, command or vfs.

reason
string

Reason returned by the policy that determined the outcome.

source
string

Where in the profile the deciding rule is written.

answers
object[]

Evaluation results from each policy.

refusal
object | null
call
string
paths
string[]
error
string

The errno name the call would raise, empty when it runs.