# ClearBlade API API

> ClearBlade API API on Apizie: 220 endpoints (DEVELOPER - Get platform assets, DEVELOPER - Get collections, DEVELOPER - Get systems, AUDIT - Get Audit Info, …) returned as clean JSON through one API key. 220 endpoints are live now. Call it over REST at https://apizie.tech/v1/iot:clearblade/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `iot:clearblade`
- Category: IoT
- Status: live
- Source: https://clearblade.com
- Page: https://apizie.tech/api/iot/clearblade
- OpenAPI: https://apizie.tech/api/iot/clearblade/openapi.json

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

## Endpoints

### DEVELOPER - Get platform assets
`GET https://apizie.tech/v1/iot:clearblade/dev-get-assets`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |

### DEVELOPER - Get collections
`GET https://apizie.tech/v1/iot:clearblade/dev-get-collections`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| appid | string | yes | System Key that identifies the system the collections belong to. |

### DEVELOPER - Get systems
`GET https://apizie.tech/v1/iot:clearblade/get-systems`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |

### AUDIT - Get Audit Info
`GET https://apizie.tech/v1/iot:clearblade/get-audit`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| query | string | no | Query object used to filter the items. See query model at in the description for example. |

### Audit - Get counts
`GET https://apizie.tech/v1/iot:clearblade/get-counts`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |

### AUDIT - Get Audit Info
`GET https://apizie.tech/v1/iot:clearblade/get-audit-dev`

| Parameter | Type | Required | Description |
|---|---|---|---|
| systemKey | string | yes | System Key that identifies the system that holds the deployment. |
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| query | string | no | Query object used to filter the items. See query model at in the description for example. |

### AUDIT - Get counts
`GET https://apizie.tech/v1/iot:clearblade/get-counts-dev`

| Parameter | Type | Required | Description |
|---|---|---|---|
| systemKey | string | yes | System Key that identifies the system that holds the deployment. |
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |

### DEVELOPER - Authenticate dev
`POST https://apizie.tech/v1/iot:clearblade/auth-dev`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### DEVELOPER - Verifies access to the system
`POST https://apizie.tech/v1/iot:clearblade/verify-auth`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |

### DEVELOPER - Create collection
`POST https://apizie.tech/v1/iot:clearblade/dev-create-collection`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through authentication. |
| body | object | yes | JSON request body |

### DEVELOPER - Update collection
`POST https://apizie.tech/v1/iot:clearblade/dev-update-collection`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | no | Developer Token obtained through admin authentication. |
| body | object | no | JSON request body |

### DEVELOPER - Delete collection
`POST https://apizie.tech/v1/iot:clearblade/dev-delete-collection`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| id | string | yes | ID that identifies the collection to be deleted. |

### ADMIN - Get number of admin developers
`GET https://apizie.tech/v1/iot:clearblade/get-admin-dev-count`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |

### ADMIN - Get number of systems available
`GET https://apizie.tech/v1/iot:clearblade/get-system-count`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |

### DATABASES - Retrieves all internal and external database statuses
`GET https://apizie.tech/v1/iot:clearblade/get-database-status`

### ADMIN - Add/Remove/Change owner
`POST https://apizie.tech/v1/iot:clearblade/admin-owner-change`

| Parameter | Type | Required | Description |
|---|---|---|---|
| systemKey | string | yes | System Key that identifies the system that holds the deployment. |
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| body | object | no | JSON request body |

### DEVICE -Creates rotating keys for a device.
`POST https://apizie.tech/v1/iot:clearblade/create-rotating-keys`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through developer authentication. |
| systemKey | string | yes | System key that identifies the system the device you're updating belongs to. |
| deviceName | string | yes | Name of the device you are adding keys to . |
| body | object | yes | JSON request body |

### DEVELOPER - Delete rotating keys for a device
`POST https://apizie.tech/v1/iot:clearblade/delete-device-keys`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through developer authentication. |
| systemKey | string | yes | System key that identifies the system the device currently belongs to. |
| deviceName | string | yes | Name of the device whose keys are being deleted. |

