Skip to content

podman_secret

The podman_secret domain has 5 actions. On the meta surface they are all reached through arcane_podman_secret; on the individual surface each one is its own tool; on the dynamic surface run them with arcane_execute_action and the canonical ID.

ActionTitleKind
podman_secret.createCreate Podman secretwrite
podman_secret.deleteRemove Podman secretdestructive
podman_secret.getInspect Podman secretread
podman_secret.listList Podman secretsread
podman_secret.updateReplace Podman secretdestructive

Create Podman secret

  • Kind: write
  • Required parameters: data, name
  • Meta tool: arcane_podman_secret with "action": "create"
  • Individual tool: arcane_podman_secret_create
  • Arcane route: POST /api/environments/{id}/podman/secrets
  • Operation ID: create-podman-secret
  • Since: Arcane v2.17.0
  • Usage: Creates a Podman secret from name and data (the value as plain text, and it is never returned again), with optional driver (default file), driverOptions and labels. Returns its id. Containers use it by name (secret=… in a quadlet, or podman run --secret). Needs podman:secrets.
  • Related actions: podman_secret.list, podman_secret.update, podman_quadlet.create

Remove Podman secret

  • Kind: destructive — requires confirm: true
  • Required parameters: secretId
  • Meta tool: arcane_podman_secret with "action": "delete"
  • Individual tool: arcane_podman_secret_delete
  • Arcane route: DELETE /api/environments/{id}/podman/secrets/{secretId}
  • Operation ID: delete-podman-secret
  • Since: Arcane v2.17.0
  • Usage: Deletes a Podman secret (secretId: name or ID from podman_secret.list). Containers already using it keep their copy, but new ones cannot mount it. Needs podman:secrets.
  • Related actions: podman_secret.list, podman_secret.create

Inspect Podman secret

Returns secret metadata. The value is never included

  • Kind: read
  • Required parameters: secretId
  • Meta tool: arcane_podman_secret with "action": "get"
  • Individual tool: arcane_podman_secret_get
  • Arcane route: GET /api/environments/{id}/podman/secrets/{secretId}
  • Operation ID: get-podman-secret
  • Since: Arcane v2.17.0
  • Usage: A secret’s metadata (secretId: name or ID from podman_secret.list): id, spec (name, driver with options, labels), createdAt and updatedAt. The value can never be read back. Needs podman:read.
  • Related actions: podman_secret.list, podman_secret.update

List Podman secrets

  • Kind: read
  • Required parameters: none
  • Meta tool: arcane_podman_secret with "action": "list"
  • Individual tool: arcane_podman_secret_list
  • Arcane route: GET /api/environments/{id}/podman/secrets
  • Operation ID: list-podman-secrets
  • Since: Arcane v2.17.0
  • Usage: A page of the Podman host’s secrets (id, spec with name, driver and labels, createdAt, updatedAt). Values are never included. search matches name, ID or driver. sort by name, driver, createdAt or updatedAt. start and limit page. These are the Podman engine’s own secrets. Needs podman:read.
  • Related actions: podman_secret.get, podman_secret.create, podman_secret.update, podman_secret.delete

Replace Podman secret

Replace the value, driver, and labels of an existing secret

  • Kind: destructive — requires confirm: true
  • Required parameters: secretId, data
  • Meta tool: arcane_podman_secret with "action": "update"
  • Individual tool: arcane_podman_secret_update
  • Arcane route: PUT /api/environments/{id}/podman/secrets/{secretId}
  • Operation ID: update-podman-secret
  • Since: Arcane v2.17.0
  • Usage: Replaces a secret in place, as podman secret create --replace: data becomes the new value and driver, driverOptions and labels are replaced too, so labels not sent again are dropped. The secret gets a new id under the same name. The old value cannot be recovered, hence destructive. Running containers keep the value they mounted until recreated. secretId is the name (from podman_secret.list). Needs podman:secrets.
  • Related actions: podman_secret.get, podman_secret.list