HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. shell

Update the shell access security setting on Orchestrator

post
http://127.0.0.1:8080/shell/shellAccessSetting

Updates the SSH shell access security setting on the Orchestrator. Security level can only be increased (never decreased). Allowed transitions: 'open' (0) -> 'lockdown_ssa' (1) -> 'lockdown' (2). If the requested setting matches the current setting, returns 204 with no changes. Successful changes are logged as system actions with the authenticated user.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Shell access setting to apply. Must be more restrictive than or equal to the current setting.

Request body for updating the shell access setting. The shellAccessSetting field is required and must contain a valid security level.

string
enum
required

Target shell access security level. Must be equal to or more restrictive than the current setting. Security levels: 'open' (0) < 'lockdown_ssa' (1) < 'lockdown' (2).

Allowed:
Responses
204

Shell access setting updated successfully, or no change was needed because the requested setting matches the current setting.

401

Unauthorized. User lacks READ_WRITE permission required for this operation.

Updated about 12 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 12 hours ago

Did this page help you?