Skip to main content
POST
Rollback pipeline plan

Authorizations

Authorization
string
header
required

API key, not necessarily a JWT. Server derives Organization, permitted actions and Corpus scope; every resource access is authorized.

Body

application/json
idempotency_key
string
required
Required string length: 1 - 200
plan_id
string

The plan whose roles become active again; absent returns to the plan the active one replaced (its previous_plan_id).

Minimum string length: 1
pinned_work
enum<string>
default:drain

What happens to work pinned to a plan naming a plugin version the rollback takes out. drain lets it finish on that version, which stays draining meanwhile. stop keeps it from calling that version again once each process follows the new plan (within plugin_plan_poll). Its next call fails instead. The processing of a Version then stops with the diagnostic pinned_plan_stopped, with the outcome of pinned_plugin_unavailable, and a rebuild fails with that code. A connector run fails as when its plugin is unavailable, and its next run uses the active plan.

Available options:
drain,
stop

Response

Accepted background Operation.

Administrative execution only. Retries keep identity. Intentional terminal rerun has a new ID and previous_operation_id. Cancellation does not promise universal rollback; already-terminal state and racing completion may win. projection_rebuild, retrieval_configuration and backfill Operations require corpus_id; when succeeded they require result naming the activated logical generation, or for a backfill the generation it filled. A backfill also carries backfill, and its counters versions_in_scope, versions_done, versions_skipped (with skipped_) and segments. A quarantine_reprocess carries corpus_id and quarantine_reprocess, and its counters versions_in_scope, versions_recovered, versions_quarantined and versions_skipped (with skipped_); it has no result. Only a backfill and a quarantine_reprocess can be paused. vector_space_promotion, plugin_activation and plugin_rollback carry admin, with no corpus_id. Their counters records_scanned, versions_missing and segments_missing describe the preflight; required_missing excludes gaps retained from an earlier rollback. Success publishes routing; rollback recovery continues in the background after success.

operation_id
string
required
Minimum string length: 1
kind
string
required
Minimum string length: 1
state
enum<string>
required
Available options:
queued,
running,
paused,
succeeded,
failed,
cancel_requested,
canceled
counters
object
required
errors
object[]
required
Maximum array length: 20
progress
number

Approximate fraction, omitted when unknown.

Required range: 0 <= x <= 1
previous_operation_id
string
Minimum string length: 1
corpus_id
string
required if kind = projection_rebuild, retrieval_configuration or backfill
Minimum string length: 1
result
object
conditionally required

Logical generation activated for the requested Corpus. Opaque ID, never a physical search collection name.

admin
object

Routing command target and successful cutover result. Administrative Operations have no corpus_id and require plugins:admin to follow. Their kinds are vector_space_promotion, plugin_activation and plugin_rollback.

backfill
object

What a backfill fills and how far it got.

quarantine_reprocess
object

What a quarantine reprocess covers, the plan it runs with and the dry run it followed.