RESOURCES

JFrog REST APIs

ft:sourceType: Paligo

JFrog REST APIs
Artifactory REST APIs
Introduction to the Artifactory REST APIs
REST Resources
BUILDS
All Builds
Build Runs
Build Upload
Build Info
Builds Diff
Build Promotion
Promote Docker Image
Delete Builds
Build Rename
Distribute Build
Control Build Retention
ARTIFACTS & STORAGE
Folder Info
File Info
Get Storage Summary Info
Refresh Storage Summary Info
Item Last Modified
File Statistics
Item Properties
Set Item Properties
Update Item Properties
Delete Item Properties
Set Item SHA256 Checksum
Zap Cache
Retrieve Artifact
Retrieve Latest Artifact
Retrieve Build Artifacts Archive
Retrieve Folder or Repository Archive
Trace Artifact Retrieval
Archive Entry Download
Create Directory
Deploy Artifact
Deploy Artifact by Checksum
Deploy Artifacts from Archive
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
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
Artifact Sync Download
Folder Sync (Deprecated)
File List
Get Background Tasks
Get RubyGem Version List
Get the Open Metrics for Artifactory
Empty Trash Can
Delete Item From Trash Can
Restore Item from Trash Can
Run Garbage Collection
Optimize System Storage
Get Puppet Modules
Get Puppet Module
Get Puppet Releases
Get Puppet Release
COLD ARTIFACT 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
Get Namespace
Restore from Archive
Get Archive Policy Status
Get Restore Process Status
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
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
Expire Password for All 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 the Vault Configuration
Delete the Secret Manager Configuration
Get the Secret Manager Configurations
Tests the Vault Configuration
Set GPG Public Key
Set DistributionPublic 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)
REPOSITORIES
Get Repositories
Repository Configuration
Create Repository
Update Repository Configuration
Delete Repository
Remote Repository Configuration (Deprecated)
Calculate Alpine Repository Metadata
Calculate YUM Repository Metadata
Calculate NuGet Repository Metadata
Calculate Npm Repository Metadata
Calculate Maven Index
Calculate Maven Metadata
Generate Maven POM File
Calculate Debian Repository Metadata
Calculate Cached Remote Debian Repository Coordinates
Create Debian Snapshot
Calculate Opkg Repository Metadata
Calculate Bower Index
Calculate Helm Chart Index
Calculate CRAN Repository Metadata
Move CRAN Archives
Calculate Cargo Repository Metadata
Calculate Conda Repository Metadata
Calculate Conan Repository Metadata
Calculate Pub Repository Metadata
Calculate Terraform Index
Calculate Swift Index
Convert Local Repository to a Federated Repository
Convert Build-Info Repository to a Federated Repository
Federated Repository Full Sync
Synchronize Federated Member Configuration
Get Federated Repository Status
Get Federation Mirror Lag Time
Get Unavailable Mirrors
Get VCS Tags
Get VCS Branches
Download a VCS Tag
Download File within a VCS Tag
Download a VCS Branch
Download File within a VCS Branch
Download a VCS Release
RELEASE BUNDLES
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
RETENTION
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)
SYSTEM & CONFIGURATION
XRAY
SUPPORT
ACCESS
PROJECTS
WEBHOOKS
ROUTER
ERROR RESPONSES
Replication Configuration JSON
Repository Configuration JSON
Security Configuration JSON
System Settings JSON
Artifactory REST API V2
Introduction to the Artifactory REST APIs V2
BUILDS
Get Permission Targets
Get Permission Target Details
Create or Replace Permission Target
Permission Target Existence Check
Create Permission Target
Update Permission Target
Get Permission Targets Per User
Get Permission Targets Per Group
Delete Permission Target
REPOSITORIES
Repository Configuration
JFrog Platform REST APIs
Introduction to the JFrog Platform REST APIs
REST Resources
SECURITY
Users
Query Strings
Get User Details
Get User List
Create User
Update a User (Partial Update)
Delete User
Add or Remove User from Groups
Change a User Password
Set User Password as Expired
Unlock User
Groups
Query Strings
Get Group Details
Get a List of Groups
Create a Group
Group Update
Delete a Group
Add or Remove a Group Member
SYSTEM & CONFIGURATION
System Info
System Health Ping
Readiness Probe
Liveness Probe
Verify Connection
General Configuration
Save General Configuration
Update Custom URL Base
License Information
Install License
HA License Information
Install HA Cluster Licenses
Delete HA Cluster License
Version and Add-ons information
Get Reverse Proxy Configuration
Possible Values for dockerReverseProxyMethod
Update Reverse Proxy Configuration
Get Reverse Proxy Snippet
Start SHA256 Migration Task
Stop SHA256 Migration Task
Create Bootstrap Bundle (Deprecated)
Re-index paths on Metadata Server
Apply Artifactory YAML Configuration Changes
SUPPORT
Create Bundle
List Bundles
Get Bundle Metadata
Delete Bundle
Get Bundle
ACCESS
Base URL
Export Access Configuration
Import Access Configuration
Ping Request
Get Root Certificate
Access Federation
Get All Access Federations
Register Access Federation
Get Access Federation
Delete Access Federation
Update Access Federation
Validate Access Federation
Full Broadcast Access Federation
SCIM
SCIM for Users
GET Specific User
FIND Users by Filter
CREATE Users
UPDATE User
DISABLE User
DELETE User
SCIM for Groups
Get Group by Filter
Get Group by Name
Create Group
Update Group
Patch Group
Delete Group
ACCESS TOKENS
Recommended Configurations
Create Token
Notes on the Create Token API
Get Tokens
Get Token by ID
Revoke Token by ID
Refresh Token
Pairing Token
Create Pairing Token
Initiate Pairing
Get Pairings
Revoke Pairing
Enable Log Collection
PROJECTS
Base URL
Get Projects List
Add a New Project
Get Project
Update Existing Project Properties
Delete Existing Project
Get Project Users
Get Project User
Update User in Project
Delete Existing Project's User
Get Projects Groups
Get Projects Group
Update Group in Project
Delete Existing Project's Group
Get Roles List
Add a New Role
Get Project Role
Update an Existing Project Role
Delete an Existing Role
Move Repository in a Project
Share Repository with All Projects
Unshare Repository with All Projects
Share Repository with Target Project
Unshare Repository with Target Project
Unassign a Project from a Repository
ROUTER
Base URL
Health Check
WEBHOOKS
Base URL
Get the List of all Webhook Subscriptions
Create a New Webhook Subscription
Get a Webhook Subscription by Key
Update Webhook Subscription by Key
Delete Webhook Subscription by Key
Test Webhook Subscription
Ping Request
Authentication Providers Configuration REST APIs
HTTP SSO
Get HTTP SSO
Update HTTP SSO
LDAP Setting
Get the LDAP Settings
Get the LDAP Settings by Key
Delete LDAP Settings
Add LDAP Settings
Change LDAP Settings
LDAP Group Setting
Get the LDAP Group Settings
Get the LDAP Group Settings by Group Name
Delete LDAP Group Settings
Add LDAP Group Settings
Change LDAP Group Settings
MyJFrog Portal REST APIs
ALLOWLIST REST API
Get the JPD IP Allowlist
Add IP to IP Allowlist
Delete IP from IP Allowlist
Xray REST APIs
Introduction to the Xray REST APIs
REST Resources
GENERAL SETTINGS
Ignore Xray Alert
Allow Download of Blocked Artifacts
Allow Download when Xray is Unavailable
Set Block Unscanned Artifacts Timeout Policy
Configuring the Workers Count
Get the Workers Count
Update DB Sync Daily Update Time
Get DB Sync Daily Update Time
USER MANAGEMENT
Get Users
Get User
ISSUES
Create Issue Event
Update Issue Event
Delete Issue Event
Get Issue Events V1
Get Issue Events V2
Garbage Collector (GC)
Garbage Collector Status
Get GC Configuration
Set GC Configuration
Force GC to Run
Abort GC
WATCHES
Create Watch
Update Watch
Get Watches
Get Watch
Delete Watch
Get Ignored Violations
POLICIES - v2
Create Policy
Security Example 1: Setting a 'min_severity' criteria
Security Example 2 - Setting a 'cvss_range' criteria
Security Example 3 - Exclude Violations with No Available Fixed Version
Security Example 4 - Generate violations by specific vulnerability IDs (CVEs)
License Example 1 - Setting an 'allowed_licenses' criteria
License Example 2 - Setting 'banned_licenses' criteria
License Example 3 - Setting ‘multi permissive licenses’ criteria
Example 4 - Projects Sample Usage
Example 5 - Policy with Jira Integration Enabled
Update Policy
Security Example- Generate violations by specific vulnerability IDs (CVEs)
Delete Policy
Get Policies
Security Example - Generate violations by specific vulnerability IDs (CVEs)
Get Policy
Security Example - Generate violations by specific vulnerability IDs (CVEs)
POLICIES - v1
Create Policy
Security Example - Generate violations by specific vulnerability IDs (CVEs)
Update Policy
Security Example - Generate violations by specific vulnerability IDs (CVEs)
Delete Policy
Get Policies
Security Example - Generate violations by specific vulnerability IDs (CVEs)
Get Policy
Security Example - Generate violations by specific vulnerability IDs (CVEs)
Assign Policy to Watches
REPOSITORY CONFIGURATION
Update Repositories Configurations
Get Repositories Configurations
SCANNING
Scan Artifact
Scan Build V1
Scan Build V2
Scan Status
Scan Now
Delete On-Demand Scan Results
Release Bundle Details
Scans List - Get Repositories
Scans List - Get Artifacts
Scans List - Get Builds
Scans List - Get Build Versions
Scans List - Get Packages
Scans List - Get Package Versions
Scans List - Get Release Bundles
Scans List - Get Release Bundle Versions
Get Contextual Analysis per Vulnerability
Exposures Scanning - Get Results List
Exposures Scanning - Get Results Details
Exposures Scanning - Get Findings
Exposures Scanning - Get Evidence
Exposures Scanning - Get Rows
Repository Advanced Scans
Get Repository Advanced Scan Status
Cancel Repository Advanced Scans
REPORTS
Generate Vulnerabilities Report
Generate Due Diligence Report
Generate Violations Report
Generate Operational Risk Report
Get Reports List
Get Vulnerabilities Report Content
Get Due Diligence Report Content
Get Violations Report Content
Get Operational Risk Report Content
Get Report Details By ID
Export
Delete
Abort
BINARY MANAGERS
Get Binary Manager
Get Repos Indexing Configuration
Get Builds Indexing Configuration
Add Builds to Indexing Configuration
Update Repos Indexing Configuration
Update Builds Indexing Configuration
Force Reindex
COMPONENTS
Find Component by Name
Find Component by CVE
Find CVEs by Component
Get Component List Per Watch
Get Artifact Dependency Graph
Compare Artifacts
Get Build Dependency Graph
Compare Builds
Export Component Details
SECURITY
Enable TLS Certificate for RabbitMQ
INTEGRATIONS
Get Integration Configuration
Add Integration Configuration
Update Integration Configuration
Delete Integration Configuration
SUMMARY
Build Summary
Artifact Summary
SYSTEM
Resend Artifacts Metadata
Create Bundle
Get System Monitoring Status
Ping Request
Get Version
Metrics
IGNORE RULES
Get Ignore Rules
Get Ignore Rule
Create Ignore Rule
Delete Ignore Rule
VIOLATIONS
Get Violations
List Ignored Violations
Restore Ignored Violations
IMPORT & EXPORT
Export Xray Settings
Import Xray Configurations
MIGRATION
On-Demand Migration
Deprecated REST APIs
Xray Webhooks
Add a New Webhook
Update a Webhook
Delete a Webhook
Get All Webhooks
Get A Webhook
Distribution REST APIs
Introduction to the Distribution REST APIs
GENERAL
Test Connection
Get System Info
Get System Settings
Update System Settings
SIGNING KEYS
Upload and Propagate GPG Signing Keys for Distribution
Update Alias Name
Get Key
Get Keys List
Delete Key
Propagate GPG Signing Keys to a Distribution Edge
Upload GPG Signing Key for Distribution
Get Public Key
RELEASE BUNDLES
Create Release Bundle Version
Dynamic Release Bundle
Update Release Bundle Version
Sign Release Bundle Version
Get all Versions of all Release Bundles
Get Release Bundle Versions
Get Release Bundle Version
Get Last Release Bundle Version
Delete Release Bundle All Versions
Delete Release Bundle Version
Export Release Bundle Version Archived File
Get Exported Release Bundle Version Status
Delete Exported Release Bundle Archive File
DISTRIBUTION
Distribute Release Bundle Version
Delete Release Bundle Version from Distribution Edges
Get Distribution Status Details
Get Distribution Status Details by Release Bundle Name
Get Distribution Status Details by Release Bundle Version
Get Distribution Status Details by Tracker Id
TOKEN MANAGEMENT
Create a Token
Refresh a Token
Revoke a Token
Get Tokens Info
PERMISSION MANAGEMENT
Create/Update Destinations Permissions by Name
Get All Permissions
Get Permission by name
Delete Permission by name
SUPPORT
Create Support Bundle
Create Specific Support Bundle
Get Support Bundle Info
Get support bundle
Delete Support Bundle
List Support Bundles
MAINTENANCE
Generate Stop All Tasks token
Stop All Tasks
XRAY
Triggers Xray Release Bundle Version Indexing
IMPORT & EXPORT
Get Source Artifactory IDs
Export Distribution Release Bundle Metadata
Import Distribution Release Bundle Metadata
ERROR RESPONSES
Pipelines REST APIs
Introduction to the Pipelines REST APIs
SYSTEM
Get Status Codes
Get System Information
Get System Config Status
Get System Health Status
SYSTEM LOG LEVEL
Update System Log Level
Delete System Log Level
Get System Log Level Information
METRICS
Get Pipelines Metrics Data
Get Pipelines Application Metrics Data
PROJECTS
Get Projects
BUILD PLANE IMAGES
Add Custom AMI Image
Get Build Plane Image Ids
NODES
Add a Node
Delete a Node
Get Nodes
Get a Node
NODE STATS
Get Node Stats
NODE POOLS
Add a Node Pool
Update a Node Pool
Delete a Node Pool
Get Node Pools
MASTER INTEGRATIONS
Get all Integrations
MASTER INTEGRATION FIELDS
Get all Master Integration Fields
PROJECT INTEGRATIONS
Add a Project Integration
Update a Project Integration
Delete a Project Integration
Get Project Integrations
Share a Project Integration
Get Project Integrations Share Information
PIPELINE SOURCES
Add a Pipeline Source
Update a Pipeline Source
Delete a Pipeline Source
Get all Pipeline Sources
Get a Pipeline Source
PIPELINES
Get Pipelines
Get Pipeline by ID
Get Pipeline Artifacts
Get Pipeline State
Trigger Pipeline
Set Next Run Number
PIPELINE SYNC STATUS
Get a Pipeline Sync Status
RUNS
Get Runs
Get Runs by ID
Cancel Run by ID
Get Run Resource Versions
RESOURCES
Get Resources
Get Resources by ID
RESOURCE VERSIONS
Get Resource Versions
Get Resource Versions by ID
STEPS
Trigger Pipelines Steps
Get Steps
Get Step by ID
Approval Response
STEP CONSOLES
Get Step Consoles
STEP TEST REPORTS
Get Step Test Reports
Get Step Test Reports by Step Id
PIPELINE STEPS
Get Pipelines Steps
Get Pipeline Step by ID
STEPLETS
Get Steplets
Get Steplet by ID
PIPELINE STEPLETS
Get Steplets
Get a Pipeline Steplet
STEPLET CONSOLES
Get Steplet Consoles
STEPLET TEST REPORTS
Get Steplet Test Reports
MASTER RESOURCES
Get all Master Resources
Get a Master Resource
TEMPLATES
Add a Template
Get all Templates
Get Templates by Id
ENVIRONMENT VARIABLES
Create an Environment Variable
Update an Environment Variable
Get an Environment Variable using Id
Get an Environment Variable using Query
Delete an Environment Variable
PDN REST APIs and Metrics
Introduction to the Private Distribution Network (PDN) REST APIs and Metrics
PDN APIs
PDN Node APIs
Generic Download
Ping
Response Headers
PDN Server APIs
Ping
Liveness
Readiness
Clear Cache
Clear Unavailable PDN Nodes
PDN Metrics
Enabling PDN Open Metrics
PDN Server Metrics
PDN Node Metrics
Mission Control REST APIs
Introduction to the Mission Control REST APIs
SYSTEM
Export
Import
System Health Check
JPDs
Add JPD
Update JPD
Get JPD List
Get JPD by id
Delete JPD
ACCESS FEDERATION
Get Access Federation Configuration for a Single JPD
Get Access Federation Configuration for All JPDs
Configure Access Federation on a JPD
Get Access Federation Candidates
Create Mesh
SUPPORT
Create Support Bundle
Get Support Bundles List
Get Details of a Support Bundle
Download Support Bundle
Delete Support Bundle
LICENSE BUCKETS
Get Buckets
Create Bucket
Upload Bucket
Delete Bucket
Get Bucket Status
Attach License
Acquire License
Release License
Artifactory Query Language
GraphQL

Back to home page