### DEVELOPER - Get devices with or without a query
`GET https://apizie.tech/v1/iot:clearblade/get-system-devices`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System key that identifies the system the devices in question belong to. |
| query | string | no | Tags to filter devices by. See the query model below for an example. All devices are returned if a query is not specified. |

### DEVELOPER - Update devices using a query
`POST https://apizie.tech/v1/iot:clearblade/update-devices-admin`

| Parameter | Type | Required | Description |
|---|---|---|---|
| systemKey | string | yes | System Key that identifies the system the device is a part of. |
| ClearBlade-DevToken | string | yes | Token obtained through user authentication. |
| body | object | yes | JSON request body |

### DEVELOPER - Delete devices using a query
`POST https://apizie.tech/v1/iot:clearblade/delete-devices-admin`

| Parameter | Type | Required | Description |
|---|---|---|---|
| systemKey | string | yes | System Key that identifies the system the device is a part of. |
| ClearBlade-DevToken | string | yes | Token obtained through user authentication. |
| query | string | yes | Tags to filter devices by. See the query model below for an example. |

### DEVELOPER - Get device
`GET https://apizie.tech/v1/iot:clearblade/get-system-device`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System key that identifies the system the device in question belongs to. |
| name | string | yes | Name of the device you're getting info about. |

### DEVELOPER - Create device
`POST https://apizie.tech/v1/iot:clearblade/create-system-device`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System key that identifies the system the new device will belong to. |
| name | string | yes | Name of the device you're creating. |
| body | object | yes | JSON request body |

### DEVELOPER - Update device
`POST https://apizie.tech/v1/iot:clearblade/update-system-device`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System key that identifies the system the device you're updating belongs to. |
| name | string | yes | Name of the device you're updating. |
| body | object | yes | JSON request body |

### DEVELOPER - Delete device
`POST https://apizie.tech/v1/iot:clearblade/delete-system-device`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System key that identifies the system the device currently belongs to. |
| name | string | yes | Name of the device you're deleting. |

### DEVELOPER - Get edge template
`GET https://apizie.tech/v1/iot:clearblade/get-edge-template`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System key that identifies the system the edge template belongs to. |

### DEVELOPER - Update edge template
`POST https://apizie.tech/v1/iot:clearblade/update-edge-template`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System key that identifies the system the edge template belongs to. |
| edgeName | string | yes | Name of the edge you're modifying the template for. |
| body | object | yes | JSON request body |

### DEVELOPER - Get edges
`GET https://apizie.tech/v1/iot:clearblade/get-edges`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System key that identifies the system the edges in question belong to. |

### DEVELOPER - Get edges for the adapter
`GET https://apizie.tech/v1/iot:clearblade/get-adapter-edges`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System key that identifies the system the edges in question belong to. |

### DEVELOPER - Get edge
`GET https://apizie.tech/v1/iot:clearblade/get-edge`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System key that identifies the system the edge in question belongs to. |
| edgeName | string | yes | Name of the edge you're getting info about. |

### DEVELOPER - Create edge
`POST https://apizie.tech/v1/iot:clearblade/create-edge`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System key that identifies the system the new edge will belong to. |
| edgeName | string | yes | Name of the edge you're creating. |
| body | object | yes | JSON request body |

### DEVELOPER - Update edge
`POST https://apizie.tech/v1/iot:clearblade/update-edge`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System key that identifies the system the edge you're updating belongs to. |
| edgeName | string | yes | Name of the edge you're updating. |
| body | object | yes | JSON request body |

### DEVELOPER - Delete edge
`POST https://apizie.tech/v1/iot:clearblade/delete-edge`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System key that identifies the system the edge currently belongs to. |
| edgeName | string | yes | Name of the edge you're deleting. |

### DEVELOPER - Log out dev
`POST https://apizie.tech/v1/iot:clearblade/dev-logout`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |

### ADMIN - Get platform license key.
`GET https://apizie.tech/v1/iot:clearblade/get-license-key`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |

### ADMIN - Get developer
`GET https://apizie.tech/v1/iot:clearblade/get-dev`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| developer | string | yes | Email of the developer in question. |

