JFrog Summary API

Artifact and build vulnerability summaries

Operations 2

POST /v1/summary/artifact JFrog Get Artifact Summary #
POST /v1/summary/build JFrog Get Build Summary #

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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/jfrog-summary-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

jfrog-summary-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: JFrog Xray REST Summary API
  description: API for vulnerability scanning, license compliance, and impact analysis. JFrog Xray provides universal software composition analysis (SCA) that natively integrates with Artifactory to scan artifacts for known vulnerabilities, license compliance violations, and operational risks.
  version: 3.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/xray/api
  description: JFrog Cloud
  variables:
    server:
      default: myserver
      description: Your JFrog server name
- url: https://{host}/xray/api
  description: Self-hosted JFrog instance
  variables:
    host:
      default: localhost:8082
      description: Your self-hosted JFrog server host
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: Summary
  description: Artifact and build vulnerability summaries
paths:
  /v1/summary/artifact:
    post:
      operationId: getArtifactSummary
      summary: JFrog Get Artifact Summary
      description: Returns a summary of security issues and license information for specified artifacts.
      tags:
      - Summary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                paths:
                  type: array
                  items:
                    type: string
                  description: List of artifact paths in Artifactory
              required:
              - paths
      responses:
        '200':
          description: Artifact summary retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtifactSummary'
  /v1/summary/build:
    post:
      operationId: getBuildSummary
      summary: JFrog Get Build Summary
      description: Returns a summary of security issues for specified build.
      tags:
      - Summary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                build_name:
                  type: string
                build_number:
                  type: string
              required:
              - build_name
              - build_number
      responses:
        '200':
          description: Build summary retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildSummary'
components:
  schemas:
    ArtifactSummary:
      type: object
      properties:
        artifacts:
          type: array
          items:
            type: object
            properties:
              general:
                type: object
                properties:
                  name:
                    type: string
                  path:
                    type: string
                  sha256:
                    type: string
                  component_id:
                    type: string
              issues:
                type: array
                items:
                  $ref: '#/components/schemas/Issue'
              licenses:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                    full_name:
                      type: string
                    components:
                      type: array
                      items:
                        type: string
    Issue:
      type: object
      properties:
        issue_id:
          type: string
        severity:
          type: string
          enum:
          - Low
          - Medium
          - High
          - Critical
        summary:
          type: string
        description:
          type: string
        issue_type:
          type: string
        provider:
          type: string
        cves:
          type: array
          items:
            type: object
            properties:
              cve:
                type: string
              cvss_v2_score:
                type: string
              cvss_v3_score:
                type: string
        created:
          type: string
          format: date-time
        impacted_artifacts:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              display_name:
                type: string
              path:
                type: string
              sha256:
                type: string
    BuildSummary:
      type: object
      properties:
        build:
          type: object
          properties:
            build_name:
              type: string
            build_number:
              type: string
        issues:
          type: array
          items:
            $ref: '#/components/schemas/Issue'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Access token authentication
    basicAuth:
      type: http
      scheme: basic
      description: Basic username/password authentication
externalDocs:
  description: JFrog Xray REST API Documentation
  url: https://www.jfrog.com/confluence/display/JFROG/Xray+REST+API