← Back to catalog

Other

ClearBlade

auto-generated
swirls add clearblade …
actionPOSTv1.0.0

2FA - Create Email Communication

## Description: Creates email communication . This endpoint is Admin only. ## Settings choices |Settings|Allowed Values| |--------|-----| |encryption_type|STARTTLS, TLS, NONE| |protocol|SMTP|

Source
actionPOSTv1.0.0

2FA - Create SMS Communication

Creates SMS communication . Twilio is the only supported service. This endpoint is Admin only.

Source
actionGETv1.0.0

ADMIN - Get system status

Retrieves the specified system's status as it relates to limits. To be used by the billing system.

Source
actionGETv1.0.0

AUDIT - Get Audit Info

## Description: Returns list of assets and the information about the changes that have been made. This endpoint is for Admin only. ### Query Structure: ```json {"PAGESIZE":int,"PAGENUM":int,"FILTERS":[[{"_REPLACE_WITH_OPERATOR_":[{"valueType":"value"}]}]], "SORT":[{"DESC":"value"}]} ``` Note - You can generate a complex query object in a code service using the `ClearBlade.Query()` object. ## Audit Table Schema: Refer to this when building the query. | Column | Type | Possible Values|Example| |:---------|:---------|:------|:---------| | id | bigint |ANY_POSITIVE_INTEGER|10440595| |system_key|string|SINGLE_STRING_WITH_HEX_CHARS_ONLY|"ccafb4cadaccaf9ebba01"| |time|timestamp|ISO_DATE_TIME_STRING|"2020-01-29T20:18:18.475214Z"| |response_time|bigint|ANY_POSITIVE_INTEGER|4038669| |asset_class|string|adapters, adapterFiles, devices, users, multi_dev, services, libraries, servicecaches, timers, triggers, webhooks, portals, plugins, rolesperms, collections, edges, messaging, deployments, edgegroups, system, usersessions, devicesessions|"collections"| |action_type|string|Create, Update, Delete, Create Columns, Delete Columns, Developer Password Reset, User Password Reset, MQTT Disconnect, MQTT Connect|"MQTT Connect"| |email|string|SINGLE_VALID_EMAIL_STRING|"[email protected]"| |asset_id|string|ANY_STRING|"ClearBlade-iPhone"| |changes|string|STRINGIFIED_JSON|"{\\"newVersion\\":2}"| |user_type|string|UNKNOWN, DEV, USER, DEVICE, Invalid UserType|"DEVICE"| ### Example: ```json {"FILTERS":[[{"NEQ":[{"asset_class":"services"}]},{"EQ":[{"action_type":"create"}]}]],"PAGESIZE":0,"PAGENUM":0} ```

Source
actionGETv1.0.0

AUDIT - Get Audit Info

## Description: Returns list of assets and the information about the changes that have been made. This endpoint is for Admin and Dev. ### Query Structure: ```json {"PAGESIZE":int,"PAGENUM":int,"FILTERS":[[{"_REPLACE_WITH_OPERATOR_":[{"valueType":"value"}]}]], "SORT":[{"DESC":"value"}]} ``` Note - You can generate a complex query object in a code service using the `ClearBlade.Query()` object. ## Audit Table Schema: Refer to this when building the query. | Column | Type | Possible Values|Example| |:---------|:---------|:------|:---------| | id | bigint |ANY_POSITIVE_INTEGER|10440595| |system_key|string|SINGLE_STRING_WITH_HEX_CHARS_ONLY|"ccafb4cadaccaf9ebba01"| |time|timestamp|ISO_DATE_TIME_STRING|"2020-01-29T20:18:18.475214Z"| |response_time|bigint|ANY_POSITIVE_INTEGER|4038669| |asset_class|string|adapters, adapterFiles, devices, users, multi_dev, services, libraries, servicecaches, timers, triggers, webhooks, portals, plugins, rolesperms, collections, edges, messaging, deployments, edgegroups, system, usersessions, devicesessions|"collections"| |action_type|string|Create, Update, Delete, Create Columns, Delete Columns, Developer Password Reset, User Password Reset, MQTT Disconnect, MQTT Connect|"MQTT Connect"| |email|string|SINGLE_VALID_EMAIL_STRING|"[email protected]"| |asset_id|string|ANY_STRING|"ClearBlade-iPhone"| |changes|string|STRINGIFIED_JSON|"{\\"newVersion\\":2}"| |user_type|string|UNKNOWN, DEV, USER, DEVICE, Invalid UserType|"DEVICE"| ### Example: ```json {"FILTERS":[[{"NEQ":[{"asset_class":"services"}]},{"EQ":[{"action_type":"create"}]}]],"PAGESIZE":0,"PAGENUM":0} ```

