Get Site Installation Package

Base URL

https://{SERVER}/api/?apikey={yourAPIkey}&service=get_site_installation_package

Description

Creates a Site Install Package based on the specified installer type. Where successful a package is created and downloaded.

By default this package is based on the latest General Availability Agent unless the beta=true parameter is used. In this case, the Site Installation Package contains the current Release Candidate Agent.

Site Installation Packages are supported for Windows, Mac, and Linux. The Site Installation Package defaults to Windows if you don't include the OS parameter.

Parameters

Required parameters

Add required parameters immediately after the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service=get_site_installation_package&required_parameters={parameter-value}

Parameter	Description	Type	Options
endcustomerid	Unique identifier of client Note: endcustomerid = clientid from list_clients	integer	0
siteid	Site Id	integer	0
os	The Operating System intended for the site installation package.	string	windows mac linux
type	The type of installer to download.	string	remote_worker group_policy

Optional parameters

Add optional parameters after the required parameters in the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service=get_site_installation_package&required_parameters={parameter-value}&optional_parameters={parameter-value}

Parameter	Description	Type	Options	Default
describe	Returns a description of the service.	boolean	true	0
mode	Mode	string	authenticate downloadgp downloadrwbuild	0
proxyenabled	Proxy enabled (deprecated)	boolean	0	0
proxyhost	Proxy Host (deprecated)	string	0	0
proxyport	Proxy Port (deprecated)	integer	0	0
proxyusername	Proxy Username (deprecated)	string	0	0
proxypassword	Proxy Password (deprecated)	string	0	0
beta	Download the current beta (RC) Agent version if set to true.	boolean	true false	false

Determine parameter values

Use the following associated service calls to determine parameter values.

Parameter	Call	URL Format
siteid	list_sites	https://{SERVER}/api/?apikey={yourAPIkey}&service=list_sites&clientid=CLIENTID
endcustomerid	list_clients	https://{SERVER}/api/?apikey={yourAPIkey}&service=list_clients

Examples

Get a Site Installation Package

https://{SERVER}/api/?apikey={yourAPIkey}&service=get_site_installation_package&endcustomerid=ENDCUSTOMERID&siteid=SITEID&os=Windows&type=TYPE

Example response: Success

<?xml version="1.0"?>
	<result created="2015-07-22T10:58:38+01:00" host="SERVER" status="FAIL">
	<data> 
		<success>1</success> 
		<siteid>123</siteid> 
	</data> 
</result>

Example response: Failure

<?xml version="1.0"?>
	<result created="2015-07-22T10:58:38+01:00" host="SERVER" status="FAIL">
	<error>
		<errorcode>4</errorcode>
		<message>Invalid value for parameter: PARAMETER</message>
	</error>
</result>

Returned fields

No XML returned on success, file returned on success.