JFrog Artifactory Catalog API

List available repositories

OpenAPI Specification

artifactory-catalog-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: JFrog Artifactory Query Language (AQL) AQL Search Catalog 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: Catalog
  description: List available repositories
paths:
  /v2/_catalog:
    get:
      operationId: listRepositories
      summary: JFrog Artifactory List Repositories
      description: Returns a list of repositories available in the registry.
      tags:
      - Catalog
      parameters:
      - name: n
        in: query
        description: Maximum number of entries to return
        schema:
          type: integer
      - name: last
        in: query
        description: Last repository name for pagination
        schema:
          type: string
      responses:
        '200':
          description: Repository list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepositoryCatalog'
          headers:
            Link:
              description: RFC5988 link to next page of results
              schema:
                type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    RepositoryCatalog:
      type: object
      properties:
        repositories:
          type: array
          items:
            type: string
          description: List of repository names available
          example:
          - library/nginx
          - library/alpine
          - myproject/myimage
    ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                description: Error code
              message:
                type: string
                description: Error message
              detail:
                type: string
                description: Additional error details
  responses:
    Unauthorized:
      description: 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