---
title: "ServiceHealthDto"
url: "https://developer.migros.ch/apis/webhook-receiver-prod-1/versions/977ec8fd-6ae2-4563-8309-c378d6594d02/schemas/ServiceHealthDto"
---

> Full API specification: https://developer.migros.ch/apis/webhook-receiver-prod-1/versions/977ec8fd-6ae2-4563-8309-c378d6594d02.md

# ServiceHealthDto

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Webhook Receiver PROD
  version: "1.0"
servers:
  - url: https://api.migros.ch
components:
  schemas:
    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
    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
```