Documentation

Appearance

Organisation API ​

Organisation-scoped endpoints for fleet inventory, logs, incident automation, and SSO. All paths include {org_hash} - the organisation identifier from your account.

Base path: /api/organisations/{org_hash}/

Device inventory ​

GET /api/organisations/{org_hash}/devices/

List devices with pagination.

Query paramDescription
limitResults per page
offsetStarting index
bash
curl -s \
  -H "Authorization: ApiKey $ORG_API_KEY" \
  "https://gateway.dataplicity.com/api/organisations/$ORG_HASH/devices/?limit=100&offset=0"

Paginated response ​

json
{
  "count": 123,
  "next": "https://gateway.dataplicity.com/api/organisations/.../devices/?offset=100&limit=100",
  "previous": null,
  "results": [
    {
      "hash_id": "...",
      "name": "acme-gateway-042",
      "hostname": "gw-042",
      "is_online": "true",
      "status": "online",
      "tag_names": "customer:acme,site:manchester",
      "last_heartbeat": "2026-07-02T04:30:00Z"
    }
  ]
}

Iterate using next until null. Do not assume a single page contains your full fleet.

Requires inventory:read scope (or equivalent) on your API key.

Logs ​

GET /api/organisations/{org_hash}/logs/

List logs for the organisation. Use when integrating external workflows or customer-facing automation against the public API contract.

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

See also the developer alias at Fleet overview - Logging.

Incident automation ​

Manage monitors, alerts, and automation rules for device health and incident response.

List rules ​

GET /api/organisations/{org_hash}/incident-automation/rules/

Create rule ​

POST /api/organisations/{org_hash}/incident-automation/rules/
json
{
  "name": "Gateway offline alert",
  "description": "Alert when gateway process stops",
  "source": "service",
  "severity": "high",
  "enabled": true,
  "trigger_threshold": 1,
  "trigger_window_minutes": 5,
  "settle_threshold": 1,
  "settle_window_minutes": 10,
  "cooldown_minutes": 30,
  "monitored_signals": ["gateway-app"]
}

Source values: heartbeat, service, user-impact, synthetic, custom, composite, cron

Get, update, replace, delete rule ​

GET    /api/organisations/{org_hash}/incident-automation/rules/{id}/
PATCH  /api/organisations/{org_hash}/incident-automation/rules/{id}/
PUT    /api/organisations/{org_hash}/incident-automation/rules/{id}/
DELETE /api/organisations/{org_hash}/incident-automation/rules/{id}/

Signals and insights ​

GET  /api/organisations/{org_hash}/incident-automation/signals/
GET  /api/organisations/{org_hash}/incident-automation/insights/
POST /api/organisations/{org_hash}/incident-automation/rule-simulations/
  • Signals - available monitor signals for rule configuration
  • Insights - incident automation analytics
  • Rule simulations - test a rule against historical data before enabling

SSO endpoints ​

Organisation SSO configuration (SAML):

GET  /api/organisations/{org_hash}/sso/metadata
GET  /api/organisations/{org_hash}/sso/login
GET  /api/organisations/{org_hash}/sso/acs
POST /api/organisations/{org_hash}/sso/acs

These SAML endpoints are available when SSO is enabled by the organisation's current entitlement. Use the organisation SSO surface for tenant-specific metadata and configuration.