ACCESS FEDERATION

JFrog REST APIs

Content Type: REST API
ft:sourceType: Paligo

JFrog REST APIs
Artifactory REST APIs
Introduction to the Artifactory REST APIs
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
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
Get Puppet APIs
Get Puppet Modules
Get Puppet Module Info
Get Puppet Releases
Get Puppet Release Info
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 the Open Metrics for Artifactory
Optimize System Storage
RELEASE LIFECYCLE MANAGEMENT
Release Bundle V2 APIs
Create Release Bundle v2 Version
Source Type - AQL
Source Type - Artifacts
Source Type - Builds
Source Type - Release Bundles
Get Release Bundle v2 Names
Get Release Bundle v2 Groups
Get Release Bundle v2 Versions
Get Release Bundle v2 Version Details
Get Release Bundle v2 Version Signature
Get Release Bundle v2 Version Status
Delete Release Bundle v2 Version
Release Bundle Manifest for Builds
Release Bundle V2 Promotion APIs
Promote Release Bundle v2 Version
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
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
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
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
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 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)
REPOSITORIES
Create Repository
Create Multiple Repositories
Get Repositories
Get Multiple Repositories by Name
Repository Configuration
Get All Repository Configurations
Update Repository Configuration
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
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 RubyGems Index
Calculate Swift Index
Calculate Terraform Index
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
FEDERATED REPOSITORIES
Convert Local Repository to a Federated Repository
Convert Build-Info Repository to a Federated Repository
Federation Recovery
Federated Repository Full Sync
Federated Repository Force Full Sync
Synchronize Federated Member Configuration
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
LOGGERS
Set Logger Debug Levels
Get Logger Debug Level
Delete Logger Debug Levels
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
Build Artifacts Request JSON
Security Configuration JSON
System Settings JSON
Artifactory REST API V2
Introduction to the Artifactory REST APIs V2
PERMISSION TARGETS
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
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
ROUTER
Health Check
Users
Get User Details
Get User List
query strings
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
Permissions
Create Permission
Get Permissions
Get Permission Details by Permission Name
Delete Permission
Get Permission Resource Based on Permission Name and Resource Type
Delete Permission Resource Based on Permission Name and Resource Type
Replace Permission Resource Based on Permission Name and Resource Type
Update Permission Resource Based on Permission Name and Resource Type
ACCESS
ACCESS TOKENS
Recommended Configurations
Create Token
Create Token API Examples
Get Tokens
Get Token by ID
Revoke Token by ID
Revoke Token by Value
Refresh Token
Get Token Default Expiry Value
Put Token Default Expiry Value
Pairing Token
Create Pairing Token
Initiate Pairing
Get Pairings
Revoke Pairing
Enable Log Collection
Export Access Configuration
Import Access Configuration
Ping Request
Get Root Certificate
Get CA Public Certificate
Access Federation
Get All Access Federations
Register Access Federation
Get Access Federation
Delete Access Federation
Update Access Federation
Validate Target for Circle of Trust
Full Broadcast Access Federation
SCIM for Users
GET Users by Filter
GET Specific User
GET Users
CREATE Users
UPDATE User
DISABLE User
DELETE User
SCIM for Groups
Get Groups
Get Group by Name
Get Group by Filter
Create Group
Update Group
Patch Group
Delete Group
OIDC Integration API
Create or Update OIDC Configuration
Get all OIDC Configuration
Get OIDC Configuration
Delete OIDC Configuration
Create an Identity Mapping
Get all Identity Mappings by Provider Name
Get Identity Mappings by Mapping Name
Delete Identity Mapping
OIDC Token Exchange
AWS IAM Role APIs
PUT AWS IAM Role
GET AWS IAM Role
DELETE IAM ROLE
SUPPORT
Create Bundle
List Bundles
Get Bundle Metadata
Delete Bundle
Get Bundle
ENVIRONMENTS
Create Global Environment
Rename a Global Environment
Get Global Environments
Delete Global Environment
Create Project Environment
Rename a Project Environment
Get Project Environments
Delete Project Environment
JFConnect
JFConnect Health Ping
JFConnect Liveness
JFConnect Readiness
JFConnect GET Service ID
JFConnect GET JPD ID
JFConnect Start Register for Air-gapped JPD
Post Offline Request Token to JFrog Entitlements Service
JFConnect Apply Entitlements to an Air-Gapped JPD
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
Stream All Troubleshooting Data
Stream Filtered Troubleshooting Data
Fetch Historical Troubleshooting Data
Authentication Providers Configuration REST APIs
Crowd
Add Crowd Settings
Get Crowd Settings
Update Crowd Settings
HTTP SSO
Get HTTP SSO Settings
Update HTTP SSO Settings
LDAP
Add LDAP Settings
Get the LDAP Settings
Get the LDAP Settings by Key
Update LDAP Settings
Delete LDAP Settings
LDAP Group
Add LDAP Group Settings
Get the LDAP Group Settings
Get the LDAP Group Settings by Group Name
Update LDAP Group Settings
Import or Update LDAP Group Settings
Delete LDAP Group Settings
SAML
Get the SAML Settings
Get the SAML Settings by Name
Add SAML Settings
Update SAML Settings
Delete SAML Settings
GET Status of Disable Basic Authentication
Enable or Disable Disable Basic Authentication
PROJECTS
Base URL
Get Projects List
Create Project
Get Project
Update Existing Project Properties
Delete Existing Project
Get Project Users
Get Project User
Add or 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
Create Role
Get Project Role
Update an Existing Project Role
Delete an Existing Role
Move Repository in a Project
Get Status of Project Repository
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
GLOBAL ROLES
Create a Custom Global Role
Get All Custom Global Roles
Get a Specific Custom Global Role
Edit a Global Role
Delete a Custom Global Role
Workers REST APIs
Create Worker
Get Workers
Get Specified Worker
Get Available Actions
Update Worker
Execute Test
Workers Service Readiness
Workers Service Liveness
Get Worker Execution History
Delete Worker
Execute Worker for Generic Event
List of Worker Events
MyJFrog Portal REST APIs
GET Platform Cloud NAT IPs
ALLOWLIST REST API
Get the JPD IP Allowlist
Add IP to IP Allowlist
Delete IP from IP Allowlist
CUSTOM DOMAIN NAME REST APIS
Create SSL Object
Delete SSL Object
Get SSL Objects
Renew SSL Object
Validate SSL Object
Manage Domain
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 V1
Create Release Bundle v1 Version
Dynamic Release Bundle v1
Update Release Bundle v1 Version
Sign Release Bundle v1 Version
Get All Versions of All Release Bundles v1
Get Release Bundle v1 Versions
Get Release Bundle v1 Version
Get Latest Release Bundle v1 Version
Delete Release Bundle v1 All Versions
Delete Release Bundle v1 Version
Export Release Bundle v1 Version Archived File
Get Exported Release Bundle v1 Version Status
Delete Exported Release Bundle v1 Archive File
DISTRIBUTION
Distribute Release Bundle v1 Version
Delete Release Bundle v1 Version from Distribution Edges
Get Distribution Status Details
Get Distribution Status Details by Release Bundle v1 Name
Get Distribution Status Details by Release Bundle v1 Version
Get Distribution Status Details by Tracker Id
Get the Open Metrics for Distribution
Distribution Open Metrics Support
AIR GAP ENVIRONMENT
Export Release Bundle v1 Version Archived File
Get Exported Release Bundle v1 Version Status
Delete Exported Release Bundle v1 Archive File
Import Release Bundle Version
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
Generate Unlock Stuck Tasks Token
Unlock Stuck Tasks
XRAY
Triggers Xray Release Bundle Version Indexing
ERROR RESPONSES
Pipelines REST APIs
Introduction to the Pipelines REST APIs
Common Optimization Parameters
Pagination Parameters
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
Get a Project Integration
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
JFrog Curation REST APIs
Approved/Blocked Audit
Get Approved/Blocked Audit Logs API
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
AQL Architecture
AQL Supported Domains
AQL Syntax
Using Fields in AQL
AQL Execution
AQL Entities and Fields
Search Criteria Construction
Field Criteria
Properties Criteria
Compounding Criteria
Match Criteria on a Single Property ($msp)
Comparison Operators
Using Wildcards
Date and Time Format in AQL
Relative Time Operators in AQL
Specify Output Fields
Display All Fields
Display Specific Fields
Users Without Admin Privileges
Filtering Properties by Key
Sorting in AQL
Display Limits and Pagination
Using AQL With Remote Repositories
Examples of Searching in Remote Repositories with AQL
Using AQL With Virtual Repositories
GraphQL
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
Watch the Tutorial

Back to home page