CLcloudsmith
repos

Retrieve the retention rules for the repository.

Retrieve the retention rules for the repository.

get/repos/{owner}/{repo}/retention/

Request

  • Base URL
    https://api.cloudsmith.io
  • Auth
    • API key in header X-Api-Key
    • or HTTP basic

Response

Retrieved the retention rules for the repository.

retention_count_limitinteger

The maximum X number of packages to retain.

retention_days_limitinteger

The X number of days of packages to retain.

retention_enabledboolean

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_formatboolean

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_nameboolean

If checked, retention will apply to groups of packages by name rather than all packages.<br>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_typeboolean

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. <br>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_stringstring nullable

A package search expression which, if provided, filters the packages to be deleted.<br>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.<br>Refer to the Cloudsmith documentation for package query syntax.

retention_size_limitinteger

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

Changes

No recorded changes to this operation across all 6 revisions of this API.