2.1 KiB
2.1 KiB
name, description
| name | description |
|---|---|
| devices-routes | Handle 8 OpenAPI operation(s) under /api/v1/devices for the devices route group. |
devices API Routes
Handle 8 OpenAPI operation(s) under /api/v1/devices for the devices route group.
Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.
Operations
list_devices
- Operation ID:
list_devices - Route:
GET /api/v1/devices - Mode: READ
- Summary: List all devices
- Parameters:
afterinquerylimitinquerysearchinqueryexpandinquery
get_device
- Operation ID:
get_device - Route:
GET /api/v1/devices/{deviceId} - Mode: READ
- Summary: Retrieve a device
- Parameters:
deviceIdinpathrequired
delete_device
- Operation ID:
delete_device - Route:
DELETE /api/v1/devices/{deviceId} - Mode: WRITE
- Summary: Delete a device
- Parameters:
deviceIdinpathrequired
activate_device
- Operation ID:
activate_device - Route:
POST /api/v1/devices/{deviceId}/lifecycle/activate - Mode: WRITE
- Summary: Activate a device
- Parameters:
deviceIdinpathrequired
deactivate_device
- Operation ID:
deactivate_device - Route:
POST /api/v1/devices/{deviceId}/lifecycle/deactivate - Mode: WRITE
- Summary: Deactivate a device
- Parameters:
deviceIdinpathrequired
suspend_device
- Operation ID:
suspend_device - Route:
POST /api/v1/devices/{deviceId}/lifecycle/suspend - Mode: WRITE
- Summary: Suspend a Device
- Parameters:
deviceIdinpathrequired
unsuspend_device
- Operation ID:
unsuspend_device - Route:
POST /api/v1/devices/{deviceId}/lifecycle/unsuspend - Mode: WRITE
- Summary: Unsuspend a Device
- Parameters:
deviceIdinpathrequired
list_device_users
- Operation ID:
list_device_users - Route:
GET /api/v1/devices/{deviceId}/users - Mode: READ
- Summary: List all users for a device
- Parameters:
deviceIdinpathrequired