Skip to main content
POST
Create VFS
Save a named VFS configuration. Fields are validated for the selected type. Secret values are stored securely and omitted from read responses. String fields can reference secrets in a saved store. Returns 409 if the name exists.
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.

Body

application/json
name
string
required

1 to 63 of a-z 0-9 . _ -, starting with a letter or digit. Not types, and not shaped like an id.

type
string
required

A supported type from the matching types endpoint, such as GET /v1/vfs/types.

fields
object
required

Settings for the selected type. Secret values are stored securely; string fields can reference a saved secret store.

Response

201 - application/json

Created

id
string
required

Configuration ID. On the OSS server, this equals the name.

name
string
required
kind
enum<string>
required
Available options:
vfs,
cli,
machine
type
string
required

The VFS, CLI or machine type, such as s3.

builtin
boolean
required
config
object
required

Non-secret configuration values. Secret values are omitted.

created_by
string | null
created_at
string<date-time> | null
updated_at
string<date-time> | null