### DEVELOPER - Disable developer
`POST https://apizie.tech/v1/iot:clearblade/disable-dev`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| body | object | yes | JSON request body |

### ADMIN - Get developers
`GET https://apizie.tech/v1/iot:clearblade/get-devs`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| pagesize | string | no | Response page size. |
| pagenum | string | no | Response page number. |
| total | string | no |  |
| filter | string | no | Filter response. |

### AUDIT - Get list of systems that have been updated
`GET https://apizie.tech/v1/iot:clearblade/get-system-updates`

| Parameter | Type | Required | Description |
|---|---|---|---|
| Clearblade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| query | string | no | Query object used to filter the items. See query model at in the description for example. |

### AUDIT - Get list of systems that have been updated
`GET https://apizie.tech/v1/iot:clearblade/get-system-updates-dev`

| Parameter | Type | Required | Description |
|---|---|---|---|
| systemKey | string | yes | System Key that identifies the system that holds the deployment. |
| clearblade-devtoken | string | yes | Developer Token obtained through admin authentication. |
| query | string | no | Query object used to filter the items. See query model at in the description for example. |

### ADMIN - Get system status
`GET https://apizie.tech/v1/iot:clearblade/get-system-status`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System Key that identifies the system you're requesting information about. |

### DEVELOPER - Gets the information for a portal
`GET https://apizie.tech/v1/iot:clearblade/get-portal-info`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through developer authentication. |
| systemKey | string | yes | System Key that identifies the specified system. |

### DEVELOPER - Change dev password
`POST https://apizie.tech/v1/iot:clearblade/change-dev-password`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| body | object | yes | JSON request body |

### DEVELOPER - Register new dev
`POST https://apizie.tech/v1/iot:clearblade/reg-dev`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### DEVELOPER - Regen secret
`POST https://apizie.tech/v1/iot:clearblade/regen-secret`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| body | object | yes | JSON request body |

### ADMIN - Change dev password (Admin)
`POST https://apizie.tech/v1/iot:clearblade/reset-password`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| body | object | yes | JSON request body |

### 2FA - Get Email Settings
`GET https://apizie.tech/v1/iot:clearblade/email-settings`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |

### 2FA - Create Email Communication
`POST https://apizie.tech/v1/iot:clearblade/create-email-communication`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| body | object | yes | JSON request body |

### 2FA - Update Email Settings
`POST https://apizie.tech/v1/iot:clearblade/update-email-settings`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| body | object | yes | JSON request body |

### 2FA - Delete email settings
`POST https://apizie.tech/v1/iot:clearblade/delete-email-settings`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |

### 2FA - Test Email Service
`POST https://apizie.tech/v1/iot:clearblade/test-email`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| body | object | yes | JSON request body |

### 2FA - View Security Settings
`GET https://apizie.tech/v1/iot:clearblade/view-security`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |

### 2FA - Update Security Settings
`POST https://apizie.tech/v1/iot:clearblade/update-security`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| body | object | yes | JSON request body |

### 2FA - Get SMS Settings
`GET https://apizie.tech/v1/iot:clearblade/smssettings`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |

### 2FA - Create SMS Communication
`POST https://apizie.tech/v1/iot:clearblade/create-smscommunication`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| body | object | yes | JSON request body |

### 2FA - Update SMS Settings
`POST https://apizie.tech/v1/iot:clearblade/update-smssettings`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| body | object | yes | JSON request body |

### 2FA - Delete SMS settings
`POST https://apizie.tech/v1/iot:clearblade/delete-smssettings`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |

### 2FA - Test SMS Service
`POST https://apizie.tech/v1/iot:clearblade/test-sms`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| body | object | yes | JSON request body |

### Get Systems for a developer
`GET https://apizie.tech/v1/iot:clearblade/get-systems-for-dev`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| devEmail | string | yes | Email of the Developer. Should be in the format `name@orgname.com` |

### DEVELOPER - Get trigger definitions
`GET https://apizie.tech/v1/iot:clearblade/get-triggers`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |

### DEVELOPER - Get trigger handlers
`GET https://apizie.tech/v1/iot:clearblade/get-trigger-handlers`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System Key that identifies the system the handlers are in. |

