Skip to content

Artifactory - Process steps

Download Latest Build for SNAPSHOT

Retrieve the latest build artifact within a SNAPSHOT.

NameTypeDescriptionRequiredProperty Name
Api KeyPasswordThe api key to authenticate with the Artifactory server. If using api key, username and password will be ignored.NoapiKey
Identity tokenPasswordThe Identity token to authenticate with the Artifactory server. If using Identity token, api key, username and password will be ignored.NoidentityKey
Artifactory Base URLStringThe base URL of the Artifactory server. For example: http://server.example.com:8081/artifactoryYesurl
Artifactory RepositoryStringThe repository in Artifactory where the build artifact resides. For example: libs-snapshot-localYesrepo
ClassifierStringThe classifier of the version snapshot, if any.Noclassifier
File ExtensionStringThe file extension of the build artifact. For example: jarYesextension
PasswordPasswordThe password to authenticate with the Artifactory server.Nopassword
Repo PathStringThe path (group ID and artifact ID) of the build artifact. For example: org.jfrog.test/multi2YesrepoPath
User NameStringThe user name to authenticate with the Artifactory server.Nousername
VersionStringThe version of the build artifact. For example: 3.8-SNAPSHOTYesversion

Download NuGet Package

Download a NuGet package from a NuGet repository.

NameTypeDescriptionRequiredProperty Name
Api KeyPasswordThe api key to authenticate with the Artifactory server. If using api key, username and password will be ignored.NoapiKey
Identity tokenPasswordThe Identity token to authenticate with the Artifactory server. If using Identity token, api key, username and password will be ignored.NoidentityKey
Artifactory Base URLStringThe base URL of the Artifactory server. For example: http://server.example.com:8081/artifactoryYesartifactoryUrl
PackagesStringA list of packages to download, separated by newline characters. Use the following format: repoPath/versionYesartifacts
Repository PasswordPasswordThe password to authenticate with Artifactory.Nopassword
Repository User nameStringThe user name to authenticate with Artifactory.Nousername
Verify HashBooleanSelect to verify hash values after the files are downloaded.NocheckHash

Download version (Maven build)

Download all files under a specified version of a repository that was built with Maven.

NameTypeDescriptionRequiredProperty Name
Api KeyPasswordThe api key to authenticate with the Artifactory server. If using api key, username and password will be ignored.NoapiKey
Identity tokenPasswordThe Identity token to authenticate with the Artifactory server. If using Identity token, api key, username and password will be ignored.NoidentityKey
Artifactory Base URLStringThe base URL of the Artifactory server. For example: http://server.example.com:8081/artifactoryYesartifactoryUrl
ExcludesStringThe patterns to use for excluding files to download.Noexcludes
IncludesStringThe patterns to use for including files to download. The wildcard ** indicates every directory and the wildcard * indicates every file. So the pattern dist/**/* would retrieve the entire file tree underneath the dist directory.Yesincludes
Repository PasswordPasswordThe password to authenticate with Artifactory.Nopassword
Repository User nameStringThe user name to authenticate with Artifactory.Nousername
Repository nameStringThe name of the repository.NorepositoryName
Verify HashBooleanSelect to verify hash values after the files are downloaded.NocheckHash
VersionsStringA list of versions to download, separated by newline characters. Use the following format: groupId/artifactId/versionYesartifacts

Download version (non-Maven build)

Download all files under specified version of a repository (non-Maven).

NameTypeDescriptionRequiredProperty Name
Api KeyPasswordThe api key to authenticate with the Artifactory server. If using api key, username and password will be ignored.NoapiKey
Identity tokenPasswordThe Identity token to authenticate with the Artifactory server. If using Identity token, api key, username and password will be ignored.NoidentityKey
Artifactory Base URLStringThe base URL of the Artifactory server. For example: http://server.example.com:8081/artifactoryYesartifactoryUrl
Download RecursivelyBooleanSelect this box to download files and folders in subfolders of versions. Requires Artifactory Pro edition or higher.Norecursive
ExcludesStringThe patterns to use for excluding files to download.Noexcludes
IncludesStringThe patterns to use for including files to download. The wildcard ** indicates every directory and the wildcard * indicates every file. So the pattern dist/**/* would retrieve the entire file tree underneath the dist directory.Yesincludes
Repository PasswordPasswordThe password to authenticate with Artifactory.Nopassword
Repository User nameStringThe user name to authenticate with Artifactory.Nousername
Repository nameStringThe name of the repository.YesrepositoryName
Verify HashBooleanSelect to verify hash values after the files are downloaded.NocheckHash
VersionsStringA list of folders and subfolders to download, separated by newline characters. Use the following format: path/to/artifact/versionYesartifacts

