Download a VCS Branch

JFrog REST APIs

Content Type
REST API

Description: Downloads a tarball (tar.gz/zip) of a complete branch.

Downloading can be executed conditionally according to properties by specifying the properties query param. In this case, only cached artifacts are searched.

Since: 3.6.0

Security: Requires a privileged user (can be anonymous)

Usage: GET /artifactory/api/vcs/downloadBranch/{repoKey}/{userOrg}/{repo}/{branch-name}?ext=tar.gz/zip[&properties=qa=approved]

This API can also be called using the userOrg as the repository, like this:

GET /artifactory/api/vcs/downloadBranch/{repoKey}/{userOrg}/{branch-name}?ext=tar.gz/zip[&properties=qa=approved]

Produces: application/octet-stream

Sample Output:

GET /artifactory/api/vcs/downloadBranch/github/jquery/jquery/master
<Branch binary content>

Sample Output when using userOrg as the repository:

GET /artifactory/api/vcs/downloadBranch/gs-repo/crossbench/main
<Branch binary content>

In the example above, userOrg = crossbench and the branch name is main.