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 AQL Search API

Execute AQL queries to search for artifacts, builds, and entries

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

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

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

1 operations 1 paths 3 schemas 1 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 AQL Search 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

AQL Search 1

Execute AQL queries to search for artifacts, builds, and entries

POST
/api/search/aql
JFrog Artifactory Execute AQL Query
executeAqlQuery body → 200400401403

Schemas 3

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

AqlResultItem
object
A single result item. Fields present depend on the queried domain and the include clause. For the items domain, common fields are shown.
19 properties
ErrorResponse
object
1 property
AqlResult
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

artifactory-aql-search-api-openapi.yml Raw ↑

Other APIs JFrog Artifactory publishes across the network.

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
JFrog Artifactory Repositories API