User Devices
Manage the devices registered to your account. List, register, and remove devices used for VPN connections.
List User Devices
Retrieve all devices currently registered to the authenticated user's account. Each device entry includes platform details, app version, and activity status.
/api/v1/users/me/devicesList all devices registered to the authenticated user
curl -X GET https://api.orbai.world/api/v1/users/me/devices \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"{
"success": true,
"data": {
"devices": [
{
"id": 1001,
"device_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
"os": "android",
"device_model": "Pixel 8 Pro",
"device_name": "John's Phone",
"app_version": "3.2.1",
"is_active": true,
"is_blocked": false,
"login_date": "2026-02-08T08:00:00Z",
"logout_date": null
},
{
"id": 1002,
"device_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"os": "ios",
"device_model": "iPhone 16 Pro",
"device_name": "John's iPad",
"app_version": "3.2.0",
"is_active": false,
"is_blocked": false,
"login_date": "2026-02-05T15:30:00Z",
"logout_date": "2026-02-07T22:00:00Z"
}
]
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or expired access token"
}
}Register Device
Register a new device to the authenticated user's account. This must be done before connecting to VPN servers from a new device.
/api/v1/users/me/devicesRegister a new device to the user's account
| Parameter | Type | Required | Description |
|---|---|---|---|
device_id | string | Required | Unique device identifier (UUID format recommended) |
platform | string | Optional | Device platform: android, ios, windows, macos, linux |
device_name | string | Optional | Human-readable name for the device (e.g., "John's Phone") |
fcm_token | string | Optional | Firebase Cloud Messaging token for push notifications on this device |
Device Limits
The maximum number of devices you can register depends on your subscription plan. If you reach the limit, you must remove an existing device before registering a new one.
curl -X POST https://api.orbai.world/api/v1/users/me/devices \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"device_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
"platform": "android",
"device_name": "John'\''s Pixel",
"fcm_token": "fMR91bGSRi2Y7..."
}'{
"success": true,
"data": {
"id": 1003,
"device_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
"os": "android",
"device_model": null,
"device_name": "John's Pixel",
"app_version": null,
"is_active": false,
"is_blocked": false,
"login_date": null,
"logout_date": null
}
}{
"success": false,
"error": {
"code": "DEVICE_LIMIT_REACHED",
"message": "Maximum number of devices reached for your subscription plan. Remove an existing device first."
}
}Remove Device
Remove a registered device from the authenticated user's account. The device will be immediately disconnected from any active VPN sessions.
/api/v1/users/me/devices/{deviceId}Remove a device from the user's account
| Parameter | Type | Required | Description |
|---|---|---|---|
deviceId | integer | Required | The numeric ID of the device to remove (from the device list response) |
Active Sessions
Removing a device will immediately terminate any active VPN connection on that device. The device will need to be re-registered to connect again.
curl -X DELETE https://api.orbai.world/api/v1/users/me/devices/1003 \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"// No response body - HTTP 204 No Content{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Device not found or does not belong to the authenticated user"
}
}