/ctrl/interface/{if}/method/{idx}/doc

Description of the purpose and operation of the method. Within this string, references to input argument names are enclosed within <arg> and </arg> tags to facilitate highlighting of argument names.

Get /ctrl/interface/{if}/method/{idx}/doc

SecurityApiKey
Request
path Parameters
if
required
string

The name of an interface. Valid interface names must start with a letter and consist entirely of letters, digits, or underscores.

Example: relay
idx
required
integer >= 0

The index of a method.

Responses
200

Normal response.

401

Unauthorized response.

get/ctrl/interface/{if}/method/{idx}/doc
Request samples
Response samples
application/json
{
  • "result": "Close the relay with index <arg>n</arg>.",
  • "error": "Error message (present if an error occurred)."
}