Skip to main content
PUT
Update CLI
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

ref
string
required

Saved configuration name.

Body

application/json
fields
object
required

Configuration fields to update. Omitted secret fields retain their values; null removes a field.

Response

200 - application/json

OK

id
string
required

Configuration ID. On the OSS server, this equals the 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

Non-secret configuration values. Secret values are omitted.

captures
any[]

Runtime capture settings, when applicable.

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

Number of templates using this configuration. Included in list responses only.