Create Retention Rule

Create a new retention rule in a repository. If you provide cron, the rule will be enabled on creation.

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. The server can also enforce a maximum number of rules per repository.

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

Path Parameters

workspace-refstringRequired

Workspace ID or name.

repository-refstringRequired

Repository ID or name.

Body

namestringRequired

Retention rule name.

descriptionstringOptional

Retention rule description (defaults to empty string).

targetType"package" | "version" | "file"Required

What this rule targets. Note: file rules can be disabled by server configuration.

ruleJsonobjectRequired

Retention rule JSON (conditions + keepRules). The exact allowed fields depend on targetType.

cronstringOptional

Optional cron expression. When provided, the rule is enabled immediately (server enforces min/max schedule frequency).

Request

Command Line

curl -sS -X POST "https://api.repoflow.io/1/workspaces/<workspace-ref>/repositories/<repository-ref>/retention-rules" \
  -H "Authorization: Bearer <admin-token>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Keep last 5 versions per package",
    "description": "Delete versions older than 30 days, keep last 5 per package",
    "targetType": "version",
    "ruleJson": {
      "conditions": {
        "and": [
          {
            "field": "creationDay",
            "operator": "OLDER_THAN_DAYS",
            "value": 30
          }
        ]
      },
      "keepRules": {
        "groupBy": "packageName",
        "sortBy": "creationDay",
        "order": "desc",
        "keep": 5
      }
    },
    "cron": "0 3 * * *"
  }'

Response

{
  "retentionRuleId": "9b1d2f3a-8c4e-4f2a-9d10-4c1d6f2f3a8c"
}