Update registry retention

Change the organisation’s project-wide retention policy (null resets it to the platform default), its repository rules (the list replaces the stored one; an empty list removes them all), or both, and apply the result to the registry at once. The newest image of every repository is always kept. harbor_applied false means the change is saved and applies on the next provisioning pass, within about five minutes. Send the version you read as expected_version: if someone changed the retention since, the save answers 409 and writes nothing. A change that needs more retention rules than the registry runs for one project (rule_slots in the read) answers 422 saying how many it needs, and writes nothing. A browser session twin is mounted at the same path without the /api/v1 prefix (cookie authentication).

PUT /api/v1/org/registry-storage/retention

Update registry retention

Python

import requests

url = "https://platform.ankra.app/api/v1/org/registry-storage/retention"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

200

{
  "retention": {
    "organisation_id": "<string>",
    "default": {
      "keep_days": 1825,
      "keep_latest": 500
    },
    "platform_default": {
      "keep_days": 1825,
      "keep_latest": 500
    },
    "source": "default",
    "updated_by": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "rules": [
      {
        "id": "<string>",
        "repository_pattern": "<string>",
        "application_id": "<string>",
        "keep_days": 123,
        "keep_latest": 123,
        "updated_by": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "recently_pulled_days": 123,
    "runs_daily_at": "<string>",
    "space_freed_at": "<string>",
    "version": "<string>",
    "rule_slots": {
      "used": 1,
      "limit": 2
    }
  },
  "harbor_applied": true,
  "harbor_apply_error": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization · string | null

x-ankra-organisation-id · string | null

Body

application/json

default · RegistryRetentionPolicy · object | null

The project-wide policy; null resets it to the platform default; omit to leave it.

Show child attributes

rules · RegistryRetentionRuleInput · object[]

Replaces every repository rule; an empty list removes them all; omit to leave them.

Show child attributes

expected_version · string | null

The version read with the retention. When sent, the save is refused with 409 if the stored retention has changed since; omit it (or send null) to save without the check. A blank string is refused with 422; surrounding whitespace is ignored.

Response

200

application/json

Successful Response

retention · RegistryRetention · object · required

Show child attributes

harbor_applied · boolean · required

harbor_apply_error · string | null · required