Deployment API - List available versions of OneAgent

Lists all available versions of OneAgent installer.

The request produces an application/json payload.

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

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

Parameter
Type
Description
In
Required
osType
string

The operating system of the installer.

  • windows
  • unix
  • aix
  • solaris
  • zos
path
required
installerType
string

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
path
required
flavor
string

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
query
optional
arch
string

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
query
optional

Response

Response codes

Code
Type
Description
200

Success. The payload contains the available versions.

4XX

Client side error.

5XX

Server side error.

Response body objects

The AgentInstallerVersions object

A list of available versions of OneAgent installer.

Element
Type
Description
availableVersions
string[]

A list of available versions of OneAgent installer.

Response body JSON model

{
  "availableVersions": [
    "string"
  ]
}