JFrog Artifactory Extensions API

openapi: 3.2.0
info:
  title: JFrog Artifactory Docker Registry Artifactory Extensions API
  description: Docker Registry HTTP API V2 implementation in JFrog Artifactory. Provides endpoints for managing Docker images including pushing and pulling layers and manifests, listing tags, and managing repositories. Artifactory acts as a fully compliant Docker registry with additional features like promotion and property management.
  version: v2
  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}
  description: JFrog Artifactory Docker Registry
  variables:
    server:
      default: myserver.jfrog.io
      description: Your JFrog Platform deployment URL
security:
- BearerAuth: []
- BasicAuth: []
tags:
- name: Artifactory Extensions
  description: Artifactory-specific Docker API extensions
paths:
  /api/docker/{repoKey}/v2/promote:
    post:
      operationId: promoteDockerImage
      summary: JFrog Artifactory Promote Docker Image
      description: Artifactory-specific extension to promote a Docker image from one repository to another. This is useful for promoting images through staging environments (e.g., dev to staging to production).
      tags:
      - Artifactory Extensions
      parameters:
      - name: repoKey
        in: path
        required: true
        description: Source repository key
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DockerPromoteRequest'
      responses:
        '200':
          description: Image promoted successfully
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Insufficient permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    DockerPromoteRequest:
      type: object
      required:
      - targetRepo
      - dockerRepository
      properties:
        targetRepo:
          type: string
          description: Target repository key to promote to
          example: docker-prod-local
        dockerRepository:
          type: string
          description: Docker repository name (image path)
          example: myproject/myimage
        targetDockerRepository:
          type: string
          description: Target Docker repository name. If not specified, uses the same name as the source.
          example: myproject/myimage
        tag:
          type: string
          description: Tag to promote. If not specified, all tags are promoted.
          example: 1.0.0
        targetTag:
          type: string
          description: Target tag name. If not specified, uses the same tag.
          example: latest
        copy:
          type: boolean
          description: If true, copies instead of moves. Default is false (move).
          default: false
    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
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Docker token authentication. Obtain a token from the authentication service endpoint returned in the WWW-Authenticate header.
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using Artifactory credentials
externalDocs:
  description: JFrog Artifactory Docker Registry Documentation
  url: https://jfrog.com/help/r/jfrog-artifactory-documentation/docker-registry