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

# Get Dataset

> Retrieve a dataset by its public id. Numeric primary keys are an internal
implementation detail and should not be exposed to clients. If the
provided id does not match any existing dataset a 404 is returned.



## OpenAPI

````yaml /api-reference/openapi.json get /api/datasets/{dataset_id}
openapi: 3.1.0
info:
  title: Blindsight API
  version: 0.1.0
  description: >-
    The full Blindsight REST surface, generated from the running application.
    Replace the server host with your own deployment.


    For the Runtime Security integration surface (scan, proxy, tool calls) see
    the Runtime Security spec, which is hand written and carries worked
    examples.
servers:
  - url: https://api.your-blindsight.com
    description: Your Blindsight deployment
security: []
tags:
  - name: Authentication
  - name: Single sign-on
  - name: Social sign-in
  - name: SCIM provisioning
  - name: Projects
  - name: Datasets
  - name: Uploads and imports
  - name: Scans
  - name: Schedules
  - name: Healing
  - name: RAG corpora
  - name: Custom rules
  - name: Playground
  - name: Search and activity
  - name: Apps
  - name: Devices and agents
  - name: Discovery
  - name: DLP policy
  - name: DLP installation
  - name: Compliance
  - name: Audit trail
  - name: Reports
  - name: Export templates
  - name: Workspaces
  - name: Users
  - name: Invitations
  - name: API keys
  - name: Settings
  - name: Directory sync
  - name: Integrations
  - name: Pending actions
  - name: License
  - name: Onboarding
  - name: Support
  - name: Platform operations
  - name: Webhooks
