Promote Application Version

post

https://{jfrog_url}/apptrust/api/v1/applications/{application_key}/versions/{version}/promote

Promotes the specified application version to the desired stage. It includes options for including/excluding repositories, specifying running conditions, and providing comments.

Note: To move an application version to the official release stage, use the Release Application Version API.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

application_key

string

required

The unique identifier for the application.

version

string

required

The application version.

Query Params

async

boolean

Determines whether the operation should be asynchronous (true) or synchronous (false).
The default value is true, which means that Artifactory does not wait for application version promotion to complete before allowing you to move on to the next task.

Body Params

Promote Application Version Request

artifact_additional_properties

array of objects

Key-value pairs that define properties to add to each promoted artifact on top of any existing properties.
Note: If a property with the same key already exists on the artifact, the value defined in artifact_additional_properties will override the previous value.

artifact_additional_properties

excluded_repository_keys

array of strings

Defines specific repositories to exclude from the promotion.

excluded_repository_keys

included_repository_keys

array of strings

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 repositories are specifically included, all other repositories are excluded (regardless of what is defined in excluded_repository_keys).

included_repository_keys

overwrite_strategy

string

enum

Defines the overwrite policy for handling write-protected artifacts that already exist in the target repository during promotion. This is primarily relevant for Docker image promotions where mutable tags (such as :latest) may already point to a protected artifact in the target stage.
- latest (default): Overwrite is permitted only if the conflicting artifact's tag is exactly latest.
- all: Overwrite is permitted for any conflicting artifact in the target, regardless of the tag name.
- disabled: No overwrite is permitted. The promotion fails with a 409 Conflict if a write-protected artifact exists at the target path.

Allowed:

promotion_authorization_type

string

The authorization type for the promotion.

promotion_type

object

The type of promotion to perform:
- copy: Copies the application version to the target stage, preserving the source artifacts. This is the default. Note: No physical copy occurs if the source and target repositories are identical.
- move: Moves the application version to the target stage, transferring the source.
- keep: Promotes the application version to the target stage while keeping the artifacts in their current location (no copy or move is performed).
- dry_run: Simulates the promotion without actually performing it.

target_stage

string

The target stage to which the application version should be promoted.

Responses

200Promotion completed synchronously

202Promotion started asynchronously

400Bad Request

401Bad Credentials

403Permission Denied

404Not Found

409Conflict