Ir al contenido

image

El dominio image tiene 18 acciones. En la superficie meta se alcanzan todas a través de arcane_image; en la individual, cada una es una herramienta propia; en la dinámica se ejecutan con arcane_execute_action y el ID canónico.

AcciónTítuloTipo
image.attestationsGet image attestationslectura
image.buildBuild an imageescritura
image.build_getGet image buildlectura
image.build_listList image buildslectura
image.countsGet image usage countslectura
image.deleteRemove an imagedestructiva
image.exportExport imagelectura
image.getGet image by IDlectura
image.historyGet image historylectura
image.listList imageslectura
image.patchPatch imageescritura
image.patch_targetsList image patch targetslectura
image.patchesList image patcheslectura
image.prunePrune unused imagesdestructiva
image.pullPull an imageescritura
image.searchSearch imageslectura
image.tagTag imageescritura
image.uploadUpload an imageescritura

Get image attestations

Get in-toto attestation statements attached to a Docker image

  • Tipo: lectura
  • Parámetros obligatorios: name
  • Meta-herramienta: arcane_image con "action": "attestations"
  • Herramienta individual: arcane_image_attestations
  • Ruta de Arcane: GET /api/environments/{id}/images/{name}/attestations
  • ID de operación: get-image-attestations
  • Uso: Reads the in-toto attestations (SBOM, provenance) attached to an image in its registry, using saved registry credentials. name is a local image ID or reference (resolved through its repo digest, else its first tag, which is then looked up in the registry) or a registry reference not pulled locally. An image with neither digest nor tag yields an empty list, and a locally built tag fails unless the registry has an image of that name (whose attestations are then returned). platform (e.g. linux/amd64) selects one manifest of a multi-platform image, predicateType keeps one exact predicate URI, and statement=true adds the statement JSON bodies. Returns imageRef, subjectDigest and attestations with predicateType, digest and subject.
  • Acciones relacionadas: image.get, vulnerability.image_scan

Build an image

Build a Docker image using BuildKit with streaming progress output

  • Tipo: escritura
  • Parámetros obligatorios: contextDir
  • Meta-herramienta: arcane_image con "action": "build"
  • Herramienta individual: arcane_image_build
  • Ruta de Arcane: POST /api/environments/{id}/images/build
  • ID de operación: build-image
  • Uso: Builds with BuildKit (or the provider setting, local or depot) and waits for the result: status completed, activityId and the last output lines. A failed build is an error. contextDir is an absolute directory on the Arcane host (e.g. the buildsDirectory setting plus a build.browse path, filled with build.mkdir and build.upload) or a Git repository URL, cloned with saved git_repository credentials when they match. Set tags to name the image, and dockerfile or dockerfileInline, buildArgs, target, platforms, noCache, pull and push as needed. Every build is recorded: find its id with image.build_list for image.build_get.
  • Acciones relacionadas: build.browse, build.upload, image.build_list, image.build_get, image.get

Get image build

Get a single image build history entry with output

  • Tipo: lectura
  • Parámetros obligatorios: buildId
  • Meta-herramienta: arcane_image con "action": "build_get"
  • Herramienta individual: arcane_image_build_get
  • Ruta de Arcane: GET /api/environments/{id}/images/builds/{buildId}
  • ID de operación: get-image-build
  • Uso: Returns one build record (buildId from image.build_list) with its full settings, status, errorMessage, digest and the captured build output (outputTruncated is true beyond 2 MiB). A build of another environment gives 404.
  • Acciones relacionadas: image.build_list, image.build

List image builds

Get a paginated list of image build history for an environment

  • Tipo: lectura
  • Parámetros obligatorios: ninguno
  • Meta-herramienta: arcane_image con "action": "build_list"
  • Herramienta individual: arcane_image_build_list
  • Ruta de Arcane: GET /api/environments/{id}/images/builds
  • ID de operación: list-image-builds
  • Uso: Pages through the environment’s build history, newest first (start, limit, default 20). Filter with status (running, success, failed) or provider, and search, which matches contextDir, dockerfile, username, provider and errorMessage but not tags. Items carry id, status, tags, contextDir, durationMs and errorMessage but no output. Pass the id to image.build_get for the log.
  • Acciones relacionadas: image.build_get, image.build

Get image usage counts

Get counts of images in use, unused, total, and total size

  • Tipo: lectura
  • Parámetros obligatorios: ninguno
  • Meta-herramienta: arcane_image con "action": "counts"
  • Herramienta individual: arcane_image_counts
  • Ruta de Arcane: GET /api/environments/{id}/images/counts
  • ID de operación: get-image-usage-counts
  • Uso: Returns imagesInuse, imagesUnused, totalImages and totalImageSize (bytes) for the environment, a cheap overview before image.prune. Use image.list for the images themselves.
  • Acciones relacionadas: image.list, image.prune

Remove an image

