Onboarding Flows

Delete an onboarding flow

DELETE/onboarding-flows/{id}
onboarding:writedelete_onboarding_flowDestructiveIdempotent

Deletes a draft flow and returns 204. Its forms, routes and classifications stay in the database but can no longer be reached, and sessions already started keep their record. A published flow returns 409 invalid_state: unpublish it first. It has no dry run and can't be undone through the API. A repeat returns 404. Emits onboarding_flow.deleted and sends no email.

Path parameters

  • idstring (uuid)Required#

    The onboarding flow's id, a uuid. An unknown or deleted id returns 404.

Responses

204

The onboarding flow was deleted.

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X DELETE https://your-org-domain/kong/core/api/v2/onboarding-flows/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"