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 System API

Access service system information

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

Tagged areas include System. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, an API reference, and an engineering blog.

This API exposes 7 operations across 7 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 2.x.

Requests are made against 2 base URLs: https://{server}.jfrog.io/access, https://{host}/access.

7 operations 7 paths 1 schemas 7 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.x
Base URL
https://myserver.jfrog.io/artifactory/api
Authentication
HTTP Bearer, HTTP Basic
Contact
Terms of Service
Resource Areas
1

Authentication & Security 2

JFrog System API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • bearerAuth — Access token authentication
  • basicAuth — Basic username/password authentication

Paths & Operations 7

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

System 7

Access service system information

GET
/api/v1/system/ping
JFrog System Ping
systemPing → 200
GET
/api/v1/system/version
JFrog Get System Version
getSystemVersion → 200
GET
/v1/system/ping
JFrog System Ping
systemPing → 200
GET
/v1/system/version
JFrog Get System Version
getSystemVersion → 200
GET
/v1/system/info
JFrog Get System Info
getSystemInfo → 200
GET
/router/api/v1/system/ping
JFrog Platform Router Ping
routerPing → 200
GET
/router/api/v1/system/health
JFrog Get System Health
getSystemHealth → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is SystemHealth (2 properties). Each schema is shown below with its type and property counts.

SystemHealth
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jfrog-system-api-openapi.yml Raw ↑

Other APIs JFrog publishes across the network.

JFrog Access Tokens API
JFrog Artifacts & Storage API
JFrog Audit API
JFrog Builds API
JFrog Commands API
JFrog Components API
JFrog Deployments API
JFrog Device Groups API
JFrog Devices API
JFrog Distribution API
JFrog Evidence API
JFrog Execution API