Skip to content

Update access item

PUT
/api/v1/access/{id}

Updates an access item. For built-in items, saves a customized copy to the DB (overriding the default). For user items, updates the existing DB row. Only provided fields are changed.

id
required
string

Access item ID

Fields to update (all optional)

One of:
object

OK

object
builtIn

BuiltIn is true for items that ship with Warden.

boolean
credentials

Credentials are the individual credential entries in this group.

Array<object>
object
injections

Injections are the container-side delivery targets.

Array<object>
object
key

Key is the env var name or container path for the injection target.

string
readOnly

ReadOnly applies to mount injections — when true the mount is read-only.

boolean
type

Type is the injection kind (env, mount_file, mount_socket).

string
Allowed values: env mount_file mount_socket
value

Value is a static override for the resolved value. When set, this is used instead of the source-resolved value. Useful when the injection needs a fixed container-side path (e.g. SSH_AUTH_SOCK env var pointing to the container socket path).

string
label

Label is a human-readable name for this credential (e.g. “SSH Agent Socket”).

string
sources

Sources are tried in order; the first detected value is used.

Array<object>
object
type

Type is the kind of host source.

string
Allowed values: env file socket command
value

Value is the env var name, file path, socket path, or command string.

string
transform

Transform is an optional processing step applied to the resolved value.

object
params

Params holds type-specific configuration (e.g. “pattern” for strip_lines).

object
key
additional properties
string
type

Type identifies the transformation.

string
Allowed values: strip_lines git_include
description

Description explains what this access item provides.

string
id

ID is a stable identifier. Built-in items use well-known IDs (e.g. “git”, “ssh”); user items get generated UUIDs.

string
label

Label is the human-readable display name (e.g. “Git Config”).

string
method

Method is the delivery strategy (only “transport” for now).

string
Allowed values: transport

Invalid input

object
code
string
Allowed values: INVALID_BODY INVALID_CONTAINER_ID INVALID_CONTAINER_NAME INVALID_WORKTREE_ID INVALID_WORKTREE_NAME REQUIRED_FIELD INVALID_PATH INVALID_NETWORK_CONFIG NOT_A_DIRECTORY NOT_FOUND NAME_TAKEN NOT_CONFIGURED STALE_MOUNTS BUDGET_EXCEEDED PROXY_ERROR INTERNAL
error
string

Item not found

object
code
string
Allowed values: INVALID_BODY INVALID_CONTAINER_ID INVALID_CONTAINER_NAME INVALID_WORKTREE_ID INVALID_WORKTREE_NAME REQUIRED_FIELD INVALID_PATH INVALID_NETWORK_CONFIG NOT_A_DIRECTORY NOT_FOUND NAME_TAKEN NOT_CONFIGURED STALE_MOUNTS BUDGET_EXCEEDED PROXY_ERROR INTERNAL
error
string

Internal Server Error

object
code
string
Allowed values: INVALID_BODY INVALID_CONTAINER_ID INVALID_CONTAINER_NAME INVALID_WORKTREE_ID INVALID_WORKTREE_NAME REQUIRED_FIELD INVALID_PATH INVALID_NETWORK_CONFIG NOT_A_DIRECTORY NOT_FOUND NAME_TAKEN NOT_CONFIGURED STALE_MOUNTS BUDGET_EXCEEDED PROXY_ERROR INTERNAL
error
string