JFrog Artifactory Search API

openapi: 3.1.0
info:
  title: JFrog Artifactory Query Language (AQL) AQL Search API
  description: Advanced search API using Artifactory Query Language (AQL), a SQL-like query language for finding and filtering artifacts, builds, and entries in JFrog Artifactory. AQL provides powerful querying capabilities including domain queries, field filtering, sorting, limiting, and inclusion of related entities.
  version: 7.x
  contact:
    name: JFrog Support
    url: https://jfrog.com/support/
    email: support@jfrog.com
  license:
    name: Proprietary
    url: https://jfrog.com/terms-of-service/
  termsOfService: https://jfrog.com/terms-of-service/
servers:
- url: https://{server}/artifactory
  description: JFrog Artifactory Server
  variables:
    server:
      default: myserver.jfrog.io
      description: Your JFrog Platform deployment URL
security:
- BearerAuth: []
- ApiKeyAuth: []
- BasicAuth: []
tags:
- name: Search
  description: Search for artifacts using various criteria
paths:
  /api/search/artifact:
    get:
      operationId: searchArtifactByName
      summary: JFrog Artifactory Artifact Search (Quick Search)
      description: Searches for artifacts by name in the specified repositories.
      tags:
      - Search
      parameters:
      - name: name
        in: query
        required: true
        description: Artifact name or partial name to search for
        schema:
          type: string
      - name: repos
        in: query
        description: Comma-separated list of repository keys to search in
        schema:
          type: string
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResults'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/search/gavc:
    get:
      operationId: searchByGAVC
      summary: JFrog Artifactory GAVC Search
      description: Searches for Maven artifacts by groupId, artifactId, version, and classifier coordinates.
      tags:
      - Search
      parameters:
      - name: g
        in: query
        description: Maven groupId
        schema:
          type: string
      - name: a
        in: query
        description: Maven artifactId
        schema:
          type: string
      - name: v
        in: query
        description: Maven version
        schema:
          type: string
      - name: c
        in: query
        description: Maven classifier
        schema:
          type: string
      - name: repos
        in: query
        description: Comma-separated list of repository keys to search in
        schema:
          type: string
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResults'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/search/checksum:
    get:
      operationId: searchByChecksum
      summary: JFrog Artifactory Checksum Search
      description: Searches for artifacts matching a specific checksum (SHA-1, SHA-256, or MD5).
      tags:
      - Search
      parameters:
      - name: sha1
        in: query
        description: SHA-1 checksum value
        schema:
          type: string
      - name: sha256
        in: query
        description: SHA-256 checksum value
        schema:
          type: string
      - name: md5
        in: query
        description: MD5 checksum value
        schema:
          type: string
      - name: repos
        in: query
        description: Comma-separated list of repository keys to search in
        schema:
          type: string
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResults'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/search/prop:
    get:
      operationId: searchByProperty
      summary: JFrog Artifactory Property Search
      description: Searches for artifacts with specific properties.
      tags:
      - Search
      parameters:
      - name: repos
        in: query
        description: Comma-separated list of repository keys to search in
        schema:
          type: string
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResults'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/search/dates:
    get:
      operationId: searchByDate
      summary: JFrog Artifactory Date-based Search
      description: Searches for artifacts created or modified within a date range.
      tags:
      - Search
      parameters:
      - name: from
        in: query
        description: Start date in milliseconds since epoch
        schema:
          type: integer
          format: int64
      - name: to
        in: query
        description: End date in milliseconds since epoch
        schema:
          type: integer
          format: int64
      - name: repos
        in: query
        description: Comma-separated list of repository keys to search in
        schema:
          type: string
      - name: dateFields
        in: query
        description: Date fields to search on (created, lastModified, lastDownloaded)
        schema:
          type: string
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResults'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/search/creation:
    get:
      operationId: searchByCreationDate
      summary: JFrog Artifactory Creation Date Search
      description: Searches for artifacts created in a specific date range.
      tags:
      - Search
      parameters:
      - name: from
        in: query
        description: Start date in milliseconds since epoch
        schema:
          type: integer
          format: int64
      - name: to
        in: query
        description: End date in milliseconds since epoch
        schema:
          type: integer
          format: int64
      - name: repos
        in: query
        description: Comma-separated list of repository keys to search in
        schema:
          type: string
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResults'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    SearchResults:
      type: object
      properties:
        results:
          type: array
          items:
            type: object
            properties:
              uri:
                type: string
                format: uri
                description: URI to the artifact storage info
    ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              status:
                type: integer
                description: HTTP status code
              message:
                type: string
                description: Error message
  responses:
    Unauthorized:
      description: Unauthorized - authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Access token authentication
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-JFrog-Art-Api
      description: API key authentication via header
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication
externalDocs:
  description: Artifactory Query Language Documentation
  url: https://jfrog.com/help/r/jfrog-artifactory-documentation/artifactory-query-language