Droplit.io Portal
API Reference

URL Organization

Overview

The Droplit REST API is structured using a small set of resources, and the structures of the URLs can be helpful in determining what a particular endpoint does. The following organization of the present URLs emphasizes common functionalities between endpoints which may not be immediately obvious.

Some URLs are present in multiple sections below, because they could, in theory, be sorted into more than one API to highlight the functionality they have in common with other URLs.

Accounts

  • /api/account
  • /api/account/logoff

Claims

  • /api/ecosystems/:id/claims
  • /api/ecosystems/:id/claims/:edgeId
  • /api/environments/claim

Clients

  • /api/clients
  • /api/clients/:id
  • /api/clients/:id/tokens
  • /api/clients/:id/tokens/:tokenId
  • /api/clients/:id/tokens/:tokenId/regenerate

Devices

  • /api/devices
  • /api/devices/:id
  • /api/devices/:id/history
  • /api/devices/:id/services
  • /api/devices/:id/services/selector

Ecosystems

  • /api/ecosystems
  • /api/ecosystems/:id
  • /api/ecosystems/:id/claims
  • /api/ecosystems/:id/claims/:edgeId
  • /api/ecosystems/:id/conduits/:conduitName
  • /api/ecosystems/:id/assets

Environments

  • /api/environments
  • /api/environments/:id
  • /api/environments/:id/history
  • /api/environments/:id/services
  • /api/environments/:id/services/:selector
  • /api/environments/claim

History

  • /api/devices/:id/history
  • /api/environments/:id/history

Schemas

  • /api/schemas
  • /api/schemas/:schemaName

Service Classes

  • /api/serviceclasses
  • /api/serviceclasses/:ecosystemId;:name
  • /api/serviceclasses/curated
  • /api/serviceclasses/curated/:curatedName

Service Implementations

  • /api/devices/:id/services
  • /api/devices/:id/services/selector
  • /api/environments/:id/services
  • /api/environments/:id/services/:selector
  • /api/zones/:id/items/services
  • /api/zones/:id/items/services/:selector

Tokens

  • /api/clients/:id/tokens
  • /api/clients/:id/tokens/:tokenId
  • /api/clients/:id/tokens/:tokenId/regenerate
  • /api/users/:ecosystemId;:userId/tokens

Users

  • /api/users
  • /api/users/:ecosystemId;:userId
  • /api/users/:ecosystemId;:userId/tokens

Webhooks

  • /api/webhooks
  • /api/webhooks/:id

Zones

  • /api/zones
  • /api/zones/:id
  • /api/zones/:id/devices
  • /api/zones/:id/items
  • /api/zones/:id/items/:itemId
  • /api/zones/:id/items/services
  • /api/zones/:id/items/services/:selector