/lua

This service provides access to Lua-script related information.

Get /lua

SecurityApiKey

Request

query Parameters

max-depth	integer >= 1 Limit output depth of the response. See Max-Depth. Example: max-depth=2
filter	string Response filter string. See Filter-Spec. Example: filter={foo,bar}

Responses

200

Normal response.

401

Unauthorized response.

get/lua

Request samples

curl
Python
JavaScript
Go

Response samples

application/json

{"result": {"var": {"sob_Grid-RD": {"value": "1677697200",
"desc": "Start of the current billing interval."
},
"kwh_sob_Grid-RD": {"value": "0",
"desc": "Accumulated kWh for billing period."
}
}
}
}

Replace /lua

SecurityApiKey

Request

Request Body schema: application/json

object (luaVar)

The persistent Lua variables. Such variables are non-volatile. That is, their value is preserved across script restarts and reboots (power-cycles). Persistent variables can be created and manipulated with the built-in Lua module persistent.

Responses

200

Normal response.

401

Unauthorized response.

put/lua

Request samples

Payload
curl
Python
JavaScript
Go

application/json

{ }

Response samples

application/json

{"status": "OK",
"error": "Error message (present if an error occurred)."
}

Update /lua

SecurityApiKey

Request

Request Body schema: application/json

object (luaVar)

Responses

200

Normal response.

401

Unauthorized response.

post/lua

Request samples

Payload
curl
Python
JavaScript
Go

application/json

{ }

Response samples

application/json

{"status": "OK",
"error": "Error message (present if an error occurred)."
}

Delete /lua

Reset to default.

SecurityApiKey

Responses

200

Normal response.

401

Unauthorized response.

delete/lua

Request samples

curl
Python
JavaScript
Go

Response samples

application/json

{"status": "OK",
"error": "Error message (present if an error occurred)."
}

➔ Next to /lua/var