JFrog System & Configuration API

System health, configuration, and version information

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/system/ping Check that Artifactory is reachable · JFrog System Health Ping #
Ask an LLM
“Is my Artifactory instance up and responding?”
“What's the quickest health check for Artifactory?”
Tell an agent
Ping Artifactory.
Check whether Artifactory is reachable.
GET /api/system/version Get the Artifactory version · JFrog Get Version Information #
Ask an LLM
“Which Artifactory version and build am I running?”
“Can I check the version of my Artifactory instance via API?”
Tell an agent
Show the Artifactory version.
Get Artifactory's version and build info.
GET /api/system/configuration Get the system configuration descriptor · JFrog Get System Configuration #
Ask an LLM
“How do I export Artifactory's full system configuration as XML?”
“Where can I read the global configuration descriptor?”
Tell an agent
Download the Artifactory system configuration XML.
Show the full global configuration descriptor.
PATCH /api/system/configuration Patch the system configuration with YAML · JFrog Update System Configuration #
Ask an LLM
“How do I apply a partial configuration change to Artifactory using YAML?”
“Can I change one global setting without uploading the whole descriptor?”
Tell an agent
Apply this YAML patch to the Artifactory system configuration.
Patch the global configuration with my YAML snippet.
GET /api/system/licenses Get installed license details · JFrog Get License Information #
Ask an LLM
“What license is installed on my Artifactory instance?”
“When does my Artifactory license expire?”
Tell an agent
Show the installed Artifactory license.
Get license details for this instance.

Documentation

📖
Documentation
https://www.jfrog.com/confluence/display/JFROG/Artifactory+REST+API
📖
Authentication
https://www.jfrog.com/confluence/display/JFROG/Access+Tokens
📖
GettingStarted
https://jfrog.com/help/r/jfrog-artifactory-documentation/use-the-rest-api
📖
Documentation
https://jfrog.com/help/r/jfrog-rest-apis/artifactory-rest-api-v2
📖
Authentication
https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-tokens
📖
Documentation
https://www.jfrog.com/confluence/display/JFROG/Xray+REST+API
📖
GettingStarted
https://jfrog.com/help/r/xray-rest-apis/introduction-to-the-xray-rest-apis
📖
Documentation
https://www.jfrog.com/confluence/display/JFROG/Distribution+REST+API
📖
Documentation
https://www.jfrog.com/confluence/display/JFROG/Pipelines+REST+API
📖
GettingStarted
https://jfrog.com/help/r/jfrog-rest-apis/introduction-to-the-pipelines-rest-apis
📖
Documentation
https://www.jfrog.com/confluence/display/JFROG/JFrog+Platform+REST+API
📖
GettingStarted
https://jfrog.com/help/r/jfrog-rest-apis/introduction-to-the-jfrog-platform-rest-apis
📖
Documentation
https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-token-rest-api
📖
GettingStarted
https://jfrog.com/help/r/jfrog-platform-administration-documentation/introduction-to-access-tokens
📖
Documentation
https://jfrog.com/help/r/jfrog-rest-apis/jfrog-curation-rest-apis
📖
Documentation
https://jfrog.com/help/r/jfrog-rest-apis/mission-control-rest-apis
📖
Documentation
https://jfrog.com/help/r/jfrog-rest-apis/release-lifecycle-management
📖
Documentation
https://jfrog.com/help/r/jfrog-rest-apis/workers-rest-apis
📖
Documentation
https://jfrog.com/help/r/jfrog-ml-documentation/jfrog-ml-rest-api
📖
Documentation
https://docs.connect.jfrog.io/rest-api-v2/connect-api-reference
📖
Authentication
https://docs.connect.jfrog.io/developers
📖
Documentation
https://jfrog.com/help/r/jfrog-security-user-guide/products/catalog
📖
Documentation
https://jfrog.com/help/r/jfrog-artifactory-documentation/create-evidence-using-rest-apis

Specifications

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/jfrog:jfrog-system-configuration-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

jfrog-system-configuration-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: JFrog Artifactory REST System & Configuration API
  description: REST API for managing artifacts, repositories, security, and system configuration in JFrog Artifactory. Artifactory is a universal binary repository manager that integrates with all major CI/CD and DevOps tools to provide an end-to-end automated solution for tracking artifacts from development to production.
  version: 7.x
  contact:
    name: JFrog
    url: https://jfrog.com
  license:
    name: Proprietary
    url: https://jfrog.com/terms-of-service/
  termsOfService: https://jfrog.com/terms-of-service/
servers:
- url: https://{server}.jfrog.io/artifactory
  description: JFrog Cloud
  variables:
    server:
      default: myserver
      description: Your JFrog server name
- url: https://{host}/artifactory
  description: Self-hosted JFrog instance
  variables:
    host:
      default: localhost:8082
      description: Your self-hosted JFrog server host
security:
- bearerAuth: []
- apiKeyAuth: []
- basicAuth: []
tags:
- name: System & Configuration
  description: System health, configuration, and version information
paths:
  /api/system/ping:
    get:
      operationId: systemPing
      summary: JFrog System Health Ping
      description: Returns a simple status response indicating whether Artifactory is accessible.
      tags:
      - System & Configuration
      responses:
        '200':
          description: Artifactory is accessible
          content:
            text/plain:
              schema:
                type: string
                example: OK
  /api/system/version:
    get:
      operationId: getSystemVersion
      summary: JFrog Get Version Information
      description: Returns version and build information for the Artifactory instance.
      tags:
      - System & Configuration
      responses:
        '200':
          description: Version information retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemVersion'
  /api/system/configuration:
    get:
      operationId: getSystemConfiguration
      summary: JFrog Get System Configuration
      description: Returns the full system configuration as an XML descriptor.
      tags:
      - System & Configuration
      responses:
        '200':
          description: System configuration retrieved
          content:
            application/xml:
              schema:
                type: string
    patch:
      operationId: updateSystemConfiguration
      summary: JFrog Update System Configuration
      description: Applies a partial update to the system configuration using a YAML payload.
      tags:
      - System & Configuration
      requestBody:
        required: true
        content:
          application/yaml:
            schema:
              type: string
      responses:
        '200':
          description: Configuration updated successfully
  /api/system/licenses:
    get:
      operationId: getSystemLicenses
      summary: JFrog Get License Information
      description: Returns the installed license details.
      tags:
      - System & Configuration
      responses:
        '200':
          description: License information retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseInfo'
components:
  schemas:
    LicenseInfo:
      type: object
      properties:
        type:
          type: string
        validThrough:
          type: string
        licensedTo:
          type: string
    SystemVersion:
      type: object
      properties:
        version:
          type: string
          example: 7.77.5
        revision:
          type: string
          example: '77700900'
        addons:
          type: array
          items:
            type: string
        license:
          type: string
          example: Enterprise+
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Access token authentication
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-JFrog-Art-Api
      description: API key authentication
    basicAuth:
      type: http
      scheme: basic
      description: Basic username/password authentication
externalDocs:
  description: JFrog Artifactory REST API Documentation
  url: https://jfrog.com/help/r/jfrog-rest-apis/artifactory-rest-apis