> ## Documentation Index
> Fetch the complete documentation index at: https://strettch-make-section-id-optional.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Service Health Check

> Returns the current health status of the service and its critical dependencies.

### Response Error Codes

If the request fails, the `code` field in the error response will contain one of the following.

| Code                    | Status | Description                                                     |
| :---------------------- | :----: | :-------------------------------------------------------------- |
| `OK`                    |   200  | The service and its critical dependencies are healthy.          |
| `INTERNAL_SERVER_ERROR` |   500  | An unexpected error occurred while performing the health check. |


## OpenAPI

````yaml api-reference/openapi.json GET /health
openapi: 3.1.0
info:
  title: Strettch Cloud Public API
  description: Public API for managing Strettch Cloud resources.
  contact:
    name: API Support
    url: https://cloud.strettch.com
    email: support@strettch.cloud
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: '1.0'
servers:
  - url: https://api.strettch.cloud/api/v1
    description: Production
security: []
paths:
  /health:
    get:
      tags:
        - System
      summary: Service health check
      description: >-
        Returns the current health status of the service and its critical
        dependencies.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/APIResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/HealthResponse'
components:
  schemas:
    APIResponse:
      type: object
      properties:
        message:
          type: string
          example: Operation successful
        requestId:
          type: string
          example: f47ac10b-58cc-4372-a567-0e02b2c3d479
        success:
          type: boolean
          example: true
        timestamp:
          type: string
          example: '2024-01-15T10:00:00Z'
    HealthResponse:
      type: object
      properties:
        service:
          type: string
          example: public-api
        status:
          type: string
          example: ok

````