Run Retention Rule

Run an existing retention rule immediately (this will delete matching content). Before running it, preview the matches with a dry run in the web UI. The v1 API does not provide a dry-run endpoint.

Allowed Roles: Workspace Admin or System Admin • Authentication Required • Local repositories only Notes: If retention rules are disabled on the server, this endpoint returns 403.

POST https://api.repoflow.io/1/workspaces/<workspace-ref>/repositories/<repository-ref>/retention-rules/run/<retention-rule-id>

Path Parameters

workspace-refstringRequired

Workspace ID or name.

repository-refstringRequired

Repository ID or name.

retention-rule-idstringRequired

Retention rule ID (UUID).

Request

Command Line

curl -sS -X POST "https://api.repoflow.io/1/workspaces/<workspace-ref>/repositories/<repository-ref>/retention-rules/run/<retention-rule-id>" \
  -H "Authorization: Bearer <admin-token>" \
  -H "Accept: application/json"

Response

The response is an array of items (shape depends on the rule target type).

[
  {
      "id": "a8dd2b4c-0d73-4bcb-8cd3-8b5e1a5e7a9a",
      "version": "1.2.3",
      "packageName": "my-package",
      "creationDay": "2026-01-01",
      "sizeInByte": 123456,
      "packageId": "b4d9c9d1-3e0f-4e9a-bf15-4fe0c8d6d7d2",
      "downloads": 12
  }
]