API and integrations #

Connect Dataplicity to provisioning pipelines, support systems, fleet reporting, and backend automation. The Gateway API exposes the same fleet identity and operational context that teams use in the Dataplicity application.

Start with an integration goal #

Goal	Start here
Create and scope an organisation API key	API keys
Confirm provisioned devices reached the service	Fleet overview
Add Dataplicity data to support tooling	Organisation API
Open remote access from your own product	Remote access
Inspect device-class capabilities	Device classes
Read, write, aggregate, or export Product Application records	Product Application API
Connect a Product Application to inbound or outbound HTTPS workflows	Product integration reference
Connect Cursor or another MCP client	Hosted MCP
Build a production service integration	Authentication and conventions

Gateway API #

The Dataplicity Gateway API is the current server-to-server integration surface. Requests use https://gateway.dataplicity.com as their API origin, while the guides and interactive endpoint reference live together in this documentation site.

API contract

The interactive reference is generated from Dataplicity's filtered public OpenAPI contract. The machine-readable schema remains available from the Gateway service.

First request #

bash

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

Product Application API #

The Product Application API is instance-scoped. It works with the records, operations, queries, reporting, and integration boundaries of one published customer application. It is separate from the Gateway API fleet surface and from the OEM authoring APIs used to edit drafts.

Start with Product Application API and integrations for the task-oriented workflow. Use the reference family for implementation details:

API overview - authentication, instance scoping, response envelopes, errors, and idempotency
Product Records - read, write, relationship integrity, secret fields, and archive semantics
Product Query - typed filters, projection, ordering, cursor pagination, and limits
Reporting - aggregates, grouping, time buckets, and streaming CSV export
Integrations - outbound delivery, managed credentials, retries, replay, and authenticated inbound endpoints

CLI and scripts #

For shell-based fleet operations from your workstation, see the command-line interface.

Typical integrations #

Factory provisioning - verify devices appear online after imaging
Support ticketing - link tickets to device_hash; read online status
Fleet reporting - paginate organisation inventory into internal dashboards
Embedded remote access - bootstrap terminal sessions from your product backend
Incident automation - create and manage alert rules programmatically