Installs

Plan an install

What installing a template would do, without changing anything: each input it needs and whether bindings answers it (bound, invalid, missing), what will be created, an unverified listing’s install cap, planCaps: per kind (tables, feeds, enrichments) what the install needs against what the workspace plan has left, and planGated: the steps the workspace plan does not include (an AI categoriser on a lower plan), which the install skips — never refuses — with “Included on <Plan>: …” (planRequirements lists every one, whatever the plan). Answer every missing or invalid input, then POST /installs with the same body.

post/v1/installs/plan

Request

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

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

source'listing' | 'workspace' | 'preset' | 'inline' required

listing (with listingId), workspace (a saved blueprint, blueprintId), preset (presetKey) or inline (blueprint)

listingIdstring

From GET /marketplace/listings

releaseIdstring

A specific release of the listing; default its current approved release

linkTokenstring

The private-link token (the ?link= value of the private link) of a listing that is not publicly listed; required to install one

blueprintIdstring
presetKeystring
blueprintobject

A portable blueprint

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.

resourceKeysstring[]

Install only these resources (by key) and what they need

Response

The plan

successtrue required

Changes

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