Skip to main content

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.
npm install @dynatrace-sdk/client-classic-environment-v1

clusterVersionClient

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

getVersion

clusterVersionClient.getVersion(abortSignal?): Promise<ClusterVersion>

Gets the current version of the Dynatrace server

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

{/ no parameters /}

Returns

Success

Code example
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

deploymentClient.downloadAgentInstallerWithVersion(config): Promise<void>

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

NameTypeDescription
config.archDownloadAgentInstallerWithVersionQueryArch

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 and Linux.

  • 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.

default: "all"
config.bitnessDownloadAgentInstallerWithVersionQueryBitness

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

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

default: "all"
config.flavorDownloadAgentInstallerWithVersionQueryFlavor

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: "default"
config.ifNoneMatchstringThe ETag of the previous request. Do not download if it matches the ETag of the installer.
config.includeArray<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*requiredDownloadAgentInstallerWithVersionPathInstallerType

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.networkZonestringThe network zone you want the result to be configured with.
config.osType*requiredDownloadAgentInstallerWithVersionPathOsTypeThe operating system of the installer.
config.skipMetadataboolean

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

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

default: false
config.version*requiredstring

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.

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

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

downloadAgentOrchestrationSignatureWithVersion

deploymentClient.downloadAgentOrchestrationSignatureWithVersion(config): Promise<void>

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

NameTypeDescription
config.orchestrationType*requiredDownloadAgentOrchestrationSignatureWithVersionPathOrchestrationTypeThe Orchestration Type of the orchestration deployment script.
config.version*requiredstringThe requested version of the OneAgent deployment orchestration tarball in 0.1.0.20200925-120822 format.

Returns

Success. The payload contains the installer file.

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

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

downloadAgentOrchestrationWithVersion

deploymentClient.downloadAgentOrchestrationWithVersion(config): Promise<void>

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

NameTypeDescription
config.orchestrationType*requiredDownloadAgentOrchestrationWithVersionPathOrchestrationTypeThe Orchestration Type of the orchestration deployment script.
config.version*requiredstringThe requested version of the OneAgent orchestration deployment tarball in 0.1.0.20200925-120822 format.

Returns

Success. The payload contains the installer file.

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

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

downloadBoshReleaseWithVersion

deploymentClient.downloadBoshReleaseWithVersion(config): Promise<void>

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

NameTypeDescription
config.networkZonestringThe network zone you want the result to be configured with.
config.osType*requiredDownloadBoshReleaseWithVersionPathOsTypeThe operating system of the installer.
config.skipMetadataboolean

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

If not set, false is used.

default: false
config.version*requiredstring

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.

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

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

downloadGatewayInstallerWithVersion

deploymentClient.downloadGatewayInstallerWithVersion(config): Promise<void>

Downloads the ActiveGate installer of the specified version

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

Parameters

NameTypeDescription
config.archDownloadGatewayInstallerWithVersionQueryArch

The architecture of your OS:

  • all: Defaults to amd64.
  • amd64: amd64 architecture.
  • s390: S/390 architecture, only supported for Linux.
default: "all"
config.ifNoneMatchstringThe ETag of the previous request. Do not download if it matches the ETag of the installer.
config.networkZonestringThe network zone you want the result to be configured with. Requires at least ActiveGate version 1.247.
config.osType*requiredDownloadGatewayInstallerWithVersionPathOsTypeThe operating system of the installer.
config.version*requiredstring

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.

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

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

downloadLatestAgentInstaller

deploymentClient.downloadLatestAgentInstaller(config): Promise<void>

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

NameTypeDescription
config.archDownloadLatestAgentInstallerQueryArch

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 and Linux.

  • 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.

default: "all"
config.bitnessDownloadLatestAgentInstallerQueryBitness

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

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

default: "all"
config.flavorDownloadLatestAgentInstallerQueryFlavor

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: "default"
config.ifNoneMatchstringThe ETag of the previous request. Do not download if it matches the ETag of the installer.
config.includeArray<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*requiredDownloadLatestAgentInstallerPathInstallerType

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.networkZonestringThe network zone you want the result to be configured with.
config.osType*requiredDownloadLatestAgentInstallerPathOsTypeThe operating system of the installer.
config.skipMetadataboolean

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

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

default: false

Returns

Success. The payload contains the installer file.

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

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

downloadLatestAgentOrchestration

deploymentClient.downloadLatestAgentOrchestration(config): Promise<void>

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

NameTypeDescription
config.orchestrationType*requiredDownloadLatestAgentOrchestrationPathOrchestrationTypeThe Orchestration Type of the orchestration deployment script.

Returns

Success. The payload contains the installer file.

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

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

downloadLatestAgentOrchestrationSignature

deploymentClient.downloadLatestAgentOrchestrationSignature(config): Promise<void>

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

NameTypeDescription
config.orchestrationType*requiredDownloadLatestAgentOrchestrationSignaturePathOrchestrationTypeThe Orchestration Type of the orchestration deployment script.

Returns

Success. The payload contains the installer file.

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

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

downloadLatestGatewayInstaller

deploymentClient.downloadLatestGatewayInstaller(config): Promise<void>

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

NameTypeDescription
config.archDownloadLatestGatewayInstallerQueryArch

The architecture of your OS:

  • all: Defaults to amd64.
  • amd64: amd64 architecture.
  • s390: S/390 architecture, only supported for Linux.
default: "all"
config.ifNoneMatchstringThe ETag of the previous request. Do not download if it matches the ETag of the installer.
config.networkZonestringThe network zone you want the result to be configured with. Requires at least ActiveGate version 1.247.
config.osType*requiredDownloadLatestGatewayInstallerPathOsTypeThe operating system of the installer.

Returns

Success. The payload contains the installer file.

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

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

getActiveGateInstallerAvailableVersions

deploymentClient.getActiveGateInstallerAvailableVersions(config): Promise<ActiveGateInstallerVersions>

Lists all available versions of ActiveGate installer

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

Parameters

NameTypeDescription
config.archGetActiveGateInstallerAvailableVersionsQueryArch

The architecture of your OS:

  • all: Defaults to amd64.
  • amd64: amd64 architecture.
  • s390: S/390 architecture, only supported for Linux.
default: "all"
config.osType*requiredGetActiveGateInstallerAvailableVersionsPathOsTypeThe operating system of the installer.

Returns

Success. The payload contains the available versions.

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

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

getActiveGateInstallerConnectionInfo

deploymentClient.getActiveGateInstallerConnectionInfo(config): Promise<ActiveGateConnectionInfo>

Gets the connectivity information for Environment ActiveGate

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

Parameters

NameTypeDescription
config.defaultZoneFallbackbooleanSet true to perform a fallback to the default network zone if the provided network zone does not exist. default: false
config.networkZonestringThe network zone you want the result to be configured with.

Returns

Success

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

const data = await deploymentClient.getActiveGateInstallerConnectionInfo();

getAgentInstallerAvailableVersions

deploymentClient.getAgentInstallerAvailableVersions(config): Promise<AgentInstallerVersions>

Lists all available versions of OneAgent installer

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

Parameters

NameTypeDescription
config.archGetAgentInstallerAvailableVersionsQueryArch

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 and Linux.

  • 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.

default: "all"
config.flavorGetAgentInstallerAvailableVersionsQueryFlavor

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: "default"
config.installerType*requiredGetAgentInstallerAvailableVersionsPathInstallerType

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*requiredGetAgentInstallerAvailableVersionsPathOsTypeThe operating system of the installer.

Returns

Success. The payload contains the available versions.

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

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

getAgentInstallerConnectionInfo

deploymentClient.getAgentInstallerConnectionInfo(config): Promise<ConnectionInfo>

Gets the connectivity information for OneAgent

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

Parameters

NameTypeDescription
config.defaultZoneFallbackbooleanSet true to perform a fallback to the default network zone if the provided network zone does not exist. default: false
config.networkZonestringThe network zone you want the result to be configured with.
config.versionstring

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

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

const data = await deploymentClient.getAgentInstallerConnectionInfo();

getAgentInstallerConnectionInfoEndpoints

deploymentClient.getAgentInstallerConnectionInfoEndpoints(config): Promise<void>

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

NameTypeDescription
config.defaultZoneFallbackbooleanSet true to perform a fallback to the default network zone if the provided network zone does not exist. default: false
config.networkZonestring

Returns

Success

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

const data = await deploymentClient.getAgentInstallerConnectionInfoEndpoints();

getAgentInstallerMetaInfo

deploymentClient.getAgentInstallerMetaInfo(config): Promise<AgentInstallerMetaInfoDto>

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

NameTypeDescription
config.archGetAgentInstallerMetaInfoQueryArch

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 and Linux.

  • 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.

default: "all"
config.bitnessGetAgentInstallerMetaInfoQueryBitness

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

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

default: "all"
config.flavorGetAgentInstallerMetaInfoQueryFlavor

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: "default"
config.installerType*requiredGetAgentInstallerMetaInfoPathInstallerType

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*requiredGetAgentInstallerMetaInfoPathOsTypeThe operating system of the installer.

Returns

Success

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

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

getAgentInstallerWithVersionChecksum

deploymentClient.getAgentInstallerWithVersionChecksum(config): Promise<OneAgentInstallerChecksum>

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

NameTypeDescription
config.archGetAgentInstallerWithVersionChecksumQueryArch

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 and Linux.

  • 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.

default: "all"
config.bitnessGetAgentInstallerWithVersionChecksumQueryBitness

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

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

default: "all"
config.flavorGetAgentInstallerWithVersionChecksumQueryFlavor

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: "default"
config.ifNoneMatchstringThe ETag of the previous request. Do not download if it matches the ETag of the installer.
config.includeArray<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*requiredPaasThe type of the installer.
config.networkZonestringThe network zone you want the result to be configured with.
config.osType*requiredGetAgentInstallerWithVersionChecksumPathOsTypeThe operating system of the installer.
config.version*requiredstring

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.

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

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

getAgentProcessModuleConfig

deploymentClient.getAgentProcessModuleConfig(config): Promise<AgentProcessModuleConfigResponse>

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

NameTypeDescription
config.revisionnumberThe previously received revision to compare against.
config.sectionsstringA list of comma-separated section identifiers to retrieve values for. Supported sections are 'general' and 'agentType'. Defaults to 'general'. default: "general"

Returns

Success

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

const data = await deploymentClient.getAgentProcessModuleConfig();

getBoshReleaseAvailableVersions

deploymentClient.getBoshReleaseAvailableVersions(config): Promise<BoshReleaseAvailableVersions>

Gets the list of available OneAgent versions for BOSH release tarballs

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

Parameters

NameTypeDescription
config.osType*requiredGetBoshReleaseAvailableVersionsPathOsTypeThe operating system of the installer.

Returns

Success

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

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

getBoshReleaseChecksum

