Platform
API keys
Platform
API keys
API keys allow clients access to the API.
API keys allow clients to authenticate with Airbotics over the REST API.
API keys should be kept secret.
Authorization scopes
When creating an API key you must specify which actions it is permitted to do within Airbotics by selecting one or more of the below permissions:
| Scope | Description | Actions |
|---|---|---|
commands:write | Send/delete commands. | - Send a command - Delete a command |
commands:read | Read all commands. | - List commands sent to any robot |
robots:write | Create/update/delete robots. | - Create a robot - Delete a robot - Update a robot |
robots:read | List all robots and read details about them. | - List all robots - Get details about a robot |
robots-compose-files:write | Add/delete compose file from robots. | - Put a compose file on a robot - Remove a compose file from a robot |
robots-compose-files:read | Read compose files on robots | - Read the compose file on a robot |
compose-files:write | Create/delete any compose file. | - Create a compose file - Delete a compose file |
compose-file:read | Read all compose files. | - List all compose files - Get details about a compose file |
logs:write | Configure logs collection | - Enable/disable log collection - Delete logs from any robot |
logs:read | Read configuration and logs. | - Read log configuration - Read logs from any robot |
data:read | Read data points and data streams. | - Read streams from any robot - Query data points from any robot |
data:write | Configure data collection | - Create data stream - Delete data stream - Enabled/disable data collection |
Prefixes
API keys are prefixed with aak_ (for Airbotics API key). You will see that tokens for robots are prefixed with art_ (for Airbotics Robot Token).