Get a Site Collector agent installation command

Install command to install the Site Collector agent. The command is encoded in base64, necessitating a decoding step. This encoding ensures the command's integrity during transmission, maintaining its format and preventing alterations. For example, after you receive the response, you can decode the string using the command base64 -d <<< "c3Vkb...............". After decoding the command from base64 to its original string format, you'll have the necessary shell commands to install the Site Collector agent. The install command varies depending on the type of Site Collector agent as defined in the Site Collector template. The command sequence downloads and runs a script to configure the agent and passes in parameters (deploymentHosts, templateIds, and optionally fetchStartDate and fetchHistoricalData) that affect how the script configures the Site Collector agent.

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

Type of Site Collector agent for which the template applies.

Allowed:
deploymentHosts
array of strings
required

Hostname or IP address of the Site Collector Core for which you want to install the agent.

deploymentHosts*
date-time

(Windows collectors only) The date after which you want the Site Collector agent to receive logs (ISO-8601 format).

boolean

(FileWindows and FileLinux only) This flag is only applicable for Core version 2.3.0 or higher. For Core versions lower than 2.3.0, this flag will always be set to true.

templateIds
array of uuids
required

You can assign multiple Template IDs to any collector.

templateIds*
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json