Purge Deleted Configuration
Permanently removes a configuration from the trash, including all its versions, rows and metadata. This cannot be undone.
The configuration must already be deleted (in the trash) — purging a live configuration fails with 400 and storage.components.configurations.notInTrash. Unlike deleting an already-deleted configuration (which also purges, for backward compatibility), this endpoint never falls back to a soft delete, so a stale caller can never destroy a live configuration.
Only available in the default branch; development branch configurations cannot be permanently removed. Requires the canPurgeTrash token permission.
The If-Match header is required: purge is irreversible, so the caller must state which version of the configuration it decided to destroy. Send the version field of the configuration (deleted configurations are listed with ?isDeleted=1) as a strong entity tag, e.g. If-Match: "5". The purge is applied only if the configuration is still at that version, otherwise nothing is removed and the request fails with 412 Precondition Failed. A request without the header (or with *, which does not pin a version) fails with 428 Precondition Required.
The variant without branch/{branchId} in the URL behaves the same as the branch endpoint with branch/default.
Request
- Base URLhttps://connection.keboola.com
- Auth
- API key in header X-StorageApi-Token
- or API key in header X-KBC-ManageApiToken
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Id of the component.
Id of the configuration.
Headers
Required optimistic-concurrency precondition, RFC 9110 form. Send the version field of the configuration as a strong entity tag, e.g. "5"; the purge is applied only if the configuration is still at that version, otherwise it fails with 412. A request without the header (or with *, which does not pin a version) fails with 428.
Response
Configuration purged.
Changes
No recorded changes to this operation across all 1 revision of this API.