paths:
  /api/datasets/{dataset_id}:
    get:
      tags:
        - Datasets
      summary: Get Dataset
      description: >-
        Retrieve a dataset by its public id. Numeric primary keys are an
        internal

        implementation detail and should not be exposed to clients. If the

        provided id does not match any existing dataset a 404 is returned.
      operationId: get_dataset_api_datasets__dataset_id__get
      parameters:
        - name: dataset_id
          in: path
          required: true
          schema:
            type: string
            title: Dataset Id
        - name: branch
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Optional branch name to resolve within the dataset family.
            title: Branch
          description: Optional branch name to resolve within the dataset family.
        - name: include_scan_issue_counts
          in: query
          required: false
          schema:
            type: boolean
            description: >-
              Include per-scan issue severity breakdowns in the embedded scans
              list.
            default: false
            title: Include Scan Issue Counts
          description: >-
            Include per-scan issue severity breakdowns in the embedded scans
            list.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    DatasetOut:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        branch_name:
          type: string
          title: Branch Name
          default: main
        is_main_branch:
          type: boolean
          title: Is Main Branch
          default: true
        branch_family_uuid:
          anyOf:
            - type: string
            - type: 'null'
          title: Branch Family Uuid
        source_branch_uuid:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Branch Uuid
        branch_origin:
          anyOf:
            - type: string
            - type: 'null'
          title: Branch Origin
        branch_count:
          type: integer
          title: Branch Count
          default: 1
        type:
          anyOf:
            - type: string
            - type: 'null'
          title: Type
        size_bytes:
          type: integer
          title: Size Bytes
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Updated At
        last_scan_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Scan At
        owner_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Owner Id
        permissions:
          anyOf:
            - $ref: '#/components/schemas/PermissionsPayload'
            - type: 'null'
        can_edit:
          type: boolean
          title: Can Edit
          default: false
        status:
          type: string
          enum:
            - UPLOADING
            - UNSCANNED
            - IN_QUEUE
            - SCANNING
            - SCANNED
            - QUARANTINED
            - STOPPED
            - FAILED
          title: Status
        severity:
          type: string
          enum:
            - UNSCANNED
            - HEALTHY
            - UNHEALTHY-
            - UNHEALTHY+
            - CRITICAL
          title: Severity
        vulnerabilities:
          anyOf:
            - type: integer
            - type: 'null'
          title: Vulnerabilities
        vulnerability_types:
          anyOf:
            - type: string
            - type: 'null'
          title: Vulnerability Types
        scan_error:
          anyOf:
            - type: string
            - type: 'null'
          title: Scan Error
        scans:
          items:
            $ref: '#/components/schemas/ScanListItem'
          type: array
          title: Scans
        valid_images:
          anyOf:
            - type: integer
            - type: 'null'
          title: Valid Images
        invalid_images:
          anyOf:
            - type: integer
            - type: 'null'
          title: Invalid Images
        document_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Document Count
        class_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Class Count
        classes:
          items:
            type: string
          type: array
          title: Classes
        image_specificity:
          type: string
          enum:
            - fine
            - broad
          title: Image Specificity
          default: fine
        active_scan_progress:
          anyOf:
            - type: integer
            - type: 'null'
          title: Active Scan Progress
        active_scan_elapsed_seconds:
          anyOf:
            - type: number
            - type: 'null'
          title: Active Scan Elapsed Seconds
        active_scan_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Active Scan Message
        active_scan_started_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Active Scan Started At
        active_scan_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Active Scan Id
        active_scan_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Active Scan Status
        active_scan_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Active Scan Type
        issue_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Issue Type
        webhook_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Webhook Url
        repo_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Repo Url
        repo_requires_auth:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Repo Requires Auth
        has_repo_access_token:
          type: boolean
          title: Has Repo Access Token
          default: false
        webhook_on_complete:
          type: boolean
          title: Webhook On Complete
          default: false
        webhook_on_failure:
          type: boolean
          title: Webhook On Failure
          default: false
        queued_scan_count:
          type: integer
          title: Queued Scan Count
          default: 0
        issue_counts:
          $ref: '#/components/schemas/DatasetIssueCounts'
        latest_mislabel_scan_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Latest Mislabel Scan Id
        processing:
          type: boolean
          title: Processing
          default: false
        processed_3d:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Processed 3D
        import_job_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Import Job Id
        import_provider:
          anyOf:
            - type: string
            - type: 'null'
          title: Import Provider
        import_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Import Status
        import_progress:
          anyOf:
            - type: integer
            - type: 'null'
          title: Import Progress
        import_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Import Message
        import_error:
          anyOf:
            - type: string
            - type: 'null'
          title: Import Error
        import_cancel_requested:
          type: boolean
          title: Import Cancel Requested
          default: false
        import_updated_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Import Updated At
        import_has_stored_credentials:
          type: boolean
          title: Import Has Stored Credentials
          default: false
        import_can_retry:
          type: boolean
          title: Import Can Retry
          default: false
        dense_branch_build:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Dense Branch Build
      type: object
      required:
        - id
        - name
        - type
        - size_bytes
        - created_at
        - updated_at
        - last_scan_at
        - status
        - severity
        - vulnerabilities
        - vulnerability_types
        - scan_error
      title: DatasetOut
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PermissionsPayload:
      properties:
        view:
          $ref: '#/components/schemas/AccessScope'
        edit:
          $ref: '#/components/schemas/AccessScope'
      additionalProperties: false
      type: object
      title: PermissionsPayload
    ScanListItem:
      properties:
        id:
          type: string
          title: Id
        scan_type:
          type: string
          title: Scan Type
        dataset_dir:
          type: string
          title: Dataset Dir
        dataset_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Dataset Id
        dataset_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Dataset Name
        params:
          additionalProperties: true
          type: object
          title: Params
        engine_params:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Engine Params
        status:
          type: string
          title: Status
        progress:
          type: integer
          title: Progress
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
        started_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Started At
        finished_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Finished At
        duration_seconds:
          anyOf:
            - type: number
            - type: 'null'
          title: Duration Seconds
        total_issues:
          type: integer
          title: Total Issues
          default: 0
        critical_count:
          type: integer
          title: Critical Count
          default: 0
        high_count:
          type: integer
          title: High Count
          default: 0
        medium_count:
          type: integer
          title: Medium Count
          default: 0
        low_count:
          type: integer
          title: Low Count
          default: 0
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Updated At
      type: object
      required:
        - id
        - scan_type
        - dataset_dir
        - params
        - status
        - progress
        - message
        - created_at
        - updated_at
      title: ScanListItem
    DatasetIssueCounts:
      properties:
        mislabel:
          type: integer
          title: Mislabel
          default: 0
        poison:
          type: integer
          title: Poison
          default: 0
        outlier:
          type: integer
          title: Outlier
          default: 0
        bias:
          type: integer
          title: Bias
          default: 0
        shortcut:
          type: integer
          title: Shortcut
          default: 0
        flagged:
          type: integer
          title: Flagged
          default: 0
      type: object
      title: DatasetIssueCounts
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    AccessScope:
      properties:
        users:
          items:
            type: integer
          type: array
          title: Users
        roles:
          items:
            type: string
          type: array
          title: Roles
      additionalProperties: false
      type: object
      title: AccessScope

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.