/ctrl/interface/{if}

Description of the interface.

Get /ctrl/interface/{if}

SecurityApiKey

Request

path Parameters

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

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}

Request samples

curl
Python
JavaScript
Go

Response samples

application/json

{"result": {"method": [{"name": "close",
"in": "u",
"in_names": ["n"
],
"out": "",
"doc": "Close the relay with index <arg>n</arg>."
},
{"name": "open",
"in": "u",
"in_names": ["n"
],
"out": "",
"doc": "Open the relay with index <arg>n</arg>."
}
]
},
"error": "Error message (present if an error occurred)."
}

➔ Next to /ctrl/interface/{if}/method