Remove a Docker image by ID

  • Tipo: destructiva — exige confirm: true
  • Parámetros obligatorios: imageId
  • Meta-herramienta: arcane_image con "action": "delete"
  • Herramienta individual: arcane_image_delete
  • Ruta de Arcane: DELETE /api/environments/{id}/images/{imageId}
  • ID de operación: remove-image
  • Uso: Removes one image (docker rmi). imageId takes an ID from image.list or a reference, and removing a reference of an image with other tags only untags it. Without force Docker refuses an image used by a container, or an image ID referenced by several tags. force=true overrides that, but an image a running container uses still cannot be removed. Also drops Arcane’s stored update records and, when imageId is the image ID (not a reference), its vulnerability scan. Use image.prune to remove unused images in bulk.
  • Acciones relacionadas: image.list, image.prune, container.list

Export image

Download a Docker image as a tar archive

  • Tipo: lectura
  • Parámetros obligatorios: name
  • Meta-herramienta: arcane_image con "action": "export"
  • Herramienta individual: arcane_image_export
  • Ruta de Arcane: GET /api/environments/{id}/images/{name}/export
  • ID de operación: export-image
  • Uso: Returns the image (name is an ID or reference) as a docker save tar archive, embedded as a base64 blob. Archives larger than ARCANE_MCP_MAX_DOWNLOAD_BYTES (4 MiB by default) are not returned. Load it back with image.upload.
  • Acciones relacionadas: image.upload, image.get

Get image by ID

Get a Docker image by its ID

  • Tipo: lectura
  • Parámetros obligatorios: imageId
  • Meta-herramienta: arcane_image con "action": "get"
  • Herramienta individual: arcane_image_get
  • Ruta de Arcane: GET /api/environments/{id}/images/{imageId}
  • ID de operación: get-image
  • Uso: Inspects one local image. imageId takes the ID from image.list or a reference such as busybox:1.37, and an unknown image gives 404. Returns the full sha256 id, repoTags, repoDigests (empty for images never pulled or pushed), config (env, cmd, entrypoint, labels, exposed ports), architecture, os, size and the pinnedReferences containers use.
  • Acciones relacionadas: image.list, image.history, image.attestations, vulnerability.image_scan

Get image history

Get Docker image layer history

  • Tipo: lectura
  • Parámetros obligatorios: name
  • Meta-herramienta: arcane_image con "action": "history"
  • Herramienta individual: arcane_image_history
  • Ruta de Arcane: GET /api/environments/{id}/images/{name}/history
  • ID de operación: get-image-history
  • Uso: Lists the layers of a local image (name is an ID or reference), newest first, each with id, created, createdBy (the Dockerfile instruction), size and tags. Use image.get for the image configuration.
  • Acciones relacionadas: image.get, image.list

List images

Get a paginated list of Docker images

  • Tipo: lectura
  • Parámetros obligatorios: ninguno
  • Meta-herramienta: arcane_image con "action": "list"
  • Herramienta individual: arcane_image_list
  • Ruta de Arcane: GET /api/environments/{id}/images
  • ID de operación: list-images
  • Uso: Pages through the environment’s local images (start, limit, default 20). Search matches repo, tag, ID and pinned references, sort takes repo, tag, size, created, inUse or vulnerabilities. inUse=true/false filters by container use, and updates takes true/false or has_update, up_to_date, error, unknown and reads the stored results of image_update checks. Each item gives id (sha256), repoTags, size, inUse, usedBy and, when recorded, updateInfo and vulnerabilityScan.
  • Acciones relacionadas: image.get, image.counts, image.delete, image_update.check_all, vulnerability.image_scan

Patch image

Patches OS package vulnerabilities in the image using Copacetic, producing a new patched tag

  • Tipo: escritura
  • Parámetros obligatorios: imageId
  • Meta-herramienta: arcane_image con "action": "patch"
  • Herramienta individual: arcane_image_patch
  • Ruta de Arcane: POST /api/environments/{id}/images/{imageId}/patch
  • ID de operación: patch-image
  • Uso: Patches the OS packages of a tagged, registry-pulled image (imageId from image.get or image.patch_targets) with Copacetic in the background and returns the patch record at status patching with patchedRef and activityId. Follow it with image.patches or activity.get. scanId set to the same image ID patches only the findings of its vulnerability.image_scan report (needs vulnerability management enabled). Without it every outdated package is updated. The output tag is patchedTag, or the source tag plus -suffix (suffix defaults to the imagePatchSuffix setting, else patched). Patches run one at a time, and timeoutSeconds defaults to the imagePatchTimeoutSec setting (600). Requires images:patch and a Docker daemon using the containerd image store.
  • Acciones relacionadas: image.patch_targets, image.patches, vulnerability.image_scan, activity.get

List image patch targets

