Skip to main content
GET
/
instances
List Instances
curl --request GET \
  --url https://api.emulator.farm/v1/instances \
  --header 'X-EMULATOR-FARM-API-KEY: <api-key>'
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "build_id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "test-instance-01",
      "status": "running",
      "created_at": "2025-12-10T12:00:00Z",
      "updated_at": "2025-12-10T12:00:00Z",
      "description": "Test instance for QA team",
      "endpoint": "https://instance-550e8400.emulatorfarm.com",
      "metadata": {
        "cpu_cores": 4,
        "memory_gb": 8,
        "disk_gb": 32
      }
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Authorizations

​
X-EMULATOR-FARM-API-KEY
string
header
required

Query Parameters

​
cursor
string<uuid>

Opaque cursor token for pagination

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
limit
integer
default:10

Maximum number of items to return

Required range: 1 <= x <= 100
​
sort_by
string
default:created_at

Field to sort by

​
order
enum<string>
default:desc

Sort order (ascending or descending)

Available options:
asc,
desc
​
status
enum<string>

Filter instances by status

Available options:
starting,
running,
stopping,
stopped,
error
Example:

"running"

​
build_id
string<uuid>

Filter instances by build ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

List of instances retrieved successfully

​
data
object[]
required
​
pagination
object
required