Get Release Bundle v2 Version (GraphQL)

JFrog REST APIs

Content Type
REST API

Description: Returns the requested data for the Release Bundle v2 version defined by the One Model GraphQL query.

Important

When operating in a Self-Hosted environment, you must enable the Evidence service in the system.yamlArtifactory System YAML file as a prerequisite to using this endpoint. Add the following:

evidence:
  enabled: true

Since: 7.111.4

Security: Requires a valid token; requires Read permissions for the specified Release Bundle

Usage: POST /onemodel/api/v1/graphql

Tip

To jump directly to common use cases & examples, click here.

Query a Release Bundle Version

Use the getVersion query to fetch a specific Release Bundle version. This is the primary entry point for all Release Bundle version data.

getVersion

Fetches a single Release Bundle version identified by its name, version, and location (repository or project).

query {
  releaseBundleVersion {
    getVersion(name: "my-release-bundle", version: "1.0.0") {
      # Fields to retrieve
      createdBy
      createdAt
    }
  }
}

 

Field

Required/Optional

Type

Description

name

required

string

The name of the Release Bundle.

version

required

string

The Release Bundle version.

repositoryKey

optional

string

The repository key where the Release Bundle is stored. The default is release-bundles-v2.

projectKey

optional

string

The project key associated with the Release Bundle. If used without repositoryKey, it resolves to the project's default Release Bundle repository ([project-key]-release-bundles-v2).

Repository Selection Logic

This API uses a specific order of preference to determine which repository to query:

  1. repositoryKey is provided: The query targets the specified repository directly. The projectKey is ignored, if provided.

  2. projectKey is provided alone: The query targets the default Release Bundle repository within the specified project.

  3. Neither is provided: The query targets the default global repository, release-bundles-v2.

ReleaseBundleVersion Type

This type represents a specific Release Bundle version and contains all its associated data.

Field

Type

Description

createdBy

string

The user who created the Release Bundle version.

createdAt

date

The timestamp of when the Release Bundle version was created.

artifactsConnection

ReleaseBundleVersionArtifact

Use this connection to retrieve a paginated list of artifacts included in the Release Bundle version. You can filter the results.

evidenceConnection

EvidenceConnection

Use this connection to retrieve a paginated list of evidence associated with the Release Bundle version. You can filter the results based on certain criteria:

hasEvidence: When set to true, returns only those artifacts with associated evidence. Set to false to return all artifacts.

For more information about evidence, see Search Evidence.

fromBuilds

array:ReleaseBundleVersionBuild

A list of source builds used to create the Release Bundle version.

Note

Fields such as ReleaseBundleVersionArtifact and EvidenceConnection use a cursor-based pagination model, which is a standard GraphQL pattern for handling large data sets efficiently.

For more information, see One Model GraphQL Common Patterns and Conventions.

Detailed Object Types

Status Codes

Code

Message

Description

200

Ok

The request was successful.

401

Bad Credentials

The request failed because the provided authentication token is invalid or expired.

403

Permission Denied

The request failed because the authenticated user does not have the required Read permissions for the subject repository.