Source
actionGETv1.0.0

Audit - Get counts

Gets total number of changes made to assets across all systems on the instance. This endpoint is Admin only.

Source
actionGETv1.0.0

AUDIT - Get counts

Gets total number of changes made to assets across all systems on the instance. This endpoint is for Admin and Dev.

Source
actionGETv1.0.0

AUDIT - Get list of systems that have been updated

## Description: Get list of systems that have been updated. This is an Admin only endpoint. ### Query: ```json {"PAGESIZE":int,"PAGENUM":int,"FILTERS":[[{"_REPLACE_WITH_OPERATOR_":[{"valueType":"value"}]}]],"SORT":[{"DESC":"value"}]} ``` Note - You can generate a complex query object in a code service using the `ClearBlade.Query()` object. ## Admin Audit Table Schema: Refer to this when building the query. | Column | Type | Possible Values| Examples| |:--------|:--------|:------|:------| | name | string |ANY_STRING|"ClearBladeDev"| |owner|string|EMAIL_STRING |"[email protected]"| |systemKey|string|SINGLE_STRING_WITH_HEX_CHARS_ONLY|"80sdff82c0b1fbda1f271"| |disabled|boolean|true, false|true| |lastUpdated|timestamp|ISO_DATE_TIME_STRING|"2020-01-29T20:18:18.475214Z"| |numDevs|int|ANY_POSITIVE_INTEGER|2| |numServices|int|ANY_POSITIVE_INTEGER|2| |numLibraries|int|ANY_POSITIVE_INTEGER|2| |numDeployments|int|ANY_POSITIVE_INTEGER|2| |numRoles|int|ANY_POSITIVE_INTEGER|2| |numUsers|int|ANY_POSITIVE_INTEGER|2| |numDevices|int|ANY_POSITIVE_INTEGER|2| |numEdge|int|ANY_POSITIVE_INTEGER|2| |numAPIReqsTotal|int|ANY_POSITIVE_INTEGER|2| |numAPIReqsMonth|int|ANY_POSITIVE_INTEGER|2| |numAPIReqsYear|int|ANY_POSITIVE_INTEGER|2| |numPub|int|ANY_POSITIVE_INTEGER|2| |numPubMonth|int|ANY_POSITIVE_INTEGER|2| |numPubYear|int|ANY_POSITIVE_INTEGER|2| |numRecTotal|int|ANY_POSITIVE_INTEGER|2| |numRecMonth|int|ANY_POSITIVE_INTEGER|2| |numRecYear|int|ANY_POSITIVE_INTEGER|2| |diskUsage|int|ANY_POSITIVE_INTEGER|2| ### Example: ```json "query":{"FILTERS":[[{"NEQ":[{"disabled":true}]},{"EQ":[{"numDevs":2}]}]],"PAGESIZE":0,"PAGENUM":0} ```

Source
actionGETv1.0.0

AUDIT - Get list of systems that have been updated

## Description: Get list of changes that have been made to the system. This is an Admin and Dev endpoint. ### Query: ```json "query":{"PAGESIZE":int,"PAGENUM":int,"FILTERS":[[{"_REPLACE_WITH_OPERATOR_":[{"valueType":"value"}]}]],"SORT":[{"DESC":"value"}]} ``` Note - You can generate a complex query object in a code service using the `ClearBlade.Query()` object. ## Admin Audit Table Schema: ## Admin Audit Table Schema: Refer to this when building the query. | Column | Type | Possible Values| Examples| |:--------|:--------|:------|:------| | name | string |ANY_STRING|"ClearBladeDev"| |owner|string|EMAIL_STRING |"[email protected]"| |systemKey|string|SINGLE_STRING_WITH_HEX_CHARS_ONLY|"80sdff82c0b1fbda1f271"| |disabled|boolean|true, false|true| |lastUpdated|timestamp|ISO_DATE_TIME_STRING|"2020-01-29T20:18:18.475214Z"| |numDevs|int|ANY_POSITIVE_INTEGER|2| |numServices|int|ANY_POSITIVE_INTEGER|2| |numLibraries|int|ANY_POSITIVE_INTEGER|2| |numDeployments|int|ANY_POSITIVE_INTEGER|2| |numRoles|int|ANY_POSITIVE_INTEGER|2| |numUsers|int|ANY_POSITIVE_INTEGER|2| |numDevices|int|ANY_POSITIVE_INTEGER|2| |numEdge|int|ANY_POSITIVE_INTEGER|2| |numAPIReqsTotal|int|ANY_POSITIVE_INTEGER|2| |numAPIReqsMonth|int|ANY_POSITIVE_INTEGER|2| |numAPIReqsYear|int|ANY_POSITIVE_INTEGER|2| |numPub|int|ANY_POSITIVE_INTEGER|2| |numPubMonth|int|ANY_POSITIVE_INTEGER|2| |numPubYear|int|ANY_POSITIVE_INTEGER|2| |numRecTotal|int|ANY_POSITIVE_INTEGER|2| |numRecMonth|int|ANY_POSITIVE_INTEGER|2| |numRecYear|int|ANY_POSITIVE_INTEGER|2| |diskUsage|int|ANY_POSITIVE_INTEGER|2| ### Example: ```json "query":{"FILTERS":[[{"NEQ":[{"disabled":true}]},{"EQ":[{"numDevs":2}]}]],"PAGESIZE":0,"PAGENUM":0} ```

