---
title: "Health endpoint for uptime.com health checks. This also contains reports for the complementary systems (Elasticsearch & Contentful)."
url: "https://developer-qual.migros.ch/apis/webhook-receiver-qual-1/versions/75e1bbe8-af91-435c-b484-6a2e746bfb27/operations/HealthController_healthCheck"
---

> Full API specification: https://developer-qual.migros.ch/apis/webhook-receiver-qual-1/versions/75e1bbe8-af91-435c-b484-6a2e746bfb27.md

# Health endpoint for uptime.com health checks. This also contains reports for the complementary systems (Elasticsearch & Contentful).

`GET` `/migros/enterprise-support/content/v1/health`

Operation ID: `HealthController_healthCheck`

## Responses

- `200` - Successful health report
- `403` - Forbidden - missing or invalid bearer token
- `500` - Internal server error
- `503` - Service unavailable - issues connecting to complementary systems

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Webhook Receiver QUAL
  version: "1.0"
servers:
  - url: https://api-qual.migros.ch
paths:
  /migros/enterprise-support/content/v1/health:
    get:
      operationId: HealthController_healthCheck
      parameters: []
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceHealthDto"
          description: Successful health report
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
          description: Forbidden - missing or invalid bearer token
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
          description: Internal server error
        "503":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceHealthDto"
          description: Service unavailable - issues connecting to complementary systems
      summary: Health endpoint for uptime.com health checks. This also contains
        reports for the complementary systems (Elasticsearch & Contentful).
security:
  - bearerAuth: []
components:
  schemas:
    ServiceHealthDto:
      properties:
        c8lDeliveryApiHealth:
          allOf:
            - $ref: "#/components/schemas/ContentfulApiHealthReportDto"
          description: The Contentful API health report for c8lDeliveryApi
        c8lPreviewApiHealth:
          allOf:
            - $ref: "#/components/schemas/ContentfulApiHealthReportDto"
          description: The Contentful API health report for c8lPreviewApi
        elasticsearch:
          allOf:
            - $ref: "#/components/schemas/ElasticsearchHealthReportDto"
          description: The Elasticsearch health report
      required:
        - elasticsearch
        - c8lDeliveryApiHealth
        - c8lPreviewApiHealth
      type: object
    ErrorResponse:
      description: Standard error response returned by the API on failures.
      properties:
        exception:
          description: Detailed exception payload.
          type: object
        path:
          description: Request path that caused the error.
          type: string
        statusCode:
          description: HTTP status code of the error.
          format: int32
          type: integer
        timestamp:
          description: ISO8601 timestamp when the error occurred.
          format: date-time
          type: string
      required:
        - statusCode
        - timestamp
        - path
        - exception
      type: object
    ContentfulApiHealthReportDto:
      properties:
        doesSpaceExist:
          default: false
          description: The space ID for the Contentful API
          example: true
          type: boolean
        isKeyValid:
          default: false
          description: The key for accessing the Contentful API
          example: true
          type: boolean
        isServiceAvailable:
          default: false
          description: Status about the connection to the endpoint
          example: true
          type: boolean
      required:
        - isServiceAvailable
        - isKeyValid
        - doesSpaceExist
      type: object
    ElasticsearchHealthReportDto:
      properties:
        healthReport:
          description: Health report of the elasticsearch cluster
          type: object
        isKeyValid:
          default: false
          description: The key for accessing the Elasticsearch API
          example: true
          type: boolean
        isServiceAvailable:
          default: false
          description: Status about the connection to the endpoint.
          example: true
          type: boolean
      required:
        - isServiceAvailable
        - isKeyValid
        - healthReport
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http
```