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

List, delete, and manage builds

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

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

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

4 operations 3 paths 2 schemas 1 DELETE1 GET2 POST

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 Management 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 4

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

Build Management 4

List, delete, and manage builds

DELETE
/api/build/{buildName}
Delete Build
deleteBuild 4 params → 200401404
POST
/api/build/rename/{buildName}
Rename Build
renameBuild 2 params → 200401404
POST
/api/build/retention/{buildName}
Set Build Retention
setBuildRetention 1 param body → 200400401
GET
/api/build/retention/{buildName}
Get Build Retention
getBuildRetention 1 param → 200401404

Schemas 2

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

BuildRetentionConfig
object
4 properties
ErrorResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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