# User Management Documentation > Documentation for User Management ## Guides - [Getting Started with JFrog User Management](https://docs.jfrog.com/user-management/docs/getting-started.md): Manage your personal identity, security credentials, and account settings within the JFrog Platform. - [User Profile](https://docs.jfrog.com/user-management/docs/user-profile.md) - [Manage User Profile](https://docs.jfrog.com/user-management/docs/manage-user-profile.md) - [Identity Tokens](https://docs.jfrog.com/user-management/docs/identity-tokens.md) - [API Key](https://docs.jfrog.com/user-management/docs/api-key.md) # Project Management Documentation > Documentation for Project Management ## Guides - [Get Started with Projects ](https://docs.jfrog.com/projects/docs/projects.md): Centralize your software resources and access controls into project-based environments for enterprise-scale DevOps agility. - [View Projects in the JFrog Platform](https://docs.jfrog.com/projects/docs/view-projects-in-the-jfrog-platform.md) - [Projects Subscription Allocation](https://docs.jfrog.com/projects/docs/projects-subscription-allocation.md) - [Projects Concepts and Terminology](https://docs.jfrog.com/projects/docs/projects-concepts-and-terminology.md) - [Basic Projects Terminology](https://docs.jfrog.com/projects/docs/basic-projects-terminology.md) - [Xray Terminology and Concepts in Projects](https://docs.jfrog.com/projects/docs/xray-terminology-and-concepts-in-projects.md) - [Project Roles and Members Concepts](https://docs.jfrog.com/projects/docs/project-roles-and-members-concepts.md) - [Global and Project Role Types](https://docs.jfrog.com/projects/docs/global-and-project-role-types.md) - [Project-Supported Actions by Role Types](https://docs.jfrog.com/projects/docs/project-supported-actions-by-role-types.md) - [Platform Administrator Role](https://docs.jfrog.com/projects/docs/platform-administrator-role.md) - [Global Roles for Projects](https://docs.jfrog.com/projects/docs/global-roles-for-projects.md) - [Project Admin Role](https://docs.jfrog.com/projects/docs/project-admin-role.md) - [Project Roles](https://docs.jfrog.com/projects/docs/project-roles.md) - [Projects Best Practices](https://docs.jfrog.com/projects/docs/projects-best-practices.md) - [Projects Setup Best Practices](https://docs.jfrog.com/projects/docs/projects-setup-best-practices.md) - [Projects Migration Best Practices](https://docs.jfrog.com/projects/docs/projects-migration-best-practices.md) - [Create a Project](https://docs.jfrog.com/projects/docs/create-a-project.md) - [Assign Members to a Project](https://docs.jfrog.com/projects/docs/step-2-assign-members-to-a-project.md) - [Assign Resources to a Project](https://docs.jfrog.com/projects/docs/step-3-add-or-assign-resources-to-projects.md) - [Dedicated Project REST APIs](https://docs.jfrog.com/projects/docs/dedicated-project-rest-apis.md) - [Manage Project Roles and Members](https://docs.jfrog.com/projects/docs/manage-project-roles-and-members.md) - [Manage Global Roles](https://docs.jfrog.com/projects/docs/manage-global-roles.md) - [Manage Project Roles](https://docs.jfrog.com/projects/docs/manage-project-roles.md) - [Manage Projects](https://docs.jfrog.com/projects/docs/manage-projects.md) - [View Projects in a Dashboard View](https://docs.jfrog.com/projects/docs/view-projects-in-a-dashboard-view.md) - [Modify a Project](https://docs.jfrog.com/projects/docs/modify-a-project.md) - [Manage Storage Quotas](https://docs.jfrog.com/projects/docs/manage-storage-quotas.md) - [Share Repositories Across Multiple Projects](https://docs.jfrog.com/projects/docs/share-repositories-across-multiple-projects.md) - [Change Repository Ownership from Project to Project](https://docs.jfrog.com/projects/docs/change-repository-ownership-from-project-to-project.md) - [Assign Multiple Projects to Resources](https://docs.jfrog.com/projects/docs/assign-multiple-projects-to-resources.md) - [Unassign Repository from a Project](https://docs.jfrog.com/projects/docs/unassign-repository-from-a-project.md) - [Unshare Repositories Across Projects](https://docs.jfrog.com/projects/docs/unshare-repositories-across-projects.md) - [Remove a Project Member](https://docs.jfrog.com/projects/docs/remove-a-project-member.md) - [Remove a Project Group](https://docs.jfrog.com/projects/docs/remove-a-project-group.md) - [Delete a Project](https://docs.jfrog.com/projects/docs/delete-a-project.md) - [Project Creation Tasks](https://docs.jfrog.com/projects/docs/project-creation-tasks.md) - [Project Management Tasks](https://docs.jfrog.com/projects/docs/project-management-tasks.md) - [Project User Management Tasks](https://docs.jfrog.com/projects/docs/project-user-management-tasks.md) ## API Reference - [Get Projects List](https://docs.jfrog.com/projects/reference/getprojectslist.md): Returns all projects the requesting user manages. Platform Admin users can view all projects; non-admin users can only view projects they manage. **Availability:** Artifactory 7.117.5+. **Security:** Requires a valid token or a scoped token with `project::r` scope. - [Create Project](https://docs.jfrog.com/projects/reference/createproject.md): Creates a new project. **Security:** Requires Platform Admin privileges. - [Get Projects List for a Global Role](https://docs.jfrog.com/projects/reference/getprojectsforrole.md): Returns a list of projects where a specific global role is used. **Availability:** Artifactory 7.117.0+ **Security:** Requires Platform Admin privileges. - [Get Project](https://docs.jfrog.com/projects/reference/getproject.md): Returns the requested project. **Security:** Requires Platform Admin or Project Admin privileges. - [Update Existing Project Properties](https://docs.jfrog.com/projects/reference/updateproject.md): Updates an existing project's properties. **Security:** Requires Platform Admin privileges. - [Delete Existing Project](https://docs.jfrog.com/projects/reference/deleteproject.md): Deletes an existing project. **Security:** Requires Platform Admin privileges. - [Get Project Users](https://docs.jfrog.com/projects/reference/getprojectusers.md): Returns all users associated with the project. **Security:** Requires Platform Admin, Project Admin with Manage Members privilege, or a scoped token with `project:/members/**:r` scope. - [Get Project User](https://docs.jfrog.com/projects/reference/getprojectuser.md): Returns the requested user associated with the project. **Security:** Requires Platform Admin or Project Admin with Manage Members privilege. - [Add or Update User in Project](https://docs.jfrog.com/projects/reference/addorupdateprojectuser.md): Adds or updates a user in a project. **Security:** Requires Platform Admin or Project Admin with Manage Members privilege. - [Delete Existing Project's User](https://docs.jfrog.com/projects/reference/deleteprojectuser.md): Deletes an existing project's user. **Security:** Requires Platform Admin or Project Admin with Manage Members privilege. - [Get Projects Groups](https://docs.jfrog.com/projects/reference/getprojectgroups.md): Returns all groups associated with the project. **Security:** Requires Platform Admin or Project Admin with Manage Members privilege. - [Get Projects Group](https://docs.jfrog.com/projects/reference/getprojectgroup.md): Returns the requested group associated with the project. **Security:** Requires Platform Admin or Project Admin with Manage Members privilege. - [Update Group in Project](https://docs.jfrog.com/projects/reference/updateprojectgroup.md): Updates the group in the project. **Security:** Requires Platform Admin or Project Admin with Manage Members privilege. - [Delete Existing Project's Group](https://docs.jfrog.com/projects/reference/deleteprojectgroup.md): Deletes the existing project group. **Security:** Requires Platform Admin or Project Admin with Manage Members privilege. - [Get Roles List](https://docs.jfrog.com/projects/reference/getprojectroles.md): Returns all project roles. **Security:** Requires Platform Admin or Project Admin privileges. - [Create Role](https://docs.jfrog.com/projects/reference/createprojectrole.md): Adds a new role to the project. **Security:** Requires Platform Admin or Project Admin with Manage Members privilege. - [Get Project Role](https://docs.jfrog.com/projects/reference/getprojectrole.md): Returns the requested project role. **Security:** Requires Platform Admin or Project Admin privileges. - [Update an Existing Project Role](https://docs.jfrog.com/projects/reference/updateprojectrole.md): Updates an existing project role. **Security:** Requires Platform Admin or Project Admin with Manage Members privilege. - [Delete an Existing Role](https://docs.jfrog.com/projects/reference/deleteprojectrole.md): Deletes an existing project role. **Security:** Requires Platform Admin or Project Admin with Manage Members privilege. - [Move Repository in a Project](https://docs.jfrog.com/projects/reference/attachrepositorytoproject.md): If not assigned, assigns a repository to a project. If already assigned, moves the project repository to the specified location, and unassigns the repository from the previous project. **Note:** When you assign a resource to a project, the project owns and manages the resource. When you share a resource with a project, the project does not own the resource. **Security:** Requires Platform Admin privileges. - [Get Status of Project Repository](https://docs.jfrog.com/projects/reference/getprojectrepositorystatus.md): Returns the status of a repository and whether it was assigned and/or shared to a project, to multiple projects, or to all projects. **Note:** When you assign a resource to a project, the project owns and manages the resource. When you share a resource with a project, the project does not own the resource. **Security:** Requires Platform Admin privileges. - [Share Repository with All Projects](https://docs.jfrog.com/projects/reference/sharerepositorywithallprojects.md): Shares a local or remote repository across all projects, allowing members in more than one project to access the repository. Project members are granted actions according to their roles in the target project. **Note:** When you assign a resource to a project, the project owns and manages the resource. When you share a resource with a project, the project does not own the resource. **Security:** Requires Platform Admin privileges. - [Share Repository with Target Project](https://docs.jfrog.com/projects/reference/sharerepositorywithtargetproject.md): Shares a local or remote repository with a specific target project. Project members of the target project are granted actions according to their roles in the target project. **Note:** When you assign a resource to a project, the project owns and manages the resource. When you share a resource with a project, the project does not own the resource. **Security:** Requires Platform Admin privileges. - [Unshare Repository with All Projects](https://docs.jfrog.com/projects/reference/unsharerepositorywithallprojects.md): Unshares a shared local or remote repository. The repository is not deleted but remains assigned to the source project. **Security:** Requires Platform Admin privileges. - [Unshare Repository with Target Project](https://docs.jfrog.com/projects/reference/unsharerepositorywithtargetproject.md): Unshares a local or remote repository with a specific target project. **Security:** Requires Platform Admin privileges. - [Unassign a Project from a Repository](https://docs.jfrog.com/projects/reference/unassignprojectfromrepository.md): Unassigns a project from a repository. **Note:** You can assign a project to a repository using the Move Repository operation. **Security:** Requires Platform Admin privileges. # Self-Managed Installation Documentation > Documentation for Self-Managed Installation ## Guides - [Platform Installation with Helm](https://docs.jfrog.com/installation/docs/install-jfrog-platform-via-helm-quick-start.md): Deploy the JFrog Platform via a single Helm Chart. Artifactory and Xray are available by default. Other products (Distribution, Catalog, Worker, Bridge, AppTrust) require configuration in `customvalues.yaml`. Includes evaluation and production installation paths. - [Get Started with JFrog Platform Installation](https://docs.jfrog.com/installation/docs/getting-started.md): Choose your first-time JFrog Platform installation path: quick evaluation or production-grade deployment workflow. - [New To JFrog](https://docs.jfrog.com/installation/docs/new-to-jfrog.md): New to JFrog: learn platform basics, run an evaluation installation, and plan your production deployment. - [Choose Your Installation Path](https://docs.jfrog.com/installation/docs/choose-your-installation-path.md): Choose between Helm (Kubernetes/OpenShift) and Ansible (VMs/bare-metal) installation methods based on your infrastructure. - [Why Platform Helm Chart?](https://docs.jfrog.com/installation/docs/why-platform-helm-chart.md): Helm chart provides all products, unified config, and native Kubernetes support. Compare with Ansible and standalone installers. - [Installation & Configuration](https://docs.jfrog.com/installation/docs/installation-configuration.md): Install JFrog Platform on Kubernetes, Linux VMs, Docker, or Windows. Covers all methods, databases, and storage options. - [Platform Installation](https://docs.jfrog.com/installation/docs/installing-the-jfrog-platform.md): Deploy the full JFrog Platform via Helm (Kubernetes) or Ansible (VMs) with Artifactory, Xray, and Distribution. - [Platform Ansible Installation [Quick Start]](https://docs.jfrog.com/installation/docs/install-jfrog-platform-via-ansible-quick-start.md): Deploy JFrog Platform on Linux VMs using the jfrog.platform Ansible collection. Supports evaluation and production topologies. - [Platform Installation with Helm Charts](https://docs.jfrog.com/installation/docs/install-the-jfrog-platform-using-helm-chart.md): Install and configure JFrog Platform Helm chart: licenses, enable products, configure external PostgreSQL database. - [Platform Installation with Ansible](https://docs.jfrog.com/installation/docs/install-the-jfrog-platform-using-ansible.md): Configure JFrog Platform using Ansible: Vault encryption, Artifactory HA, external PostgreSQL, TLS/mTLS with NGINX. - [Helm Charts for Advanced Use Cases](https://docs.jfrog.com/installation/docs/helm-charts-for-advanced-users.md): Advanced Helm chart customizations for JFrog Platform: storage, TLS, HA, plugins, databases, and infrastructure settings. - [All Products - Customization](https://docs.jfrog.com/installation/docs/all-products-customization.md): Customize all JFrog Helm products: TLS, custom volumes, sidecars, init containers, secrets, system.yaml, Circle of Trust certs. - [Auto-generated Passwords (Internal PostgreSQL)](https://docs.jfrog.com/installation/docs/auto-generated-passwords-internal-postgresql.md): Manage auto-generated PostgreSQL passwords for JFrog Helm deployments: set, retrieve, and pass during upgrades. - [Custom Volumes in Helm Installation](https://docs.jfrog.com/installation/docs/add-custom-volumes-in-helm-installation.md): Mount Kubernetes volumes to JFrog pods using customVolumes and customVolumeMounts in Helm values.yaml. - [Custom Sidecar Containers in Helm Installations](https://docs.jfrog.com/installation/docs/add-custom-sidecars-containers-in-helm-installations.md): Add sidecar containers to JFrog Helm deployments for log shipping, monitoring, and auxiliary services. - [Custom Init Containers in Helm Installation](https://docs.jfrog.com/installation/docs/add-custom-init-containers-in-helm-installation.md): Add init containers to JFrog Helm deployments to run pre-startup tasks: configuration, secrets, file system setup. - [Use Custom Secrets in Helm Installation](https://docs.jfrog.com/installation/docs/use-custom-secrets-in-helm-installation.md): Store encrypted credentials in JFrog Helm deployments using Kubernetes secrets via customSecrets in values.yaml. - [Override the Default System YAML File in Helm Installation](https://docs.jfrog.com/installation/docs/override-the-default-system-yaml-file-in-helm-installation.md): Override system.yaml in Helm deployments using extraSystemYaml, extraEnvironmentVariables, or systemYamlOverride secret. - [Establish TLS in Artifactory and JFrog Platform](https://docs.jfrog.com/installation/docs/establish-tls-in-artifactory-and-jfrog-platform.md): Enable TLS encryption between JFrog Platform nodes: configure Access CA, certificates, Kubernetes service SANs, and Nginx. - [Circle of Trust Certificates](https://docs.jfrog.com/installation/docs/add-circle-of-trust-certificates.md): Configure Circle of Trust root certificates in JFrog Helm deployments via Kubernetes secrets. - [Use Unified Secret in Helm Installation](https://docs.jfrog.com/installation/docs/use-unified-secret-in-helm-installation.md): Consolidate all JFrog Helm secrets into a single unified secret by enabling the unifiedSecretInstallation flag. - [Artifactory Advanced Options](https://docs.jfrog.com/installation/docs/artifactory-advanced-options.md): Configure Artifactory Helm deployments: storage, licenses, security, load balancer, logs, extensions, JVM, and databases. - [Artifactory License Installation with Kubernetes Secrets](https://docs.jfrog.com/installation/docs/add-licenses-using-secrets.md): Install Artifactory licenses via Kubernetes secrets: reference an existing secret or create one during Helm release. - [Security-related Issues](https://docs.jfrog.com/installation/docs/security-related-issues.md): Secure Artifactory Helm deployments: customize database password, manage Kubernetes secrets, and configure network policies. - [Ingress Behind Another Load Balancer](https://docs.jfrog.com/installation/docs/run-ingress-behind-another-load-balancer.md): Configure Nginx Ingress for Artifactory Helm deployments behind an external load balancer with TLS offloading. - [Log Analytics](https://docs.jfrog.com/installation/docs/log-analytics.md): Configure Artifactory Helm log analytics: FluentD, Prometheus, and Grafana metrics gathering with network policies. - [Advanced Storage Options](https://docs.jfrog.com/installation/docs/advanced-storage-options.md): Configure Artifactory Helm filestore: file-system, NFS, S3, GCS, Azure Blob, external databases, and custom binarystore settings. - [Extensions Configuration](https://docs.jfrog.com/installation/docs/add-extensions.md): Extend Artifactory Helm deployments with plugins: logger sidecars, user plugins, JMX metrics, and custom integrations. - [Infrastructure Customization](https://docs.jfrog.com/installation/docs/infrastructure-customization.md): Configure Artifactory Helm resource requests and limits: memory, CPU, and JVM settings (xms, xmx) for all components. - [Use ConfigMaps to Store Non-confidential Data](https://docs.jfrog.com/installation/docs/use-configmaps-to-store-non-confidential-data.md): Use Kubernetes ConfigMaps in Artifactory Helm to mount config files: logback.xml, mimetypes.xml, and init scripts. - [External Database for Artifactory Helm Installation](https://docs.jfrog.com/installation/docs/use-an-external-database-with-artifactory-helm-installation.md): Use external PostgreSQL with Artifactory Helm: disable internal PostgreSQL, set custom JDBC URL, user, and password. - [Artifactory Bootstrap](https://docs.jfrog.com/installation/docs/bootstraps-artifactory.md): Bootstrap Artifactory Helm admin credentials and initial configuration automatically during deployment via values.yaml. - [Monitoring and Logging for Artifactory Helm Installation](https://docs.jfrog.com/installation/docs/monitoring-and-logging-in-artifactory-helm-installation.md): Monitor Artifactory Helm deployments via JMX MBeans: enable JMX, configure ports, and monitor pools, repositories, and storage. - [Artifactory and Artifactory HA Installation with Nginx SSL Termination](https://docs.jfrog.com/installation/docs/install-artifactory-and-artifactory-ha-with-nginx-and-terminate-ssl-in-nginx-service-load-balancer.md): Install Artifactory or Artifactory HA with Nginx via Helm and terminate SSL at the LoadBalancer layer using AWS ACM or custom certs. - [readOnlyRootFilesystem Configuration in Artifactory Containers](https://docs.jfrog.com/installation/docs/configure-readonlyrootfilesystem-in-artifactory-containers.md): Enable readOnlyRootFilesystem security context in Artifactory Helm containers (v7.111+) to prevent unauthorized file modifications. - [Memory Target Trigger for Artifactory Charts with HPA](https://docs.jfrog.com/installation/docs/add-memory-target-trigger-to-artifactory-charts-using-hpa.md): Configure Artifactory Helm HPA autoscaling with memory target trigger (v7.111+): minReplicas, maxReplicas, and metrics settings. - [Configure Nginx Service and Load Balancer for Helm](https://docs.jfrog.com/installation/docs/configure-nginx-service-load-balancer-helm.md): Configure the Kubernetes service type, load balancer IP, source ranges, external traffic policy, and cloud-provider annotations for Artifactory Helm deployments. - [Artifactory High Availability](https://docs.jfrog.com/installation/docs/artifactory-high-availability.md): Configure Artifactory HA Helm deployments: storage backends, licenses, scaling, persistent volume claims, shared storage. - [Artifactory Storage](https://docs.jfrog.com/installation/docs/artifactory-storage.md): Configure Artifactory HA storage backends in Helm: file-system replication, S3, GCS, Azure Blob, or NFS. - [License Configuration for Artifactory HA Helm Installation](https://docs.jfrog.com/installation/docs/add-licenses-with-artifactory-ha-helm-installation.md): Activate Artifactory HA by installing licenses via UI, REST API, or Kubernetes secrets during Helm installation. - [Scale the Artifactory HA Helm Installation Cluster](https://docs.jfrog.com/installation/docs/scale-the-artifactory-ha-helm-installation-cluster.md): Scale Artifactory HA Helm cluster by setting artifactory.primary.replicaCount. Manage PostgreSQL password during scaling. - [Existing Shared Volume Claim for Artifactory HA Helm Installation](https://docs.jfrog.com/installation/docs/use-an-existing-shared-volume-claim-with-artifactory-ha-helm-installation.md): Configure Artifactory HA Helm to use shared ReadWriteMany PVCs for data and backup across all nodes. - [Existing Volume Claim for Artifactory HA Helm Installation](https://docs.jfrog.com/installation/docs/use-an-existing-volume-claim-for-artifactory-ha-helm-installation.md): Use existing PersistentVolumeClaims for Artifactory HA Helm primary and member node storage. - [Advanced Options for Xray](https://docs.jfrog.com/installation/docs/advanced-options-for-xray.md): Configure Xray Helm deployments: RabbitMQ TLS/non-TLS, custom storage, split topology, external database. - [TLS Configuration in RabbitMQ for Xray Helm Chart](https://docs.jfrog.com/installation/docs/enable-tls-in-rabbitmq-in-xray-helm-chart.md): Enable RabbitMQ TLS in Xray Helm chart (v3.78.10+) with autogenerated or custom certificates via values.yaml. - [RabbitMQ TLS Configuration for Xray (Platform Helm)](https://docs.jfrog.com/installation/docs/enable-tls-in-rabbitmq-for-xray-in-jfrog-platform-chart.md): Enable RabbitMQ TLS for Xray in JFrog Platform chart (v10.14.1+) with global and rabbitmq TLS settings. - [Disable TLS in RabbitMQ for Xray in JFrog Platform Chart](https://docs.jfrog.com/installation/docs/disable-tls-in-rabbitmq-for-xray-in-jfrog-platform-chart.md): Disable RabbitMQ TLS for Xray in JFrog Platform chart by setting global.rabbitmq.auth.tls.enabled and rabbitmq.auth.tls.enabled to false. - [Distribution Custom Volumes](https://docs.jfrog.com/installation/docs/distribution-custom-volumes.md): Mount custom volumes in Distribution Helm deployments via customVolumes and customVolumeMounts in values.yaml. - [System Architecture](https://docs.jfrog.com/installation/docs/system-architecture.md): JPD microservices architecture: each product runs with local services and a Router for API gateway and inter-service discovery. - [Checksum-Based Storage](https://docs.jfrog.com/installation/docs/checksum-based-storage.md): Artifactory stores artifacts by SHA1 checksum in two-character subdirectories with database mappings for deduplication. - [Checksum-Based Storage Implementation](https://docs.jfrog.com/installation/docs/checksum-based-storage-implementation.md): Artifactory checksum storage implements deduplication, atomic deployment, and database-driven copy/move/delete operations. - [SHA-256 Support](https://docs.jfrog.com/installation/docs/sha-256-support.md): Artifactory calculates and stores SHA-256 checksums at deployment for use in AQL queries, REST APIs, and integrity verification. - [High Availability](https://docs.jfrog.com/installation/docs/high-availability.md): Configure an Artifactory HA cluster of 2+ nodes on the same LAN. Requires an external database and Enterprise X/+ license. - [Cloud-Native High Availability](https://docs.jfrog.com/installation/docs/cloud-native-high-availability.md): Cloud-Native HA (Artifactory 7.17.4+): any node can execute cluster-wide tasks by setting taskAffinity to "any". - [HA Architecture](https://docs.jfrog.com/installation/docs/ha-architecture.md): JFrog Platform HA architecture: load balancer, multiple application nodes, shared external database and storage. - [Artifactory Clustering](https://docs.jfrog.com/installation/docs/clustering-artifactory.md): Deploy Active/Active cluster for full HA or Active/Passive for fast disaster recovery on fault-tolerant shared storage. - [Products Container Base Image](https://docs.jfrog.com/installation/docs/jfrog-products-container-base-image.md): JFrog container images use Red Hat UBI Micro base with net-tools, curl, tar, and zip for lightweight secure deployments. - [System Directories](https://docs.jfrog.com/installation/docs/system-directories.md): JFrog directory structure: $JFROG_HOME contains app (immutable binaries) and var (mutable configs/data) subdirectories. - [$JFROG_HOME Directory](https://docs.jfrog.com/installation/docs/jfrog-home.md): $JFROG_HOME is the root directory for all JFrog products, containing app and var subdirectories for each product. - [Application Directory](https://docs.jfrog.com/installation/docs/application-directory.md): The app directory holds immutable product binaries and default configs at $JFROG_HOME//app across all install types. - [Data Directory](https://docs.jfrog.com/installation/docs/data-directory.md): The var directory holds mutable configs, generated data, and logs at $JFROG_HOME//var across all install types. - [Generic Directory Layout](https://docs.jfrog.com/installation/docs/generic-directory-layout.md): All JFrog products share $JFROG_HOME//app for binaries and /var for configs, data, and logs. - [Artifactory Product](https://docs.jfrog.com/installation/docs/jfrog-artifactory-product.md): Artifactory microservices overview: 15+ services including Artifactory Service, Router, Access, Metadata, Topology, and Event. - [Artifactory Federation Service (RTFS)](https://docs.jfrog.com/installation/docs/artifactory-federation-service-rtfs.md): Artifactory Federation Service (RTFS) synchronizes federated repository metadata across multiple JPD sites asynchronously. - [Evidence Service](https://docs.jfrog.com/installation/docs/evidence-service.md): Attach signed evidence attestations to artifacts, builds, packages, and Release Bundle v2 for compliance audit trails. - [JFConnect Microservice](https://docs.jfrog.com/installation/docs/jfconnect-microservice.md): JFConnect syncs entitlements from jes.jfrog.io and uploads usage to jcs.jfrog.io for license management. - [Individual JVM for Access Service](https://docs.jfrog.com/installation/docs/individual-jvm-for-access-service.md): Configure Access service on a dedicated JVM (Artifactory 7.90+) with separate memory allocation via access.extraJavaOpts. - [IPv6 Support](https://docs.jfrog.com/installation/docs/ipv6-support.md): Configure IPv6 context.url in ha-node.properties using bracket-enclosed addresses for Artifactory node-to-node communication. - [Xray Service](https://docs.jfrog.com/installation/docs/jfrog-xray-service.md): Xray service contains Indexer, Persist, Analysis, Server, Policy Enforcer, and SBOM microservices. - [Distribution Service](https://docs.jfrog.com/installation/docs/jfrog-distribution-service.md): JFrog Distribution service contains Distribution and Router microservices for artifact distribution tasks. - [Router Service](https://docs.jfrog.com/installation/docs/jfrog-router-service.md): Router microservice registers services and routes external traffic (port 8082) to internal microservices (8081, 8040, etc.). - [System Requirements](https://docs.jfrog.com/installation/docs/system-requirements.md): Review hardware, OS, database, and network requirements for Artifactory 7.x, Xray 3.x, and Distribution 2.x. - [Requirements Matrix](https://docs.jfrog.com/installation/docs/requirements-matrix.md): Validate platform support, CPU/RAM sizing, software versions, product dependencies, and license tiers before deployment. - [Supported Platforms And OS](https://docs.jfrog.com/installation/docs/supported-platforms-and-os.md): Supported OS: RHEL 8–9, Ubuntu 20.04–24.04, Debian 11–12, Windows 2022. Kubernetes 1.27+, OpenShift 4.14+. x86-64 and ARM64. - [Product License Matrix](https://docs.jfrog.com/installation/docs/license-matrix-pro-x-enterprise-x-enterprise.md): Use this matrix to confirm license eligibility by product/service before selecting the deployment scope. - [Feature Comparison Matrix](https://docs.jfrog.com/installation/docs/feature-comparison-matrix-for-self-mangaged-jpds.md): Compare components and services included in each JFrog Platform edition, from commercial subscriptions to free non-commercial licenses like OSS and JCR. - [Product Dependencies Matrix](https://docs.jfrog.com/installation/docs/product-dependencies-matrix.md): Xray requires Artifactory, RabbitMQ, and PostgreSQL. Distribution requires Artifactory with optional external PostgreSQL. - [Software Dependencies Matrix](https://docs.jfrog.com/installation/docs/software-dependencies-matrix.md): Minimum software versions: Java 11+ (bundled 21), Docker 20.10+, Kubernetes 1.27+, Helm 3.17+, PostgreSQL 13+, RabbitMQ 3.8+. - [Hardware Sizing Matrix](https://docs.jfrog.com/installation/docs/hardware-sizing-matrix.md): Artifactory sizing: 4 cores/6 GB (0–20 clients), 6 cores/12 GB (21–100), 8 cores/18 GB (101–200). Xray scales by indexed artifacts. - [Network Requirements](https://docs.jfrog.com/installation/docs/network-requirements-for-jfrog-products.md): JFrog products require static IPs and shared internal LAN. External ports 8081–8082, internal microservice ports reserved. - [Artifactory Network Ports](https://docs.jfrog.com/installation/docs/artifactory-network-ports.md): Learn about Artifactory external and internal network ports. - [Distribution Network Ports](https://docs.jfrog.com/installation/docs/distribution-network-ports_distribution-system-requirements-and-platform-support.md): Learn about Distribution external and internal network ports. - [Xray Network Ports](https://docs.jfrog.com/installation/docs/xray-network-ports_xray-system-requirements-and-platform-support.md): Learn about Xray external and internal network ports. - [General System Requirements](https://docs.jfrog.com/installation/docs/general-system-requirements.md): Each JFrog product requires a dedicated server. PostgreSQL, filestore, bundled JDK 21, and ports 8000–8100 reserved. - [Preflight Check](https://docs.jfrog.com/installation/docs/preflight-check.md): Run diagnosticUtil inspect (system|connectivity|database|all) to validate your environment before installation. - [Java Requirements for JFrog Products](https://docs.jfrog.com/installation/docs/java-requirements-for-jfrog-products.md): Artifactory and Distribution require JDK 21+. Bundled OpenJDK is included. Reserve 512 MB minimum JVM memory. - [Supported Browsers](https://docs.jfrog.com/installation/docs/supported-browsers.md): Artifactory supports Chrome, Firefox, Safari (Mac), and Edge (Chromium-based) latest browser versions. - [Docker Requirements](https://docs.jfrog.com/installation/docs/docker-requirements_general-system-requirements.md): Docker deployments require Docker Engine 25.0+ and Docker Compose v2. - [Helm Chart Requirements](https://docs.jfrog.com/installation/docs/helm-chart-requirements_general-system-requirements.md): Helm deployments require Kubernetes 1.27+ or OpenShift 4.14+, and Helm 3.17+. - [Database Support Matrix](https://docs.jfrog.com/installation/docs/database-support-matrix.md): Database support by product: PostgreSQL recommended for all. Xray and Distribution require PostgreSQL only. Artifactory supports 6 engines. - [Artifactory Database Requirements](https://docs.jfrog.com/installation/docs/artifactory-database-requirements.md): Artifactory supports PostgreSQL 13–17.x, Oracle 19c/23c, MySQL 8.x, SQL Server 2019+, and MariaDB 10.5–10.6, 10.11.x and 11.4.x. - [Database and Third-Party Applications in Xray](https://docs.jfrog.com/installation/docs/database-and-third-party-applications-in-xray_xray-system-requirements-and-platform-support.md): Xray requires PostgreSQL 13–17.x, RabbitMQ 3.7–4.x, and Erlang 19–27.x. Quorum Queues are mandatory for RabbitMQ 4.x. - [Database and Third-Party Applications in Distribution](https://docs.jfrog.com/installation/docs/database-and-third-party-applications-in-distribution_distribution-system-requirements-and-platform-support.md): Distribution supports PostgreSQL 15–17.x. Requires external PostgreSQL for HA. Redis 7.x removed as of Distribution 2.37.0. - [Artifactory Filestore](https://docs.jfrog.com/installation/docs/artifactory-filestore.md): Configure Artifactory filestore: local filesystem, NFS, AWS S3, Azure Blob, or Google Cloud Storage. - [Artifactory System Requirements and Platform Support](https://docs.jfrog.com/installation/docs/artifactory-system-requirements-and-platform-support.md): System requirements, supported platforms, and third-party dependencies for JFrog Artifactory self-managed deployments. - [Xray System Requirements and Platform Support](https://docs.jfrog.com/installation/docs/xray-system-requirements-and-platform-support.md): Xray prerequisites: RabbitMQ node recommendations, SSD storage (NFS not recommended), and file handle limit requirements. - [Xray and RabbitMQ Nodes Recommendations](https://docs.jfrog.com/installation/docs/xray-and-rabbitmq-nodes-recommendations_xray-system-requirements-and-platform-support.md): Use dedicated nodes for Xray and RabbitMQ. Odd-node RabbitMQ cluster (3 nodes recommended). Quorum Queues require minimum 3 nodes. - [Xray Storage Recommendations](https://docs.jfrog.com/installation/docs/xray-storage-recommendations_xray-system-requirements-and-platform-support.md): Xray requires SSD storage. Avoid NFS due to I/O bottlenecks. Local storage does not require replication in HA deployments. - [Xray File Handle Allocation Limit](https://docs.jfrog.com/installation/docs/xray-file-handle-allocation-limit_xray-system-requirements-and-platform-support.md): Set Xray file handles to 100,000 in /etc/security/limits.conf for the xray and postgres users. - [RabbitMQ HA in Xray using Quorum Queues](https://docs.jfrog.com/installation/docs/rabbitmq-ha-in-xray-using-quorum-queues.md): Xray uses RabbitMQ Quorum Queues (mandatory for v4.x). Replaces Classic Queue mirroring. 3-node cluster recommended for HA. - [Distribution System Requirements and Platform Support](https://docs.jfrog.com/installation/docs/distribution-system-requirements-and-platform-support.md): System requirements, supported platforms, and third-party dependencies for JFrog Distribution self-managed deployments. - [Allowlisted URLs and Air-Gapped Environment Considerations](https://docs.jfrog.com/installation/docs/allowlisted-urls-and-air-gapped-environment-considerations.md): Allowlist JFrog service URLs (releases.jfrog.io, charts.jfrog.io, jes.jfrog.io) in proxy/firewall settings. - [Platform Air-gapped Environment Configuration](https://docs.jfrog.com/installation/docs/configure-jfrog-platform-in-an-air-gapped-environment.md): Configure JFrog Platform for air-gapped deployment by setting jfconnect.airgap.enabled=true in values.yaml (K8S) or system.yaml (Non-K8S). - [Onboarding Wizard](https://docs.jfrog.com/installation/docs/onboarding-wizard.md): Complete post-install setup via onboarding wizard: reset admin password, activate license, set base URL, configure repositories. - [Load Balancer](https://docs.jfrog.com/installation/docs/load-balancer.md): Configure a load balancer as the entry point for JFrog Platform HA deployments to distribute requests across Artifactory nodes. - [Mission Control Installation](https://docs.jfrog.com/installation/docs/installing-mission-control.md): Enable Mission Control microservice for centralized topology management of multiple JFrog Platform Deployments. - [Artifactory Federation Service Installation](https://docs.jfrog.com/installation/docs/installing-artifactory-federation-service.md): Enable Artifactory Federation Service (RTFS) to synchronize artifact metadata securely across multiple customer sites. - [AI/ML Service Activation for Self-Managed Environments](https://docs.jfrog.com/installation/docs/activate-ai-ml.md): Enable JFrog AI/ML front-end service to integrate ML model building and deployment with enterprise security controls. - [Communication Between Services](https://docs.jfrog.com/installation/docs/communication-between-services.md): Configure router services for inter-node communication, TLS, service discovery, and proxy routing between JFrog Platform services. - [Manage Keys](https://docs.jfrog.com/installation/docs/manage-keys.md): Generate and bootstrap master keys and join keys using openssl for AES encryption of inter-service communication. - [Pairing Tokens](https://docs.jfrog.com/installation/docs/pairing-tokens.md): Pairing tokens establish initial cross-service trust with a 5-minute default lifetime, then are replaced by master tokens. - [Automatic Admin Token Creation](https://docs.jfrog.com/installation/docs/create-an-automatic-admin-token.md): Create admin-scoped bootstrap tokens via generate.token.json in /var/bootstrap/etc/access/keys (Artifactory 7.38.4+). - [Access as a Certificate Authority](https://docs.jfrog.com/installation/docs/using-access-as-a-certificate-authority.md): Configure JFrog Access as internal CA, provide a custom CA, or use pre-signed certificates for platform TLS. - [TLS Setup on the JFrog Platform](https://docs.jfrog.com/installation/docs/set-tls-on-the-jfrog-platform.md): Enable TLS in access.config.import.yml, distribute the CA to services, and configure Artifactory HTTPS on port 8443. - [TLS Certificates as a Client](https://docs.jfrog.com/installation/docs/using-tls-certificates-as-a-client.md): Configure JFrog Platform to trust external TLS certificates for mTLS connections to LDAPS, OAuth, and proxy services. - [Download TLS Certificates](https://docs.jfrog.com/installation/docs/download-tls-certificates.md): Use openssl s_client -connect host:port -showcerts to download server certificates for JFrog trust configuration. - [Trust a Self-Signed Certificate or a New CA](https://docs.jfrog.com/installation/docs/trust-a-self-signed-certificate-or-a-new-ca.md): Add PEM certificates to $JFROG_HOME//var/etc/security/keys/trusted on all nodes to establish trust. - [Custom Token Certificates](https://docs.jfrog.com/installation/docs/custom-token-certificates.md): Upload custom CA and token issuer key pairs to replace auto-generated certificates used for signing JFrog access tokens. - [Key Pair Bootstrap File Configuration (JPD)](https://docs.jfrog.com/installation/docs/load-the-key-pair-to-the-jfrog-platform-deployment-jpd-through-bootstrap-files.md): Place ca.crt, ca.private.key, root.crt, and private.key in $JFROG_HOME/bootstrap/etc/access/keys for token certificate initialization. - [Private-Public Key Pair Creation](https://docs.jfrog.com/installation/docs/create-a-private-public-key-pair.md): Generate an RSA CA certificate and private key with OpenSSL using v3_ca extensions for JFrog token signing. - [Proxy Configuration Between JFrog Products](https://docs.jfrog.com/installation/docs/configure-proxy-between-jfrog-products.md): Configure router proxy settings for HTTP/HTTPS with host-based bypass in system.yaml files. - [Database Configuration](https://docs.jfrog.com/installation/docs/database-configuration.md): Configure an external database for JFrog Artifactory. Supported databases include PostgreSQL, Oracle, MySQL, MariaDB, and Microsoft SQL Server, with PostgreSQL recommended for all new deployments. - [Choose Right Database](https://docs.jfrog.com/installation/docs/choose-the-right-database.md): PostgreSQL is JFrog's recommended database for all JFrog Platform products. Learn how to choose the right database for new and existing installations. - [Database Connection Settings](https://docs.jfrog.com/installation/docs/database-connection-settings.md): Configure database connection pool settings for JFrog Artifactory in system.yaml, including connection limits, timeout values, and driver-specific parameters. - [Database Setup Workflow](https://docs.jfrog.com/installation/docs/database-setup-workflow.md): Set up a database for JFrog Artifactory by creating an instance, creating a dedicated user, installing a JDBC driver, and configuring system.yaml. - [Database Tuning for Heavy Loads in Artifactory](https://docs.jfrog.com/installation/docs/database-tuning-for-heavy-loads-in-artifactory.md): Tune JFrog Artifactory database performance under heavy loads by adjusting maxOpenConnections in system.yaml to control the connection pool across all nodes. - [PostgreSQL for Artifactory](https://docs.jfrog.com/installation/docs/postgresql-for-artifactory.md): Configure PostgreSQL as the database for JFrog Artifactory, the recommended engine for all deployments and the only database shared across all JFrog products. - [Artifactory PostgreSQL Database Creation](https://docs.jfrog.com/installation/docs/create-the-artifactory-postgresql-database.md): Create the PostgreSQL user and database for JFrog Artifactory using SQL commands for both standard superuser and restricted superuser (e.g., AWS RDS) environments. - [PostgreSQL Remote Server Connectivity](https://docs.jfrog.com/installation/docs/enable-postgresql-connectivity-from-remote-servers.md): Enable remote server access to the PostgreSQL database used by JFrog Artifactory by configuring pg_hba.conf and reloading the PostgreSQL service. - [Artifactory PostgreSQL Configuration](https://docs.jfrog.com/installation/docs/configure-artifactory-to-use-postgresql.md): Configure JFrog Artifactory to store artifact metadata in PostgreSQL while keeping binary data on the filesystem under $JFROG_HOME. - [Artifactory PostgreSQL Single Node Configuration with Ansible](https://docs.jfrog.com/installation/docs/configure-artifactory-to-use-postgresql-single-node.md): Configure a single-node JFrog Artifactory instance to use PostgreSQL by stopping the service, editing the database block in system.yaml, and restarting. - [Artifactory HA PostgreSQL Configuration with Ansible](https://docs.jfrog.com/installation/docs/configure-artifactory-ha-to-use-postgresql-database-in-ha.md): Configure JFrog Artifactory HA to use PostgreSQL HA by setting multi-host JDBC connection strings with automatic primary failover in system.yaml. - [Artifactory Advisory Locks Configuration for PostgreSQL](https://docs.jfrog.com/installation/docs/configure-artifactory-to-use-advisory-locks-in-postgresql.md): JFrog Artifactory 7.77.3 and later supports PostgreSQL advisory locks as an alternative to distributed table locks, reducing contention in high-throughput environments. - [TLS Encryption for PostgreSQL](https://docs.jfrog.com/installation/docs/enable-tls-encryption-for-postgresql.md): Enable TLS for PostgreSQL in JFrog Artifactory by setting sslmode=verify-full in the JDBC URL and configuring a separate Go URL for the metadata service. - [Change the Postgres Database Password](https://docs.jfrog.com/installation/docs/change-the-postgres-database-password.md): Rotate the PostgreSQL password for JFrog Artifactory with no downtime by switching to a temporary user and updating credentials in `system.yaml`. - [Oracle for Artifactory](https://docs.jfrog.com/installation/docs/oracle-for-artifactory.md): Configure JFrog Artifactory to use Oracle Database as its external datastore, which requires a dedicated Oracle instance before Artifactory can start. - [Artifactory Oracle Database Creation](https://docs.jfrog.com/installation/docs/create-the-artifactory-oracle-database.md): Create a dedicated Oracle tablespace with AL32UTF8 encoding for JFrog Artifactory. Binaries are stored on the filesystem by default, not in Oracle. - [Artifactory Oracle Database Configuration](https://docs.jfrog.com/installation/docs/configure-artifactory-to-use-oracle.md): Install libaio, Oracle Instant Client, and the OJDBC jar, then set LD_LIBRARY_PATH in system.yaml to connect JFrog Artifactory to Oracle. - [MySQL for Artifactory](https://docs.jfrog.com/installation/docs/mysql-for-artifactory.md): Use MySQL as the external database for JFrog Artifactory to leverage MySQL infrastructure features such as backup, restore, and replication. - [Artifactory MySQL Database Creation](https://docs.jfrog.com/installation/docs/create-the-artifactory-mysql-database.md): Run the createdb_mysql.sql script to create the MySQL database with utf8_bin collation, then enable remote connectivity by configuring bind-address. - [Artifactory MySQL Configuration](https://docs.jfrog.com/installation/docs/configure-artifactory-to-use-mysql.md): Copy the MySQL JDBC driver to Artifactory's Tomcat lib directory and configure the database connection in system.yaml. Avoid storing artifact BLOBs in MySQL. - [Increase MySQL Default Packet Size](https://docs.jfrog.com/installation/docs/increase-mysql-default-packet-size.md): Set max_allowed_packet=8M in /etc/my.cnf or /etc/mysql/mysql.conf.d/mysqld.cnf to prevent packet-too-large errors when storing builds in MySQL. - [Tune MySQL for Artifactory](https://docs.jfrog.com/installation/docs/tune-mysql-for-artifactory.md): Optimize MySQL performance for JFrog Artifactory by enabling the InnoDB engine and applying recommended tuning parameters in /etc/my.cnf. - [Microsoft SQL Server for Artifactory](https://docs.jfrog.com/installation/docs/microsoft-sql-server-for-artifactory.md): Configure JFrog Artifactory to use Microsoft SQL Server 2012 or later as an external database, with a dedicated instance recommended for optimal performance. - [Artifactory Microsoft SQL Server Database Creation](https://docs.jfrog.com/installation/docs/create-the-artifactory-microsoft-sql-server-database.md): Create the SQL Server artifactory database and login in Management Studio, setting Latin1_General_CS_AI collation required by JFrog Artifactory. - [Artifactory Microsoft SQL Server Configuration](https://docs.jfrog.com/installation/docs/configure-artifactory-to-use-microsoft-sql-server.md): Configure JFrog Artifactory to connect to an external Microsoft SQL Server database by installing the JDBC driver and updating the system.yaml database settings. - [MariaDB for Artifactory](https://docs.jfrog.com/installation/docs/mariadb-for-artifactory.md): JFrog Artifactory supports MariaDB as a database backend. Configure a dedicated MariaDB instance and update Artifactory settings to use it. - [Artifactory MariaDB Database Creation](https://docs.jfrog.com/installation/docs/create-the-artifactory-mariadb-database.md): Run the createdb_mariadb.sql script to create the MariaDB database, grant Artifactory privileges, and apply a case-sensitive utf8_bin collation. - [Artifactory MariaDB Configuration](https://docs.jfrog.com/installation/docs/configure-artifactory-to-use-mariadb.md): Configure JFrog Artifactory to connect to an external MariaDB database by downloading the JDBC driver and updating the database settings in system.yaml. - [Increase MariaDB Default Packet Size](https://docs.jfrog.com/installation/docs/increase-mariadb-default-packet-size.md): Set max_allowed_packet=8M in /etc/my.cnf or /etc/mysql/mysql.conf.d/mysqld.cnf to prevent packet-too-large errors when storing builds in MariaDB. - [Tune MariaDB for Artifactory](https://docs.jfrog.com/installation/docs/tune-mariadb-for-artifactory.md): Optimize MariaDB performance for JFrog Artifactory by enabling the InnoDB engine and applying recommended tuning parameters in /etc/my.cnf. - [Known Issues with MariaDB](https://docs.jfrog.com/installation/docs/known-issues-with-mariadb.md): MariaDB Connector/J does not support the /* ping */ validation query. Artifactory uses SELECT 1 as the JDBC pool connection validation query instead. - [Filestore Configuration](https://docs.jfrog.com/installation/docs/filestore-configuration-landing.md): Manage Artifactory binary storage via binarystore.xml using built-in cloud, filesystem, or chained binary providers. - [File System Binary Provider](https://docs.jfrog.com/installation/docs/file-system-binary-provider.md): file-system binary provider is the default Artifactory filestore for local or mounted filesystem storage. - [File System Binary Provider Template Configuration](https://docs.jfrog.com/installation/docs/file-system-binary-provider-template-configuration.md) - [Cached Filesystem Binary Provider](https://docs.jfrog.com/installation/docs/cached-filesystem-binary-provider.md): cache-fs binary provider acts as a local LRU cache layer for remote filestores with configurable size and multiReadEnabled. - [Full-DB and Full-DB-Direct Binary Providers](https://docs.jfrog.com/installation/docs/full-db-and-full-db-direct-binary-providers.md): full-db stores artifacts in the database with a cache-fs layer. full-db-direct stores in the database without caching. - [Filestore Sharding](https://docs.jfrog.com/installation/docs/filestore-sharding.md): Distribute Artifactory binaries across multiple mounts (M) with redundancy (R) for stability and unlimited horizontal scalability. - [Sharding Binary Provider Configuration](https://docs.jfrog.com/installation/docs/configure-a-sharding-binary-provider.md): Configure sharding with read/write behavior, redundancy, and balancing parameters. Supports cross-zone sharding configurations. - [Double Shards Binary Provider](https://docs.jfrog.com/installation/docs/double-shards-binary-provider.md): double-shards template: two mounts with redundancy=1, each artifact stored once across both shards for capacity expansion. - [Redundant Shards Binary Provider](https://docs.jfrog.com/installation/docs/redundant-shards-binary-provider.md): redundant-shards template: two mounts with redundancy=2, each artifact copied to both shards for redundant storage. - [State-Aware Binary Provider](https://docs.jfrog.com/installation/docs/state-aware-binary-provider.md): state-aware sharding sub-provider monitors mount health with checkPeriod, zone assignment, and writeEnabled flag. - [Sharding Configuration for HA Cluster](https://docs.jfrog.com/installation/docs/configure-sharding-for-ha-cluster.md): Use cluster-file-system, cluster-s3, or cluster-google-storage templates with sharding-cluster provider for Artifactory HA. - [Sharding-Cluster Binary Provider](https://docs.jfrog.com/installation/docs/sharding-cluster-binary-provider.md): sharding-cluster provider: uses crossNetworkStrategy for reads/writes, dynamic remote sub-providers, and cluster topology awareness. - [Filestore Balancing for Mount Failure Recovery](https://docs.jfrog.com/installation/docs/using-balancing-to-recover-from-mount-failure.md): Restore shard redundancy after mount repair via automatic balancing sessions triggered after garbage collection runs. - [Redundant Storage Unit Balance Restoration](https://docs.jfrog.com/installation/docs/restoring-balance-in-unbalanced-redundant-storage-units.md): Use the Optimize System Storage REST API to rebalance shards after migration, triggered on next garbage collection. - [AWS S3 Object Storage](https://docs.jfrog.com/installation/docs/aws-s3-object-storage.md): Configure AWS S3 as the Artifactory filestore with direct or eventual upload mechanisms for unlimited scalability. - [Artifactory S3 Storage Configuration](https://docs.jfrog.com/installation/docs/configure-artifactory-to-use-s3-storage.md): Configure Artifactory S3 filestore in binarystore.xml using IAM roles or explicit credentials with direct or eventual templates. - [Amazon S3 Template Parameters](https://docs.jfrog.com/installation/docs/amazon-s3-template-parameters.md): Reference for all s3-storage-v3 binary provider parameters: bucketName, region, endpoint, encryption, multipart, and authentication modes. - [S3 Binary Storage Templates](https://docs.jfrog.com/installation/docs/s3-binary-storage-templates.md): Configure s3-storage-v3-direct, s3-storage-v3, cluster-s3-storage-v3, or s3-sharding templates with account-specific parameters. - [Filestore Migration to S3](https://docs.jfrog.com/installation/docs/migrate-your-filestore-to-s3.md): Migrate Artifactory filestore to S3 manually or automatically using eventual directory symlinks for validation. - [S3 Intelligent Tiering Storage Class](https://docs.jfrog.com/installation/docs/using-the-s3-intelligent-tiering-storage-class.md): Migrate S3 artifacts to Intelligent Tiering storage class via lifecycle rules for potential 20–60% storage cost savings. - [Integrate Artifactory with AWS SDK v2 for S3 Storage](https://docs.jfrog.com/installation/docs/copy-of-integrate-artifactory-with-aws-sdk-v2-for-s3-storage.md) - [Google Cloud Storage](https://docs.jfrog.com/installation/docs/google-cloud-storage.md): Configure Google Cloud Storage (GCS) as the Artifactory remote filestore with unlimited scalability and disaster recovery. - [Artifactory GCS Setup](https://docs.jfrog.com/installation/docs/set-up-artifactory-to-use-gcs.md): Configure Artifactory to use GCS: shut down, configure the native client template, migrate the filestore, then restart. - [Google Storage Binary Provider Native Client Template](https://docs.jfrog.com/installation/docs/google-storage-binary-provider-native-client-template.md): Configure google-storage-v2 binary provider using the GCS native client SDK with bucket, signed URLs, and proxy support. - [Google Storage V2 Cluster Binary Provider](https://docs.jfrog.com/installation/docs/google-storage-v2-cluster-binary-provider.md): Use cluster-google-storage-v2 template for HA Artifactory with sharding-cluster, eventual, and google-storage-v2 providers. - [Filestore Migration to Google Storage](https://docs.jfrog.com/installation/docs/migrate-your-filestore-to-google-storage.md): Migrate Artifactory filestore to GCS: stop the service, copy the filestore directory to the bucket, then restart. - [Azure Blob Storage](https://docs.jfrog.com/installation/docs/azure-blob-storage.md): Configure Azure Blob Storage as the Artifactory filestore for massive scalability, disaster recovery, and security. - [Artifactory Azure Blob Storage Setup](https://docs.jfrog.com/installation/docs/set-up-artifactory-to-use-azure-blob-storage.md): Configure Artifactory Azure Blob Storage: choose direct or eventual upload, set binarystore.xml parameters, migrate filestore. - [Azure Blob Storage V2 Binary Provider](https://docs.jfrog.com/installation/docs/azure-blob-storage-v2-binary-provider.md): Configure azure-blob-storage-v2-direct or azure-blob-storage-v2 templates supporting SAS tokens and signed URL redirect. - [Azure Blob Storage Cluster V2 Binary Provider](https://docs.jfrog.com/installation/docs/azure-blob-storage-cluster-v2-binary-provider.md): Configure cluster-azure-blob-storage-v2 template for Artifactory HA. azure-blob-storage-v2-direct is now recommended instead. - [Azure Blob Storage V1 Binary Provider](https://docs.jfrog.com/installation/docs/azure-blob-storage-v1-binary-provider.md): Configure azure-blob-storage-direct or azure-blob-storage templates for single-node Azure Blob Storage deployments. - [Azure Blob Storage Cluster V1 Binary Provider](https://docs.jfrog.com/installation/docs/azure-blob-storage-cluster-v1-binary-provider.md): Configure cluster-azure-blob-storage template for Artifactory HA with eventual storage, sharding-cluster, and remote binary providers. - [Manual Filestore Migration for Azure Blob Storage](https://docs.jfrog.com/installation/docs/manual-filestore-migration-for-azure-blob-storage.md): Migrate Artifactory filestore to Azure Blob Storage: stop Artifactory, copy filestore directory, configure binarystore.xml, restart. - [Azure Workload Identity](https://docs.jfrog.com/installation/docs/azure-workload-identity.md): Enable Azure Workload Identity for AKS by setting useInstanceCredentials=true in binarystore.xml for secret-less authentication. - [Eventual Binary Provider](https://docs.jfrog.com/installation/docs/eventual-binary-provider.md): The Eventual Binary Provider buffers uploads locally then writes asynchronously to remote storage with configurable threads and timeouts. - [Federated Binary Provider](https://docs.jfrog.com/installation/docs/federated-binary-provider.md): This section explains the federated repository configuration, which defines the filestore settings located under `$JFROG_HOME/artifactory/var/etc/artifactory/binarystore.xml` (followed by a restart) for synchronizing federated repository binaries. - [Remote Binary Provider](https://docs.jfrog.com/installation/docs/remote-binary-provider.md): The Remote Binary Provider links HA cluster nodes via HTTP with configurable connection/socket timeout and zone assignment. - [Retry Binary Provider](https://docs.jfrog.com/installation/docs/retry-binary-provider.md): The Retry Binary Provider retries failed reads/writes with configurable maxTrys and interval parameters. - [State-Aware Binary Provider](https://docs.jfrog.com/installation/docs/state-aware-binary-provider_filestore-configuration.md): state-aware binary provider in sharding-cluster monitors mount health. Reroutes writes when a storage unit is unhealthy. - [Eventual-Cluster Binary Provider](https://docs.jfrog.com/installation/docs/eventual-cluster-binary-provider.md): eventual-cluster provider for HA nodes buffers to local _pre/_queue folders with configurable workers and dispatcher interval. - [State-Aware-S3 Binary Provider](https://docs.jfrog.com/installation/docs/state-aware-s3-binary-provider.md): state-aware-s3 sub-provider for S3 sharding monitors bucket health with checkPeriod and zone assignment. - [Direct Cloud Storage Download](https://docs.jfrog.com/installation/docs/direct-cloud-storage-download.md): Enable direct cloud storage download to redirect artifact requests via signed URLs to S3, Azure Blob, or GCS. - [Configure the Artifactory Filestore for Direct Cloud Storage](https://docs.jfrog.com/installation/docs/step-1-configure-the-artifactory-filestore-for-direct-cloud-storage.md): Set enableSignedUrlRedirect=true and signedUrlExpirySeconds in binarystore.xml. Optionally configure CloudFront distribution. - [Specify Repositories for Direct Download](https://docs.jfrog.com/installation/docs/step-2-specify-repositories-for-direct-download.md): Enable downloadRedirect per repository via UI, REST API, or YAML. Set storeArtifactsLocally=true for remote repositories. - [Finetune Direct Download](https://docs.jfrog.com/installation/docs/step-3-finetune-direct-download.md): Set Minimum Direct Cloud Storage Download Size (default 1 MB) to fine-tune when redirect applies to artifact downloads. - [Control Your Signed URL Downloads](https://docs.jfrog.com/installation/docs/step-4-control-your-signed-url-downloads.md): Control signed URL redirect behavior using X-JFrog-Download-Redirect-To header: None, S3, or CF (CloudFront). - [Configure Firewalls](https://docs.jfrog.com/installation/docs/step-5-configure-firewalls.md): Whitelist S3, CloudFront, GCS, and Azure Blob Storage domains in firewalls to enable signed URL artifact downloads. - [System Configuration](https://docs.jfrog.com/installation/docs/system-configuration.md): JFrog Platform configuration files: system.yaml, artifactory.yaml, and access.yaml, covering their types, purposes, and locations. - [System YAML Configuration File](https://docs.jfrog.com/installation/docs/system-yaml-configuration-file.md): system.yaml is the central configuration-as-code file for all self-managed JFrog products: shared and per-service settings. - [Configuration as Code in JFrog](https://docs.jfrog.com/installation/docs/implementing-configuration-as-code-in-jfrog.md): Implement configuration-as-code in JFrog using system.yaml files in $JFROG_HOME//var/etc. - [System YAML Reference](https://docs.jfrog.com/installation/docs/using-system-yamls.md): Reference system.yaml format: key-entity structure, configuration hierarchy, and how to apply changes across JFrog services. - [Artifactory System YAML](https://docs.jfrog.com/installation/docs/artifactory-system-yaml.md): Complete Artifactory system.yaml reference with database, filestore, security, and service configuration parameters. - [Xray System YAML](https://docs.jfrog.com/installation/docs/xray-system-yaml.md): Complete Xray system.yaml reference with database, RabbitMQ, storage, and server configuration parameters. - [Distribution System YAML](https://docs.jfrog.com/installation/docs/distribution-system-yaml.md): Configure JFrog Distribution using system.yaml with key-entity structure for shared and microservice-specific settings. - [Artifactory YAML Configuration](https://docs.jfrog.com/installation/docs/artifactory-yaml-configuration.md): Configure existing Artifactory instances using YAML configuration files applied via REST API PATCH request. - [Artifactory YAML File Format](https://docs.jfrog.com/installation/docs/artifactory-yaml-file-format.md): Artifactory YAML configuration format uses a key: [entity] structure for all configuration entries. - [Artifactory YAML Configuration Change Application](https://docs.jfrog.com/installation/docs/apply-artifactory-yaml-configuration-changes.md): Apply Artifactory YAML configuration changes by sending a PATCH request to the /api/system/configuration REST endpoint. - [Existing Element Deletion in Artifactory YAML](https://docs.jfrog.com/installation/docs/delete-an-existing-element-in-artifactory-yaml.md): Delete Artifactory configuration elements by setting the key to null or ~ in the YAML configuration file. - [Repositories Configurations in Artifactory YAML](https://docs.jfrog.com/installation/docs/repositories-configurations-in-artifactory-yaml.md): Configure local, remote, virtual, and federated repository settings in artifactory.yaml. - [Replication Configuration in Artifactory YAML](https://docs.jfrog.com/installation/docs/replication-push-and-pull-configurations-in-artifactory-yaml.md): Configure push and pull replication for local and remote repositories in artifactory.yaml. - [General (General, Property Sets, Proxy, Mail) Configurations in Artifactory YAML](https://docs.jfrog.com/installation/docs/general-general-property-sets-proxy-mail-configurations-in-artifactory-yaml.md): Configure general settings, property sets, proxies, and mail server in artifactory.yaml. - [Security Configurations in Artifactory YAML](https://docs.jfrog.com/installation/docs/security-configurations-in-artifactory-yaml.md): Configure security, authentication, LDAP, SAML, OAuth, and HTTP SSO settings in artifactory.yaml. - [Service Configurations in Artifactory YAML](https://docs.jfrog.com/installation/docs/service-configurations-in-artifactory-yaml.md): Configure Artifactory backups, Maven indexer, and Xray integration settings in artifactory.yaml. - [Advanced Configurations in Artifactory YAML](https://docs.jfrog.com/installation/docs/advanced-configurations-in-artifactory-yaml.md): Configure Artifactory maintenance, garbage collection, and storage quota settings in artifactory.yaml. - [Artifactory Configuration Files](https://docs.jfrog.com/installation/docs/artifactory-configuration-files.md): Reference Artifactory configuration files located in $JFROG_HOME/artifactory/var/etc/artifactory. - [Artifactory System Properties](https://docs.jfrog.com/installation/docs/artifactory-system-properties.md): Configure Artifactory using artifactory.system.properties as an alternative to JVM runtime parameters. - [Load Healer Automatic Load Protection](https://docs.jfrog.com/installation/docs/load-healer-automatic-load-protection.md): Protect Artifactory from overload by monitoring worker-thread consumption and throttling offending activities with HTTP 429 when the node enters an outage state. - [Access YAML Configuration](https://docs.jfrog.com/installation/docs/access-yaml-configuration.md): Configure JFrog Access using access.config.*.yml files in $JFROG_HOME/artifactory/var/etc/access. - [Access YAML Configuration Files](https://docs.jfrog.com/installation/docs/access-yaml-configuration-files.md): Reference Access YAML configuration files: access.config.import.yml, patch.yml, template.yml, and latest.yml. - [Upload the Access YAML File](https://docs.jfrog.com/installation/docs/upload-the-access-yaml-file.md): Upload access.config.import.yml to apply JFrog Access configuration changes. - [New Integrations Enablement](https://docs.jfrog.com/installation/docs/enable-new-integrations.md): Enable new JFrog Platform integrations by setting integrations-enabled: true in access.config.import.yaml. - [Revert to Previous Access Configurations](https://docs.jfrog.com/installation/docs/revert-to-previous-access-configurations.md): Restore previous Access configurations from timestamped access.config.latest..yml backup files. - [Supported Access Configurations](https://docs.jfrog.com/installation/docs/supported-access-configurations.md): Reference all supported JFrog Access YAML configuration parameters for security, tokens, authentication, and service settings. - [Migrated Authentication Provider Properties](https://docs.jfrog.com/installation/docs/migrated-authentication-provider-properties.md): Reference LDAP and Crowd authentication provider properties migrated from artifactory.system.properties to Access YAML. - [Artifactory Bootstrap YAML File](https://docs.jfrog.com/installation/docs/artifactory-bootstrap-yaml-file.md): Bootstrap Artifactory at startup using artifactory.config.import.yml for license, base URL, proxy, and repository settings. - [Access Bootstrap YAML File](https://docs.jfrog.com/installation/docs/access-bootstrap-yaml-file.md): Pre-configure JFrog Access authentication providers using access.security.bootstrap.yml at startup. - [Distribution Application Config YAML File](https://docs.jfrog.com/installation/docs/distribution-application-config-yaml-file.md): Configure JFrog Distribution using distribution.config.import.yml for initial setup before service startup. - [Worker YAML Configuration](https://docs.jfrog.com/installation/docs/worker-yaml-configuration.md): Configure the Worker service using system.yaml for shared, Worker microservice, and router settings. - [Artifactory Configuration](https://docs.jfrog.com/installation/docs/configuring-artifactory.md): Configure Artifactory security, HTTP proxies, scheduled backups, import/export, Maven indexer, and artifact signing. - [Artifactory General Settings](https://docs.jfrog.com/installation/docs/general-settings.md): Configure global Artifactory parameters: file upload limits, folder downloads, replication blocking, and trash retention. - [Artifactory HTTP Settings](https://docs.jfrog.com/installation/docs/http-settings.md): Configure Artifactory reverse proxy (NGINX/Apache) with internal ports, load balancer, and Docker registry subdomain or port method. - [Artifactory Import and Export](https://docs.jfrog.com/installation/docs/import-and-export.md): Export or import individual repository data or a full Artifactory system (config, security, binaries) via REST API or UI. - [Artifactory Backup Configuration](https://docs.jfrog.com/installation/docs/backups.md): Schedule incremental or full Artifactory system backups outside $JFROG_HOME. Use separate filestore, database, and config for large instances. - [Artifactory Maven Indexer](https://docs.jfrog.com/installation/docs/maven-indexer.md): Schedule Maven index calculation via cron for IDE integrations. Exclude resource-intensive repositories from indexing. - [Artifactory Security](https://docs.jfrog.com/installation/docs/artifactory-security.md): Configure PEM certificate aliases in Artifactory for remote repositories requiring SSL/TLS client authentication. - [Artifactory Configuration Descriptors](https://docs.jfrog.com/installation/docs/artifactory-configuration-descriptors.md): Artifactory configuration descriptors are deprecated. Refer to the Configuration Files page for current information on JFrog Artifactory configuration files. - [Artifactory Configuration XSD](https://docs.jfrog.com/installation/docs/artifactory-configuration-xsd.md): Reference XSD schemas for Artifactory configuration XML files and MIME type definitions. - [WebStart and Jar Signing](https://docs.jfrog.com/installation/docs/webstart-and-jar-signing.md): Generate keystores and sign JAR files in Artifactory via keytool for Java Web Start (JNLP) client downloads. - [RSA Key Pairs](https://docs.jfrog.com/installation/docs/rsa-key-pairs.md): Generate and manage 2048-bit RSA key pairs in Artifactory for Alpine Linux package index signing and verification. - [Passwordless Access for Amazon EKS](https://docs.jfrog.com/installation/docs/passwordless-access-for-amazon-eks.md): Configure AWS AssumeRole and JFrog Registry Operator for passwordless EKS cluster authentication without stored secrets. - [Permissions for Passwordless Access to EKS Cluster](https://docs.jfrog.com/installation/docs/permissions-for-passwordless-access-to-eks-cluster.md): JFrog Registry Operator Helm charts create ClusterRole permissions for secretrotators, namespaces, secrets, and events. - [EKS Cluster Configuration with AWS Policy and IAM Role](https://docs.jfrog.com/installation/docs/configure-the-eks-cluster-with-the-aws-policy-and-iam-role.md): Create an EKS OIDC provider, IAM role with trust relationship, and policy allowing sts:GetCallerIdentity. - [Platform Passwordless Access Configuration for EKS](https://docs.jfrog.com/installation/docs/configure-jfrog-platform-for-passwordless-access-to-eks.md): Tag JFrog users with IAM role ARNs using the Put IAM Role API after EKS and Access service configuration. - [Registry Operator Installation in EKS](https://docs.jfrog.com/installation/docs/install-the-jfrog-registry-operator-in-eks.md): Deploy JFrog Registry Operator via Helm with CRD, service accounts, and SecretRotator CustomResource for EKS. - [EKS Pod Identity Configuration](https://docs.jfrog.com/installation/docs/eks-pod-identity-configuration.md): Install the EKS Pod Identity Agent, configure IAM trust for pods.eks.amazonaws.com, create Pod Identity associations, and deploy the JFrog Registry Operator with authType: podIdentity. - [Individual JFrog Products Installation](https://docs.jfrog.com/installation/docs/install.md): Install JFrog Artifactory, Xray, Distribution, and Advanced Security via Docker, Helm, RPM, Debian, or Linux archive. - [Artifactory Installation](https://docs.jfrog.com/installation/docs/installing-artifactory.md): Install Artifactory single-node or HA via Helm, Docker, Docker Compose, RPM, Debian, Linux archive, or Windows archive. - [Artifactory Installation with Helm Charts](https://docs.jfrog.com/installation/docs/helm-charts.md): Install Artifactory on Kubernetes or OpenShift using Helm charts for single-node and HA deployments. - [Artifactory Docker Installation](https://docs.jfrog.com/installation/docs/docker.md): Install Artifactory using Docker Compose for single-node and HA deployments. - [Artifactory Linux Package Installation](https://docs.jfrog.com/installation/docs/linux-package.md): Install Artifactory on Linux using RPM, Debian, or Linux archive for single-node and HA deployments. - [Artifactory Windows Archive Installation](https://docs.jfrog.com/installation/docs/windows-archive.md): Install Artifactory on Windows using the .zip archive for single-node and HA deployments. - [Xray Installation](https://docs.jfrog.com/installation/docs/installing-xray.md): Install Xray single-node or HA using Helm, Docker Compose, RPM, Debian, or Linux archive with PostgreSQL and RabbitMQ. - [Xray FIPS Installation](https://docs.jfrog.com/installation/docs/install-xray-with-fips.md): Install Xray with FIPS 140-2 enabled on RHEL 8/9 or Amazon Linux 3 using the Linux archive installer. - [Quorum Queue Enablement for Xray and Platform Helm Charts](https://docs.jfrog.com/installation/docs/quorum-queue-enablement-for-xray-and-platform-helm-charts.md): Enable RabbitMQ Quorum Queues in Xray 3.124.x+ and Platform Helm charts. Replaces deprecated Classic Queue mirroring. - [Xray Single Node Installation](https://docs.jfrog.com/installation/docs/xray-single-node-installation.md): Choose Xray single-node installation: Helm, OpenShift, interactive script, Docker Compose, RPM, Debian, or Linux archive. - [Xray HA Installation](https://docs.jfrog.com/installation/docs/xray-ha-installation.md): Set up a Xray HA cluster with 2+ nodes using Helm, Docker Compose, or Linux archive with external PostgreSQL. - [Xray Single Node Helm Installation](https://docs.jfrog.com/installation/docs/xray-single-node-helm-installation.md): Install Xray single-node on Kubernetes using Helm chart with join key and JFrog URL configuration. - [Xray Single Node OpenShift Installation](https://docs.jfrog.com/installation/docs/xray-single-node-openshift-installation.md): Install Xray single-node on OpenShift (v3.80.9+) using Helm chart on a Kubernetes-compatible platform. - [Xray Single Node Interactive Script Installation](https://docs.jfrog.com/installation/docs/install-xray-single-node-with-interactive-script.md): Install Xray single-node using interactive script supporting RPM, archive, Debian, and Docker Compose methods. - [Xray Single Node Manual Docker Compose Installation](https://docs.jfrog.com/installation/docs/xray-single-node-manual-docker-compose-installation.md): Install Xray single-node using Docker Compose with direct compose file configuration and external PostgreSQL/RabbitMQ. - [Xray Single Node Manual RPM Installation](https://docs.jfrog.com/installation/docs/xray-single-node-manual-rpm-installation.md): Install Xray single-node using RPM packages bundled with all dependencies, installable separately for automation. - [Xray Single Node Manual Debian Installation](https://docs.jfrog.com/installation/docs/xray-single-node-manual-debian-installation.md): Install Xray single-node on Debian using native packages bundled with all dependencies, separately installable for automation. - [Xray Single Node Linux Archive Installation](https://docs.jfrog.com/installation/docs/install-xray-single-node-with-linux-archive.md): Install Xray single-node using Linux archive with independently installed PostgreSQL, RabbitMQ, and Redis prerequisites. - [Xray HA Helm Installation](https://docs.jfrog.com/installation/docs/xray-ha-helm-installation.md): Install Xray HA on Kubernetes using Helm with a multi-node cluster, shared PostgreSQL, and RabbitMQ services. - [Xray HA OpenShift Installation](https://docs.jfrog.com/installation/docs/xray-ha-openshift-installation.md): Install Xray HA on OpenShift (v3.80.9+) using Helm chart on a Kubernetes-compatible container platform. - [Xray HA Docker Compose Installation](https://docs.jfrog.com/installation/docs/xray-ha-docker-compose-installation.md): Install Xray HA using Docker Compose with multiple nodes sharing external PostgreSQL and RabbitMQ. - [Xray HA Linux Archive / RPM/ Debian Installation](https://docs.jfrog.com/installation/docs/xray-ha-linux-archive-rpm-debian-installation.md): Install Xray HA on Linux using archive, RPM, or Debian. Configure multi-node cluster with external PostgreSQL. - [PostgreSQL for Xray](https://docs.jfrog.com/installation/docs/postgresql-for-xray.md): Configure PostgreSQL for Xray single-node or HA: create database and user, enable remote connectivity, update system.yaml. - [RabbitMQ (Split) for Xray ( Xray Version < 3.131.x ) ](https://docs.jfrog.com/installation/docs/rabbitmq-split-for-xray.md): Install Xray and RabbitMQ on separate nodes. Connect multiple Xray nodes to a shared RabbitMQ cluster for HA. - [Xray installation using installv2.sh](https://docs.jfrog.com/installation/docs/xray-installation-using-installv2sh.md): This guide explain how to install xray (rpm, deb , linux archive and docker compose) using the new interactive script - [RabbitMQ (Split) for Xray ( Xray Version >= 3.131.x ) ](https://docs.jfrog.com/installation/docs/rabbitmq-split-for-xray-xray-version-3131x.md): Install Xray and RabbitMQ on separate nodes. Connect multiple Xray nodes to a shared RabbitMQ cluster for HA. - [Advanced Security Installation](https://docs.jfrog.com/installation/docs/installing-jfrog-advanced-security.md): Install JFrog Advanced Security on self-hosted Artifactory: requires Xray 3.67.x+ (Helm), 3.73.5+ (RPM/Debian/Archive), 3.73.8+ (Docker Compose). - [Advanced Security Prerequisites](https://docs.jfrog.com/installation/docs/jfrog-advanced-security-prerequisites.md): Hardware requirements for JFrog Advanced Security: Xray, JAS, and database sizing based on indexed artifact count and daily build volume. - [Advanced Security Helm Installation](https://docs.jfrog.com/installation/docs/install-jfrog-advanced-security-on-your-self-hosted-environment-with-helm.md): Deploy JFrog Advanced Security via Helm into an existing JFrog Platform or a new Artifactory and Xray installation. - [Advanced Security Installation without Helm](https://docs.jfrog.com/installation/docs/install-jfrog-advanced-security-on-your-self-hosted-environment-without-helm.md): Install JFrog Advanced Security without Helm using K3s-based Kubernetes for RPM, Debian, Linux Archive, or Docker Compose deployments. - [Advanced Security Additional Configurations](https://docs.jfrog.com/installation/docs/jfrog-advanced-security-additional-configurations.md): Tune JFrog Advanced Security resource limits (CPU, memory, ephemeral storage) via system.yaml or custom-values.yaml. - [Advanced Security Readiness Checking](https://docs.jfrog.com/installation/docs/jfrog-advanced-security-readiness-checking.md): Run JFrog Advanced Security health checks (Xray 3.107+) to validate JFConnect, entitlements, K3s/K8s config, and database sync. - [Catalog Installation](https://docs.jfrog.com/installation/docs/installing-catalog.md): Install JFrog Catalog for vulnerability and license data via interactive script or Helm. - [Catalog Installation with Interactive Script](https://docs.jfrog.com/installation/docs/installing-jfrog-catalog-with-interactive-script.md): Install JFrog Catalog via Docker Compose, RPM, Debian, or Linux archive with Valkey cache service. - [Catalog Helm and OpenShift Installation](https://docs.jfrog.com/installation/docs/install-jfrog-catalog-with-helm-and-openshift.md): Install JFrog Catalog on Kubernetes or OpenShift via Helm as standalone or sub-chart of Platform/Xray chart. - [PostgreSQL for JFrog Catalog](https://docs.jfrog.com/installation/docs/postgresql-for-jfrog-catalog.md): Configure an external PostgreSQL database for JFrog Catalog. - [Valkey Installation with Interactive Script](https://docs.jfrog.com/installation/docs/valkey-installation-with-interactive-script.md) - [Installing Curation](https://docs.jfrog.com/installation/docs/installing-curation.md) - [Valkey HA Installation ( RPM / Deb / Archive )](https://docs.jfrog.com/installation/docs/valkey-ha-installation.md) - [Runtime Security Installation](https://docs.jfrog.com/installation/docs/installing-jfrog-runtime-security.md): Install JFrog Runtime Security on Kubernetes to monitor container workloads via REST or gRPC with CPU/memory sizing guidance. - [Distribution Installation](https://docs.jfrog.com/installation/docs/installing-distribution.md): Install Distribution single-node or HA using Helm, Docker Compose, RPM, Debian, or Linux archive (Enterprise+ license). - [Distribution Single Node Helm Installation](https://docs.jfrog.com/installation/docs/distribution-single-node-helm-installation.md): Install Distribution single-node on Kubernetes using Helm chart with join key and JFrog URL configuration. - [Distribution Single Node Docker Compose Installation](https://docs.jfrog.com/installation/docs/distribution-single-node-docker-compose-installation.md): Install Distribution single-node using Docker Compose with direct compose file configuration. - [Distribution Single Node Interactive Script Installation](https://docs.jfrog.com/installation/docs/distribution-single-node-interactive-script-installation.md): Install Distribution single-node using interactive script supporting Docker Compose, RPM, Debian, and Linux archive. - [Distribution Single Node RPM Installation](https://docs.jfrog.com/installation/docs/distribution-single-node-rpm-installation.md): Install Distribution single-node using RPM packages bundled with all dependencies, separately installable for automation. - [Distribution Single Node Debian Installation](https://docs.jfrog.com/installation/docs/distribution-single-node-debian-installation.md): Install Distribution single-node on Debian using native packages bundled with all dependencies, separately installable. - [Distribution Single Node Linux Archive Installation](https://docs.jfrog.com/installation/docs/distribution-single-node-linux-archive-installation.md): Install Distribution single-node using Linux archive with independently installed PostgreSQL and Redis prerequisites. - [Distribution HA Helm Installation](https://docs.jfrog.com/installation/docs/distribution-ha-helm-installation.md): Install Distribution HA on Kubernetes using Helm with multi-node cluster, external PostgreSQL, and shared filestore. - [Distribution HA Docker Compose Installation](https://docs.jfrog.com/installation/docs/distribution-ha-docker-compose-installation.md): Install Distribution HA using Docker Compose with multiple nodes sharing external PostgreSQL. - [Distribution HA Linux Archive/RPM/Debian Installation](https://docs.jfrog.com/installation/docs/distribution-ha-linux-archive-rpm-debian-installation.md): Install Distribution HA on Linux using archive, RPM, or Debian. Configure multi-node cluster with external PostgreSQL. - [Workers Installation](https://docs.jfrog.com/installation/docs/installing-workers.md): Deploy JFrog Workers service for event-driven automation via Platform Helm, Artifactory Helm, or Docker Compose. - [Workers Platform Helm Chart Installation](https://docs.jfrog.com/installation/docs/install-jfrog-worker-with-platform-helm-chart.md): Install JFrog Worker using Platform Helm Chart (v10.20.x+) by enabling Worker in custom-values.yaml. - [Workers Artifactory Helm Chart Installation](https://docs.jfrog.com/installation/docs/install-jfrog-worker-with-artifactory-helm-chart.md): Install JFrog Worker using Artifactory Helm Chart (v7.98.4+) for event-driven automation plugin execution. - [Workers Docker Compose Installation](https://docs.jfrog.com/installation/docs/install-jfrog-worker-with-docker-compose.md): Install JFrog Worker using Docker Compose for serverless execution alongside JFrog Artifactory. - [MCP Server Installation](https://docs.jfrog.com/installation/docs/mcp.md): Deploy the JFrog MCP Server on self-managed environments to connect AI Agents to the JFrog Platform. - [PostgreSQL for MCP Server](https://docs.jfrog.com/installation/docs/postgresql-for-mcp-server.md): Configure an external PostgreSQL database for the JFrog MCP Server. PostgreSQL is bundled by default for both Helm and Docker Compose, and external setup is optional. - [MCP Server Helm Chart Installation](https://docs.jfrog.com/installation/docs/mcp-platform-helm.md): Install the JFrog MCP Server as a standalone Helm chart on Kubernetes and connect it to your JFrog Platform Deployment. - [MCP Server Docker Compose Installation](https://docs.jfrog.com/installation/docs/mcp-docker-compose.md): Install the JFrog MCP Server using Docker Compose to deploy the MCP service alongside the JFrog Platform on non-Kubernetes environments. - [Enable MCP Server Integration](https://docs.jfrog.com/installation/docs/enable-mcp-integration.md): Enable the JFrog MCP Server integration on your JFrog Platform Deployment after installation. - [MCP Clients Supported](https://docs.jfrog.com/installation/docs/mcp-clients.md): Connect MCP clients to your self-managed JFrog MCP Server deployment. Covers supported clients (VS Code, Claude, and Cursor) and how to configure each. - [Add MCP Server to MCP Client](https://docs.jfrog.com/installation/docs/add-mcp-server-to-client.md): Configure an MCP client to connect to your self-managed JFrog MCP Server deployment using your JPD URL. - [MCP Server Tools](https://docs.jfrog.com/installation/docs/mcp-server-tools.md): Reference all tools exposed by the self-managed JFrog MCP Server, grouped by product and domain. - [Disable MCP Server](https://docs.jfrog.com/installation/docs/disable-mcp-server.md): Disable the JFrog MCP Server entirely, revoke all MCP sessions, or remove an individual user's MCP access on a self-managed JFrog Platform Deployment. - [JFrog Online Beta Agreement - MCP Server Self-Managed](https://docs.jfrog.com/installation/docs/mcp-server-beta-agreement.md) - [Bridge Client Service Installation](https://docs.jfrog.com/installation/docs/install-bridge-client-service.md): Install Bridge Client service on self-managed JPDs using Helm, Docker Compose, or Linux archive. - [Install Bridge Client Using Helm Charts](https://docs.jfrog.com/installation/docs/bridge-client-helm-chart-installation.md): Install the JFrog Bridge Client on Kubernetes with Platform or standalone Helm charts to connect your self-managed JPD to JFrog Bridges. - [Bridge Client Docker Compose Installation](https://docs.jfrog.com/installation/docs/bridge-client-docker-compose-installation.md): Install JFrog Bridge Client with Docker Compose on self-hosted JPDs. - [Bridge Client Linux Archive Installation](https://docs.jfrog.com/installation/docs/bridge-client-linux-archive-installation.md): Install JFrog Bridge Client on Linux using the archive method as a service or background process. - [Artifactory Edge Installation](https://docs.jfrog.com/installation/docs/installing-artifactory-edge.md): JFrog Artifactory Edge is a specialized edition for distributing software to runtime endpoints via Release Bundles. - [Edge Node Addition](https://docs.jfrog.com/installation/docs/add-an-edge-node.md): Add Artifactory Edge nodes by establishing Circle of Trust and configuring Mission Control, Access Federation, and signing keys. - [Binary Signature Verification](https://docs.jfrog.com/installation/docs/verifying-signatures-of-jfrog-binaries.md): Verify JFrog binary signatures using the primary 4096-bit RSA GPG key or secondary 1024-bit GPG key. - [Artifactory Overloading Troubleshooting](https://docs.jfrog.com/installation/docs/artifactory-overloading-troubleshooting.md): Diagnose Artifactory overload from busy worker-thread logs, map activities to root causes, interpret HTTP 429 responses, and decide when to enable Load Healer Reactive mode. - [Products Upgrade](https://docs.jfrog.com/installation/docs/upgrade.md): Upgrade JFrog Platform products using the same installation method as the original deployment. - [Artifactory Upgrade](https://docs.jfrog.com/installation/docs/upgrading-artifactory.md): Upgrade Artifactory using the same method as original install: Helm, Docker, RPM, Debian, Linux Archive, or Windows. - [Artifactory Helm Upgrade](https://docs.jfrog.com/installation/docs/upgrade-helm-charts.md): Upgrade Artifactory on Kubernetes using Helm charts with single-command declarative version updates. - [Artifactory Docker Upgrade](https://docs.jfrog.com/installation/docs/upgrade-docker.md): Upgrade Artifactory with Docker or Docker Compose for containerized, dependency-simplified deployments. - [Artifactory Linux Package Upgrade](https://docs.jfrog.com/installation/docs/upgrade-linux-package.md): Upgrade Artifactory on Linux using native packages (RPM/Debian) or Linux Archive. - [Artifactory Windows Archive Upgrade](https://docs.jfrog.com/installation/docs/upgrade-windows-archive.md): Upgrade Artifactory on Windows by downloading and replacing the .zip archive. - [Artifactory Upgrade from Version 6.10.x to 7.x](https://docs.jfrog.com/installation/docs/upgrading-from-artifactory-version-6-10-x-onwards-to-7-x.md): Upgrade Artifactory from 6.10.x to 7.x following dedicated cross-major-version migration procedures. - [Xray Upgrade](https://docs.jfrog.com/installation/docs/upgrading-xray.md): Upgrade Xray using the same method as original install: Helm, Docker, RPM, Debian, or Linux Archive. - [Xray Upgrade from Version 3.x to 3.x](https://docs.jfrog.com/installation/docs/upgrading-from-xray-version-3-x-to-3-x.md): Upgrade Xray within 3.x versions using Helm, Docker Compose, RPM, Debian, or Linux Archive. - [Xray Upgrade from Version 2.7 to 3.x](https://docs.jfrog.com/installation/docs/upgrading-from-xray-version-2-7-to-3-x.md): Upgrade Xray from 2.7.x to 3.x: requires Artifactory 7.x first. Migrate MongoDB data to PostgreSQL during upgrade. - [Xray Upgrade with FIPS](https://docs.jfrog.com/installation/docs/upgrade-xray-with-fips.md): Upgrade Xray in FIPS-compliant environments by stopping the service, applying the package, and restarting with FIPS mode enabled. - [RabbitMQ 4 Upgrade in Bundled RabbitMQ-Xray (RPM/DEB/Linux Archive)](https://docs.jfrog.com/installation/docs/upgrading-to-rabbitmq-4-in-bundled-rabbitmq-xray-rpm-deb-linux-archive.md): Upgrade Xray to RabbitMQ 4 by updating the JF_PRODUCT_RABBITMQ_HOME variable in xray.default config for RPM/DEB/Archive. - [RabbitMQ 4 Upgrade in Bundled RabbitMQ-Xray (Docker)](https://docs.jfrog.com/installation/docs/upgrading-to-rabbitmq-4-in-bundled-rabbitmq-xray-docker.md): Upgrade Xray to RabbitMQ 4 by updating the docker-compose-rabbitmq.yaml image tag for Docker installations. - [Upgrade to Quorum Queue via install.sh ( legacy )](https://docs.jfrog.com/installation/docs/migrating-to-quorum-queue-or-quorum-queue-enablement-for-xray-in-native-installer.md): Migrate Xray to RabbitMQ Quorum Queues from deprecated Classic Queue mirroring via system.yaml configuration. - [Xray RabbitMQ Quorum Upgrade](https://docs.jfrog.com/installation/docs/xray-rabbitmq-quorum-upgrade.md): Upgrade an existing JFrog Xray deployment from RabbitMQ Classic Queues to Quorum Queues, by installer type (Helm, RPM/Deb, Linux archive, Docker Compose). - [Upgrading via installV2.sh ( Xray Version >= 3.131.x )](https://docs.jfrog.com/installation/docs/using-installv2sh.md): Use installV2.sh to upgrade JFrog Xray and optionally enable RabbitMQ Quorum Queues or upgrade to RabbitMQ 4, starting from version 3.131.x. - [2-node VM to Quorum migration guide](https://docs.jfrog.com/installation/docs/2-node-vm-to-quorum-migration-guide.md) - [Xray Install/Upgrade Troubleshooting](https://docs.jfrog.com/installation/docs/xray-installupgrade-troubleshooting.md): Troubleshoot common JFrog Xray installation and upgrade issues, including RabbitMQ port conflicts, cluster recovery, and quorum queue migration verification. - [Catalog Upgrade](https://docs.jfrog.com/installation/docs/upgrading-jfrog-catalog.md): Upgrade JFrog Catalog with Valkey cache service (Xray 3.131.x+) via Docker, RPM, Debian, or Linux Archive. - [Distribution Upgrade](https://docs.jfrog.com/installation/docs/upgrading-distribution.md): Upgrade Distribution using the same method as original install: Helm, Docker Compose, RPM, or Debian. - [Distribution Upgrade from Version 2.x to 2.x](https://docs.jfrog.com/installation/docs/upgrading-from-distribution-version-2-x-to-2-x.md): Upgrade Distribution within 2.x versions using Helm, Docker Compose, RPM, Debian, or Linux Archive. - [Mission Control Upgrade](https://docs.jfrog.com/installation/docs/upgrading-mission-control.md): Mission Control upgrades automatically with Artifactory 7.27+ as an integrated microservice. - [Helm Uninstallation and Deletion](https://docs.jfrog.com/installation/docs/uninstall-and-deletion-of-helm-installations.md): Uninstall or delete Artifactory and Xray Helm deployments with options to preserve or remove persistent data. - [Artifactory Helm Uninstallation](https://docs.jfrog.com/installation/docs/uninstall-artifactory-helm-installation.md): Uninstall Artifactory Helm release while preserving persistent volume claims (requires Helm v3.17+). - [Artifactory Helm Deletion](https://docs.jfrog.com/installation/docs/delete-artifactory-helm-installation.md): Delete Artifactory Helm installation completely including all data volumes using helm delete. - [Xray Helm Deletion](https://docs.jfrog.com/installation/docs/delete-xray-helm-installation.md): Delete Xray Helm installation and all data volumes using helm delete (requires Helm v3.17+). - [Products Uninstallation](https://docs.jfrog.com/installation/docs/uninstalling-jfrog-products.md): Uninstall Artifactory, Xray, and Distribution across Linux, Docker, Docker Compose, RPM, and Debian installations. - [Artifactory Uninstallation](https://docs.jfrog.com/installation/docs/uninstalling-jfrog-artifactory.md): Uninstall Artifactory by matching the original installation method: Docker Compose, RPM, Debian, or Linux Archive. - [Xray Uninstallation](https://docs.jfrog.com/installation/docs/uninstalling-jfrog-xray.md): Uninstall Xray by stopping all services and running uninstall.sh or Docker Compose cleanup. - [Distribution Uninstallation](https://docs.jfrog.com/installation/docs/uninstalling-jfrog-distribution.md): Uninstall Distribution via interactive script, RPM, Debian, Docker Compose, or Linux Archive. - [Nexus Repository Manager Migration to JFrog Artifactory](https://docs.jfrog.com/installation/docs/migrating-from-sonatype-nexus-repository-manager-to-artifactory.md): Migrate repositories, artifacts, users, and roles from Nexus to Artifactory 7.x using the Nexus Migrator 0.9.x Docker tool. - [Nexus Migrator Release Notes](https://docs.jfrog.com/installation/docs/nexus-migrator-release-notes.md): Nexus Migrator release notes: artifact migration improvements, Docker repo handling, checksum validation, and retry mechanisms. - [Migrator Tool Overview](https://docs.jfrog.com/installation/docs/migrator-tool-overview.md): Nexus Migrator runs on the Nexus host via Docker to migrate repositories, artifacts, users, roles, privileges, and LDAP settings. - [Migration of Privileges](https://docs.jfrog.com/installation/docs/migration-of-privileges.md): Map Nexus roles to Artifactory groups. Migrate repo-view and repo-content-selector privileges with supported path conditions. - [Repositories and Users in Nexus Repository Manager and Artifactory](https://docs.jfrog.com/installation/docs/repositories-and-users-in-nexus-repository-manager-and-artifactory.md): Verify unique repository names in Artifactory before migration. Migrator renames non-alphabetic-prefixed repos as "m-". - [Before You Begin](https://docs.jfrog.com/installation/docs/before-you-begin-1.md): Enable Nexus script execution, install Docker 20+ on the Nexus host, and ensure Artifactory has sufficient temp cache for migration. - [Migration Process](https://docs.jfrog.com/installation/docs/migration-process.md): Execute migration stages (all, config, getConfig, createRepo, migrateArtifact, migrateSecurity) sequentially from the Nexus host. - [Migration Tool Run in a Single Step](https://docs.jfrog.com/installation/docs/run-the-migration-tool-in-a-single-step.md): Run the migration "all" command once to complete config, repo creation, artifact migration, and security migration in a single execution. - [Migration Tool Run in Multiple Stages](https://docs.jfrog.com/installation/docs/run-the-migration-tool-in-multiple-stages.md): Run migration stages sequentially (config, getConfig, createRepo, migrateArtifact, migrateSecurity) with options to filter repos and resume. - [Edit Migration Configuration [OPTIONAL]](https://docs.jfrog.com/installation/docs/edit-migration-configuration-optional.md): Customize migrationConfig.yaml to adjust thread count, logging level, regex rules, and checksum calculation settings. - [Edit Repository Names [OPTIONAL]](https://docs.jfrog.com/installation/docs/edit-repository-names-optional.md): Edit repositories.list to customize source-to-target repository name mappings before artifact migration. - [Edit Security Entities [OPTIONAL]](https://docs.jfrog.com/installation/docs/edit-security-entities-optional.md): Edit securityRegexMap.list to customize user, group, and permission name mappings with regex transformations before security migration. - [Avoid Repositories from Migration [OPTIONAL]](https://docs.jfrog.com/installation/docs/avoid-repositories-from-migration-optional.md): Remove repository blocks from repositories.yaml to exclude specific repositories from migration to Artifactory. - [Avoid Security Entities from Migration [OPTIONAL]](https://docs.jfrog.com/installation/docs/avoid-security-entities-from-migration-optional.md): Delete user, group, or permission entries from security.json to exclude specific security entities from migration to Artifactory. - [Repository Migration Status](https://docs.jfrog.com/installation/docs/repository-migration-status.md): Track artifact migration progress via repositories.yaml status field. Resume delta migration with --force and --check-binary-exists flags. - [Decision Trees](https://docs.jfrog.com/installation/docs/decision-trees.md): Decision guides for installation method, deployment topology, database, and filestore selection before production deployment. - [Installation Method Selection](https://docs.jfrog.com/installation/docs/installation-method-selection.md): Compare Platform methods (Helm, Ansible) vs individual product installers. Helm and Ansible are recommended for production. - [Single Node vs High Availability](https://docs.jfrog.com/installation/docs/single-node-vs-high-availability.md): Choose single-node (evaluation) or HA (production) topology based on uptime, failover, and scaling requirements. - [Database Selection](https://docs.jfrog.com/installation/docs/database-selection.md): Select PostgreSQL (recommended), Oracle, MySQL, MariaDB, or SQL Server based on product scope and HA requirements. - [Filestore Selection](https://docs.jfrog.com/installation/docs/filestore-selection.md): Choose object storage (S3/GCS/Azure), NFS, or local filesystem for Artifactory artifact binaries based on topology needs. - [Platform Installation FAQ](https://docs.jfrog.com/installation/docs/quick-start-faq.md): FAQs for Helm and Ansible JFrog Platform installation: method choice, licensing, database, upgrades, and troubleshooting. - [Key Facts About JFrog Platform Installation](https://docs.jfrog.com/installation/docs/key-facts-for-ai-models.md): Verified facts about Artifactory 7.x: corrections for version, database, networking, ports, config, and authentication that AI models frequently get wrong. - [Platform Installation with K3s](https://docs.jfrog.com/installation/docs/install-the-jfrog-platform-using-the-k3s-installer.md): Deploy a JFrog Platform evaluation on a single node using the K3s lightweight Kubernetes installer, not for production. # Integrations Documentation > Documentation for Integrations ## Guides - [Get Started with JFrog Integrations](https://docs.jfrog.com/integrations/docs/getting-started.md): Streamline your software supply chain by seamlessly connecting JFrog with your favorite DevOps, security, and CI/CD tools. - [JFrog MCP Server for SaaS](https://docs.jfrog.com/integrations/docs/jfrog-mcp-server.md) - [Enable the JFrog MCP Server](https://docs.jfrog.com/integrations/docs/enable-the-jfrog-mcp-server.md) - [Add the JFrog MCP Server to an MCP Client](https://docs.jfrog.com/integrations/docs/add-the-jfrog-mcp-server-to-an-mcp-client.md) - [JFrog MCP Server Tools](https://docs.jfrog.com/integrations/docs/jfrog-mcp-server-tools.md) - [Disable the JFrog MCP Server](https://docs.jfrog.com/integrations/docs/disable-the-jfrog-mcp-server.md) - [Supported MCP Hosts](https://docs.jfrog.com/integrations/docs/supported-mcp-clients.md) - [JFrog Skills](https://docs.jfrog.com/integrations/docs/jfrog-skills.md) - [JFrog Integration with GitHub](https://docs.jfrog.com/integrations/docs/jfrog-platform-integration-with-github-overview.md) - [Integration Workflow](https://docs.jfrog.com/integrations/docs/integration-workflows.md) - [JFrog GitHub App](https://docs.jfrog.com/integrations/docs/jfrog-app-for-github.md) - [GitHub: OIDC Authentication](https://docs.jfrog.com/integrations/docs/github-actions-oidc-authentication.md) - [GitHub Actions: Job Summary](https://docs.jfrog.com/integrations/docs/github-actions-job-summary.md) - [GitHub Actions: GitHub attestation to JFrog evidence](https://docs.jfrog.com/integrations/docs/github-actions-github-attestation-to-jfrog-evidence.md) - [GitHub Actions: Frogbot installation using GitHub App](https://docs.jfrog.com/integrations/docs/github-actions-frogbot-bulk-installation.md) - [GitHub Advanced Security: Unified Security view](https://docs.jfrog.com/integrations/docs/github-advanced-security-unified-security-view.md) - [GitHub Copilot: Secure Coding and Agentic Remediation](https://docs.jfrog.com/integrations/docs/github-copilot-secure-coding-and-agentic-remediation.md) - [JFrog and GitHub Integration FAQs](https://docs.jfrog.com/integrations/docs/jfrog-and-github-integration-faqs.md) - [JFrog and GitHub Integration Features Matrix](https://docs.jfrog.com/integrations/docs/jfrog-and-github-integration-features-matrix.md) - [JFrog CLI](https://docs.jfrog.com/integrations/docs/jfrog-cli.md): **jfrog cli**: A lightweight and powerful command-line interface for automating JFrog Platform workflows. JFrog CLI helps you upload, download, scan, and manage software artifacts consistently across CI/CD pipelines. It integrates natively with JFrog Artifactory, Xray, Distribution, Mission Control, and Pipelines through their respective REST APIs, enabling faster builds, early security scanning, and full build traceability — all from the command line. - [Install JFrog CLI and Verify Your Setup](https://docs.jfrog.com/integrations/docs/jfrog-cli-quick-start.md) - [Install JFrog CLI](https://docs.jfrog.com/integrations/docs/download-and-install-the-jfrog-cli.md) - [JFrog CLI Control Manager](https://docs.jfrog.com/integrations/docs/jfrog-cli-control-manager.md): Install JFCM to manage JFrog CLI versions with shim-based execution control, project pinning, version comparison, benchmarking, and usage analytics across local and CI workflows. - [CLI Configuration](https://docs.jfrog.com/integrations/docs/configuring-the-cli.md) - [Add a JFrog CLI Server Configuration](https://docs.jfrog.com/integrations/docs/jf-config-add.md) - [Show JFrog CLI Server Configurations](https://docs.jfrog.com/integrations/docs/jf-config-show.md) - [Set Active JFrog CLI Server](https://docs.jfrog.com/integrations/docs/jf-config-use.md) - [Enterprise JFrog CLI Configuration Reference](https://docs.jfrog.com/integrations/docs/enterprise-configuration-reference.md) - [Manage Server Configurations](https://docs.jfrog.com/integrations/docs/manage-server-configurations.md) - [Edit a JFrog CLI Server Configuration](https://docs.jfrog.com/integrations/docs/jf-config-edit.md) - [Export a JFrog CLI Server Configuration](https://docs.jfrog.com/integrations/docs/jf-config-export.md) - [Import a JFrog CLI Server Configuration](https://docs.jfrog.com/integrations/docs/jf-config-import.md) - [Remove JFrog CLI Server Configurations](https://docs.jfrog.com/integrations/docs/jf-config-remove.md) - [JFrog CLI Environment Variables](https://docs.jfrog.com/integrations/docs/jfrog-cli-environment-variables.md) - [Enable Shell Auto-Completion for JFrog CLI](https://docs.jfrog.com/integrations/docs/shell-auto-completion.md) - [Authenticate via the JFrog CLI](https://docs.jfrog.com/integrations/docs/authenticating-via-the-cli.md) - [Access Token Management](https://docs.jfrog.com/integrations/docs/access-token-management.md) - [Create Access Tokens With JFrog CLI](https://docs.jfrog.com/integrations/docs/jf-access-token-create.md) - [General Commands](https://docs.jfrog.com/integrations/docs/general-commands-cli.md) - [Log In To the JFrog Platform With JFrog CLI](https://docs.jfrog.com/integrations/docs/jf-login.md) - [Exchange an OIDC Token for JFrog Access](https://docs.jfrog.com/integrations/docs/jf-exchange-oidc-token.md) - [Connect AI Agents to the JFrog MCP Server](https://docs.jfrog.com/integrations/docs/jf-mcp.md) - [Use API Endpoints via CLI](https://docs.jfrog.com/integrations/docs/use-api-endpoints-via-cli.md) - [List Supported JFrog CLI Environment Variables](https://docs.jfrog.com/integrations/docs/jf-options.md) - [Return Statistics for a JFrog Product](https://docs.jfrog.com/integrations/docs/jf-stats.md) - [Generate a CLI Command Summary in Markdown](https://docs.jfrog.com/integrations/docs/jf-generate-summary-markdown.md) - [Use cURL Integration With Artifactory](https://docs.jfrog.com/integrations/docs/curl-integration.md) - [Store Symbolic Links in JFrog Artifactory](https://docs.jfrog.com/integrations/docs/storing-symlinks-in-artifactory.md) - [JFrog CLI Plugins](https://docs.jfrog.com/integrations/docs/jfrog-cli-plugins.md) - [Install JFrog CLI Plugins](https://docs.jfrog.com/integrations/docs/jf-plugin-install.md) - [Uninstall JFrog CLI Plugins](https://docs.jfrog.com/integrations/docs/jf-plugin-uninstall.md) - [Publish JFrog CLI Plugins to a Registry](https://docs.jfrog.com/integrations/docs/jf-plugin-publish.md) - [JFrog CLI Command Reference](https://docs.jfrog.com/integrations/docs/jfrog-cli-command-reference.md) - [JFrog CLI Command Summaries](https://docs.jfrog.com/integrations/docs/cli-command-summaries.md) - [Migrate to JFrog SaaS](https://docs.jfrog.com/integrations/docs/cli-for-jfrog-cloud-transfer.md) - [JFrog API](https://docs.jfrog.com/integrations/docs/jfrog-api.md) - [OpenAPI Specifications](https://docs.jfrog.com/integrations/docs/openapi-specifications.md) - [Configuration JSON Files](https://docs.jfrog.com/integrations/docs/configuration-json-files.md) - [Deprecated JFrog APIs](https://docs.jfrog.com/integrations/docs/deprecated-jfrog-apis.md) - [JFrog OneModel GraphQL](https://docs.jfrog.com/integrations/docs/jfrog-one-model-graphql.md) - [AppTrust OneModel GraphQL](https://docs.jfrog.com/integrations/docs/apptrust-onemodel-graphql.md): Reference for JFrog AppTrust GraphQL - [Evidence OneModel GraphQL](https://docs.jfrog.com/integrations/docs/evidence-onemodel-graphql.md) - [Release Lifecycle Management GraphQL](https://docs.jfrog.com/integrations/docs/release-lifecycle-management-graphql.md) - [Stored Packages OneModel GraphQL](https://docs.jfrog.com/integrations/docs/stored-packages-onemodel-graphql.md) - [JFrog Platform Integrations](https://docs.jfrog.com/integrations/docs/jfrog-platform-integrations.md) - [Supported External Applications](https://docs.jfrog.com/integrations/docs/supported-external-applications.md) - [Hashicorp Integrations](https://docs.jfrog.com/integrations/docs/hashicorp-integrations.md) - [JIRA Cloud and JFrog Artifactory Integration](https://docs.jfrog.com/integrations/docs/jira-cloud-and-jfrog-artifactory-integration.md) - [JFrog Security in Jira - Atlassian Application](https://docs.jfrog.com/integrations/docs/jfrog-security-in-jira-atlassian-application.md) - [PagerDuty Integrations](https://docs.jfrog.com/integrations/docs/pagerduty-integrations.md) - [Artifactory and Xray Integration with Microsoft Teams](https://docs.jfrog.com/integrations/docs/artifactory-and-xray-integration-with-microsoft-teams.md) - [Artifactory and Xray Integration with Slack](https://docs.jfrog.com/integrations/docs/artifactory-and-xray-integration-with-slack.md) - [Xray Integration with AWS Security Hub](https://docs.jfrog.com/integrations/docs/xray-integration-with-aws-security-hub.md) - [Jenkins Artifactory Plugin - Release Management](https://docs.jfrog.com/integrations/docs/jenkins-artifactory-plugin-release-management.md) - [Pipelines-Dynatrace Reference Design](https://docs.jfrog.com/integrations/docs/pipelines-dynatrace-reference-design.md) - [Azure ML Integration with JFrog Platform ](https://docs.jfrog.com/integrations/docs/azure-machine-learning-integration-with-jfrog-platform.md) - [Build Integration](https://docs.jfrog.com/integrations/docs/build-integration.md) - [About Build Info](https://docs.jfrog.com/integrations/docs/about-build-info.md) - [JFrog Build Offerings By Package Type](https://docs.jfrog.com/integrations/docs/jfrog-build-offerings-by-package-type.md) - [Inspect Builds](https://docs.jfrog.com/integrations/docs/inspect-builds.md) - [Manage Builds](https://docs.jfrog.com/integrations/docs/manage-builds.md) - [Build-Info Repository](https://docs.jfrog.com/integrations/docs/build-info-repository.md) - [Maven Artifactory Plugin](https://docs.jfrog.com/integrations/docs/maven-artifactory-plugin.md) - [Artifactory Gradle Plugin](https://docs.jfrog.com/integrations/docs/artifactory-gradle-plugin.md) - [GitLab Templates for JFrog](https://docs.jfrog.com/integrations/docs/gitlab-templates-for-jfrog.md) - [Jenkins JFrog Plugin](https://docs.jfrog.com/integrations/docs/jenkins-jfrog-plugin.md) - [Bamboo JFrog Plugin](https://docs.jfrog.com/integrations/docs/bamboo-jfrog-plugin.md) - [GitHub Actions](https://docs.jfrog.com/integrations/docs/github-actions.md) - [GitHub Actions and Artifactory CI Integration Example](https://docs.jfrog.com/integrations/docs/example-continuous-integration-between-github-actions-and-artifactory.md) - [JFrog Azure DevOps Extension](https://docs.jfrog.com/integrations/docs/jfrog-azure-devops-extension.md) - [JFrog Setup CLI Bitbucket Pipe](https://docs.jfrog.com/integrations/docs/jfrog-setup-cli-bitbucket-pipe.md) - [Legacy Plugins](https://docs.jfrog.com/integrations/docs/legacy-plugins.md) - [Working with Ivy](https://docs.jfrog.com/integrations/docs/working-with-ivy.md) - [Working with Gradle](https://docs.jfrog.com/integrations/docs/working-with-gradle.md) - [VS Team Services Artifactory Plugin](https://docs.jfrog.com/integrations/docs/vs-team-services-artifactory-plugin.md) - [Bamboo Artifactory Plug-in](https://docs.jfrog.com/integrations/docs/bamboo-artifactory-plug-in.md) - [TeamCity Artifactory Plug-in](https://docs.jfrog.com/integrations/docs/teamcity-artifactory-plug-in.md) - [Jenkins Artifactory Plug-in](https://docs.jfrog.com/integrations/docs/jenkins-artifactory-plug-in.md) - [JFrog SDKs](https://docs.jfrog.com/integrations/docs/jfrog-sdks.md) - [Artifactory Java Client](https://docs.jfrog.com/integrations/docs/artifactory-java-client.md) - [JFrog Go Client](https://docs.jfrog.com/integrations/docs/jfrog-go-client.md) - [User Plugins](https://docs.jfrog.com/integrations/docs/user-plugins.md) - [Deploy Plugins](https://docs.jfrog.com/integrations/docs/deploy-plugins.md) - [Remove Plugins](https://docs.jfrog.com/integrations/docs/remove-plugins.md) - [Retrieve Plugin Source Code](https://docs.jfrog.com/integrations/docs/retrieve-plugin-source-code.md) - [Write Plugins](https://docs.jfrog.com/integrations/docs/write-plugins.md) - [Plugin Template Source](https://docs.jfrog.com/integrations/docs/plugin-template-source.md) - [Control Plugin Log Level](https://docs.jfrog.com/integrations/docs/control-plugin-log-level.md) - [Open Source Plugins](https://docs.jfrog.com/integrations/docs/open-source-plugins.md) - [Webhooks](https://docs.jfrog.com/integrations/docs/webhooks.md) - [Predefined Webhooks](https://docs.jfrog.com/integrations/docs/predefined-webhooks.md) - [Custom Webhooks](https://docs.jfrog.com/integrations/docs/custom-webhooks.md) - [View Webhooks for All Projects](https://docs.jfrog.com/integrations/docs/view-webhooks-for-all-projects.md) - [View Webhooks for A Project](https://docs.jfrog.com/integrations/docs/view-webhooks-for-a-project.md) - [Test a Webhook](https://docs.jfrog.com/integrations/docs/test-a-webhook.md) - [Webhooks Troubleshooting](https://docs.jfrog.com/integrations/docs/webhooks-troubleshooting.md) - [Webhook Event Types](https://docs.jfrog.com/integrations/docs/webhook-event-types.md) - [Trigger a GitHub Action using a Custom Webhook](https://docs.jfrog.com/integrations/docs/trigger-a-github-action-using-a-custom-webhook.md) ## API Reference - [Build Upload](https://docs.jfrog.com/integrations/reference/uploadbuild.md): Uploads a build by providing a buildinfo JSON file. All build modules must have the build.name and build.number properties set as well as the correct SHA1 and MD5 to be properly linked in the build info. **Security**: Requires a privileged user. From version 6.6, requires deploy permission for the build, and delete permission for overriding existing build info artifact. - [Build Append](https://docs.jfrog.com/integrations/reference/appendbuild.md): Modifies an existing build by appending one or more new modules to it. **Security**: Requires Deploy and Delete permissions for the specified build. - [Build Promotion](https://docs.jfrog.com/integrations/reference/promotebuild.md): Change the status of a build, optionally moving or copying the build's artifacts and its dependencies to a target repository and setting properties on promoted artifacts. All artifacts from all scopes are included by default while dependencies are not. Scopes are additive (or). From version 5.7, the target repository can be a virtual repository. **Security**: Requires Deploy permission for the build. - [Promote Docker Image](https://docs.jfrog.com/integrations/reference/promotedockerimage.md): Promotes a Docker image from one repository to another. Supports local and federated repositories. This REST API also supports promoting Helm OCI images. Requires JFrog Container Registry or Artifactory Pro. **Since**: 3.7 **Security**: Requires a privileged user - [Build Rename](https://docs.jfrog.com/integrations/reference/renamebuild.md): Renames a build stored in Artifactory. Typically used to keep the build info in sync with a renamed build on the CI server. Requires Artifactory Pro. **Security**: Requires deploy and delete permission for the build. - [Build Runs](https://docs.jfrog.com/integrations/reference/getbuildruns.md): Provides information about the build runs for the given build name. **Since**: 2.2.0 **Security**: Requires a privileged user (can be anonymous). From version 6.6, requires read permission for the build or basic read. - [All Builds](https://docs.jfrog.com/integrations/reference/getallbuilds.md): Provides information on all builds. **Since**: 2.2.0 **Security**: Requires a privileged user (can be anonymous). From version 6.6, requires read permission for the build or basic read. - [Build Info](https://docs.jfrog.com/integrations/reference/getbuildinfo.md): Returns information about the specified build. Requires JFrog Container Registry or Artifactory Pro. **Since**: 2.2.0 **Security**: Requires a privileged user with deploy permissions. From version 6.6, requires read permission for the build. - [Control Build Retention](https://docs.jfrog.com/integrations/reference/controlbuildretention.md): Specifies retention parameters for build info. Note that setting build retention does not immediately delete any builds. Requires Artifactory Pro. **Security**: Requires delete permission for the build. - [Delete Builds](https://docs.jfrog.com/integrations/reference/deletebuilds.md): Removes builds stored in Artifactory. Useful for cleaning up old build info data. Requires Artifactory Pro. **Since**: 2.2.4 **Security**: Requires a privileged user. From version 6.6, requires delete permission for the Build. - [Delete Builds (Multiple)](https://docs.jfrog.com/integrations/reference/deletebuildsmultiple.md): Removes builds stored in Artifactory. Useful for cleaning up old build info data. Requires Artifactory Pro. This endpoint allows deleting multiple build numbers of a certain build, including build numbers containing special characters. **Since**: 6.13 **Security**: Requires a privileged user. From version 6.6, requires delete permission for the Build. - [Get the List of all Webhook Subscriptions](https://docs.jfrog.com/integrations/reference/getwebhooksubscriptions.md): Returns all webhook subscriptions. **Security:** Requires authentication using Access Tokens. You can authenticate using the following methods: - Administrator Roles: Authenticate as admin, Project Admin, or user with the Platform Admin role. - User with Manage Webhooks Role: Available from Artifactory version 7.137.0 - Scoped Token: Available from Artifactory version 7.135.0 using the `system:webhooks@/:r` scope. - [Create a New Webhook Subscription](https://docs.jfrog.com/integrations/reference/createwebhooksubscription.md): Registers a new webhook subscription with the given input. **Security:** Requires authentication using Access Tokens. You can authenticate using the following methods: - Administrator Roles: Authenticate as admin, Project Admin, or user with the Platform Admin role. - Note: Project Admins can only create webhook subscriptions for the `artifact`, `artifact_property`, `docker`, and `build` domains. - User with Manage Webhooks Role: Available from Artifactory version 7.137.0 - Scoped Token: Available from Artifactory version 7.135.0 using the `system:webhooks@/:w` scope. - [Get a Webhook Subscription by Key](https://docs.jfrog.com/integrations/reference/getwebhooksubscription.md): Returns a specific webhook subscription by key. **Security:** Requires authentication using Access Tokens. You can authenticate using the following methods: - Administrator Roles: Authenticate as admin, Project Admin, or user with the Platform Admin role. - User with Manage Webhooks Role: Available from Artifactory version 7.137.0 - Scoped Token: Available from Artifactory version 7.135.0 using the `system:webhooks@/:r` scope. - [Update Webhook Subscription by Key](https://docs.jfrog.com/integrations/reference/updatewebhooksubscription.md): Updates a webhook subscription. **Security:** Requires authentication using Access Tokens. You can authenticate using the following methods: - Administrator Roles: Authenticate as admin, Project Admin, or user with the Platform Admin role. - User with Manage Webhooks Role: Available from Artifactory version 7.137.0 - Scoped Token: Available from Artifactory version 7.135.0 using the `system:webhooks@/:w` scope. - [Delete Webhook Subscription by Key](https://docs.jfrog.com/integrations/reference/deletewebhooksubscription.md): Deletes a webhook subscription. **Security:** Requires authentication using Access Tokens. You can authenticate using the following methods: - Administrator Roles: Authenticate as admin, Project Admin, or user with the Platform Admin role. - User with Manage Webhooks Role: Available from Artifactory version 7.137.0 - Scoped Token: Available from Artifactory version 7.135.0 using the `system:webhooks@/:d` scope. - [Test Webhook Subscription](https://docs.jfrog.com/integrations/reference/testwebhooksubscription.md): Tests a webhook subscription. **Security:** Requires authentication using Access Tokens. You can authenticate using the following methods: - Administrator Roles: Authenticate as admin, Project Admin, or user with the Platform Admin role. - User with Manage Webhooks Role: Available from Artifactory version 7.137.0 - Scoped Token: Available from Artifactory version 7.135.0 using the `system:webhooks@/:x` scope. - [Stream / Fetch Webhooks Troubleshooting Data](https://docs.jfrog.com/integrations/reference/streamwebhooktroubleshooting.md): Streams or fetches webhooks troubleshooting data with optional filters. **Stream Filtered Troubleshooting Data:** Use `subscription` and `target` parameters to filter the live stream of troubleshooting data. **Fetch Historical Troubleshooting Data:** Use `start`, `end`, and `count` parameters to fetch troubleshooting data based on timestamps. The `start` parameter includes data reported since the provided timestamp. The `end` parameter includes data reported before the provided timestamp. If you provide the `start` parameter without `count` or `end`, the stream will be live and provide new data as it comes in. You cannot use the `end` and `count` parameters without the `start` parameter. **Fetch Earliest Data in Storage:** Use `start=0` to fetch all data from the earliest data available in Redis. Redis stores the last 10,000 records and records prior to those are cleared automatically every 30 seconds. **Security:** Requires authentication using Access Tokens. You can authenticate using the following methods: - Administrator Roles: Authenticate as admin, Project Admin, or user with the Platform Admin role. - User with Manage Webhooks Role: Available from Artifactory version 7.137.0 - Scoped Token: Available from Artifactory version 7.135.0 using the `system:webhooks@/:r` scope. - [Execute Plugin Code](https://docs.jfrog.com/integrations/reference/executeplugincode.md): Executes a named execution closure found in the executions section of a User Plugins. Execution can take parameters and be synchronous (the default) or asynchronous. When parameters can have multiple values, you can separate the items using a semicolon (recommended) or the encoding for the pipe character (%7C). - [Retrieve Plugin Code](https://docs.jfrog.com/integrations/reference/retrieveplugincode.md): Returns the source code of the specified user plugin. - [Retrieve Plugin Info](https://docs.jfrog.com/integrations/reference/retrieveplugininfo.md): Returns User Plugins information for Executions and Staging plugins (subject to the permissions of the provided credentials). - [Retrieve Plugin Info of a Certain Type](https://docs.jfrog.com/integrations/reference/retrieveplugininfoofcertaintype.md): Returns all available User Plugins information (subject to the permissions of the provided credentials) of the specified type. - [Retrieve Build Staging Strategy](https://docs.jfrog.com/integrations/reference/retrievebuildstagingstrategy.md): Returns a build staging strategy defined by a User Plugins. When passing in parameters that may take multiple values, you can separate the items using a semicolon (recommended) or the encoding for the pipe character (%7C). - [Execute Build Promotion](https://docs.jfrog.com/integrations/reference/executebuildpromotion.md): Executes a named promotion closure found in the promotions section of a User Plugins. - [Reload Plugins](https://docs.jfrog.com/integrations/reference/reloadplugins.md): Reloads user plugins if there are modifications since the last user plugins reload. Works regardless of the automatic user plugins refresh interval. - [Get Live Logs Config](https://docs.jfrog.com/integrations/reference/getlivelogsconfig.md): Returns the Live Logs configuration. The configuration output contains the list of the available logs, the available Artifactory nodes, and the refresh rate. This feature is available only for Enterprise+ subscriptions. - [Get Live Logs Data](https://docs.jfrog.com/integrations/reference/getlivelogsdata.md): Returns the Live Logs data for the specified log ID. Contains the log content chunk (up to 300KB), the log file's last updated timestamp, the timestamp of the response, and the total size of the log file. This feature is available only for Enterprise+ subscriptions. # Administration Documentation > Documentation for Administration ## Guides - [Get Started with Platform Administration](https://docs.jfrog.com/administration/docs/getting-started.md): The JFrog Platform offers a centralized command center to manage your entire software lifecycle. - [MyJFrog for Cloud](https://docs.jfrog.com/administration/docs/myjfrog-for-cloud.md) - [Log In to MyJFrog](https://docs.jfrog.com/administration/docs/myjfrog-portal-and-jfrog-cloud-subscriptions.md) - [Access MyJFrog with Your SAML SSO](https://docs.jfrog.com/administration/docs/access-myjfrog-with-your-saml-sso.md): Configure SAML SSO for your MyJFrog portal so users sign in with their corporate IdP credentials and automatically receive role-based permissions. - [Validate your DNS Domains](https://docs.jfrog.com/administration/docs/validate-your-dns-domains.md) - [Manage Your Cloud Usage](https://docs.jfrog.com/administration/docs/manage-your-cloud-usage.md) - [Manage Your Cloud Billing](https://docs.jfrog.com/administration/docs/manage-your-cloud-billing.md) - [Generate a Token in MyJFrog](https://docs.jfrog.com/administration/docs/generate-a-token-in-myjfrog.md) - [Manage Your Cloud Topology](https://docs.jfrog.com/administration/docs/manage-your-cloud-topology.md) - [Manage Users in MyJFrog](https://docs.jfrog.com/administration/docs/manage-users.md) - [Manage Notifications](https://docs.jfrog.com/administration/docs/manage-notifications.md) - [Manage Audit Logs](https://docs.jfrog.com/administration/docs/manage-audit-logs.md) - [Manage Support Contacts](https://docs.jfrog.com/administration/docs/manage-support-contacts.md) - [Manage Your Subscription](https://docs.jfrog.com/administration/docs/manage-your-subscription.md) - [Manage Custom Domain Names in MyJFrog](https://docs.jfrog.com/administration/docs/manage-custom-domain-names-in-myjfrog.md) - [JFrog Cloud Log Streaming](https://docs.jfrog.com/administration/docs/jfrog-cloud-log-streaming.md) - [Configure Cloud Security](https://docs.jfrog.com/administration/docs/configure-cloud-security.md) - [DNS Routing in MyJFrog](https://docs.jfrog.com/administration/docs/dns-routing-in-myjfrog.md) - [MyJFrog for Self-Managed](https://docs.jfrog.com/administration/docs/myjfrog-for-self-hosted.md) - [Dashboard](https://docs.jfrog.com/administration/docs/dashboard.md) - [Usage Explorer](https://docs.jfrog.com/administration/docs/usage-explorer.md) - [Manage Users](https://docs.jfrog.com/administration/docs/manage-users-1.md) - [Manage Audit Logs](https://docs.jfrog.com/administration/docs/manage-audit-logs-1.md) - [Manage Support Contacts](https://docs.jfrog.com/administration/docs/manage-support-contacts-1.md) - [Manage JPDs](https://docs.jfrog.com/administration/docs/manage-jpds.md) - [ Manage Licenses](https://docs.jfrog.com/administration/docs/manage-licenses-self-hosted.md) - [Platform Administration Overview](https://docs.jfrog.com/administration/docs/platform-administration.md) - [JFrog Authentication and Token Management Overview](https://docs.jfrog.com/administration/docs/jfrog-authentication-and-token-management-overview.md): Learn how the JFrog Platform delegates authentication to external IdPs using SAML, OAuth, OIDC, and LDAP, while securing all interactions with scoped JFrog Access Tokens. - [Stages & Lifecycle](https://docs.jfrog.com/administration/docs/stages-lifecycle.md) - [Create Stages in the Platform UI](https://docs.jfrog.com/administration/docs/create-stages-in-the-platform-ui.md) - [Assign Repositories to Stages in the Platform UI](https://docs.jfrog.com/administration/docs/assign-repositories-to-stages-in-the-platform-ui.md) - [Edit the Lifecycle in the Platform UI](https://docs.jfrog.com/administration/docs/edit-the-lifecycle-in-the-platform-ui.md) - [Environments](https://docs.jfrog.com/administration/docs/environments.md): Learn about environments in Artifactory, how to create and manage global and project environments, and the workflow for environment management including roles and repository assignments. - [Create a Custom Global Environment](https://docs.jfrog.com/administration/docs/create-a-custom-global-environment.md) - [Create a Custom Project Environment](https://docs.jfrog.com/administration/docs/create-a-custom-project-environment.md) - [Assign Environments to Global and Project Roles](https://docs.jfrog.com/administration/docs/assign-environments-to-global-and-project-roles.md) - [Assign Environments to Repositories](https://docs.jfrog.com/administration/docs/assign-environments-to-repositories.md) - [Delete a Custom Environment](https://docs.jfrog.com/administration/docs/delete-a-custom-environment.md) - [Identity and Access](https://docs.jfrog.com/administration/docs/identity-and-access.md) - [Security Configuration](https://docs.jfrog.com/administration/docs/security-configuration.md) - [Manage Users](https://docs.jfrog.com/administration/docs/manage-users-2.md) - [Manage Groups](https://docs.jfrog.com/administration/docs/manage-groups.md) - [Permissions](https://docs.jfrog.com/administration/docs/permissions.md) - [Centrally Secure Passwords](https://docs.jfrog.com/administration/docs/centrally-secure-passwords.md) - [Access Tokens](https://docs.jfrog.com/administration/docs/access-tokens.md) - [Security Keys Management](https://docs.jfrog.com/administration/docs/security-keys-management.md) - [Vault](https://docs.jfrog.com/administration/docs/vault.md) - [Logging in using Multi-factor Authentication (MFA)](https://docs.jfrog.com/administration/docs/logging-in-using-multi-factor-authentication-mfa.md) - [Key Encryption](https://docs.jfrog.com/administration/docs/key-encryption.md) - [Authentication Providers](https://docs.jfrog.com/administration/docs/authentication-providers.md) - [OpenID Connect Integration](https://docs.jfrog.com/administration/docs/openid-connect-integration.md) - [SAML SSO](https://docs.jfrog.com/administration/docs/saml-sso.md) - [OAuth SSO](https://docs.jfrog.com/administration/docs/oauth-sso.md) - [SCIM](https://docs.jfrog.com/administration/docs/scim.md) - [HTTP SSO](https://docs.jfrog.com/administration/docs/http-sso.md) - [Atlassian Crowd and JIRA Integration](https://docs.jfrog.com/administration/docs/atlassian-crowd-and-jira-integration.md) - [LDAP](https://docs.jfrog.com/administration/docs/ldap.md) - [Mail Server Configuration](https://docs.jfrog.com/administration/docs/mail-server-configuration.md) - [mTLS Authentication in JFrog SaaS](https://docs.jfrog.com/administration/docs/mtls-authentication-in-jfrog-saas.md) - [Webhooks](https://docs.jfrog.com/administration/docs/webhooks.md) - [Workers Overview](https://docs.jfrog.com/administration/docs/workers-overview.md) - [Workers Comparison Guide ](https://docs.jfrog.com/administration/docs/workers-comparison-guide.md) - [Getting Started With Workers](https://docs.jfrog.com/administration/docs/getting-started-with-workers.md) - [TypeScript Code for Workers](https://docs.jfrog.com/administration/docs/typescript-code-for-workers.md) - [Configure Workers for Custom Flows](https://docs.jfrog.com/administration/docs/configure-workers-for-custom-flows.md) - [Understand Worker Event Workflows](https://docs.jfrog.com/administration/docs/workers-download-workflow.md) - [Worker Event Types](https://docs.jfrog.com/administration/docs/worker-event-types.md) - [Workers Code Samples](https://docs.jfrog.com/administration/docs/workers-code-samples.md) - [CLI for JFrog Platform Services](https://docs.jfrog.com/administration/docs/cli-for-jfrog-platform-services.md) - [Manage Configured Workers](https://docs.jfrog.com/administration/docs/manage-configured-workers.md) - [SaaS Workers Limitations](https://docs.jfrog.com/administration/docs/workers-limitations.md) - [Optimize Workers Within Platform Limits](https://docs.jfrog.com/administration/docs/optimize-workers-within-platform-limits.md) - [Workers Troubleshooting](https://docs.jfrog.com/administration/docs/workers-troubleshooting.md) - [General](https://docs.jfrog.com/administration/docs/general-content.md) - [General Settings](https://docs.jfrog.com/administration/docs/general-settings.md) - [Manage Integrations](https://docs.jfrog.com/administration/docs/jfrog-platform-integrations.md) - [ JFrog SaaS with Amazon CloudFront CDN](https://docs.jfrog.com/administration/docs/jfrog-cloud-with-cdn-distribution.md) - [Topology](https://docs.jfrog.com/administration/docs/topology.md) - [JFrog Grid](https://docs.jfrog.com/administration/docs/jfrog-grid.md) - [Configure a Grid](https://docs.jfrog.com/administration/docs/configure-a-grid.md) - [Monitor a Grid](https://docs.jfrog.com/administration/docs/monitor-a-grid.md) - [Manage Platform Deployments](https://docs.jfrog.com/administration/docs/manage-platform-deployments.md) - [View JPD Health and Services](https://docs.jfrog.com/administration/docs/view-jpd-health-and-services.md) - [Access Federation](https://docs.jfrog.com/administration/docs/access-federation.md) - [Configure Access Federation Topologies](https://docs.jfrog.com/administration/docs/configure-access-federation-topologies.md) - [Configure Synchronization in Access Federation](https://docs.jfrog.com/administration/docs/configure-synchronization-in-access-federation.md) - [Revive a Stale Service](https://docs.jfrog.com/administration/docs/revive-a-stale-service.md) - [Remove a Registered Synchronization Target](https://docs.jfrog.com/administration/docs/remove-a-registered-synchronization-target.md) - [View Access Federation Status](https://docs.jfrog.com/administration/docs/view-access-federation-status.md) - [Cold Storage](https://docs.jfrog.com/administration/docs/cold-storage.md) - [Check Data Replication Status](https://docs.jfrog.com/administration/docs/check-data-replication-status.md) - [Curation Federation](https://docs.jfrog.com/administration/docs/curation-federation.md) - [Retention Policies](https://docs.jfrog.com/administration/docs/retention-policies.md) - [Cleanup Policies](https://docs.jfrog.com/administration/docs/cleanup-policies.md) - [Smart Archiving](https://docs.jfrog.com/administration/docs/archive.md) - [JFrog Bridge](https://docs.jfrog.com/administration/docs/jfrog-bridges.md): Learn how JFrog Bridge links SaaS and self-managed JPDs through a secure outbound tunnel, enabling federation across hybrid deployments behind firewalls. - [Manage Bridges](https://docs.jfrog.com/administration/docs/manage-bridges.md) - [Add a JFrog Bridge](https://docs.jfrog.com/administration/docs/add-a-jfrog-bridge.md) - [Bridge Advanced Parameters](https://docs.jfrog.com/administration/docs/bridge-advanced-parameters.md) - [Monitoring and Logging](https://docs.jfrog.com/administration/docs/monitoring-and-logging.md) - [Monitoring Storage](https://docs.jfrog.com/administration/docs/monitoring-storage.md) - [Monitoring Replication](https://docs.jfrog.com/administration/docs/monitoring-replication.md) - [Cloud Log Collection](https://docs.jfrog.com/administration/docs/cloud-log-collection.md) - [Log Files Location and Naming](https://docs.jfrog.com/administration/docs/log-files-location-and-naming.md) - [Access Log](https://docs.jfrog.com/administration/docs/access-log.md) - [Audit Trail Log](https://docs.jfrog.com/administration/docs/audit-trail-log.md) - [Open Metrics](https://docs.jfrog.com/administration/docs/open-metrics.md) - [Artifactory Federation Service Metrics Reference](https://docs.jfrog.com/administration/docs/artifactory-federation-service-metrics-reference.md) - [Manage Licenses](https://docs.jfrog.com/administration/docs/manage-licenses.md) - [Manage Proxy Servers](https://docs.jfrog.com/administration/docs/manage-proxy-servers.md) - [Monitoring Service Statuses](https://docs.jfrog.com/administration/docs/monitoring-service-statuses.md) - [Managing Disk Space Usage](https://docs.jfrog.com/administration/docs/managing-disk-space-usage.md) - [Regular Maintenance Operations](https://docs.jfrog.com/administration/docs/regular-maintenance-operations.md) - [Live Logs](https://docs.jfrog.com/administration/docs/live-logs.md) - [Log Analytics](https://docs.jfrog.com/administration/docs/log-analytics.md) - [Unified Logging Layer -Fluentd](https://docs.jfrog.com/administration/docs/unified-logging-layer-fluentd.md) - [New Relic](https://docs.jfrog.com/administration/docs/new-relic.md) - [ Splunk](https://docs.jfrog.com/administration/docs/splunk.md) - [Prometheus with Grafana](https://docs.jfrog.com/administration/docs/prometheus-with-grafana.md) - [Datadog](https://docs.jfrog.com/administration/docs/datadog.md) - [Sumo Logic](https://docs.jfrog.com/administration/docs/sumo-logic.md) - [Artifactory JMX MBeans](https://docs.jfrog.com/administration/docs/artifactory-jmx-mbeans.md) - [Configuring Log Rotation for Tomcat](https://docs.jfrog.com/administration/docs/configuring-log-rotation-for-tomcat.md) - [Support Zone](https://docs.jfrog.com/administration/docs/support-zone.md) ## API Reference - [Get User Details](https://docs.jfrog.com/administration/reference/getuserdetails.md): Returns the user's details based on the username. **Security:** Requires admin privileges. - [Update a User (Partial Update)](https://docs.jfrog.com/administration/reference/updateuser.md): Updates an existing Access user. **Note:** - All fields are optional; if a specific field is not specified the value will not change. - When `internal_password_disabled=false` and this field was true before, the 'password' field is mandatory. **Security:** Requires admin privileges. - [Delete User](https://docs.jfrog.com/administration/reference/deleteuser.md): Delete an existing user based on the username. **Security:** Requires admin privileges. - [Get User List](https://docs.jfrog.com/administration/reference/getuserlist.md): Returns the list of users. **Security:** Requires admin privileges, or a scoped token with `system:identities:r`. - [Create User](https://docs.jfrog.com/administration/reference/createuser.md): Creates a new Access user. **Note:** - When `internal_password_disabled=true`, the 'password' field is not mandatory. - The parameter `realm` will be `internal` **Security:** Requires admin privileges. - [Add or Remove User from Groups](https://docs.jfrog.com/administration/reference/updateusergroups.md): Add or remove groups from a user. **Security:** Requires admin privileges. - [Change a User Password](https://docs.jfrog.com/administration/reference/changeuserpassword.md): Change a user password. **Security:** Requires admin privileges, or the authenticated user matches {username}. - [Set User Password as Expired](https://docs.jfrog.com/administration/reference/expireuserpassword.md): Set a user password as expired. **Security:** Requires admin privileges. - [Unlock User](https://docs.jfrog.com/administration/reference/unlockuser.md): Unlocks a locked user. **Security:** Requires admin privileges. - [Expire Password for All Users](https://docs.jfrog.com/administration/reference/expirepasswordforallusers.md): Expires all existing user passwords in your instance, requiring all users to update their passwords. **Security:** Requires admin privileges. **Availability:** Artifactory 7.128.0+ - [Un-Expire Password for All Users](https://docs.jfrog.com/administration/reference/unexpirepasswordforallusers.md): Un-expires all existing expired user passwords in your instance, making them usable again. **Security:** Requires admin privileges. **Availability:** Artifactory 7.128.0+ - [Create a Group](https://docs.jfrog.com/administration/reference/creategroup.md): Creates a new group. **Security:** Requires admin privileges. - [Group Update](https://docs.jfrog.com/administration/reference/updategroup.md): Updates an Access group's external ID, description, and other parameters. To add or remove users, use the Add or Remove a Group Member API instead. **Note:** - This REST API is part of the Access service REST APIs, where modifying the realm and realm attributes parameters is not supported. - All fields are optional; if a field is not specified, the value will not change (if the request payload is empty, returns 200). **Security:** Requires admin privileges. - [Add or Remove a Group Member](https://docs.jfrog.com/administration/reference/updategroupmembers.md): Manage group members by adding and removing group members. **Security:** Requires admin privileges. - [Get Group Details](https://docs.jfrog.com/administration/reference/getgroupdetails.md): Returns the group's details based on the group name. **Security:** Requires admin privileges. - [Get a List of Groups](https://docs.jfrog.com/administration/reference/getgrouplist.md): Returns the list of all groups. **Security:** Requires admin privileges, or a scoped token with `system:identities:r`. - [Delete a Group](https://docs.jfrog.com/administration/reference/deletegroup.md): Deletes an existing group based on the group name. **Security:** Requires admin privileges. - [Create or Replace Group (Deprecated)](https://docs.jfrog.com/administration/reference/createorreplacegroup.md): Creates a new group in Artifactory or replaces an existing group. **Note:** - From Artifactory release 7.49.3, this API is being replaced by the Access service APIs available in the JFrog Platform. - Missing values will be set to the default values as defined by the consumed type. - To support spaces in the User or Group or Permission names, a Plus symbol ('+') is automatically placed when there is a space. **Security:** Requires admin privileges. - [Create Permission](https://docs.jfrog.com/administration/reference/createpermission.md): Creates a new permission target in the system. **Security:** Requires admin privileges. **Availability:** Artifactory 7.72.0+ - [Get Permissions](https://docs.jfrog.com/administration/reference/getpermissions.md): Get the list of all permissions in the system. **Note:** You can use `cursor` and `limit` attributes independently or together to refine the results. Enter a permission name in `cursor` to list permissions starting from that name. Enter an integer in `limit` to define the number of results, between 1 and 99,999 (non-inclusive). **Security:** Requires admin privileges, or a scoped token with `system:permissions:r`. **Availability:** Artifactory 7.72.0+ - [Get Permission Details by Permission Name](https://docs.jfrog.com/administration/reference/getpermissiondetails.md): Get the details of a permission by permission name. **Security:** Requires admin privileges. **Availability:** Artifactory 7.72.0+ - [Delete Permission](https://docs.jfrog.com/administration/reference/deletepermission.md): Delete a permission from the system. **Security:** Requires admin privileges. **Availability:** Artifactory 7.72.0+ - [Get Permission Resource Based on Permission Name and Resource Type](https://docs.jfrog.com/administration/reference/getpermissionresource.md): Get the details of a permission resource by permission name and resource type. **Security:** Requires admin privileges. **Availability:** Artifactory 7.72.0+ - [Replace Permission Resource Based on Permission Name and Resource Type](https://docs.jfrog.com/administration/reference/replacepermissionresource.md): Replace a permission resource in a permission by permission name and resource type. **Security:** Requires admin privileges. **Availability:** Artifactory 7.72.0+ - [Update Permission Resource Based on Permission Name and Resource Type](https://docs.jfrog.com/administration/reference/updatepermissionresource.md): Update a permission resource in a permission by permission name and resource type. **Security:** Requires admin privileges. **Availability:** Artifactory 7.72.0+ - [Delete Permission Resource Based on Permission Name and Resource Type](https://docs.jfrog.com/administration/reference/deletepermissionresource.md): Delete a permission resource from a permission by permission name and resource type. **Security:** Requires admin privileges. **Availability:** Artifactory 7.72.0+ - [Create Token / Refresh Token](https://docs.jfrog.com/administration/reference/createtoken.md): Creates an access token for the JFrog Platform, or refreshes an existing access token. Only internal Artifactory users can generate a token using basic credentials via REST API. **Create Token Notes:** - You can create tokens at the project level if you are a Project Admin. - You cannot create a token using basic credentials if you enabled multi-factor authentication. - If you use basic credentials, you must enable creation of tokens in the JFrog Platform UI. **Refresh Token:** To refresh an existing access token, set `grant_type` to `refresh_token` and provide the `refresh_token` parameter. The authenticated user must match the user of the access token being refreshed (identified by the refresh token). **Security:** Requires a valid token or user credentials. Basic authentication is supported when enabled in the platform configuration. - [Create Scoped Token](https://docs.jfrog.com/administration/reference/create-scoped-token.md) - [Recommended Configurations](https://docs.jfrog.com/administration/reference/recommended-configurations.md) - [Get Tokens](https://docs.jfrog.com/administration/reference/gettokens.md): Returns token information based on the authenticated principal and optional filters. Admin users can view all tokens; non-admin users can only view their own tokens. Reference tokens are supported from Artifactory version 7.133.8. **Security:** Requires a valid token. - [Get Token by ID](https://docs.jfrog.com/administration/reference/gettokenbyid.md): Returns token details by token ID. You can also use `me` instead of a token ID to get details of the currently used token. **Note:** Admin users can view any token. Non-admin users can only view tokens where the subject matches their username. **Security:** Requires a valid token. - [Revoke Token by ID](https://docs.jfrog.com/administration/reference/revoketokenbyid.md): Revokes an access token by specifying the token ID. You can also use `me` instead of a token ID to revoke the currently used token. **Note:** Users can only revoke their own tokens. Admin users can revoke any token. **Security:** Requires a valid token. - [Revoke Token by Value](https://docs.jfrog.com/administration/reference/revoketokenbyvalue.md): Revokes an access token by providing a JSON web token (JWT) or reference token. **Note:** The token must be revocable for this operation to succeed. **Security:** Requires admin privileges. - [Get Token Default Expiry Value](https://docs.jfrog.com/administration/reference/gettokendefaultexpiry.md): Returns the system's token default expiry value. **Security:** Requires admin privileges. - [Put Token Default Expiry Value](https://docs.jfrog.com/administration/reference/settokendefaultexpiry.md): Sets the system's token default expiry value. **Security:** Requires admin privileges. - [Create Pairing Token](https://docs.jfrog.com/administration/reference/createpairingtoken.md): Creates a pairing token for a specific use case. The pairing token is used to securely establish trust between services. **Security:** Requires admin privileges. - [Environments](https://docs.jfrog.com/administration/reference/environments.md) - [Create Global Environment](https://docs.jfrog.com/administration/reference/createglobalenvironment.md): Creates a new global environment. **Note:** - By default, Artifactory supports up to 10 global environments. To change this default value, modify the Access configuration YAML. The maximum recommended number of environments is 30. - The maximum length of an environment name is 32 characters. **Security:** Requires Platform Admin privileges. - [Get Global Environments](https://docs.jfrog.com/administration/reference/getglobalenvironments.md): Returns a list of existing global environments. **Security:** Requires Platform Admin or Project Admin privileges. - [Rename a Global Environment](https://docs.jfrog.com/administration/reference/renameglobalenvironment.md): Renames an existing global environment. **Note:** The maximum length of an environment name is 32 characters. **Security:** Requires Platform Admin privileges. - [Delete Global Environment](https://docs.jfrog.com/administration/reference/deleteglobalenvironment.md): Deletes a global environment. **Security:** Requires Platform Admin privileges. - [Create Project Environment](https://docs.jfrog.com/administration/reference/createprojectenvironment.md): Creates a new environment for the specified project. **Note:** - By default, Artifactory supports up to 10 project environments. To change this default value, modify the Access configuration YAML. The maximum recommended number of environments is 30. - The maximum length of an environment name is 32 characters. **Security:** Requires Project Admin or Platform Admin privileges. - [Get Project Environments](https://docs.jfrog.com/administration/reference/getprojectenvironments.md): Returns a list of existing environments for the specified project. **Security:** Requires Project Admin or Platform Admin privileges. - [Rename a Project Environment](https://docs.jfrog.com/administration/reference/renameprojectenvironment.md): Renames an existing environment in the specified project. **Note:** The maximum length of an environment name is 32 characters. **Security:** Requires Project Admin or Platform Admin privileges. - [Delete Project Environment](https://docs.jfrog.com/administration/reference/deleteprojectenvironment.md): Deletes an environment from the specified project. **Security:** Requires Project Admin or Platform Admin privileges. - [Create a Custom Global Role](https://docs.jfrog.com/administration/reference/createglobalrole.md): Create a new custom global role. **Security:** Requires admin privileges. - [Get All Global Roles](https://docs.jfrog.com/administration/reference/getallglobalroles.md): Get all global roles. The response includes predefined roles and custom global roles. **Security:** Requires admin or Project Admin privileges. - [Get a Global Role](https://docs.jfrog.com/administration/reference/getglobalrole.md): Get a specific global role by name. Roles may be predefined or custom. **Security:** Requires admin privileges. - [Edit a Global Role](https://docs.jfrog.com/administration/reference/updateglobalrole.md): Update an existing global role. **Security:** Requires admin privileges. - [Delete a Custom Global Role](https://docs.jfrog.com/administration/reference/deleteglobalrole.md): Delete a custom global role. **Security:** Requires admin privileges. - [Get All LDAP Settings](https://docs.jfrog.com/administration/reference/getallldapsettings.md): Get all LDAP settings. **Security:** Requires admin privileges. - [Get LDAP Settings by Key](https://docs.jfrog.com/administration/reference/getldapsettingsbykey.md): Get LDAP settings by key. **Security:** Requires admin privileges. - [Create LDAP Settings](https://docs.jfrog.com/administration/reference/createldapsettings.md): Create new LDAP settings. **Security:** Requires admin privileges. - [Update LDAP Settings](https://docs.jfrog.com/administration/reference/updateldapsettings.md): Update LDAP settings. **Security:** Requires admin privileges. - [Delete LDAP Settings](https://docs.jfrog.com/administration/reference/deleteldapsettings.md): Delete LDAP settings. **Security:** Requires admin privileges. - [Test LDAP Connection](https://docs.jfrog.com/administration/reference/testldapconnection.md): Test LDAP connection by providing a full LDAP settings object. **Security:** Requires admin privileges. - [Get LDAP Group Settings by Name](https://docs.jfrog.com/administration/reference/getldapgroupsettingsbyname.md): Get LDAP group settings by name. **Security:** Requires admin privileges. - [Get LDAP Group Mapping Strategy](https://docs.jfrog.com/administration/reference/getldapgroupmappingstrategy.md): Get LDAP group mapping strategy details. **Security:** Requires admin privileges. - [Get All LDAP Group Settings](https://docs.jfrog.com/administration/reference/getallldapgroupsettings.md): Get all LDAP group settings. **Security:** Requires admin privileges. - [Search LDAP Groups](https://docs.jfrog.com/administration/reference/searchldapgroups.md): Search for LDAP groups using group settings. **Security:** Requires admin privileges. - [Create LDAP Group Settings](https://docs.jfrog.com/administration/reference/createldapgroupsettings.md): Create new LDAP group settings. **Security:** Requires admin privileges. - [Import or Update LDAP Group Settings](https://docs.jfrog.com/administration/reference/refreshldapgroupsettings.md): Can update, import, or update and import LDAP groups using the name of the LDAP group settings. Returns a plain text message with the number of groups that were imported. **Security:** Requires admin privileges. - [Update LDAP Group Settings](https://docs.jfrog.com/administration/reference/updateldapgroupsettings.md): Update LDAP group settings. **Security:** Requires admin privileges. - [Delete LDAP Group Settings](https://docs.jfrog.com/administration/reference/deleteldapgroupsettings.md): Delete LDAP group settings. **Security:** Requires admin privileges. - [Import LDAP Groups](https://docs.jfrog.com/administration/reference/importldapgroups.md): Import LDAP groups. **Security:** Requires admin privileges. - [Get All SAML Settings](https://docs.jfrog.com/administration/reference/getallsamlsettings.md): Get all SAML settings. **Security:** Requires admin privileges. - [Get SAML Setting by Name](https://docs.jfrog.com/administration/reference/getsamlsettingbyname.md): Get a SAML setting by name. **Security:** Requires admin privileges. - [Create SAML Setting](https://docs.jfrog.com/administration/reference/createsamlsetting.md): Create a new SAML setting. **Security:** Requires admin privileges. - [Update SAML Setting](https://docs.jfrog.com/administration/reference/updatesamlsetting.md): Update a SAML setting. **Security:** Requires admin privileges. - [Delete SAML Setting](https://docs.jfrog.com/administration/reference/deletesamlsetting.md): Delete a SAML setting. **Security:** Requires admin privileges. - [Get SAML SSO General Settings](https://docs.jfrog.com/administration/reference/getsamlgeneralsettings.md): Get the SAML SSO general settings, including whether SAML SSO is enabled and whether a certificate is present. **Security:** Requires admin privileges. - [Enable SAML SSO](https://docs.jfrog.com/administration/reference/updatesamlgeneralsettings-1.md): Enable or disable SAML SSO. **Security:** Requires admin privileges. - [Get HTTP SSO Configuration](https://docs.jfrog.com/administration/reference/gethttpssoconfiguration.md): Get the HTTP SSO configuration. **Note:** This API is available only in Self-hosted instances. **Security:** Requires admin privileges. - [Create or Update HTTP SSO Configuration](https://docs.jfrog.com/administration/reference/upserthttpssoconfiguration.md): Create or update the HTTP SSO configuration (upsert). **Note:** This API is available only in Self-hosted instances. **Security:** Requires admin privileges. - [Get Crowd Configuration](https://docs.jfrog.com/administration/reference/getcrowdconfiguration.md): Get the Crowd configuration. **Security:** Requires admin privileges. - [Create or Update Crowd Configuration](https://docs.jfrog.com/administration/reference/upsertcrowdconfiguration.md): Create or update the Crowd configuration (upsert). **Security:** Requires admin privileges. - [Get Status of Disable Basic Authentication](https://docs.jfrog.com/administration/reference/getbasicauthenticationstatus.md): Returns the status of Disable Basic Authentication in the JPD. **Security:** Requires admin privileges. - [Enable or Disable Basic Authentication](https://docs.jfrog.com/administration/reference/setbasicauthenticationstatus.md): Allows you to enable or disable basic authentication in your JFrog instance. **Security:** Requires admin privileges. - [Create Password Policy](https://docs.jfrog.com/administration/reference/createpasswordpolicy.md): Creates a new password policy. This REST API overwrites all existing field values: if a value is not specified, its default value will be set. **Security:** Requires admin privileges. - [Update Password Policy](https://docs.jfrog.com/administration/reference/updatepasswordpolicy.md): Updates the password policy (partial update). **Security:** Requires admin privileges. - [Create OIDC Configuration](https://docs.jfrog.com/administration/reference/createoidcconfiguration.md): Creates a new OIDC configuration. **Security:** Requires admin privileges. - [Get all OIDC Configuration](https://docs.jfrog.com/administration/reference/getalloidcconfigurations.md): Get details of all OIDC configurations. **Security:** Requires admin or Project Admin privileges. - [Update OIDC Configuration](https://docs.jfrog.com/administration/reference/updateoidcconfiguration.md): Updates an existing OIDC configuration. **Security:** Requires admin privileges. - [Get OIDC Configuration](https://docs.jfrog.com/administration/reference/getoidcconfiguration.md): Get details of an OIDC configuration by provider name. **Security:** Requires admin or Project Admin privileges. - [Delete OIDC Configuration](https://docs.jfrog.com/administration/reference/deleteoidcconfiguration.md): Delete an OIDC configuration. **Security:** Requires admin privileges. - [Create an Identity Mapping](https://docs.jfrog.com/administration/reference/createoidcidentitymapping.md): Creates an identity mapping for an OIDC configuration. **Security:** Requires admin or Project Admin privileges. - [Get all Identity Mappings by Provider Name](https://docs.jfrog.com/administration/reference/getoidcidentitymappings.md): Get all identity mappings for an OIDC configuration. **Security:** Requires admin or Project Admin privileges. - [Get Identity Mappings by Mapping Name](https://docs.jfrog.com/administration/reference/getoidcidentitymappingbyname.md): Get an identity mapping for an OIDC configuration by mapping name. **Security:** Requires admin or Project Admin privileges. - [Update OIDC Identity Mapping](https://docs.jfrog.com/administration/reference/updateoidcidentitymapping.md): Updates an existing OIDC identity mapping. **Security:** Requires admin or Project Admin privileges. - [Delete Identity Mapping](https://docs.jfrog.com/administration/reference/deleteoidcidentitymapping.md): Delete an identity mapping of an OIDC configuration. **Security:** Requires admin or Project Admin privileges. - [OIDC Token Exchange](https://docs.jfrog.com/administration/reference/oidctokenexchange.md): Exposes the token endpoint to retrieve a temporary access token. The scope of the token is determined using identity mappings. - [Get Resource Types](https://docs.jfrog.com/administration/reference/getscimresourcetypes.md): Returns a list of SCIM resource types supported by the server, such as User and Group. Use this REST API to discover the types of resources available. **Availability:** Artifactory 7.127.0+ **Security:** Requires admin privileges or a scoped token with the `system:identities:r` scope. - [Get Schemas](https://docs.jfrog.com/administration/reference/getscimschemas.md): Returns all SCIM schema definitions supported by the server. SCIM schemas define the structure of SCIM resources, such as User and Group. **Availability:** Artifactory 7.127.0+ **Security:** Requires admin privileges or a scoped token with the `system:identities:r` scope. - [Get Schema by ID](https://docs.jfrog.com/administration/reference/getscimschemabyid.md): Returns a specific SCIM schema definition by its ID. SCIM schemas define the structure of SCIM resources, such as User and Group. **Availability:** Artifactory 7.127.0+ **Security:** Requires admin privileges or a scoped token with the `system:identities:r` scope. - [Get Service Provider Configuration](https://docs.jfrog.com/administration/reference/getscimserviceproviderconfig.md): Returns the SCIM Service Provider Configuration, describing the SCIM features and authentication schemes supported by the server. **Availability:** Artifactory 7.127.0+ **Security:** Requires admin privileges or a scoped token with the `system:identities:r` scope. - [GET Users (SCIM)](https://docs.jfrog.com/administration/reference/getscimusers.md): Returns a list of SCIM users. When a filter query parameter is provided in the form of `filter=userName eq "username"`, returns matching users' details. When a filter is not provided, the response will contain all users. **Security:** Requires admin privileges or a scoped token with the `system:identities:r` scope. - [GET Specific User (SCIM)](https://docs.jfrog.com/administration/reference/getscimuserbyusername.md): Returns a specific SCIM user by username. **Security:** Requires admin privileges or a scoped token with the `system:identities:r` scope. - [CREATE Users (SCIM)](https://docs.jfrog.com/administration/reference/createscimuser.md): Creates a new SCIM user. **Security:** Requires admin privileges or a scoped token with the `system:identities:w` scope. - [UPDATE User (SCIM)](https://docs.jfrog.com/administration/reference/updatescimuser.md): Updates a SCIM user (full replacement). **Security:** Requires admin privileges or a scoped token with the `system:identities:w` scope. - [DISABLE User (SCIM)](https://docs.jfrog.com/administration/reference/patchscimuser.md): Partially updates a SCIM user (can be used to disable). **Security:** Requires admin privileges or a scoped token with the `system:identities:w` scope. - [DELETE User (SCIM)](https://docs.jfrog.com/administration/reference/deletescimuser.md): Deletes a SCIM user. **Security:** Requires admin privileges or a scoped token with the `system:identities:d` scope. - [Get Groups (SCIM)](https://docs.jfrog.com/administration/reference/getscimgroups.md): Returns a list of SCIM groups. When a filter query parameter is provided in the form of `filter=displayName eq "groupName"`, returns matching group details. When a filter is not provided, the response will contain all groups. **Security:** Requires admin privileges or a scoped token with the `system:identities:r` scope. - [Create Group (SCIM)](https://docs.jfrog.com/administration/reference/createscimgroup.md): Creates a new SCIM group. **Security:** Requires admin privileges or a scoped token with the `system:identities:w` scope. - [Get Group by Name (SCIM)](https://docs.jfrog.com/administration/reference/getscimgroupbyname.md): Returns a specific SCIM group by name. **Security:** Requires admin privileges or a scoped token with the `system:identities:r` scope. - [Update Group (SCIM)](https://docs.jfrog.com/administration/reference/updatescimgroup.md): Updates a SCIM group (full replacement). **Security:** Requires admin privileges or a scoped token with the `system:identities:w` scope. - [Patch Group (SCIM)](https://docs.jfrog.com/administration/reference/patchscimgroup.md): Partially updates a SCIM group. **Security:** Requires admin privileges or a scoped token with the `system:identities:w` scope. - [Delete Group (SCIM)](https://docs.jfrog.com/administration/reference/deletescimgroup.md): Deletes a SCIM group. **Security:** Requires admin privileges or a scoped token with the `system:identities:d` scope. - [PUT AWS IAM Role](https://docs.jfrog.com/administration/reference/putawsiamrole.md): Assigns an AWS IAM role to a user. **Security:** Requires admin privileges. - [GET AWS IAM Role](https://docs.jfrog.com/administration/reference/getawsiamrole.md): Get information of the AWS IAM role assigned to a user. **Security:** Requires admin privileges. - [DELETE IAM ROLE](https://docs.jfrog.com/administration/reference/deleteawsiamrole.md): Deletes AWS IAM role from a user. **Security:** Requires admin privileges. - [Set the Vault Configuration](https://docs.jfrog.com/administration/reference/setvaultconfiguration.md): Connects the vault to the JFrog Platform to use signing keys stored in the vault. **Note:** Requires TLS enabled. **Security:** Requires admin privileges. - [Get the Secret Manager Configurations](https://docs.jfrog.com/administration/reference/getvaultconfigurations.md): Returns a list of all configured secret managers. **Security:** Requires admin privileges. - [Test the Vault Configuration](https://docs.jfrog.com/administration/reference/testvaultconfiguration.md): Tries to connect to the Vault server. **Note:** Requires TLS enabled. **Security:** Requires admin privileges. - [Delete the Secret Manager Configuration](https://docs.jfrog.com/administration/reference/deletevaultconfiguration.md): Deletes the connection between the vault and JFrog Platform. **Security:** Requires admin privileges. - [Get Root Certificate](https://docs.jfrog.com/administration/reference/getrootcertificate.md): Returns the root certificate. - [Get CA Public Certificate](https://docs.jfrog.com/administration/reference/getcacertificate.md): Returns the CA public certificate. **Security:** Requires admin privileges. - [Export Access Configuration](https://docs.jfrog.com/administration/reference/exportaccessconfiguration.md): Exports the Access configuration. Once the export is complete, look for an `access.backup.[timestamp].json` file in the `$JF_HOME/backup/access` folder on the host running Artifactory. **Note:** This API is available only in Self-hosted instances. **Security:** Requires admin privileges. - [Import Access Configuration](https://docs.jfrog.com/administration/reference/importaccessconfiguration.md): Imports the Access configuration. Place the Access backup file in the following location with the filename `access.bootstrap.json`: `$JF_HOME/etc/access/access.bootstrap.json`. The API loads only this file from this location. **Note:** This API is available only in Self-hosted instances. **Security:** Requires admin privileges. - [Ping Request](https://docs.jfrog.com/administration/reference/pingsystem.md): A simple ping request to verify that Access is running. - [Enable Cloud Log Collection](https://docs.jfrog.com/administration/reference/enablecloudlogcollection.md): Enables log collection into a dedicated Logs Artifactory System Repository, to improve auditing capabilities. **Note:** Available for Cloud (SaaS) subscriptions only. - Logs are collected in a dedicated system repository called `jfrog-logs`. The repository will be created upon calling the API. - Logs are collected in a cycle that may take up to 24 hours. - By default, the log types collected are audit and request logs. **Important:** The data transfer and storage you consume for downloading or storing the logs will apply against your standard cloud usage, and may incur costs. **Security:** Requires admin privileges. - [Get All Access Federations](https://docs.jfrog.com/administration/reference/getallaccessfederations.md): Returns all federation targets' configurations. **Security:** Requires admin privileges. - [Register Access Federation](https://docs.jfrog.com/administration/reference/registeraccessfederation.md): Registers a new federation target. **Note:** This endpoint manages Access Federation directly on the JPD you are connected to. For centralized federation management across multiple JPDs, we recommend using the [Mission Control Access Federation APIs](https://docs.jfrog.com/administration/reference/configuremcfederation). **Security:** Requires admin privileges. - [Get Access Federation](https://docs.jfrog.com/administration/reference/getaccessfederation.md): Returns the federation target by server name. **Security:** Requires admin privileges. - [Update Access Federation](https://docs.jfrog.com/administration/reference/updateaccessfederation.md): Updates federation target configurations. **Note:** Server name and URL cannot be altered. **Security:** Requires admin privileges. - [Validate Target for Circle of Trust](https://docs.jfrog.com/administration/reference/validatefederationtarget.md): Validates a target server for Circle of Trust federation. **Security:** Requires admin privileges. - [Full Broadcast Access Federation](https://docs.jfrog.com/administration/reference/fullbroadcastaccessfederation.md): Invokes Access Federation full broadcast from a single federation source to all its federation targets. **Security:** Requires admin privileges. - [Delete Access Federation](https://docs.jfrog.com/administration/reference/deleteaccessfederation.md): Unregisters a federation target. **Security:** Requires admin privileges. - [Create Worker](https://docs.jfrog.com/administration/reference/createworker.md): Creates a worker service. **Security:** Requires Platform Admin or Project Admin privileges. For Project Admin, the `projectKey` query parameter must be set and match the one in the Worker request body. - [Get Workers](https://docs.jfrog.com/administration/reference/getworkers.md): Returns a list of all workers. **Security:** Requires Platform Admin privileges. - [Update Worker](https://docs.jfrog.com/administration/reference/updateworker.md): Updates an existing worker. **Security:** Requires Platform Admin privileges. - [Get Specified Worker](https://docs.jfrog.com/administration/reference/getworker.md): Returns a specific worker by key. **Security:** Requires Platform Admin privileges. - [Delete Worker](https://docs.jfrog.com/administration/reference/deleteworker.md): Deletes a worker. **Security:** Requires Platform Admin privileges. - [Get Available Actions](https://docs.jfrog.com/administration/reference/getworkeractions.md): Returns the list of available worker action names. **Security:** Requires Platform Admin privileges. - [Get Actions Metadata](https://docs.jfrog.com/administration/reference/getworkeractionsmetadata.md): Returns full metadata for each available worker action. Use this to discover the dynamic payload and result shapes: each action's `samplePayload` (example request JSON), `typesDefinitions` (TypeScript interfaces for request/response), and `filterType` (which filter criteria shape applies). Refer to this endpoint when building or validating execution payloads and when interpreting execution results. **Security:** Requires Platform Admin privileges. - [Execute Test](https://docs.jfrog.com/administration/reference/executeworkertestgeneric.md): Executes a worker test without a specific worker key. **Security:** Requires Platform Admin privileges. - [Execute Test for Worker](https://docs.jfrog.com/administration/reference/executeworkertest.md): Executes a test for a specific worker. **Security:** Requires Platform Admin privileges. - [Workers Service Readiness](https://docs.jfrog.com/administration/reference/checkworkersreadiness.md): Checks the workers service readiness. **Security:** Does not require authentication. - [Workers Service Liveness](https://docs.jfrog.com/administration/reference/checkworkersliveness.md): Checks the workers service liveness. **Security:** Does not require authentication. - [Get Worker Execution History](https://docs.jfrog.com/administration/reference/getworkerexecutionhistory.md): Returns the execution history for workers. **Security:** Requires Platform Admin privileges. - [Execute an HTTP-Triggered Worker](https://docs.jfrog.com/administration/reference/executehttptriggeredworker.md): Executes an HTTP-triggered worker. **Security:** Requires Platform Admin privileges. - [Rerun Worker](https://docs.jfrog.com/administration/reference/rerunworker.md): Reruns a worker. **Security:** Requires Platform Admin privileges. - [List of Worker Events](https://docs.jfrog.com/administration/reference/list-of-worker-events.md) - [List available JPDs](https://docs.jfrog.com/administration/reference/listjpds.md): Returns the list of available JPDs (JFrog Platform Deployments) known to Mission Control. Supports optional filtering by name, tag, URL, or status. Filters may contain wildcards (`*`). **Security:** Requires a token with admin privileges. - [List all Grid topologies](https://docs.jfrog.com/administration/reference/listgridtopologies.md): Retrieves a list of all Grid topology configurations. **Security:** Requires a token with admin privileges. - [Get a Grid topology by key](https://docs.jfrog.com/administration/reference/getgridtopology.md): Retrieves a specific Grid topology configuration by its unique key. **Security:** Requires a token with admin privileges. - [Create a Grid topology](https://docs.jfrog.com/administration/reference/creategridtopology.md): Creates a new Grid topology with the supplied sites. The Grid topology key is derived from the supplied `name`. Always returns `201` when the Grid topology is stored. Per-site federation status (including any post-store federation errors) is reflected in each site's `status` and `status_description` fields in the response. **Security:** Requires a token with admin privileges. - [Update a Grid topology](https://docs.jfrog.com/administration/reference/updategridtopology.md): Updates an existing Grid topology configuration. All fields are optional — only the supplied fields are updated. Returns `200`. If federation configuration fails for a particular site after the store succeeds, that site's `status` will be reported as `Disconnected` with a `status_description`. **Security:** Requires a token with admin privileges. - [Delete a Grid topology](https://docs.jfrog.com/administration/reference/deletegridtopology.md): Deletes a Grid topology by its key. Returns `204` on full success. Returns `409` with the current Grid topology (including per-site statuses) if federation cleanup failed — the Grid topology is intentionally retained in Mission Control in that case. Retry `DELETE` to complete removal. **Security:** Requires a token with admin privileges. - [Get aggregated entity sync health summary](https://docs.jfrog.com/administration/reference/getmonitoringsummary.md): Returns aggregated entity-sync status counts (`failure`, `in_progress`, `success`) for every monitored entity type, aggregated across all JPDs in the Grid. **Monitored entity types** (public keys): `users`, `groups`, `permissions`, `tokens`, `projects`, `environments`, `roles`, `projectGroups`, `projectUsers`, `projectResources`. **Security:** Requires a token with admin privileges. - [List entities by type and sync status](https://docs.jfrog.com/administration/reference/getmonitoringentitylist.md): Returns entity IDs with their per-target sync status, aggregated across the Grid. Supports filtering by `entity_type` and a single `status` value (`failure`, `success`, `in_progress`). **Security:** Requires a token with admin privileges. - [Get entity sync detail with per-target descriptions](https://docs.jfrog.com/administration/reference/getmonitoringentitydetail.md): Returns the detailed sync status for a specific entity across all target JPDs in the Grid, including failure descriptions for targets in the `failure` state. **Security:** Requires a token with admin privileges. - [Get JPD List](https://docs.jfrog.com/administration/reference/getjpdlist.md): Get all JPDs. **Security:** Requires admin privileges. - [Get JPD by id](https://docs.jfrog.com/administration/reference/getjpdbyid.md): Get a JPD by ID. **Security:** Requires admin privileges. - [Add JPD](https://docs.jfrog.com/administration/reference/addjpd.md): Add a new JPD to Mission Control. **Prerequisites:** Before adding a JPD, you must generate a pairing token on the target JPD. **Steps to add a JPD:** 1. On the **target JPD** (the JPD you want to register), create a pairing token: ``` POST https://{target-jpd-url}/access/api/v1/service_trust/pairing/mission-control ``` See [Create Pairing Token](https://docs.jfrog.com/administration/reference/createpairingtoken) for details. 2. Use the returned `pairing_token` in the `token` field of this request. 3. Mission Control will validate the pairing token by connecting to the target JPD. **Note:** The `token` field accepts either a pairing token (JWT) or a join key. **Security:** Requires admin privileges. - [Delete JPD](https://docs.jfrog.com/administration/reference/deletejpd.md): Delete a JPD. **Security:** Requires admin privileges. - [Update JPD](https://docs.jfrog.com/administration/reference/updatejpd.md): Update a JPD. **Security:** Requires admin privileges. - [Get Buckets](https://docs.jfrog.com/administration/reference/getlicensebuckets.md): Retrieves all the license buckets in the system. **Security:** Requires admin privileges. - [Get Bucket Status](https://docs.jfrog.com/administration/reference/getlicensebucketstatus.md): Get bucket status report. **Security:** Requires admin privileges. - [Upload Bucket](https://docs.jfrog.com/administration/reference/uploadlicensebucket.md): Creates a new License Bucket. Supports two modes: **JSON mode** (`Content-Type: application/json`): Provide a URL from which Mission Control will download the encrypted bucket file, along with the decryption key. **Multipart mode** (`Content-Type: multipart/form-data`): Upload the encrypted bucket file directly from your environment, along with the decryption key. Both modes return the same response. **Multipart mode example:** ``` curl -X POST 'https:///mc/api/v1/buckets' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: multipart/form-data' \ -F 'file=@/path/to/bucket-file.json;type=application/octet-stream' \ -F 'key=' \ -F 'name=mybucket' ``` **Security:** Requires admin privileges. - [Attach License](https://docs.jfrog.com/administration/reference/attachlicense.md): Attaches a license from a bucket to the specified JPD. **Security:** Requires admin privileges. - [Acquire License](https://docs.jfrog.com/administration/reference/acquirelicense.md): Acquires one or several license(s) from a bucket and returns them. Those licenses are marked as used in the bucket report under the "Unknown usage" section. **Security:** Requires admin privileges. - [Release License](https://docs.jfrog.com/administration/reference/releaselicense.md): Releases a license from a bucket given the JPD id or label previously used by an "acquire" call. **Security:** Requires admin privileges. - [Delete Bucket](https://docs.jfrog.com/administration/reference/deletelicensebucket.md): Delete a license bucket. **Security:** Requires admin privileges. - [Get Access Federation Configuration for a Single JPD](https://docs.jfrog.com/administration/reference/getmcfederationconfig.md): Get access federation configuration for a specific JPD. **Security:** Requires admin privileges. - [Get Access Federation Configuration for All JPDs](https://docs.jfrog.com/administration/reference/getallmcfederationconfigs.md): Get access federation configuration for all JPDs. **Security:** Requires admin privileges. - [Get Access Federation Candidates](https://docs.jfrog.com/administration/reference/getmcfederationcandidates.md): Get access federation candidates. **Security:** Requires admin privileges. - [Configure Access Federation on a JPD](https://docs.jfrog.com/administration/reference/configuremcfederation.md): Configure access federation on a JPD. **Note:** Mission Control acts as a centralized orchestrator, and is the recommended way to manage Access Federation configuration across multiple JPDs from a single control plane. To manage federation settings directly on an individual JPD, you can also use the [Access Federation APIs](https://docs.jfrog.com/administration/reference/registeraccessfederation). **Security:** Requires admin privileges. - [System Health Check](https://docs.jfrog.com/administration/reference/mcsystemping.md): Mission Control system health check. - [Export Mission Control Configuration](https://docs.jfrog.com/administration/reference/exportmcconfiguration.md): Export Mission Control configuration. **Note:** This API is available only in Self-hosted instances. **Security:** Requires admin privileges. - [Import Mission Control Data](https://docs.jfrog.com/administration/reference/importmcdata.md): Import Mission Control data from a JSON file encrypted with the master key. **Note:** - This API is available only in Self-hosted instances. - Before importing, you must rename the export.json file to import.json. **Security:** Requires admin privileges. - [Bridge](https://docs.jfrog.com/administration/reference/bridge.md) - [Reset Bridge Connections at Server](https://docs.jfrog.com/administration/reference/resetbridgeserver.md): Reset the active tunnel connections for a specific bridge on this Bridge Server instance. This operation terminates existing tunnel connections and allows new ones to be established. **Note:** In High Availability (HA) deployments, this endpoint only affects the specific instance that handles the request. **Security:** Requires Platform Admin privileges. - [Block a Bridge at the Bridge Server](https://docs.jfrog.com/administration/reference/blockbridge.md): Add a Bridge to the Bridge Server's blacklist. The Bridge Server terminates connections to the Bridge Client and declines new connections, but the Bridge is not removed. For more information, see [Manage Bridges](https://docs.jfrog.com/administration/docs/manage-bridges). **Security:** Requires Platform Admin privileges. - [Unblock a Bridge at the Bridge Server](https://docs.jfrog.com/administration/reference/unblockbridge.md): Remove a Bridge from the Bridge Server's blacklist, allowing connections to resume. For more information, see [Manage Bridges](https://docs.jfrog.com/administration/docs/manage-bridges). **Security:** Requires Platform Admin privileges. - [Get Bridge Server Blacklist](https://docs.jfrog.com/administration/reference/getbridgeserverblacklist.md): Get the list of blocked bridges on the Bridge Server. **Security:** Requires Platform Admin privileges. - [Bridge Client Liveness Check](https://docs.jfrog.com/administration/reference/getbridgeclientliveness.md): Verifies the liveness of the Bridge Client service. **Security:** Does not require authentication. - [Bridge Client Readiness Check](https://docs.jfrog.com/administration/reference/getbridgeclientreadiness.md): Verifies the readiness of the Bridge Client service. **Security:** Does not require authentication. - [Establish Bridge Trust Pairing](https://docs.jfrog.com/administration/reference/establishbridgetrustpairing.md): Establish trust between the Bridge Client and Bridge Server using a pairing token. This endpoint completes the pairing process for an existing bridge configuration. **Note:** The pairing token can also be updated using the PATCH `/bridges/{bridge_id}` endpoint. **Security:** Requires Platform Admin privileges. - [Define a New Bridge](https://docs.jfrog.com/administration/reference/definenewbridge.md): Define a new JFrog Bridge connection between JPDs. After successful creation, the bridge is active. For more information, see [Add a JFrog Bridge](https://docs.jfrog.com/administration/docs/add-a-jfrog-bridge). **Security:** Requires Platform Admin privileges. - [Modify Bridge Configuration](https://docs.jfrog.com/administration/reference/modifybridgeconfiguration.md): Change connection details and TCP tunnel creation thresholds for an existing bridge. After successful update, the bridge is active with new settings. For more information, see [Manage Bridges](https://docs.jfrog.com/administration/docs/manage-bridges). You can submit a shorter payload with the full path of the modified key-value pair, for example: `{"jobs": {"tunnel_creation": {"interval_minutes": 10}}}`. **Security:** Requires Platform Admin privileges. - [Delete a Bridge](https://docs.jfrog.com/administration/reference/deletebridge.md): Delete a JFrog Bridge connection. **Security:** Requires Platform Admin privileges. - [Get Bridge Configuration](https://docs.jfrog.com/administration/reference/getbridgeconfig.md): Retrieve the configuration of a specific bridge. The remote token is redacted in the response for security purposes. **Security:** Requires Platform Admin privileges. - [Reset Active Bridge Connections](https://docs.jfrog.com/administration/reference/resetbridgeclient.md): Reset the active tunnel connections for a specific bridge on this Bridge Client instance. This operation terminates existing tunnel connections and allows new ones to be established. **Note:** In High Availability (HA) deployments, this endpoint only affects the specific instance that handles the request. **Security:** Requires Platform Admin privileges. - [Stop a Bridge at the Bridge Client](https://docs.jfrog.com/administration/reference/stopbridge.md): Suspend a JFrog Bridge connection between JPDs without removing the Bridge. Active TCP nodes and tunnels are terminated. The Bridge is listed as Offline in the JFrog Platform user interface and in response to Bridge API queries. For more information, see [Manage Bridges](https://docs.jfrog.com/administration/docs/manage-bridges). **Security:** Requires Platform Admin privileges. - [Restart a Bridge at the Bridge Client](https://docs.jfrog.com/administration/reference/restartbridge.md): Restart a JFrog Bridge connection between JPDs. Active sessions over TCP nodes or communication tunnels are terminated and new sessions are established after restart. For more information, see [Manage Bridges](https://docs.jfrog.com/administration/docs/manage-bridges). **Security:** Requires Platform Admin privileges. - [Get Bridge Client Debug Snapshot](https://docs.jfrog.com/administration/reference/getbridgeclientdebugsnapshot.md): Returns operational statistics and runtime information for all bridges configured on this Bridge Client instance, including active connections, request counts, and creation timestamps. **Note:** In High Availability (HA) deployments, this endpoint returns information from the specific instance that handles the request. **Security:** Requires Platform Admin privileges. - [Get Bridge Client Metrics](https://docs.jfrog.com/administration/reference/getbridgeclientmetrics.md): Retrieve metrics in Prometheus format from the Bridge Client service. **Security:** Requires Platform Admin privileges or a token with `system:metrics:r` scope. - [Create Bridge Client Support Bundle](https://docs.jfrog.com/administration/reference/createbridgeclientsupportbundle.md): Creates a Bridge Client support bundle for troubleshooting purposes. The support bundle collects diagnostic information from all microservices in the topology. Only one support bundle can be created at a time. **Security:** Requires Platform Admin privileges. - [JFConnect Start Register for Air-gapped JPD](https://docs.jfrog.com/administration/reference/startregisterairgappedjpd.md): Starts the offline registration of the air-gapped JPD for entitlements through the JFConnect microservice. **Prerequisite:** You must [configure your JFrog Platform for an air-gapped environment](https://docs.jfrog.com/installation/docs/configure-jfrog-platform-in-an-air-gapped-environment) before using this API. This includes setting `jfconnect.airgap.enabled: true` in the Artifactory System YAML file and restarting Artifactory. **Security:** Requires Platform Admin privileges. - [Post Offline Request Token to JFrog Entitlements Service](https://docs.jfrog.com/administration/reference/postofflinerequesttoken.md): Posts the offline request token from the air-gapped JPD to the JFrog Entitlements Service and returns the entitlements in JSON format. You must run this API from a machine that has connectivity to the Internet. The `offline_response_token` needed for applying entitlements is returned as a response header. **Example 1 - Save the entitlements to a file:** ``` curl -v -L 'https://jes.jfrog.io/api/v1/offline_register' \ -H 'Content-Type: application/json' \ --data '{"offline_request_token": ""}' \ > entitlements.json ``` The `-v` flag prints the response headers (including `offline_response_token`) to stderr while saving the response body to `entitlements.json`. **Example 2 - Extract only the `offline_response_token`:** ``` curl -s -L 'https://jes.jfrog.io/api/v1/offline_register' \ -H 'Content-Type: application/json' \ --data '{"offline_request_token": ""}' \ -o /dev/null -D - | grep offline_response_token ``` This discards the response body and prints only the `offline_response_token` header value to the screen. You need **both** the `entitlements.json` file and the `offline_response_token` header value to complete the next step: applying entitlements to the air-gapped JPD using the JFConnect Apply Entitlements API. **Warning:** If you save the response manually instead of directing the response body to an `entitlements.json` file, ensure that there are no spaces or any modifications. Any change in the response fails checksum validation when you apply entitlements. - [JFConnect Apply Entitlements to an Air-Gapped JPD](https://docs.jfrog.com/administration/reference/applyentitlementsairgappedjpd.md): Posts the entitlements to the air-gapped JPD through the JFConnect microservice. This request requires two values obtained from the [Post Offline Request Token to JFrog Entitlements Service API](https://docs.jfrog.com/installation/docs/configure-jfrog-platform-in-an-air-gapped-environment) (`POST https://jes.jfrog.io/api/v1/offline_register`): - `entitlements` - the `entitlements.json` file saved from the response **body**. - `offline_response_token` - the token returned in the response **header**. **Sample usage:** ``` curl -L -H 'Authorization: Bearer ' \ -X POST 'http://:8082/jfconnect/api/v1/offline/register' \ --form 'entitlements=@entitlements.json;type=application/json' \ --form 'offline_response_token=' ``` **Warning:** You must use the `offline_response_token` (returned during offline registration). Do **not** use the `offline_request_token` from the start register step. The API request fails if the incorrect token is used. **Security:** Requires Platform Admin privileges. - [JFConnect GET JPD ID](https://docs.jfrog.com/administration/reference/getjpdid.md): Gets the ID of the JPD through the JFConnect microservice. **Security:** Requires Platform Admin privileges. - [JFConnect GET Service ID](https://docs.jfrog.com/administration/reference/getserviceid.md): Gets the service ID of the services in the JPD through the JFConnect microservice. **Security:** Does not require authentication. - [JFConnect Readiness](https://docs.jfrog.com/administration/reference/checkreadiness.md): Tests the readiness of the JFConnect microservice. **Security:** Does not require authentication. - [JFConnect Liveness](https://docs.jfrog.com/administration/reference/checkliveness.md): Tests the liveness of the JFConnect microservice. **Security:** Does not require authentication. - [Health Check](https://docs.jfrog.com/administration/reference/routerhealthcheck.md): Get a simple status response about the state of a JFrog Product node. Returns health state and general information regarding the router and locally registered services. **Security:** No authentication required. - [Curation Federation](https://docs.jfrog.com/administration/reference/curation-federation-pfed-service.md) - [Add a Follower JPD](https://docs.jfrog.com/administration/reference/addfollowerjpd.md): Add a Follower JPD on the Controller JPD using a pairing token. This establishes a trust relationship between the Controller and the Follower, allowing the Controller to propagate federated entities (Curation Policies, Conditions, Package Types, and Catalog Custom Labels) to the Follower. This is the first step in setting up Curation Federation. After adding all Follower JPDs, use the Create a Federation API to define which entities to synchronize. **Prerequisites:** Obtain a pairing token from the Follower JPD using the [Create Pairing Token](https://docs.jfrog.com/administration/reference/createpairingtoken) API with the `platform-federation` use case. **Security:** Requires admin privileges. - [List Follower JPDs](https://docs.jfrog.com/administration/reference/listfollowerjpds.md): List all Follower JPDs on this Controller JPD. **Security:** Requires admin privileges. - [Get a Follower JPD](https://docs.jfrog.com/administration/reference/getfollowerjpd.md): Retrieve the details of a specific Follower JPD by its ID. **Security:** Requires admin privileges. - [Update a Follower JPD](https://docs.jfrog.com/administration/reference/updatefollowerjpd.md): Update the URL and pairing token of an existing Follower JPD. Use this to rotate the pairing token or update the Follower's URL. **Security:** Requires admin privileges. - [Delete a Follower JPD](https://docs.jfrog.com/administration/reference/deletefollowerjpd.md): Remove a Follower JPD from the Controller. The Follower will no longer participate in any federations. **Note:** Ensure the JPD is removed from all federation connection groups before deleting it. **Security:** Requires admin privileges. - [Create a Federation](https://docs.jfrog.com/administration/reference/createfederation.md): Define a new Platform Federation on the Controller JPD. A federation specifies which Curation entities to synchronize and which Follower JPDs participate. **Prerequisites:** All Follower JPDs referenced in `target_jpd_ids` must already be added via the Add a Follower JPD API (`POST /pfed/api/v1/jpd`). The request body follows a fixed structure. Only the following fields are user-configurable: - **`name`** — A unique name for this federation. - **`description`** — A brief description of the use case. - **`connection_groups.source-jpd.target_jpd_ids`** — The list of Follower JPD IDs to include. The `connection_groups` key (`"source-jpd"`) and the `entities` list are fixed and must be provided exactly as shown in the example. **Fixed entity types (must all be included as-is):** - `catalog.customLabels` — Catalog custom labels - `xray.curationCondition` — Curation conditions - `xray.curationPkgType` — Curation package types - `xray.curationPolicy` — Curation policies **Security:** Requires admin privileges. - [List Federations](https://docs.jfrog.com/administration/reference/listfederations.md): List all federations defined on this Controller JPD. **Security:** Requires admin privileges. - [Get a Federation](https://docs.jfrog.com/administration/reference/getfederation.md): Retrieve the full details of a specific federation by its ID, including connection groups and entity types. **Security:** Requires admin privileges. - [Delete a Federation](https://docs.jfrog.com/administration/reference/deletefederation.md): Delete a federation from the Controller JPD. Entity synchronization for this federation will stop immediately. **Security:** Requires admin privileges. - [Create Support Bundle](https://docs.jfrog.com/administration/reference/createsupportbundle.md): Create a new support bundle. **Note:** This API is available only in Self-Hosted platforms. **Since:** 4.3.0 **Security:** Requires an admin user. - [Get Support Bundle Metadata](https://docs.jfrog.com/administration/reference/getsupportbundlemetadata.md): Downloads the metadata for a previously created bundle currently stored in the system. **Note:** This API is available only in Self-Hosted platforms. **Since:** 6.8.0 **Security:** Requires an admin user. - [Delete Support Bundle](https://docs.jfrog.com/administration/reference/deletesupportbundle.md): Deletes a previously created bundle from the system. **Note:** This API is available only in Self-Hosted platforms. **Since:** 4.3.0 **Security:** Requires an admin user. - [Get Support Bundle](https://docs.jfrog.com/administration/reference/getsupportbundle.md): Downloads a previously created bundle currently stored in the system. **Note:** This API is available only in Self-Hosted platforms. **Since:** 4.3.0 **Security:** Requires an admin user. - [List Support Bundles](https://docs.jfrog.com/administration/reference/listsupportbundles.md): Lists previously created bundles currently stored in the system. **Note:** This API is available only in Self-Hosted platforms. **Since:** 4.3.0 **Security:** Requires an admin user. - [Create Distribution Support Bundle](https://docs.jfrog.com/administration/reference/createdistributionsupportbundle.md): Creates a support bundle with automatically generated ID. Since: 1.6 Security: Admin only - [Create Specific Support Bundle](https://docs.jfrog.com/administration/reference/createspecificdistributionsupportbundle.md): Creates a new support bundle and assigns it a specific ID. Since: 1.6 Security: Admin only - [Get Support Bundle Info](https://docs.jfrog.com/administration/reference/getdistributionsupportbundleinfo.md): Returns details about a support bundle. Since: 1.6 Security: Admin only - [Delete Support Bundle](https://docs.jfrog.com/administration/reference/deletedistributionsupportbundle.md): Deletes a support bundle. Since: 1.6 Security: Admin only - [Get Support Bundle](https://docs.jfrog.com/administration/reference/downloaddistributionsupportbundle.md): Downloads a specified support bundle as a ZIP archive. Since: 1.6 Security: Admin only - [List Support Bundles](https://docs.jfrog.com/administration/reference/listdistributionsupportbundles.md): Get the list of all support bundles. Since: 1.6 Security: Admin only - [Artifactory Ping](https://docs.jfrog.com/administration/reference/artifactoryping.md): Get a simple status response about the state of Artifactory. **Since:** 2.3.0 **Security:** Requires a valid user (can be anonymous). - [Readiness Probe](https://docs.jfrog.com/administration/reference/getreadinessprobe.md): The readiness probe returns a simple status response about the state of Artifactory using the Kubernetes style readiness probe. The probe can be used to measure system latency and provides an important metric to monitor. **Since:** 7.31.x **Security:** Requires a valid user (can be anonymous). - [Liveness Probe](https://docs.jfrog.com/administration/reference/getlivenessprobe.md): Get a status response to know when a container is ready to start accepting traffic. **Since:** 7.31.x **Security:** Requires a valid user (can be anonymous). - [Get Artifactory Version](https://docs.jfrog.com/administration/reference/getartifactoryversion.md): Return information about the current Artifactory version, revision, and currently installed Add-ons. **Since:** 2.2.2 **Security:** Requires a valid user (can be anonymous). - [Get System Info](https://docs.jfrog.com/administration/reference/getsysteminfo.md): Get general system information. **Since:** 2.2.0 **Security:** Requires a valid admin user. - [Verify Connection](https://docs.jfrog.com/administration/reference/verifyconnection.md): Verifies a two-way connection between Artifactory and another product. Returns Success (200) if Artifactory receives a similar success code (200) from the provided endpoint. **Note:** This API is available only in Self-hosted instances. **Since:** 4.15.0 **Security:** Requires an admin user. - [Update Custom URL Base](https://docs.jfrog.com/administration/reference/updatecustomurlbase.md): Changes the Custom URL base. **Note:** This API is available only in Self-hosted instances. **Since:** 3.9.0 **Security:** Requires a valid admin user. - [Get System Configuration](https://docs.jfrog.com/administration/reference/getsystemconfiguration.md): Get the general configuration (artifactory.config.xml). **Note:** This API is available only in Self-hosted instances. **Since:** 2.2.0 **Security:** Requires a valid admin user. - [Apply Artifactory YAML Configuration Changes](https://docs.jfrog.com/administration/reference/patchsystemconfiguration.md): Configure an existing Artifactory instance using a simple YAML configuration file. Make single or multiple configuration changes as needed, to create, update, and delete any elements in Artifactory. **⚠️ Take care when modifying Artifactory configurations:** Modifying the Artifactory configurations is an advanced feature, and if done incorrectly may render Artifactory in an undefined and unusable state. Since it is easy to overwrite configurations, such as a repository's package type, we strongly recommend backing up the configuration before making any direct changes, and taking great care when doing so. **Note:** This API is available only in Self-hosted instances. **Since:** 5.8.0 **Security:** Requires an admin user. - [Save General Configuration](https://docs.jfrog.com/administration/reference/savesystemconfiguration.md): Save the general configuration (artifactory.config.xml). **Note:** This API is available only in Self-hosted instances. This is an advanced feature - make sure the new configuration is really what you wanted before saving. **Since:** 2.2.0 **Security:** Requires a valid admin user. - [Get License Information](https://docs.jfrog.com/administration/reference/getlicenseinfo.md): Return information about the currently installed license. **Note:** This API is available only in Self-hosted instances. **Since:** 3.3.0 **Security:** Requires a valid admin user. - [Install License](https://docs.jfrog.com/administration/reference/installlicense.md): Install new license key or change the current one. **Note:** This API is available only in Self-hosted instances. **Since:** 3.3.0 **Security:** Requires a valid admin user. - [Get HA License Information](https://docs.jfrog.com/administration/reference/gethalicenseinfo.md): Return information about the currently installed licenses in an HA cluster. **Note:** This API is available only in Self-hosted instances. **Since:** 5.0.0 **Security:** Requires authentication using Access Tokens, either as admin or using a scoped token with the system:info/licenses:r scope. - [Install HA Cluster Licenses](https://docs.jfrog.com/administration/reference/installhalicenses.md): Install new license key(s) on an HA cluster. **Note:** This API is available only in Self-hosted instances. **Since:** 5.0.0 **Security:** Requires an admin user. - [Delete HA Cluster License](https://docs.jfrog.com/administration/reference/deletehalicense.md): Deletes a license key from an HA cluster. **Note:** This API is available only in Self-hosted instances. **Since:** 5.0.0 **Security:** Requires an admin user. - [Get Reverse Proxy Configuration](https://docs.jfrog.com/administration/reference/getreverseproxyconfiguration.md): Returns the reverse proxy configuration. **Note:** Applicable to a Self-Hosted JFrog Platform only. **Since:** 4.3.1 **Security:** Requires a valid admin user and supported for users with the relevant permissions. Non-admin users will get the proxy method and ports and the list of repositories based on their user permissions. - [Possible Values for dockerReverseProxyMethod](https://docs.jfrog.com/administration/reference/possible-values-for-dockerreverseproxymethod.md) - [Update Reverse Proxy Configuration](https://docs.jfrog.com/administration/reference/updatereverseproxyconfiguration.md): Updates the reverse proxy configuration. **Note:** This API is available only in Self-hosted instances. **Since:** 4.3.1 **Security:** Requires an admin user. - [Get Reverse Proxy Snippet](https://docs.jfrog.com/administration/reference/getreverseproxysnippet.md): Returns the reverse proxy configuration snippet in text format. **Note:** This API is available only in Self-hosted instances. **Since:** 4.3.1 **Security:** Requires a valid admin user. - [Start SHA256 Migration Task](https://docs.jfrog.com/administration/reference/startsha256migration.md): Starts the SHA-256 migration process. **Note:** This API is available only in Self-hosted instances. Migration can also be configured using a set of properties in Artifactory's artifactory.system.properties file. **Since:** 6.6.0 **Security:** Administrator permissions. - [Stop SHA256 Migration Task](https://docs.jfrog.com/administration/reference/stopsha256migration.md): Stops the SHA-256 migration process. **Note:** This API is available only in Self-hosted instances. The sleepIntervalMillis should match what was defined in the Start SHA256 Migration Task. **Since:** 6.6.0 **Security:** Administrator permissions. - [Re-index Paths on Metadata Server](https://docs.jfrog.com/administration/reference/reindexmetadataserver.md): If needed, Artifactory can re-send Metadata events to the Metadata Server in case of an inconsistent state. The API will recursively re-index artifacts under the given repository or path if a repository key or a directory path is specified. Asynchronous by default. Does not delete data associated with the given paths on the Metadata Server before re-indexing by default. **Since:** 7.0.0 **Security:** Requires an admin user. - [Get Private Links by Server Name](https://docs.jfrog.com/administration/reference/getprivatelinksbyserver.md): Retrieve all private links associated with a specific server. Security: Requires a valid token - [Get Servers by Private Link ID](https://docs.jfrog.com/administration/reference/getserversbyprivatelink.md): Retrieve all servers associated with a specific private link. Security: Requires a valid token - [Add Private Link to Servers](https://docs.jfrog.com/administration/reference/addprivatelink.md): Add a private link configuration to one or more servers. Security: Requires a valid token - [Fix Private Link](https://docs.jfrog.com/administration/reference/fixprivatelink.md): Replace an existing private link with a new one across affected servers. Only private links in status "Failed: not found" or "Failed" may be replaced. Security: Requires a valid token - [Delete Private Link from Servers](https://docs.jfrog.com/administration/reference/deleteprivatelink.md): Remove a private link configuration from one or more servers. Security: Requires a valid token - [Private Link Status Values ](https://docs.jfrog.com/administration/reference/private-link-status-values.md) - [Get SSL Objects](https://docs.jfrog.com/administration/reference/getsslobjects.md): Get all SSL certificate objects. - [Create SSL Object](https://docs.jfrog.com/administration/reference/createsslobject.md): Create a new SSL certificate object. Security: Requires a valid token - [Delete SSL Object](https://docs.jfrog.com/administration/reference/deletesslobject.md): Delete an SSL certificate object. - [Renew SSL Object](https://docs.jfrog.com/administration/reference/renewsslobject.md): Renew an SSL certificate object. Security: Requires a valid token - [Validate SSL Object](https://docs.jfrog.com/administration/reference/validatesslobject.md): Validate an SSL certificate object. If certificate_id is provided, validates for renewal. Otherwise, validates new certificate elements. Security: Requires a valid token - [Manage Domain](https://docs.jfrog.com/administration/reference/managedomains.md): Add or delete the defined domains associated to JPDs under a valid SSL certificate. Security: Requires a valid token - [Get the JPD IP Allowlist](https://docs.jfrog.com/administration/reference/getipallowlist.md): Returns the list of IPs in the JPD allowlist. An IP/CIDR allowlist provides access to selected IP addresses and programs that your network server policy could typically block. **Note:** If your JFrog URL is myserver.jfrog.io, the serverName is myserver. Security: Requires a valid token ## Limitations - Maximum Allowlist Count: 4500 unique IP/CIDR values per subscription - Private IPs (RFC 1918) cannot be added: 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16 - [Add IP to IP Allowlist](https://docs.jfrog.com/administration/reference/addiptoallowlist.md): Adds a new IP or a list of new IPs to the JPD allowlist. The existing IPs in the allowlist are not affected. Security: Requires a valid token ## Limitations - A single POST request can contain up to 2500 unique IP/CIDR values - Maximum Allowlist Count: 4500 unique IP/CIDR values per subscription - Private IPs (RFC 1918) cannot be added - [Delete IP from IP Allowlist](https://docs.jfrog.com/administration/reference/deleteipfromallowlist.md): Deletes an IP or list of IPs from the JPD allowlist. Security: Requires a valid token ## Limitations - A single DELETE request can contain up to 2500 unique IP/CIDR values - [GET Platform Cloud NAT IPs](https://docs.jfrog.com/administration/reference/getcloudnatips.md): Get the list of JFrog Cloud Platform NAT IPs. To assure proper communications are established with external services (like LDAP and SSO), you need to whitelist JFrog Platform Cloud NAT IPs on the external service. Security: Does not require authentication. - [Get Available Regions by Cloud Provider](https://docs.jfrog.com/administration/reference/getavailableregions.md): Returns a list of the geographical regions in each provider's cloud that are available for deployment of a JFrog platform. Filter or sort the list as your application requires. Security: Does not require authentication. - [Get JFrog Server List](https://docs.jfrog.com/administration/reference/getserverlist.md): Returns a list of all the JFrog servers defined in your subscription. Filter or sort the list as your application requires. For each server, the list reports the following fields: - server_name: the name of the server - server_type: the type you chose when you created the server (Platform, Distribution Edge, Smart Archive) - cloud_provider: the Cloud vendor that hosts the server - region: the geographical location of the server in the vendor cloud Related documentation: [Manage Your Cloud Topology](/docs/manage-your-cloud-topology). Security: Requires a valid token **Subscription:** This feature is supported on the Cloud (SaaS) platform, with an Enterprise X or Enterprise+ license. - [GET MyJFrog Usage Data](https://docs.jfrog.com/administration/reference/getusagedata.md): Returns a CSV file containing usage data for the subscription over a specified time period. You can define data filters and output settings for the exported report. Related Documentation: This API parallels the filtering and reporting features of the MyJFrog portal's [Usage Explorer tab](/docs/manage-your-cloud-usage). Security: Requires a valid token **Subscription:** This feature is supported on the Cloud (SaaS) platform for all licenses. ## Filter and Group Keys The following keys are valid for the optional filter_by and group_by parameters: - action: Valid values are upload or download - artifact_path: you can group data in blocks of 32 days or more - ip: you can group data in blocks of 32 days or more - package_type - project - repo_type (repository type) - repository - server_name - service - username ## Rate Limiting This API request can generate significant processing loads. To retrieve a large data set, define a series of API requests with date ranges or filters. The following limits are imposed on consecutive submissions of this request: IP-based limits: - 10 requests within 10 minutes - 20 requests per hour Token-based limits: - 5 requests within 5 minutes - 10 requests per hour **Note:** Rate limits may vary from these defaults in response to network conditions and service priorities. ## Response The response payload contains a CSV file named `JFrog-data-transfer-YYYYMMDD-yyyymmdd.csv` where YYYYMMDD is the value of start_date and yyyymmdd is the value of non_inclusive_end_date. All timestamps in the CSV file are UTC. - [Create Smart Archiving Policy](https://docs.jfrog.com/administration/reference/createsmartarchivingpolicy.md): Creates a new package-level smart archiving policy. A policy must be created inactive. This feature is supported in Artifactory version 7.111 and later for cloud only. - [Get Single Smart Archiving Policy by Key](https://docs.jfrog.com/administration/reference/getsmartarchivingpolicy.md): Returns details on a single smart archiving policy. - [Update Smart Archiving Policy](https://docs.jfrog.com/administration/reference/updatesmartarchivingpolicy.md): Updates configuration settings for an existing smart archiving policy. A policy cannot be updated if it is currently running. - [Delete Smart Archiving Policy](https://docs.jfrog.com/administration/reference/deletesmartarchivingpolicy.md): Deletes a smart archiving policy. A policy cannot be deleted if it is currently running. - [Get All Smart Archiving Policies](https://docs.jfrog.com/administration/reference/getallsmartarchivingpolicies.md): Returns a list of all the existing smart archiving policies for either a specific project or for the entire system. - [Disable All Smart Archiving Policies](https://docs.jfrog.com/administration/reference/disableallsmartarchivingpolicies.md): This API is called to disable all smart archiving policies on the global level. - [View Smart Archiving Policies](https://docs.jfrog.com/administration/reference/viewsmartarchivingpolicies.md): Displays smart archiving policies in the user interface and uses various optional filters to refine results. - [Enable/Disable Smart Archiving Policy](https://docs.jfrog.com/administration/reference/enabledisablesmartarchivingpolicy.md): Enables or disables a smart archiving policy. A policy must be enabled for it to run according to the automated schedule set in the cron expression or to trigger a run manually. - [Run Smart Archiving Policy](https://docs.jfrog.com/administration/reference/runsmartarchivingpolicy.md): Manually runs a smart archiving policy. - [Download Smart Archiving Policy Run Report](https://docs.jfrog.com/administration/reference/downloadsmartarchivingpolicyrunreport.md): This REST API is called to download a CSV report after a smart archiving policy run. Platform admins can download run reports for both global smart archiving policies and project-specific smart archiving policies. This API checks that the username is the project admin for the policyKey received and therefore project admins can download run reports for archive policies related to the projects they manage. - [View Smart Archiving Policy Run Summary Report](https://docs.jfrog.com/administration/reference/viewsmartarchivingpolicyrunsummaryreport.md): This REST API is called to view a summary report on a smart archiving policy run. Platform admins can view run summary reports for both global archive policies and project-specific smart archiving policies. This API checks that the username is the project admin for the policyKey received and therefore project admins can view run summary reports for smart archiving policies related to the projects they manage. - [Stop All Running Smart Archiving Policies](https://docs.jfrog.com/administration/reference/stopallrunningsmartarchivingpolicies.md): Stops all running smart archiving policies on the global level. - [Stop Running Smart Archiving Policy](https://docs.jfrog.com/administration/reference/stoprunningsmartarchivingpolicy.md): Stops a smart archiving policy that is currently running. Once a policy has been stopped, it cannot be resumed from the point where it stopped. - [Restore Archived Packages](https://docs.jfrog.com/administration/reference/restorearchivedpackages.md): Restores the archived packages. - [Create an Archive Policy](https://docs.jfrog.com/administration/reference/createarchivepolicy.md): Creates a new archive policy in Artifactory using the provided policy configuration. This Cold Storage feature is available only for Artifactory Enterprise and Enterprise+ users. - [Update an Archive Policy](https://docs.jfrog.com/administration/reference/updatearchivepolicy.md): Updates an existing archive policy based on the policy key. This Cold Storage feature is available only for Artifactory Enterprise and Enterprise+ users. - [Get an Archive Policy](https://docs.jfrog.com/administration/reference/getarchivepolicy.md): Returns an archive policy based on the policy key. This Cold Storage feature is available only for Artifactory Enterprise and Enterprise+ users. - [Delete an Archive Policy](https://docs.jfrog.com/administration/reference/deletearchivepolicy.md): Deletes an existing archive policy based on policy key. This Cold Storage feature is available only for Artifactory Enterprise and Enterprise+ users. - [Get All Archive Policies](https://docs.jfrog.com/administration/reference/getallarchivepolicies.md): Returns a list of all available archive policies. This Cold Storage feature is available only for Artifactory Enterprise and Enterprise+ users. - [Run an Archive Policy](https://docs.jfrog.com/administration/reference/runarchivepolicy.md): Runs an archive policy based on the provided policy key. This Cold Storage feature is available only for Artifactory Enterprise and Enterprise+ users. - [Stop Policy Execution](https://docs.jfrog.com/administration/reference/stoparchivepolicy.md): Stops the execution of an archive policy based on the policy key. This Cold Storage feature is available only for Artifactory Enterprise and Enterprise+ users. - [Preview Retention Policy by Policy Key](https://docs.jfrog.com/administration/reference/previewarchivepolicybykey.md): Provides an estimated count and total size of archive candidates based on the provided retention policy key. This Cold Storage feature is available only for Artifactory Enterprise and Enterprise+ users. - [Preview Retention Policy by Policy Model](https://docs.jfrog.com/administration/reference/previewarchivepolicybymodel.md): Provides an estimated count and total size of archive candidates based on the provided retention policy model. This Cold Storage feature is available only for Artifactory Enterprise and Enterprise+ users. - [Convert Search Criteria Form to AQL](https://docs.jfrog.com/administration/reference/convertsearchcriteriatoaql.md): Generates an AQL query according to the given search criteria form. The generated AQL query can then be used to perform a search. This Cold Storage feature is available only for Artifactory Enterprise and Enterprise+ users. - [Search for Archives](https://docs.jfrog.com/administration/reference/searcharchives.md): Search for archived artifacts based on AQL query. This Cold Storage feature is available only for Artifactory Enterprise and Enterprise+ users. - [Search for Package Archives](https://docs.jfrog.com/administration/reference/searchpackagearchives.md): Search for archived artifacts based on AQL query. This Cold Storage feature is available only for Artifactory Enterprise and Enterprise+ users. - [Get Namespace](https://docs.jfrog.com/administration/reference/getnamespace.md): Get the namespace that was generated for all the repositories during the archive process. This namespace is required when sending a request for restoring artifacts. This Cold Storage feature is available only for Artifactory Enterprise and Enterprise+ users. - [Restore from Archive](https://docs.jfrog.com/administration/reference/restorefromarchive.md): Triggers restoration of multiple items from the Archive. An admin can choose one of the following options - Restore items to the original location and provide fallback repository in case the original location was deprecated. Restore to a dedicated central repository. Important Restore operation only moves the items back to the Warm instance location and does not delete them from the Cold instance. This Cold Storage feature is available only for Artifactory Enterprise and Enterprise+ users. - [Get Archive Policy Status](https://docs.jfrog.com/administration/reference/getarchivepolicystatus.md): Returns the status of an archive policy based on the specified duration and policy key. This Cold Storage feature is available only for Artifactory Enterprise and Enterprise+ users. - [Get Restore Process Status](https://docs.jfrog.com/administration/reference/getrestoreprocessstatus.md): Returns the status of the restore process based on the specified duration and policy key. This Cold Storage feature is available only for Artifactory Enterprise and Enterprise+ users. - [Create a Package Cleanup Policy](https://docs.jfrog.com/administration/reference/createpackagecleanuppolicy.md): This API is called to create a new package-level cleanup policy. Packages Cleanup Policies APIs are supported on Artifactory version 7.98.2 and later. - [Update a Package-Level Cleanup Policy](https://docs.jfrog.com/administration/reference/updatepackagecleanuppolicy.md): This REST API is called to update configuration settings for an existing package-level cleanup policy. A policy cannot be updated if it is currently running. - [Get Single Package Cleanup Policy by Key](https://docs.jfrog.com/administration/reference/getpackagecleanuppolicy.md): This API is called to provide details on a single package cleanup policy. - [Delete Package Cleanup Policy](https://docs.jfrog.com/administration/reference/deletepackagecleanuppolicy.md): Deletes a cleanup policy. A policy cannot be deleted if it is currently running. - [Get all Package Cleanup Policies](https://docs.jfrog.com/administration/reference/getallpackagecleanuppolicies.md): This API is called to return a list of all the existing package cleanup policies for either a specific project or for the entire system. - [Enable/Disable a Package Cleanup Policy](https://docs.jfrog.com/administration/reference/enabledisablepackagecleanuppolicy.md): This REST API is called to enable or disable a package cleanup policy. A policy must be enabled for it to run according to the automated schedule set in the cron expression or to trigger a run manually. A dry run can be performed on a policy that is disabled. - [Manually Run Package Cleanup Policy](https://docs.jfrog.com/administration/reference/runpackagecleanuppolicy.md): This REST API is called to manually run a package cleanup policy. - [Get All Cleanup Bundle Policies](https://docs.jfrog.com/administration/reference/getallreleasebundlecleanuppolicies.md): This API is called to return a list of all the existing release bundle cleanup policies for either a specific project or for the entire system. - [Create a Release Bundle Cleanup Policy](https://docs.jfrog.com/administration/reference/createreleasebundlecleanuppolicy.md): This API is called to create a new release bundle cleanup policy. Release Bundles V2 Cleanup Policies APIs are supported on Artifactory version 7.104.2 and later. - [Update Release Bundle Cleanup Policy](https://docs.jfrog.com/administration/reference/updatereleasebundlecleanuppolicy.md) - [Get Single Release Bundle Cleanup Policy by Key](https://docs.jfrog.com/administration/reference/getreleasebundlecleanuppolicy.md): This API is called to provide details on a single release bundle cleanup policy. - [Delete Release Bundle Cleanup Policy](https://docs.jfrog.com/administration/reference/deletereleasebundlecleanuppolicy.md): Deletes a cleanup policy. A policy cannot be deleted if it is currently running. - [Enable/Disable Release Bundle Cleanup Policy](https://docs.jfrog.com/administration/reference/enabledisablereleasebundlecleanuppolicy.md): This REST API is called to enable or disable a cleanup policy. A policy must be enabled for it to run according to the automated schedule set in the cron expression or to trigger a run manually. A dry run can be performed on a policy that is disabled. - [Manually Run Release Bundle Cleanup Policy](https://docs.jfrog.com/administration/reference/runreleasebundlecleanuppolicy.md): This REST API is called to manually run a release bundle cleanup policy. - [Get All Build Cleanup Policies](https://docs.jfrog.com/administration/reference/getallbuildcleanuppolicies.md): This API is called to return a list of all the existing build cleanup policies for either a specific project or for the entire system. - [Create Build Cleanup Policy](https://docs.jfrog.com/administration/reference/createbuildcleanuppolicy.md): This API is called to create a new build cleanup policy. Build Cleanup Policies APIs are supported on Artifactory version 7.125 and later. - [Update Build Cleanup Policy](https://docs.jfrog.com/administration/reference/updatebuildcleanuppolicy.md): This REST API is called to update configuration settings for an existing build cleanup policy. A policy cannot be updated if it is currently running. - [Get Single Build Cleanup Policy by Key](https://docs.jfrog.com/administration/reference/getbuildcleanuppolicy.md): This API is called to provide details on a single build cleanup policy. - [Delete Build Cleanup Policy](https://docs.jfrog.com/administration/reference/deletebuildcleanuppolicy.md): Deletes a cleanup policy. A policy cannot be deleted if it is currently running. - [Enable/Disable Build Cleanup Policy](https://docs.jfrog.com/administration/reference/enabledisablebuildcleanuppolicy.md): This REST API is called to enable or disable a cleanup policy. A policy must be enabled for it to run according to the automated schedule set in the cron expression or to trigger a run manually. A dry run can be performed on a policy that is disabled. - [Manually Run Build Cleanup Policy](https://docs.jfrog.com/administration/reference/runbuildcleanuppolicy.md): This REST API is called to manually run a build cleanup policy. - [Stop a Running Cleanup Policy](https://docs.jfrog.com/administration/reference/stoprunningcleanuppolicy.md): This REST API is called to stop a cleanup policy that is currently running. Once a policy has been stopped, it cannot be resumed from the point where it stopped. - [Stop All Running Cleanup Policies](https://docs.jfrog.com/administration/reference/stopallrunningcleanuppolicies.md): This API is called to stop all running cleanup policies on the global level. This API stops packages, builds and release bundles running policies. - [Disable All Cleanup Policies](https://docs.jfrog.com/administration/reference/disableallcleanuppolicies.md): This API is called to disable all cleanup policies on the global level. This API disables packages, builds and release bundles policies. - [Get All Cleanup Policies View](https://docs.jfrog.com/administration/reference/getcleanuppoliciesview.md) - [Get Policy Runs View](https://docs.jfrog.com/administration/reference/getcleanuppolicyrunsview.md) - [Get Run Details by Trigger ID](https://docs.jfrog.com/administration/reference/getrunbytriggerid.md) - [Download Cleanup Policy Run Report](https://docs.jfrog.com/administration/reference/downloadcleanuppolicyrunreport.md) - [View Cleanup Policy Run Summary Report](https://docs.jfrog.com/administration/reference/viewcleanuppolicyrunsummaryreport.md): This REST API is called to view a summary report on a cleanup policy run. Platform admins can view run summary reports for both global cleanup policies and project-specific cleanup policies. Since 7.117 - [Get User Details](https://docs.jfrog.com/administration/reference/getuserdetails-1.md): Get the details of an Artifactory user. Note: From Artifactory release 7.49.3, this API is being replaced by the new Security APIs available in the JFrog Platform. Since: 2.4.0 Notes: Requires Artifactory Pro. Security: Requires an admin user - [Get Permission Targets](https://docs.jfrog.com/administration/reference/getpermissiontargets.md): Get the permission targets list. Manages permissions on repositories only. For permissions on builds and release bundles, use the V2 API at `/v2/security/permissions`. Since: 2.4.0 Notes: Requires Artifactory Pro. To support spaces in the User or Group or Permission names, a Plus symbol (+) is automatically placed when there is a space. This is set by default as the artifactory. Security: Requires an admin user - [Get Permission Target Details](https://docs.jfrog.com/administration/reference/getpermissiontargetdetails.md): Returns the details of an Artifactory Permission Target. Manages permissions on repositories only. For permissions on builds and release bundles, use the V2 API at `/v2/security/permissions/{permissionTargetName}`. Since: 2.4.0 Notes: Requires Artifactory Pro. Security: Requires an admin user - [Create or Replace Permission Target](https://docs.jfrog.com/administration/reference/createorreplacepermissiontarget.md): Creates a new permission target in the JFrog Unified Platform or replaces an existing permission target. Manages permissions on repositories only. For permissions on builds and release bundles, use the V2 API at `/v2/security/permissions/{permissionTargetName}`. Since: 2.4.0 Notes: Requires Artifactory Pro. - Missing values will be set to the default values as defined by the consumed type. - Please note when adding Release Bundles permission targets - Requires an Edge/Enterprise+ license On Edge nodes, the repositories section in the request body can be left empty or contain the 'release-bundles' default repository. No other repositories are allowed. An Enterprise+ license allows you to add any repository The default repository in the repository section is "release-bundles" for both Edge/EntPlus licenses. (if user create permission target with empty repositories section the repository that we put is "release bundles") - To support spaces in the User or Group or Permission names, a Plus symbol (+) is automatically placed when there is a space. This is set by default as the artifactory. security.api.plus.insteadof.space property is set to true. If you want to use the + (plus) symbol, set the artifactory.security.api.plus.insteadof.space to false. Security: Requires an admin user - [Delete Permission Target](https://docs.jfrog.com/administration/reference/deletepermissiontarget.md): Deletes an Artifactory permission target. Manages permissions on repositories only. For permissions on builds and release bundles, use the V2 API at `/v2/security/permissions/{permissionTargetName}`. Since: 2.4.0 Notes: Requires Artifactory Pro. - To support spaces in the User or Group or Permission names, a Plus symbol (+) is automatically placed when there is a space. This is set by default as the artifactory.security.api.plus.insteadof.space property is set to true. If you want to use the + (plus) symbol, set the artifactory.security.api.plus.insteadof.space to false. Security: Requires an admin user - [Get Permission Targets (V2)](https://docs.jfrog.com/administration/reference/getpermissiontargetsv2.md): Get the permission targets list for repository and build permission targets. Since: 6.6.0 Notes: Requires Artifactory Pro. It is recommended that users with Artifactory 7.72.0 or later use the Access APIs for permission targets. Security: Requires an admin user or a user with Manage permission on permission target. - [Get Permission Target Details (V2)](https://docs.jfrog.com/administration/reference/getpermissiontargetdetailsv2.md): Get the details of an Artifactory Permission Target. Since: 6.6.0 Notes: Requires Artifactory Pro. Security: Requires an admin user or a user with Manage permission on permission target. - [Permission Target Existence Check](https://docs.jfrog.com/administration/reference/permissiontargetexistencecheckv2.md): Get the existence details of an Artifactory Permission Target. Since: 6.6.0 Notes: Requires Artifactory Pro. Security: Requires an admin user or a user with Manage permission on permission target. - [Create Permission Target](https://docs.jfrog.com/administration/reference/createpermissiontargetv2.md): Creates a new permission target in Artifactory or replaces an existing permission target. Since: 6.6.0 Notes: Requires Artifactory Pro. - Missing values will be set to the default values as defined by the consumed type. - Please note when adding Release Bundles permission targets: - Requires an Edge/Enterprise+ license. - On Edge nodes, the repositories section in the request body can be left empty or contain the 'release-bundles' default repository. No other repositories are allowed. An Enterprise+ license allows you to add any repository. - The default repository in the repository section is "release-bundles" for both Edge/EntPlus licenses. (If the user creates a permission target with an empty repositories section, the repository set is "release-bundles".) - To support spaces in the User or Group or Permission names, a Plus symbol ('+') is automatically placed when there is a space. This is set by default as the security.api.plus.insteadof.space property is set to true. If you want to use the + (plus) symbol, set the security.api.plus.insteadof.space to false. Security: Requires an admin user. - [Create or Replace / Update Permission Target (V2)](https://docs.jfrog.com/administration/reference/createorreplacepermissiontargetv2.md): Creates a new permission target in the JFrog Unified Platform or replaces / updates an existing permission target. Since: 6.6.0 Notes: Requires Artifactory Pro. - Missing values will be set to the default values as defined by the consumed type. - The values defined in the request payload will replace what currently exists in the permission target entity. In case the request is missing one of the permission target entities (repo/build), the entity will be deleted. This means that if an update request is sent to an entity that contains both repo and builds, with only repo, the build values will be removed from the entity. - Please note when adding Release Bundles permission targets: - Requires an Edge/Enterprise+ license. - On Edge nodes, the repositories section in the request body can be left empty or contain the 'release-bundles' default repository. No other repositories are allowed. An Enterprise+ license allows you to add any repository. - The default repository in the repository section is "release-bundles" for both Edge/EntPlus licenses. (If the user creates a permission target with an empty repositories section, the repository set is "release-bundles".) - To support spaces in the User or Group or Permission names, a Plus symbol ('+') is automatically placed when there is a space. This is set by default as the artifactory.security.api.plus.insteadof.space property is set to true. If you want to use the + (plus) symbol, set the artifactory.security.api.plus.insteadof.space to false. Security: Requires an admin user, or a user with Manage permission on the permission target (a user with Manage permission can only edit the actions). - [Delete Permission Target (V2)](https://docs.jfrog.com/administration/reference/deletepermissiontargetv2.md): Deletes an Artifactory permission target. Since: 6.6.0 Notes: Requires Artifactory Pro. - To support spaces in the User or Group or Permission names, a Plus symbol ('+') is automatically placed when there is a space. This is set by default as the security.api.plus.insteadof.space property is set to true. If you want to use the + (plus) symbol, set the security.api.plus.insteadof.space to false. Security: Requires an admin user. - [Get Permission Targets Per User](https://docs.jfrog.com/administration/reference/getpermissiontargetsbyuserv2.md): Get the permission targets list for repository and build permission targets for a specific user. Since: 6.9.0 Notes: Requires Artifactory Pro. - Permission targets are not supported for Virtual repositories. Security: Requires an admin user or a user with Manage permission on permission target. - [Get Permission Targets Per Group](https://docs.jfrog.com/administration/reference/getpermissiontargetsbygroupv2.md): Get the permission targets list for the repository and build permission targets for a specific group. Since: 6.9.0 Notes: Requires Artifactory Pro. - To support spaces in the User or Group or Permission names, a Plus symbol (+) is automatically placed when there is a space. This is set by default as the security.api.plus.insteadof.space property is set to true. If you want to use the + (plus) symbol, set the security.api.plus.insteadof.space to false. - Permission targets are not supported for Virtual repositories. Security: Requires an admin user or a user with Manage permission on permission target. - [Create API Key](https://docs.jfrog.com/administration/reference/createapikey.md): Create an API key for the current user. Returns an error if API key already exists - use regenerate API key instead. **Deprecated:** From Artifactory 7.47.x, the API Key is being deprecated. Since: 4.3.0 - [Regenerate API Key](https://docs.jfrog.com/administration/reference/regenerateapikey.md): Regenerate an API key for the current user **Deprecated:** From Artifactory 7.47.x, the API Key is being deprecated. Since: 4.3.0 - [Get API Key](https://docs.jfrog.com/administration/reference/getapikey.md): Get the current user's own API key **Deprecated:** From Artifactory 7.47.x, the API Key is being deprecated. Since: 4.3.0 - [Revoke API Key](https://docs.jfrog.com/administration/reference/revokeapikey.md): Revokes the current user's API key. When deleteAll is set to 1, revokes all API keys currently defined in the system (requires admin privileges). **Deprecated:** From Artifactory 7.47.x, the API Key is being deprecated. Since: 4.3.0 Security: Revoking all API keys (deleteAll=1) requires a privileged user (Admin only) - [Revoke User API Key](https://docs.jfrog.com/administration/reference/revokeuserapikey.md): Revokes the API key of another user. **Deprecated:** From Artifactory 7.47.x, the API Key is being deprecated. Since: 4.3.0 Security: Requires a privileged user (Admin only) - [Set GPG Public Key](https://docs.jfrog.com/administration/reference/setgpgpublickey.md): Sets the default public GPG key that Artifactory provides to Debian, RPM, and Opkg clients to verify packages. Since: 3.3 Notes: Requires Artifactory Pro. Note that when the GPG key is provided as part of the JSON payload and not in the request header, you need to add the --data-binary flag to the call. Security: Requires an admin user - [Get GPG Public Key](https://docs.jfrog.com/administration/reference/getgpgpublickey.md): Returns the public key that Artifactory provides to Debian and Opkg clients to verify packages Since: 3.3 Notes: Requires Artifactory Pro Security: Requires an authenticated user, or anonymous (if "Anonymous Access" is globally enabled) - [Set GPG Private Key](https://docs.jfrog.com/administration/reference/setgpgprivatekey.md): Sets the default private GPG key that Artifactory uses to sign Debian, RPM, and ipk (Opkg) packages. Since: 3.3 Notes: Requires Artifactory Pro Note that when the GPG key is provided as part of the JSON payload and not in the request header, you need to add the --data-binary flag to the call. Security: Requires an admin user - [Set GPG Pass Phrase](https://docs.jfrog.com/administration/reference/setgpgpassphrase.md): Sets the pass phrase required signing Debian and ipk packages using the private key Since: 3.3 Notes: Requires Artifactory Pro Security: Requires an admin user - [Set Distribution Public GPG Key](https://docs.jfrog.com/administration/reference/setdistributionpublicgpgkey.md): Sets the public preconfigured GPG key of a JFrog Distribution service that needs to upload Release Bundles to a source Artifactory and Edge node. The GPG public key will be uploaded under Trusted Keys in the source Artifactory and Edge node. Since: 6.0 Notes: Requires Artifactory Pro Note that when the public GPG key is provided as part of the JSON payload and not in the request header, you need to add the --data-binary flag to the call. Security: Requires an admin user - [Create Key Pair](https://docs.jfrog.com/administration/reference/createkeypair.md): Creates a new key pair in Artifactory or replaces an existing pair. Since: 7.6.0 Notes: Requires Artifactory Pro You need to add the --data-binary flag to the call when the keys are provided as part of the JSON payload. Security: Requires an admin user - [Get All Key Pairs](https://docs.jfrog.com/administration/reference/getallkeypairs.md): Returns details of all the key pairs. Since: 7.19 Notes: Requires Artifactory Pro Security: Requires an admin user - [Update Key Pair](https://docs.jfrog.com/administration/reference/updatekeypair.md): Updates a key pair with new key pairs. Since: 7.19 Notes: Requires Artifactory Pro Security: Requires a valid admin user - [Get Key Pair](https://docs.jfrog.com/administration/reference/getkeypair.md): Returns the details of a key pair. Since: 7.6.0 Notes: Requires Artifactory Pro Security: Requires an authenticated user, or anonymous (if "Anonymous Access" is globally enabled). - [Delete Key Pair](https://docs.jfrog.com/administration/reference/deletekeypair.md): Deletes a key pair. Since: 7.6.0 Security: Requires a valid admin user - [Verify Key Pair](https://docs.jfrog.com/administration/reference/verifykeypair.md): Verifies the validity of the key pair. Since: 7.19 Notes: Requires Artifactory Pro Security: Requires a valid admin user - [Get Key Pair Public Key Per Repository](https://docs.jfrog.com/administration/reference/getkeypairpublickeyperrepository.md): Returns the public key assigned to a repository. Note - To retrieve the key with its appropriate filename, run cURL request with flags -O -J. Since: 7.6.0 Notes: Requires Artifactory Pro Security: Requires an authenticated user, or anonymous (if "Anonymous Access" is globally enabled). - [Set Key for Repository](https://docs.jfrog.com/administration/reference/setrepositorykey.md): Sets the GPG keys for the repository. Since: 7.19 Security: Requires a valid admin user - [Delete Key from Repository](https://docs.jfrog.com/administration/reference/deleterepositorykey.md): Removes the key pair from the repository. Since: 7.19 Security: Requires a valid admin user - [Download Primary Key](https://docs.jfrog.com/administration/reference/downloadprimarykey.md): Downloads the primary key. Since: 7.19 Security: Requires a valid admin user - [Download Secondary Public Key](https://docs.jfrog.com/administration/reference/downloadsecondarypublickey.md): Downloads the secondary key. Since: 7.19 Security: Requires a valid admin user - [Set Primary Key](https://docs.jfrog.com/administration/reference/setprimarykey.md): Sets the Primary Key for the repository. Since: 7.19 Security: Requires a valid admin user - [Delete Primary Key](https://docs.jfrog.com/administration/reference/deleteprimarykey.md): Deletes the primary key from the repository. Since: 7.19 Security: Requires a valid admin user - [Set Secondary Key](https://docs.jfrog.com/administration/reference/setsecondarykey.md): Sets the secondary key for the repository that will be used as a backup key, in case the primary key has been removed. Since: 7.19 Security: Requires a valid admin user - [Delete Secondary Key](https://docs.jfrog.com/administration/reference/deletesecondarykey.md): Deletes the secondary key from the repository. Since: 7.19 Security: Requires a valid admin user - [Promote Secondary to Primary Key](https://docs.jfrog.com/administration/reference/promotesecondarykey.md): Promotes the secondary key to be the primary key for the repository. Since: 7.19 Security: Requires a valid admin user - [Get Certificates](https://docs.jfrog.com/administration/reference/getcertificates.md): Returns a list of installed SSL certificates. Since: 5.4.0 Security: Requires an admin user - [Add Certificate](https://docs.jfrog.com/administration/reference/addcertificate.md): Adds an SSL certificate. Since: 5.4.0 Security: Requires an admin user - [Delete Certificate](https://docs.jfrog.com/administration/reference/deletecertificate.md): Deletes an SSL certificate. Since: 5.4.0 Security: Requires an admin user - [Activate Artifactory Key Encryption](https://docs.jfrog.com/administration/reference/activateartifactorykeyencryption.md): Creates a new Artifactory encryption key and activates Artifactory key encryption. This is an advanced feature intended for administrators. Since: 3.2.2 Security: Requires an admin user - [Deactivate Artifactory Key Encryption](https://docs.jfrog.com/administration/reference/deactivateartifactorykeyencryption.md): Removes the current Artifactory encryption key and deactivates Artifactory key encryption. This is an advanced feature intended for administrators. The decrypted state is temporary and will be reactivated following config descriptor updates. Since: 3.2.2 Security: Requires an admin user - [Retrieve User Lock Policy](https://docs.jfrog.com/administration/reference/getuserlockpolicy.md): Returns the currently configured user lock policy. Since: 4.4 Security: Requires a valid admin user - [Configure User Lock Policy](https://docs.jfrog.com/administration/reference/configureuserlockpolicy.md): Configures the user lock policy that locks users out of their account if the number of repeated incorrect login attempts exceeds the configured maximum allowed. Since: 4.4 Security: Requires a valid admin user - [Get Locked Out Users](https://docs.jfrog.com/administration/reference/getlockedoutusers.md): If locking out users is enabled, lists all users that were locked out due to recurrent incorrect login attempts. Since: 4.4 Security: Requires a valid admin user - [Unlock Locked-Out Users](https://docs.jfrog.com/administration/reference/unlocklockedoutusers.md): Unlocks a list of users that were locked out due to recurrent incorrect login attempts. Since: 4.4 Security: Requires a valid admin user - [Unlock All Locked Out Users](https://docs.jfrog.com/administration/reference/unlockalllockedoutusers.md): Unlocks all users that were locked out due to recurrent incorrect login attempts. Since: 4.4 Security: Requires a valid admin user - [Get User Encrypted Password](https://docs.jfrog.com/administration/reference/getuserencryptedpassword.md): Get the encrypted password of the authenticated requestor. The request needs to be authenticated using a clear-text password. If you authenticate with an API key, the encrypted API key will be returned in the response. Since: 3.3.0 Security: Requires a privileged user - [Expire Password for Multiple Users](https://docs.jfrog.com/administration/reference/expirepasswordformultipleusers.md): Expires password for a list of users Since: 4.4.2 Notes: Requires Artifactory Pro Security: Requires an admin user - [Unexpire Password for a Single User](https://docs.jfrog.com/administration/reference/unexpirepasswordforsingleuser.md): Unexpires a user's password. Artifactory REST API Future Breaking Change: In an upcoming release of Artifactory, JFrog will expire the "Unexpire Password for a Single User" endpoint from the Artifactory REST APIs and the UI that goes with it (once API v1 is fully deprecated). This means this API will not available in Artifactory REST API V2. Since: 4.4.2 Notes: Requires Artifactory Pro Security: Requires an admin user - [Get Password Expiration Policy](https://docs.jfrog.com/administration/reference/getpasswordexpirationpolicy.md): Returns the password expiration policy Since: 4.4.2 Notes: Requires Artifactory Pro Security: Requires an admin user - [Set Password Expiration Policy](https://docs.jfrog.com/administration/reference/setpasswordexpirationpolicy.md): Sets the password expiration policy Since: 4.4.2 Notes: Requires Artifactory Pro Security: Requires an admin user - [Get Service ID](https://docs.jfrog.com/administration/reference/getserviceid-1.md): Provides the service ID of an Artifactory instance or cluster. Up to version 5.5.1, the Artifactory service ID is formatted jf-artifactory@[id]. From version 5.5.2 the service ID is formatted jfrt@[id]. Since: 5.0.0 Security: Requires an admin user - [Set Logger Debug Levels](https://docs.jfrog.com/administration/reference/setloggerdebuglevels.md): Defines a temporary debug level for one or more loggers in memory without changing the logback.xml file. This request can be used to collect more detailed log information for a short period of time to help investigate a particular issue. When the defined time interval expires, the logger debug level is reset to its previous value. In HA environments, the debug level is propagated so that all nodes have the same log level. **Tip:** This API was intended for customers whose security protocols prevent accessing the loggers remotely via SSH. It is strongly recommended to contact JFrog Support before using this API. A support representative will provide the names of the loggers to include in the request and the desired debug level. **Warning:** Do not send a new POST request until the previous POST request has expired. If you want to change the debug level configuration, first send a DELETE request to undo the previous POST and only then execute a new POST request. **Note:** To return to the previous debug level before the timer expires, use the Delete Logger Debug Levels API. **Note:** If any of the classes defined in the request do not exist, the POST operation will still complete. Therefore, before making a correction, you must either wait for the timer to expire or execute a DELETE operation before sending a new POST request. Since: 7.77.0 Security: Requires an admin user. Supported on the Self-Hosted platform, with a Pro, Pro X, Enterprise X, or Enterprise+ license. - [Delete Logger Debug Levels](https://docs.jfrog.com/administration/reference/deleteloggerdebuglevels.md): Deletes the current logger debug level configuration and restores the previous settings. Use this request when you want to return to the previous settings before they expire automatically. If you want to make changes to a POST request that is still running, run this DELETE request first and then issue a new POST request. This request propagates to all nodes in HA environments. Since: 7.77.0 Security: Requires an admin user. Supported on the Self-Hosted platform, with a Pro, Pro X, Enterprise X, or Enterprise+ license. - [Get Logger Debug Level](https://docs.jfrog.com/administration/reference/getloggerdebuglevel.md): Returns the current debug level configuration for the specified logger. In HA environments, it returns the debug level from whichever node receives the request. If the className defined in the request does not exist, this API returns the default value of the root from logback.xml. Since: 7.77.0 Security: Requires an admin user. Supported on the Self-Hosted platform, with a Pro, Pro X, Enterprise X, or Enterprise+ license. - [Import Repository Content](https://docs.jfrog.com/administration/reference/importrepositorycontent.md): Import one or more repositories. Since: 2.2.2 Security: Requires a valid admin user. - [Import System Settings Example](https://docs.jfrog.com/administration/reference/getimportsystemsettingsexample.md): Returns the default Import Settings JSON. From version 5.10, Artifactory maintains any security entities (users, groups, permissions and tokens) when doing a system import. Since: 2.4.0 Security: Requires a valid admin user. - [Full System Import](https://docs.jfrog.com/administration/reference/fullsystemimport.md): Import full system from a server local Artifactory export directory. From version 5.10, Artifactory maintains any security entities (users, groups, permissions and tokens) when doing a system import. Since: 2.4.0 Security: Requires a valid admin user. - [Export System Settings Example](https://docs.jfrog.com/administration/reference/getexportsystemsettingsexample.md): Returned default Export Settings JSON. Since: 2.4.0 Security: Requires a valid admin user. - [Export System](https://docs.jfrog.com/administration/reference/exportsystem.md): Export full system to a server local directory. Since: 2.4.0 Security: Requires a valid admin user. - [Export Repository with Metadata](https://docs.jfrog.com/administration/reference/exportrepositorywithmetadata.md): Export repository with its metadata. This command creates two directories: Repository Data Directory (contains the exported data) and Metadata Directory (contains the associated metadata). Note: This export API does not adhere to the same structure as the import command (/artifactory/api/import/repositories). Security: Requires a valid admin user. - [Update Curation Interface Settings](https://docs.jfrog.com/administration/reference/updatecurationinterfacesettings.md): Update the curation interface settings, such as whether to allow downloads when the curation service is unavailable. **Security:** Requires a valid admin user. - [Get Curation Interface Settings](https://docs.jfrog.com/administration/reference/getcurationinterfacesettings.md): Retrieve the current curation interface settings. **Security:** Requires a valid admin user. # Governance & Lifecycle Documentation > Documentation for Governance & Lifecycle ## Guides - [Get Started with Governance & Lifecycle (DevGovOps)](https://docs.jfrog.com/governance/docs/getting-started.md): Get ready to deliver secure, compliant, and trusted software releases with JFrog AppTrust. - [AppTrust Overview](https://docs.jfrog.com/governance/docs/jfrog-apptrust.md): High-level overview of JFrog AppTrust, solution for trusted, secure, and compliant application releases. - [AppTrust Quickstart](https://docs.jfrog.com/governance/docs/apptrust-quickstart.md): Do these procedures to get to know the basic workflow and features of JFrog AppTrust. - [AppTrust Prerequisites](https://docs.jfrog.com/governance/docs/apptrust-prerequisites.md) - [AppTrust Onboarding Checklist](https://docs.jfrog.com/governance/docs/apptrust-onboarding-checklist.md): This checklist describes the essential steps to get up and running with JFrog AppTrust. - [Enable AppTrust for Self-Hosted](https://docs.jfrog.com/governance/docs/enable-apptrust-for-self-managed.md): Prerequisites and procedures for enabling JFrog AppTrust on self-managed system - [Project Insights](https://docs.jfrog.com/governance/docs/project-insights.md): JFrog Apptrust project-level dashboard, metrics, and insights - [Applications](https://docs.jfrog.com/governance/docs/application-management.md): How to use the power of applications in JFrog AppTrust - [Choose a Project](https://docs.jfrog.com/governance/docs/projects.md): Choose your project for JFrog AppTrust. - [Create an Application](https://docs.jfrog.com/governance/docs/create-an-application.md): Create an application in JFrog AppTrust. - [Edit an Application](https://docs.jfrog.com/governance/docs/edit-an-application.md): Edit application details in JFrog AppTrust. - [View Applications](https://docs.jfrog.com/governance/docs/view-applications.md): View an overview of all applications and detailed information about a specific application. - [View Application Insights](https://docs.jfrog.com/governance/docs/view-application-insights.md): View application details, post-release CVEs, DORA metrics, and blast radius details. - [View Application Resources](https://docs.jfrog.com/governance/docs/view-application-resources.md): View the resources included in a JFrog AppTrust application. - [Delete an Application](https://docs.jfrog.com/governance/docs/delete-an-application.md): Delete an application in JFrog AppTrust. - [Bind Packages to an Application](https://docs.jfrog.com/governance/docs/bind-packages-to-an-application.md) - [Application Versions](https://docs.jfrog.com/governance/docs/application-version-management.md): Create, manage, and release application versions in JFrog AppTrust. - [Create an Application Version](https://docs.jfrog.com/governance/docs/create-an-application-version.md): Procedure to create an application version in JFrog AppTrust - [Dry Run of Application Version](https://docs.jfrog.com/governance/docs/dry-run-of-application-version.md) - [Draft Application Version](https://docs.jfrog.com/governance/docs/draft-application-version.md) - [Edit an Application Version](https://docs.jfrog.com/governance/docs/edit-an-application-version.md) - [Tag an Application Version](https://docs.jfrog.com/governance/docs/tag-an-application-version.md): Add descriptive tags to application versions in JFrog AppTrust. - [Lifecycle Stages](https://docs.jfrog.com/governance/docs/manage-application-versions-on-the-stages-board.md): In JFrog AppTrust, you can use the Stages Board to track and manage the lifecycle stages in your SDLC. - [Promotion through the Lifecycle](https://docs.jfrog.com/governance/docs/promote-an-application-version.md) - [Promote an Application Version](https://docs.jfrog.com/governance/docs/promote-an-application-version-in-the-platform-ui.md) - [Set Promote and Release Permissions](https://docs.jfrog.com/governance/docs/set-promote-and-release-permissions.md) - [Release an Application Version](https://docs.jfrog.com/governance/docs/release-an-application-version.md): Release an Application Version in JFrog AppTrust. - [Runtime Information](https://docs.jfrog.com/governance/docs/view-runtime-information.md) - [Roll Back an Application Version](https://docs.jfrog.com/governance/docs/roll-back-an-application-version-promotion.md) - [View Application Versions](https://docs.jfrog.com/governance/docs/view-application-versions-in-the-platform-ui.md): For an application in JFrog AppTrust, this is where you see overview information about the application versions. - [View Application Version Details](https://docs.jfrog.com/governance/docs/view-application-version-details.md): Overview of application version details in JFrog AppTrust - [Version Timeline](https://docs.jfrog.com/governance/docs/view-the-application-version-timeline.md): A chronological record of lifecycle events related to the application version in JFrog AppTrust. - [Content](https://docs.jfrog.com/governance/docs/view-the-contents-of-an-application-version.md): Listing of packages and builds included in the version. - [Evidence](https://docs.jfrog.com/governance/docs/view-application-version-evidence.md) - [Risk](https://docs.jfrog.com/governance/docs/view-the-risk-issues-detected-in-an-application-version.md) - [Delete an Application Version](https://docs.jfrog.com/governance/docs/delete-an-application-version.md): Delete an application version from JFrog AppTrust. - [Policies & Evaluations](https://docs.jfrog.com/governance/docs/lifecycle-policy-management.md): Governance policies and evaluations in JFrog AppTrust - [Policies](https://docs.jfrog.com/governance/docs/policies.md) - [Create Lifecycle Policy](https://docs.jfrog.com/governance/docs/create-lifecycle-policies.md) - [Policy Rule Templates](https://docs.jfrog.com/governance/docs/rego-policy-code.md) - [Edit Lifecycle Policy](https://docs.jfrog.com/governance/docs/edit-lifecycle-policies.md) - [View Lifecycle Policy](https://docs.jfrog.com/governance/docs/view-lifecycle-policies.md) - [Delete Lifecycle Policy](https://docs.jfrog.com/governance/docs/delete-lifecycle-policies.md) - [Templates](https://docs.jfrog.com/governance/docs/templates.md): Rule templates and Rego Playground in JFrog AppTrust - [Custom Templates](https://docs.jfrog.com/governance/docs/custom-templates.md) - [Rego Playground](https://docs.jfrog.com/governance/docs/rego-playground.md) - [Create a Template](https://docs.jfrog.com/governance/docs/create-a-template.md) - [Generate Rego Code with AI](https://docs.jfrog.com/governance/docs/generate-rego-code-with-ai.md) - [Allowed Rego Operations](https://docs.jfrog.com/governance/docs/allowed-rego-operations.md) - [Load an Existing Template](https://docs.jfrog.com/governance/docs/load-an-existing-template.md) - [Update a Template](https://docs.jfrog.com/governance/docs/update-a-template.md) - [Delete a Template](https://docs.jfrog.com/governance/docs/delete-a-template.md) - [Evaluations](https://docs.jfrog.com/governance/docs/evaluations.md) - [View Application Evaluations](https://docs.jfrog.com/governance/docs/view-application-evaluations.md) - [View Evaluated Policies](https://docs.jfrog.com/governance/docs/view-evaluated-policies.md) - [View Triggered Issues](https://docs.jfrog.com/governance/docs/view-triggered-issues.md) - [Waivers](https://docs.jfrog.com/governance/docs/waivers.md) - [Request a Waiver](https://docs.jfrog.com/governance/docs/request-a-waiver.md) - [Request Waiver from Failed Promotion](https://docs.jfrog.com/governance/docs/request-waiver-from-failed-promotion.md) - [View Waiver Requests](https://docs.jfrog.com/governance/docs/view-waiver-requests.md) - [Approve or Reject a Waiver Request](https://docs.jfrog.com/governance/docs/approve-or-reject-a-waiver.md) - [Cancel a Waiver Request](https://docs.jfrog.com/governance/docs/cancel-a-waiver-request.md) - [Revoke a Waiver Request](https://docs.jfrog.com/governance/docs/revoke-a-waiver-request.md) - [Activity Log](https://docs.jfrog.com/governance/docs/activity-log.md) - [View the Application Activity Log](https://docs.jfrog.com/governance/docs/view-the-application-activity-log.md) - [Activity Log Events](https://docs.jfrog.com/governance/docs/activity-log-events.md) - [Automation](https://docs.jfrog.com/governance/docs/automation.md): Automate governance and compliance workflows with JFrog AppTrust. - [AppTrust Automation with Terraform](https://docs.jfrog.com/governance/docs/apptrust-automation-with-terraform.md): Terraform providers for JFrog AppTrust enable you to define and manage your application lifecycle and governance policies as code. - [Get Started with AppTrust Provider](https://docs.jfrog.com/governance/docs/get-started-with-apptrust-provider.md) - [Get Started with Unified Policy Provider](https://docs.jfrog.com/governance/docs/get-started-with-unified-policy-provider.md) - [Define AppTrust Webhooks](https://docs.jfrog.com/governance/docs/define-apptrust-webhooks.md): JFrog AppTrust uses webhooks to notify users or trigger automated workflows. - [AppTrust APIs](https://docs.jfrog.com/governance/docs/apptrust-apis.md) - [AppTrust Ecosystem](https://docs.jfrog.com/governance/docs/apptrust-ecosystem.md): JFrog AppTrust Integrations - [AppTrust Jira Integration](https://docs.jfrog.com/governance/docs/jira-integration.md): The JFrog AppTrust Jira integration provides automated traceability between your Jira tickets and your AppTrust application versions. - [Set Up Jira Integration](https://docs.jfrog.com/governance/docs/set-up-jira-integration.md): Set up the AppTrust connection to Jira and configure the JFrog project. - [Development Promotion Process](https://docs.jfrog.com/governance/docs/development-promotion-process.md): The process of promoting application versions when using the Jira integration with JFrog AppTrust - [AppTrust ServiceNow Integration](https://docs.jfrog.com/governance/docs/servicenow-integration.md): Set up the ServiceNow integration in JFrog AppTrust. - [Set Up Authentication](https://docs.jfrog.com/governance/docs/set-up-authentication.md) - [Configure Global Level](https://docs.jfrog.com/governance/docs/configure-global-level.md) - [Configure Project Level](https://docs.jfrog.com/governance/docs/configure-project-level.md) - [Synchronize Applications](https://docs.jfrog.com/governance/docs/synchronize-applications.md) - [Complete a Change Request](https://docs.jfrog.com/governance/docs/complete-a-change-request.md) - [AppTrust Evidence Partners](https://docs.jfrog.com/governance/docs/evidence-partners.md): List of native evidence integrations and reference designs with JFrog AppTrust. - [AppTrust Glossary](https://docs.jfrog.com/governance/docs/apptrust-glossary.md) - [Evidence Management](https://docs.jfrog.com/governance/docs/evidence-management.md) - [Evidence Quickstart](https://docs.jfrog.com/governance/docs/evidence-quick-start.md) - [Evidence Setup](https://docs.jfrog.com/governance/docs/evidence-setup.md) - [Create a Key Pair for Evidence](https://docs.jfrog.com/governance/docs/create-a-key-pair-for-evidence.md) - [Upload the Public Key to Artifactory](https://docs.jfrog.com/governance/docs/upload-the-public-key-to-artifactory.md) - [Create Evidence](https://docs.jfrog.com/governance/docs/create-evidence.md) - [Create Evidence Using the JFrog CLI](https://docs.jfrog.com/governance/docs/create-evidence-using-the-jfrog-cli.md) - [Create Evidence Using REST APIs](https://docs.jfrog.com/governance/docs/create-evidence-using-rest-apis.md) - [Deploy Evidence Directly Using Your Own DSSE](https://docs.jfrog.com/governance/docs/deploy-evidence-directly-using-your-own-dsse-1.md) - [Add an Attachment to Evidence](https://docs.jfrog.com/governance/docs/add-an-attachment-to-evidence.md) - [View Evidence](https://docs.jfrog.com/governance/docs/view-evidence.md) - [Search for Evidence Using GraphQL](https://docs.jfrog.com/governance/docs/search-for-evidence-using-graphql.md) - [Understanding Evidence Files](https://docs.jfrog.com/governance/docs/understanding-evidence-files.md) - [Evidence Predicate](https://docs.jfrog.com/governance/docs/evidence-predicate.md) - [Evidence Payload](https://docs.jfrog.com/governance/docs/evidence-payload.md) - [Evidence Envelope](https://docs.jfrog.com/governance/docs/evidence-envelope.md) - [Evidence Deployment Workflow](https://docs.jfrog.com/governance/docs/evidence-deployment-workflow.md) - [Evidence Deletion Workflow](https://docs.jfrog.com/governance/docs/evidence-deletion-workflow.md) - [Evidence Glossary](https://docs.jfrog.com/governance/docs/evidence-glossary.md) - [Release Lifecycle Management](https://docs.jfrog.com/governance/docs/release-lifecycle-management.md) - [Understanding Release Bundles v2](https://docs.jfrog.com/governance/docs/understanding-release-bundles-v2.md) - [Release Lifecycle Management Workflow](https://docs.jfrog.com/governance/docs/release-lifecycle-management-workflow.md) - [Release Lifecycle Management Setup](https://docs.jfrog.com/governance/docs/release-lifecycle-management-setup.md) - [Create Release Bundles (v2)](https://docs.jfrog.com/governance/docs/create-release-bundles-v2.md) - [Create a Release Bundle v2 in the Platform UI](https://docs.jfrog.com/governance/docs/create-a-release-bundle-v2-in-the-platform-ui.md) - [Change the Signing Key](https://docs.jfrog.com/governance/docs/change-the-signing-key.md) - [Create a Release Bundle v2 using the REST API](https://docs.jfrog.com/governance/docs/create-a-release-bundle-v2-using-the-rest-api.md) - [Patch a Release Bundle v2 Version](https://docs.jfrog.com/governance/docs/patch-a-release-bundle-v2-version.md) - [Perform a Release Bundle v2 Creation Dry Run](https://docs.jfrog.com/governance/docs/perform-a-release-bundle-v2-creation-dry-run.md) - [Create a Draft Release Bundle v2 Version](https://docs.jfrog.com/governance/docs/create-a-draft-release-bundle-v2-version.md) - [Tag a Release Bundle v2 Version](https://docs.jfrog.com/governance/docs/tag-a-release-bundle-v2-version.md) - [Tag a Release Bundle v2 Version in the Platform UI](https://docs.jfrog.com/governance/docs/tag-a-release-bundle-v2-version-in-the-platform-ui.md) - [Promote a Release Bundle v2 Version](https://docs.jfrog.com/governance/docs/promote-a-release-bundle-v2-version.md) - [Promote a Release Bundle v2 Version in the Platform UI](https://docs.jfrog.com/governance/docs/promote-a-release-bundle-v2-version-in-the-platform-ui.md) - [Promotion Rollback](https://docs.jfrog.com/governance/docs/promotion-rollback.md) - [Manage Release Bundle v2 Versions](https://docs.jfrog.com/governance/docs/manage-release-bundle-v2-versions.md) - [View Release Bundle v2 Versions](https://docs.jfrog.com/governance/docs/view-release-bundle-v2-versions.md) - [View Received Release Bundle v2 Versions](https://docs.jfrog.com/governance/docs/view-received-release-bundle-v2-versions.md) - [View Release Bundle v2 Version Details](https://docs.jfrog.com/governance/docs/view-release-bundle-v2-version-details.md) - [Use the Release Bundle Version Timeline](https://docs.jfrog.com/governance/docs/use-the-release-bundle-version-timeline.md) - [View the Definition of a Release Bundle v2 Version](https://docs.jfrog.com/governance/docs/view-the-definition-of-a-release-bundle-v2-version.md) - [View the Contents of a Release Bundle v2 Version](https://docs.jfrog.com/governance/docs/view-the-contents-of-a-release-bundle-v2-version.md) - [View the Release Bundle Version Evidence Table](https://docs.jfrog.com/governance/docs/view-the-release-bundle-version-evidence-table.md) - [Add Properties to a Release Bundle v2 Version](https://docs.jfrog.com/governance/docs/add-properties-to-a-release-bundle-v2-version.md) - [Scan Release Bundle v2 Versions with Xray](https://docs.jfrog.com/governance/docs/scan-release-bundle-v2-versions-with-xray.md) - [Monitor Release Bundle v2 Versions](https://docs.jfrog.com/governance/docs/monitor-release-bundle-v2-versions.md) - [Verify Release Bundle v2 Versions](https://docs.jfrog.com/governance/docs/verify-release-bundle-v2-versions.md) - [Distribute Release Bundles (v2)](https://docs.jfrog.com/governance/docs/distribute-release-bundles-v2.md) - [Distribute a Release Bundle v2 Version using the Platform UI](https://docs.jfrog.com/governance/docs/distribute-a-release-bundle-v2-version-using-the-platform-ui.md) - [Distribute a Release Bundle (v2) using REST APIs](https://docs.jfrog.com/governance/docs/distribute-a-release-bundle-v2-using-rest-apis.md) - [Delete a Release Bundle (v2) Version from a Selected Edge Node](https://docs.jfrog.com/governance/docs/delete-a-release-bundle-v2-version-from-a-selected-edge-node.md) - [Delete a Release Bundle (v2) from Multiple Edge Nodes](https://docs.jfrog.com/governance/docs/delete-a-release-bundle-v2-from-multiple-edge-nodes.md) - [Configure Deleted-at-Target Scraping Service](https://docs.jfrog.com/governance/docs/configure-deleted-at-target-scraping-service.md) - [Distribute Release Bundle v2 Versions in an Air Gap Environment](https://docs.jfrog.com/governance/docs/distribute-release-bundle-v2-versions-in-an-air-gap-environment.md) - [Export Release Bundle v2 Versions in the Platform UI](https://docs.jfrog.com/governance/docs/export-release-bundle-v2-versions-in-the-platform-ui.md) - [Import Release Bundle v2 Versions in the Platform UI](https://docs.jfrog.com/governance/docs/import-release-bundle-v2-versions-in-the-platform-ui.md) - [Export and Import Release Bundle v2 Versions using REST APIs](https://docs.jfrog.com/governance/docs/export-and-import-release-bundle-v2-versions-using-rest-apis.md) - [Delete a Release Bundle v2 Version](https://docs.jfrog.com/governance/docs/delete-a-release-bundle-v2-version.md) - [Release Lifecycle Management in Federated Environments](https://docs.jfrog.com/governance/docs/release-lifecycle-management-in-federated-environments_release-lifecycle-management.md) - [Lifecycle System YAML](https://docs.jfrog.com/governance/docs/lifecycle-system-yaml.md) - [Known Issues and Limitations](https://docs.jfrog.com/governance/docs/known-issues-and-limitations.md) - [AppTrust CLI](https://docs.jfrog.com/governance/docs/apptrust-cli.md) - [Application CLI Commands](https://docs.jfrog.com/governance/docs/application-cli-commands.md) - [Create Application CLI](https://docs.jfrog.com/governance/docs/create-application-cli.md) - [Update Application CLI](https://docs.jfrog.com/governance/docs/update-application-cli.md) - [Delete Application CLI](https://docs.jfrog.com/governance/docs/delete-application-cli.md) - [Application Version CLI Commands](https://docs.jfrog.com/governance/docs/application-version-cli-commands.md) - [Create Application Version CLI](https://docs.jfrog.com/governance/docs/create-application-version-cli.md) - [Update Application Version CLI](https://docs.jfrog.com/governance/docs/update-application-version-cli.md) - [Promote Application Version CLI](https://docs.jfrog.com/governance/docs/promote-application-version-cli.md): Promotes an application version to a target lifecycle stage. - [Release Application Version CLI](https://docs.jfrog.com/governance/docs/release-application-version-cli.md) - [Roll Back Application Version Promotion CLI](https://docs.jfrog.com/governance/docs/roll-back-application-version-promotion-cli.md) - [Delete Application Version CLI](https://docs.jfrog.com/governance/docs/delete-application-version-cli.md) - [Package CLI Commands](https://docs.jfrog.com/governance/docs/package-cli-commands.md) - [Bind Package Version CLI](https://docs.jfrog.com/governance/docs/bind-package-version-cli.md) - [Unbind Package Version CLI](https://docs.jfrog.com/governance/docs/unbind-package-version-cli.md) - [Monorepo Support](https://docs.jfrog.com/governance/docs/monorepo-support.md): Configure monorepo support using the Set Up JFrog CLI GitHub Action. - [Evidence Service CLI](https://docs.jfrog.com/governance/docs/evidence-service-cli.md) - [Generate Evidence Key Pair CLI](https://docs.jfrog.com/governance/docs/generate-evidence-key-pair-cli.md) - [Create Evidence CLI](https://docs.jfrog.com/governance/docs/create-evidence-cli.md) - [Create Evidence CLI - Sample Commands](https://docs.jfrog.com/governance/docs/create-evidence-cli-sample-commands.md) - [Sonar Evidence Integration](https://docs.jfrog.com/governance/docs/sonar-evidence-integration.md) - [Get Evidence CLI](https://docs.jfrog.com/governance/docs/get-evidence-cli.md) - [Get Evidence CLI - Sample Commands](https://docs.jfrog.com/governance/docs/get-evidence-cli-sample-commands.md) - [Verify Evidence CLI](https://docs.jfrog.com/governance/docs/verify-evidence-cli.md) - [Evidence JSON Output Format](https://docs.jfrog.com/governance/docs/evidence-json-output-format.md) - [Release Lifecycle Management CLI](https://docs.jfrog.com/governance/docs/release-lifecycle-management-cli.md) ## API Reference - [JFrog AppTrust REST API](https://docs.jfrog.com/governance/reference/apptrust-rest-api-reference.md): The JFrog AppTrust REST API enables you to programmatically access all the essential AppTrust features. - [Get Activity Log](https://docs.jfrog.com/governance/reference/getactivitylog.md): Returns activity logs, with optional sorting and filtering parameters. All array parameters can be specified multiple times separated by commas. - [Get Applications](https://docs.jfrog.com/governance/reference/getapplications.md): Returns a paginated list of applications, including the latest version and the total number of versions. - [Create Application](https://docs.jfrog.com/governance/reference/createapplication.md): Creates a new application. - [Create applications batch](https://docs.jfrog.com/governance/reference/createapplicationsbatch.md): Create multiple applications in a single batch operation. Returns 207 with succeeded and failed arrays showing results for each application. - [Delete Application](https://docs.jfrog.com/governance/reference/deleteapplication.md): Deletes the specified application from the JFrog platform, including all associated versions. - [Get Application Details](https://docs.jfrog.com/governance/reference/getapplication.md): Returns the details of a selected application, such as its creation time, owners, defined labels, and so on. - [Update Application](https://docs.jfrog.com/governance/reference/updateapplication.md): Updates the definition of the specified application with new data. All fields in the body are optional, which means that only the fields included in the request body will be replaced. Note that the application_key and project_key cannot be modified. - [List Application Evaluations](https://docs.jfrog.com/governance/reference/listapplicationevaluations.md): List the evaluations for an application across all its versions. - [Unsync integration](https://docs.jfrog.com/governance/reference/unsyncapplicationintegration.md): Unsyncs an integration from an application by removing integration-related labels. The integration must be present in the request context. This is an idempotent operation - returns 200 OK even if the integration is already unsynced. - [Get Application Package Bindings](https://docs.jfrog.com/governance/reference/getapplicationpackages.md): Returns a paginated list of unique packages bound with the specified application, including summary details. - [Bind Package Version](https://docs.jfrog.com/governance/reference/bindapplicationpackage.md): Binds a specific package version with the specified application. A specific package version can be bound to only one application. - [Get Bound Package Versions](https://docs.jfrog.com/governance/reference/getapplicationpackageversions.md): Returns a list of package versions that are bound with the specified application. - [Unbind Package Version](https://docs.jfrog.com/governance/reference/unbindapplicationpackageversion.md): Disassociates (unbinds) the specified package version from the specified application. This action removes the ownership link between them, and the package version will no longer be considered as belonging to the application. - [Get Application Versions](https://docs.jfrog.com/governance/reference/getapplicationversions.md): Returns a list of application versions associated with the specified application key. - [Create Application Version](https://docs.jfrog.com/governance/reference/createapplicationversion.md): Creates a new version of an application. - [Delete Application Version](https://docs.jfrog.com/governance/reference/deleteapplicationversion.md): Deletes the specified application version. - [Update Application Version](https://docs.jfrog.com/governance/reference/updateapplicationversion.md): Updates the tag and/or properties of the specified application version. You can set or replace values for specific property keys. - [Get Application Version Content](https://docs.jfrog.com/governance/reference/getapplicationversioncontent.md): Returns detailed content for a specified application version, including its components (artifacts, packages, builds), sources, and the ownership details for each component. - [List Application Version Evaluations](https://docs.jfrog.com/governance/reference/listapplicationversionevaluations.md): List the evaluations for a specific application version. - [Get Application Version Evaluation](https://docs.jfrog.com/governance/reference/getapplicationversionevaluation.md): Get a specific evaluation for an application version. - [Post Integration Event](https://docs.jfrog.com/governance/reference/createapplicationversionintegrationevent.md): Post an integration event for a specific application version. - [Get Application Version Status](https://docs.jfrog.com/governance/reference/getapplicationversionstatus.md): Get the release status for a specific application version from Release Lifecycle Management (RLM). - [Distribute Application Version](https://docs.jfrog.com/governance/reference/distributeapplicationversion.md): Distributes the specified application version to the target destinations. - [Remote Delete Application Version](https://docs.jfrog.com/governance/reference/remotedeleteapplicationversion.md): Remotely deletes the specified application version from the target destinations. - [Promote Application Version](https://docs.jfrog.com/governance/reference/promoteapplicationversion.md): Promotes the specified application version to the desired stage. It includes options for including/excluding repositories, specifying running conditions, and providing comments.

Note: To move an application version to the official release stage, use the Release Application Version API. - [Get Application Version Promotions](https://docs.jfrog.com/governance/reference/getapplicationversionpromotions.md): Returns the details of all promotions of the specified application version. - [Get Application Version Promotion Details](https://docs.jfrog.com/governance/reference/getapplicationversionpromotion.md): Returns the details of the specified application version promotion. Security: Requires Read permissions to the target application version path. - [Release Application Version](https://docs.jfrog.com/governance/reference/releaseapplicationversion.md): Releases the specified application version by moving it to the PROD stage. - [Rollback Application Version](https://docs.jfrog.com/governance/reference/rollbackapplicationversion.md): Rolls back the latest promotion of the specified application version to its previous stage. This action removes the promotion record, but the audit log will retain a history of the rollback. The behavior of the rollback on the artifacts in the application version depends on the original promotion type:

- Copy promotion: Artifacts in the current stage's repositories are deleted.
- Move promotion: Artifacts are removed from the current stage's repositories and restored to the previous stage's repositories from a secure internal repository.

Note: Rollback can be performed from the PROD stage, if needed.

Note: If an artifact in the target stage has been overwritten by a newer promotion (i.e., the artifact's SHA-256 no longer matches the version's original manifest), that artifact is skipped during rollback and a warning is returned. This prevents accidental deletion of artifacts that now belong to a different version. - [Save integration configuration](https://docs.jfrog.com/governance/reference/saveintegrationconfig.md): Saves configuration details for an integration (e.g., ServiceNow or Jira) to JFrog platform config - [Remove integration](https://docs.jfrog.com/governance/reference/removeintegration.md): Removes the specified integration, deleting its configuration from the platform config store - [Get metrics](https://docs.jfrog.com/governance/reference/getmetrics.md): Collect and return the metrics - [Get lifecycle stages with gates](https://docs.jfrog.com/governance/reference/getprojectlifecyclestages.md): Get lifecycle stages with gates. Gates are filtered based on category and filter_gates_by parameter. - [Get stages by project key](https://docs.jfrog.com/governance/reference/getprojectstages.md): Get stages by project key - [Get release stage by project key](https://docs.jfrog.com/governance/reference/getprojectreleasestage.md): Get release stage by project key - [Check the liveness of the service](https://docs.jfrog.com/governance/reference/checkliveness.md): Get the liveness status of the service - [Ping the service](https://docs.jfrog.com/governance/reference/ping.md): Get the service status - [Check the readiness of the service](https://docs.jfrog.com/governance/reference/checkreadiness.md): Get the readiness status of the service - [Get the service ID](https://docs.jfrog.com/governance/reference/getserviceid.md): Get the service ID of the node - [Create a support bundle](https://docs.jfrog.com/governance/reference/createsupportbundle.md): Create a support bundle for the service - [List all templates](https://docs.jfrog.com/governance/reference/templateslist.md): Retrieve a paginated list of all templates in the system. - [Create a new template](https://docs.jfrog.com/governance/reference/templatescreate.md): Create a new template in the system. - [Get a specific template](https://docs.jfrog.com/governance/reference/templatesget.md): Retrieve detailed information about a specific template by its unique identifier. - [Update an existing template](https://docs.jfrog.com/governance/reference/templatesupdate.md): Update an existing template with new configuration. - [Delete a template](https://docs.jfrog.com/governance/reference/templatesdelete.md): Delete a template by its unique identifier. This endpoint removes the specified template from the system. - [List all rules](https://docs.jfrog.com/governance/reference/ruleslist.md): Retrieve a paginated list of all rules in the system. This endpoint supports filtering by template category and other criteria. **Expand Parameter:** - Use `expand=template` to include complete template details with each rule - [Create a new rule](https://docs.jfrog.com/governance/reference/rulescreate.md): Create a new rule in the system. - [Get a specific rule](https://docs.jfrog.com/governance/reference/rulesget.md): Retrieve detailed information about a specific rule by its unique identifier. This endpoint supports expanding template details using the expand parameter. - [Update an existing rule](https://docs.jfrog.com/governance/reference/ruleupdate.md): Update an existing rule with new configuration. - [Delete a rule](https://docs.jfrog.com/governance/reference/ruledelete.md): Delete a rule by its unique identifier. This endpoint removes the specified rule from the system. - [List all policies](https://docs.jfrog.com/governance/reference/policieslist.md): Retrieve a paginated list of all policies in the system. This endpoint supports pagination and filtering of policies based on various criteria. - [Create a new policy](https://docs.jfrog.com/governance/reference/policiescreate.md): Create a new policy in the system. The policy must include a unique name, description, and the policy rules to be enforced. - [Get a specific policy](https://docs.jfrog.com/governance/reference/policiesget.md): Retrieve detailed information about a specific policy by its unique identifier. This endpoint returns the complete policy configuration including rules and metadata. - [Update an existing policy](https://docs.jfrog.com/governance/reference/policiesupdate.md): Update an existing policy with new configuration. This endpoint allows updating any aspect of the policy including rules, description, and other metadata. - [Delete a policy](https://docs.jfrog.com/governance/reference/policiesdelete.md): Delete a policy by its unique identifier. This endpoint removes the specified policy from the system. - [List all evaluations](https://docs.jfrog.com/governance/reference/evaluationslist.md): Retrieve a paginated list of all evaluations in the system. This endpoint supports pagination and filtering of evaluations based on various criteria. - [Get a specific evaluation](https://docs.jfrog.com/governance/reference/evaluationsget.md): Retrieve detailed information about a specific evaluation by its unique identifier. This endpoint returns the complete evaluation summary. - [Create Lifecycle Stage](https://docs.jfrog.com/governance/reference/createlifecyclestage.md): Creates a new global or project-level lifecycle stage. Since: 7.125.4 - [Get Lifecycle Stages](https://docs.jfrog.com/governance/reference/getlifecyclestages-1.md): Returns a list of all stages with optional filtering. When no project_key is defined, this endpoint returns all global stages and is available to platform administrators only. When a specific project_key is defined, this endpoint returns both global stages and the relevant project stages, and is available to project administrators for that project. Since: 7.125.4 - [Get Lifecycle Stage Details](https://docs.jfrog.com/governance/reference/getlifecyclestagedetails.md): Returns the details of a selected lifecycle stage, such as its scope and associated repositories. Since: 7.125.4 - [Update Stage](https://docs.jfrog.com/governance/reference/updatestage.md): Updates the definition of the specified stage with new data, including the name, category, and associated repositories (for project stages). The category can be modified only if the stage is not in use by a lifecycle. The repositories field is relevant only when the category is promote. Since: 7.125.4 - [Delete Lifecycle Stage](https://docs.jfrog.com/governance/reference/deletelifecyclestage.md): Deletes the specified lifecycle stage from the JFrog platform. Important: You cannot delete a stage that is in use by a lifecycle. Since: 7.125.4 - [Get Lifecycle](https://docs.jfrog.com/governance/reference/getlifecycle.md): Returns the global lifecycle definition, or optionally, the lifecycle definition for a specific project. Since: 7.125.4 - [Update Lifecycle](https://docs.jfrog.com/governance/reference/updatelifecycle.md): Adds, removes, and reorders the stages of a project lifecycle. Note: Global stages, such as PR, COMMIT, and PROD, cannot be modified and should not be included in the request. Since: 7.125.4 - [Deploy Evidence](https://docs.jfrog.com/governance/reference/deployevidence.md): Deploys an evidence file for the designated subject that complies with the DSSE framework and the in-toto Attestation Framework. This API endpoint deploys an external evidence file that was created elsewhere. An efficient method for attaching evidence to a subject, such as an artifact, is to use the Create Evidence CLI. This feature is supported with the Enterprise+ license. - [Get Evidence by Subject](https://docs.jfrog.com/governance/reference/getevidencebysubject.md): Retrieves all evidence records associated with the specified subject. The subject is identified by its repository path. - [Delete Evidence](https://docs.jfrog.com/governance/reference/deleteevidence.md): Deletes the specified evidence file and its database record. - [Get Evidence by ID](https://docs.jfrog.com/governance/reference/getevidencebyid.md): Retrieves a single evidence record by its unique identifier. - [Search Evidence](https://docs.jfrog.com/governance/reference/searchevidence.md): Searches for evidence records using query parameters. Returns a paginated list of evidence records matching the specified filters. - [Prepare Evidence for Signing](https://docs.jfrog.com/governance/reference/prepareevidence.md): Prepares an in-toto statement for external signing. Returns the DSSE payload (base64-encoded) and the URL to POST the signed envelope to. This is the first step in a two-step evidence creation flow: 1. Call this endpoint to prepare the statement and receive the DSSE payload 2. Sign the payload externally and POST the signed DSSE envelope to the returned `post_url` - [Create Release Bundle v2 Version](https://docs.jfrog.com/governance/reference/createbundleversion.md): Creates a new Release Bundle v2, uniquely identified by a combination of repository key, name, and version. You can create a Release Bundle version using one or a combination of the following source types AQL, Artifacts, Packages, Builds, or Release Bundles. - [Update Release Bundle v2 Version](https://docs.jfrog.com/governance/reference/updatebundleversion.md): Updates an existing draft Release Bundle v2 version by adding new sources and/or applying filters. The bundle must be in draft state to be updated. You can add sources of any supported type (AQL, Artifacts, Packages, Builds, or Release Bundles) and optionally apply inclusion/exclusion filters. - [Get Release Bundle v2 Names](https://docs.jfrog.com/governance/reference/getbundlenames.md): Returns a list of Release Bundle v2 names mapped to their repository key (and project key, where applicable). - [Get Release Bundle v2 Groups](https://docs.jfrog.com/governance/reference/getbundlegroups.md): Returns a list of Release Bundle v2 names mapped to their repository key. Each element includes the latest version and the total number of versions. - [Get Release Bundle v2 Versions](https://docs.jfrog.com/governance/reference/getbundleversions.md): Returns a list of versions for a specified Release Bundle v2. Records are provided regardless of status, including failed attempts at creation. You can filter the results based on version, creator, tags, status, and where they have been promoted. - [Get Release Bundle v2 Version Details](https://docs.jfrog.com/governance/reference/getbundleversion.md): Returns the details of a selected Release Bundle v2 version, such as its creation time, the user who created it, the artifacts it includes, and so on. The details are stored in the form of a DSSE attestation, a signature envelope with a Base64-encoded payload, which contains a snapshot of the items in the Release Bundle. - [Delete Release Bundle v2 Version](https://docs.jfrog.com/governance/reference/deletebundleversion.md): Deletes a specific Release Bundle v2 version. Can be performed synchronously or asynchronously. - [Get Release Bundle v2 Latest Version](https://docs.jfrog.com/governance/reference/getbundleversionlatest.md): Retrieves the latest version of a release bundle by name. Returns the bundle descriptor and includes X-Ray SHA256 in response header if available. - [Get Release Bundle v2 Version Signature](https://docs.jfrog.com/governance/reference/getbundleversionsignature.md): Retrieves the DSSE envelope signature of a specific Release Bundle v2 version. - [Get Release Bundle v2 Version Status](https://docs.jfrog.com/governance/reference/getbundleversionstatus.md): Retrieves the status of a specific Release Bundle v2 version. - [Get Release Bundle v2 Versions by Artifact](https://docs.jfrog.com/governance/reference/getbundlesbyartifact.md): Returns a list of Release Bundle v2 versions that contain the specified artifact. Supports filtering by bundle name, artifact path, SHA256, and pagination. - [Assign Tag to Release Bundle v2 Version](https://docs.jfrog.com/governance/reference/setbundletag.md): Assigns a descriptive tag to a Release Bundle v2 version. The tag will appear on the card for the Release Bundle version on the Release Lifecycle stages board. - [Delete Release Bundle v2 Version Tag](https://docs.jfrog.com/governance/reference/deletebundletag.md): Deletes the tag from the selected Release Bundle v2 version. - [Get Release Bundle v2 Versions in a Specific Environment](https://docs.jfrog.com/governance/reference/getbundlesbyenvironment.md): Returns a list of Release Bundle v2 versions that have been promoted to a specific environment. - [Finalize Release Bundle v2 Version](https://docs.jfrog.com/governance/reference/finalizebundleversion.md): Finalizes a draft Release Bundle v2 version, making it immutable. Once finalized, a bundle version cannot be updated further. This operation is idempotent and will succeed even if the bundle is already finalized. - [List Received Release Bundle v2 Versions](https://docs.jfrog.com/governance/reference/getreceivedbundles.md): Returns a list of Release Bundle v2 versions that have been received on this Artifactory instance (e.g. as a distribution target). Results can be filtered and ordered by name, source project key, or date received. - [Get Received Release Bundle v2 Versions by Name](https://docs.jfrog.com/governance/reference/getreceivedbundleversions.md): Returns the list of versions for a given Release Bundle v2 name that have been received on this instance. - [Get Received Release Bundle v2 Version Artifacts](https://docs.jfrog.com/governance/reference/getreceivedbundleversionartifacts.md): Returns the list of artifacts included in a specific Release Bundle v2 version that has been received on this instance. - [Get Received Release Bundle v2 Version Status](https://docs.jfrog.com/governance/reference/getreceivedbundleversionstatus.md): Returns the status and messages for a specific Release Bundle v2 version that has been received on this instance (e.g. distribution/promotion status). - [Delete Received Release Bundle v2 Version](https://docs.jfrog.com/governance/reference/deletereceivedbundleversion.md): Deletes a Release Bundle v2 version that has been received on this Artifactory instance (e.g. as a distribution target). Used for remote delete from Distribution or cleanup of received bundle data. When async is true, returns 200 with a submission message; when false, returns 204 when deletion completes. - [Roll Back Release Bundle v2 Version Promotion](https://docs.jfrog.com/governance/reference/rollbackpromotion.md): Removes the latest promotion of a Release Bundle v2 version and restores the version to its previous environment, including the properties and evidence that were present when the version was first created. - [Get Release Bundle v2 Promotions](https://docs.jfrog.com/governance/reference/getpromotions.md): Returns the records of all promotions for the specified Release Bundle v2 (regardless of version). All promotion records are provided regardless of status, including failed attempts. - [Promote Release Bundle v2 Version](https://docs.jfrog.com/governance/reference/createpromotion.md): Promotes the selected Release Bundle v2 version. - [Get Release Bundle v2 Version Promotions](https://docs.jfrog.com/governance/reference/getpromotionsbyversion.md): Returns the details of all promotions for the specified Release Bundle v2 version. All promotion records are provided regardless of status, including failed attempts. - [Get Release Bundle v2 Version Promotion Details](https://docs.jfrog.com/governance/reference/getpromotiondetails.md): Returns the specification of the specified Release Bundle v2 version promotion. The specification file contains a snapshot of the items in the promotion. - [Delete Release Bundle v2 Version Promotion](https://docs.jfrog.com/governance/reference/deletepromotion.md): Deletes a specific Release Bundle v2 version promotion. - [Get Release Bundle v2 Version Promotion Status](https://docs.jfrog.com/governance/reference/getpromotionstatus.md): Retrieves the status of a specific Release Bundle v2 version promotion. - [Get Release Bundle v2 Version Promotions with a Specific Artifact](https://docs.jfrog.com/governance/reference/getpromotionsbyartifact.md): Returns a list of Release Bundle v2 version promotions that contain the specified artifact. - [Distribute Release Bundle Version v2](https://docs.jfrog.com/governance/reference/distributebundleversion.md): Distributes a Release Bundle v2 version. - [Abort Release Bundle V2 Distribution](https://docs.jfrog.com/governance/reference/abortdistribution.md): Aborts the distribution of a Release Bundle v2 version. The Abort operation affects only those targets that have not yet received the complete Release Bundle. - [Get Release Bundle V2 Distributions](https://docs.jfrog.com/governance/reference/getdistributions.md): Returns a list of distributions for a specified Release Bundle v2 version. - [Get Release Bundle V2 Distribution Details](https://docs.jfrog.com/governance/reference/getdistributiondetails.md): Returns the details of a specific distribution of a Release Bundle v2 version. - [Remote Delete Release Bundle V2 Distribution](https://docs.jfrog.com/governance/reference/remotedeletedistribution.md): Deletes the Release Bundle v2 version from the distribution targets. (The Release Bundle version is not deleted locally.) - [Propagate Public Signing Key](https://docs.jfrog.com/governance/reference/propagatesigningkey.md): Propagates the public signing key created in Artifactory to Edge nodes. This enables Distribution to distribute a Release Bundle v2 version using the same signing key used in Artifactory to create and promote the Release Bundle. - [Export Release Bundle Version v2 Archived File](https://docs.jfrog.com/governance/reference/exportbundleversion.md): Triggers the Release Bundle v2 export process from JFrog Distribution. This is used when working in an Air Gap environment. - [Get Exported Release Bundle Version v2 Status](https://docs.jfrog.com/governance/reference/getexportstatus.md): Returns the status of an exported Release Bundle v2 operation. - [Delete Exported Release Bundle v2 Archive File](https://docs.jfrog.com/governance/reference/deleteexportarchive.md): Deletes the exported Release Bundle v2 archive from Distribution. # Security Documentation > Documentation for Security ## Guides - [End-to-End Experience](https://docs.jfrog.com/security/docs/end-to-end-experience.md) - [Products/Concepts](https://docs.jfrog.com/security/docs/products-concepts.md) - [Curation](https://docs.jfrog.com/security/docs/curation-intro.md) - [Features and Capabilities](https://docs.jfrog.com/security/docs/features-and-capabilities.md) - [Catalog](https://docs.jfrog.com/security/docs/catalog.md) - [Features and Capabilities](https://docs.jfrog.com/security/docs/features-and-capabilities-getting-started.md) - [Xray](https://docs.jfrog.com/security/docs/xray.md) - [Features and Capabilities](https://docs.jfrog.com/security/docs/features-and-capabilities-getting-started-2.md) - [Advanced Security](https://docs.jfrog.com/security/docs/advanced-security.md) - [Features and Capabilities](https://docs.jfrog.com/security/docs/features-and-capabilities-p.md) - [Contextual Analysis of CVEs](https://docs.jfrog.com/security/docs/contextual-analysis-of-cves.md) - [Secrets Scans](https://docs.jfrog.com/security/docs/secrets-scans-p.md) - [Custom Secrets Scanner](https://docs.jfrog.com/security/docs/custom-secrets-scanner.md) - [Misconfigurations Scans](https://docs.jfrog.com/security/docs/misconfigurations-scans.md) - [Advanced Security Reports](https://docs.jfrog.com/security/docs/advanced-security-reports.md) - [SAST](https://docs.jfrog.com/security/docs/sast-p.md) - [Prerequisites](https://docs.jfrog.com/security/docs/prerequisites.md) - [List of SAST Rules](https://docs.jfrog.com/security/docs/list-of-sast-rules.md) - [Runtime](https://docs.jfrog.com/security/docs/runtime.md) - [Features and Capabilities](https://docs.jfrog.com/security/docs/features-and-capabilities-getting-started-3.md) - [Source Code](https://docs.jfrog.com/security/docs/source-code.md) - [Curation Workshop](https://docs.jfrog.com/security/docs/curation-workshop.md) - [Part 1: Curation Rollout Overview](https://docs.jfrog.com/security/docs/curation-rollout-overview.md) - [Part 2: Prepare for Curation Rollout](https://docs.jfrog.com/security/docs/part-2-prepare-for-curation-rollout.md) - [Part 3: Block Malicious Packages](https://docs.jfrog.com/security/docs/part-3-block-malicious-packages.md) - [Part 4: Estimate Policy Impact Using Dry Run](https://docs.jfrog.com/security/docs/part-4-estimate-policy-impact-using-dry-run.md) - [ Part 5: Apply Organization-Wide Blocking Policies](https://docs.jfrog.com/security/docs/part-5-apply-organization-wide-blocking-policies.md) - [Part 6: Apply Scoped and Project-Level Policies](https://docs.jfrog.com/security/docs/part-6-apply-scoped-and-project-level-policies.md) - [Part 7: Operate and Monitor Curation](https://docs.jfrog.com/security/docs/part-7-operate-and-monitor-curation.md) - [Xray Workshop](https://docs.jfrog.com/security/docs/xray-workshop.md) - [Part 1: Xray and DevSecOps Overview](https://docs.jfrog.com/security/docs/part-1-xray-and-devsecops-overview.md) - [Part 2: Plan Your Xray Rollout](https://docs.jfrog.com/security/docs/part-2-plan-your-xray-rollout.md) - [Part 3: Prepare and Configure Xray](https://docs.jfrog.com/security/docs/part-3-prepare-and-configure-xray.md) - [Part 4: Run Xray in Notification Mode (Dry Run)](https://docs.jfrog.com/security/docs/part-4-run-xray-in-notification-mode-dry-run.md) - [Part 5: Enforce Policies and Monitor Risk](https://docs.jfrog.com/security/docs/part-5-enforce-policies-and-monitor-risk.md) - [Part 6: Operate Xray as Part of DevSecOps](https://docs.jfrog.com/security/docs/part-6-operate-xray-as-part-of-devsecops.md) - [Glossary](https://docs.jfrog.com/security/docs/glossary.md) - [Supported Technologies](https://docs.jfrog.com/security/docs/supported-technologies.md) - [Compliant Version Selection](https://docs.jfrog.com/security/docs/compliant-version-selection.md) - [Behavior By Package ](https://docs.jfrog.com/security/docs/behavior-by-package.md) - [Curation Federation](https://docs.jfrog.com/security/docs/curation-federation.md) - [Configure Curation](https://docs.jfrog.com/security/docs/configure-curation.md) - [Configure Curation for Self-Managed](https://docs.jfrog.com/security/docs/configure-curation-for-self-hosted.md) - [Set User Roles and Permissions](https://docs.jfrog.com/security/docs/set-user-roles-and-permissions.md) - [General](https://docs.jfrog.com/security/docs/general.md) - [Configure Repositories](https://docs.jfrog.com/security/docs/configure-repositories.md) - [Connect Remote Repositories to Curation](https://docs.jfrog.com/security/docs/connect-remote-repositories-to-curation.md) - [Enable Pass-Through for Specific Repositories](https://docs.jfrog.com/security/docs/enable-pass-through-for-specific-repositories.md) - [Create Policies](https://docs.jfrog.com/security/docs/create-policies-1.md) - [List of Available Conditions](https://docs.jfrog.com/security/docs/list-of-available-conditions.md) - [Create Custom Conditions](https://docs.jfrog.com/security/docs/create-custom-conditions.md) - [Fallback Behavior for Blocked Packages](https://docs.jfrog.com/security/docs/fallback-behavior-for-blocked-packages.md) - [Block Downloads from Cached Remote Repositories](https://docs.jfrog.com/security/docs/block-downloads-from-cached-remote-repositories.md) - [On-Demand Curation](https://docs.jfrog.com/security/docs/on-demand-curation.md) - [Curation Webhooks](https://docs.jfrog.com/security/docs/curation-webhooks.md) - [Package Traffic Controller (PTC)](https://docs.jfrog.com/security/docs/package-traffic-controller.md): Route public package traffic through Artifactory via your security edge for JFrog Curation policy enforcement and audit. - [PTC Quick Start](https://docs.jfrog.com/security/docs/quick-start.md): Set up Package Traffic Controller (PTC) for a first pilot: Artifactory, workstations, and security edge redirect rules. - [Deploy and Roll Out PTC](https://docs.jfrog.com/security/docs/deployment-and-rollout.md): Deploy Package Traffic Controller (PTC) in order: Artifactory, workstation trust, then SASE redirect rules, with phased rollout guidance for SaaS consumption. - [Review PTC Prerequisites](https://docs.jfrog.com/security/docs/prerequisites-and-installation-script.md): Review prerequisites for Package Traffic Controller (PTC), including SASE and JFrog Artifactory requirements. - [Configure Workstation for PTC](https://docs.jfrog.com/security/docs/configure-workstation.md): Install the SASE CA certificate and set environment variables on developer workstations so package managers (npm, pip, Docker, and others) trust SSL inspection for Package Traffic Controller (PTC). - [Configure Artifactory for PTC](https://docs.jfrog.com/security/docs/configure-artifactory.md): Configure JFrog Artifactory remote repositories and register package types for Package Traffic Controller (PTC). - [Configure Zscaler ZIA for PTC](https://docs.jfrog.com/security/docs/configure-zscaler-zia.md): Configure Zscaler ZIA URL categories, SSL inspection, and redirect rules to send package traffic to Artifactory for Package Traffic Controller (PTC). - [Configure Netskope for PTC](https://docs.jfrog.com/security/docs/configure-netskope.md): Configure Netskope destination profiles, HTTP header profiles, and real-time protection policies to send package traffic to Artifactory for Package Traffic Controller (PTC). - [Configure Cloudflare Gateway for PTC](https://docs.jfrog.com/security/docs/configure-cloudflare.md): Configure Cloudflare Gateway to redirect package traffic to Artifactory for PTC. - [Configuration by Package Type](https://docs.jfrog.com/security/docs/configuration-by-package-type.md): Set SASE intercept hostnames, redirect methods, and client trust for npm, PyPI, Docker, and Hugging Face when routing public registry traffic through JFrog Artifactory. - [Package Reroute Logs for PTC](https://docs.jfrog.com/security/docs/package-reroute-logs.md): View, interpret, and use Package Traffic Controller (PTC) reroute log lines in JFrog Artifactory for verification, audit, and troubleshooting. - [Limitations and Troubleshooting](https://docs.jfrog.com/security/docs/limitations-and-troubleshooting.md): Review Package Traffic Controller (PTC) limitations, verify your deployment, resolve common SSL and redirect issues, and roll back security edge redirect rules when needed. - [Manage Curation](https://docs.jfrog.com/security/docs/manage-curation-p.md) - [Manage Repositories](https://docs.jfrog.com/security/docs/manage-repositories.md) - [Manage Policies](https://docs.jfrog.com/security/docs/manage-policies.md) - [Curated Packages Audit Events](https://docs.jfrog.com/security/docs/curated-packages-audit-events.md) - [Manage Waivers](https://docs.jfrog.com/security/docs/manage-waivers.md) - [View the Active Policies for a Repository](https://docs.jfrog.com/security/docs/view-the-active-policies-for-a-repository.md) - [How-Tos](https://docs.jfrog.com/security/docs/how-tos-p.md) - [How to Curate VS Code Remote Repositories](https://docs.jfrog.com/security/docs/how-to-curate-vs-code-remote-repositories.md) - [How to Block Malicious or Vulnerable Packages from Entering the Repository](https://docs.jfrog.com/security/docs/how-to-block-malicious-or-vulnerable-packages-from-entering-the-repository.md) - [How to Ensure Only Open-Source Packages with Approved Licenses Are Used](https://docs.jfrog.com/security/docs/how-to-ensure-only-open-source-packages-with-approved-licenses-are-used.md) - [How to Prevent the Use of Deprecated or Outdated Packages in Development](https://docs.jfrog.com/security/docs/how-to-prevent-the-use-of-deprecated-or-outdated-packages-in-development.md) - [How to Use JFrog Curation as a Developer with the JFrog CLI](https://docs.jfrog.com/security/docs/how-to-use-jfrog-curation-as-a-developer-with-the-jfrog-cli.md) - [How to Utilize JFrog Catalog for Curation](https://docs.jfrog.com/security/docs/how-to-utilize-jfrog-catalog-for-curation.md) - [How to Manage Virtual Repository Behavior and Curation in JFrog Xray](https://docs.jfrog.com/security/docs/how-to-manage-virtual-repository-behavior-and-curation-in-jfrog-xray.md) - [How to Assess and Optimize Your Curation Settings](https://docs.jfrog.com/security/docs/how-to-assess-and-optimize-your-curation-settings.md) - [How to Manage “Package Pending Catalog” Events in JFrog Curation](https://docs.jfrog.com/security/docs/how-to-manage-package-pending-catalog-events-in-jfrog-curation.md) - [Supported Technologies](https://docs.jfrog.com/security/docs/supported-technologies-xray.md) - [Java / Kotlin](https://docs.jfrog.com/security/docs/xray-java.md) - [JavaScript / TypeScript](https://docs.jfrog.com/security/docs/xray-javascript-typescript.md) - [Python](https://docs.jfrog.com/security/docs/xray-python.md) - [Go](https://docs.jfrog.com/security/docs/xray-go.md) - [C# / .NET](https://docs.jfrog.com/security/docs/xray-dotnet.md) - [C/C++](https://docs.jfrog.com/security/docs/xray-cpp.md) - [Conan](https://docs.jfrog.com/security/docs/xray-conan.md) - [PHP](https://docs.jfrog.com/security/docs/xray-php.md) - [Rust](https://docs.jfrog.com/security/docs/xray-rust.md) - [Ruby](https://docs.jfrog.com/security/docs/xray-ruby.md) - [R](https://docs.jfrog.com/security/docs/xray-r.md) - [Scala](https://docs.jfrog.com/security/docs/xray-scala.md) - [Swift / Objective-C (iOS)](https://docs.jfrog.com/security/docs/xray-swift-objectivec.md) - [Dart / Pub](https://docs.jfrog.com/security/docs/xray-dart.md) - [Docker / OCI ](https://docs.jfrog.com/security/docs/xray-docker-containers.md) - [Helm / HelmOCI](https://docs.jfrog.com/security/docs/xray-helm.md) - [ML Models](https://docs.jfrog.com/security/docs/xray-ml-models.md) - [Security](https://docs.jfrog.com/security/docs/security.md) - [Xray Overview Page](https://docs.jfrog.com/security/docs/xray-overview-page.md): A single-pane-of-glass view of your organization's security scanning coverage, secrets detection adoption, supply chain protection, and policy enforcement. - [Malicious Package Detection](https://docs.jfrog.com/security/docs/malicious-package-detection.md) - [Detect Malicious AI Models](https://docs.jfrog.com/security/docs/detect-malicious-ai-models.md) - [Scanning AI Agent Skills](https://docs.jfrog.com/security/docs/skill-scanning.md) - [JFrog Security Research](https://docs.jfrog.com/security/docs/jfrog-security-research.md) - [Understanding and Analyzing Xray Scan Results](https://docs.jfrog.com/security/docs/understanding-and-analyzing-xray-scan-results-p.md) - [Builds Security Overview](https://docs.jfrog.com/security/docs/builds-security-overview.md) - [Comparing Build Versions](https://docs.jfrog.com/security/docs/comparing-build-versions.md) - [License Compliance](https://docs.jfrog.com/security/docs/legal.md) - [License Attribution Report](https://docs.jfrog.com/security/docs/license-attribution-report.md) - [License Conclusion](https://docs.jfrog.com/security/docs/license-conclusion.md) - [Custom Software Licenses](https://docs.jfrog.com/security/docs/custom-software-licenses.md) - [License Studio](https://docs.jfrog.com/security/docs/license-studio.md): Override license and copyright metadata on components, with automatic propagation via Impact Analysis. - [Operational Risk](https://docs.jfrog.com/security/docs/operational-risk.md) - [Snippet Detection](https://docs.jfrog.com/security/docs/snippet-detection.md): Identify the origin of AI-generated and copied code snippets, exposing hidden vulnerabilities and license risks that traditional scanners miss. - [How to Run Snippet Detection](https://docs.jfrog.com/security/docs/run-snippet-detection.md): Step-by-step instructions for running snippet detection scans using Frogbot V3 and JFrog CLI. - [SBOM](https://docs.jfrog.com/security/docs/sbom.md) - [Base Image Detection](https://docs.jfrog.com/security/docs/base-image-detection.md) - [SBOM Import](https://docs.jfrog.com/security/docs/sbom-import.md) - [SBOM Export](https://docs.jfrog.com/security/docs/sbom-export.md) - [CBOM](https://docs.jfrog.com/security/docs/cbom-export.md) - [Transitive SBOM](https://docs.jfrog.com/security/docs/transitive-sbom.md) - [Policy and Governance](https://docs.jfrog.com/security/docs/policies-in-jfrog-xray.md) - [Watches in JFrog Xray](https://docs.jfrog.com/security/docs/watches-in-jfrog-xray.md) - [Ignoring Violations in JFrog Xray: Understanding Ignore Rules](https://docs.jfrog.com/security/docs/ignoring-violations-in-jfrog-xray-understanding-ignore-rules.md) - [Violations Handling and Notifications](https://docs.jfrog.com/security/docs/violations-handling-and-notifications.md) - [Audit Events](https://docs.jfrog.com/security/docs/xray-audit-events.md) - [Webhooks](https://docs.jfrog.com/security/docs/webhooks.md) - [Observability and Search](https://docs.jfrog.com/security/docs/observeablity-and-search.md) - [Export Scan Results](https://docs.jfrog.com/security/docs/export-scan-results.md) - [Xray Reports](https://docs.jfrog.com/security/docs/xray-reports.md) - [Impact Search](https://docs.jfrog.com/security/docs/impact-search-1.md) - [Configure Xray](https://docs.jfrog.com/security/docs/configure-xray.md) - [Index Xray Resources](https://docs.jfrog.com/security/docs/index-xray-resources.md) - [Configure Indexing in JFrog Xray](https://docs.jfrog.com/security/docs/configure-indexing-in-jfrog-xray.md) - [Set a Retention Period for Xray Indexed Resources](https://docs.jfrog.com/security/docs/set-a-retention-period-for-xray-indexed-resources.md) - [Create Watches](https://docs.jfrog.com/security/docs/create-watches.md) - [Create Policies](https://docs.jfrog.com/security/docs/create-policies.md) - [Manage Xray](https://docs.jfrog.com/security/docs/manage-xray.md) - [Xray and JFrog External DB Sync](https://docs.jfrog.com/security/docs/xray-and-jfrog-external-db-sync-p.md) - [Migration Guide for Self-Hosted Customers: Upgrading from DBSync V1 to V3](https://docs.jfrog.com/security/docs/migration-guide-for-self-hosted-customers-upgrading-from-dbsync-v1-to-v3.md) - [Advanced Settings](https://docs.jfrog.com/security/docs/advanced-settings.md) - [System Monitoring](https://docs.jfrog.com/security/docs/system-monitoring.md) - [TLS Certificates](https://docs.jfrog.com/security/docs/tls-certificates.md) - [Secure PostgreSQL with TLS Support on Xray](https://docs.jfrog.com/security/docs/secure-postgresql-with-tls-support-on-xray.md) - [Secure RabbitMQ with TLS Support on Xray](https://docs.jfrog.com/security/docs/secure-rabbitmq-with-tls-support-on-xray.md) - [Trust Self Signed Certificates en](https://docs.jfrog.com/security/docs/trust-self-signed-certificates-en.md) - [System Messages](https://docs.jfrog.com/security/docs/system-messages.md) - [CI-CD Integration with Xray](https://docs.jfrog.com/security/docs/ci-cd-integration-with-xray.md) - [Jira Integration](https://docs.jfrog.com/security/docs/jira-integration.md) - [Setup Integration](https://docs.jfrog.com/security/docs/setup-integration.md) - [View Jira Tickets](https://docs.jfrog.com/security/docs/view-jira-tickets.md) - [Manually Create a Jira Ticket](https://docs.jfrog.com/security/docs/manually-create-a-jira-ticket.md) - [Assign/Unassign Jira Tickets](https://docs.jfrog.com/security/docs/assign-unassign-jira-tickets.md) - [Best Practices](https://docs.jfrog.com/security/docs/best-practices.md) - [REST API Support](https://docs.jfrog.com/security/docs/rest-api-support.md) - [How-Tos](https://docs.jfrog.com/security/docs/how-tos-xray.md) - [How to Filter Out Your 1st Party Components in CycloneDX SBOM report](https://docs.jfrog.com/security/docs/how-to-filter-out-your-1st-party-components-in-cyclonedx-sbom-report.md) - [How to Assign Supplier to your resources in SBOM reports](https://docs.jfrog.com/security/docs/how-to-assign-supplier-to-your-resources-in-sbom-reports.md) - [How to Block Malicious Packages in your SDLC](https://docs.jfrog.com/security/docs/how-to-block-malicious-packages-in-your-sdlc.md) - [How to Block Critical and High Vulnerabilities Before Promotion](https://docs.jfrog.com/security/docs/how-to-block-critical-and-high-vulnerabilities-before-promotion.md) - [How to Create a Violation for a Specific Package Version](https://docs.jfrog.com/security/docs/how-to-create-a-violation-for-a-specific-package-version.md) - [How to Send Email Notifications for Each Critical Vulnerability Found in Resource](https://docs.jfrog.com/security/docs/how-to-send-email-notifications-for-each-critical-vulnerability-found-in-resource.md) - [How to Generate a Report with All Vulnerabilities in a Distributed Bundle](https://docs.jfrog.com/security/docs/how-to-generate-a-report-with-all-vulnerabilities-in-a-distributed-bundle.md) - [How to Generate a Report with All Used Licenses in Your Environment Using JFrog Xray](https://docs.jfrog.com/security/docs/how-to-generate-a-report-with-all-used-licenses-in-your-environment-using-jfrog-xray.md) - [How to Exclude Specific File Names from Scans](https://docs.jfrog.com/security/docs/how-to-exclude-specific-file-names-from-scans.md) - [How to Enable and Monitor SBOM Migration in Xray](https://docs.jfrog.com/security/docs/how-to-enable-and-monitor-sbom-migration-in-xray.md) - [How to View and Modify Licenses in the SBOM Tab](https://docs.jfrog.com/security/docs/how-to-view-and-modify-licenses-in-the-sbom-tab.md) - [ How to Identify Affected Artifacts Using Impact Search](https://docs.jfrog.com/security/docs/how-to-identify-affected-artifacts-using-impact-search.md) - [Supported Technologies](https://docs.jfrog.com/security/docs/supported-technologies-advanced-security.md) - [Contextual Analysis of CVEs](https://docs.jfrog.com/security/docs/contextual-analysis-of-cves-1.md) - [Secrets Scans](https://docs.jfrog.com/security/docs/secrets-scans-1.md) - [Advanced Remediation](https://docs.jfrog.com/security/docs/advanced-remediation.md) - [Misconfigurations Scans](https://docs.jfrog.com/security/docs/misconfigurations-scans-1.md) - [GitHub Actions Workflow Scanner: Pwn-Request Detection](https://docs.jfrog.com/security/docs/github-actions-workflow-scanner-pwn-request-detection.md) - [Advanced Security Reports](https://docs.jfrog.com/security/docs/advanced-security-reports-1.md) - [SAST](https://docs.jfrog.com/security/docs/sast-1.md) - [Configure Advanced Security](https://docs.jfrog.com/security/docs/configure-advanced-security.md) - [Enable Advanced Scans](https://docs.jfrog.com/security/docs/enable-advanced-scans-p.md) - [Enable Advanced Scans for Repositories](https://docs.jfrog.com/security/docs/enable-advanced-scans-for-repositories.md) - [Enable Advanced Scans for Artifacts](https://docs.jfrog.com/security/docs/enable-advanced-scans-for-artifacts.md) - [Initiate Advanced Scans](https://docs.jfrog.com/security/docs/initiate-advanced-scans.md) - [Create Advanced Security Policies](https://docs.jfrog.com/security/docs/create-advanced-security-policies.md) - [Contextual Analysis Policy](https://docs.jfrog.com/security/docs/contextual-analysis-policy.md) - [Exposures Policy](https://docs.jfrog.com/security/docs/exposures-policy.md) - [SAST](https://docs.jfrog.com/security/docs/sast.md) - [ML Model Policy](https://docs.jfrog.com/security/docs/ml-model-policy.md) - [Ignore Advanced Security Violations](https://docs.jfrog.com/security/docs/ignore-advanced-security-violations.md) - [Create Custom Secrets Scanner](https://docs.jfrog.com/security/docs/create-custom-secrets-scanner.md) - [How-Tos](https://docs.jfrog.com/security/docs/how-tos-advanced-security-p.md) - [Create an Uber JAR for Contextual Analysis](https://docs.jfrog.com/security/docs/create-an-uber-jar-for-contextual-analysis.md) - [Package Applications in Docker for Contextual Analysis](https://docs.jfrog.com/security/docs/package-applications-in-docker-for-contextual-analysis.md) - [Secrets Scans](https://docs.jfrog.com/security/docs/secrets-scans.md) - [Prevent the Use of Unsecured ML Models](https://docs.jfrog.com/security/docs/prevent-the-use-of-unsecured-ml-models.md) - [How to Scan Terraform State Files for IaC Misconfigurations](https://docs.jfrog.com/security/docs/how-to-scan-terraform-state-files-for-iac-misconfigurations.md) - [Supported Technologies](https://docs.jfrog.com/security/docs/supported-technologies-catalog.md) - [Configure Catalog](https://docs.jfrog.com/security/docs/configure-catalog.md) - [Configure and Manage Labels](https://docs.jfrog.com/security/docs/configure-and-manage-labels.md) - [GraphQL APIs](https://docs.jfrog.com/security/docs/graphql-apis.md) - [How-Tos](https://docs.jfrog.com/security/docs/how-tos-catalog.md) - [How to Identify and Mitigate Vulnerable OSS Packages in Your Repository](https://docs.jfrog.com/security/docs/how-to-identify-and-mitigate-vulnerable-oss-packages-in-your-repository.md) - [How to Enforce Compliance Policies Using Catalog Labels](https://docs.jfrog.com/security/docs/how-to-enforce-compliance-policies-using-catalog-labels.md) - [How to Compare and Select the Best OSS Package for Your Project](https://docs.jfrog.com/security/docs/how-to-compare-and-select-the-best-oss-package-for-your-project.md) - [How to Request a License Review in JFrog Catalog](https://docs.jfrog.com/security/docs/how-to-request-a-license-review-in-jfrog-catalog.md) - [How to Migrate to the Standalone JFrog Catalog Service](https://docs.jfrog.com/security/docs/how-to-migrate-to-the-standalone-jfrog-catalog-service.md) - [Frogbot V2](https://docs.jfrog.com/security/docs/frogbot-v2.md) - [Supported Technologies](https://docs.jfrog.com/security/docs/supported-technologies-source-code.md) - [Package Manager Prerequisites](https://docs.jfrog.com/security/docs/package-manager-prerequisites.md) - [Features and Capabilities](https://docs.jfrog.com/security/docs/features-and-capabilities-source-code.md) - [Installation](https://docs.jfrog.com/security/docs/installation-1.md) - [GitHub Actions](https://docs.jfrog.com/security/docs/github-actions.md) - [Integrate Frogbot with the JFrog GitHub App](https://docs.jfrog.com/security/docs/integrate-frogbot-with-the-jfrog-github-app.md) - [Installation](https://docs.jfrog.com/security/docs/installation.md) - [OpenID Connect Authentication](https://docs.jfrog.com/security/docs/openid-connect-authentication.md) - [GitLab CI](https://docs.jfrog.com/security/docs/gitlab-ci.md) - [Azure DevOps](https://docs.jfrog.com/security/docs/azure-devops.md) - [Jenkins](https://docs.jfrog.com/security/docs/jenkins.md) - [Configure Frogbot](https://docs.jfrog.com/security/docs/configure-frogbot.md) - [The frogbot-config.yml File Structure](https://docs.jfrog.com/security/docs/the-frogbot-config-yml-file-structure.md) - [Frogbot Optional Configuration Parameters](https://docs.jfrog.com/security/docs/frogbot-optional-configuration-parameters.md) - [Frogbot Offline](https://docs.jfrog.com/security/docs/frogbot-offline.md) - [Troubleshooting](https://docs.jfrog.com/security/docs/troubleshooting.md) - [Frogbot Scan Results in GitHub](https://docs.jfrog.com/security/docs/frogbot-scan-results-in-github-p.md) - [View Scan Results in GitHub Security](https://docs.jfrog.com/security/docs/view-scan-results-in-github-security.md) - [View SBOM in GitHub Dependency Graph](https://docs.jfrog.com/security/docs/view-sbom-in-github-dependency-graph.md) - [Frogbot V3 ](https://docs.jfrog.com/security/docs/frogbot.md) - [Scanning Commits and Pull Requests](https://docs.jfrog.com/security/docs/how-to-commit-scan-and-pr-scan.md) - [GitHub](https://docs.jfrog.com/security/docs/github.md) - [GitLab](https://docs.jfrog.com/security/docs/gitlab.md) - [Bitbucket](https://docs.jfrog.com/security/docs/bitbucket.md) - [Jenkins](https://docs.jfrog.com/security/docs/jenkins-1.md) - [Azure DevOps](https://docs.jfrog.com/security/docs/azure-devops-1.md) - [How To Consume Results](https://docs.jfrog.com/security/docs/how-to-consume-results.md) - [JFrog Platform](https://docs.jfrog.com/security/docs/jfrog-platform.md) - [Github Advanced Security](https://docs.jfrog.com/security/docs/github-advnaced-security.md) - [GitLab](https://docs.jfrog.com/security/docs/gitlab-1.md) - [Advanced Management and Configuration](https://docs.jfrog.com/security/docs/advanced-management-and-configuration.md) - [Frogbot Scan Results](https://docs.jfrog.com/security/docs/copy-of-frogbot-scan-results-in-github.md) - [GitHub](https://docs.jfrog.com/security/docs/github-1.md) - [GitLab](https://docs.jfrog.com/security/docs/gitlab-2.md) - [Git Repository Scans and Results](https://docs.jfrog.com/security/docs/git-repository-scans-and-results-p.md) - [Git Repository Configuration](https://docs.jfrog.com/security/docs/git-repository-configuration.md) - [Create a Git Repository Policy](https://docs.jfrog.com/security/docs/create-a-git-repository-policy.md) - [Create a Git Repository Watch](https://docs.jfrog.com/security/docs/create-a-git-repository-watch.md) - [View Git Repository Scan Results](https://docs.jfrog.com/security/docs/view-git-repository-scan-results.md) - [Export Scan Results](https://docs.jfrog.com/security/docs/export-scan-results-source-code.md) - [Ignore Git Repository Violations](https://docs.jfrog.com/security/docs/ignore-git-repository-violations.md) - [Working in Air-Gapped Environments](https://docs.jfrog.com/security/docs/working-in-air-gapped-environments.md) - [IDEs](https://docs.jfrog.com/security/docs/ides.md) - [Visual Studio Code](https://docs.jfrog.com/security/docs/visual-studio-code-1.md) - [Package Manager Prerequisites](https://docs.jfrog.com/security/docs/package-manager-prerequisites-source-code.md) - [Supported Technologies](https://docs.jfrog.com/security/docs/supported-technologies-source-code-2.md) - [Installation](https://docs.jfrog.com/security/docs/installation-source-code.md) - [Manage](https://docs.jfrog.com/security/docs/manage.md) - [Quick Start](https://docs.jfrog.com/security/docs/quick-start-source-code.md) - [How-Tos](https://docs.jfrog.com/security/docs/how-tos.md) - [Cursor](https://docs.jfrog.com/security/docs/cursor-1.md) - [Package Manager Prerequisites](https://docs.jfrog.com/security/docs/package-manager-prerequisites-source-code-2.md) - [Supported Technologies](https://docs.jfrog.com/security/docs/supported-technologies-source-code-3.md) - [Installation](https://docs.jfrog.com/security/docs/installation-source-code-2.md) - [Manage](https://docs.jfrog.com/security/docs/manage-source-code.md) - [Quick Start](https://docs.jfrog.com/security/docs/quick-start-source-code-2.md) - [How-Tos](https://docs.jfrog.com/security/docs/how-tos-source-code.md) - [Windsurf Editor](https://docs.jfrog.com/security/docs/windsurf-editor.md) - [Package Manager Prerequisites](https://docs.jfrog.com/security/docs/package-manager-prerequisites-source-code-3.md) - [Supported Technologies](https://docs.jfrog.com/security/docs/supported-technologies-source-code-4.md) - [Installation](https://docs.jfrog.com/security/docs/installation-source-code-3.md) - [Manage](https://docs.jfrog.com/security/docs/manage-source-code-2.md) - [Quick Start](https://docs.jfrog.com/security/docs/quick-start-source-code-3.md) - [How-Tos](https://docs.jfrog.com/security/docs/how-tos-source-code-2.md) - [JetBrains](https://docs.jfrog.com/security/docs/jetbrains.md) - [Supported Technologies](https://docs.jfrog.com/security/docs/supported-technologies-source-code-5.md) - [Installation](https://docs.jfrog.com/security/docs/installation-source-code-4.md) - [Manage](https://docs.jfrog.com/security/docs/manage-source-code-3.md) - [Quick Start](https://docs.jfrog.com/security/docs/quick-start-source-code-4.md) - [How-Tos](https://docs.jfrog.com/security/docs/how-tos-source-code-3.md) - [Troubleshooting](https://docs.jfrog.com/security/docs/troubleshooting-source-code.md) - [Eclipse](https://docs.jfrog.com/security/docs/eclipse.md) - [Supported Technologies](https://docs.jfrog.com/security/docs/supported-technologies-source-code-6.md) - [Installation](https://docs.jfrog.com/security/docs/installation-source-code-5.md) - [Quick Start](https://docs.jfrog.com/security/docs/quick-start-source-code-5.md) - [How-Tos](https://docs.jfrog.com/security/docs/how-tos-source-code-4.md) - [Visual Studio](https://docs.jfrog.com/security/docs/visual-studio.md) - [Supported Technologies](https://docs.jfrog.com/security/docs/supported-technologies-source-code-7.md) - [Installation](https://docs.jfrog.com/security/docs/installation-source-code-6.md) - [Quick Start](https://docs.jfrog.com/security/docs/quick-start-source-code-6.md) - [Local SAST MCP](https://docs.jfrog.com/security/docs/local-sast-mcp.md) - [Visual Studio Code](https://docs.jfrog.com/security/docs/visual-studio-code.md) - [Cursor](https://docs.jfrog.com/security/docs/cursor.md) - [CLI](https://docs.jfrog.com/security/docs/cli.md) - [Platform Maintenance](https://docs.jfrog.com/security/docs/platform-maintenance-p.md): Guide on using the git count-contributors command in JFrog CLI to determine Git developers contributing to a repository. - [Download Updates for Xray's Vulnerability Database](https://docs.jfrog.com/security/docs/download-updates-for-xray-s-vulnerability-database.md) - [Counting Contributing Developers](https://docs.jfrog.com/security/docs/counting-contributing-developers.md) - [Curation Compliance Check](https://docs.jfrog.com/security/docs/curation-compliance-check.md) - [Scan Your Binaries](https://docs.jfrog.com/security/docs/scan-your-binaries.md) - [Scan Binaries](https://docs.jfrog.com/security/docs/scan-binaries.md) - [View Binary Scan Results](https://docs.jfrog.com/security/docs/view-binary-scan-results.md) - [Scan Published Builds](https://docs.jfrog.com/security/docs/scan-published-builds.md) - [Enrich your SBOM JSONs & XMLs](https://docs.jfrog.com/security/docs/enrich-your-sbom-jsons-xmls.md) - [Scan Your Source Code](https://docs.jfrog.com/security/docs/scan-your-source-code.md) - [Scan Your ML Models](https://docs.jfrog.com/security/docs/scan-your-ml-models.md) - [Xray Offline Database Sync](https://docs.jfrog.com/security/docs/xray-offline-database-sync.md) - [Supported Technologies](https://docs.jfrog.com/security/docs/supported-technologies-runtime.md) - [Runtime Impact](https://docs.jfrog.com/security/docs/runtime-impact.md) - [Runtime Integrity](https://docs.jfrog.com/security/docs/runtime-integrity.md) - [Integrity Violation Explainability](https://docs.jfrog.com/security/docs/integrity-violation-explainability.md) - [Configure Runtime](https://docs.jfrog.com/security/docs/configure-runtime.md) - [Sensor](https://docs.jfrog.com/security/docs/sensor.md) - [OpenShift SCC](https://docs.jfrog.com/security/docs/openshift-scc.md) - [Certificate Verification](https://docs.jfrog.com/security/docs/certificate-verification.md) - [Workload Automation Service](https://docs.jfrog.com/security/docs/workload-automation-service.md) - [Configure AWS ECS Fargate](https://docs.jfrog.com/security/docs/ecs-task-scanning-fargate-launch-type-supported.md) - [Manage Runtime](https://docs.jfrog.com/security/docs/manage-runtime.md) - [How-Tos](https://docs.jfrog.com/security/docs/how-tos-runtime.md) - [Prioritizing Runtime Vulnerabilities Using Xray Dashboard](https://docs.jfrog.com/security/docs/prioritizing-vulnerabilities-using-runtime-dashboard.md) - [Inspecting Live Software Components](https://docs.jfrog.com/security/docs/inspecting-live-software-components.md) - [Reducing Noise in Risk Management](https://docs.jfrog.com/security/docs/reducing-noise-in-risk-management.md) - [Fast Exposure Window Closing](https://docs.jfrog.com/security/docs/fast-exposure-window-closing.md) - [Strengthening Runtime Trust Through Image Verification](https://docs.jfrog.com/security/docs/strengthening-runtime-trust-through-image-verification.md) - [Detecting Your Live Artifacts in Artifactory](https://docs.jfrog.com/security/docs/detecting-your-live-artifacts-in-artifactory.md) - [Ensure Security Scanning for Runtime-Detected Images in a Cluster Use Case A DevSecOps engineer](https://docs.jfrog.com/security/docs/ensure-security-scanning-for-runtime-detected-images-in-a-cluster-use-case-a-devsecops-engineer.md) - [Renewing Registration Tokens](https://docs.jfrog.com/security/docs/renewing-registration-tokens.md) - [APIs](https://docs.jfrog.com/security/docs/apis.md) - [List Image Tags](https://docs.jfrog.com/security/docs/list-image-tags.md) - [Get Clusters List](https://docs.jfrog.com/security/docs/get-clusters-list.md) - [Get Cluster](https://docs.jfrog.com/security/docs/get-cluster.md) - [List Workloads](https://docs.jfrog.com/security/docs/list-workloads.md) - [Get Registration Token](https://docs.jfrog.com/security/docs/get-registration-token.md) - [Revoke and Create Registration Token](https://docs.jfrog.com/security/docs/revoke-and-create-registration-token.md) ## API Reference - [About Security APIs](https://docs.jfrog.com/security/reference/about-security-apis.md) - [List curation policies](https://docs.jfrog.com/security/reference/listpolicies.md): Get policies with pagination and filtering. The condition of each policy is inlined in the response for convenience. - [Create a curation policy](https://docs.jfrog.com/security/reference/createpolicy.md): Create a policy that associates a condition with a repository scope and an action (block or dry_run). **Note:** Do not send read-only properties (`id`, `created_by`, `updated_by`, `created_at`, `updated_at`) — they will cause an error. - [Get a curation policy by ID](https://docs.jfrog.com/security/reference/getpolicybyid.md): Get the full definition of a policy. The condition is inlined for convenience. - [Update a curation policy](https://docs.jfrog.com/security/reference/updatepolicy.md): Update an existing policy. **Note about editable properties:** Do not send the entire object returned by GET. Properties like `id`, `created_by`, `updated_by`, `created_at`, `updated_at` cannot be set via the API and sending them will cause an error. **Note about waivers:** Waivers and label waivers cannot be edited in place. They can be: - **added** — send an object without an `id` but with the content fields - **retained** — send an object with the `id` of an existing waiver - **removed** — omit the object To edit a waiver, remove it and add a new one with the desired values. - [Delete a curation policy](https://docs.jfrog.com/security/reference/deletepolicy.md) - [List condition templates](https://docs.jfrog.com/security/reference/listconditiontemplates.md): Returns the list of available condition templates and their configurable parameters used to create custom conditions in JFrog Curation. Each custom condition is based on a single template, identified by `condition_template_id`, along with template-specific parameter values. Templates define the supported condition types, such as CVE-based, license-based, package maturity, allow/block lists, and CVSS score range conditions. - [List conditions](https://docs.jfrog.com/security/reference/listconditions.md): Get both built-in and custom conditions with pagination and filtering. - [Create a custom condition](https://docs.jfrog.com/security/reference/createcondition.md): Create a custom condition from a condition template. The `condition_template_id` determines which parameters are required or optional (see the List Condition Templates endpoint). - [Get a condition by ID](https://docs.jfrog.com/security/reference/getconditionbyid.md): Get the full details of a condition, including its parameter values. - [Update a custom condition](https://docs.jfrog.com/security/reference/updatecondition.md): Update an existing custom condition's name or parameter values. Built-in conditions cannot be updated. - [Delete a custom condition](https://docs.jfrog.com/security/reference/deletecondition.md): Delete a custom condition. Built-in conditions cannot be deleted. - [Create a waiver request](https://docs.jfrog.com/security/reference/createwaiverrequest.md): Create a waiver request to unblock a package that was blocked by a curation policy. The policy must have `waiver_request_config` set to `manual` or `auto_approved`. - [List waiver requests](https://docs.jfrog.com/security/reference/listwaiverrequests.md): Get waiver requests for packages that were requested to be unblocked. - [Get approved/blocked audit logs](https://docs.jfrog.com/security/reference/getauditpackages.md): Export approved/blocked audit events for packages. When `dry_run=false` (default), outputs real audit events. Each event includes the non-dry-run policies that affected it (blocking, bypassed, waived). This is what the UI shows on the *Blocked/Approved* tab. When `dry_run=true`, outputs dry-run events — one per dry-run policy. This is what the UI shows on the *Dry Run* tab. When `format=csv`, the response is a ZIP file containing a CSV. Pagination counts audit events, not CSV rows — each event may produce multiple rows (one per policy). - [Package Reroute Config API](https://docs.jfrog.com/security/reference/package-reroute-config.md) - [Get Full Configuration](https://docs.jfrog.com/security/reference/getpackagererouteconfig.md): Returns the full package reroute configuration including the registry configuration for each supported package type (npm, pypi, docker, huggingfaceml). **Security:** Requires admin role. - [Get Registry Configuration](https://docs.jfrog.com/security/reference/getregistryconfig.md): Returns the package reroute configuration for the specified registry type. **Security:** Requires admin role. - [Update Registry Configuration](https://docs.jfrog.com/security/reference/updateregistryconfig.md): Updates the package reroute configuration for the specified registry type. **Security:** Requires admin role. - [Delete Registry Configuration](https://docs.jfrog.com/security/reference/deleteregistryconfig.md): Deletes the package reroute configuration for the specified registry type. **Security:** Requires admin role. - [Get Artifact Dependency Graph](https://docs.jfrog.com/security/reference/get-artifact-dependency-graph.md): Retrieves the complete dependency graph for a specified artifact. Returns the artifact metadata and a recursive tree of all its component dependencies, including package type and component IDs. Requires a user with Read permission. - [Compare Artifacts](https://docs.jfrog.com/security/reference/compare-artifacts.md): Compares two artifacts and produces a delta of their dependency components. Returns the source and target artifact metadata plus three component lists: added (in target only), removed (in source only), and unchanged (in both). Requires a user with Read permission. - [Get Build Dependency Graph](https://docs.jfrog.com/security/reference/get-build-dependency-graph.md): Retrieves the complete dependency graph for a build identified by name and number. Returns the build metadata and a recursive tree of all its component dependencies. Requires a user with Read permission. - [Compare Builds](https://docs.jfrog.com/security/reference/compare-builds.md): Compares two builds and produces a delta of their dependency components. Returns the source and target build metadata plus three component lists: added (in target only), removed (in source only), and unchanged (in both). Requires a user with Read permission. - [Release Bundle Details](https://docs.jfrog.com/security/reference/release-bundle-details.md): Returns the scan status and optionally the license, security, and operational risk violations found in a Release Bundle. Requires Admin or Read permission. - [Release Bundle V2 Details](https://docs.jfrog.com/security/reference/release-bundle-v2-details.md): Returns security, license, and operational risk violations found in a Release Bundle V2. Use the `operation` parameter to specify whether to check promotion or distribution violations. Requires Admin or Read permission. Since Xray 3.82.x. - [Update Repositories Configurations](https://docs.jfrog.com/security/reference/update-repositories-configurations.md): Updates the scanning configuration for a specific repository, including contextual analysis settings, exposures scanning, retention period, and path-specific configurations. Requires Admin or Index Resources permission. - [Get Repository Configuration](https://docs.jfrog.com/security/reference/get-repositories-configurations.md): Returns the scanning configuration for a specific repository, including contextual analysis, exposures, retention, and path-specific settings. Requires Read permission. Route supports project scope. - [Build Vulnerability Diff](https://docs.jfrog.com/security/reference/build-vulnerability-diff.md): Compares security vulnerabilities between two builds and returns the differences grouped by severity or package ID. The response contains added, removed, changed, and unchanged vulnerability lists for each group. Requires a user with Read permission. - [Artifact Summary](https://docs.jfrog.com/security/reference/artifact-summary.md): Provides a security, license, and operational risk summary for artifacts specified by path identifiers or checksums. Returns issues (vulnerabilities), licenses, operational risks, and any errors for each artifact. Either paths or checksums must be provided. If both are provided, checksums are ignored. Note: In the v1 endpoint, the components field within issues is not included. Use the v2 endpoint for component-level details including fixed versions. Requires a user with Read permission. - [Artifact Summary](https://docs.jfrog.com/security/reference/artifact-summary_artifacts-v2-openapi.md): Provides a security, license, and operational risk summary for artifacts specified by path identifiers or checksums (v2 API). The v2 endpoint includes component-level vulnerability details within each issue, showing which specific components are affected and what fixed versions are available (via the components array containing component_id, version, pkg_type, and fixed_versions). This data is not available in the v1 endpoint. Either paths or checksums must be provided. If both are provided, checksums are ignored. Requires a user with Read permission. - [Build Summary](https://docs.jfrog.com/security/reference/build-summary_artifacts-v2-openapi.md): Provides a security, license, and operational risk summary for a build specified by name and number. Returns issues (vulnerabilities), licenses found, operational risks, and any scan errors. The v2 endpoint includes component-level details within issues that are not available in v1. Requires a user with Read permission. - [Find Component by Name](https://docs.jfrog.com/security/reference/get-component-by-name.md): Search for a component by name. This API is applicable only for components synced from the JFrog Global database to Xray. Requires Read permission. - [Export Component Details V2](https://docs.jfrog.com/security/reference/export-component-details-v1-deprecated_components-v2-openapi.md): Exports component details to various formats. Returns a ZIP file containing the exported data. Requires Read permission. ### Request structure: content selectors vs. format settings Request fields fall into two independent groups, plus the identifying fields (`package_type`, `component_name`, `path`). **Content selectors** — at least one must be `true`. These say *what* to include in the export: - `vulnerabilities`, `violations`, `license`, `operational_risk`, `sast` — generate a single rendered report covering the selected content (rendered with `output_format`) - `spdx` — generate an SPDX SBOM document (rendered with `spdx_format`; SPDX version controlled by `spdx_version`) - `cyclonedx` — generate a CycloneDX SBOM document (rendered with `cyclonedx_format`) - any of `secrets`, `services`, `applications`, `iac`, `malicious_code` — include the corresponding exposure category Calling the endpoint without any content selector returns `400 Non of the export options were selected`. **Format settings** — required only when their companion content is selected, ignored otherwise: - `output_format` (e.g., `pdf`, `json`, `csv`) — required when any of `vulnerabilities`, `violations`, `license`, `operational_risk`, `sast` is `true` - `spdx_format` (`json`, `tag-value`) — required when `spdx: true` - `spdx_version` (`2.3` default, `3.0`) — optional, only meaningful when `spdx: true` - `cyclonedx_format` (`json`, `xml`) — required when `cyclonedx: true` The three format dimensions are independent — a single call can combine, for example, a PDF vulnerabilities report with an SPDX SBOM (see the `combinedReportAndSbom` example). - [Get Component List Per Watch](https://docs.jfrog.com/security/reference/get-all-the-packages-by-watch-name.md): Returns package details for all packages in repositories watched by the specified watch. Requires Reports Manager permission. - [Cancel Artifact Contextual Analysis Scan](https://docs.jfrog.com/security/reference/cancel-contextual-analysis-scan.md): Cancels a running contextual analysis scan for a specific artifact. Requires Read permission. - [Scan Artifact for Contextual Analysis](https://docs.jfrog.com/security/reference/scan-artifact-for-contextual-analysis.md): Triggers a contextual analysis (applicability) scan. This endpoint supports two modes of operation: **Artifact mode** - scan a specific artifact by providing `repo` and `path` (and optionally `componentId`). The artifact must already be scanned by Xray SCA. **Aggregate mode** - scan all artifacts in a build or release bundle by providing the corresponding key pair instead: - For builds: `build_name` + `build_number` - For Release Bundles V1: `release_bundle_name` + `release_bundle_version` - For Release Bundles V2: `release_bundle_v2_name` + `release_bundle_v2_version` The two modes are mutually exclusive. If `repo`, `path`, or `componentId` is provided, the request is treated as artifact mode and aggregate keys are ignored. If none of those are set, the request is treated as aggregate mode. Optionally, `project` can be provided to scope the request to a specific project. Requires the MANAGE_DATA permission. Since Xray 3.73. - [Get Artifact Contextual Analysis Scan Status](https://docs.jfrog.com/security/reference/get-contextual-analysis-scan-status.md): Returns the status of a contextual analysis scan for a specific artifact. Requires Read permission. - [Get Contextual Analysis per Vulnerability V1](https://docs.jfrog.com/security/reference/get-contextual-analysis-per-vulnerability-v1.md): Returns contextual analysis results for a specific vulnerability on a component (v1 format). Requires Read permission. - [Get Contextual Analysis per Vulnerability V2](https://docs.jfrog.com/security/reference/get-contextual-analysis-per-vulnerability-v2_contextual-analysis-v2-openapi.md): Returns contextual analysis results with evidence details and transitive dependency graph (v2 format). Requires Read permission. - [Create Issue Event](https://docs.jfrog.com/security/reference/create-issue-event.md): Creates a custom issue (vulnerability). The id parameter cannot have a prefix Xray, and provider parameter cannot be JFrog. Requires Manage Xray Metadata permission. - [Update Issue Event](https://docs.jfrog.com/security/reference/update-issue-event.md): Allows an issue vendor to update a custom issue - [Delete Issue Event](https://docs.jfrog.com/security/reference/delete-issue-event.md): Deletes a custom issue - [Get Issue Events V2](https://docs.jfrog.com/security/reference/get-issue-events-v2_custom-issues-v2-openapi.md): Gets an issue created by a vendor. - [Create Ignore Rule](https://docs.jfrog.com/security/reference/create-ignore-rule.md): Creates an Ignore Rule that suppresses violations matching the specified filters. Ignore rules apply only to future scans. To apply to past scans, you must manually trigger Apply on Existing Content on the relevant watch or watches. The `ignore_filters` object defines what to ignore. You must specify at least one objective filter (vulnerabilities, licenses, cves, operational_risk, or exposures) and can optionally scope it with source filters (components, artifacts, builds, watches, etc.). Combining an objective filter with scope filters is supported, for example `cves` together with `watches`. The optional `expires_at` field must be a future RFC 3339 timestamp (e.g., `2027-06-29T00:00:00Z`). Past timestamps are rejected with a validation error. Tip: when calling this endpoint with `jf xr curl` or another shell client, pass the JSON body via `--data @file.json` rather than an inline string to avoid quoting pitfalls — embedding single quotes inside a single-quoted argument produces invalid JSON, which fails with `Failed to parse ignore rule`. Requires the "Manage Watches" permission. Since Xray 3.11. - [Get Ignore Rules](https://docs.jfrog.com/security/reference/get-ignore-rules.md): Returns all Ignore Rules matching the specified query filters. All filter parameters are optional. Use pagination parameters to control result size. Requires the "Manage Watches" permission. Since Xray 3.11. - [Get Ignore Rule](https://docs.jfrog.com/security/reference/get-ignore-rule.md): Returns a single Ignore Rule by its ID, including its filters and metadata. Requires the "Manage Watches" permission. Since Xray 3.11. - [Delete Ignore Rule](https://docs.jfrog.com/security/reference/delete-ignore-rule.md): Deletes an Ignore Rule by its ID. The rule is soft-deleted and a background job is triggered to reactivate any violations that were previously suppressed by this rule. Requires the "Manage Watches" permission. Since Xray 3.11. - [Force Reindex](https://docs.jfrog.com/security/reference/force-reindex.md): Triggers a reindex of specified artifacts and/or builds. Use this to reindex existing resources that may have missing component data. The total number of entities (artifacts + builds) cannot exceed the configured maximum (default 1000). For some package types, dependency information lives in a separate package metadata file rather than the artifact binary itself. To recover that information you must force-reindex the metadata file, not just the artifact. Examples: - Docker: `manifest.json` (the manifest is the indexable entity for a Docker image; force-reindex also clears existing layer impact paths so they are re-derived from the manifest) - Maven: `pom.xml` - npm: `package.json` - Conan: `conanfile.py` For artifacts whose dependencies are encoded in a separate metadata file, point `path` at the metadata file (see the "Reindex Docker manifest" example below). Requires Admin permission. - [Scan Now](https://docs.jfrog.com/security/reference/scan-now_indexing-v2-openapi.md): Enables you to index resources on-demand. - [Get All Binary Managers](https://docs.jfrog.com/security/reference/get-all-binary-managers.md): Gets details of all connected Artifactory instances (binary managers). Requires Admin permission. - [Get Binary Manager](https://docs.jfrog.com/security/reference/get-binary-manager.md): Gets the details of the specified connected Artifactory instance. Requires Admin permission. - [Get Repos Indexing Configuration](https://docs.jfrog.com/security/reference/get-repos-indexing-configuration.md): Gets the indexed and non-indexed repositories for a given binary manager. For Xray version 3.21.2 and above with Projects, a Project Admin with Index Resources privilege can use the `projectKey` query parameter to scope this request to a project. Requires Admin permission. - [Update Repos Indexing Configuration](https://docs.jfrog.com/security/reference/update-repos-indexing-configuration.md): Updates the list of repositories selected for indexing in a given binary manager. Provide the list of repositories to be indexed. Requires Admin permission. - [Get Builds Indexing Configuration](https://docs.jfrog.com/security/reference/get-builds-indexing-configuration.md): Gets the indexed and non-indexed builds for a given binary manager. For Xray version 3.21.2 and above with Projects, a Project Admin with Index Resources privilege can use the `projectKey` query parameter to scope this request to a project. Requires Admin permission. - [Update Builds Indexing Configuration](https://docs.jfrog.com/security/reference/update-builds-indexing-configuration.md): Updates the indexed builds for a given binary manager. You can provide either a list of build names OR include/exclude patterns, but not both. For Xray version 3.21.2 and above with Projects, a Project Admin with Index Resources privilege can use the `projectKey` query parameter to scope this request to a project. Requires Admin permission. - [Add Builds to Indexing Configuration](https://docs.jfrog.com/security/reference/add-builds-to-indexing.md): Adds new builds to the list of builds selected for indexing. Provide either build names OR include/exclude patterns, but not both. Since Xray 3.8.2. For Xray version 3.21.2 and above with Projects, a Project Admin with Index Resources privilege can use the `projectKey` query parameter to scope this request to a project. Requires Admin permission. - [Get Release Bundles V2 Indexing Configuration](https://docs.jfrog.com/security/reference/get-release-bundle-v2-indexing-configuration.md): Gets the indexed and non-indexed Release Bundles V2 for a given binary manager. Requires Admin permission. - [Update Release Bundles V2 Indexing Configuration](https://docs.jfrog.com/security/reference/update-release-bundle-v2-indexing-configuration.md): Updates the indexed and non-indexed Release Bundles V2 for a given binary manager. Requires Admin permission. - [Add Release Bundles V2 to Indexing Configuration](https://docs.jfrog.com/security/reference/add-release-bundle-v2-to-indexing.md): Adds new Release Bundles V2 to the list selected for indexing by providing the new names. Requires Admin permission. - [Get All Binary Managers (V2)](https://docs.jfrog.com/security/reference/get-all-binary-managers-v2.md): Gets details of all connected Artifactory instances (binary managers), including indexed builds, release bundles, and release bundles v2 configuration. Requires Admin permission. - [Get Binary Manager (V2)](https://docs.jfrog.com/security/reference/get-binary-manager-v2.md): Gets the details of the specified connected Artifactory instance, including indexed builds, release bundles, and release bundles v2 configuration. Requires Admin permission. - [Get Builds Indexing Configuration (V2)](https://docs.jfrog.com/security/reference/get-builds-indexing-configuration-v2.md): Gets the indexed and non-indexed builds, including build repository and project information. Requires Index Resources permission (available to Project Admins). - [Update Builds Indexing Configuration (V2)](https://docs.jfrog.com/security/reference/update-builds-indexing-configuration-v2.md): Updates the indexed builds list. Provide the complete list of builds to be indexed, including build name and optionally project information. This replaces the existing indexed builds configuration. Requires Index Resources permission (available to Project Admins). - [Create Jira Integration](https://docs.jfrog.com/security/reference/create-jira-integration.md): Creates a new Jira integration. - [Get Jira Integration Status](https://docs.jfrog.com/security/reference/get-latest-status-of-integration.md): Retrieves the latest status of an existing Jira integration by its connection name. - [Get Jira Integration Details](https://docs.jfrog.com/security/reference/get-integration-detail.md): Retrieves full configuration details by connection name (PDF §21.2). - [Update Jira Integration](https://docs.jfrog.com/security/reference/update-jira-integration.md): Updates an existing Jira integration's configuration (PDF §21.4). - [Delete Jira Integration](https://docs.jfrog.com/security/reference/delete-jira-integration.md): Deletes a Jira integration. - [Add Custom License](https://docs.jfrog.com/security/reference/add-custom-license.md): Assigns a license to a single component in Xray. The license must be a known license (already existing in the system). The request body contains a `component` object identifying the target and a `license` object specifying which license to assign. Requires a valid user with MANAGE_DATA permission. - [Create Custom License](https://docs.jfrog.com/security/reference/create-custom-license.md): Creates a custom license for license compliance management. Custom licenses are user-defined and can be assigned to components for tracking and compliance purposes. The license name must be unique and cannot exceed 128 characters. Aliases also have a 128 character limit each. Requires Admin permission. Since Xray 3.132.0. - [Set License Priority](https://docs.jfrog.com/security/reference/set-license-priority.md): Set License Priority. - [Get Licenses](https://docs.jfrog.com/security/reference/get-licenses.md): Get Licenses. - [License Attribution Report](https://docs.jfrog.com/security/reference/license-attribution-report.md): Generates a license attribution report for a specific resource in the platform. The report can be output in PDF, JSON, CSV, or TXT format. Requires the Catalog service to be available. Requires the "Manage Data" role. Supported from Xray Version 3.118.0 and above. - [Create Policy](https://docs.jfrog.com/security/reference/create-policy.md): Creates a new security, license, or operational risk policy. A policy contains rules that define criteria for matching issues and actions to take when issues are found (e.g., block downloads, fail builds, send notifications). Once created, assign the policy to one or more watches using the Assign Policy to Watches endpoint. Requires the "Manage Policies" role to be set on the User or Group level. For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can create policies in the scope of a project by using the additional query parameter `projectKey`. - [Get Policies](https://docs.jfrog.com/security/reference/get-policies.md): Returns a list of all policies in the system. When `projectKey` is provided, returns both Global and Project-scoped policies for that project. Requires the Read Policies role to be set on the User or Group level. For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can get a list of Global and Project Policies by using the additional query parameter `projectKey`. - [Assign Policy to Watches](https://docs.jfrog.com/security/reference/assign-policy-to-watches.md): Assigns an existing policy to one or more watches. Each watch name in the request is processed independently — the response reports the result for each watch separately. If a watch does not exist or the policy is already assigned, the response indicates the status per watch rather than failing the entire request. Requires the "Manage Watches" role to be set on the User or Group level. Note: This endpoint does not support the `projectKey` query parameter. The policy is looked up by name across all scopes. - [Get Policy](https://docs.jfrog.com/security/reference/get-policy-by-name.md): Returns the details of a specific policy by name, including its rules, criteria, actions, and metadata (author, created/modified timestamps, assigned watches). Requires the Read Policies role to be set on the User or Group level. For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can get a policy by using the additional query parameter `projectKey`. When `projectKey` is provided, the policy is looked up in both the project scope and globally. - [Update Policy](https://docs.jfrog.com/security/reference/update-policy.md): Updates an existing policy. The policy name in the URL path is authoritative — it overrides any `name` field in the request body. The full policy definition must be provided (this is a full replacement, not a partial update). Requires the "Manage Policies" role to be set on the User or Group level. For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can update a policy in the scope of a project by using the additional query parameter `projectKey`. - [Delete Policy](https://docs.jfrog.com/security/reference/delete-policy.md): Deletes an existing policy by name. A policy cannot be deleted if it is currently assigned to one or more watches — you must unassign it first. Upon successful deletion, any associated violations are updated asynchronously and related ignore rules are cleaned up. Requires the "Manage Policies" role to be set on the User or Group level. Note: This endpoint does not support the `projectKey` query parameter. - [Create Policy](https://docs.jfrog.com/security/reference/create-policy_policies-v2-openapi.md): Creates a new security, license, or operational risk policy (v2 API). The v2 API supports additional action fields compared to v1, including `build_failure_grace_period_in_days`, `block_release_bundle_distribution`, `block_release_bundle_promotion`, and `create_ticket_enabled`. Requires the "Manage Policies" role to be set on the User or Group level. - [Get Policies](https://docs.jfrog.com/security/reference/get-policies_policies-v2-openapi.md): Returns a list of all policies in the system (v2 format). The v2 response includes additional action fields compared to v1. When `projectKey` is provided, returns both Global and Project-scoped policies for that project. Requires the Read Policies role to be set on the User or Group level. - [Get Policy](https://docs.jfrog.com/security/reference/get-policy-by-name_policies-v2-openapi.md): Returns the details of a specific policy by name (v2 format). The v2 response includes additional action fields compared to v1. Requires the Read Policies role to be set on the User or Group level. - [Update Policy](https://docs.jfrog.com/security/reference/update-policy_policies-v2-openapi.md): Updates an existing policy (v2 API). The policy name in the URL path is authoritative — it overrides any `name` field in the request body. The full policy definition must be provided (full replacement, not partial update). Requires the "Manage Policies" role to be set on the User or Group level. - [Delete Policy](https://docs.jfrog.com/security/reference/delete-policy_policies-v2-openapi.md): Deletes an existing policy by name. A policy cannot be deleted if it is currently assigned to one or more watches — you must unassign it first. Requires the "Manage Policies" role to be set on the User or Group level. Note: This endpoint does not support the `projectKey` query parameter. - [Get Reports List](https://docs.jfrog.com/security/reference/get-reports-list.md): Returns a paginated list of reports that have been generated. All pagination query parameters are mandatory (direction, page_num, num_of_rows, order_by). For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can get a list of reports in the scope of a project by using the additional query parameter `projectKey`. Requires a user with the Manage Reports role. Since Xray 3.8. - [Abort Report Generation](https://docs.jfrog.com/security/reference/abort.md): Aborts a report that is currently being generated. Use the report ID returned from a generate report request. For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can abort a report in the scope of a project by using the additional query parameter `projectKey`. Requires a user with the Manage Reports role. Since Xray 3.8. - [Generate CVE Search Report](https://docs.jfrog.com/security/reference/generate-cve-search-report.md): Generates a CVE Search Report with data defined by scope and filters. This request starts the report generation process which runs in the background. The search only works on indexed resources. The report limit is up to 5 reports; any new reports beyond the limit will delete previously generated reports. The request must have exactly one resource type (repositories, builds, release bundles, or projects). Requires a user with the Manage Reports role. Since Xray 3.73.x. - [Get CVE Search Report Details by ID](https://docs.jfrog.com/security/reference/get-cve-search-report-details-by-id.md): Retrieves the content of a previously generated CVE Search report by its ID. Results are paginated; use the pagination query parameters to control page size and ordering. An optional request body may be provided with filters (impacted_artifact, scan_date, vulnerable_component). Requires a user with the Manage Reports role. Since Xray 3.73.x. - [Get CVE Search Reports List](https://docs.jfrog.com/security/reference/get-cve-search-reports-list.md): Returns a paginated list of CVE Search reports that have been generated. Use pagination query parameters (direction, page_num, num_of_rows, order_by) to control the listing. An optional request body may be provided with filters for name, time range, status, and author. Requires a user with the Manage Reports role. Since Xray 3.73.x. - [Generate Exposures Report](https://docs.jfrog.com/security/reference/generate-exposures-report.md): Generates an Exposures report with data defined by scope and filters. This request starts the report generation process which runs in the background. The returned report ID is used in other requests such as Get Report Content, Export, Delete Report, etc. Requires a user with the Manage Reports role. - [Get Exposures Report Content](https://docs.jfrog.com/security/reference/generate-exposures-report-by-id.md): Retrieves the content of a previously generated Exposures report by its ID. Results are paginated; all pagination query parameters are mandatory. Requires a user with the Manage Reports role. - [Generate Due Diligence Report](https://docs.jfrog.com/security/reference/generate-due-diligence-report.md): Generates a Due Diligence report with data defined by scope and filters. This request starts the report generation process which runs in the background. The returned report ID is used in other requests such as Get Report Content, Export, Delete Report, etc. For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can generate a Due Diligence report in the scope of a project by using the additional query parameter `projectKey`. Requires a user with the Manage Reports role. Since Xray 3.9. - [Get Due Diligence Report Content](https://docs.jfrog.com/security/reference/get-due-diligence-report-content.md): Retrieves the content of a previously generated Due Diligence (license) report by its ID. Results are paginated; all pagination query parameters are mandatory. For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can access report content in the scope of a project by using the additional query parameter `projectKey`. Requires a user with the Manage Reports role. Since Xray 3.9. - [Generate Operational Risk Report](https://docs.jfrog.com/security/reference/generate-operational-risk-report.md): Generates an Operational Risk report with data defined by scope and filters. This request starts the report generation process which runs in the background. The returned report ID is used in other requests such as Get Report Content, Export, Delete Report, etc. For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can generate an Operational Risk report in the scope of a project by using the additional query parameter `projectKey`. Requires a user with the Manage Reports role. Since Xray 3.49.0. - [Get Operational Risk Report Content](https://docs.jfrog.com/security/reference/get-operational-risk-report-content.md): Retrieves the content of a previously generated Operational Risk report by its ID. Results are paginated; all pagination query parameters are mandatory. For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can access report content in the scope of a project by using the additional query parameter `projectKey`. Requires a user with the Manage Reports role. Since Xray 3.49.0. - [Generate Violations Report](https://docs.jfrog.com/security/reference/generate-violations-report.md): Generates a Violations report with data defined by scope and filters. This request starts the report generation process which runs in the background. The returned report ID is used in other requests such as Get Report Content, Export, Delete Report, etc. For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can generate a Violations report in the scope of a project by using the additional query parameter `projectKey`. Requires a user with the Manage Reports role. Since Xray 3.11. - [Get Violations Report Content](https://docs.jfrog.com/security/reference/get-violations-report-content.md): Retrieves the content of a previously generated Violations report by its ID. Results are paginated; all pagination query parameters are mandatory. For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can access report content in the scope of a project by using the additional query parameter `projectKey`. Requires a user with the Manage Reports role. Since Xray 3.11. - [Generate Vulnerabilities Report](https://docs.jfrog.com/security/reference/generate-vulnerabilities-report.md): Generates a Vulnerabilities report with data defined by scope and filters. This request starts the report generation process which runs in the background. The returned report ID is used in other requests such as Get Report Content, Export, Delete Report, etc. For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can generate a report in the scope of a project by using the additional query parameter `projectKey`. Requires a user with the Manage Reports role. Since Xray 3.8. - [Get Vulnerabilities Report Content](https://docs.jfrog.com/security/reference/get-vulnerabilities-report-content.md): Retrieves the content of a previously generated Vulnerabilities report by its ID. Results are paginated; all pagination query parameters are mandatory. An optional request body may be provided to apply advanced filters. For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can access report content in the scope of a project by using the additional query parameter `projectKey`. Requires a user with the Manage Reports role. Since Xray 3.8. - [Export Report](https://docs.jfrog.com/security/reference/export.md): Exports a report and its data to a PDF, JSON, or CSV file. The response is a ZIP file stream containing the exported file with the naming convention `.pdf|json|csv`. The report ID can be retrieved using the Get Reports List endpoint. Two mandatory query parameters must be provided: `file_name` (desired file name without suffix) and `format` (pdf, json, or csv). For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can export a report in the scope of a project by using the additional query parameter `projectKey`. Requires a user with the Manage Reports role. Since Xray 3.8. - [Get Report Details By ID](https://docs.jfrog.com/security/reference/get-report-details-by-id.md): Returns the metadata and status of a report by its unique ID, including progress, row count, start/end times, and report type. For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can get report details in the scope of a project by using the additional query parameter `projectKey`. Requires a user with the Manage Reports role. Since Xray 3.8. - [Delete Report](https://docs.jfrog.com/security/reference/delete.md): Deletes a report by its unique ID. Once deleted, the report and its data are permanently removed. For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can delete a report in the scope of a project by using the additional query parameter `projectKey`. Requires a user with the Manage Reports role. Since Xray 3.8. - [Get Vulnerabilities Report Content (V2)](https://docs.jfrog.com/security/reference/get-vulnerabilities-report-content_reports-v2-openapi.md): Retrieves vulnerability report data by report ID using the enhanced V2 format. This version includes additional fields such as applicability analysis results, JFrog severity ratings, CWE identifiers, and multi-CVE support per vulnerability row. Results are paginated; `num_of_rows` and `page_num` are required. Use the optional `search` query parameter to filter results across CVEs, impacted artifacts, vulnerable components, paths, and project keys. An optional request body may include advanced filters (e.g. severity, applicability_result). Requires a valid user with Reports Manager permission. - [Apply Watch on Existing Content](https://docs.jfrog.com/security/reference/apply-watch-on-existing-content.md): Applies watches on existing content within a specified date range. This triggers watch evaluation on artifacts that were already indexed before the watch was created. Requires the Manage Watches permission. - [Cancel Artifact Exposures Scan](https://docs.jfrog.com/security/reference/cancel-a-running-scan.md): Cancels a running exposures scan for a specific artifact. Only artifacts that are in pending status can be canceled. Requires the Manage Xray Metadata permission. - [Scan Artifact for Exposures](https://docs.jfrog.com/security/reference/scan-artifact-for-exposures.md): Triggers an exposures scan for a specific artifact. Only artifacts already scanned by Xray (SCA) can be scanned for exposures. Requires the Manage Xray Metadata permission. - [Get Artifact Exposures Scan Status](https://docs.jfrog.com/security/reference/scan-status-of-an-artifact.md): Returns the exposures scan status for a specific artifact. Requires the Manage Xray Metadata permission. - [Artifact Scan Status](https://docs.jfrog.com/security/reference/artifact-scan-status.md): Returns the scan status for a specific artifact. Requires Read permission. - [Build Scan Status](https://docs.jfrog.com/security/reference/build-scan-status.md): Returns the scan status for a specific build. Requires Read permission. - [Delete On-Demand Scan Results](https://docs.jfrog.com/security/reference/delete-on-demand-scan-results.md): Deletes multiple on-demand scan results. Requires Read permission. Since Xray 3.40.0. - [Release Bundle Scan Status](https://docs.jfrog.com/security/reference/release-bundle-scan-status.md): Returns the scan status for a release bundle. Requires Read permission. - [Release Bundle V2 Scan Status](https://docs.jfrog.com/security/reference/release-bundle-v2-scan-status.md): Returns the scan status for a Release Bundle V2. Requires Read permission. - [Repository Advanced Scans](https://docs.jfrog.com/security/reference/repository-advanced-scans.md): Triggers an advanced security scan (JAS Exposures and Contextual Analysis) on a repository. Only artifacts already scanned by Xray (SCA) can be scanned. Requires the Manage Xray Metadata permission. Since Xray 3.73. - [Cancel Repository Advanced Scan](https://docs.jfrog.com/security/reference/abort-a-running-repository-scan.md): Cancels a running advanced repository scan. Only artifacts in pending status will be canceled; already-scanned artifacts retain their results. Requires the Manage Xray Metadata permission. Since Xray 3.73. - [Scan Artifact](https://docs.jfrog.com/security/reference/scan-artifact.md): Invokes scanning of an artifact. The artifact is identified by its component ID (e.g. docker://image:tag). Requires the Manage Xray Metadata permission. - [Scan Build V1](https://docs.jfrog.com/security/reference/scan-build-v1.md): Invokes scanning of a build that was uploaded to Artifactory as requested by a CI server. Requires the Manage Xray Metadata permission. - [Get Repository Advanced Scan Status](https://docs.jfrog.com/security/reference/get-the-status-of-a-running-repository-scan.md): Returns the status of an advanced repository scan. Requires the Manage Xray Metadata permission. Since Xray 3.73. - [Exposures Scanning - Get Results List](https://docs.jfrog.com/security/reference/get-exposure-result-list.md): Returns a paginated list of exposures scan results for a specific artifact. The category is specified in the path (e.g. secrets, applications, services, iac). Requires Read permission. Since Xray 3.59.4. - [Exposures Scanning - Get Results Details](https://docs.jfrog.com/security/reference/get-exposure-result-details.md): Returns detailed information about a specific exposure finding. Requires Read permission. Since Xray 3.59.4. - [Exposures Scanning - Get Findings](https://docs.jfrog.com/security/reference/get-more-exposure-result-findings.md): Returns additional findings for an exposure result. Requires Read permission. Since Xray 3.59.4. - [Exposures Scanning - Get Evidence](https://docs.jfrog.com/security/reference/get-more-exposure-result-evidences.md): Returns evidence details for a specific finding. Requires Read permission. Since Xray 3.59.4. - [Exposures Scanning - Get Rows](https://docs.jfrog.com/security/reference/get-more-exposure-result-evidence-rows.md): Returns evidence row data for a specific finding. Requires Read permission. Since Xray 3.59.4. - [Get Git Repositories](https://docs.jfrog.com/security/reference/get-git-repositories.md): Retrieves a list of all git repositories that have been scanned. Allows fetching comprehensive information about git repositories based on scans that have been performed. You can apply various filters to refine the results. Requires a user with READ permissions. Since Xray 3.122. - [Get Branches for a Repository](https://docs.jfrog.com/security/reference/get-git-repository-branches.md): Retrieves all branches that belong to a specific repository. Allows fetching all Git branches associated with a given repository identified by its repository_id. Requires a user with READ permissions. Since Xray 3.122. - [Get Commits for a Branch](https://docs.jfrog.com/security/reference/get-git-repository-commits.md): Retrieves all commits that were scanned for a specific branch within a repository. The branch_name query parameter is required. Requires a user with READ permissions. Since Xray 3.122. - [Get Scan Results for a Commit](https://docs.jfrog.com/security/reference/get-git-commit-scan-results.md): Retrieves the scan results data associated with a specific commit in a branch of a repository. The scan results provide insights into vulnerabilities, SBOM components, operational risks, secrets, IaC issues, and SAST findings detected at the time of the commit. If the same commit was scanned multiple times (e.g., by different jobs), the API returns findings from all scans. It does not deduplicate issues across scans. Requires a user with READ permissions. Since Xray 3.122. - [Scan Build V2](https://docs.jfrog.com/security/reference/scan-build-v2.md): Triggers a CI build scan (v2 API). Invokes scanning of a build that was uploaded to Artifactory as requested by a CI server. Requires the Manage Xray Metadata permission. - [Get Build Scan Results](https://docs.jfrog.com/security/reference/get-builds-scan-results.md): Returns CI build scan results for a specific build. Returns violations only if it determines a build failure. To retrieve full scan results including vulnerabilities, use the include_vulnerabilities parameter. Requires the Manage Xray Metadata permission. - [Find Component by CVE](https://docs.jfrog.com/security/reference/find-component-by-cve.md): Searches for components that are directly affected by the specified CVEs. Returns a list of matching components grouped by CVE, including component name, package type, version, and a link to the instance. Requires the Reports Manager permission. - [Find CVEs by Component](https://docs.jfrog.com/security/reference/find-cves-by-component.md): Searches for CVEs that affect the specified components. Each component is identified by its component ID (e.g., gav://commons-collections:commons-collections:3.2.1). Returns CVE IDs grouped by component. If a component is not found, the response includes an error field for that component. Requires the Reports Manager permission. - [Search Resources by Vulnerability and Package](https://docs.jfrog.com/security/reference/search-resources-by-vulnerability-and-package.md): Search all resources (Artifacts, Builds, Release Bundles, etc.) that include a specific package or are impacted by a specific vulnerability (CVE or XRAY ID). Supports three search modes: - **Mode 1 - By Vulnerability**: `vulnerability` is required. - **Mode 2 - By Package Version**: `name` and `type` are required; `version` is optional. - **Mode 3 - By Package (all versions)**: `name` and `type` are required; omit `version`. **SBOM Requirement**: This capability depends on the SBOM Service. Self-Hosted users must enable the SBOM feature and complete the SBOM migration. If SBOM is disabled, the API returns 403. **Pagination**: Use `last_key` from the response to fetch subsequent pages; an empty `last_key` indicates no further results. Limit defaults to 1000, maximum 10000. Requires the Reports Manager permission. Since Xray 3.131. - [Get the Workers Count](https://docs.jfrog.com/security/reference/get-the-workers-count.md): Returns the current worker thread counts for each processing lane (index, persist, analysis, alert, impact analysis, notification). Each lane has separate counts for new content and existing content processing. Available for Self-Hosted installation only, not in JFrog SaaS. Requires System Admin permission. - [Update Workers Count](https://docs.jfrog.com/security/reference/configuring-the-workers-count.md): Updates the worker thread counts for each processing lane. Changes require a system restart to take effect. Available for Self-Hosted installation only, not in JFrog SaaS. Requires System Admin permission. - [System Liveness](https://docs.jfrog.com/security/reference/system-liveness.md): Kubernetes-style liveness probe. Returns 200 if the Xray service is alive, or 503 if health checks have failed. No authentication required. - [Ping](https://docs.jfrog.com/security/reference/ping-request.md): Simple health check endpoint. Returns a pong response to verify the Xray service is responding. No authentication required. - [System Readiness](https://docs.jfrog.com/security/reference/system-readiness.md): Kubernetes-style readiness probe. Returns 200 if all dependent services are ready. Supports an optional `noCache` query parameter to bypass cached results. No authentication required. - [Get Version](https://docs.jfrog.com/security/reference/get-version.md): Returns the Xray version and revision number. No authentication required by default (can be configured to require Read permission via `authenticateRequestForSystemVersion` setting). - [Get Violations](https://docs.jfrog.com/security/reference/get-violations.md): Gets Xray violations based on a set of search criteria. Returns violations with details about severity, type, infected components, and impacted artifacts. Use the `filters` object to narrow results by violation type, watch, severity, time range, CVE, issue ID, and specific resources. Use the `pagination` object to control sorting and paging. Starting from Xray version 3.42.3, JFrog Security CVE Research and Enrichment data is supported in the response. Fields short_description, full_description, and remediation are markdown. Requires a user with Read permissions. - [List Ignored Violations](https://docs.jfrog.com/security/reference/list-ignored-violations.md): Returns ignored violations by filters. Accepts objective filters (vulnerabilities, licenses, cves, operational_risk, exposures) and scope filters (policies, watches, components, artifacts, builds, release-bundles, etc.) in the request body. Pagination parameters are passed as query parameters. Requires the "Manage Watches" permission. Since Xray 3.11. Applicable to JFrog SaaS and Self-Hosted. - [Restore Ignored Violations](https://docs.jfrog.com/security/reference/restore-ignored-violations.md): Restores violations that were previously ignored by an Ignore Rule. The violations are identified by their violation IDs. Maximum of 500 violations can be restored per request (configurable). Requires the "Manage Watches" permission. Since Xray 3.16. Applicable to JFrog SaaS and Self-Hosted. - [Get Ignored Violations](https://docs.jfrog.com/security/reference/get-ignored-violations.md): Gets a list of all ignored violations on a specific watch. Returns violation details along with the ignore rule information that caused each violation to be suppressed. Requires the "Manage Watches" permission. Since Xray 3.11. - [Create Watch](https://docs.jfrog.com/security/reference/create-watch_watches-v2-openapi.md): Creates a new Watch. A Watch defines a set of resources (repositories, builds, release bundles, projects) to be monitored by assigned security and license policies. **Notes:** - For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can create a Watch in the scope of a project by using the `projectKey` query parameter. - A Watch can include both Global and Project Policies. Requires the 'Manage Watches' role to be set on the User or Group level. - [Get Watches](https://docs.jfrog.com/security/reference/get-watches_watches-v2-openapi.md): Gets a list of all Watches in the system. **Notes:** - For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can get a list of Watches in the scope of a project by using the `projectKey` query parameter. - A Watch can include both Global and Project Policies. Requires the 'Manage Watches' role to be set on the User or Group level. - [Get Watch](https://docs.jfrog.com/security/reference/get-watch_watches-v2-openapi.md): Gets a named Watch by its name. **Notes:** - For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can get a Watch in the scope of a project by using the `projectKey` query parameter. - A Watch can include both Global and Project Policies. Requires the 'Manage Watches' role to be set on the User or Group level. - [Update Watch](https://docs.jfrog.com/security/reference/update-watch_watches-v2-openapi.md): Updates an existing Watch. This overwrites the previous Watch configuration and replaces it with the provided parameters. The Watch name in the path takes precedence over the name in the request body. **Notes:** - You cannot update the project_key property. - A Watch can include both Global and Project Policies. - For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can update a Watch in the scope of a project by using the `projectKey` query parameter. Requires the 'Manage Watches' role to be set on the User or Group level. - [Delete Watch](https://docs.jfrog.com/security/reference/delete-watch_watches-v2-openapi.md): Deletes a Watch by name. **Notes:** - For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can delete a Watch in the scope of a project by using the `projectKey` query parameter. - A Watch can include both Global and Project Policies. Requires the 'Manage Watches' role to be set on the User or Group level. - [List of all images in runtime](https://docs.jfrog.com/security/reference/get_live-images.md) - [List of images tags in runtime](https://docs.jfrog.com/security/reference/get_live-image-tags.md) - [Detailed view of an image](https://docs.jfrog.com/security/reference/get_live-image-details.md) - [Get clusters for a specific image tag](https://docs.jfrog.com/security/reference/get_live-image-details-clusters.md) - [List of all workloads in runtime](https://docs.jfrog.com/security/reference/get_live-workloads.md) - [List of all Process Groups in runtime](https://docs.jfrog.com/security/reference/get_live-processgroups.md) - [Get Process Group by ID](https://docs.jfrog.com/security/reference/get_live-processgroups-processgroupid.md) - [Get Process Group Summary by ID](https://docs.jfrog.com/security/reference/get_live-processgroups-processgroupid-details.md) - [Get Accessed Files by Process Group ID](https://docs.jfrog.com/security/reference/get_live-processgroups-processgroupid-accessed-files.md) - [Get autocomplete suggestions](https://docs.jfrog.com/security/reference/get_live-autocomplete.md) - [List of images tags](https://docs.jfrog.com/security/reference/post_images-tags.md) - [List of workloads](https://docs.jfrog.com/security/reference/post_workloads.md) - [Get application versions by SHA256](https://docs.jfrog.com/security/reference/get_application-versions.md) - [Detect if repository is monitored in runtime](https://docs.jfrog.com/security/reference/post_detected.md) - [Get artifact status in runtime](https://docs.jfrog.com/security/reference/post_artifacts-status.md) - [Get image artifact status in runtime](https://docs.jfrog.com/security/reference/post_scan-list-images-status.md) - [Get detection status of artifacts from docker/oci repository in runtime](https://docs.jfrog.com/security/reference/post_scan-list-images-repository-artifacts-status.md) - [Get detection status of artifacts from multiple repositories in runtime](https://docs.jfrog.com/security/reference/post_scan-list-images-repository-artifacts-statuses.md): Similar to /scan_list/images_repository/artifacts/status but accepts paths with embedded repository names, allowing queries across multiple repositories in a single request. - [Get detection and integrity status of image artifacts from application versions in runtime](https://docs.jfrog.com/security/reference/post_application-versions-images-status.md) - [Check if image(s) by SHA256 are running in runtime](https://docs.jfrog.com/security/reference/post_images-running.md): Returns whether image(s) with the given SHA256(s) are currently running in any monitored cluster. Used for Xray policy integration. Supports both single SHA256 and batch queries: - Single: { "sha256": "abc123..." } - Batch: { "sha256List": ["abc123...", "def456..."] } Note: If both sha256 and sha256List are provided, sha256List takes precedence. - [Get Vulnerabilities by Process Group ID](https://docs.jfrog.com/security/reference/get_live-processgroups-processgroupid-vulnerabilities.md) - [Get Vulnerabilities by Sha256](https://docs.jfrog.com/security/reference/get_live-image-vulnerabilities.md) - [Get all related images for a CVE](https://docs.jfrog.com/security/reference/post_vulnerabilities-related-images.md) - [List vulnerabilities for the table view](https://docs.jfrog.com/security/reference/post_vulnerabilities.md) - [Get vulnerability dashboard stats widget](https://docs.jfrog.com/security/reference/get_vulnerability-dashboard-widgets-stats.md) - [Get vulnerability dashboard runtime status](https://docs.jfrog.com/security/reference/get_vulnerability-dashboard-widgets-runtime-status.md) - [Get vulnerability prioritization widget](https://docs.jfrog.com/security/reference/get_dashboard-overview-widgets-vulnerability-prioritization.md) - [Get live assessment highlights widget](https://docs.jfrog.com/security/reference/get_dashboard-overview-widgets-live-assessment-highlights.md) - [Get running images chart widget](https://docs.jfrog.com/security/reference/get_dashboard-overview-widgets-running-images-chart.md) - [Get registration token status and expiration information](https://docs.jfrog.com/security/reference/get_registration-token-status.md): Retrieves the status of the registration token including expiration information. Returns whether the token exists, expiration date, days until expiry, warning threshold status, and whether the token has expired. Requires Resource Manager permissions. - [Retrieve All Clusters By Status](https://docs.jfrog.com/security/reference/get_ui-clusters-count-by-status.md) - [Retrieve Clusters Count By Provider](https://docs.jfrog.com/security/reference/get_ui-clusters-count-by-provider.md) - [Retrieve Clusters Count By Version](https://docs.jfrog.com/security/reference/get_ui-clusters-count-by-version.md) - [List Clusters](https://docs.jfrog.com/security/reference/get_ui-clusters.md) - [Get Cluster by ID](https://docs.jfrog.com/security/reference/get_ui-clusters-id.md) - [Delete Cluster by ID](https://docs.jfrog.com/security/reference/delete_ui-clusters-id.md) - [Modify cluster name by ID](https://docs.jfrog.com/security/reference/post_ui-clusters-id.md) - [List Clusters](https://docs.jfrog.com/security/reference/post_clusters.md) - [Get Cluster By ID Public API](https://docs.jfrog.com/security/reference/get_clusters-id.md) - [Retrieve All Trusted Registries](https://docs.jfrog.com/security/reference/get_trusted-registries.md) - [Add a Trusted Registry](https://docs.jfrog.com/security/reference/put_trusted-registries.md) - [Retrieve a Trusted Registry by URL](https://docs.jfrog.com/security/reference/get_trusted-registries-registryurl.md) - [Modify a Trusted Registry by URL](https://docs.jfrog.com/security/reference/post_trusted-registries-registryurl.md) - [Delete a Trusted Registry by URL](https://docs.jfrog.com/security/reference/delete_trusted-registries-registryurl.md) - [Store AWS credentials](https://docs.jfrog.com/security/reference/post_aws-credentials.md) - [List all AWS secret stores](https://docs.jfrog.com/security/reference/get_aws-credentials.md) - [Delete an AWS secret store](https://docs.jfrog.com/security/reference/delete_aws-secrets-uuid.md) - [Add a new ECS task](https://docs.jfrog.com/security/reference/post_aws-ecs-tasks.md) - [List all ECS tasks](https://docs.jfrog.com/security/reference/get_aws-ecs-tasks.md) - [Get ECS task by ID](https://docs.jfrog.com/security/reference/get_aws-ecs-tasks-id.md) - [Delete an ECS task](https://docs.jfrog.com/security/reference/delete_aws-ecs-tasks-id.md) - [List ECS tasks by secret UUID](https://docs.jfrog.com/security/reference/get_aws-ecs-tasks-by-secret-secretuuid.md) - [Get Worker Events](https://docs.jfrog.com/security/reference/get_workers-events.md): Retrieve the list of worker events - [Create support bundle](https://docs.jfrog.com/security/reference/post_system-support-bundle.md) - [Create node support bundle](https://docs.jfrog.com/security/reference/put_system-support-bundle-id.md) - [Retrieve the base URL](https://docs.jfrog.com/security/reference/get_base-url.md) - [Get User Agreement](https://docs.jfrog.com/security/reference/get_user-agreement.md) - [Post User Agreement](https://docs.jfrog.com/security/reference/post_user-agreement.md) # Release Information Documentation > Documentation for Release Information ## Guides - [Get Started with JFrog Releases](https://docs.jfrog.com/releases/docs/getting-started.md): Stay informed on the latest features and security updates for JFrog across both our SaaS and Self-Managed platforms. - [Artifactory Release Notes](https://docs.jfrog.com/releases/docs/artifactory-release-notes.md) - [Artifactory SaaS Releases](https://docs.jfrog.com/releases/docs/artifactory-saas-releases.md): This section contains the Release Notes for Artifactory SaaS releases. - [Artifactory Self-Managed Releases](https://docs.jfrog.com/releases/docs/artifactory-self-managed-releases.md) - [About Artifactory Releases](https://docs.jfrog.com/releases/docs/about-artifactory-releases.md) - [Artifactory Known Issues](https://docs.jfrog.com/releases/docs/artifactory-known-issues.md): Known issues for Artifactory releases, including affected versions, fix versions, and suggested workarounds. - [Artifactory End of Life](https://docs.jfrog.com/releases/docs/artifactory-end-of-life.md) - [Artifactory Fixed Security Vulnerabilities](https://docs.jfrog.com/releases/docs/artifactory-fixed-security-vulnerabilities.md) - [Artifactory Deprecations](https://docs.jfrog.com/releases/docs/artifactory-deprecations.md) - [JFrog Security SaaS Releases](https://docs.jfrog.com/releases/docs/security-previous-releases.md) - [Frogbot V3](https://docs.jfrog.com/releases/docs/frogbot.md) - [Xray](https://docs.jfrog.com/releases/docs/xray.md) - [Runtime Security](https://docs.jfrog.com/releases/docs/runtime-security.md) - [Runtime Integrity](https://docs.jfrog.com/releases/docs/runtime-integrity.md) - [Runtime Impact](https://docs.jfrog.com/releases/docs/runtime-impact.md) - [ JFrog Security Self-Managed Releases](https://docs.jfrog.com/releases/docs/security-self-managed-releases.md) - [JFrog Security Known Issues](https://docs.jfrog.com/releases/docs/security-known-issues.md) - [JFrog Security End of Life](https://docs.jfrog.com/releases/docs/security-end-of-life.md) - [JFrog Security Fixed Security Vulnerabilities](https://docs.jfrog.com/releases/docs/security-fixed-security-vulnerabilities.md) - [JFrog Security Deprecations](https://docs.jfrog.com/releases/docs/xray-deprecations.md) - [AppTrust Release Notes](https://docs.jfrog.com/releases/docs/apptrust-release-notes.md): Updates about the latest features and enhancements in JFrog AppTrust - [JFrog ML Release Notes 2026](https://docs.jfrog.com/releases/docs/jfrog-ml-release-notes-2026.md): Updates about the latest features and enhancements in JFrog ML - [JFrog ML Release Notes 2025](https://docs.jfrog.com/releases/docs/jfrog-ml-release-notes-2025.md): Updates about new and improved features in 2025 in JFrog ML - [Distribution Release Notes](https://docs.jfrog.com/releases/docs/distribution-release-notes.md) - [Distribution Known Issues](https://docs.jfrog.com/releases/docs/distribution-known-issues.md) - [Distribution End of Life](https://docs.jfrog.com/releases/docs/distribution-end-of-life.md) - [Distribution Fixed Security Vulnerabilities](https://docs.jfrog.com/releases/docs/distribution-fixed-security-vulnerabilities.md) - [Distribution Deprecations](https://docs.jfrog.com/releases/docs/distribution-deprecations.md) - [JFrog Workers Release Information](https://docs.jfrog.com/releases/docs/jfrog-workers-release-information.md) - [JFrog Bridges Release Information](https://docs.jfrog.com/releases/docs/bridges-release-information.md) - [JFrog MCP Server Release Information](https://docs.jfrog.com/releases/docs/jfrog-mcp-server-release-information.md) - [JFrog Grid Release Information](https://docs.jfrog.com/releases/docs/jfrog-grid-release-information.md) - [JFrog Security Advisories](https://docs.jfrog.com/releases/docs/jfrog-security-advisories.md): JFrog security advisories and CVE information for Artifactory vulnerabilities, with detailed information on affected versions and remediation guidance. - [Deprecations](https://docs.jfrog.com/releases/docs/deprecations.md) - [Deprecations in Process](https://docs.jfrog.com/releases/docs/deprecations-in-process.md) - [JFrog Platform Deprecations](https://docs.jfrog.com/releases/docs/jfrog-platform-deprecations.md) - [JFrog Pipelines Deprecation - End of Life](https://docs.jfrog.com/releases/docs/pipeline-deprecation-end-of-life.md): JFrog Pipelines reached end of life on May 1, 2026, and no longer receives updates, bug fixes, or security patches. # Set up JFrog Documentation > Documentation for Set up JFrog ## Guides - [Welcome to JFrog Docs!](https://docs.jfrog.com/setup/docs/get-started.md): JFrog provides a full end-to-end solution for secure software development and distribution, in a fully managed, scalable service. The Help Center Portal can help you get started, and provide in-depth information to help you make the most of JFrog component services. - [Why JFrog](https://docs.jfrog.com/setup/docs/why-jfrog.md): Learn why the JFrog Platform secures your software supply chain from build to AI release. - [For JFrog Administrators](https://docs.jfrog.com/setup/docs/for-jfrog-administrators.md) - [Initial Configuration of Your Subscription](https://docs.jfrog.com/setup/docs/security-and-first-steps.md) - [Complete the SDLC - Release Bundles, Edge Nodes. Build Integration](https://docs.jfrog.com/setup/docs/complete-the-sdlc-release-bundles-edge-nodes-build-integration.md) - [For Developers and Project Managers](https://docs.jfrog.com/setup/docs/for-developers-and-project-managers-2.md) - [Working with JFrog](https://docs.jfrog.com/setup/docs/working-with-jfrog.md) - [MyJFrog Admin Interface](https://docs.jfrog.com/setup/docs/myjfrog-admin-interface.md) - [JFrog Platform Interface](https://docs.jfrog.com/setup/docs/jfrog-platform-interface.md): Navigate the JFrog Platform interface to manage projects, repositories, and packages, and switch between subscription sites using Platform and Administration modules. - [Move Between Sites in Your Subscription](https://docs.jfrog.com/setup/docs/navigate-sites.md): Navigate between your organization's sites and subscriptions. - [AI Tools for Your JFrog Journey](https://docs.jfrog.com/setup/docs/ai-tools-for-your-jfrog-journey.md) - [JFrog AI Assistant](https://docs.jfrog.com/setup/docs/jfrog-ai-assistant.md) # Binary Management Documentation > Documentation for Binary Management ## Guides - [Get Started with Binary Management (DevOps)](https://docs.jfrog.com/artifactory/docs/getting-started.md): JFrog Artifactory is the single solution for housing and managing all your software artifacts, AI/ML models, binaries, packages, files, containers, components, and releases used in and generated across your organization’s software supply chain. - [Artifactory Overview](https://docs.jfrog.com/artifactory/docs/jfrog-artifactory.md) - [Supported Package Types](https://docs.jfrog.com/artifactory/docs/supported-package-types.md) - [Work with Package Management](https://docs.jfrog.com/artifactory/docs/working-with-package-management.md) - [Set up Package Management in Artifactory](https://docs.jfrog.com/artifactory/docs/set-up-package-management-in-artifactory.md) - [Understand Artifacts and Packages](https://docs.jfrog.com/artifactory/docs/understanding-artifacts-and-packages.md) - [Use Artifactory Set Me Up to Configure Package Manager Clients](https://docs.jfrog.com/artifactory/docs/use-artifactory-set-me-up-for-configuring-package-manager-clients.md) - [Upload and Download Packages using Artifactory](https://docs.jfrog.com/artifactory/docs/upload-and-download-packages-using-artifactory.md) - [Viewing Packages](https://docs.jfrog.com/artifactory/docs/viewing-packages.md) - [JFrog User Types](https://docs.jfrog.com/artifactory/docs/jfrog-user-types.md) - [Package and Repositories Use Cases](https://docs.jfrog.com/artifactory/docs/package-and-repositories-use-cases.md) - [Connect your Package Manager or IDE to Artifactory](https://docs.jfrog.com/artifactory/docs/connect-your-package-manager-to-artifactory.md) - [Agent Packages Repositories](https://docs.jfrog.com/artifactory/docs/agent-packages-repositories.md): Set up Agent Packages repositories in JFrog Artifactory to publish, install, and govern versioned APM agent packages with skills, prompts, hooks, and MCP servers. - [Agent Plugins Repositories](https://docs.jfrog.com/artifactory/docs/agent-plugins-repositories.md): Configure JFrog Artifactory Agent Plugins repositories to securely store and distribute agent plugins from Artifactory. - [AI Editor Extension Repositories](https://docs.jfrog.com/artifactory/docs/ai-editor-extension-repositories.md) - [Alpine Linux Repositories](https://docs.jfrog.com/artifactory/docs/alpine-linux-repositories.md) - [Ansible Repositories](https://docs.jfrog.com/artifactory/docs/ansible-repositories.md) - [Bazel Modules Repositories](https://docs.jfrog.com/artifactory/docs/bazel-modules-repositories.md) - [Bower Repositories](https://docs.jfrog.com/artifactory/docs/bower-repositories.md) - [Cargo Repositories](https://docs.jfrog.com/artifactory/docs/cargo-repositories.md) - [Chef Repositories](https://docs.jfrog.com/artifactory/docs/chef-repositories.md) - [CocoaPods Repositories](https://docs.jfrog.com/artifactory/docs/cocoapods-repositories.md) - [Conan Repositories](https://docs.jfrog.com/artifactory/docs/conan-repositories.md) - [Conda Repositories](https://docs.jfrog.com/artifactory/docs/conda-repositories.md) - [CRAN Repositories](https://docs.jfrog.com/artifactory/docs/cran-repositories.md) - [Debian Repositories](https://docs.jfrog.com/artifactory/docs/debian-repositories.md) - [Docker Repositories](https://docs.jfrog.com/artifactory/docs/docker-repositories.md): Connect your Docker client to JFrog Artifactory using docker login or manual credentials so you can push and pull images from private Docker repositories. - [Additional Docker Information](https://docs.jfrog.com/artifactory/docs/additional-docker-information.md) - [Git LFS Repositories](https://docs.jfrog.com/artifactory/docs/git-lfs-repositories.md) - [Go Modules](https://docs.jfrog.com/artifactory/docs/go-modules.md) - [Hex Repositories](https://docs.jfrog.com/artifactory/docs/hex-repositories.md) - [Hugging Face Repositories](https://docs.jfrog.com/artifactory/docs/hugging-face-repositories.md) - [JetBrains Plugins Repositories](https://docs.jfrog.com/artifactory/docs/jetbrains-plugins-repositories.md) - [Kubernetes Helm Chart Repositories](https://docs.jfrog.com/artifactory/docs/kubernetes-helm-chart-repositories.md) - [LuaRocks Repositories](https://docs.jfrog.com/artifactory/docs/luarocks-repositories.md): Configure LuaRocks repositories in JFrog Artifactory to upload and install Lua packages. - [Machine Learning Repositories](https://docs.jfrog.com/artifactory/docs/machine-learning-repositories.md) - [Maven Repositories](https://docs.jfrog.com/artifactory/docs/maven-repositories.md) - [Nix Repositories](https://docs.jfrog.com/artifactory/docs/nix-repositories.md): Configure Nix repositories in JFrog Artifactory for private binary caching, channel publishing, and Ed25519 signing for trusted reproducible builds. - [npm Repositories](https://docs.jfrog.com/artifactory/docs/npm-repositories.md) - [NuGet Repositories](https://docs.jfrog.com/artifactory/docs/nuget-repositories.md) - [NVIDIA NIM Repositories](https://docs.jfrog.com/artifactory/docs/nvidia-nim-repositories.md) - [OCI Repositories](https://docs.jfrog.com/artifactory/docs/oci-repositories.md) - [Opkg Repositories](https://docs.jfrog.com/artifactory/docs/opkg-repositories.md) - [P2 Repositories](https://docs.jfrog.com/artifactory/docs/p2-repositories.md) - [PHP Composer Repositories](https://docs.jfrog.com/artifactory/docs/php-composer-repositories.md) - [pub Repositories](https://docs.jfrog.com/artifactory/docs/pub-repositories.md) - [Puppet Repositories](https://docs.jfrog.com/artifactory/docs/puppet-repositories.md): Learn how to use JFrog Artifactory with Puppet to manage collections, deploy packages, and configure repositories for your automation workflows. - [PyPI Repositories](https://docs.jfrog.com/artifactory/docs/pypi-repositories.md) - [RPM Repositories](https://docs.jfrog.com/artifactory/docs/rpm-repositories.md) - [RubyGems Repositories](https://docs.jfrog.com/artifactory/docs/rubygems-repositories.md) - [sbt Repositories](https://docs.jfrog.com/artifactory/docs/sbt-repositories.md) - [Skills Repositories](https://docs.jfrog.com/artifactory/docs/skills-repositories.md) - [Swift Repositories](https://docs.jfrog.com/artifactory/docs/swift-repositories.md): Configure Swift repositories in JFrog Artifactory to deploy and resolve packages with SPM. - [Terraform/OpenTofu and Terraform Backend Repositories](https://docs.jfrog.com/artifactory/docs/terraform-opentofu-and-terraform-backend-repositories.md) - [Vagrant Repositories](https://docs.jfrog.com/artifactory/docs/vagrant-repositories.md) - [VCS Repositories](https://docs.jfrog.com/artifactory/docs/vcs-repositories.md) - [Repository Management](https://docs.jfrog.com/artifactory/docs/repository-management.md) - [Get Started with Repositories](https://docs.jfrog.com/artifactory/docs/repository-management-overview.md) - [View Repositories](https://docs.jfrog.com/artifactory/docs/view-repositories.md) - [Local Repositories](https://docs.jfrog.com/artifactory/docs/local-repositories.md) - [Remote Repositories](https://docs.jfrog.com/artifactory/docs/remote-repositories.md) - [Smart Remote Repositories](https://docs.jfrog.com/artifactory/docs/smart-remote-repositories.md) - [Virtual Repositories](https://docs.jfrog.com/artifactory/docs/virtual-repositories.md) - [Federated Repositories](https://docs.jfrog.com/artifactory/docs/federated-repositories.md): Synchronize artifacts and metadata across distributed JFrog Platform Deployments with event-driven replication. - [Concepts](https://docs.jfrog.com/artifactory/docs/federation-concepts.md): Learn the core architecture, sync behavior, and health concepts for Federated repositories. - [What Are Federated Repositories](https://docs.jfrog.com/artifactory/docs/what-are-federated-repositories.md): Learn how Artifactory Federated repositories replicate artifacts across multiple JPDs. - [Access Federation vs. Repository Federation](https://docs.jfrog.com/artifactory/docs/access-federation-vs-repo-federation.md): Compare Access Federation and Repository Federation to sync identities or artifacts across JPDs. - [Federation Members and Topology](https://docs.jfrog.com/artifactory/docs/federation-members-and-topology.md): Learn how Federation members form a mesh topology with independent metadata and binary sync. - [Synchronization and Conflict Resolution](https://docs.jfrog.com/artifactory/docs/synchronization-and-conflict-resolution.md): Learn how Federated repositories resolve sync conflicts using timestamp-based rules. - [Event Types and Lifecycle](https://docs.jfrog.com/artifactory/docs/event-types-and-lifecycle.md): Learn the event types and lifecycle that drive Federation synchronization in Artifactory. - [Member States and Health](https://docs.jfrog.com/artifactory/docs/member-states-and-health.md): Interpret HEALTHY, PENDING_FS, ERROR, and other member states to monitor Federation synchronization health. - [Mirror Modes in Federated Repositories](https://docs.jfrog.com/artifactory/docs/mirror-modes-in-federated-repositories.md): Choose bidirectional, receiving-only, or transmitter mode to control Federation artifact flow. - [Federation Priority](https://docs.jfrog.com/artifactory/docs/federation-priority.md): Assign STANDARD, HIGH, or URGENT priority levels to control synchronization urgency for Federated repositories. - [Artifactory Federation Service (RTFS)](https://docs.jfrog.com/artifactory/docs/artifactory-federation-service-rtfs.md): Learn how the Artifactory Federation Service (RTFS) orchestrates scalable, self-healing sync. - [Multi-Version Support](https://docs.jfrog.com/artifactory/docs/multi-version-support.md): Run different Artifactory versions across Federation members with automatic configuration conflict handling. - [Getting Started](https://docs.jfrog.com/artifactory/docs/federation-getting-started.md): Complete prerequisites and create your first Federated repository across JFrog Platform Deployments. - [Prerequisites for Federated Repositories](https://docs.jfrog.com/artifactory/docs/prerequisites-federated-repositories.md): Verify subscription, version, clock sync, and trust requirements before setting up Federated repositories. - [Create Your First Federation](https://docs.jfrog.com/artifactory/docs/create-your-first-federation.md): Walk through creating a Federated repository, adding members, and verifying artifact synchronization between JPDs. - [Admin Tasks](https://docs.jfrog.com/artifactory/docs/federation-admin-tasks.md): Manage the full lifecycle of Federated repositories in JFrog Artifactory. - [Create a Federated Repository](https://docs.jfrog.com/artifactory/docs/create-a-federated-repository.md): Create a Federated repository in JFrog Artifactory and add members to form a Federation. - [Edit a Federated Repository](https://docs.jfrog.com/artifactory/docs/edit-a-federated-repository.md): Modify settings, membership, and configuration of a Federated repository in JFrog Artifactory. - [Convert Between Repository Types](https://docs.jfrog.com/artifactory/docs/convert-between-repository-types.md): Convert repositories between local, Federated, and Build-Info types in JFrog Artifactory. - [Delete a Federated Repository](https://docs.jfrog.com/artifactory/docs/delete-a-federated-repository.md): Remove a Federated repository from JFrog Artifactory and review the impact on remaining members. - [Add and Remove Federation Members](https://docs.jfrog.com/artifactory/docs/add-and-remove-federation-members.md): Add repositories to or remove members from a Federation in JFrog Artifactory. - [Configure Receiving-Only Mode](https://docs.jfrog.com/artifactory/docs/configure-receiving-only-mode.md): Set a Federation member to receiving-only mode in JFrog Artifactory for unidirectional sync. - [Set Federation Priority](https://docs.jfrog.com/artifactory/docs/set-federation-priority.md): Assign Standard, High, or Urgent priority to a Federated repository in JFrog Artifactory. - [Pause and Resume Synchronization](https://docs.jfrog.com/artifactory/docs/pause-and-resume-synchronization.md): Pause and resume artifact synchronization between Federation members in JFrog Artifactory. - [Trigger a Full Sync](https://docs.jfrog.com/artifactory/docs/trigger-a-full-sync.md): Run a Full Sync in JFrog Artifactory to copy missing files between Federation members. - [Push Configuration to Federation Members](https://docs.jfrog.com/artifactory/docs/push-configuration-to-federation-members.md): Push an updated repository configuration to out-of-sync Federation members in JFrog Artifactory. - [Replay Failed Binary Tasks](https://docs.jfrog.com/artifactory/docs/replay-failed-binary-tasks.md): Reset and re-queue exhausted binary tasks in a JFrog Artifactory Federation. - [Recovery and Auto-Healing](https://docs.jfrog.com/artifactory/docs/recovery-and-auto-healing.md): Learn how JFrog Artifactory automatically recovers exhausted event queues and binary tasks in a Federation. - [Change Base URL in Federated Repositories](https://docs.jfrog.com/artifactory/docs/change-base-url-in-federated-repositories.md): Update the base URL on an active Federation in JFrog Artifactory and re-pair members. - [Configure Proxy for Federation](https://docs.jfrog.com/artifactory/docs/configure-proxy-for-federation.md): Route outbound Federation traffic in JFrog Artifactory through a proxy, or bypass it entirely. - [Import and Export Repositories](https://docs.jfrog.com/artifactory/docs/import-export-repositories.md): Import or export repository content in JFrog Artifactory for seeding, recovery, or migration. - [Working with Repositories](https://docs.jfrog.com/artifactory/docs/federation-working-with-repositories.md): Deploy, resolve, and browse artifacts in Federated repositories using build tools or the Artifactory UI. - [Using Federated Repositories](https://docs.jfrog.com/artifactory/docs/using-federated-repositories.md): Learn how Federation affects deployment, resolution, and conflict handling for developers. - [Browse Artifacts in a Federated Repository](https://docs.jfrog.com/artifactory/docs/browse-artifacts-in-a-federated-repository.md): Navigate the Artifacts Browser to view and inspect files stored in a Federated repository on your local JPD. - [Deploy Artifacts to a Federated Repository](https://docs.jfrog.com/artifactory/docs/deploy-artifacts-to-a-federated-repository.md): Upload artifacts through the UI or build tools and understand how deployments synchronize to other Federation members. - [Resolve Artifacts from a Federated Repository](https://docs.jfrog.com/artifactory/docs/resolve-artifacts-from-a-federated-repository.md): Download and resolve dependencies from the local Federation member using build tools or the Artifactory UI. - [Use Set Me Up with a Federated Repository](https://docs.jfrog.com/artifactory/docs/use-set-me-up-with-a-federated-repository.md): Generate build tool configuration snippets for deploying to and resolving from a Federated repository. - [Configuration](https://docs.jfrog.com/artifactory/docs/federation-configuration.md): Configure RTFS, tune sync performance, and set up advanced Federation topologies. - [Configuration Overview](https://docs.jfrog.com/artifactory/docs/configuration-overview.md): Understand the three configuration layers for Federation: Artifactory backend, RTFS service, and Helm deployment. - [Configure General Settings](https://docs.jfrog.com/artifactory/docs/configure-general-settings.md): Set up the custom base URL and other general Artifactory settings for Federation members. - [RTFS Configuration](https://docs.jfrog.com/artifactory/docs/rtfs-configuration.md): Configure RTFS application.properties for Full Sync, auto-healing, and event processing. - [RTFS Database Requirements](https://docs.jfrog.com/artifactory/docs/rtfs-database-requirements.md): Provision a dedicated PostgreSQL database for RTFS with sizing and partitioning guidance. - [Helm Deployment Configuration](https://docs.jfrog.com/artifactory/docs/helm-deployment-configuration.md): Deploy the RTFS service on Kubernetes using the Helm chart's image, database, and scaling settings. - [Network Architecture and Ports](https://docs.jfrog.com/artifactory/docs/network-architecture-and-ports.md): Review the ports and firewall rules RTFS and Federated repositories need between JPD sites. - [Federation over JFrog Bridge](https://docs.jfrog.com/artifactory/docs/federation-over-jfrog-bridge.md): Synchronize Federated repositories between SaaS and self-managed JPDs through JFrog Bridge. - [Bulk Mirroring Configuration](https://docs.jfrog.com/artifactory/docs/bulk-mirroring-configuration.md): Speed up Federation sync with parallel bulk mirroring and thread pool tuning. - [Scaling and Sizing Guide](https://docs.jfrog.com/artifactory/docs/scaling-and-sizing-guide.md): Size RTFS deployments with tier-based guidance on thread pools, batches, and autoscaling. - [Geo-Synchronized Topology](https://docs.jfrog.com/artifactory/docs/geo-synchronized-topology.md): Connect Artifactory instances behind a GeoDNS with a dedicated Federated Repository URL. - [Manage Property Sets](https://docs.jfrog.com/artifactory/docs/manage-property-sets.md): Create, assign, and manage property sets for structured artifact metadata across Federation members. - [Manage User Plugins](https://docs.jfrog.com/artifactory/docs/manage-user-plugins.md): Deploy Groovy-based user plugins on self-managed Artifactory and understand their local-only execution in a Federation. - [System Properties Reference](https://docs.jfrog.com/artifactory/docs/system-properties-reference.md): Look up Artifactory system properties for Federated repositories, from queues to binary stores. - [Federated Repository Best Practices](https://docs.jfrog.com/artifactory/docs/federated-repository-best-practices.md): Optimize Federation performance with recommendations for queues, workers, and timeouts. - [Monitoring](https://docs.jfrog.com/artifactory/docs/federation-monitoring.md): Track synchronization health across your Federated repositories using dashboards, REST APIs, and Open Metrics. - [Use the Federation Dashboard](https://docs.jfrog.com/artifactory/docs/federation-dashboard.md): Monitor your Federated repository health at a glance using the Federation Status dashboard. - [Monitoring Connection States](https://docs.jfrog.com/artifactory/docs/monitoring-connection-states.md): Inspect per-connection synchronization health between Federation members in real time. - [Monitoring Binaries Tasks](https://docs.jfrog.com/artifactory/docs/monitoring-binaries-tasks.md): Track binary transfer progress, failures, and lifecycle states between Federation members. - [Monitoring REST APIs](https://docs.jfrog.com/artifactory/docs/monitoring-rest-apis.md): Reference the REST API endpoints for monitoring Federation health and synchronization status. - [Open Metrics Reference](https://docs.jfrog.com/artifactory/docs/open-metrics-reference.md): Track Federation performance using RTFS and legacy Open Metrics endpoints. - [Legacy UI Monitoring](https://docs.jfrog.com/artifactory/docs/legacy-ui-monitoring.md): Monitor Federated repositories through the platform UI when running the legacy Federation service. - [How-To Guides](https://docs.jfrog.com/artifactory/docs/federation-how-tos.md): Explore step-by-step scenarios for Federated repository distribution, cleanup, and tenant migration. - [Set Up Multi-Site Artifact Distribution](https://docs.jfrog.com/artifactory/docs/how-to-set-up-multi-site-artifact-distribution.md): Distribute artifacts across geographic sites using Federated repositories and configured mirror modes. - [Configure Cleanup Policies for Federated Repositories](https://docs.jfrog.com/artifactory/docs/how-to-configure-cleanup-policies-for-federated-repositories.md): Create and run retention policies on Federated repositories while keeping members consistent. - [Migrate a Tenant with Federation](https://docs.jfrog.com/artifactory/docs/how-to-migrate-a-tenant-with-federation.md): Export and import Federation state when moving a tenant between regions using the RTFS TenantMove service. - [Migrating to RTFS](https://docs.jfrog.com/artifactory/docs/federation-migration-to-rtfs.md): Plan and execute the migration from legacy Federation to the Artifactory Federation Service (RTFS). - [Migration Overview and Decision Guide](https://docs.jfrog.com/artifactory/docs/migration-overview-and-decision-guide.md): Review the Legacy Federation sunset timeline and confirm readiness before migrating to RTFS. - [Migrate to the Artifactory Federation Service](https://docs.jfrog.com/artifactory/docs/migrate-to-the-artifactory-federation-service.md): Run the JFrog CLI migration plugin to move repository Federations from the legacy service to the standalone RTFS. - [Migration Rollback](https://docs.jfrog.com/artifactory/docs/migration-rollback.md): Revert from RTFS to the legacy Federation service using the JFrog CLI migration plugin. - [Frequently Asked Questions on Migration](https://docs.jfrog.com/artifactory/docs/frequently-asked-questions-on-migration.md): Find answers to common RTFS migration questions about rollback, hybrid mode, and auto-migration. - [Troubleshooting](https://docs.jfrog.com/artifactory/docs/troubleshooting-federated-repositories.md): Diagnose and resolve common Federation issues like out-of-sync members and replication delays. - [Federated Repositories Reference](https://docs.jfrog.com/artifactory/docs/federation-reference.md): Browse look-up tables, state machines, and API indexes for Federated repositories. - [Member State Reference](https://docs.jfrog.com/artifactory/docs/member-state-reference.md): Look up state machine diagrams and status values for Federation members. - [Synchronized Metadata Reference](https://docs.jfrog.com/artifactory/docs/synchronized-metadata-reference.md): Identify which metadata syncs between Federation members and which settings stay local. - [Federation Configuration Reference](https://docs.jfrog.com/artifactory/docs/federation-configuration-reference.md): Tune Federation thread pools, sync, events, and authentication with backend properties. - [Federation Status Dashboard Field Reference](https://docs.jfrog.com/artifactory/docs/federation-status-dashboard-field-reference.md): Look up every field and control on the Federation Status dashboard. - [Federated Repository Form Field Reference](https://docs.jfrog.com/artifactory/docs/federated-repository-form-field-reference.md): Review every field on the Federated repository creation and edit form. - [REST API Reference Index](https://docs.jfrog.com/artifactory/docs/federated-repository-rest-api-reference-index.md): Browse the categorized index of Federation REST APIs for repository management and monitoring. - [RTFS Scheduled Jobs Reference](https://docs.jfrog.com/artifactory/docs/rtfs-scheduled-jobs-reference.md): Look up background jobs RTFS runs for Federation health and event processing. - [Federation Permissions](https://docs.jfrog.com/artifactory/docs/federation-permissions.md): Identify the roles and internal scopes required for Federation operations. - [Supported Package Types](https://docs.jfrog.com/artifactory/docs/federated-repository-supported-package-types.md): Check which package types Federated repositories support and which are excluded. - [Error Reference](https://docs.jfrog.com/artifactory/docs/error-reference.md): Look up Federation exceptions, error classes, and common failure scenarios with resolutions. - [UI Navigation Reference](https://docs.jfrog.com/artifactory/docs/ui-navigation-reference.md): Find admin UI paths and URL patterns for Federated repository workflows. - [Release Bundle Repositories](https://docs.jfrog.com/artifactory/docs/release-bundle-repositories.md) - [Repository Replication](https://docs.jfrog.com/artifactory/docs/repository-replication.md) - [Repository Layouts](https://docs.jfrog.com/artifactory/docs/repository-layouts.md) - [Repository Support for Package Clients](https://docs.jfrog.com/artifactory/docs/repository-support-for-package-clients.md) - [Migration Tool](https://docs.jfrog.com/artifactory/docs/migration-tool.md) - [Artifact Management](https://docs.jfrog.com/artifactory/docs/artifact-management.md) - [JFrog Properties](https://docs.jfrog.com/artifactory/docs/jfrog-properties.md) - [Managing Artifacts](https://docs.jfrog.com/artifactory/docs/managing-artifacts.md) - [Trash Can](https://docs.jfrog.com/artifactory/docs/trash-can.md) - [Deploy Artifacts](https://docs.jfrog.com/artifactory/docs/deploy-artifacts.md) - [Filtered Resources](https://docs.jfrog.com/artifactory/docs/filtered-resources.md) - [Artifactory Query Language](https://docs.jfrog.com/artifactory/docs/artifactory-query-language.md): Search artifacts, builds, and properties in JFrog Artifactory using Artifactory Query Language (AQL). Construct cross-domain queries with filters, sorting, and pagination via a RESTful API. - [AQL Entities and Fields Reference](https://docs.jfrog.com/artifactory/docs/aql-entities-fields-reference.md): Complete field reference for all AQL domains — item, build, promotion, property, statistic, artifact, module, dependency, and release bundle fields with types and descriptions. - [AQL Examples and Common Patterns](https://docs.jfrog.com/artifactory/docs/aql-examples.md): Ready-to-use AQL query examples for JFrog Artifactory — basic searches, property filters, build queries, date/time filters, sorting, pagination, delete, and update actions. - [Performance and Operational Controls](https://docs.jfrog.com/artifactory/docs/aql-performance.md): Configure AQL result set limits, query timeouts, and rate limiting for JFrog Artifactory. Includes optimization best practices for indexing, pagination, and efficient queries. - [Query Execution and Permissions](https://docs.jfrog.com/artifactory/docs/aql-query-execution.md): Execute AQL queries via the REST API with cURL or JFrog CLI. Covers authentication methods, permission model, scoped tokens, HTTP error codes, and streaming large result sets. - [Query Output and Modifiers](https://docs.jfrog.com/artifactory/docs/aql-query-output.md): Control AQL query output with .include(), .sort(), .offset(), .limit(), and .distinct() modifiers. Learn field selection, pagination, sorting rules, and output limitations. - [Repository-Specific Queries](https://docs.jfrog.com/artifactory/docs/aql-repository-queries.md): Run AQL queries against remote and virtual repositories using .transitive(). Covers rules, limitations, include/exclude pattern behavior, and transitive search configuration. - [Search Criteria and Operators](https://docs.jfrog.com/artifactory/docs/aql-search-criteria.md): Filter AQL query results using field criteria, property criteria, comparison operators like $match and $eq, wildcards, relative time operators, and the $msp single-property matcher. - [Query Structure and Syntax](https://docs.jfrog.com/artifactory/docs/aql-syntax.md): Learn how AQL queries are structured, including domain syntax, find/delete/update methods, field references, cross-domain paths, and JSON-like syntax rules. - [Searching in Artifactory](https://docs.jfrog.com/artifactory/docs/understanding-how-to-search-for-artifacts-and-packages.md) - [Search for Artifacts (SaaS)](https://docs.jfrog.com/artifactory/docs/search-for-artifacts.md) - [Browsing Artifacts](https://docs.jfrog.com/artifactory/docs/browsing-artifacts.md) - [Platform Search](https://docs.jfrog.com/artifactory/docs/application-search.md) - [Searching for Scanned Resources](https://docs.jfrog.com/artifactory/docs/searching-for-scanned-resources.md) - [JFrog Container Registry](https://docs.jfrog.com/artifactory/docs/jfrog-container-registry.md) - [JFrog Container Registry Documentation](https://docs.jfrog.com/artifactory/docs/jfrog-container-registry-documentation.md) - [Container Registry Functionality](https://docs.jfrog.com/artifactory/docs/container-registry-functionality.md) - [Get Started: JFrog Container Registry](https://docs.jfrog.com/artifactory/docs/get-started-jfrog-container-registry.md) - [JFrog Distribution](https://docs.jfrog.com/artifactory/docs/jfrog-distribution.md) - [Configure Distribution](https://docs.jfrog.com/artifactory/docs/configure-distribution.md) - [GPG Signing](https://docs.jfrog.com/artifactory/docs/gpg-signing.md) - [Hybrid Deployment](https://docs.jfrog.com/artifactory/docs/hybrid-deployment.md) - [The Distribution Flow](https://docs.jfrog.com/artifactory/docs/the-distribution-flow.md) - [Distribute Release Bundles (v1)](https://docs.jfrog.com/artifactory/docs/distribute-release-bundles-v1.md) - [Create Release Bundles (v1)](https://docs.jfrog.com/artifactory/docs/create-release-bundles-v1.md) - [Create a Dynamic Release Bundle (v1)](https://docs.jfrog.com/artifactory/docs/create-a-dynamic-release-bundle-v1.md) - [Distribute a Release Bundle (v1)](https://docs.jfrog.com/artifactory/docs/distribute-a-release-bundle-v1.md) - [Release Bundle (v1) Tasks](https://docs.jfrog.com/artifactory/docs/release-bundle-v1-tasks.md) - [View Release Bundles on Edge Nodes](https://docs.jfrog.com/artifactory/docs/view-release-bundles-on-edge-nodes.md) - [Xray Scanning of Release Bundles (v1)](https://docs.jfrog.com/artifactory/docs/xray-scanning-of-release-bundles-v1.md) - [Release Bundle v1 REST APIs](https://docs.jfrog.com/artifactory/docs/release-bundle-v1-rest-apis.md) - [Distribution Task Maintenance](https://docs.jfrog.com/artifactory/docs/distribution-task-maintenance.md) - [Distribution Target Troubleshooting](https://docs.jfrog.com/artifactory/docs/distribution-target-troubleshooting_distribute-release-bundles-v1.md) - [Distribute Release Bundles (v1) in an Air Gap Environment](https://docs.jfrog.com/artifactory/docs/distribute-release-bundles-v1-in-an-air-gap-environment.md) - [Export and Import Release Bundles (v1) in the UI](https://docs.jfrog.com/artifactory/docs/export-and-import-release-bundles-v1-in-the-ui.md) - [Export and Import Release Bundles (v1) Using the REST API](https://docs.jfrog.com/artifactory/docs/export-and-import-release-bundles-v1-using-the-rest-api.md) - [Monitor the Distribution Service](https://docs.jfrog.com/artifactory/docs/monitor-the-distribution-service.md) - [Manage Release Bundle Retention and Cleanup](https://docs.jfrog.com/artifactory/docs/manage-release-bundle-retention-and-cleanup.md) - [Manage Release Bundle Retention Policies in the JFrog Platform UI](https://docs.jfrog.com/artifactory/docs/manage-release-bundles-in-the-jfrog-platform-ui.md) - [Release Bundle Retention Policies](https://docs.jfrog.com/artifactory/docs/release-bundle-retention-policies.md) - [Distribution CLI](https://docs.jfrog.com/artifactory/docs/distribution-through-cli.md) - [Binary Management with Artifactory](https://docs.jfrog.com/artifactory/docs/binaries-management-with-jfrog-artifactory.md) - [Artifactory Authentication](https://docs.jfrog.com/artifactory/docs/authentication.md) - [Verify Artifactory Accessibility](https://docs.jfrog.com/artifactory/docs/verifying-artifactory-s-accessibility.md) - [jf rt Output Format](https://docs.jfrog.com/artifactory/docs/jf-rt-output-format.md): Learn how to use --format json and table on jf rt commands in JFrog CLI 2.105.0 for structured JFrog Artifactory output in scripts and automation. - [Manage Generic Files in Artifactory with JFrog CLI](https://docs.jfrog.com/artifactory/docs/generic-files.md) - [Use File Specs with JFrog CLI](https://docs.jfrog.com/artifactory/docs/using-file-specs.md) - [Clean Up Unreferenced Files from a Git LFS Repository](https://docs.jfrog.com/artifactory/docs/cleaning-up-unreferenced-files-from-a-git-lfd-repository.md) - [Use Placeholders in Upload, Download, Copy, and Move Commands](https://docs.jfrog.com/artifactory/docs/search-by-vulnerability-cve.md) - [Manage configuration entities](https://docs.jfrog.com/artifactory/docs/managing-configuration-entities.md) - [Create a user in Artifactory](https://docs.jfrog.com/artifactory/docs/user-management.md) - [Create users from a CSV with jf rt users-create](https://docs.jfrog.com/artifactory/docs/jf-rt-users-create.md) - [Delete Artifactory users with jf rt users-delete](https://docs.jfrog.com/artifactory/docs/jf-rt-users-delete.md) - [Group Management](https://docs.jfrog.com/artifactory/docs/group-management.md) - [Create an Artifactory group with jf rt group-create](https://docs.jfrog.com/artifactory/docs/jf-rt-group-create.md) - [Add users to a group with jf rt group-add-users](https://docs.jfrog.com/artifactory/docs/jf-rt-group-add-users.md) - [Delete an Artifactory group with jf rt group-delete](https://docs.jfrog.com/artifactory/docs/jf-rt-group-delete.md) - [Permission targets in Artifactory](https://docs.jfrog.com/artifactory/docs/permission-targets.md) - [Generate a permission target template with jf rt permission-target-template](https://docs.jfrog.com/artifactory/docs/jf-rt-permission-target-template.md) - [Create a permission target with jf rt permission-target-create](https://docs.jfrog.com/artifactory/docs/jf-rt-permission-target-create.md) - [Update a permission target with jf rt permission-target-update](https://docs.jfrog.com/artifactory/docs/jf-rt-permission-target-update.md) - [Delete a permission target with jf rt permission-target-delete](https://docs.jfrog.com/artifactory/docs/jf-rt-permission-target-delete.md) - [Build-Info Integration](https://docs.jfrog.com/artifactory/docs/build-integration.md) - [Build Tools](https://docs.jfrog.com/artifactory/docs/build-tool-commands.md) - [Native Mode](https://docs.jfrog.com/artifactory/docs/native-mode.md) - [Connect a Build Tool to Artifactory with JFrog CLI](https://docs.jfrog.com/artifactory/docs/set-up-a-build-tool-with-jfrog-artifactory.md) - [Use Maven with JFrog CLI](https://docs.jfrog.com/artifactory/docs/jf-mvn.md) - [Use Gradle with JFrog CLI](https://docs.jfrog.com/artifactory/docs/jf-gradle.md) - [Use Yarn with JFrog CLI](https://docs.jfrog.com/artifactory/docs/jf-yarn.md) - [Use pip with JFrog CLI](https://docs.jfrog.com/artifactory/docs/jf-pip.md) - [Use Pipenv with JFrog CLI](https://docs.jfrog.com/artifactory/docs/jf-pipenv.md) - [Use Poetry with JFrog CLI](https://docs.jfrog.com/artifactory/docs/jf-poetry.md) - [Use uv with JFrog CLI](https://docs.jfrog.com/artifactory/docs/jf-uv.md) - [Publish Python Packages with Twine Using JFrog CLI](https://docs.jfrog.com/artifactory/docs/jf-twine.md) - [Use NuGet with JFrog CLI](https://docs.jfrog.com/artifactory/docs/jf-nuget.md) - [Use .NET CLI with JFrog CLI](https://docs.jfrog.com/artifactory/docs/jf-dotnet.md) - [Use Go with JFrog CLI](https://docs.jfrog.com/artifactory/docs/jf-go.md) - [Use Docker with JFrog CLI](https://docs.jfrog.com/artifactory/docs/jf-docker.md) - [Use Advanced Docker Operations with Artifactory CLI](https://docs.jfrog.com/artifactory/docs/docker-advanced-operations.md) - [Use Helm with JFrog CLI](https://docs.jfrog.com/artifactory/docs/jf-helm.md) - [Publish Terraform Modules with JFrog CLI](https://docs.jfrog.com/artifactory/docs/jf-terraform.md) - [Use Conan with JFrog CLI](https://docs.jfrog.com/artifactory/docs/jf-conan.md) - [Use Nix with JFrog CLI](https://docs.jfrog.com/artifactory/docs/jf-nix.md): Configure and run jf nix with JFrog Artifactory for Nix binary cache, channels, build-info collection, and CI publishing workflows. - [Configure Ruby and Bundler for Artifactory](https://docs.jfrog.com/artifactory/docs/jf-ruby.md) - [Use Hugging Face with Jfrog CLI](https://docs.jfrog.com/artifactory/docs/use-hugging-face-with-jfrog-cli.md) - [Use Pnpm with Jfrog CLI](https://docs.jfrog.com/artifactory/docs/use-pnpm-with-jfrog-cli.md) - [Use Npm with Jfrog CLI](https://docs.jfrog.com/artifactory/docs/use-npm-with-jfrog-cli.md) - [Use JFrog CLI Package Alias](https://docs.jfrog.com/artifactory/docs/jfrog-cli-package-alias.md): Configure JFrog CLI Package Alias to intercept docker, npm, Maven, pip, and other package managers without the jf prefix in local shells and CI pipelines. - [Skills and Agent Plugins CLI](https://docs.jfrog.com/artifactory/docs/agent-commands.md) - [JFrog CLI for Skills](https://docs.jfrog.com/artifactory/docs/jf-skills.md): Manage AI agent skills in JFrog Artifactory with the jf agent skills CLI: publish, install, search, update, list, and delete skills with full flag and environment variable reference. - [JFrog CLI for Agent Plugins](https://docs.jfrog.com/artifactory/docs/jf-agent-plugins.md): Manage agent plugins in JFrog Artifactory with jf agent plugins: publish, install, search, and delete plugins using flags and environment variables for CI and interactive workflows. - [Transfer files between Artifactory servers](https://docs.jfrog.com/artifactory/docs/transferring-files-between-artifactory-servers.md) - [Install the data-transfer plugin with jf rt transfer-plugin-install](https://docs.jfrog.com/artifactory/docs/jf-rt-transfer-plugin-install.md) - [Copy Artifactory configuration with jf rt transfer-config](https://docs.jfrog.com/artifactory/docs/jf-rt-transfer-config.md) - [Merge Artifactory configuration with jf rt transfer-config-merge](https://docs.jfrog.com/artifactory/docs/jf-rt-transfer-config-merge.md) - [Transfer artifact files with jf rt transfer-files](https://docs.jfrog.com/artifactory/docs/jf-rt-transfer-files.md) - [Supported Package Manager Versions](https://docs.jfrog.com/artifactory/docs/package-manager-compatibility-matrix.md): Package managers and versions that work with JFrog CLI. ## API Reference - [Start PUD Process](https://docs.jfrog.com/artifactory/reference/startpudprocess.md): This REST API is called to start a new PUD process, or resume a PUD process that was stopped before completion. The Pruning Unreferenced Data (PUD) APIs are used to delete randomly existing binaries in the filestore that are not referenced in Artifactory. Since: 7.72 Security: Requires an admin user. - [Get Status of the PUD Process](https://docs.jfrog.com/artifactory/reference/getpudprocessstatus.md): Get the current status of the PUD process (i.e., running, stopped, finished, or error) along with relevant data on the process such as total binaries deleted, total size of disk space cleaned, information on the last handled directory, and other information. Since: 7.72 Security: Requires an admin user. - [Stop PUD Process](https://docs.jfrog.com/artifactory/reference/stoppudprocess.md): This REST API is called to stop the PUD process. Since: 7.72 Security: Requires an admin user. - [Get Storage Item Information](https://docs.jfrog.com/artifactory/reference/getstorageitem.md): Returns different types of information about an item based on query parameters. **Query parameters are mutually exclusive** - only one operation type can be requested at a time: - list - Get file/folder listing (flat or deep). **Requires a non-anonymous privileged user.** Requires Artifactory Pro. - stats - Get file statistics (download count, last download info). Requires read privileges. - lastModified - Get last modified timestamp. **Requires a valid user with deploy permissions.** Requires Artifactory Pro. - properties - Get item properties - permissions - Get item permissions - No parameters - Get folder or file info Since: 2.2.1 (folder/file info); 2.2.4 (file list); 2.2.5 (lastModified); 3.1.0 (stats) Security: Requires a privileged user (can be anonymous) for basic folder/file/properties/permissions info. See per-operation notes above for stricter requirements. - [Set Item Properties](https://docs.jfrog.com/artifactory/reference/setitemproperties.md): Attach properties to an existing item (file, folder, repository, or Release Bundle v2). To supply special characters (comma (,), backslash(\), pipe(|), equals(=)) as a key/value you must add an encoded backslash (%5C) before them. For example: ..?properties=a=1%5C=1 will attach key a with 1=1 as value. Requires Artifactory Pro, supported by local and local-cached repositories only. Since: 2.3.0 Security: Requires a privileged user (can be anonymous) Tip: Starting with Artifactory 7.104.x, it is possible to define an upper limit on the number of artifacts on which property updates can be performed at one time. For example, if you revise a folder property and the folder contains more items than the limit defined in this system parameter, the operation will fail. This feature is useful for preventing heavy loads on the database. The limit is defined using the system parameter, artifactory.max.artifacts.set.properties.recursive. By default, this feature is off. There is no default value when turned on. - [Delete Item Properties](https://docs.jfrog.com/artifactory/reference/deleteitemproperties.md): Deletes the specified properties from an item (file, folder, or repository). Requires Artifactory Pro, supported by local and local-cached repositories only. Since: 2.3.2 Security: Requires a privileged user (can be anonymous) - [Update Item Properties](https://docs.jfrog.com/artifactory/reference/updateitemproperties.md): Attach and modify properties to an item - file, folder, or repository. Requires Artifactory Pro, supported by local and local-cached repositories only. Since: 6.1.0 Security: Requires a privileged user (Annotate authorization required) - [Set Item SHA256 Checksum](https://docs.jfrog.com/artifactory/reference/setitemsha256checksum.md): Calculates an artifact's SHA256 checksum and attaches it as a property (with key "sha256"). If the artifact is a folder, then recursively calculates the SHA256 of each item in the folder and attaches the property to each item. Since: 4.2.1 Security: Requires an admin user Note: Artifactory natively supports SHA-256 since version 5.5. This API has been maintained to provide backward compatibility for users of older Artifactory versions. - [Deploy Artifact or Create Directory](https://docs.jfrog.com/artifactory/reference/deployartifact.md): Deploy an artifact to the specified destination. **Create Directory**: Create a new directory by specifying a path that ends with `/` and omitting the request body. You can also attach properties as part of deploying artifacts or creating directories. Important: In certain cases (particularly when working with large artifacts), the Created timestamp might be later than the Last Modified timestamp. This can occur because the Last Modified timestamp records when the upload began, whereas the Created timestamp is set only when the upload is complete and committed to the database. Security: Requires a user with 'deploy' permissions (can be anonymous) - [Deploy Artifact by Checksum](https://docs.jfrog.com/artifactory/reference/deployartifactbychecksum.md): Deploy an artifact to the specified destination by checking if the artifact content already exists in Artifactory. If Artifactory already contains a user-readable artifact with the same checksum, the artifact content is copied to the new location and returns a response without requiring content transfer. Otherwise, a 404 error is returned to indicate that content upload is expected to deploy the artifact. If the X-Checksum-Deploy header is set to false, the artifact will be uploaded successfully with a 201 response, even if it didn't exist before, and submitted checksums will have the status Uploaded: Identical. You can also attach properties when deploying artifacts. Since: 2.5.1 Security: Requires a user with Deploy permissions (can be anonymous) - [Deploy Artifacts from Archive](https://docs.jfrog.com/artifactory/reference/deployartifactsfromarchive.md): Deploys an archive containing multiple artifacts and extracts it at the specified destination while maintaining the archive's file structure. Deployment is performed in a single HTTP request. Only the extracted content is deployed, not the archive file itself. By default, the deployment of artifacts is performed sequentially. However, starting from Artifactory 7.96.3, artifact deployment can be performed in multiple parallel threads using the system parameter `artifactory.explode.archive.threads`. For example, if you set `artifactory.explode.archive.threads=10`, the deployment of the artifacts contained in the archive will be performed in 10 parallel threads per archive file, which can save considerable time for large archive files. Supported archive types: zip, tar, tar.gz, tgz. Note: Requires Artifactory Pro. Deployment of compressed archives (unlike tar) may incur considerable CPU overhead. Since: 2.6.3 Security: Requires a user with 'deploy' permissions (can be anonymous) - [Retrieve Artifact](https://docs.jfrog.com/artifactory/reference/retrieveartifact.md): Returns an artifact from the specified destination. You can also use properties in deployment and resolution as part of retrieving artifacts. Special tokens for retrieving latest versions: - **Latest Maven Release/Integration**: Specify SNAPSHOT or [RELEASE] for the version in the requested path to get the latest Maven integration or release artifact. - **Latest Non-Maven Release/Integration**: Specify [INTEGRATION] and [RELEASE] for the version in the requested path (replacing [folderItegRev] and [fileItegRev], as defined by the repository's Repository Layouts) to get the latest integration version or latest release version artifact accordingly based on alphabetical sorting. Notes: - Integration and release tokens cannot be mixed together. - Only local, cache and virtual repositories will be used for latest version resolution. - To change the retrieve latest behavior to retrieve the latest version based on the created date, add `artifactory.request.searchLatestReleaseByDateCreated=true` to `artifactory.system.properties` and restart Artifactory. - Both [folderItegRev] and [fileItegRev] have to be defined in the repository layout. - Latest version resolution requires Artifactory Pro. Since: Latest Maven: 2.6.0; Latest non-Maven: 2.6.2 Security: Requires a user with 'read' permission (can be anonymous) - [Archive Entry Download](https://docs.jfrog.com/artifactory/reference/archiveentrydownload.md): Returns an archived resource from the specified archive destination. The `!` must be between the archive file name and the archive entry path, and will not work without the `/` after the `!`. Security: Requires a user with 'read' permission (can be anonymous) - [Retrieve Build Artifacts Archive](https://docs.jfrog.com/artifactory/reference/retrievebuildartifactsarchive.md): Returns an archive file (supports zip/tar/tar.gz/tgz) containing all the artifacts related to a specific build, you can optionally provide mappings to filter the results; the mappings support regexp capturing groups which enables you to dynamically construct the target path inside the result archive file. Requires Artifactory Pro. Since: 2.6.5 Security: Requires a privileged user (can be anonymous) - [Retrieve Folder or Repository Archive](https://docs.jfrog.com/artifactory/reference/retrievefolderorrepositoryarchive.md): Returns an archive file (supports zip/tar/tar.gz/tgz) containing all the artifacts that reside under the specified path (folder or repository root). Requires Enable Folder Download to be set. Requires Artifactory Pro. Since: 4.1.0 Security: Requires a privileged user with read permissions on the path. Downloading a folder or a repository's root is only supported for local (or cache) repositories. - [Artifact Sync Download](https://docs.jfrog.com/artifactory/reference/artifactsyncdownload.md): Downloads an artifact with or without returning the actual content to the client. When tracking the progress marks are printed (by default every 1024 bytes). This is extremely useful if you want to trigger downloads on a remote Artifactory server, for example to force eager cache population of large artifacts, but want to avoid the bandwidth consumption involved in transferring the artifacts to the triggering client. Notes: Requires Artifactory Pro. Since: 2.2.2 Security: Requires a privileged user (can be anonymous) - [Get RubyGem Version List](https://docs.jfrog.com/artifactory/reference/getrubygemversionlist.md): Returns the list of versions and other metadata associated with a specific Ruby gem. Since: 7.49.3 Security: Requires an authenticated user. - [Delete Item](https://docs.jfrog.com/artifactory/reference/deleteitem.md): Deletes a file or a folder from the specified local repository or remote repository cache. Security: Requires a user with 'delete' permission (can be anonymous) - [Copy Item](https://docs.jfrog.com/artifactory/reference/copyitem.md): Copy an artifact or a folder to the specified destination. Supported for local, remote and Federated repositories only. Optionally suppress cross-layout module path translation during copy. You can test the copy using a dry run. Notes: Requires Artifactory Pro. Since: 2.2.2 Security: Requires a privileged user (can be anonymous) - [Move Item](https://docs.jfrog.com/artifactory/reference/moveitem.md): Moves an artifact or a folder to the specified destination. Supported by local repositories only. Optionally suppress cross-layout module path translation during move. You can test the move using dry run. Notes: Requires Artifactory Pro. Since: 2.2.2 Security: Requires a privileged user (can be anonymous) - [Create Signed URL](https://docs.jfrog.com/artifactory/reference/createsignedurl.md): Generates a signed url for the provided repository path, providing temporary access to download artifacts. User may provide expiry or valid_for_secs optional parameter. With a maximum timeframe of one year (365 days). Default expiry is 24 hours. Note - This API is available only to Artifactory Cloud Enterprise and Cloud Enterprise+ users. The JSON included in the request URL cannot include %20. Since: Artifactory 7.5.0 Security: Requires a privileged user (admin or manage permission type) - [Replace Signed URL Key](https://docs.jfrog.com/artifactory/reference/replacesignedurlkey.md): Replaces the key for signing and validating signed URLs. This will invalidate any signed URLs previously created. Note - This feature is available only for Artifactory Cloud Enterprise and Enterprise+ users. Note: This feature is available only for Artifactory Cloud Enterprise and Enterprise+ users. Since: Artifactory 7.5.0 Security: Requires a privileged user (admin) - [Distribute Artifact](https://docs.jfrog.com/artifactory/reference/distributeartifact.md): Deploys artifacts from Artifactory to Bintray, and creates an entry in the corresponding Artifactory distribution repository specified. **Deprecation Notice:** Bintray was sunset in May 2021. This endpoint is deprecated and is replaced with the Distribution REST APIs. Requires Artifactory Pro. Since: 4.8 Security: Requires an authenticated user. - [Zap Cache](https://docs.jfrog.com/artifactory/reference/zapcache.md): Zapping cache invalidates all cached metadata artifacts downloaded from central registries like pypi.org, repo1.maven.org, registry.npmjs.org and stored in remote repo cache to speed up remote repo actions. The zapping action does not invalidate immutable artifacts (like software binaries). After Zapping, whenever an invalidated metadata artifact is needed, Artifactory refreshes it from the central registry first. If unavailable, it falls back to the stale version. Zapping the cache may slow down for clients who download packages requiring stale metadata updates. Zapping cache solves: - Resolving Cache Issues: If there are problems with the cached packages artifacts, such as corruption or inconsistencies with the central repository, zapping the cache fixes these issues. Since: 7.49.3 Security: Requires a privileged user, Manage or Delete permissions on the Remote Repository. - [Get Background Tasks](https://docs.jfrog.com/artifactory/reference/getbackgroundtasks.md): Returns list of background tasks currently scheduled or running in Artifactory. In HA, the nodeId is added to each task. Task can be in one of few states - scheduled, running, stopped, cancelled. Running task also shows the task start time. Since: 4.4.0 Security: Requires a valid admin user - [Optimize System Storage](https://docs.jfrog.com/artifactory/reference/optimizesystemstorage.md): From Artifactory Self-Hosted 4.6.0 to 7.98.x - Raises a flag to invoke balancing between redundant storage units of a shared filestore following the next full garbage collection. From Artifactory Self-Hosted 7.104.5 and later - Immediately triggers balancing between redundant storage units of a sharded filestore. If balancing is already running, the process is skipped. This is an advanced feature intended for administrators. Since: 4.6.0 Security: Requires a valid admin user. - [Get Storage Summary Info](https://docs.jfrog.com/artifactory/reference/getstoragesummaryinfo.md): Returns storage summary information regarding binaries, file store and repositories. Since: 4.2.0 Security: Requires authentication using Access Tokens, either as admin or using a scoped token with the system:info/storage:r scope. - [Refresh Storage Summary Info](https://docs.jfrog.com/artifactory/reference/refreshstoragesummaryinfo.md): Refreshes storage summary information regarding binaries, file store and repositories. Since: 6.17.0 Security: Requires a valid admin user. - [Get Artifactory Application Metrics](https://docs.jfrog.com/artifactory/reference/getartifactoryapplicationmetrics.md): Returns application-related metrics for Cloud (SaaS) users in OpenMetrics/Prometheus exposition text format (text/plain). This feature is supported on the Cloud (SaaS) platform for all licenses. Security: Requires a valid admin user. - [Get the Open Metrics for Artifactory](https://docs.jfrog.com/artifactory/reference/getopenmetricsforartifactory.md): Returns the open metrics collected for Artifactory. This feature is supported on the Self-Managed platform, with a Pro, Pro X, Enterprise X, or Enterprise+ license. Security: Requires an admin user. - [Get Puppet Modules](https://docs.jfrog.com/artifactory/reference/getpuppetmodules.md): Returns a list of all Puppet modules hosted by the specified repository. Results are paginated. - [Get Puppet Module Info](https://docs.jfrog.com/artifactory/reference/getpuppetmoduleinfo.md): Returns information about a specific Puppet module. - [Get Puppet Releases](https://docs.jfrog.com/artifactory/reference/getpuppetreleases.md): Returns a list of all Puppet releases hosted by the specified repository. Results are paginated. - [Get Puppet Release Info](https://docs.jfrog.com/artifactory/reference/getpuppetreleaseinfo.md): Returns information about the specific Puppet module's release. - [Get VCS Tags](https://docs.jfrog.com/artifactory/reference/getvcstags.md): Lists all VCS tags in a specific repository or subgroup repository. - [Get VCS Branches](https://docs.jfrog.com/artifactory/reference/getvcsbranches.md): Lists all VCS branches in a specific repository or subgroup repository. - [Get VCS Refs](https://docs.jfrog.com/artifactory/reference/getvcsrefs.md): Downloads a VCS Git References file. - [Download a VCS Tag](https://docs.jfrog.com/artifactory/reference/downloadvcstag.md): Download a complete tarball (tar.gz/zip) of a tag. Downloading can be executed conditionally according to properties by specifying the properties query param. - [Download a VCS Tag (Alternative Format)](https://docs.jfrog.com/artifactory/reference/downloadvcstagalternative.md): Download a complete tarball (tar.gz/zip) of a tag using userOrg as the repository. - [Download File within a VCS Tag](https://docs.jfrog.com/artifactory/reference/downloadfilewithinvcstag.md): Download a specific file from within a tag. - [Download File within a VCS Tag (Alternative Format)](https://docs.jfrog.com/artifactory/reference/downloadfilewithinvcstagalternative.md): Download a specific file from within a tag using userOrg as the repository. - [Download a VCS Branch](https://docs.jfrog.com/artifactory/reference/downloadvcsbranch.md): Downloads a tarball (tar.gz/zip) of a complete branch. Downloading can be executed conditionally according to properties by specifying the properties query param. - [Download a VCS Branch (Alternative Format)](https://docs.jfrog.com/artifactory/reference/downloadvcsbranchalternative.md): Downloads a tarball (tar.gz/zip) of a complete branch using userOrg as the repository. - [Download a VCS Commit](https://docs.jfrog.com/artifactory/reference/downloadvcscommit.md): Downloads a tarball (tar.gz/zip, default tar.gz) of a complete commit. - [Download File within a VCS Branch](https://docs.jfrog.com/artifactory/reference/downloadfilewithinvcsbranch.md): Downloads a specific file from within a branch. - [Download File within a VCS Branch (Alternative Format)](https://docs.jfrog.com/artifactory/reference/downloadfilewithinvcsbranchalternative.md): Downloads a specific file from within a branch using userOrg as the repository. - [Download a VCS Release](https://docs.jfrog.com/artifactory/reference/downloadvcsrelease.md): Downloads a complete release tarball (tar.gz/zip, default tar.gz) of a tag from GitHub. - [Download a File in a VCS Branch in a Subgroup Repository](https://docs.jfrog.com/artifactory/reference/downloadfileinvcsbranchinsubgrouprepository.md): Downloads a specific file that is in a VCS branch in a subgroup repository. - [Download a File in a VCS Tag in a Subgroup Repository](https://docs.jfrog.com/artifactory/reference/downloadfileinvcstaginsubgrouprepository.md): Downloads a specific file that is in a VCS tag in a subgroup repository. - [Download a VCS Branch from a Subgroup Repository](https://docs.jfrog.com/artifactory/reference/downloadvcsbranchfromsubgrouprepository.md): Downloads a tarball (tar.gz/zip, default tar.gz) of a complete branch from a subgroup repository. Downloading can be executed conditionally according to properties by specifying the properties query param. - [Download a VCS Tag from a Subgroup Repository](https://docs.jfrog.com/artifactory/reference/downloadvcstagfromsubgrouprepository.md): Download a complete tarball (tar.gz/zip) of a tag in a subgroup repository. Downloading can be executed conditionally according to properties by specifying the properties query parameter. - [Calculate Alpine Repository Metadata](https://docs.jfrog.com/artifactory/reference/calculatealpinerepositorymetadata.md): Calculates/recalculates the metadata index for this repository, based on the Alpine packages in it. Calculation is asynchronous. Supported by local repositories only. - [Calculate CocoaPods Index](https://docs.jfrog.com/artifactory/reference/calculatecocoapodsindex.md): Calculates a CocoaPods index for the specified repository. - [Calculate YUM Repository Metadata](https://docs.jfrog.com/artifactory/reference/calculateyumrepositorymetadata.md): For Local repositories calculates/recalculates the YUM metadata for this repository, based on the RPM package currently hosted in the repository. Supported by local, virtual, and Federated repositories. Calculation can be synchronous (the default) or asynchronous. - [Calculate NuGet Repository Metadata](https://docs.jfrog.com/artifactory/reference/calculatenugetrepositorymetadata.md): Recalculates all the NuGet packages for this repository (local/cache/virtual), and re-annotate the NuGet properties for each NuGet package according to its internal nuspec file. Supported by local, local-cache, remote and virtual repositories. - [Calculate Npm Repository Metadata](https://docs.jfrog.com/artifactory/reference/calculatenpmrepositorymetadata.md): Recalculates the npm packages indexes for this repository. Supported by local repositories. - [Calculate Maven Index](https://docs.jfrog.com/artifactory/reference/calculatemavenindex.md): Calculates/caches a Maven index for the specified repositories. For a virtual repository specify all underlying repositories that you want the aggregated index to include. - [Calculate Maven Metadata](https://docs.jfrog.com/artifactory/reference/calculatemavenmetadata.md): Calculates Maven metadata on the specified path (for local repositories only). A POM file must exist in the repository for the calculation to succeed. - [Generate Maven POM File](https://docs.jfrog.com/artifactory/reference/generatemavenpomfile.md): Generates a Maven POM file from an internal Jar or a default POM file. - [Calculate PyPI Repository Metadata](https://docs.jfrog.com/artifactory/reference/calculatepypirepositorymetadata.md): Calculates/recalculates the PyPI packages and repository indexes from the artifact metadata in this repository. The calculation can be synchronous (the default) or asynchronous. Supported for local repositories only. - [Get PyPI Latest Package Version Metadata in JSON](https://docs.jfrog.com/artifactory/reference/getpypilatestpackageversionmetadatainjson.md): Retrieves metadata in JSON format for the latest PyPI package version. - [Get PyPI Package Version Metadata in JSON](https://docs.jfrog.com/artifactory/reference/getpypipackageversionmetadatainjson.md): Retrieves metadata in JSON format for a specific PyPI package version. - [Calculate Debian Repository Metadata](https://docs.jfrog.com/artifactory/reference/calculatedebianrepositorymetadata.md): Calculates/recalculates the Packages and Release metadata for this repository, based on the Debian packages in it. Calculation can be synchronous (the default) or asynchronous. Supported by local repositories only. - [Calculate Cached Remote Debian Repository Coordinates](https://docs.jfrog.com/artifactory/reference/calculatecachedremotedebianrepositorycoordinates.md): Calculates/recalculates the Debian packages coordinates. Supported by remote-cache repositories only. - [Create Debian Snapshot](https://docs.jfrog.com/artifactory/reference/createdebiansnapshot.md): Creates Debian Snapshots in the Debian repository in Artifactory. - [Calculate Opkg Repository Metadata](https://docs.jfrog.com/artifactory/reference/calculateopkgrepositorymetadata.md): Calculates/recalculates the Packages and Release metadata for this repository, based on the ipk packages in it (in each feed location). Calculation can be synchronous (the default) or asynchronous. Supported by local repositories only. - [Calculate Bower Index](https://docs.jfrog.com/artifactory/reference/calculatebowerindex.md): Recalculates the index for a Bower repository. - [Calculate Helm Chart Index](https://docs.jfrog.com/artifactory/reference/calculatehelmchartindex.md): Calculates Helm chart index on the specified path (local and Federated repositories only). - [Helm Charts Partial Re-Indexing](https://docs.jfrog.com/artifactory/reference/helmchartspartialreindexing.md): Recalculates partial indexing for the helm repository. - [Calculate CRAN Repository Metadata](https://docs.jfrog.com/artifactory/reference/calculatecranrepositorymetadata.md): Calculates/recalculates the Packages and Release metadata for this repository, based on the CRAN packages in it. The calculation can be synchronous (the default) or asynchronous. Supported by local repositories only. - [Move CRAN Archives](https://docs.jfrog.com/artifactory/reference/movecranarchives.md): Moves the existing archives from the wrong location to the correct location (if the system property is enabled). - [Calculate Cargo Repository Metadata](https://docs.jfrog.com/artifactory/reference/calculatecargorepositorymetadata.md): Calculates/recalculates the Cargo packages and release metadata for this repository. The calculation can be synchronous (the default) or asynchronous. Supported for local and remote repositories. - [Calculate Conda Repository Metadata](https://docs.jfrog.com/artifactory/reference/calculatecondarepositorymetadata.md): Calculates/recalculates the Conda packages and release metadata for this repository. The calculation can be synchronous (the default) or asynchronous. Supported for local repositories only. - [Calculate Conan Repository Metadata](https://docs.jfrog.com/artifactory/reference/calculateconanrepositorymetadata.md): Calculates/recalculates the Conan packages and release metadata for this repository. The calculation can be synchronous (the default) or asynchronous. Supported for local repositories only. - [Calculate Pub Repository Metadata](https://docs.jfrog.com/artifactory/reference/calculatepubrepositorymetadata.md): Calculates/recalculates the Dart/Flutter packages and release metadata for this repository. The calculation is asynchronous. Supported for local and remote repositories. - [Calculate RubyGems Index](https://docs.jfrog.com/artifactory/reference/calculaterubygemsindex.md): Calculates RubyGems index on the specified path. - [Calculate Swift Index](https://docs.jfrog.com/artifactory/reference/calculateswiftindex.md): Calculates a Swift index for the specified repository. - [Calculate Terraform Index](https://docs.jfrog.com/artifactory/reference/calculateterraformindex.md): Calculates Terraform Modules or Providers index for the specified repository. - [Create Repository](https://docs.jfrog.com/artifactory/reference/createrepository.md): Creates a new repository in Artifactory with the provided configuration. Supported by local, remote, virtual, and Federated repositories. **Since:** 2.3.0 **Supported JFrog Subscriptions:** Local, remote, and virtual repositories require a Pro subscription. Federated repositories are supported from Artifactory 7.18.3 and require an Enterprise X or Enterprise+ subscription. If a repository with the specified repoKey already exists, the call fails with a 400 response. Missing values are set to default values as defined by the consumed type spec. For a Smart Remote Repository, set the `enabled` flag to true under `contentSynchronisation`. To enable CDN Distribution, set the `cdnRedirect` flag; this applies to Artifactory Cloud and requires an Enterprise or Enterprise+ license. **Security:** Requires an admin user. Additional examples of repository configuration can be found at: https://docs.jfrog.com/integrations/docs/configuration-json-files#repository-configuration-json - [Get Repository Configuration](https://docs.jfrog.com/artifactory/reference/getrepositoryconfiguration.md): Returns the current configuration of a repository. Supported by local, remote, virtual, and Federated repositories. **Since:** 2.3.0 **Supported JFrog subscriptions:** Local, remote, and virtual repositories require a Pro subscription. Federated repositories are supported from Artifactory 7.18.3 and require an Enterprise X or Enterprise+ subscription. **Security:** Requires an admin user for complete repository configuration. Non-admin users receive only partial configuration data. **Produces:** `application/json` and package-specific `application/vnd.org.jfrog.artifactory.repositories.*+json` types depending on repository class. **Tip:** This API returns a complete list of configuration properties, including properties unrelated to the repository's package type. Use the v2 version of this API to return only those properties that are relevant to the package type. Additional examples of repository configuration can be found at: https://docs.jfrog.com/integrations/docs/configuration-json-files#repository-configuration-json - [Update Repository Configuration](https://docs.jfrog.com/artifactory/reference/updaterepositoryconfiguration.md): Updates an existing repository configuration in Artifactory with the provided configuration elements. Supported by local, remote, virtual, and Federated repositories. **Since:** 2.3.0 **Supported JFrog Subscriptions:** Local, remote, and virtual repositories require a Pro subscription. Federated repositories are supported from Artifactory 7.18.3 and require an Enterprise or Enterprise+ subscription. The class of a repository (`rclass`) cannot be updated. To enable CDN Distribution, set the `cdnRedirect` flag; applies to Artifactory Cloud and requires an Enterprise or Enterprise+ license. **Security:** Requires an admin user. Additional examples of repository configuration can be found at: https://docs.jfrog.com/integrations/docs/configuration-json-files#repository-configuration-json - [Delete Repository](https://docs.jfrog.com/artifactory/reference/deleterepository.md): Removes a repository configuration together with the whole repository content. Supported by local, remote, virtual and federated repositories. **Since:** 2.3.0 **Supported JFrog Subscriptions:** Local, remote, and virtual repositories require a Pro subscription. Federated repositories are supported from Artifactory 7.18.3 and require an Enterprise X or Enterprise+ subscription. **Security:** Requires an admin user. **Produces:** `application/text` (plain-text confirmation body per handbook). - [Get Repository Configuration (v2)](https://docs.jfrog.com/artifactory/reference/getrepositoryconfigurationv2.md): Returns the current configuration of a repository, providing only those fields that are relevant to the package type. Supported by local, remote, virtual, and Federated repositories. **Since:** 6.12.0 **Supported JFrog subscriptions:** Local, remote, and virtual repositories require a Pro subscription. Federated repositories are supported from Artifactory 7.18.3 and require an Enterprise X or Enterprise+ subscription. **Security:** Requires an admin user for complete repository configuration. Non-admin users receive only partial configuration data. - [Create Multiple Repositories](https://docs.jfrog.com/artifactory/reference/createmultiplerepositories.md): Creates multiple repositories using a batch request. The batch request can contain a mix of different package types and repository types. **Since:** 7.84.3 For additional details and restrictions, see Create Repository. **Warning:** When creating multiple repositories using a batch request, if one of the repository configurations is invalid, **the entire batch request will fail**. **Security:** Requires an admin user. - [Get Batch of Repositories by Name](https://docs.jfrog.com/artifactory/reference/getbatchofrepositoriesbyname.md): Returns a batch of repositories defined by name. The default batch size is 100 items (configurable). **Since:** 7.84.3 **Security:** Requires an admin user for complete repository configuration. Non-admin users receive only partial configuration data. - [Update Multiple Repositories](https://docs.jfrog.com/artifactory/reference/updatemultiplerepositories.md): Updates the configuration of multiple repositories using a batch request. The batch request can contain a mix of different package types and repository types. **Since:** 7.104.2 For additional details and restrictions, see Create Repository. **Warning:** When updating multiple repositories using a batch request, if one of the repository configurations is invalid, **the entire batch request will fail**. **Security:** Requires an admin user. - [Get Repositories by Type and Project](https://docs.jfrog.com/artifactory/reference/getrepositoriesbytypeandproject.md): Returns a list of minimal repository details for all repositories of the specified type. Filter the results using `type` (repository type), `packageType`, and `project`; each query segment is optional per the usage URL (you may omit filters to list broadly). **Since:** 2.2.0 (`packageType` option introduced in 6.2.0) **Note:** Federated repositories are supported from Artifactory 7.18.3 and require an Enterprise X or Enterprise+ subscription. **Security:** Requires a privileged user (can be anonymous). **Produces:** `application/json` and `application/vnd.org.jfrog.artifactory.repositories.RepositoryDetailsList+json` (handbook lists this vendor list form alongside JSON). - [Check If Repository Exists](https://docs.jfrog.com/artifactory/reference/checkifrepositoryexists.md): Checks if repositories exist that match the repository types and the project key specified in the query parameters. **Since:** Artifactory 7.103.0 **Security:** Requires an admin user. - [Get All Repository Configurations](https://docs.jfrog.com/artifactory/reference/getallrepositoryconfigurations.md): Returns a list of all repository configurations. **Since:** 7.61.3 **Security:** Requires a user with admin permissions. **Produces:** `application/json` and `application/vnd.org.jfrog.artifactory.repositories.RepositoryConfigurationsList+json`. Optional query parameters `packageType` and `repoType` are not described in the handbook subsection for this endpoint; they are retained for clients that rely on them. - [Remote Repository Configuration (Deprecated)](https://docs.jfrog.com/artifactory/reference/getremoterepositoryconfiguration.md): Returns the shared configuration of a remote repository. **Since:** 2.2.0 **Note:** This API is deprecated. Use Get Repository Configuration instead. **Security:** Requires a valid user for a shared remote repository and an admin user for anything else. Shared remote repository data is sanitized for security when a non-admin user is used. **Produces:** `application/json` and `application/vnd.org.jfrog.artifactory.repositories.SharedRemoteRepositoryConfiguration+json`. - [Convert Local Repository to a Federated Repository](https://docs.jfrog.com/artifactory/reference/convertlocalrepositorytofederated.md): Converts the local repository to a Federated repository. When working inside a specific project, the Federated repositories that comprise the Federation must all share the same project key. - [Convert Federated Repository to a Local Repository](https://docs.jfrog.com/artifactory/reference/convertfederatedrepositorytolocal.md): Converts the specified Federated repository to a local repository. The conversion from Federated back to local is allowed only if the Federated repository is not part of an active Federation containing additional members. - [Get List of Inconsistent Federated Repositories](https://docs.jfrog.com/artifactory/reference/getlistofinconsistentfederatedrepositories.md): Returns a list of Federated repositories in your local Artifactory instance that have a configuration mismatch with one or more remote members. - [Federation Recovery](https://docs.jfrog.com/artifactory/reference/federationrecovery.md): Activates the recovery mechanism on the Federation or the specified Federated repository. The recovery mechanism clears errors in exhausted queues so that additional attempts can be made to send events to all remote Federation members. - [Reconnect to Federation Client](https://docs.jfrog.com/artifactory/reference/reconnecttofederationclient.md): If Artifactory cannot connect to the Artifactory Federation service automatically during startup, use this endpoint to reconnect the service manually. - [Federated Repository Full Sync](https://docs.jfrog.com/artifactory/reference/federatedrepositoryfullsync.md): Runs a full synchronization between the Federated repository members. Starting with Artifactory 7.104.2, there is an option to use the Federation Comparison tool, which uses the isDry query parameter to generate a JSON file listing the binaries requiring synchronization without carrying out the operation. - [Federated Repository Force Full Sync](https://docs.jfrog.com/artifactory/reference/federatedrepositoryforcefullsync.md): Forces a full synchronization between the Federated repository members, interrupting another Full Sync operation that is already in progress. This can be used if the Full Sync operation in progress has become stuck. - [Propagate Creation Time Metadata during Full Sync](https://docs.jfrog.com/artifactory/reference/propagatecreationtimemetadataduringfullsync.md): Enables the propagation of artifact creation time metadata during Full Sync operations. This endpoint is relevant when using the Artifactory Federation Service (RTFS). - [Synchronize Federated Member Configuration](https://docs.jfrog.com/artifactory/reference/synchronizefederatedmemberconfiguration.md): Synchronizes the configuration of a federated member in case of a network malfunction. - [Remove Federation Member](https://docs.jfrog.com/artifactory/reference/removefederationmember.md): Removes the member from all the Federations with which it was associated. This API requires the installation of the Artifactory Federation Service. - [Get Federation Connection Details](https://docs.jfrog.com/artifactory/reference/getfederationconnectiondetails.md): Returns the connection status of a Federated repository with other members of its Federation. This status indicates whether metadata events are being synchronized promptly between each source and each target within the Federation. - [Get Federation State Details](https://docs.jfrog.com/artifactory/reference/getfederationstatedetails.md): Returns the current state of each repository Federation configured on your JPD. - [Get Federation State Summaries](https://docs.jfrog.com/artifactory/reference/getfederationstatesummaries.md): Returns the number of Federation members that are currently in each of the following states - HEALTHY, NOT_AVAILABLE, DELAYED, PENDING_FS, FULL_SYNC_RUNNING, ERROR, DISABLED - [Prioritize Federated Repository](https://docs.jfrog.com/artifactory/reference/prioritizefederatedrepository.md): Determines whether the queue of the specified Federated repository has priority access to system resources. Prioritizing the repository helps ensure timely synchronization of its events with other members of the Federation. There can be a maximum of 10 prioritized Federated repositories at any one time on the JPD. - [Get Federated Repository Status](https://docs.jfrog.com/artifactory/reference/getfederatedrepositorystatus.md): Returns the synchronization status of the Federation for a specific repository. This API is not supported by the standalone Artifactory Federation service that was released in version 7.104.2. This API has a high impact on the database and should be used with care. - [Get Federated Repository Status (v2)](https://docs.jfrog.com/artifactory/reference/getfederatedrepositorystatusv2.md): Returns the synchronization status of the Federation for a specific repository. This is the v2 version of the endpoint, which was released to offer a wider range of possible member statuses. This API is not supported by the standalone Artifactory Federation service that was released in version 7.104.2. This API greatly impacts the database and should be used with care. - [Get Federation Sync State](https://docs.jfrog.com/artifactory/reference/getfederationsyncstate.md): Returns the synchronization state of all Federated repositories in the JPD. This API is not supported by the standalone Artifactory Federation service that was released in version 7.104.2. - [Get Federation Mirror Lag Time](https://docs.jfrog.com/artifactory/reference/getfederationmirrorlagtime.md): Returns the elapsed time since the last event that was not handled on each Federation mirror for all repositories. This API is not supported by the standalone Artifactory Federation service that was released in version 7.104.2. - [Get Unavailable Mirrors](https://docs.jfrog.com/artifactory/reference/getunavailablemirrors.md): Gets a list of unsynchronized Federated mirrors from all repositories. Mirrors are unsynchronized when they are first added to the federation, during repository migration from local to Federated, and when a certain error threshold is crossed. This API is not supported by the standalone Artifactory Federation service that was released in version 7.104.2. - [Get List of Failed Binary Tasks](https://docs.jfrog.com/artifactory/reference/getlistoffailedbinarytasks.md): Returns a list of tasks that failed because Artifactory was not able to retrieve the binary of the task. The number of attempts that Artifactory tries to retrieve the binary of the task is set by maximum, which is 10 by default. - [Replay Failed Binary Tasks](https://docs.jfrog.com/artifactory/reference/replayfailedbinarytasks.md): This API marks binary tasks that previously failed to be processed again. This can be done for the entire repository or for a particular binary task in the repository. - [Delete Failed Binary Tasks](https://docs.jfrog.com/artifactory/reference/deletefailedbinarytasks.md): This API deletes binary tasks that previously failed. This can be done for the entire repository or for a particular binary task in the repository. - [Generate Pairing Token](https://docs.jfrog.com/artifactory/reference/generatepairingtoken.md): Creates a pairing token for the specified use case (e.g., federated-repo/r for read-only unidirectional sync). - [Exchange Pairing Token](https://docs.jfrog.com/artifactory/reference/exchangepairingtoken.md): Exchanges a pairing token to establish trust between services. - [Unregister Pairing Token](https://docs.jfrog.com/artifactory/reference/unregisterpairingtoken.md): Cancels the trust relationship with a specific service. - [Get Repository Replication Configuration](https://docs.jfrog.com/artifactory/reference/getrepositoryreplicationconfiguration.md): Returns the replication configuration for the given repository key, if found. Supported by local and remote repositories - [Set Repository Replication Configuration](https://docs.jfrog.com/artifactory/reference/setrepositoryreplicationconfiguration.md): Add or replace replication configuration for given repository key. Supported by local and remote repositories. Accepts the JSON payload returned from Get Repository Replication Configuration for a single and an array of configurations. If the payload is an array of replication configurations, then values for cronExp and enableEventReplication in the first element in the array will determine the corresponding values when setting the repository replication configuration. Requires Artifactory Pro. - [Update Repository Replication Configuration](https://docs.jfrog.com/artifactory/reference/updaterepositoryreplicationconfiguration.md): Update existing replication configuration for given repository key, if found. Supported by local and remote repositories. Requires Artifactory Pro - [Delete Repository Replication Configuration](https://docs.jfrog.com/artifactory/reference/deleterepositoryreplicationconfiguration.md): Delete existing replication configuration for given repository key. Supported by local and local-cached repositories. Requires Artifactory Pro. - [Get Replication Status](https://docs.jfrog.com/artifactory/reference/getreplicationstatus.md): Returns the replication status for the specified repository path. Returns status based on replication properties annotated on the artifact. Supported by local, local-cached, and remote repositories. Requires Artifactory Pro. - [Pull/Push Replication](https://docs.jfrog.com/artifactory/reference/executepullpushreplication.md): Schedules immediate content replication between two Artifactory instances. Replication can optionally include properties and delete items if they do not exist in the source repository. Pull Replication - pulls content from a remote Artifactory repository to a local cache of the remote repository. Push Replication - pushes content from a local repository into a local repository of another Artifactory instance. Multi-push Replication - pushes content from a local repository into a local repository of several Artifactory instances (Enterprise only). The type of replication initiated depends on the type of repository specified in the repoPath parameter. If repoPath is a local repository, a push replication will be triggered. If repoPath is a remote repository cache, a pull replication will be triggered. If no repositories are provided in the payload, Artifactory will trigger all existing replication configurations. - [Create or Replace Local Multi-push Replication](https://docs.jfrog.com/artifactory/reference/createorreplacemultipushreplication.md): Creates or replaces a local multi-push replication configuration. Supported by local repositories. Requires an enterprise license - [Update Local Multi-push Replication](https://docs.jfrog.com/artifactory/reference/updatemultipushreplication.md): Updates a local multi-push replication configuration. Supported by local repositories. Requires an enterprise license. - [Enable or Disable Multiple Replications](https://docs.jfrog.com/artifactory/reference/enableordisablemultiplereplications.md): Enables/disables multiple replication tasks by repository or Artifactory server based on include and exclude patterns where include and exclude patterns should be target repository URLs. Requires Artifactory Pro. - [Get Remote Repositories Registered for Replication](https://docs.jfrog.com/artifactory/reference/getremoterepositoriesregisteredforreplication.md): This endpoint, which is run against a local repository, returns a list of all the instances subscribed for event-based pull replication by a remote repository. Requires Artifactory Pro. - [Close all event based pull replication subscribed channels](https://docs.jfrog.com/artifactory/reference/closeeventbasedpullreplicationchannels.md): Close the connection of all the event based pull replication instances subscribed to this Artifactory, which force them to try to reopen connection. Requires Artifactory Pro. - [[Internal] Establish event-based pull replication channel](https://docs.jfrog.com/artifactory/reference/establishreplicationchannel.md): Opens a long-lived event stream between two Artifactory instances for event-based pull replication. Internal peer-to-peer endpoint. Requires authenticated credentials. - [[Internal] Tear down event-based pull replication channel](https://docs.jfrog.com/artifactory/reference/removereplicationchannel.md): Closes a previously established replication channel between peers. Internal peer-to-peer endpoint. Requires authenticated credentials. - [[Internal] Propagate replication events](https://docs.jfrog.com/artifactory/reference/propagatereplicationevents.md): Receives replication events propagated from a peer Artifactory instance. Internal peer-to-peer endpoint. Requires authenticated credentials. - [Get Global System Replication Configuration](https://docs.jfrog.com/artifactory/reference/getglobalsystemreplicationconfiguration.md): Returns the global system replication configuration status, i.e. if push and pull replications are blocked or unblocked. Requires Artifactory Pro. - [Block System Replication](https://docs.jfrog.com/artifactory/reference/blocksystemreplication.md): Blocks replications globally. Push and pull are true by default. If false, replication for the corresponding type is not blocked. Requires Artifactory Pro. - [Unblock System Replication](https://docs.jfrog.com/artifactory/reference/unblocksystemreplication.md): Unblocks replications globally. Push and pull are true by default. If false, replication for the corresponding type is not unblocked. Requires Artifactory Pro. - [Configure Checksum Replication](https://docs.jfrog.com/artifactory/reference/configurechecksumreplication.md): Configures metadata replication of artifacts between the source Artifactory and target Artifactory while artifact replication is done with storage-level replication. The API can also set the number of days to trust the replication, which allows the transfer for a limited number of days. Allows the usage of the checkBinaryExistenceInFilestore flag in the Pull/Push Replication API on the source Artifactory. This feature is available for customers in Self-Hosted environments. - [Get Checksum Replication](https://docs.jfrog.com/artifactory/reference/getchecksumreplication.md): Gets the checksum replication status on the target Artifactory. The API returns the replication status and the date until which the trust expires. This REST API is supported on Self-Hosted platforms only. - [Artifactory Query Language (AQL)](https://docs.jfrog.com/artifactory/reference/searchaql.md): Flexible and high performance search using Artifactory Query Language.For information on limiting the maximum number of AQL search results, see[AQL documentation](/artifactory/docs/artifactory-query-language).**Since:** 3.5.0**Security:** Requires an authenticated user. Certain domains/queries may require Admin access. - [Artifact Search (Quick Search)](https://docs.jfrog.com/artifactory/reference/searchartifact.md): Artifact search by part of file name. Searches return file info URIs. Can limit search to specific repositories (local or caches). > **Note:** The search must be performed on the actual source repository (local or remote). Virtual repositories are not supported. **Since:** 2.2.0 **Security:** Requires a privileged user (can be anonymous) - [Archive Entries Search (Class Search)](https://docs.jfrog.com/artifactory/reference/searcharchive.md): Search archive for classes or any other resources within an archive. Can limit search to specific repositories (local or caches). > **Deprecation Notice:** This API is deprecated and is scheduled for removal in a future version of Artifactory. We strongly recommend using Artifactory Query Language (AQL) for all new development. **Since:** 2.2.0 **Security:** Requires a privileged user (can be anonymous) - [GAVC Search](https://docs.jfrog.com/artifactory/reference/searchgavc.md): Search by Maven coordinates: GroupId, ArtifactId, Version & Classifier. The search must contain at least one argument. The search can be limited to specific repositories (local and remote-cache). > **Note:** This endpoint requires a repository type or layout that supports GAVC, including Maven, Gradle, Ivy, and SBT. > **Important:** The exact GroupId and ArtifactId must be provided to search remote repositories. **Since:** 2.2.0 **Security:** Requires a privileged user (can be anonymous) - [Property Search](https://docs.jfrog.com/artifactory/reference/searchproperty.md): Search by properties. If no value is specified for a property — assume `*`. Can limit search to specific repositories (local, remote-cache or virtual). Property key-value pairs are passed as **arbitrary query parameters** (not fixed names). For example: `GET /api/search/prop?build.name=my-build&build.number=1&repos=libs-release-local` The parameter names are the property keys; the values are comma-separated property values. **Since:** 2.2.0 **Security:** Requires a privileged user (can be anonymous) - [Checksum Search](https://docs.jfrog.com/artifactory/reference/searchchecksum.md): Artifact search by checksum (md5, sha1, or sha256). Searches return file info URIs. Can limit search to specific repositories (local, remote-cache or virtual). **Product:** Requires Artifactory Pro **Since:** 2.3.0 **Security:** Requires a privileged user (can be anonymous) - [Bad Checksum Search](https://docs.jfrog.com/artifactory/reference/searchbadchecksum.md): Find all artifacts that have bad or missing client checksum values (md5 or sha1). Searches return file info URIs. Can limit the search to specific repositories (local, remote-cache, or virtual). > **Important:** The response is limited to a maximum of 10,000 results. **Product:** Requires Artifactory Pro or higher **Since:** 2.3.4 **Security:** Requires a privileged user (can be anonymous) - [Artifacts Not Downloaded Since](https://docs.jfrog.com/artifactory/reference/searchusage.md): Returns all artifacts not downloaded since the specified Java epoch in milliseconds. Optionally include only artifacts created before the specified `createdBefore` date, otherwise only artifacts created before `notUsedSince` are returned. Can limit search to specific repositories (local or caches). **Since:** 2.2.4 **Security:** Requires a privileged non-anonymous user - [Artifacts With Date in Date Range](https://docs.jfrog.com/artifactory/reference/searchdates.md): Get all artifacts with specified dates within the given range. Search can be limited to specific repositories (local or caches). The `dateFields` parameter dictates which fields will be added to the JSON returned. If any of the specified date fields of an artifact is within the specified range, the artifact will be returned. **Since:** 3.2.1 **Security:** Requires a privileged non-anonymous user - [Artifacts Created in Date Range](https://docs.jfrog.com/artifactory/reference/searchcreation.md): Get All Artifacts Created in Date Range. If `to` is not specified, use `now()`. Can limit search to specific repositories (local or remote-cache). **Since:** 2.2.0 **Security:** Requires a privileged non-anonymous user - [Pattern Search](https://docs.jfrog.com/artifactory/reference/searchpattern.md): Get all artifacts matching the given Ant path pattern. Pattern `**` is not supported to avoid overloading search results. **Product:** Requires Artifactory Pro **Since:** 2.2.4 **Security:** Requires a privileged non-anonymous user - [Builds for Dependency](https://docs.jfrog.com/artifactory/reference/searchdependency.md): Find all the builds an artifact is a dependency of (where the artifact is included in the build-info dependencies). **Product:** Requires Artifactory Pro **Since:** 2.3.4 **Security:** Requires a privileged user (can be anonymous) - [License Search](https://docs.jfrog.com/artifactory/reference/searchlicense.md): Search for artifacts that were already tagged with license information and their respective licenses. To search by specific license values use Property Search with the `artifactory.licenses` property. When the `autofind` parameter is specified Artifactory will try to automatically find new license information and return it as part of the result in the `found` field. Please note that this can affect the speed of the search quite dramatically, and will still search only on already-tagged artifacts. Default parameter values when unspecified: `unapproved=1`, `unknown=1`, `notfound=0`, `neutral=0`, `approved=0`, `autofind=0`. Can limit search to specific repositories (local, remote-cache or virtual). **Product:** Requires Artifactory Pro **Since:** 2.3.0 **Security:** Requires an admin user - [Artifact Version Search](https://docs.jfrog.com/artifactory/reference/searchversions.md): Search for all available artifact versions by GroupId and ArtifactId in local, remote or virtual repositories. Search can be limited to specific repositories (local, remote and virtual) by settings the `repos` parameter. **Release/integration versions:** Unless the `version` parameter is specified, both release and integration versions are returned. When version is specified, e.g. `1.0-SNAPSHOT`, result includes only integration versions. **Remote searches:** By default only local and cache repositories are used. When specifying `remote=1`, Artifactory searches for versions on remote repositories. NOTE: this can dramatically slow down the search. For Maven repositories the remote maven-metadata.xml is consulted. For non-Maven layouts, remote file listing runs for all remote repositories that have the 'List Remote Folder Items' checkbox enabled. Integration versions are determined by the Repository Layouts of the repositories searched. For the integration search to work the repository layout requires an 'Artifact Path Pattern' that contains the baseRev token and then the fileItegRev token with only literals between them. **Filtering results (Artifactory 3.0.2+):** The `version` parameter can accept the `*` and/or `?` wildcards which will then filter the final result to match only those who match the given version pattern. **Product:** Requires Artifactory Pro **Since:** 2.6.0 **Security:** Requires a privileged user (can be anonymous) - [Artifact Latest Version Search Based on Layout](https://docs.jfrog.com/artifactory/reference/searchlatestversion.md): Search for the latest artifact version by groupId and artifactId, based on the definitions in the Repository Layouts. This API is based on a Maven-specific algorithm for sorting versions. Search can be limited to specific repositories (local, remote-cache, or virtual) by settings the `repos` parameter. **Latest release vs. latest integration:** Unless the version parameter is specified, the search returns the latest artifact release version. When version is specified, e.g. `1.0-SNAPSHOT`, the result is the latest integration version. **Remote searches:** By default only local and cache repositories will be used. When specifying `remote=1`, Artifactory searches for versions on remote repositories. Note that this can dramatically slow down the search. **Filtering results (Artifactory 3.0.2+):** The `version` parameter can accept the `*` and/or `?` wildcards which will then filter the final result to match only those who match the given version pattern. **Artifact path pattern:** The `[org]` and `[module]` fields must be specified in the artifact path pattern of the repository layout for this call to work. **Product:** Requires Artifactory Pro **Since:** 2.6.0 **Security:** Requires a privileged user (can be anonymous) - [Artifact Latest Version Search Based on Properties](https://docs.jfrog.com/artifactory/reference/searchlatestversionbyproperties.md): Search for artifacts with the latest value in the `version` property. Only artifacts with the version property expressly defined in lowercase will be returned. This API is based on a Maven-specific algorithm for sorting versions. Results can be filtered by specifying additional properties as query parameters (e.g., `?os=win&license=GPL`). - `{repo}`: Specify a repository to search through or replace with `_any` to search through all repositories. - `{path}`: Specify a path to search through or replace with `_any` to search through all paths. - `listFiles=0` (default): Artifactory will only retrieve the latest version. - `listFiles=1`: Artifactory will retrieve the latest version and the corresponding files. You may specify filters to restrict the set of artifacts by adding any properties to your search URL as additional query parameters. **Product:** Requires Artifactory Pro **Since:** 3.1.1 **Security:** Requires an authenticated user (not anonymous) with read permission to the repository of each artifact. - [Build Artifacts Search](https://docs.jfrog.com/artifactory/reference/searchbuildartifacts.md): Find all the artifacts related to a specific build. **Product:** Requires Artifactory Pro **Since:** 2.6.5 **Security:** Requires a privileged user (can be anonymous) - [Find Parent Manifest Lists](https://docs.jfrog.com/artifactory/reference/findparentmanifestlists.md): Finds all parent manifest lists that include a specific Docker manifest. **Since:** 7.119.0 **Security:** Requires a user with read permission on the Docker repository. - [List Docker Repositories](https://docs.jfrog.com/artifactory/reference/listdockerrepositories.md): Lists all Docker repositories (the registry's `_catalog`) hosted in an Artifactory Docker repository. The `n` and `last` pagination parameters are supported from version 5.4.6. > **Note:** To enable fetching from the cache using the List Docker Repositories and the List Docker Tags REST APIs, set the following system properties in the `artifactory.system.properties` file: > - `artifactory.docker.catalogs.tags.fallback.fetch.remote.cache` to `true` (default is `false`) > - `artifactory.docker.cache.remote.repo.tags.and.catalog` to the URL of the remote registry (e.g., `https://registry-1.docker.io/`) > - Use the `retrievalCachePeriodSecs` property to adjust the cache interval setting. **Product:** Requires JFrog Container Registry or Artifactory Pro **Since:** 4.4.3 **Security:** Requires a user with read permission. - [List Docker Tags](https://docs.jfrog.com/artifactory/reference/listdockertags.md): Lists all tags of the specified Artifactory Docker repository. The `n` and `last` pagination parameters are supported from version 5.4.6. For Artifactory versions 7.90.1 and above, Artifactory will only return tags that comply with the OCI and Docker naming specifications. To disable this feature and return all tags, set the following feature flag in your system configuration file: `aritfactory.docker.filter.digests.from.tags.list.enabled=false`. **Product:** Requires JFrog Container Registry or Artifactory Pro **Since:** 4.4.3 **Security:** Requires a privileged user - [Empty Trash Can](https://docs.jfrog.com/artifactory/reference/emptytrashcan.md): Permanently deletes the entire contents of the Trash Can. **Notes:** Requires Artifactory Pro. **Security:** Requires a valid admin user. - [Delete Item From Trash Can](https://docs.jfrog.com/artifactory/reference/deleteitemfromtrashcan.md): Permanently deletes an item from the trash can. Requires Artifactory Pro. **Security:** Requires a valid admin user, project admin user, or user with Manage or Delete permissions. - [Restore Item from Trash Can](https://docs.jfrog.com/artifactory/reference/restoreitemfromtrashcan.md): Restore an item from the trash can. **Notes:** Requires Artifactory Pro. **Security:** Requires a valid admin user, project admin user, or user with Manage permissions. - [Delete Redundant Records to Trash Can Directories](https://docs.jfrog.com/artifactory/reference/deleteredundantrecordstotrashcandirectories.md): This REST API is called to delete redundant records to Trash Can directories. The redundant metadata of a Trash Can directory slows down the Small Garbage Collection process and can eventually cause an overall degradation in database performance. Calling this API alleviates this problem - [Run Garbage Collection](https://docs.jfrog.com/artifactory/reference/rungarbagecollection.md): Deletes from the Trash Can artifacts with a retention time that has expired and deletes orphan binaries when the full garbage collection cycle runs. The full garbage collection runs after a certain number of iterations and this number can be changed by the user. The default value is 20. **Security:** Requires an admin user. - [Get All Bundles](https://docs.jfrog.com/artifactory/reference/getallbundles.md): Returns a list of all release bundles. Requires Artifactory Enterprise+. - [Get All Bundle Versions](https://docs.jfrog.com/artifactory/reference/getallbundleversions.md): Returns a list of all bundles versions. Requires Artifactory Enterprise+. - [Get a Release Bundle Version](https://docs.jfrog.com/artifactory/reference/getreleasebundleversion.md): Returns a specific Release Bundle v1. Requires Artifactory Enterprise+. - [Delete a Release Bundle Version](https://docs.jfrog.com/artifactory/reference/deletereleasebundleversion.md): Delete a specific release bundle version from the source Artifactory. To delete a release bundle on a target Artifactory, see Delete Release Bundle v1 Version in the Distribution REST API. Requires Artifactory Enterprise+. - [Import Release Bundle Version](https://docs.jfrog.com/artifactory/reference/importreleasebundleversion.md): Import the Release Bundle version from the exported zip file. This API is relevant for both Release Bundles v1 and Release Bundles v2. The Import process is performed on the Artifactory node. You can set dryRun=true to validate that the conditions for performing the import process are met. From Artifactory 7.10.2, the import feature has been extended to support importing a file from a user-defined ARTIFACTORY_HOME/var/data/artifactory/import/ path. Note that the file will be deleted from the path after the file is imported. - [Get Release Bundle Version Import Status](https://docs.jfrog.com/artifactory/reference/getreleasebundleversionimportstatus.md): Returns the status of the imported Release Bundle version. The Import process is performed on the Artifactory Edge node. - [Query the Status of the Retention Service](https://docs.jfrog.com/artifactory/reference/querystatusofretentionservice.md): Gets the activation status of the retention policies. If enable is set to false, any bundles can be deleted even if they have been marked as keep (i.e., their keep status will be ignored). - [Set Retention Policies to Enabled](https://docs.jfrog.com/artifactory/reference/setretentionpoliciestoenabled.md): Sets the Release Bundle retention policy to enabled. If enable is set to false, any bundles can be deleted even if they have been marked as keep (i.e., their keep status will be ignored). - [Get Retention Policy Configuration](https://docs.jfrog.com/artifactory/reference/getretentionpolicyconfiguration.md): Gets the retention policies that were configured. - [Set the Retention Policy Configuration](https://docs.jfrog.com/artifactory/reference/setretentionpolicyconfiguration.md): Sets the retention policies that were configured. If a Release Bundle meets one or more of the retention policies configured, the policy will be applied to it. Note that you can set a partial configuration, but you cannot 'unset' a value - instead you will need to override it to change it. - [Get the Configured Retention Policies List](https://docs.jfrog.com/artifactory/reference/getconfiguredretentionpolicieslist.md): Finds the bundles that are candidates for retention according to the configuration type. - [Get the Retention Operations History](https://docs.jfrog.com/artifactory/reference/getretentionoperationshistory.md): Gets the history of the retention operations. - [Delete Release Bundles](https://docs.jfrog.com/artifactory/reference/deletereleasebundles.md): Deletes the Release Bundles. - [Mark Release Bundles to Keep (or Don't Keep)](https://docs.jfrog.com/artifactory/reference/markreleasebundlestokeepordontkeep.md): Sets the indicator to keep (indefinitely) or not keep (unkeep) Release Bundles. - [Get All Bundles](https://docs.jfrog.com/artifactory/reference/getallbundles-1.md): Returns a list of all V1 release bundles managed by the Distribution service. - [Create Release Bundle V1 Version](https://docs.jfrog.com/artifactory/reference/createreleasebundlev1version.md): Creates a new V1 release bundle. The bundle is created with the specified artifacts and configuration. If a GPG passphrase is provided, the bundle is signed during creation. - [Get Release Bundle V1 Versions by Name](https://docs.jfrog.com/artifactory/reference/getreleasebundlev1versionsbyname.md): Returns all versions of a named V1 release bundle. - [Delete All Release Bundle V1 Versions](https://docs.jfrog.com/artifactory/reference/deleteallreleasebundlev1versions.md): Deletes all versions of a named V1 release bundle from the Distribution service. - [Get Latest Release Bundle V1 Version](https://docs.jfrog.com/artifactory/reference/getlatestreleasebundlev1version.md): Returns the latest version of a named V1 release bundle. - [Get Release Bundle V1 Version Details](https://docs.jfrog.com/artifactory/reference/getreleasebundlev1versiondetails.md): Returns details of a specific V1 release bundle version. Supports JWS and JOSE response formats. - [Get Release Bundle V1 Version SHA-256](https://docs.jfrog.com/artifactory/reference/getreleasebundlev1versionsha256.md): Returns the SHA-256 checksum of a release bundle version in the X-Checksum-Sha256 response header. - [Update Release Bundle V1 Version](https://docs.jfrog.com/artifactory/reference/updatereleasebundlev1version.md): Updates an existing V1 release bundle version with new artifacts or configuration. - [Delete Release Bundle V1 Version](https://docs.jfrog.com/artifactory/reference/deletereleasebundlev1version.md): Deletes a specific V1 release bundle version from the Distribution service. - [Sign Release Bundle V1 Version](https://docs.jfrog.com/artifactory/reference/signreleasebundlev1version.md): Signs a V1 release bundle version with the configured GPG key. A release bundle must be signed before it can be distributed. - [Trigger Xray Scan Release Bundle V1 Version](https://docs.jfrog.com/artifactory/reference/triggerxrayscanreleasebundlev1version.md): Triggers an Xray security scan on a specific V1 release bundle version. The scan analyzes the bundle's artifacts for known vulnerabilities and license compliance issues. - [Get Distribution Status Details](https://docs.jfrog.com/artifactory/reference/getdistributionstatusdetails.md): Returns distribution statuses for all V1 release bundles. - [Get Distribution Status Details by Release Bundle V1 Name](https://docs.jfrog.com/artifactory/reference/getdistributionstatusdetailsbyreleasebundlev1name.md): Returns distribution statuses for all versions of a named V1 release bundle. - [Get Distribution Status Details by Release Bundle V1 Version](https://docs.jfrog.com/artifactory/reference/getdistributionstatusdetailsbyreleasebundlev1version.md): Returns distribution statuses for a specific V1 release bundle version. - [Get Distribution Status Details by Release Bundle V1 Tracker ID](https://docs.jfrog.com/artifactory/reference/getdistributionstatusdetailsbyreleasebundlev1trackerid.md): Returns detailed distribution progress for a specific V1 distribution tracker, including per-edge-node status. - [Distribute Release Bundle V1 Version](https://docs.jfrog.com/artifactory/reference/distributereleasebundlev1version.md): Distributes a signed Release Bundle V1 to the specified target edge nodes. The distribution rules define which sites receive the bundle. Supports dry-run mode to simulate the distribution without executing it. - [Delete Release Bundle V1 Version from Distribution Edges](https://docs.jfrog.com/artifactory/reference/deletereleasebundlev1versionfromdistributionedges.md): Remotely deletes a Release Bundle V1 version from edge nodes. The distribution rules define which sites should have the bundle removed. Supports dry-run mode. - [Abort Release Bundle V1 Distribution](https://docs.jfrog.com/artifactory/reference/abortreleasebundlev1distribution.md): Aborts an in-progress V1 distribution. Sends abort signals to all edge nodes that are currently receiving the distribution. - [Get Distribution Edge Nodes](https://docs.jfrog.com/artifactory/reference/getdistributionedgenodes.md): Returns a list of registered edge nodes connected to the Distribution service. - [Dynamic Distribute Release Bundle V1](https://docs.jfrog.com/artifactory/reference/distributedynamicreleasebundlev1.md): Creates a release bundle from the given spec, signs it (using optional GPG passphrase), and distributes it to the target edge nodes in one request. The release bundle name and version are generated by the service. Distribution rules define which sites receive the bundle. - [Distribute Release Bundle V2 Version](https://docs.jfrog.com/artifactory/reference/distributereleasebundlev2version.md): Distributes a Release Bundle v2 to the specified target edge nodes. The distribution rules define which sites receive the bundle. Supports dry-run mode to simulate the distribution without executing it. - [Abort Release Bundle V2 Distribution](https://docs.jfrog.com/artifactory/reference/abortreleasebundlev2distribution.md): Aborts an in-progress distribution of a Release Bundle v2. Sends abort signals to all edge nodes that are currently receiving the distribution. - [Remote Delete Release Bundle V2 Distribution](https://docs.jfrog.com/artifactory/reference/remotedeletereleasebundlev2distribution.md): Remotely deletes a Release Bundle v2 from edge nodes. The distribution rules define which sites should have the bundle removed. Supports dry-run mode. - [Get Release Bundle V2 Distribution Trackers](https://docs.jfrog.com/artifactory/reference/getreleasebundlev2distributiontrackers.md): Returns a list of distribution trackers for a Release Bundle v2. Each tracker represents a distribution operation and its overall status. - [Get Distribution Status Details by Tracker ID](https://docs.jfrog.com/artifactory/reference/getdistributionstatusdetailsbytrackerid.md): Returns detailed distribution progress for a specific distribution tracker, including per-edge-node status. - [Export Release Bundle V1 Version](https://docs.jfrog.com/artifactory/reference/exportreleasebundlev1version.md): Exports a V1 release bundle as a zip file for air-gapped environments. The export process runs asynchronously. - [Delete Exported Release Bundle V1 File](https://docs.jfrog.com/artifactory/reference/deleteexportedreleasebundlev1file.md): Deletes an exported air-gap zip file for a V1 release bundle. - [Get Exported Release Bundle V1 Status](https://docs.jfrog.com/artifactory/reference/getexportedreleasebundlev1status.md): Returns the current status of an air-gap export for a V1 release bundle. - [Import Release Bundle V1 Version](https://docs.jfrog.com/artifactory/reference/importreleasebundlev1version.md): Imports a previously exported V1 release bundle into Artifactory. This endpoint runs on the Artifactory service (not Distribution) and is the counterpart to the air-gap export operation. Use this to import release bundles into air-gapped environments. - [Get Public Signing Key for Distribution](https://docs.jfrog.com/artifactory/reference/getpublicsigningkeyfordistribution.md): Returns the public signing key content by key name. Requires admin permission. - [Propagate Public Signing Key](https://docs.jfrog.com/artifactory/reference/propagatepublicsigningkey.md): Propagates the release bundle signing key (used to verify release bundle integrity) to all connected edge nodes by key name. Returns a propagation report with the status for each edge node. Requires admin permission. - [Set GPG Signing Key for Distribution](https://docs.jfrog.com/artifactory/reference/setgpgsigningkey.md): Sets a GPG/PGP signing key pair for the Distribution service. The key is used to sign release bundles before distribution. - [Get GPG Signing Key for Distribution](https://docs.jfrog.com/artifactory/reference/getgpgsigningkey.md): Returns the default GPG public signing key. - [Upload and Propagate GPG Signing Keys for Distribution](https://docs.jfrog.com/artifactory/reference/uploadandpropagategpgsigningkeysfordistribution.md): Propagates GPG/PGP signing keys (used for artifact-level signature verification) to all connected edge nodes. Can propagate a specific key alias or all configured GPG keys. Unlike the release bundle signing key propagation endpoint, this manages GPG keys used for verifying individual artifacts. - [Get All Key Aliases](https://docs.jfrog.com/artifactory/reference/getallgpgkeyaliases.md): Returns all GPG/PGP key aliases configured in the Distribution service. - [Get Public Key by Alias](https://docs.jfrog.com/artifactory/reference/getgpgpublickeybyalias.md): Returns the public key for a specific alias. - [Update Key Alias](https://docs.jfrog.com/artifactory/reference/updategpgkeyalias.md): Updates the alias name for a GPG/PGP key. - [Delete Key by Alias](https://docs.jfrog.com/artifactory/reference/deletegpgkeybyalias.md): Deletes a GPG/PGP key by its alias. - [Create or Refresh Token](https://docs.jfrog.com/artifactory/reference/createorrefreshtoken.md): Creates a new access token (grant_type=client_credentials) or refreshes an existing one (grant_type=refresh_token). Request must be application/x-www-form-urlencoded. **Create token (client_credentials):** Requires username and optionally scope, expires_in, refreshable. Supported scopes are admin and groups. Non-admin users can only create tokens for themselves and cannot request admin scope. **Refresh token (refresh_token):** Requires grant_type, refresh_token, and access_token; optionally expires_in and refreshable. - [Get Token Infos](https://docs.jfrog.com/artifactory/reference/gettokeninfos.md): Returns information about tokens (e.g. token ID, issuer, subject, expiry). Requires admin permission. - [Revoke Token](https://docs.jfrog.com/artifactory/reference/revoketoken.md): Revokes a token by providing either the token value (access or refresh token) or the token ID. Request must be application/x-www-form-urlencoded. See RFC 7009 (Token Revocation). Requires admin permission. - [Get All Permissions](https://docs.jfrog.com/artifactory/reference/getalldistributionpermissions.md): Returns all destination permissions configured in the Distribution service. Requires admin permissions. - [Get Permission by Name](https://docs.jfrog.com/artifactory/reference/getdistributionpermissionbyname.md): Returns a specific destination permission by name. Requires admin permissions. - [Create or Update Destination Permission by Name](https://docs.jfrog.com/artifactory/reference/setdistributionpermission.md): Creates or updates a destination permission that controls which users and groups can distribute or delete release bundles to specific edge nodes. The `distribution_destinations` field is required and defines the target edge nodes using site name, city name, and/or country code filters. The `principals` field defines which users and groups are granted which actions (distribute, delete). If a permission with the given name does not exist, it will be created. If it already exists, it will be updated. Requires admin permissions. - [Delete Permission by Name](https://docs.jfrog.com/artifactory/reference/deletedistributionpermission.md): Deletes a destination permission by name. Requires admin permissions. - [Get Stuck Distributions](https://docs.jfrog.com/artifactory/reference/getstuckdistributions.md): Returns a list of distributions that are currently stuck in a non-final state. Use this endpoint to identify distributions that may need to be unlocked using the maintenance execute endpoint with the UNLOCK_STUCK action type. Requires admin permissions. - [Generate Maintenance Execution Token](https://docs.jfrog.com/artifactory/reference/generatemaintenanceexecutiontoken.md): Generates a time-limited encrypted token required to execute a maintenance action. The token must be used within 3 minutes. Pass the returned token as the request body to the execute endpoint. Requires admin permissions. - [Execute Maintenance Action](https://docs.jfrog.com/artifactory/reference/executemaintenanceaction.md): Executes a maintenance action using a previously generated token. Two action types are supported: - **UNLOCK_STUCK**: Unlocks all stuck distributions, allowing them to be retried or cleaned up. Returns a report listing the stuck distributions and whether they were unlocked. - **STOP_ALL**: Force-stops all in-progress distributions across the cluster, aborts all non-final trackers in the database, and flushes the task queue. Returns a report with affected tracker counts and queue flush status. The `dryRun` query parameter (defaults to `true`) allows previewing what would be affected without actually performing the action. Requires admin permissions. - [Distribute by Last Days](https://docs.jfrog.com/artifactory/reference/distributebylastdays.md): Redistributes all release bundles that were distributed within a specified time window to a target edge node. The time window is defined by a date and a number of days to look back from that date. For example, specifying `date: "2025-03-11"` and `lastNumberOfDays: 7` will redistribute all release bundles that were distributed in the 7-day window ending on March 11, 2025. The `lastNumberOfDays` value must be between 1 and the configured maximum (default: 7). Requires admin permissions. - [Get Open Metrics for Distribution](https://docs.jfrog.com/artifactory/reference/getopenmetricsfordistribution.md): Returns Distribution service metrics in OpenMetrics (Prometheus) text format. The following metrics are returned: | Metric | Description | Prometheus Metric Type | |--------|-------------|----------------------| | `jfds_total_number_of_release_bundles_total` | The total number of Release Bundles created. | COUNTER | | `jfds_number_of_created_release_bundle_versions_total` | The number of Release Bundle versions created per request type (API, UI). | COUNTER | | `jfds_number_of_signed_release_bundle_versions_total` | The total number of signed Release Bundle versions. | COUNTER | | `jfds_number_of_deleted_release_bundle_versions_total` | The total number of deleted Release Bundle versions. | COUNTER | | `jfds_size_of_release_bundle_versions_in_bytes_total` | The size (in bytes) of all artifacts in all signed Release Bundle versions. | COUNTER | | `jfds_number_of_artifacts_in_release_bundle_version_max` | The maximum number of artifacts in a Release Bundle version. | GAUGE | | `jfds_number_of_artifacts_in_release_bundle_version_bucket` | The number of artifacts in a Release Bundle version (rounded off into units of 10, 50, 100, 500, 1000, 5000, 10000, 50000, and infinite). | HISTOGRAM | | `jfds_number_of_artifacts_in_release_bundle_version_per_package_type_total` | The number of artifacts in a Release Bundle version per package type. | COUNTER | | `jfds_number_of_artifactory_queries_total` | The number of queries used to construct the Release Bundle. | COUNTER | | `jfds_number_of_queries_with_additional_properties_total` | The number of queries containing additional properties. | COUNTER | | `jfds_number_of_queries_with_path_mapping_total` | The total number of queries that include path mapping (path and repo modifications). | COUNTER | | `jfds_number_of_path_mapping_based_on_last_promotion_total` | The total number of path mappings based on the last successful Release Bundle v2 promotion. | COUNTER | | `jfds_number_of_modifications_of_path_total` | The total number of modifications made to the original path during distribution operations. | COUNTER | | `jfds_number_of_modifications_of_repo_total` | The total number of modifications that have been made to the original repository. | COUNTER | | `jfds_distribution_build_info` | The Distribution service version and revision. | GAUGE | | `jfds_total_number_of_distribution_requests_total` | The total number of Release Bundle v1 distribution start actions. | COUNTER | | `jfds_total_number_of_distribution_requests_v2_total` | The total number of Release Bundle v2 distribution start actions. | COUNTER | | `jfds_total_number_of_distribution_requests_with_project_v2_total` | The total number of Release Bundle v2 distribution start actions performed in the context of a project. | COUNTER | | `jfds_number_of_distribution_requests_per_trigger_type_total` | The total number of Release Bundle (v1 & v2) distribution start actions per request type (API, UI). | COUNTER | | `jfds_total_number_of_exports_requests_v2_total` | The total number of export operations for Release Bundle v2 versions. | COUNTER | | `jfds_number_of_distributions_per_status_total` | The total number of Release Bundle v1 distributions per status (completed, failed). | COUNTER | | `jfds_number_of_distributions_per_status_v2_total` | The total number of Release Bundle v2 distributions per status (completed, failed). | COUNTER | | `jfds_number_of_exports_per_status_v2_total` | The total number of export operations per status (completed, failed). | COUNTER | | `jfds_number_of_remote_deletion_requests_per_trigger_type_total` | The total number of Release Bundle v1 remote delete actions per request type (API, UI). | COUNTER | | `jfds_number_of_remote_deletion_requests_per_trigger_type_v2_total` | The total number of Release Bundle v2 remote delete actions per request type (API, UI). | COUNTER | | `jfds_number_of_approved_distributions_total` | The total number of Release Bundle v1 distribution/exports approved by Xray. | COUNTER | | `jfds_number_of_approved_distributions_v2_total` | The number of Release Bundle v2 distributions/exports approved by Xray. | COUNTER | | `jfds_number_of_xray_scan_result_not_allowed_total` | The total number of distribution failures due to Xray scan results of NOT ALLOWED. Possible reasons: blocked, not_indexed (v2 only), not_found_in_artifactory (v2 only). | COUNTER | | `jfds_number_of_rejected_distributions_total` | The total number of Release Bundle v1 distribution/exports blocked by Xray. | COUNTER | | `jfds_number_of_rejected_distributions_v2_total` | The total number of Release Bundle v2 distribution/exports blocked by Xray. | COUNTER | | `jfds_number_of_api_requests_per_endpoint_total` | The total number of API requests that were processed per endpoint. | COUNTER | - [Supported Open Metrics for Distribution](https://docs.jfrog.com/artifactory/reference/supported-open-metrics-for-distribution.md) - [Distribution Ping](https://docs.jfrog.com/artifactory/reference/distributionping.md): Health check that indicates whether the Distribution service is running and its dependent services (e.g. Artifactory, Access) are available. Returns a JSON body with status. May allow unauthenticated access depending on platform configuration; otherwise returns 401. - [Get Distribution System Info](https://docs.jfrog.com/artifactory/reference/getdistributionsysteminfo.md): Returns system information about the Distribution service including version, service ID, and health status (STABLE/UNSTABLE). When dependent services are unavailable, status is UNSTABLE and message describes which services are down. - [Get Distribution System Settings](https://docs.jfrog.com/artifactory/reference/getdistributionsystemsettings.md): Returns the current system settings for the Distribution service. Requires admin permissions. - [Update Distribution System Settings](https://docs.jfrog.com/artifactory/reference/updatedistributionsystemsettings.md): Updates the system settings for the Distribution service. Requires admin permissions. # AI Supply Chain Documentation > Documentation for AI Supply Chain ## Guides - [JFrog AI Supply Chain](https://docs.jfrog.com/ai-ml/docs/getting-started-ai-ml.md): Centralize, Secure, and Govern Your AI Assets - [AI Tools and Integrations](https://docs.jfrog.com/ai-ml/docs/ai-tools-and-integrations.md): Connect AI coding agents and AI-powered tools to the JFrog platform. - [JFrog Plugins](https://docs.jfrog.com/ai-ml/docs/jfrog-plugins.md): Official plugins for Claude Code, VS Code, Cursor, and OpenCode. Extend your IDE with JFrog governance, security scanning, and artifact management. - [Install JFrog Plugin for Cursor](https://docs.jfrog.com/ai-ml/docs/cursor.md): How to install the JFrog plugin for Cursor to enable AI-assisted development with governance - [Install JFrog Plugin for Claude Code](https://docs.jfrog.com/ai-ml/docs/claude-code.md): How to install the JFrog plugin for Claude Code - [Install JFrog Plugin for VS Code](https://docs.jfrog.com/ai-ml/docs/vs-code.md): How to install the JFrog plugin for VS Code - [Install JFrog Plugin for OpenCode](https://docs.jfrog.com/ai-ml/docs/opencode.md): Install and configure the JFrog plugin for OpenCode, including Agent Skills and the JFrog Platform MCP server. - [Troubleshoot Plugins](https://docs.jfrog.com/ai-ml/docs/troubleshoot-plugins.md): Troubleshoot plugin installation and configuration problems across IDEs, including network connectivity issues and environment-specific workarounds. - [JFrog AI Catalog Overview](https://docs.jfrog.com/ai-ml/docs/jfrog-ai-catalog-overview.md) - [JFrog AI Catalog Architecture](https://docs.jfrog.com/ai-ml/docs/jfrog-ai-catalog-architecture.md) - [Shadow AI Detection and Governance](https://docs.jfrog.com/ai-ml/docs/detect-shadow-ai.md): Govern Shadow AI in the JFrog AI Catalog—detect models in repositories and allow, block, or dismiss them by project or repository. - [AI/ML Overview Dashboard](https://docs.jfrog.com/ai-ml/docs/aiml-overview-dashboard.md): Monitor AI models, MCP servers, and gateway usage from the JFrog Platform AI/ML Overview page. - [Viewing Curation Policy Status for AI Catalog Models](https://docs.jfrog.com/ai-ml/docs/viewing-curation-policy-status-for-ai-catalog-models.md): Learn how JFrog AI Catalog shows Curation policy status on model pages. - [Troubleshoot AI Catalog](https://docs.jfrog.com/ai-ml/docs/troubleshoot-ai-catalog.md): Troubleshoot JFrog AI Catalog issues quickly with dedicated guidance for model operations and MCP Registry workflows. - [Get Started](https://docs.jfrog.com/ai-ml/docs/ai-catalog-quick-start.md): Follow these steps to start managing your AI models. - [Discover and Allow Models](https://docs.jfrog.com/ai-ml/docs/discover-and-allow-models.md): Discover, search, and allow AI models in JFrog AI Catalog for your projects. - [Understanding ML-BOM in AI Catalog](https://docs.jfrog.com/ai-ml/docs/ml-bom-overview.md): Learn ML-BOM scope, fields, and editability for models in JFrog AI Catalog. - [View, Edit, and Export ML-BOM](https://docs.jfrog.com/ai-ml/docs/manage-ml-bom.md): View, edit, and export ML-BOM for models in JFrog AI Catalog Registry. - [Upload Custom Models](https://docs.jfrog.com/ai-ml/docs/upload-custom-models.md) - [Use Models in Your Code](https://docs.jfrog.com/ai-ml/docs/integrate-models-in-your-code.md): Integrate allowed models within your code. - [Connect AI Providers](https://docs.jfrog.com/ai-ml/docs/connect-ai-providers.md) - [Deploy Hugging Face Model Packages](https://docs.jfrog.com/ai-ml/docs/deploy-model-packages.md): Configure and deploy a hugging face model to a managed inference cluster with compute and scaling settings. - [Automatic Undeployment](https://docs.jfrog.com/ai-ml/docs/automatic-undeployment.md): How JFrog ML can remove package model (Hugging Face) deployments that never become available, when that happens, and how it differs from undeploying manually. - [Deploy Custom Models](https://docs.jfrog.com/ai-ml/docs/deploy-custom-models.md) - [Inference Metrics](https://docs.jfrog.com/ai-ml/docs/ai-catalog-inference-metrics.md): Viewing the model dashboard - [Troubleshoot Models in AI Catalog](https://docs.jfrog.com/ai-ml/docs/troubleshoot-models-in-ai-catalog.md): Troubleshoot model deployment and inference errors in JFrog AI Catalog, including validation failures, 401/404 responses, and NVIDIA NGC authentication. - [JFrog MCP Registry Overview](https://docs.jfrog.com/ai-ml/docs/mcp-registry-overview.md): Learn why the JFrog MCP Registry is the single source of truth for MCP servers. - [Get Started with the MCP Registry](https://docs.jfrog.com/ai-ml/docs/get-started-mcp.md): Connect governed MCP servers to your coding agent using the JFrog MCP Registry. - [Install an MCP Server](https://docs.jfrog.com/ai-ml/docs/install-an-mcp-server.md): How to install an allowed MCP server using the JFrog Platform UI - [Manage MCP Servers](https://docs.jfrog.com/ai-ml/docs/manage-mcp-servers.md): Configure and govern pre-built and custom MCP servers in the JFrog MCP Registry. - [Configure and Enable Pre-built MCP Servers](https://docs.jfrog.com/ai-ml/docs/configure-pre-built-mcp-servers.md): Configure and enable pre-built MCP servers in the JFrog MCP Registry for a project. - [Custom MCP Servers](https://docs.jfrog.com/ai-ml/docs/custom-mcp-servers.md): Upload, govern, and distribute your proprietary MCP servers using the JFrog MCP Registry. - [Register Local Custom MCP Servers](https://docs.jfrog.com/ai-ml/docs/local-custom-mcp-servers.md) - [Register Remote Custom MCP Servers](https://docs.jfrog.com/ai-ml/docs/remote-custom-mcp-servers.md): Register remote custom MCP server endpoints in the JFrog MCP Registry using the Platform UI or REST API so your team can govern tools for AI Catalog agents. - [Configure Tool Policies](https://docs.jfrog.com/ai-ml/docs/configure-tool-policies.md): Govern specific tool access within your approved MCP servers. - [Use the MCP Registry with Agent Guard](https://docs.jfrog.com/ai-ml/docs/configure-coding-agents.md): Connect your coding agent to the JFrog Agent Guard using the JFrog coding assistant (IDE) plugin. - [Example Workflows (MCPs via Agents)](https://docs.jfrog.com/ai-ml/docs/manage-mcps-via-agents.md) - [Troubleshoot MCP Registry](https://docs.jfrog.com/ai-ml/docs/mcp-registry-troubleshoot.md): Verify Agent Guard integration and troubleshoot common MCP Registry issues, including custom MCP errors, runtime configuration, and support escalation. - [Security and Validation](https://docs.jfrog.com/ai-ml/docs/security-and-validation-mcp.md): How access control and validation work for MCP servers and tools. - [Enforce Organization-Wide MCP Policies](https://docs.jfrog.com/ai-ml/docs/enforce-organization-wide-mcp-policies.md): Compare three organization-wide MCP enforcement models across Claude Code, Cursor, and VS Code. Choose the right enforcement method for your coding assistant and organization. - [VS Code: Enforce Governed MCP Usage](https://docs.jfrog.com/ai-ml/docs/vs-code-enforce-jfrog-governed-mcp-usage.md): Install the JFrog Agent Guard hook on developer machines via MDM to enforce organization-wide MCP usage policies in VS Code. Includes macOS, Windows, and Linux deployment instructions. - [Cursor: Enforce Governed MCP Usage](https://docs.jfrog.com/ai-ml/docs/cursor-enforce-jfrog-governed-mcp-usage.md): Apply organization-wide MCP usage policies to your Cursor team by copying allowlist entries from JFrog AI Catalog and applying them in the Cursor team dashboard. - [Claude Code: Enforce Governed MCP Usage](https://docs.jfrog.com/ai-ml/docs/claude-code-enforce-jfrog-governed-mcp-usage.md): Apply organization-wide managed settings so that Claude Code runs only on approved MCP servers via JFrog Agent Guard. - [JFrog Boost Overview](https://docs.jfrog.com/ai-ml/docs/jfrog-boost-overview.md): Learn how JFrog Boost trims noisy agent command output while preserving failures. - [JFrog Boost Quickstart](https://docs.jfrog.com/ai-ml/docs/jfrog-boost-quickstart.md): Install JFrog Boost and initialize your coding agent in one session. - [Token Savings with JFrog Boost](https://docs.jfrog.com/ai-ml/docs/token-savings-with-jfrog-boost.md): Understand how JFrog Boost compresses noisy command output for agents. - [Deploy JFrog Boost with Jamf Pro MDM](https://docs.jfrog.com/ai-ml/docs/deploy-jfrog-boost-with-jamf-pro-mdm.md): Deploy JFrog Boost on managed macOS devices with Jamf Pro MDM. - [Configuring JFrog Boost](https://docs.jfrog.com/ai-ml/docs/configuring-jfrog-boost.md): Configure JFrog Boost filters, hooks, reporting, and data paths. - [TOML Filters for JFrog Boost](https://docs.jfrog.com/ai-ml/docs/toml-filters-for-jfrog-boost.md): Add custom JFrog Boost output filters with TOML filter rules. - [JFrog ML Overview](https://docs.jfrog.com/ai-ml/docs/jfrog-ml-introduction.md) - [JFrog ML Architecture](https://docs.jfrog.com/ai-ml/docs/jfrog-ml-architecture.md): Explore the architecture that makes JFrog ML a single, trusted platform for MLOps. - [Control and Data Planes](https://docs.jfrog.com/ai-ml/docs/control-and-data-planes-interaction.md): Learn how the control and data planes of JFrog ML interact. - [Set Up JFrog ML ](https://docs.jfrog.com/ai-ml/docs/setting-up-jfrog-ml.md): Install and configure FrogML CLI and SDK - [JFrog ML Quickstart](https://docs.jfrog.com/ai-ml/docs/jfrogml-quickstart.md) - [Model Version Management](https://docs.jfrog.com/ai-ml/docs/model-version-management.md) - [Build Models](https://docs.jfrog.com/ai-ml/docs/build-models.md) - [Model Build Overview](https://docs.jfrog.com/ai-ml/docs/model-build-overview.md) - [Model Builds SDK](https://docs.jfrog.com/ai-ml/docs/model-builds-sdk.md) - [Managing Dependencies](https://docs.jfrog.com/ai-ml/docs/managing-dependencies.md) - [FrogML Model Anatomy](https://docs.jfrog.com/ai-ml/docs/frogml-model-anatomy.md) - [The FrogML Model Class](https://docs.jfrog.com/ai-ml/docs/the-frogml-model-class.md) - [Training Models](https://docs.jfrog.com/ai-ml/docs/training-models.md): Train your models on a scalable infrastructure using JFrog ML. - [Testing Models](https://docs.jfrog.com/ai-ml/docs/testing-models.md) - [Loading Pre-built Models](https://docs.jfrog.com/ai-ml/docs/loading-pre-built-models.md): The fastest way to start using FrogML is to deploy a model that was previously trained as a FrogML service. - [Model Registry and Metadata](https://docs.jfrog.com/ai-ml/docs/model-registry-and-metadata.md) - [Advanced Build Concepts](https://docs.jfrog.com/ai-ml/docs/advanced-build-concepts.md) - [Serve Models (Deployment)](https://docs.jfrog.com/ai-ml/docs/serve-models-deployment.md) - [Real-Time Deployments](https://docs.jfrog.com/ai-ml/docs/real-time-deployments.md) - [Calling Model Endpoints](https://docs.jfrog.com/ai-ml/docs/calling-model-endpoints.md) - [Deployment Strategies](https://docs.jfrog.com/ai-ml/docs/deployment-strategies.md): General and specific explanations of variations and deployment strategies. - [Performance and Runtime Configuration](https://docs.jfrog.com/ai-ml/docs/performance-and-runtime-configuration.md) - [Local Deployment](https://docs.jfrog.com/ai-ml/docs/local-deployment.md): Supporting local realtime deployment of models - [Prediction Input & Output Adapters](https://docs.jfrog.com/ai-ml/docs/prediction-input-output-adapters.md) - [Batch Deployments](https://docs.jfrog.com/ai-ml/docs/batch-deployments.md): After a successful build, you can deploy your custom model as a batch application. - [Storage-based Execution](https://docs.jfrog.com/ai-ml/docs/storage-based-execution.md): The low-level API of the batch execution allows you to start an execution from a specific remote path, and write the results to another path. - [DataFrame Execution](https://docs.jfrog.com/ai-ml/docs/dataframe-execution.md): DataFrame-based execution Enables you to execute a batch job on an input Pandas DataFrame, and receive an output DataFrame back. - [Batch Execution Management](https://docs.jfrog.com/ai-ml/docs/batch-execution-management.md): Understand the various commands that help you manage and track the execution status of your batch models. - [Streaming Deployments ](https://docs.jfrog.com/ai-ml/docs/streaming-deployments.md): Streaming deployments enable you to connect Kafka streams with your custom models for real-time inference. - [Inference Analytics](https://docs.jfrog.com/ai-ml/docs/inference-analytics.md): The model Analytics tab provides an interface to the JFrog ML Lake, which is an automated log collection system for models. - [Model Monitors](https://docs.jfrog.com/ai-ml/docs/model-monitors.md) - [Runtime Metrics](https://docs.jfrog.com/ai-ml/docs/runtime-metrics.md) - [Prediction Timers](https://docs.jfrog.com/ai-ml/docs/prediction-timers.md): JFrog ML prediction timers help troubleshoot model prediction latency, measure prediction times, find bottlenecks, and optimize performance. - [Performance Monitors](https://docs.jfrog.com/ai-ml/docs/performance-monitors.md): Monitoring ML model performance on JFrog ML is essential for maintaining the reliability and effectiveness of your models. - [Define Automations](https://docs.jfrog.com/ai-ml/docs/define-automations.md): JFrog ML offers built-in automations for various recurring actions in the model lifecycle. These automations are meant to replace external orchestration tools such as Airflow for example. - [Automate Build and Deploy](https://docs.jfrog.com/ai-ml/docs/automating-build-and-deploy.md): Automating model build and deployment helps maintaining models accurate in production. - [Automate Batch Execution](https://docs.jfrog.com/ai-ml/docs/automating-batch-execution.md): Automating batch model inference simplifies running batch tasks on a periodic basis. - [Manage Automations](https://docs.jfrog.com/ai-ml/docs/manage-automations.md) - [Automation Tutorials](https://docs.jfrog.com/ai-ml/docs/automation-tutorials.md) - [Configure JFrog ML](https://docs.jfrog.com/ai-ml/docs/configure-jfrog-ml.md) - [JFrog ML Alerts](https://docs.jfrog.com/ai-ml/docs/jfrog-ml-alerts.md) - [Instance Sizes & ML Credits](https://docs.jfrog.com/ai-ml/docs/instance-sizes-ml-credits.md): Instance sizes enable the simple selection of the best compute and memory resources when building and deploying models. - [Secret Management](https://docs.jfrog.com/ai-ml/docs/secret-management.md): Use secrets to avoid revealing confidential information in model deployments and data source connections - [Accessing AWS Resources with IAM Role](https://docs.jfrog.com/ai-ml/docs/accessing-aws-resources-with-iam-role.md): A step-by-step guide to accessing data from your AWS private S3 bucket by assuming an IAM role via the JFrog ML platform. - [Experiment Tracking](https://docs.jfrog.com/ai-ml/docs/integrating-experiment-tracking-tools-with-jfrog-ml.md): Easily integrate experiment tracking tools with JFrog ML. - [Feature Store Overview](https://docs.jfrog.com/ai-ml/docs/feature-store-overview.md) - [Feature Store Quick Start Guide](https://docs.jfrog.com/ai-ml/docs/feature-store-quick-start-guide.md) - [Data Sources](https://docs.jfrog.com/ai-ml/docs/data-sources.md) - [Feature Sets](https://docs.jfrog.com/ai-ml/docs/feature-set.md): Fundamental components of a machine learning feature store. - [Batch Feature Sets](https://docs.jfrog.com/ai-ml/docs/batch-feature-set.md) - [Streaming Feature Sets](https://docs.jfrog.com/ai-ml/docs/streaming-feature-set.md) - [Feature Consumption](https://docs.jfrog.com/ai-ml/docs/feature-consumption.md) - [Feature Set Alerts](https://docs.jfrog.com/ai-ml/docs/feature-set-alerts.md): Feature set alerts help you track and maintain the status of batch feature sets. - [Use Cases](https://docs.jfrog.com/ai-ml/docs/feature-store-use-cases.md) - [Cross-environment Online Serving Replication](https://docs.jfrog.com/ai-ml/docs/cross-environment-online-serving-replication.md): To enable fast access to inference across different regions - [FrogML Client](https://docs.jfrog.com/ai-ml/docs/frogml-client-examples.md): Learn how to use the FrogML client through these examples. - [JFrog ML Troubleshooting](https://docs.jfrog.com/ai-ml/docs/jfrog-ml-troubleshooting.md) - [JFrog ML in Self-Managed Environments](https://docs.jfrog.com/ai-ml/docs/jfrog-ml-self-managed-environment.md): Enable secure communication between your JFrog Platform Deployment (JPD) and JFrog ML for Self-Managed environments. - [Role-based Access Control (RBAC) in JFrog ML](https://docs.jfrog.com/ai-ml/docs/role-based-access-control-rbac.md): Define roles for AI/ML use-cases and workflows. - [Qwak Documentation](https://docs.jfrog.com/ai-ml/docs/qwak-documentation.md)