Onboarding

Reset all implementations of an onboarding flow

POST/onboarding/flows/{complianceId}/implementations/reset
onboarding:adminreset_compliance_implementationsDestructiveDeprecatedSunset 2027-06-30

Sensitive. Resets every implementation of the onboarding flow and answers 204, with one untracked queue job per matched implementation. type selects ALL implementations or only IN_PROGRESS ones. Deprecated: withdrawn on 2027-06-30. POST /onboarding-sessions/actions/reset replaces it; the Link header names it.

Path parameters

  • complianceIdstring (uuid)Required#

    The compliance flow's public uuid.

Request body

application/json, required

  • typestringRequired#

    Which respondents to reset. ALL = reset every respondent's implementation; IN_PROGRESS = reset only respondents who have not yet completed (leaves completed responses untouched).

    One of: ALL, IN_PROGRESS
{
  "type": "IN_PROGRESS"
}

Responses

204

Reset queued (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
422

Request validation failed (HTTP 422). The body is either the Laravel validation envelope (message + field-keyed errors) or the API error envelope for domain rejections (e.g. form_type_not_supported, folder_locked, parent_not_found, folder_not_empty).

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/onboarding/flows/{complianceId}/implementations/reset\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "type": "IN_PROGRESS"
}'