JFrog Distribution API

openapi: 3.1.0
info:
  title: JFrog Access REST Access Tokens Distribution API
  description: API for managing users, groups, permissions, projects, and access tokens across the JFrog Platform. JFrog Access handles identity management, role-based access control, federated identity, and scoped token creation for authentication and authorization across all JFrog services.
  version: 2.x
  contact:
    name: JFrog
    url: https://jfrog.com
  license:
    name: Proprietary
    url: https://jfrog.com/terms-of-service/
  termsOfService: https://jfrog.com/terms-of-service/
servers:
- url: https://{server}.jfrog.io/access
  description: JFrog Cloud
  variables:
    server:
      default: myserver
      description: Your JFrog server name
- url: https://{host}/access
  description: Self-hosted JFrog instance
  variables:
    host:
      default: localhost:8082
      description: Your self-hosted JFrog server host
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: Distribution
  description: Distribute release bundles to edge nodes
paths:
  /v1/distribution/{name}/{version}:
    post:
      operationId: distributeReleaseBundle
      summary: JFrog Distribute Release Bundle
      description: Distributes a signed release bundle to target edge nodes.
      tags:
      - Distribution
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
        description: Release bundle name
      - name: version
        in: path
        required: true
        schema:
          type: string
        description: Release bundle version
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DistributionRequest'
      responses:
        '200':
          description: Distribution initiated
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Tracker ID for monitoring distribution status
  /v1/distribution/{name}/{version}/status:
    get:
      operationId: getDistributionStatus
      summary: JFrog Get Distribution Status
      description: Returns the distribution status for a release bundle version.
      tags:
      - Distribution
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
        description: Release bundle name
      - name: version
        in: path
        required: true
        schema:
          type: string
        description: Release bundle version
      responses:
        '200':
          description: Distribution status retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - Not distributed
                    - In progress
                    - Completed
                    - Failed
                  distribution_rules:
                    type: array
                    items:
                      type: object
                      properties:
                        site_name:
                          type: string
                        status:
                          type: string
  /v1/distribution/{name}/{version}/delete:
    post:
      operationId: deleteDistributedReleaseBundle
      summary: JFrog Delete Distributed Release Bundle
      description: Deletes a distributed release bundle from target edge nodes.
      tags:
      - Distribution
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
        description: Release bundle name
      - name: version
        in: path
        required: true
        schema:
          type: string
        description: Release bundle version
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DistributionRequest'
      responses:
        '200':
          description: Delete distribution initiated
  /v2/release_bundle/distribute/{name}/{version}:
    post:
      operationId: distributeReleaseBundle
      summary: JFrog Distribute Release Bundle v2
      description: Distributes a release bundle to specified edge nodes.
      tags:
      - Distribution
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
        description: Release bundle name
      - name: version
        in: path
        required: true
        schema:
          type: string
        description: Release bundle version
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DistributeRequest'
      responses:
        '200':
          description: Distribution initiated
  /v2/release_bundle/distribute/{name}/{version}/status:
    get:
      operationId: getDistributionStatus
      summary: JFrog Get Distribution Status
      description: Returns distribution status for a release bundle.
      tags:
      - Distribution
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
        description: Release bundle name
      - name: version
        in: path
        required: true
        schema:
          type: string
        description: Release bundle version
      responses:
        '200':
          description: Distribution status
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  sites:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        status:
                          type: string
components:
  schemas:
    DistributionRequest:
      type: object
      properties:
        dry_run:
          type: boolean
          default: false
        auto_create_missing_repositories:
          type: boolean
          default: false
        distribution_rules:
          type: array
          items:
            type: object
            properties:
              site_name:
                type: string
              city_name:
                type: string
              country_codes:
                type: array
                items:
                  type: string
      required:
      - distribution_rules
    DistributeRequest:
      type: object
      properties:
        auto_create_missing_repositories:
          type: boolean
          default: false
        distribution_rules:
          type: array
          items:
            type: object
            properties:
              site_name:
                type: string
      required:
      - distribution_rules
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Access token authentication
    basicAuth:
      type: http
      scheme: basic
      description: Basic username/password authentication
externalDocs:
  description: JFrog Access REST API Documentation
  url: https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-token-rest-api