proxy

Available methods

Description

Provides methods to activate/deactivate a proxy server.

Namespace:

proxy

Method: activateProxy

HTTP POST

Description:

Activates the proxy identified by the given client certificate i.e. systemid file.

Parameters:

  • string clientcert - client certificate file

  • string version - Version of proxy to be registered.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: containerConfig

HTTP POST

Description:

Compute and download the configuration for proxy containers

Parameters:

  • string sessionKey

  • string proxyName

  • int proxyPort

  • string server

  • int maxCache

  • string email

  • string rootCA

  • string array intermediateCAs - intermediate CAs used to sign the SSL certificate in PEM format

  • string proxyCrt

  • string proxyKey

Returns:

  • byte array binary object - package file

Method: containerConfig

HTTP POST

Description:

Compute and download the configuration for proxy containers

Parameters:

  • string sessionKey

  • string proxyName

  • int proxyPort

  • string server

  • int maxCache

  • string email

  • string caCrt

  • string caKey

  • string caPassword

  • string array cnames - Proxy alternate cnames to set in the SSL certificate

  • string country

  • string state

  • string city

  • string org

  • string orgUnit

  • string sslEmail

Returns:

  • byte array binary object - package file

Method: createMonitoringScout

HTTP POST

Description:

Create Monitoring Scout for proxy.

Parameters:

  • string clientcert - client certificate file

Returns:

  • string

Available since API version: 10.7

Method: deactivateProxy

HTTP POST

Description:

Deactivates the proxy identified by the given client certificate i.e. systemid file.

Parameters:

  • string clientcert - client certificate file

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: isProxy

HTTP GET

Description:

Test, if the system identified by the given client certificate i.e. systemid file, is proxy.

Parameters:

  • string clientcert - client certificate file

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: listAvailableProxyChannels

HTTP GET

Description:

List available version of proxy channel for system identified by the given client certificate i.e. systemid file.

Parameters:

  • string clientcert - client certificate file

Returns:

  • string array version

Available since API version: 10.5

Method: listProxies

HTTP GET

Description:

List the proxies within the user’s organization.

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct system

    • int "id"

    • string "name"

    • dateTime.iso8601 "last_checkin" - last time server successfully checked in

    • dateTime.iso8601 "created" - server registration time

    • dateTime.iso8601 "last_boot" - last server boot time

Method: listProxyClients

HTTP GET

Description:

List the clients directly connected to a given Proxy.

Parameters:

  • string sessionKey

  • int proxyId

Returns:

  • int array clientId