Install an agent

This command installs an agent over SSH.


POST https://{hostname}:{port}
Accept: application/json
Table 1. Header parameters
Parameter Type Required Description
Accept application/json true
This command takes a JSON request string or file. Use the following template for the request:
  "host": "Host name or IP address of the system to 
  install the agent on",
  "installDir": "Installation directory for the agent",
  "javaHomePath": "Path to Java on the agent system",
  "name": "Name of the agent resource",
  "port": "SSH port of the agent system; the default port 
  is 22",
  "sshPassword": "SSH password for the agent system; leave 
  blank to use public key authentication instead",
  "sshUsername": "SSH user name to use to connect to the 
  agent system",
  "tempDirPath": "Path to directory to install from on the 
  agent system",
  "webProxyUri": "Web socket URI for the relay server (e.
  g. https://relay:20080).",
  "webUri": "Web socket URI for the Deploy server (e.g. 

Related CLI command: installAgent.