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 Build Info API

Publish and retrieve build information

JFrog Artifactory Build Info 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 Build Info. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, code examples, and 4 JSON Schemas.

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

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

3 operations 3 paths 7 schemas 2 GET1 PUT

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 Build Info 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 3

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

Build Info 3

Publish and retrieve build information

PUT
/api/build
Publish Build Info
publishBuildInfo body → 204400401403
GET
/api/build/{buildName}
Get Build Runs
getBuildRuns 1 param → 200401404
GET
/api/build/{buildName}/{buildNumber}
Get Build Information
getBuildInfo 3 params → 200401404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are BuildInfo (16 properties), BuildInfoPublish (15 properties), BuildStatus (6 properties), BuildModule (3 properties). Each schema is shown below with its type and property counts.

BuildStatus
object
6 properties
ErrorResponse
object
1 property
BuildInfoPublish
object
15 properties 4 required
BuildInfoResponse
object
2 properties
BuildRuns
object
2 properties
BuildInfo
object
16 properties
BuildModule
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

artifactory-build-info-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 Management API
JFrog Artifactory Build Promotion API
JFrog Artifactory Catalog API
JFrog Artifactory Manifests API
JFrog Artifactory Replication API
JFrog Artifactory Repositories API