Storage endpoint

Start Storage Index

POST/storages/{storageId}/index-runs/

Path parameters

storageId

Identifier used by the registered route.

Example request

application/json

{
  "id": "example-index-run-1"
}

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}/storages/{storageId}/index-runs/"

Supply a valid request.json before running this command.

Replace the path identifiers with IDs from your instance.

202 Acceptedapplication/json

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

{
  "id": "string",
  "storageId": "string",
  "status": "string",
  "indexedEntries": 0,
  "error": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "finishedAt": "2026-01-01T00:00:00Z"
}

Handler-checked behavior

Indexing must be enabled for this registered storage. Use a unique id in place of the example or omit it for a generated ID. The current service completes the bounded scan before responding; the returned record is completed or the request fails. The 202 Accepted status does not mean this scan continues in the background.

Related guide

See the Storage guide for related tasks and context.