Artifacts endpoint

Register Docker Artifact

POST/artifacts/docker/

Example request

application/json

{
  "artifactId": "busybox",
  "version": "1.36",
  "image": "docker.io/library/busybox:1.36",
  "architecture": "amd64"
}

cURL template

curl --fail-with-body \
  -H "Authorization: Bearer ${AKOFLOW_API_TOKEN}" \
  -H "Content-Type: application/json" \
  --data-binary @request.json \
  -X POST \
  "${AKOFLOW_API_URL}/artifacts/docker/"

Supply a valid request.json before running this command.

201 Createdapplication/json

Handler-checked response shape; values and optional fields vary.

{
  "artifact": {
    "id": "artifact-version-...",
    "artifactId": "busybox",
    "version": "1.36",
    "scope": "system"
  },
  "build": {
    "id": "build-...",
    "artifactVersionId": "artifact-version-...",
    "sourceType": "docker-image",
    "contextDigest": "sha256:...",
    "recipePath": "docker.io/library/busybox:1.36",
    "recipeDigest": "sha256:...",
    "targetFormat": "sif",
    "targetOs": "linux",
    "targetArchitecture": "amd64",
    "buildArguments": "{}",
    "cacheKey": "docker-image:..."
  }
}

Handler-checked behavior

Required: artifactId, version, and a Docker image reference without whitespace. architecture defaults to amd64. This registers a version and build specification; it does not pull the image or create a SIF yet. Use build.id from the response in POST /artifact-builds/{buildId}/runs/ to start conversion. The build run returns a separate ID.

Related guide

See the Artifacts guide for related tasks and context.