Delete Configuration
Deletes a configuration in specified branch. When a configuration is deleted, it is only marked as deleted and remains still available in the system. You can list deleted configurations. Other operations with deleted configurations are restricted.
Calling this API call on a deleted configuration in a development branch will result in an error. Development branch configuration cannot be permanently removed. Calling this API call on a deleted configuration in a default branch will purge the configuration. Prefer the explicit purge endpoint for that — it states the destructive intent unambiguously and never falls back to a soft delete.
The optional If-Match header carries the same optimistic-concurrency precondition as configuration update: the delete is applied only if the configuration is still at the given version, otherwise nothing is written and the request fails with 412 Precondition Failed. This closes the double-delete race — a delete sent from a stale view (which still saw the live configuration) cannot purge a configuration that moved to the trash in the meantime. Send the version field of a configuration detail response as a strong entity tag, e.g. If-Match: "5". If-Match: * only requires that the configuration still exists; weak validators and tag lists are rejected with 400.
The variant without branch/{branchId} in the URL is deprecated, use the branch endpoint and set 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
Optimistic concurrency precondition, RFC 9110 form. Send the version field of the configuration detail response as a strong entity tag, e.g. "5"; the delete is applied only if the configuration is still at that version, otherwise it fails with 412.
Response
Configuration moved to trash, or purged when it already was in the trash.
Changes
No recorded changes to this operation across all 1 revision of this API.