Clearblade

ClearBlade API

A friendly little API to help you interact with the ClearBlade platform.

IoT & devices#openapi#iot

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

A friendly little API to help you interact with the ClearBlade platform.

Endpoints 220

Adapter

  • GETADAPTERS - Get all adapters/api/v/4/:SystemKey/adaptersReturns all device info that the current user is authorized to see.
  • POSTADAPTERS - Add an adapter/api/v/4/:SystemKey/adaptersAdds an adapter to the system
  • PUTADAPTERS - Map Adapter command to execute a file/api/v/4/:SystemKey/adapters/:AdapterNameAdds a command to the configuration section of the adapter.
  • DELETEADAPTERS - Delete adapter/api/v/4/:SystemKey/adapters/:AdapterNameDeletes the adapter
  • PUTADAPTERS - Send command to edge/api/v/4/:SystemKey/adapters/:AdapterName/controlCommands with files will send data to an edge
  • GETGets list of configuration information for all adapter files/api/v/4/:SystemKey/adapters/:AdapterName/filesLists configuration information for all versions of all adapter files
  • POSTADAPTERS - Add or replace file content & configuration/api/v/4/:SystemKey/adapters/:AdapterName/filesCreate a new file with content and configuration, or replace an existing file's content & configuration.
  • GETADAPTERS - Download file from adapter/api/v/4/:SystemKey/adapters/:AdapterName/files/:fileNameDownloads file from command in adapter to computer.
  • PUTADAPTERS - Update Existing File's content/api/v/4/:SystemKey/adapters/:AdapterName/files/:fileNameUpdate the content of the existing file
  • DELETEADAPTERS - Delete adapter files/api/v/4/:SystemKey/adapters/:AdapterName/files/:fileNameDeletes the adapter file for a command

Admin

  • GETADMIN - Get number of admin developers/admin/count/developersRetrieves the number of developers who are considered administrators in their system.
  • GETADMIN - Get number of systems available/admin/count/systemsRetrieves the number of systems that are available.
  • PUTADMIN - Add/Remove/Change owner/admin/developers/:systemKeyFor admin, you can add/remove/change the owner of a system even if you’re not the system's owner. For Developer,you can add/remove a developer as long as…
  • GETADMIN - Get platform license key./admin/pkeyReturns current platform license key.
  • GETADMIN - Get developer/admin/platform/developer?developer=stringReturns information about the specified developer.
  • GETADMIN - Get developers/admin/platform/developers?pagesize=string&pagenum=string&total=string&filter=stringReturns all developers in the platform.
  • GETADMIN - Get system status/admin/platform/:systemKeyRetrieves the specified system's status as it relates to limits. To be used by the billing system.
  • POSTADMIN - Change dev password (Admin)/admin/resetpasswordChanges a developer's password.
  • GETGet Systems for a developer/admin/systems/:devEmailGet the list of systems the developer has access to

2FA

  • GET2FA - Get Email Settings/admin/settings/email-serviceGets current email communication settings. This endpoint is Admin only.
  • PUT2FA - Update Email Settings/admin/settings/email-serviceDescription: Updates email communication settings. This endpoint is Admin only. Setting options SMTP is the only protocol supported
  • POST2FA - Create Email Communication/admin/settings/email-serviceDescription: Creates email communication . This endpoint is Admin only. Settings choices
  • DELETE2FA - Delete email settings/admin/settings/email-serviceDeletes email communication settings. This endpoint is Admin only.
  • POST2FA - Test Email Service/admin/settings/email-service/testTest email service . This endpoint is Admin only.
  • GET2FA - View Security Settings/admin/settings/securityView instance wide security settings. This endpoint is Admin only.
  • PUT2FA - Update Security Settings/admin/settings/securityUpdate instance wide security settings.TTL must be between 86400 and 2592000 seconds. This endpoint is Admin only.
  • GET2FA - Get SMS Settings/admin/settings/sms-serviceGets current SMS communication settings. This endpoint is Admin only.
  • PUT2FA - Update SMS Settings/admin/settings/sms-serviceUpdates SMS communication settings. Twilio is the only supported service. This endpoint is Admin only.
  • POST2FA - Create SMS Communication/admin/settings/sms-serviceCreates SMS communication . Twilio is the only supported service. This endpoint is Admin only.
  • DELETE2FA - Delete SMS settings/admin/settings/sms-serviceDeletes SMS communication settings. This endpoint is Admin only.
  • POST2FA - Test SMS Service/admin/settings/sms-service/testTest SMS service . This endpoint is Admin only.
  • PUT2FA - Update developer 2FA information./admin/userinfoDescription: Update the developer 2FA information. This is a developer only endpoint. Note - the email is taken from the developer's account.…
  • POST2FA - Send validation link/admin/validateDescription: Sends a validation link to either the developer's email or phone. This endpoint is for Dev only. Validation Method Types: * email * phone

