Onboarding

Remove a section/form from an onboarding flow

DELETE/onboarding/flows/{complianceId}/forms/{formId}
onboarding:writedetach_compliance_formDestructiveIdempotentDeprecatedSunset 2027-06-30

Removes a section/form from the onboarding flow. The {formId} path parameter is the underlying form's UUID — i.e. the form_id field returned by GET /onboarding/flows/{complianceId}/forms, NOT the compliance-form link id. A form attached to another flow, or an unknown/malformed id, is a leak-safe 404. Deprecated: withdrawn on 2027-06-30. DELETE /onboarding-flows/{onboarding_flow_id}/forms/{id} replaces it; the Link header names it.

Path parameters

  • complianceIdstring (uuid)Required#

    The compliance flow's public uuid.

  • formIdstring (uuid)Required#

    The underlying form's public uuid.

Responses

204

Removed (no content).

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
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

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