Skip to main content
Create a CLI config

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

One of the types its kind's /types route lists, such as GET /v1/vfs/types.

fields
object
required

The type's config. Secret fields are sealed; a string field may point at a saved store instead.

Response

Created

id
string
required

The entry's id; the daemon uses its name.

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

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

builtin
boolean
required
config
object
required

The plain fields. Sealed fields are never answered.

captures
any[]

A runtime's captures; runtimes only.

created_by
string | null
created_at
string | null
updated_at
string | null
used_by
integer

How many templates name the entry; in a list only.