view release on metacpan or  search on metacpan

README.md  view on Meta::CPAN

Calculates an artifact's SHA256 checksum and attaches it as a property (with key "sha256"). If the artifact is a folder,
then recursively calculates the SHA256 of each item in the folder and attaches the property to each item.

## retrieve\_artifact( $path, $filename )

Takes path and retrieves artifact on the path.  If $filename is given, artifact content goes into the $filename rather
than the HTTP::Response object.

## retrieve\_latest\_artifact( path => $path, version => $version, release => $release, integration => $integration,
 flag => 'snapshot', 'release', 'integration' )

Takes path, version, flag of 'snapshot', 'release' or 'integration' and retrieves artifact

## retrieve\_build\_artifacts\_archive( $payload )

Takes payload (hashref) then retrieve build artifacts archive.

## retrieve\_folder\_or\_repository\_archive( path => '/foobar', archiveType => 'zip' )

Retrieves an archive file (supports zip/tar/tar.gz/tgz) containing all the artifacts that reside under the specified
path (folder or repository root). Requires Enable Folder Download to be set.

## trace\_artifact\_retrieval( $path )

Takes path and traces artifact retrieval

## archive\_entry\_download( $path, $archive\_path )

Takes path and archive\_path, retrieves an archived resource from the specified archive destination.

## create\_directory( path => $path, properties => { key => \[ values \] } )

Takes path, properties then create a directory.  Directory needs to end with a /, such as "/some\_dir/".

## deploy\_artifact( path => $path, properties => { key => \[ values \] }, file => $file )

Takes path on Artifactory, properties and filename then deploys the file.  Note that properties are a hashref with
key-arrayref pairs, such as:

    $prop = { key1 => ['a'], key2 => ['a', 'b'] }

## deploy\_artifact\_by\_checksum( path => $path, properties => { key => \[ values \] }, file => $file, sha1 => $sha1 )

Takes path, properties, filename and sha1 then deploys the file.  Note that properties are a hashref with key-arrayref
pairs, such as:

    $prop = { key1 => ['a'], key2 => ['a', 'b'] }

## deploy\_artifacts\_from\_archive( path => $path, file => $file )

Path is the path on Artifactory, file is path to local archive.  Will deploy $file to $path.

## push\_a\_set\_of\_artifacts\_to\_bintray( descriptor => 'foo', gpgPassphrase => 'top\_secret', gpgSign => 'true' )

Push a set of artifacts to Bintray as a version.  Uses a descriptor file (that must have 'bintray-info' in it's filename
and a .json extension) that was deployed to artifactory, the call accepts the full path to the descriptor as a
parameter.

## push\_docker\_tag\_to\_bintray( dockerImage => 'jfrog/ubuntu:latest', async => 'true', ... )

Push Docker tag to Bintray.  Calculation can be synchronous (the default) or asynchronous.  You will need to enter your
Bintray credentials, for more details, please refer to Entering your Bintray credentials.

## distribute\_artifact( publish => 'true', async => 'false' )

Deploys artifacts from Artifactory to Bintray, and creates an entry in the corresponding Artifactory distribution
repository specified

## file\_compliance\_info( $path )

Retrieves file compliance info of a given path.

## delete\_item( $path )

Delete $path on artifactory.

## copy\_item( from => $from, to => $to, dry => 1, suppressLayouts => 0/1, failFast => 0/1 )

Copies an artifact from $from to $to.  Note that for this particular API call, the $from and $to must include repository
names as copy source and destination may be different repositories.  You can also supply dry, suppressLayouts and
failFast values as specified in the documentation.

## move\_item( from => $from, to => $to, dry => 1, suppressLayouts => 0/1, failFast => 0/1 )

Moves an artifact from $from to $to.  Note that for this particular API call, the $from and $to must include repository
names as copy source and destination may be different repositories.  You can also supply dry, suppressLayouts and
failFast values as specified in the documentation.

## get\_repository\_replication\_configuration

