/config/lua/script

Lua scripts.

Get /config/lua/script

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/config/lua/script

Request samples

curl
Python
JavaScript
Go

Response samples

application/json

{"result": {"alertd": "print(\"this is the alert script\");",
"tariff": "print(\"this is the tariff script\");",
"teamd": "print(\"this is the formulas script\");"
},
"error": "Error message (present if an error occurred)."
}

Replace /config/lua/script

SecurityApiKey

Request

Request Body schema: application/json

alertd	string (configLuaScriptAlertd) The Lua script loaded by alert reporting daemon. This script can be used to define helper functions that can then be called from the alert conditions. If loading this script takes longer than 15 seconds or evaluating any custom alert condition takes longer than 60 seconds, an alert is raised.
tariff	string (configLuaScriptTariff) The Lua script used to calculate energy cost. This script can be modified only if server-storage variable `global/billing/tariff_uri` is empty or unset. If loading this script takes longer than 15 seconds or evaluating the register formulas takes longer than half the update-interval, an alert is raised.
teamd	string (configLuaScriptTeamd) The Lua script loaded by the register calculator. This script can be used to define helper functions that can then be called from register formulas. If loading this script takes longer than 15 seconds or evaluating the register formulas takes longer than half the update-interval, an alert is raised.

Responses

200

Normal response.

401

Unauthorized response.

put/config/lua/script

Request samples

Payload
curl
Python
JavaScript
Go

application/json

{ }

Response samples

application/json

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

Update /config/lua/script

SecurityApiKey

Request

Request Body schema: application/json

alertd	string (configLuaScriptAlertd) The Lua script loaded by alert reporting daemon. This script can be used to define helper functions that can then be called from the alert conditions. If loading this script takes longer than 15 seconds or evaluating any custom alert condition takes longer than 60 seconds, an alert is raised.
tariff	string (configLuaScriptTariff) The Lua script used to calculate energy cost. This script can be modified only if server-storage variable `global/billing/tariff_uri` is empty or unset. If loading this script takes longer than 15 seconds or evaluating the register formulas takes longer than half the update-interval, an alert is raised.
teamd	string (configLuaScriptTeamd) The Lua script loaded by the register calculator. This script can be used to define helper functions that can then be called from register formulas. If loading this script takes longer than 15 seconds or evaluating the register formulas takes longer than half the update-interval, an alert is raised.

Responses

200

Normal response.

401

Unauthorized response.

post/config/lua/script

Request samples

Payload
curl
Python
JavaScript
Go

application/json

{ }

Response samples

application/json

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

Delete /config/lua/script

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/config/lua/script

Request samples

curl
Python
JavaScript
Go

Response samples

application/json

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

➔ Next to /config/lua/script/alertd