Try it free

Deployment API - View the latest version of OneAgent

  • Reference
  • Published Aug 28, 2019

Gets the latest available version number of OneAgent.

The request produces an application/json payload.

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

Authentication

Api-Token:

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

To learn how to obtain and use it, see Personal access tokens.

Platform Token / OAuth:

Required scope: fleet-management:oneagents:download

To learn how to obtain and use it, see Platform tokens or OAuth clients.

Parameters

ParameterTypeDescriptionInRequired
osTypestring

The operating system of the installer.

The element can hold these values
  • 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.
The element can hold these values
  • 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 Linux distributions, which are using musl C and glibc standard library.

  • default for Linux distributions, which are using glibc standard library.

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

The element can hold these values
  • 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.

The element can hold these values
  • 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.

The element can hold these values
  • 32
  • 64
  • all
queryOptional

Response

Response codes

CodeTypeDescription
200AgentInstallerMetaInfoDto

Success

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The AgentInstallerMetaInfoDto object

ElementTypeDescription
latestAgentVersionstring-

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
  "latestAgentVersion": "string"
}
{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}