Try JFrog
Contact Support
JFrog.com
Jump to Content
Guides
Recipes
API Reference
Changelog
Discussions
Contact Support
Try JFrog
API Reference
Contact Support
Try JFrog
Guides
Recipes
API Reference
Changelog
Discussions
Create Token API Examples
All
Pages
Start typing to search…
JUMP TO
JFrog Platform REST APIs
Users
Get User Details
get
Update a User (Partial Update)
patch
Delete User
del
Get User List
get
Query Strings
Create User
post
Add or Remove User from Groups
patch
Change a User Password
put
Set User Password as Expired
post
Unlock User
post
Expire Password for All Users
post
Un-Expire Password for All Users
post
Groups
Create or Replace Group
put
Get Group Details
get
Group Update
patch
Delete a Group
del
Get a List of Groups
get
Create a Group
post
Add or Remove a Group Member
patch
Permissions
Create Permission
post
Get Permissions
get
Get Permission Details by Permission Name
get
Delete Permission
del
Get Permission Resource Based on Permission Name and Resource Type
get
Replace Permission Resource Based on Permission Name and Resource Type
put
Update Permission Resource Based on Permission Name and Resource Type
patch
Delete Permission Resource Based on Permission Name and Resource Type
del
Access
AWS IAM
PUT AWS IAM Role
put
GET AWS IAM Role
get
DELETE IAM ROLE
del
Backup
Export Access Configuration
post
Import Access Configuration
post
Vault
Set the Vault Configuration
put
Delete the Secret Manager Configuration
del
Get the Secret Manager Configurations
get
Test the Vault Configuration
post
Password Policy
Create Password Policy
put
Update Password Policy
patch
Certificates
Get Root Certificate
get
Get CA Public Certificate
get
System
Ping Request
get
Enable Cloud Log Collection
post
OIDC
Create OIDC Configuration
post
Get all OIDC Configuration
get
Update OIDC Configuration
put
Get OIDC Configuration
get
Delete OIDC Configuration
del
Create an Identity Mapping
post
Get all Identity Mappings by Provider Name
get
Get Identity Mappings by Mapping Name
get
Update OIDC Identity Mapping
put
Delete Identity Mapping
del
OIDC Token Exchange
post
SCIM
Get Resource Types
get
Get Schemas
get
Get Schema by ID
get
Get Service Provider Configuration
get
GET Users (SCIM)
get
CREATE Users (SCIM)
post
GET Specific User (SCIM)
get
UPDATE User (SCIM)
put
DISABLE User (SCIM)
patch
DELETE User (SCIM)
del
Get Groups (SCIM)
get
Create Group (SCIM)
post
Get Group by Name (SCIM)
get
Update Group (SCIM)
put
Patch Group (SCIM)
patch
Delete Group (SCIM)
del
Access Federation
Get All Access Federations
get
Register Access Federation
post
Get Access Federation
get
Update Access Federation
patch
Delete Access Federation
del
Validate Target for Circle of Trust
post
Full Broadcast Access Federation
put
Access Tokens
Create Token
post
Recommended Configurations
Create Scoped Token
Create Token API Examples
Get Tokens
get
Get Token by ID
get
Revoke Token by ID
del
Revoke Token by Value
del
Get Token Default Expiry Value
get
Put Token Default Expiry Value
put
Create Pairing Token
post
Initiate Pairing
put
Get Pairings
get
Revoke Pairing
del
Webhooks
Get the List of all Webhook Subscriptions
get
Create a New Webhook Subscription
post
Get a Webhook Subscription by Key
get
Update Webhook Subscription by Key
put
Delete Webhook Subscription by Key
del
Test Webhook Subscription
post
Stream All Troubleshooting Data
get
Authentication Providers
Import or Update LDAP Group Settings
post
Get SAML Settings by Name
get
Get SAML Configuration
get
Create SAML Configuration
post
Update SAML Configuration
put
Delete SAML Configuration
del
Get SAML Service Provider Metadata
get
Get SAML Service Provider Certificate
get
Generate SAML Service Provider Certificate
post
Get All LDAP Settings
get
Create LDAP Settings
post
Get LDAP Settings by Key
get
Update LDAP Settings
put
Delete LDAP Settings
del
Test LDAP Connection
post
Get All LDAP Group Settings
get
Create LDAP Group Settings
post
Get LDAP Group Settings by Name
get
Update LDAP Group Settings
put
Delete LDAP Group Settings
del
Get HTTP SSO Configuration
get
Update HTTP SSO Configuration
put
Delete HTTP SSO Configuration
del
Get Crowd Configuration
get
Create Crowd Configuration
post
Update Crowd Configuration
put
Delete Crowd Configuration
del
Test Crowd Connection
post
Environments
Create Global Environment
post
Get Global Environments
get
Rename a Global Environment
post
Delete Global Environment
del
Create Project Environment
post
Get Project Environments
get
Rename a Project Environment
post
Delete Project Environment
del
Workers
Create Worker
post
Get Workers
get
Update Worker
put
Get Specified Worker
get
Delete Worker
del
Get Available Actions
get
Get Actions Metadata
get
Execute Test
post
Execute Test for Worker
post
Workers Service Readiness
get
Workers Service Liveness
get
Get Worker Execution History
get
Execute an HTTP-Triggered Worker
post
Rerun Worker
post
List of Worker Events
Mission Control
Import Mission Control Data
put
Upload Bucket
post
Add JPD
post
Get JPD List
get
Get JPD by id
get
Update JPD
put
Delete JPD
del
Get Buckets
get
Delete Bucket
del
Get Bucket Status
get
Attach License
post
Acquire License
post
Release License
post
Get Access Federation Configuration for a Single JPD
get
Configure Access Federation on a JPD
put
Get Access Federation Configuration for All JPDs
get
Get Access Federation Candidates
get
Export Mission Control Configuration
put
System Health Check
get
Artifactory System
Artifactory Ping
get
Readiness Probe
get
Liveness Probe
get
Get Artifactory Version
get
Get System Info
get
Verify Connection
post
Update Custom URL Base
put
Get System Configuration
get
Apply Artifactory YAML Configuration Changes
patch
Save General Configuration
post
Get License Information
get
Install License
post
Get HA License Information
get
Install HA Cluster Licenses
post
Delete HA Cluster License
del
Get Reverse Proxy Configuration
get
Possible Values for dockerReverseProxyMethod
Update Reverse Proxy Configuration
post
Get Reverse Proxy Snippet
get
Start SHA256 Migration Task
post
Stop SHA256 Migration Task
post
Re-index Paths on Metadata Server
post
Support Bundle
Create Support Bundle
post
Create Specific Support Bundle
put
Get Support Bundle Info
get
Delete Support Bundle
del
Get Support Bundle
get
List Support Bundles
get
Global Roles
Create a Custom Global Role
post
Get All Custom Global Roles
get
Get a Specific Custom Global Role
get
Edit a Global Role
put
Delete a Custom Global Role
del
MyJFrog Portal
Private Link
Get Private Links by Server Name
get
Get Servers by Private Link ID
get
Add Private Link to Servers
post
Fix Private Link
post
Delete Private Link from Servers
del
Private Link Status Values
Custom Domain
Get SSL Objects
get
Create SSL Object
post
Delete SSL Object
del
Renew SSL Object
post
Validate SSL Object
post
Manage Domain
post
IP Allowlist
Get the JPD IP Allowlist
get
Add IP to IP Allowlist
post
Delete IP from IP Allowlist
del
Platform Info
GET Platform Cloud NAT IPs
get
Get Available Regions by Cloud Provider
get
Get JFrog Server List
get
GET MyJFrog Usage Data
get
Bridge
Bridge Server
Bridge Server Liveness Check
get
Bridge Server Readiness Check
get
Get Bridge Server Metrics
get
Reset Bridge Connections at Server
post
Block a Bridge at the Bridge Server
put
Unblock a Bridge at the Bridge Server
del
Get Bridge Server Blacklist
get
Get Bridge Server Debug Snapshot
get
Bridge Client
Bridge Client Liveness Check
get
Bridge Client Readiness Check
get
Establish Bridge Trust Pairing
put
Define a New Bridge
post
Modify Bridge Configuration
patch
Delete a Bridge
del
Get Bridge Configuration
get
Reset Active Bridge Connections
post
Stop a Bridge at the Bridge Client
post
Restart a Bridge at the Bridge Client
post
Get Bridge Client Debug Snapshot
get
Get Bridge Client Metrics
get
Create Support Bundle
post
JFConnect
Health
JFConnect Readiness
get
JFConnect Liveness
get
JFConnect Health Ping
get
Platform Info
JFConnect GET JPD ID
get
JFConnect GET Service ID
get
Entitlements
Post Offline Request Token to JFrog Entitlements Service
post
JFConnect Apply Entitlements to an Air-Gapped JPD
post
Registration
JFConnect Start Register for Air-gapped JPD
post
Storage and Archive
Smart Archiving Policies
Create Smart Archiving Policy
post
Get Single Smart Archiving Policy by Key
get
Update Smart Archiving Policy
put
Delete Smart Archiving Policy
del
Get All Smart Archiving Policies
get
Disable All Smart Archiving Policies
put
View Smart Archiving Policies
get
Enable/Disable Smart Archiving Policy
post
Run Smart Archiving Policy
put
Download Smart Archiving Policy Run Report
get
View Smart Archiving Policy Run Summary Report
get
Stop All Running Smart Archiving Policies
put
Stop Running Smart Archiving Policy
put
Restore Archived Packages
post
Archive Policies
Create an Archive Policy
post
Update an Archive Policy
put
Get an Archive Policy
get
Delete an Archive Policy
del
Get All Archive Policies
get
Run an Archive Policy
post
Stop Policy Execution
post
Preview Retention Policy by Policy Key
post
Preview Retention Policy by Policy Model
post
Convert Search Criteria Form to AQL
post
Search for Archives
post
Search for Package Archives
post
Get Namespace
get
Restore from Archive
post
Get Archive Policy Status
get
Get Restore Process Status
get
JFrog Platform - System & Configuration API
System
Get Status of Disable Basic Authentication
get
Enable or Disable Basic Authentication
put
Health Check
get
JFrog Artifactory Cleanup Policies API
Package Cleanup Policies
Create a Package Cleanup Policy
post
Update a Package-Level Cleanup Policy
put
Get Single Package Cleanup Policy by Key
get
Delete Package Cleanup Policy
del
Get all Package Cleanup Policies
get
Enable/Disable a Package Cleanup Policy
post
Manually Run Package Cleanup Policy
put
Release Bundle Cleanup Policies
Get All Cleanup Bundle Policies
get
Create a Release Bundle Cleanup Policy
post
Update Release Bundle Cleanup Policy
put
Get Single Release Bundle Cleanup Policy by Key
get
Delete Release Bundle Cleanup Policy
del
Enable/Disable Release Bundle Cleanup Policy
post
Manually Run Release Bundle Cleanup Policy
put
Build Cleanup Policies
Get All Build Cleanup Policies
get
Create Build Cleanup Policy
post
Update Build Cleanup Policy
put
Get Single Build Cleanup Policy by Key
get
Delete Build Cleanup Policy
del
Enable/Disable Build Cleanup Policy
post
Manually Run Build Cleanup Policy
put
Common Cleanup Policies
Stop a Running Cleanup Policy
put
Stop All Running Cleanup Policies
put
Disable All Cleanup Policies
put
Get All Cleanup Policies View
get
Get Policy Runs View
get
Get Run Details by Trigger ID
get
Download Cleanup Policy Run Report
get
View Cleanup Policy Run Summary Report
get
Powered by
JFrog Platform REST APIs
Access
Access Tokens
Create Token API Examples
