Source Type - AQL

JFrog REST APIs

Content Type
REST API
ft:sourceType
Paligo

Use this source type to create a Release Bundle v2 version by collecting source artifacts from an AQL query result.

Security: Requires Read permissions to source artifact repository paths; requires Read and Create permissions to the Release Bundles.

Note

A complex AQL query may result in a time-consuming operation. Consider using asynchronous mode in such cases.

Usage restrictions: See here for details.

Sample Usage: POST /lifecycle/api/v2/release_bundle?project=default&async=false --header 'X-JFrog-Signing-Key-Name: my-signing-key' -H 'Content-Type: application/json' --upload-file aql.json

Consumes: application/json

Sample Request:

{
    "release_bundle_name": "Commons-Bundle",
    "release_bundle_version": "1.0.0",
    "skip_docker_manifest_resolution": false,
    "source_type": "aql",
    "source": {
        "aql": "items.find({\"$and\" : [{\"repo\": {\"$match\": \"repository-prefix-*\"}}, {\"name\": {\"$match\": \"artifact-prefix-*\"}}]})"
    }
}

The request includes the following information:

Property

Description

source_type

Should be set to aql.

source.aql

The contents of the AQL query.

skip_docker_manifest_resolution

Determines whether to skip the resolution of the Docker manifest, which adds the image layers to the Release Bundle.

The default value is false (the manifest is resolved and image layers are included).

Sample Response: See here for an example.