Skip to main content
PUT
Start installation test

Authorizations

x-api-key
string
header
required

Send your API key in the x-api-key header of every request. The key belongs to one Orbital account, and requests act as that account: they see and control only the devices it owns or has been given access to. A missing or unknown key gets 403 with { "message": "Forbidden" }.

Path Parameters

id
string
required

The shower ID

Body

application/json
email
string

Email address of the installer, saved in the shower’s installation_info.

Example:

"installer@example.com"

heater_power_available
number

Heater power the installation allows, in kW. Kept as the shower’s setting.

Example:

3.2

Response

Success

id
string

ID of the test run, saved as the shower’s installation_test.id.

Example:

"9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d"

action
string

Always run.

Example:

"run"

test_id
string

ID of the installation test being run.

Example:

"7a6b5c4d-3e2f-4a1b-9c8d-7e6f5a4b3c2d"