Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

JFrog Artifactory System & Configuration API

System health, version, and configuration management

JFrog Artifactory System & Configuration API is one of 17 APIs that JFrog Artifactory publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include System & Configuration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, code examples, and 4 JSON Schemas.

This API exposes 6 operations across 5 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 7.x.

Requests are made against a single base URL, https://{server}/artifactory.

6 operations 5 paths 4 schemas 5 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
7.x
Base URL
https://artifactory.example.com/artifactory/api
Authentication
HTTP Bearer, API Key, HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 3

JFrog Artifactory System & Configuration API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the header as X-JFrog-Art-Api (ApiKeyAuth). It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • BearerAuth — Access token authentication
  • ApiKeyAuth — API key authentication via header
  • BasicAuth — HTTP Basic authentication

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 5 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

System & Configuration 6

System health, version, and configuration management

GET
/api/system/ping
JFrog Artifactory System Health Ping
systemPing → 200
GET
/api/system/version
JFrog Artifactory Get Version Information
getSystemVersion → 200401
GET
/api/system/configuration
JFrog Artifactory Get System Configuration
getSystemConfiguration → 200401403
PATCH
/api/system/configuration
JFrog Artifactory Update System Configuration
updateSystemConfiguration body → 200400401403
GET
/api/system/licenses
JFrog Artifactory Get License Information
getLicenseInfo → 200401
GET
/api/system/storage
JFrog Artifactory Get Storage Summary
getStorageSummary → 200401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are VersionInfo (4 properties), LicenseInfo (3 properties), StorageSummary (3 properties), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

StorageSummary
object
3 properties
ErrorResponse
object
1 property
VersionInfo
object
4 properties
LicenseInfo
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

artifactory-system-configuration-api-openapi.yml Raw ↑

Other APIs JFrog Artifactory publishes across the network.

JFrog Artifactory AQL Search API
JFrog Artifactory Artifactory Extensions API
JFrog Artifactory Artifacts & Storage API
JFrog Artifactory Base API
JFrog Artifactory Blobs API
JFrog Artifactory Build Diff API
JFrog Artifactory Build Info API
JFrog Artifactory Build Management API
JFrog Artifactory Build Promotion API
JFrog Artifactory Catalog API
JFrog Artifactory Manifests API
JFrog Artifactory Replication API