### DEVELOPER - Get trigger handler
`GET https://apizie.tech/v1/iot:clearblade/get-trigger-handler`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System Key that identifies the system the handler is in. |
| name | string | yes | Name of the trigger handler you want. |

### DEVELOPER - Create trigger handler
`POST https://apizie.tech/v1/iot:clearblade/create-trigger`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System Key that identifies the system the handler is in. |
| name | string | yes | Name of the trigger handler you're creating. |
| body | object | yes | JSON request body |

### DEVELOPER - Update trigger handler
`POST https://apizie.tech/v1/iot:clearblade/update-trigger-handler`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System Key that identifies the system the handler is in. |
| name | string | yes | Name of the trigger handler you're updating. |
| body | object | yes | JSON request body |

### DEVELOPER - Delete trigger handler
`POST https://apizie.tech/v1/iot:clearblade/delete-trigger-handler`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System Key that identifies the system the handler is in. |
| name | string | yes | Name of the trigger handler you're deleting. |

### DEVELOPER - Get timer handlers
`GET https://apizie.tech/v1/iot:clearblade/get-timer-handlers`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System Key that identifies the system the handler is in. |

### DEVELOPER - Get timer handler
`GET https://apizie.tech/v1/iot:clearblade/get-timer-handler`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System Key that identifies the system the handler is in. |
| name | string | yes | Name of the timer handler you want. |

### DEVELOPER - Create time handler
`POST https://apizie.tech/v1/iot:clearblade/create-timer-handler`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System Key that identifies the system the handler is in. |
| name | string | yes | Name of the timer handler you're creating. |
| body | object | yes | JSON request body |

### DEVELOPER - Update timer handler
`POST https://apizie.tech/v1/iot:clearblade/update-timer-handler`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System Key that identifies the system the handler is in. |
| name | string | yes | Name of the timer handler you're updating. |
| body | object | yes | JSON request body |

### DEVELOPER - Delete trigger handler
`POST https://apizie.tech/v1/iot:clearblade/delete-timer-handler`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System Key that identifies the system the handler is in. |
| name | string | yes | Name of the timer you're deleting. |

### DEVELOPER - Get list of users and information
`GET https://apizie.tech/v1/iot:clearblade/get-user-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| systemKey | string | yes | System Key that identifies the system the user is a part of. |
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| query | string | no | Tags to filter users. Check 'users' model at the bottom of this page. |

### DEVELOPER - Add user
`POST https://apizie.tech/v1/iot:clearblade/add-user`

| Parameter | Type | Required | Description |
|---|---|---|---|
| systemKey | string | yes | System Key that identifies the system the user is a part of. |
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| body | object | yes | JSON request body |

### DEVELOPER - Change user information and permissions
`POST https://apizie.tech/v1/iot:clearblade/user-change-user-info`

| Parameter | Type | Required | Description |
|---|---|---|---|
| systemKey | string | yes | System Key that identifies the system the user is a part of. |
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| body | object | yes | JSON request body |

### DEVELOPER - Delete user
`POST https://apizie.tech/v1/iot:clearblade/delete-user`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System Key that identifies the system the handler is in. |
| user | string | no | UserId of the user to delete |

### DEVELOPER - Get users column info.
`GET https://apizie.tech/v1/iot:clearblade/get-user-column-data`

| Parameter | Type | Required | Description |
|---|---|---|---|
| systemKey | string | yes | System Key that identifies the system the user is a part of. |
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |

### DEVELOPER - Add new column
`POST https://apizie.tech/v1/iot:clearblade/add-column`

| Parameter | Type | Required | Description |
|---|---|---|---|
| systemKey | string | yes | System Key that identifies the system the user is a part of. |
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| body | object | yes | JSON request body |

### DEVELOPER - Get list of roles
`GET https://apizie.tech/v1/iot:clearblade/get-roles`

| Parameter | Type | Required | Description |
|---|---|---|---|
| systemKey | string | yes | System Key that identifies the system the user is a part of. |
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| query | string | no | Refer to the example query above. |

