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

The description of this method.

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

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.

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