Developer

Fire Healthcheck

Restrictions: "sidecar:write"

Re-runs a sidecar healthcheck for the current session.

Only module-based healthchecks can be fired. Restricted to users with the sidecar:write scope.

Inputs

Name	Type	Description	Required	Dynamic
check	string	The module-based healthcheck to re-run, e.g. "Sidecar.Healthcheck.Check.Appium".	Yes	No

Outputs

Name	Type	Description
default	boolean	Is the healthcheck healthy after firing?
healthy	boolean	Is the healthcheck healthy after firing?

Global Context

Restrictions: :root

No docs available

Inputs

Name	Type	Description	Required	Dynamic

Outputs

Name	Type	Description
app.name	string	Current app name
app.id	string	Current app ID
app.version	string	Current app version
device.make	string	Device manufacturer
device.model	string	Device model
device.year	string	Device year
default	null

Demo All UI

Restrictions: :root

No docs available

Inputs

Name	Type	Description	Required	Dynamic
color	color	Choose a color.	Yes	No
color_optional	color	Choose an optional color.	No	No
number_signed	number	Enter a number.	Yes	No
number_unsigned	number	Enter a number.	Yes	No
number_optional	number	Enter a number.	No	No
boolean	boolean	Boolean input.	Yes	No
code	code	Enter some code.	Yes	No
code_optional	code	Enter some code.	No	No
enum	enum	Choose an item from a dropdown list.	Yes	No
enum_optional	enum	Choose an optional item from a dropdown list.	No	No
string	string	Enter some text.	Yes	No
string_optional	string	Enter some text.	No	No
string_extra_long	string	Enter some long text.	Yes	No
string_multiple	string	Enter some text.	Yes	No
image	image	Select an image.	Yes	No
region	region	Select a region defined in a screen.	Yes	No
screen	screen	Select a screen.	Yes	No
screen_multiple	screen	Select multiple screens.	Yes	No
screen_optional	screen	Select an optional screen.	No	No
key	key	Define a sequence of keys.	Yes	No

Outputs

Name	Type	Description
default	null

Restart Sidecar

Restrictions: "sidecar:write"

Restarts the sidecar that is running the current session.

A hard restart gracefully recreates the sidecar containers through the sidecar-agent.

A quick restart halts the sidecar process and lets Docker recreate the container, which is faster but abrupt.

Restricted to users with the sidecar:write scope.

Inputs

Name	Type	Description	Required	Dynamic
mode	enum	How to restart the sidecar. "Hard Restart" gracefully recreates the sidecar via the sidecar-agent; "Quick Restart" halts the process and lets Docker restart the container.	Yes	No
delay	number	Seconds to wait before restarting, giving the running automation time to finish first. Minimum 1 second.	Yes	No

Outputs

Name	Type	Description
default	null

Update Context

Restrictions: "none"

No docs available

Inputs

Name	Type	Description	Required	Dynamic
key	string	The key to update in the context.	Yes	Yes
value	code	The value to set the key to.	Yes	Yes

Outputs

Name	Type	Description
default	null

Demo Image Upload

Restrictions: "none"

No docs available

Inputs

Name	Type	Description	Required	Dynamic
image	image	This is a single image.	Yes	No
image_multiple	image	These are a multiple image.	Yes	No

Outputs

Name	Type	Description
default	null

Mark Healthcheck

Restrictions: "sidecar:write"

Marks a sidecar healthcheck as healthy or unhealthy for the current session.

The change is flagged as a manual override so it is distinguishable from automated healthcheck results. Restricted to users with the sidecar:write scope.

Inputs

Name	Type	Description	Required	Dynamic
check	string	The healthcheck to mark, e.g. "Sidecar.Healthcheck.Check.Appium".	Yes	No
status	enum	Whether to mark the healthcheck as healthy or unhealthy.	Yes	No

Outputs

Name	Type	Description
default	null

Override Protocols

Restrictions: "sidecar:write"

Overrides the device's active control protocols for the current session.

The override applies for the duration of the session and reverts when the device disconnects. Restricted to users with the sidecar:write scope.

Inputs

Name	Type	Description	Required	Dynamic
protocols	enum	One or more control protocols to apply to the device for this session.	Yes	No

Outputs

Name	Type	Description
old_protocols	table	Protocols that were active before the override
new_protocols	table	Protocols applied by the override
default	null