CLcloudbeds
Connection

HealthCheck

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

post/HealthCheck

Request

  • Base URL
    https://api.your-ota.com/cloudbeds
  • URL
    https://api.your-ota.com/cloudbeds/HealthCheck
  • Auth
    API key in query parameter shared_secret

Request body

ota_property_idstring required

Username, login or property ID on the OTA if already set, empty string otherwise

ota_property_passwordstring 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.

guidstring required

Request reference ID, used for debugging and support requests.

shared_secretstring required

Authentication between the OTA and the channel. Identical for all requests. Not to be shared with customers.

ota_cidstring required

OTA ID as given by Cloudbeds

verb'HealthCheck' required

Response

HealthCheck

successtrue | false required

Changes

No recorded changes to this operation across all 1 revision of this API.