Skip to content
Fleet Fleet Platform API

Create external devices (batch)

POST
/devices

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
object
devices
required
Array<object>
>= 1 items
object
name
required
string
>= 1 characters
type
required
string
>= 1 characters
category
required
string
>= 1 characters
user_id
integer
added_via

How the device was added in Fleet

string
Allowed values: MASS_IMPORT SINGLE_IMPORT ONBOARDING
Example
SINGLE_IMPORT
brand
string
serial_number
string
is_rented
boolean
client_purchase_price
string
client_purchase_date
string
client_warranty_endDate
string
client_rental_price
string
client_rental_startDate
string
client_rental_endDate
string
client_contract_number
string
client_invoice_number
string
screen_size
string
graphic
string
processor
string
ram
string
storage
string
model_year
string
connectivity
string
keyboard_layout

Keyboard layout key (same enum as cart/order keyboard_layout).

string
Allowed values: FRENCH_AZERTY SPANISH_QWERTY ITALIAN_QWERTY INTERNATIONAL_ENGLISH_QWERTY GERMAN_QWERTZ PORTUGUESE_QWERTY ENGLISH_QWERTY SWISS_QWERTZ AMERICAN_ENGLISH_QWERTY CANADIAN_ENGLISH_QWERTY DUTCH_QWERTY
Example
FRENCH_AZERTY
resolution
string
comment
string
has_microphone
boolean
nullable
has_webcam
boolean
nullable
noise_cancellation
boolean
nullable
compliance
Any of:
Array<string>
connection_type

Connection type labels; single string or array (stored as array).

Array<string>
nullable
has_stool
boolean
nullable
has_video_package
boolean
nullable
has_screen
boolean
nullable
has_premium_tablet
boolean
nullable
color
string
seats_number
string
assembly
string
os_platform
string

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Devices created

object
data
required
object
devices
required
Array<object>
object
id
required
integer
name
required
string
nullable
serial_number
required
string
nullable
rent
required
string
nullable
tracking_number
required
string
nullable
client_status
required

Device progress key for display and filtering

string
Allowed values: ARCHIVED PENDING_VALIDATION IN_PREPARATION DELIVERED SHIPPED AVAILABLE IN_SERVICE IN_MAINTENANCE OUT_OF_SERVICE
type
required
string
nullable
category
required
string
nullable
source
required
string
nullable
comment
required

Free-form device comment

string
nullable
characteristics
required
object
screen_size
required
string
nullable
graphic
required
string
nullable
processor
required
string
nullable
ram
required
string
nullable
storage
required
string
nullable
model_year
required
string
nullable
connectivity
required
string
nullable
keyboard_layout
required

Keyboard layout for delivery pricing (maps to Fleet keyboard_layouts.type)

string
nullable
Allowed values: FRENCH_AZERTY SPANISH_QWERTY ITALIAN_QWERTY INTERNATIONAL_ENGLISH_QWERTY GERMAN_QWERTZ PORTUGUESE_QWERTY ENGLISH_QWERTY SWISS_QWERTZ AMERICAN_ENGLISH_QWERTY CANADIAN_ENGLISH_QWERTY DUTCH_QWERTY
Example
FRENCH_AZERTY
resolution
required
string
nullable
has_microphone
required
boolean
nullable
has_webcam
required
boolean
nullable
noise_cancellation
required
boolean
nullable
compliance
required
Array<string>
nullable
connection_type
required
Array<string>
nullable
has_stool
required
boolean
nullable
has_video_package
required
boolean
nullable
has_screen
required
boolean
nullable
has_premium_tablet
required
boolean
nullable
color
required
string
nullable
seats_number
required
string
nullable
assembly
required
string
nullable
os_platform
required
string
nullable
mdm
required

MDM enrollment row when present (non-deleted, non-DRAFT); null otherwise

object
id
required
integer
status
required

Raw MDM enrollment status from devices_mdm. DRAFT rows are omitted by the device relation; other values match DB enum.

string
Allowed values: DRAFT SUBSCRIBED DOWNLOADED IDENTIFIED ENROLLMENT_IN_PROGRESS ENROLLED UNENROLLED DEVICE_WIPE_PENDING
local_name
required
string
nullable
is_locked
required
boolean
nullable
lock_date
required
string
nullable
firewall_enabled
required
boolean
nullable
os_updates_enabled
required
boolean
nullable
is_encrypted
required
boolean
nullable
screenlock_enabled
required
boolean
nullable
is_compromised
required
boolean
nullable
os_updates_available
required
boolean
nullable
disk_encryption_profile_installed
required
boolean
nullable
enrollment_date
required
string
nullable
unenrollment_date
required
string
nullable
download_date
required
string
nullable
last_seen_date
required
string
nullable
last_sync_date
required
string
nullable

400

Section titled “400 ”

Validation or business rule error

Any of:
object
error
required
string

403

Section titled “403 ”

Forbidden

object
error
required
string
Allowed values: INSUFFICIENT_SCOPE

404

Section titled “404 ”

Not found

object
error
required
string
Allowed values: COMPANY_NOT_FOUND

500

Section titled “500 ”

Internal error

object
error
required
string
Allowed values: PLATFORM_DEVICE_ACTOR_NOT_FOUND DEVICE_PROVISIONING_FAILED