Update the retention rules for the repository.

patch

https://api.cloudsmith.io/repos/{owner}/{repo}/retention/

Path Params

owner

string

required

repo

string

required

Body Params

retention_count_limit

integer

0 to 10000

The maximum X number of packages to retain.

retention_days_limit

integer

0 to 180

The X number of days of packages to retain.

retention_enabled

boolean

If checked, the retention lifecycle rules will be activated for the repository. Any packages that don't match will be deleted automatically, and the rest are retained.

retention_group_by_format

boolean

If checked, retention will apply to packages by package formats rather than across all package formats.For example, when retaining by a limit of 1 and you upload PythonPkg 1.0 and RubyPkg 1.0, no packages are deleted because they are different formats.

retention_group_by_name

boolean

If checked, retention will apply to groups of packages by name rather than all packages.
For example, when retaining by a limit of 1 and you upload PkgA 1.0, PkgB 1.0 and PkgB 1.1; only PkgB 1.0 is deleted because there are two (2) PkgBs and one (1) PkgA.

retention_group_by_package_type

boolean

If checked, retention will apply to packages by package type (e.g. by binary, by source, etc.), rather than across all package types for one or more formats.
For example, when retaining by a limit of 1 and you upload DebPackage 1.0 and DebSourcePackage 1.0, no packages are deleted because they are different package types, binary and source respectively.

retention_package_query_string

string | null

A package search expression which, if provided, filters the packages to be deleted.
For example, a search expression of name:foo will result in only packages called 'foo' being deleted, or a search expression of tag:~latest will prevent any packages tagged 'latest' from being deleted.
Refer to the Cloudsmith documentation for package query syntax.

retention_size_limit

integer

0 to 21474836480

The maximum X total size (in bytes) of packages to retain.

Responses

200Updated the retention rules for the repository.

400Request could not be processed (see detail).

404Owner namespace or repository not found

422Missing or invalid parameters (see detail).

Cloudsmith is the new standard in Package / Artifact Management and Software Distribution