ClearBlade API

POST

/admin/reg

DEVELOPER - Register new dev

GET

/api/about

DEVELOPER - Gets the information for the platform

POST

/admin/auth

DEVELOPER - Authenticate dev

GET

/admin/pkey

ADMIN - Get platform license key.

GET

/admin/audit

AUDIT - Get Audit Info

POST

/admin/logout

DEVELOPER - Log out dev

GET

/api/v/1/user

USERS - Get all users

GET

/admin/allapps

DEVELOPER - Get platform assets

PUT

/admin/putpass

DEVELOPER - Change dev password

GET

/admin/userinfo

DEVELOPER - Get dev info

PUT

/admin/userinfo

2FA - Update developer 2FA information.

POST

/admin/validate

2FA - Send validation link

POST

/admin/checkauth

DEVELOPER - Verifies access to the system

GET

/admin/allsystems

DEVELOPER - Get systems

POST

/api/v/1/user/reg

USERS - Register new user

GET

/codeadmin/failed

DEVELOPER - Get all failed services

GET

/admin/audit/count

Audit - Get counts

POST

/api/v/1/user/anon

USERS - Authenticate anonymous user

POST

/api/v/1/user/auth

USERS - Authenticate user

GET

/api/v/1/user/info

USERS - Get user info

PUT

/api/v/1/user/info

USERS - Update user info

DELETE

/api/v/1/user/info

Allows an user with adequate permissions to delete another user

PUT

/api/v/1/user/pass

USERS - Change user password

GET

/admin/count/systems

ADMIN - Get number of systems available

POST

/admin/resetpassword

ADMIN - Change dev password (Admin)

POST

/api/v/1/user/logout

USERS - Log out user

PUT

/api/v/4/user/manage

USER - Users change roles and passwords for other users

GET

/admin/allcollections

DEVELOPER - Get collections

GET

/admin/database/status

DATABASES - Retrieves all internal and external database statuses

GET

/admin/count/developers

ADMIN - Get number of admin developers

GET

/admin/platform/systems

AUDIT - Get list of systems that have been updated

GET

/admin/user/{systemKey}

DEVELOPER - Get list of users and information

PUT

/admin/user/{systemKey}

DEVELOPER - Change user information and permissions

POST

/admin/user/{systemKey}

DEVELOPER - Add user

DELETE

/admin/user/{systemKey}

DEVELOPER - Delete user

POST

/api/v/1/user/checkauth

USERS - Check user auth

GET

/admin/audit/{systemKey}

AUDIT - Get Audit Info

GET

/admin/edges/{systemKey}

DEVELOPER - Get edges

PUT

/admin/regensystemsecret

DEVELOPER - Regen secret

GET

/admin/settings/security

2FA - View Security Settings

PUT

/admin/settings/security

2FA - Update Security Settings

GET

/admin/platform/developer

ADMIN - Get developer

POST

/admin/platform/developer

DEVELOPER - Disable developer

GET

/admin/systems/{devEmail}

Get Systems for a developer

GET

/admin/devices/{systemKey}

DEVELOPER - Get devices with or without a query

PUT

/admin/devices/{systemKey}

DEVELOPER - Update devices using a query

DELETE

/admin/devices/{systemKey}

DEVELOPER - Delete devices using a query

GET

/admin/platform/developers

ADMIN - Get developers

GET

/admin/portals/{systemKey}

DEVELOPER - Gets the information for a portal

GET

/api/v/2/edges/{systemKey}

EDGE - Fetch all edges

PUT

/admin/collectionmanagement

DEVELOPER - Update collection

POST

/admin/collectionmanagement

DEVELOPER - Create collection

DELETE

/admin/collectionmanagement

DEVELOPER - Delete collection

GET

/admin/platform/{systemKey}

ADMIN - Get system status

GET

/admin/settings/sms-service

2FA - Get SMS Settings

PUT

/admin/settings/sms-service

2FA - Update SMS Settings

POST

/admin/settings/sms-service

2FA - Create SMS Communication

DELETE

/admin/settings/sms-service

2FA - Delete SMS settings