deploymentClient.getBoshReleaseChecksum(config): Promise<BoshReleaseChecksum>

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

NameTypeDescription
config.networkZonestringThe network zone you want the result to be configured with.
config.osType*requiredGetBoshReleaseChecksumPathOsTypeThe operating system of the installer.
config.skipMetadataboolean

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

If not set, false is used.

default: false
config.version*requiredstring

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

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

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

getGatewayInstallerMetaInfo

deploymentClient.getGatewayInstallerMetaInfo(config): Promise<GatewayInstallerMetaInfoDto>

Gets the latest available version of an ActiveGate installer

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

Parameters

NameTypeDescription
config.archGetGatewayInstallerMetaInfoQueryArch

The architecture of your OS:

  • all: Defaults to amd64.
  • amd64: amd64 architecture.
  • s390: S/390 architecture, only supported for Linux.
default: "all"
config.osType*requiredGetGatewayInstallerMetaInfoPathOsTypeThe operating system of the installer.

Returns

Success

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

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

getLatestActiveGateImage

deploymentClient.getLatestActiveGateImage(abortSignal?): Promise<ImageDto>

Gets the latest available ActiveGate image

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

Returns the latest available ActiveGate image

{/ no parameters /}

Returns

Success

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

const data = await deploymentClient.getLatestActiveGateImage();

getLatestAgentImage

deploymentClient.getLatestAgentImage(config): Promise<ImageDto>

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

NameTypeDescription
config.agentImageType*requiredGetLatestAgentImagePathAgentImageTypeAgent Type

Returns

Success

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

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

getLatestLambdaBuildUnits

deploymentClient.getLatestLambdaBuildUnits(abortSignal?): Promise<LatestLambdaLayerNames>

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.

{/ no parameters /}

Returns

Success. The payload contains the available versions.

Code example
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

oneAgentOnAHostClient.deleteAgentPersistedPotentialProblems(abortSignal?): Promise<void>

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

{/ no parameters /}

{/ no returns /}

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

const data =
await oneAgentOnAHostClient.deleteAgentPersistedPotentialProblems();

getAgentPersistedPotentialProblems

oneAgentOnAHostClient.getAgentPersistedPotentialProblems(abortSignal?): Promise<AgentPotentialProblemsState>

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

{/ no parameters /}

Returns

Success

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

const data = await oneAgentOnAHostClient.getAgentPersistedPotentialProblems();

getHostsWithSpecificAgents

oneAgentOnAHostClient.getHostsWithSpecificAgents(config): Promise<HostsListPage>

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

NameTypeDescription
config.activeGateIdstring

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.agentVersionIsGetHostsWithSpecificAgentsQueryAgentVersionIs

Filters the resulting set of hosts to those that have a certain OneAgent version deployed on the host.

Specify the comparison operator here.

config.agentVersionNumberstring

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.autoInjectionGetHostsWithSpecificAgentsQueryAutoInjectionFilters the resulting set of hosts by the auto-injection status.
config.autoUpdateSettingGetHostsWithSpecificAgentsQueryAutoUpdateSettingFilters the resulting set of hosts by the actual state of the auto-update setting of deployed OneAgents.
config.availabilityStateGetHostsWithSpecificAgentsQueryAvailabilityState

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.cloudTypeGetHostsWithSpecificAgentsQueryCloudTypeFilters the resulting set of hosts by the cloud type.
config.detailedAvailabilityStateGetHostsWithSpecificAgentsQueryDetailedAvailabilityState

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.
  • 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.endTimestampnumber

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.entityArray<string>

Filters result to the specified hosts only.

To specify several hosts use the following format: entity=ID1&entity=ID2.

config.faultyVersionbooleanFilters the resulting set of hosts to those that run OneAgent version that is marked as faulty.
config.hostGroupIdstring

Filters the resulting set of hosts by the specified host group.

Specify the Dynatrace entity ID of the required host group.

config.hostGroupNamestring

Filters the resulting set of hosts by the specified host group.

Specify the name of the required host group.

config.includeDetailsboolean

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.

default: true
config.managementZonestring

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.managementZoneIdnumber

Only return hosts that are part of the specified management zone.

Specify the management zone ID here.

config.monitoringTypeGetHostsWithSpecificAgentsQueryMonitoringTypeFilters the resulting set of hosts by monitoring mode of OneAgent deployed on the host.
config.networkZoneIdstring

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.nextPageKeystring

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.osTypeGetHostsWithSpecificAgentsQueryOsTypeFilters the resulting set of hosts by the OS type.
config.pluginNamestring

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.pluginStateGetHostsWithSpecificAgentsQueryPluginStateFilters the resulting set of hosts to those that run the plugin with the specified state.
config.pluginVersionIsGetHostsWithSpecificAgentsQueryPluginVersionIs

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.pluginVersionNumberstring

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.relativeTimeGetHostsWithSpecificAgentsQueryRelativeTime

The relative timeframe, back from now.

If you need to specify relative timeframe that is not presented in the list of possible values, specify the startTimestamp (up to 214 days back from now) and leave endTimestamp and relativeTime empty.

config.startTimestampnumber

The start timestamp of the requested timeframe, in milliseconds (UTC).

If not set, then 72 hours behind from now is used.

config.tagArray<string>

Filters the resulting set of hosts by the specified tag. You can specify several tags in the following format: tag=tag1&tag=tag2. The host has to match all the specified tags.

In case of key-value tags, such as imported AWS or CloudFoundry tags, use the following format: tag=[context]key:value. For custom key-value tags, omit the context: tag=key:value.

config.technologyModuleFaultyVersionboolean

Filters the resulting set of hosts to those that run the code module version that is marked as faulty.

If several code module filters are specified, the code module has to match all the filters.

config.technologyModuleTypeGetHostsWithSpecificAgentsQueryTechnologyModuleType

Filters the resulting set of hosts to those that run the specified OneAgent code module.

If several code module filters are specified, the code module has to match all the filters.

config.technologyModuleVersionIsGetHostsWithSpecificAgentsQueryTechnologyModuleVersionIs

Filters the resulting set of hosts to those that have a certain code module version deployed on the host.

Specify the comparison operator here.

If several code module filters are specified, the code module has to match all the filters.

config.technologyModuleVersionNumberstring

Filters the resulting set of hosts to those that have a certain code module 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.

If several code module filters are specified, the code module has to match all the filters.

config.updateStatusGetHostsWithSpecificAgentsQueryUpdateStatusFilters the resulting set of hosts by the update status of OneAgent deployed on the host.

Returns

Success

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

const data = await oneAgentOnAHostClient.getHostsWithSpecificAgents();

rumJavaScriptTagManagementClient

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

getAppRevision

rumJavaScriptTagManagementClient.getAppRevision(config): Promise<string>

Gets the version of the RUM JavaScript code injected into specified application

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

Parameters

NameTypeDescription
config.entity*requiredstring

The Dynatrace entity ID of the application.

You can obtain it from the response of the GET the list of manually injected applications call.

Returns

Success

