Installs

Update an install

Rename, retry, update to a newer release, rebind an install, or — after an upgrade — add the steps it left out because the plan did not include them (addPlanIncluded). A retry re-runs only what failed or is pending; nothing is duplicated. An update merges the new release over your edits; conflicts keep your value unless resolutions says otherwise. Pass the generation you read: a stale one is refused (STALE).

patch/v1/installs/{installId}

Request

  • Base URL: https://api.banksync.io
  • URL: https://api.banksync.io/v1/installs/{installId}
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

installIdstring required

Install id, from the list

Headers

Idempotency-Keystring

Makes a retry safe: the same key with the same request replays the first answer for 24 hours instead of running twice, and the same key with a different request is a 409 IDEMPOTENCY_KEY_REUSED. Refusals a retry can outlive — 408, 409, 423, 425, 429 and every 5xx — are never replayed, so retrying with the same key after the cause clears runs the request.

Request body

action'rename' | 'retry' | 'update' | 'rebind' | 'addPlanIncluded' required

rename (with name); retry a partial install; update to the listing’s newest release (or releaseId), keeping your edits; rebind with new bindings on the same release; addPlanIncluded after an upgrade, to make the steps the install left out because the plan did not include them (planIncludedNow on GET /installs/{installId})

namestring
releaseIdstring
bindingsobject

Slot id → binding: {"kind":"bank","bankId"}, {"kind":"feed","feedId"}, {"kind":"connection","integrationId"}, {"kind":"container","destination"}, {"kind":"resource","id"} or {"kind":"value","value"}. The plan lists each slot and what answers it.

resolutionsobject

Conflict choices for update: resource key → path → keep (the workspace’s value) or template (the new release’s)

expectedGenerationinteger

The generation you read: required for update and rebind

Response

The install

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.