HealthCheck

post

https://api.your-ota.com/cloudbeds/HealthCheck

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

mya_property_id

required

≥ 1

Property ID on the Cloudbeds channel manager if already set

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

string

enum

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.

Allowed:

guid

string

required

^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

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

^[a-z0-9]+$

OTA ID as given by Cloudbeds

verb

string

enum

required

Allowed:

Response

200HealthCheck