Audit

  • GETAUDIT - Get Audit Info/admin/audit?query=stringDescription: Returns list of assets and the information about the changes that have been made. This endpoint is for Admin only. Query Structure:…
  • GETAudit - Get counts/admin/audit/countGets total number of changes made to assets across all systems on the instance. This endpoint is Admin only.
  • GETAUDIT - Get Audit Info/admin/audit/:systemKey?query=stringDescription: Returns list of assets and the information about the changes that have been made. This endpoint is for Admin and Dev. Query Structure:…
  • GETAUDIT - Get counts/admin/audit/:systemKey/countGets total number of changes made to assets across all systems on the instance. This endpoint is for Admin and Dev.
  • GETAUDIT - Get list of systems that have been updated/admin/platform/systems?query=stringDescription: Get list of systems that have been updated. This is an Admin only endpoint. Query:…
  • GETAUDIT - Get list of systems that have been updated/admin/platform/systems/:systemKey?query=stringDescription: Get list of changes that have been made to the system. This is an Admin and Dev endpoint. Query:…

Code

  • GETCODE - Retrieve information about service/api/v/1/code/:systemKey/:serviceNameReturns setting information and data for a code service
  • POSTCODE - Call/Execute code service/api/v/1/code/:systemKey/:serviceNameExecutes a code service.
  • GETCODE - Returns code services and settings/api/v/3/code/codemeta/:systemKeyReturns list of code services and its settings info .
  • GETCODE - Get all failed services using Query/api/v/4/:systemKey/code/failed?query=stringReturns list of failed code services.

Webhooks

  • GETWEBHOOKS - Returns webhooks in the system/admin/v/4/webhook/:systemKeyReturns all webhooks in the system.
  • PUTWEBHOOKS - Update a webhook/admin/v/4/webhook/:systemKey/:nameUpdates an existing webhook in the specified system. List of Auth Methods These will be used in auth_method in the body. * clearblade_auth * http_basic_auth *…
  • POSTWEBHOOKS - Creates a webhook/admin/v/4/webhook/:systemKey/:nameCreates a webhook in the system List of Auth Methods These will be used in auth_method in the body. * clearblade_auth * http_basic_auth * payload_auth * no_auth
  • DELETEWEBHOOKS - Delete a webhook/admin/v/4/webhook/:systemKey/:nameDeletes an existing webhook in the specified system.
  • GETWEBHOOKS - Executes query string payload webhook/api/v/4/webhook/execute/:systemKey/:webhookName?token=stringExecutes the webhook of type Payload, authentication occurs over GET's query string
  • POSTWEBHOOKS - Executing a webhook/api/v/4/webhook/execute/:systemKey/:webhookNameExecutes a webhook through a code service

