Get Release Bundle Version Promotion Specification

JFrog REST APIs

ft:sourceType
Paligo

Description: Returns the specification of the specified Release Bundle version promotion. The specification file contains a snapshot of the items in the promotion.

Since: 7.63.2

Security: Requires Read permissions to the target Release Bundle path.

Usage: GET  /lifecycle/api/v2/promotion/records/{name}/{version}/{created}

Query Parameters (optional): repository_key, project. See Common Optional Query Parameters.

Sample Response:

{
    "schema_version": "1.0.0",
    "service_id": "jfrt@01h0nvs1pwjtzs15x7kbtv1sve",
    "environment": "QA",
    "created_by": "admin",
    "created": "2023-05-19T06:22:09.586Z",
    "created_millis": 1684477329586,
    "artifacts": [
        {
            "path": "catalina-qa-maven-local/org/apache/tomcat/catalina/1.0.0/catalina-1.0.0.pom",
            "checksum": "c05ce06781aaa8c3318dd7d96972c964507d6771e4bf9ae45d63c740c142b84e",
            "package_type": "maven"
        },
        {
            "path": "catalina-qa-maven-local/org/apache/tomcat/catalina/1.0.0/catalina-1.0.0.jar",
            "checksum": "36b3df648df4d82632b165166b2631d91c5860d6202125389dbbb44ee70c0012",
            "package_type": "maven"
        },
        {
            "path": "catalina-qa-generic-local/catalina/release-notes-1.0.0.txt",
            "checksum": "e06f59f5a976c7f4a5406907790bb8cad6148406282f07cd143fd1de64ca169d",
            "package_type": "generic"
        }
    ],
    "checked_webhooks": [],
    "included_repository_keys": [
        "catalina-qa-maven-local",
        "catalina-qa-docker-local",
        "catalina-qa-generic-local"
    ],
    "excluded_repository_keys": [],
    "overwrite_existing_artifacts": true
}

The response includes the following information:

Property

Description

schema_version

The schema version number, which is used to track specification versions.

service_id

The unique identifier of the Artifactory instance where the Release Bundle was created.

environment

Name of the target environment for the promotion.

created_by

The user who created the Release Bundle.

created

The timestamp when the Release Bundle was created (ISO 8601 standard).

created_millis

The timestamp when the Release Bundle was created (in milliseconds).

path

The path of a Release Bundle item relative to its contents directory.

checksum

The SHA-256 checksum of the source artifact.

package_type

The package type of the source repository associated with the artifact.

included_repository_keys

Defines specific repositories to include in the promotion.

If this property is left undefined, all repositories (except those specifically excluded) are included in the promotion.

Important: If one or more specific repositories are specifically included, all other repositories are excluded (regardless of what is defined in excluded_repository_keys).

excluded_repository_keys

Defines specific repositories to exclude from the promotion.

overwrite_existing_artifacts

Whether artifacts that already existed on the targets were overwritten during the promotion.

Status Codes:

Code

Description

200

Fetched

401

Bad Credentials

403

Permission Denied

404

Not Found (Release Bundle version/promotion)