Build Promotion

post

https://{jfrog_url}/artifactory/api/build/promote/{buildName}/{buildNumber}

Change the status of a build, optionally moving or copying the build's artifacts and its dependencies to a target repository and setting properties on promoted artifacts. All artifacts from all scopes are included by default while dependencies are not. Scopes are additive (or). From version 5.7, the target repository can be a virtual repository.

Security: Requires Deploy permission for the build.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

buildName

string

required

length ≥ 1

Build name

buildNumber

string

required

length ≥ 1

Build number

Query Params

project

string

The name of the project that contains the build to be promoted. If not defined, Artifactory uses the default build-info repo.

Body Params

Build promotion request

status

string

The new status of the build. This is especially important when performing a promotion that only changes the status of the build without copying or moving artifacts and dependencies.

comment

string

An optional comment describing the reason for the promotion.

ciUser

string

required

The user that invoked promotion from the CI server.

timestamp

date-time

required

The time when the promotion command was received by Artifactory (ISO8601 format). The format is yyyy-MM-dd'T'HH:mm:ss.SSSZ.

dryRun

boolean

Defaults to false

When set to true, performs a dry run of the promotion without executing any operation in Artifactory.

sourceRepo

string

The repository from which the build contents will be copied or moved. If this property is not defined, the source repository is resolved automatically.

targetRepo

string

The target repository to which the build contents will be copied or moved. This property does not need to defined if the promotion involves a change of status only.

copy

boolean

required

Defaults to false

Determines how to perform the build promotion. true Copies the artifacts (and optionally, the dependencies) to the targetRepo. false

artifacts

boolean

required

Defaults to true

Determines whether to move/copy the build's artifacts.

dependencies

boolean

required

Defaults to false

Determines whether to move/copy the build's dependencies.

scopes

array of strings

An array of dependency scopes that indicate the circumstances under which a dependency is available. Relevant when dependencies is set to true. Common examples include compile and runtime.

scopes

properties

object

A list of properties to attach to the build's artifacts (regardless of whether a targetRepo is defined).

failFast

boolean

required

Defaults to true

When set to true, fails and aborts the promotion operation upon receiving an error.

Responses

401

Bad Credentials - Authentication failed. A valid token is required.

403

Permission Denied - The user does not have Deploy permission for the build.

404

Not Found - The specified build does not exist.

200Success