Blueprints

Export resources as a blueprint

Turn tables, feeds and enrichments of this workspace into a portable template: ids become references between the exported resources, and anything workspace-specific (the bank, a destination) becomes an input the installer answers. Values of your own (a made-up category, the text a rule matches) are left out and listed in report.candidates; send the ids you choose in includeValues to include them. Nothing is saved — pass blueprint to POST /blueprints. At most 40 resources. An id this workspace does not hold (or that the key may not see) is a 404.

post/v1/blueprints/export

Request

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

titlestring required

The template’s title

descriptionstring
tablesstring[]

Table ids to include

feedsstring[]

Feed ids to include

enrichmentsstring[]

Enrichment ids to include

dashboardsstring[]

Dashboard ids to include

widgetsstring[]

Widget ids to include

automationsstring[]

Automation ids to include

includeValuesstring[]

Values of your own to include, by report.candidates[].id. Nothing is included by default; a value holding personal data or a credential is refused.

Response

The blueprint and what was left out

successtrue required

Changes

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