Component Identifiers

Xray REST APIs
Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Several endpoints require the use of a Component ID which must be formatted, according to its package type, using the convention described in the following table:

Package Type

Identifier

Example

Maven

gav://group:artifact:version

gav://ant:ant:1.6.5

Docker and OCI

docker://Namespace/name:tag

docker://jfrog/artifactory-oss:latest

RPM

rpm://os-version:package:epoch-version:version

rpm://7:rpm-python:7:4.11.3-43.el7

Debian

deb://vendor:dist:package:version

deb://ubuntu:trustee:acl:2.2.49-2

NuGet

nuget://module:version

nuget://log4net:9.0.1

Generic file

generic://sha256:<Checksum>/name

generic://sha256:244fd47e07d1004f0aed9c156aa09083c82bf8944eceb67c946ff7430510a77b/foo.jar

NPM

npm://package:version

npm://mocha:2.4.5

Python

pypi://package:version

pypi://raven:5.13.0

Composer

composer://package:version

composer://nunomaduro/collision:1.1

Golang

go://package:version

go://github.com/ethereum/go-ethereum:1.8.2

Alpine

alpine://branch:package:version

alpine://3.7:htop:2.0.2-r0

Conan

conan://vendor:name:version

conan://openssl:openssl:1.1.1g

Conda

conda://name:version

conda://matplotlib-base:3.5.3

CRAN

cran://name:version

cran://abess:0.4.7

Cargo

cargo://name:version

cargo://google_maps:3.0.1

Hugging Face ML

huggingfaceml://model_name:model_revision

huggingfaceml://mustrr/gpt2-elite:a1c740be581fa80e2d19961d15da96cb162fff85

Terraform state

For Terraform state use the generic file identifier

generic://sha256:147f9242fa6fa57cd7467ffd9450afc734860944e8c04e97b28a03c9c6328e24/state.latest.json

In addition Build, Release Bundle, and Release Bundle V2 have dedicated identifiers:

Resource Type

Identifier

Example

Build Version

build://[buildRepo]/buildName:buildVersion

[buildRepo] is optional

It’s required if the build is in a Project scope.

build://infra-build:2.3

build://[core-project]/our-build:2.3

Release Bundle Version

releaseBundle://bundleName:bundleVersion

releaseBundle://MyRB:1.0

Release Bundle V2 Version

releaseBundleV2://[bundleRepoName]/bundleName:bundleVersion

[bundleRepoName] is required

releaseBundleV2://[release-bundles-v2]/MyRBV2:1.0