Onboarding Flows

Remove a form from an onboarding flow

DELETE/onboarding-flows/{onboarding_flow_id}/forms/{id}
onboarding:writedelete_onboarding_flow_formDestructiveIdempotent

Removes a form from the flow and returns 204. The start form cannot go while the flow has other forms. A form that a route or a condition uses, or any form of a published flow, returns 409 conflict, with the routes that use it in details. The hidden form itself is kept. It has no dry run and can't be undone through the API. A repeat returns 404. Sends no email and emits no webhook.

Path parameters

  • onboarding_flow_idstring (uuid)Required#

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

  • idstring (uuid)Required#

    The form's id, a uuid, as the flow's form list shows it. A form of another flow returns 404.

Responses

204

The form was removed from the flow.

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/{onboarding_flow_id}/forms/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"