Data

  • GETDATA(name) - Get items/api/v/1/collection/:systemKey/:collectionName?query=stringReturns the data from the specified collection.
  • PUTDATA(name) - Update items/api/v/1/collection/:systemKey/:collectionNameUpdates preexisting data rows in the specified collection.
  • POSTDATA(name) - Create items/api/v/1/collection/:systemKey/:collectionNameCreates new data rows in the specified collection.
  • DELETEDATA(name) - Delete items/api/v/1/collection/:systemKey/:collectionName?query=stringDeletes data rows in the specified collection.
  • GETDATA(id) - Get items/api/v/1/data/:collectionID?query=stringReturns the data from the specified collection.
  • PUTDATA(id) - Update items/api/v/1/data/:collectionIDUpdates preexisting data rows in the specified collection.
  • POSTDATA(id) - Create items/api/v/1/data/:collectionIDCreates new data rows in the specified collection.
  • DELETEDATA(id) - Delete items/api/v/1/data/:collectionID?query=stringDeletes data rows in the specified collection.
  • GETDATA(id) - Get columns/api/v/1/data/:collectionID/columnsReturns the columns and their data type for the specified collection.
  • GETDATA - Get collections/api/v/3/allcollections/:systemKeyReturns all the collections in the specified system.
  • PUTDATA - Update collection/api/v/3/collectionmanagementCreates or deletes a column within an existing collection, or updates an existing database connection in the specified system.
  • POSTDATA - Create collection/api/v/3/collectionmanagementCreates a new collection or database connection in the specified system.
  • DELETEDATA - Delete collection/api/v/3/collectionmanagement?id=stringDeletes an existing collection in the specified system.
  • POSTDATA - Create collection/api/v/4/data/:systemKey/:collectionName/index?columnName=stringThis creates a non-unique index on a column. This is useful for speeding up certain queries, but doesn't work with upsert. This call will fail if the index…
  • DELETEDATA - Delete collection/api/v/4/data/:systemKey/:collectionName/index?columnName=stringThis deletes a non unique index from a column.
  • GETDATA - Get list of indexes/api/v/4/data/:systemKey/:collectionName/listindexesThis returns all USER CREATED indexes/constraints for the collection.For safety, primary key indexes are not returned.
  • POSTDATA - Create Unique Index/api/v/4/data/:systemKey/:collectionName/uniqueindex?columnName=stringThis creates a unique index on a column. A user has to do this before you can use upsert with columnName as the conflictColumn. This call will fail if the…
  • DELETEDATA - Delete unique index/api/v/4/data/:systemKey/:collectionName/uniqueindex?columnName=stringThis deletes a unique index on a column.
  • PUTDATA - Update upsert values/api/v/4/data/:systemKey/:collectionName/upsert?conflictColumn=stringThis adds an insert (if the row does not exist) or an update (if the row exists)

Databases

  • GETDATABASES - Retrieves all internal and external database statuses/admin/database/statusReturns all the names and internal and external database statuses
  • GETDATABASES - Retrieves all external database connections/api/v/4/external-db/:systemKeyReturns all the names and database types of the external database connections for that system. This is a developer only endpoint.
  • POSTDATABASES - Create a external database connection/api/v/4/external-db/:systemKeyDescription: Creates an external database connections for that system. This is a developer only endpoint. List of database types supported: Database Credentials
  • GETDATABASES - Retrieve a specific external database connection/api/v/4/external-db/:systemKey/:nameReturns the name and database type of a external database connection. This is a developer and user endpoint.
  • PUTDATABASES - Update external database credentials/api/v/4/external-db/:systemKey/:nameUpdates existing external database credentials in the specified system. This is a developer and user endpoint.
  • DELETEDATABASES - Delete a external database connection/api/v/4/external-db/:systemKey/:nameDeletes an existing external database connection in the specified system.This is a developer and user endpoint.
  • POSTDATABASES - Create a external database connection/api/v/4/external-db/:systemKey/:name/dataPerform an operation on the external database.This is a developer and user endpoint.

Deployments

  • GETDEPLOYMENTS - Gets sync status for a deployment/admin/:systemKey/sync/deployment/status/:deploymentName
  • POSTDEPLOYMENTS - Retries sync for an asset/admin/:systemKey/sync/retryRetries sync for an asset in an deployment
  • GETDEPLOYMENTS - Gets all deployment names and descriptions for a system/api/v/3/:systemKey/deployments?query=stringDescription: Gets all deployment names and descriptions for a system Query:…
  • POSTDEPLOYMENTS - Creates a deployment/api/v/3/:systemKey/deploymentsCreates one deployment for system
  • GETDEPLOYMENTS - Gets a deloyment for a system/api/v/3/:systemKey/deployments/:deploymentName
  • PUTDEPLOYMENT - Update deployment/api/v/3/:systemKey/deployments/:deploymentNameUpdates a deployment.
  • DELETEDEPLOYMENT - Delete a deployment/api/v/3/:systemKey/deployments/:deploymentNameDeletes a deployment based on the name