Source
actionPOSTv1.0.0

DATA - Create collection

Creates a new collection or database connection in the specified system.

Source
actionPOSTv1.0.0

DATA - Create collection

This 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 already exists.

Source
actionPOSTv1.0.0

DATA - Create Unique Index

This 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 index already exists.

Source
actionGETv1.0.0

DATA - Get list of indexes

This returns all USER CREATED indexes/constraints for the collection.For safety, primary key indexes are not returned.

Source
actionGETv1.0.0

DATA(id) - Get columns

Returns the columns and their data type for the specified collection.

Source
actionGETv1.0.0

DATA(id) - Get items

Returns the data from the specified collection.

Source
actionPOSTv1.0.0

DATABASES - Create a external database connection

## Description: Creates an external database connections for that system. This is a developer only endpoint. ### List of database types supported: |Database Name|db_type| |-------------|-------| |MONGO|mongodb| |POSTGRES|postgres| |MYSQL|mysql| |MSSQL|mssql| |COUCHDB|couchdb| ### Database Credentials |Field|Type|Database|Description|Options|Default| |-----|----|-----|-------|-------|----| |user|string|All|The external database username| |password|string|All|The external database password| |address|string|All|The external database IP address| |port|string|All|The port used to connect to the external database||27017 (Mongo), 3306 (MySQL), 5432 (Postgres), 1433 (MSSQL)| |dbname|string|All|The name of the external database| |connection_type|string|Mongo|The external database DNS connection type|srv and standard|standard| |tls|boolean|Mongo and Postgres|Setting the tls to `true` allows for transport encryption. This field is optional|True and false|True (Mongo) False(Postgres)| |authMechanism|string|Mongo|Database authentication method. This field is optional|SCRAM-SHA-256, SCRAM-SHA-1, MONGODB-CR, PLAIN, GSSAPI, MONGODB-X509|SCRAM-SHA-1| |authSource|string|Mongo|Database authentication source. This field is optional||admin| |replicaSet|string|Mongo|Allows for use of Replication Methods such as `rs.reconfig() `.This field is optional||empty string| |encryption|string|MSSQL|Setting the encryption to `true` allows for secure encryption|disable and true|

Source
actionGETv1.0.0

DEPLOYMENTS - Gets all deployment names and descriptions for a system

## Description: Gets all deployment names and descriptions for a system ### Query: ```json {"PAGESIZE":int,"PAGENUM":int,"FILTERS":[[{"EQ":[{"valueType":"value"}]}]],"SORT":[{"DESC":"value"}]} ``` ### Example: ```json {"PAGESIZE":0,"PAGENUM":0,"SORT":[{"DESC":"name"}]}

Source
actionGETv1.0.0

DEVELOPER - Get all libraries

Returns all available libraries in the specified system along with their meta information.

Source
actionGETv1.0.0

DEVELOPER - Get dev info

Returns all user information about the current developer. This is a developer only endpoint.

Source
actionGETv1.0.0

DEVELOPER - Get edge template

Get list of which triggers, services, and libraries should be copied onto which edge when it starts up.

Source
actionGETv1.0.0

DEVELOPER - Get list of roles

## Description: Get as a list of roles that are available to add to an user ### Query: ```json {"PAGESIZE":int,"PAGENUM":int,"FILTERS":[[{"EQ":[{"name":"value"}]}]]} ``` ### Example: 0 and 0 for pagesize and pagenum returns all the information in one response. ```json {"PAGESIZE":0,"PAGENUM":0,"FILTERS":[[{"EQ":[{"name":"Authenticated"}]}]]} ```

Source
actionGETv1.0.0

DEVICES - Get count

Returns the total number of devices in a system.

Source
actionPOSTv1.0.0

EDGE - Create edge

Creates a new edge in the specified system.

Source
actionGETv1.0.0

EDGE - Fetch all edges

Returns all edge info that the current user is authorized to see.

Source
actionGETv1.0.0

EDGE - Get count

Returns the total number of edges in a system.

Source
actionGETv1.0.0

FILES - Get a file's metadata in a box

