Remove an install
Remove an install, keeping or trashing what it made (mode). What it adopted or linked is never touched. A resource that cannot be removed yet is listed in failures and the install stays removing; calling again retries it.
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
Install id, from the list
Query parameters
keep: what it made stays as ordinary resources. trash: what it made moves to trash, restorable. What it adopted or linked is never touched.
Headers
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.
Response
The removal
Changes
No recorded changes to this operation across all 1 revision of this API.