Adding an Image Retention Policy

Function

Add an image retention policy.

URI

POST /v2/manage/namespaces/{namespace}/repos/{repository}/retentions

Table 1 describes the parameters.

Request

• Request parameters

  Table 2 Request body parameter description

  Parameter	Mandatory	Type	Description
  algorithm	Yes	String	Retention policy matching rule. The value is or.
  rules	Yes	Array of objects	Image retention policy.

  Table 3 rules parameter description

  Parameter	Mandatory	Type	Description
  template	Yes	String	Retention policy type. The value can be date_rule (number of days) or tag_rule (number of tags).
  params	Yes	Object	If template is set to date_rule, set params to {"days": "xxx"}. If template is set to tag_rule, set params to {"num": "xxx"}.
  tag_selectors	Yes	Array of objects	Image tags that are not counted in the retention policy.

  Table 4 tag_selectors parameter description

  Parameter	Mandatory	Type	Description
  kind	Yes	String	Matching rule. The value can be label or regexp.
  pattern	Yes	String	If kind is set to label, set this parameter to specific image tags. If kind is set to regexp, set this parameter to a regular expression.

• Example request

  POST https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/retentions

  Body:

  {
      "algorithm": "or",
      "rules": [
          {
              "template": "date_rule",
              "params": {
                  "days": "30"
              },
              "tag_selectors": [
                  {
                      "kind": "label",
                      "pattern": "v5"
                  },
                  {
                      "kind": "label",
                      "pattern": "1.0.1"
                  },
                  {
                      "kind": "regexp",
                      "pattern": "^123$"
                  }
              ]
          }
      ]
  }

Response

• Response parameters

  Table 5 Response body parameter description

  Parameter	Type	Description
  id	Integer	Rule ID.

• Example response

  {"id": 34}

Status Code