### DEVELOPER - Add new role
`POST https://apizie.tech/v1/iot:clearblade/add-role`

| Parameter | Type | Required | Description |
|---|---|---|---|
| systemKey | string | yes | System Key that identifies the system the user is a part of. |
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| body | object | no | JSON request body |

### DEVELOPER - Changes roles settings
`POST https://apizie.tech/v1/iot:clearblade/settings-changes`

| Parameter | Type | Required | Description |
|---|---|---|---|
| systemKey | string | yes | System Key that identifies the system the user is a part of. |
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| body | object | yes | JSON request body |

### DEVELOPER - Delete roles
`POST https://apizie.tech/v1/iot:clearblade/delete-roles`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| systemKey | string | yes | System Key that identifies the system the handler is in. |
| query | string | yes | Role identification key. |

### DEVELOPER - Get number of roles
`GET https://apizie.tech/v1/iot:clearblade/get-roles-count`

| Parameter | Type | Required | Description |
|---|---|---|---|
| systemKey | string | yes | System Key that identifies the system the user is a part of. |
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| user | string | yes | Identifies page size and page number for roles list. |

### DEVELOPER - Get dev info
`GET https://apizie.tech/v1/iot:clearblade/get-dev-info`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |

### 2FA - Update developer 2FA information.
`POST https://apizie.tech/v1/iot:clearblade/update-dev2-fa`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| body | object | yes | JSON request body |

### SHARED CACHE - Gets shared caches for a system
`GET https://apizie.tech/v1/iot:clearblade/get-shared-cache`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Dev Token obtained through user authentication. |
| systemKey | string | yes | System Key that identifies the system that holds the deployment. |

### SHARED CACHE - Add a shared cache
`POST https://apizie.tech/v1/iot:clearblade/add-shared-cache`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Dev Token obtained through user authentication. |
| systemKey | string | yes | System Key that identifies the system that holds the shared cache. |
| cacheName | string | yes | Name of the shared cache to add |
| body | object | yes | JSON request body |

### SHARED CACHE - Update a shared cache
`POST https://apizie.tech/v1/iot:clearblade/update-shared-cache`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Dev Token obtained through user authentication. |
| systemKey | string | yes | System Key that identifies the system that holds the shared cache. |
| cacheName | string | yes | Name of the shared cache to update |
| body | object | yes | JSON request body |

### SHARED CACHE - Delete a shared cache
`POST https://apizie.tech/v1/iot:clearblade/delete-shared-cache`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Dev Token obtained through user authentication. |
| systemKey | string | yes | System Key that identifies the system that holds the deployment. |
| cacheName | string | yes | Name of the shared cache to delete |

### SESSION - Get device session info
`GET https://apizie.tech/v1/iot:clearblade/get-device-session`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| query | string | no | Query object used to filter the items. See query model at in the description for example. |
| systemKey | string | yes | System Key that identifies the system. |

### SESSION - Delete device session
`POST https://apizie.tech/v1/iot:clearblade/delete-device-session`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| query | string | no | Query object used to filter the items. See query model at in the description for example. |
| systemKey | string | yes | System Key that identifies the system. |

### SESSION - Get device session count
`GET https://apizie.tech/v1/iot:clearblade/get-device-session-count`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| query | string | no | Query object used to filter the items. See query model at in the description for example. |
| systemKey | string | yes | System Key that identifies the system. |

### SESSION - Get user session info
`GET https://apizie.tech/v1/iot:clearblade/get-user-session`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| query | string | no | Query object used to filter the items. See query model at in the description for example. |
| systemKey | string | yes | System Key that identifies the system. |

### SESSION - Delete user session
`POST https://apizie.tech/v1/iot:clearblade/delete-user-session`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| query | string | no | Query object used to filter the items. See query model at in the description for example. |
| systemKey | string | yes | System Key that identifies the system. |

### SESSION - Get user session count
`GET https://apizie.tech/v1/iot:clearblade/get-user-session-count`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| query | string | no | Query object used to filter the items. See query model at in the description for example. |
| systemKey | string | yes | System Key that identifies the system. |

