Element Descriptions

View documentation on collections and elements with https://[rcell_ip]/api/help. For a description of an element or group of elements, use the path to retrieve the data and prepend help to the collection component. For example, if you want information on the DHCP element enabled ( https://[rcell_ip]/api/dhcp/enabled ), submit a RESTful GET request to https://[rcell_ip]/api/help/dhcp/enabled.

Examples

Retrieving a description of the DHCP member enabled.

GET https://192.168.2.1/api/help/dhcp/enabled

Status: HTTP/1.1 200 OK
{
    "code" : 200, 
    "result" : {
        "dhcp_enabled" : "enable or disable DHCP server (default:true) : BOOL"
    },  
    "status" : "success"
}

The API also provides a separate set of help descriptions used by the rCell website for context-sensitive help-on-hover content. The path to each description follows the menu and category embedding of the rCell website.

Retrieving a more human-readable description of the DHCP member enabled.

GET https://192.168.2.1/help/Setup/DHCP/Settings/Enabled

Status: HTTP/1.1 200 OK
{
    "code" : 200, 
    "result" : {
        "Setup_DHCP_Settings_Enabled" : "Check to use a DHCP server on network"
    },  
    "status" : "success"
}