Manage Cleanup - Policies

JFrog Platform Administration Documentation

Content Type
Administration / Platform
ft:sourceType
Paligo

This section outlines the actions you can perform on the Cleanup Policies in Artifactory. It includes enable/disable, search, manual run, dry run, edit, stop, delete, view and delete policies.

The following table lists all the possible actions on the policies and their equivalent links to REST API.

Task

Description

For UI, see...

For API, see...

View All Policies

This section outlines how to view all cleanup policies. It guides you in reviewing key details such as the policy status, associated projects with the policy, timestamps for the last and next scheduled runs, last run status, actions performed on each policy, and options for customizing table columns.

View All Cleanup Policies

Perform a Dry Run

This section outlines how to perform a dry run for a cleanup policy. A dry run lets you preview which items will be deleted based on your defined policy criteria, without performing the actual deleting. This helps you understand the potential outcome before executing the policy. After the dry run, a CSV report is generated, listing all items that would be deleted along with relevant details. Review this list to decide whether to proceed with the policy or adjust the settings.

Perform Dry Run Cleanup Policy

Download the Last Run Report

This section outlines how to download the last run report. The report is in CSV format and lists all deleted items with relevant information. You can review the list to learn about the deleted items.

Download Last Run Report Cleanup Policy

Enable/Disable Policy

This topic outlines how to enable/disable a cleanup policy. By default, newly created cleanup policies are disabled. You must activate a policy before it can execute automatically according to the schedule or be triggered manually.

Enable/Disable Cleanup Policy

Run Now

This topic outlines how to run a cleanup policy manually. In addition to the periodic automated execution of the cleanup policy that occurs if you enable the policy and set its Cron Expression, you can also manually run the cleanup policy at any time.

Run Cleanup Policy Manually

Search Policies

This topic outlines how to search for cleanup policies to locate the desired policy easily.

Search Cleanup Policy

Disable All Policies

This topic outlines how to disable all cleanup policies. As a Platform Admin, you can disable all policies globally, making them inactive. Once this is done, you can activate policies individually as needed.

Disable All Cleanup Policies

Disable All Cleanup Policies APIDisable All Cleanup Policies API

Edit Policy

This topic outlines how to edit a Cleanup policy. After the cleanup policy has been created, you can change the settings or cleanup criteria.

Edit Cleanup Policy

Stop Policy

This topic outlines how to stop a running cleanup policy. For some reason, you may want to stop a running cleanup policy that is currently running before it finishes completion.

Stop a Running Cleanup Policy

Stop a Running Cleanup Policy APIStop a Running Cleanup Policy API

Delete Policy

This topic outlines how to delete a Cleanup policy. If you decide that a cleanup policy is no longer needed, you can delete it.

Delete Cleanup Policy

Stop All Runs

This topic outlines how to stop all cleanup policy runs. You can perform this action from the policies tab and runs tab. As a Platform Admin, you can stop all currently running policies. Once a policy run is stopped, it cannot resume from its last point. You must restart the policy from the beginning to rerun it.

Stop All Cleanup Policy Runs

Stop All Running Cleanup Policies APIStop All Running Cleanup Policies API

Authorization

Activity

Platform Admin

Project Admin

Note: Applicable within the scope of your project context

Non-admin User

Edit Cleanup Policy 

Enable/Disable Cleanup Policy 

Perform Dry Run Cleanup Policy 

Run Cleanup Policy Manually 

Edit Cleanup Policy 

 

Stop a Running Cleanup Policy 

Delete Cleanup Policy 

Download Last Run Report Cleanup Policy 

Disable All Cleanup Policies 

Note: This option is shown from the Global Context only.

Search Cleanup Policy 

Stop All Cleanup Policy Runs 

Note: This option is shown from the Global Context only.