Device

  • POSTDEVICE -Creates rotating keys for a device./admin/devices/keys/:systemKey/:deviceNameCreates rotating keys for a device.
  • GETDEVICES - Get all devices/api/v/2/devices/:SystemKey?query=stringReturns all device info that the current user is authorized to see.
  • PUTDEVICES - Update devices using a query/api/v/2/devices/:SystemKeyUpdates all devices matching the filters specified by a query.
  • DELETEDEVICES - Delete devices using a query/api/v/2/devices/:SystemKey?query=stringDeletes all devices matching the filters specified by a query.
  • POSTDEVICES - Authenticate device/api/v/2/devices/:SystemKey/authDescription Logs device into system and returns an Device Access Token. Endpoint Body Values Here are the body values for the two scenarios Basic Auth…
  • PUTDEVICES - Update info/api/v/2/devices/:systemKey/:nameUpdates a device's state or custom attributes.
  • POSTDEVICES - Adds a device/api/v/2/devices/:systemKey/:nameAdds a device in the system
  • GETEDGE - Get device columns/api/v/3/devices/:systemKey/columnsReturns the columns and their data type for the device table in a system.
  • GETDEVICES - Get count/api/v/3/devices/:systemKey/countReturns the total number of devices in a system.
  • GETDEVICES - Get total of connected devices/api/v/4/devices/:systemKey/connectioncountReturns the number of device connections.
  • GETDEVICES - Get connected device list/api/v/4/devices/:systemKey/connectionsReturns the list of connected devices.
  • GETDEVICES - Get information for a connected device/api/v/4/devices/:systemKey/connections/:nameReturns the connection information of the device.

