@dynatrace-sdk/client-classic-environment-v1 NPM

@dynatrace-sdk/client-classic-environment-v1

Documentation of the Dynatrace Classic Environment API v1. To read about use cases and examples, see Dynatrace Documentation.

Notes about compatibility:

Operations marked as early adopter or preview may be changed in non-compatible ways, although we try to avoid this.
We may add new enum constants without incrementing the API version; thus, clients need to handle unknown enum constants gracefully.

Installation

npm install @dynatrace-sdk/client-classic-environment-v1

Getting help

Visit SDK for Typescript guide in the Dynatrace Developer
Ask a question in the Dynatrace Community

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

API reference

Full API reference for the latest version of the SDK is also available at the Dynatrace Developer.

clusterVersionClient

import { clusterVersionClient } from '@dynatrace-sdk/client-classic-environment-v1';

getVersion

Gets the current version of the Dynatrace server

Required scope: environment-api:cluster-version:read Required permission: environment:roles:viewer

Returns

Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { clusterVersionClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data = await clusterVersionClient.getVersion();

deploymentClient

import { deploymentClient } from '@dynatrace-sdk/client-classic-environment-v1';

downloadAgentInstallerWithVersion

Downloads OneAgent installer of the specified version

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

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

Parameters

Name	Type	Description
config.arch	DownloadAgentInstallerWithVersionQueryArch	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.
config.bitness	DownloadAgentInstallerWithVersionQueryBitness	The bitness of your OS. Must be supported by the OS. Only applicable to the paas and paas-sh installer types.
config.flavor	DownloadAgentInstallerWithVersionQueryFlavor	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.
config.ifNoneMatch	string	The ETag of the previous request. Do not download if it matches the ETag of the installer.
config.include	Array<DownloadAgentInstallerWithVersionQueryIncludeItem>	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.
config.installerType*required	DownloadAgentInstallerWithVersionPathInstallerType	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.
config.networkZone	string	The network zone you want the result to be configured with.
config.osType*required	DownloadAgentInstallerWithVersionPathOsType	The operating system of the installer.
config.skipMetadata	boolean	Set true to omit the OneAgent connectivity information from the installer. Only applicable to the paas and paas-sh installer types.
config.version*required	string	The required version of the OneAgent in 1.155.275.20181112-084458 format. You can retrieve the list of available versions with the GET available versions of OneAgent call.

Returns

Success. The payload contains the installer file.

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.downloadAgentInstallerWithVersion({
    osType:
      DownloadAgentInstallerWithVersionPathOsType.Windows,
    installerType:
      DownloadAgentInstallerWithVersionPathInstallerType.Default,
    version: "...",
  });

downloadAgentOrchestrationSignatureWithVersion

Downloads the requested version matching OneAgent deployment orchestration tarball's signature

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

Downloading the requested version matching deployment orchestration tarball's signature matching the requested Orchestration Type (ansible, puppet).

Parameters

Name	Type	Description
config.orchestrationType*required	DownloadAgentOrchestrationSignatureWithVersionPathOrchestrationType	The Orchestration Type of the orchestration deployment script.
config.version*required	string	The requested version of the OneAgent deployment orchestration tarball in 0.1.0.20200925-120822 format.

Returns

Success. The payload contains the installer file.

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.downloadAgentOrchestrationSignatureWithVersion(
    {
      orchestrationType:
        DownloadAgentOrchestrationSignatureWithVersionPathOrchestrationType.Ansible,
      version: "...",
    },
  );

downloadAgentOrchestrationWithVersion

Downloads the requested version matching OneAgent deployment orchestration tarball

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

Downloading the requested version matching deployment orchestration tarball matching the requested Orchestration Type (ansible, puppet).

Parameters

Name	Type	Description
config.orchestrationType*required	DownloadAgentOrchestrationWithVersionPathOrchestrationType	The Orchestration Type of the orchestration deployment script.
config.version*required	string	The requested version of the OneAgent orchestration deployment tarball in 0.1.0.20200925-120822 format.

Returns

Success. The payload contains the installer file.

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.downloadAgentOrchestrationWithVersion(
    {
      orchestrationType:
        DownloadAgentOrchestrationWithVersionPathOrchestrationType.Ansible,
      version: "...",
    },
  );

downloadBoshReleaseWithVersion

Downloads BOSH release tarballs of the specified version, OneAgent included

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

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

Parameters

Name	Type	Description
config.networkZone	string	The network zone you want the result to be configured with.
config.osType*required	DownloadBoshReleaseWithVersionPathOsType	The operating system of the installer.
config.skipMetadata	boolean	Set true to omit the OneAgent connectivity information from the installer. If not set, false is used.
config.version*required	string	The required version of the OneAgent in the 1.155.275.20181112-084458 format. You can retrieve the list of available versions with the GET available versions of BOSH tarballs call.

Returns

Success. The payload contains the BOSH release tarball file.

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.downloadBoshReleaseWithVersion({
    osType:
      DownloadBoshReleaseWithVersionPathOsType.Windows,
    version: "...",
  });

downloadGatewayInstallerWithVersion

Downloads the ActiveGate installer of the specified version

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

Parameters

Name	Type	Description
config.arch	DownloadGatewayInstallerWithVersionQueryArch	The architecture of your OS: all: Defaults to amd64. amd64: amd64 architecture. s390: S/390 architecture, only supported for Linux. arm64: arm64 architecture, only supported for Linux.
config.ifNoneMatch	string	The ETag of the previous request. Do not download if it matches the ETag of the installer.
config.networkZone	string	The network zone you want the result to be configured with. Provided network zone must exist, otherwise the request will fail. Requires at least ActiveGate version 1.247.
config.osType*required	DownloadGatewayInstallerWithVersionPathOsType	The operating system of the installer.
config.version*required	string	The required version of the ActiveGate installer, in 1.155.275.20181112-084458 format. You can retrieve the list of available versions with the GET available versions of ActiveGate call.

Returns

Success. The payload contains the installer file.

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.downloadGatewayInstallerWithVersion(
    {
      osType:
        DownloadGatewayInstallerWithVersionPathOsType.Windows,
      version: "...",
    },
  );

downloadLatestAgentInstaller

Downloads the latest OneAgent installer

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

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

Parameters

Name	Type	Description
config.arch	DownloadLatestAgentInstallerQueryArch	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.
config.bitness	DownloadLatestAgentInstallerQueryBitness	The bitness of your OS. Must be supported by the OS. Only applicable to the paas and paas-sh installer types.
config.flavor	DownloadLatestAgentInstallerQueryFlavor	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.
config.ifNoneMatch	string	The ETag of the previous request. Do not download if it matches the ETag of the installer.
config.include	Array<DownloadLatestAgentInstallerQueryIncludeItem>	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.
config.installerType*required	DownloadLatestAgentInstallerPathInstallerType	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.
config.networkZone	string	The network zone you want the result to be configured with.
config.osType*required	DownloadLatestAgentInstallerPathOsType	The operating system of the installer.
config.skipMetadata	boolean	Set true to omit the OneAgent connectivity information from the installer. Only applicable to the paas and paas-sh installer types.

Returns

Success. The payload contains the installer file.

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.downloadLatestAgentInstaller({
    osType: DownloadLatestAgentInstallerPathOsType.Windows,
    installerType:
      DownloadLatestAgentInstallerPathInstallerType.Default,
  });

downloadLatestAgentOrchestration

Downloads the latest OneAgent deployment orchestration tarball

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

Downloading the latest available deployment orchestration script tarball matching the requested Orchestration Type (ansible, puppet).

Parameters

Name	Type	Description
config.orchestrationType*required	DownloadLatestAgentOrchestrationPathOrchestrationType	The Orchestration Type of the orchestration deployment script.

Returns

Success. The payload contains the installer file.

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.downloadLatestAgentOrchestration({
    orchestrationType:
      DownloadLatestAgentOrchestrationPathOrchestrationType.Ansible,
  });

downloadLatestAgentOrchestrationSignature

Downloads the latest OneAgent deployment orchestration tarball's signature

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

Downloading the latest available deployment orchestration tarball's sigature matching the requested Orchestration Type (ansible, puppet).

Parameters

Name	Type	Description
config.orchestrationType*required	DownloadLatestAgentOrchestrationSignaturePathOrchestrationType	The Orchestration Type of the orchestration deployment script.

Returns

Success. The payload contains the installer file.

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.downloadLatestAgentOrchestrationSignature(
    {
      orchestrationType:
        DownloadLatestAgentOrchestrationSignaturePathOrchestrationType.Ansible,
    },
  );

downloadLatestGatewayInstaller

Downloads the configured standard ActiveGate installer of the latest version for the specified OS

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

Parameters

Name	Type	Description
config.arch	DownloadLatestGatewayInstallerQueryArch	The architecture of your OS: all: Defaults to amd64. amd64: amd64 architecture. s390: S/390 architecture, only supported for Linux. arm64: arm64 architecture, only supported for Linux.
config.ifNoneMatch	string	The ETag of the previous request. Do not download if it matches the ETag of the installer.
config.networkZone	string	The network zone you want the result to be configured with. Provided network zone must exist, otherwise the request will fail. Requires at least ActiveGate version 1.247.
config.osType*required	DownloadLatestGatewayInstallerPathOsType	The operating system of the installer.

Returns

Success. The payload contains the installer file.

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.downloadLatestGatewayInstaller({
    osType:
      DownloadLatestGatewayInstallerPathOsType.Windows,
  });

getActiveGateInstallerAvailableVersions

Lists all available versions of ActiveGate installer

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

Parameters

Name	Type	Description
config.arch	GetActiveGateInstallerAvailableVersionsQueryArch	The architecture of your OS: all: Defaults to amd64. amd64: amd64 architecture. s390: S/390 architecture, only supported for Linux. arm64: arm64 architecture, only supported for Linux.
config.osType*required	GetActiveGateInstallerAvailableVersionsPathOsType	The operating system of the installer.

Returns

Success. The payload contains the available versions.

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.getActiveGateInstallerAvailableVersions(
    {
      osType:
        GetActiveGateInstallerAvailableVersionsPathOsType.Windows,
    },
  );

getActiveGateInstallerConnectionInfo

Gets the connectivity information for Environment ActiveGate

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

Parameters

Name	Type	Description
config.defaultZoneFallback	boolean	Set true to perform a fallback to the default network zone if the provided network zone does not exist.
config.networkZone	string	The network zone you want the result to be configured with.

Returns

Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.getActiveGateInstallerConnectionInfo();

getAgentInstallerAvailableVersions

Lists all available versions of OneAgent installer

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

Parameters

Name	Type	Description
config.arch	GetAgentInstallerAvailableVersionsQueryArch	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.
config.flavor	GetAgentInstallerAvailableVersionsQueryFlavor	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.
config.installerType*required	GetAgentInstallerAvailableVersionsPathInstallerType	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.
config.osType*required	GetAgentInstallerAvailableVersionsPathOsType	The operating system of the installer.

Returns

Success. The payload contains the available versions.

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.getAgentInstallerAvailableVersions(
    {
      osType:
        GetAgentInstallerAvailableVersionsPathOsType.Windows,
      installerType:
        GetAgentInstallerAvailableVersionsPathInstallerType.Default,
    },
  );

getAgentInstallerConnectionInfo

Gets the connectivity information for OneAgent

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

Parameters

Name	Type	Description
config.defaultZoneFallback	boolean	Set true to perform a fallback to the default network zone if the provided network zone does not exist.
config.networkZone	string	The network zone you want the result to be configured with.
config.version	string	The version of the OneAgent for which you're requesting connectivity information, in the 1.221 format. Set this parameter to get the best format of endpoint list for optimal performance.

Returns

Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.getAgentInstallerConnectionInfo();

getAgentInstallerConnectionInfoEndpoints

Gets the list of the ActiveGate-Endpoints to be used for Agents ordered by networkzone-priorities.

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

Highest priority first, separated by a semicolon.If no network zone provided the default zone is used. Responds with 404 if network zone is not known.

Parameters

Name	Type	Description
config.defaultZoneFallback	boolean	Set true to perform a fallback to the default network zone if the provided network zone does not exist.
config.networkZone	string

Returns

Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.getAgentInstallerConnectionInfoEndpoints();

getAgentInstallerMetaInfo

Gets the latest available version of a OneAgent installer

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

If a standard version is configured, then this is the downloaded version.

Non-required parameters are only applicable to the paas and paas-sh installer types.

Parameters

Name	Type	Description
config.arch	GetAgentInstallerMetaInfoQueryArch	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.
config.bitness	GetAgentInstallerMetaInfoQueryBitness	The bitness of your OS. Must be supported by the OS. Only applicable to the paas and paas-sh installer types.
config.flavor	GetAgentInstallerMetaInfoQueryFlavor	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.
config.installerType*required	GetAgentInstallerMetaInfoPathInstallerType	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.
config.osType*required	GetAgentInstallerMetaInfoPathOsType	The operating system of the installer.

Returns

Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.getAgentInstallerMetaInfo({
    osType: GetAgentInstallerMetaInfoPathOsType.Windows,
    installerType:
      GetAgentInstallerMetaInfoPathInstallerType.Default,
  });

getAgentInstallerWithVersionChecksum

Gets the checksum of a non-customized OneAgent installer

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

The checksum is the sha256 hash of the installer file.

Compare this checksum only with a non-customized OneAgent installer.

To get a non-customized installer, set the skipMetadata query parameter of the download endpoint to true.

Parameters

Name	Type	Description
config.arch	GetAgentInstallerWithVersionChecksumQueryArch	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.
config.bitness	GetAgentInstallerWithVersionChecksumQueryBitness	The bitness of your OS. Must be supported by the OS. Only applicable to the paas and paas-sh installer types.
config.flavor	GetAgentInstallerWithVersionChecksumQueryFlavor	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.
config.ifNoneMatch	string	The ETag of the previous request. Do not download if it matches the ETag of the installer.
config.include	Array<GetAgentInstallerWithVersionChecksumQueryIncludeItem>	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.
config.installerType*required	Paas	The type of the installer.
config.networkZone	string	The network zone you want the result to be configured with.
config.osType*required	GetAgentInstallerWithVersionChecksumPathOsType	The operating system of the installer.
config.version*required	string	The required version of the OneAgent in 1.155.275.20181112-084458 format. You can retrieve the list of available versions with the GET available versions of OneAgent call.

Returns

Success. The payload contains the installer file.

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.getAgentInstallerWithVersionChecksum(
    {
      osType:
        GetAgentInstallerWithVersionChecksumPathOsType.Windows,
      installerType:
        GetAgentInstallerWithVersionChecksumPathInstallerType.Paas,
      version: "...",
    },
  );

getAgentProcessModuleConfig

Gets the latest process module config | maturity=EARLY_ADOPTER

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

Returns the latest process module config. Passing a previously gotten revision will first do a revision check, and return a 304 response if no changes were detected.

Parameters

Name	Type	Description
config.hostgroup	string	The name of the host group the process is part of.
config.revision	number	The previously received revision to compare against.
config.sections	string	A list of comma-separated section identifiers to retrieve values for. Supported sections are 'general' and 'agentType'. Defaults to 'general'.

Returns

Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.getAgentProcessModuleConfig();

getBoshReleaseAvailableVersions

Gets the list of available OneAgent versions for BOSH release tarballs

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

Parameters

Name	Type	Description
config.osType*required	GetBoshReleaseAvailableVersionsPathOsType	The operating system of the installer.

Returns

Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.getBoshReleaseAvailableVersions({
    osType:
      GetBoshReleaseAvailableVersionsPathOsType.Windows,
  });

getBoshReleaseChecksum

Gets the checksum of the specified BOSH release tarball

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

The checksum is the sha256 hash of the installer file.

Result is not stable if skipMetadata is set to false.

For SaaS only works on environment ActiveGates version 1.176 or higher

Parameters

Name	Type	Description
config.networkZone	string	The network zone you want the result to be configured with.
config.osType*required	GetBoshReleaseChecksumPathOsType	The operating system of the installer.
config.skipMetadata	boolean	Set true to omit the OneAgent connectivity information from the installer. If not set, false is used.
config.version*required	string	The required version of the OneAgent in the 1.155.275.20181112-084458 format. You can retrieve the list of available versions with the GET available versions of BOSH tarballs call.

Returns

Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data = await deploymentClient.getBoshReleaseChecksum({
  osType: GetBoshReleaseChecksumPathOsType.Windows,
  version: "...",
});

getGatewayInstallerMetaInfo

Gets the latest available version of an ActiveGate installer

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

Parameters

Name	Type	Description
config.arch	GetGatewayInstallerMetaInfoQueryArch	The architecture of your OS: all: Defaults to amd64. amd64: amd64 architecture. s390: S/390 architecture, only supported for Linux. arm64: arm64 architecture, only supported for Linux.
config.osType*required	GetGatewayInstallerMetaInfoPathOsType	The operating system of the installer.

Returns

Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.getGatewayInstallerMetaInfo({
    osType: GetGatewayInstallerMetaInfoPathOsType.Windows,
  });

getLatestActiveGateImage

Gets the latest available ActiveGate image

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

Returns the latest available ActiveGate image

Returns

Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.getLatestActiveGateImage();

getLatestAgentImage

Gets the latest available Agent image

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

Returns the latest available Agent image while considering default and minimal agent version

Parameters

Name	Type	Description
config.agentImageType*required	GetLatestAgentImagePathAgentImageType	Agent Type

Returns

Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data = await deploymentClient.getLatestAgentImage({
  agentImageType:
    GetLatestAgentImagePathAgentImageType.OneAgent,
});

getLatestLambdaBuildUnits

Get the latest version names of the OneAgent for AWS Lambda

Required scope: environment-api:deployment:download Required permission: environment:roles:agent-install

Get the latest version names of the OneAgent for the Java, Node.js, and Python AWS Lambda runtimes, also including names for layers that are combined with the log collector, as well as for the standalone log collector layer.

Returns

Success. The payload contains the available versions.

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { deploymentClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await deploymentClient.getLatestLambdaBuildUnits();

oneAgentOnAHostClient

import { oneAgentOnAHostClient } from '@dynatrace-sdk/client-classic-environment-v1';

deleteAgentPersistedPotentialProblems

Deletes all detected auto-update blocking problems for this environment. | maturity=EARLY_ADOPTER

Required scope: environment-api:oneagents:read Required permission: environment:roles:manage-settings

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { oneAgentOnAHostClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await oneAgentOnAHostClient.deleteAgentPersistedPotentialProblems();

getAgentPersistedPotentialProblems

Gets a list of cluster-side detected auto-update problems that may block further rollout of a OneAgent version on a particular OS. | maturity=EARLY_ADOPTER

Required scope: environment-api:oneagents:read Required permission: environment:roles:manage-settings

Returns

Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Client side error. \| Server side error.

import { oneAgentOnAHostClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data =
  await oneAgentOnAHostClient.getAgentPersistedPotentialProblems();

getHostsWithSpecificAgents

Gets the list of hosts with OneAgent deployment information for each host

Required scope: environment-api:oneagents:read Required permission: environment:roles:manage-settings

You can narrow down the output by specifying filtering parameters for the request.

The response is limited to 500 items. Use the nextPageKey cursor to obtain subsequent results.

Parameters

Name	Type	Description
config.activeGateId	string	Filters the resulting set of hosts to those that are currently connected to the ActiveGate with the specified ID. Use DIRECT_COMMUNICATION keyword to find the hosts not connected to any ActiveGate.
config.agentVersionIs	GetHostsWithSpecificAgentsQueryAgentVersionIs	Filters the resulting set of hosts to those that have a certain OneAgent version deployed on the host. Specify the comparison operator here.
config.agentVersionNumber	string	Filters the resulting set of hosts to those that have a certain OneAgent version deployed on the host. Specify the version in the <major>.<minor>.<revision> format, for example 1.182.0. You can fetch the list of available versions with the GET available versions call.
config.autoInjection	GetHostsWithSpecificAgentsQueryAutoInjection	Filters the resulting set of hosts by the auto-injection status.
config.autoUpdateSetting	GetHostsWithSpecificAgentsQueryAutoUpdateSetting	Filters the resulting set of hosts by the actual state of the auto-update setting of deployed OneAgents.
config.availabilityState	GetHostsWithSpecificAgentsQueryAvailabilityState	Filters the resulting set of hosts by the availability state of OneAgent. MONITORED: Hosts where OneAgent is enabled and active. UNMONITORED: Hosts where OneAgent is disabled and inactive. CRASHED: Hosts where OneAgent has returned a crash status code. LOST: Hosts where it is impossible to establish connection with OneAgent. PRE_MONITORED: Hosts where OneAgent is being initialized for monitoring. SHUTDOWN: Hosts where OneAgent is shutting down in a controlled process. UNEXPECTED_SHUTDOWN: Hosts where OneAgent is shutting down in an uncontrolled process. UNKNOWN: Hosts where the state of OneAgent is unknown.
config.cloudType	GetHostsWithSpecificAgentsQueryCloudType	Filters the resulting set of hosts by the cloud type.
config.detailedAvailabilityState	GetHostsWithSpecificAgentsQueryDetailedAvailabilityState	Filters the resulting set of hosts by the detailed availability state of OneAgent. UNKNOWN: Hosts where the state of OneAgent is unknown. PRE_MONITORED: Hosts where OneAgent is being initialized for monitoring. CRASHED_UNKNOWN: Hosts where OneAgent has crashed for unknown reason. CRASHED_FAILURE: Hosts where OneAgent has returned a crash status code. LOST_UNKNOWN: Hosts where it is impossible to establish connection with OneAgent for unknown reason. LOST_CONNECTION: Hosts where OneAgent has been recognized to be inactive. LOST_AGENT_UPGRADE_FAILED: Hosts where OneAgent has a potential update problem due to inactivity after update. SHUTDOWN_UNKNOWN_UNEXPECTED: Hosts where OneAgent is shutting down in an uncontrolled process. SHUTDOWN_UNKNOWN: Hosts where OneAgent has shutdown for unknown reason. SHUTDOWN_GRACEFUL: Hosts where OneAgent has shutdown because of host shutdown. SHUTDOWN_STOPPED: Hosts where OneAgent has shutdown because the host has stopped. SHUTDOWN_AGENT_LOST: Hosts where PaaS module has been recognized to be inactive. SHUTDOWN_SPOT_INSTANCE: Hosts where OneAgent shutdown was triggered by the AWS Spot Instance interruption. SHUTDOWN_K8S_NODE_SHUTDOWN: Hosts where OneAgent shutdown was triggered by a k8s node graceful shutdown. UNMONITORED_UNKNOWN: Hosts where OneAgent is disabled and inactive for unknown reason. UNMONITORED_TERMINATED: Hosts where OneAgent has terminated. UNMONITORED_DISABLED: Hosts where OneAgent has been disabled in configuration. UNMONITORED_AGENT_STOPPED: Hosts where OneAgent is stopped. UNMONITORED_AGENT_RESTART_TRIGGERED: Hosts where OneAgent is being restarted. UNMONITORED_AGENT_UNINSTALLED: Hosts where OneAgent is uninstalled. UNMONITORED_AGENT_DISABLED: Hosts where OneAgent reported that it was disabled. UNMONITORED_AGENT_UPGRADE_FAILED: Hosts where OneAgent has a potential update problem. UNMONITORED_ID_CHANGED: Hosts where OneAgent has potentially changed ID during update. UNMONITORED_AGENT_LOST: Hosts where OneAgent has been recognized to be unavailable due to server communication issues. UNMONITORED_AGENT_UNREGISTERED: Hosts where a code module has been recognized to be unavailable because of shutdown. UNMONITORED_AGENT_VERSION_REJECTED: Hosts where OneAgent was rejected because the version does not meet the minimum agent version requirement. MONITORED: Hosts where OneAgent is enabled and active. MONITORED_ENABLED: Hosts where OneAgent has been enabled in configuration. MONITORED_AGENT_REGISTERED: Hosts where the new OneAgent has been recognized. MONITORED_AGENT_UPGRADE_STARTED: Hosts where OneAgent has shutdown due to an update. MONITORED_AGENT_ENABLED: Hosts where OneAgent reported that it was enabled. MONITORED_AGENT_VERSION_ACCEPTED: Hosts where OneAgent was accepted because the version meets the minimum agent version requirement.
config.endTimestamp	number	The end timestamp of the requested timeframe, in milliseconds (UTC). If not set, then the current timestamp is used. The timeframe must not exceed 7 months (214 days).
config.entity	Array<string>	Filters result to the specified hosts only. To specify several hosts use the following format: entity=ID1&entity=ID2.
config.faultyVersion	boolean	Filters the resulting set of hosts to those that run OneAgent version that is marked as faulty.
config.hostGroupId	string	Filters the resulting set of hosts by the specified host group. Specify the Dynatrace entity ID of the required host group.
config.hostGroupName	string	Filters the resulting set of hosts by the specified host group. Specify the name of the required host group.
config.includeDetails	boolean	Includes (true) or excludes (false) details which are queried from related entities. Excluding details may make queries faster. If not set, then true is used.
config.managementZone	string	Only return hosts that are part of the specified management zone. Specify the management zone name here. If the managementZoneId parameter is set, this parameter is ignored.
config.managementZoneId	number	Only return hosts that are part of the specified management zone. Specify the management zone ID here.
config.monitoringType	GetHostsWithSpecificAgentsQueryMonitoringType	Filters the resulting set of hosts by monitoring mode of OneAgent deployed on the host.
config.networkZoneId	string	Filters the resulting set of hosts by the specified network zone. Specify the Dynatrace entity ID of the required network zone. You can fetch the list of available network zones with the GET all network zones call.
config.nextPageKey	string	The cursor for the next page of results, if results do not fit on one page. You can find the cursor value on the current page of the response, in the nextPageKey field. To obtain subsequent pages, you must specify this cursor value in your query, and keep all other query parameters as they were in the original request. If you don't specify the cursor, the first page will always be returned.
config.osType	GetHostsWithSpecificAgentsQueryOsType	Filters the resulting set of hosts by the OS type.
config.pluginName	string	Filters the resulting set of hosts to those that run the plugin with the specified name. The CONTAINS operator is applied to the specified value. If several plugin filters are specified, the plugin has to match all the filters.
config.pluginState	GetHostsWithSpecificAgentsQueryPluginState	Filters the resulting set of hosts to those that run the plugin with the specified state.
config.pluginVersionIs	GetHostsWithSpecificAgentsQueryPluginVersionIs	Filters the resulting set of hosts to those that have a certain plugin version deployed on the host. Specify the comparison operator here. If several plugin filters are specified, the plugin has to match all the filters.
config.pluginVersionNumber	string	Filters the resulting set of hosts to those that have a certain plugin version deployed on the host. Specify the version in the <major>.<minor>.<revision> format, for example 1.182.0. You can fetch the list of available versions with the GET available versions call. <minor> and <revision> parts of the version number are optional. If several plugin filters are specified, the plugin has to match all the filters.
config.relativeTime	GetHostsWithSpecificAgentsQueryRelativeTime	The relative timeframe, back from now. If you need to spe