Install an agent

This command installs an agent over SSH.

Request

POST https://{hostname}:{port}
    /cli/sshInstallAgent/installNewAgent?{parameters}
Accept: application/json
Table 1. Request parameters
Parameter Type Required Description
name string true Name of the agent resource
host string true Host name or IP address of the system to install the agent on
port int true SSH port of the agent system; the default port is 22
sshUsername string true SSH user name to use to connect to the agent system
sshPassword string false SSH password for the agent system; leave blank to use public key authentication instead
installDir string true Installation directory for the agent
javaHomePath string true Path to Java on the agent system
tempDirPath string true Path to directory to install from on the agent system
webUri string false Web socket URI for the Deploy server (e.g. wss://server:7919).
webProxyUri string false Web socket URI for the relay server (e.g. https://relay:20080).
serverHost string false Deprecated. Host name or IP address of the Deploy server or agent relay that the agent connects to
serverPort int false Deprecated. Agent communication port of the Deploy server (7918) or agent relay (7916) the agent connects to
relayWebPort int false Deprecated. HTTP proxy port of the agent relay, if the agent is connecting to an agent relay; the default is 20080
mutualAuth boolean false Deprecated. Specify true to enforce certificate validation for mutual authentication
Table 2. Header parameters
Parameter Type Required Description
Accept application/json true

Related CLI command: installAgent.