User Guide

Getting Started

Instantiate the Rtpy class
- Mandatory keys
- Optional keys

Instantiate the Rtpy class

A rtpy.Rtpy object is used to make all the API calls.
To be instantiated the Rtpy class only takes a python dictionary as first positional argument. This dictionary contains the user's settings such as API key and Artifactory instance URL.

Mandatory keys

"af_url" : URL of the AF instance (starting with http(s)://)
"api_key" or "username" and "password" : API key or username and password for the user in the Artifactory instance

import rtpy

settings = {}
settings["af_url"] = "http://..."
settings["api_key"] = "123QWA..." 
# settings["username"] = "my_username"
# settings["password"] = "my_password"

af = rtpy.Rtpy(settings)

Optional keys

"verbose_level" : 0/1
- The desired verbose level, 0 for nothing, 1 to print performed operations
- 0 if not not provided
"raw_response" : False/True
- True will return a requests.Response object and the errors will not be automatically raised
- False will return a python object
- False if not provided
"session": requests.Session object
- rtpy uses a requests.Session object to make calls to the Artifactory API endpoint. A custom can be provided session object when creating a Rtpy object for advanced HTTP configurations, proxies, SSL...
- request.Session() (default attributes) if not provided

import requests
import rtpy

settings["verbose_level"] = 0/1
settings["raw_response"] = False/True

# SSL : custom CA bundle example
session = requests.Session()
session.verify = "path/to/ca_bundle.crt"
settings['session'] = session

af = rtpy.Rtpy(settings)

Responses

The response when using methods can be a :

When "raw_response" is False (default):
- python dictionary or list (a converted json output) (most cases)
- unicode string ((requests.Response).text) (if the json content can't be decoded/is missing/isn't expected)
When "raw_response" is True :
- requests.Response Object

Tips

Environment variables as settings
Error handling
Overriding settings
Instantiate and check equality of multiple Rtpy objects
pretty-print
Json file to Python dictionary

Environment variables as settings

Use environement variables for the api_key and af_url in the settings dictionary

settings = {}
settings["af_url"] = os.environ["ARTIFACTORY_URL"] # URL of the AF instance
settings["api_key"] = os.environ["ARTIFACTORY_API_KEY"] # User/Admin API key in the given AF instance

af = rtpy.Rtpy(settings)

Error handling

There are currently 4 errors :

UserSettingsError
AfApiError
MalformedAfApiError
RtpyError

UserSettingsError

Standalone error, when the instantiation of the Rtpy object fails due to incorrect settings

try:
    af = rtpy.Rtpy(settings)
except rtpy.UserSettingsError:
    # Do stuff

### AfApiError When the status code is 4xx-5xx and the API sends a well formed JSON

The error has specific attributes

try:
    r = af.category.method_xyz()

except af.AfApiError as error:

    # All the attributes of the error
    print(dir(error))

    # Rtpy attributes for the error
    print(error.api_method)
    print(error.url)
    print(error.verb)
    print(error.status_code)
    print(error.message)
    print(error.print_message)

    if error.status_code == 404:
        # Do stuff

    if error.status_code == 403:
        # Do stuff

### MalformedAfApiError When the status code is 4xx-5xx and the API sends a malformed JSON ```python try: # The JSON is currently malformed when the API sends an error when using this method af.system_and_configuration.install_license(params) except af.MalformedAfApiError: pass ```
### RtpyError When a method is called and parameters are missing or incorrect ```python try: # Providing "" for artifact_path will raise the RtpyError af.artifacts_and_storage.retrieve_artifact("repo_key", "") except af.RtpyError: pass ```
## Overriding settings All the settings can be overridden for a **single function call** (original settings are restored when the call is over)
This is useful for debugging (verbose level) or not raising errors (raw_response). It can also be used to provide different credentials

r = af.category.method_xyz(settings={"raw_response" : True, "verbose_level" : 1})

r = af.category.method_xyz(settings={"verbose_level" : 1})

r = af.category.method_xyz(settings={"api_key" : "123ABC..."})

session = requests.Session()
session.verify = "path/to/ca_bundle.crt"
r = af.category.method_xyz(settings={"session" : session})

Instantiate and check equality of multiple Rtpy objects

This can be used to have different persistent settings and make different calls with different users

import rtpy

af1 = rtpy.Rtpy({"af_url" : "https://...", "api_key" : "123QWA..."})
af2 = rtpy.Rtpy({"af_url" : "https://...", "api_key" : "456IOU..."})

# Usage of Rtpy's __repr__ and __eq__ special methods 
settings = {}
settings["af_url"] = "http://localhost:8081/artifactory"
settings["username"] = "admin"
settings["password"] = "password"

af1 = rtpy.Rtpy(settings)

print(af1)
# rtpy.Rtpy({'af_url': 'http://localhost:8081/artifactory', 'username': 'admin', 'password': 'password'})

af2 = rtpy.Rtpy(settings)
assert af1 == af2

af3 = eval(repr(af1))
af4 = eval(repr(af2))

assert af1 == af2 == af3 == af4

pretty-print

Use the pprint package to print the json responses in a more readable way

r = af.category.method_xyz()
pprint.pprint(r)

## Json file to Python dictionary Convert a json file to a python dictionnary using the json_to_dict method ```python my_dict = rtpy.json_to_dict(json_file_path) ```

# Examples List of examples for **[supported methods](./SUPPORTED_METHODS.md)**.

ARITFACTS AND STORAGE
BUILDS
- All Builds
REPOSITORIES
SEARCHES
SECURITY
SUPPORT
SYSTEM AND CONFIGURATION

## ARTIFACTS AND STORAGE

Folder Info

https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-FolderInfo

r = af.artifacts_and_storage.folder_info(repo_key, folder_path)
# repo_key is the name of the repository in Artifactory
# folder_path is the path of the folder inside the repo
# To get information on the root repo, use "", as argument for folder_path

Standard example

r = af.artifacts_and_storage.item_properties("my_repo", "folder/artifact.png")

Retrieve specific propertie(s)

r = af.artifacts_and_storage.item_properties(repo_key, item_path, properties="version") r = af.artifacts_and_storage.item_properties(repo_key, item_path, properties="version, owner")

<br/>
### Set Item Properties
[https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-SetItemProperties](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-SetItemProperties)
```python
r = af.artifacts_and_storage.set_item_properties(repo_key, item_path, properties)
# repo_key is the name of the repository in Artifactory
# item_path is the path of the item inside the repo

# Single property
r = af.artifacts_and_storage.set_item_properties(repo_key, item_path, "version=1.0")

# Set multiple properties
r = af.artifacts_and_storage.set_item_properties(repo_key, item_path, "version=1.0;author=smith")

### Delete Item Properties [https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-DeleteItemProperties](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-DeleteItemProperties) ```python r = af.artifacts_and_storage.set_item_properties(repo_key, item_path, properties) # repo_key is the name of the repository in Artifactory # item_path is the path of the item inside the repo

Delete a single property

r = af.artifacts_and_storage.set_item_properties(repo_key, item_path, "version")

Delete multiple properties

r = af.artifacts_and_storage.set_item_properties(repo_key, item_path, "version,author")

<br/>
### Set Item SHA256 Checksum
[https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-SetItemSHA256Checksum](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-SetItemSHA256Checksum)
```python
params = {"repo_key": my_repo_key, "path": mypath}
# repo_key is the name of the repository in Artifactory
# artifact_path is the path of the artifact inside the repo
r = af.artifacts_and_storage.set_item_sha256_checksum(params)

### Retrieve Artifact [https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-RetrieveArtifact](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-RetrieveArtifact) ```python r = af.artifacts_and_storage.retrieve_artifact(repo_key, artifact_path) # repo_key is the name of the repository in Artifactory # artifact_path is the path of the artifact inside the repo

Save the file locally

with open("myartifact.png", "wb") as artifact: artifact.write(r.content)

<br/>
### Retrieve Folder or Repository Archive
[https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-RetrieveFolderorRepositoryArchive](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-RetrieveFolderorRepositoryArchive)
```python
r = af.artifacts_and_storage.retrieve_folder_or_repository_archive(repo_key, path, archive_type)
# repo_key is the name of the repository in Artifactory
# path is the path of the folder inside the repo
# archive_type can be "zip", "tar", "tar.gz", "tgz"

# Checksums can be included
r = af.artifacts_and_storage.retrieve_folder_or_repository_archive(repo_key, path, archive_type, include_checksums=True)

# Save the archive locally
with open("myarchive.archive_type", "wb") as archive:
    archive.write(r.content)

### Trace Artifact Retrieval [https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-TraceArtifactRetrieval](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-TraceArtifactRetrieval) ```python r = af.artifacts_and_storage.trace_artifact_retrieval(repo_key, item_path) # repo_key is the name of the repository in Artifactory # item_path is the path of the item inside the repo

with this method the response is a Python requests response object

use r.text

print(r.text)

<br/>
### Create Directory
[https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CreateDirectory](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CreateDirectory)
```python
r = af.artifacts_and_storage.create_directory(repo_key, directory_path)
# repo_key is the name of the repository in Artifactory
# directory_path is the path of the directory inside the repo

# Known issue : when trying to create a directory that already exists, 
# response will not say already exist and nothing will happen.

### Deploy Artifact [https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-DeployArtifact](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-DeployArtifact) ```python r = af.artifacts_and_storage.deploy_artifact(repo_key, local_artifact_path, target_artifact_path) # repo_key is the name of the repository in Artifactory # target_artifact_path is the path of the artifact inside the repo # local_artifact_path is the path of the artifact on the local machine

Standard example

r = af.artifacts_and_storage.deploy_artifact("myrepo", "myartifact_on_my_machine.png", "directory/my_remote_artifact.png")

It is possible to attach properties as part of deploying an artifact using

Artifactory's Matrix Parameters :

https://www.jfrog.com/confluence/display/RTF4X/Using+Properties+in+Deployment+and+Resolution

Single property

r = af.artifacts_and_storage.deploy_artifact("myrepo", "myartifact_on_my_machine", "myartifact;prop1=value")

Multiple properties

r = af.artifacts_and_storage.deploy_artifact("myrepo", "myartifact_on_my_machine", "myartifact;prop1=value;prop2=value2")

<br/>
### Deploy Artifact by Checksum
[https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-DeployArtifactbyChecksum](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-DeployArtifactbyChecksum)
```python
r = af.artifacts_and_storage.deploy_artifact_by_checksum(repo_key, target_artifact_path, sha_type, sha_value):
# repo_key is the name of the repository in Artifactory
# target_artifact_path is the path of the artifact inside the repo
# sha_type is "sha1" or "sha256"
# sha_value is the value of the sha (string)

# Standard example
sha_type = "sha1"
sha_value = "e1a13e64b0414015d43dd80eed7876d7cee5e50e"

r = af.artifacts_and_storage.deploy_artifact_by_checksum("my_repo", "my_remote_artifact", sha_type, sha_value)


# It is possible to attach properties as part of deploying an artifact using 
# Artifactory's Matrix Parameters : 
# https://www.jfrog.com/confluence/display/RTF4X/Using+Properties+in+Deployment+and+Resolution

# Single property
r = af.artifacts_and_storage.deploy_artifact_by_checksum("myrepo", "myartifact;prop1=value", sha_type, sha_value)

# Multiple properties
r = af.artifacts_and_storage.deploy_artifact_by_checksum("myrepo", "myartifact;prop1=value;prop2=value2", sha_type, sha_value)

### Delete Item [https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-DeleteItem](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-DeleteItem) ```python r = af.artifacts_and_storage.delete_item(repo_key, path_to_item) # repo_key is the name of the repository in Artifactory # path_to_item is the path to the item (repo or artifact) in the repo # use "" as argument for path_to_item to delete all the content of a repository ```
### Copy Item [https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CopyItem](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CopyItem) ```python r = af.artifacts_and_storage.copy_item(src_repo_key, src_item_path, target_repo_key, target_item_path) # src_repo_key is the name of the repository in Artifactory # src_item_path is the path to the item (repo or artifact) in the repo # target_repo_key is the name of the target repository in Artifactory # target_item_path is the path of the item in the target repository

Additionnal options from the documentation can be supplied as a string

r = af.artifacts_and_storage.copy_item(src_repo_key, src_item_path, target_repo_key, target_item_path, options=string_of_options)

Such as "[&dry=1][&suppressLayouts=0/1(default)][&failFast=0/1]"

<br/>
### Move Item
[https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-MoveItem](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-MoveItem)
```python
r = af.artifacts_and_storage.move_item(src_repo_key, src_item_path, target_repo_key, target_item_path)
# src_repo_key is the name of the repository in Artifactory
# src_item_path is the path to the item (repo or artifact) in the repo
# target_repo_key is the name of the target repository in Artifactory
# target_item_path is the path of the item in the target repository

# Additionnal options from the documentation can be supplied as a string
r = af.artifacts_and_storage.move_item(src_repo_key, src_item_path, target_repo_key, target_item_path, options=string_of_options)
# Such as [&dry=1][&suppressLayouts=0/1(default)][&failFast=0/1]

### Artifact Sync Download [https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ArtifactSyncDownload](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ArtifactSyncDownload) ```python r = af.artifacts_and_storage.artifact_sync_download(repo_key, artifact_path) # repo_key is the name of the repository in Artifactory # artifact_path is the path of the artifact inside the repo

Additionnal options from the documentation can be supplied as a string

r = af.artifacts_and_storage.artifact_sync_download(repo_key, artifact_path, options=string_of_options)

Such as [?content=none/progress][&mark=numOfBytesToPrintANewProgressMark]

If no content parameter is specified the file content is downloaded to the client.

<br/>
### File List
[https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-FileList](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-FileList)
```python
r = af.artifacts_and_storage.file_list(repo_key, folder_path)
# repo_key is the name of the repository in Artifactory
# folder_path is the path of the folder inside the repo
# To get information on the root repo, use "", as argument for folder_path

# Additionnal options from the documentation can be supplied as a string
r = af.artifacts_and_storage.file_list(repo_key, folder_path, options=string_of_options)
# Such as [&depth=n][&listFolders=0/1][&mdTimestamps=0/1][&includeRootPath=0/1]

All Builds

r = af.builds.all_builds()

REPOSITORIES

Get Repositories

https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-GetRepositories

r = af.repositories.get_repositories()

Additionnal options from the documentation can be supplied as a string

r = af.calculate_yum_repository_metadata(repo_key, options=string_of_options)

Such as [?path={path to repodata dir][&async=0/1]

a GPG passphrase can be supplied

gpg_passphrase = "abc" r = af.calculate_yum_repository_metadata(repo_key, x_gpg_passphrase=gpg_passphrase)

<br/>
### Calculate NuGet Repository Metadata
[https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CalculateNuGetRepositoryMetadata](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CalculateNuGetRepositoryMetadata)
```python
r = af.repositories.calculate_nuget_repository_metadata(repo_key)
# repo_key is the name of the repository in Artifactory

### Calculate Npm Repository Metadata [https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CalculateNpmRepositoryMetadata](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CalculateNpmRepositoryMetadata) ```python r = af.repositories.calculate_npm_repository_metadata(repo_key) # repo_key is the name of the repository in Artifactory ```
### Calculate Maven Index [https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CalculateMavenIndex](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CalculateMavenIndex) ```python r = af.repositories.calculate_maven_index(options_string) # options_string is a string of the possible options # Such as [?repos=x[,y]][&force=0/1] ```
### Calculate Maven Metadata [https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CalculateMavenMetadata](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CalculateMavenMetadata) ```python r = af.repositories.calculate_maven_metadata(repo_key, folder_path) # repo_key is the name of the repository in Artifactory # folder_path is the path of the folder inside the repo

Additionnal options from the documentation can be supplied as a string

r = af.repositories.calculate_maven_metadata(repo_key, folder_path, options=string_of_options)

Such as {nonRecursive=true | false}

<br/>
### Calculate Debian Repository Metadata
[https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CalculateDebianRepositoryMetadata](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CalculateDebianRepositoryMetadata)
```python
r = af.repositories.calculate_debian_repository_metadata(repo_key)
# repo_key is the name of the repository in Artifactory

# Additionnal options from the documentation can be supplied as a string
r = af.calculate_debian_repository_metadata(repo_key, options=string_of_options)
# Such as [?async=0/1][?writeProps=0/1]

# a GPG passphrase can be supplied
gpg_passphrase = "abc"
r = af.calculate_debian_repository_metadata(repo_key, x_gpg_passphrase=gpg_passphrase)

### Calculate Opkg Repository Metadata [https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CalculateOpkgRepositoryMetadata](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CalculateOpkgRepositoryMetadata) ```python r = af.repositories.calculate_opkg_repository_metadata(repo_key) # repo_key is the name of the repository in Artifactory

Additionnal options from the documentation can be supplied as a string

r = af.calculate_opkg_repository_metadata(repo_key, options=string_of_options)

Such as [?async=0/1][?writeProps=0/1]

a GPG passphrase can be supplied

gpg_passphrase = "abc" r = af.calculate_opkg_repository_metadata(repo_key, x_gpg_passphrase=gpg_passphrase)

<br/>
### Calculate Bower Index
[https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CalculateBowerIndex](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CalculateBowerIndex)
```python
r = af.repositories.calculate_bower_index(repo_key)
# repo_key is the name of the repository in Artifactory

### Calculate Helm Chart Index [https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CalculateHelmChartIndex](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CalculateHelmChartIndex) ```python r = af.repositories.calculate_helm_chart_index(repo_key) # repo_key is the name of the repository in Artifactory ```

## SEARCHES

Artifactory Query Language

https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ArtifactoryQueryLanguage(AQL)

query = "aql_querry_string"
r = af.searches.artifactory_query_language(query)
# Example : query = "items.find({"repo":{"$eq":"my-repo"}})"

### List Docker Repositories [https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ListDockerRepositories](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ListDockerRepositories) ```python r = af.searches.list_docker_repositories(repo_key) # repo_key is the name of the repository in Artifactory

Additionnal options from the documentation can be supplied as a string

r = af.searches.list_docker_repositories(repo_key, options=string_of_options)

<br/>
### List Docker Tags
[https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ListDockerTags](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ListDockerTags)
```python
r = af.searches.list_docker_tags(repo_key, image_path)
# repo_key is the name of the repository/registry in Artifactory
# image_path is the path of the docker image in the repository/registry

# Additionnal options from the documentation can be supplied as a string
r = af.searches.list_docker_repositories(repo_key, image_path, options=string_of_options)
# Such as ?n=<n from the request>&last=<last tag value from previous response>

SECURITY

Get Users

https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-GetUsers

r = af.security.get_users()

<br/>
<br/><br/>
## SUPPORT

### Create Bundle
[https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CreateBundle](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CreateBundle)
```python
# params is a python dictionnary which should be like :
# https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-CreateBundle
params = rtpy.json_to_dict("tests/templates/bundle_creation.json")
r = af.support.create_bundle(params)

### List Bundles [https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ListBundles](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ListBundles) ```python r = af.support.list_bundles() ```
### Get Bundle [https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-GetBundle](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-GetBundle) ```python # bundle_name is the name of the bundle r = af.support.get_bundle(bundle_name) with open(my_bundle_name, "wb") as bundle_file: bundle_file.write(r.content) ```
### Delete Bundle [https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-DeleteBundle](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-DeleteBundle) ```python # bundle_name is the name of the bundle r = af.support.delete_bundle(bundle_name) ```

## SYSTEM AND CONFIGURATION

System Info

https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-SystemInfo

r = af.system_and_configuration.system_info()

Files

USERGUIDE.md

Latest commit

History

USERGUIDE.md

File metadata and controls

User Guide

Table of contents

Getting Started

Instantiate the Rtpy class

Mandatory keys

Optional keys

Responses

Tips

Environment variables as settings

Error handling

UserSettingsError

Instantiate and check equality of multiple Rtpy objects

pretty-print

Folder Info

Standard example

Retrieve specific propertie(s)

Delete a single property

Delete multiple properties

Save the file locally

with this method the response is a Python requests response object

use r.text

Standard example

It is possible to attach properties as part of deploying an artifact using

Artifactory's Matrix Parameters :

https://www.jfrog.com/confluence/display/RTF4X/Using+Properties+in+Deployment+and+Resolution

Single property

Multiple properties

Additionnal options from the documentation can be supplied as a string

Such as "[&dry=1][&suppressLayouts=0/1(default)][&failFast=0/1]"

Additionnal options from the documentation can be supplied as a string

Such as [?content=none/progress][&mark=numOfBytesToPrintANewProgressMark]

If no content parameter is specified the file content is downloaded to the client.

All Builds

REPOSITORIES

Get Repositories

Additionnal options from the documentation can be supplied as a string

Such as [?path={path to repodata dir][&async=0/1]

a GPG passphrase can be supplied

Additionnal options from the documentation can be supplied as a string

Such as {nonRecursive=true | false}

Additionnal options from the documentation can be supplied as a string

Such as [?async=0/1][?writeProps=0/1]

a GPG passphrase can be supplied

Artifactory Query Language

Additionnal options from the documentation can be supplied as a string

SECURITY

Get Users

System Info