Folder Imports

Revert a folder import

POST/folder-imports/{id}/actions/revert
documents:writerevert_folder_import

Starts a folder-import-revert job that deletes the empty folders the import created, deepest first, and returns 202 with it. 409 invalid_state when the import has not completed, created no folders, is being reverted or was already reverted; it can run again after a failed revert or one that left failed folders. Needs view-all-documents or super admin on the token's user; service tokens get 403. dry_run checks the same and queues nothing. No webhook or email. POST /folders/{id}/actions/restore undoes it.

Path parameters

  • idstring (uuid)Required#

    The record's id.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

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

202

The revert job was started. Its result holds import_id, deleted, kept, missing and failed.

Job
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "type": "string",
    "status": "queued",
    "progress": {
      "done": 1,
      "total": 1
    },
    "result": {},
    "error": {},
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00",
    "completed_at": "2026-06-12T10:00:00+00:00"
  }
}
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 POST https://your-org-domain/kong/core/api/v2/folder-imports/{id}/actions/revert\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"