Deployment API - Download BOSH tarballs of specific version

Downloads BOSH release tarballs of the specified version, OneAgent included. You can fetch the list of available versions with the GET available versions of BOSH tarballs call.

For SaaS, the call is executed on an Environment ActiveGate. Be sure to use the base of an ActiveGate, not the environment.

  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/deployment/boshrelease/agent/{osType}/version/{version}
  • SaaS https://{your-environment-activegate}:9999/e/{your-environment-id}/api/v1/deployment/boshrelease/agent/{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
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 in the format.

You can retrieve the list of available versions with the GET /deployment/boshrelease/versions/{osType} call.

path required
skipMetadata boolean

Set true to omit the OneAgent connectivity information from the installer.

If not set, false is used.

query optional

Possible values

Possible values for the osType element:

  • windows
  • unix

Response codes

Code Description
200 Success. The payload contains the BOSH release tarball file.