Deployment API - Download ActiveGate of specific version

Downloads the ActiveGate installer compatible with the specified OneAgent version. You can fetch the list of available OneAgent versions with the GET available versions of OneAgent call.

The request downloads the ActiveGate installer of the version compatible with the provided OneAgent version. This version might be different from the specified OneAgent version.

  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/deployment/installer/gateway/{osType}/version/{version}
  • SaaS https://{your-environment-id}{osType}/version/{version}


To execute this request, you need the PaaS token (InstallerDownload) of your environment. To learn how to obtain and use it, see Access tokens.


Parameter Type Description In Required
If-None-Match string

The ETag of the previous request. Do not download if it matches the ETag of the installer.

header optional
osType string

The operating system of the installer.

The osType element can hold these values.
path required
version string

The required version of the OneAgent installer, in format.

The request returns the ActiveGate installer of the version, compatible with the provided OneAgent version.

path required

Possible values

Possible values for the osType element:

  • windows
  • unix

Response codes

Code Description
200 Success. The payload contains the installer file.
304 Not modified. You already have the latest version of the installer. The response does not contain a payload.