Skip to main content
POST
/
instances
Create a new Instance
curl --request POST \
  --url https://api.emulator.farm/v1/instances \
  --header 'Content-Type: application/json' \
  --header 'X-EMULATOR-FARM-API-KEY: <api-key>' \
  --data '
{
  "build_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "test-instance-01",
  "description": "Test instance for QA team",
  "metadata": {}
}
'
{
  "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
  }
}

Authorizations

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

Body

application/json
​
build_id
string<uuid>
required
Example:

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

​
name
string
required
Example:

"test-instance-01"

​
description
string | null
Example:

"Test instance for QA team"

​
metadata
object

Response

Instance created successfully

​
id
string<uuid>
required
Example:

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

​
build_id
string<uuid>
required
Example:

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

​
name
string
required
Example:

"test-instance-01"

​
status
enum<string>
required
Available options:
starting,
running,
stopping,
stopped,
error
Example:

"running"

​
created_at
string<date-time>
required
Example:

"2025-12-10T12:00:00Z"

​
updated_at
string<date-time>
required
Example:

"2025-12-10T12:00:00Z"

​
description
string | null
Example:

"Test instance for QA team"

​
endpoint
string<uri> | null
Example:

"https://instance-550e8400.emulatorfarm.com"

​
metadata
object
Example:
{
  "cpu_cores": 4,
  "memory_gb": 8,
  "disk_gb": 32
}