Developer

  • GETDEVELOPER - Get platform assets/admin/allappsRetrieves system information for all systems in the developer account.
  • GETDEVELOPER - Get collections/admin/allcollections?appid=stringReturns all the collections in the specified system.
  • GETDEVELOPER - Get systems/admin/allsystemsReturns all the systems tied to the specified developer's account.
  • POSTDEVELOPER - Authenticate dev/admin/authDescription Logs developer into system and returns an Developer Token Endpoint Body Values Here are the body values for the two scenarios Basic Auth Required…
  • POSTDEVELOPER - Verifies access to the system/admin/checkauthVerifies developer access to the system
  • PUTDEVELOPER - Update collection/admin/collectionmanagementCreates or deletes a column within an existing collection, or updates an existing database connection in the specified system.
  • POSTDEVELOPER - Create collection/admin/collectionmanagementCreates a new collection or database connection in the specified system.
  • DELETEDEVELOPER - Delete collection/admin/collectionmanagement?id=stringDeletes an existing collection in the specified system.
  • DELETEDEVELOPER - Delete rotating keys for a device/admin/devices/keys/:systemKey/:deviceNameDeletes the rotating keys from its device.
  • GETDEVELOPER - Get devices with or without a query/admin/devices/:systemKey?query=stringRetrieves information about all devices in the specified system
  • PUTDEVELOPER - Update devices using a query/admin/devices/:systemKeyUpdates all devices matching the filters specified by a query.
  • DELETEDEVELOPER - Delete devices using a query/admin/devices/:systemKey?query=stringDeletes all devices matching the filters specified by a query.
  • GETDEVELOPER - Get device/admin/devices/:systemKey/:nameRetrieves information about the specified device.
  • PUTDEVELOPER - Update device/admin/devices/:systemKey/:nameUpdates the specified device's information.
  • POSTDEVELOPER - Create device/admin/devices/:systemKey/:nameCreates a new device in the specified system.
  • DELETEDEVELOPER - Delete device/admin/devices/:systemKey/:nameDeletes the specified device from its system.
  • GETDEVELOPER - Get edge template/admin/edges/template/:systemKeyGet list of which triggers, services, and libraries should be copied onto which edge when it starts up.
  • PUTDEVELOPER - Update edge template/admin/edges/template/:systemKey/:edgeNameUpdate template for the specified edge.
  • GETDEVELOPER - Get edges/admin/edges/:systemKeyRetrieves all the edges that belong to the specified system.
  • GETDEVELOPER - Get edges for the adapter/admin/edges/:systemKey/controlRetrieves all the edges that the adapter belongs to.
  • GETDEVELOPER - Get edge/admin/edges/:systemKey/:edgeNameRetrieves information about the specified edge.
  • PUTDEVELOPER - Update edge/admin/edges/:systemKey/:edgeNameUpdates the specified edge's information.
  • POSTDEVELOPER - Create edge/admin/edges/:systemKey/:edgeNameCreates a new edge in the specified system.
  • DELETEDEVELOPER - Delete edge/admin/edges/:systemKey/:edgeNameDeletes the specified edge from its system.
  • POSTDEVELOPER - Log out dev/admin/logoutLogs the current developer out of their session and invalidates their DevToken
  • POSTDEVELOPER - Disable developer/admin/platform/developerDisables the specified developer on the platform.
  • GETDEVELOPER - Gets the information for a portal/admin/portals/:systemKeyReturns information about a specified portal.
  • PUTDEVELOPER - Change dev password/admin/putpassChanges a developer's password.
  • POSTDEVELOPER - Register new dev/admin/regRegisters a new developer account with the CB platform.
  • PUTDEVELOPER - Regen secret/admin/regensystemsecretGenerates a new System Secret for the specified system.
  • GETDEVELOPER - Get trigger definitions/admin/triggers/definitionsReturns list of trigger definitions. These are the possible actions that can set off a trigger.
  • GETDEVELOPER - Get trigger handlers/admin/triggers/handlers/:systemKeyReturns list of trigger handlers.
  • GETDEVELOPER - Get trigger handler/admin/triggers/handlers/:systemKey/:nameReturns the specified trigger handler information.
  • PUTDEVELOPER - Update trigger handler/admin/triggers/handlers/:systemKey/:nameUpdates the specified trigger handler.
  • POSTDEVELOPER - Create trigger handler/admin/triggers/handlers/:systemKey/:nameCreates a new trigger handler.
  • DELETEDEVELOPER - Delete trigger handler/admin/triggers/handlers/:systemKey/:nameDeletes the specified trigger handler.
  • GETDEVELOPER - Get timer handlers/admin/triggers/timers/:systemKeyReturns a list of timer handlers.
  • GETDEVELOPER - Get timer handler/admin/triggers/timers/:systemKey/:nameReturns the specified timer handler information.
  • PUTDEVELOPER - Update timer handler/admin/triggers/timers/:systemKey/:nameUpdates the specified timer handler.
  • POSTDEVELOPER - Create time handler/admin/triggers/timers/:systemKey/:nameCreates new timer handler.
  • DELETEDEVELOPER - Delete trigger handler/admin/triggers/timers/:systemKey/:nameDeletes the specified trigger handler.
  • GETDEVELOPER - Get list of users and information/admin/user/:systemKey?query=stringReturns list of all of the users in the system
  • PUTDEVELOPER - Change user information and permissions/admin/user/:systemKeyChanges any colomn in users table and update password or permissions of the specified user.
  • POSTDEVELOPER - Add user/admin/user/:systemKeyAdd an user to the system.
  • DELETEDEVELOPER - Delete user/admin/user/:systemKey?user=stringDeletes user from the system
  • GETDEVELOPER - Get users column info./admin/user/:systemKey/columnsReturns data in the user list column
  • POSTDEVELOPER - Add new column/admin/user/:systemKey/columnsAdds a new column to the user collection
  • GETDEVELOPER - Get list of roles/admin/user/:systemKey/roles?query=stringDescription: Get as a list of roles that are available to add to an user Query: {"PAGESIZE":int,"PAGENUM":int,"FILTERS":[[{"EQ":[{"name":"value"}]}]]}…
  • PUTDEVELOPER - Changes roles settings/admin/user/:systemKey/rolesChanges settings in individual roles
  • POSTDEVELOPER - Add new role/admin/user/:systemKey/rolesAdds a new role to the system.
  • DELETEDEVELOPER - Delete roles/admin/user/:systemKey/roles?query=stringDeletes roles from the system
  • GETDEVELOPER - Get number of roles/admin/user/:systemKey/roles/count?user=stringGet number of roles in a system
  • GETDEVELOPER - Get dev info/admin/userinfoReturns all user information about the current developer. This is a developer only endpoint.
  • GETDEVELOPER - Get system info/admin/v/4/systemmanagement?id=stringReturns metadata about specified system.
  • PUTDEVELOPER - Update system info/admin/v/4/systemmanagementUpdates a system's metadata.
  • POSTDEVELOPER - Create system/admin/v/4/systemmanagementCreates a new system tied to the developer's account.
  • DELETEDEVELOPER - Delete system/admin/v/4/systemmanagement?id=stringDeletes the specified system.
  • GETDEVELOPER - Get all failed services/codeadmin/failedReturns list of failed code services for all systems the current developer is authorized to see.
  • GETDEVELOPER - Get system's failed services/codeadmin/failed/:systemKeyReturns list of failed code services for the specified system.
  • POSTDEVELOPER - Retry failed service/codeadmin/failed/:systemKeyRetries one failed service in the specified system.
  • DELETEDEVELOPER - Delete failed service run/codeadmin/failed/:systemKeyDeletes the specified failed service run from the list of failed service runs. Does not delete the service.
  • GETDEVELOPER - Get library history/codeadmin/v/2/history/library/:systemKey/:libNameReturns all previous versions of a library.
  • GETDEVELOPER - Get old library version/codeadmin/v/2/history/library/:systemKey/:libName/:libVersionGets an old version of a library.
  • GETDEVELOPER - Get all libraries/codeadmin/v/2/library/:systemKeyReturns all available libraries in the specified system along with their meta information.
  • GETDEVELOPER - Get library/codeadmin/v/2/library/:systemKey/:libNameReturns the specified library and its meta information.
  • PUTDEVELOPER - Update library/codeadmin/v/2/library/:systemKey/:libNameUpdates local library.
  • POSTDEVELOPER - Create library/codeadmin/v/2/library/:systemKey/:libNameCreates a local library in the specified system.
  • DELETEDEVELOPER - Delete library/codeadmin/v/2/library/:systemKey/:libNameDeletes a local library from the specified system.
  • GETDEVELOPER - Get services logs/codeadmin/v/2/logs/:systemKey/:serviceNameReturns log list for the code service
  • PUTDEVELOPER - Update code service/codeadmin/v/2/:systemKey/:serviceNameUpdates the information and data in the code service.
  • POSTDEVELOPER - Add code service/codeadmin/v/2/:systemKey/:serviceNameAdds code service to the system.
  • DELETEDEVELOPER - Delete code service/codeadmin/v/2/:systemKey/:serviceNameDeletes a local library from the specified system.

