Remote CLI invocation

POST

/system/cli

curl --request POST \
  --url https://example.com/api/v1/system/cli \
  --header 'Content-Type: application/json' \
  --cookie grommunioAuthJwt=<grommunioAuthJwt> \
  --data '{ "command": "example", "mode": "exec", "color": false, "fs": { "additionalProperty": "example" } }'

• Default deployment path

Authorizations

• JWTCookie

Parameters

Header Parameters

X-Csrf-Token

string

CSRF Token

Request Body^required

Media typeapplication/json

object

command

required

CLI command to execute

string

mode

CLI mode (execute or complete)

string

default: exec

Allowed values: exec complete

color

Enable terminal colors

boolean

fs

If not null, enable filesystem redirection. Each property is a file path

object

key

additional properties

Content of the file

string

Responses

200

Execution successful

Media typeapplication/json

object

code

Command exit code (exec mode only)

integer

stdout

Command output (exec mode only)

string

fs

object

key

additional properties

object

mode

Mode the file was opened with

string

conf

Configuration key the file path was derived from

string

nullable

content

Content of the file

string

completions

Possible command completions (complete mode only)

Array<string>

Example^generated

{
  "code": 1,
  "stdout": "example",
  "fs": {
    "additionalProperty": {
      "mode": "example",
      "conf": "example",
      "content": "example"
    }
  },
  "completions": [
    "example"
  ]
}

400

Validation of input parameters failed

Media typeapplication/json

object

message

string

errors

List of errors encountered during validation

Array<string>

Example^generated

{
  "message": "example",
  "errors": [
    "example"
  ]
}

500

An error occurred while processing the request

Media typeapplication/json

object

message

String representation of the exception

string

Example^generated

{
  "message": "example"
}