GET

/admin/triggers/definitions

DEVELOPER - Get trigger definitions

GET

/admin/v/4/systemmanagement

DEVELOPER - Get system info

PUT

/admin/v/4/systemmanagement

DEVELOPER - Update system info

POST

/admin/v/4/systemmanagement

DEVELOPER - Create system

DELETE

/admin/v/4/systemmanagement

DEVELOPER - Delete system

GET

/api/v/1/data/{collectionID}

DATA(id) - Get items

PUT

/api/v/1/data/{collectionID}

DATA(id) - Update items

POST

/api/v/1/data/{collectionID}

DATA(id) - Create items

DELETE

/api/v/1/data/{collectionID}

DATA(id) - Delete items

GET

/api/v/1/message/{systemKey}

MESSAGING - Get history

DELETE

/api/v/1/message/{systemKey}

MESSAGING - Delete history

GET

/api/v/2/devices/{SystemKey}

DEVICES - Get all devices

PUT

/api/v/2/devices/{SystemKey}

DEVICES - Update devices using a query

DELETE

/api/v/2/devices/{SystemKey}

DEVICES - Delete devices using a query

PUT

/admin/developers/{systemKey}

ADMIN - Add/Remove/Change owner

GET

/admin/settings/email-service

2FA - Get Email Settings

PUT

/admin/settings/email-service

2FA - Update Email Settings

POST

/admin/settings/email-service

2FA - Create Email Communication

DELETE

/admin/settings/email-service

2FA - Delete email settings

GET

/admin/user/{systemKey}/roles

DEVELOPER - Get list of roles

PUT

/admin/user/{systemKey}/roles

DEVELOPER - Changes roles settings

POST

/admin/user/{systemKey}/roles

DEVELOPER - Add new role

DELETE

/admin/user/{systemKey}/roles

DEVELOPER - Delete roles

POST

/admin/{systemKey}/sync/retry

DEPLOYMENTS - Retries sync for an asset

PUT

/api/v/3/collectionmanagement

DATA - Update collection

POST

/api/v/3/collectionmanagement

DATA - Create collection

DELETE

/api/v/3/collectionmanagement

DATA - Delete collection

GET

/api/v/4/{SystemKey}/adapters

ADAPTERS - Get all adapters

POST

/api/v/4/{SystemKey}/adapters

ADAPTERS - Add an adapter

GET

/codeadmin/failed/{systemKey}

DEVELOPER - Get system's failed services

POST

/codeadmin/failed/{systemKey}

DEVELOPER - Retry failed service

DELETE

/codeadmin/failed/{systemKey}

DEVELOPER - Delete failed service run

GET

/admin/audit/{systemKey}/count

AUDIT - Get counts

GET

/admin/v/4/webhook/{systemKey}

WEBHOOKS - Returns webhooks in the system

GET

/admin/user/{systemKey}/columns

DEVELOPER - Get users column info.

POST

/admin/user/{systemKey}/columns

DEVELOPER - Add new column

GET

/admin/edges/{systemKey}/control

DEVELOPER - Get edges for the adapter

POST

/admin/settings/sms-service/test

2FA - Test SMS Service

GET

/api/v/3/code/{systemKey}/timers

HANDLERS - Get timer handlers

GET

/api/v/3/edges/{systemKey}/count

EDGE - Get count

GET

/api/v/3/{systemKey}/deployments

DEPLOYMENTS - Gets all deployment names and descriptions for a system

POST

/api/v/3/{systemKey}/deployments

DEPLOYMENTS - Creates a deployment

GET

/api/v/4/bucket_sets/{systemKey}

FILES - Returns a list of metadata for buckets in system

GET

/api/v/4/external-db/{systemKey}

DATABASES - Retrieves all external database connections

POST

/api/v/4/external-db/{systemKey}

DATABASES - Create a external database connection

GET

/api/v/4/{systemKey}/code/failed

CODE - Get all failed services using Query

GET

/admin/devices/{systemKey}/{name}

DEVELOPER - Get device

PUT

/admin/devices/{systemKey}/{name}

