Preview Retention Policy by Policy Key

JFrog REST APIs

ft:sourceType
Paligo

Description: Provides an estimated count and total size of archive candidates based on the provided retention policy key.

Note

This Cold Storage feature is available only for Artifactory Enterprise and Enterprise+ users.

Since: Artifactory 7.27.3

Security: Requires an admin user

Usage: POST /api/retention/archive/policies/{key}/preview

Produces: application/json

Consumes: text/plain

URL Parameters:

Parameters

Type

Description

Required/Optional

key

string

The policy key for which you want to get a preview.

Required

Sample Request:

POST /api/retention/archive/policies/example-policy-key/preview

Sample Response:

{  "count": 100000, //archive candidates count     "totalSize": 800000 //total size in bytes }

Status:

200: Success