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
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
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

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

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

Related

• Devices concept
• Production rollout
• Security model