Navigation:  Integration > Data Extraction API > Clients, Sites and Devices >

Get Site Installation Package: get_site_installation_package

Previous pageReturn to chapter overviewNext page

 

Service name: get_site_installation_package

URL

 

https://SERVER/api/?apikey=yourAPItoken&service=get_site_installation_package

&required_parameters=required_parameters

[&optional_parameters=optional_parameters]

 

Description

Creates a site installation package. Where successful a file is returned.

This package is based on the latest General Availability Agent unless the beta=true parameter is used in which case the Site Installation Package contains the current Release Candidate Agent.

Please note, with the release of Dashboard 6.35 the password field requirement was removed for this API call.

 

Parameters

Post Variable

Description

Type

Required

Options

Default

endcustomerid 

Unique identifier of client

Note: endcustomerid = clientid from list_clients

integer 

yes 

0

0

siteid 

Site ID 

integer 

yes 

0

0

mode 

Mode 

string 

no 

authenticate

downloadgp

downloadrwbuild

0

proxyenabled 

Proxy enabled 

boolean 

no 

0

0

proxyhost 

Proxy Host 

string 

no 

0

0

proxyport 

Proxy Port 

integer 

no 

0

0

proxyusername 

Proxy Username 

string 

no 

0

0

proxypassword 

Proxy Password 

string 

no 

0

0

describe 

Optional. Returns a description of the service. 

boolean 

no 

true

0

beta 

True if you require the current beta version 

boolean 

no 

true

false

false

type 

Type must be set to group_policy or remote_worker 

string 

yes 

remote_worker

group_policy

0

 

Example Service Call =get_site_installation_package

 

https://SERVER/api/?apikey=yourAPItoken&service=get_site_installation_package&endcustomerid=ENDCUSTOMERID&siteid=SITEID&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>

 

Field Descriptions

 

No xml returned on success, file returned on success