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

Successful response

plan_id
string
required
Minimum string length: 1
created_at
string<date-time>
required
activated_at
string<date-time>
required
source
enum<string>
required

What recorded the plan, and so why the plan changed. configuration is the startup configuration, which applies the roles its pins changed since it last applied, even over an earlier activation of the same role. activation is an operator activation. rollback is an operator rollback to an earlier plan's roles.

Available options:
configuration,
activation,
rollback
roles
object[]
required

One entry per role, sorted by role.

previous_plan_id
string

The plan this one replaced; absent for the first plan of the deployment.

Minimum string length: 1