Deployment API - Download latest OneAgent

Downloads the latest OneAgent installer. You can check the latest version number with the GET the latest version of OneAgent call.

For the paas or paas-sh installer types, you can get a configuring installer by passing additional parameters.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v1/deployment/installer/agent/{osType}/{installerType}/latest
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/deployment/installer/agent/{osType}/{installerType}/latest

Authentication

To execute this request, you need an access token with InstallerDownload scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
If-None-Matchstring

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

headeroptional
osTypestring

The operating system of the installer.

  • windows
  • unix
  • aix
  • solaris
  • zos
pathrequired
installerTypestring

The type of the installer:

  • default: Self-extracting installer for manual installation. Downloads an .exe file for Windows or an .sh file for Unix.
  • default-unattended: Self-extracting installer for unattended installation. Windows only. Downloads a .zip archive, containing the .msi installer and the batch file. This option is deprecated with OneAgent version 1.173
  • mainframe: Downloads all code modules for z/OS combined in a single *.pax archive.
  • paas: Code modules installer. Downloads a *.zip archive, containing the manifest.json file with meta information or a .jar file for z/OS.
  • paas-sh: Code modules installer. Downloads a self-extracting shell script with the embedded tar.gz archive.
  • default
  • default-unattended
  • mainframe
  • paas
  • paas-sh
pathrequired
flavorstring

The flavor of your Linux distribution:

  • musl for Linux distributions, which are using the musl C standard library, for example Alpine Linux.
  • 'multidistro` for all Linux distributions which are using musl C and glibc standard library.

Only applicable to the paas and paas-sh installer types.

  • default
  • multidistro
  • musl
queryoptional
archstring

The architecture of your OS:

  • all: Use this value for AIX and z/OS. Defaults to x86 for other OS types.

  • x86: x86 architecture.

  • ppc: PowerPC architecture, only supported for AIX.

  • ppcle: PowerPC Little Endian architecture, only supported for Linux.

  • sparc: Sparc architecture, only supported for Solaris.

  • arm: ARM architecture, only supported for Linux.

  • s390: S/390 architecture, only supported for Linux.

Only applicable to the paas and paas-sh installer types.

  • all
  • arm
  • ppc
  • ppcle
  • s390
  • sparc
  • x86
queryoptional
bitnessstring

The bitness of your OS. Must be supported by the OS.

Only applicable to the paas and paas-sh installer types.

  • 32
  • 64
  • all
queryoptional
includestring[]

The code modules to be included to the installer. You can specify several modules in the following format: include=java&include=dotnet.

Only applicable to the paas and paas-sh installer types.

  • all
  • java
  • java-graal-native
  • apache
  • nginx
  • nodejs
  • dotnet
  • php
  • go
  • sdk
  • envoy
queryoptional
skipMetadataboolean

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

Only applicable to the paas and paas-sh installer types.

queryoptional
networkZonestring

The network zone you want the result to be configured with.

queryoptional

Response

Response codes

CodeTypeDescription
200string

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.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The ResponseBody object