Edge

  • GETEDGE - Gets sync status for all edges/admin/:systemKey/sync/alledges/statusReturns sync status for all edges in a system
  • GETEDGE - Gets sync status for an edge/admin/:systemKey/sync/edge/status/:edgeNameReturns sync status for an edge
  • GETEDGE - Fetch all edges/api/v/2/edges/:systemKey?id=stringReturns all edge info that the current user is authorized to see.
  • GETEDGE - Get columns/api/v/3/edges/:systemKey/columnsReturns the columns and their data type for the edge table in a system.
  • GETEDGE - Get count/api/v/3/edges/:systemKey/countReturns the total number of edges in a system.
  • GETEdge(name) - Get edge info/api/v/3/edges/:systemKey/:nameReturns the data from the specified edge.
  • PUTEDGE - Update edge/api/v/3/edges/:systemKey/:nameUpdates the specified edge's information.
  • POSTEDGE - Create edge/api/v/3/edges/:systemKey/:nameCreates a new edge in the specified system.
  • DELETEEdge - Delete edge/api/v/3/edges/:systemKey/:nameDeletes the specified edge from its system.

Handlers

  • GETHANDLERS - Get timer handler/api/v/3/code/:systemKey/timer/:nameReturns the specified timer handler information.
  • PUTHANDLERS - Update timer handler/api/v/3/code/:systemKey/timer/:nameUpdates the specified timer handler.
  • POSTHANDLERS - Create timer handler/api/v/3/code/:systemKey/timer/:nameCreates new timer handler.
  • DELETEHANDLERS - Delete trigger handler/api/v/3/code/:systemKey/timer/:nameDeletes the specified trigger handler.
  • GETHANDLERS - Get timer handlers/api/v/3/code/:systemKey/timersReturns a list of timer handlers.
  • GETHANDLERS - Get trigger handler/api/v/3/code/:systemKey/trigger/:nameReturns the specified trigger handler information.
  • PUTHANDLERS - Update trigger handler/api/v/3/code/:systemKey/trigger/:nameUpdates the specified trigger handler.
  • POSTHANDLERS - Create trigger handler/api/v/3/code/:systemKey/trigger/:nameCreates a new trigger handler.
  • DELETEHANDLERS - Delete trigger handler/api/v/3/code/:systemKey/trigger/:nameDeletes the specified trigger handler.
  • GETHANDLERS - Get trigger handlers/api/v/3/code/:systemKey/triggersReturns list of trigger handlers.

