Appearance
Fleet overview
Fleet overview endpoints expose device inventory and state for OEM/developer portal integrations. All requests require Authorization: ApiKey <key>.
Base path: /api/developer/
List devices
GET /api/developer/devices/List devices accessible via device-class ownership.
bash
curl -s \
-H "Authorization: ApiKey $ORG_API_KEY" \
"https://gateway.dataplicity.com/api/developer/devices/"No query parameters required. Returns devices visible to the authenticated API key.
Get device details
GET /api/developer/devices/{device_hash}/Returns high-level details for a single device.
bash
curl -s \
-H "Authorization: ApiKey $ORG_API_KEY" \
"https://gateway.dataplicity.com/api/developer/devices/$DEVICE_HASH/"Update device details
PATCH /api/developer/devices/{device_hash}/Developer-safe partial update. Allowed fields:
| Field | Maps to | Description |
|---|---|---|
name | vendor_name | Display name |
description | vendor_description | Device description |
wormhole_enabled | - | Enable/disable Wormhole |
wormhole_override | - | Wormhole configuration override |
bash
curl -s -X PATCH \
-H "Authorization: ApiKey $ORG_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "acme-gateway-042", "description": "Manchester warehouse"}' \
"https://gateway.dataplicity.com/api/developer/devices/$DEVICE_HASH/"Delete device
DELETE /api/developer/devices/{device_hash}/Remove a device from the developer device management surface. Returns 204 No Content on success.
Fleet map
GET /api/developer/devices/fleet-map/Return map markers for devices with a known last-seen geo location. Use for fleet map visualisations in your product.
Status refresh
GET /api/developer/devices/status-refresh/
POST /api/developer/devices/status-refresh/Lightweight online-status refresh without refetching the full device list payload.
- GET - retrieve current status refresh data
- POST - trigger a status refresh (returns online indicator fields only)
Use this to keep online/offline indicators current in dashboards that poll frequently.
Logging
GET /api/developer/logging/
GET /api/developer/logging/{log_id}/Developer API alias for organisation logs.
- List -
GET /api/developer/logging/ - Get entry -
GET /api/developer/logging/{log_id}/
For organisation-scoped log access, see Organisation operations - Logs.
Device object fields
Device list responses include fields such as:
| Field | Description |
|---|---|
hash_id | Device identifier for API calls |
name / vendor_name | Display name |
hostname | Device hostname |
is_online | Online indicator |
status | Device status string |
device_class | Associated device class |
tag_names / vendor_tag_names | Fleet tags |
last_heartbeat | Last agent heartbeat timestamp |
developer_serial | Optional 16-char alphanumeric serial |
current_firmware_version | Firmware version string |
See the interactive schema for the full DeviceList object.