{"@context": "https://schema.org", "@type": "WebAPI", "name": "ClearBlade API API", "description": "A friendly little API to help you interact with the ClearBlade platform.", "provider": {"@type": "Organization", "name": "clearblade.com"}, "documentation": "https://docs.clearblade.com/v/4/static/api/openapi.yaml"}
A friendly little API to help you interact with the ClearBlade platform.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://platform.clearblade.com
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
A friendly little API to help you interact with the ClearBlade platform.
| method | path | what the vendor says it does |
|---|---|---|
GET | /admin/allapps | DEVELOPER - Get platform assets Retrieves system information for all systems in the developer account. Develop |
GET | /admin/allcollections | DEVELOPER - Get collections Returns all the collections in the specified system. Developer |
GET | /admin/allsystems | DEVELOPER - Get systems Returns all the systems tied to the specified developer's account. Developer |
GET | /admin/audit | AUDIT - Get Audit Info ## Description: Returns list of assets and the information about the changes that have |
GET | /admin/audit/count | Audit - Get counts Gets total number of changes made to assets across all systems on the instance. This endpoi |
GET | /admin/audit/{systemKey} | AUDIT - Get Audit Info ## Description: Returns list of assets and the information about the changes that have |
GET | /admin/audit/{systemKey}/count | AUDIT - Get counts Gets total number of changes made to assets across all systems on the instance. This endpoi |
POST | /admin/auth | DEVELOPER - Authenticate dev ## Description Logs developer into system and returns an Developer Token ## Endpo |
POST | /admin/checkauth | DEVELOPER - Verifies access to the system Verifies developer access to the system Developer |
POST | /admin/collectionmanagement | DEVELOPER - Create collection Creates a new collection or database connection in the specified system. Develop |
PUT | /admin/collectionmanagement | DEVELOPER - Update collection Creates or deletes a column within an existing collection, or updates an existin |
DELETE | /admin/collectionmanagement | DEVELOPER - Delete collection Deletes an existing collection in the specified system. Developer |
GET | /admin/count/developers | ADMIN - Get number of admin developers Retrieves the number of developers who are considered administrators in |
GET | /admin/count/systems | ADMIN - Get number of systems available Retrieves the number of systems that are available. Admin |
GET | /admin/database/status | DATABASES - Retrieves all internal and external database statuses Returns all the names and internal and exter |
PUT | /admin/developers/{systemKey} | ADMIN - Add/Remove/Change owner For admin, you can add/remove/change the owner of a system even if you’re not |
POST | /admin/devices/keys/{systemKey}/{deviceName} | DEVICE -Creates rotating keys for a device. Creates rotating keys for a device. Device |
DELETE | /admin/devices/keys/{systemKey}/{deviceName} | DEVELOPER - Delete rotating keys for a device Deletes the rotating keys from its device. Developer |
GET | /admin/devices/{systemKey} | DEVELOPER - Get devices with or without a query Retrieves information about all devices in the specified syste |
PUT | /admin/devices/{systemKey} | DEVELOPER - Update devices using a query Updates all devices matching the filters specified by a query. Develo |
DELETE | /admin/devices/{systemKey} | DEVELOPER - Delete devices using a query Deletes all devices matching the filters specified by a query. Develo |
GET | /admin/devices/{systemKey}/{name} | DEVELOPER - Get device Retrieves information about the specified device. Developer |
POST | /admin/devices/{systemKey}/{name} | DEVELOPER - Create device Creates a new device in the specified system. Developer |
PUT | /admin/devices/{systemKey}/{name} | DEVELOPER - Update device Updates the specified device's information. Developer |
DELETE | /admin/devices/{systemKey}/{name} | DEVELOPER - Delete device Deletes the specified device from its system. Developer |
GET | /admin/edges/template/{systemKey} | DEVELOPER - Get edge template Get list of which triggers, services, and libraries should be copied onto which |
PUT | /admin/edges/template/{systemKey}/{edgeName} | DEVELOPER - Update edge template Update template for the specified edge. Developer |
GET | /admin/edges/{systemKey} | DEVELOPER - Get edges Retrieves all the edges that belong to the specified system. Developer |
GET | /admin/edges/{systemKey}/control | DEVELOPER - Get edges for the adapter Retrieves all the edges that the adapter belongs to. Developer |
GET | /admin/edges/{systemKey}/{edgeName} | DEVELOPER - Get edge Retrieves information about the specified edge. Developer |
POST | /admin/edges/{systemKey}/{edgeName} | DEVELOPER - Create edge Creates a new edge in the specified system. Developer |
PUT | /admin/edges/{systemKey}/{edgeName} | DEVELOPER - Update edge Updates the specified edge's information. Developer |
DELETE | /admin/edges/{systemKey}/{edgeName} | DEVELOPER - Delete edge Deletes the specified edge from its system. Developer |
POST | /admin/logout | DEVELOPER - Log out dev Logs the current developer out of their session and invalidates their DevToken Develop |
GET | /admin/pkey | ADMIN - Get platform license key. Returns current platform license key. Admin |
GET | /admin/platform/developer | ADMIN - Get developer Returns information about the specified developer. Admin |
POST | /admin/platform/developer | DEVELOPER - Disable developer Disables the specified developer on the platform. Developer |
GET | /admin/platform/developers | ADMIN - Get developers Returns all developers in the platform. Admin |
GET | /admin/platform/systems | AUDIT - Get list of systems that have been updated ## Description: Get list of systems that have been updated. |
GET | /admin/platform/systems/{systemKey} | AUDIT - Get list of systems that have been updated ## Description: Get list of changes that have been made to |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://docs.clearblade.com/v/4/static/api/openapi.yaml
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.