Skip to main content
POST
Register device agent

Body

application/json
name
string
required

Human-readable computer name reported by the device

Example:

"Jane's MacBook Pro"

hostname
string
required

Network hostname of the device

Example:

"janes-macbook-pro.local"

platform
enum<string>
required

Operating system family the device runs

Available options:
macos,
windows,
linux
Example:

"macos"

osVersion
string
required

Operating system version string reported by the device

Example:

"15.3.1"

organizationId
string
required

ID of the organization to register the device under

Example:

"org_abc123def456"

serialNumber
string

Hardware serial number, used to match the device to an existing record

Example:

"C02XY1234567"

hardwareModel
string

Hardware model identifier reported by the device

Example:

"MacBookPro18,3"

agentVersion
string

Version of the device agent performing the registration

Example:

"1.4.2"

Response

201 - undefined