Create a device

Request

Security

ApiKey(Required scopes: devices.create)

Bodyapplication/jsonrequired

namestring, <= 100 characters(deviceName)^[A-Za-z0-9_.-]+$required

The name of the device.

propertiesobject(CustomPropertyValues)

A key-value map, where each key is one of your pre-defined device custom property keys. Keys which are not recognized as custom properties will be ignored.

projectIdstring

The project ID that the device belongs to. Required for multi-project orgs.

from foxglove.client import Client

token = "<YOUR API TOKEN HERE>"
client = Client(token=token)

client.create_device(
    name=name,
    project_id="<YOUR PROJECT ID HERE>",
)

Responses

The newly created device

Bodyapplication/json

idstringrequired

Opaque identifier

namestringrequired

Organization-chosen device name

projectIdstringrequired

The project ID that the device belongs to

retainRecordingsSecondsnumber

Retention period for recordings on a device running Foxlet, in seconds. Set to 0 to retain recordings indefinitely.

propertiesobject(CustomPropertyValues)

A key-value map of the custom properties associated with this device.

enabledbooleanrequired

Whether this device is enabled. Devices are enabled by default, unless they are created with a device token with preapproved set to false. Disabled devices show up in the device list, but you can't upload recordings for them. A device token linked to a disabled device does not grant access to the API.

remoteAccessEnabledbooleanrequired

Whether remote access is enabled for this device. When disabled, the device cannot establish new remote access sessions.

autoDeleteAfterImportbooleanrequired

Whether recordings on this device are automatically deleted once they have been successfully uploaded and accepted for import. This is only relevant for devices that have Foxlet installed.

orgIdstring

createdAtstring, (date)

updatedAtstring, (date-time)

Response

{
  "id": "string",
  "name": "string",
  "projectId": "string",
  "retainRecordingsSeconds": 0,
  "properties": {
    "property1": "string",
    "property2": "string"
  },
  "enabled": true,
  "remoteAccessEnabled": true,
  "autoDeleteAfterImport": true,
  "orgId": "string",
  "createdAt": "2019-08-24",
  "updatedAt": "2019-08-24T14:15:22Z"
}