DEVELOPER - Update device

POST

/admin/devices/{systemKey}/{name}

DEVELOPER - Create device

DELETE

/admin/devices/{systemKey}/{name}

DEVELOPER - Delete device

GET

/admin/edges/template/{systemKey}

DEVELOPER - Get edge template

POST

/api/v/2/devices/{SystemKey}/auth

DEVICES - Authenticate device

GET

/api/v/3/edges/{systemKey}/{name}

Edge(name) - Get edge info

PUT

/api/v/3/edges/{systemKey}/{name}

EDGE - Update edge

POST

/api/v/3/edges/{systemKey}/{name}

EDGE - Create edge

DELETE

/api/v/3/edges/{systemKey}/{name}

Edge - Delete edge

POST

/admin/settings/email-service/test

2FA - Test Email Service

GET

/admin/triggers/timers/{systemKey}

DEVELOPER - Get timer handlers

GET

/api/v/3/code/codemeta/{systemKey}

CODE - Returns code services and settings

GET

/api/v/3/code/{systemKey}/triggers

HANDLERS - Get trigger handlers

GET

/api/v/3/devices/{systemKey}/count

DEVICES - Get count

GET

/api/v/3/edges/{systemKey}/columns

EDGE - Get columns

GET

/codeadmin/v/2/library/{systemKey}

DEVELOPER - Get all libraries

GET

/admin/edges/{systemKey}/{edgeName}

DEVELOPER - Get edge

PUT

/admin/edges/{systemKey}/{edgeName}

DEVELOPER - Update edge

POST

/admin/edges/{systemKey}/{edgeName}

DEVELOPER - Create edge

DELETE

/admin/edges/{systemKey}/{edgeName}

DEVELOPER - Delete edge

GET

/admin/platform/systems/{systemKey}

AUDIT - Get list of systems that have been updated

GET

/admin/user/{systemKey}/roles/count

DEVELOPER - Get number of roles

GET

/admin/v/4/session/{systemKey}/user

SESSION - Get user session info

DELETE

/admin/v/4/session/{systemKey}/user

SESSION - Delete user session

PUT

/api/v/2/devices/{systemKey}/{name}

DEVICES - Update info

POST

/api/v/2/devices/{systemKey}/{name}

DEVICES - Adds a device

GET

/api/v/3/allcollections/{systemKey}

DATA - Get collections

GET

/api/v/4/message/{systemKey}/topics

MESSAGING - Gets list of topics

GET

/admin/triggers/handlers/{systemKey}

DEVELOPER - Get trigger handlers

GET

/api/v/1/data/{collectionID}/columns

DATA(id) - Get columns

POST

/api/v/1/message/{systemKey}/publish

MESSAGING - Publish message

GET

/api/v/3/devices/{systemKey}/columns

EDGE - Get device columns

GET

/admin/v/4/service_caches/{systemKey}

SHARED CACHE - Gets shared caches for a system

GET

/admin/v/4/session/{systemKey}/device

SESSION - Get device session info

DELETE

/admin/v/4/session/{systemKey}/device

SESSION - Delete device session

PUT

/admin/v/4/webhook/{systemKey}/{name}

WEBHOOKS - Update a webhook

POST

/admin/v/4/webhook/{systemKey}/{name}

WEBHOOKS - Creates a webhook

DELETE

/admin/v/4/webhook/{systemKey}/{name}

WEBHOOKS - Delete a webhook

GET

/api/v/3/code/{systemKey}/timer/{name}

HANDLERS - Get timer handler

PUT

/api/v/3/code/{systemKey}/timer/{name}

HANDLERS - Update timer handler

POST

/api/v/3/code/{systemKey}/timer/{name}

HANDLERS - Create timer handler

DELETE

/api/v/3/code/{systemKey}/timer/{name}

HANDLERS - Delete trigger handler

GET

/admin/{systemKey}/sync/alledges/status

EDGE - Gets sync status for all edges

GET

/api/v/1/code/{systemKey}/{serviceName}

CODE - Retrieve information about service

POST

