Skip to main content
POST
Call VFS function
Call a VFS function by name using the selected session and its permissions. Request arguments and the JSON response depend on the function. A name no mount declares answers 400 with errno ENOTSUP. A name Mirage defines itself, such as copy, answers 400 without an errno.
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

The function's name, as a mount declares it.

Query Parameters

session_id
string

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

Body

application/json
path
string
required

The path the function acts on.

kwargs
object

The function's keyword arguments.

Response

200 - application/json

value is what the function returns.

value
any
required

What the function returns.