Devices

Register a local device (BYOD)

Registers your own device (a desktop machine or a locally connected phone) for test execution and returns a device token. The token is shown only once — store it securely. The on-device agent uses it to connect to the Aximo gateway; the returned deviceId is what you pass as userDeviceId when creating sessions or triggering runs.

Requires the BYOD feature to be enabled for your organization; responds 404 when it is not.

post/api/devices/register

Request

Base URL
https://aximo.autify.com
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/autify/apis/aximo-api/docs/api/devices/register/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

Display name for the device.

platform'windows' | 'macos' | 'linux' | 'ios' | 'android' required

osstring

OS version string (informational).

Example request

{
  "name": "QA MacBook Pro",
  "os": "macOS 15.5"
}

Response

Device registered.

deviceIdstring uuid required

Pass this value as userDeviceId when creating sessions or triggering runs.

deviceTokenstring required

Device token for the on-device agent. Shown only once.

Changes

No recorded changes to this operation across all 1 revision of this API.