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

# Get Server Status

> Check the current operational status of the Veridox API.

Returns the operational status of the Veridox Core API server and the current API version. This endpoint is publicly accessible and requires no authentication.

## Use Cases

* **Health Monitoring**: Use this endpoint for automated uptime monitoring and alerting.
* **Load Balancing**: Ideal for health probes in load balancer configurations.
* **Version Verification**: Confirm the current API version for compatibility checks.

## Best Practices

1. **Caching**: Cache the response briefly (30-60 seconds) for high-frequency health checks to reduce unnecessary load.
2. **Error Handling**: Expect only network-level errors; treat any 5xx response as a critical service issue.


## OpenAPI

````yaml GET /status
openapi: 3.1.0
info:
  title: Veridox Core API
  description: Veridox Core Platform API
  version: 0.0.1
  contact: {}
servers:
  - url: https://api.uk.veridox.ai
    description: Live (UK)
  - url: https://api.ca.veridox.ai
    description: Live (CA)
security: []
tags:
  - name: Status
    description: System status and health check endpoints
  - name: Cases
    description: Case and case file management
  - name: Organisations
    description: Organisation management
  - name: Document Requests
    description: Document request management
  - name: Search
    description: Search functionality
  - name: Admin
    description: Administrative endpoints
paths:
  /status:
    get:
      tags:
        - Status
      summary: Get server status
      description: >-
        Returns the current operational status of the server and API version.
        This endpoint is public and requires no authentication.
      operationId: StatusController_status
      parameters: []
      responses:
        '200':
          description: Server status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusDto'
components:
  schemas:
    StatusDto:
      type: object
      properties:
        status:
          type: string
          enum:
            - ok
          x-nestjs_zod-parent-additional-properties: false
        version:
          type: string
          x-nestjs_zod-parent-additional-properties: false
      required:
        - status
        - version

````