Powered by Redocly

/lua/var

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.

Get /lua/var

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/var
Request samples 
Response samples 
application/json
{
  • "result": {
    }
}
Replace /lua/var
SecurityApiKey 
Request 
Request Body schema: application/json
additional property
object (luaVarName) 
A persistent Lua variable.


 
Responses 
200
Normal response.


401
Unauthorized response.


put/lua/var
Request samples 
application/json
{
  • "name1": {
    },
  • "name2": {
    }
}
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /lua/var
SecurityApiKey 
Request 
Request Body schema: application/json
additional property
object (luaVarName) 
A persistent Lua variable.


 
Responses 
200
Normal response.


401
Unauthorized response.


post/lua/var
Request samples 
application/json
{
  • "name1": {
    },
  • "name2": {
    }
}
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Delete /lua/var
Reset to default. See the descriptions of the individual endpoints for their default values.  Commonly, arrays and strings are cleared to empty, numbers are cleared to 0, and booleans are cleared to false.  


SecurityApiKey 
Responses 
200
Normal response.


401
Unauthorized response.


delete/lua/var
Request samples 
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
➔ Next to /lua/var/{name}