---
title: "GET Health Check"
url: "https://apiportal.six-group.com/apis/sic-clearing-day-calendar-api-v1-ch-v1/versions/0f2fee1c-ce1f-4323-8b82-cfed13b6e3f3/operations/getHealthCheckForGet"
---

> Full API specification: https://apiportal.six-group.com/apis/sic-clearing-day-calendar-api-v1-ch-v1/versions/0f2fee1c-ce1f-4323-8b82-cfed13b6e3f3.md

# GET Health Check

`GET` `/healthcheck`

Operation ID: `getHealthCheckForGet`

Returns a status message of the system.

## Responses

- `200` - Healthcheck successful
- `default` - Unexpected error.

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Clearing Day Calendar v1
  version: 1.0 (generated 2024-03-27T17:02:01Z)
servers:
  - url: https://api.six-group.com/api/epcd/clearingday/v1
  - url: https://api.p2p.six-group.com/api/epcd/clearingday/v1
  - url: https://api.fip.six-group.com/api/epcd/clearingday/v1
paths:
  /healthcheck:
    get:
      tags:
        - healthcheck
      summary: GET Health Check
      description: Returns a status message of the system.
      operationId: getHealthCheckForGet
      responses:
        "200":
          description: Healthcheck successful
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HealthCheckResponse"
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Problem"
components:
  schemas:
    HealthCheckResponse:
      required:
        - apiVersion
        - applicationVersion
        - environmentStage
        - message
        - receivedHeaders
        - requestDateTime
      type: object
      properties:
        message:
          maxLength: 100
          type: string
          description: Response message from health check.
          example: The health check GET request was successfully received and processed.
        requestDateTime:
          type: string
          description: According to RFC3339, section 5.6 in ISO 8601 with timezone and
            milliseconds.
          format: date-time
          example: 2024-12-21T10:52:05.1904957+01:00
        receivedHeaders:
          type: array
          items:
            type: object
            properties:
              headerName:
                type: string
                description: The name of the provided header.
                example: Accept
              headerValue:
                type: string
                description: As received
                example: application/json
        environmentStage:
          type: string
          description: The instance to which the request was sent to.
          example: X1
        applicationVersion:
          type: string
          description: The version of the API backend.
          example: 4.5.0-julia
        apiVersion:
          type: string
          description: The version of the API.
          example: 1.0.23
    Problem:
      required:
        - detail
        - status
        - title
      type: object
      properties:
        type:
          type: string
          description: >
            An absolute URI that identifies the problem type.

            We may provide human-readable documentation for the problem type in
            the future, when the URI is dereferenced.
          format: uri
          example: /problems/REQUEST_PARAMETER_VALIDATION_FAILED
          default: about:blank
        title:
          type: string
          description: |
            A short, human readable summary of the problem type.
          example: Request parameter has missing or invalid values
        status:
          maximum: 600
          exclusiveMaximum: true
          minimum: 100
          type: integer
          description: >
            The HTTP status code generated by the origin server for this
            occurrence

            of the problem.
          format: int32
          example: 400
        detail:
          type: string
          description: |
            A human readable explanation specific to this occurrence of the
            problem.
          example: The submitted request contains invalid or missing request parameters
            which cannot be processed.
        instance:
          type: string
          description: >
            An absolute URI that identifies the specific occurrence of the
            problem.

            It may or may not yield further information if dereferenced.
          format: uri
          example: /api/epcd/bankmaster/v3/public/errors/EPCD0090000001/provided-D
        metadata:
          $ref: "#/components/schemas/GenericObject"
    GenericObject:
      required:
        - "@type"
        - data
      type: object
      properties:
        "@type":
          type: string
          description: >
            The field "@type" contains a URI/name identifying the type. Example:
            "@type": "types.example.com/standard/id".
        data:
          type: object
          properties: {}
          description: |
            An object of type @type containing custom fields.
      description: |
        Structured type that contains an object and its type.
      example: >
        When associated with a 'Problem', it typically contains values which
        caused the failure and similar. May not contain sensitive CID.
```