Search for Archives

JFrog REST APIs
Content Type
REST API

Description: Search for archived artifacts based on AQL query.

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 /artifactory/api/retention/search

Produces: application/json

Consumes: text/plain

Query Parameters:

Parameters

Type

Description

Required/Optional

aqlQuery

string

Search for archived artifacts using Artifactory Query Language.

The AQL query can be based on these properties:

  • Artifact name

  • Artifact checksum

  • Artifact properties

  • Repository and path

  • Archiving period

Note

When searching for the repository, ensure that the AQL query is for the original repository name only. Do not include the namespace that was generated during the archive process.

Required

Sample Request:

POST https://[JFrogPlatformURL]/artifactory/api/retention/search
items.find({"repo": "myRepo"}).include("property")

Sample Response:

{
        "results" : [ {
                "repo" : "myRepo",
                "path" : ".",
                "name" : "artifactory.20210507233800.td",
                "type" : "file",
                "size" : 145149,
                "created" : "2021-06-30T10:27:01.866Z",
                "created_by" : "admin",
                "modified" : "2021-06-30T10:27:00.414Z",
                "modified_by" : "admin",
                "updated" : "2021-06-30T10:29:06.139Z",
                "properties" : [ {
                        "key" : "artifact.lifecycle.archive.time",
                        "value" : "1625048946037"
                } ]
        } ],
        "range" : {
        "start_pos" : 0,
        "end_pos" : 1,
        "total" : 1
        }
}

Status:

200: Success