Skip to content

Legacy API (/api/custom)

These are older /api/custom/* routes that are still supported. For new integrations prefer the current /api/v2/* endpoints documented on the other pages. The routes below are the ones most useful to end users — downloading reports and traces, inspecting the schedule, reserving and controlling devices, and managing your API key.

Reports & Traces

/api/custom/executionPdf/{id} 📋 Copied! Download a Test Execution report as PDF ▼

Parameters

Name Description
id * Numeric ID of the Test Execution.
Type: integer (path)

Responses

Code Description
200 The execution report. Media type: application/pdf
404 Resource was not found.
/api/custom/trace/{id} 📋 Copied! Download a trace file ▼

Parameters

Name Description
id * Numeric ID of the trace.
Type: integer (path)

Responses

Code Description
200 The trace file (binary). Media type: application/octet-stream
404 Resource was not found.

Schedule

/api/custom/scheduledTasks 📋 Copied! List scheduled Test Suites ▼

Parameters

Name Description
none No parameters required.

Responses

Code Description
200

OK

Media type: application/json

Example Value:

[
  {
    "testSuiteId": 0,
    "testSuiteName": "string",
    "nextFireTime": "string"
  }
]
/api/custom/nextFireTime/{id} 📋 Copied! Get the next scheduled fire time of a Test Suite ▼

Parameters

Name Description
id * Numeric ID of the Test Suite.
Type: integer (path)

Responses

Code Description
200

OK

Media type: application/json

Example Value:

{
  "id": 0,
  "nextFireTime": "string"
}
404 Resource was not found.

Device Reservation & Control

/api/custom/canReserve/{id} 📋 Copied! Check whether a device can be reserved ▼

Parameters

Name Description
id * Numeric ID of the mobile device.
Type: integer (path)

Responses

Code Description
200

OK

Media type: application/json

Example Value:

{
  "canReserve": true
}
/api/custom/reserveDevice/{id} 📋 Copied! Reserve a device ▼

Parameters

Name Description
id * Numeric ID of the mobile device.
Type: integer (path)
duration Reservation duration in minutes.
Type: integer (query)

Responses

Code Description
200

OK

Media type: application/json

Example Value:

{
  "id": 0,
  "reservedUntil": "string"
}
409 Device cannot be reserved.
/api/custom/reserveDevice/{id} 📋 Copied! Release a device reservation ▼

Parameters

Name Description
id * Numeric ID of the mobile device.
Type: integer (path)

Responses

Code Description
200 Reservation released successfully.
404 Resource was not found.
/api/custom/reboot/{id} 📋 Copied! Reboot a device ▼

Parameters

Name Description
id * Numeric ID of the mobile device.
Type: integer (path)

Responses

Code Description
200 Reboot command sent.
404 Resource was not found.
/api/custom/prepare/{id} 📋 Copied! Prepare a device for testing ▼

Parameters

Name Description
id * Numeric ID of the mobile device.
Type: integer (path)

Responses

Code Description
200 Prepare command sent.
404 Resource was not found.

API Key

/api/custom/apiKey 📋 Copied! Get your API key ▼

Parameters

Name Description
none No parameters required.

Responses

Code Description
200

OK

Media type: application/json

Example Value:

{
  "apiKey": "string"
}
/api/custom/apiKey 📋 Copied! Regenerate your API key ▼

Parameters

Name Description
none No parameters required.

Responses

Code Description
200

OK

Media type: application/json

Example Value:

{
  "apiKey": "string"
}