Installs

Install a template

Install a template into this workspace. Answers at once with the install installing; it finishes in the background — poll GET /installs/{installId}. A resource that fails leaves the install partial (retry with PATCH, action: "retry"). Automations arrive switched off. 50 installs an hour per workspace; an unverified listing installs into at most ten workspaces (INSTALL_CAP_REACHED); a template that needs more tables, feeds or enrichments than the plan has left is refused (PLAN_LIMIT_REACHED, the same caps as creating them by hand).

post/v1/installs

Request

  • Base URL: https://api.banksync.io
  • URL: https://api.banksync.io/v1/installs
  • 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

namestring

Default: the template’s title, numbered when one of that name exists

timeZonestring

The installing person’s IANA time zone (Australia/Sydney): a template automation scheduled in the installer’s zone runs in it when the workspace keeps none. Default: UTC

Response

The install

successtrue required

Changes

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