JFrog Reports API

openapi: 3.1.0
info:
  title: JFrog Access REST Access Tokens Reports 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: Reports
  description: Vulnerability and compliance reports
paths:
  /v1/report/vulnerabilities:
    post:
      operationId: generateVulnerabilityReport
      summary: JFrog Generate Vulnerability Report
      description: Generates a vulnerability report for specified scope.
      tags:
      - Reports
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                resources:
                  type: object
                  properties:
                    repositories:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                filters:
                  type: object
                  properties:
                    severity:
                      type: array
                      items:
                        type: string
                    has_remediation:
                      type: boolean
              required:
              - name
              - resources
      responses:
        '200':
          description: Report generation started
          content:
            application/json:
              schema:
                type: object
                properties:
                  report_id:
                    type: integer
                  status:
                    type: string
  /v1/report/{reportId}:
    get:
      operationId: getReportStatus
      summary: JFrog Get Report Status
      description: Returns the status and details of a report.
      tags:
      - Reports
      parameters:
      - name: reportId
        in: path
        required: true
        schema:
          type: integer
        description: Report ID
      responses:
        '200':
          description: Report status retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                  status:
                    type: string
                    enum:
                    - pending
                    - running
                    - completed
                    - failed
    delete:
      operationId: deleteReport
      summary: JFrog Delete Report
      description: Deletes a generated report.
      tags:
      - Reports
      parameters:
      - name: reportId
        in: path
        required: true
        schema:
          type: integer
        description: Report ID
      responses:
        '200':
          description: Report deleted
components:
  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