Search


Cloud customer?
Upgrade in MyJFrog >


Working with an older version?

JFrog Artifactory 6.x
JFrog Xray 2.x
JFrog Mission Control 3.x
JFrog Distribution 1.x
JFrog Enterprise+ (Pre-Platform Release)




Usage

This version of GraphQL is a beta version and for now it only has a limited set of capabilities till future additions are made.

JFrog's Metadata Service has now enabled the integration of the metadata server with the GraphQL public API. Currently, only packages are supported, with more GraphQL capabilities coming in the near future. You can use the graphiql to learn about the GraphQL metadata schema and as a playground to test your queries. To access it,  <your server url>/metadata/api/v1/query/graphiql.

Authentication

To use the metadata server GraphQL you need a metadata scope access token. Generate a token by logging in to the JFrog platform as an Admin, and follow the steps in Access Tokens

Page Contents


Top-level Queries

Currently, only Packages are supported:

Packages: Query packages by name-pattern and retrieve all package related metadata from the metadata server.

Entities

Package 

Field

Type

name

String!

packageType

String!

created

Time!

modified

Time!

versionsCount

Int!

vcsUrl

String!

issiesUrl

String!

description

String!

latestVersion

String!

licenses

[License!] 

properties

[Property!]

qualifiers

[Qualifier!]

versions

[Version]

sources

[Source!]

tags

[String!]

stats

PackageStats

vulnerabilities

Vulnerabilities


Licenses

FieldType

name

String!

source

String!

description

String!

modified

Time!

url

String!


Properties

FieldType

name

String!

value

String!


Qualifiers

FieldType

name

String!

value

String!


Versions

FieldType

name

String!
sizeString!

created

Time!

modified

Time!
license
Entity
files
Entity
repos

VersionRepository

tags
Entity
stats
VersionsStats
qualifiers
Entity
properties
Entity
contributors
VersionContributors
vulnerabilities
VersionVulnerabilties


Sources

FieldType

name

String!

url

String!

modified

Time!

PackageStats

Field

Type

downloads

Int!

followers

Int!

VersionVulnerabilities

Field

Type

high

Int!

medium

Int!

low

Int!

info

Int!

unknown

Int!

skipped

Int!


Files

FieldType

name

String!

md5

String!

sha1

String!

sha256

String!

lead

Bolean

length

String!

arch

String!

dist

String!

compiler

String!

compilerVersion

String!

mimeType

String!
qualifiers
Entity

VersionRepository

FieldType

name

String!

url

String!

type

String!

leadFilePath

String!

VersionStats

Field

Type

downloadCount

Int!

VersionContributor

FieldType

name

String!

type

String!

email

String!

url

String!

Example

Here is a video demonstrating how to use the GraphQL playground to retrieve packages metadata:

GraphQL.mp4

  • No labels
Copyright © 2020 JFrog Ltd.