Gateway API overview

The Dataplicity Gateway API is the current integration surface for server-to-server automation, fleet dashboards, and remote access bootstrap.


Base URL	`https://gateway.dataplicity.com`
Version	v1
Format	JSON
Interactive reference	gateway.dataplicity.com
OpenAPI schema	gateway.dataplicity.com/developers/schema/

Use this API to read fleet state, bootstrap remote access, collect logs, and run organisation-scoped workflows from your own backend systems.

First request in 60 seconds

bash

curl -s \
  -H "Authorization: ApiKey $ORG_API_KEY" \
  "https://gateway.dataplicity.com/api/organisations/$ORG_HASH/devices/"

Use an API key with inventory:read scope. If this returns 200, your key format, scope, and organisation hash are valid.

Powering fleet dashboards and operational views in your own product
Automating device and organisation workflows from backend services
Bootstrapping remote access (terminal and related services) with correct customer context
Integrating logs, monitors, and incident automation into your ops stack

Section	Endpoints	Use for
Authentication	API keys, scopes, tenancy	Every request
Fleet overview	`/api/developer/devices/`	Device inventory, details, status refresh
Organisation API	`/api/organisations/{org_hash}/…`	Inventory, logs, incident automation
Remote access	`/api/remote/devices/{device_hash}/…`	Host/port bootstrap for terminal sessions
Device classes	`/api/device-classes/{hash_id}/…`	Class capabilities and rollout context
Conventions	-	Pagination, errors, production checklist

Provision an organisation API key - store it server-side only
Call GET /api/organisations/{org_hash}/devices/ to verify auth and scope
Map org_hash and device_hash to your customer/device model
For remote access: GET …/host/ then POST …/ports/ with service: terminal
Add write operations (device updates, incident rules) as your integration matures