Code example
import { rumJavaScriptTagManagementClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data = await rumJavaScriptTagManagementClient.getAppRevision({
entity: "...",
});

getAsyncCodeSnippet

rumJavaScriptTagManagementClient.getAsyncCodeSnippet(config): Promise<string>

Downloads the asynchronous code snippet

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

This code provides configuration and basic code to be manually inserted into your web application code.

The full functionality of the monitoring code is loaded asynchronously.

Parameters

NameTypeDescription
config.entity*requiredstring

The Dynatrace entity ID of the application.

You can obtain it from the response of the GET the list of manually injected applications call.

Returns

Success

Code example
import { rumJavaScriptTagManagementClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data = await rumJavaScriptTagManagementClient.getAsyncCodeSnippet({
entity: "...",
});

getJsInlineScript

rumJavaScriptTagManagementClient.getJsInlineScript(config): Promise<string>

Downloads inline code

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

Returns the inline code of the most recent OneAgent JavaScript. This is a complete configuration and monitoring code to be manually inserted into your web application code.

Parameters

NameTypeDescription
config.entity*requiredstring

The Dynatrace entity ID of the application.

You can obtain it from the response of the GET the list of manually injected applications call.

Returns

Success

Code example
import { rumJavaScriptTagManagementClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data = await rumJavaScriptTagManagementClient.getJsInlineScript({
entity: "...",
});

getJsLatestVersion

rumJavaScriptTagManagementClient.getJsLatestVersion(abortSignal?): Promise<string>

Gets the latest version of OneAgent JavaScript library

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

{/ no parameters /}

Returns

Success

Code example
import { rumJavaScriptTagManagementClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data = await rumJavaScriptTagManagementClient.getJsLatestVersion();

getJsScript

rumJavaScriptTagManagementClient.getJsScript(config): Promise<string>

Downloads OneAgent JavaScript tag

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

Returns the OneAgent JavaScript tag. This is a complete configuration and monitoring code to be manually inserted into your web application code.

The monitoring code is loaded as a separate file from a CDN.

Parameters

NameTypeDescription
config.entity*requiredstring

The Dynatrace entity ID of the application.

You can obtain it from the response of the GET the list of manually injected applications call.

Returns

Success

Code example
import { rumJavaScriptTagManagementClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data = await rumJavaScriptTagManagementClient.getJsScript({
entity: "...",
});

getJsTagComplete

rumJavaScriptTagManagementClient.getJsTagComplete(config): Promise<string>

Downloads JavaScript tag

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

Returns a JavaScript tag to be manually inserted into your web application code. The tag references a JavaScript file with full configuration and monitoring code, which causes a lower possible caching duration.

Parameters

NameTypeDescription
config.entity*requiredstring

The Dynatrace entity ID of the application.

You can obtain it from the response of the GET the list of manually injected applications call.

Returns

Success

Code example
import { rumJavaScriptTagManagementClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data = await rumJavaScriptTagManagementClient.getJsTagComplete({
entity: "...",
});

getManualApps

rumJavaScriptTagManagementClient.getManualApps(abortSignal?): Promise<Array<ManualApplication>>

Lists all manually injected applications

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

{/ no parameters /}

Returns

Success

Code example
import { rumJavaScriptTagManagementClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data = await rumJavaScriptTagManagementClient.getManualApps();

getSyncCodeSnippet

rumJavaScriptTagManagementClient.getSyncCodeSnippet(config): Promise<string>

Downloads the synchronous code snippet

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

This code provides configuration and basic code to be manually inserted into your web application code.

The full functionality of the monitoring code is loaded synchronously.

Parameters

NameTypeDescription
config.entity*requiredstring

The Dynatrace entity ID of the application.

You can obtain it from the response of the GET the list of manually injected applications call.

Returns

Success

Code example
import { rumJavaScriptTagManagementClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data = await rumJavaScriptTagManagementClient.getSyncCodeSnippet({
entity: "...",
});

rumUserSessionsClient

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

getUsqlResultAsTable

rumUserSessionsClient.getUsqlResultAsTable(config): Promise<UsqlResultAsTable>

Returns the result of the query as a table structure

Required scope: environment-api:usersessionquerylanguage:read Required permission: environment:roles:viewer

The result is a flat list of rows containing the requested columns.

Parameters

NameTypeDescription
config.addDeepLinkFieldsboolean

Add (true) to enable deep linking of additional fields in the query.

If not set, then false is used

default: false
config.endTimestampnumber

The end timestamp of the query, in UTC milliseconds.

If not set or set as 0, the current timestamp is used.

If the exact times are important, set the timeframe in the query itself (query parameter).

config.explainboolean

Add (true) or don't add (false) some additional information about the result to the response.

It helps to understand the query and how the result was calculated.

If not set, then false is used

default: false
config.offsetUtcnumber

Optional offset of local time to UTC time in minutes. Offset will be applied to Date fields encountered in the query.

Can be positive or negative. E.g. if the local time is UTC+02:00, the timeOffset is 120. If it is UTC-05:00, timeOffset is -300.

config.pageOffsetnumber

Optional offset of the requested results from the start of tabular results. Relates to pageSize.

E.g. on a query that might return 500 results, you might want to receive results in chunks of 50 rows.

this can be achieved by using pageSize=50, and setting pageOffset in subsequent calls.In the example adding pageOffset=50 returns result rows 51-100.

config.pageSizenumberOptional limit on how many of the actual query results should be returned in the tabular result.
config.query*requiredstring

The user session query to be executed. See USQL documentation page for syntax details.

You can find the available columns of the usersession table in the UserSession object.

Here is an example of the query: SELECT country, city, COUNT(*) FROM usersession GROUP BY country, city.

config.startTimestampnumber

The start timestamp of the query, in UTC milliseconds.

If not set or set as 0, 2 hours behind the current time is used.

If the exact times are important, set the timeframe in the query itself (query parameter).

Returns

Success. The response contains the result of the query.

Code example
import { rumUserSessionsClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data = await rumUserSessionsClient.getUsqlResultAsTable({
query: "...",
});

getUsqlResultAsTree

rumUserSessionsClient.getUsqlResultAsTree(config): Promise<UsqlResultAsTree>

Returns the result of the query as a tree structure

Required scope: environment-api:usersessionquerylanguage:read Required permission: environment:roles:viewer

To get a proper tree structure, you need to specify grouping in the query.

Parameters

NameTypeDescription
config.addDeepLinkFieldsboolean

Add (true) to enable deep linking of additional fields in the query.

If not set, then false is used

default: false
config.endTimestampnumber

The end timestamp of the query, in UTC milliseconds.

If not set or set as 0, the current timestamp is used.

If the exact times are important, set the timeframe in the query itself (query parameter).

config.explainboolean

Add (true) or don't add (false) some additional information about the result to the response.

It helps to understand the query and how the result was calculated.

If not set, then false is used

default: false
config.offsetUtcnumber

Optional offset of local time to UTC time in minutes. Offset will be applied to Date fields encountered in the query.

Can be positive or negative. E.g. if the local time is UTC+02:00, the timeOffset is 120. If it is UTC-05:00, timeOffset is -300.

config.query*requiredstring

The user session query to be executed. See USQL documentation page for syntax details.

You can find the available columns of the usersession table in the UserSession object.

Here is an example of the query: SELECT country, city, COUNT(*) FROM usersession GROUP BY country, city.

config.startTimestampnumber

The start timestamp of the query, in UTC milliseconds.

If not set or set as 0, 2 hours behind the current time is used.

If the exact times are important, set the timeframe in the query itself (query parameter).

Returns

Success. The response contains the result of the query.

Code example
import { rumUserSessionsClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data = await rumUserSessionsClient.getUsqlResultAsTree({
query: "...",
});

syntheticLocationsNodesAndConfigurationClient

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

getNode

syntheticLocationsNodesAndConfigurationClient.getNode(config): Promise<Node>

Lists properties of the specified synthetic node

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

Parameters

NameTypeDescription
config.nodeId*requiredstringThe ID of the required synthetic node.

Returns

Success

Code example
import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data = await syntheticLocationsNodesAndConfigurationClient.getNode({
nodeId: "...",
});

getNodes

syntheticLocationsNodesAndConfigurationClient.getNodes(abortSignal?): Promise<Nodes>

Lists all synthetic nodes available in your environment

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

{/ no parameters /}

Returns

Success

Code example
import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data = await syntheticLocationsNodesAndConfigurationClient.getNodes();

syntheticMonitorsClient

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

addMonitor

syntheticMonitorsClient.addMonitor(config): Promise<EntityIdDto>

Creates a new synthetic monitor

Required scope: environment-api:synthetic-monitors:write Required permission: environment:roles:manage-settings

Parameters

NameType
config.body*requiredSyntheticMonitorUpdate

Returns

Success. The new synthetic monitor has been created. The response contains the Dynatrace entity ID of the new monitor.

Code example
import { syntheticMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data = await syntheticMonitorsClient.addMonitor({
body: {
anomalyDetection: {
loadingTimeThresholds: {
enabled: false,
thresholds: [{ valueMs: 10 }],
},
outageHandling: {
globalOutage: false,
globalOutagePolicy: { consecutiveRuns: 10 },
localOutage: false,
localOutagePolicy: {
affectedLocations: 10,
consecutiveRuns: 10,
},
},
},
enabled: false,
frequencyMin: 10,
locations: ["..."],
manuallyAssignedApps: ["..."],
name: "...",
tags: [{ key: "..." }],
},
});

deleteMonitor

syntheticMonitorsClient.deleteMonitor(config): Promise<void>

Deletes the specified synthetic monitor

Required scope: environment-api:synthetic-monitors:write Required permission: environment:roles:manage-settings

Parameters

NameTypeDescription
config.monitorId*requiredstringThe ID of the synthetic monitor to be deleted.

{/ no returns /}

Code example
import { syntheticMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data = await syntheticMonitorsClient.deleteMonitor({
monitorId: "...",
});

getMonitor

syntheticMonitorsClient.getMonitor(config): Promise<SyntheticMonitor>

Gets parameters of the specified synthetic monitor

Required scope: environment-api:synthetic-monitors:read Required permission: environment:roles:manage-settings

Parameters

NameTypeDescription
config.monitorId*requiredstringThe ID of the required synthetic monitor

Returns

Success

Code example
import { syntheticMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data = await syntheticMonitorsClient.getMonitor({
monitorId: "...",
});

getMonitorsCollection

syntheticMonitorsClient.getMonitorsCollection(config): Promise<Monitors>

Lists all synthetic monitors in your Dynatrace environment

Required scope: environment-api:synthetic-monitors:read Required permission: environment:roles:manage-settings

The full list can be lengthy, but you can narrow it down by specifying filter query parameters.

Parameters

NameTypeDescription
config.assignedAppsArray<string>

Filters the resulting set of monitors to those assigned to the specified applications.

You can specify several applications in the following format: assignedApps=app1&assignedApps=app2. The monitor has to have all the specified applications assigned.

Specify Dynatrace entity IDs of applications here.

config.credentialIdstring

Filters the resulting set of monitors to those using the specified credential set.

Specify the ID of the credentials set here.

config.credentialOwnerstringFilters the resulting set of monitors to those using a credential owned by the specified user.
config.enabledbooleanFilters the resulting set of monitors to those which are enabled (true) or disabled (false).
config.locationstring

Filters the resulting set of monitors to those assigned to a specified Synthetic location.

Specify the ID of the location here.

config.managementZonenumber

Filters the resulting set of monitors to those which are part of the specified management zone.

Specify the ID of the management zone here.

config.tagArray<string>

Filters the resulting set of monitors by specified tags.

You can specify several tags in the following format: tag=tag1&tag=tag2. The monitor has to match all the specified tags.

In case of key-value tags, such as imported AWS or CloudFoundry tags use following format: [context]key:value.

config.typestringFilters the resulting set of monitors to those of the specified type: BROWSER or HTTP.

Returns

Success

Code example
import { syntheticMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data = await syntheticMonitorsClient.getMonitorsCollection();

replaceMonitor

syntheticMonitorsClient.replaceMonitor(config): Promise<void>

Updates parameters of the specified synthetic monitor

Required scope: environment-api:synthetic-monitors:write Required permission: environment:roles:manage-settings

Parameters

NameTypeDescription
config.body*requiredSyntheticMonitorUpdate
config.monitorId*requiredstringThe ID of the synthetic monitor to be updated.

{/ no returns /}

Code example
import { syntheticMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v1";

const data = await syntheticMonitorsClient.replaceMonitor({
monitorId: "...",
body: {
anomalyDetection: {
loadingTimeThresholds: {
enabled: false,
thresholds: [{ valueMs: 10 }],
},
outageHandling: {
globalOutage: false,
globalOutagePolicy: { consecutiveRuns: 10 },
localOutage: false,
localOutagePolicy: {
affectedLocations: 10,
consecutiveRuns: 10,
},
},
},
enabled: false,
frequencyMin: 10,
locations: ["..."],
manuallyAssignedApps: ["..."],
name: "...",
tags: [{ key: "..." }],
},
});

Types

ActiveGateConnectionInfo

Connectivity information for an Environment ActiveGate (except ActiveGate tokens)

NameType
communicationEndpointsstring
tenantTokenstring
tenantUUIDstring

ActiveGateInstallerVersions

A list of available versions of ActiveGate installer.

NameTypeDescription
availableVersionsArray<string>Available versions.

AgentInstallerMetaInfoDto

NameType
latestAgentVersionstring

AgentInstallerVersions

A list of available versions of OneAgent installer.

NameTypeDescription
availableVersionsArray<string>A list of available versions of OneAgent installer.

AgentPotentialProblem

One agent auto-update blocking problem for a specific version and OS, with a list of affected hosts.

NameTypeDescription
hostsArray<string>All hosts that are affected by the auto-update problem, given by ME Identifier
osTypeAgentPotentialProblemOsType
versionstringFormatted Installer version

AgentPotentialProblemsState

All agent potential auto-update problems aggregated over all servers for this tenant.

NameTypeDescription
autoUpdateProblemsArray<AgentPotentialProblem>List of all agent auto-update blocking problems

AgentProcessModuleConfigResponse

The response to a process module config request.

NameTypeDescription
propertiesArray<SectionProperty>The properties and their sections in this response.
revisionnumberThe new revision associated with the config.

AgentVersion

Defines the version of the agent currently running on the entity.

NameTypeDescription
majornumberThe major version number.
minornumberThe minor version number.
revisionnumberThe revision number.
sourceRevisionstringA string representation of the SVN revision number.
timestampstringA timestamp string: format "yyyymmdd-hhmmss

AnomalyDetection

The anomaly detection configuration.

NameType
loadingTimeThresholds*requiredLoadingTimeThresholdsPolicyDto
outageHandling*requiredOutageHandlingPolicy

BoshReleaseAvailableVersions

A list of available OneAgent versions for BOSH release tarballs.

NameTypeDescription
availableVersionsArray<string>A list of available OneAgent versions for BOSH release tarballs.

BoshReleaseChecksum

The checksum of the BOSH release tarball.

NameTypeDescription
sha256string

The checksum of the BOSH release tarball.

This is the sha256 hash of the installer file.

BrowserSyntheticMonitor

Browser synthetic monitor. Some fields are inherited from the base SyntheticMonitor model.

NameTypeDescription
anomalyDetectionAnomalyDetection
automaticallyAssignedApps*requiredArray<string>A set of automatically assigned applications.
createdFrom*requiredSyntheticMonitorCreatedFrom
enabled*requiredbooleanThe monitor is enabled (true) or disabled (false).
entityId*requiredstringThe entity ID of the monitor.
eventsArray<EventDto>A list of events for this monitor
frequencyMin*requirednumber

The frequency of the monitor, in minutes.

You can use one of the following values: 5, 10, 15, 30, and 60.

keyPerformanceMetricsKeyPerformanceMetrics
locations*requiredArray<string>

A list of locations from which the monitor is executed.

To specify a location, use its entity ID.

managementZones*requiredArray<ManagementZone>A set of management zones to which the monitor belongs to.
manuallyAssignedApps*requiredArray<string>A set of manually assigned applications.
name*requiredstringThe name of the monitor.
script*requiredSyntheticMonitorScript
tags*requiredArray<TagWithSourceInfo>A set of tags assigned to the monitor.
type*requiredSyntheticMonitorType

BrowserSyntheticMonitorUpdate

Browser synthetic monitor update. Some fields are inherited from base SyntheticMonitorUpdate model.

NameTypeDescription
anomalyDetectionAnomalyDetection
enabled*requiredbooleanThe monitor is enabled (true) or disabled (false).
frequencyMin*requirednumber

The frequency of the monitor, in minutes.

You can use one of the following values: 5, 10, 15, 30, and 60.

keyPerformanceMetricsKeyPerformanceMetrics
locations*requiredArray<string>

A list of locations from which the monitor is executed.

To specify a location, use its entity ID.

manuallyAssignedApps*requiredArray<string>A set of manually assigned applications.
name*requiredstringThe name of the monitor.
script*requiredSyntheticMonitorUpdateScript
tags*requiredArray<TagWithSourceInfo>

A set of tags assigned to the monitor.

You can specify only the value of the tag here and the CONTEXTLESS context and source 'USER' will be added automatically. But preferred option is usage of TagWithSourceDto model.

type*requiredSyntheticMonitorUpdateType

ClusterVersion

NameTypeDescription
versionstringThe version of the Dynatrace server.

ConnectionInfo

OneAgent connectivity information.

NameTypeDescription
communicationEndpointsArray<string>The list of endpoints to connect to the Dynatrace environment. The list is sorted by endpoint priority, descending.
formattedCommunicationEndpointsArray<string>The formatted list of endpoints to connect to the Dynatrace environment.
tenantTokenstringThe internal token that is used for authentication when OneAgent connects to the Dynatrace cluster to send data.
tenantUUIDstringThe ID of your Dynatrace environment.

DateProperty

A custom property of the user-action with a date value.

NameTypeDescription
keystringThe custom key of the property.
valueDateThe date value of the property.

DoubleProperty

A custom property of the user action with a Double value.

NameTypeDescription
keystringThe custom key of the property.
valuenumberThe floating-point numeric value of the property.

EntityIdDto

A DTO for entity ID.

NameTypeDescription
entityId*requiredstringEntity ID to be transferred

EntityShortRepresentation

The short representation of a Dynatrace entity.

NameTypeDescription
descriptionstringA short description of the Dynatrace entity.
id*requiredstringThe ID of the Dynatrace entity.
namestringThe name of the Dynatrace entity.

EventDto

NameTypeDescription
entityId*requiredstringEvent identifier
name*requiredstringEvent name
sequenceNumber*requirednumberEvent sequence number

GatewayInstallerMetaInfoDto

NameType
latestGatewayVersionstring

GlobalOutagePolicy

Global outage handling configuration.

NameTypeDescription
consecutiveRuns*requirednumberAlert if all locations are unable to access the web application X times consecutively.

Host

Information about the host.

NameTypeDescription
agentVersionAgentVersion
amiIdstring
autoInjectionHostAutoInjection
autoScalingGroupstring
awsInstanceIdstring
awsInstanceTypestring
awsNameTagstringThe name inherited from AWS.
awsSecurityGroupArray<string>
azureComputeModeNameHostAzureComputeModeName
azureEnvironmentstring
azureHostNamesArray<string>
azureResourceGroupNamestring
azureResourceIdstring
azureSiteNamesArray<string>
azureSkuHostAzureSku
azureVmNamestring
azureVmScaleSetNamestring
azureVmSizeLabelstring
azureZonestring
beanstalkEnvironmentNamestring
bitnessHostBitness
boshAvailabilityZonestringThe Cloud Foundry BOSH availability zone.
boshDeploymentIdstringThe Cloud Foundry BOSH deployment ID.
boshInstanceIdstringThe Cloud Foundry BOSH instance ID.
boshInstanceNamestringThe Cloud Foundry BOSH instance name.
boshNamestringThe Cloud Foundry BOSH name.
boshStemcellVersionstringThe Cloud Foundry BOSH stemcell version.
cloudPlatformVendorVersionstringDefines the cloud platform vendor version.
cloudTypeHostCloudType
consumedHostUnitsstringConsumed Host Units. Applicable only for Dynatrace classic licensing
cpuCoresnumber
customizedNamestringThe customized name of the entity
discoveredNamestringThe discovered name of the entity
displayNamestringThe name of the Dynatrace entity as displayed in the UI.
entityIdstringThe Dynatrace entity ID of the required entity.
esxiHostNamestring
firstSeenTimestampnumberThe timestamp of when the entity was first detected, in UTC milliseconds
fromRelationshipsHostFromRelationships
gceInstanceIdstringThe Google Compute Engine instance ID.
gceInstanceNamestringThe Google Compute Engine instance name.
gceMachineTypestringThe Google Compute Engine machine type.
gceProjectstringThe Google Compute Engine project.
gceProjectIdstringThe Google Compute Engine numeric project ID.
gcePublicIpAddressesArray<string>The public IP addresses of the Google Compute Engine.
gcpZonestringThe Google Cloud Platform Zone.
hostGroupHostGroup
hypervisorTypeHostHypervisorType
ipAddressesArray<string>
isMonitoringCandidateboolean
kubernetesClusterstringThe kubernetes cluster the entity is in.
kubernetesLabelsHostKubernetesLabels
kubernetesNodestringThe kubernetes node the entity is in.
lastSeenTimestampnumberThe timestamp of when the entity was last detected, in UTC milliseconds
localHostNamestring
localIpstring
logicalCpuCoresnumber
logicalCpusnumberThe AIX instance logical CPU count.
managementZonesArray<EntityShortRepresentation>The management zones that the entity is part of.
monitoringModeHostMonitoringMode
networkZoneIdstringThe ID of network zone the entity is in.
oneAgentCustomHostNamestringThe custom name defined in OneAgent config.
openStackInstaceTypestring
openstackAvZonestring
openstackComputeNodeNamestring
openstackProjectNamestring
openstackSecurityGroupsArray<string>
openstackVmNamestring
osArchitectureHostOsArchitecture
osTypeHostOsType
osVersionstring
paasAgentVersionsArray<AgentVersion>The versions of the PaaS agents currently running on the entity.
paasMemoryLimitnumber
paasTypeHostPaasType
publicHostNamestring
publicIpstring
scaleSetNamestring
simultaneousMultithreadingnumberThe AIX instance simultaneous threads count.
softwareTechnologiesArray<TechnologyInfo>
tagsArray<TagInfo>The list of entity tags.
toRelationshipsHostToRelationships
userLevelHostUserLevel
virtualCpusnumberThe AIX instance virtual CPU count.
vmwareNamestring
zosCPUModelNumberstringThe CPU model number.
zosCPUSerialNumberstringThe CPU serial number.
zosLpaNamestringName of the LPAR.
zosSystemNamestringName of the system.
zosTotalGeneralPurposeProcessorsnumberNumber of assigned processors for this LPAR.
zosTotalPhysicalMemorynumberMemory assigned to the host (Terabyte).
zosTotalZiipProcessorsnumberNumber of assigned support processors for this LPAR.
zosVirtualizationstringType of virtualization on the mainframe.

HostAgentInfo

OneAgent deployment on a host.

NameTypeDescription
activebooleanOneAgent is active (true) or inactive (false).
autoUpdateSettingHostAgentInfoAutoUpdateSetting
availabilityStateHostAgentInfoAvailabilityState
availableVersionsArray<string>A list of versions OneAgent can be updated to.
configuredMonitoringEnabledbooleanMonitoring is enabled (true) or disabled (false) in the OneAgent configuration.
configuredMonitoringModeHostAgentInfoConfiguredMonitoringMode
currentActiveGateIdnumber

This field is deprecated and provided for backward compatibility.

Use the currentActiveGateIds field instead.

currentActiveGateIdsArray<string>The list of ActiveGate IDs of ActiveGates to which OneAgent is currently connected.
currentNetworkZoneIdstringThe ID of the network zone that OneAgent is using.
detailedAvailabilityStateHostAgentInfoDetailedAvailabilityState
faultyVersionbooleanOneAgent version is faulty (true) or not (false).
hostInfoHost
modulesArray<ModuleInfo>A list of code modules deployed on the host.
monitoringTypeHostAgentInfoMonitoringType
pluginsArray<PluginInfo>A list of plugins deployed on the host.
updateStatusHostAgentInfoUpdateStatus

HostFromRelationships

NameType
isNetworkClientOfHostArray<string>

HostGroup

NameTypeDescription
meIdstringThe Dynatrace entity ID of the host group.
namestringThe name of the Dynatrace entity, displayed in the UI.

HostKubernetesLabels

The kubernetes labels defined on the entity.

HostToRelationships

NameType
isNetworkClientOfHostArray<string>
isProcessOfArray<string>
isSiteOfArray<string>
runsOnArray<string>

HostsListPage

A list of hosts with OneAgent deployment information for each host.

NameTypeDescription
hostsArray<HostAgentInfo>A list of hosts with OneAgent deployment information for each host.
nextPageKeystring

The cursor for the next page of results.

Has the value of null on the last page.

There might be another page of results even if the current page is empty.

percentageOfEnvironmentSearchednumberThe progress of the environment search, in percent.

HttpSyntheticMonitor

HTTP synthetic monitor. Some fields are inherited from base SyntheticMonitor model.

NameTypeDescription
anomalyDetectionAnomalyDetection
automaticallyAssignedApps*requiredArray<string>A set of automatically assigned applications.
createdFrom*requiredSyntheticMonitorCreatedFrom
enabled*requiredbooleanThe monitor is enabled (true) or disabled (false).
entityId*requiredstringThe entity ID of the monitor.
frequencyMin*requirednumber

The frequency of the monitor, in minutes.

You can use one of the following values: 5, 10, 15, 30, and 60.

locations*requiredArray<string>

A list of locations from which the monitor is executed.

To specify a location, use its entity ID.

managementZones*requiredArray<ManagementZone>A set of management zones to which the monitor belongs to.
manuallyAssignedApps*requiredArray<string>A set of manually assigned applications.
name*requiredstringThe name of the monitor.
requestsArray<RequestDto>A list of events for this monitor
script*requiredSyntheticMonitorScript
tags*requiredArray<TagWithSourceInfo>A set of tags assigned to the monitor.
type*requiredSyntheticMonitorType

HttpSyntheticMonitorUpdate

HTTP synthetic monitor update. Some fields are inherited from base SyntheticMonitorUpdate model.

NameTypeDescription
anomalyDetectionAnomalyDetection
enabled*requiredbooleanThe monitor is enabled (true) or disabled (false).
frequencyMin*requirednumber

The frequency of the monitor, in minutes.

You can use one of the following values: 5, 10, 15, 30, and 60.

locations*requiredArray<string>

A list of locations from which the monitor is executed.

To specify a location, use its entity ID.

manuallyAssignedApps*requiredArray<string>A set of manually assigned applications.
name*requiredstringThe name of the monitor.
script*requiredSyntheticMonitorUpdateScript
tags*requiredArray<TagWithSourceInfo>

A set of tags assigned to the monitor.

You can specify only the value of the tag here and the CONTEXTLESS context and source 'USER' will be added automatically. But preferred option is usage of TagWithSourceDto model.

type*requiredSyntheticMonitorUpdateType

ImageDto

NameTypeDescription
source*requiredstringImage location
tagnull | stringImage tag

KeyPerformanceMetrics

The key performance metrics configuration.

NameType
loadActionKpm*requiredKeyPerformanceMetricsLoadActionKpm
xhrActionKpm*requiredKeyPerformanceMetricsXhrActionKpm

LatestLambdaLayerNames

Latest OneAgent lambda version names available

NameType
collectorstring
javastring
java_with_collectorstring
nodejsstring
nodejs_with_collectorstring
pythonstring
python_with_collectorstring

LoadingTimeThreshold

The performance threshold rule.

NameTypeDescription
eventIndexnumberSpecify the event to which an ACTION threshold applies.
requestIndexnumberSpecify the request to which an ACTION threshold applies.
type*requiredLoadingTimeThresholdType
valueMs*requirednumberNotify if monitor takes longer than X milliseconds to load.

LoadingTimeThresholdsPolicyDto

Performance thresholds configuration.

NameTypeDescription
enabled*requiredbooleanPerformance threshold is enabled (true) or disabled (false).
thresholds*requiredArray<LoadingTimeThreshold>The list of performance threshold rules.

LocalOutagePolicy

Local outage handling configuration.

Alert if affectedLocations of locations are unable to access the web application consecutiveRuns times consecutively.

NameTypeDescription
affectedLocations*requirednumberThe number of affected locations to trigger an alert.
consecutiveRuns*requirednumberThe number of consecutive fails to trigger an alert.

LongProperty

A custom property of the user action with a Long value.

NameTypeDescription
keystringThe custom key of the property.
valuenumberThe Long value of the property.

ManagementZone

The configuration of a management zone.

NameTypeDescription
id*requiredstringThe ID of the management zone.
name*requiredstringThe name of the management zone.

ManualApplication

Parameters of a manually injected application.

NameTypeDescription
applicationIdstringThe Dynatrace entity ID of the application.
displayNamestringThe name of the application.
monitoringEnabledbooleanMonitoring is enabled (true) or disabled (false).
revisionstringThe application settings revision.

ModuleInfo

OneAgent code module.

NameTypeDescription
instancesArray<ModuleInstance>A list of instances of the code module.
moduleTypeModuleInfoModuleType

ModuleInstance

An instance of the OneAgent code module.

NameTypeDescription
activebooleanThe code module instance is active (true) or inactive (false).
faultyVersionbooleanThe code module version is faulty (true) or not (false).
instanceNamestringThe name of the instance.
moduleVersionstringThe version of the code module.

MonitorCollectionElement

The short representation of a synthetic monitor.

NameTypeDescription
enabled*requiredbooleanThe state of a synthetic monitor.
entityId*requiredstringThe ID of a synthetic object.
name*requiredstringThe name of a synthetic object.
type*requiredMonitorCollectionElementType

Monitors

A list of synthetic monitors

NameTypeDescription
monitors*requiredArray<MonitorCollectionElement>The list of synthetic monitors.

Node

Configuration of a synthetic node.

A synthetic node is an ActiveGate that is able to execute synthetic monitors.

NameTypeDescription
activeGateVersion*requiredstringThe version of the Active Gate.
autoUpdateEnabled*requiredbooleanThe Active Gate has the Auto update option enabled ('true') or not ('false')
browserMonitorsEnabled*requiredbooleanThe synthetic node is able to execute browser monitors (true) or not (false).
browserType*requiredstringThe browser type.
browserVersion*requiredstringThe browser version.
entityId*requiredstringThe ID of the synthetic node.
healthCheckStatus*requiredstringThe health check status of the synthetic node.
hostname*requiredstringThe hostname of the synthetic node.
ips*requiredArray<string>The IP of the synthetic node.
oneAgentRoutingEnabled*requiredbooleanThe Active Gate has the One Agent routing enabled ('true') or not ('false').
operatingSystem*requiredstringThe Active Gate's host operating system.
playerVersion*requiredstringThe version of the synthetic player.
status*requiredstringThe status of the synthetic node.
version*requiredstringThe version of the synthetic node.

NodeCollectionElement

The short representation of a synthetic object. Only contains the ID and the display name.

NameTypeDescription
activeGateVersion*requiredstringThe version of the Active Gate.
autoUpdateEnabled*requiredbooleanThe Active Gate has the Auto update option enabled ('true') or not ('false')
browserMonitorsEnabled*requiredbooleanBrowser check capabilities enabled flag.
entityId*requiredstringThe ID of a node.
healthCheckStatus*requiredstringThe health check status of the synthetic node.
hostname*requiredstringThe hostname of a node.
ips*requiredArray<string>The IP of a node.
oneAgentRoutingEnabled*requiredbooleanThe Active Gate has the One Agent routing enabled ('true') or not ('false').
operatingSystem*requiredstringThe Active Gate's host operating system.
playerVersion*requiredstringThe version of the synthetic player.
status*requiredstringThe status of the synthetic node.
version*requiredstringThe version of a node

Nodes

A list of synthetic nodes

NameTypeDescription
nodes*requiredArray<NodeCollectionElement>A list of synthetic nodes

OneAgentInstallerChecksum

The checksum of the OneAgent installer.

NameTypeDescription
sha256string

The checksum of the OneAgent installer.

This is the sha256 hash of the installer file.

OutageHandlingPolicy

Outage handling configuration.

NameTypeDescription
globalOutage*requiredbooleanWhen enabled (true), generate a problem and send an alert when the monitor is unavailable at all configured locations.
globalOutagePolicynull | GlobalOutagePolicy
localOutage*requiredbooleanWhen enabled (true), generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location.
localOutagePolicy*requiredLocalOutagePolicy
retryOnErrorbooleanSchedule retry if browser monitor execution results in a fail. For HTTP monitors this property is ignored. default: true

PluginInfo

OneAgent plugin.

NameTypeDescription
instancesArray<PluginInstance>A list of instances of the plugin.
pluginNamestringThe name of the plugin.

PluginInstance

An instance of the OneAgent plugin.

NameTypeDescription
pluginVersionstringThe version of the plugin.
statestringThe state of the plugin instance.

RequestDto

NameTypeDescription
entityId*requiredstringRequest identifier
name*requiredstringRequest name
sequenceNumber*requirednumberRequest sequence number

SectionProperty

A single agent property with it's associated section.

NameTypeDescription
keystringThe property key.
sectionstringThe section this property belongs to.
valuestringThe property value.

StringProperty

A custom property of the user action with a string value.

NameTypeDescription
keystringThe custom key of the property.
valuestringThe string value of the property.

SyntheticMonitor

The synthetic monitor.

The actual set of fields depends the type of the monitor. Find the list of actual objects in the description of the type field or see Synthetic monitors API - JSON models.

NameTypeDescription
anomalyDetectionAnomalyDetection
automaticallyAssignedApps*requiredArray<string>A set of automatically assigned applications.
createdFrom*requiredSyntheticMonitorCreatedFrom
enabled*requiredbooleanThe monitor is enabled (true) or disabled (false).
entityId*requiredstringThe entity ID of the monitor.
frequencyMin*requirednumber

The frequency of the monitor, in minutes.

You can use one of the following values: 5, 10, 15, 30, and 60.

locations*requiredArray<string>

A list of locations from which the monitor is executed.

To specify a location, use its entity ID.

managementZones*requiredArray<ManagementZone>A set of management zones to which the monitor belongs to.
manuallyAssignedApps*requiredArray<string>A set of manually assigned applications.
name*requiredstringThe name of the monitor.
script*requiredSyntheticMonitorScript
tags*requiredArray<TagWithSourceInfo>A set of tags assigned to the monitor.
type*requiredSyntheticMonitorType

SyntheticMonitorUpdate

The synthetic monitor update.

The actual set of fields depends the type of the monitor. Find the list of actual objects in the description of the type field or see Synthetic monitors API - JSON models.

NameTypeDescription
anomalyDetectionAnomalyDetection
enabled*requiredbooleanThe monitor is enabled (true) or disabled (false).
frequencyMin*requirednumber

The frequency of the monitor, in minutes.

You can use one of the following values: 5, 10, 15, 30, and 60.

locations*requiredArray<string>

A list of locations from which the monitor is executed.

To specify a location, use its entity ID.

manuallyAssignedApps*requiredArray<string>A set of manually assigned applications.
name*requiredstringThe name of the monitor.
script*requiredSyntheticMonitorUpdateScript
tags*requiredArray<TagWithSourceInfo>

A set of tags assigned to the monitor.

You can specify only the value of the tag here and the CONTEXTLESS context and source 'USER' will be added automatically. But preferred option is usage of TagWithSourceDto model.

type*requiredSyntheticMonitorUpdateType

TagInfo

Tag of a Dynatrace entity.

NameTypeDescription
context*requiredTagInfoContext
key*requiredstring

The key of the tag.

Custom tags have the tag value here.

valuestring

The value of the tag.

Not applicable to custom tags.

TagWithSourceInfo

Tag with source of a Dynatrace entity.

NameTypeDescription
context*requiredTagWithSourceInfoContext
key*requiredstring

The key of the tag.

Custom tags have the tag value here.

sourceTagWithSourceInfoSource
valuestring

The value of the tag.

Not applicable to custom tags.

TechnologyInfo

NameType
editionstring
typestring
versionstring

UserSession

A user session, encompassing multiple user actions and additional information about a user's visit.

NameTypeDescription
appVersionstring

The version of the application where the user session has been recorded.

This information is provided by another integration, such as OpenKit.

applicationTypeUserSessionApplicationType
bounceboolean

The user session has (true) or doesn't have (false) a bounce.

A bounce means there is only one (or less) user action in the user session.

browserFamilystringThe family of the browser used for the user session.
browserMajorVersionstringThe version of the browser used for the user session.
browserMonitorIdstringThe ID of the Synthetic browser monitor that created the session.
browserMonitorNamestringThe name of the Synthetic browser monitor that created the session.
browserTypestringThe type of browser used for the user session.
carrierstringThe carrier information of the mobile user session.
citystringThe city from which the user session originates (based on the IP address).
clientTimeOffsetnumberThe time offset of the client, in milliseconds
clientTypestring

Additional information about the client.

This field can not be queried via the user session query language. Use the browserType field instead.

connectionTypeUserSessionConnectionType
continentstringThe continent from which the user session originates (based on the IP address).
countrystringThe country from which the user session originates (based on the IP address).
crashGroupIdstring

If a mobile session crashed, this is the ID of the group to which the crashed session belongs.

If the session did not crash or the session is not a mobile session, it has the null value.

datePropertiesArray<DateProperty>A list of custom properties of the user session with date values.
devicestringThe detected device used for the user session.
displayResolutionUserSessionDisplayResolution
doublePropertiesArray<DoubleProperty>A list of custom properties of the user session with floating-point numerical values.
durationnumber

The duration of the user session, in milliseconds.

This is calculated as the amount of time between the start of the first user action and the end of the last user action.

endReasonUserSessionEndReason
endTimenumberThe timestamp of the last user action in the user session, in UTC milliseconds.
errorsArray<UserSessionErrors>A list of errors recorded in the user session.
eventsArray<UserSessionEvents>A list of additional events recorded in the user session.
hasCrashbooleanThe user session includes (true) or doesn't include (false) a crash.
hasErrorbooleanThe user session includes (true) or doesn't include (false) an error.
hasSessionReplaybooleanSession Replay is (true) or is not (false) available for the session.
internalUserIdstringThe unique ID of the user that triggered the user session.
ipstringThe IP address (IPv4 or IPv6) from which the user session originates.
ispstringThe internet service provider from which the user session originates (based on the IP address).
longPropertiesArray<LongProperty>A list of custom properties of the user session with integer (short or long) values.
manufacturerstringThe detected manufacturer of the device used for the user session.
matchingConversionGoalsArray<string>

A list of conversion goals achieved by the user session.

Additionally, you can define conversion goals for a single user action.

matchingConversionGoalsCountnumberThe number of conversion goals achieved by the user session.
networkTechnologystringThe network technology information of the mobile user session.
newUserbooleanThe user is a first-time (true) or a returning user (false).
numberOfRageClicksnumberThe number of rage clicks detected in the user session.
numberOfRageTapsnumberThe number of rage taps detected in the user session.
osFamilystringThe type of operating system used for the user session.
osVersionstringThe version of the operating system used for the user session.
partNumbernumberUser sessions can be split into multiple parts for various technical reasons (e.g. after 200 user actions). This partNumber represents the number of each part of the overall user session.
reasonForNoSessionReplayUserSessionReasonForNoSessionReplay
reasonForNoSessionReplayMobileUserSessionReasonForNoSessionReplayMobile
regionstringThe region from which the user session originates (based on the IP address).
replayEndnumberThe timestamp of the Session Replay end, in UTC milliseconds.
replayStartnumberThe timestamp of the Session Replay start, in UTC milliseconds.
rootedOrJailbrokenboolean

The mobile device is rooted/jailbroken (true) or genuine (false).

Has the value of null if the status is unknown or undefined. Custom applications always report unknown/undefined.

screenHeightnumberThe detected screen height of the device used for the user session.
screenOrientationUserSessionScreenOrientation
screenWidthnumberThe detected screen width of the device used for the user session.
startTimenumberThe timestamp of the first user action in the user session, in UTC milliseconds.
stringPropertiesArray<StringProperty>A list of custom properties of the user session with string values.
syntheticEventsArray<UserSessionSyntheticEvent>A list of synthetic events recorded in the user session.
tenantIdstring

The ID of the Dynatrace environment that captured the user session.

This field can not be queried via the User Session Query Language.

totalErrorCountnumberThe number of errors detected in the user session.
totalLicenseCreditCountnumberNumber of resulting billed sessions: Dynatrace classic licensing, Dynatrace Platform Subscription.
userActionCountnumberThe number of user actions in the user session.
userActionsArray<UserSessionUserAction>A list of user actions recorded in the user session.
userExperienceScoreUserSessionUserExperienceScore
userIdstringThe user ID provided for the user session by session tagging.
userSessionIdstringThe unique ID of the user session.
userTypeUserSessionUserType

UserSessionErrors

The error of a user session.

NameTypeDescription
applicationstringThe name of the application, based on the configured detection rules.
domainstringThe DNS domain where the error has been recorded.
internalApplicationIdstring

The Dynatrace entity ID of the application.

This information is useful when calling various REST APIs, for example, as a key for time series queries.

namestringThe name of the error.
startTimenumberThe timestamp of the error, in UTC milliseconds.
typeUserSessionErrorsType

UserSessionEvents

The external event of a user session.

NameTypeDescription
applicationstringThe name of the application, based on the configured detection rules.
domainstringThe DNS domain where the event has been recorded.
internalApplicationIdstring

The Dynatrace entity ID of the application.

This information is useful when calling various REST APIs, for example, as a key for time series queries.

metadatastringThe metadata attached to the event.
namestringThe name of the event.
pagestringThe name of the page the user navigated to during a page change event.
pageGroupstringThe page group is automatically derived from the page.
pageReferrerstringThe name of the previous page from which the user navigated from during a page change event.
pageReferrerGroupstringThe page referrer group is automatically derived from the page referrer.
startTimenumberThe timestamp of the event, in UTC milliseconds.
typeUserSessionEventsType

UserSessionSyntheticEvent

A synthetic event of a user session.

NameTypeDescription
errorCodenumberThe error code of the error that occurred during this event.
errorNamestringDescription of the error that occurred during this event.
namestringThe name of the synthetic event.
sequenceNumbernumberThe sequence number of the synthetic event in scope of the complete browser monitor.
syntheticEventIdstringThe Dynatrace entity ID for the synthetic event.
timestampnumberThe timestamp when the synthetic event was simulated, in UTC milliseconds.
typestringThe type of the synthetic event. For example click or keystroke.

UserSessionUserAction

A user action.

A user action is a single action performed by the user as part of a user session, for example a mouse click.

NameTypeDescription
apdexCategoryUserSessionUserActionApdexCategory
applicationstringThe name of the application where the user action has been recorded.
cdnBusyTimenumberThe time spent waiting for CDN resources for the user action, in milliseconds.
cdnResourcesnumberThe number of resources fetched from a CDN for the user action.
cumulativeLayoutShiftnumber

The cumulative layout shift (CLS) is the total amount of all individual scores for every unexpected layout shift that occurs during the entire lifespan of the page.

The CLS is an important user-centric metric for measuring visual stability. It quantifies how often users experience unexpected layout shifts. A low CLS indicates that the page is delightful.

customErrorCountnumberThe total number of custom errors during the user action.
datePropertiesArray<DateProperty>A list of custom properties of the user session with date values.
documentInteractiveTimenumberThe amount of time spent until the document for the user action became interactive, in milliseconds.
domCompleteTimenumberThe amount of time until the DOM tree is completed, in milliseconds.
domContentLoadedTimenumberThe amount of time until the DOM tree is loaded, in milliseconds.
domainstringThe DNS domain where the user action has been recorded.
doublePropertiesArray<DoubleProperty>A list of custom properties of the user session with floating-point numerical values.
durationnumber

The duration of the user action, in milliseconds.

This is calculated as the of time between the start and the end timestamps of the user action.

endTimenumberThe end timestamp of the user action, in UTC milliseconds.
firstInputDelaynumber

The first input delay (FID) is the time (in milliseconds) that the browser took to respond to the first user input.

The FID is an important user-centric metric for measuring load responsiveness. It quantifies the user experience when trying to interact with unresponsive pages. A low FID indicates that the page is usable.

firstPartyBusyTimenumberThe time spent waiting for resources from the originating server for the user action, in milliseconds.
firstPartyResourcesnumberThe number of resources fetched from the originating server for the user action.
frontendTimenumberThe amount of time spent on the frontend rendering for the user action, in milliseconds.
hasCrashbooleanThe user action has (true) or doesn't have (false) a crash.
internalApplicationIdstring

The Dynatrace entity ID of the application where the user action has been recorded.

This information is useful when calling various REST APIs, for example as a key for time series queries.

internalKeyUserActionIdstringThe Dynatrace entity ID of the key user action.
javascriptErrorCountnumberThe total number of Javascript errors during the user action.
keyUserActionbooleanThe action is (true) or is not (false) a key action.
largestContentfulPaintnumber

The largest contentful paint (LCP) is the time (in milliseconds) that the largest element on the page took to render.

The LCP is an important user-centric metric for measuring load speed. It marks the point when the page's main content is likely loaded. A low LCP indicates that the page loads quickly.

loadEventEndnumberThe amount of time until the load event ended, in milliseconds.
loadEventStartnumberThe amount of time until the load event started, in milliseconds.
longPropertiesArray<LongProperty>A list of custom properties of the user session with integer (short or long) values.
matchingConversionGoalsArray<string>

A list of conversion goals achieved by the user action.

Additionally, you can define conversion goals for a user session as a whole.

namestring

The name of the user action.

Typically, this is the name of the page that is loaded as part of a user action or a textual description of the action, such as a mouse click.

navigationStartnumberThe timestamp of the navigation start, in UTC milliseconds.
networkTimenumberThe amount of time spent on the data transfer for the user action, in milliseconds.
requestErrorCountnumberThe total number of request errors during the user action.
requestStartnumberThe amount of time until the request started, in milliseconds.
responseEndnumberThe amount of time until the response ended, in milliseconds.
responseStartnumberThe amount of time until the response started, in milliseconds.
serverTimenumberThe amount of time spent on the server-side processing for the user action, in milliseconds.
speedIndexnumber

The speed index of the user action, in milliseconds.

This is calculated as average time it takes for all visible parts of a page to display.

startTimenumberThe start timestamp of the user action, in UTC milliseconds.
stringPropertiesArray<StringProperty>A list of custom properties of the user session with string values.
syntheticEventstringThe name of the Synthetic event that triggered the user action.
syntheticEventIdstringThe ID of the Synthetic event that triggered the user action.
targetUrlstringThe target URL of the user action.
thirdPartyBusyTimenumberThe time spent waiting for third party resources for the user action, in milliseconds.
thirdPartyResourcesnumberThe number of third party resources loaded for the user action.
totalBlockingTimenumberThe total blocking time is the total time (in milliseconds) between the first contentful paint and the time to interactive, during which the browser has been blocked long enough to prevent input responsiveness.
typeUserSessionUserActionType
userActionPropertyCountnumberThe total number of properties in the user action.
visuallyCompleteTimenumberThe amount of time until the page is visually complete, in milliseconds.

UsqlResultAsTable

The user session query result as a table.

NameTypeDescription
additionalColumnNamesArray<string>

A list of columns in the additionalValues table.

Only present if the endpoint was called with deepLinkFields=true parameter.

additionalValuesArray<Array<Record<string | any>>>

A list of data rows.

Each array element represents a row in the table of additionally linked fields.

The size of each data row and the order of the elements correspond to the additionalColumnNames content.

Only present if the endpoint was called with deepLinkFields=true parameter.

columnNamesArray<string>A list of columns in the result table.
explanationsArray<string>

Additional information about the query and the result, that helps to understand the query and how the result was calculated.

Only appears when the explain parameter is set to true.

Example: The number of results was limited to the default of 50. Use the LIMIT clause to increase or decrease this limit.

extrapolationLevelnumber

The extrapolation level of the result.

To improve performance, some results may be calculated from a subset of actual data. The extrapolation level indicates the share of actual data in the result.

The number is the denominator of a fraction and indicates the amount of actual data. The value 1 means that the result contains only the actual data. The value 4 means that result is calculated using 1/4 of the actual data.

If you need the analysis to be based on the actual data, reduce the timeframe of your query. For example, in case of extrapolation level of 4, try to use 1/4 of the original timeframe.

valuesArray<Array<Record<string | any>>>

A list of data rows.

Each array element represents a row in the result table.

The size of each data row and the order of the elements correspond to the columnNames content.

UsqlResultAsTree

The user session query result as a tree.

NameTypeDescription
additionalColumnNamesArray<string>

A list of columns in the additionalValues table.

Only present if the endpoint was called with deepLinkFields=true parameter.

additionalValuesArray<Array<Record<string | any>>>

A list of data rows.

Each array element represents a row in the table of additionally linked fields.

The size of each data row and the order of the elements correspond to the additionalColumnNames content.

Only present if the endpoint was called with deepLinkFields=true parameter.

branchNamesArray<string>

A list of branches of the tree.

Typically, these are fields from the SELECT clause, that have been used in the GROUP BY clause.

explanationsArray<string>

Additional information about the query and the result, that helps to understand the query and how the result was calculated.

Only appears when the explain parameter is set to true.

Example: The number of results was limited to the default of 50. Use the LIMIT clause to increase or decrease this limit.

extrapolationLevelnumber

The extrapolation level of the result.

To improve performance, some results may be calculated from a subset of actual data. The extrapolation level indicates the share of actual data in the result.

The number is the denominator of a fraction and indicates the amount of actual data. The value 1 means that the result contains only the actual data. The value 4 means that result is calculated using 1/4 of the actual data.

If you need the analysis to be based on the actual data, reduce the timeframe of your query. For example, in case of extrapolation level of 4, try to use 1/4 of the original timeframe.

leafNamesArray<string>

A list of leaves on each tree branch.

Typically, these are fields from the SELECT clause, that have not been used in the GROUP BY clause.

valuesUsqlResultAsTreeValues

Enums

AgentPotentialProblemOsType

Installer OS type

Enum keys

Aix | Darwin | Hpux | Linux | Solaris | Windows | Zos

DownloadAgentInstallerWithVersionPathInstallerType

Enum keys

Default | DefaultUnattended | Mainframe | Paas | PaasSh

DownloadAgentInstallerWithVersionPathOsType

Enum keys

Aix | Solaris | Unix | Windows | Zos

DownloadAgentInstallerWithVersionQueryArch

Enum keys

All | Arm | Ppc | Ppcle | S390 | Sparc | X86

DownloadAgentInstallerWithVersionQueryBitness

Enum keys

All | _32 | _64

DownloadAgentInstallerWithVersionQueryFlavor

Enum keys

Default | Multidistro | Musl

DownloadAgentInstallerWithVersionQueryIncludeItem

Enum keys

All | Apache | Dotnet | Envoy | Go | Java | Nginx | Nodejs | Php | Sdk

DownloadAgentOrchestrationSignatureWithVersionPathOrchestrationType

Enum keys

Ansible | Puppet

DownloadAgentOrchestrationWithVersionPathOrchestrationType

Enum keys

Ansible | Puppet

DownloadBoshReleaseWithVersionPathOsType

Enum keys

Unix | Windows

DownloadGatewayInstallerWithVersionPathOsType

Enum keys

Unix | Windows

DownloadGatewayInstallerWithVersionQueryArch

Enum keys

All | Amd64 | S390

DownloadLatestAgentInstallerPathInstallerType

Enum keys

Default | DefaultUnattended | Mainframe | Paas | PaasSh

DownloadLatestAgentInstallerPathOsType

Enum keys

Aix | Solaris | Unix | Windows | Zos

DownloadLatestAgentInstallerQueryArch

Enum keys

All | Arm | Ppc | Ppcle | S390 | Sparc | X86

DownloadLatestAgentInstallerQueryBitness

Enum keys

All | _32 | _64

DownloadLatestAgentInstallerQueryFlavor

Enum keys

Default | Multidistro | Musl

DownloadLatestAgentInstallerQueryIncludeItem

Enum keys

All | Apache | Dotnet | Envoy | Go | Java | Nginx | Nodejs | Php | Sdk

DownloadLatestAgentOrchestrationPathOrchestrationType

Enum keys

Ansible | Puppet

DownloadLatestAgentOrchestrationSignaturePathOrchestrationType

Enum keys

Ansible | Puppet

DownloadLatestGatewayInstallerPathOsType

Enum keys

Unix | Windows

DownloadLatestGatewayInstallerQueryArch

Enum keys

All | Amd64 | S390

GetActiveGateInstallerAvailableVersionsPathOsType

Enum keys

Unix | Windows

GetActiveGateInstallerAvailableVersionsQueryArch

Enum keys

All | Amd64 | S390

GetAgentInstallerAvailableVersionsPathInstallerType

Enum keys

Default | DefaultUnattended | Mainframe | Paas | PaasSh

GetAgentInstallerAvailableVersionsPathOsType

Enum keys

Aix | Solaris | Unix | Windows | Zos

GetAgentInstallerAvailableVersionsQueryArch

Enum keys

All | Arm | Ppc | Ppcle | S390 | Sparc | X86

GetAgentInstallerAvailableVersionsQueryFlavor

Enum keys

Default | Multidistro | Musl

GetAgentInstallerMetaInfoPathInstallerType

Enum keys

Default | DefaultUnattended | Mainframe | Paas | PaasSh

GetAgentInstallerMetaInfoPathOsType

Enum keys

Aix | Solaris | Unix | Windows | Zos

GetAgentInstallerMetaInfoQueryArch

Enum keys

All | Arm | Ppc | Ppcle | S390 | Sparc | X86

GetAgentInstallerMetaInfoQueryBitness

Enum keys

All | _32 | _64

GetAgentInstallerMetaInfoQueryFlavor

Enum keys

Default | Multidistro | Musl

GetAgentInstallerWithVersionChecksumPathInstallerType

Enum keys

Paas

GetAgentInstallerWithVersionChecksumPathOsType

Enum keys

Aix | Solaris | Unix | Windows | Zos

GetAgentInstallerWithVersionChecksumQueryArch

Enum keys

All | Arm | Ppc | Ppcle | S390 | Sparc | X86

GetAgentInstallerWithVersionChecksumQueryBitness

Enum keys

All | _32 | _64

GetAgentInstallerWithVersionChecksumQueryFlavor

Enum keys

Default | Multidistro | Musl

GetAgentInstallerWithVersionChecksumQueryIncludeItem

Enum keys

All | Apache | Dotnet | Envoy | Go | Java | Nginx | Nodejs | Php | Sdk

GetBoshReleaseAvailableVersionsPathOsType

Enum keys

Unix | Windows

GetBoshReleaseChecksumPathOsType

Enum keys

Unix | Windows

GetGatewayInstallerMetaInfoPathOsType

Enum keys

Unix | Windows

GetGatewayInstallerMetaInfoQueryArch

Enum keys

All | Amd64 | S390

GetHostsWithSpecificAgentsQueryAgentVersionIs

Enum keys

Equal | Greater | GreaterEqual | Lower | LowerEqual

GetHostsWithSpecificAgentsQueryAutoInjection

Enum keys

DisabledManually | DisabledOnInstallation | DisabledOnSanityCheck | Enabled | FailedOnInstallation

GetHostsWithSpecificAgentsQueryAutoUpdateSetting

Enum keys

Disabled | Enabled

GetHostsWithSpecificAgentsQueryAvailabilityState

Enum keys

Crashed | Lost | Monitored | PreMonitored | Shutdown | UnexpectedShutdown | Unknown | Unmonitored

GetHostsWithSpecificAgentsQueryCloudType

Enum keys

Azure | Ec2 | GoogleCloudPlatform | Openstack | Oracle | Unrecognized

GetHostsWithSpecificAgentsQueryDetailedAvailabilityState

Enum keys

CrashedFailure | CrashedUnknown | LostAgentUpgradeFailed | LostConnection | LostUnknown | Monitored | MonitoredAgentEnabled | MonitoredAgentRegistered | MonitoredAgentUpgradeStarted | MonitoredAgentVersionAccepted | MonitoredEnabled | PreMonitored | ShutdownAgentLost | ShutdownGraceful | ShutdownSpotInstance | ShutdownStopped | ShutdownUnknown | ShutdownUnknownUnexpected | Unknown | UnmonitoredAgentDisabled | UnmonitoredAgentLost | UnmonitoredAgentRestartTriggered | UnmonitoredAgentStopped | UnmonitoredAgentUninstalled | UnmonitoredAgentUnregistered | UnmonitoredAgentUpgradeFailed | UnmonitoredAgentVersionRejected | UnmonitoredDisabled | UnmonitoredIdChanged | UnmonitoredTerminated | UnmonitoredUnknown

GetHostsWithSpecificAgentsQueryMonitoringType

Enum keys

CloudInfrastructure | FullStack | Standalone

GetHostsWithSpecificAgentsQueryOsType

Enum keys

Aix | Darwin | Hpux | Linux | Solaris | Windows | Zos

GetHostsWithSpecificAgentsQueryPluginState

Enum keys

Disabled | ErrorAuth | ErrorCommunicationFailure | ErrorConfig | ErrorTimeout | ErrorUnknown | Incompatible | LimitReached | NothingToReport | Ok | StateTypeUnknown | Uninitialized | Unsupported | WaitingForState

GetHostsWithSpecificAgentsQueryPluginVersionIs

Enum keys

Equal | Greater | GreaterEqual | Lower | LowerEqual

GetHostsWithSpecificAgentsQueryRelativeTime

Enum keys

Day | Hour | Min | Month | Week | _10mins | _15mins | _2hours | _30mins | _3days | _5mins | _6hours

GetHostsWithSpecificAgentsQueryTechnologyModuleType

Enum keys

Apache | DotNet | Dumpproc | Go | IbmIntegrationBus | Iis | Java | LogAnalytics | Nettracer | Network | Nginx | NodeJs | Opentracingnative | Php | Process | Python | Ruby | Sdk | Updater | Varnish | ZOs

GetHostsWithSpecificAgentsQueryTechnologyModuleVersionIs

Enum keys

Equal | Greater | GreaterEqual | Lower | LowerEqual

GetHostsWithSpecificAgentsQueryUpdateStatus

Enum keys

Incompatible | Outdated | Scheduled | Suppressed | Unknown | Up2Date | UpdateInProgress | UpdatePending | UpdateProblem

GetLatestAgentImagePathAgentImageType

Enum keys

CodeModules | OneAgent

HostAgentInfoAutoUpdateSetting

The effective auto-update setting of OneAgent. For host with inherited configuration it is calculated from its parent's configuration

Enum keys

Disabled | Enabled

HostAgentInfoAvailabilityState

The availability state of OneAgent.

Enum keys

Crashed | Lost | Monitored | PreMonitored | Shutdown | UnexpectedShutdown | Unknown | Unmonitored

HostAgentInfoConfiguredMonitoringMode

Configured monitoring mode of OneAgent.

Enum keys

CloudInfrastructure | Discovery | FullStack

HostAgentInfoDetailedAvailabilityState

The detailed availability state of OneAgent.

Enum keys

CrashedFailure | CrashedUnknown | LostAgentUpgradeFailed | LostConnection | LostUnknown | Monitored | MonitoredAgentEnabled | MonitoredAgentRegistered | MonitoredAgentUpgradeStarted | MonitoredAgentVersionAccepted | MonitoredEnabled | PreMonitored | ShutdownAgentLost | ShutdownGraceful | ShutdownSpotInstance | ShutdownStopped | ShutdownUnknown | ShutdownUnknownUnexpected | Unknown | UnmonitoredAgentDisabled | UnmonitoredAgentLost | UnmonitoredAgentRestartTriggered | UnmonitoredAgentStopped | UnmonitoredAgentUninstalled | UnmonitoredAgentUnregistered | UnmonitoredAgentUpgradeFailed | UnmonitoredAgentVersionRejected | UnmonitoredDisabled | UnmonitoredIdChanged | UnmonitoredTerminated | UnmonitoredUnknown

HostAgentInfoMonitoringType

The monitoring mode of OneAgent.

Enum keys

CloudInfrastructure | FullStack | Standalone

HostAgentInfoUpdateStatus

The current update status of OneAgent.

Enum keys

Incompatible | Outdated | Scheduled | Suppressed | Unknown | Up2Date | UpdateInProgress | UpdatePending | UpdateProblem

HostAutoInjection

Status of auto-injection

Enum keys

DisabledManually | DisabledOnInstallation | DisabledOnSanityCheck | Enabled | FailedOnInstallation

HostAzureComputeModeName

Enum keys

Dedicated | Shared

HostAzureSku

Enum keys

Basic | Dynamic | Free | Premium | Shared | Standard

HostBitness

Enum keys

_32bit | _64bit

HostCloudType

Enum keys

Azure | Ec2 | GoogleCloudPlatform | Openstack | Oracle | Unrecognized

HostHypervisorType

Enum keys

Ahv | AwsNitro | Gvisor | Hyperv | Kvm | Lpar | Qemu | Unrecognized | Virtualbox | Vmware | Wpar | Xen

HostMonitoringMode

Enum keys

FullStack | Infrastructure | Off

HostOsArchitecture

Enum keys

Arm | Ia64 | Parisc | Ppc | Ppcle | S390 | Sparc | X86 | Zos

HostOsType

Enum keys

Aix | Darwin | Hpux | Linux | Solaris | Windows | Zos

HostPaasType

Enum keys

AwsEcsEc2 | AwsEcsFargate | AwsLambda | AzureFunctions | AzureWebsites | CloudFoundry | GoogleAppEngine | GoogleCloudRun | Heroku | Kubernetes | Openshift

HostUserLevel

Enum keys

NonSuperuser | NonSuperuserStrict | Superuser

KeyPerformanceMetricsLoadActionKpm

Defines the key performance metric for load actions.

Enum keys

DomInteractive | HtmlDownloaded | LoadEventEnd | LoadEventStart | SpeedIndex | TimeToFirstByte | UserActionDuration | VisuallyComplete

KeyPerformanceMetricsXhrActionKpm

Defines the key performance metric for XHR actions.

Enum keys

ResponseEnd | TimeToFirstByte | UserActionDuration | VisuallyComplete

LoadingTimeThresholdType

The type of the threshold: total loading time or action loading time.

Enum keys

Action | Total

ModuleInfoModuleType

The type of the code module.

Enum keys

Apache | DotNet | Dumpproc | Go | IbmIntegrationBus | Iis | Java | LogAnalytics | Nettracer | Network | Nginx | NodeJs | Opentracingnative | Php | Process | Python | Ruby | Sdk | Updater | Varnish | ZOs

MonitorCollectionElementType

The type of a synthetic monitor.

Enum keys

Browser | Http

SyntheticMonitorCreatedFrom

The origin of a monitor

Enum keys

Api | Gui

SyntheticMonitorType

Defines the actual set of fields depending on the value. See one of the following objects:

  • BROWSER -> BrowserSyntheticMonitor
  • HTTP -> HttpSyntheticMonitor

Enum keys

Browser | Http

SyntheticMonitorUpdateType

Defines the actual set of fields depending on the value. See one of the following objects:

  • BROWSER -> BrowserSyntheticMonitorUpdate
  • HTTP -> HttpSyntheticMonitorUpdate

Enum keys

Browser | Http

TagInfoContext

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

Enum keys

Aws | AwsGeneric | Azure | CloudFoundry | Contextless | Environment | GoogleCloud | Kubernetes

TagWithSourceInfoContext

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

Enum keys

Aws | AwsGeneric | Azure | CloudFoundry | Contextless | Environment | GoogleCloud | Kubernetes

TagWithSourceInfoSource

The source of the tag, such as USER, RULE_BASED or AUTO

Enum keys

Auto | RuleBased | User

UserSessionApplicationType

The type of the application used in the user session.

Enum keys

AmpApplication | CustomApplication | MobileApplication | WebApplication

UserSessionConnectionType

The serialized connection type of the mobile user session.

Enum keys

Lan | Mobile | Offline | Unknown | Wifi

UserSessionDisplayResolution

The detected screen resolution of the device used for the user session.

Enum keys

Cga | Dci2K | Dci4K | Dvga | Fhd | Fwvga | Fwxga | GhdPlus | Hd | Hqvga | Hqvga2 | Hsxga | Huxga | Hvga | Hxga | NHd | Ntsc | Pal | QHd | Qhd | Qqvga | Qsxga | Quxga | Qvga | Qwxga | Qxga | Svga | Sxga | SxgaMinus | SxgaPlus | Uga | Uhd16K | Uhd4K | Uhd8K | UhdPlus | Unknown | Uwqhd | Uxga | Vga | Whsxga | Whuxga | Whxga | Wqsxga | Wquxga | Wqvga | Wqvga2 | Wqvga3 | Wqxga | Wqxga2 | Wsvga | Wsvga2 | Wsxga | WsxgaPlus | Wuxga | Wvga | Wvga2 | Wxga | Wxga2 | Wxga3 | WxgaPlus | Xga | Xgaplus | _1280x854

UserSessionEndReason

The reason for the end of the user session.

Enum keys

DurationLimit | EndEvent | ExtendedTimeout | TestFailed | Timeout | UserActionLimit

UserSessionErrorsType

The type of error.

Enum keys

Behavioral | Crash | Error | PageChange | RageClick | RageTap | UserTag | UserTagFromMetaData | VisitTag

UserSessionEventsType

The type of event.

Enum keys

Behavioral | Crash | Error | PageChange | RageClick | RageTap | UserTag | UserTagFromMetaData | VisitTag

UserSessionReasonForNoSessionReplay

The reason for absence of Session Replay.

Enum keys

KilledEmergency | KilledError | KilledInvalidResponse | KilledMinJsAgentVersion | KilledNoLicense | KilledWrongContentType | MisconfiguredCluster | ModuleDisabled | NoActivity | OptInMode | OptedOutSession | RobotDetected | SampledOut | UnableToLoadWorker | UnhandledException | Unknown | UnsupportedBrowser | ViewExcluded

UserSessionReasonForNoSessionReplayMobile

The reason for absence of Session Replay on mobile.

Enum keys

CostControl | CrashesOptedIn | Disabled | InvalidConfiguration | NoAgent | OptedOut | Unknown

UserSessionScreenOrientation

The detected screen orientation of the device used on the device for the user session.

Enum keys

Landscape | Portrait | Undefined

UserSessionUserActionApdexCategory

The user experience index of the user action.

Enum keys

Frustrated | Satisfied | Tolerating | Unknown

UserSessionUserActionType

The type of the user action.

Enum keys

Custom | EndVisit | Error | Load | RageClick | SyntheticHiddenAction | UserSessionProperties | VisitTag | Xhr

UserSessionUserExperienceScore

The user experience score of the user session.

Enum keys

Frustrated | Satisfied | Tolerated | Undefined

UserSessionUserType

The type of the user. Indicates either a real human user (REAL_USER) or a robot (ROBOT or SYNTHETIC).

Enum keys

RealUser | Robot | Synthetic

Still have questions?
Find answers in the Dynatrace Community