{"_id":"59d1274e10f793001075294b","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":19,"createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"59a734eb757d030019b85af8","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-08-30T21:58:03.883Z","from_sync":false,"order":6,"slug":"rest-api-usage","title":"REST API Usage"},"user":"58cc41f21751ce2f003be3b7","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-10-01T17:35:10.790Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"# Overview\n\nThe 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.\n\nSome 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.\n\n# Accounts\n- /api/account\n- /api/account/logoff\n\n# Claims\n- /api/ecosystems/:id/claims\n- /api/ecosystems/:id/claims/:edgeId\n- /api/environments/claim\n\n# Clients\n- /api/clients\n- /api/clients/:id\n- /api/clients/:id/tokens\n- /api/clients/:id/tokens/:tokenId\n- /api/clients/:id/tokens/:tokenId/regenerate\n\n# Devices\n- /api/devices\n- /api/devices/:id\n- /api/devices/:id/history\n- /api/devices/:id/services\n- /api/devices/:id/services/selector\n\n# Ecosystems\n- /api/ecosystems\n- /api/ecosystems/:id\n- /api/ecosystems/:id/claims\n- /api/ecosystems/:id/claims/:edgeId\n\n# Environments\n- /api/environments\n- /api/environments/:id\n- /api/environments/:id/history\n- /api/environments/:id/services\n- /api/environments/:id/services/:selector\n- /api/environments/claim\n\n# History\n- /api/devices/:id/history\n- /api/environments/:id/history\n\n# Schemas\n- /api/schemas\n- /api/schemas/:schemaName\n\n# Service Classes\n- /api/serviceclasses\n- /api/serviceclasses/:ecosystemId;:name\n- /api/serviceclasses/curated\n- /api/serviceclasses/curated/:curatedName\n\n# Service Implementations\n- /api/devices/:id/services\n- /api/devices/:id/services/selector\n- /api/environments/:id/services\n- /api/environments/:id/services/:selector\n- /api/zones/:id/items/services\n- /api/zones/:id/items/services/:selector\n\n# Tokens\n- /api/clients/:id/tokens\n- /api/clients/:id/tokens/:tokenId\n- /api/clients/:id/tokens/:tokenId/regenerate\n- /api/users/:ecosystemId;:userId/tokens\n\n# Users\n- /api/users\n- /api/users/:ecosystemId;:userId\n- /api/users/:ecosystemId;:userId/tokens\n\n# Webhooks\n- /api/webhooks\n- /api/webhooks/:id\n\n# Zones\n- /api/zones\n- /api/zones/:id\n- /api/zones/:id/devices\n- /api/zones/:id/items\n- /api/zones/:id/items/:itemId\n- /api/zones/:id/items/services\n- /api/zones/:id/items/services/:selector","excerpt":"","slug":"rest-api-url-organization","type":"basic","title":"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 # 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