Creating an Image Retention Policy

Description

Create an image retention policy.

Constraints

None

API Calling

For details, see Calling APIs.

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.

URI

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

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
namespace	Yes	String	Organization name. Enter 1 to 64 characters, starting with a lowercase letter and ending with a lowercase letter or digit. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. Periods, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed.
repository	Yes	String	Image repository name. Enter 1 to 128 characters. It must start and end with a lowercase letter or digit. Only lowercase letters, digits, periods (.), slashes (/), underscores (_), and hyphens (-) are allowed. Periods, slashes, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed. Replace a slash (/) with a dollar sign ($) before you send the request.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format). The value can be application/json or charset=utf-8 application/json. Default value: application/json
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
algorithm	Yes	String	Retention policy matching rule. The value is or.
rules	Yes	Array of Rule objects	Image retention policy.

**Table 4** Rule
Parameter	Mandatory	Type	Description
template	Yes	String	Retention policy type. The value can be date_rule and tag_rule.
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 TagSelector objects	Exception images.

**Table 5** TagSelector
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 the image tag. If kind is set to regexp, set this parameter to a regular expression.

Response Parameters

Status code: 201

**Table 6** Response body parameter
Parameter	Type	Description
id	Integer	Image retention policy ID.

Example Request

POST https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/retentions

{
  "algorithm" : "string",
  "rules" : [ {
    "params" : { },
    "tag_selectors" : [ {
      "kind" : "string",
      "pattern" : "string"
    } ],
    "template" : "string"
  } ]
}