Skip to main content

Creates a device

POST /v1/device

Summary​

Creates a device.

Authentication​

No operation-level security requirement is documented here.

Parameters​

None documented here.

Request Body​

Required: Yes

application/json​

  • key (integer (int64), optional)
  • deviceTypeID (integer (int64), optional)
  • deviceName (string, optional)
  • serialNumber (string, optional)
  • deviceDescription (string, optional)
  • recentOutput (string, optional)
  • cameraStatus (string, optional)
  • lastIPAddress (string, optional)
  • tunnelIPAddress (string, optional)
  • lastHeardFromDate (string (date-time), optional)
  • offlineNotificationDate (string (date-time), optional)
  • softwareDate (string (date-time), optional)
  • location (string, optional)
  • setupStatus (integer (int64), optional)
  • autoSendFiles (integer (int64), optional)
  • runStartupEvent (integer (int64), optional)
  • deviceReadyEventPresetID (integer (int64), optional)
  • standaloneEventPresetID (integer (int64), optional)
  • logHealth (integer (int64), optional)
  • runAnalytics (integer (int64), optional)
  • audioChannelName (string, optional)
  • volume (integer (int64), optional)
  • commentListID (integer (int64), optional)
  • creationDate (string (date-time), optional)

Example

{
  "key": 201,
  "deviceTypeID": 1,
  "deviceName": "WearableDevice",
  "serialNumber": "10001234",
  "deviceDescription": "Example description",
  "recentOutput": "Agent started successfully.",
  "cameraStatus": "online",
  "lastIPAddress": "203.0.113.42",
  "tunnelIPAddress": "203.0.113.42",
  "lastHeardFromDate": "2026-03-30T12:00:00.0000000Z",
  "offlineNotificationDate": "2026-03-30T12:00:00.0000000Z",
  "softwareDate": "2026-03-30T12:00:00.0000000Z",
  "location": "Remote site",
  "setupStatus": 1,
  "autoSendFiles": 1,
  "runStartupEvent": 1,
  "deviceReadyEventPresetID": 1,
  "standaloneEventPresetID": 1,
  "logHealth": 1,
  "runAnalytics": 1,
  "audioChannelName": "Example value",
  "volume": 75,
  "commentListID": 1,
  "creationDate": "2026-03-30T12:00:00.0000000Z"
}

Responses​

200​

Success

application/json​

  • key (integer (int64), optional)
  • deviceTypeID (integer (int64), optional)
  • deviceName (string, optional)
  • serialNumber (string, optional)
  • deviceDescription (string, optional)
  • recentOutput (string, optional)
  • cameraStatus (string, optional)
  • lastIPAddress (string, optional)
  • tunnelIPAddress (string, optional)
  • lastHeardFromDate (string (date-time), optional)
  • offlineNotificationDate (string (date-time), optional)
  • softwareDate (string (date-time), optional)
  • location (string, optional)
  • setupStatus (integer (int64), optional)
  • autoSendFiles (integer (int64), optional)
  • runStartupEvent (integer (int64), optional)
  • deviceReadyEventPresetID (integer (int64), optional)
  • standaloneEventPresetID (integer (int64), optional)
  • logHealth (integer (int64), optional)
  • runAnalytics (integer (int64), optional)
  • audioChannelName (string, optional)
  • volume (integer (int64), optional)
  • commentListID (integer (int64), optional)
  • creationDate (string (date-time), optional)

Example

{
  "key": 201,
  "deviceTypeID": 1,
  "deviceName": "WearableDevice",
  "serialNumber": "10001234",
  "deviceDescription": "Example description",
  "recentOutput": "Agent started successfully.",
  "cameraStatus": "online",
  "lastIPAddress": "203.0.113.42",
  "tunnelIPAddress": "203.0.113.42",
  "lastHeardFromDate": "2026-03-30T12:00:00.0000000Z",
  "offlineNotificationDate": "2026-03-30T12:00:00.0000000Z",
  "softwareDate": "2026-03-30T12:00:00.0000000Z",
  "location": "Remote site",
  "setupStatus": 1,
  "autoSendFiles": 1,
  "runStartupEvent": 1,
  "deviceReadyEventPresetID": 1,
  "standaloneEventPresetID": 1,
  "logHealth": 1,
  "runAnalytics": 1,
  "audioChannelName": "Example value",
  "volume": 75,
  "commentListID": 1,
  "creationDate": "2026-03-30T12:00:00.0000000Z"
}