Messaging

  • GETMESSAGING - Get history/api/v/1/message/:systemKey?topic=string&count=string&last=string&start=string&stop=stringReturns the message history for a single topic. Does not honor wildcards.
  • DELETEMESSAGING - Delete history/api/v/1/message/:systemKey?topic=string&count=string&last=string&start=string&stop=stringDeletes the messaging history for a single topic.
  • POSTMESSAGING - Publish message/api/v/1/message/:systemKey/publishPublishes a message to a topic, given the user has permission to publish on that topic.
  • GETMESSAGING - Gets list of topics/api/v/4/message/:systemKey/topics?query=stringDescription: Returns the list of topics. Query Structure: {"PAGESIZE":int,"PAGENUM":int,"FILTERS":[[{"_REPLACE_WITH_OPERATOR_":[{"valueType":"value"}]}]],…
  • GETMESSAGING - Gets number of topics/api/v/4/message/:systemKey/topics/countReturns the number of topics.

Shared Cache

  • GETSHARED CACHE - Gets shared caches for a system/admin/v/4/service_caches/:systemKey
  • PUTSHARED CACHE - Update a shared cache/admin/v/4/service_caches/:systemKey/:cacheNameUpdates a shared cache properties, like ttl & description.
  • POSTSHARED CACHE - Add a shared cache/admin/v/4/service_caches/:systemKey/:cacheNameAdds a shared cache to the system
  • DELETESHARED CACHE - Delete a shared cache/admin/v/4/service_caches/:systemKey/:cacheNameDeletes a shared cache

User

  • GETUSERS - Get all users/api/v/1/user?query=stringReturns all user info that the current user is authorized to see.
  • POSTUSERS - Authenticate anonymous user/api/v/1/user/anonLogs an anonymous user into the specified system and returns an UserToken.
  • POSTUSERS - Authenticate user/api/v/1/user/authDescription Logs user into system and returns an UserToken. Endpoint Body Values Here are the body values for the two scenarios Basic Auth Required Keys…
  • POSTUSERS - Check user auth/api/v/1/user/checkauthChecks if current user's UserToken is valid.
  • GETUSERS - Get user info/api/v/1/user/infoReturns all user information about the current user.
  • PUTUSERS - Update user info/api/v/1/user/infoUpdates some or all of the current user's information.
  • DELETEAllows an user with adequate permissions to delete another user/api/v/1/user/infoThis endpoints provides user the ability to delete another user if the user has Delete User operation permissions in Roles settings.
  • POSTUSERS - Log out user/api/v/1/user/logoutLogs the current user out of the specified system and invalidates their UserToken.
  • PUTUSERS - Change user password/api/v/1/user/passChanges an user's password.
  • POSTUSERS - Register new user/api/v/1/user/regRegisters a new user in the specified system and returns an UserToken for them.
  • PUTUSER - Users change roles and passwords for other users/api/v/4/user/manageUsers can change the roles and passwords for other users in the system

Session

  • GETSESSION - Get device session info/admin/v/4/session/:systemKey/device?query=stringDescription: Returns list of device sessions with Device Key and Timestamps . Query Structure:…
  • DELETESESSION - Delete device session/admin/v/4/session/:systemKey/device?query=stringDescription: Delete device session. Query Structure: {"PAGESIZE":int,"PAGENUM":int,"FILTERS":[[{"_REPLACE_WITH_OPERATOR_":[{"valueType":"value"}]}]],…
  • GETSESSION - Get device session count/admin/v/4/session/:systemKey/device/count?query=stringDescription: Returns number of device sessions. Query Structure:…
  • GETSESSION - Get user session info/admin/v/4/session/:systemKey/user?query=stringDescription: Returns list of user sessions with User ID and Timestamps . Query Structure:…
  • DELETESESSION - Delete user session/admin/v/4/session/:systemKey/user?query=stringDescription: Delete user session. Query Structure: {"PAGESIZE":int,"PAGENUM":int,"FILTERS":[[{"_REPLACE_WITH_OPERATOR_":[{"valueType":"value"}]}]],…
  • GETSESSION - Get user session count/admin/v/4/session/:systemKey/user/count?query=stringDescription: Returns number of user sessions. Query Structure:…

Files

  • GETFILES - Returns a list of metadata for buckets in system/api/v/4/bucket_sets/:systemKeyReturns a list of metadata for buckets in system
  • GETFILES - Returns metadata for specified bucket/api/v/4/bucket_sets/:systemKey/:deploymentNameReturns metadata for specified bucket
  • POSTFILES - Copies a file to a new location within buckets/api/v/4/bucket_sets/:systemKey/:deploymentName/file/copyCopies a file to a new location within buckets
  • POSTFILES - Creates a new file in a bucket/api/v/4/bucket_sets/:systemKey/:deploymentName/file/createCreates a new file in bucket
  • POSTFILES - Deletes a file from the bucket./api/v/4/bucket_sets/:systemKey/:deploymentName/file/deleteDeletes a file from the bucket.
  • GETFILES - Get a file's metadata in a box/api/v/4/bucket_sets/:systemKey/:deploymentName/file/meta?box=string&path=stringDescription: Returns metadata of a specific file in a specific box. boxName defaults to "inbox" Query Structure: box={boxName} path={relativePath} boxName…
  • POSTFILES - Moves a file to a new location within buckets./api/v/4/bucket_sets/:systemKey/:deploymentName/file/moveMoves a file to a new location within buckets.
  • GETFILES - Get all files metadata in a box/api/v/4/bucket_sets/:systemKey/:deploymentName/files?box=stringDescription: Returns metadata of files in a specific box. boxName defaults to "inbox" Query Structure: box={boxName} boxName Options * inbox * outbox *…
  • GETDEVELOPER - Gets the information for the platform/api/aboutReturns information about the platform version.

API details

Base URL
https://platform.clearblade.com
Authentication
None declared in the description
Operations
220 operations on 133 pathsGET 94POST 54PUT 38DELETE 34
Main resources
Developer 73Data 192FA 14Device 12User 11Adapter 10Handlers 10Admin 9Edge 9Files 8
Description format
Swagger 2.0, API version 3.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the ClearBlade API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the ClearBlade API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “ADAPTERS - Get all adapters” (GET /api/v/4/:SystemKey/adapters), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the ClearBlade API?

A friendly little API to help you interact with the ClearBlade platform. It is listed under IoT & devices and has 220 endpoints.

Who publishes the ClearBlade API?

It is listed from Clearblade's public API description (an OpenAPI document), not published by Clearblade on Swastik Codes. Anyone who controls clearblade.com can claim the profile by adding a DNS TXT record.

What is the base URL of the ClearBlade API?

Requests go to https://platform.clearblade.com. Endpoint paths are added to this base URL.

How do I authenticate with the ClearBlade API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the ClearBlade API have?

220 operations on 133 paths (94 GET, 54 POST, 38 PUT, 34 DELETE). The largest groups are Developer, Data, 2FA, Device.

Is forking the ClearBlade API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.