---
title: "HealthCheck"
method: POST
path: "/HealthCheck"
tags: ["Connection"]
---

# HealthCheck

`POST /HealthCheck`

Called prior to `SetupProperty` or other configuration requests to verify proper operation. Should always return true.

## Request body

- object
  - `mya_property_id` union, required
    - integer — Property ID on the Cloudbeds channel manager if already set
    - '' — Empty string otherwise if not previously setup
  - `ota_property_id` string, required — Username, login or property ID on the OTA if already set, empty string otherwise
  - `ota_property_password` string, required — Password for property on your OTA if already set, empty string otherwise. In case the OTA does not use passwords this will be an empty string.
  - `ota_property_sub_id` '', required — Property ID on the OTA, if OTA supports multiple properties under one `ota_property_id`/`ota_property_password` combination. Empty string if not already set.
  - `guid` string, required — Request reference ID, used for debugging and support requests.
  - `shared_secret` string, required — Authentication between the OTA and the channel. Identical for all requests. Not to be shared with customers.
  - `ota_cid` string, required — OTA ID as given by Cloudbeds
  - `verb` 'HealthCheck', required

## Response `200`

HealthCheck

- ResponseSimple
  - `errors` object[] — Array of error objects. Required when `success` is `false`.
    - `id` integer, required — Error code. Check the "Error Codes" section of the specification for valid codes.
    - `msg` string — Optional error string to give more details about the error. Myallocator localises errors into different languages, so this field is generally ignored and only useful for debugging.
  - `success` true | false, required

---

[API](https://skmtc.net/cloudbeds/apis/cloudbeds-api.md) · [All operations](https://skmtc.net/cloudbeds/apis/cloudbeds-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudbeds/cloudbeds-api/versions/2faa857793e8/schema)