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

# Healthcheck

> Responds {"ok":true} while the API is up; it is the target of the deploy smoke check.



## OpenAPI

````yaml /openapi.json get /
openapi: 3.1.0
info:
  title: CSMS API
  description: Backend API documentation
  version: 0.0.0
servers: []
security: []
paths:
  /:
    get:
      summary: Healthcheck
      description: >-
        Responds {"ok":true} while the API is up; it is the target of the deploy
        smoke check.
      operationId: getIndex
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                required:
                  - ok

````