Powered by Redocly

/lua/var/{name}/desc

A brief, user-friendly description of the purpose of this persistent variable. This description is set when the persistent variable is created and is in the language chosen by the author of the Lua script that is created the variable. The string is, therefore, not localized to the user's environment.

Get /lua/var/{name}/desc

SecurityApiKey
Request
path Parameters
name
required
string

The name of a persistent Lua variable.

Responses
200

Normal response.

401

Unauthorized response.

get/lua/var/{name}/desc
Request samples 
Response samples 
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}
Replace /lua/var/{name}/desc
SecurityApiKey 
Request 
path Parameters
name
required
string
The name of a persistent Lua variable.


 
Request Body schema: application/json
string (luaVarNameDesc) 
A brief, user-friendly description of the purpose of this
persistent variable.  This description is set when the persistent
variable is created and is in the language chosen by the author of
the Lua script that is created the variable.  The string is,
therefore, not localized to the user's environment.


 
Responses 
200
Normal response.


401
Unauthorized response.


put/lua/var/{name}/desc
Request samples 
application/json
{
  • "result": "Start of the current billing interval."
}
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /lua/var/{name}/desc
SecurityApiKey 
Request 
path Parameters
name
required
string
The name of a persistent Lua variable.


 
Request Body schema: application/json
string (luaVarNameDesc) 
A brief, user-friendly description of the purpose of this
persistent variable.  This description is set when the persistent
variable is created and is in the language chosen by the author of
the Lua script that is created the variable.  The string is,
therefore, not localized to the user's environment.


 
Responses 
200
Normal response.


401
Unauthorized response.


post/lua/var/{name}/desc
Request samples 
application/json
{
  • "result": "Start of the current billing interval."
}
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Delete /lua/var/{name}/desc
Reset to empty string.


SecurityApiKey 
Request 
path Parameters
name
required
string
The name of a persistent Lua variable.


 
Responses 
200
Normal response.


401
Unauthorized response.


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