Devices

Delete device

Delete device using Ovok’s Slim API.

MethodPath
DELETE/v1/slim/device/:id

Authentication · Access policies

Deletes a device from your project.

Auth: bearer token. The caller must be a practitioner, an admin or a System Owner, and needs Device:delete. System Owners cannot delete devices. Scope: the device must belong to the caller's project (from the token).

Request

Path parameters

NameTypeRequiredDescription
idstring (uuid)YesDevice id.

Behaviour

  • The Device resource is deleted. This cannot be undone.
  • If a resident is assigned, they are unassigned and their active out-of-bed episode is closed in the same transaction.
  • The device's use history is updated in the same transaction.
  • The delete is recorded in the change history.
  • The response has no body.

Example

curl -X DELETE 'https://api.sandbox.ovok.com/v1/slim/device/8c5e7a21-4b9d-4f36-a1c8-0d2e6b9f3a54' \
  -H "Authorization: Bearer ${OVOK_TOKEN}"

Successful response

200 — Device deleted. The response has no body.

Errors

StatusMeaning
401Bearer token is missing, invalid or expired.
403You are not a practitioner, admin or System Owner, you lack Device:delete, you have the System Owner policy, or the device does not exist or is not in your project.
422id is not a UUID.

Last updated on

On this page