Skip to main content
POST

Authorizations

Authorization
string
header
required

API token from your CloudBlast account settings. Pass as Authorization: Bearer <token>.

Path Parameters

sandbox
string<uuid>
required

Sandbox UUID, as returned in the uuid field. Only the full UUID works here.

Body

application/json

One action. Each action reads only the fields it uses. Coordinates are screen pixels from the top left, 0 to 16384.

action
enum<string>
required
Available options:
screenshot,
size,
cursor,
move,
click,
mouse_down,
mouse_up,
drag,
scroll,
type,
key,
open,
windows,
focus,
read_screen,
wait
Example:

"click"

x
integer

move (required), click, mouse_down, mouse_up, scroll: where to act. Give both x and y, or neither to act where the cursor is.

Required range: 0 <= x <= 16384
Example:

640

y
integer

See x.

Required range: 0 <= x <= 16384
Example:

360

button
enum<string>
default:left

click, mouse_down, mouse_up.

Available options:
left,
middle,
right
count
integer
default:1

click: 2 for a double click, 3 for a triple click.

Required range: 1 <= x <= 3
from
object

drag (required): where to press the button.

to
object

drag (required): where to let it go.

direction
enum<string>
default:down

scroll.

Available options:
up,
down,
left,
right
amount
integer
default:3

scroll: how many notches.

Required range: 1 <= x <= 30
text
string

type (required): the text to type, in any language.

Maximum string length: 20000
keys

key (required): one combination like "ctrl+l", or a list pressed in turn like ["ctrl+a", "delete"] (up to 20).

Example:

"ctrl+l"

repeat
integer
default:1

key: how many times to press them.

Required range: 1 <= x <= 50
target
string

open (required): a URL, a file or an app.

Maximum string length: 2000
Example:

"https://example.com"

args
string

open: arguments for the app.

Maximum string length: 2000
wait
integer

open: seconds to wait after opening it, before answering.

Required range: 0 <= x <= 30
window
string

focus (required) and read_screen: a window id from windows, or part of its title. read_screen reads the window in front without it.

Maximum string length: 200
max_nodes
integer

read_screen: the most controls to list.

Required range: 20 <= x <= 1500
seconds
integer
default:1

wait: how long to wait.

Required range: 0 <= x <= 30
format
enum<string>
default:jpeg

screenshot, and any action with screenshot: true: the format of the picture.

Available options:
jpeg,
png
quality
integer

screenshot in jpeg: the quality of the picture.

Required range: 10 <= x <= 100
screenshot
boolean
default:false

On an action that changes the screen (move, click, mouse_down, mouse_up, drag, scroll, type, key, open, focus, wait): also take a screenshot just after, returned as screenshot.

Response

The action was done

data
object

Always ok: true. The other fields depend on the action, and can differ a little between Linux and Windows.