Update a device

Request

Security

ApiKey(Required scopes: devices.update)

Path

nameOrIdstringrequired

Device name or ID. Device names must be URI-encoded if they contain non-URI-safe characters. If a device is named with another device's ID, the device with the matching name will be returned.

Query

projectIdstring

Filter devices by project

Bodyapplication/jsonrequired

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

Device names must be unique within a project.

retainRecordingsSecondsinteger, >= 0

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

propertiesobject

A key-value map from device custom property keys to their values. Unknown keys are ignored. Omitted keys are unchanged. Set a value to null to remove it.

enabledboolean

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.

remoteAccessEnabledboolean

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

autoDeleteAfterImportboolean

Whether recordings on a device running Foxlet are automatically deleted once they have been successfully uploaded and accepted for import. This is only relevant for devices that have Foxlet installed. Foxlet versions older than 1.5.0 ignore this setting until upgraded.

Payload

{
  "name": "string",
  "retainRecordingsSeconds": 0,
  "properties": {},
  "enabled": true,
  "remoteAccessEnabled": true,
  "autoDeleteAfterImport": true
}

Responses

Update 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.

Response

{
  "id": "string",
  "name": "string",
  "projectId": "string",
  "retainRecordingsSeconds": 0,
  "properties": {
    "property1": "string",
    "property2": "string"
  },
  "enabled": true,
  "remoteAccessEnabled": true,
  "autoDeleteAfterImport": true
}