Get repository replication configuration

## set\_repository\_replication\_configuration( $payload )

Set repository replication configuration

## update\_repository\_replication\_configuration( $payload )

Update repository replication configuration

## delete\_repository\_replication\_configuration

Delete repository replication configuration

## scheduled\_replication\_status

Gets scheduled replication status of a repository

## pull\_push\_replication( payload => $payload, path => $path )

Schedules immediate content replication between two Artifactory instances

## create\_or\_replace\_local\_multi\_push\_replication( $payload )

Creates or replaces a local multi-push replication configuration. Supported by local and local-cached repositories

## update\_local\_multi\_push\_replication( $payload )

Updates a local multi-push replication configuration. Supported by local and local-cached repositories

## delete\_local\_multi\_push\_replication( $url )

README.md  view on Meta::CPAN

## get\_certificates

Returns a list of installed SSL certificates.

## add\_certificate( $alias, $file\_path )

Adds an SSL certificate.

## delete\_certificate( $alias )

Deletes an SSL certificate.

# REPOSITORIES

## get\_repositories( $type )

Returns a list of minimal repository details for all repositories of the specified type

## repository\_configuration( $name, %args )

Retrieves the current configuration of a repository

## create\_or\_replace\_repository\_configuration( $name, \\%payload, %args )

Creates a new repository in Artifactory with the provided configuration or replaces the configuration of an existing
repository

## update\_repository\_configuration( $name, \\%payload )

Updates an exiting repository configuration in Artifactory with the provided configuration elements

## delete\_repository( $name )

Removes a repository configuration together with the whole repository content

## calculate\_yum\_repository\_metadata( async => 0/1 )

Calculates/recalculates the YUM metdata for this repository, based on the RPM package currently hosted in the repository

## calculate\_nuget\_repository\_metadata

Recalculates all the NuGet packages for this repository (local/cache/virtual), and re-annotate the NuGet properties for
each NuGet package according to it's internal nuspec file

## calculate\_npm\_repository\_metadata

Recalculates the npm search index for this repository (local/virtual). Please see the Npm integration documentation for
more details.

## calculate\_maven\_index( repos => \[ 'repo1', 'repo2' \], force => 0/1 )

Calculates/caches a Maven index for the specified repositories

## calculate\_maven\_metadata( $path )

Calculates Maven metadata on the specified path (local repositories only)

## calculate\_debian\_repository\_metadata( async => 0/1 )

Calculates/recalculates the Packages and Release metadata for this repository,based on the Debian packages in it.
Calculation can be synchronous (the default) or asynchronous.

## calculate\_cached\_remote\_debian\_repository\_coordinates( 'repokey' )

Calculates/recalculates the Debian packages coordinates

## calculate\_opkg\_repository\_metadata( async => 0/1, writeProps => 1 )

Calculates/recalculates the Packages and Release metadata for this repository,based on the ipk packages in it (in each
feed location).

## calculate\_bower\_index

Recalculates the index for a Bower repository.

## calculate\_helm\_chart\_index

Calculates Helm chart index on the specified path (local repositories only).

## calculate\_cran\_repository\_metadata

Calculates/recalculates the Packages and Release metadata for this repository, based on the CRAN packages in it.

## calculate\_conda\_repository\_metadata

Calculates/recalculates the Conda packages and release metadata for this repository.

# SYSTEM & CONFIGURATION

## system\_info

Get general system information

## verify\_connection( endpoint => 'http://server/foobar', username => 'admin', password => 'password' )

Verifies a two-way connection between Artifactory and another product

## system\_health\_ping

Get a simple status response about the state of Artifactory

## general\_configuration

Get the general configuration (artifactory.config.xml)

## save\_general\_configuration( $file )

Save the general configuration (artifactory.config.xml)

## update\_custom\_url\_base( $url )

Changes the Custom URL base

## license\_information

Retrieve information about the currently installed license

## install\_license( $licensekey )

Install new license key or change the current one