Automation Interface HTTP API
Clients
Cross platform client binary: GBA client binary
We also have client libraries for:
API endpoints
List devices
Endpoint
GET /devices
Response
application/json
200
[
{
"id": "a-device-id",
"name": "Example"
}
]
Retrieve a device
Endpoint
GET /devices/{deviceId}
Response
application/json
200
[
{
"id": "a-device-id"
}
]
Retrieve a device’s apps
Endpoint
GET /devices/{deviceId}/apps
Response
application/json
200
[
{
"id": "an-app-id"
}
]
List sessions
Endpoint
GET /sessions
Query parameters
Parameter | Type | Required | Default |
---|---|---|---|
type | string | No | active |
Response
application/json
200
[
{
"id": "an-example-id"
}
]
Start a session
Endpoint
POST /sessions
Request body
Request content-type: application/json
Parameter | Type | Required | Default |
---|---|---|---|
deviceId | string | Yes | |
appId | string | Yes | |
autoSync | boolean | No | false |
screenshots | boolean | No | false |
tags | object | No |
Response
application/json
200
{
"id": "an-example-id"
}
Stop a session
Endpoint
POST /sessions/{sessionId}/stop
Request body
Request content-type: application/json
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
includeSessionJsonInResponse | boolean | No | false | |
outputDir | string | No | Write session JSON file to this directory |
Response
204