brightsec-com API

openapi: 3.1.0
info:
  title: brightsec-com API
  version: '2026-10-29'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-29: 13 operation(s) read from 11 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; brightsec-com has published no machine-readable contract
    that the pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 4
    documentation: 9
    pages-with-code: 8
    pages-read: 11
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-29'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://docs.brightsec.com/docs/integrating-with-the-bright-api
  - https://docs.brightsec.com/docs/gitlab-integration-examples
  - https://docs.brightsec.com/docs/gitlab-integration-examples.md
  - https://docs.brightsec.com/docs/travis-ci-integration-examples
  - https://docs.brightsec.com/docs/travis-ci-integration-examples.md
  - https://docs.brightsec.com/docs/integrating-with-the-bright-api.md
  - https://docs.brightsec.com/recipes/bright-cli-installation-on-linux-macos.md
  - https://docs.brightsec.com/docs/cli-standalone-installation
  - https://docs.brightsec.com/docs/cli-standalone-installation.md
  - https://docs.brightsec.com/docs/create-scan-by-status
  - https://docs.brightsec.com/docs/star-installation
servers:
- url: https://app.brightsec.com
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://docs.brightsec.com/docs/gitlab-integration-examples.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -y\n  script:\n  - echo \"Start Bright Scan \U0001F3C1\"\n  - >\n    SCAN_ID=$(bright-cli scan:run --token $BRIGHT_TOKEN\n\
          \    --name \"GitLab Integration Scan\"\n    --project $PROJECT_ID\n    --crawler https://brokencrystals.com\n    --smart)\n  - echo\
          \ \"export SCAN_ID=$SCAN_ID\" > $CI_PROJECT_DIR/variables\n  - printf \"Scan was started with ID https://app.brightsec.com/scans/$SCAN_ID\\\
          n\"\n  - printf \"Wait for issues "
  /BrightSec/bright-cli/releases/latest/download/{downloadid}:
    get:
      operationId: get_BrightSec_bright_cli_releases_latest_download_downloadid
      tags:
      - Brightsec
      summary: Download Bright CLI standalone executable for Linux.
      x-source: https://docs.brightsec.com/docs/cli-standalone-installation
      parameters:
      - name: downloadid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at downloadId
  /api/v1/project-issues/{projectissueid}:
    get:
      operationId: get_api_v1_project_issues_projectissueid
      tags:
      - Api
      summary: Get Detailed Information for a Single Vulnerability - retrieve rich context about a single vulnerability using the projectIssueId.
      x-source: https://docs.brightsec.com/docs/integrating-with-the-bright-api
      parameters:
      - name: projectissueid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1ProjectIssuesProjectissueidResponse'
      x-evidence:
        kind: documentation
  /api/v1/scans:
    get:
      operationId: get_api_v1_scans
      tags:
      - Api
      summary: GET /api/v1/scans
      x-source: https://docs.brightsec.com/docs/gitlab-integration-examples
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl request to get all the scan issues and after that we parse the Id with jq\n GET_ID=$(curl -X 'GET' 'https://app.brightsec.com/api/v1/scans/'$SCAN_ID'/issues'\
          \ -H 'accept: application/json' -H 'Authorization: Api-Key '$BRIGHT_TOKEN'' | jq '.[].id' )"
    post:
      operationId: post_api_v1_scans
      tags:
      - Api
      summary: Scan by Status is a scan type that lets you run on-demand or scheduled scans based on the status of Entry Points (EPs) in your
        project.
      x-source: https://docs.brightsec.com/docs/create-scan-by-status
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1ScansRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/me/org/groups:
    get:
      operationId: get_api_v2_me_org_groups
      tags:
      - Api
      summary: Get Organization Groups - retrieve groups associated with the organization.
      x-source: https://docs.brightsec.com/docs/integrating-with-the-bright-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/projects:
    get:
      operationId: get_api_v2_projects
      tags:
      - Api
      summary: Get All Available Projects - returns a paginated array of all available project objects.
      x-source: https://docs.brightsec.com/docs/integrating-with-the-bright-api
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: The maximum number of items per response.
      - name: offset
        in: query
        required: false
        schema:
          type: integer
        description: The number of items to skip from the beginning of the list.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV2ProjectsResponse'
      x-evidence:
        kind: documentation
  /api/v2/projects/{projectid}:
    get:
      operationId: get_api_v2_projects_projectid
      tags:
      - Api
      summary: Get Project Details - retrieve detailed information about a specific project.
      x-source: https://docs.brightsec.com/docs/integrating-with-the-bright-api
      parameters:
      - name: projectid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/projects/{projectid}/entry-points:
    get:
      operationId: get_api_v2_projects_projectid_entry_points
      tags:
      - Api
      summary: Get Entry Points for a Project - retrieve all entry points associated with a project.
      x-source: https://docs.brightsec.com/docs/integrating-with-the-bright-api
      parameters:
      - name: projectid
        in: path
        required: true
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: The maximum number of items per response.
      - name: nextId
        in: query
        required: false
        schema:
          type: string
        description: The ID of the last item from the previous response.
      - name: nextCreatedAt
        in: query
        required: false
        schema:
          type: string
        description: The creation timestamp of the last item from the previous response.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/projects/{projectid}/entry-points/summary:
    get:
      operationId: get_api_v2_projects_projectid_entry_points_summary
      tags:
      - Api
      summary: Get Host Summaries for Project Entry Points - returns a summary of hosts related to all scanned entry points in the project.
      x-source: https://docs.brightsec.com/docs/integrating-with-the-bright-api
      parameters:
      - name: projectid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV2ProjectsProjectidEntryPointsSummaryResponse'
      x-evidence:
        kind: documentation
  /api/v2/projects/{projectid}/issues:
    get:
      operationId: get_api_v2_projects_projectid_issues
      tags:
      - Api
      summary: Get Vulnerabilities for a Specific Project - retrieve all the issues (vulnerabilities) identified within that project.
      x-source: https://docs.brightsec.com/docs/integrating-with-the-bright-api
      parameters:
      - name: projectid
        in: path
        required: true
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: The maximum number of items per response.
      - name: nextId
        in: query
        required: false
        schema:
          type: string
        description: The ID of the last item from the previous response.
      - name: nextCreatedAt
        in: query
        required: false
        schema:
          type: string
        description: The creation timestamp of the last item from the previous response.
      - name: certainty
        in: query
        required: false
        schema:
          type: boolean
        description: Filter for verified vulnerabilities (true) or unverified (false).
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV2ProjectsProjectidIssuesResponse'
      x-evidence:
        kind: documentation
  /api/v2/projects/{projectid}/issues/summary:
    get:
      operationId: get_api_v2_projects_projectid_issues_summary
      tags:
      - Api
      summary: Get Host Summaries for Project Issues - returns a summary of hosts where vulnerabilities have been found.
      x-source: https://docs.brightsec.com/docs/integrating-with-the-bright-api
      parameters:
      - name: projectid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV2ProjectsProjectidIssuesSummaryResponse'
      x-evidence:
        kind: documentation
  /docker/compose/releases/download/1.26.0/docker-compose-$(uname:
    get:
      operationId: get_docker_compose_releases_download_1_26_0_docker_compose_uname
      tags:
      - Docker
      summary: GET /docker/compose/releases/download/1.26.0/docker-compose-$(uname
      x-source: https://docs.brightsec.com/docs/gitlab-integration-examples
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl\n - curl -L \"https://github.com/docker/compose/releases/download/1.26.0/docker-compose-$(uname -s)-$(uname -m)\" -o /usr/local/bin/docker-compose\n\
          \ - chmod +x /usr/local/bin/docker-compose\n - apt-get -y install apt-transport-https ca-certificates curl software-properties-common\n\
          \ - curl -fsSL https://download.docker.com/linux/ubuntu/gpg | apt-key add -\n - add-apt-repository \"deb [arch=amd64] http"
components:
  schemas:
    GetApiV1ProjectIssuesProjectissueidResponse:
      type: object
      properties:
        projectIssueId:
          type: string
          description: Unique vulnerability identifier
        name:
          type: string
          description: Vulnerability name
        type:
          type: string
          description: Vulnerability type
    PostApiV1ScansRequest:
      type: object
      properties:
        entryPointsStatuses:
          type: array
          description: 'The list of statuses to filter by. Possible values: new, changed, tested, vulnerable'
      required:
      - entryPointsStatuses
    GetApiV2ProjectsResponse:
      type: object
      properties:
        projectId:
          type: string
          description: Unique ID for each project
    GetApiV2ProjectsProjectidEntryPointsSummaryResponse:
      type: object
      properties:
        hosts:
          type: array
          description: Summary of hosts related to scanned entry points
    GetApiV2ProjectsProjectidIssuesResponse:
      type: object
      properties:
        id:
          type: string
          description: Issue ID for cursor-based pagination
        createdAt:
          type: string
          description: Creation timestamp for cursor-based pagination
        projectIssueId:
          type: string
          description: Unique vulnerability identifier across scans
        name:
          type: string
          description: Issue name (e.g., CVE-2024-6531)
        type:
          type: string
          description: Issue type (same as name field)
        certainty:
          type: boolean
          description: Whether Bright fully verified the vulnerability
    GetApiV2ProjectsProjectidIssuesSummaryResponse:
      type: object
      properties:
        hosts:
          type: array
          description: Summary of hosts where vulnerabilities have been found
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization
security:
- apiKey: []
tags:
- name: Api
- name: Brightsec
- name: Docker