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

# Server-side doctor report

> The configuration and connectivity checks `datris doctor` runs, as JSON. This is the endpoint the `datris doctor` CLI, the Configuration → Doctor page and the `run_doctor` MCP tool call. It is authenticated: the report names environment keys, Vault paths and model ids, so when API keys are on the calling key must hold the `config:read` capability (401/403 otherwise).



## OpenAPI

````yaml /openapi.yaml get /api/v1/doctor
openapi: 3.0.3
info:
  title: Datris API
  description: >
    REST API for the Datris AI Data Platform. Ingest, validate, transform,
    store, and retrieve data.


    For AI agent integration, use the [MCP
    Server](https://docs.datris.ai/mcp-server) instead.
  version: 1.57.1
  contact:
    name: Datris
    url: https://datris.ai
  license:
    name: Apache 2.0
servers:
  - url: http://localhost:8080
    description: Local development
security:
  - ApiKeyAuth: []
paths:
  /api/v1/doctor:
    get:
      tags:
        - Health
      summary: Server-side doctor report
      description: >-
        The configuration and connectivity checks `datris doctor` runs, as JSON.
        This is the endpoint the `datris doctor` CLI, the Configuration → Doctor
        page and the `run_doctor` MCP tool call. It is authenticated: the report
        names environment keys, Vault paths and model ids, so when API keys are
        on the calling key must hold the `config:read` capability (401/403
        otherwise).
      parameters:
        - name: mode
          in: query
          required: false
          schema:
            type: string
            enum:
              - full
              - quick
            default: full
          description: '`quick` runs only the cheap startup-safe checks'
        - name: probes
          in: query
          required: false
          schema:
            type: string
          description: >-
            Comma-separated opt-in probe groups to include (currently `ai`,
            which spends a model call)
        - name: cli
          in: query
          required: false
          schema:
            type: string
          description: >-
            Version of the calling CLI, echoed under `surface.cli` and compared
            with the server
        - name: mcp
          in: query
          required: false
          schema:
            type: string
          description: Version of the calling MCP server, echoed under `surface.mcp`
        - name: ui
          in: query
          required: false
          schema:
            type: string
          description: Version of the calling UI, echoed under `surface.ui`
      responses:
        '200':
          description: The report
          content:
            application/json:
              schema:
                type: object
                properties:
                  doctorVersion:
                    type: integer
                  ranAt:
                    type: string
                    description: ISO-8601 instant
                  mode:
                    type: string
                    enum:
                      - full
                      - quick
                  surface:
                    type: object
                    additionalProperties:
                      type: string
                    description: >-
                      Versions by surface (`server` always; `cli`, `mcp`, `ui`
                      when passed)
                  summary:
                    type: object
                    properties:
                      ok:
                        type: integer
                      warn:
                        type: integer
                      error:
                        type: integer
                      skip:
                        type: integer
                  checks:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        status:
                          type: string
                          enum:
                            - ok
                            - warn
                            - error
                            - skip
                        severity:
                          type: string
                        detail:
                          type: string
                        remediation:
                          type: string
                        surface:
                          type: string
                        ms:
                          type: integer
                          format: int64
        '401':
          description: 'API key missing or rejected. Body: `{"error": ...}`'
        '500':
          description: Error
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Optional API key for authentication (enabled via application.yaml)

````

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