Skip to main content
POST
Send a remote control command to a tap

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 unique identifier for the tap

Body

application/json
action
enum<string>
required

Turns the tap on.

Available options:
start
Example:

"start"

data
object

Optional setpoints. A missing or null value uses the tap’s default.

Response

The tap accepted the command

id
string

ID of the command. Returned once the device has confirmed it.

Example:

"3e2d1c0b-9a8f-4e7d-8c6b-5a4f3e2d1c0b"

action
string

The action sent.

Example:

"set_temp"