/api/v/1/code/{systemKey}/{serviceName}

CODE - Call/Execute code service

GET

/api/v/4/external-db/{systemKey}/{name}

DATABASES - Retrieve a specific external database connection

PUT

/api/v/4/external-db/{systemKey}/{name}

DATABASES - Update external database credentials

DELETE

/api/v/4/external-db/{systemKey}/{name}

DATABASES - Delete a external database connection

GET

/api/v/3/code/{systemKey}/trigger/{name}

HANDLERS - Get trigger handler

PUT

/api/v/3/code/{systemKey}/trigger/{name}

HANDLERS - Update trigger handler

POST

/api/v/3/code/{systemKey}/trigger/{name}

HANDLERS - Create trigger handler

DELETE

/api/v/3/code/{systemKey}/trigger/{name}

HANDLERS - Delete trigger handler

GET

/api/v/4/devices/{systemKey}/connections

DEVICES - Get connected device list

PUT

/codeadmin/v/2/{systemKey}/{serviceName}

DEVELOPER - Update code service

POST

/codeadmin/v/2/{systemKey}/{serviceName}

DEVELOPER - Add code service

DELETE

/codeadmin/v/2/{systemKey}/{serviceName}

DEVELOPER - Delete code service

GET

/admin/triggers/timers/{systemKey}/{name}

DEVELOPER - Get timer handler

PUT

/admin/triggers/timers/{systemKey}/{name}

DEVELOPER - Update timer handler

POST

/admin/triggers/timers/{systemKey}/{name}

DEVELOPER - Create time handler

DELETE

/admin/triggers/timers/{systemKey}/{name}

DEVELOPER - Delete trigger handler

GET

/admin/v/4/session/{systemKey}/user/count

SESSION - Get user session count

GET

/api/v/4/message/{systemKey}/topics/count

MESSAGING - Gets number of topics

GET

/admin/triggers/handlers/{systemKey}/{name}

DEVELOPER - Get trigger handler

PUT

/admin/triggers/handlers/{systemKey}/{name}

DEVELOPER - Update trigger handler

POST

/admin/triggers/handlers/{systemKey}/{name}

DEVELOPER - Create trigger handler

DELETE

/admin/triggers/handlers/{systemKey}/{name}

DEVELOPER - Delete trigger handler

GET

/admin/v/4/session/{systemKey}/device/count

SESSION - Get device session count

PUT

/api/v/4/{SystemKey}/adapters/{AdapterName}

ADAPTERS - Map Adapter command to execute a file

DELETE

/api/v/4/{SystemKey}/adapters/{AdapterName}

ADAPTERS - Delete adapter

POST

/admin/devices/keys/{systemKey}/{deviceName}

DEVICE -Creates rotating keys for a device.

DELETE

/admin/devices/keys/{systemKey}/{deviceName}

DEVELOPER - Delete rotating keys for a device

PUT

/admin/edges/template/{systemKey}/{edgeName}

DEVELOPER - Update edge template

GET

/api/v/4/devices/{systemKey}/connectioncount

DEVICES - Get total of connected devices

POST

/api/v/4/external-db/{systemKey}/{name}/data

DATABASES - Create a external database connection

GET

/codeadmin/v/2/library/{systemKey}/{libName}

DEVELOPER - Get library

PUT

/codeadmin/v/2/library/{systemKey}/{libName}

DEVELOPER - Update library

POST

/codeadmin/v/2/library/{systemKey}/{libName}

DEVELOPER - Create library

DELETE

/codeadmin/v/2/library/{systemKey}/{libName}

DEVELOPER - Delete library

GET

/codeadmin/v/2/logs/{systemKey}/{serviceName}

DEVELOPER - Get services logs

GET

/admin/{systemKey}/sync/edge/status/{edgeName}

EDGE - Gets sync status for an edge

GET

/api/v/4/devices/{systemKey}/connections/{name}

DEVICES - Get information for a connected device

GET

/api/v/1/collection/{systemKey}/{collectionName}

DATA(name) - Get items

PUT

/api/v/1/collection/{systemKey}/{collectionName}

