Skip to content
Exofind

    REST API

    ReindexInfo

    A reindex job record. See Job record and phases.

    Example

    {
      "id": "6f1c2a9d8b3e4c05",
      "index": "products",
      "target": "products@2",
      "source": "products@1",
      "phase": "copying",
      "promote": "auto",
      "documentsCopied": 125000,
      "sourceDocuments": 2400000,
      "backlog": 4100,
      "error": null,
      "startedBy": "3f9a1c7e2b8d4650",
      "node": "node-a-7f21",
      "startedAt": "2026-08-28T10:15:30Z",
      "updatedAt": "2026-08-28T10:16:02Z",
      "finishedAt": null,
      "freshness": null
    }

    Properties

    idstring
    The id of the job, minted when it was accepted. Tells one job of an index from the one that replaced it. null on a record an earlier version wrote.
    Example
    "6f1c2a9d8b3e4c05"
    indexstring
    The name of the index.
    Example
    "products"
    targetstring
    The generation being populated, formatted as index@generation.
    Example
    "products@2"
    sourcestring
    The generation providing the source documents.
    Example
    "products@1"
    phasestring
    The current phase of the job. pending: accepted and waiting for a concurrency slot on the node. copying: streaming documents from the source to the target in primary key order. replaying: copying documents that changed in the source while the copy ran. ready: used only with promote: manual, caught up and waiting for manual promotion, while continuing to catch up periodically. promoting: holding writes for the final drain and promotion. done: completed and promoted successfully. failed: stopped before promotion due to an error, indicated by error. cancelled: stopped before completion in response to a cancellation request.
    Values
    "pending", "copying", "replaying", "ready", "promoting", "done", "failed", "cancelled"
    Example
    "copying"
    promotestring
    The configured promote mode. auto automatically promotes the target generation once it catches up with changes. manual pauses the job in the ready phase and keeps the target caught up until you manually promote it.
    Values
    "auto", "manual"
    Example
    "auto"
    documentsCopiedinteger
    The number of confirmed documents copied to the target.
    Format
    int64
    Example
    125000
    sourceDocumentsinteger
    The document count of the source generation when the copy started.
    Format
    int64
    Example
    2400000
    backloginteger
    The number of changed documents waiting to be replayed when the record was last written.
    Format
    int64
    Example
    4100
    errorstring
    The error message if the job failed, or null.
    startedBystring
    The id of the principal whose request started the job: the id of a key, or the name of a configured principal such as root. null on a record an earlier version wrote.
    Example
    "3f9a1c7e2b8d4650"
    nodestring
    The name of the node running the job, as the indexer listing names it, or the node that ended it. A job resumed on another node after a failover names that node from its next checkpoint on. null on a record an earlier version wrote.
    Example
    "node-a-7f21"
    startedAtstring
    The timestamp when the job started.
    Example
    "2026-08-28T10:15:30Z"
    updatedAtstring
    The timestamp when the job record was last updated.
    Example
    "2026-08-28T10:16:02Z"
    finishedAtstring
    The timestamp when the job reached done, failed or cancelled, or null while it runs.
    Example
    "2026-08-28T10:41:17Z"
    freshnessstring
    A freshness token for the state the promotion of the target landed in. Present once the job reaches done, and null before that. Pass it as freshness.atLeast on a search, and the search is answered from the target generation whichever node it lands on. Opaque; pass it back unchanged. See Freshness.
    Example
    "AQoIcHJvZHVjdHMSATI"

    Endpoints

    Endpoints where the request or responses uses this type.

    Exofind is built by Level Four AB and is available under the Apache License 2.0.