JFrog API

This section reviews the various options and interfaces for working with the JFrog API. JFrog offers the following types of documentation related to JFrog API operation:

  • JFrog Open API Specifications: A range of OpenAPI specifications are available enabling you to connect to your environment and try out the API. Open API specifications are hosted in their relevant project. For example, if you're looking for an API for Creating Repositories, you'd find that OpenAPI specification in the Binary Management project for Artifactory. You can search for APIs using the JFrog Docs search, then clicking the API Reference tab, or by manually navigating within the relevant project and clicking the API reference Tab at the top of the table of contents
  • Configuration JSON Files: These topics define the structured JSON payloads used as the request body for various JFrog REST APIs. While the API reference guides you on how to call an endpoint, these configuration files provide the specific schemas required to define repository settings, security policies, and system behaviors. They serve as the modular 'blueprints' that the platform consumes to execute complex management tasks.
  • Deprecated APIs: JFrog APIs that were previously deprecated can be found here until they are decommissioned.