## Description: Returns metadata of a specific file in a specific box. boxName defaults to "inbox" ### Query Structure: ```json box={boxName} path={relativePath} ``` ### boxName Options * inbox * outbox * sandbox If `box==""`, then all files from all three boxes (inbox, outbox, sandbox) will be returned. ### Example: ```json box=inbox path=/relative/path/to/file ```

Source
actionGETv1.0.0

FILES - Get all files metadata in a box

## Description: Returns metadata of files in a specific box. boxName defaults to "inbox" ### Query Structure: ```json box={boxName} ``` ### boxName Options * inbox * outbox * sandbox If `box==""`, then all files from all three boxes (inbox, outbox, sandbox) will be returned. ### Example: ```json box=inbox ```

Source
actionGETv1.0.0

MESSAGING - Get history

Returns the message history for a single topic. Does not honor wildcards.

Source
actionGETv1.0.0

MESSAGING - Gets list of topics

## Description: Returns the list of topics. ### Query Structure: ```json {"PAGESIZE":int,"PAGENUM":int,"FILTERS":[[{"_REPLACE_WITH_OPERATOR_":[{"valueType":"value"}]}]], "SORT":[{"DESC":"value"}]} ``` ### Example: ```json {"FILTERS":[[{"NEQ":[{"concurrency":0}]}]],"PAGESIZE": ,"PAGENUM":1} ```

Source
actionGETv1.0.0

SESSION - Get device session count

## Description: Returns number of device sessions. ### Query Structure: ```json {"PAGESIZE":int,"PAGENUM":int,"FILTERS":[[{"_REPLACE_WITH_OPERATOR_":[{"valueType":"value"}]}]], "SORT":[{"DESC":"value"}]} ``` Note - You can generate a complex query object in a code service using the `ClearBlade.Query()` object. ### Filter Options * device_key - string * issued - int ### Example: ```json {"FILTERS":[[{"NEQ":[{"device_key":"e2c794e60bee9ced68fc101 :: DEVICENAME0001"}]},{"EQ":[{"issued":1587659839}]}]],"PAGESIZE":0,"PAGENUM":0} ```

Source
actionGETv1.0.0

SESSION - Get device session info

## Description: Returns list of device sessions with Device Key and Timestamps . ### Query Structure: ```json {"PAGESIZE":int,"PAGENUM":int,"FILTERS":[[{"_REPLACE_WITH_OPERATOR_":[{"valueType":"value"}]}]], "SORT":[{"DESC":"value"}]} ``` Note - You can generate a complex query object in a code service using the `ClearBlade.Query()` object. ### Filter Options * device_key - string * issued - int (Unix timestamp) ### Example: ```json {"FILTERS":[[{"NEQ":[{"device_key":"e2c794e60bee9ced68fc101 :: DEVICENAME0001}]},{"EQ":[{"issued":1587659839}]}]],"PAGESIZE":0,"PAGENUM":0} ```

Source
actionGETv1.0.0

SESSION - Get user session count

## Description: Returns number of user sessions. ### Query Structure: ```json {"PAGESIZE":int,"PAGENUM":int,"FILTERS":[[{"_REPLACE_WITH_OPERATOR_":[{"valueType":"value"}]}]], "SORT":[{"DESC":"value"}]} ``` Note - You can generate a complex query object in a code service using the `ClearBlade.Query()` object. ### Filter Options * user_id - string * issued - int (Unix timestamp) ### Example: ```json {"FILTERS":[[{"NEQ":[{"user_id":"9cd8ece70bea9e5a6de9cee05"}]},{"EQ":[{"issued":1587659839}]}]],"PAGESIZE":0,"PAGENUM":0} ```

Source
actionGETv1.0.0

SESSION - Get user session info

## Description: Returns list of user sessions with User ID and Timestamps . ### Query Structure: ```json {"PAGESIZE":int,"PAGENUM":int,"FILTERS":[[{"_REPLACE_WITH_OPERATOR_":[{"valueType":"value"}]}]], "SORT":[{"DESC":"value"}]} ``` Note - You can generate a complex query object in a code service using the `ClearBlade.Query()` object. ### Filter Options * user_id - string * issued - int (Unix timestamp) ### Example: ```json {"FILTERS":[[{"NEQ":[{"user_id":"9cd8ece70bea9e5a6de9cee05"}]},{"EQ":[{"issued":1587659839}]}]],"PAGESIZE":0,"PAGENUM":0} ```

Source
actionGETv1.0.0

USERS - Get all users

Returns all user info that the current user is authorized to see.

Source
Beyond the catalog

Any provider, on request.

01

Request it

Tell us which provider you need, and we will ship it in the registry.

02

Generate it

Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.

Request a providerRead the actions docs
acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
 
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec