Lantronix SGX 5150 IoT Device Gateway SGX 5150 Command Reference - Page 58
: Configuration Using Web API, Overview, Device Actions API, File System API, Export Status Group
View all Lantronix SGX 5150 IoT Device Gateway manuals
Add to My Manuals
Save this manual to your list of manuals |
Page 58 highlights
5: Configuration Using Web API The Web APIs are RESTful APIs that allow access to a subset of gateway functions through a standard HTTP request. Overview SGX 5150 provides the following APIs: Device Actions API Export Status Group - Retrieve device status Export Configuration Group - Retrieve device configuration Import Configuration Group - Import device configuration Take Status Action - Take device status action File System API HTTP GET - Read the contents of files and directories HTTP PUT - Create new files and update existing files HTTP MKCOL - Create new directories HTTP DELETE - Remove files and directories from the file system Device Actions API The Device Actions API provide functions to export and import the configuration as well as export status and take a status action. Export Status Group An HTTP POST request can be sent to the device to retrieve status information. Protocol: HTTP Method: POST URL: http:///export/status Parameters: optionalLine: Optional line index for line oriented XML groups optionalGroupList: Optional list of XML groups separated by semicolon. If omitted, all status groups will be returned. optionalBoolListOnly: Optional parameter if set to 'true' returns supported group list. CURL example: curl -u admin:PASSWORD http:///export/status -X POST curl -u admin:PASSWORD http:///export/status -X POST -d "optionalGroupList=device" SGXTM 5150 IoT Device GatewaySGXTM 5150 IoT Device Gateway Command Reference 58