REST API - get
  1. Operations
  2. appliance
  3. access
  4. shell

appliance access shell: get

Get enabled state of BASH, that is, access to BASH from within the controlled CLI.

Request:

HTTP request

GET https://{server}/rest/appliance/access/shell
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "enabled" : true,
        "timeout" : 1
    }
}

Response Type:

Name Type Description
bold = required
value shell_config Current shell configuration.
value.enabled boolean Enabled can be set to true or false
value.timeout long The timeout (in seconds) specifies how long you enable the Shell access. The maximum timeout is 86400 seconds(1 day).

Errors:

HTTP Status Code Type Description
500 error Generic error