Skip to content

image_update

The image_update domain has 7 actions. On the meta surface they are all reached through arcane_image_update; 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
image_update.check_allCheck all imageswrite
image_update.check_batchCheck multiple imageswrite
image_update.check_by_idCheck image update by IDwrite
image_update.check_by_id_refreshCheck image update by ID (POST)write
image_update.check_refCheck image update by referencewrite
image_update.info_by_refsGet persisted update info for image referencesread
image_update.summaryGet update summaryread

Check all images

  • Kind: write
  • Required parameters: none
  • Meta tool: arcane_image_update with "action": "check_all"
  • Individual tool: arcane_image_update_check_all
  • Arcane route: POST /api/environments/{id}/image-updates/check-all
  • Operation ID: check-all-images
  • Usage: Checks every tagged local image plus the references containers (running or stopped) use against their registries, skipping images whose containers all opted out with the label com.getarcaneapp.arcane.update-check=false. The call waits for the whole scan (slow with many images), stores the results and deletes stored records of images that no longer exist. The answer maps each image reference to its result (hasUpdate, updateType, error…). Optional credentials work as in image_update.check_batch. Afterwards image_update.summary gives the totals and updater.run applies the updates.
  • Related actions: image_update.summary, image_update.check_batch, image_update.info_by_refs, updater.run

Check multiple images

  • Kind: write
  • Required parameters: imageRefs
  • Meta tool: arcane_image_update with "action": "check_batch"
  • Individual tool: arcane_image_update_check_batch
  • Arcane route: POST /api/environments/{id}/image-updates/check-batch
  • Operation ID: check-multiple-images
  • Usage: Checks the listed references (imageRefs, an array of refs like nginx:1.27, where an empty array returns an empty map) against their registries in one background workflow, waits for it and stores the results. The answer maps each reference to its result (same shape as image_update.check_ref, each carrying the workflow’s activityId), and a reference whose check failed has its message in its error field instead of failing the call. Optional credentials (each entry needs url, username, token and enabled=true, otherwise it is ignored) replace the saved registry logins of registry.list for this check only. For every image of the environment use image_update.check_all.
  • Related actions: image_update.check_ref, image_update.check_all, image_update.info_by_refs, registry.list

Check image update by ID

  • Kind: write
  • Required parameters: imageId
  • Meta tool: arcane_image_update with "action": "check_by_id"
  • Individual tool: arcane_image_update_check_by_id
  • Arcane route: GET /api/environments/{id}/image-updates/check/{imageId}
  • Operation ID: check-image-update-by-id
  • Usage: Runs the image_update.check_ref check for a local image: imageId is an image ID from image.list (sha256: prefix optional) or a name:tag. Arcane resolves it to the image’s first repo tag (else its repository with :latest, or, for a pruned image, the tag reference a running or stopped container still uses) and fails if none exists. The result has the same shape as image_update.check_ref and is stored, so image.list and image_update.summary reflect it.
  • Related actions: image.list, image_update.check_ref, image_update.summary

Check image update by ID (POST)

  • Kind: write
  • Required parameters: imageId
  • Meta tool: arcane_image_update with "action": "check_by_id_refresh"
  • Individual tool: arcane_image_update_check_by_id_refresh
  • Arcane route: POST /api/environments/{id}/image-updates/check/{imageId}
  • Operation ID: check-image-update-by-id-post
  • Usage: POST twin of image_update.check_by_id: Arcane runs the very same handler (same imageId, same stored result), so prefer image_update.check_by_id.
  • Related actions: image_update.check_by_id, image.list

Check image update by reference

  • Kind: write
  • Required parameters: none
  • Meta tool: arcane_image_update with "action": "check_ref"
  • Individual tool: arcane_image_update_check_ref
  • Arcane route: GET /api/environments/{id}/image-updates/check
  • Operation ID: check-image-update
  • Usage: Asks the registry now whether one image reference has a newer version. imageRef (e.g. nginx:1.27, from image.list or container.list) is required although the schema marks it optional. The result (hasUpdate, updateType digest, local or not_pulled (the ref resolves remotely but is not pulled locally, so nothing is compared), currentDigest/latestDigest, error, activityId, containerUpdates keyed by container ID for containers with their own tag policy) is stored, logged as an activity and may trigger update notifications. Digest-pinned refs (name@sha256:…) and locally built images are answered without asking the registry, an unparsable reference comes back in the error field, but a registry lookup failure usually fails the call. For a local image ID use image_update.check_by_id, for several refs image_update.check_batch, for stored results without a registry call image_update.info_by_refs.
  • Related actions: image_update.check_by_id, image_update.check_batch, image_update.info_by_refs, image.pull, updater.container_update

Get persisted update info for image references

  • Kind: read
  • Required parameters: none
  • Meta tool: arcane_image_update with "action": "info_by_refs"
  • Individual tool: arcane_image_update_info_by_refs
  • Arcane route: GET /api/environments/{id}/image-updates/by-refs
  • Operation ID: get-update-info-by-refs
  • Usage: Reads the stored results of earlier checks without contacting any registry: imageRefs is one comma-separated string (e.g. nginx:1.27,redis:7), not an array. The answer maps each given reference to its last image-level result. References never checked are simply absent, so run image_update.check_ref or image_update.check_batch for those or for fresher data. Needs only the image-updates:read permission, unlike the check actions (image-updates:check).
  • Related actions: image_update.check_ref, image_update.check_batch, image_update.summary

Get update summary

  • Kind: read
  • Required parameters: none
  • Meta tool: arcane_image_update with "action": "summary"
  • Individual tool: arcane_image_update_summary
  • Arcane route: GET /api/environments/{id}/image-updates/summary
  • Operation ID: get-update-summary
  • Usage: Totals for the environment: totalImages counts the current local images, imagesWithUpdates, digestUpdates and errorsCount come from stored check results for those images. No registry is contacted, so run image_update.check_all first for fresh numbers. To apply updates use updater.run (all) or updater.container_update (one container).
  • Related actions: image_update.check_all, image_update.info_by_refs, updater.run, updater.container_update