---
title: "Register a local device (BYOD)"
method: POST
path: "/api/devices/register"
tags: ["Devices"]
---

# Register a local device (BYOD)

`POST /api/devices/register`

## Request

- Base URL: `https://aximo.autify.com`
- URL: `https://aximo.autify.com/api/devices/register`
- 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)

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.

## Request body

- object
  - `name` string, required: Display name for the device.
  - `platform` 'windows' | 'macos' | 'linux' | 'ios' | 'android', required
  - `os` string: OS version string (informational).

## Response `201`

Device registered.

- object
  - `deviceId` string, uuid, required: Pass this value as `userDeviceId` when creating sessions or triggering runs.
  - `deviceToken` string, required: Device token for the on-device agent. Shown only once.

## Other responses

- `400`: Invalid request body.
- `401`: Missing or invalid API key.
- `403`: API key is not scoped to an organization, the user is banned, or the user is no longer a member of the organization.
- `404`: BYOD is not enabled for the organization.
- `429`: Rate limit exceeded — e.g. the daily session limit was reached for the organization, or too many API requests were sent in a short window (retry after the number of seconds in the `Retry-After` header).
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/autify/apis/aximo-api.md) - [All operations](https://skmtc.dev/autify/apis/aximo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/autify/apis/aximo-api/revisions/590722011284?raw)