49 lines
1.5 KiB
Markdown
49 lines
1.5 KiB
Markdown
---
|
|
name: device-integrations-routes
|
|
description: Handle 4 OpenAPI operation(s) under /api/v1/device-integrations for the device integrations route group.
|
|
---
|
|
|
|
# device integrations API Routes
|
|
|
|
Handle 4 OpenAPI operation(s) under /api/v1/device-integrations for the device integrations 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_device_integrations
|
|
|
|
- Operation ID: `list_device_integrations`
|
|
- Route: `GET /api/v1/device-integrations`
|
|
- Mode: READ
|
|
- Summary: List all device integrations
|
|
|
|
### get_device_integration
|
|
|
|
- Operation ID: `get_device_integration`
|
|
- Route: `GET /api/v1/device-integrations/{deviceIntegrationId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a device integration
|
|
- Parameters:
|
|
- `deviceIntegrationId` in `path` required
|
|
|
|
### activate_device_integration
|
|
|
|
- Operation ID: `activate_device_integration`
|
|
- Route: `POST /api/v1/device-integrations/{deviceIntegrationId}/lifecycle/activate`
|
|
- Mode: WRITE
|
|
- Summary: Activate a device integration
|
|
- Parameters:
|
|
- `deviceIntegrationId` in `path` required
|
|
|
|
### deactivate_device_integration
|
|
|
|
- Operation ID: `deactivate_device_integration`
|
|
- Route: `POST /api/v1/device-integrations/{deviceIntegrationId}/lifecycle/deactivate`
|
|
- Mode: WRITE
|
|
- Summary: Deactivate a device integration
|
|
- Parameters:
|
|
- `deviceIntegrationId` in `path` required
|