JFrog Release Bundles V2 API

Create and manage release bundles v2

Documentation

📖
Documentation
https://www.jfrog.com/confluence/display/JFROG/Artifactory+REST+API
📖
Authentication
https://www.jfrog.com/confluence/display/JFROG/Access+Tokens
📖
GettingStarted
https://jfrog.com/help/r/jfrog-artifactory-documentation/use-the-rest-api
📖
Documentation
https://jfrog.com/help/r/jfrog-rest-apis/artifactory-rest-api-v2
📖
Authentication
https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-tokens
📖
Documentation
https://www.jfrog.com/confluence/display/JFROG/Xray+REST+API
📖
GettingStarted
https://jfrog.com/help/r/xray-rest-apis/introduction-to-the-xray-rest-apis
📖
Documentation
https://www.jfrog.com/confluence/display/JFROG/Distribution+REST+API
📖
Documentation
https://www.jfrog.com/confluence/display/JFROG/Pipelines+REST+API
📖
GettingStarted
https://jfrog.com/help/r/jfrog-rest-apis/introduction-to-the-pipelines-rest-apis
📖
Documentation
https://www.jfrog.com/confluence/display/JFROG/JFrog+Platform+REST+API
📖
GettingStarted
https://jfrog.com/help/r/jfrog-rest-apis/introduction-to-the-jfrog-platform-rest-apis
📖
Documentation
https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-token-rest-api
📖
GettingStarted
https://jfrog.com/help/r/jfrog-platform-administration-documentation/introduction-to-access-tokens
📖
Documentation
https://jfrog.com/help/r/jfrog-rest-apis/jfrog-curation-rest-apis
📖
Documentation
https://jfrog.com/help/r/jfrog-rest-apis/mission-control-rest-apis
📖
Documentation
https://jfrog.com/help/r/jfrog-rest-apis/release-lifecycle-management
📖
Documentation
https://jfrog.com/help/r/jfrog-rest-apis/workers-rest-apis
📖
Documentation
https://jfrog.com/help/r/jfrog-ml-documentation/jfrog-ml-rest-api
📖
Documentation
https://docs.connect.jfrog.io/rest-api-v2/connect-api-reference
📖
Authentication
https://docs.connect.jfrog.io/developers
📖
Documentation
https://jfrog.com/help/r/jfrog-security-user-guide/products/catalog
📖
Documentation
https://jfrog.com/help/r/jfrog-artifactory-documentation/create-evidence-using-rest-apis

Specifications

Other Resources

OpenAPI Specification

jfrog-release-bundles-v2-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: JFrog Access REST Access Tokens Release Bundles V2 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: Release Bundles V2
  description: Create and manage release bundles v2
paths:
  /v2/release_bundle:
    post:
      operationId: createReleaseBundle
      summary: JFrog Create Release Bundle v2
      description: Creates a new release bundle version 2 from specified artifacts.
      tags:
      - Release Bundles V2
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReleaseBundleV2Request'
      responses:
        '201':
          description: Release bundle created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReleaseBundleV2'
        '400':
          description: Invalid request
  /v2/release_bundle/records:
    get:
      operationId: listReleaseBundles
      summary: JFrog List Release Bundles v2
      description: Returns a list of all release bundle v2 records.
      tags:
      - Release Bundles V2
      parameters:
      - name: name
        in: query
        schema:
          type: string
        description: Filter by release bundle name
      - name: after
        in: query
        schema:
          type: string
        description: Cursor for pagination
      - name: limit
        in: query
        schema:
          type: integer
          default: 25
        description: Maximum number of results
      responses:
        '200':
          description: Release bundles list
          content:
            application/json:
              schema:
                type: object
                properties:
                  release_bundles:
                    type: array
                    items:
                      $ref: '#/components/schemas/ReleaseBundleV2Summary'
  /v2/release_bundle/records/{name}/{version}:
    get:
      operationId: getReleaseBundle
      summary: JFrog Get Release Bundle v2
      description: Returns details for a specific release bundle version.
      tags:
      - Release Bundles V2
      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: Release bundle details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReleaseBundleV2'
    delete:
      operationId: deleteReleaseBundle
      summary: JFrog Delete Release Bundle v2
      description: Deletes a release bundle version.
      tags:
      - Release Bundles V2
      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:
        '204':
          description: Release bundle deleted
components:
  schemas:
    ReleaseBundleV2Request:
      type: object
      properties:
        release_bundle_name:
          type: string
        release_bundle_version:
          type: string
        skip_docker_manifest_resolution:
          type: boolean
          default: false
        source_type:
          type: string
          enum:
          - artifacts
          - builds
          - release_bundles
          - aql
        source:
          type: object
          properties:
            artifacts:
              type: array
              items:
                type: object
                properties:
                  path:
                    type: string
                  sha256:
                    type: string
            builds:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  number:
                    type: string
                  project:
                    type: string
            release_bundles:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  version:
                    type: string
                  project_key:
                    type: string
            aql:
              type: string
      required:
      - release_bundle_name
      - release_bundle_version
      - source_type
      - source
    ReleaseBundleV2:
      type: object
      properties:
        name:
          type: string
        version:
          type: string
        status:
          type: string
          enum:
          - CREATED
          - SIGNED
          - PROMOTED
          - DISTRIBUTED
        created:
          type: string
          format: date-time
        created_by:
          type: string
        source_type:
          type: string
        artifacts:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
              sha256:
                type: string
              size:
                type: integer
        current_environment:
          type: string
        promotion_history:
          type: array
          items:
            type: object
            properties:
              environment:
                type: string
              promoted_at:
                type: string
                format: date-time
              promoted_by:
                type: string
    ReleaseBundleV2Summary:
      type: object
      properties:
        name:
          type: string
        version:
          type: string
        status:
          type: string
        created:
          type: string
          format: date-time
        artifacts_count:
          type: integer
        current_environment:
          type: string
  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