Update Device
PATCH
/users/{user_id}/devices/{device_id}
const url = 'https://example.com/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/devices/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = { method: 'PATCH', headers: {'Content-Type': 'application/json'}, body: '{"archived":true,"name":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://example.com/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/devices/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \ --header 'Content-Type: application/json' \ --data '{ "archived": true, "name": "example" }'Rename and/or archive a device.
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”user_id
required
User Id
string format: uuid
device_id
required
Device Id
string format: uuid
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
DeviceUpdate
Rename and/or archive a device. Only user-owned fields — observational fields (hostname, platform, seen timestamps) are refreshed from uploads, not the client.
Examplegenerated
{ "archived": true, "name": "example"}Responses
Section titled “Responses”Successful Response
Media typeapplication/json
DeviceOut
object
archived
required
Archived
boolean
client_id
required
Client Id
string
id
required
Id
string format: uuid
name
required
Name
string
Examplegenerated
{ "archived": true, "client_id": "example", "first_seen_at": "2026-04-15T12:00:00Z", "hostname": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "last_seen_at": "2026-04-15T12:00:00Z", "name": "example", "platform": "example"}Validation Error
Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{ "detail": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ]}