/config/lua/ctrld

The control scripts. Control scripts generally run indefinitely. The more control scripts exist, the slower they will execute. If a control script voluntarily terminates execution, it is restarted automatically after five seconds. If a control script is updated, its execution is automatically restarted.

Get /config/lua/ctrld

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/ctrld
Request samples
Response samples
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}

Replace /config/lua/ctrld

SecurityApiKey
Request
Request Body schema: application/json
script*
additional property
string (configLuaCtrldScript)

The control script.

Responses
200

Normal response.

401

Unauthorized response.

put/config/lua/ctrld
Request samples
application/json
{
  • "test": "print(\"this is control script test\");"
}
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Update /config/lua/ctrld

SecurityApiKey
Request
Request Body schema: application/json
script*
additional property
string (configLuaCtrldScript)

The control script.

Responses
200

Normal response.

401

Unauthorized response.

post/config/lua/ctrld
Request samples
application/json
{
  • "test": "print(\"this is control script test\");"
}
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Delete /config/lua/ctrld

Delete all control scripts.

SecurityApiKey
Responses
200

Normal response.

401

Unauthorized response.

delete/config/lua/ctrld
Request samples
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}