Instance endpoint

Import Archive Instance

POST/instances/import/

Request body

application/zip

See the request guidance below for a valid body.

cURL template

curl --fail-with-body \
  -H "Authorization: Bearer ${AKOFLOW_API_TOKEN}" \
  -H "Content-Type: application/zip" \
  --data-binary @instance.zip \
  -X POST \
  "${AKOFLOW_API_URL}/instances/import/"

Supply a valid instance.zip before running this command.

201 Createdapplication/json

Field shape inferred from Go types; inspect the returned JSON for actual values and optional fields.

{
  "id": "string",
  "name": "string",
  "description": "string",
  "source": "string",
  "status": "string",
  "readOnly": true,
  "credentialsSet": true,
  "importedAt": "2026-01-01T00:00:00Z",
  "exportedAt": "2026-01-01T00:00:00Z",
  "lastOpenedAt": "2026-01-01T00:00:00Z",
  "schemaVersion": "string",
  "akoflowVersion": "string",
  "contents": {}
}

Handler-checked behavior

Send a ZIP archive as the request body with Content-Type: application/zip, not JSON. The archive must be a compatible AkôFlow export with its redaction marker, valid database checksum and schema, no symbolic links, at most 100,000 entries, at most 8 GiB compressed and 64 GiB expanded. Success returns 201 Created with the new read-only snapshot id; import does not replace the active instance. See instance management.

Related guide

See the Instance guide for related tasks and context.