Update Smart Archiving Policy

put

https://{jfrog_url}/artifactory/api/archive/v2/packages/policies/{policyKey}

Updates configuration settings for an existing smart archiving policy. A policy cannot be updated if it is currently running.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

policyKey

string

required

length ≥ 3

Body Params

key

string

required

An ID that is used to identify the archive policy. A minimum of three characters is required and can include letters, numbers, underscore and hyphen.

description

string

A description of the policy

cronExp

string

The cron expression determines when the policy is run. This parameter is not mandatory, however if left empty the policy will not run automatically and can only be triggered manually.

durationInMinutes

integer

This setting limits the maximum duration (in minutes) the policy can run when enabled. The maximum allowed duration is 300 minutes.

enabled

boolean

An archive policy must be created inactive. This parameter is optional, but if used it must be set to FALSE. If set to TRUE when calling this API, the API call will fail and an error message is received.

skipTrashcan

boolean

A true value means that when this policy is executed, packages will be permanently deleted without an option to restore them immediately, false means that when the policy is executed packages will be deleted to the Trash Can.

projectKey

string

This key is obtained from the Project Settings screen. This parameter is used only for project-level archive V2 policies, it is not used for global-level policies.

searchCriteria

object

required

Responses

400

Validation errors

401

Bad Credentials

403

Unauthorized

404

Not Found

500

Internal server error

200OK