Promote Build

Change the status of a build, optionally moving or copying the build to a target repository.

NameTypeDescriptionRequiredProperty Name
Api KeyPasswordThe api key to authenticate with the Artifactory server. If using api key, no username and password can be specified.NoapiKey
Identity tokenPasswordThe Identity token to authenticate with the Artifactory server. If using Identity token, api key, username and password will be ignored.NoidentityKey
Artifactory Base URLStringThe base URL of the Artifactory server. For example: http://server.example.com:8081/artifactoryYesurl
Build NameStringThe name of the build to promote.YesbuildName
Build NumberStringThe number of the build to promote.YesbuildNumber
CI UserStringUser that invoked promotion from the CI server.NobuildUser
CommentStringComment to describe the reason for promotion.NobuildComment
CopyBooleanSelect to copy instead of move when a target repository is specified.NobuildCopy
Include ArtifactsBooleanSelect to move or copy the build artifacts.NobuildArtifact
Include DependenciesBooleanSelect to move or copy the build dependencies.NobuildDepend
PasswordPasswordThe password to authenticate with the Artifactory server.Nopassword
PropertiesStringA newline separated list of name=value properties to set on the promotion. For example: tester=Adam Boe. Specify multiple values per name with commas (escape commas with backslash \ to avoid this). For example: osVersions=Windows,LinuxNobuildProps
Source RepositoryStringThe source repository that contains the build artifacts to copy or move.YesbuildSource
StatusStringNew build status.YesbuildStatus
Target RepositoryStringThe target repository for the build artifacts and dependencies.YesbuildTarget
User NameStringThe user name to authenticate with the Artifactory server.Nousername

Retrieve Build Artifacts Archive

Retrieve an archive file that contains all the artifacts for a specific build.

NameTypeDescriptionRequiredProperty Name
Api KeyPasswordThe API key to authenticate with the Artifactory server. If you enter an API key, you cannot specify a user name and password.NoapiKey
Identity tokenPasswordThe Identity token to authenticate with the Artifactory server. If using Identity token, api key, username and password will be ignored.NoidentityKey
Archive TypeEnumeration:
  • zip
  • tar
  • tar.gz
  • tgz | Select the merge type of the archive file to return. | No | buildType | | Artifactory Base URL | String | The base URL of the Artifactory server. For example: http://server.example.com:8081/artifactory | Yes | url | | Build Name | String | The name of the build to download. | Yes | buildName | | Build Number | String | Specify the build to download by number. Cannot be used with Build Status. | No | buildNumber | | Password | Password | The password to authenticate with the Artifactory server. | No | password | | Repositories | String | Specify the repository to search for the build in. Separate multiple repositories with commas. | No | buildRepos | | Status | String | Specify the build to download by status. Cannot be used with Build Number. | No | buildStatus | | User Name | String | The user name to authenticate with the Artifactory server. | No | username |

Set Item Properties

Attach properties to a file or folder.

NameTypeDescriptionRequiredProperty Name
Api KeyPasswordThe api key to authenticate with the Artifactory server. If using api key, username and password will be ignored.NoapiKey
Identity tokenPasswordThe Identity token to authenticate with the Artifactory server. If using Identity token, api key, username and password will be ignored.NoidentityKey
Artifact PathStringThe path to the artifact to set properties on. For example: libs-release-local/org/jfrog/multi1/2.7-SNAPSHOTYespath
Artifactory Base URLStringThe base URL of the Artifactory server. For example: http://server.example.com:8081/artifactoryYesurl
PasswordPasswordThe password to authenticate with the Artifactory server.Nopassword
PropertiesStringSpecify a list of properties to set. Place each entry on a separate line. Use the following format: key=value. Separate multiple values for a key with commas, and add a backslash () before the following special characters: comma (,), backslash(), vertical bar (), and equal sign (=). Do not use a backslash before the equal sign between the key and the value or before commas used to separate multiple values. For example: osVersions=Windows=7,10,Linux=16.04 LTS\Yes
RecursiveBooleanSelect to attach properties recursively if the Artifact Path is a directory.Norecursive
User NameStringThe user name to authenticate with the Artifactory server.Nousername