References#

Complete API Reference#

API Calls Table#

Method

URL

Description

POST

/dashboards/action/copyDashboards

POST

/dashboards/action/deleteDashboards

POST

/dashboards/action/moveDashboards

POST

/dashboards/action/saveDataSources

DELETE

/dashboards/colorPalettes/user/

POST

/dashboards/colorPalettes/user/

PUT

/dashboards/colorPalettes/user/

GET

/dashboards/customer/:userId

DELETE

/dashboards/customers

GET

/dashboards/customers

PUT

/dashboards/customers

POST

/dashboards/data/user/

DELETE

/dashboards/fieldGroups/user/

POST

/dashboards/fieldGroups/user/

PUT

/dashboards/fieldGroups/user/

DELETE

/dashboards/groups/user/

POST

/dashboards/groups/user/

PUT

/dashboards/groups/user/

POST

/dashboards/manage/

POST

/dashboards/resources/fields/

POST

/dashboards/schedules/deleteReports

POST

/dashboards/schedules/sync

DELETE

/dashboards/schedules/user/

POST

/dashboards/schedules/user/

PUT

/dashboards/schedules/user/

DELETE

/dashboards/seriesMappings/

POST

/dashboards/seriesMappings/

PUT

/dashboards/seriesMappings/

PUT

/dashboards/seriesMappings/name/

DELETE

/dashboards/seriesMappings/user/

POST

/dashboards/seriesMappings/user/

PUT

/dashboards/seriesMappings/user/

GET

/dashboards/streamHealthMonitor

PUT

/dashboards/streamHealthMonitor

POST

/dashboards/sync/copy

POST

/dashboards/sync/overwrite

POST

/dashboards/sync/sync

POST

/dashboards/themes/push

POST

/dashboards/themes/status

DELETE

/dashboards/themes/user

POST

/dashboards/themes/user

PUT

/dashboards/themes/user

DELETE

/dashboards/user/

POST

/dashboards/user/

PUT

/dashboards/user/

DELETE

/datasource/

GET

/datasource/

PUT

/datasource/

GET

/datasource/types/

DELETE

/definitions/groups/user/

POST

/definitions/groups/user/

PUT

/definitions/groups/user/

DELETE

/definitions/user/

POST

/definitions/user/

PUT

/definitions/user/

GET

/docs/swagjson/:filename

POST

/log/events(/:tags+)

POST

/login

GET

/system/stats

GET

/system/version

/v2#

API v2 Calls Table#

Method

URL

Description

DELETE

/v2/dashboards/roles/

POST

/v2/dashboards/roles/

PUT

/v2/dashboards/roles/

POST

/v2/db/readDatabaseTable/

POST

/v2/login

GET

/v2/lxt_updates/

DELETE

/v2/lxt_updates/

POST

/v2/lxt_updates/

PUT

/v2/lxt_updates/

GET

/v2/lxt_updates/current/

GET

/v2/lxt_updates/:version/

DELETE

/v2/lxt_updates/:version/

PUT

/v2/lxt_updates/:version/

GET

/v2/system/

PUT

/v2/system/

GET

/v2/system/:parameter/

PUT

/v2/system/:key/:value

GET

/v2/users/

DELETE

/v2/users/

POST

/v2/users/

PUT

/v2/users/

GET

/v2/users/:id/

PUT

/v2/users/deactivate/

PUT

/v2/users/reactivate/

Status Codes#

All status codes are standard HTTP status codes. The table below are status codes commonly used in the API.

Status Code

Description

200

OK

201

Created

202

Accepted

400

Bad Request by Client

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal LayerX Error

501

Not Implemented

503

Service Unavailable