### DEVELOPER - Get system info
`GET https://apizie.tech/v1/iot:clearblade/get-system-info`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| id | string | yes | System Key that identifies the system you want the info about. |

### DEVELOPER - Create system
`POST https://apizie.tech/v1/iot:clearblade/create-system`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through developer authentication. |
| body | object | yes | JSON request body |

### DEVELOPER - Update system info
`POST https://apizie.tech/v1/iot:clearblade/update-system`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| body | object | yes | JSON request body |

### DEVELOPER - Delete system
`POST https://apizie.tech/v1/iot:clearblade/delete-system`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| id | string | yes | System Key that identifies the system you want to delete. |

### WEBHOOKS - Returns webhooks in the system
`GET https://apizie.tech/v1/iot:clearblade/get-webhooks`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Dev Token obtained through authentication. |
| systemKey | string | yes | System Key that identifies the system the messages belong to. |

### WEBHOOKS - Creates a webhook
`POST https://apizie.tech/v1/iot:clearblade/create-webhook`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Dev Token obtained through authentication. |
| systemKey | string | yes | System Key that identifies the system the messages belong to. |
| name | string | yes | Name that identifies the webhook |
| body | object | yes | JSON request body |

### WEBHOOKS - Update a webhook
`POST https://apizie.tech/v1/iot:clearblade/update-webhook`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Dev Token obtained through authentication. |
| systemKey | string | yes | System Key that identifies the system the messages belong to. |
| name | string | yes | Name that identifies the webhook |
| body | object | no | JSON request body |

### WEBHOOKS - Delete a webhook
`POST https://apizie.tech/v1/iot:clearblade/delete-webhook`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Dev Token obtained through authentication. |
| systemKey | string | yes | System Key that identifies the system the messages belong to. |
| name | string | yes | Name that identifies the webhook |

### 2FA - Send validation link
`POST https://apizie.tech/v1/iot:clearblade/send-validation`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Developer Token obtained through admin authentication. |
| body | object | yes | JSON request body |

### EDGE - Gets sync status for all edges
`GET https://apizie.tech/v1/iot:clearblade/all-edge-sync-status`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Token obtained through dev authentication. |
| systemKey | string | yes | System Key that identifies the system that holds the edges. |

### DEPLOYMENTS - Gets sync status for a deployment
`GET https://apizie.tech/v1/iot:clearblade/get-sync-status`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Dev Token obtained through user authentication. |
| systemKey | string | yes | System Key that identifies the system that holds the deployment. |
| deploymentName | string | yes | Name of the deployment to retrieve |

### EDGE - Gets sync status for an edge
`GET https://apizie.tech/v1/iot:clearblade/edge-sync-status`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Token obtained through dev authentication. |
| systemKey | string | yes | System Key that identifies the system that holds the edges. |
| edgeName | string | yes | Name of the edge |

### DEPLOYMENTS - Retries sync for an asset
`POST https://apizie.tech/v1/iot:clearblade/retry-sync`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Dev Token obtained through dev authentication. |
| systemKey | string | yes | System Key that identifies the system that holds the deployment. |
| body | object | yes | JSON request body |

### DEVELOPER - Gets the information for the platform
`GET https://apizie.tech/v1/iot:clearblade/apiinfo`

### CODE - Retrieve information about service
`GET https://apizie.tech/v1/iot:clearblade/get-service`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-DevToken | string | yes | Dev Token obtained through authentication. |
| systemKey | string | yes | System key that identifies the system the device is a part of. |
| serviceName | string | yes | Code Service's name |

### CODE - Call/Execute code service
`POST https://apizie.tech/v1/iot:clearblade/execute-service`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-UserToken | string | yes | Token obtained through user authentication. |
| systemKey | string | yes | System Key that identifies the system that holds the code service. |
| serviceName | string | yes | Code Service's name |
| body | object | no | JSON request body |

### DATA(name) - Get items
`GET https://apizie.tech/v1/iot:clearblade/get-collection-data`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-UserToken | string | yes | Token obtained through user authentication. |
| systemKey | string | yes | System Key that identifies the system that holds the collection. |
| collectionName | string | yes | Name of the collection. |
| query | string | no | Query object used to filter the items. See query model below for example. |

