HMI service
Contents
The HMI service hosts web UI applications and provides HTTP/WebSocket API.
See also:
Setup
Use the template EVA_DIR/share/svc-tpl/svc-tpl-hmi.yml:
# The default HMI service
command: svc/eva-hmi
workers: 1
bus:
path: var/bus.ipc
config:
api:
- proto: http
listen: 0.0.0.0:7727
## if a front-end server or TLS terminator is used
#real_ip_header: X-Real-IP
# HMI database for API log, user data and sessions, can be shared between instances
# default: runtime/svc_data/<SVC_ID>/hmi.db
#db: sqlite:///tmp/hmi.db
#db: postgres://USER:PASSWORD@HOST/DB
# Custom API call filter lmacro
#api_filter: lmacro:service/api_filter
auth_svcs:
- eva.aaa.localauth
session:
timeout: 60
prolong: true
stick_ip: true
allow_list_neighbors: false
user_data:
max_records: 100
max_record_length: 16384
keep_api_log: 86400
# any user can get API log for everyone (false = admins and users with op moderator in ACLs)
# public_api_log: true
ui_path: ui
# for all 404 serve /ui/ index (useful e.g. for SPAs)
#ui_not_found_to_base: true
pvt_path: pvt
# enable private user directories (path relative to pvt, e.g. "users" for pvt/users)
#pvt_user_dirs: users
# default database service ID for item.state_log & item.state_history,
# without eva.db. prefix, e.g. "db1" for eva.db.db1
#default_history_db_svc: default
mime_types: share/mime.yml
buf_size: 16384
# enable development mode (CORS headers etc.)
#development: true
# demo mode (disable profile.set_field and set_password methods)
#demo: true
# uncomment to disable vendored apps
#vendored_apps: false
# WebSocket URI alias. some front-end applications may interfere with /ws, so
# a custom one may be required. do not forget to change it also in EVA ICS
# Webengine and other front-end applications (the default "/ws" will be still
# available)
#ws_uri: /ws
user: eva
timeout:
default: 10
startup: 45
Create the service using eva-shell:
eva svc create eva.hmi.default /opt/eva4/share/svc-tpl/svc-tpl-hmi.yml
or using the bus CLI client:
cd /opt/eva4
cat DEPLOY.yml | ./bin/yml2mp | \
./sbin/bus ./var/bus.ipc rpc call eva.core svc.deploy -
(see eva.core::svc.deploy for more info)
EAPI methods
See EAPI commons for the common information about the bus, types, errors and RPC calls.
api_log.get
Description |
Gets log of recent API calls |
Parameters |
required |
Returns |
List of recent API calls |
Name |
Type |
Description |
Required |
t_start |
String/i64 |
Start time |
no |
t_end |
String/i64 |
End time |
no |
user |
String |
Filter by user |
no |
acl |
String |
Filter by ACL ID |
no |
method |
String |
Filter by method |
no |
source |
String |
Filter by source |
no |
code |
i64 |
Filter by code |
no |
success |
bool |
Filter by success/failed |
no |
Return payload example:
[
{
"acl": "admin",
"auth": "token",
"code": 0,
"dt": "2022-05-10T03:43:26+02:00",
"elapsed": 0.023,
"id": "41770402-8154-4d3f-ae49-55fa9b9840b6",
"method": "action.toggle",
"msg": null,
"params": {
"i": "unit:tests/door1"
},
"source": "127.0.0.1",
"t": 1652147006,
"user": "admin"
},
{
"acl": "admin",
"auth": "token",
"code": 0,
"dt": "2022-05-10T03:43:32+02:00",
"elapsed": 0.019,
"id": "6d12a29e-ba5f-4757-a2d3-770641393dd3",
"method": "action.toggle",
"msg": null,
"params": {
"i": "unit:tests/door2"
},
"source": "127.0.0.1",
"t": 1652147012,
"user": "admin"
}
]
authenticate
Description |
Allows other services to directly authenticate users |
Parameters |
required |
Returns |
Serialized ACL |
Name |
Type |
Description |
Required |
key |
String |
API key or a token |
yes |
ip |
String |
IP Address of the client |
no |
Return payload example:
{
"admin": true,
"deny_read": {
"items": [],
"pvt": [],
"rpvt": []
},
"deny_write": {
"items": [],
"pvt": [],
"rpvt": []
},
"from": [
"admin"
],
"id": "admin",
"meta": {
"admin": [
"any"
]
},
"ops": [],
"read": {
"items": [],
"pvt": [],
"rpvt": []
},
"write": {
"items": []
}
}
i18n.cache_purge
Description |
Purges i18n locale cache |
Parameters |
none |
Returns |
nothing |
session.broadcast.reload
Description |
Broadcasts an event to connected clients to reload interface |
Parameters |
none |
Returns |
nothing |
session.broadcast.restart
Description |
Broadcasts an event to connected clients that the server is restarting |
Parameters |
none |
Returns |
nothing |
session.destroy
Description |
Destroys an active user session |
Parameters |
required |
Returns |
nothing |
Name |
Type |
Description |
Required |
i |
String |
Session token ID |
yes |
session.list
Description |
Lists active sessions of logged in users |
Parameters |
none |
Returns |
nothing |
Return payload example:
[
{
"expires_in": 57,
"id": "token:unFdcur2dGUcfA4XgBaEIVqVBFjEi83U",
"mode": "normal",
"source": "127.0.0.1",
"user": "admin"
},
{
"expires_in": 59,
"id": "token:OziFA5Pzb0IndXHmVVy13Sh24BxFW73E",
"mode": "normal",
"source": "127.0.0.1",
"user": "admin"
}
]
tpl.reload
Description |
Reloads server templates |
Parameters |
none |
Returns |
nothing |
user_data.get
Description |
Get user data |
Parameters |
required |
Returns |
User data field value |
Name |
Type |
Description |
Required |
login |
String |
user login |
yes |
key |
String |
field key |
yes |
Return payload example:
{
"value": "somedata"
}
ws.stats
Description |
Gets statistic of connected web sockets |
Parameters |
none |
Returns |
Web socket subscription statistic (struct) |
Return payload example:
{
"clients": 1,
"sub_clients": 1,
"subscriptions": 1
}
HTTP API
Basics
HTTP API requests are performed using JSON RPC 2.0.
If JSON RPC request is called without ID, it means that the server does not need to return a result. In this case, http response with a code 202 Accepted is returned.
JSON RPC API URL:
http://<IP/DOMAIN[:SVC_LISTEN_PORT]>/jrpc
or
http://<IP/DOMAIN[:SVC_LISTEN_PORT]>/
(all POST requests to the root URI are processed as JSON RPC)
EVA ICS v4 included HMI service provides a compact HTTP API, which can be extended with x calls. Administration methods can be called directly via bus calls.
JSON RPC POST requests can alternatively accept API keys/tokens, specified in X-Auth-Key header. It is recommended to avoid such requests as this approach is not compatible with JSON RPC 2.0 standard. Use the header only if there is no option to put the key/token into payload. If the header is set, the parameter “k” in request can be omitted.
JSON RPC payload encoding
Supported encodings are generic JSON and as MessagePack.
To call API methods with MessagePack-encoded payloads, use Content-Type: application/msgpack HTTP request header.
JSON RPC error responses
RPC error codes are equal to EAPI error codes.
Response field “message” may contain additional information about error.
Warning
It is highly not recommended to perform long API calls, calling API functions from JavaScript in a web browser (e.g. giving “w” param to action methods to wait until action finish). The web browser may repeat API call continuously considering them as timed-out, which leads to absolutely unexpected behavior.
JSON RPC via HTTP GET
Embedded equipment sometimes can send HTTP GET requests only. JSON RPC API supports such calls as well.
To make JSON RPC API request with HTTP get, send it to:
http://<IP/DOMAIN>[:SVC_LISTEN_PORT]/jrpc?i=ID&m=METHOD&p=PARAMS
where:
ID request ID (any custom value). If not specified, API response isn’t sent back
METHOD JSON RPC method to call
PARAMS method params, as url-encoded JSON
E.g. the following HTTP GET request will invoke method “test” with request id=1 and params { “k”: “mykey” }:
http://localhost:7727/jrpc?i=1&m=test&p=%7B%22k%22%3A%22mykey%22%7D
Note
JSON RPC API calls via HTTP GET are insecure, limited to 2048 bytes and can not be batch. Use JSON RPC via HTTP POST with JSON or MessagePack payload always when possible.
action
Description |
Executes a unit action |
Parameters |
required |
Returns |
Current result payload |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
i |
String |
Unit OID |
yes |
value |
Any |
Desired unit value |
yes |
priority |
u8 |
Action priority |
no |
wait |
f64 |
Wait max seconds to finish |
no |
note |
String |
a custom note for accounting |
no |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "action",
"params": {
"i": "unit:tests/door",
"k": "secretkey",
"value": 1,
"wait": 1
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "action", "params": {"i": "unit:tests/door", "k": "secretkey", "value": 1, "wait": 1}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "action", "params": {"i": "unit:tests/door", "k": "secretkey", "value": 1, "wait": 1}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "action",
"params": {
"i": "unit:tests/door",
"k": "secretkey",
"value": 1,
"wait": 1
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'action', 'params': {'i': 'unit:tests/door', 'k': 'secretkey', 'value': 1, 'wait': 1}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 575
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"err": null,
"exitcode": 0,
"finished": true,
"node": "mws1",
"oid": "unit:tests/door",
"out": null,
"params": {
"status": 1
},
"priority": 100,
"status": "completed",
"svc": "eva.controller.virtual",
"time": {
"accepted": 1652391907.96199,
"completed": 1652391907.9621937,
"created": 1652391907.9593222
},
"uuid": "b37f15f0-410c-4ded-93d0-2ce744c68e08"
}
}
action.kill
Description |
Attempts to terminate/cancel all scheduled/running actions for the specified item |
Parameters |
required |
Returns |
nothing |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
i |
String |
Item OID |
yes |
note |
String |
a custom note for accounting |
no |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "action.kill",
"params": {
"i": "unit:tests/door",
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "action.kill", "params": {"i": "unit:tests/door", "k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "action.kill", "params": {"i": "unit:tests/door", "k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "action.kill",
"params": {
"i": "unit:tests/door",
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'action.kill', 'params': {'i': 'unit:tests/door', 'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 67
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"ok": true
}
}
action.result
Description |
Gets current action result |
Parameters |
required |
Returns |
Current result payload |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
u |
String |
Action UUID |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "action.result",
"params": {
"k": "secretkey",
"u": "b37f15f0-410c-4ded-93d0-2ce744c68e08"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "action.result", "params": {"k": "secretkey", "u": "b37f15f0-410c-4ded-93d0-2ce744c68e08"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "action.result", "params": {"k": "secretkey", "u": "b37f15f0-410c-4ded-93d0-2ce744c68e08"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "action.result",
"params": {
"k": "secretkey",
"u": "b37f15f0-410c-4ded-93d0-2ce744c68e08"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'action.result', 'params': {'k': 'secretkey', 'u': 'b37f15f0-410c-4ded-93d0-2ce744c68e08'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 575
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"err": null,
"exitcode": 0,
"finished": true,
"node": "mws1",
"oid": "unit:tests/door",
"out": null,
"params": {
"status": 1
},
"priority": 100,
"status": "completed",
"svc": "eva.controller.virtual",
"time": {
"accepted": 1652391907.96199,
"completed": 1652391907.9621937,
"created": 1652391907.9593222
},
"uuid": "b37f15f0-410c-4ded-93d0-2ce744c68e08"
}
}
action.terminate
Description |
Attempts to terminate/cancel an action |
Parameters |
required |
Returns |
nothing |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
u |
String |
Action UUID |
yes |
note |
String |
a custom note for accounting |
no |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "action.terminate",
"params": {
"k": "secretkey",
"u": "b37f15f0-410c-4ded-93d0-2ce744c68e08"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "action.terminate", "params": {"k": "secretkey", "u": "b37f15f0-410c-4ded-93d0-2ce744c68e08"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "action.terminate", "params": {"k": "secretkey", "u": "b37f15f0-410c-4ded-93d0-2ce744c68e08"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "action.terminate",
"params": {
"k": "secretkey",
"u": "b37f15f0-410c-4ded-93d0-2ce744c68e08"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'action.terminate', 'params': {'k': 'secretkey', 'u': 'b37f15f0-410c-4ded-93d0-2ce744c68e08'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 67
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"ok": true
}
}
action.toggle
Description |
Executes a unit status-toggle action |
Parameters |
required |
Returns |
Current result payload |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
i |
String |
Unit OID |
yes |
priority |
u8 |
Action priority |
no |
wait |
f64 |
Wait max seconds to finish |
no |
note |
String |
a custom note for accounting |
no |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "action.toggle",
"params": {
"i": "unit:tests/door",
"k": "secretkey",
"wait": 1
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "action.toggle", "params": {"i": "unit:tests/door", "k": "secretkey", "wait": 1}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "action.toggle", "params": {"i": "unit:tests/door", "k": "secretkey", "wait": 1}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "action.toggle",
"params": {
"i": "unit:tests/door",
"k": "secretkey",
"wait": 1
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'action.toggle', 'params': {'i': 'unit:tests/door', 'k': 'secretkey', 'wait': 1}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 575
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"err": null,
"exitcode": 0,
"finished": true,
"node": "mws1",
"oid": "unit:tests/door",
"out": null,
"params": {
"status": 1
},
"priority": 100,
"status": "completed",
"svc": "eva.controller.virtual",
"time": {
"accepted": 1652391907.96199,
"completed": 1652391907.9621937,
"created": 1652391907.9593222
},
"uuid": "b37f15f0-410c-4ded-93d0-2ce744c68e08"
}
}
api_log.get
Description |
Gets log of recent API calls (requires ACL op “moderator”) |
Parameters |
required |
Returns |
List of recent API calls |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
t_start |
String/i64 |
Start time |
no |
t_end |
String/i64 |
End time |
no |
user |
String |
Filter by user (requires admin access) |
no |
acl |
String |
Filter by ACL ID |
no |
method |
String |
Filter by method |
no |
source |
String |
Filter by source |
no |
code |
i64 |
Filter by code |
no |
success |
bool |
Filter by success/failed |
no |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "api_log.get",
"params": {
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "api_log.get", "params": {"k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "api_log.get", "params": {"k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "api_log.get",
"params": {
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'api_log.get', 'params': {'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 67
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"ok": true
}
}
bus::<TARGET_SVC>::<METHOD>
Description |
Calls any bus method (requires admin ACL) |
Parameters |
Sent as-is to the target service, except “k” |
Returns |
The target service reply as-is |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "bus::eva.repl.1::node.get",
"params": {
"i": "rtest1",
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "bus::eva.repl.1::node.get", "params": {"i": "rtest1", "k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "bus::eva.repl.1::node.get", "params": {"i": "rtest1", "k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "bus::eva.repl.1::node.get",
"params": {
"i": "rtest1",
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'bus::eva.repl.1::node.get', 'params': {'i': 'rtest1', 'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 394
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"build": 2022051001,
"compress": true,
"enabled": true,
"link_uptime": 1897.710214411,
"managed": true,
"name": "rtest1",
"online": true,
"ping_interval": 1.0,
"reload_interval": 60.0,
"static": true,
"timeout": 30.0,
"version": "4.0.0"
}
}
call
Description |
Call any HMI method using a string query |
Parameters |
required |
Returns |
The result of the target method |
Allows to call any HTTP method using a string query
E.g.
item.state_history sensor:tests/temp fill=10T xopts.retention=daily
The first unnamed parameter goes to “i”. If an array is required, a value must be comma-separated, e.g. key=1,2,3 (for 1-item array key=1,). Keys with dots are formatted as maps (max one level allowed).
The method should be used in human-interactive environments only.
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
q |
String |
Call query |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "call",
"params": {
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "call", "params": {"k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "call", "params": {"k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "call",
"params": {
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'call', 'params': {'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 67
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"ok": true
}
}
db.list
Description |
Get available databases |
Parameters |
required |
Returns |
List of available databases |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "db.list",
"params": {
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "db.list", "params": {"k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "db.list", "params": {"k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "db.list",
"params": {
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'db.list', 'params': {'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 226
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": [
{
"default": true,
"id": "default"
},
{
"default": false,
"id": "i2"
},
{
"default": false,
"id": "pg"
}
}
dobj.generate_struct_code
Description |
Generate data object structure code |
Parameters |
required |
Returns |
Data object structure code |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
i |
String/Vec<String> |
Data object name(s) |
yes |
lang |
String |
Language (“rust”, “c”) |
yes |
config |
Any |
A specific language generator configuration |
no |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "dobj.generate_struct_code",
"params": {
"i": [
"Env",
"PlantEnv"
],
"k": "secretkey",
"lang": "c"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "dobj.generate_struct_code", "params": {"i": ["Env", "PlantEnv"], "k": "secretkey", "lang": "c"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "dobj.generate_struct_code", "params": {"i": ["Env", "PlantEnv"], "k": "secretkey", "lang": "c"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "dobj.generate_struct_code",
"params": {
"i": [
"Env",
"PlantEnv"
],
"k": "secretkey",
"lang": "c"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'dobj.generate_struct_code', 'params': {'i': ['Env', 'PlantEnv'], 'k': 'secretkey', 'lang': 'c'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 318
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"code": "#[derive(Clone, Debug)]\n#[binrw]\n#[brw(little)]\nstruct test {\n value2: u16,\n value_s1: i16,\n subpayload: sub1,\n}\n\n#[derive(Clone, Debug)]\n#[binrw]\n#[brw(little)]\nstruct Env {\n temp: [f64; 2],\n hum: f64,\n pressure: f64,\n}\n"
}
}
dobj.get_struct
Description |
Get data object structure |
Parameters |
required |
Returns |
Data object structure |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
i |
String |
Data object name |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "dobj.get_struct",
"params": {
"i": "test",
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "dobj.get_struct", "params": {"i": "test", "k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "dobj.get_struct", "params": {"i": "test", "k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "dobj.get_struct",
"params": {
"i": "test",
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'dobj.get_struct', 'params': {'i': 'test', 'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 370
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"fields": [
{
"name": "value2",
"type": "u16"
},
{
"name": "value_s1",
"oid": "sensor:tests/s1",
"type": "i16"
},
{
"name": "subpayload",
"type": "sub1"
}
],
"name": "test"
}
}
dobj.list
Description |
Get list of data objects |
Parameters |
required |
Returns |
List of data objects |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "dobj.list",
"params": {
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "dobj.list", "params": {"k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "dobj.list", "params": {"k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "dobj.list",
"params": {
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'dobj.list', 'params': {'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 276
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": [
{
"name": "Env",
"size": 24
},
{
"name": "sub1",
"size": 8
},
{
"name": "test",
"size": 12
},
{
"name": "xstruct",
"size": 2
}
]
}
item.check_access
Description |
Check read/write access for a single or multiple items |
Parameters |
required |
Returns |
Map OID/access |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
i |
Vec<String>/String |
Item OID(s) or masks |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "item.check_access",
"params": {
"i": "unit:tests/u1",
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "item.check_access", "params": {"i": "unit:tests/u1", "k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "item.check_access", "params": {"i": "unit:tests/u1", "k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "item.check_access",
"params": {
"i": "unit:tests/u1",
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'item.check_access', 'params': {'i': 'unit:tests/u1', 'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 143
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"unit:tests/u1": {
"r": true,
"w": true
}
}
}
item.state
Description |
Gets state of item(s) |
Parameters |
required |
Returns |
List of item states |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
i |
Vec<String>/String |
Item OID(s) or masks |
no |
full |
bool |
Full state (enabled + meta) |
no |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "item.state",
"params": {
"full": true,
"i": "sensor:#",
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "item.state", "params": {"full": true, "i": "sensor:#", "k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "item.state", "params": {"full": true, "i": "sensor:#", "k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "item.state",
"params": {
"full": true,
"i": "sensor:#",
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'item.state', 'params': {'full': True, 'i': 'sensor:#', 'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 653
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": [
{
"connected": true,
"ieid": [
1796,
509854682016335
],
"node": "mws1",
"oid": "sensor:env/temp",
"status": 1,
"t": 1649733900.9208307,
"value": 5
},
{
"connected": true,
"ieid": [
2185,
20759006408168
],
"node": "mws1",
"oid": "sensor:tests/test1",
"status": 1,
"t": 1652387199.1481013,
"value": 91.0
}
]
}
item.state_history
Description |
Gets state history for item(s) |
Parameters |
required |
Returns |
State history payload |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
i |
Vec<String>/String |
Item OID(s) |
yes |
t_start |
f64/String |
Beginning timestamp (default: last 24 hours) |
no |
t_end |
f64/String |
Ending timestamp (default: now) |
no |
fill |
String |
Fill (nS/T/H/D/W e.g. 10T for 10-minute or nA for n records) + optional [:precision] |
no |
limit |
u32 |
Limit records to |
no |
prop |
String |
Fetch the state property status or value only |
no |
xopts |
Map<String, String> |
Extra options, depending on database type |
no |
database |
String |
DB svc to get history from, w/o “eva.db.” pfx (def: specified in default_db) |
no |
output_format |
String |
“list” or “dict” |
no |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "item.state_history",
"params": {
"fill": "5T:2",
"i": "sensor:env/temp",
"k": "secretkey",
"t_start": 1652387700
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "item.state_history", "params": {"fill": "5T:2", "i": "sensor:env/temp", "k": "secretkey", "t_start": 1652387700}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "item.state_history", "params": {"fill": "5T:2", "i": "sensor:env/temp", "k": "secretkey", "t_start": 1652387700}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "item.state_history",
"params": {
"fill": "5T:2",
"i": "sensor:env/temp",
"k": "secretkey",
"t_start": 1652387700
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'item.state_history', 'params': {'fill': '5T:2', 'i': 'sensor:env/temp', 'k': 'secretkey', 't_start': 1652387700}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 312
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"status": [
1,
1,
1
],
"t": [
1652387700.0,
1652388000.0,
1652388300.0
],
"value": [
5,
5,
5
]
}
}
item.state_log
Description |
Gets state log for item(s) |
Parameters |
required |
Returns |
State log payload |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
i |
String |
Item OID/Mask |
yes |
t_start |
f64/String |
Beginning timestamp (default: last 24 hours) |
no |
t_end/String |
f64 |
Ending timestamp (default: now) |
no |
limit |
u32 |
Limit records to |
no |
xopts |
Map<String, String> |
Extra options, depending on database type |
no |
database |
String |
DB svc to get history from, w/o “eva.db.” pfx (def: specified in default_db) |
no |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "item.state_log",
"params": {
"i": "sensor:env/temp",
"k": "secretkey",
"t_start": 1652387700
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "item.state_log", "params": {"i": "sensor:env/temp", "k": "secretkey", "t_start": 1652387700}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "item.state_log", "params": {"i": "sensor:env/temp", "k": "secretkey", "t_start": 1652387700}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "item.state_log",
"params": {
"i": "sensor:env/temp",
"k": "secretkey",
"t_start": 1652387700
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'item.state_log', 'params': {'i': 'sensor:env/temp', 'k': 'secretkey', 't_start': 1652387700}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 489
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": [
{
"oid": "sensor:env/temp",
"status": 1,
"t": 1652387838.5007,
"value": 5
},
{
"oid": "sensor:env/temp",
"status": 1,
"t": 1652387843.5008562,
"value": 5
},
{
"oid": "sensor:env/temp",
"status": 1,
"t": 1652387848.5038078,
"value": 5
}
]
}
log.get
Description |
Gets memory logger log records, requires log allow in ACL |
Parameters |
required |
Returns |
List of log records |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
level |
String/u8 |
Log level (trace, debug, info, warn, error) |
no |
time |
u32 |
Recent entries, N seconds before now |
no |
limit |
u32 |
Limit records to |
no |
module |
String |
Filter by module |
no |
rx |
String |
Filter by regex in message |
no |
msg |
String |
message filter substring |
no |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "log.get",
"params": {
"k": "secretkey",
"level": "info",
"module": "eva::svc",
"rx": "starting.*",
"time": 60
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "log.get", "params": {"k": "secretkey", "level": "info", "module": "eva::svc", "rx": "starting.*", "time": 60}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "log.get", "params": {"k": "secretkey", "level": "info", "module": "eva::svc", "rx": "starting.*", "time": 60}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "log.get",
"params": {
"k": "secretkey",
"level": "info",
"module": "eva::svc",
"rx": "starting.*",
"time": 60
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'log.get', 'params': {'k': 'secretkey', 'level': 'info', 'module': 'eva::svc', 'rx': 'starting.*', 'time': 60}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 677
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": [
{
"dt": "2022-05-12T23:06:05.965+02:00",
"h": "mws1",
"l": 20,
"lvl": "info",
"mod": "eva::svc",
"msg": "eva.controller.eip starting puller #2, interval: 1s",
"t": 1652389565.965001,
"th": null
},
{
"dt": "2022-05-12T23:06:05.965+02:00",
"h": "mws1",
"l": 20,
"lvl": "info",
"mod": "eva::svc",
"msg": "eva.controller.eip starting puller #1, interval: 1s",
"t": 1652389565.96536,
"th": null
}
]
}
login
Description |
Login and obtain session token (read-write) |
Parameters |
required |
Returns |
Token information payload |
if no params are given, the method attempts to login user using basic auth or x-auth-key header
if k parameter is given, the method attempts to authenticate API key and create a temporary token for it. In ACI and API call logs requests are marked as user=.key_id
if user and password are set, the method attempts to login user using the provided credentials
if token is set, the method returns token information
if both user, password and token are set, the method switches the token in read-write mode
Name |
Type |
Description |
Required |
user |
String |
User login |
no |
password |
String |
User password (plain) |
no |
token |
String |
User token |
no |
k |
String |
API key |
no |
xopts |
Map<String, Any> |
Extra auth ptions |
no |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "login",
"params": {
"password": "secret",
"user": "admin"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "login", "params": {"password": "secret", "user": "admin"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "login", "params": {"password": "secret", "user": "admin"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "login",
"params": {
"password": "secret",
"user": "admin"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'login', 'params': {'password': 'secret', 'user': 'admin'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 220
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"acl": "admin",
"api_version": 4,
"mode": "normal",
"token": "token:1oeb5vHbLTTABBg2DfoueSHl9kT3ZPm6",
"user": "admin"
}
}
logout
Description |
Ends the user session and destroys the token |
Parameters |
required |
Returns |
always no error, even if the token does not exist |
Name |
Type |
Description |
Required |
token |
String |
User token |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "logout",
"params": {
"token": "token:1oeb5vHbLTTABBg2DfoueSHl9kT3ZPm6"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "logout", "params": {"token": "token:1oeb5vHbLTTABBg2DfoueSHl9kT3ZPm6"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "logout", "params": {"token": "token:1oeb5vHbLTTABBg2DfoueSHl9kT3ZPm6"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "logout",
"params": {
"token": "token:1oeb5vHbLTTABBg2DfoueSHl9kT3ZPm6"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'logout', 'params': {'token': 'token:1oeb5vHbLTTABBg2DfoueSHl9kT3ZPm6'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 67
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"ok": true
}
}
lvar.clear
Description |
Sets lvar status to 0 |
Parameters |
required |
Returns |
nothing |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
i |
String |
Lvar OID |
yes |
note |
String |
a custom note for accounting |
no |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "lvar.clear",
"params": {
"i": "lvar:tests/v1",
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "lvar.clear", "params": {"i": "lvar:tests/v1", "k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "lvar.clear", "params": {"i": "lvar:tests/v1", "k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "lvar.clear",
"params": {
"i": "lvar:tests/v1",
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'lvar.clear', 'params': {'i': 'lvar:tests/v1', 'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 67
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"ok": true
}
}
lvar.decr
Description |
Decrements lvar value by 1 |
Parameters |
required |
Returns |
New lvar value |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
i |
String |
Lvar OID |
yes |
note |
String |
a custom note for accounting |
no |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "lvar.decr",
"params": {
"i": "lvar:tests/v1",
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "lvar.decr", "params": {"i": "lvar:tests/v1", "k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "lvar.decr", "params": {"i": "lvar:tests/v1", "k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "lvar.decr",
"params": {
"i": "lvar:tests/v1",
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'lvar.decr', 'params': {'i': 'lvar:tests/v1', 'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 55
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": 0
}
lvar.incr
Description |
Increments lvar value by 1 |
Parameters |
required |
Returns |
New lvar value |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
i |
String |
Lvar OID |
yes |
note |
String |
a custom note for accounting |
no |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "lvar.incr",
"params": {
"i": "lvar:tests/v1",
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "lvar.incr", "params": {"i": "lvar:tests/v1", "k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "lvar.incr", "params": {"i": "lvar:tests/v1", "k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "lvar.incr",
"params": {
"i": "lvar:tests/v1",
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'lvar.incr', 'params': {'i': 'lvar:tests/v1', 'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 55
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": 1
}
lvar.reset
Description |
Sets lvar status to 1 |
Parameters |
required |
Returns |
nothing |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
i |
String |
Lvar OID |
yes |
note |
String |
a custom note for accounting |
no |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "lvar.reset",
"params": {
"i": "lvar:tests/v1",
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "lvar.reset", "params": {"i": "lvar:tests/v1", "k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "lvar.reset", "params": {"i": "lvar:tests/v1", "k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "lvar.reset",
"params": {
"i": "lvar:tests/v1",
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'lvar.reset', 'params': {'i': 'lvar:tests/v1', 'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 67
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"ok": true
}
}
lvar.set
Description |
Sets lvar status/value |
Parameters |
required |
Returns |
nothing |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
i |
String |
Lvar OID |
yes |
status |
i16 |
Desired status |
no |
value |
Any |
Desired value |
no |
note |
String |
a custom note for accounting |
no |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "lvar.set",
"params": {
"i": "lvar:tests/v1",
"k": "secretkey",
"status": 1,
"value": "TEST"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "lvar.set", "params": {"i": "lvar:tests/v1", "k": "secretkey", "status": 1, "value": "TEST"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "lvar.set", "params": {"i": "lvar:tests/v1", "k": "secretkey", "status": 1, "value": "TEST"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "lvar.set",
"params": {
"i": "lvar:tests/v1",
"k": "secretkey",
"status": 1,
"value": "TEST"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'lvar.set', 'params': {'i': 'lvar:tests/v1', 'k': 'secretkey', 'status': 1, 'value': 'TEST'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 67
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"ok": true
}
}
lvar.toggle
Description |
Toggles lvar status between 0 and 1 |
Parameters |
required |
Returns |
nothing |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
i |
String |
Lvar OID |
yes |
note |
String |
a custom note for accounting |
no |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "lvar.toggle",
"params": {
"i": "lvar:tests/v1",
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "lvar.toggle", "params": {"i": "lvar:tests/v1", "k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "lvar.toggle", "params": {"i": "lvar:tests/v1", "k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "lvar.toggle",
"params": {
"i": "lvar:tests/v1",
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'lvar.toggle', 'params': {'i': 'lvar:tests/v1', 'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 67
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"ok": true
}
}
ping
Description |
Pings the back-end, prolongs the session |
Parameters |
required |
Returns |
Nothing |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "ping",
"params": {
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "ping", "params": {"k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "ping", "params": {"k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "ping",
"params": {
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'ping', 'params': {'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 58
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": null
}
profile.get_field
Description |
Set user profile field |
Parameters |
required |
Returns |
nothing |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
field |
String |
Field name (email) |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "profile.get_field",
"params": {
"field": "email",
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "profile.get_field", "params": {"field": "email", "k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "profile.get_field", "params": {"field": "email", "k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "profile.get_field",
"params": {
"field": "email",
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'profile.get_field', 'params': {'field': 'email', 'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 123
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"readonly": false,
"value": "admin@localhost"
}
}
profile.set_field
Description |
Set user profile field |
Parameters |
required |
Returns |
nothing |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
field |
String |
Field name (email) |
yes |
value |
Any |
Field value |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "profile.set_field",
"params": {
"field": "email",
"k": "secretkey",
"value": "admin@localhost"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "profile.set_field", "params": {"field": "email", "k": "secretkey", "value": "admin@localhost"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "profile.set_field", "params": {"field": "email", "k": "secretkey", "value": "admin@localhost"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "profile.set_field",
"params": {
"field": "email",
"k": "secretkey",
"value": "admin@localhost"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'profile.set_field', 'params': {'field': 'email', 'k': 'secretkey', 'value': 'admin@localhost'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 67
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"ok": true
}
}
pvt.get
Description |
Get contents of a file in pvt (text) |
Parameters |
required |
Returns |
File content |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
path |
String |
Relative path |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "pvt.get",
"params": {
"k": "secretkey",
"path": "vendored-apps/file1.json"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "pvt.get", "params": {"k": "secretkey", "path": "vendored-apps/file1.json"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "pvt.get", "params": {"k": "secretkey", "path": "vendored-apps/file1.json"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "pvt.get",
"params": {
"k": "secretkey",
"path": "vendored-apps/file1.json"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'pvt.get', 'params': {'k': 'secretkey', 'path': 'vendored-apps/file1.json'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 88
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"content": "hello"
}
}
pvt.list
Description |
List entries in pvt |
Parameters |
required |
Returns |
List of available files and folders |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
path |
String |
Relative path |
yes |
masks |
String/Vec<String> |
file masks |
no |
kind |
String |
file, dir or any |
no |
recursive |
bool |
recursive listing |
no |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "pvt.list",
"params": {
"k": "secretkey",
"path": "vendored-apps"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "pvt.list", "params": {"k": "secretkey", "path": "vendored-apps"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "pvt.list", "params": {"k": "secretkey", "path": "vendored-apps"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "pvt.list",
"params": {
"k": "secretkey",
"path": "vendored-apps"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'pvt.list', 'params': {'k': 'secretkey', 'path': 'vendored-apps'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 505
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": [
{
"kind": "dir",
"path": "vendored-apps/opcentre/idc"
},
{
"kind": "dir",
"path": "vendored-apps/opcentre/idc/dashboards"
},
{
"kind": "file",
"path": "vendored-apps/opcentre/idc/dashboards/test2.json"
},
{
"kind": "file",
"path": "vendored-apps/opcentre/idc/dashboards/test3.json"
}
]
}
pvt.put
Description |
Puts contents of a file in pvt (text) |
Parameters |
required |
Returns |
nothing |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
path |
String |
Relative path |
yes |
content |
String |
File content |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "pvt.put",
"params": {
"content": "hello",
"k": "secretkey",
"path": "vendored-apps/file1.json"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "pvt.put", "params": {"content": "hello", "k": "secretkey", "path": "vendored-apps/file1.json"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "pvt.put", "params": {"content": "hello", "k": "secretkey", "path": "vendored-apps/file1.json"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "pvt.put",
"params": {
"content": "hello",
"k": "secretkey",
"path": "vendored-apps/file1.json"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'pvt.put', 'params': {'content': 'hello', 'k': 'secretkey', 'path': 'vendored-apps/file1.json'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 67
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"ok": true
}
}
pvt.unlink
Description |
Deletes a file in pvt |
Parameters |
required |
Returns |
nothing |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
path |
String |
Relative path |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "pvt.unlink",
"params": {
"k": "secretkey",
"path": "vendored-apps/file1.json"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "pvt.unlink", "params": {"k": "secretkey", "path": "vendored-apps/file1.json"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "pvt.unlink", "params": {"k": "secretkey", "path": "vendored-apps/file1.json"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "pvt.unlink",
"params": {
"k": "secretkey",
"path": "vendored-apps/file1.json"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'pvt.unlink', 'params': {'k': 'secretkey', 'path': 'vendored-apps/file1.json'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 67
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"ok": true
}
}
run
Description |
Executes a lmacro action |
Parameters |
required |
Returns |
Current result payload |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
i |
String |
Lmacro OID |
yes |
args |
Vec<Any> |
Arguments |
no |
kwargs |
Map<String, Any> |
Keyword arguments |
no |
priority |
u8 |
Action priority |
no |
wait |
f64 |
Wait max seconds to finish |
no |
note |
String |
a custom note for accounting |
no |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "run",
"params": {
"i": "lmacro:tests/m1",
"k": "secretkey",
"kwargs": {
"a": 123
},
"wait": 2
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "run", "params": {"i": "lmacro:tests/m1", "k": "secretkey", "kwargs": {"a": 123}, "wait": 2}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "run", "params": {"i": "lmacro:tests/m1", "k": "secretkey", "kwargs": {"a": 123}, "wait": 2}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "run",
"params": {
"i": "lmacro:tests/m1",
"k": "secretkey",
"kwargs": {
"a": 123
},
"wait": 2
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'run', 'params': {'i': 'lmacro:tests/m1', 'k': 'secretkey', 'kwargs': {'a': 123}, 'wait': 2}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 694
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"err": null,
"exitcode": 0,
"finished": true,
"node": "mws1",
"oid": "lmacro:tests/m1",
"out": null,
"params": {
"kwargs": {
"a": 123
}
},
"priority": 100,
"status": "completed",
"svc": "eva.controller.py",
"time": {
"accepted": 1652392370.5245202,
"completed": 1652392370.524651,
"created": 1652392370.5234292,
"pending": 1652392370.524566,
"running": 1652392370.524599
},
"uuid": "3c0354e6-dfc6-4e3e-96a4-e4f5e4471da6"
}
}
session.list_neighbors
Description |
List all logged in users (if allowed) |
Parameters |
required |
Returns |
List of logged in users |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "session.list_neighbors",
"params": {
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "session.list_neighbors", "params": {"k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "session.list_neighbors", "params": {"k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "session.list_neighbors",
"params": {
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'session.list_neighbors', 'params': {'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 274
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": [
{
"acl": "admin",
"mode": "normal",
"u": "admin"
},
{
"acl": "operator",
"mode": "normal",
"u": "operator"
}
]
}
session.set_readonly
Description |
Set the current session token read-only |
Parameters |
required |
Returns |
nothing |
To switch back to normal (read/write) session, either call “login” method to create a new session, or call it with user+password+a params to keep the current one.
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "session.set_readonly",
"params": {
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "session.set_readonly", "params": {"k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "session.set_readonly", "params": {"k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "session.set_readonly",
"params": {
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'session.set_readonly', 'params': {'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 171
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"acl": "admin",
"mode": "readonly",
"token": "token:6SngcQsYtHSAESOzCuyJebvoAYB3ZBlp"
}
}
set_password
Description |
Changes the current password (user must be logged in and session token used) |
Parameters |
required |
Returns |
if the password has been changed, the session is dropped and the user must re-login |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
current_password |
String |
Current user’s password |
yes |
password |
String |
New user’s password |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "set_password",
"params": {
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "set_password", "params": {"k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "set_password", "params": {"k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "set_password",
"params": {
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'set_password', 'params': {'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 67
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"ok": true
}
}
test
Description |
Tests the node and HMI svc, returns system info |
Parameters |
required |
Returns |
System info (struct) |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "test",
"params": {
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "test", "params": {"k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "test", "params": {"k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "test",
"params": {
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'test', 'params': {'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 935
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"aci": {
"acl": "admin",
"auth": "token",
"token_mode": "normal",
"u": "admin"
},
"acl": {
"admin": true,
"deny": {
"items": [],
"pvt": [],
"rpvt": []
},
"from": [
"admin"
],
"id": "admin",
"ops": [],
"read": {
"items": [],
"pvt": [],
"rpvt": []
},
"write": {
"items": []
}
},
"build": 2022051001,
"ok": true,
"product_code": "eva4node",
"product_name": "EVA ICS node server",
"system_name": "mws1",
"time": 1652312576.585399,
"uptime": 795.01865705,
"version": "4.0.0"
}
}
user_data.delete
Description |
Delete user data |
Parameters |
required |
Returns |
nothing |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
key |
String |
field key |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "user_data.delete",
"params": {
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "user_data.delete", "params": {"k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "user_data.delete", "params": {"k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "user_data.delete",
"params": {
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'user_data.delete', 'params': {'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 67
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"ok": true
}
}
user_data.get
Description |
Get user data |
Parameters |
required |
Returns |
User data field value |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
key |
String |
field key |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "user_data.get",
"params": {
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "user_data.get", "params": {"k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "user_data.get", "params": {"k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "user_data.get",
"params": {
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'user_data.get', 'params': {'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 87
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"value": "somedata"
}
}
user_data.set
Description |
Set user data |
Parameters |
required |
Returns |
nothing |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
key |
String |
field key |
yes |
value |
any |
field value |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "user_data.set",
"params": {
"k": "secretkey"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "user_data.set", "params": {"k": "secretkey"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "user_data.set", "params": {"k": "secretkey"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "user_data.set",
"params": {
"k": "secretkey"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'user_data.set', 'params': {'k': 'secretkey'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 67
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"ok": true
}
}
x::<TARGET_SVC>::<METHOD>
Description |
Calls “x” service method |
Parameters |
Sent as-is to the target service, except “k” |
Returns |
nothing |
Allows to extend HTTP API with custom functions.
Similar to the admin bus call, but does not check ACL/permissions. The target service MUST implement “x” EAPI method and check ACL/permissions by itself.
The target service gets the following parameters payload:
Name |
Type |
Description |
|---|---|---|
method |
String |
sub-method |
params |
Any |
call params as-is, except “k” |
aci |
Struct |
call ACI |
acl |
Struct |
call ACL |
Name |
Type |
Description |
Required |
k |
String |
valid API key/token |
yes |
http
POST /jrpc HTTP/1.1
accept: application/json
content-type: application/json
host: localhost:7727
{
"id": 1,
"jsonrpc": "2.0",
"method": "x::eva.svc.mysvc::hello",
"params": {
"k": "secretkey",
"param1": "value1"
}
}
curl
curl -i -X POST http://localhost:7727/jrpc -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"id": 1, "jsonrpc": "2.0", "method": "x::eva.svc.mysvc::hello", "params": {"k": "secretkey", "param1": "value1"}}'
wget
wget -S -O- http://localhost:7727/jrpc --header="Accept: application/json" --header="Content-Type: application/json" --post-data='{"id": 1, "jsonrpc": "2.0", "method": "x::eva.svc.mysvc::hello", "params": {"k": "secretkey", "param1": "value1"}}'
httpie
echo '{
"id": 1,
"jsonrpc": "2.0",
"method": "x::eva.svc.mysvc::hello",
"params": {
"k": "secretkey",
"param1": "value1"
}
}' | http POST http://localhost:7727/jrpc Accept:application/json Content-Type:application/json
python-requests
requests.post('http://localhost:7727/jrpc', headers={'Accept': 'application/json', 'Content-Type': 'application/json'}, json={'id': 1, 'jsonrpc': '2.0', 'method': 'x::eva.svc.mysvc::hello', 'params': {'k': 'secretkey', 'param1': 'value1'}})
response
HTTP/1.1 200 OK
cache-control: no-cache, no-store
content-length: 64
content-type: application/json
date: Thu, 13 Aug 2021 00:00:00 GMT
expires: 0
pragma: no-cache
{
"id": 1,
"jsonrpc": "2.0",
"result": "hi there"
}
Web socket methods
Web socket method can be executed using a web socket, connected to:
ws://<IP/DOMAIN>[:SVC_LISTEN_PORT]/ws?PARAMS
Query string parameters:
Name |
Value |
Required |
|---|---|---|
k |
yes |
|
buf_ttl |
seconds (float), group send state events and send them in bulk |
no |
state |
OID masks, comma separated (automatically subscribe to state events) |
no |
initial |
1/true. Send initial states of subscribed items |
no |
The API key/session token can be optionally sent in “X-Auth-Key” HTTP header.
Web socket methods provide one-way RPC calls with no returns. If a method returns a value, it means that the value is “ordered” and can be returned any time when processed.
The web socket RPC payload MUST be JSON-encoded and contains the following fields:
Field |
Type |
Description |
Required |
method |
String |
method name |
yes |
params |
Any |
parameters |
no |
Example:
{
"method": "subscribe.state",
"params": ["#"]
}
bye
Description |
Closes the session |
Parameters |
none |
Returns |
nothing |
ping
Description |
Manually pings the server |
Parameters |
none |
Returns |
{s:”pong”} |
subscribe.log
Description |
Subscribes to log events |
Parameters |
u8 (20 = info, 30 = warn, 40 = error) |
Returns |
nothing |
subscribe.state
Description |
Subscribes to item state events |
Parameters |
Vec<OID/OIDMask(String)> |
Returns |
nothing |
subscribe.state_initial
Description |
Subscribes to item state events and request initial states |
Parameters |
Vec<OID/OIDMask(String)> |
Returns |
nothing |
unsubscribe.state
Description |
Unsubscribe from all item state events |
Parameters |
none |
Returns |
nothing |
Events
After connecting, the web socket receives event payloads in the following format:
Field |
Type |
Description |
s |
String |
Event subject |
d |
Any |
Event data |
The service can send events with the following subjects:
state a state event, data contains one or multiple (list) item states
pong ping-reply events, data contains nothing
reload reload event, the server asks clients to reload interfaces
server other server events, determined by data field:
restart server is going to be restarted soon
Note
Log events are collected from the local IPC bus. To let web sockets subscribe and receive log messages, a core bus logger MUST be configured.
The service allows subscribing to log levels info and above.