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

appliance access shell: set

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

Request:

HTTP request

PUT https://{server}/rest/appliance/access/shell

Request Body Structure:

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

Request Body Parameters:

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

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
500 error Generic error