> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cybedefend.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Start GitHub Container Registry scan

> Initiates a vulnerability scan for a container image hosted on ghcr.io. Uses the GitHub App installation token or configured PAT for authentication. The image is validated to ensure it belongs to the organization before scanning.



## OpenAPI

````yaml post /integrations/github-container-registry/project/{projectId}/scan
openapi: 3.0.0
info:
  title: Cybedefend API
  description: >-
    CybeDefend is an advanced API for application security analysis. Key
    features include OAuth 2.0 authentication, user/organization/project
    management, and REBAC-based permissions. It excels in static, dynamic, and
    IaC security analyses (SAST, DAST, IaC, etc.).
  version: '1.0'
  contact: {}
servers:
  - url: https://api-eu.cybedefend.com
    description: EU
  - url: https://api-us.cybedefend.com
    description: US
security: []
tags: []
paths:
  /integrations/github-container-registry/project/{projectId}/scan:
    post:
      tags:
        - GitHub Container Registry
      summary: Start GitHub Container Registry scan
      description: >-
        Initiates a vulnerability scan for a container image hosted on ghcr.io.
        Uses the GitHub App installation token or configured PAT for
        authentication. The image is validated to ensure it belongs to the
        organization before scanning.
      operationId: GithubContainerRegistryProjectController_startContainerScan
      parameters:
        - name: projectId
          required: true
          in: path
          description: CybeDefend project ID
          schema:
            format: uuid
            example: 550e8400-e29b-41d4-a716-446655440000
            type: string
      requestBody:
        required: true
        description: Container scan configuration
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GithubStartContainerScanDto'
      responses:
        '202':
          description: Scan request accepted and queued for processing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartScanResponseDto'
        '400':
          description: Bad request - Invalid input data
          content:
            application/json:
              schema:
                example:
                  message: Bad Request
                  statusCode: 400
                  timestamp: '2025-02-18T12:31:18.491Z'
                  path: /example/path
        '401':
          description: Unauthorized - Invalid or missing authentication
          content:
            application/json:
              schema:
                example:
                  message: Unauthorized
                  statusCode: 401
                  timestamp: '2025-02-18T12:31:18.491Z'
                  path: /example/path
        '403':
          description: >-
            Forbidden - Insufficient permissions or image does not belong to
            organization
          content:
            application/json:
              schema:
                example:
                  message: Forbidden
                  statusCode: 403
                  timestamp: '2025-02-18T12:31:18.491Z'
                  path: /example/path
        '404':
          description: Project not found, GitHub App not installed, or image not found
          content:
            application/json:
              schema:
                example:
                  message: Resource not found
                  statusCode: 404
                  timestamp: '2025-02-18T12:31:18.491Z'
                  path: /example/path
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                example:
                  message: Internal server error
                  statusCode: 500
                  timestamp: '2025-02-18T12:31:18.491Z'
                  path: /example/path
components:
  schemas:
    GithubStartContainerScanDto:
      type: object
      properties:
        imageName:
          type: string
          description: >-
            Image name with tag to scan (e.g., "my-app:v1.0.0" or
            "my-app@sha256:...")
          example: my-app:v1.0.0
        branch:
          type: string
          description: Branch name for tracking purposes
          example: main
        privateScan:
          type: boolean
          description: Whether the scan results should be private
          default: false
        severities:
          description: Vulnerability severities to include
          example:
            - CRITICAL
            - HIGH
          type: array
          items:
            type: string
      required:
        - imageName
    StartScanResponseDto:
      type: object
      properties:
        success:
          type: boolean
          description: Whether the scan started successfully
        message:
          type: string
          description: Message describing the scan start result
        scanId:
          type: string
          description: The unique identifier of the created scan
        detectedLanguages:
          description: Detected languages (if any) during scan initialization
          type: array
          items:
            type: string
      required:
        - success
        - message

````