Approval Workflows

Reset an approval workflow with the old path

POST/approval-workflows/{type}/reset
approval-workflows:writereset_approval_workflow_deprecatedDestructiveDeprecatedSunset 2027-06-30

Does what POST /approval-workflows/{id}/actions/reset does and answers 204 with no body, as it always did. Deprecated: it will be withdrawn on 2027-06-30. Use the actions/reset path, which the Deprecation and Sunset headers point towards. It refuses dry_run. Emits approval_workflow.reset only when steps were removed; no email. Undo it with PUT /approval-workflows/{id}.

Path parameters

  • typestringRequired#

    The workflow type, such as internal_publish.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Responses

204

The workflow was reset, or had no steps of its own to remove.

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

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 POST https://your-org-domain/kong/core/api/v2/approval-workflows/{type}/reset\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"