### DATA(name) - Create items
`POST https://apizie.tech/v1/iot:clearblade/create-collection-data`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-UserToken | string | yes | Token obtained through user authentication. |
| systemKey | string | yes | System Key that identifies the system that holds the collection. |
| collectionName | string | yes | Name of the collection. |
| body | object | no | JSON request body |

### DATA(name) - Update items
`POST https://apizie.tech/v1/iot:clearblade/update-collection-data`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-UserToken | string | yes | Token obtained through user authentication. |
| systemKey | string | yes | System Key that identifies the system that holds the collection. |
| collectionName | string | yes | Name of the collection. |
| body | object | yes | JSON request body |

### DATA(name) - Delete items
`POST https://apizie.tech/v1/iot:clearblade/delete-collection-data`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-UserToken | string | yes | Token obtained through user authentication. |
| systemKey | string | yes | System Key that identifies the system that holds the collection. |
| collectionName | string | yes | Name of the collection. |
| query | string | yes | Query to limit scope of deletion. |

### DATA(id) - Get items
`GET https://apizie.tech/v1/iot:clearblade/get-collection-data-alt`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-UserToken | string | yes | Token obtained through user authentication. |
| collectionID | string | yes | ID of the collection. |
| query | string | no | Query object used to filter the items. See query model below for example. |

### DATA(id) - Create items
`POST https://apizie.tech/v1/iot:clearblade/create-collection-data-alt`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-UserToken | string | yes | Token obtained through user authentication. |
| collectionID | string | yes | ID of the collection. |
| body | object | yes | JSON request body |

### DATA(id) - Update items
`POST https://apizie.tech/v1/iot:clearblade/update-collection-data-alt`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-UserToken | string | yes | Token obtained through user authentication. |
| collectionID | string | yes | ID of the collection. |
| body | object | yes | JSON request body |

### DATA(id) - Delete items
`POST https://apizie.tech/v1/iot:clearblade/delete-collection-data-alt`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-UserToken | string | yes | Token obtained through user authentication. |
| collectionID | string | yes | ID of the collection. |
| query | string | yes | Query to limit scope of deletion. |

### DATA(id) - Get columns
`GET https://apizie.tech/v1/iot:clearblade/get-columns`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-UserToken | string | yes | Token obtained through user authentication. |
| collectionID | string | yes | ID of the collection. |
| ClearBlade-SystemKey | string | yes | System Key that identifies the system that holds the collection. |
| ClearBlade-SystemSecret | string | yes | header parameter for ensuring authenticity |

### MESSAGING - Get history
`GET https://apizie.tech/v1/iot:clearblade/get-message-history`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-UserToken | string | yes | Token obtained through user authentication. |
| systemKey | string | yes | System Key that identifies the system the messages belong to. |
| topic | string | yes | Messaging topic to retrieve the history for. |
| count | string | yes | Number of messages to retrieve. 0 retrieves all messages. |
| last | string | no | Point in time to start search. (epoch timestamp) |
| start | string | no | Start time for searching within a timeframe. (epoch timestamp) |
| stop | string | no | End time for searching within a timeframe. (epoch timestamp) |

### MESSAGING - Delete history
`POST https://apizie.tech/v1/iot:clearblade/delete-message-history`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClearBlade-UserToken | string | yes | Token obtained through user authentication. |
| systemKey | string | yes | System Key that identifies the system the messages belong to. |
| topic | string | yes | Messaging topic to delete the history for. |
| count | string | yes | Number of messages to delete. 0 deletes all messages. |
| last | string | no | Point in time to start deleting. (epoch timestamp) |
| start | string | no | Start time for deleting within a timeframe. (epoch timestamp) |
| stop | string | no | End time for deleting within a timeframe. (epoch timestamp) |

…and 100 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/iot:clearblade/dev-get-assets" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the ClearBlade API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/iot:clearblade/dev-get-assets with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the ClearBlade API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the ClearBlade API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key iot:clearblade.

### What is the status of the ClearBlade API API?
Live: works with just an Apizie key