Artifactory REST APIs

Products: JFrog Artifactory

Introduction to the Artifactory REST APIs
BUILDS
All Builds
Build Runs
Build Upload
Build Append
Build Info
Builds Diff
Build Promotion
Promote Docker Image
Delete Builds
Build Rename
Control Build Retention
ARTIFACTS & STORAGE
Repository Replication APIs
Get Repository Replication Configuration
Set Repository Replication Configuration
Update Repository Replication Configuration
Delete Repository Replication Configuration
Scheduled Replication Status
Pull/Push Replication
Pull/Push Replication (Deprecated)
Create or Replace Local Multi-push Replication
Update Local Multi-push Replication
Delete Local Multi-push Replication
Enable or Disable Multiple Replications
Get Global System Replication Configuration
Get Remote Repositories Registered for Replication
Close all event based pull replication subscribed channels
Block System Replication
Unblock System Replication
Configure Checksum Replication
Get Checksum Replication
Trash Can/Garbage Collection APIs
Empty Trash Can
Delete Item From Trash Can
Restore Item from Trash Can
Run Garbage Collection
Delete Redundant Records to Trash Can Directories
Pruning Unreferenced Data (PUD) APIs
Start PUD Process
Get Status of the PUD Process
Stop PUD Process
Item Properties APIs
Get Item Properties
Set Item Properties
Update Item Properties
Delete Item Properties
Set Item SHA256 Checksum
Deploy Artifact APIs
Deploy Artifact
Deploy Artifact by Checksum
Deploy Artifacts from Archive
Get Folder Info
Get File Info
Get Storage Summary Info
Refresh Storage Summary Info
Get Last Modified Item
File Statistics
Zap Cache
Retrieve Artifact
Retrieve Latest Artifact
Retrieve Build Artifacts Archive
Retrieve Folder or Repository Archive
Trace Artifact Retrieval
Archive Entry Download
Create Directory
Push a Set of Artifacts to Bintray
Control Build Retention
Create Signed URL
Replace Signed URL Key
Distribute Artifact
File Compliance Info (Deprecated)
Delete Item
Copy Item
Move Item
Artifact Sync Download
Folder Sync (Deprecated)
File List
Get Background Tasks
Get RubyGem Version List
Get Artifactory Application Metrics
Get the Open Metrics for Artifactory
Optimize System Storage
RELEASE LIFECYCLE MANAGEMENT
Release Bundle V2 APIs
Create Release Bundle v2 Version
Create Release Bundle v2 Version – Examples
Release Bundle v2 Creation Errors Collected by System
Update Draft Release Bundle v2 Content
Finalize Draft Release Bundle v2 Version
Assign Tag to Release Bundle v2 Version
Delete Release Bundle v2 Version Tag
Get Release Bundle v2 Names
Get Release Bundle v2 Groups
Get Release Bundle v2 Versions
Get Release Bundle v2 Versions - Examples
Get Release Bundle v2 Version (GraphQL)
Get Release Bundle v2 Version (GraphQL) Use Cases & Examples
Get Release Bundle v2 Version Details
Get Release Bundle v2 Versions by Artifact
Get Release Bundle v2 Versions in a Specific Environment
Get Release Bundle v2 Version Signature
Get Release Bundle v2 Version Status
Delete Release Bundle v2 Version
Release Bundle V2 Promotion APIs
Promote Release Bundle v2 Version
Roll Back Release Bundle v2 Version Promotion
Get Release Bundle v2 Promotions
Get Release Bundle v2 Version Promotions
Get Release Bundle v2 Version Promotion Details
Get Release Bundle v2 Version Promotion Status
Get Release Bundle v2 Version Promotions with a Specific Artifact
Delete Release Bundle v2 Version Promotion
Release Bundle V2 Distribution APIs
Distribute Release Bundle Version v2
Abort Release Bundle V2 Distribution
Get Release Bundle V2 Distributions
Get Release Bundle V2 Distribution Details
Remote Delete Release Bundle V2 Distribution
Propagate Public Signing Key
Export Release Bundle Version v2 Archived File
Get Exported Release Bundle Version v2 Status
Delete Exported Release Bundle v2 Archive File
Lifecycle System YAML
Common Optional Query Parameters
EVIDENCE
Prepare Evidence
Prepare Evidence - Sample Payloads
Deploy Evidence
Delete Evidence
Search Evidence (REST API)
Get Evidence by ID (REST API)
Search Evidence (GraphQL)
Search Evidence - Examples
Get Evidence
Get Evidence - Examples
Get Evidence by ID (GraphQL)
SMART ARCHIVING
Create Smart Archiving Policy API
Enable/Disable Smart Archiving Policy API
Run Smart Archiving Policy API
Download Smart Archiving Policy Run Report API
View Smart Archiving Policy Run Summary Report API
Get All Smart Archiving Policies API
View Smart Archiving Policies API
Get Single Smart Archiving Policy by Key API
Update Smart Archiving Policy API
Disable All Smart Archiving Policies API
Delete Smart Archiving Policy API
Stop All Running Smart Archiving Policies API
Stop Running Smart Archiving Policy API
Search for Archived Packages
Restore Archived Packages API
COLD STORAGE
Base URL
Example - Running an Archive Policy
Create an Archive Policy
Convert Search Criteria Form to AQL
Run an Archive Policy
Update an Archive Policy
Stop Policy Execution
Delete an Archive Policy
Get All Archive Policies
Get an Archive Policy
Preview Retention Policy by Policy Key
Preview Retention Policy by Policy Model
Search for Archives
Search for Package Archives
Get Namespace
Restore from Archive
Get Archive Policy Status
Get Restore Process Status
CLEANUP POLICIES
CLEANUP POLICIES - PACKAGES APIs
Create a Package Cleanup Policy API
Enable/Disable a Package Cleanup Policy API
Manually Run Package Cleanup Policy API
Get all Package Cleanup Policies API
Get Single Package Cleanup Policy by Key API
Update a Package-Level Cleanup Policy API
Delete Package Cleanup Policy API
Download Package Cleanup Policy Run Report API
View Package Cleanup Policy Run Summary Report API
CLEANUP POLICIES - RELEASE BUNDLES V2 APIs
Create a Release Bundle Cleanup Policy API
Enable/Disable Release Bundle Cleanup Policy API
Manually Run Release Bundle Cleanup Policy API
Get Single Release Bundle Cleanup Policy by Key API
Update Release Bundle Cleanup Policy API
Delete Release Bundle Cleanup Policy API
Download Release Bundle Cleanup Policy Run Report API
CLEANUP POLICIES - BUILDS APIs
Create Build Cleanup Policy API
Enable/Disable Build Cleanup Policy API
Manually Run Build Cleanup Policy API
Get All Build Cleanup Policies API
Get Single Build Cleanup Policy by Key API
Update Build Cleanup Policy API
Delete Build Cleanup Policy API
Download Build Cleanup Policy Run Report API
CLEANUP POLICIES - COMMON APIs
Stop a Running Cleanup Policy API
Stop All Running Cleanup Policies API
Disable All Cleanup Policies API
SEARCHES
Artifactory Query Language (AQL)
Artifact Search (Quick Search)
Archive Entries Search (Class Search)
GAVC Search
Usage for Remote and Virtual Repositories
Property Search
Checksum Search
Bad Checksum Search
Artifacts Not Downloaded Since
Artifacts With Date in Date Range
Artifacts Created in Date Range
Pattern Search
Builds for Dependency
License Search
Artifact Version Search
Artifact Latest Version Search Based on Layout
Artifact Latest Version Search Based on Properties
Build Artifacts Search
Find Parent Manifest Lists
List Docker Repositories
List Docker Tags
ARTIFACTORY SECURITY
Updates to the Security APIs
Get User Details
Get User Encrypted Password
Expire Password for Multiple Users
Unexpire Password for a Single User
Get Password Expiration Policy
Set Password Expiration Policy
Configure User Lock Policy
Retrieve User Lock Policy
Get Locked Out Users
Unlock Locked-Out Users
Unlock All Locked Out Users
Create API Key
Regenerate API Key
Get API Key
Revoke API Key
Revoke User API Key
Revoke All API Keys
Get Permission Targets
Get Permission Target Details
Create or Replace Permission Target
Delete Permission Target
Effective Item Permissions
Security Configuration (Deprecated)
Activate Artifactory Key Encryption
Deactivate Artifactory Key Encryption
Set GPG Public Key
Set Distribution Public GPG Key
Get GPG Public Key
Set GPG Private Key
Set GPG Pass Phrase
Create Key Pair
Get Key Pair
Delete Key Pair
Get Key Pair Public Key Per Repository
Multiple GPG Signing Keys APIs
Set Key
Delete Key
Download Primary Key
Download Secondary Public Key
Set Primary Key
Set Secondary Key
Delete Primary Key
Delete Secondary Key
Promote
Update Key Pair
Verify Key Pair
Get All Key Pairs
Get Service ID
Get Certificates
Add Certificate
Delete Certificate
Deprecated Security APIs
Get Users
Create or Replace User
Update User
Delete User
Expire Password for a Single User
Change Password
Unlock Locked Out User
Get Groups
Get Group Details
Create or Replace Group
Update Group
Delete Group
Create Token (Deprecated)
Refresh Token (Deprecated)
Get Tokens (Deprecated)
Revoke Token (Deprecated)
Save Security Configuration (Deprecated)
Expire Password for All Users (Deprecated)
REPOSITORIES
Create Repository
Create Multiple Repositories
Check If Repository Exists in a Project
Get Repositories by Type and Project
Get Batch of Repositories by Name
Get Repository Configuration
Get Repository Configuration (v2)
Get All Repository Configurations
Get Puppet APIs
Get Puppet Modules
Get Puppet Module Info
Get Puppet Releases
Get Puppet Release Info
Update Repository Configuration
Update Multiple Repositories
Delete Repository
Remote Repository Configuration (Deprecated)
Calculate Alpine Repository Metadata
Calculate CocoaPods Index
Calculate YUM Repository Metadata
Calculate NuGet Repository Metadata
Calculate Npm Repository Metadata
Calculate Maven Index
Calculate Maven Metadata
Generate Maven POM File
Calculate PyPI Repository Metadata
Get PyPI Latest Package Version Metadata in JSON
Get PyPI Package Version Metadata in JSON
Calculate Debian Repository Metadata
Calculate Cached Remote Debian Repository Coordinates
Create Debian Snapshot
Calculate Opkg Repository Metadata
Calculate Bower Index
Calculate Helm Chart Index
Helm Charts Partial Re-Indexing
Calculate CRAN Repository Metadata
Move CRAN Archives
Calculate Cargo Repository Metadata
Calculate Conda Repository Metadata
Calculate Conan Repository Metadata
Calculate Pub Repository Metadata
Calculate RubyGems Index
Calculate Swift Index
Calculate Terraform Index
VCS Repositories APIs
Get VCS Tags
Get VCS Branches
Get VCS Refs
Download a VCS Tag
Download File within a VCS Tag
Download a VCS Branch
Download a VCS Commit
Download File within a VCS Branch
Download a VCS Release
Download a File in a VCS Branch in a Subgroup Repository
Download a File in a VCS Tag in a Subgroup Repository
Download a VCS Branch from a Subgroup Repository
Download a VCS Tag from a Subgroup Repository
FEDERATED REPOSITORIES
Convert Local Repository to a Federated Repository
Convert Federated Repository to a Local Repository
Convert Build-Info Repository to a Federated Repository
Get List of Inconsistent Federated Repositories
Federation Recovery
Reconnect to Federation Client
Federated Repository Full Sync
Federated Repository Force Full Sync
Propagate Creation Time Metadata during Full Sync
Synchronize Federated Member Configuration
Unidirectional Sync over Federated Repositories
Remove Federation Member
ARTIFACTORY FEDERATION SERVICE MONITORING
Get Federation Connection Details
Get Federation State Details
Get Federation State Summaries
Prioritize Federated Repository
LEGACY FEDERATION MONITORING
Get Federated Repository Status
Get Federated Repository Status (v2)
Get Federation Sync State
Get Federation Mirror Lag Time
Get Unavailable Mirrors
Get List of Failed Binary Tasks
Replay Failed Binary Tasks
Delete Failed Binary Tasks
METADATA
Authentication to use the Metadata Server GraphQL
GraphiQL
Build a Metadata GraphQL Query
GraphQL Pagination
Available Queries for Metadata GraphQL
Filter Types
Entities and Fields
Example 1 - Package by name and type
Example 2 - Package with its Versions and Licenses by creation date
LOGGERS
Set Logger Debug Levels
Get Logger Debug Level
Delete Logger Debug Levels
RELEASE BUNDLES V1
Get All Bundles
Get All Bundle Versions
Get a Release Bundle Version
Delete a Release Bundle Version
Import Release Bundle Version
Get Release Bundle Version Import Status
PLUGINS
Execute Plugin Code
Retrieve Plugin Code
Retrieve Plugin Info
Retrieve Plugin Info of a Certain Type
Retrieve Build Staging Strategy
Execute Build Promotion
Reload Plugins
Live Logs Plugin
Get Live Logs Config
Get Live Logs Data
IMPORT & EXPORT
Import Repository Content
Import System Settings Example
Full System Import
Export System Settings Example
Export System
Export Repository with Metadata
RETENTION (Release Bundle v1)
Query the Status of the Retention Service
Set Retention Policies to Enabled
Get Retention Policy Configuration
Set the Retention Policy Configuration
Get the Configured Retention Policies List
Get the Retention Operations History
Delete Release Bundles
Mark Release Bundles to Keep (or Don’t Keep)
XRAY
ERROR RESPONSES
Replication Configuration JSON
Repository Configuration JSON
Build Artifacts Request JSON
Security Configuration JSON
System Settings JSON

Back to home page