Update a device

wireguard_pubkey has to be different from the public key of the location.

put

Authorizations

cookieapi_token

defguard_sessionstringRequired

Path parameters

device_idinteger · int64Required

ID of the device.

Body

application/json

descriptionstring · nullableOptional

namestringRequired

wireguard_pubkeystringRequired

Responses

200

Device updated.

application/json

configuredbooleanRequired

Whether the device is ready to use. Unconfigured devices are not sent to the gateway. Such a device is already added to all its networks, but is still missing something, for example its public key.

createdstring · date-timeRequired

descriptionstring · nullableOptional

device_typestring · enumRequiredPossible values:

idinteger · int64Required

namestringRequired

user_idinteger · int64Required

wireguard_pubkeystringRequired

400

No networks are configured, or the public key belongs to a location.

application/json

401

Session is missing or invalid.

application/json

403

Requires admin privileges or the request must target your own account.

application/json

404

Device not found.

application/json

500

Unable to update device.

application/json

put/api/v1/device/{device_id}

HTTPcURLJavaScriptPython

PUT /api/v1/device/{device_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "description": null,
  "name": "text",
  "wireguard_pubkey": "text"
}

{
  "configured": true,
  "created": "2024-07-10T10:25:43.231",
  "description": null,
  "device_type": "user",
  "id": 1,
  "name": "work laptop",
  "user_id": 1,
  "wireguard_pubkey": "xTIBA5rboUvnH4htodjb6e697QjLERt1NAB4mZqp8Dg="
}