DATA(name) - Update items

POST

/api/v/1/collection/{systemKey}/{collectionName}

DATA(name) - Create items

DELETE

/api/v/1/collection/{systemKey}/{collectionName}

DATA(name) - Delete items

POST

/api/v/4/data/{systemKey}/{collectionName}/index

DATA - Create collection

DELETE

/api/v/4/data/{systemKey}/{collectionName}/index

DATA - Delete collection

PUT

/admin/v/4/service_caches/{systemKey}/{cacheName}

SHARED CACHE - Update a shared cache

POST

/admin/v/4/service_caches/{systemKey}/{cacheName}

SHARED CACHE - Add a shared cache

DELETE

/admin/v/4/service_caches/{systemKey}/{cacheName}

SHARED CACHE - Delete a shared cache

GET

/api/v/3/{systemKey}/deployments/{deploymentName}

DEPLOYMENTS - Gets a deloyment for a system

PUT

/api/v/3/{systemKey}/deployments/{deploymentName}

DEPLOYMENT - Update deployment

DELETE

/api/v/3/{systemKey}/deployments/{deploymentName}

DEPLOYMENT - Delete a deployment

GET

/api/v/4/bucket_sets/{systemKey}/{deploymentName}

FILES - Returns metadata for specified bucket

PUT

/api/v/4/data/{systemKey}/{collectionName}/upsert

DATA - Update upsert values

GET

/api/v/4/{SystemKey}/adapters/{AdapterName}/files

Gets list of configuration information for all adapter files

POST

/api/v/4/{SystemKey}/adapters/{AdapterName}/files

ADAPTERS - Add or replace file content & configuration

GET

/api/v/4/webhook/execute/{systemKey}/{webhookName}

WEBHOOKS - Executes query string payload webhook

POST

/api/v/4/webhook/execute/{systemKey}/{webhookName}

WEBHOOKS - Executing a webhook

PUT

/api/v/4/{SystemKey}/adapters/{AdapterName}/control

ADAPTERS - Send command to edge

GET

/codeadmin/v/2/history/library/{systemKey}/{libName}

DEVELOPER - Get library history

GET

/api/v/4/data/{systemKey}/{collectionName}/listindexes

DATA - Get list of indexes

POST

/api/v/4/data/{systemKey}/{collectionName}/uniqueindex

DATA - Create Unique Index

DELETE

/api/v/4/data/{systemKey}/{collectionName}/uniqueindex

DATA - Delete unique index

GET

/api/v/4/bucket_sets/{systemKey}/{deploymentName}/files

FILES - Get all files metadata in a box

GET

/admin/{systemKey}/sync/deployment/status/{deploymentName}

DEPLOYMENTS - Gets sync status for a deployment

POST

/api/v/4/bucket_sets/{systemKey}/{deploymentName}/file/copy

FILES - Copies a file to a new location within buckets

GET

/api/v/4/bucket_sets/{systemKey}/{deploymentName}/file/meta

FILES - Get a file's metadata in a box

POST

/api/v/4/bucket_sets/{systemKey}/{deploymentName}/file/move

FILES - Moves a file to a new location within buckets.

GET

/api/v/4/{SystemKey}/adapters/{AdapterName}/files/{fileName}

ADAPTERS - Download file from adapter

PUT

/api/v/4/{SystemKey}/adapters/{AdapterName}/files/{fileName}

ADAPTERS - Update Existing File's content

DELETE

/api/v/4/{SystemKey}/adapters/{AdapterName}/files/{fileName}

ADAPTERS - Delete adapter files

POST

/api/v/4/bucket_sets/{systemKey}/{deploymentName}/file/create

FILES - Creates a new file in a bucket

POST

/api/v/4/bucket_sets/{systemKey}/{deploymentName}/file/delete

FILES - Deletes a file from the bucket.

GET

/codeadmin/v/2/history/library/{systemKey}/{libName}/{libVersion}

DEVELOPER - Get old library version

Endpoints

ClearBlade API

Endpoints

ClearBlade API

Endpoints

ClearBlade API

Endpoints