API
- PUT /api/v1/can/connect
Can Connect
Connect to a CAN network
If no network is given, the default network is used (or else the first network that was found).
- Status Codes:
200 OK – Successful Response
404 Not Found – The requested CAN network was not found.
422 Unprocessable Entity – Validation Error
502 Bad Gateway – The CAN network could not be opened or the STU did not respond.
- PUT /api/v1/can/disconnect
Can Disconnect
Disconnect from the CAN network
- Status Codes:
200 OK – Successful Response
- GET /api/v1/can/networks
Can Networks
Search for available CAN networks
- Status Codes:
200 OK – Successful Response
- POST /api/v1/cloud/authenticate
Authenticate
Authenticate to cloud storage
- Status Codes:
200 OK – Successful Response
- POST /api/v1/cloud/update
Update File
Update file in cloud storage
- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- POST /api/v1/cloud/upload
Upload File
Upload file to cloud storage
- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
500 Internal Server Error – Could not upload to dataspace. Most likely, this results from a duplicate entry.
- GET /api/v1/config/backup
Get Config Backups
Get configuration backup files
- Status Codes:
200 OK – Configuration backups returned successfully.
500 Internal Server Error – Failed to list configuration backups.
- POST /api/v1/config/dataspace
Upload Dataspace File
Upload dataspace configuration file
- Status Codes:
200 OK – Dataspace configuration uploaded successfully.
400 Bad Request – Failed to parse YAML payload.
415 Unsupported Media Type – Unsupported media type for configuration upload.
422 Unprocessable Entity – Provided YAML does not satisfy sensors schema.
500 Internal Server Error – Failed to store configuration file.
- GET /api/v1/config/meta
Get Metadata File
Get metadata file information
- Status Codes:
200 OK – File was found and returned.
404 Not Found – File not found. Check your measurement directory.
- POST /api/v1/config/meta
Upload Metadata File
Upload YAML metadata file
- Status Codes:
200 OK – Metadata configuration uploaded successfully.
400 Bad Request – Failed to parse YAML payload.
415 Unsupported Media Type – Unsupported media type for configuration upload.
422 Unprocessable Entity – Provided YAML does not satisfy metadata schema.
500 Internal Server Error – Failed to store configuration file.
- PUT /api/v1/config/restore
Restore Config File
Restore configuration file from backup
- Status Codes:
200 OK – Configuration restored successfully.
400 Bad Request – Invalid configuration restore request.
404 Not Found – Requested configuration backup not found.
422 Unprocessable Entity – Validation Error
500 Internal Server Error – Failed to restore configuration file.
- GET /api/v1/config/sensors
Get Sensors File
Get sensor configuration file information
- Status Codes:
200 OK – File was found and returned.
404 Not Found – File not found. Check your measurement directory.
- POST /api/v1/config/sensors
Upload Sensors File
Upload sensor configuration file
- Status Codes:
200 OK – Sensor configuration uploaded successfully.
400 Bad Request – Failed to parse YAML payload.
415 Unsupported Media Type – Unsupported media type for configuration upload.
422 Unprocessable Entity – Provided YAML does not satisfy sensors schema.
500 Internal Server Error – Failed to store configuration file.
- GET /api/v1/files
List Files And Capacity
Get file list and storage capacity information
- Status Codes:
200 OK – Successful Response
- POST /api/v1/files/analyze
Post Analyzed File
Upload file for analysis
- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- GET /api/v1/files/analyze/meta/{name}
Get File Meta
Get measurement file metadata
- Parameters:
name (string)
- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- GET /api/v1/files/analyze/{name}
Get Analyzed File
Analyze measurement file
- Parameters:
name (string)
- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- DELETE /api/v1/files/post_meta/{name}
Delete Post Meta
Delete post metadata from measurement file, if any exists
- Parameters:
name (string)
- Status Codes:
200 OK – Metadata deleted successfully
404 Not Found – File not found. Check your measurement directory.
422 Unprocessable Entity – Validation Error
- POST /api/v1/files/post_meta/{name}
Overwrite Post Meta
Add or overwrite post metadata in measurement file
This also works for files that do not have any post metadata yet, and for a metadata.profile that differs from whatever profile the file previously had (any picture arrays belonging to the old metadata are removed first).
- Parameters:
name (string)
- Status Codes:
200 OK – Metadata successfully saved
404 Not Found – File not found. Check your measurement directory.
422 Unprocessable Entity – Validation Error
- DELETE /api/v1/files/pre_meta/{name}
Delete Pre Meta
Delete pre metadata from measurement file, if any exists
- Parameters:
name (string)
- Status Codes:
200 OK – Metadata deleted successfully
404 Not Found – File not found. Check your measurement directory.
422 Unprocessable Entity – Validation Error
- POST /api/v1/files/pre_meta/{name}
Overwrite Pre Meta
Add or overwrite pre metadata in measurement file
This also works for files that do not have any pre metadata yet, and for a metadata.profile that differs from whatever profile the file previously had (any picture arrays belonging to the old metadata are removed first).
- Parameters:
name (string)
- Status Codes:
200 OK – Metadata successfully saved
404 Not Found – File not found. Check your measurement directory.
422 Unprocessable Entity – Validation Error
- DELETE /api/v1/files/{name}
Delete File
Delete measurement file
- Parameters:
name (string)
- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- GET /api/v1/files/{name}
Download File
Download measurement files
- Parameters:
name (string)
- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- POST /api/v1/files/{name}/embedded
Upload Embedded File
Append uploaded files below the embedded_files group
- Parameters:
name (string)
- Status Codes:
200 OK – Successful Response
404 Not Found – File not found. Check your measurement directory.
422 Unprocessable Entity – Target file is not a valid HDF5 file.
- DELETE /api/v1/files/{name}/embedded/{dataset_name}
Delete Embedded File
Delete an embedded file from an HDF5 file
- Parameters:
name (string)
dataset_name (string)
- Status Codes:
200 OK – Embedded file deleted successfully.
404 Not Found – File not found. Check your measurement directory.
422 Unprocessable Entity – Target file is not a valid HDF5 file.
- GET /api/v1/files/{name}/embedded/{dataset_name}
Download Embedded File
Download an embedded file from an HDF5 file
- Parameters:
name (string)
dataset_name (string)
- Status Codes:
200 OK – Successful Response
404 Not Found – File not found. Check your measurement directory.
422 Unprocessable Entity – Target file is not a valid HDF5 file.
- GET /api/v1/logs/all
Download Logs Zip
Download log files as zipped file
- Query Parameters:
include_system_info (boolean)
- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- GET /api/v1/logs/download/{file}
Download Log File
Download log file
- Parameters:
file (string)
- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- GET /api/v1/logs/view
View Log File
View log file
- Query Parameters:
file (string) – (Required)
limit (integer)
- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- GET /api/v1/measurement
Measurement Status
Get measurement status
- Status Codes:
200 OK – Successful Response
- POST /api/v1/measurement/execute
Execute Measurement
Connect, configure and start a measurement in one call, for headless orchestration.
All-or-nothing: on any failure, the STH is disconnected rather than left connected with a half-applied configuration. Idempotent with respect to an already-connected STH at the requested MAC address - the existing connection is reused rather than being torn down and re-established.
- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
503 Service Unavailable – No CAN network connected.
- POST /api/v1/measurement/start
Start Measurement
Start measurement
- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
503 Service Unavailable – No CAN network connected.
- POST /api/v1/measurement/stop
Stop Measurement
Stop measurement
- Status Codes:
200 OK – Measurement stopped successfully.
504 Gateway Timeout – Failed to stop measurement within timeout.
- PUT /api/v1/reset-can
Reset Can
Reset CAN connection
Disconnects and searches for CAN networks again. The API reconnects to the network it was connected to before, if that network is still available. If it was not connected, it only reconnects if autoconnect is enabled.
- Status Codes:
200 OK – Successful Response
- GET /api/v1/sth
Sth
Get a list of available sensor devices
- Status Codes:
200 OK – Return the STH Devices reachable
502 Bad Gateway – The CAN network did not respond to the request.
503 Service Unavailable – No CAN network connected.
- PUT /api/v1/sth/connect
Sth Connect
Connect to sensor node
- Status Codes:
200 OK – Connection was successful.
400 Bad Request – Incorrect request for current ICOtronic system state.
404 Not Found – STH could not be connected and must be out of reach or discharged.
422 Unprocessable Entity – Validation Error
502 Bad Gateway – The CAN network did not respond to the request.
503 Service Unavailable – No CAN network connected.
- PUT /api/v1/sth/disconnect
Sth Disconnect
Disconnect from sensor node
- Status Codes:
200 OK – Disconnect was successful.
400 Bad Request – Incorrect request for current ICOtronic system state.
502 Bad Gateway – The CAN network did not respond to the request.
503 Service Unavailable – No CAN network connected.
- GET /api/v1/sth/read-adc
Read Adc
Read ADC configuration
- Status Codes:
200 OK – Connection was successful.
404 Not Found – STH could not be connected and must be out of reach or discharged.
502 Bad Gateway – The CAN network did not respond to the request.
503 Service Unavailable – No CAN network connected.
- PUT /api/v1/sth/rename
Sth Rename
Rename sensor node
- Status Codes:
200 OK – Connection was successful.
400 Bad Request – Incorrect request for current ICOtronic system state.
404 Not Found – STH could not be connected and must be out of reach or discharged.
422 Unprocessable Entity – Validation Error
502 Bad Gateway – The CAN network did not respond to the request.
503 Service Unavailable – No CAN network connected.
- GET /api/v1/sth/supply-voltage
Get Supply Voltage
Get supply voltage of connected STH.
- Status Codes:
200 OK – Supply voltage of connected STH.
500 Internal Server Error – Failed to read supply voltage.
503 Service Unavailable – No CAN network connected.
- PUT /api/v1/sth/write-adc
Write Adc
Write ADC configuration
- Status Codes:
200 OK – ADC configuration written successfully.
404 Not Found – STH could not be connected and must be out of reach or discharged.
422 Unprocessable Entity – Validation Error
502 Bad Gateway – The CAN network did not respond to the request.
503 Service Unavailable – No CAN network connected.
- GET /api/v1/stu
Stu
Get available STU
- Status Codes:
200 OK – Successful Response
503 Service Unavailable – No CAN network connected.
- GET /api/v1/stu/connected
Stu Connected
Check if the STU is connected to a sensor device
- Status Codes:
200 OK – Returns true if the STU is connected, false otherwise.
502 Bad Gateway – The CAN network did not respond to the request.
503 Service Unavailable – No CAN network connected.
- PUT /api/v1/stu/reset
Stu Reset
Reset STU
- Status Codes:
200 OK – Indicates the STU has been reset.
400 Bad Request – Incorrect request for current ICOtronic system state.
502 Bad Gateway – The CAN network did not respond to the request.
503 Service Unavailable – No CAN network connected.