Retrieves scanned images with fixable vulnerability counts and their latest patch run

  • Tipo: lectura
  • Parámetros obligatorios: ninguno
  • Meta-herramienta: arcane_image con "action": "patch_targets"
  • Herramienta individual: arcane_image_patch_targets
  • Ruta de Arcane: GET /api/environments/{id}/images/patch-targets
  • ID de operación: list-image-patch-targets
  • Uso: Lists images whose completed vulnerability scan has fixable findings or that were patched before, with imageId, imageRef, fixableCount, totalCount, localOnly (never pulled, so not patchable) and lastPatch. Patch outputs themselves are left out. Needs vulnerability management enabled and vulnerabilities:read. Pages with start and limit (default 20), search matches the image name.
  • Acciones relacionadas: image.patch, image.patches, vulnerability.image_scan

List image patches

Retrieves the paginated image patch history for the environment

  • Tipo: lectura
  • Parámetros obligatorios: ninguno
  • Meta-herramienta: arcane_image con "action": "patches"
  • Herramienta individual: arcane_image_patches
  • Ruta de Arcane: GET /api/environments/{id}/images/patches
  • ID de operación: list-image-patches
  • Uso: Pages through the environment’s patch runs, newest first (start, limit), each with originalRef, patchedRef, mode (update-all or report), status (patching, completed, failed), packagesUpdated and error. Filter with status, and search matches originalRef and patchedRef. Use it to follow an image.patch run.
  • Acciones relacionadas: image.patch, image.patch_targets

Prune unused images

Remove unused Docker images

  • Tipo: destructiva — exige confirm: true
  • Parámetros obligatorios: ninguno
  • Meta-herramienta: arcane_image con "action": "prune"
  • Herramienta individual: arcane_image_prune
  • Ruta de Arcane: POST /api/environments/{id}/images/prune
  • ID de operación: prune-images
  • Uso: Removes images no container uses and returns imagesDeleted and spaceReclaimed (bytes). Pass dangling=true to remove only untagged (dangling) images: without it, and without body.mode, Arcane removes every unused image, tagged ones included. body.mode (dangling, all, or olderThan with body.until such as 24h) overrides dangling, and olderThan removes every unused image, tagged ones included, created before until. Use system.prune_all to prune containers, networks, volumes and build cache too.
  • Acciones relacionadas: image.counts, image.delete, system.prune_all

Pull an image

Pull a Docker image from a registry with streaming progress output

  • Tipo: escritura
  • Parámetros obligatorios: imageName
  • Meta-herramienta: arcane_image con "action": "pull"
  • Herramienta individual: arcane_image_pull
  • Ruta de Arcane: POST /api/environments/{id}/images/pull
  • ID de operación: pull-image
  • Uso: Pulls imageName (e.g. nginx or ghcr.io/org/app) at tag (Docker uses latest when no tag is given) and waits for the pull to finish. The result has status completed, activityId and the last progress lines, and a failed pull is an error. Credentials of registries saved with registry.create are used automatically for a matching host, but credentials (or auth), each {url, username, token, enabled: true}, override them for this pull, and a rejected login is retried anonymously.
  • Acciones relacionadas: image.search, image.get, registry.list, activity.get

Search images

Search Docker Hub images

  • Tipo: lectura
  • Parámetros obligatorios: ninguno
  • Meta-herramienta: arcane_image con "action": "search"
  • Herramienta individual: arcane_image_search
  • Ruta de Arcane: GET /api/environments/{id}/images/search
  • ID de operación: search-images
  • Uso: Searches Docker Hub through the Docker daemon (docker search) by term, which is required. Results give name, description, starCount and official. Pass a name to image.pull. It does not list tags (use registry.repositories and registry.tags to browse a saved registry).
  • Acciones relacionadas: image.pull, registry.repositories, registry.tags

Tag image

Add a repository tag to an image

  • Tipo: escritura
  • Parámetros obligatorios: name, repository
  • Meta-herramienta: arcane_image con "action": "tag"
  • Herramienta individual: arcane_image_tag
  • Ruta de Arcane: POST /api/environments/{id}/images/{name}/tag
  • ID de operación: tag-image
  • Uso: Adds a tag to an existing local image (docker tag): name is the source image ID or reference, repository the target name (e.g. registry.example.com/team/app) and tag the target tag (Docker uses latest when omitted). The source keeps its tags. Remove a tag with image.delete on the reference.
  • Acciones relacionadas: image.get, image.list, image.delete

Upload an image

Load a Docker image tar archive from a complete chunked upload session. multipart/form-data bodies are still accepted for backward compatibility. That form is deprecated and will be removed in a future release.

  • Tipo: escritura
  • Parámetros obligatorios: uploadId
  • Meta-herramienta: arcane_image con "action": "upload"
  • Herramienta individual: arcane_image_upload
  • Ruta de Arcane: POST /api/environments/{id}/images/upload
  • ID de operación: upload-image
  • Uso: Loads a docker save archive (.tar, .tar.gz, .tgz, .tar.xz) into the environment: create a session with upload.session_create (kind image), send it with upload.chunk_put until complete, then pass its id as uploadId. The session is used up. Archives above the maxImageUploadSize setting (500 MB by default) fail, and the result’s stream holds Docker’s load output naming the loaded images.
  • Acciones relacionadas: upload.session_create, upload.chunk_put, image.export, image.get