Classic Environment V2

Documentation of the Dynatrace Environment API v2. Resources here generally supersede those in v1. Migration of resources from v1 is in progress.

If you miss a resource, consider using the Dynatrace Environment API v1.

To read about use cases and examples, see Dynatrace Documentation.

To authorize, use a valid access token or personal access token. For usage in a Dynatrace app, refer to the Dynatrace Developer 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.

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

v4.1.0

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

accessTokensActiveGateTokensClient

import { accessTokensActiveGateTokensClient } from '@dynatrace-sdk/client-classic-environment-v2';

createToken

accessTokensActiveGateTokensClient.createToken(config): Promise<ActiveGateTokenCreated>

Creates a new ActiveGate token

One of the following scopes is required:

• environment-api:activegate-tokens:create
• environment-api:activegate-tokens:write

Required permission: environment:roles:manage-settings

The newly created token will be owned by the same user who owns the token used for authentication of the call.

Parameters

Name	Type
config.body*required	ActiveGateTokenCreate

Returns

Return type	Status code	Description
ActiveGateTokenCreated	201	Success. The token has been created. The body of the response contains the token secret.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensActiveGateTokensClient.createToken({
    body: {
      activeGateType: "ENVIRONMENT",
      name: "myToken",
    },
  });

getToken

accessTokensActiveGateTokensClient.getToken(config): Promise<ActiveGateToken>

Gets metadata of an ActiveGate token

Required scope: environment-api:activegate-tokens:read Required permission: environment:roles:manage-settings

The token secret is not exposed.

Parameters

Name	Type	Description
config.activeGateTokenIdentifier*required	string	The ActiveGate token identifier, consisting of prefix and public part of the token.

Returns

Return type	Status code	Description
ActiveGateToken	200	Success. The response contains the metadata of the tokens.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensActiveGateTokensClient.getToken({
    activeGateTokenIdentifier: "...",
  });

listTokens

accessTokensActiveGateTokensClient.listTokens(config): Promise<ActiveGateTokenList>

Lists all available ActiveGate tokens

Required scope: environment-api:activegate-tokens:read Required permission: environment:roles:manage-settings

You can limit the output by using pagination:

1. Specify the number of results per page in the pageSize query parameter.
2. Use the cursor from the nextPageKey field of the previous response in the nextPageKey query parameter to obtain subsequent pages.

Parameters

Name	Type	Description
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of ActiveGate tokens in a single response payload. The maximal allowed page size is 3000 and the minimal size is 100. If not set, 100 is used.

Returns

Return type	Status code	Description
ActiveGateTokenList	200	Success. The response contains the list of ActiveGate tokens.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensActiveGateTokensClient.listTokens();

revokeToken

accessTokensActiveGateTokensClient.revokeToken(config): Promise<void>

Deletes an ActiveGate token

Required scope: environment-api:activegate-tokens:write Required permission: environment:roles:manage-settings

Parameters

Name	Type	Description
config.activeGateTokenIdentifier*required	string	The ActiveGate token identifier, consisting of prefix and public part of the token to be deleted.

Returns

Return type	Status code	Description
void	204	Success. Response doesn't have a body.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensActiveGateTokensClient.revokeToken({
    activeGateTokenIdentifier: "...",
  });

accessTokensAgentTokensClient

import { accessTokensAgentTokensClient } from '@dynatrace-sdk/client-classic-environment-v2';

getAgentConnectionToken

accessTokensAgentTokensClient.getAgentConnectionToken(config): Promise<AgentConnectionToken>

Gets the agent connection token | maturity=EARLY_ADOPTER

Required scope: environment-api:agent-connection-tokens:read Required permission: environment:roles:agent-install

Returns the agent connection token.

Returns

Return type	Status code	Description
AgentConnectionToken	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { accessTokensAgentTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensAgentTokensClient.getAgentConnectionToken();

accessTokensApiTokensClient

import { accessTokensApiTokensClient } from '@dynatrace-sdk/client-classic-environment-v2';

createApiToken

accessTokensApiTokensClient.createApiToken(config): Promise<ApiTokenCreated>

Creates a new API token

Required scope: environment-api:api-tokens:write Required permission: environment:roles:viewer

The newly created token will be owned by the same user who owns the token used for authentication of the call.

Creating personal access tokens requires the environment:roles:viewer permission. Creating access tokens requires the environment:roles:manage-settings permission.

Parameters

Name	Type
config.body*required	ApiTokenCreate

Returns

Return type	Status code	Description
ApiTokenCreated	201	Success. The token has been created. The body of the response contains the token secret.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensApiTokensClient.createApiToken({
    body: { name: "tokenName", scopes: ["metrics.read"] },
  });

deleteApiToken

accessTokensApiTokensClient.deleteApiToken(config): Promise<void>

Deletes an API token

Required scope: environment-api:api-tokens:write Required permission: environment:roles:viewer

Parameters

Name	Type	Description
config.id*required	string	The ID of the token to be deleted. You can specify either the ID or the secret of the token. You can't delete the token you're using for authentication of the request.

Returns

Return type	Status code	Description
void	204	Success. Response doesn't have a body.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. You can't delete the token you're using for authentication of the request. | Client side error. | Server side error.

Code example

import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensApiTokensClient.deleteApiToken({
    id: "...",
  });

getApiToken

accessTokensApiTokensClient.getApiToken(config): Promise<ApiToken>

Gets API token metadata by token ID

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

The token secret is not exposed.

Parameters

Name	Type
config.id*required	string

Returns

Return type	Status code	Description
ApiToken	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await accessTokensApiTokensClient.getApiToken({
  id: "...",
});

listApiTokens

accessTokensApiTokensClient.listApiTokens(config): Promise<ApiTokenList>

Lists all available API tokens

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

You can limit the output by using pagination:

1. Specify the number of results per page in the pageSize query parameter.
2. Use the cursor from the nextPageKey field of the previous response in the nextPageKey query parameter to obtain subsequent pages.

Parameters

Name	Type	Description
config.apiTokenSelector	string	Filters the resulting sets of tokens. Only tokens matching the specified criteria are included into response. You can set one or more of the following criteria: Owner: owner("value"). The user that owns the token. Case-sensitive. Personal access token: personalAccessToken(false). Set to true to include only personal access tokens or to false to include only API tokens. Token scope: scope("scope1","scope2"). If several values are specified, the OR logic applies. To set multiple criteria, separate them with commas (,). Only results matching all criteria are included into response.
config.fields	string	Specifies the fields to be included in the response. The following fields are included by default: id name enabled owner creationDate To remove fields from the response, specify them with the minus (-) operator as a comma-separated list (for example, -creationDate,-owner). You can include additional fields: personalAccessToken expirationDate lastUsedDate lastUsedIpAddress modifiedDate scopes additionalMetadata To add fields to the response, specify them with the plus (+) operator as a comma-separated list (for example, +expirationDate,+scopes). You can combine adding and removing of fields (for example, +scopes,-creationDate). Alternatively, you can define the desired set of fields in the response. Specify the required fields as a comma-separated list, without operators (for example, creationDate,expirationDate,owner). The ID is always included in the response. The fields string must be URL-encoded.
config.from	string	Filters tokens based on the last usage time. The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of API tokens in a single response payload. The maximal allowed page size is 10000 and the minimal allowed page size is 100. If not set, 200 is used.
config.sort	string	The sort order of the token list. You can sort by the following properties with a sign prefix for the sort order: name: token name (+ a...z or - z...a) lastUsedDate last used (+ never used tokens first - most recently used tokens first) creationDate (+ oldest tokens first - newest tokens first) expirationDate (+ tokens that expire soon first - unlimited tokens first) modifiedDate last modified (+ never modified tokens first - most recently modified tokens first) If no prefix is set, + is used. If not set, tokens are sorted by creation date with newest first.
config.to	string	Filters tokens based on the last usage time. The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
ApiTokenList	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensApiTokensClient.listApiTokens();

lookupApiToken

accessTokensApiTokensClient.lookupApiToken(config): Promise<ApiToken>

Gets API token metadata by token secret

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

Parameters

Name	Type
config.body*required	ApiTokenSecret

Returns

Return type	Status code	Description
ApiToken	200	Success

Throws

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

Code example

import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensApiTokensClient.lookupApiToken({
    body: {
      token:
        "dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM",
    },
  });

updateApiToken

accessTokensApiTokensClient.updateApiToken(config): Promise<void>

Updates an API token

Required scope: environment-api:api-tokens:write Required permission: environment:roles:viewer

Parameters

Name	Type	Description
config.body*required	ApiTokenUpdate
config.id*required	string	The ID of the token to be updated. You can't disable the token you're using for authentication of the request.

Returns

Return type	Status code	Description
void	204	Success. Response doesn't have a body.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensApiTokensClient.updateApiToken({
    id: "...",
    body: {},
  });

accessTokensTenantTokensClient

import { accessTokensTenantTokensClient } from '@dynatrace-sdk/client-classic-environment-v2';

cancelRotation

accessTokensTenantTokensClient.cancelRotation(config): Promise<TenantTokenConfig>

Cancels tenant token rotation

Required scope: environment-api:tenant-token-rotation:write Required permission: environment:roles:manage-settings

To learn how to rotate tokens, see Token rotation in Dynatrace Documentation.

Returns

Return type	Status code	Description
TenantTokenConfig	200	Success. Rotation process has been cancelled. The current tenant token remains valid.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. There is no ongoing rotation process. | Client side error. | Server side error.

Code example

import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensTenantTokensClient.cancelRotation();

finishRotation

accessTokensTenantTokensClient.finishRotation(config): Promise<TenantTokenConfig>

Finishes tenant token rotation

Required scope: environment-api:tenant-token-rotation:write Required permission: environment:roles:manage-settings

To learn how to rotate tokens, see Token rotation in Dynatrace Documentation.

Returns

Return type	Status code	Description
TenantTokenConfig	200	Success. The rotation process is completed. The active field of the response contains the new tenant token.

Throws

Error Type	Error Message
ErrorEnvelopeError	No ongoing rotation process. | Client side error. | Server side error.

Code example

import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensTenantTokensClient.finishRotation();

startRotation

accessTokensTenantTokensClient.startRotation(config): Promise<TenantTokenConfig>

Starts tenant token rotation

Required scope: environment-api:tenant-token-rotation:write Required permission: environment:roles:manage-settings

To learn how to rotate tokens, see Token rotation in Dynatrace Documentation.

Returns

Return type	Status code	Description
TenantTokenConfig	200	Success. The new tenant token is created and will replace the old one. The active field of the response contains the new tenant token.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. Another rotation process is already in progress. | Client side error. | Server side error.

Code example

import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await accessTokensTenantTokensClient.startRotation();

activeGatesActiveGateGroupsClient

import { activeGatesActiveGateGroupsClient } from '@dynatrace-sdk/client-classic-environment-v2';

getActiveGateGroups

activeGatesActiveGateGroupsClient.getActiveGateGroups(config): Promise<ActiveGateGroups>

Lists ActiveGate groups

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

Returns

Return type	Status code	Description
ActiveGateGroups	200	Success

Throws

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

Code example

import { activeGatesActiveGateGroupsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesActiveGateGroupsClient.getActiveGateGroups();

activeGatesAutoUpdateConfigurationClient

import { activeGatesAutoUpdateConfigurationClient } from '@dynatrace-sdk/client-classic-environment-v2';

getAutoUpdateConfigById

activeGatesAutoUpdateConfigurationClient.getAutoUpdateConfigById(config): Promise<ActiveGateAutoUpdateConfig>

Gets the configuration of auto-update for the specified ActiveGate

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

Parameters

Name	Type	Description
config.agId*required	string	The ID of the required ActiveGate.

Returns

Return type	Status code	Description
ActiveGateAutoUpdateConfig	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Not found. See response body for details. | Client side error. | Server side error.

Code example

import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateConfigurationClient.getAutoUpdateConfigById(
    { agId: "..." },
  );

getGlobalAutoUpdateConfigForTenant

activeGatesAutoUpdateConfigurationClient.getGlobalAutoUpdateConfigForTenant(config): Promise<ActiveGateGlobalAutoUpdateConfig>

Gets the global auto-update configuration of environment ActiveGates.

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

Returns

Return type	Status code	Description
ActiveGateGlobalAutoUpdateConfig	200	Success

Throws

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

Code example

import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateConfigurationClient.getGlobalAutoUpdateConfigForTenant();

putAutoUpdateConfigById

activeGatesAutoUpdateConfigurationClient.putAutoUpdateConfigById(config): Promise<void>

Updates the configuration of auto-update for the specified ActiveGate

Required scope: environment-api:activegates:write Required permission: environment:roles:manage-settings

Parameters

Name	Type	Description
config.agId*required	string	The ID of the required ActiveGate.
config.body*required	ActiveGateAutoUpdateConfig

Returns

Return type	Status code	Description
void	204	Success. The auto-update configuration have been updated. Response doesn't have a body.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateConfigurationClient.putAutoUpdateConfigById(
    { agId: "...", body: { setting: "INHERITED" } },
  );

putGlobalAutoUpdateConfigForTenant

activeGatesAutoUpdateConfigurationClient.putGlobalAutoUpdateConfigForTenant(config): Promise<void>

Puts the global auto-update configuration of environment ActiveGates.

Required scope: environment-api:activegates:write Required permission: environment:roles:manage-settings

Parameters

Name	Type
config.body*required	ActiveGateGlobalAutoUpdateConfig

Returns

Return type	Status code	Description
void	204	Success. The global auto-update configuration have been updated. Response doesn't have a body.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateConfigurationClient.putGlobalAutoUpdateConfigForTenant(
    { body: { globalSetting: "ENABLED" } },
  );

validateAutoUpdateConfigById

activeGatesAutoUpdateConfigurationClient.validateAutoUpdateConfigById(config): Promise<void>

Validates the payload for the POST /activeGates/{agId}/autoUpdate request.

Required scope: environment-api:activegates:write Required permission: environment:roles:manage-settings

Parameters

Name	Type	Description
config.agId*required	string	The ID of the required ActiveGate.
config.body*required	ActiveGateAutoUpdateConfig

Returns

Return type	Status code	Description
void	204	Validated. The submitted auto-update configuration is valid. Response doesn't have a body.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateConfigurationClient.validateAutoUpdateConfigById(
    { agId: "...", body: { setting: "INHERITED" } },
  );

validateGlobalAutoUpdateConfigForTenant

activeGatesAutoUpdateConfigurationClient.validateGlobalAutoUpdateConfigForTenant(config): Promise<void>

Validates the payload for the POST /activeGates/autoUpdate request.

Required scope: environment-api:activegates:write Required permission: environment:roles:manage-settings

Parameters

Name	Type
config.body*required	ActiveGateGlobalAutoUpdateConfig

Returns

Return type	Status code	Description
void	204	Validated. The submitted configuration is valid. Response doesn't have a body.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateConfigurationClient.validateGlobalAutoUpdateConfigForTenant(
    { body: { globalSetting: "ENABLED" } },
  );

activeGatesAutoUpdateJobsClient

import { activeGatesAutoUpdateJobsClient } from '@dynatrace-sdk/client-classic-environment-v2';

createUpdateJobForAg

activeGatesAutoUpdateJobsClient.createUpdateJobForAg(config): Promise<UpdateJob>

Creates a new update job for the specified ActiveGate

Required scope: environment-api:activegates:write Required permission: environment:roles:manage-settings

Parameters

Name	Type	Description
config.agId*required	string	The ID of the required ActiveGate.
config.body*required	UpdateJob

Returns

Return type	Status code	Description
UpdateJob	201	Success. The update-job have been created.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateJobsClient.createUpdateJobForAg(
    {
      agId: "...",
      body: { targetVersion: "1.190.0.20200301-130000" },
    },
  );

deleteUpdateJobByJobIdForAg

activeGatesAutoUpdateJobsClient.deleteUpdateJobByJobIdForAg(config): Promise<void>

Deletes the specified update job

Required scope: environment-api:activegates:write Required permission: environment:roles:manage-settings

Parameters

Name	Type	Description
config.agId*required	string	The ID of the required ActiveGate.
config.jobId*required	string	A unique identifier for a update-job of ActiveGate.

Returns

Return type	Status code	Description
void	204	Success. The update-job have been deleted. Response doesn't have a body.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Not found. See response body for details. | Client side error. | Server side error.

Code example

import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateJobsClient.deleteUpdateJobByJobIdForAg(
    { agId: "...", jobId: "..." },
  );

getAllUpdateJobList

activeGatesAutoUpdateJobsClient.getAllUpdateJobList(config): Promise<UpdateJobsAll>

List ActiveGates with update jobs

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

The response includes ActiveGates that have both completed (successful and failed) jobs and jobs in progress.

Parameters

Name	Type	Description
config.from	string	The start of the requested timeframe for update jobs. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of one day is used (now-1d). Maximum timeframe is 31 days.
config.lastUpdates	boolean	If true, filters the resulting set of update jobs to the most recent update of each type.
config.startVersion	string	Filters the resulting set of update-jobs by the initial version (required format <major>.<minor>.<revision>).
config.startVersionCompareType	"EQUAL" | "GREATER" | "GREATER_EQUAL" | "LOWER" | "LOWER_EQUAL"	Filters the resulting set of update jobs by the specified initial version. Specify the comparison operator here.
config.targetVersion	string	Filters the resulting set of update-jobs by the target version (required format <major>.<minor>.<revision>).
config.targetVersionCompareType	"EQUAL" | "GREATER" | "GREATER_EQUAL" | "LOWER" | "LOWER_EQUAL"	Filters the resulting set of update jobs by the specified target version. Specify the comparison operator here.
config.to	string	The end of the requested timeframe for update jobs. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.
config.updateType	"SYNTHETIC" | "ACTIVE_GATE" | "REMOTE_PLUGIN_AGENT" | "Z_REMOTE"	Filters the resulting set of update-jobs by the update type.

Returns

Return type	Status code	Description
UpdateJobsAll	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateJobsClient.getAllUpdateJobList();

getUpdateJobByJobIdForAg

activeGatesAutoUpdateJobsClient.getUpdateJobByJobIdForAg(config): Promise<UpdateJob>

Gets the parameters of the specified update job

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

Parameters

Name	Type	Description
config.agId*required	string	The ID of the required ActiveGate.
config.jobId*required	string	A unique identifier for a update-job of ActiveGate.

Returns

Return type	Status code	Description
UpdateJob	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Not found. See response body for details. | Client side error. | Server side error.

Code example

import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateJobsClient.getUpdateJobByJobIdForAg(
    { agId: "...", jobId: "..." },
  );

getUpdateJobListByAgId

activeGatesAutoUpdateJobsClient.getUpdateJobListByAgId(config): Promise<UpdateJobList>

Lists update jobs for the specified ActiveGate

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

The job can update the ActiveGate to the specified version or the latest available one.

Parameters

Name	Type	Description
config.agId*required	string	The ID of the required ActiveGate.
config.from	string	The start of the requested timeframe for update jobs. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of one week is used (now-1w). Maximum timeframe is 31 days.
config.lastUpdates	boolean	If true, filters the resulting set of update jobs to the most recent update of each type.
config.startVersion	string	Filters the resulting set of update-jobs by the initial version (required format <major>.<minor>.<revision>).
config.startVersionCompareType	"EQUAL" | "GREATER" | "GREATER_EQUAL" | "LOWER" | "LOWER_EQUAL"	Filters the resulting set of update jobs by the specified initial version. Specify the comparison operator here.
config.targetVersion	string	Filters the resulting set of update-jobs by the target version (required format <major>.<minor>.<revision>).
config.targetVersionCompareType	"EQUAL" | "GREATER" | "GREATER_EQUAL" | "LOWER" | "LOWER_EQUAL"	Filters the resulting set of update jobs by the specified target version. Specify the comparison operator here.
config.to	string	The end of the requested timeframe for update jobs. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.
config.updateType	"SYNTHETIC" | "ACTIVE_GATE" | "REMOTE_PLUGIN_AGENT" | "Z_REMOTE"	Filters the resulting set of update-jobs by the update type.

Returns

Return type	Status code	Description
UpdateJobList	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Not found. See response body for details. | Client side error. | Server side error.

Code example

import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateJobsClient.getUpdateJobListByAgId(
    { agId: "..." },
  );

validateUpdateJobForAg

activeGatesAutoUpdateJobsClient.validateUpdateJobForAg(config): Promise<void>

Validates the payload for the POST /activeGates/{agId}/updateJobs request.

Required scope: environment-api:activegates:write Required permission: environment:roles:manage-settings

Parameters

Name	Type	Description
config.agId*required	string	The ID of the required ActiveGate.
config.body*required	UpdateJob

Returns

Return type	Status code	Description
void	204	Validated. The submitted update-job is valid. Response doesn't have a body.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await activeGatesAutoUpdateJobsClient.validateUpdateJobForAg(
    {
      agId: "...",
      body: { targetVersion: "1.190.0.20200301-130000" },
    },
  );

activeGatesClient

import { activeGatesClient } from '@dynatrace-sdk/client-classic-environment-v2';

getAllActiveGates

activeGatesClient.getAllActiveGates(config): Promise<ActiveGateList>

Lists all available ActiveGates

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

The response includes all ActiveGates that are currently connected to the environment or have been connected during last 2 hours.

Parameters

Name	Type	Description
config.autoUpdate	"ENABLED" | "DISABLED"	Filters the resulting set of ActiveGates by the actual state of auto-update.
config.containerized	boolean	Filters the resulting set of ActiveGates to those which are running in container (true) or not (false).
config.disabledModule	Array<"SYNTHETIC" | "AWS" | "AZURE" | "BEACON_FORWARDER" | "CLOUD_FOUNDRY" | "DB_INSIGHT" | "DEBUGGING" | "EXTENSIONS_V1" | "EXTENSIONS_V2" | "KUBERNETES" | "LOGS" | "MEMORY_DUMPS" | "METRIC_API" | "ONE_AGENT_ROUTING" | "OTLP_INGEST" | "REST_API" | "VMWARE" | "Z_OS">	Filters the resulting set of ActiveGates by the disabled modules.
config.enabledModule	Array<"SYNTHETIC" | "AWS" | "AZURE" | "BEACON_FORWARDER" | "CLOUD_FOUNDRY" | "DB_INSIGHT" | "DEBUGGING" | "EXTENSIONS_V1" | "EXTENSIONS_V2" | "KUBERNETES" | "LOGS" | "MEMORY_DUMPS" | "METRIC_API" | "ONE_AGENT_ROUTING" | "OTLP_INGEST" | "REST_API" | "VMWARE" | "Z_OS">	Filters the resulting set of ActiveGates by the enabled modules.
config.fipsMode	boolean	Filters the resulting set of ActiveGates to those which are running in FIPS mode (true) or not (false).
config.group	string	Filters the resulting set of ActiveGates by the group. You can specify a partial name. In that case, the CONTAINS operator is used.
config.hostname	string	Filters the resulting set of ActiveGates by the name of the host it's running on. You can specify a partial name. In that case, the CONTAINS operator is used.
config.loadBalancerAddress	string	Filters the resulting set of ActiveGates by the Load Balancer address. You can specify a partial address. In that case, the CONTAINS operator is used.
config.networkAddress	string	Filters the resulting set of ActiveGates by the network address. You can specify a partial address. In that case, the CONTAINS operator is used.
config.networkZone	string	Filters the resulting set of ActiveGates by the network zone. You can specify a partial name. In that case, the CONTAINS operator is used.
config.online	boolean	Filters the resulting set of ActiveGates by the communication status.
config.osArchitecture	"S390" | "X86" | "ARM" | "PPCLE"	Filters the resulting set of ActiveGates by the OS architecture of the host it's running on.
config.osType	"LINUX" | "WINDOWS"	Filters the resulting set of ActiveGates by the OS type of the host it's running on.
config.tokenExpirationSet	boolean	Filters the resulting set of ActiveGates to those with set expiration date for authorization token.
config.tokenState	"UNKNOWN" | "ABSENT" | "EXPIRING" | "INVALID" | "UNSUPPORTED" | "VALID"	Filters the resulting set of ActiveGates to those with authorization token in specified state.
config.type	"ENVIRONMENT" | "ENVIRONMENT_MULTI"	Filters the resulting set of ActiveGates by the ActiveGate type.
config.updateStatus	"UNKNOWN" | "INCOMPATIBLE" | "OUTDATED" | "SCHEDULED" | "SUPPRESSED" | "UP2DATE" | "UPDATE_IN_PROGRESS" | "UPDATE_PENDING" | "UPDATE_PROBLEM"	Filters the resulting set of ActiveGates by the auto-update status.
config.version	string	Filters the resulting set of ActiveGates by the specified version. Specify the version in <major>.<minor>.<revision> format (for example, 1.195.0) here.
config.versionCompareType	"EQUAL" | "GREATER" | "GREATER_EQUAL" | "LOWER" | "LOWER_EQUAL"	Filters the resulting set of ActiveGates by the specified version. Specify the comparison operator here.

Returns

Return type	Status code	Description
ActiveGateList	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { activeGatesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await activeGatesClient.getAllActiveGates();

getOneActiveGateById

activeGatesClient.getOneActiveGateById(config): Promise<ActiveGate>

Gets the details of the specified ActiveGate

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

Parameters

Name	Type	Description
config.agId*required	string	The ID of the required ActiveGate.

Returns

Return type	Status code	Description
ActiveGate	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Not found. See response body for details. | Client side error. | Server side error.

Code example

import { activeGatesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await activeGatesClient.getOneActiveGateById({
  agId: "...",
});

attacksClient

import { attacksClient } from '@dynatrace-sdk/client-classic-environment-v2';

getAttack

attacksClient.getAttack(config): Promise<Attack>

Gets the specified attack

Required scope: environment-api:attacks:read One of the following permissions is required:

• environment:roles:manage-security-problems
• environment:roles:view-security-problems

Parameters

Name	Type	Description
config.fields	string	A list of additional attack properties you can add to the response. The following properties are available (all other properties are always included and you can't remove them from the response): attackTarget: The targeted host/database of an attack. request: The request that was sent from the attacker. entrypoint: The entry point used by an attacker to start a specific attack. vulnerability: The vulnerability utilized by the attack. securityProblem: The related security problem. attacker: The attacker of an attack. managementZones: The related management zones. To add properties, specify them in a comma-separated list and prefix each property with a plus (for example, +attackTarget,+securityProblem).
config.id*required	string	The ID of the attack.

Returns

Return type	Status code	Description
Attack	200	Success

Throws

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

Code example

import { attacksClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await attacksClient.getAttack({ id: "..." });

getAttacks

attacksClient.getAttacks(config): Promise<AttackList>

Lists all attacks

Required scope: environment-api:attacks:read One of the following permissions is required:

• environment:roles:manage-security-problems
• environment:roles:view-security-problems

Parameters

Name	Type	Description
config.attackSelector	string	Defines the scope of the query. Only attacks matching the specified criteria are included in the response. You can add one or more of the following criteria. Values are not case-sensitive and the EQUALS operator is used unless otherwise specified. State: state("value"). The state of the attack. Possible values are EXPLOITED, BLOCKED, and ALLOWLISTED. Attack Type: attackType("value"). The type of the attack. Find the possible values in the description of the attackType field of the response. Country Code: countryCode("value"). The country code of the attacker. Supported values include all ISO-3166-1 alpha-2 country codes (2-letter). Supplying empty filter value countryCode() will return attacks, where location is not available. Request path contains: requestPathContains("value"). Filters for a substring in the request path. The CONTAINS operator is used. A maximum of 48 characters are allowed. Process group name contains: processGroupNameContains("value"). Filters for a substring in the targeted process group's name. The CONTAINS operator is used. Vulnerability ID: vulnerabilityId("123456789"). The exact ID of the vulnerability. Source IPs: sourceIps("93.184.216.34", "63.124.6.12"). The exact IPv4/IPv6 addresses of the attacker. Management zone ID: managementZoneIds("mzId-1", "mzId-2"). Management zone name: managementZones("name-1", "name-2"). Values are case sensitive. Technology: technology("technology-1", "technology-2"). Find the possible values in the description of the technology field of the response. The EQUALS operator is used. To set several criteria, separate them with a comma (,). Only results matching (all criteria are included in the response. Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (~) inside quotes: Tilde ~ Quote "
config.fields	string	A list of additional attack properties you can add to the response. The following properties are available (all other properties are always included and you can't remove them from the response): attackTarget: The targeted host/database of an attack. request: The request that was sent from the attacker. entrypoint: The entry point used by an attacker to start a specific attack. vulnerability: The vulnerability utilized by the attack. securityProblem: The related security problem. attacker: The attacker of an attack. managementZones: The related management zones. affectedEntities: The affected entities of an attack. To add properties, specify them in a comma-separated list and prefix each property with a plus (for example, +attackTarget,+securityProblem).
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of thirty days is used (now-30d).
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of attacks in a single response payload. The maximal allowed page size is 500. If not set, 100 is used.
config.sort	string	Specifies one or more fields for sorting the attack list. Multiple fields can be concatenated using a comma (,) as a separator (e.g. +state,-timestamp). You can sort by the following properties with a sign prefix for the sorting order. displayId: The attack's display ID. displayName: The attack's display name. attackType: The type of the attack (e.g. SQL_INJECTION, JNDI_INJECTION, etc.). state: The state of the attack. (+ low severity state first - high severity state first) sourceIp: The IP address of the attacker. Sorts by the numerical IP value. requestPath: The request path where the attack was started. timestamp: When the attack was executed. (+ old attacks first or - new attacks first) If no prefix is set, + is used.
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
AttackList	200	Success

Throws

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

Code example

import { attacksClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await attacksClient.getAttacks();

auditLogsClient

import { auditLogsClient } from '@dynatrace-sdk/client-classic-environment-v2';

getLog

auditLogsClient.getLog(config): Promise<AuditLogEntry>

Gets the specified entry of the audit log | maturity=EARLY_ADOPTER

Required scope: environment-api:audit-logs:read Required permission: environment:roles:manage-settings

Parameters

Name	Type	Description
config.id*required	string	The ID of the required log entry.

Returns

Return type	Status code	Description
AuditLogEntry	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. Invalid ID format. | Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { auditLogsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await auditLogsClient.getLog({ id: "..." });

getLogs

auditLogsClient.getLogs(config): Promise<AuditLog>

Gets the audit log of your Dynatrace environment | maturity=EARLY_ADOPTER

Required scope: environment-api:audit-logs:read Required permission: environment:roles:manage-settings

You can limit the output by using pagination:

1. Specify the number of results per page in the pageSize query parameter.
2. Use the cursor from the nextPageKey field of the previous response in the nextPageKey query parameter to obtain subsequent pages.

Parameters

Name	Type	Description
config.filter	string	Filters the audit log. You can use the following criteria: User: user("userIdentification"). The EQUALS operator applies. Event type: eventType("value"). The EQUALS operator applies. Category of a logged operation: category("value"). The EQUALS operator applies. Entity ID: entityId("id"). The CONTAINS operator applies. Settings schema ID: dt.settings.schema_id("id"). The EQUALS operator applies. Settings scope ID: dt.settings.scope_id("id"). The EQUALS operator applies. Settings key: dt.settings.key("key"). The EQUALS operator applies. Settings object ID: dt.settings.object_id("id"). The EQUALS operator applies. For each criterion, you can specify multiple alternatives with comma-separated values. In this case, the OR logic applies. For example, eventType("CREATE","UPDATE") means eventType can be "CREATE" or "UPDATE". You can specify multiple comma-separated criteria, such as eventType("CREATE","UPDATE"),category("CONFIG"). Only results matching all criteria are included in response. Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (~) inside quotes: Tilde ~ Quote "
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of two weeks is used (now-2w).
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of log entries in a single response payload. The maximal allowed page size is 5000. If not set, 1000 is used.
config.sort	string	The sorting of audit log entries: timestamp: Oldest first. -timestamp: Newest first. If not set, the newest first sorting is applied.
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
AuditLog	200	Success

Throws

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

Code example

import { auditLogsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await auditLogsClient.getLogs();

businessEventsClient

import { businessEventsClient } from '@dynatrace-sdk/client-classic-environment-v2';

ingest

businessEventsClient.ingest(config): Promise<void>

Ingests a business event

Required scope: storage:events:write Required permission: storage:events:write

The maximum payload size of a single request is 5 MiB. Requests with a greater payload are rejected, and the API returns a 413 response code.

The ingestion of business events is subject to licensing (see licensing documentation).

Parameters

Name	Type
config.body*required	CloudEvent | Array<CloudEvent> | IngestBody
config.type*required	"application/cloudevent+json" | "application/cloudevents+json" | "application/cloudevent-batch+json" | "application/cloudevents-batch+json" | "application/json; charset=utf-8"

Returns

Return type	Status code	Description
void	202	The provided business events are all accepted and will be processed.

Throws

Error Type	Error Message
BizEventIngestResultError	Some business events are invalid. Valid business events are accepted and will be processed. | Content too large | Too many requests | Service is temporarily unavailable
ErrorEnvelopeError	Client side error. | Server side error.

Code example

import { businessEventsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await businessEventsClient.ingest({
  type: "application/cloudevent+json",
  body: {
    specversion: "1.0",
    id: "1",
    source: "custom.source",
    type: "com.mycompany.shop.checkout",
    dtcontext:
      'dt.session_id="234234234324235345345",dt.entity.rum_application="APPLICATION-53453458340758",host.name="123.123.123.123"',
    dataschema:
      "http://dynatrace.com/schema/bizevents/generic/1.0",
    traceparent:
      "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00",
    data: {
      id: "OR-838475",
      paymentType: "paypal",
      plannedDeliveryDate: "01.01.2021",
      total: 234,
    },
  },
});

credentialVaultClient

import { credentialVaultClient } from '@dynatrace-sdk/client-classic-environment-v2';

createCredentials

credentialVaultClient.createCredentials(config): Promise<CredentialsId>

Creates a new credentials set.

Required scope: environment-api:credentials:write Required permission: environment:roles:viewer

The body must not provide an ID. An ID is assigned automatically by the Dynatrace server.

Parameters

Name	Type
config.body*required	Credentials

Returns

Return type	Status code	Description
CredentialsId	201	Success. The new credentials set has been created. The response contains the ID of the set.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await credentialVaultClient.createCredentials({
  body: {
    name: "...",
    scopes: ["APP_ENGINE"],
    type: "AWS_MONITORING_KEY_BASED",
  },
});

getCredentials

credentialVaultClient.getCredentials(config): Promise<CredentialsResponseElement>

Gets the metadata of the specified credentials set.

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

The credentials set itself (e.g. username/certificate and password) is not included in the response.

Parameters

Name	Type	Description
config.id*required	string	The Dynatrace entity ID of the required credentials set.

Returns

Return type	Status code	Description
CredentialsResponseElement	200	Success. The response contains the metadata of the credentials set.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await credentialVaultClient.getCredentials({
  id: "...",
});

getCredentialsDetails

credentialVaultClient.getCredentialsDetails(config): Promise<AbstractCredentialsResponseElement>

Gets the details of the specified credentials set.

Required scope: environment-api:credentials:read

The credentials set including username/certificate, password or token is included in the response.

Parameters

Name	Type	Description
config.id*required	string	The Dynatrace entity ID of the required credentials set.

Returns

Return type	Status code	Description
AbstractCredentialsResponseElement	200	Success. The response contains the details of the credentials set.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. E.g. Requested credentials with unsupported scope. Only APP_ENGINE scope is supported. | Failed. Requested credentials belong to another user.

Code example

import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await credentialVaultClient.getCredentialsDetails({
    id: "...",
  });

listCredentials

credentialVaultClient.listCredentials(config): Promise<CredentialsList>

Lists all sets of credentials in your environment.

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

The credentials set itself (username/certificate and password) is not included in the response.

Parameters

Name	Type	Description
config.name	string	Filters the result by the name. When in quotation marks, whole phrase is taken. Case insensitive.
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of credentials in a single response payload. The maximal allowed page size is 500. If not set, 100 is used.
config.scope	string	Filters credentials with specified scope.
config.type	"CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"	Filters the result by the specified credentials type.
config.user	string	Filters credentials accessible to the user (owned by the user or the ones that are accessible for all).

Returns

Return type	Status code	Description
CredentialsList	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await credentialVaultClient.listCredentials();

removeCredentials

credentialVaultClient.removeCredentials(config): Promise<void>

Deletes the specified credentials set

Required scope: environment-api:credentials:write Required permission: environment:roles:viewer

Provide credential ID in the path.

Parameters

Name	Type	Description
config.id*required	string	The ID of the credentials set to be deleted.

Returns

Return type	Status code	Description
void	204	Success. The credentials set has been deleted. Response doesn't have a body.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await credentialVaultClient.removeCredentials({
  id: "...",
});

updateCredentials

credentialVaultClient.updateCredentials(config): Promise<void | CredentialsId>

Updates the specified credentials set.

Required scope: environment-api:credentials:write Required permission: environment:roles:viewer

The body must not provide an ID. The ID should be provided in the path.

Parameters

Name	Type	Description
config.body*required	Credentials
config.id*required	string	The Dynatrace entity ID of the credentials set to be updated.

Returns

Return type	Status code	Description
CredentialsId	201	Success. The new credentials set has been created. The response contains the ID of the set.
void	204	Success. The credentials set has been updated. Response doesn't have a body.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await credentialVaultClient.updateCredentials({
  id: "...",
  body: {
    name: "...",
    scopes: ["APP_ENGINE"],
    type: "AWS_MONITORING_KEY_BASED",
  },
});

davisSecurityAdvisorClient

import { davisSecurityAdvisorClient } from '@dynatrace-sdk/client-classic-environment-v2';

getAdviceForSecurityProblems

davisSecurityAdvisorClient.getAdviceForSecurityProblems(config): Promise<DavisSecurityAdviceList>

Provides advice for security problems.

Required scope: environment-api:security-problems:read One of the following permissions is required:

• environment:roles:manage-security-problems
• environment:roles:view-security-problems

You can narrow down the output by providing the management zone and pagination. If you specify a management zone, only problems originating from that zone are included to the request.

Parameters

Name	Type	Description
config.managementZoneFilter	string	To specify management zones, use one of the options listed below. For each option you can specify multiple comma-separated values. If several values are specified, the OR logic applies. All values are case-sensitive and must be quoted. Management zone ID: ids("mzId-1", "mzId-2"). Management zone names: names("mz-1", "mz-2"). You can specify several comma-separated criteria (for example, names("myMz"),ids("9130632296508575249")).
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of security advices in a single response payload. The maximal allowed page size is 500. If not set, 5 is used.

Returns

Return type	Status code	Description
DavisSecurityAdviceList	200	Success

Throws

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

Code example

import { davisSecurityAdvisorClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await davisSecurityAdvisorClient.getAdviceForSecurityProblems();

eventsClient

import { eventsClient } from '@dynatrace-sdk/client-classic-environment-v2';

createEvent

eventsClient.createEvent(config): Promise<EventIngestResults>

Ingests a custom event

One of the following scopes is required:

• storage:events:write
• environment-api:events:write

One of the following permissions is required:

• environment:roles:viewer
• storage:events:write

The ingestion of custom events is subject to licensing (see licensing documentation).

Parameters

Name	Type
config.body*required	EventIngest

Returns

Return type	Status code	Description
EventIngestResults	201	The event ingest request was received by the server. The response body indicates for each event whether its creation was successful.

Throws

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

Code example

import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await eventsClient.createEvent({
  body: { eventType: "AVAILABILITY_EVENT", title: "..." },
});

getEvent

eventsClient.getEvent(config): Promise<Event>

Gets the properties of an event

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

Parameters

Name	Type	Description
config.eventId*required	string	The ID of the required event.

Returns

Return type	Status code	Description
Event	200	Success. The response contains the configuration of the event.

Throws

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

Code example

import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await eventsClient.getEvent({
  eventId: "...",
});

getEventProperties

eventsClient.getEventProperties(config): Promise<EventPropertiesList>

Lists all event properties

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

Parameters

Name	Type	Description
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of event properties in a single response payload. The maximal allowed page size is 500. If not set, 100 is used.

Returns

Return type	Status code	Description
EventPropertiesList	200	Success

Throws

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

Code example

import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await eventsClient.getEventProperties();

getEventProperty

eventsClient.getEventProperty(config): Promise<EventPropertyDetails>

Gets the details of an event property

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

Parameters

Name	Type	Description
config.propertyKey*required	string	The event property key you're inquiring.

Returns

Return type	Status code	Description
EventPropertyDetails	200	Success

Throws

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

Code example

import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await eventsClient.getEventProperty({
  propertyKey: "...",
});

getEventType

eventsClient.getEventType(config): Promise<EventType>

Gets the properties of an event type

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

Parameters

Name	Type	Description
config.eventType*required	string	The event type you're inquiring.

Returns

Return type	Status code	Description
EventType	200	Success

Throws

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

Code example

import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await eventsClient.getEventType({
  eventType: "...",
});

getEventTypes

eventsClient.getEventTypes(config): Promise<EventTypeList>

Lists all event types

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

Parameters

Name	Type	Description
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of event types in a single response payload. The maximal allowed page size is 500. If not set, 100 is used.

Returns

Return type	Status code	Description
EventTypeList	200	Success

Throws

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

Code example

import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await eventsClient.getEventTypes();

getEvents

eventsClient.getEvents(config): Promise<EventList>

Lists events within the specified timeframe

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

Parameters

Name	Type	Description
config.entitySelector	string	The entity scope of the query. You must set one of these criteria: Entity type: type("TYPE") Dynatrace entity ID: entityId("id"). You can specify several IDs, separated by a comma (entityId("id-1","id-2")). All requested entities must be of the same type. You can add one or more of the following criteria. Values are case-sensitive and the EQUALS operator is used unless otherwise specified. Tag: tag("value"). Tags in [context]key:value, key:value, and value formats are detected and parsed automatically. Any colons (:) that are part of the key or value must be escaped with a backslash(\). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive. Management zone ID: mzId(123) Management zone name: mzName("value") Entity name: entityName.equals: performs a non-casesensitive EQUALS query. entityName.startsWith: changes the operator to BEGINS WITH. entityName.in: enables you to provide multiple values. The EQUALS operator applies. caseSensitive(entityName.equals("value")): takes any entity name criterion as an argument and makes the value case-sensitive. Health state (HEALTHY,UNHEALTHY): healthState("HEALTHY") First seen timestamp: firstSeenTms.<operator>(now-3h). Use any timestamp format from the from /to parameters. The following operators are available: lte: earlier than or at the specified time lt: earlier than the specified time gte: later than or at the specified time gt: later than the specified time Entity attribute: <attribute>("value1","value2") and <attribute>.exists(). To fetch the list of available attributes, execute the GET entity type request and check the properties field of the response. Relationships: fromRelationships.<relationshipName>() and toRelationships.<relationshipName>(). This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the GET entity type request and check the fromRelationships and toRelationships fields. Negation: not(<criterion>). Inverts any criterion except for type. For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma (,). For example, type("HOST"),healthState("HEALTHY"). Only results matching all criteria are included in the response. The maximum string length is 2,000 characters. The number of entities that can be selected is limited to 10000.
config.eventSelector	string	Defines the scope of the query. Only events matching the specified criteria are included in the response. You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the OR logic applies. Event ID: eventId("id-1", "id-2"). ID of related entity: entityId("id-1", "id-2"). Event status: status("OPEN") or status("CLOSED"). You can specify only one status. Management zone ID: managementZoneId("123", "321"). Event type: eventType("event-type"). You can specify only one event type. You can fetch the list of possible event types with the GET event types call. Correlation ID: correlationId("id-1", "id-2"). Happened during maintenance (true, false): underMaintenance(true). Notifications are suppressed (true, false): suppressAlert(true). Problem creation is suppressed (true, false): suppressProblem(true). Frequent event (true, false): frequentEvent(true). Event property: property.<key>("value-1", "value-2"). Only properties with the filterable property set to true can be used. You can check event properties via the GET event properties call. To set several criteria, separate them with commas (,). Only results matching all criteria are included in the response.
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of two hours is used (now-2h).
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of events in a single response payload. The maximal allowed page size is 1000. If not set, 100 is used.
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
EventList	200	Success. The response contains the list of events.

Throws

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

Code example

import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await eventsClient.getEvents();

extensions_2_0Client

import { extensions_2_0Client } from '@dynatrace-sdk/client-classic-environment-v2';

activateExtensionEnvironmentConfiguration

extensions_2_0Client.activateExtensionEnvironmentConfiguration(config): Promise<ExtensionEnvironmentConfigurationVersion>

Activates the environment configuration from the specified version of the extension 2.0

Required scope: environment-api:extensions:write One of the following permissions is required:

• environment:roles:manage-settings
• extensions:definitions:write

Parameters

Name	Type	Description
config.body*required	ExtensionEnvironmentConfigurationVersion
config.extensionName*required	string	The name of the requested extension 2.0.

Returns

Return type	Status code	Description
ExtensionEnvironmentConfigurationVersion	200	Success. Environment configuration created.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await extensions_2_0Client.activateExtensionEnvironmentConfiguration(
    { extensionName: "...", body: { version: "1.2.3" } },
  );

createMonitoringConfiguration

extensions_2_0Client.createMonitoringConfiguration(config): Promise<Array<MonitoringConfigurationResponse>>

Creates new monitoring configuration for the specified extension 2.0

Required scope: environment-api:extension-configurations:write One of the following permissions is required:

• environment:roles:manage-settings
• extensions:configurations:write

Parameters

Name	Type	Description
config.body*required	Array<MonitoringConfigurationDto>
config.extensionName*required	string	The name of the requested extension 2.0.

Returns

Return type	Status code	Description
MonitoringConfigurationResponse	200	Success
ErrorEnvelope	207	Multi-Status, if not all requests resulted in the same status

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await extensions_2_0Client.createMonitoringConfiguration({
    extensionName: "...",
    body: [{ scope: "HOST-D3A3C5A146830A79" }],
  });

extensions_2_0Client.createMonitoringConfiguration(config): Promise<Array<ErrorEnvelope | MonitoringConfigurationResponse>>

Parameters

Name	Type	Description
config.body*required	Array<MonitoringConfigurationDto>
config.extensionName*required	string	The name of the requested extension 2.0.

Returns

Return type	Status code	Description
MonitoringConfigurationResponse	200	Success
ErrorEnvelope	207	Multi-Status, if not all requests resulted in the same status

deleteEnvironmentConfiguration

extensions_2_0Client.deleteEnvironmentConfiguration(config): Promise<ExtensionEnvironmentConfigurationVersion>

Deactivates the environment configuration of the specified extension 2.0

Required scope: environment-api:extensions:write One of the following permissions is required:

• environment:roles:manage-settings
• extensions:definitions:write

Parameters

Name	Type	Description
config.extensionName*required	string	The name of the requested extension 2.0.

Returns

Return type	Status code	Description
ExtensionEnvironmentConfigurationVersion	200	Success. Environment configuration deactivated.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await extensions_2_0Client.deleteEnvironmentConfiguration(
    { extensionName: "..." },
  );

executeExtensionMonitoringConfigurationActions

extensions_2_0Client.executeExtensionMonitoringConfigurationActions(config): Promise<ExecuteActionsResponse>

Executes Data Source action of Active Gate or Host

Required scope: environment-api:extension-configuration-actions:write One of the following permissions is required:

• environment:roles:manage-settings
• extensions:configuration.actions:write

Parameters

Name	Type	Description
config.body*required	ExecuteActionsDto
config.configurationId*required	string	The ID of the requested monitoring configuration.
config.extensionName*required	string	The name of the requested extension 2.0.

Returns

Return type	Status code	Description
ExecuteActionsResponse	202	Accepted. Response doesn't have a body.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Authentication failed | Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await extensions_2_0Client.executeExtensionMonitoringConfigurationActions(
    {
      extensionName: "...",
      configurationId: "...",
      body: {},
    },
  );

extensionConfigurationSchema

extensions_2_0Client.extensionConfigurationSchema(config): Promise<SchemaDefinitionRestDto>

Gets the configuration schema of the specified version of the extension 2.0

One of the following scopes is required:

• environment-api:extensions:read
• environment-api:extension-configurations:read

One of the following permissions is required:

• environment:roles:manage-settings
• extensions:definitions:read

Parameters

Name	Type	Description
config.extensionName*required	string	The name of the requested extension 2.0.
config.extensionVersion*required	string	The version of the requested extension 2.0 Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

Returns

Return type	Status code	Description
SchemaDefinitionRestDto	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await extensions_2_0Client.extensionConfigurationSchema({
    extensionName: "...",
    extensionVersion: "...",
  });

extensionDetails

extensions_2_0Client.extensionDetails(config): Promise<Extension>

Gets details of the specified version of the extension 2.0

Required scope: environment-api:extensions:read One of the following permissions is required:

• environment:roles:manage-settings
• extensions:definitions:read

Parameters

Name	Type	Description
config.acceptType*required	"application/json; charset=utf-8"
config.extensionName*required	string	The name of the requested extension 2.0.
config.extensionVersion*required	string	The version of the requested extension 2.0 Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

Returns

Return type	Status code	Description
void	200	Success

Throws

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

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await extensions_2_0Client.extensionDetails({
  acceptType: "application/json; charset=utf-8",
  extensionName: "...",
  extensionVersion: "...",
});

extensions_2_0Client.extensionDetails(config): Promise<Binary>

Parameters

Name	Type	Description
config.acceptType*required	"application/octet-stream"
config.extensionName*required	string	The name of the requested extension 2.0.
config.extensionVersion*required	string	The version of the requested extension 2.0 Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

Returns

Return type	Status code	Description
void	200	Success

extensionMonitoringConfigurations

extensions_2_0Client.extensionMonitoringConfigurations(config): Promise<ExtensionMonitoringConfigurationsList>

Lists all the monitoring configurations of the specified extension 2.0

Required scope: environment-api:extension-configurations:read One of the following permissions is required:

• environment:roles:manage-settings
• extensions:configurations:read

Parameters

Name	Type	Description
config.active	boolean	Filters the resulting set of configurations by the active state.
config.extensionName*required	string	The name of the requested extension 2.0.
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of extensions in a single response payload. The maximal allowed page size is 100. If not set, 20 is used.
config.version	string	Filters the resulting set of configurations by extension 2.0 version.

Returns

Return type	Status code	Description
ExtensionMonitoringConfigurationsList	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await extensions_2_0Client.extensionMonitoringConfigurations(
    { extensionName: "..." },
  );

getActiveEnvironmentConfiguration

extensions_2_0Client.getActiveEnvironmentConfiguration(config): Promise<ExtensionEnvironmentConfigurationVersion>

Gets the active environment configuration version of the specified extension 2.0

Required scope: environment-api:extensions:read One of the following permissions is required:

• environment:roles:manage-settings
• extensions:definitions:read

Parameters

Name	Type	Description
config.extensionName*required	string	The name of the requested extension 2.0.

Returns

Return type	Status code	Description
ExtensionEnvironmentConfigurationVersion	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await extensions_2_0Client.getActiveEnvironmentConfiguration(
    { extensionName: "..." },
  );

getActiveGateGroupsInfo

extensions_2_0Client.getActiveGateGroupsInfo(config): Promise<ActiveGateGroupsInfoDto>

List all activeGate groups available for extension

Required scope: environment-api:extension-configurations:write One of the following permissions is required:

• environment:roles:manage-settings
• extensions:configurations:write

Parameters

Name	Type	Description
config.extensionName*required	string	The name of the requested extension 2.0.
config.extensionVersion*required	string	The version of the requested extension 2.0 Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

Returns

Return type	Status code	Description
ActiveGateGroupsInfoDto	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await extensions_2_0Client.getActiveGateGroupsInfo({
    extensionName: "...",
    extensionVersion: "...",
  });

getAlertTemplate

extensions_2_0Client.getAlertTemplate(config): Promise<AlertTemplateDto>

Gets an alert template asset for given ID

Required scope: environment-api:extensions:read One of the following permissions is required:

• environment:roles:manage-settings
• extensions:definitions:read

Parameters

Name	Type	Description
config.assetId*required	string	ID of the requested asset.
config.extensionName*required	string	The name of the requested extension 2.0.

Returns

Return type	Status code	Description
AlertTemplateDto	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await extensions_2_0Client.getAlertTemplate({
  extensionName: "...",
  assetId: "...",
});

getEnvironmentConfigurationAssetsInfo

extensions_2_0Client.getEnvironmentConfigurationAssetsInfo(config): Promise<ExtensionAssetsDto>

Gets the information about assets in an active extension 2.0

Required scope: environment-api:extensions:read One of the following permissions is required:

• environment:roles:manage-settings
• extensions:definitions:read

Parameters

Name	Type	Description
config.extensionName*required	string	The name of the requested extension 2.0.

Returns

Return type	Status code	Description
ExtensionAssetsDto	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await extensions_2_0Client.getEnvironmentConfigurationAssetsInfo(
    { extensionName: "..." },
  );

getEnvironmentConfigurationEvents

⚠️ Deprecated

extensions_2_0Client.getEnvironmentConfigurationEvents(config): Promise<ExtensionEventsList>

List of the latest extension environment configuration events

Required scope: environment-api:extensions:read One of the following permissions is required:

• environment:roles:manage-settings
• extensions:definitions:read

Parameters

Name	Type	Description
config.content	string	Content of the event
config.extensionName*required	string	The name of the requested extension 2.0.
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of two hours is used (now-2h).
config.status	"ERROR" | "INFO" | "NONE" | "WARN"	Status of the event
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
ExtensionEventsList	200	List of the latest extension environment configuration events

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await extensions_2_0Client.getEnvironmentConfigurationEvents(
    { extensionName: "..." },
  );

getExtensionMonitoringConfigurationEvents

⚠️ Deprecated

extensions_2_0Client.getExtensionMonitoringConfigurationEvents(config): Promise<ExtensionEventsList>

Gets the list of the events linked to specific monitoring configuration

Required scope: environment-api:extension-configurations:read One of the following permissions is required:

• environment:roles:manage-settings
• extensions:configurations:read

Parameters

Name	Type	Description
config.configurationId*required	string	The ID of the requested monitoring configuration.
config.content	string	Content of the event
config.dtActiveGateId	string	Hexadecimal ID of Active Gate that uses this monitoring configuration. Example: 0x1a2b3c4d
config.dtEntityHost	string	Host that uses this monitoring configuration. Example: HOST-ABCDEF0123456789
config.dtExtensionDs	string	Data source that uses this monitoring configuration. Example: snmp
config.extensionName*required	string	The name of the requested extension 2.0.
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of two hours is used (now-2h).
config.status	"ERROR" | "INFO" | "NONE" | "WARN"	Status of the event
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
ExtensionEventsList	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await extensions_2_0Client.getExtensionMonitoringConfigurationEvents(
    { extensionName: "...", configurationId: "..." },
  );

getExtensionMonitoringConfigurationStatus

extensions_2_0Client.getExtensionMonitoringConfigurationStatus(config): Promise<ExtensionStatusDto>

Gets the most recent status of the execution of given monitoring configuration

Required scope: environment-api:extension-configurations:read One of the following permissions is required:

• environment:roles:manage-settings
• extensions:configurations:read

Parameters

Name	Type	Description
config.configurationId*required	string	The ID of the requested monitoring configuration.
config.extensionName*required	string	The name of the requested extension 2.0.

Returns

Return type	Status code	Description
ExtensionStatusDto	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await extensions_2_0Client.getExtensionMonitoringConfigurationStatus(
    { extensionName: "...", configurationId: "..." },
  );

getExtensionStatus

extensions_2_0Client.getExtensionStatus(config): Promise<Array<ExtensionStatusWithIdDto>>

Gets the most recent status of the execution of monitoring configurations of given extension

Required scope: environment-api:extension-configurations:read One of the following permissions is required:

• environment:roles:manage-settings
• extensions:configurations:read

Parameters

Name	Type	Description
config.extensionName*required	string	The name of the requested extension 2.0.

Returns

Return type	Status code	Description
ExtensionStatusWithIdDto	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await extensions_2_0Client.getExtensionStatus({
  extensionName: "...",
});

getSchemaFile

extensions_2_0Client.getSchemaFile(config): Promise<JsonNode>

Gets the extension 2.0 schema file in the specified version

Required scope: environment-api:extensions:read One of the following permissions is required:

• environment:roles:manage-settings
• extensions:definitions:read

Parameters

Name	Type	Description
config.fileName*required	string	The name of the schema file.
config.schemaVersion*required	string	The version of the schema. Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

Returns

Return type	Status code	Description
JsonNode	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await extensions_2_0Client.getSchemaFile({
  schemaVersion: "...",
  fileName: "...",
});

installExtension

extensions_2_0Client.installExtension(config): Promise<RegisteredExtensionResultDto>

Installs Extension from HUB

Required scope: environment-api:extensions:write One of the following permissions is required:

• environment:roles:manage-settings
• extensions:definitions:write

Parameters

Name	Type	Description
config.extensionName*required	string	The name of the requested extension 2.0.
config.version	string	Filters the resulting set of configurations by extension 2.0 version.

Returns

Return type	Status code	Description
RegisteredExtensionResultDto	200	Success. The extension 2.0 has been uploaded.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await extensions_2_0Client.installExtension({
  extensionName: "...",
});

listExtensionInfos

extensions_2_0Client.listExtensionInfos(config): Promise<ExtensionInfoList>

Lists all the extensions 2.0 available in your environment with additional metadata

Required scope: environment-api:extensions:read One of the following permissions is required:

• environment:roles:manage-settings
• extensions:definitions:read

Parameters

Name	Type	Description
config.name	string	Filters the resulting set of extensions 2.0 by name. You can specify a partial name. In that case, the CONTAINS operator is used.
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of extensions in a single response payload. The maximal allowed page size is 100. If not set, 20 is used.

Returns

Return type	Status code	Description
ExtensionInfoList	200	Success

Throws

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

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await extensions_2_0Client.listExtensionInfos();

listExtensionVersions

extensions_2_0Client.listExtensionVersions(config): Promise<ExtensionList>

Lists all versions of the extension 2.0

Required scope: environment-api:extensions:read One of the following permissions is required:

• environment:roles:manage-settings
• extensions:definitions:read

Parameters

Name	Type	Description
config.extensionName*required	string	The name of the requested extension 2.0.
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of extensions in a single response payload. The maximal allowed page size is 100. If not set, 20 is used.

Returns

Return type	Status code	Description
ExtensionList	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await extensions_2_0Client.listExtensionVersions({
    extensionName: "...",
  });

listExtensions

extensions_2_0Client.listExtensions(config): Promise<ExtensionList>

Lists all the extensions 2.0 available in your environment

Required scope: environment-api:extensions:read One of the following permissions is required:

• environment:roles:manage-settings
• extensions:definitions:read

Parameters

Name	Type	Description
config.name	string	Filters the resulting set of extensions 2.0 by name. You can specify a partial name. In that case, the CONTAINS operator is used.
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of extensions in a single response payload. The maximal allowed page size is 100. If not set, 20 is used.

Returns

Return type	Status code	Description
ExtensionList	200	Success

Throws

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

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await extensions_2_0Client.listExtensions();

listSchemaFiles

extensions_2_0Client.listSchemaFiles(config): Promise<SchemaFiles>

Lists all the files available for the specified extension 2.0 schema version

Required scope: environment-api:extensions:read One of the following permissions is required:

• environment:roles:manage-settings
• extensions:definitions:read

Parameters

Name	Type	Description
config.acceptType*required	"application/json; charset=utf-8"
config.schemaVersion*required	string	The version of the schema. Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

Returns

Return type	Status code	Description
void	200	Success

Throws

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

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await extensions_2_0Client.listSchemaFiles({
  acceptType: "application/json; charset=utf-8",
  schemaVersion: "...",
});

extensions_2_0Client.listSchemaFiles(config): Promise<Binary>

Parameters

Name	Type	Description
config.acceptType*required	"application/octet-stream"
config.schemaVersion*required	string	The version of the schema. Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

Returns

Return type	Status code	Description
void	200	Success

listSchemas

extensions_2_0Client.listSchemas(config): Promise<SchemasList>

Lists all the extension 2.0 schemas versions available in your environment

Required scope: environment-api:extensions:read One of the following permissions is required:

• environment:roles:manage-settings
• extensions:definitions:read

Returns

Return type	Status code	Description
SchemasList	200	Success

Throws

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

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await extensions_2_0Client.listSchemas();

monitoringConfigurationAudit

extensions_2_0Client.monitoringConfigurationAudit(config): Promise<AuditLog>

Gets the audit logs of monitoring configuration of given extension

Required scope: environment-api:extension-configurations:read One of the following permissions is required:

• environment:roles:manage-settings
• extensions:configurations:read

Parameters

Name	Type	Description
config.configurationId*required	string	The ID of the requested monitoring configuration.
config.extensionName*required	string	The name of the requested extension 2.0.
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of two weeks is used (now-2w).
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of extensions in a single response payload. The maximal allowed page size is 100. If not set, 20 is used.
config.sort	string	The sorting of audit log entries: timestamp: Oldest first. -timestamp: Newest first. If not set, the newest first sorting is applied.
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
AuditLog	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await extensions_2_0Client.monitoringConfigurationAudit({
    extensionName: "...",
    configurationId: "...",
  });

monitoringConfigurationDetails

extensions_2_0Client.monitoringConfigurationDetails(config): Promise<ExtensionMonitoringConfiguration>

Gets the details of the specified monitoring configuration

Required scope: environment-api:extension-configurations:read One of the following permissions is required:

• environment:roles:manage-settings
• extensions:configurations:read

Parameters

Name	Type	Description
config.configurationId*required	string	The ID of the requested monitoring configuration.
config.extensionName*required	string	The name of the requested extension 2.0.

Returns

Return type	Status code	Description
ExtensionMonitoringConfiguration	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await extensions_2_0Client.monitoringConfigurationDetails(
    { extensionName: "...", configurationId: "..." },
  );

removeExtension

extensions_2_0Client.removeExtension(config): Promise<Extension>

Deletes the specified version of the extension 2.0

Required scope: environment-api:extensions:write One of the following permissions is required:

• environment:roles:manage-settings
• extensions:definitions:write

Parameters

Name	Type	Description
config.extensionName*required	string	The name of the requested extension 2.0.
config.extensionVersion*required	string	The version of the requested extension 2.0 Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

Returns

Return type	Status code	Description
Extension	200	Success. The extension 2.0 version has been deleted.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await extensions_2_0Client.removeExtension({
  extensionName: "...",
  extensionVersion: "...",
});

removeMonitoringConfiguration

extensions_2_0Client.removeMonitoringConfiguration(config): Promise<void>

Deletes the specified monitoring configuration

Required scope: environment-api:extension-configurations:write One of the following permissions is required:

• environment:roles:manage-settings
• extensions:configurations:write

Parameters

Name	Type	Description
config.configurationId*required	string	The ID of the requested monitoring configuration.
config.extensionName*required	string	The name of the requested extension 2.0.

Returns

Return type	Status code	Description
void	204	Success. Response doesn't have a body.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await extensions_2_0Client.removeMonitoringConfiguration({
    extensionName: "...",
    configurationId: "...",
  });

updateExtensionEnvironmentConfiguration

extensions_2_0Client.updateExtensionEnvironmentConfiguration(config): Promise<ExtensionEnvironmentConfigurationVersion>

Updates the active environment configuration version of the extension 2.0

Required scope: environment-api:extensions:write One of the following permissions is required:

• environment:roles:manage-settings
• extensions:definitions:write

Parameters

Name	Type	Description
config.body*required	ExtensionEnvironmentConfigurationVersion
config.extensionName*required	string	The name of the requested extension 2.0.

Returns

Return type	Status code	Description
ExtensionEnvironmentConfigurationVersion	200	Success. Environment configuration updated.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await extensions_2_0Client.updateExtensionEnvironmentConfiguration(
    { extensionName: "...", body: { version: "1.2.3" } },
  );

updateMonitoringConfiguration

extensions_2_0Client.updateMonitoringConfiguration(config): Promise<MonitoringConfigurationResponse>

Updates the specified monitoring configuration

Required scope: environment-api:extension-configurations:write One of the following permissions is required:

• environment:roles:manage-settings
• extensions:configurations:write

Parameters

Name	Type	Description
config.body*required	MonitoringConfigurationUpdateDto
config.configurationId*required	string	The ID of the requested monitoring configuration.
config.extensionName*required	string	The name of the requested extension 2.0.

Returns

Return type	Status code	Description
MonitoringConfigurationResponse	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await extensions_2_0Client.updateMonitoringConfiguration({
    extensionName: "...",
    configurationId: "...",
    body: {},
  });

uploadExtension

extensions_2_0Client.uploadExtension(config): Promise<ExtensionUploadResponseDto>

Uploads or verifies a new extension 2.0

Required scope: environment-api:extensions:write One of the following permissions is required:

• environment:roles:manage-settings
• extensions:definitions:write

Parameters

Name	Type	Description
config.body*required	Blob
config.validateOnly	boolean	Only run validation but do not persist the extension even if validation was successful.

Returns

Return type	Status code	Description
ExtensionUploadResponseDto	200	The extension is valid
ExtensionUploadResponseDto	201	Success. The extension 2.0 has been uploaded.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input file is invalid. | Upload not possible yet, please try again in a few seconds. | Client side error. | Server side error.

Code example

import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await extensions_2_0Client.uploadExtension({
  body: new Blob(),
});

logsClient

import { logsClient } from '@dynatrace-sdk/client-classic-environment-v2';

exportLogRecords

logsClient.exportLogRecords(config): Promise<ExportedLogRecordList>

Exports log records | maturity=EARLY_ADOPTER

Required scope: storage:logs:read One of the following permissions is required:

• environment:roles:logviewer
• storage:logs:read

Returns the first X records (specified in the pageSize query parameter).

Unlike the search API, this API does not split the result into slices and has no limit for the total number of records. Log records are sorted by the criteria specified in the sort query parameter.

In order to fetch large amount of records (exceeding the pageSize value), one should repeat the export call with nextPageKey param.

Please note that export works only for Logs Classic.

Parameters

Name	Type	Description
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of two weeks is used (now-2w).
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The number of results per result page.
config.query	string	The log search query. The query must use the Dynatrace search query language.
config.sort	string	Defines the ordering of the log records. Each field has a sign prefix (+/-) for sorting order. If no sign prefix is set, then the + option will be applied. Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first). When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected). Pattern: ^[+-]?[a-z]+$
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
ExportedLogRecordList	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Failed. The server either does not recognize the request method, or it lacks the ability to fulfill the request. May happen when Grail log storage is enabled. | Client side error. | Server side error.

Code example

import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await logsClient.exportLogRecords();

getLogHistogramData

logsClient.getLogHistogramData(config): Promise<AggregatedLog>

Gets aggregated log records | maturity=EARLY_ADOPTER

Required scope: storage:logs:read One of the following permissions is required:

• environment:roles:logviewer
• storage:logs:read

Returns the aggregated number of occurrences of log values divided into time slots.

It is possible that the timeframe covered by results exceeds the specified timeframe. In that case the request returns fewer time slots than specified in the timeBuckets query parameter.

If Log Management and Analytics, powered by Grail is enabled, then a bearer OAuth token (with storage:logs:read and storage:buckets:read scopes) needs to be used for authentication.

Please note that Dynatrace API explorer does not currently support OAuth authentication.

Logs on Grail:

It is not recommended to run Grail queries using Logs v2 API, please use Grail API instead.

Parameters

Name	Type	Description
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of two weeks is used (now-2w).
config.groupBy	Array<string>	The groupings to be included in the response. You can specify several groups in the following format: groupBy=status&groupBy=log.source. If not set, all possible groups are returned. You can use this option to check for possible grouping values. Unique log data attributes (high-cardinality attributes) for example, span_id or trace_id cannot be used for grouping.
config.maxGroupValues	number	The maximum number of values in each group. You can get up to 100 values per group. If not set, 10 is used.
config.query	string	The log search query. The query must use the Dynatrace search query language.
config.timeBuckets	number	The number of time slots in the result. The query timeframe is divided equally into the specified number of slots. The minimum length of a slot is 1 ms. If not set, 1 is used.
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
AggregatedLog	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await logsClient.getLogHistogramData();

getLogRecords

logsClient.getLogRecords(config): Promise<LogRecordsList>

Reads log records | maturity=EARLY_ADOPTER

Required scope: storage:logs:read One of the following permissions is required:

• environment:roles:logviewer
• storage:logs:read

Returns the first X records (specified in the limit query parameter). Log records are sorted by the criteria specified in the sort query parameter.

If the query is too large to be processed in a single request, it is divided into slices (slices are unsupported on Log Management and Analytics, powered by Grail). In that case the first response contains the nextSliceKey cursor for the second slice. Use it in the nextSliceKey query parameter to obtain the second slice, which contains nextSliceKey cursor for the third slice, and so on.

Results can be distributed unevenly between slices and some slices might be empty.

If Log Management and Analytics, powered by Grail is enabled, then a bearer OAuth token (with storage:logs:read and storage:buckets:read scopes) needs to be used for authentication.

Please note that Dynatrace API explorer does not currently support OAuth authentication.

Logs on Grail:

It is not recommended to run Grail queries using Logs v2 API, please use Grail API instead.

Parameters

Name	Type	Description
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of two weeks is used (now-2w).
config.limit	number	The desired amount of log records. The maximal allowed limit is 1000. If not set, 1000 is used.
config.nextSliceKey	string	The cursor for the next slice of results. You can find it in the nextSliceKey field of the previous response. The first slice is always returned if you don't specify this parameter. If this parameter is set, all other query parameters are ignored. Unsupported on Log Management and Analytics, powered by Grail.
config.query	string	The log search query. The query must use the Dynatrace search query language.
config.sort	string	Defines the ordering of the log records. Each field has a sign prefix (+/-) for sorting order. If no sign prefix is set, then the + option will be applied. Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first). When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected). Pattern: ^[+-]?[a-z]+$
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
LogRecordsList	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await logsClient.getLogRecords();

storeLog

logsClient.storeLog(config): Promise<void | SuccessEnvelope>

Pushes log records to Dynatrace

Required scope: storage:logs:write Required permission: storage:logs:write

Ingested logs are stored in the indexed log storage.

This endpoint requires an ActiveGate with the Log Analytics Collector module enabled.

High-cardinality attributes:

Unique log data attributes (high-cardinality attributes) such as span_id and trace_id generate unnecessarily excessive facet lists that may impact log viewer performance. Because of this, they aren't listed in log viewer facets. You can still use them in a log viewer advanced search query.

Limitations:

Please refer to the following documentation pages:

• Grail tenant limits
• LM v2 SaaS tenant limits
• LM v2 Managed tenant limits

Error handling:

The following HTTP status codes are considered retryable:

• 429 Too Many Requests
• 502 Bad Gateway
• 503 Service Unavailable
• 504 Gateway Timeout

It is recommended to use an exponential backoff strategy for retrying requests.

Parameters

Name	Type
config.body*required	LogMessageJson | LogMessagePlain
config.type*required	"application/json" | "application/json; charset=utf-8" | "application/jsonl" | "application/jsonl; charset=utf-8" | "application/jsonlines" | "application/jsonlines+json" | "application/jsonlines+json; charset=utf-8" | "application/jsonlines; charset=utf-8" | "application/x-jsonlines" | "application/x-jsonlines; charset=utf-8" | "application/x-ndjson" | "application/x-ndjson; charset=utf-8" | "text/plain; charset=utf-8"

Returns

Return type	Status code	Description
SuccessEnvelope	200	Only a part of input events were ingested due to event invalidity. For details, check the response body.
void	204	Success. Response doesn't have a body.

Throws

Error Type

Error Message

ErrorEnvelopeError

Failed. The input is invalid. | Failed. This is due either to the status of your licensing agreement or because you've exhausted your DPS license. | Failed. The requested resource doesn't exist. This may happen when no ActiveGate is available with the Log Analytics Collector module enabled. | Failed. Request payload size is too big. This may happen when the payload byte size exceeds the limit or when the ingested payload is a JSON array with the size exceeding the limit. | Failed. Too Many Requests. This may happen when ActiveGate is unable to process more requests at the moment or when log ingest is disabled. Retryable with exponential backoff strategy. | Failed. The server either does not recognize the request method, or it lacks the ability to fulfil the request. In Log Monitoring Classic, this may happen when indexed log storage is not enabled. | Failed. The server is currently unable to handle the request. This may happen when ActiveGate is overloaded. Retryable with exponential backoff strategy. | Client side error. | Server side error.

Code example

import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await logsClient.storeLog({
  type: "application/json",
  body: [
    {
      content:
        "Exception: Custom error log sent via Generic Log Ingest",
      "log.source": "/var/log/syslog",
      timestamp: "2022-01-17T22:12:31.0000",
      severity: "error",
      "custom.attribute": "attribute value",
    },
    {
      content:
        "Exception: Custom error log sent via Generic Log Ingest",
      "log.source": "/var/log/syslog",
      timestamp: "2022-01-17T22:12:35.0000",
    },
    {
      content:
        "Exception: Custom error log sent via Generic Log Ingest",
      "log.source": "/var/log/syslog",
    },
    {
      content:
        "Exception: Custom error log sent via Generic Log Ingest",
    },
  ],
});

metricsClient

import { metricsClient } from '@dynatrace-sdk/client-classic-environment-v2';

allMetrics

metricsClient.allMetrics(config): Promise<MetricDescriptorCollection>

Lists all available metrics

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

You can narrow down the output by selecting metrics in the metricSelector field.

You can additionally limit the output by using pagination:

1. Specify the number of results per page in the pageSize query parameter.

2. Then use the cursor from the nextPageKey field of the response in the nextPageKey query parameter to obtain subsequent pages. All other query parameters must be omitted.

Parameters

Name	Type	Description
config.acceptType*required	"application/json; charset=utf-8" | "text/csv; header=absent; charset=utf-8" | "text/csv; header=present; charset=utf-8"
config.fields	string	Defines the list of metric properties included in the response. metricId is always included in the result. The following additional properties are available: displayName: The name of the metric in the user interface. Enabled by default. description: A short description of the metric. Enabled by default. unit: The unit of the metric. Enabled by default. tags: The tags of the metric. dduBillable: An indicator whether the usage of metric consumes Davis data units. Deprecated and always false for Dynatrace Platform Subscription. Superseded by billable. billable: An indicator whether the usage of metric is billable. created: The timestamp (UTC milliseconds) when the metrics has been created. lastWritten: The timestamp (UTC milliseconds) when metric data points have been written for the last time. aggregationTypes: The list of allowed aggregations for the metric. Note that it may be different after a transformation is applied. defaultAggregation: The default aggregation of the metric. It is used when no aggregation is specified or the :auto transformation is set. dimensionDefinitions: The fine metric division (for example, process group and process ID for some process-related metric). transformations: A list of transformations that can be applied to the metric. entityType: A list of entity types supported by the metric. minimumValue: The minimum allowed value of the metric. maximumValue: The maximum allowed value of the metric. rootCauseRelevant: Whether (true or false) the metric is related to a root cause of a problem. A root-cause relevant metric represents a strong indicator for a faulty component. impactRelevant: Whether (true or false) the metric is relevant to a problem's impact. An impact-relevant metric is highly dependent on other metrics and changes because an underlying root-cause metric has changed. metricValueType: The type of the metric's value. You have these options: score: A score metric is a metric where high values indicate a good situation, while low values indicate trouble. An example of such a metric is a success rate. error: An error metric is a metric where high values indicate trouble, while low values indicate a good situation. An example of such a metric is an error count. latency: The latency of the metric, in minutes. The latency is the expected reporting delay (for example, caused by constraints of cloud vendors or other third-party data sources) between the observation of a metric data point and its availability in Dynatrace. The allowed value range is from 1 to 60 minutes. metricSelector: The underlying metric selector used by a func: metric. scalar: Indicates whether the metric expression resolves to a scalar (true) or to a series (false). A scalar result always contains one data point. The amount of data points in a series result depends on the resolution you're using. resolutionInfSupported: If true, resolution=Inf can be applied to the metric query. To add properties, list them with leading plus +. To exclude default properties, list them with leading minus -. To specify several properties, join them with a comma (for example fields=+aggregationTypes,-description). If you specify just one property, the response contains the metric key and the specified property. To return metric keys only, specify metricId here.
config.metadataSelector	string	The metadata scope of the query. Only metrics with specified properties are included to the response. You can set one or more of the following criteria. Values are case-sensitive and the EQUALS operator is used. If several values are specified, the OR logic applies. unit("unit-1","unit-2") tags("tag-1","tag-2") dimensionKey("dimkey-1","dimkey-2"). The filtering applies only to dimensions that were written within the last 14 days. custom("true"). "true" to include only user-defined metrics metrics (without namespace or with ext:, calc:, func:, appmon:), "false" to filter them out. exported("true"). "true" to include only exported metrics, "false" to filter them out. To set several criteria, separate them with a comma (,). For example, tags("feature","cloud"),unit("Percent"),dimensionKey("location"),custom("true"). Only results matching all criteria are included in response. For example, to list metrics that have the tags feature AND cloud with a unit of Percent OR MegaByte AND a dimension with a dimension key location, use this metadataSelector: tags("feature"),unit("Percent","MegaByte"),tags("cloud"),dimensionKey("location").
config.metricSelector	string	Selects metrics for the query by their keys. You can specify multiple metric keys separated by commas (for example, metrickey1,metrickey2). To select multiple metrics belonging to the same parent, list the last part of the required metric keys in parentheses, separated by commas, while keeping the common part untouched. For example, to list the builtin:host.cpu.idle and builtin:host.cpu.user metric, write: builtin:host.cpu.(idle,user). You can select a full set of related metrics by using a trailing asterisk (*) wildcard. For example, builtin:host.* selects all host-based metrics and builtin:* selects all Dynatrace-provided metrics. You can set additional transformation operators, separated by a colon (:). See Metrics selector transformations in Dynatrace Documentation for additional information on available result transformations and syntax. Only aggregation, merge, parents, and splitBy transformations are supported by this endpoint. If the metric key contains any symbols you must quote (") the key. The following characters inside of a quoted metric key must be escaped with a tilde (~): Quotes (") Tildes (~) For example, to query the metric with the key of ext:selfmonitoring.jmx.Agents: Type "APACHE" you must specify this selector: "ext:selfmonitoring.jmx.Agents: Type ~"APACHE~"" To find metrics based on a search term, rather than metricId, use the text query parameter instead of this one.
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of metric schemata in a single response payload. The maximal allowed page size is 500. If not set, 100 is used. If a value higher than 500 is used, only 500 results per page are returned.
config.text	string	Metric registry search term. Only show metrics that contain the term in their key, display name, or description. Use the metricSelector parameter instead of this one to select a complete metric hierarchy instead of doing a text-based search.
config.writtenSince	string	Filters the resulted set of metrics to those that have data points within the specified timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years

Returns

Return type	Status code	Description
MetricDescriptorCollection	200	Success

Throws

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

Code example

import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await metricsClient.allMetrics({
  acceptType: "application/json; charset=utf-8",
});

delete

metricsClient.delete(config): Promise<void>

Deletes the specified metric

Required scope: environment-api:metrics:write Required permission: environment:roles:manage-settings

Deletion cannot be undone! You can't delete a metric if it has data points ingested within the last two hours.

Parameters

Name	Type	Description
config.metricKey*required	string	The key of the required metric.

Returns

Return type	Status code	Description
void	202	Success. The deletion of the metric has been triggered.

Throws

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

Code example

import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await metricsClient.delete({
  metricKey: "...",
});

ingest

metricsClient.ingest(config): Promise<ValidationResponse>

Pushes metric data points to Dynatrace

Required scope: storage:metrics:write Required permission: storage:metrics:write

Parameters

Name	Type
config.body*required	string

Returns

Return type	Status code	Description
void	202	The provided business events are all accepted and will be processed.

Throws

Error Type	Error Message
ValidationResponseError	Some data points are invalid. Valid data points are accepted and will be processed in the background.
ErrorEnvelopeError	Client side error. | Server side error.

Code example

import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await metricsClient.ingest({
  body: "server.cpu.temperature,cpu.id=0 42",
});

metric

metricsClient.metric(config): Promise<MetricDescriptor>

Gets the descriptor of the specified metric

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

Parameters

Name	Type	Description
config.acceptType*required	"application/json; charset=utf-8" | "text/csv; header=absent; charset=utf-8" | "text/csv; header=present; charset=utf-8"
config.metricKey*required	string	The key of the required metric. You can set additional transformation operators, separated by a colon (:). See Metrics selector transformations in Dynatrace Documentation for additional information on available result transformations and syntax.

Returns

Return type	Status code	Description
MetricDescriptor	200	Success

Throws

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

Code example

import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await metricsClient.metric({
  acceptType: "application/json; charset=utf-8",
  metricKey: "...",
});

query

metricsClient.query(config): Promise<MetricData>

Gets data points of the specified metrics

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

The following limits apply:

• The amount of aggregated data points in the response is limited to 1,000
• The amount of series in the response is limited to 1,000
  • The amount of data points per series is limited to 10,080 (minutes of one week)
  • The overall amount of data points is limited to 100,000

The dataPointCountRatio specifies the ratio of queried data points divided by the maximum number of data points per metric that are allowed in a single query. The dimensionCountRatio specifies the ratio of queried dimension tuples divided by the maximum number of dimension tuples allowed in a single query.

Parameters

Name	Type	Description
config.acceptType*required	"application/json; charset=utf-8" | "text/csv; header=absent; charset=utf-8" | "text/csv; header=present; charset=utf-8"
config.entitySelector	string	Specifies the entity scope of the query. Only data points delivered by matched entities are included in response. You must set one of these criteria: Entity type: type("TYPE") Dynatrace entity ID: entityId("id"). You can specify several IDs, separated by a comma (entityId("id-1","id-2")). All requested entities must be of the same type. You can add one or more of the following criteria. Values are case-sensitive and the EQUALS operator is used unless otherwise specified. Tag: tag("value"). Tags in [context]key:value, key:value, and value formats are detected and parsed automatically. Any colons (:) that are part of the key or value must be escaped with a backslash(\). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive. Management zone ID: mzId(123) Management zone name: mzName("value") Entity name: entityName.equals: performs a non-casesensitive EQUALS query. entityName.startsWith: changes the operator to BEGINS WITH. entityName.in: enables you to provide multiple values. The EQUALS operator applies. caseSensitive(entityName.equals("value")): takes any entity name criterion as an argument and makes the value case-sensitive. Health state (HEALTHY,UNHEALTHY): healthState("HEALTHY") First seen timestamp: firstSeenTms.<operator>(now-3h). Use any timestamp format from the from /to parameters. The following operators are available: lte: earlier than or at the specified time lt: earlier than the specified time gte: later than or at the specified time gt: later than the specified time Entity attribute: <attribute>("value1","value2") and <attribute>.exists(). To fetch the list of available attributes, execute the GET entity type request and check the properties field of the response. Relationships: fromRelationships.<relationshipName>() and toRelationships.<relationshipName>(). This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the GET entity type request and check the fromRelationships and toRelationships fields. Negation: not(<criterion>). Inverts any criterion except for type. For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma (,). For example, type("HOST"),healthState("HEALTHY"). Only results matching all criteria are included in the response. The maximum string length is 2,000 characters. Use the GET /metrics/\{metricId} call to fetch the list of possible entity types for your metric. To set a universal scope matching all entities, omit this parameter.
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of two hours is used (now-2h).
config.metricSelector	string	Selects metrics for the query by their keys. You can select up to 10 metrics for one query. You can specify multiple metric keys separated by commas (for example, metrickey1,metrickey2). To select multiple metrics belonging to the same parent, list the last part of the required metric keys in parentheses, separated by commas, while keeping the common part untouched. For example, to list the builtin:host.cpu.idle and builtin:host.cpu.user metric, write: builtin:host.cpu.(idle,user). If the metric key contains any symbols you must quote (") the key. The following characters inside of a quoted metric key must be escaped with a tilde (~): Quotes (") Tildes (~) For example, to query the metric with the key of ext:selfmonitoring.jmx.Agents: Type "APACHE" you must specify this selector: "ext:selfmonitoring.jmx.Agents: Type ~"APACHE~"" You can set additional transformation operators, separated by a colon (:). See Metrics selector transformations in Dynatrace Documentation for additional information on available result transformations and syntax.
config.mzSelector	string	The management zone scope of the query. Only metrics data relating to the specified management zones are included to the response. You can set one or more of the following criteria. Values are case-sensitive and the EQUALS operator is used. If several values are specified, the OR logic applies. mzId(123,456) mzName("name-1","name-2") To set several criteria, separate them with a comma (,). For example, mzName("name-1","name-2"),mzId(1234). Only results matching all of the criteria are included in the response.For example, to list metrics that have the id 123 OR 234 AND the name name-1 OR name-2, use this mzSelector: `mzId(123,234),mzName("name-1","name-2").
config.resolution	string	The desired resolution of data points. You can use one of the following options: The desired amount of data points. This is the default option. This is a reference number of points, which is not necessarily equal to the number of the returned data points. The desired timespan between data points. This is a reference timespan, which is not necessarily equal to the returned timespan. To use this option, specify the unit of the timespan. Valid units for the timespan are: m: minutes h: hours d: days w: weeks M: months q: quarters y: years If not set, the default is 120 data points. For example: Get data points which are 10 minutes apart: resolution=10m Get data points which are 3 weeks apart: resolution=3w
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
MetricData	200	Success

Throws

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

Code example

import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await metricsClient.query({
  acceptType: "application/json; charset=utf-8",
});

metricsUnitsClient

import { metricsUnitsClient } from '@dynatrace-sdk/client-classic-environment-v2';

allUnits

metricsUnitsClient.allUnits(config): Promise<UnitList>

Lists all available units

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

You can narrow down the output by providing filter criteria in the unitSelector field.

Parameters

Name	Type	Description
config.fields	string	Defines the list of properties to be included in the response. The ID of the unit is always included. The following additional properties are available: displayName: The display name of the unit. symbol: The symbol of the unit. description: A short description of the unit. By default, the ID, the display name, and the symbol are included. To add properties, list them with leading plus +. To exclude default properties, list them with leading minus -. To specify several properties, join them with a comma (for example fields=+description,-symbol). If you specify just one property, the response contains the unitId and the specified property. To return unit IDs only, specify unitId here.
config.unitSelector	string	Selects units to be included to the response. Available criteria: Compatibility: compatibleTo("unit","display-format"). Returns units that can be converted to the specified unit. The optional display format (binary or decimal) argument is supported by bit- and byte-based units and returns only units for the specified format.

Returns

Return type	Status code	Description
UnitList	200	Success

Throws

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

Code example

import { metricsUnitsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await metricsUnitsClient.allUnits();

convert

metricsUnitsClient.convert(config): Promise<UnitConversionResult>

Converts a value from a source unit into a target unit

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

If no target unit is set, the request finds an appropriate target unit automatically, taking into account the preferred number format (if specified).

Parameters

Name	Type	Description
config.numberFormat	string	The preferred number format of the target value. You can specify the following formats: binary decimal `Only used if the target unit if not set.
config.targetUnit	string	The ID of the target unit. If not set, the request finds an appropriate target unit automatically, based on the specified number format.
config.unitId*required	string	The ID of the source unit.
config.value*required	number	The value to be converted.

Returns

Return type	Status code	Description
UnitConversionResult	200	Success

Throws

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

Code example

import { metricsUnitsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await metricsUnitsClient.convert({
  unitId: "...",
  value: 10,
});

unit

metricsUnitsClient.unit(config): Promise<Unit>

Gets the properties of the specified unit

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

Parameters

Name	Type
config.unitId*required	string

Returns

Return type	Status code	Description
Unit	200	Success

Throws

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

Code example

import { metricsUnitsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await metricsUnitsClient.unit({
  unitId: "...",
});

monitoredEntitiesClient

import { monitoredEntitiesClient } from '@dynatrace-sdk/client-classic-environment-v2';

deleteSecurityContext

monitoredEntitiesClient.deleteSecurityContext(config): Promise<SecurityContextResultDto>

Deletes the security context for all entities matching the entity selector.

Required scope: settings:objects:write One of the following permissions is required:

• environment:roles:manage-settings
• settings:objects:write

Automatic management zone rules will apply again to entities without a security context.

Parameters

Name	Type	Description
config.entitySelector*required	string	Defines the scope of the entities to set the security context for. Only entities that can have management zones are considered for this operation You must set one of these criteria: Entity type: type("TYPE") Dynatrace entity ID: entityId("id"). You can specify several IDs, separated by a comma (entityId("id-1","id-2")). All requested entities must be of the same type. You can add one or more of the following criteria. Values are case-sensitive and the EQUALS operator is used unless otherwise specified. Tag: tag("value"). Tags in [context]key:value, key:value, and value formats are detected and parsed automatically. Any colons (:) that are part of the key or value must be escaped with a backslash(\). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive. Management zone ID: mzId(123) Management zone name: mzName("value") Entity name: entityName.equals: performs a non-casesensitive EQUALS query. entityName.startsWith: changes the operator to BEGINS WITH. entityName.in: enables you to provide multiple values. The EQUALS operator applies. caseSensitive(entityName.equals("value")): takes any entity name criterion as an argument and makes the value case-sensitive. Health state (HEALTHY,UNHEALTHY): healthState("HEALTHY") First seen timestamp: firstSeenTms.<operator>(now-3h). Use any timestamp format from the from /to parameters. The following operators are available: lte: earlier than or at the specified time lt: earlier than the specified time gte: later than or at the specified time gt: later than the specified time Entity attribute: <attribute>("value1","value2") and <attribute>.exists(). To fetch the list of available attributes, execute the GET entity type request and check the properties field of the response. Relationships: fromRelationships.<relationshipName>() and toRelationships.<relationshipName>(). This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the GET entity type request and check the fromRelationships and toRelationships fields. Negation: not(<criterion>). Inverts any criterion except for type. For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma (,). For example, type("HOST"),healthState("HEALTHY"). Only results matching all criteria are included in the response. The maximum string length is 2,000 characters.
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of three days is used (now-3d).
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
SecurityContextResultDto	200	Success

Throws

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

Code example

import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await monitoredEntitiesClient.deleteSecurityContext({
    entitySelector: "...",
  });

getEntities

monitoredEntitiesClient.getEntities(config): Promise<EntitiesList>

Gets the information about monitored entities

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

Lists entities observed within the specified timeframe along with their properties.

When you query entities of the SERVICE_METHOD type, only the following requests are returned:

• Key requests
• Top X requests that are used for baselining
• Requests that have caused a problem

You can limit the output by using pagination:

1. Specify the number of results per page in the pageSize query parameter.
2. Use the cursor from the nextPageKey field of the previous response in the nextPageKey query parameter to obtain subsequent pages.

Parameters

Name	Type	Description
config.entitySelector	string	Defines the scope of the query. Only entities matching the specified criteria are included into response. You must set one of these criteria: Entity type: type("TYPE") Dynatrace entity ID: entityId("id"). You can specify several IDs, separated by a comma (entityId("id-1","id-2")). All requested entities must be of the same type. You can add one or more of the following criteria. Values are case-sensitive and the EQUALS operator is used unless otherwise specified. Tag: tag("value"). Tags in [context]key:value, key:value, and value formats are detected and parsed automatically. Any colons (:) that are part of the key or value must be escaped with a backslash(\). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive. Management zone ID: mzId(123) Management zone name: mzName("value") Entity name: entityName.equals: performs a non-casesensitive EQUALS query. entityName.startsWith: changes the operator to BEGINS WITH. entityName.in: enables you to provide multiple values. The EQUALS operator applies. caseSensitive(entityName.equals("value")): takes any entity name criterion as an argument and makes the value case-sensitive. Health state (HEALTHY,UNHEALTHY): healthState("HEALTHY") First seen timestamp: firstSeenTms.<operator>(now-3h). Use any timestamp format from the from /to parameters. The following operators are available: lte: earlier than or at the specified time lt: earlier than the specified time gte: later than or at the specified time gt: later than the specified time Entity attribute: <attribute>("value1","value2") and <attribute>.exists(). To fetch the list of available attributes, execute the GET entity type request and check the properties field of the response. Relationships: fromRelationships.<relationshipName>() and toRelationships.<relationshipName>(). This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the GET entity type request and check the fromRelationships and toRelationships fields. Negation: not(<criterion>). Inverts any criterion except for type. For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma (,). For example, type("HOST"),healthState("HEALTHY"). Only results matching all criteria are included in the response. The maximum string length is 2,000 characters. The field is required when you're querying the first page of results.
config.fields	string	Defines the list of entity properties included in the response. The ID and the name of an entity are always included to the response. To add properties, list them with leading plus +. You can specify several properties, separated by a comma (for example fields=+lastSeenTms,+properties.BITNESS). Use the GET entity type request to fetch the list of properties available for your entity type. Fields from the properties object must be specified in the properties.FIELD format (for example, properties.BITNESS). When requesting large amounts of relationship fields, throttling can apply.
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of three days is used (now-3d).
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of entities. If not set, 50 is used.
config.sort	string	Defines the ordering of the entities returned. This field is optional, each field has a sign prefix (+/-), which corresponds to sorting order ( + for ascending and - for descending). If no sign prefix is set, then default ascending sorting order will be applied. Currently ordering is only available for the display name (for example sort=name or sort =+name for ascending, sort=-name for descending)
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
EntitiesList	200	Success

Throws

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

Code example

import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await monitoredEntitiesClient.getEntities();

getEntity

monitoredEntitiesClient.getEntity(config): Promise<Entity>

Gets the properties of the specified monitored entity

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

Parameters

Name	Type	Description
config.entityId*required	string	The ID of the required entity.
config.fields	string	Defines the list of entity properties included in the response. The ID and the name of an entity are always included to the response. To add properties, list them with leading plus +. You can specify several properties, separated by a comma (for example fields=+lastSeenTms,+properties.BITNESS). Use the GET entity type request to fetch the list of properties available for your entity type. Fields from the properties object must be specified in the properties.FIELD format (for example, properties.BITNESS). When requesting large amounts of relationship fields, throttling can apply.
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of three days is used (now-3d).
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
Entity	200	Success

Throws

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

Code example

import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await monitoredEntitiesClient.getEntity({
  entityId: "...",
});

getEntityType

monitoredEntitiesClient.getEntityType(config): Promise<EntityType>

Gets a list of properties for the specified entity type

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

Parameters

Name	Type	Description
config.type*required	string	The required entity type.

Returns

Return type	Status code	Description
EntityType	200	Success

Throws

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

Code example

import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await monitoredEntitiesClient.getEntityType({
  type: "...",
});

getEntityTypes

monitoredEntitiesClient.getEntityTypes(config): Promise<EntityTypeList>

Gets a list of properties for all entity types

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

You can limit the output by using pagination:

1. Specify the number of results per page in the pageSize query parameter.
2. Use the cursor from the nextPageKey field of the previous response in the nextPageKey query parameter to obtain subsequent pages.

Parameters

Name	Type	Description
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of entity types in a single response payload. The maximal allowed page size is 500. If not set, 50 is used.

Returns

Return type	Status code	Description
EntityTypeList	200	Success

Throws

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

Code example

import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await monitoredEntitiesClient.getEntityTypes();

pushCustomDevice

monitoredEntitiesClient.pushCustomDevice(config): Promise<void | CustomDeviceCreationResult>

Creates or updates a custom device

Required scope: environment-api:entities:write Required permission: environment:roles:manage-settings

Parameters

Name	Type	Description
config.body*required	CustomDeviceCreation
config.uiBased	boolean	If true, it will be handled as if it was created via UI. It will be refreshed automatically and won't age out.

Returns

Return type	Status code	Description
CustomDeviceCreationResult	201	Success
void	204	Success

Throws

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

Code example

import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await monitoredEntitiesClient.pushCustomDevice(
  { body: { customDeviceId: "...", displayName: "..." } },
);

setSecurityContext

monitoredEntitiesClient.setSecurityContext(config): Promise<SecurityContextResultDto>

Sets the given security context for all entities matching the entity selector.

Required scope: settings:objects:write One of the following permissions is required:

• environment:roles:manage-settings
• settings:objects:write

Matching entities will have a management zone assigned, if the given security context matches the name of an already existing management zone. This endpoint does not create a new management zone, if there is no management zone with the provided name. Automatic management zone rules will not apply to entities with a set security context. It will need to be removed, to have them apply again.

Parameters

Name	Type	Description
config.body*required	SecurityContextDtoImpl
config.entitySelector*required	string	Defines the scope of the entities to set the security context for. Only entities that can have management zones are considered for this operation You must set one of these criteria: Entity type: type("TYPE") Dynatrace entity ID: entityId("id"). You can specify several IDs, separated by a comma (entityId("id-1","id-2")). All requested entities must be of the same type. You can add one or more of the following criteria. Values are case-sensitive and the EQUALS operator is used unless otherwise specified. Tag: tag("value"). Tags in [context]key:value, key:value, and value formats are detected and parsed automatically. Any colons (:) that are part of the key or value must be escaped with a backslash(\). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive. Management zone ID: mzId(123) Management zone name: mzName("value") Entity name: entityName.equals: performs a non-casesensitive EQUALS query. entityName.startsWith: changes the operator to BEGINS WITH. entityName.in: enables you to provide multiple values. The EQUALS operator applies. caseSensitive(entityName.equals("value")): takes any entity name criterion as an argument and makes the value case-sensitive. Health state (HEALTHY,UNHEALTHY): healthState("HEALTHY") First seen timestamp: firstSeenTms.<operator>(now-3h). Use any timestamp format from the from /to parameters. The following operators are available: lte: earlier than or at the specified time lt: earlier than the specified time gte: later than or at the specified time gt: later than the specified time Entity attribute: <attribute>("value1","value2") and <attribute>.exists(). To fetch the list of available attributes, execute the GET entity type request and check the properties field of the response. Relationships: fromRelationships.<relationshipName>() and toRelationships.<relationshipName>(). This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the GET entity type request and check the fromRelationships and toRelationships fields. Negation: not(<criterion>). Inverts any criterion except for type. For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma (,). For example, type("HOST"),healthState("HEALTHY"). Only results matching all criteria are included in the response. The maximum string length is 2,000 characters.
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of three days is used (now-3d).
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
SecurityContextResultDto	200	Success

Throws

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

Code example

import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await monitoredEntitiesClient.setSecurityContext({
    entitySelector: "...",
    body: {},
  });

monitoredEntitiesCustomTagsClient

import { monitoredEntitiesCustomTagsClient } from '@dynatrace-sdk/client-classic-environment-v2';

deleteTags

monitoredEntitiesCustomTagsClient.deleteTags(config): Promise<DeletedEntityTags>

Deletes the specified tag from the specified entities

Required scope: environment-api:entities:write Required permission: environment:roles:manage-settings

Parameters

Name	Type	Description
config.deleteAllWithKey	boolean	If true, all tags with the specified key are deleted, regardless of the value. If false, only tags with exact match of key and value are deleted. If not set, false is used.
config.entitySelector*required	string	Specifies the entities where you want to delete tags. You must set one of these criteria: Entity type: type("TYPE") Dynatrace entity ID: entityId("id"). You can specify several IDs, separated by a comma (entityId("id-1","id-2")). All requested entities must be of the same type. You can add one or more of the following criteria. Values are case-sensitive and the EQUALS operator is used unless otherwise specified. Tag: tag("value"). Tags in [context]key:value, key:value, and value formats are detected and parsed automatically. Any colons (:) that are part of the key or value must be escaped with a backslash(\). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive. Management zone ID: mzId(123) Management zone name: mzName("value") Entity name: entityName.equals: performs a non-casesensitive EQUALS query. entityName.startsWith: changes the operator to BEGINS WITH. entityName.in: enables you to provide multiple values. The EQUALS operator applies. caseSensitive(entityName.equals("value")): takes any entity name criterion as an argument and makes the value case-sensitive. Health state (HEALTHY,UNHEALTHY): healthState("HEALTHY") First seen timestamp: firstSeenTms.<operator>(now-3h). Use any timestamp format from the from /to parameters. The following operators are available: lte: earlier than or at the specified time lt: earlier than the specified time gte: later than or at the specified time gt: later than the specified time Entity attribute: <attribute>("value1","value2") and <attribute>.exists(). To fetch the list of available attributes, execute the GET entity type request and check the properties field of the response. Relationships: fromRelationships.<relationshipName>() and toRelationships.<relationshipName>(). This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the GET entity type request and check the fromRelationships and toRelationships fields. Negation: not(<criterion>). Inverts any criterion except for type. For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma (,). For example, type("HOST"),healthState("HEALTHY"). Only results matching all criteria are included in the response. The maximum string length is 2,000 characters.
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of 24 hours is used (now-24h).
config.key*required	string	The key of the tag to be deleted. If deleteAllWithKey is true, then all tags with this key are deleted. Otherwise, only tags with exact match of key and value are deleted. For value-only tags, specify the value here.
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.
config.value	string	The value of the tag to be deleted. The value is ignored if deleteAllWithKey is true. For value-only tags, specify the value in the key parameter.

Returns

Return type	Status code	Description
DeletedEntityTags	200	Success

Throws

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

Code example

import { monitoredEntitiesCustomTagsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await monitoredEntitiesCustomTagsClient.deleteTags({
    key: "...",
    entitySelector: "...",
  });

getTags

monitoredEntitiesCustomTagsClient.getTags(config): Promise<CustomEntityTags>

Gets a list of custom tags applied to the specified entities

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

Automatically applied tags and imported tags are not included.

Parameters

Name	Type	Description
config.entitySelector*required	string	Specifies the entities where you want to read tags. You must set one of these criteria: Entity type: type("TYPE") Dynatrace entity ID: entityId("id"). You can specify several IDs, separated by a comma (entityId("id-1","id-2")). All requested entities must be of the same type. You can add one or more of the following criteria. Values are case-sensitive and the EQUALS operator is used unless otherwise specified. Tag: tag("value"). Tags in [context]key:value, key:value, and value formats are detected and parsed automatically. Any colons (:) that are part of the key or value must be escaped with a backslash(\). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive. Management zone ID: mzId(123) Management zone name: mzName("value") Entity name: entityName.equals: performs a non-casesensitive EQUALS query. entityName.startsWith: changes the operator to BEGINS WITH. entityName.in: enables you to provide multiple values. The EQUALS operator applies. caseSensitive(entityName.equals("value")): takes any entity name criterion as an argument and makes the value case-sensitive. Health state (HEALTHY,UNHEALTHY): healthState("HEALTHY") First seen timestamp: firstSeenTms.<operator>(now-3h). Use any timestamp format from the from /to parameters. The following operators are available: lte: earlier than or at the specified time lt: earlier than the specified time gte: later than or at the specified time gt: later than the specified time Entity attribute: <attribute>("value1","value2") and <attribute>.exists(). To fetch the list of available attributes, execute the GET entity type request and check the properties field of the response. Relationships: fromRelationships.<relationshipName>() and toRelationships.<relationshipName>(). This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the GET entity type request and check the fromRelationships and toRelationships fields. Negation: not(<criterion>). Inverts any criterion except for type. For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma (,). For example, type("HOST"),healthState("HEALTHY"). Only results matching all criteria are included in the response. The maximum string length is 2,000 characters.
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of 24 hours is used (now-24h).
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
CustomEntityTags	200	Success

Throws

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

Code example

import { monitoredEntitiesCustomTagsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await monitoredEntitiesCustomTagsClient.getTags({
    entitySelector: "...",
  });

postTags

monitoredEntitiesCustomTagsClient.postTags(config): Promise<AddedEntityTags>

Adds custom tags to the specified entities

Required scope: environment-api:entities:write Required permission: environment:roles:manage-settings

All existing tags remain unaffected.

Parameters

Name	Type	Description
config.body*required	AddEntityTags
config.entitySelector*required	string	Specifies the entities where you want to update tags. You must set one of these criteria: Entity type: type("TYPE") Dynatrace entity ID: entityId("id"). You can specify several IDs, separated by a comma (entityId("id-1","id-2")). All requested entities must be of the same type. You can add one or more of the following criteria. Values are case-sensitive and the EQUALS operator is used unless otherwise specified. Tag: tag("value"). Tags in [context]key:value, key:value, and value formats are detected and parsed automatically. Any colons (:) that are part of the key or value must be escaped with a backslash(\). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive. Management zone ID: mzId(123) Management zone name: mzName("value") Entity name: entityName.equals: performs a non-casesensitive EQUALS query. entityName.startsWith: changes the operator to BEGINS WITH. entityName.in: enables you to provide multiple values. The EQUALS operator applies. caseSensitive(entityName.equals("value")): takes any entity name criterion as an argument and makes the value case-sensitive. Health state (HEALTHY,UNHEALTHY): healthState("HEALTHY") First seen timestamp: firstSeenTms.<operator>(now-3h). Use any timestamp format from the from /to parameters. The following operators are available: lte: earlier than or at the specified time lt: earlier than the specified time gte: later than or at the specified time gt: later than the specified time Entity attribute: <attribute>("value1","value2") and <attribute>.exists(). To fetch the list of available attributes, execute the GET entity type request and check the properties field of the response. Relationships: fromRelationships.<relationshipName>() and toRelationships.<relationshipName>(). This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the GET entity type request and check the fromRelationships and toRelationships fields. Negation: not(<criterion>). Inverts any criterion except for type. For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma (,). For example, type("HOST"),healthState("HEALTHY"). Only results matching all criteria are included in the response. The maximum string length is 2,000 characters.
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of 24 hours is used (now-24h).
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
AddedEntityTags	200	Success

Throws

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

Code example

import { monitoredEntitiesCustomTagsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await monitoredEntitiesCustomTagsClient.postTags({
    entitySelector: "...",
    body: { tags: [{ key: "..." }] },
  });

monitoredEntitiesMonitoringStateClient

import { monitoredEntitiesMonitoringStateClient } from '@dynatrace-sdk/client-classic-environment-v2';

getStates

monitoredEntitiesMonitoringStateClient.getStates(config): Promise<MonitoredStates>

Lists monitoring states of entities

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

Only process group instances are supported.

Parameters

Name	Type	Description
config.entitySelector	string	Specifies the process group instances where you're querying the state. Use the PROCESS_GROUP_INSTANCE entity type. You must set one of these criteria: Entity type: type("TYPE") Dynatrace entity ID: entityId("id"). You can specify several IDs, separated by a comma (entityId("id-1","id-2")). All requested entities must be of the same type. You can add one or more of the following criteria. Values are case-sensitive and the EQUALS operator is used unless otherwise specified. Tag: tag("value"). Tags in [context]key:value, key:value, and value formats are detected and parsed automatically. Any colons (:) that are part of the key or value must be escaped with a backslash(\). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive. Management zone ID: mzId(123) Management zone name: mzName("value") Entity name: entityName.equals: performs a non-casesensitive EQUALS query. entityName.startsWith: changes the operator to BEGINS WITH. entityName.in: enables you to provide multiple values. The EQUALS operator applies. caseSensitive(entityName.equals("value")): takes any entity name criterion as an argument and makes the value case-sensitive. Health state (HEALTHY,UNHEALTHY): healthState("HEALTHY") First seen timestamp: firstSeenTms.<operator>(now-3h). Use any timestamp format from the from /to parameters. The following operators are available: lte: earlier than or at the specified time lt: earlier than the specified time gte: later than or at the specified time gt: later than the specified time Entity attribute: <attribute>("value1","value2") and <attribute>.exists(). To fetch the list of available attributes, execute the GET entity type request and check the properties field of the response. Relationships: fromRelationships.<relationshipName>() and toRelationships.<relationshipName>(). This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the GET entity type request and check the fromRelationships and toRelationships fields. Negation: not(<criterion>). Inverts any criterion except for type. For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma (,). For example, type("HOST"),healthState("HEALTHY"). Only results matching all criteria are included in the response. The maximum string length is 2,000 characters.
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of 24 hours is used (now-24h).
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of monitoring states in a single response payload. The maximal allowed page size is 500. If not set, 500 is used.
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
MonitoredStates	200	Success

Throws

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

Code example

import { monitoredEntitiesMonitoringStateClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await monitoredEntitiesMonitoringStateClient.getStates();

networkZonesClient

import { networkZonesClient } from '@dynatrace-sdk/client-classic-environment-v2';

createOrUpdateNetworkZone

networkZonesClient.createOrUpdateNetworkZone(config): Promise<void | EntityShortRepresentation>

Updates an existing network zone or creates a new one

Required scope: environment-api:network-zones:write Required permission: environment:roles:manage-settings

If the network zone with the specified ID does not exist, a new network zone is created.

The ID is not case sensitive. Dynatrace stores the ID in lowercase.

Parameters

Name	Type	Description
config.body*required	NetworkZone
config.id*required	string	The ID of the network zone to be updated. If you set the ID in the body as well, it must match this ID. The ID is not case sensitive. Dynatrace stores the ID in lowercase.

Returns

Return type	Status code	Description
EntityShortRepresentation	201	Success. The new network zone has been created. The response body contains the ID of the new network zone.
void	204	Success. The network zone has been updated. Response doesn't have a body.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await networkZonesClient.createOrUpdateNetworkZone({
    id: "...",
    body: {},
  });

deleteNetworkZone

networkZonesClient.deleteNetworkZone(config): Promise<void>

Deletes the specified network zone

Required scope: environment-api:network-zones:write Required permission: environment:roles:manage-settings

You can only delete an empty network zone (a zone that no ActiveGate or OneAgent is using).

If the network zone is used as an alternative zone for any OneAgent, it will be automatically removed from the list of possible alternatives.

Parameters

Name	Type	Description
config.id*required	string	The ID of the network zone to be deleted.

Returns

Return type	Status code	Description
void	204	Deleted. Response doesn't have a body.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. See error message in the response body for details. | Client side error. | Server side error.

Code example

import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await networkZonesClient.deleteNetworkZone({
  id: "...",
});

getAllNetworkZones

networkZonesClient.getAllNetworkZones(config): Promise<NetworkZoneList>

Lists all existing network zones

Required scope: environment-api:network-zones:read Required permission: environment:roles:viewer

Returns

Return type	Status code	Description
NetworkZoneList	200	Success

Throws

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

Code example

import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await networkZonesClient.getAllNetworkZones();

getHostStats

networkZonesClient.getHostStats(config): Promise<NetworkZoneConnectionStatistics>

Gets the statistics about hosts using the network zone

Required scope: environment-api:network-zones:read Required permission: environment:roles:manage-settings

Parameters

Name	Type	Description
config.filter	"all" | "configuredButNotConnectedOnly" | "connectedAsAlternativeOnly" | "connectedAsFailoverOnly" | "connectedAsFailoverWithoutOwnActiveGatesOnly"	Filters the resulting set of hosts: all: All hosts using the zone. configuredButNotConnectedOnly: Hosts from the network zone that use other zones. connectedAsAlternativeOnly: Hosts that use the network zone as an alternative. connectedAsFailoverOnly: Hosts from other zones that use the zone (not configured as an alternative) even though ActiveGates of higher priority are available. connectedAsFailoverWithoutOwnActiveGatesOnly: Hosts from other zones that use the zone (not configured as an alternative) and no ActiveGates of higher priority are available. If not set, all is used.
config.id*required	string	The ID of the required network zone.

Returns

Return type	Status code	Description
NetworkZoneConnectionStatistics	200	Success

Throws

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

Code example

import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await networkZonesClient.getHostStats({
  id: "...",
});

getNetworkZoneSettings

networkZonesClient.getNetworkZoneSettings(config): Promise<NetworkZoneSettings>

Gets the global configuration of network zones

Required scope: environment-api:network-zones:read Required permission: environment:roles:viewer

Returns

Return type	Status code	Description
NetworkZoneSettings	200	Success

Throws

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

Code example

import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await networkZonesClient.getNetworkZoneSettings();

getSingleNetworkZone

networkZonesClient.getSingleNetworkZone(config): Promise<NetworkZone>

Gets parameters of the specified network zone

Required scope: environment-api:network-zones:read Required permission: environment:roles:viewer

Parameters

Name	Type	Description
config.id*required	string	The ID of the required network zone.

Returns

Return type	Status code	Description
NetworkZone	200	Success

Throws

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

Code example

import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await networkZonesClient.getSingleNetworkZone({
  id: "...",
});

updateNetworkZoneSettings

networkZonesClient.updateNetworkZoneSettings(config): Promise<void>

Updates the global configuration of network zones

Required scope: environment-api:network-zones:write Required permission: environment:roles:manage-settings

Parameters

Name	Type
config.body*required	NetworkZoneSettings

Returns

Return type	Status code	Description
void	204	Success. The global network zones configuration has been updated. Response doesn't have a body.

Throws

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

Code example

import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await networkZonesClient.updateNetworkZoneSettings({
    body: {},
  });

problemsClient

import { problemsClient } from '@dynatrace-sdk/client-classic-environment-v2';

closeProblem

problemsClient.closeProblem(config): Promise<void | ProblemCloseResult>

Closes the specified problem and adds a closing comment on it

Required scope: environment-api:problems:write Required permission: environment:roles:viewer

Parameters

Name	Type	Description
config.body*required	ProblemCloseRequestDtoImpl
config.problemId*required	string	The ID of the required problem.

Returns

Return type	Status code	Description
ProblemCloseResult	200	Success
void	204	The problem is closed already the request hasn't been executed.

Throws

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

Code example

import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await problemsClient.closeProblem({
  problemId: "...",
  body: { message: "..." },
});

createComment

problemsClient.createComment(config): Promise<void>

Adds a new comment on the specified problem

Required scope: environment-api:problems:write Required permission: environment:roles:viewer

Parameters

Name	Type	Description
config.body*required	CommentRequestDtoImpl
config.problemId*required	string	The ID of the required problem.

Returns

Return type	Status code	Description
void	201	Success. The comment has been added.

Throws

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

Code example

import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await problemsClient.createComment({
  problemId: "...",
  body: { message: "..." },
});

deleteComment

problemsClient.deleteComment(config): Promise<void>

Deletes the specified comment from a problem

Required scope: environment-api:problems:write Required permission: environment:roles:viewer

Parameters

Name	Type	Description
config.commentId*required	string	The ID of the required comment.
config.problemId*required	string	The ID of the required problem.

Returns

Return type	Status code	Description
void	204	Success. The comment has been deleted.

Throws

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

Code example

import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await problemsClient.deleteComment({
  problemId: "...",
  commentId: "...",
});

getComment

problemsClient.getComment(config): Promise<Comment>

Gets the specified comment on a problem

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

Parameters

Name	Type	Description
config.commentId*required	string	The ID of the required comment.
config.problemId*required	string	The ID of the required problem.

Returns

Return type	Status code	Description
Comment	200	Success

Throws

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

Code example

import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await problemsClient.getComment({
  problemId: "...",
  commentId: "...",
});

getComments

problemsClient.getComments(config): Promise<CommentsList>

Gets all comments on the specified problem

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

Parameters

Name	Type	Description
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters except the optional fields parameter.
config.pageSize	number	The amount of comments in a single response payload. The maximal allowed page size is 500. If not set, 10 is used.
config.problemId*required	string	The ID of the required problem.

Returns

Return type	Status code	Description
CommentsList	200	Success

Throws

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

Code example

import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await problemsClient.getComments({
  problemId: "...",
});

getProblem

problemsClient.getProblem(config): Promise<Problem>

Gets the properties of the specified problem

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

Parameters

Name	Type	Description
config.fields	string	A list of additional problem properties you can add to the response. The following properties are available (all other properties are always included and you can't remove them from the response): evidenceDetails: The details of the root cause. impactAnalysis: The impact analysis of the problem on other entities/users. recentComments: A list of the most recent comments to the problem. To add properties, specify them as a comma-separated list (for example, evidenceDetails,impactAnalysis).
config.problemId*required	string	The ID of the required problem.

Returns

Return type	Status code	Description
Problem	200	Success

Throws

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

Code example

import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await problemsClient.getProblem({
  problemId: "...",
});

getProblems

problemsClient.getProblems(config): Promise<Problems>

Lists problems observed within the specified timeframe

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

Parameters

Name	Type	Description
config.entitySelector	string	The entity scope of the query. You must set one of these criteria: Entity type: type("TYPE") Dynatrace entity ID: entityId("id"). You can specify several IDs, separated by a comma (entityId("id-1","id-2")). All requested entities must be of the same type. You can add one or more of the following criteria. Values are case-sensitive and the EQUALS operator is used unless otherwise specified. Tag: tag("value"). Tags in [context]key:value, key:value, and value formats are detected and parsed automatically. Any colons (:) that are part of the key or value must be escaped with a backslash(\). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive. Management zone ID: mzId(123) Management zone name: mzName("value") Entity name: entityName.equals: performs a non-casesensitive EQUALS query. entityName.startsWith: changes the operator to BEGINS WITH. entityName.in: enables you to provide multiple values. The EQUALS operator applies. caseSensitive(entityName.equals("value")): takes any entity name criterion as an argument and makes the value case-sensitive. Health state (HEALTHY,UNHEALTHY): healthState("HEALTHY") First seen timestamp: firstSeenTms.<operator>(now-3h). Use any timestamp format from the from /to parameters. The following operators are available: lte: earlier than or at the specified time lt: earlier than the specified time gte: later than or at the specified time gt: later than the specified time Entity attribute: <attribute>("value1","value2") and <attribute>.exists(). To fetch the list of available attributes, execute the GET entity type request and check the properties field of the response. Relationships: fromRelationships.<relationshipName>() and toRelationships.<relationshipName>(). This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the GET entity type request and check the fromRelationships and toRelationships fields. Negation: not(<criterion>). Inverts any criterion except for type. For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma (,). For example, type("HOST"),healthState("HEALTHY"). Only results matching all criteria are included in the response. The maximum string length is 2,000 characters. The maximum number of entities that may be selected is limited to 10000.
config.fields	string	A list of additional problem properties you can add to the response. The following properties are available (all other properties are always included and you can't remove them from the response): evidenceDetails: The details of the root cause. impactAnalysis: The impact analysis of the problem on other entities/users. recentComments: A list of the most recent comments to the problem. To add properties, specify them as a comma-separated list (for example, evidenceDetails,impactAnalysis). The field is valid only for the current page of results. You must set it for each page you're requesting.
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of two hours is used (now-2h).
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters except the optional fields parameter.
config.pageSize	number	The amount of problems in a single response payload. The maximal allowed page size is 500. If not set, 50 is used.
config.problemSelector	string	Defines the scope of the query. Only problems matching the specified criteria are included into response. You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the OR logic applies. All values must be quoted. Status: status("open") or status("closed"). You can specify only one status. Severity level: severityLevel("level-1","level-2"). Find the possible values in the description of the severityLevel field of the response. Impact level: impactLevel("level-11","level-2") Find the possible values in the description of the impactLevel field of the response. Root cause entity: rootCauseEntity("id-1", "id-2"). Management zone ID: managementZoneIds("mZId-1", "mzId-2"). Management zone name: managementZones("value-1","value-2"). Impacted entities: impactedEntities("id-1", "id-2"). Affected entities: affectedEntities("id-1", "id-2"). Type of affected entities: affectedEntityTypes("value-1","value-2"). Problem ID: problemId("id-1", "id-2"). Alerting profile ID: problemFilterIds("id-1", "id-2"). Alerting profile name (contains, case-insensitive): problemFilterNames("value-1","value-2"). Alerting profile name (exact match, case-insensitive): problemFilterNames.equals("value-1","value-2"). Entity tags: entityTags("[context]key:value","key:value"). Tags in [context]key:value, key:value, and value formats are detected and parsed automatically. If a value-only tag has a colon (:) in it, you must escape the colon with a backslash(\). Otherwise, the tag will be parsed as a key:value tag. All tag values are case-sensitive. Display ID of the problem: displayId("id-1", "id-2"). Under maintenance: underMaintenance(true|false). Shows (true) or hides (false) all problems created during maintenance mode. Text search: text("value"). Text search on the following fields: problem title, event titles, displayId and the id of affected and impacted entities. The text search is case insensitive, partial matching and based on a relevance score. Therefore the relevance sort option should be used to get the most relevant problems first. The special characters \~ and " need to be escaped using a \~ (e.g. double quote search text("\~"")). The search value is limited to 30 characters. To set several criteria, separate them with a comma (,). Only results matching all criteria are included in the response.
config.sort	string	Specifies a set of comma-separated (,) fields for sorting in the problem list. You can sort by the following properties with a sign prefix for the sorting order. status: problem status (+ open problems first or - closed problems first) startTime: problem start time (+ old problems first or - new problems first) relevance: problem relevance (+ least relevant problems first or - most relevant problems first) - can be used only in combination with text search If no prefix is set, + is used. You can specify several levels of sorting. For example, +status,-startTime sorts problems by status, open problems first. Within the status, problems are sorted by start time, oldest first.
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
Problems	200	Success

Throws

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

Code example

import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await problemsClient.getProblems();

updateComment

problemsClient.updateComment(config): Promise<void>

Updates the specified comment on a problem

Required scope: environment-api:problems:write Required permission: environment:roles:viewer

Parameters

Name	Type	Description
config.body*required	CommentRequestDtoImpl
config.commentId*required	string	The ID of the required comment.
config.problemId*required	string	The ID of the required problem.

Returns

Return type	Status code	Description
void	204	Success. The comment has been updated.

Throws

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

Code example

import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await problemsClient.updateComment({
  problemId: "...",
  commentId: "...",
  body: { message: "..." },
});

releasesClient

import { releasesClient } from '@dynatrace-sdk/client-classic-environment-v2';

getReleases

releasesClient.getReleases(config): Promise<Releases>

Returns all releases

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

Parameters

Name	Type	Description
config.demo	boolean	Get your Releases (false) or a set of demo Releases (true).
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of two weeks is used (now-2w).
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of Releases in a single response payload. The maximal allowed page size is 1000. If not set, 100 is used.
config.releasesSelector	string	Defines the scope of the query. Only Releases matching the provided criteria are included in the response. You can add one or several of the criteria listed below. Management zone: type(PROCESS_GROUP_INSTANCE),mzName("ManagementZone-A"). Filters for all releases in the given management zone. The filter is case-sensitive. Monitoring state: monitoringState("Active") or monitoringState("Inactive"). You can specify only one monitoring state. Health state: healthState("HEALTHY") or healthState("UNHEALTHY"). You can specify only one health state. Security vulnerability: affectedBySecurityProblem("Detected") or affectedBySecurityProblem("Not detected"). You can specify only one security vulnerability state. Name: entityName("name"). Filters for all releases that contain the given value in their name. The filter is case-insensitive. Entity ID: entityId("id"). Product: releasesProduct("product"). Filters for all releases that contain the given value in their product. The filter is case-insensitive. Stage: releasesStage("stage"). Filters for all releases that contain the given value in their stage. The filter is case-insensitive. Version: releasesVersion("version"). Filters for all releases that contain the given value in their version. The filter is case-insensitive. To set several criteria, separate them with comma (,). Only results matching all criteria are included in the response. e.g., .../api/v2/releases?releasesSelector=name("Server"),monitoringState("Active"),healthState("HEALTHY"),releasesVersion("1.0.7"). The special characters ~ and " need to be escaped using a ~ (e.g. double quote search entityName("~"").
config.sort	string	Specifies the field that is used for sorting the releases list. The field has a sign prefix (+/-) which corresponds to the sorting order ('+' for ascending and '-' for descending). If no sign prefix is set, then the default ascending sorting order will be applied. You can sort by the following properties: 'product': Product name 'name': Release name 'stage': Stage name 'version': Version 'instances': Instances 'traffic': Traffic If not set, the ascending order sorting for name is applied.
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
Releases	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { releasesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await releasesClient.getReleases();

securityProblemsClient

import { securityProblemsClient } from '@dynatrace-sdk/client-classic-environment-v2';

bulkMuteRemediationItems

securityProblemsClient.bulkMuteRemediationItems(config): Promise<RemediationItemsBulkMuteResponse>

Mutes several remediation items

Required scope: environment-api:security-problems:write Required permission: environment:roles:manage-security-problems

Parameters

Name	Type	Description
config.body*required	RemediationItemsBulkMute
config.id*required	string	The ID of the requested third-party security problem.

Returns

Return type	Status code	Description
RemediationItemsBulkMuteResponse	200	Success. The remediation item(s) have been muted.

Throws

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

Code example

import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await securityProblemsClient.bulkMuteRemediationItems({
    id: "...",
    body: {
      reason: "CONFIGURATION_NOT_AFFECTED",
      remediationItemIds: ["..."],
    },
  });

bulkMuteSecurityProblems

securityProblemsClient.bulkMuteSecurityProblems(config): Promise<SecurityProblemsBulkMuteResponse>

Mutes several security problems

Required scope: environment-api:security-problems:write Required permission: environment:roles:manage-security-problems

Parameters

Name	Type
config.body*required	SecurityProblemsBulkMute

Returns

Return type	Status code	Description
SecurityProblemsBulkMuteResponse	200	Success. The security problem(s) have been muted.

Throws

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

Code example

import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await securityProblemsClient.bulkMuteSecurityProblems({
    body: {
      reason: "CONFIGURATION_NOT_AFFECTED",
      securityProblemIds: ["..."],
    },
  });

bulkUnmuteRemediationItems

securityProblemsClient.bulkUnmuteRemediationItems(config): Promise<RemediationItemsBulkUnmuteResponse>

Un-mutes several remediation items

Required scope: environment-api:security-problems:write Required permission: environment:roles:manage-security-problems

Parameters

Name	Type	Description
config.body*required	RemediationItemsBulkUnmute
config.id*required	string	The ID of the requested third-party security problem.

Returns

Return type	Status code	Description
RemediationItemsBulkUnmuteResponse	200	Success. The remediation item(s) have been un-muted.

Throws

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

Code example

import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await securityProblemsClient.bulkUnmuteRemediationItems({
    id: "...",
    body: {
      reason: "AFFECTED",
      remediationItemIds: ["..."],
    },
  });

bulkUnmuteSecurityProblems

securityProblemsClient.bulkUnmuteSecurityProblems(config): Promise<SecurityProblemsBulkUnmuteResponse>

Un-mutes several security problems

Required scope: environment-api:security-problems:write Required permission: environment:roles:manage-security-problems

Parameters

Name	Type
config.body*required	SecurityProblemsBulkUnmute

Returns

Return type	Status code	Description
SecurityProblemsBulkUnmuteResponse	200	Success. The security problem(s) have been un-muted.

Throws

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

Code example

import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await securityProblemsClient.bulkUnmuteSecurityProblems({
    body: {
      reason: "AFFECTED",
      securityProblemIds: ["..."],
    },
  });

getEventsForSecurityProblem

securityProblemsClient.getEventsForSecurityProblem(config): Promise<SecurityProblemEventsList>

Lists all events of a security problem

Required scope: environment-api:security-problems:read One of the following permissions is required:

• environment:roles:manage-security-problems
• environment:roles:view-security-problems

Parameters

Name	Type	Description
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of thirty days is used (now-30d).
config.id*required	string	The ID of the requested security problem.
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
SecurityProblemEventsList	200	Success. The response contains the list of security problem events.

Throws

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

Code example

import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await securityProblemsClient.getEventsForSecurityProblem({
    id: "...",
  });

getRemediationItem

securityProblemsClient.getRemediationItem(config): Promise<RemediationDetailsItem>

Gets parameters of a remediation item of a security problem

Required scope: environment-api:security-problems:read One of the following permissions is required:

• environment:roles:manage-security-problems
• environment:roles:view-security-problems

Parameters

Name	Type	Description
config.id*required	string	The ID of the requested third-party security problem.
config.remediationItemId*required	string	The ID of the remediation item.

Returns

Return type	Status code	Description
RemediationDetailsItem	200	Success. The response contains details of a single remediation item of a security problem.

Throws

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

Code example

import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await securityProblemsClient.getRemediationItem({
    id: "...",
    remediationItemId: "...",
  });

getRemediationItems

securityProblemsClient.getRemediationItems(config): Promise<RemediationItemList>

Lists remediation items of a third-party security problem

Required scope: environment-api:security-problems:read One of the following permissions is required:

• environment:roles:manage-security-problems
• environment:roles:view-security-problems

Parameters

Name	Type	Description
config.id*required	string	The ID of the requested third-party security problem.
config.remediationItemSelector	string	Defines the scope of the query. Only remediable entities matching the specified criteria are included in the response. You can add one or more of the following criteria. Values are not case-sensitive and the EQUALS operator is used unless otherwise specified. Vulnerability state: vulnerabilityState("value"). Possible values are VULNERABLE, and RESOLVED. If not set, all entities are returned. Muted: muted("value"). Possible values are TRUE or FALSE. Reachable data asset assessment: assessment.dataAssets("value") Possible values are REACHABLE, and NOT_DETECTED. Network exposure assessment: assessment.exposure("value") Possible values are PUBLIC_NETWORK, and NOT_DETECTED. Vulnerable function usage assessment: assessment.vulnerableFunctionUsage("value") Possible values are IN_USE, and NOT_IN_USE. Vulnerable function restart required: assessment.vulnerableFunctionRestartRequired("value") Possible values are TRUE or FALSE. Vulnerable function in use contains: assessment.vulnerableFunctionInUseContains("value"). Possible values are class::function, class:: and function. The CONTAINS operator is used. Only vulnerable functions in use are considered. Assessment accuracy: assessment.accuracy("value") Possible values are FULL and REDUCED. Entity name contains: entityNameContains("value-1"). The CONTAINS operator is used. Tracking link display name: trackingLink.displayNameContains("value"). The CONTAINS operator is used. To set several criteria, separate them with a comma (,). Only results matching all criteria are included in the response. Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (~) inside quotes: Tilde ~ Quote "

Returns

Return type	Status code	Description
RemediationItemList	200	Success. The response contains the list of remediation items of a problem.

Throws

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

Code example

import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await securityProblemsClient.getRemediationItems({
    id: "...",
  });

getRemediationProgressEntities

securityProblemsClient.getRemediationProgressEntities(config): Promise<RemediationProgressEntityList>

Lists remediation progress entities

Required scope: environment-api:security-problems:read One of the following permissions is required:

• environment:roles:manage-security-problems
• environment:roles:view-security-problems

Parameters

Name	Type	Description
config.id*required	string	The ID of the requested third-party security problem.
config.remediationItemId*required	string	The ID of the remediation item.
config.remediationProgressEntitySelector	string	Defines the scope of the query. Only remediation progress entities matching the specified criteria are included in the response. You can add one or more of the following criteria. Values are not case-sensitive and the EQUALS operator is used unless otherwise specified. State: state("value"). Possible values the state field are AFFECTED and UNAFFECTED. If not set, all entities are returned. Vulnerable function usage assessment: assessment.vulnerableFunctionUsage("value") Possible values are IN_USE, and NOT_IN_USE. Vulnerable function restart required: assessment.vulnerableFunctionRestartRequired("value") Possible values are TRUE or FALSE. Vulnerable function in use contains: assessment.vulnerableFunctionInUseContains("value"). Possible values are class::function, class:: and function. The CONTAINS operator is used. Only vulnerable functions in use are considered. Entity name contains: entityNameContains("value-1"). The CONTAINS operator is used. To set several criteria, separate them with a comma (,). Only results matching all criteria are included in the response. Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (~) inside quotes: Tilde ~ Quote "

Returns

Return type	Status code	Description
RemediationProgressEntityList	200	Success. The response contains a list of remediation progress entities of a remediation item of a security problem. The number of entities returned is limited.

Throws

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

Code example

import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await securityProblemsClient.getRemediationProgressEntities(
    { id: "...", remediationItemId: "..." },
  );

getSecurityProblem

securityProblemsClient.getSecurityProblem(config): Promise<SecurityProblemDetails>

Gets parameters of a security problem

Required scope: environment-api:security-problems:read One of the following permissions is required:

• environment:roles:manage-security-problems
• environment:roles:view-security-problems

Parameters

Name	Type	Description
config.fields	string	A list of additional security problem properties you can add to the response. The following properties are available (all other properties are always included and you can't remove them from the response): riskAssessment: A risk assessment of the security problem. managementZones: The management zone where the security problem occurred. codeLevelVulnerabilityDetails: Details of the code-level vulnerability. globalCounts: Globally calculated statistics about the security problem. No management zone information is taken into account. filteredCounts: Statistics about the security problem, filtered by the management zone and timeframe start ('from') query parameters. description: The description of the vulnerability. remediationDescription: Description of how to remediate the vulnerability. events: The security problem's last 10 events within the last 365 days, sorted from newest to oldest. vulnerableComponents: A list of vulnerable components of the security problem within the provided filter range. affectedEntities: A list of affected entities of the security problem within the provided filter range. exposedEntities: A list of exposed entities of the security problem within the provided filter range. reachableDataAssets: A list of data assets reachable by affected entities of the security problem within the provided filter range. relatedEntities: A list of related entities of the security problem within the provided filter range. relatedContainerImages: A list of related container images of the security problem within the provided filter range. relatedAttacks: A list of attacks detected on the exposed security problem. entryPoints: A list of entry points and a flag which indicates whether this list was truncated or not. To add properties, specify them in a comma-separated list and prefix each property with a plus (for example, +riskAssessment,+managementZones).
config.from	string	Based on the timeframe start the affected-, related- and vulnerable entities are being calculated. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the default timeframe start of 24 hours in the past is used (now-24h). The timeframe start must not be older than 365 days.
config.id*required	string	The ID of the requested security problem.
config.managementZoneFilter	string	To specify management zones, use one of the options listed below. For each option you can specify multiple comma-separated values. If several values are specified, the OR logic applies. All values are case-sensitive and must be quoted. Management zone ID: ids("mzId-1", "mzId-2"). Management zone names: names("mz-1", "mz-2"). You can specify several comma-separated criteria (for example, names("myMz"),ids("9130632296508575249")).

Returns

Return type	Status code	Description
SecurityProblemDetails	200	Success. The response contains parameters of the security problem.

Throws

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

Code example

import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await securityProblemsClient.getSecurityProblem({
    id: "...",
  });

getSecurityProblems

securityProblemsClient.getSecurityProblems(config): Promise<SecurityProblemList>

Lists all security problems

Required scope: environment-api:security-problems:read One of the following permissions is required:

• environment:roles:manage-security-problems
• environment:roles:view-security-problems

Parameters

Name	Type	Description
config.fields	string	A list of additional security problem properties you can add to the response. The following properties are available (all other properties are always included and you can't remove them from the response): riskAssessment: A risk assessment of the security problem. managementZones: The management zone where the security problem occurred. codeLevelVulnerabilityDetails: Details of the code-level vulnerability. globalCounts: Globally calculated statistics about the security problem. No management zone information is taken into account. To add properties, specify them in a comma-separated list and prefix each property with a plus (for example, +riskAssessment,+managementZones).
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of thirty days is used (now-30d).
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of security problems in a single response payload. The maximal allowed page size is 500. If not set, 100 is used.
config.securityProblemSelector	string	Defines the scope of the query. Only security problems matching the specified criteria are included in the response. You can add one or more of the following criteria. Values are not case-sensitive and the EQUALS operator is used unless otherwise specified. Status: status("value"). Find the possible values in the description of the status field of the response. If not set, all security problems are returned. Muted: muted("value"). Possible values are TRUE or FALSE. Risk level: riskLevel("value"). The Davis risk level. Find the possible values in the description of the riskLevel field of the response. Minimum risk score: minRiskScore("5.5"). The Davis minimum risk score. The GREATER THAN OR EQUAL TO operator is used. Specify a number between 1.0 and 10.0. Maximum risk score: maxRiskScore("5.5"). The Davis maximum risk score. The LESS THAN operator is used. Specify a number between 1.0 and 10.0. Base risk level: baseRiskLevel("value"). The Base risk level from the CVSS. Find the possible values in the description of the riskLevel field of the response. Minimum base risk score: minBaseRiskScore("5.5"). The minimum base risk score from the CVSS. The GREATER THAN OR EQUAL TO operator is used. Specify a number between 1.0 and 10.0. Maximum base risk score: maxBaseRiskScore("5.5"). The maximum base risk score from the CVSS. The LESS THAN operator is used. Specify a number between 1.0 and 10.0. External vulnerability ID contains: externalVulnerabilityIdContains("id-1"). The CONTAINS operator is used. Maximum value length is 48 characters. External vulnerability ID: externalVulnerabilityId("id-1", "id-2"). CVE ID: cveId("id"). Risk assessment riskAssessment("value-1", "value-2") Possible values are EXPOSED, SENSITIVE, EXPLOIT, VULNERABLE_FUNCTION_IN_USE and ACCURACY_REDUCED. Related host ID: relatedHostIds("value-1", "value-2"). Specify Dynatrace entity IDs here. Related host name: relatedHostNames("value-1", "value-2"). Values are case-sensitive. Related host name contains: relatedHostNameContains("value-1"). The CONTAINS operator is used. Related Kubernetes cluster ID: relatedKubernetesClusterIds("value-1", "value-2"). Specify Dynatrace entity IDs here. Related Kubernetes cluster name: relatedKubernetesClusterNames("value-1", "value-2"). Values are case-sensitive. Related Kubernetes cluster name contains: relatedKubernetesClusterNameContains("value-1"). The CONTAINS operator is used. Related Kubernetes workload ID: relatedKubernetesWorkloadIds("value-1", "value-2"). Specify Dynatrace entity IDs here. Related Kubernetes workload name: relatedKubernetesWorkloadNames("value-1", "value-2"). Values are case-sensitive. Related Kubernetes workload name contains: relatedKubernetesWorkloadNameContains("value-1"). The CONTAINS operator is used. Management zone ID: managementZoneIds("mzId-1", "mzId-2"). Management zone name: managementZones("name-1", "name-2"). Values are case-sensitive. Affected process group instance ID: affectedPgiIds("pgiId-1", "pgiId-2"). Specify Dynatrace entity IDs here. Affected process group ID: affectedPgIds("pgId-1", "pgId-2"). Specify Dynatrace entity IDs here. Affected process group name: affectedPgNames("name-1", "name-2"). Values are case-sensitive. Affected process group name contains: affectedPgNameContains("name-1"). The CONTAINS operator is used. Vulnerable component ID: vulnerableComponentIds("componentId-1", "componentId-2"). Specify component IDs here. Vulnerable component name: vulnerableComponentNames("name-1", "name-2"). Values are case-sensitive. Vulnerable component name contains: vulnerableComponentNameContains("name-1"). The CONTAINS operator is used. Host tags: hostTags("hostTag-1"). The CONTAINS operator is used. Maximum value length is 48 characters. Process group tags: pgTags("pgTag-1"). The CONTAINS operator is used. Maximum value length is 48 characters. Process group instance tags: pgiTags("pgiTag-1"). The CONTAINS operator is used. Maximum value length is 48 characters. Tags: tags("tag-1"). The CONTAINS operator is used. This selector picks hosts, process groups, and process group instances at the same time. Maximum value length is 48 characters. Display ID: displayIds("S-1234", "S-5678"). The EQUALS operator is used. Security problem ID: securityProblemIds("12544152654387159360", "5904857564184044850"). The EQUALS operator is used. Technology: technology("technology-1", "technology-2"). Find the possible values in the description of the technology field of the response. The EQUALS operator is used. Vulnerability type: vulnerabilityType("type-1", "type-2"). Possible values are THIRD_PARTY, CODE_LEVEL, RUNTIME. Risk score and risk category are mutually exclusive (cannot be used at the same time). To set several criteria, separate them with a comma (,). Only results matching all criteria are included in the response. Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (~) inside quotes: Tilde ~ Quote "
config.sort	string	Specifies one or more fields for sorting the security problem list. Multiple fields can be concatenated using a comma (,) as a separator (e.g. +status,-timestamp). You can sort by the following properties with a sign prefix for the sorting order. status: The security problem status (+ open first or - resolved first) muted: The security problem mute state (+ unmuted first or - muted first) technology: The security problem technology firstSeenTimestamp: The timestamp of the first occurrence of the security problem (+ new problems first or - old problems first) lastUpdatedTimestamp: The timestamp of the last update of the security problem (+ recently updated problems first or - earlier updated problems first) securityProblemId: The auto-generated ID of the security problem (+ lower number first or - higher number first) externalVulnerabilityId: The ID of the external vulnerability (+ lower number first or - higher number first) displayId: The display ID (+ lower number first or - higher number first) riskAssessment.riskScore: Davis Security Score (+ lower score first or - higher score first) riskAssessment.riskLevel: Davis Security Score level (+ lower level first or - higher level first) riskAssessment.exposure: Whether the problem is exposed to the internet riskAssessment.baseRiskScore: The CVSS score (+ lower score first or - higher score first) riskAssessment.baseRiskLevel: The CVSS level (+ lower level first or - higher level first) riskAssessment.dataAssets: Whether data assets are affected riskAssessment.vulnerableFunctionUsage: Whether vulnerable functions are used riskAssessment.assessmentAccuracy: The assessments accuracy (+ less accuracy first or - more accuracy first) globalCounts.affectedNodes: Number of affected nodes (+ lower number first or - higher number first) globalCounts.affectedProcessGroupInstances: Number of affected process group instances (+ lower number first or - higher number first) globalCounts.affectedProcessGroups: Number of affected process groups (+ lower number first or - higher number first) globalCounts.exposedProcessGroups: Number of exposed process groups (+ lower number first or - higher number first) globalCounts.reachableDataAssets: Number of reachable data assets (+ lower number first or - higher number first) globalCounts.relatedApplications: Number of related applications (+ lower number first or - higher number first) globalCounts.relatedAttacks: Number of attacks on the security problem (+ lower number first or - higher number first) globalCounts.relatedHosts: Number of related hosts (+ lower number first or - higher number first) globalCounts.relatedKubernetesClusters: Number of related Kubernetes cluster (+ lower number first or - higher number first) globalCounts.relatedKubernetesWorkloads: Number of related Kubernetes workloads (+ lower number first or - higher number first) globalCounts.relatedServices: Number of related services (+ lower number first or - higher number first) globalCounts.vulnerableComponents: Number of vulnerable components (+ lower number first or - higher number first) If no prefix is set, + is used.
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used. The end of the timeframe must not be older than 365 days.

Returns

Return type	Status code	Description
SecurityProblemList	200	Success. The response contains the list of security problems.

Throws

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

Code example

import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await securityProblemsClient.getSecurityProblems();

getVulnerableFunctions

securityProblemsClient.getVulnerableFunctions(config): Promise<VulnerableFunctionsContainer>

Lists all vulnerable functions and their usage for a third-party security problem

Required scope: environment-api:security-problems:read One of the following permissions is required:

• environment:roles:manage-security-problems
• environment:roles:view-security-problems

Parameters

Name	Type	Description
config.groupBy	string	Defines additional grouping types in which vulnerable functions should be displayed. You can add one of the following grouping types. Process group: PROCESS_GROUP
config.id*required	string	The ID of the requested third-party security problem.
config.vulnerableFunctionsSelector	string	Defines the scope of the query. Only vulnerable functions matching the specified criteria are included in the response. You can add the following criteria. Values are not case sensitive and the EQUALS operator is used unless otherwise specified. Management zone ID: managementZoneIds("mzId-1", "mzId-2"). Management zone name: managementZones("name-1", "name-2"). Values are case sensitive. Process group ID: processGroupIds("pgId-1", "pgId-2"). Specify Dynatrace entity IDs here. Process group name: processGroupNames("name-1", "name-2"). Values are case sensitive. Process group name contains: processGroupNameContains("name-1"). The CONTAINS operator is used. Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (~) inside quotes: Tilde ~ Quote "

Returns

Return type	Status code	Description
VulnerableFunctionsContainer	200	Success. The response contains the list of vulnerable functions.

Throws

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

Code example

import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await securityProblemsClient.getVulnerableFunctions({
    id: "...",
  });

muteSecurityProblem

securityProblemsClient.muteSecurityProblem(config): Promise<void>

Mutes a security problem

Required scope: environment-api:security-problems:write Required permission: environment:roles:manage-security-problems

Parameters

Name	Type	Description
config.body*required	SecurityProblemMute
config.id*required	string	The ID of the requested security problem.

Returns

Return type	Status code	Description
void	200	Success. The security problem has been muted.
void	204	Not executed. The security problem is already muted.

Throws

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

Code example

import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await securityProblemsClient.muteSecurityProblem({
    id: "...",
    body: { reason: "CONFIGURATION_NOT_AFFECTED" },
  });

setRemediationItemMuteState

securityProblemsClient.setRemediationItemMuteState(config): Promise<void>

Sets the mute state of a remediation item

Required scope: environment-api:security-problems:write Required permission: environment:roles:manage-security-problems

Parameters

Name	Type	Description
config.body*required	RemediationItemMuteStateChange
config.id*required	string	The ID of the requested third-party security problem.
config.remediationItemId*required	string	The ID of the remediation item.

Returns

Return type	Status code	Description
void	200	Success. The requested mute state has been applied to the remediation item.
void	204	Not executed. The remediation item was previously put into the requested mute state by the same user with the same reason and comment.

Throws

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

Code example

import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await securityProblemsClient.setRemediationItemMuteState({
    id: "...",
    remediationItemId: "...",
    body: {
      comment: "...",
      muted: false,
      reason: "IGNORE",
    },
  });

trackingLinkBulkUpdateAndDelete

securityProblemsClient.trackingLinkBulkUpdateAndDelete(config): Promise<void>

Updates the external tracking links of the remediation items. | maturity=EARLY_ADOPTER

Required scope: environment-api:security-problems:write Required permission: environment:roles:manage-security-problems

Parameters

Name	Type	Description
config.body*required	RemediationItemsBulkUpdateDeleteDto
config.id*required	string	The ID of the requested third-party security problem.

Returns

Return type	Status code	Description
void	204	Success. The requested tracking links have been updated.

Throws

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

Code example

import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await securityProblemsClient.trackingLinkBulkUpdateAndDelete(
    { id: "...", body: {} },
  );

unmuteSecurityProblem

securityProblemsClient.unmuteSecurityProblem(config): Promise<void>

Un-mutes a security problem

Required scope: environment-api:security-problems:write Required permission: environment:roles:manage-security-problems

Parameters

Name	Type	Description
config.body*required	SecurityProblemUnmute
config.id*required	string	The ID of the requested security problem.

Returns

Return type	Status code	Description
void	200	Success. The security problem has been un-muted.
void	204	Not executed. The security problem is already un-muted.

Throws

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

Code example

import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await securityProblemsClient.unmuteSecurityProblem({
    id: "...",
    body: { reason: "AFFECTED" },
  });

serviceLevelObjectivesClient

import { serviceLevelObjectivesClient } from '@dynatrace-sdk/client-classic-environment-v2';

createAlert

serviceLevelObjectivesClient.createAlert(config): Promise<EntityShortRepresentation>

Creates an alert of the provided alert type for an SLO

Required scope: environment-api:slo:write One of the following permissions is required:

• environment:roles:manage-settings
• settings:objects:write

Parameters

Name	Type	Description
config.body*required	AbstractSloAlertDto
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of two weeks is used (now-2w).
config.id*required	string	The ID of the required SLO.
config.timeFrame	"CURRENT" | "GTF"	The timeframe to calculate the SLO values: CURRENT: SLO's own timeframe. GTF: timeframe specified by from and to parameters. If not set, the CURRENT value is used.
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
EntityShortRepresentation	201	Success. The new alert has been created. The response contains the parameters of the new alert. The location response header contains the ID of the new alert.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Failed. The requested resource doesn't exist. | Precondition for creating an SLO alert not fulfilled. The SLO func metric cannot be created or is not created by the SLO. | Internal server error. | Client side error. | Server side error.

Code example

import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await serviceLevelObjectivesClient.createAlert(
  {
    id: "...",
    body: {
      alertName: "...",
      alertThreshold: 10,
      alertType: "BURN_RATE",
    },
  },
);

createSlo

serviceLevelObjectivesClient.createSlo(config): Promise<void>

Creates a new SLO

Required scope: environment-api:slo:write One of the following permissions is required:

• environment:roles:manage-settings
• settings:objects:write

Parameters

Name	Type
config.body*required	SloConfigItemDtoImpl

Returns

Return type	Status code	Description
void	201	Success. The new SLO has been created. Response doesn't have a body. The location response header contains the ID of the new SLO.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Failed. Conflicting resource. | Internal server error. | Client side error. | Server side error.

Code example

import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await serviceLevelObjectivesClient.createSlo({
  body: {
    evaluationType: "AGGREGATE",
    name: "Payment service availability",
    target: 95,
    timeframe: "-1d",
    warning: 97.5,
  },
});

deleteSlo

serviceLevelObjectivesClient.deleteSlo(config): Promise<void>

Deletes an SLO

Required scope: environment-api:slo:write One of the following permissions is required:

• environment:roles:manage-settings
• settings:objects:write

Parameters

Name	Type
config.id*required	string

Returns

Return type	Status code	Description
void	204	Success. The SLO has been deleted. Response doesn't have a body.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The requested resource doesn't exist. | Failed. Conflicting resource. | Internal server error. | Client side error. | Server side error.

Code example

import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await serviceLevelObjectivesClient.deleteSlo({
  id: "...",
});

getSlo

serviceLevelObjectivesClient.getSlo(config): Promise<SLOs>

Lists all available SLOs along with calculated values

Required scope: environment-api:slo:read One of the following permissions is required:

• environment:roles:viewer
• settings:objects:read

By default the values are calculated for the SLO's own timeframe. You can use a custom timeframe:

1. Set the timeFrame parameter to GTF.
2. Provide the timeframe in from and to parameters.

Parameters

Name	Type	Description
config.demo	boolean	Get your SLOs (false) or a set of demo SLOs (true).
config.enabledSlos	"false" | "true" | "all"	Get your enabled SLOs (true), disabled ones (false) or both enabled and disabled ones (all).
config.evaluate	"false" | "true"	Get your SLOs without them being evaluated (false) or with evaluations (true) with maximum pageSize of 25.
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of two weeks is used (now-2w).
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of SLOs in a single response payload. The maximal allowed page size is 10000. If not set, 10 is used.
config.showGlobalSlos	boolean	Get your global SLOs (true) regardless of the selected filter or filter them out (false).
config.sloSelector	string	The scope of the query. Only SLOs matching the provided criteria are included in the response. You can add one or several of the criteria listed below. SLO ID: id("id-1","id-2"). Name: name("name"). Filters for an SLO with the given name. The filter is case-sensitive. Health state: healthState("HEALTHY") or healthState("UNHEALTHY"). Filters for SLOs that have no related open problems (HEALTHY) or SLOs that have related open problems (UNHEALTHY). You can specify only one health state. Text: text("value"). Filters for all SLOs that contain the given value in their name or description. The filter is case-insensitive. Problem: problemDisplayName("value"). Filters for all SLOs that are related to a given problem display name (e.g. P-12345). Management zone name: managementZone("MZ-A"). Filters for all SLOs that are related to the given management zone name. Returned SLOs are evaluated against the given management zone. Management zone ID: managementZoneID("123"). Filters for all SLOs that are related to the given management zone ID. Returned SLOs are evaluated against the given management zone. To set several criteria, separate them with comma (,). Only SLOs matching all criteria are included in the response. Examples: .../api/v2/slo?sloSelector=name("Service Availability") .../api/v2/slo?sloSelector=id("id") .../api/v2/slo?sloSelector=text("Description"),healthState("HEALTHY"). The special characters ~ and " need to be escaped using a ~ (e.g. double quote search text("~"")).
config.sort	string	The sorting of SLO entries: name: Names in ascending order. -name: Names in descending order. If not set, the ascending order is used.
config.timeFrame	"CURRENT" | "GTF"	The timeframe to calculate the SLO values: CURRENT: SLO's own timeframe. GTF: timeframe specified by from and to parameters. If not set, the CURRENT value is used.
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
SLOs	200	Success. The response contains the parameters and calculated values of the requested SLO.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await serviceLevelObjectivesClient.getSlo();

getSloById

serviceLevelObjectivesClient.getSloById(config): Promise<SLO>

Gets parameters and calculated values of a specific SLO

Required scope: environment-api:slo:read One of the following permissions is required:

• environment:roles:viewer
• settings:objects:read

If from and to parameters are provided, the SLO is calculated for that timeframe; otherwise the SLO's own timeframe is used.

Parameters

Name	Type	Description
config.from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the relative timeframe of two weeks is used (now-2w).
config.id*required	string	The ID of the required SLO.
config.timeFrame	"CURRENT" | "GTF"	The timeframe to calculate the SLO values: CURRENT: SLO's own timeframe. GTF: timeframe specified by from and to parameters. If not set, the CURRENT value is used.
config.to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.

Returns

Return type	Status code	Description
SLO	200	Success. The response contains the parameters and calculated values of the requested SLO.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Failed. The requested resource doesn't exist. | Client side error. | Server side error.

Code example

import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await serviceLevelObjectivesClient.getSloById({
  id: "...",
});

updateSloById

serviceLevelObjectivesClient.updateSloById(config): Promise<void>

Updates an existing SLO

Required scope: environment-api:slo:write One of the following permissions is required:

• environment:roles:manage-settings
• settings:objects:write

Parameters

Name	Type	Description
config.body*required	SloConfigItemDtoImpl
config.id*required	string	The ID of the required SLO.

Returns

Return type	Status code	Description
void	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Internal server error. | Client side error. | Server side error.

Code example

import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await serviceLevelObjectivesClient.updateSloById({
    id: "...",
    body: {
      evaluationType: "AGGREGATE",
      name: "Payment service availability",
      target: 95,
      timeframe: "-1d",
      warning: 97.5,
    },
  });

settingsManagementZonesClient

import { settingsManagementZonesClient } from '@dynatrace-sdk/client-classic-environment-v2';

getManagementZoneDetails

settingsManagementZonesClient.getManagementZoneDetails(config): Promise<ManagementZoneDetails>

Reads management zone details.

Required scope: settings:objects:read One of the following permissions is required:

• environment:roles:manage-settings
• settings:objects:read

Allows to convert from an objectId to the ID of the management zone, and can serve as a replacement for the old config endpoint for that purpose.

Parameters

Name	Type	Description
config.objectId*required	string	The ID of the required settings object.

Returns

Return type	Status code	Description
ManagementZoneDetails	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. Forbidden. | No object available for the given objectId | Client side error. | Server side error.

Code example

import { settingsManagementZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await settingsManagementZonesClient.getManagementZoneDetails(
    { objectId: "..." },
  );

settingsObjectsClient

import { settingsObjectsClient } from '@dynatrace-sdk/client-classic-environment-v2';

addPermission

settingsObjectsClient.addPermission(config): Promise<AccessorPermissions>

Add the permissions for a single accessor on this object.

Required scope: settings:objects:write Required permission: settings:objects:write

Add the permissions for a single accessor on this object, anyone with read/write permissions is allowed to add more permissions.

Parameters

Name	Type	Description
config.adminAccess	boolean	If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
config.body*required	AccessorPermissions
config.objectId*required	string	The ID of the required settings object.

Returns

Return type	Status code	Description
AccessorPermissions	201	Created

Throws

Error Type	Error Message
ErrorEnvelopeError	If accessor id already exists. | Failed. Forbidden. | No object available for the given objectId. | Client side error. | Server side error.

Code example

import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await settingsObjectsClient.addPermission({
  objectId: "...",
  body: { accessor: { type: "user" } },
});

deleteSettingsObjectByObjectId

settingsObjectsClient.deleteSettingsObjectByObjectId(config): Promise<void>

Deletes the specified settings object

Required scope: settings:objects:write One of the following permissions is required:

• environment:roles:manage-settings
• settings:objects:write

Parameters

Name	Type	Description
config.adminAccess	boolean	If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
config.objectId*required	string	The ID of the required settings object.
config.updateToken	string	The update token of the object. You can use it to detect simultaneous modifications by different users. It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update. If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.

Returns

Return type	Status code	Description
void	204	Success. Response doesn't have a body.

Throws

Error Type	Error Message
SettingsObjectResponseError	Failed. Schema validation failed. | Failed. The requested resource doesn't exist. | Failed. Conflicting resource.
ErrorEnvelopeError	Failed. Forbidden. | Client side error. | Server side error.

Code example

import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await settingsObjectsClient.deleteSettingsObjectByObjectId(
    { objectId: "..." },
  );

getEffectiveSettingsValues

settingsObjectsClient.getEffectiveSettingsValues(config): Promise<EffectiveSettingsValuesList>

Lists effective settings values

Required scope: settings:objects:read One of the following permissions is required:

• environment:roles:manage-settings
• settings:objects:read

Lists effective settings values for selected schemas at a selected scope (or entity). This operation evaluates the hierarchy of persisted objects (see /settings/objects)

It will always return a result for a schema/scope combination, even if the schema would not be relevant to the given scope/entity.

If no object along the hierarchy is persisted, the default value as defined in the schema will be returned.

Deprecation notice: The ability to query values of any schema by leaving out the schemaIds parameter in the first-page query is deprecated and will eventually be removed.

Parameters

Name	Type	Description
config.adminAccess	boolean	If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
config.fields	string	A list of fields to be included to the response. The provided set of fields replaces the default set. Specify the required top-level fields, separated by commas (for example, origin,value). Supported fields: summary, searchSummary, created, modified, createdBy, modifiedBy, author, origin, schemaId, schemaVersion, value, externalId.
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of settings objects in a single response payload. The maximal allowed page size is 500. If not set, 100 is used.
config.schemaIds	string	A list of comma-separated schema IDs to which the requested objects belong. Only considered on load of the first page, when the nextPageKey is not set.
config.scope	string	The scope that the requested objects target. The selection only matches objects directly targeting the specified scope. For example, environment will not match objects that target a host within environment. For more details, please see Dynatrace Documentation. To load the first page, when the nextPageKey is not set, this parameter is required.

Returns

Return type	Status code	Description
EffectiveSettingsValuesList	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The specified schema or scope is not found. | Client side error. | Server side error.

Code example

import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await settingsObjectsClient.getEffectiveSettingsValues();

getPermission

settingsObjectsClient.getPermission(config): Promise<AccessorPermissions>

Get current permissions of the accessor on this object.

Required scope: settings:objects:read Required permission: settings:objects:read

Get current permissions of the accessor on this object.

Parameters

Name	Type	Description
config.accessorId*required	string	The user uuid or group uuid of the accessor, depending on the type.
config.accessorType*required	"group" | "user"	The type of the accessor.
config.adminAccess	boolean	If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
config.objectId*required	string	The ID of the required settings object.

Returns

Return type	Status code	Description
AccessorPermissions	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	No object available for the given objectId or the accessor doesn't have any permissions on this object. | Client side error. | Server side error.

Code example

import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await settingsObjectsClient.getPermission({
  objectId: "...",
  accessorType: "group",
  accessorId: "...",
});

getPermissionAllUsers

settingsObjectsClient.getPermissionAllUsers(config): Promise<AccessorPermissions>

Get current permissions of the all-users accessor on this object.

Required scope: settings:objects:read Required permission: settings:objects:read

Get current permissions of the all-users accessor on this object.

Parameters

Name	Type	Description
config.adminAccess	boolean	If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
config.objectId*required	string	The ID of the required settings object.

Returns

Return type	Status code	Description
AccessorPermissions	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	No object available for the given objectId or the all-users accessor doesn't have any permissions on this object. | Client side error. | Server side error.

Code example

import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await settingsObjectsClient.getPermissionAllUsers({
    objectId: "...",
  });

getPermissions

settingsObjectsClient.getPermissions(config): Promise<AccessorPermissionsList>

Get current permissions on this object.

Required scope: settings:objects:read Required permission: settings:objects:read

Get current permissions on this object.

Parameters

Name	Type	Description
config.adminAccess	boolean	If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
config.objectId*required	string	The ID of the required settings object.

Returns

Return type	Status code	Description
AccessorPermissionsList	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	No object available for the given objectId. | Client side error. | Server side error.

Code example

import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await settingsObjectsClient.getPermissions({
  objectId: "...",
});

getSettingsHistory

settingsObjectsClient.getSettingsHistory(config): Promise<RevisionDiffPage>

Gets the history of settings objects

Required scope: settings:objects:read One of the following permissions is required:

• environment:roles:manage-settings
• settings:objects:read

Parameters

Name	Type	Description
config.adminAccess	boolean	If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
config.fields	string	A list of fields to be included to the response.Specify the required top-level fields, separated by commas (for example, revision,modificationInfo). Supported fields: revision, jsonPatch, jsonBefore, jsonAfter, objectId, type, schemaId, schemaVersion, schemaDisplayName, modificationInfo, summary, source, appId.(optional, default to revision, modificationInfo)
config.filter	string	The filter parameter, as explained here. Filtering is supported on the following fields: objectId modificationInfo.lastModifiedTime The fields can only be combined with and as a boolean operator. If this parameter is omitted only revisions of the last 2 weeks are returned. If modificationInfo.lastModifiedTime does not specify a full range, it will be completed with current time minus 1 year for the missing lower bound or the current time for the upper bound. (optional)
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of settings objects in a single response payload. The maximal allowed page size is 500. If not set, 100 is used.
config.schemaId	string	Schema ID to which the requested revisions belong.
config.scope	string	The scope that the requested history objects target. The selection only matches revisions directly targeting the specified scope. For example, environment will not match objects that target a host within environment. For more details, please see Dynatrace Documentation. To load the first page, when the nextPageKey is not set, this parameter is required.
config.sort	string	The sort parameter, as explained here. Sorting is supported on the following fields: modificationInfo.lastModifiedTime (optional, default to -modificationInfo.lastModifiedTime)

Returns

Return type	Status code	Description
RevisionDiffPage	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. Forbidden. | No object available for the given objectId | Client side error. | Server side error.

Code example

import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await settingsObjectsClient.getSettingsHistory();

getSettingsObjectByObjectId

settingsObjectsClient.getSettingsObjectByObjectId(config): Promise<SettingsObjectByObjectIdResponse>

Gets the specified settings object

Required scope: settings:objects:read One of the following permissions is required:

• environment:roles:manage-settings
• settings:objects:read

Parameters

Name	Type	Description
config.adminAccess	boolean	If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
config.objectId*required	string	The ID of the required settings object.

Returns

Return type	Status code	Description
SettingsObjectByObjectIdResponse	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. Forbidden. | No object available for the given objectId | Client side error. | Server side error.

Code example

import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await settingsObjectsClient.getSettingsObjectByObjectId({
    objectId: "...",
  });

getSettingsObjects

settingsObjectsClient.getSettingsObjects(config): Promise<ObjectsList>

Lists persisted settings objects

Required scope: settings:objects:read One of the following permissions is required:

• environment:roles:manage-settings
• settings:objects:read

Lists persisted settings objects for selected schemas at selected scopes (or entities).

If nothing is persisted or if all persisted settings objects are not accessible due to missing permissions, no items will be returned.

Deprecation notice: The ability to query values of any schema by leaving out the schemaIds parameter in the first-page query is deprecated and will eventually be removed.

To query the effective values (including schema defaults) please see /settings/effectiveValues.

Parameters

Name	Type	Description
config.adminAccess	boolean	If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
config.externalIds	string	A list of comma-separated external IDs that the requested objects have. Each external ID has a maximum length of 500 characters. Only considered on load of the first page, when the nextPageKey is not set.
config.fields	string	A list of fields to be included to the response. The provided set of fields replaces the default set. Specify the required top-level fields, separated by commas (for example, objectId,value). Supported fields: objectId, summary, searchSummary, created, modified, createdBy, modifiedBy, author, updateToken, scope, modificationInfo (deprecated), resourceContext, owner, schemaId, schemaVersion, value, externalId.
config.filter	string	The filter parameter, as explained here. Filtering is supported on the following fields: created modified createdBy modifiedBy author (deprecated, will not work for future schemas) value with properties and sub-properties separated by dot (for example, value.owningApp = 'Notebooks') If this parameter is omitted, all settings objects will be returned. The maximum nesting depth (via parentheses) is 5. The maximum expression length is 1024 characters. Note that only fields included to the response via fields can be used for filtering.
config.nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
config.pageSize	number	The amount of settings objects in a single response payload. The maximal allowed page size is 500. If not set, 100 is used.
config.schemaIds	string	A list of comma-separated schema IDs to which the requested objects belong. To load the first page, when the nextPageKey is not set, either this parameter or scopes is required. To load all objects belonging to the given schema IDs leave the scopes parameter empty.
config.scopes	string	A list of comma-separated scopes, that the requested objects target. The selection only matches objects directly targeting the specified scopes. For example, environment will not match objects that target a host within environment. For more details, please see Dynatrace Documentation. To load the first page, when the nextPageKey is not set, either this parameter or schemaIds is required. To load all objects belonging to the given scopes leave the schemaIds parameter empty.
config.sort	string	The sort parameter, as explained here. Sorting is supported on the following fields: created modified createdBy modifiedBy author (deprecated, will not work for future schemas) value with properties and sub-properties separated by dot (for example, value.owningApp) Note that only fields included to the response via fields can be used for sorting.

Returns

Return type	Status code	Description
ObjectsList	200	Success. Accessible objects returned.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. Forbidden. | Failed. The specified schema or scope is not found. | Client side error. | Server side error.

Code example

import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await settingsObjectsClient.getSettingsObjects();

postSettingsObjects

settingsObjectsClient.postSettingsObjects(config): Promise<Array<SettingsObjectResponse>>

Creates a new settings object

Required scope: settings:objects:write One of the following permissions is required:

• environment:roles:manage-settings
• settings:objects:write

You can upload several objects at once. In that case each object returns its own response code. Check the response body for details.

Parameters

Name	Type	Description
config.adminAccess	boolean	If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
config.body*required	Array<SettingsObjectCreate>
config.validateOnly	boolean	If true, the request runs only validation of the submitted settings objects, without saving them.

Returns

Return type	Status code	Description
SettingsObjectResponse	200	Success
SettingsObjectResponse	207	Multi-status: different objects in the payload resulted in different statuses.

Throws

Error Type	Error Message
SettingsObjectResponseArrayError	Failed. Schema validation failed. | Failed. The requested resource doesn't exist. | Failed. Conflicting resource.
ErrorEnvelopeError	Failed. Forbidden. | Client side error. | Server side error.

Code example

import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await settingsObjectsClient.postSettingsObjects({
    body: [
      {
        schemaId:
          "builtin:container.built-in-monitoring-rule",
        scope: "HOST-D3A3C5A146830A79",
        value: {},
      },
    ],
  });

putSettingsObjectByObjectId

settingsObjectsClient.putSettingsObjectByObjectId(config): Promise<SettingsObjectResponse>

Updates an existing settings object

Required scope: settings:objects:write One of the following permissions is required:

• environment:roles:manage-settings
• settings:objects:write

To update a property of the secret type you need to pass the new value unmasked. To keep the current value, send the current masked secret. You can obtain it via GET an object endpoint.

Some schemas don't allow passing of the masked secret. In that case you need to send the unmasked secret with every update of the object.

Parameters

Name	Type	Description
config.adminAccess	boolean	If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
config.body*required	SettingsObjectUpdate
config.objectId*required	string	The ID of the required settings object.
config.validateOnly	boolean	If true, the request runs only validation of the submitted settings object, without saving it.

Returns

Return type	Status code	Description
SettingsObjectResponse	200	Success

Throws

Error Type	Error Message
SettingsObjectResponseError	Failed. Schema validation failed. | Failed. The requested resource doesn't exist. | Failed. Conflicting resource.
ErrorEnvelopeError	Failed. Forbidden. | Client side error. | Server side error.

Code example

import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await settingsObjectsClient.putSettingsObjectByObjectId({
    objectId: "...",
    body: { value: {} },
  });

removePermission

settingsObjectsClient.removePermission(config): Promise<void>

Remove the permissions for an existing accessor on this object.

Required scope: settings:objects:write Required permission: settings:objects:write

Remove the permissions for an existing accessor on this object, anyone with read/write permissions is allowed to delete permissions.

Parameters

Name	Type	Description
config.accessorId*required	string	The user uuid or group uuid of the accessor, depending on the type.
config.accessorType*required	"group" | "user"	The type of the accessor.
config.adminAccess	boolean	If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
config.objectId*required	string	The ID of the required settings object.

Returns

Return type	Status code	Description
void	204	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	No object available for the given objectId or the accessor doesn't have any permissions on this object. | Client side error. | Server side error.

Code example

import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await settingsObjectsClient.removePermission({
  objectId: "...",
  accessorType: "group",
  accessorId: "...",
});

removePermissionAllUsers

settingsObjectsClient.removePermissionAllUsers(config): Promise<void>

Remove the permissions for an existing all-users accessor on this object.

Required scope: settings:objects:write Required permission: settings:objects:write

Remove the permissions for an existing all-users accessor on this object, anyone with read/write permissions is allowed to delete permissions.

Parameters

Name	Type	Description
config.adminAccess	boolean	If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
config.objectId*required	string	The ID of the required settings object.

Returns

Return type	Status code	Description
void	204	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	No object available for the given objectId or the all-users accessor doesn't have any permissions on this object. | Client side error. | Server side error.

Code example

import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await settingsObjectsClient.removePermissionAllUsers({
    objectId: "...",
  });

resolveEffectivePermissions

settingsObjectsClient.resolveEffectivePermissions(config): Promise<Array<EffectivePermission>>

Get the effective settings permissions of the calling user in the environment

One of the following scopes is required:

• settings:objects:write
• settings:objects:read
• settings:schemas:read

One of the following permissions is required:

• environment:roles:viewer
• settings:schemas:read

Parameters

Name	Type
config.body*required	ResolutionRequest

Returns

Return type	Status code	Description
EffectivePermission	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. Forbidden. No access to any settings. | Client side error. | Server side error.

Code example

import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await settingsObjectsClient.resolveEffectivePermissions({
    body: {
      permissions: [
        {
          context: {
            schemaId: "service:schema",
            scope: "environment",
          },
          permission: "settings:objects:write",
        },
      ],
    },
  });

transferOwnership

settingsObjectsClient.transferOwnership(config): Promise<void>

Transfer ownership of the object.

Required scope: settings:objects:write Required permission: settings:objects:write

Transfer ownership of the object, only the owner or the main admin is allowed to transfer the ownership (IAM permission needed).

Parameters

Name	Type	Description
config.adminAccess	boolean	If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
config.body*required	TransferOwnershipRequest
config.objectId*required	string	The ID of the required settings object.

Returns

Return type	Status code	Description
void	204	Success. Response doesn't have a body.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Failed. Forbidden. | No object available for the given objectId. | Client side error. | Server side error.

Code example

import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await settingsObjectsClient.transferOwnership({
  objectId: "...",
  body: { newOwner: { type: "user" } },
});

updatePermission

settingsObjectsClient.updatePermission(config): Promise<void>

Update the permissions for an existing accessor on this object.

Required scope: settings:objects:write Required permission: settings:objects:write

Update the permissions for an existing accessor on this object, anyone with read/write permissions is allowed to update permissions.

Parameters

Name	Type	Description
config.accessorId*required	string	The user uuid or group uuid of the accessor, depending on the type.
config.accessorType*required	"group" | "user"	The type of the accessor.
config.adminAccess	boolean	If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
config.body*required	UpdatePermissionsRequest
config.objectId*required	string	The ID of the required settings object.

Returns

Return type	Status code	Description
void	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	If permission list is empty, contains unsupported entries or unsupported combinations of entries. | No object available for the given objectId or the accessor doesn't have any permissions on this object. | Client side error. | Server side error.

Code example

import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data = await settingsObjectsClient.updatePermission({
  objectId: "...",
  accessorType: "group",
  accessorId: "...",
  body: {},
});

updatePermissionAllUsers

settingsObjectsClient.updatePermissionAllUsers(config): Promise<void>

Update the permissions for an existing all-users accessor on this object.

Required scope: settings:objects:write Required permission: settings:objects:write

Update the permissions for an existing all-users accessor on this object, anyone with read/write permissions is allowed to update permissions.

Parameters

Name	Type	Description
config.adminAccess	boolean	If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
config.body*required	UpdatePermissionsRequest
config.objectId*required	string	The ID of the required settings object.

Returns

Return type	Status code	Description
void	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	If permission list is empty, contains unsupported entries or unsupported combinations of entries. | No object available for the given objectId or the all-users accessor doesn't have any permissions on this object. | Client side error. | Server side error.

Code example

import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await settingsObjectsClient.updatePermissionAllUsers({
    objectId: "...",
    body: {},
  });

settingsSchemasClient

import { settingsSchemasClient } from '@dynatrace-sdk/client-classic-environment-v2';

getAvailableSchemaDefinitions

settingsSchemasClient.getAvailableSchemaDefinitions(config): Promise<SchemaList>

Lists available settings schemas

Required scope: settings:schemas:read One of the following permissions is required:

• environment:roles:manage-settings
• settings:schemas:read

Parameters

Name	Type	Description
config.fields	string	A list of fields to be included to the response. The provided set of fields replaces the default set. Specify the required top-level fields, separated by commas (for example, schemaId,displayName). Supported fields: schemaId, displayName, latestSchemaVersion, multiObject, ordered, ownerBasedAccessControl.

Returns

Return type	Status code	Description
SchemaList	200	Success

Throws

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

Code example

import { settingsSchemasClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await settingsSchemasClient.getAvailableSchemaDefinitions();

getSchemaDefinition

settingsSchemasClient.getSchemaDefinition(config): Promise<SchemaDefinitionRestDto>

Gets parameters of the specified settings schema

Required scope: settings:schemas:read One of the following permissions is required:

• environment:roles:manage-settings
• settings:schemas:read

Parameters

Name	Type	Description
config.schemaId*required	string	The ID of the required schema.
config.schemaVersion	string	The version of the required schema. If not set, the most recent version is returned.

Returns

Return type	Status code	Description
SchemaDefinitionRestDto	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. Forbidden. | Failed. The specified schema doesn't exist. | Client side error. | Server side error.

Code example

import { settingsSchemasClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await settingsSchemasClient.getSchemaDefinition({
    schemaId: "...",
  });

syntheticHttpMonitorExecutionsClient

import { syntheticHttpMonitorExecutionsClient } from '@dynatrace-sdk/client-classic-environment-v2';

getExecutionResult

syntheticHttpMonitorExecutionsClient.getExecutionResult(config): Promise<MonitorExecutionResults>

Gets detailed information about the last execution of the specified HTTP monitor

Required scope: environment-api:synthetic-execution:read Required permission: environment:roles:viewer

Parameters

Name	Type	Description
config.locationId	string	Filters the results to those executed by specified Synthetic location. Specify the ID of the location.
config.monitorId*required	string	Identifier of the HTTP monitor for which last execution result is returned.
config.resultType*required	"SUCCESS" | "FAILED"	Defines the result type of the last HTTP monitor's execution.

Returns

Return type	Status code	Description
MonitorExecutionResults	200	Success. The response contains detailed data.

Throws

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

Code example

import { syntheticHttpMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await syntheticHttpMonitorExecutionsClient.getExecutionResult(
    { monitorId: "...", resultType: "SUCCESS" },
  );

syntheticLocationsNodesAndConfigurationClient

import { syntheticLocationsNodesAndConfigurationClient } from '@dynatrace-sdk/client-classic-environment-v2';

addLocation

syntheticLocationsNodesAndConfigurationClient.addLocation(config): Promise<SyntheticLocationIdsDto>

Creates a new private synthetic location

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

Parameters

Name	Type
config.body*required	PrivateSyntheticLocation

Returns

Return type	Status code	Description
SyntheticLocationIdsDto	201	Success. The private location has been created. The response contains the ID of the new location.

Throws

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

Code example

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

const data =
  await syntheticLocationsNodesAndConfigurationClient.addLocation(
    {
      body: {
        latitude: 10,
        longitude: 10,
        name: "...",
        nodes: ["..."],
        type: "CLUSTER",
      },
    },
  );

getConfiguration

syntheticLocationsNodesAndConfigurationClient.getConfiguration(config): Promise<SyntheticConfigDto>

Gets set of synthetic related parameters defined for whole tenant (affects all monitors and all private locations). | maturity=EARLY_ADOPTER

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

Returns

Return type	Status code	Description
SyntheticConfigDto	200	Success. The response contains synthetic related parameters defined for whole tenant.

Throws

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

Code example

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

const data =
  await syntheticLocationsNodesAndConfigurationClient.getConfiguration();

getLocation

syntheticLocationsNodesAndConfigurationClient.getLocation(config): Promise<PrivateSyntheticLocation | SyntheticLocation>

Gets properties of the specified location

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

Parameters

Name	Type	Description
config.locationId*required	string	The Dynatrace entity ID of the required location.

Returns

Return type	Status code	Description
PrivateSyntheticLocation	200	Success. The response contains parameters of the synthetic location.

Throws

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

Code example

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

const data =
  await syntheticLocationsNodesAndConfigurationClient.getLocation(
    { locationId: "..." },
  );

getLocationDeploymentApplyCommands

syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentApplyCommands(config): Promise<void>

Gets list of commands to deploy synthetic location in Kubernetes/Openshift cluster | maturity=EARLY_ADOPTER

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

Parameters

Name	Type	Description
config.filename	string	Filename
config.namespace	string	Namespace
config.platform	string	Container platform, currently supported are: KUBERNETES and OPENSHIFT. Default value is KUBERNETES.

Returns

Return type	Status code	Description
void	200	Success. The response contains the list of commands that needs to be executed to deploy a synthetic location.

Throws

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

Code example

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

const data =
  await syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentApplyCommands();

getLocationDeploymentDeleteCommands

syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentDeleteCommands(config): Promise<void>

Gets list of commands to delete synthetic location in Kubernetes/Openshift cluster | maturity=EARLY_ADOPTER

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

Parameters

Name	Type	Description
config.filename	string	Filename
config.locationId*required	string	The Dynatrace entity ID of the required location.
config.namespace	string	Namespace
config.platform	string	Container platform, currently supported are: KUBERNETES and OPENSHIFT. Default value is KUBERNETES.

Returns

Return type	Status code	Description
void	200	Success. The response contains the list of commands that needs to be executed to delete a synthetic location.

Throws

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

Code example

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

const data =
  await syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentDeleteCommands(
    { locationId: "..." },
  );

getLocationDeploymentYaml

syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentYaml(config): Promise<void>

Gets yaml file content to deploy location in Kubernetes/Openshift cluster | maturity=EARLY_ADOPTER

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

Parameters

Name	Type	Description
config.activeGateName	string	Active gate name
config.customRegistry	string	Custom images registry prefix - this will replace 'dynatrace' in image URLs in generated yaml.
config.locationId*required	string	The Dynatrace entity ID of the required location.
config.namespace	string	Namespace
config.tagVersionActiveGate	string	Custom version tag for Active Gate - this will be used as desired Active Gate version in generated yaml.
config.tagVersionSynthetic	string	Custom version tag for Synthetic- this will be used as desired Synthetic version in generated yaml

Returns

Return type	Status code	Description
void	200	Success. The response contains the content of deployment yaml file.

Throws

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

Code example

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

const data =
  await syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentYaml(
    { locationId: "..." },
  );

getLocations

syntheticLocationsNodesAndConfigurationClient.getLocations(config): Promise<SyntheticLocations>

Lists all synthetic locations (both public and private) available for your environment

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

Parameters

Name	Type	Description
config.capability	"BROWSER" | "HTTP" | "HTTP_HIGH_RESOURCE" | "ICMP" | "TCP" | "DNS"	Filters the resulting set of locations to those which support specific capability.
config.cloudPlatform	"AWS" | "AZURE" | "ALIBABA" | "GOOGLE_CLOUD" | "OTHER"	Filters the resulting set of locations to those which are hosted on a specific cloud platform.
config.type	"PUBLIC" | "PRIVATE"	Filters the resulting set of locations to those of a specific type.

Returns

Return type	Status code	Description
SyntheticLocations	200	Success

Throws

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

Code example

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

const data =
  await syntheticLocationsNodesAndConfigurationClient.getLocations();

getLocationsStatus

syntheticLocationsNodesAndConfigurationClient.getLocationsStatus(config): Promise<SyntheticPublicLocationsStatus>

Checks the status of public synthetic locations

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

Returns

Return type	Status code	Description
SyntheticPublicLocationsStatus	200	Success. The response contains the public locations status.

Throws

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

Code example

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

const data =
  await syntheticLocationsNodesAndConfigurationClient.getLocationsStatus();

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

Name	Type	Description
config.nodeId*required	string	The ID of the required synthetic node.

Returns

Return type	Status code	Description
Node	200	Success

Throws

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

Code example

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

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

getNodes

syntheticLocationsNodesAndConfigurationClient.getNodes(config): Promise<Nodes>

Lists all synthetic nodes available in your environment

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

Parameters

Name	Type	Description
config.assignedToLocation	"TRUE" | "FALSE"	Filters the resulting set of nodes to those which are assigned to a synthetic location or not.
config.isContainerized	boolean	If set to true, returns only containerized nodes.

Returns

Return type	Status code	Description
Nodes	200	Success

Throws

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

Code example

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

const data =
  await syntheticLocationsNodesAndConfigurationClient.getNodes();

removeLocation

syntheticLocationsNodesAndConfigurationClient.removeLocation(config): Promise<void>

Deletes the specified private synthetic location

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

Parameters

Name	Type	Description
config.locationId*required	string	The Dynatrace entity ID of the private synthetic location to be deleted.

Returns

Return type	Status code	Description
void	204	Success. The location has been deleted. Response doesn't have a body.

Throws

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

Code example

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

const data =
  await syntheticLocationsNodesAndConfigurationClient.removeLocation(
    { locationId: "..." },
  );

updateConfiguration

syntheticLocationsNodesAndConfigurationClient.updateConfiguration(config): Promise<SyntheticConfigDto>

Updates set of synthetic related parameters defined for whole tenant (affects all monitors and all private locations). | maturity=EARLY_ADOPTER

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

Parameters

Name	Type
config.body*required	SyntheticConfigDto

Returns

Return type	Status code	Description
SyntheticConfigDto	204	Success. The set of synthetic related parameters has been updated. Response doesn't have a body.

Throws

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

Code example

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

const data =
  await syntheticLocationsNodesAndConfigurationClient.updateConfiguration(
    { body: { bmMonitorTimeout: 10, bmStepTimeout: 10 } },
  );

updateLocation

syntheticLocationsNodesAndConfigurationClient.updateLocation(config): Promise<void>

Updates the specified synthetic location

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

For public locations you can only change the location status.

Parameters

Name	Type	Description
config.body*required	SyntheticLocationUpdate
config.locationId*required	string	The Dynatrace entity ID of the synthetic location to be updated.

Returns

Return type	Status code	Description
void	204	Success. The location has been updated. Response doesn't have a body.

Throws

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

Code example

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

const data =
  await syntheticLocationsNodesAndConfigurationClient.updateLocation(
    { locationId: "...", body: { type: "PRIVATE" } },
  );

updateLocationsStatus

syntheticLocationsNodesAndConfigurationClient.updateLocationsStatus(config): Promise<void>

Changes the status of public synthetic locations

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

Parameters

Name	Type
config.body*required	SyntheticPublicLocationsStatus

Returns

Return type	Status code	Description
void	204	Success. Locations status has been updated.

Throws

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

Code example

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

const data =
  await syntheticLocationsNodesAndConfigurationClient.updateLocationsStatus(
    { body: { publicLocationsEnabled: false } },
  );

syntheticNetworkAvailabilityMonitorsClient

import { syntheticNetworkAvailabilityMonitorsClient } from '@dynatrace-sdk/client-classic-environment-v2';

createMonitor

syntheticNetworkAvailabilityMonitorsClient.createMonitor(config): Promise<MonitorEntityIdDto>

Creates a synthetic monitor definition. Currently network availability monitors only. | maturity=EARLY_ADOPTER

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

Parameters

Name	Type
config.body*required	SyntheticMultiProtocolMonitorRequest

Returns

Return type	Status code	Description
MonitorEntityIdDto	200	Success

Throws

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

Code example

import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await syntheticNetworkAvailabilityMonitorsClient.createMonitor(
    {},
  );

deleteMonitor

syntheticNetworkAvailabilityMonitorsClient.deleteMonitor(config): Promise<void>

Deletes a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER

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

Parameters

Name	Type	Description
config.monitorId*required	string	The identifier of the monitor.

Returns

Return type	Status code	Description
void	204	Success. Response doesn't have a body.

Throws

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

Code example

import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";

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

getMonitor

syntheticNetworkAvailabilityMonitorsClient.getMonitor(config): Promise<SyntheticMultiProtocolMonitorResponse>

Gets a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER

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

Parameters

Name	Type	Description
config.monitorId*required	string	The identifier of the monitor.

Returns

Return type	Status code	Description
SyntheticMultiProtocolMonitorResponse	200	Success

Throws

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

Code example

import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";

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

getMonitors

syntheticNetworkAvailabilityMonitorsClient.getMonitors(config): Promise<SyntheticMonitorListDto>

Gets all synthetic monitors. Currently network availability monitors only. | maturity=EARLY_ADOPTER

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

Parameters

Name	Type	Description
config.monitorSelector	string	Defines the scope of the query. Only monitors matching the specified criteria are included into response. You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the OR logic applies. Monitor type: type(HTTP,MULTI_PROTOCOL). Possible values: 'HTTP', 'BROWSER', 'THIRD_PARTY', 'MULTI_PROTOCOL' (Note that only 'MULTI_PROTOCOL' is currently supported). Management zone ID: managementZoneId(1, 2). Synthetic Location ME ID: location(SYNTHETIC_LOCATION-123). Monitored host ME ID: monitoredEntity(HOST-123). Monitor tags: tag([context]key:value,key:value,key). Tags in [context]key:value, key:value, and key formats are detected and parsed automatically. If a key-only tag has a colon (:) in it, you must escape the colon with a backslash(\). Otherwise, the tag will be parsed as a key:value tag. All tag values are case-sensitive. Monitor enablement: enabled(true). To set several criteria, separate them with a comma (,). Only results matching all criteria are included in the response.

Returns

Return type	Status code	Description
SyntheticMonitorListDto	200	Success

Throws

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

Code example

import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await syntheticNetworkAvailabilityMonitorsClient.getMonitors();

updateMonitor

syntheticNetworkAvailabilityMonitorsClient.updateMonitor(config): Promise<void>

Updates a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER

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

Parameters

Name	Type	Description
config.body*required	SyntheticMultiProtocolMonitorRequest
config.monitorId*required	string	The identifier of the monitor.

Returns

Return type	Status code	Description
void	204	Success. Response doesn't have a body.

Throws

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

Code example

import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await syntheticNetworkAvailabilityMonitorsClient.updateMonitor(
    { monitorId: "..." },
  );

syntheticOnDemandMonitorExecutionsClient

import { syntheticOnDemandMonitorExecutionsClient } from '@dynatrace-sdk/client-classic-environment-v2';

execute

syntheticOnDemandMonitorExecutionsClient.execute(config): Promise<SyntheticOnDemandExecutionResult>

Triggers on-demand executions for synthetic monitors

Required scope: environment-api:synthetic-execution:write Required permission: environment:roles:viewer

Parameters

Name	Type
config.body*required	SyntheticOnDemandExecutionRequest

Returns

Return type	Status code	Description
SyntheticOnDemandExecutionResult	201	Success. The monitor's execution response details

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Unavailable | Client side error. | Server side error.

Code example

import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await syntheticOnDemandMonitorExecutionsClient.execute({
    body: {},
  });

getBatch

syntheticOnDemandMonitorExecutionsClient.getBatch(config): Promise<SyntheticOnDemandBatchStatus>

Gets summary information and the list of failed executions for the given batch ID

Required scope: environment-api:synthetic-execution:read Required permission: environment:roles:viewer

Parameters

Name	Type	Description
config.batchId*required	number	The batch identifier of the executions.

Returns

Return type	Status code	Description
SyntheticOnDemandBatchStatus	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Batch with the given ID doesn't exist. | Client side error. | Server side error.

Code example

import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await syntheticOnDemandMonitorExecutionsClient.getBatch({
    batchId: 10,
  });

getExecution

syntheticOnDemandMonitorExecutionsClient.getExecution(config): Promise<SyntheticOnDemandExecution>

Gets basic results of the specified on-demand execution

Required scope: environment-api:synthetic-execution:read Required permission: environment:roles:viewer

Parameters

Name	Type	Description
config.executionId*required	number	The identifier of the on-demand execution.

Returns

Return type	Status code	Description
SyntheticOnDemandExecution	200	Success. The response contains basic information about the on-demand execution.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Execution with the given ID doesn't exist. | Client side error. | Server side error.

Code example

import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await syntheticOnDemandMonitorExecutionsClient.getExecution(
    { executionId: 10 },
  );

getExecutionFullReport

syntheticOnDemandMonitorExecutionsClient.getExecutionFullReport(config): Promise<SyntheticOnDemandExecution>

Gets detailed results of the specified on-demand execution

Required scope: environment-api:synthetic-execution:read Required permission: environment:roles:viewer

Parameters

Name	Type	Description
config.executionId*required	number	The identifier of the on-demand execution.

Returns

Return type	Status code	Description
SyntheticOnDemandExecution	200	Success. The response contains detailed information about the on-demand execution.

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Execution with the given ID doesn't exist. | Client side error. | Server side error.

Code example

import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await syntheticOnDemandMonitorExecutionsClient.getExecutionFullReport(
    { executionId: 10 },
  );

getExecutions

syntheticOnDemandMonitorExecutionsClient.getExecutions(config): Promise<SyntheticOnDemandExecutions>

Gets the list of all on-demand executions of synthetic monitors

Required scope: environment-api:synthetic-execution:read Required permission: environment:roles:viewer

Parameters

Name	Type	Description
config.batchId	number	Filters the resulting set of the executions by batch. Specify the ID of the batch.
config.dataDeliveryFrom	string	The start of the requested timeframe for data delivering timestamps. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the maximum relative timeframe of six hours is used (now-6h).
config.dataDeliveryTo	string	The end of the requested timeframe for data delivering timestamps. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.
config.executionFrom	string	The start of the requested timeframe for execution timestamps. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the maximum relative timeframe of six hours is used (now-6h).
config.executionStage	"TRIGGERED" | "EXECUTED" | "DATA_RETRIEVED"	Filters the resulting set of executions by their stage.
config.executionTo	string	The end of the requested timeframe for execution timestamps. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.
config.locationId	string	Filters the resulting set of the executions by Synthetic location. Specify the ID of the location.
config.monitorId	string	Filters the resulting set of the executions by monitor synthetic monitor. Specify the ID of the monitor.
config.schedulingFrom	string	The start of the requested timeframe for scheduling timestamps. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the maximum relative timeframe of six hours is used (now-6h).
config.schedulingTo	string	The end of the requested timeframe for scheduling timestamps. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the current timestamp is used.
config.source	"API" | "UI"	Filters the resulting set of the executions by the source of the triggering request.
config.userId	string	Filters the resulting set of executions by scheduled user.

Returns

Return type	Status code	Description
SyntheticOnDemandExecutions	200	Success

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Client side error. | Server side error.

Code example

import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await syntheticOnDemandMonitorExecutionsClient.getExecutions();

rerun

syntheticOnDemandMonitorExecutionsClient.rerun(config): Promise<SyntheticOnDemandExecutionResult>

Reruns specified on-demand execution of synthetic monitors

Required scope: environment-api:synthetic-execution:write Required permission: environment:roles:viewer

Parameters

Name	Type	Description
config.executionId*required	number	The identifier of the on-demand execution.

Returns

Return type	Status code	Description
SyntheticOnDemandExecutionResult	201	Success. The monitor's execution response details

Throws

Error Type	Error Message
ErrorEnvelopeError	Failed. The input is invalid. | Unavailable | Client side error. | Server side error.

Code example

import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";

const data =
  await syntheticOnDemandMonitorExecutionsClient.rerun({
    executionId: 10,
  });

Types

AWSKeyBasedCredentialsDto

A credentials set of the AWS_MONITORING_KEY_BASED type.

Name	Type	Description
accessKeyID	string	Access Key ID of the credentials set.
allowContextlessRequests	boolean	Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope).
allowedEntities	Array<CredentialAccessData>	The set of entities allowed to use the credential.
awsPartition	"CHINA" | "DEFAULT" | "US_GOV"	AWS partition of the credential.
description	string	A short description of the credentials set.
id	string	The ID of the credentials set.
name*required	string	The name of the credentials set.
ownerAccessOnly	boolean	The credentials set is available to every user (false) or to owner only (true).
scopeDEPRECATED	"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"	The scope of the credentials set.
scopes*required	Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">	The set of scopes of the credentials set. Limitations: CredentialsScope.APP_ENGINE is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.
secretKey	string	Secret access key of the credential.
type*required	"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"	Defines the actual set of fields depending on the value. See one of the following objects: CERTIFICATE -> CertificateCredentials PUBLIC_CERTIFICATE -> PublicCertificateCredentials USERNAME_PASSWORD -> UserPasswordCredentials TOKEN -> TokenCredentials SNMPV3 -> SNMPV3Credentials AWS_MONITORING_KEY_BASED -> AWSKeyBasedCredentialsDto AWS_MONITORING_ROLE_BASED -> AWSRoleBasedCredentials

AWSRoleBasedCredentials

A credentials set of the AWS_MONITORING_ROLE_BASED type.

Name	Type	Description
accountID	string	Amazon account ID of the credential.
allowContextlessRequests	boolean	Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope).
allowedEntities	Array<CredentialAccessData>	The set of entities allowed to use the credential.
description	string	A short description of the credentials set.
iamRole	string	The IAM role name of the credentials set.
id	string	The ID of the credentials set.
name*required	string	The name of the credentials set.
ownerAccessOnly	boolean	The credentials set is available to every user (false) or to owner only (true).
scopeDEPRECATED	"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"	The scope of the credentials set.
scopes*required	Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">	The set of scopes of the credentials set. Limitations: CredentialsScope.APP_ENGINE is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.
type*required	"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"	Defines the actual set of fields depending on the value. See one of the following objects: CERTIFICATE -> CertificateCredentials PUBLIC_CERTIFICATE -> PublicCertificateCredentials USERNAME_PASSWORD -> UserPasswordCredentials TOKEN -> TokenCredentials SNMPV3 -> SNMPV3Credentials AWS_MONITORING_KEY_BASED -> AWSKeyBasedCredentialsDto AWS_MONITORING_ROLE_BASED -> AWSRoleBasedCredentials

AbstractCredentialsResponseElement

Credentials set.

Name	Type	Description
credentialUsageSummary*required	Array<CredentialUsageHandler>	The list contains summary data related to the use of credentials.
description*required	string	A short description of the credentials set.
externalVault	ExternalVaultConfig	Configuration for external vault synchronization for username and password credentials.
id	string	The ID of the credentials set.
name*required	string	The name of the credentials set.
owner*required	string	The owner of the credential (user for which used API token was created).
ownerAccessOnly*required	boolean	Flag indicating that this credential is visible only to the owner.
scope	"ALL" | "EXTENSION" | "SYNTHETIC" | "UNKNOWN"	The scope of the credentials set.
type*required	"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD"	Defines the actual set of fields depending on the value. See one of the following objects: USERNAME_PASSWORD -> CredentialsDetailsUsernamePasswordResponseElement CERTIFICATE -> CredentialsDetailsCertificateResponseElement TOKEN -> CredentialsDetailsTokenResponseElement PUBLIC_CERTIFICATE -> CredentialsDetailsCertificateResponseElement

AbstractSloAlertDto

Name	Type	Description
alertName*required	string	Name of the alert.
alertThreshold*required	number	Threshold of the alert. Status alerts trigger if they fall below this value, burn rate alerts trigger if they exceed the value.
alertType*required	"BURN_RATE" | "STATUS"	Defines the actual set of fields depending on the value. See one of the following objects: BURN_RATE -> BurnRateAlert STATUS -> StatusAlert

AccessorPermissions

An accessor identity and it's associated permissions.

Name	Type	Description
accessor	Identity	An Identity describing either a user, a group, or the all-users group (applying to all users).
permissions	Array<"r" | "w">	The permissions associated with the accessor.

AccessorPermissionsList

All configured permissions of an object (excluding owner).

Name	Type
accessors	Array<AccessorPermissions>

ActiveGate

Parameters of the ActiveGate.

Name	Type	Description
activeGateTokens	Array<ActiveGateTokenInfoDto>	A list of the ActiveGate tokens.
autoUpdateSettings	ActiveGateAutoUpdateConfig	Configuration of the ActiveGate auto-updates.
autoUpdateStatus	"UNKNOWN" | "INCOMPATIBLE" | "OUTDATED" | "SCHEDULED" | "SUPPRESSED" | "UP2DATE" | "UPDATE_IN_PROGRESS" | "UPDATE_PENDING" | "UPDATE_PROBLEM"	The current status of auto-updates of the ActiveGate.
connectedHosts	ActiveGateConnectedHosts	Information about hosts currently connected to the ActiveGate
containerized	boolean	ActiveGate is deployed in container (true) or not (false).
environments	Array<string>	A list of environments (specified by IDs) the ActiveGate can connect to.
fipsMode	boolean	ActiveGate is running in FIPS compliant mode (true) or not (false).
group	string	The group of the ActiveGate.
hostname	string	The name of the host the ActiveGate is running on.
id	string	The ID of the ActiveGate.
loadBalancerAddresses	Array<string>	A list of Load Balancer addresses of the ActiveGate.
mainEnvironment	string	The ID of the main environment for a multi-environment ActiveGate.
modules	Array<ActiveGateModule>	A list of modules of the ActiveGate.
networkAddresses	Array<string>	A list of network addresses of the ActiveGate.
networkZone	string	The network zone of the ActiveGate.
offlineSince	number	The timestamp since when the ActiveGate is offline. The null value means the ActiveGate is online.
osArchitecture	"S390" | "X86" | "ARM" | "PPCLE"	The OS architecture that the ActiveGate is running on.
osBitness	"64"	The OS bitness that the ActiveGate is running on.
osType	"LINUX" | "WINDOWS"	The OS type that the ActiveGate is running on.
type	"CLUSTER" | "ENVIRONMENT" | "ENVIRONMENT_MULTI"	The type of the ActiveGate.
version	string	The current version of the ActiveGate in the <major>.<minor>.<revision>.<timestamp> format.

ActiveGateAutoUpdateConfig

Configuration of the ActiveGate auto-updates.

Name	Type	Description
effectiveSetting	"ENABLED" | "DISABLED"	The actual state of the ActiveGate auto-update. Applicable only if the setting parameter is set to INHERITED. In that case, the value is taken from the parent setting. Otherwise, it's just a duplicate of the setting value.
setting*required	"ENABLED" | "DISABLED" | "INHERITED"	The state of the ActiveGate auto-update: enabled, disabled, or inherited. If set to INHERITED, the setting is inherited from the global configuration set on the environment or Managed cluster level.

ActiveGateConnectedHosts

Information about hosts currently connected to the ActiveGate

Name	Type	Description
number	number	The number of hosts currently connected to the ActiveGate

ActiveGateGlobalAutoUpdateConfig

Global configuration of ActiveGates auto-update.

Name	Type	Description
globalSetting*required	"ENABLED" | "DISABLED"	The state of auto-updates for all ActiveGates connected to the environment or Managed cluster. This setting is inherited by all ActiveGates that have the INHERITED setting.
metadata	ConfigurationMetadata	Metadata useful for debugging

ActiveGateGroup

Information about ActiveGate group.

Name	Type	Description
name	string	Name of ActiveGate group

ActiveGateGroupInfoDto

Metadata for each ActiveGate group.

Name	Type	Description
activeGates*required	Array<ActiveGateInfoDto>	ActiveGates in group.
availableActiveGates*required	number	Number of ActiveGates in group available for extension.
groupName*required	string	ActiveGate group name.

ActiveGateGroups

The collection of ActiveGate groups.

Name	Type	Description
groups	Array<ActiveGateGroup>	List of ActiveGate groups

ActiveGateGroupsInfoDto

ActiveGate groups metadata for extensions.

Name	Type	Description
activeGateGroups*required	Array<ActiveGateGroupInfoDto>	Metadata for each ActiveGate group.

ActiveGateInfoDto

ActiveGates in group.

Name	Type	Description
errors*required	Array<string>	List of errors if Extension cannot be run on the ActiveGate
id*required	number	ActiveGate ID.

ActiveGateList

A list of ActiveGates.

Name	Type	Description
activeGates	Array<ActiveGate>	A list of ActiveGates.

ActiveGateModule

Information about ActiveGate module

Name	Type	Description
attributes	ActiveGateModuleAttributes	The attributes of the ActiveGate module.
enabled	boolean	The module is enabled (true) or disabled (false).
misconfigured	boolean	The module is misconfigured (true) or not (false).
type	"SYNTHETIC" | "AWS" | "AZURE" | "BEACON_FORWARDER" | "CLOUD_FOUNDRY" | "DB_INSIGHT" | "DEBUGGING" | "EXTENSIONS_V1" | "EXTENSIONS_V2" | "KUBERNETES" | "LOGS" | "MEMORY_DUMPS" | "METRIC_API" | "ONE_AGENT_ROUTING" | "OTLP_INGEST" | "REST_API" | "VMWARE" | "Z_OS"	The type of ActiveGate module.
version	string	The version of the ActiveGate module.

ActiveGateModuleAttributes

The attributes of the ActiveGate module.

type: Record<string, string | undefined>

ActiveGateToken

Metadata of an ActiveGate token.

Name	Type	Description
activeGateType*required	"CLUSTER" | "ENVIRONMENT"	The type of the ActiveGate for which the token is valid.
creationDate*required	string	The token creation date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z').
expirationDate	string	The token expiration date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z'). If not set, the token never expires.
id*required	string	The ActiveGate token identifier, consisting of prefix and public part of the token.
lastUsedDate	string	The token last used date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z').
name*required	string	The name of the token.
owner*required	string	The owner of the token.
seedToken	boolean	The token is a seed token (true) or an individual token (false).

ActiveGateTokenCreate

Parameters of a new ActiveGate token.

Name	Type	Description
activeGateType*required	"CLUSTER" | "ENVIRONMENT"	The type of the ActiveGate for which the token is valid.
expirationDate	string	The expiration date of the token. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the token never expires. Ensure that it is not set in the past and does not exceed 2 years from the moment of creation."
name*required	string	The name of the token.
seedToken	boolean	The token is a seed token (true) or an individual token (false). We recommend the individual token option (false).

ActiveGateTokenCreated

The newly created ActiveGate token.

Name	Type	Description
expirationDate	string	The token expiration date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z').
id*required	string	The ActiveGate token identifier, consisting of prefix and public part of the token.
token*required	string	The secret of the token.

ActiveGateTokenInfoDto

Information about ActiveGate token.

Name	Type	Description
environmentId	string	The environment ID to which the token belongs. Only available if more than one environment is supported.
id	string	The ActiveGate token identifier, consisting of prefix and public part of the token.
state	"UNKNOWN" | "ABSENT" | "EXPIRING" | "INVALID" | "UNSUPPORTED" | "VALID"	State of the ActiveGate token.

ActiveGateTokenList

A list of ActiveGate tokens.

Name	Type	Description
activeGateTokens	Array<ActiveGateToken>	A list of ActiveGate tokens.
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

AddEntityTag

The custom tag to be added to monitored entities.

Name	Type	Description
key*required	string	The key of the custom tag to be added to monitored entities.
value	string	The value of the custom tag to be added to monitored entities. May be null

AddEntityTags

A list of tags to be added to monitored entities.

Name	Type	Description
tags*required	Array<AddEntityTag>	A list of tags to be added to monitored entities.

AddedEntityTags

A list of custom tags added to monitored entities.

Name	Type	Description
appliedTags	Array<METag>	A list of added custom tags.
matchedEntitiesCount	number	The number of monitored entities where the tags have been added.

AffectedEntities

Information about affected entities of an attack.

Name	Type	Description
processGroup	AffectedEntity	Information about an affected entity.
processGroupInstance	AffectedEntity	Information about an affected entity.

AffectedEntity

Information about an affected entity.

Name	Type	Description
id	string	The monitored entity ID of the affected entity.
name	string	The name of the affected entity.

AgentConnectionToken

Holds the agent connection token.

Name	Type	Description
token	string	The agent connection token

AggregatedLog

Aggregated log records.

Name	Type	Description
aggregationResult	AggregatedLogAggregationResult	Aggregated log records.
warnings	string	Optional warning messages.

AggregatedLogAggregationResult

Aggregated log records.

type: Record<string, object | undefined>

AlertTemplateDto

Name	Type
templateJson	string

AlertingProfileStub

Short representation of the alerting profile.

Name	Type	Description
id*required	string	The ID of the alerting profile.
name	string	The name of the alerting profile.

ApiToken

Metadata of an API token.

Name	Type	Description
additionalMetadata	ApiTokenAdditionalMetadata	Contains additional properties for specific kinds of token. Examples: A dashboardId property for dashboard sharing tokens. A reportId property for report sharing tokens
creationDate	string	Token creation date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
enabled	boolean	The token is enabled (true) or disabled (false).
expirationDate	string	Token expiration date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z'). If not set, the token never expires.
id	string	The ID of the token, consisting of prefix and public part of the token.
lastUsedDate	string	Token last used date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
lastUsedIpAddress	string	Token last used IP address.
modifiedDate	string	Token last modified date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z'). Updating scopes or name counts as modification, enabling or disabling a token does not.
name	string	The name of the token.
owner	string	The owner of the token.
personalAccessToken	boolean	The token is a personal access token (true) or an API token (false).
scopes	Array<"ActiveGateCertManagement" | "AdvancedSyntheticIntegration" | "CaptureRequestData" | "DTAQLAccess" | "DataExport" | "DataImport" | "DataPrivacy" | "Davis" | "DiagnosticExport" | "DssFileManagement" | "ExternalSyntheticIntegration" | "InstallerDownload" | "LogExport" | "MemoryDump" | "Mobile" | "PluginUpload" | "ReadConfig" | "ReadSyntheticData" | "RestRequestForwarding" | "RumBrowserExtension" | "RumJavaScriptTagManagement" | "SupportAlert" | "TenantTokenManagement" | "UserSessionAnonymization" | "ViewDashboard" | "ViewReport" | "WriteConfig" | "WriteSyntheticData" | "activeGateTokenManagement.create" | "activeGateTokenManagement.read" | "activeGateTokenManagement.write" | "activeGates.read" | "activeGates.write" | "adaptiveTrafficManagement.read" | "agentTokenManagement.read" | "analyzers.read" | "analyzers.write" | "apiTokens.read" | "apiTokens.write" | "attacks.read" | "attacks.write" | "auditLogs.read" | "bizevents.ingest" | "credentialVault.read" | "credentialVault.write" | "entities.read" | "entities.write" | "events.ingest" | "events.read" | "extensionConfigurationActions.write" | "extensionConfigurations.read" | "extensionConfigurations.write" | "extensionEnvironment.read" | "extensionEnvironment.write" | "extensions.read" | "extensions.write" | "geographicRegions.read" | "hub.install" | "hub.read" | "hub.write" | "javaScriptMappingFiles.read" | "javaScriptMappingFiles.write" | "logs.ingest" | "logs.read" | "metrics.ingest" | "metrics.read" | "metrics.write" | "networkZones.read" | "networkZones.write" | "oneAgents.read" | "oneAgents.write" | "openTelemetryTrace.ingest" | "openpipeline.events" | "openpipeline.events.custom" | "openpipeline.events_sdlc" | "openpipeline.events_sdlc.custom" | "openpipeline.events_security" | "openpipeline.events_security.custom" | "problems.read" | "problems.write" | "releases.read" | "rumCookieNames.read" | "securityProblems.read" | "securityProblems.write" | "settings.read" | "settings.write" | "slo.read" | "slo.write" | "syntheticExecutions.read" | "syntheticExecutions.write" | "syntheticLocations.read" | "syntheticLocations.write" | "tenantTokenRotation.write" | "traces.lookup" | "unifiedAnalysis.read">	A list of scopes assigned to the token.

ApiTokenCreate

Parameters of a new API token.

Name	Type	Description
expirationDate	string	The expiration date of the token. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years If not set, the token never expires. Ensure that the expiration date is not set in the past.
name*required	string	The name of the token.
personalAccessToken	boolean	The token is a personal access token (true) or an API token (false). Personal access tokens are tied to the permissions of their owner.
scopes*required	Array<"ActiveGateCertManagement" | "AdvancedSyntheticIntegration" | "CaptureRequestData" | "DTAQLAccess" | "DataExport" | "DataImport" | "DataPrivacy" | "Davis" | "DssFileManagement" | "ExternalSyntheticIntegration" | "InstallerDownload" | "LogExport" | "PluginUpload" | "ReadConfig" | "ReadSyntheticData" | "RestRequestForwarding" | "RumBrowserExtension" | "RumJavaScriptTagManagement" | "SupportAlert" | "TenantTokenManagement" | "UserSessionAnonymization" | "WriteConfig" | "activeGateTokenManagement.create" | "activeGateTokenManagement.read" | "activeGateTokenManagement.write" | "activeGates.read" | "activeGates.write" | "adaptiveTrafficManagement.read" | "agentTokenManagement.read" | "analyzers.read" | "analyzers.write" | "apiTokens.read" | "apiTokens.write" | "attacks.read" | "attacks.write" | "auditLogs.read" | "bizevents.ingest" | "credentialVault.read" | "credentialVault.write" | "entities.read" | "entities.write" | "events.ingest" | "events.read" | "extensionConfigurationActions.write" | "extensionConfigurations.read" | "extensionConfigurations.write" | "extensionEnvironment.read" | "extensionEnvironment.write" | "extensions.read" | "extensions.write" | "geographicRegions.read" | "hub.install" | "hub.read" | "hub.write" | "javaScriptMappingFiles.read" | "javaScriptMappingFiles.write" | "logs.ingest" | "logs.read" | "metrics.ingest" | "metrics.read" | "metrics.write" | "networkZones.read" | "networkZones.write" | "oneAgents.read" | "oneAgents.write" | "openTelemetryTrace.ingest" | "openpipeline.events" | "openpipeline.events.custom" | "openpipeline.events_sdlc" | "openpipeline.events_sdlc.custom" | "openpipeline.events_security" | "openpipeline.events_security.custom" | "problems.read" | "problems.write" | "releases.read" | "rumCookieNames.read" | "securityProblems.read" | "securityProblems.write" | "settings.read" | "settings.write" | "slo.read" | "slo.write" | "syntheticExecutions.read" | "syntheticExecutions.write" | "syntheticLocations.read" | "syntheticLocations.write" | "tenantTokenRotation.write" | "traces.lookup" | "unifiedAnalysis.read">	A list of the scopes to be assigned to the token. InstallerDownload: PaaS integration - Installer download. DataExport: Access problem and event feed, metrics, and topology. PluginUpload: Upload Extension. SupportAlert: PaaS integration - Support alert. AdvancedSyntheticIntegration: Dynatrace module integration - Synthetic Classic. ExternalSyntheticIntegration: Create and read synthetic monitors, locations, and nodes. RumBrowserExtension: RUM Browser Extension. LogExport: Read logs. ReadConfig: Read configuration. WriteConfig: Write configuration. DTAQLAccess: User sessions. UserSessionAnonymization: Anonymize user session data for data privacy reasons. DataPrivacy: Change data privacy settings. CaptureRequestData: Capture request data. Davis: Dynatrace module integration - Davis. DssFileManagement: Mobile symbolication file management. RumJavaScriptTagManagement: Real user monitoring JavaScript tag management. TenantTokenManagement: Token management. ActiveGateCertManagement: ActiveGate certificate management. RestRequestForwarding: Fetch data from a remote environment. ReadSyntheticData: Read synthetic monitors, locations, and nodes. DataImport: Data ingest, e.g.: metrics and events. syntheticExecutions.write: Write synthetic monitor executions. syntheticExecutions.read: Read synthetic monitor execution results. auditLogs.read: Read audit logs. metrics.read: Read metrics. metrics.write: Write metrics. entities.read: Read entities. entities.write: Write entities. problems.read: Read problems. problems.write: Write problems. events.read: Read events. events.ingest: Ingest events. openpipeline.events: OpenPipeline - Ingest Events (Built-in). openpipeline.events.custom: OpenPipeline - Ingest Events (Custom). openpipeline.events_security: OpenPipeline - Ingest Security Events (Built-in). openpipeline.events_security.custom: OpenPipeline - Ingest Security Events (Custom). openpipeline.events_sdlc: OpenPipeline - Ingest Software Development Lifecycle Events (Built-in). openpipeline.events_sdlc.custom: OpenPipeline - Ingest Software Development Lifecycle Events (Custom). bizevents.ingest: Ingest bizevents. analyzers.read: Read analyzers. analyzers.write: Write & execute analyzers. networkZones.read: Read network zones. networkZones.write: Write network zones. activeGates.read: Read ActiveGates. activeGates.write: Write ActiveGates. activeGateTokenManagement.read: Read ActiveGate tokens. activeGateTokenManagement.create: Create ActiveGate tokens. activeGateTokenManagement.write: Write ActiveGate tokens. agentTokenManagement.read: Read Agent tokens. credentialVault.read: Read credential vault entries. credentialVault.write: Write credential vault entries. extensions.read: Read extensions. extensions.write: Write extensions. extensionConfigurations.read: Read extension monitoring configurations. extensionConfigurations.write: Write extension monitoring configurations. extensionEnvironment.read: Read extension environment configurations. extensionEnvironment.write: Write extension environment configurations. metrics.ingest: Ingest metrics. attacks.read: Read attacks. attacks.write: Write Application Protection settings. securityProblems.read: Read security problems. securityProblems.write: Write security problems. syntheticLocations.read: Read synthetic locations. syntheticLocations.write: Write synthetic locations. settings.read: Read settings. settings.write: Write settings. tenantTokenRotation.write: Tenant token rotation. slo.read: Read SLO. slo.write: Write SLO. releases.read: Read releases. apiTokens.read: Read API tokens. apiTokens.write: Write API tokens. openTelemetryTrace.ingest: Ingest OpenTelemetry traces. logs.read: Read logs. logs.ingest: Ingest logs. geographicRegions.read: Read Geographic regions. oneAgents.read: Read OneAgents. oneAgents.write: Write OneAgents. traces.lookup: Look up a single trace. unifiedAnalysis.read: Read Unified Analysis page. hub.read: Read Hub related data. hub.write: Manage metadata of Hub items. hub.install: Install and update Hub items. javaScriptMappingFiles.read: Read JavaScript mapping files. javaScriptMappingFiles.write: Write JavaScript mapping files. extensionConfigurationActions.write: Actions for extension monitoring configurations. rumCookieNames.read: Read RUM cookie names. adaptiveTrafficManagement.read: Read sampling configuration for Adaptive Traffic Management.

ApiTokenCreated

The newly created token.

Name	Type	Description
expirationDate	string	The token expiration date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z').
id	string	The ID of the token, consisting of prefix and public part of the token.
token	string	The secret of the token.

ApiTokenList

A list of API tokens.

Name	Type	Description
apiTokens	Array<ApiToken>	A list of API tokens.
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

ApiTokenSecret

Name	Type	Description
token*required	string	The API token.

ApiTokenUpdate

The update of the API token.

Name	Type	Description
enabled	boolean	The token is enabled (true) or disabled (false)
name	string	The name of the token.
scopes	Array<"ActiveGateCertManagement" | "AdvancedSyntheticIntegration" | "CaptureRequestData" | "DTAQLAccess" | "DataExport" | "DataImport" | "DataPrivacy" | "Davis" | "DssFileManagement" | "ExternalSyntheticIntegration" | "InstallerDownload" | "LogExport" | "PluginUpload" | "ReadConfig" | "ReadSyntheticData" | "RestRequestForwarding" | "RumBrowserExtension" | "RumJavaScriptTagManagement" | "SupportAlert" | "TenantTokenManagement" | "UserSessionAnonymization" | "WriteConfig" | "activeGateTokenManagement.create" | "activeGateTokenManagement.read" | "activeGateTokenManagement.write" | "activeGates.read" | "activeGates.write" | "adaptiveTrafficManagement.read" | "agentTokenManagement.read" | "analyzers.read" | "analyzers.write" | "apiTokens.read" | "apiTokens.write" | "attacks.read" | "attacks.write" | "auditLogs.read" | "bizevents.ingest" | "credentialVault.read" | "credentialVault.write" | "entities.read" | "entities.write" | "events.ingest" | "events.read" | "extensionConfigurationActions.write" | "extensionConfigurations.read" | "extensionConfigurations.write" | "extensionEnvironment.read" | "extensionEnvironment.write" | "extensions.read" | "extensions.write" | "geographicRegions.read" | "hub.install" | "hub.read" | "hub.write" | "javaScriptMappingFiles.read" | "javaScriptMappingFiles.write" | "logs.ingest" | "logs.read" | "metrics.ingest" | "metrics.read" | "metrics.write" | "networkZones.read" | "networkZones.write" | "oneAgents.read" | "oneAgents.write" | "openTelemetryTrace.ingest" | "openpipeline.events" | "openpipeline.events.custom" | "openpipeline.events_sdlc" | "openpipeline.events_sdlc.custom" | "openpipeline.events_security" | "openpipeline.events_security.custom" | "problems.read" | "problems.write" | "releases.read" | "rumCookieNames.read" | "securityProblems.read" | "securityProblems.write" | "settings.read" | "settings.write" | "slo.read" | "slo.write" | "syntheticExecutions.read" | "syntheticExecutions.write" | "syntheticLocations.read" | "syntheticLocations.write" | "tenantTokenRotation.write" | "traces.lookup" | "unifiedAnalysis.read">	The list of scopes assigned to the token. Apart from the new scopes, you need to submit the existing scopes you want to keep, too. Any existing scope, missing in the payload, is removed. InstallerDownload: PaaS integration - Installer download. DataExport: Access problem and event feed, metrics, and topology. PluginUpload: Upload Extension. SupportAlert: PaaS integration - Support alert. AdvancedSyntheticIntegration: Dynatrace module integration - Synthetic Classic. ExternalSyntheticIntegration: Create and read synthetic monitors, locations, and nodes. RumBrowserExtension: RUM Browser Extension. LogExport: Read logs. ReadConfig: Read configuration. WriteConfig: Write configuration. DTAQLAccess: User sessions. UserSessionAnonymization: Anonymize user session data for data privacy reasons. DataPrivacy: Change data privacy settings. CaptureRequestData: Capture request data. Davis: Dynatrace module integration - Davis. DssFileManagement: Mobile symbolication file management. RumJavaScriptTagManagement: Real user monitoring JavaScript tag management. TenantTokenManagement: Token management. ActiveGateCertManagement: ActiveGate certificate management. RestRequestForwarding: Fetch data from a remote environment. ReadSyntheticData: Read synthetic monitors, locations, and nodes. DataImport: Data ingest, e.g.: metrics and events. syntheticExecutions.write: Write synthetic monitor executions. syntheticExecutions.read: Read synthetic monitor execution results. auditLogs.read: Read audit logs. metrics.read: Read metrics. metrics.write: Write metrics. entities.read: Read entities. entities.write: Write entities. problems.read: Read problems. problems.write: Write problems. events.read: Read events. events.ingest: Ingest events. openpipeline.events: OpenPipeline - Ingest Events (Built-in). openpipeline.events.custom: OpenPipeline - Ingest Events (Custom). openpipeline.events_security: OpenPipeline - Ingest Security Events (Built-in). openpipeline.events_security.custom: OpenPipeline - Ingest Security Events (Custom). openpipeline.events_sdlc: OpenPipeline - Ingest Software Development Lifecycle Events (Built-in). openpipeline.events_sdlc.custom: OpenPipeline - Ingest Software Development Lifecycle Events (Custom). bizevents.ingest: Ingest bizevents. analyzers.read: Read analyzers. analyzers.write: Write & execute analyzers. networkZones.read: Read network zones. networkZones.write: Write network zones. activeGates.read: Read ActiveGates. activeGates.write: Write ActiveGates. activeGateTokenManagement.read: Read ActiveGate tokens. activeGateTokenManagement.create: Create ActiveGate tokens. activeGateTokenManagement.write: Write ActiveGate tokens. agentTokenManagement.read: Read Agent tokens. credentialVault.read: Read credential vault entries. credentialVault.write: Write credential vault entries. extensions.read: Read extensions. extensions.write: Write extensions. extensionConfigurations.read: Read extension monitoring configurations. extensionConfigurations.write: Write extension monitoring configurations. extensionEnvironment.read: Read extension environment configurations. extensionEnvironment.write: Write extension environment configurations. metrics.ingest: Ingest metrics. attacks.read: Read attacks. attacks.write: Write Application Protection settings. securityProblems.read: Read security problems. securityProblems.write: Write security problems. syntheticLocations.read: Read synthetic locations. syntheticLocations.write: Write synthetic locations. settings.read: Read settings. settings.write: Write settings. tenantTokenRotation.write: Tenant token rotation. slo.read: Read SLO. slo.write: Write SLO. releases.read: Read releases. apiTokens.read: Read API tokens. apiTokens.write: Write API tokens. openTelemetryTrace.ingest: Ingest OpenTelemetry traces. logs.read: Read logs. logs.ingest: Ingest logs. geographicRegions.read: Read Geographic regions. oneAgents.read: Read OneAgents. oneAgents.write: Write OneAgents. traces.lookup: Look up a single trace. unifiedAnalysis.read: Read Unified Analysis page. hub.read: Read Hub related data. hub.write: Manage metadata of Hub items. hub.install: Install and update Hub items. javaScriptMappingFiles.read: Read JavaScript mapping files. javaScriptMappingFiles.write: Write JavaScript mapping files. extensionConfigurationActions.write: Actions for extension monitoring configurations. rumCookieNames.read: Read RUM cookie names. adaptiveTrafficManagement.read: Read sampling configuration for Adaptive Traffic Management.

ApplicationImpact

Analysis of problem impact to an application.

Name	Type	Description
estimatedAffectedUsers*required	number	The estimated number of affected users.
impactType*required	"APPLICATION" | "CUSTOM_APPLICATION" | "MOBILE" | "SERVICE"	Defines the actual set of fields depending on the value. See one of the following objects: SERVICE -> ServiceImpact APPLICATION -> ApplicationImpact MOBILE -> MobileImpact CUSTOM_APPLICATION -> CustomApplicationImpact
impactedEntity*required	EntityStub	A short representation of a monitored entity.

AppliedFilter

Optional filters that took effect.

Name	Type	Description
appliedTo*required	Array<string>	The keys of all metrics that this filter has been applied to. Can contain multiple metrics for complex expressions and always at least one key.
filter	Filter	A dimensional or series filter on a metric.

AssessmentAccuracyDetails

The assessment accuracy details.

Name	Type	Description
reducedReasons	Array<"LIMITED_AGENT_SUPPORT" | "LIMITED_BY_CONFIGURATION">	The reasons for a reduced assessment accuracy.

AssetInfo

Assets types and its count

Name	Type
assetType	string
count	number

AssetInfoDto

Metadata for an extension asset.

Name	Type	Description
assetSchemaDetails	AssetSchemaDetailsDto	Settings schema details for asset
displayName	string	User-friendly name of the asset.
id	string	ID of the asset. Identifies the asset in REST API and/or UI (where applicable).
type	"ALERT" | "ALERT_TEMPLATE" | "AWS_SERVICE" | "CUSTOM_CARDS" | "DASHBOARD" | "DECLARATIVE_PROCESSES" | "DOCUMENT_DASHBOARD" | "DQL_LOG_METRIC" | "DQL_LOG_PROCESSING_RULE" | "GENERIC_RELATIONSHIP" | "GENERIC_TYPE" | "LIST_SCREEN_FILTERS" | "LIST_SCREEN_INJECTIONS" | "LIST_SCREEN_LAYOUT" | "LOG_EVENT" | "LOG_METRIC" | "LOG_PROCESSING_RULE" | "LQL_LOG_METRIC" | "LQL_LOG_PROCESSING_RULE" | "METRIC_METADATA" | "METRIC_QUERY" | "PROCESS_GROUPING_RULES" | "SCREEN_ACTIONS" | "SCREEN_CHART_GROUPS" | "SCREEN_DQL_TABLE" | "SCREEN_ENTITIES_LISTS" | "SCREEN_EVENTS_CARDS" | "SCREEN_FILTERS" | "SCREEN_HEALTH_CARDS" | "SCREEN_INJECTIONS" | "SCREEN_LAYOUT" | "SCREEN_LOGS_CARDS" | "SCREEN_MESSAGE_CARDS" | "SCREEN_METRIC_TABLES" | "SCREEN_PROBLEMS" | "SCREEN_PROPERTIES"	The type of the asset.

AssetSchemaDetailsDto

Settings schema details for asset

Name	Type	Description
key	string	Asset key
schemaId	string	Asset schema id
scope	string	Asset configuration scope

Attack

Describes an attack.

Name	Type	Description
affectedEntities	AffectedEntities	Information about affected entities of an attack.
attackId	string	The ID of the attack.
attackTarget	AttackTarget	Information about the targeted host/database of an attack.
attackType	"COMMAND_INJECTION" | "JNDI_INJECTION" | "SQL_INJECTION" | "SSRF"	The type of the attack.
attacker	Attacker	Attacker of an attack.
displayId	string	The display ID of the attack.
displayName	string	The display name of the attack.
entrypoint	AttackEntrypoint	Describes the entrypoint used by an attacker to start a specific attack.
managementZones	Array<ManagementZone>	A list of management zones which the affected entities belong to.
request	RequestInformation	Describes the complete request information of an attack.
securityProblem	AttackSecurityProblem	Assessment information and the ID of a security problem related to an attack.
state	"ALLOWLISTED" | "BLOCKED" | "EXPLOITED"	The state of the attack.
technology	"DOTNET" | "GO" | "JAVA" | "NODE_JS"	The technology of the attack.
timestamp	number	The timestamp when the attack occurred.
vulnerability	Vulnerability	Describes the exploited vulnerability.

AttackEntrypoint

Describes the entrypoint used by an attacker to start a specific attack.

Name	Type	Description
codeLocation	CodeLocation	Information about a code location.
entrypointFunction	FunctionDefinition	Information about a function definition.
payload	Array<AttackEntrypointPayloadItem>	All relevant payload data that has been sent during the attack.

AttackEntrypointPayloadItem

A list of values that has possibly been truncated.

Name	Type	Description
truncationInfo	TruncationInfo	Information on a possible truncation.
values	Array<EntrypointPayload>	Values of the list.

AttackList

A list of attacks.

Name	Type	Description
attacks	Array<Attack>	A list of attacks.
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

AttackRequestHeader

A header element of the attack's request.

Name	Type	Description
name	string	The name of the header element.
value	string	The value of the header element.

AttackSecurityProblem

Assessment information and the ID of a security problem related to an attack.

Name	Type	Description
assessment	AttackSecurityProblemAssessmentDto	The assessment of a security problem related to an attack.
securityProblemId	string	The security problem ID.

AttackSecurityProblemAssessmentDto

The assessment of a security problem related to an attack.

Name	Type	Description
dataAssets	"NOT_AVAILABLE" | "NOT_DETECTED" | "REACHABLE"	The reachability of data assets by the attacked target.
exposure	"NOT_AVAILABLE" | "NOT_DETECTED" | "PUBLIC_NETWORK"	The level of exposure of the attacked target
numberOfReachableDataAssets	number	The number of data assets reachable by the attacked target.

AttackTarget

Information about the targeted host/database of an attack.

Name	Type	Description
entityId	string	The monitored entity ID of the targeted host/database.
name	string	The name of the targeted host/database.

Attacker

Attacker of an attack.

Name	Type	Description
location	AttackerLocation	Location of an attacker.
sourceIp	string	The source IP of the attacker.

AttackerLocation

Location of an attacker.

Name	Type	Description
city	string	City of the attacker.
country	string	The country of the attacker.
countryCode	string	The country code of the country of the attacker, according to the ISO 3166-1 Alpha-2 standard.

AuditLog

The audit log of your environment.

Name	Type	Description
auditLogs	Array<AuditLogEntry>	A list of audit log entries ordered by the creation timestamp.
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

AuditLogEntry

An entry of the audit log.

Name	Type	Description
category*required	"TOKEN" | "ACTIVEGATE_TOKEN" | "BUILD_UNIT_V2" | "CONFIG" | "MANUAL_TAGGING_SERVICE" | "TENANT_LIFECYCLE" | "WEB_UI"	The category of the recorded operation.
dt.settings.key	string	The key of the affected object of a setting for entries of category CONFIG.
dt.settings.object_id	string	The ID of the affected object of a setting for entries of category CONFIG.
dt.settings.object_summary	string	The value summary for entries of category CONFIG.
dt.settings.schema_id	string	The schema ID or config ID for entries of category CONFIG.
dt.settings.scope_id	string	The persistence scope for entries of category CONFIG, e.g. an ME identifier.
dt.settings.scope_name	string	The display name of the scope for entries of category CONFIG.
entityId	string	The ID of an entity from the category. For example, it can be config ID for the CONFIG category or token ID for the TOKEN category.
environmentId*required	string	The ID of the Dynatrace environment where the recorded operation occurred.
eventType*required	"CREATE" | "DELETE" | "LOGIN" | "LOGOUT" | "REORDER" | "REVOKE" | "TAG_ADD" | "TAG_REMOVE" | "TAG_UPDATE" | "UPDATE"	The type of the recorded operation. LOGIN -> A user logged in LOGOUT -> A user logged out CREATE -> An object was created UPDATE -> An object was updated DELETE -> An object was deleted REVOKE -> An Active Gate token was revoked TAG_ADD -> A manual tag was added TAG_REMOVE -> A manual tag was removed TAG_UPDATE -> A manual tag was updated REMOTE_CONFIGURATION_MANAGEMENT -> A Remote Configuration Management related operation occurred
logId*required	string	The ID of the log entry.
message	string	The logged message.
patch	AnyValue	The patch of the recorded operation as the JSON representation. The format is an enhanced RFC 6902. The patch also carries the previous value in the oldValue field.
success*required	boolean	The recorded operation is successful (true) or failed (false).
timestamp*required	number	The timestamp of the record creation, in UTC milliseconds.
user*required	string	The ID of the user who performed the recorded operation.
userOrigin	string	The origin and the IP address of the user.
userType*required	"PUBLIC_TOKEN_IDENTIFIER" | "SERVICE_NAME" | "TOKEN_HASH" | "USER_NAME"	The type of the authentication of the user. USER_NAME -> User was logged in the UI TOKEN_HASH -> URL Token or DevOps Token, the hash of the token is logged SERVICE_NAME -> No authenticated user at all, this action was performed by a system service automatically PUBLIC_TOKEN_IDENTIFIER -> API Token, the public token id is logged

AuthorDto

Extension author

Name	Type	Description
name	string	Author name

AvailabilityEvidence

The availability evidence of the problem.

Indicates an entity that has been unavailable during the problem lifespan and that might be related to the root cause.

Name	Type	Description
displayName*required	string	The display name of the evidence.
endTime	number	The end time of the evidence, in UTC milliseconds.
entity*required	EntityStub	A short representation of a monitored entity.
evidenceType*required	"AVAILABILITY_EVIDENCE" | "EVENT" | "MAINTENANCE_WINDOW" | "METRIC" | "TRANSACTIONAL"	Defines the actual set of fields depending on the value. See one of the following objects: EVENT -> EventEvidence METRIC -> MetricEvidence TRANSACTIONAL -> TransactionalEvidence MAINTENANCE_WINDOW -> MaintenanceWindowEvidence AVAILABILITY_EVIDENCE -> AvailabilityEvidence
groupingEntity	EntityStub	A short representation of a monitored entity.
rootCauseRelevant*required	boolean	The evidence is (true) or is not (false) a part of the root cause.
startTime*required	number	The start time of the evidence, in UTC milliseconds.

AzureClientSecret

Synchronization credentials with Azure Key Vault using client secret authentication method

Name	Type	Description
clientId	string	Client (application) ID of Azure application in Azure Active Directory which has permission to access secrets in Azure Key Vault.
clientSecret	string	Client secret generated for Azure application in Azure Active Directory used for proving identity when requesting a token used later for accessing secrets in Azure Key Vault.
locationForSynchronizationId	string	Id of a location used by the synchronizing monitor
passwordSecretName	string	The name of the secret saved in external vault where password is stored.
sourceAuthMethod	"AZURE_KEY_VAULT_CLIENT_SECRET" | "CYBERARK_VAULT_ALLOWED_LOCATION" | "CYBERARK_VAULT_USERNAME_PASSWORD" | "HASHICORP_VAULT_APPROLE" | "HASHICORP_VAULT_CERTIFICATE"	Defines the actual set of fields depending on the value. See one of the following objects: HASHICORP_VAULT_APPROLE -> HashicorpApprole HASHICORP_VAULT_CERTIFICATE -> HashicorpCertificate AZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecret CYBERARK_VAULT_USERNAME_PASSWORD -> CyberArkUsernamePassword CYBERARK_VAULT_ALLOWED_LOCATION -> CyberArkAllowedLocationDto
tenantId	string	Tenant (directory) ID of Azure application in Azure Active Directory which has permission to access secrets in Azure Key Vault.
tokenSecretName	string	The name of the secret saved in external vault where token is stored.
usernameSecretName	string	The name of the secret saved in external vault where username is stored.
vaultUrl	string	External vault URL.

AzureClientSecretConfig

Configuration for external vault synchronization for username and password credentials.

Name	Type	Description
clientId	string
clientSecret	string
credentialsUsedForExternalSynchronization	Array<string>
passwordSecretName	string
sourceAuthMethod	"AZURE_KEY_VAULT_CLIENT_SECRET" | "CYBERARK_VAULT_ALLOWED_LOCATION" | "CYBERARK_VAULT_USERNAME_PASSWORD" | "HASHICORP_VAULT_APPROLE" | "HASHICORP_VAULT_CERTIFICATE"	Defines the actual set of fields depending on the value. See one of the following objects: HASHICORP_VAULT_APPROLE -> HashicorpApproleConfig HASHICORP_VAULT_CERTIFICATE -> HashicorpCertificateConfig AZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecretConfig CYBERARK_VAULT_USERNAME_PASSWORD -> CyberArkUsernamePasswordConfig CYBERARK_VAULT_ALLOWED_LOCATION -> CyberArkAllowedLocationConfig
tenantId	string
tokenSecretName	string
type	"AZURE_CERTIFICATE_MODEL" | "AZURE_CLIENT_SECRET_MODEL" | "CYBERARK_VAULT_ALLOWED_LOCATION_MODEL" | "CYBERARK_VAULT_USERNAME_PASSWORD_MODEL" | "HASHICORP_APPROLE_MODEL" | "HASHICORP_CERTIFICATE_MODEL"
usernameSecretName	string
vaultUrl	string

BMAction

Contains detailed information about Browser monitor action.

Name	Type	Description
apdexType	"UNKNOWN" | "FRUSTRATED" | "SATISFIED" | "TOLERATING"	The user experience index of the action.
cdnBusyTime	number	The time spent waiting for CDN resources for the action, in milliseconds.
cdnResources	number	The number of resources fetched from a CDN for the action.
clientTime	number	The event startTime in client time, in milliseconds.
cumulativeLayoutShift	number	Cumulative layout shift: Available for Chromium-based browsers. Measured using Google-provided APIs.
customErrorCount	number	The total number of custom errors during the action.
documentInteractiveTime	number	The amount of time spent until the document for the action became interactive, in milliseconds.
domCompleteTime	number	The amount of time until the DOM tree is completed, in milliseconds.
domContentLoadedTime	number	The amount of time until the DOM tree is loaded, in milliseconds.
domain	string	The DNS domain where the action has been recorded
duration	number	The duration of the action, in milliseconds
endTime	number	The stop time of the action on the server, in UTC milliseconds
entryAction	boolean
exitAction	boolean
firstInputDelay	number	The first input delay (FID) is the time (in milliseconds) that the browser took to respond to the first user input.
firstPartyBusyTime	number	The time spent waiting for resources from the originating server for the action, in milliseconds.
firstPartyResources	number	The number of resources fetched from the originating server for the action.
frontendTime	number	The amount of time spent on the frontend rendering for the action, in milliseconds.
javascriptErrorCount	number	The total number of Javascript errors during the action.
largestContentfulPaint	number	The largest contentful paint (LCP) is the time (in milliseconds) that the largest element on the page took to render.
loadEventEnd	number	The amount of time until the load event ended, in milliseconds.
loadEventStart	number	The amount of time until the load event started, in milliseconds.
monitorType*required	"BROWSER" | "HTTP"	Defines the actual set of fields depending on the value. See one of the following objects: BROWSER -> BMAction HTTP -> MonitorRequestExecutionResult
name	string	The name of the action.
navigationStartTime	number	The timestamp of the navigation start, in UTC milliseconds.
networkTime	number	The amount of time spent on the data transfer for the action, in milliseconds.
referrer	string	The referrer.
requestErrorCount	number	The total number of request errors during the action.
requestStart	number	The amount of time until the request started, in milliseconds.
responseEnd	number	The amount of time until the response ended, in milliseconds.
responseStart	number	The amount of time until the response started, in milliseconds.
serverTime	number	The amount of time spent on the server-side processing for the action, in milliseconds.
speedIndex	number	A score indicating how quickly the page content is visually populated. A low speed index means that most parts of a page are rendering quickly.
startSequenceNumber	number	The sequence number of the action (to get a kind of order).
startTime	number	The start time of the action on the server, in in UTC milliseconds.
targetUrl	string	The URL of the action.
thirdPartyBusyTime	number	The time spent waiting for third party resources for the action, in milliseconds.
thirdPartyResources	number	The number of third party resources loaded for the action.
totalBlockingTime	number	The time between the moment when the browser receives a request to download a resource and the time that it actually starts downloading the resource in ms.
type	"Custom" | "EndVisit" | "Error" | "Load" | "RageClick" | "StandaloneAgentEvent" | "StandaloneHttpError" | "SyntheticHiddenAction" | "UserSessionProperties" | "ViewChangeEvent" | "VisitTag" | "Xhr"	The type of the action.
userActionPropertyCount	number	The total number of properties in the action.
visuallyCompleteTime	number	The amount of time until the page is visually complete, in milliseconds.

BizEventIngestError

Name	Type
id	string
index	number
message	string
source	string

BizEventIngestResult

Result received after ingesting business events.

Name	Type	Description
errors	Array<BizEventIngestError>	A list of business events ingest errors.

BurnRateAlert

Parameters of an error budget burn rate alert.

Name	Type	Description
alertName*required	string	Name of the alert.
alertThreshold*required	number	Threshold of the alert. Status alerts trigger if they fall below this value, burn rate alerts trigger if they exceed the value.
alertType*required	"BURN_RATE" | "STATUS"	Defines the actual set of fields depending on the value. See one of the following objects: BURN_RATE -> BurnRateAlert STATUS -> StatusAlert

CertificateCredentials

A credentials set of the CERTIFICATE type.

Name	Type	Description
allowContextlessRequests	boolean	Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope).
allowedEntities	Array<CredentialAccessData>	The set of entities allowed to use the credential.
certificate	string	String containing the certificate file bytes encoded in Base64 without carriage return.
certificateFormat	"UNKNOWN" | "PEM" | "PKCS12"	The certificate format. Use PEM for PEM certificates and PKCS12 for PFX and P12 certificates.
description	string	A short description of the credentials set.
id	string	The ID of the credentials set.
name*required	string	The name of the credentials set.
ownerAccessOnly	boolean	The credentials set is available to every user (false) or to owner only (true).
password	string	The password of the credential encoded in Base64. Must be empty for PEM certificates.
scopeDEPRECATED	"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"	The scope of the credentials set.
scopes*required	Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">	The set of scopes of the credentials set. Limitations: CredentialsScope.APP_ENGINE is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.
type*required	"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"	Defines the actual set of fields depending on the value. See one of the following objects: CERTIFICATE -> CertificateCredentials PUBLIC_CERTIFICATE -> PublicCertificateCredentials USERNAME_PASSWORD -> UserPasswordCredentials TOKEN -> TokenCredentials SNMPV3 -> SNMPV3Credentials AWS_MONITORING_KEY_BASED -> AWSKeyBasedCredentialsDto AWS_MONITORING_ROLE_BASED -> AWSRoleBasedCredentials

CloudEvent

CloudEvents is a specification for describing event data in common formats to provide interoperability across services, platforms and systems.

Name	Type	Description
data	Record<string | any>
data_base64	string
datacontenttype	string
dataschema	string
dtcontext	string	Dynatrace context
id*required	string
source*required	string
specversion*required	string
subject	string
time	Date
traceparent	string	Trace related to this event. See distributed tracing for further information.
type*required	string

CodeLevelVulnerabilityDetails

The details of a code-level vulnerability.

Name	Type	Description
processGroupIds	Array<string>	The list of encoded MEIdentifier of the process groups.
processGroups	Array<string>	The list of affected process groups.
shortVulnerabilityLocation	string	The code location of the vulnerability without package and parameter.
type	"SQL_INJECTION" | "SSRF" | "CMD_INJECTION" | "IMPROPER_INPUT_VALIDATION"	The type of code level vulnerability.
vulnerabilityLocation	string	The code location of the vulnerability.
vulnerableFunction	string	The vulnerable function of the vulnerability.
vulnerableFunctionInput	VulnerableFunctionInput	Describes what got passed into the code level vulnerability.

CodeLocation

Information about a code location.

Name	Type	Description
className	string	The fully qualified class name of the code location.
columnNumber	number	The column number of the code location.
displayName	string	A human readable string representation of the code location.
fileName	string	The file name of the code location.
functionName	string	The function/method name of the code location.
lineNumber	number	The line number of the code location.
parameterTypes	TruncatableListString	A list of values that has possibly been truncated.
returnType	string	The return type of the function.

Comment

The comment to a problem.

Name	Type	Description
authorName	string	The user who wrote the comment.
content	string	The text of the comment.
context	string	The context of the comment.
createdAtTimestamp*required	number	The timestamp of comment creation, in UTC milliseconds.
id	string	The ID of the comment.

CommentRequestDtoImpl

Name	Type	Description
context	string	The context of the comment.
message*required	string	The text of the comment.

CommentsList

A list of comments.

Name	Type	Description
comments*required	Array<Comment>	The result entries.
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

ComplexConstraint

A constraint on the values accepted for a complex settings property.

Name	Type	Description
checkAllProperties	boolean	Defines if modification of any property triggers secret resubmission check.
customMessage	string	A custom message for invalid values.
customValidatorId	string	The ID of a custom validator.
maximumPropertyCount	number	The maximum number of properties that can be set.
minimumPropertyCount	number	The minimum number of properties that must be set.
properties	Array<string>	A list of properties (defined by IDs) that are used to check the constraint.
skipAsyncValidation	boolean	Whether to skip validation on a change made from the UI.
type*required	"UNKNOWN" | "CUSTOM_VALIDATOR_REF" | "GREATER_THAN" | "GREATER_THAN_OR_EQUAL" | "LESS_THAN" | "LESS_THAN_OR_EQUAL" | "PROPERTY_COUNT_RANGE" | "SECRET_RESUBMISSION"	The type of the constraint.

ConfigurationMetadata

Metadata useful for debugging

Name	Type	Description
clusterVersion	string	Dynatrace version.
configurationVersions	Array<number>	A sorted list of the version numbers of the configuration.
currentConfigurationVersions	Array<string>	A sorted list of version numbers of the configuration.

Constraint

A constraint on the values accepted for a settings property.

Name	Type	Description
customMessage	string	A custom message for invalid values.
customValidatorId	string	The ID of a custom validator.
disallowDangerousRegex	boolean	Whether to disallow usage of dangerous regexes
maxLength	number	The maximum allowed length of string values.
maximum	number	The maximum allowed value.
minLength	number	The minimum required length of string values.
minimum	number	The minimum allowed value.
pattern	string	The regular expression pattern for valid string values.
skipAsyncValidation	boolean	Whether to skip validation on a change made from the UI.
type*required	"UNKNOWN" | "CUSTOM_VALIDATOR_REF" | "LENGTH" | "NOT_BLANK" | "NOT_EMPTY" | "NO_WHITESPACE" | "PATTERN" | "RANGE" | "REGEX" | "TRIMMED" | "UNIQUE"	The type of the constraint.
uniqueProperties	Array<string>	A list of properties for which the combination of values must be unique.

ConstraintViolation

A list of constraint violations

Name	Type
location	string
message	string
parameterLocation	"HEADER" | "PATH" | "PAYLOAD_BODY" | "QUERY"
path	string

CredentialAccessData

The set of entities allowed to use the credential.

Name	Type
id	string
type	"UNKNOWN" | "APPLICATION" | "USER"

CredentialUsageHandler

Keeps information about credential's usage.

Name	Type	Description
count	number	The number of uses.
type	string	Type of usage.

Credentials

A set of credentials for synthetic monitors.

The actual set of fields depends on the type of credentials. Find the list of actual objects in the description of the type field or see Credential vault API - JSON models.

Name	Type	Description
allowContextlessRequests	boolean	Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope).
allowedEntities	Array<CredentialAccessData>	The set of entities allowed to use the credential.
description	string	A short description of the credentials set.
id	string	The ID of the credentials set.
name*required	string	The name of the credentials set.
ownerAccessOnly	boolean	The credentials set is available to every user (false) or to owner only (true).
scopeDEPRECATED	"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"	The scope of the credentials set.
scopes*required	Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">	The set of scopes of the credentials set. Limitations: CredentialsScope.APP_ENGINE is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.
type*required	"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"	Defines the actual set of fields depending on the value. See one of the following objects: CERTIFICATE -> CertificateCredentials PUBLIC_CERTIFICATE -> PublicCertificateCredentials USERNAME_PASSWORD -> UserPasswordCredentials TOKEN -> TokenCredentials SNMPV3 -> SNMPV3Credentials AWS_MONITORING_KEY_BASED -> AWSKeyBasedCredentialsDto AWS_MONITORING_ROLE_BASED -> AWSRoleBasedCredentials

CredentialsDetailsCertificateResponseElement

Details of certificate credentials set.

Name	Type	Description
certificate	string	Base64 encoded certificate bytes
certificateType	string	Certificate type: PEM, PKCS12 or UNKNOWN
credentialUsageSummary*required	Array<CredentialUsageHandler>	The list contains summary data related to the use of credentials.
description*required	string	A short description of the credentials set.
externalVault	ExternalVaultConfig	Configuration for external vault synchronization for username and password credentials.
id	string	The ID of the credentials set.
name*required	string	The name of the credentials set.
owner*required	string	The owner of the credential (user for which used API token was created).
ownerAccessOnly*required	boolean	Flag indicating that this credential is visible only to the owner.
password	string	Base64 encoded password
scope	"ALL" | "EXTENSION" | "SYNTHETIC" | "UNKNOWN"	The scope of the credentials set.
type*required	"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD"	Defines the actual set of fields depending on the value. See one of the following objects: USERNAME_PASSWORD -> CredentialsDetailsUsernamePasswordResponseElement CERTIFICATE -> CredentialsDetailsCertificateResponseElement TOKEN -> CredentialsDetailsTokenResponseElement PUBLIC_CERTIFICATE -> CredentialsDetailsCertificateResponseElement

CredentialsDetailsTokenResponseElement

Details of the token credentials set.

Name	Type	Description
credentialUsageSummary*required	Array<CredentialUsageHandler>	The list contains summary data related to the use of credentials.
description*required	string	A short description of the credentials set.
externalVault	ExternalVaultConfig	Configuration for external vault synchronization for username and password credentials.
id	string	The ID of the credentials set.
name*required	string	The name of the credentials set.
owner*required	string	The owner of the credential (user for which used API token was created).
ownerAccessOnly*required	boolean	Flag indicating that this credential is visible only to the owner.
scope	"ALL" | "EXTENSION" | "SYNTHETIC" | "UNKNOWN"	The scope of the credentials set.
token	string	Plain text token value
type*required	"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD"	Defines the actual set of fields depending on the value. See one of the following objects: USERNAME_PASSWORD -> CredentialsDetailsUsernamePasswordResponseElement CERTIFICATE -> CredentialsDetailsCertificateResponseElement TOKEN -> CredentialsDetailsTokenResponseElement PUBLIC_CERTIFICATE -> CredentialsDetailsCertificateResponseElement

CredentialsDetailsUsernamePasswordResponseElement

Details of username and password credentials set.

Name	Type	Description
credentialUsageSummary*required	Array<CredentialUsageHandler>	The list contains summary data related to the use of credentials.
description*required	string	A short description of the credentials set.
externalVault	ExternalVaultConfig	Configuration for external vault synchronization for username and password credentials.
id	string	The ID of the credentials set.
name*required	string	The name of the credentials set.
owner*required	string	The owner of the credential (user for which used API token was created).
ownerAccessOnly*required	boolean	Flag indicating that this credential is visible only to the owner.
password	string	Plain text password value
scope	"ALL" | "EXTENSION" | "SYNTHETIC" | "UNKNOWN"	The scope of the credentials set.
type*required	"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD"	Defines the actual set of fields depending on the value. See one of the following objects: USERNAME_PASSWORD -> CredentialsDetailsUsernamePasswordResponseElement CERTIFICATE -> CredentialsDetailsCertificateResponseElement TOKEN -> CredentialsDetailsTokenResponseElement PUBLIC_CERTIFICATE -> CredentialsDetailsCertificateResponseElement
username	string	Plain text username value

CredentialsId

A short representation of the credentials set.

Name	Type	Description
id*required	string	The ID of the credentials set.

CredentialsList

A list of credentials sets for Synthetic monitors.

Name	Type	Description
credentials*required	Array<CredentialsResponseElement>	A list of credentials sets for Synthetic monitors.
nextPageKey	string
pageSize	number
totalCount	number

CredentialsResponseElement

Metadata of the credentials set.

Name	Type	Description
allowContextlessRequests	boolean	Allow access without app context, for example, from ad hoc functions in Workflows (requires the APP_ENGINE scope).
allowedEntities*required	Array<CredentialAccessData>	The set of entities allowed to use the credential.
credentialUsageSummary*required	Array<CredentialUsageHandler>	The list contains summary data related to the use of credentials.
description*required	string	A short description of the credentials set.
externalVault	ExternalVaultConfig	Configuration for external vault synchronization for username and password credentials.
id	string	The ID of the credentials set.
name*required	string	The name of the credentials set.
owner*required	string	The owner of the credential (user for which used API token was created).
ownerAccessOnly*required	boolean	Flag indicating that this credential is visible only to the owner.
scope	"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"	The scope of the credentials set.
scopes	Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">	The set of scopes of the credentials set.
type*required	"UNKNOWN" | "CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"	The type of the credentials set.

CustomApplicationImpact

Analysis of problem impact to a custom application.

Name	Type	Description
estimatedAffectedUsers*required	number	The estimated number of affected users.
impactType*required	"APPLICATION" | "CUSTOM_APPLICATION" | "MOBILE" | "SERVICE"	Defines the actual set of fields depending on the value. See one of the following objects: SERVICE -> ServiceImpact APPLICATION -> ApplicationImpact MOBILE -> MobileImpact CUSTOM_APPLICATION -> CustomApplicationImpact
impactedEntity*required	EntityStub	A short representation of a monitored entity.

CustomDeviceCreation

Configuration of a custom device.

Name	Type	Description
configUrl	string	The URL of a configuration web page for the custom device, such as a login page for a firewall or router.
customDeviceId*required	string	The internal ID of the custom device. If you use the ID of an existing device, the respective parameters will be updated.
displayName*required	string	The name of the custom device to be displayed in the user interface.
dnsNames	Array<string>	The list of DNS names related to the custom device. These names are used to automatically discover the horizontal communication relationship between this component and all other observed components within Smartscape. Once a connection is discovered, it is automatically mapped and shown within Smartscape. Non-public DNS addresses can also be mapped internally. This is applicable only if the domain name consists of at least two parts, for example hostname.xyz. If you send a value, the existing values will be overwritten. If you send null or an empty value; or omit this field, the existing values will be kept.
faviconUrl	string	The icon to be displayed for your custom component within Smartscape. Provide the full URL of the icon file.
group	string	User defined group ID of entity. The group ID helps to keep a consistent picture of device-group relations. One of many cases where a proper group is important is service detection: you can define which custom devices should lead to the same service by defining the same group ID for them. If you set a group ID, it will be hashed into the Dynatrace entity ID of the custom device. In that case the custom device can only be part of one custom device group. If you don't set the group ID, Dynatrace will create it based on the ID or type of the custom device. Also, the group will not be hashed into the device ID which means the device may switch groups.
ipAddresses	Array<string>	The list of IP addresses that belong to the custom device. These addresses are used to automatically discover the horizontal communication relationship between this component and all other observed components within Smartscape. Once a connection is discovered, it is automatically mapped and shown within Smartscape. If you send a value (including an empty value), the existing values will be overwritten. If you send null or omit this field, the existing values will be kept.
listenPorts	Array<number>	The list of ports the custom devices listens to. These ports are used to discover the horizontal communication relationship between this component and all other observed components within Smartscape. Once a connection is discovered, it is automatically mapped and shown within Smartscape. If ports are specified, you should also add at least one IP address or a DNS name for the custom device. If you send a value, the existing values will be overwritten. If you send null, or an empty value, or omit this field, the existing values will be kept.
properties	CustomDeviceCreationProperties	The list of key-value pair properties that will be shown beneath the infographics of your custom device.
type	string	The technology type definition of the custom device. It must be the same technology type of the metric you're reporting. If you send a value, the existing value will be overwritten. If you send null, empty or omit this field, the existing value will be kept.

CustomDeviceCreationProperties

The list of key-value pair properties that will be shown beneath the infographics of your custom device.

type: Record<string, string | undefined>

CustomDeviceCreationResult

The short representation of a newly created custom device.

Name	Type	Description
entityId	string	The Dynatrace entity ID of the custom device.
groupId	string	The Dynatrace entity ID of the custom device group.

CustomEntityTags

A list of custom tags.

Name	Type	Description
tags*required	Array<METag>	A list of custom tags.
totalCount	number	The total number of tags in the response.

CustomLogLine

A custom script log line

Name	Type	Description
logLevel	string	Log level of the message
message	string	The message
timestamp	number	A timestamp of this log message

CyberArkAllowedLocationConfig

Configuration for external vault synchronization for username and password credentials.

Name	Type	Description
accountName	string
applicationId	string
certificate	string
credentialsUsedForExternalSynchronization	Array<string>
folderName	string
passwordSecretName	string
safeName	string
sourceAuthMethod	"AZURE_KEY_VAULT_CLIENT_SECRET" | "CYBERARK_VAULT_ALLOWED_LOCATION" | "CYBERARK_VAULT_USERNAME_PASSWORD" | "HASHICORP_VAULT_APPROLE" | "HASHICORP_VAULT_CERTIFICATE"	Defines the actual set of fields depending on the value. See one of the following objects: HASHICORP_VAULT_APPROLE -> HashicorpApproleConfig HASHICORP_VAULT_CERTIFICATE -> HashicorpCertificateConfig AZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecretConfig CYBERARK_VAULT_USERNAME_PASSWORD -> CyberArkUsernamePasswordConfig CYBERARK_VAULT_ALLOWED_LOCATION -> CyberArkAllowedLocationConfig
tokenSecretName	string
type	"AZURE_CERTIFICATE_MODEL" | "AZURE_CLIENT_SECRET_MODEL" | "CYBERARK_VAULT_ALLOWED_LOCATION_MODEL" | "CYBERARK_VAULT_USERNAME_PASSWORD_MODEL" | "HASHICORP_APPROLE_MODEL" | "HASHICORP_CERTIFICATE_MODEL"
usernameSecretName	string
vaultUrl	string

CyberArkAllowedLocationDto

Synchronization credentials with CyberArk Vault using allowed machines (location) authentication method.

Name	Type	Description
accountName	string	Account name that stores the username and password to retrieve and synchronize with the Dynatrace Credential Vault: This is NOT the name of the account logged into the CyberArk Central Credential Provider.
applicationId	string	Application ID connected to CyberArk Vault.
certificate	string	[Recommended] Certificate used for authentication to CyberArk application. ID of certificate credential saved in Dynatrace CV.
folderName	string	[Optional] Folder name where credentials in CyberArk Vault are stored. Default folder name is 'Root'.
locationForSynchronizationId	string	Id of a location used by the synchronizing monitor
passwordSecretName	string	The name of the secret saved in external vault where password is stored.
safeName	string	Safe name connected to CyberArk Vault.
sourceAuthMethod	"AZURE_KEY_VAULT_CLIENT_SECRET" | "CYBERARK_VAULT_ALLOWED_LOCATION" | "CYBERARK_VAULT_USERNAME_PASSWORD" | "HASHICORP_VAULT_APPROLE" | "HASHICORP_VAULT_CERTIFICATE"	Defines the actual set of fields depending on the value. See one of the following objects: HASHICORP_VAULT_APPROLE -> HashicorpApprole HASHICORP_VAULT_CERTIFICATE -> HashicorpCertificate AZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecret CYBERARK_VAULT_USERNAME_PASSWORD -> CyberArkUsernamePassword CYBERARK_VAULT_ALLOWED_LOCATION -> CyberArkAllowedLocationDto
tokenSecretName	string	The name of the secret saved in external vault where token is stored.
usernameSecretName	string	The name of the secret saved in external vault where username is stored.
vaultUrl	string	External vault URL.

CyberArkUsernamePassword

Synchronization credentials with CyberArk Vault using username password authentication method.

Name	Type	Description
accountName	string	Account name that stores the username and password to retrieve and synchronize with the Dynatrace Credential Vault: This is NOT the name of the account logged into the CyberArk Central Credential Provider.
applicationId	string	Application ID connected to CyberArk Vault.
certificate	string	[Recommended] Certificate used for authentication to CyberArk application. ID of certificate credential saved in Dynatrace CV.
folderName	string	[Optional] Folder name where credentials in CyberArk Vault are stored. Default folder name is 'Root'.
locationForSynchronizationId	string	Id of a location used by the synchronizing monitor
passwordSecretName	string	The name of the secret saved in external vault where password is stored.
safeName	string	Safe name connected to CyberArk Vault.
sourceAuthMethod	"AZURE_KEY_VAULT_CLIENT_SECRET" | "CYBERARK_VAULT_ALLOWED_LOCATION" | "CYBERARK_VAULT_USERNAME_PASSWORD" | "HASHICORP_VAULT_APPROLE" | "HASHICORP_VAULT_CERTIFICATE"	Defines the actual set of fields depending on the value. See one of the following objects: HASHICORP_VAULT_APPROLE -> HashicorpApprole HASHICORP_VAULT_CERTIFICATE -> HashicorpCertificate AZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecret CYBERARK_VAULT_USERNAME_PASSWORD -> CyberArkUsernamePassword CYBERARK_VAULT_ALLOWED_LOCATION -> CyberArkAllowedLocationDto
tokenSecretName	string	The name of the secret saved in external vault where token is stored.
usernamePasswordForCPM	string	Dynatrace credential ID of the username-password pair used for authentication to the CyberArk Central Credential Provider
usernameSecretName	string	The name of the secret saved in external vault where username is stored.
vaultUrl	string	External vault URL.

CyberArkUsernamePasswordConfig

Configuration for external vault synchronization for username and password credentials.

Name	Type	Description
accountName	string
applicationId	string
certificate	string
credentialsUsedForExternalSynchronization	Array<string>
folderName	string
passwordSecretName	string
safeName	string
sourceAuthMethod	"AZURE_KEY_VAULT_CLIENT_SECRET" | "CYBERARK_VAULT_ALLOWED_LOCATION" | "CYBERARK_VAULT_USERNAME_PASSWORD" | "HASHICORP_VAULT_APPROLE" | "HASHICORP_VAULT_CERTIFICATE"	Defines the actual set of fields depending on the value. See one of the following objects: HASHICORP_VAULT_APPROLE -> HashicorpApproleConfig HASHICORP_VAULT_CERTIFICATE -> HashicorpCertificateConfig AZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecretConfig CYBERARK_VAULT_USERNAME_PASSWORD -> CyberArkUsernamePasswordConfig CYBERARK_VAULT_ALLOWED_LOCATION -> CyberArkAllowedLocationConfig
tokenSecretName	string
type	"AZURE_CERTIFICATE_MODEL" | "AZURE_CLIENT_SECRET_MODEL" | "CYBERARK_VAULT_ALLOWED_LOCATION_MODEL" | "CYBERARK_VAULT_USERNAME_PASSWORD_MODEL" | "HASHICORP_APPROLE_MODEL" | "HASHICORP_CERTIFICATE_MODEL"
usernamePasswordForCPM	string
usernameSecretName	string
vaultUrl	string

DatasourceDefinition

Configuration of a datasource for a property.

Name	Type	Description
filterProperties*required	Array<string>	The properties to filter the datasource options on.
fullContext*required	boolean	Whether this datasource expects full setting payload as the context.
identifier*required	string	The identifier of a custom data source of the property's value.
resetValue	"ALWAYS" | "INVALID_ONLY" | "NEVER"	When to reset datasource value in the UI on filter change.
useApiSearch*required	boolean	If true, the datasource should use the api to filter the results instead of client-side filtering.
validate*required	boolean	Whether to validate input to only allow values returned by the datasource.

DavisSecurityAdvice

Security advice from the Davis security advisor.

Name	Type	Description
adviceType	"UPGRADE"	The type of the advice.
critical	Array<string>	IDs of critical level security problems caused by vulnerable component.
high	Array<string>	IDs of high level security problems caused by vulnerable component.
low	Array<string>	IDs of low level security problems caused by vulnerable component.
medium	Array<string>	IDs of medium level security problems caused by vulnerable component.
name	string	The name of the advice.
none	Array<string>	IDs of none level security problems caused by vulnerable component.
technology	"KUBERNETES" | "DOTNET" | "GO" | "JAVA" | "NODE_JS" | "PHP" | "PYTHON"	The technology of the vulnerable component.
vulnerableComponent	string	The vulnerable component to which advice applies.

DavisSecurityAdviceList

A list of advice from the Davis security advisor.

Name	Type	Description
advices	Array<DavisSecurityAdvice>
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

DeletedEntityTags

Deleted custom tag.

Name	Type	Description
matchedEntitiesCount	number	The number of monitored entities where the tag has been deleted.

DeletionConstraint

A constraint on the values that are going to be deleted.

Name	Type	Description
customMessage	string	A custom message for invalid values.
customValidatorId	string	The ID of a custom validator.
schemaIds	Array<string>
type*required	"UNKNOWN" | "CUSTOM_VALIDATOR_REF" | "REFERENTIAL_INTEGRITY"	The type of the deletion constraint.

EffectivePermission

Name	Type	Description
context	PermissionContext	Optional context data
granted*required	"condition" | "false" | "true"
permission*required	string

EffectiveSettingsValue

An effective settings value.

Name	Type	Description
author	string	The user (identified by a user ID or a public token ID) who performed that most recent modification.
created	number	The timestamp of the creation.
externalId	string	The external identifier of the settings object.
modified	number	The timestamp of the last modification.
origin	string	The origin of the settings value.
schemaId	string	The schema on which the object is based.
schemaVersion	string	The version of the schema on which the object is based.
searchSummary	string	A searchable summary string of the setting value. Plain text without Markdown.
summary	string	A short summary of settings. This can contain Markdown and will be escaped accordingly.
value	AnyValue	The value of the setting. It defines the actual values of settings' parameters. The actual content depends on the object's schema.

EffectiveSettingsValuesList

A list of effective settings values.

Name	Type	Description
items*required	Array<EffectiveSettingsValue>	A list of effective settings values.
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize*required	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

EntitiesList

A list of monitored entities along with their properties.

Name	Type	Description
entities	Array<Entity>	A list of monitored entities.
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

Entity

The properties of a monitored entity.

Name	Type	Description
displayName	string	The name of the entity, displayed in the UI.
entityId	string	The ID of the entity.
firstSeenTms	number	The timestamp at which the entity was first seen, in UTC milliseconds.
fromRelationships	EntityFromRelationships	A list of relationships where the entity occupies the FROM position.
icon	EntityIcon	The icon of a monitored entity.
lastSeenTms	number	The timestamp at which the entity was last seen, in UTC milliseconds.
managementZones	Array<ManagementZone>	A set of management zones to which the entity belongs.
properties	EntityProperties	A list of additional properties of the entity.
tags	Array<METag>	A set of tags assigned to the entity.
toRelationships	EntityToRelationships	A list of relationships where the entity occupies the TO position.
type	string	The type of the entity.

EntityFromRelationships

A list of relationships where the entity occupies the FROM position.

type: Record<string, EntityId[] | undefined>

EntityIcon

The icon of a monitored entity.

Name	Type	Description
customIconPath	string	The user-defined icon of the entity. Specify the barista ID of the icon or a URL of your own icon.
primaryIconType	string	The primary icon of the entity. Specified by the barista ID of the icon.
secondaryIconType	string	The secondary icon of the entity. Specified by the barista ID of the icon.

EntityId

A short representation of a monitored entity.

Name	Type	Description
id	string	The ID of the entity.
type	string	The type of the entity.

EntityProperties

A list of additional properties of the entity.

type: Record<string, any>

EntityShortRepresentation

The short representation of a Dynatrace entity.

Name	Type	Description
description	string	A short description of the Dynatrace entity.
id*required	string	The ID of the Dynatrace entity.
name	string	The name of the Dynatrace entity.

EntityStub

A short representation of a monitored entity.

Name	Type	Description
entityId	EntityId	A short representation of a monitored entity.
name	string	The name of the entity. Not included in the response in case no entity with the relevant ID was found.

EntityToRelationships

A list of relationships where the entity occupies the TO position.

type: Record<string, EntityId[] | undefined>

EntityType

A list of properties of the monitored entity type.

Name	Type	Description
dimensionKey	string	The dimension key used within metrics for this monitored entity.
displayName	string	The display name of the monitored entity.
entityLimitExceeded	boolean	Whether the entity creation limit for the given type has been exceeded
fromRelationships	Array<ToPosition>	A list of possible relationships where the monitored entity type occupies the FROM position
managementZones	string	The placeholder for the list of management zones of an actual entity.
properties	Array<EntityTypePropertyDto>	A list of additional properties of the monitored entity type.
tags	string	The placeholder for the list of tags of an actual entity.
toRelationships	Array<FromPosition>	A list of possible relationships where the monitored entity type occupies the TO position.
type	string	The type of the monitored entity.

EntityTypeList

A list of properties of all available entity types.

Name	Type	Description
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.
types	Array<EntityType>	The list of meta information for all available entity-types

EntityTypePropertyDto

The property of a monitored entity.

Name	Type	Description
displayName	string	The display-name of the property.
id	string	The ID of the property.
type	string	The type of the property.

EntryPoint

Information about an entry point of a code-level vulnerability.

Name	Type	Description
sourceHttpPath	string	Source HTTP path of entry points.
usageSegments	Array<EntryPointUsageSegment>	List of entry point usage segments.

EntryPointUsageSegment

Describes one segment that was passed into a usage and the associated source name and type.

Name	Type	Description
segmentType	"MALICIOUS_INPUT" | "REGULAR_INPUT" | "TAINTED_INPUT"	The type of this input segment.
segmentValue	string	The value of this input segment.
sourceArgumentName	string	The name used in the source for this segment.
sourceType	"UNKNOWN" | "HTTP_BODY" | "HTTP_COOKIE" | "HTTP_HEADER_NAME" | "HTTP_HEADER_VALUE" | "HTTP_OTHER" | "HTTP_PARAMETER_NAME" | "HTTP_PARAMETER_VALUE" | "HTTP_URL"	The type of the HTTP request part that contains the value that was used in this segment.

EntryPoints

A list of entry points and a flag which indicates whether this list was truncated or not.

Name	Type	Description
items	Array<EntryPoint>	A list of entry points.
truncated	boolean	Indicates whether the list of entry points was truncated or not.

EntrypointPayload

Describes a payload sent to an entrypoint during an attack.

Name	Type	Description
name	null | string	Name of the payload, if applicable.
type	"UNKNOWN" | "HTTP_BODY" | "HTTP_COOKIE" | "HTTP_HEADER_NAME" | "HTTP_HEADER_VALUE" | "HTTP_OTHER" | "HTTP_PARAMETER_NAME" | "HTTP_PARAMETER_VALUE" | "HTTP_URL"	Type of the payload.
value	string	Value of the payload.

EnumType

Definition of an enum property.

Name	Type	Description
description*required	string	A short description of the property.
displayName	string	The display name of the property.
documentation*required	string	An extended description and/or links to documentation.
enumClass	string	An existing Java enum class that holds the allowed values of the enum.
items*required	Array<EnumValue>	A list of allowed values of the enum.
type*required	"enum"	The type of the property.

EnumValue

An allowed value for an enum property.

Name	Type	Description
description	string	A short description of the value.
displayName*required	string	The display name of the value.
enumInstance	string	The name of the value in an existing Java enum class.
icon	string	The icon of the value.
value*required	AnyValue	The allowed value of the enum.

Error

Name	Type	Description
code	number	The HTTP status code
constraintViolations	Array<ConstraintViolation>	A list of constraint violations
message	string	The error message

ErrorEnvelope

Name	Type
error	Error

Event

Configuration of an event.

Name	Type	Description
correlationId	string	The correlation ID of the event.
endTime	number	The timestamp when the event was closed, in UTC milliseconds. Has the value of null if the event is still active.
entityId	EntityStub	A short representation of a monitored entity.
entityTags	Array<METag>	A list of tags of the related entity.
eventId	string	The ID of the event.
eventType	string	The type of the event.
frequentEvent	boolean	If true, the event happens frequently. A frequent event doesn't raise a problem.
managementZones	Array<ManagementZone>	A list of all management zones that the event belongs to.
properties	Array<EventProperty>	A list of event properties.
startTime	number	The timestamp when the event was raised, in UTC milliseconds.
status	"CLOSED" | "OPEN"	The status of the event.
suppressAlert	boolean	The alerting status during a maintenance: false: Alerting works as usual. true: Alerting is disabled.
suppressProblem	boolean	The problem detection status during a maintenance: false: Problem detection works as usual. true: Problem detection is disabled.
title	string	The title of the event.
underMaintenance	boolean	If true, the event happened while the monitored system was under maintenance.

EventEvidence

The event evidence of the problem.

An event that occurred during the problem lifespan that might be related to the root cause.

Name	Type	Description
data	Event	Configuration of an event.
displayName*required	string	The display name of the evidence.
endTime	number	The end timestamp of the event, in UTC milliseconds. Has -1 value, if the event is still active.
entity*required	EntityStub	A short representation of a monitored entity.
eventId	string	The ID of the event.
eventType	string	The type of the event.
evidenceType*required	"AVAILABILITY_EVIDENCE" | "EVENT" | "MAINTENANCE_WINDOW" | "METRIC" | "TRANSACTIONAL"	Defines the actual set of fields depending on the value. See one of the following objects: EVENT -> EventEvidence METRIC -> MetricEvidence TRANSACTIONAL -> TransactionalEvidence MAINTENANCE_WINDOW -> MaintenanceWindowEvidence AVAILABILITY_EVIDENCE -> AvailabilityEvidence
groupingEntity	EntityStub	A short representation of a monitored entity.
rootCauseRelevant*required	boolean	The evidence is (true) or is not (false) a part of the root cause.
startTime*required	number	The start time of the evidence, in UTC milliseconds.

EventIngest

The configuration of an event to be ingested.

Name	Type	Description
endTime	number	The end time of the event, in UTC milliseconds. If not set, the start time plus timeout is used.
entitySelector	string	The entity selector, defining a set of Dynatrace entities to be associated with the event. Only entities that have been active within the last 24 hours can be selected. If not set, the event is associated with the environment (dt.entity.environment) entity.
eventType*required	"AVAILABILITY_EVENT" | "CUSTOM_ALERT" | "CUSTOM_ANNOTATION" | "CUSTOM_CONFIGURATION" | "CUSTOM_DEPLOYMENT" | "CUSTOM_INFO" | "ERROR_EVENT" | "MARKED_FOR_TERMINATION" | "PERFORMANCE_EVENT" | "RESOURCE_CONTENTION_EVENT"	The type of the event.
properties	EventIngestProperties	A map of event properties. To set event properties with predefined behavior, use classic dt.event.* and dt.davis.* properties. To check which properties belong to classic API, see Events API v2 - GET all event properties. To attach entity information to an event, use dt.entity.* keys. To provide additional info, you can use any key outside of the dt.* namespace. Values of event properties with predefined behavior must fulfill the requirements of the respective property. A maximum of 100 properties can be specified. A property key is allowed to contain up to 100 characters. A property value is allowed to contain up to 4096 characters.
startTime	number	The start time of the event, in UTC milliseconds. If not set, the current timestamp is used. Depending on the event type, the start time must not lie in the past more than 6 hours for problem-opening events and 30 days for info events. Depending on the event type, the start time must not lie in the future more than 5 minutes for problem-opening events and 7 days for info events. Events that can be sent up to 7 days in the future: CUSTOM_ANNOTATION CUSTOM_CONFIGURATION CUSTOM_DEPLOYMENT CUSTOM_INFO MARKED_FOR_TERMINATION
timeout	number	The timeout of the event, in minutes. If not set, 15 is used. The timeout will automatically be capped to a maximum of 360 minutes (6 hours). Problem-opening events can be refreshed and therefore kept open by sending the same payload again.
title*required	string	The title of the event.

EventIngestProperties

A map of event properties.

• To set event properties with predefined behavior, use classic dt.event.* and dt.davis.* properties. To check which properties belong to classic API, see Events API v2 - GET all event properties.
• To attach entity information to an event, use dt.entity.* keys.
• To provide additional info, you can use any key outside of the dt.* namespace.

Values of event properties with predefined behavior must fulfill the requirements of the respective property.

A maximum of 100 properties can be specified. A property key is allowed to contain up to 100 characters. A property value is allowed to contain up to 4096 characters.

type: Record<string, string | undefined>

EventIngestResult

The result of a created event report.

Name	Type	Description
correlationId	string	The correlation ID of the created event.
status	"INVALID_ENTITY_TYPE" | "INVALID_METADATA" | "INVALID_TIMESTAMPS" | "OK"	The status of the ingestion.

EventIngestResults

The results of an event ingest.

Name	Type	Description
eventIngestResults	Array<EventIngestResult>	The result of each created event report.
reportCount	number	The number of created event reports.

EventList

A list of events.

Name	Type	Description
events	Array<Event>	A list of events.
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.
warnings	Array<string>	A list of warnings.

EventPropertiesList

A list of event properties.

Name	Type	Description
eventProperties	Array<EventPropertyDetails>	A list of event properties.
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

EventProperty

A property of an event.

Name	Type	Description
key	string	The key of the event property.
value	string	The value of the event property.

EventPropertyDetails

Configuration of an event property.

Name	Type	Description
description	string	A short description of the event property.
displayName	string	The display name of the event property.
filterable	boolean	The property can (true) or cannot (false) be used for filtering in the event selector. Usage in event selector: property.<key>("value-1", "value-2")
key	string	The key of the event property.
writable	boolean	The property can (true) or cannot (false) be set during event ingestion.

EventType

Configuration of an event type.

Name	Type	Description
description	string	A short description of the event type.
displayName	string	The display name of the event type.
severityLevel	"CUSTOM_ALERT" | "AVAILABILITY" | "ERROR" | "INFO" | "MONITORING_UNAVAILABLE" | "PERFORMANCE" | "RESOURCE_CONTENTION"	The severity level associated with the event type.
type	string	The event type.

EventTypeList

A list of event types.

Name	Type	Description
eventTypeInfos	Array<EventType>	A list of event types.
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

Evidence

An evidence of a root cause.

The actual set of fields depends on the type of the evidence. Find the list of actual objects in the description of the evidenceType field or see Problems API v2 - JSON models.

Name	Type	Description
displayName*required	string	The display name of the evidence.
entity*required	EntityStub	A short representation of a monitored entity.
evidenceType*required	"AVAILABILITY_EVIDENCE" | "EVENT" | "MAINTENANCE_WINDOW" | "METRIC" | "TRANSACTIONAL"	Defines the actual set of fields depending on the value. See one of the following objects: EVENT -> EventEvidence METRIC -> MetricEvidence TRANSACTIONAL -> TransactionalEvidence MAINTENANCE_WINDOW -> MaintenanceWindowEvidence AVAILABILITY_EVIDENCE -> AvailabilityEvidence
groupingEntity	EntityStub	A short representation of a monitored entity.
rootCauseRelevant*required	boolean	The evidence is (true) or is not (false) a part of the root cause.
startTime*required	number	The start time of the evidence, in UTC milliseconds.

EvidenceDetails

The evidence details of a problem.

Name	Type	Description
details*required	Array<Evidence>	A list of all evidence.
totalCount*required	number	The total number of evidence of a problem.

ExecuteActionsDto

Name	Type	Description
actions	ExecuteActionsDtoActions	Data Source defined action objects

ExecuteActionsDtoActions

Data Source defined action objects

type: Record<string, JsonNode | undefined>

ExecuteActionsResponse

Name	Type	Description
agId	string	Active Gate id for actions execution
agName	string	Active Gate name for actions execution

ExecutionFullResults

Contains extended monitor's execution details.

Name	Type	Description
errorCode	string	Error code.
executionStepCount	number	Number executed steps.
executionSteps	Array<ExecutionStep>	Details about the monitor's step execution.
failedStepName	string	Failed step name.
failedStepSequenceId	number	Failed step sequence id.
failureMessage	string	Failure message.
status	string	Execution status.

ExecutionSimpleResults

Contains basic results of the monitor's on-demand execution.

Name	Type	Description
chromeError	boolean	Informs whether is Chrome error.
engineId	number	Synthetic engine id on which monitor was executed.
errorCode	string	Error code.
executedSteps	number	Number of the executed steps by Synthetic engine
failureMessage	string	Failure message.
hostNameResolutionTime	number	A hostname resolution time measured in milliseconds.
httperror	boolean	Informs whether is HTTP error.
peerCertificateExpiryDateDEPRECATED	number	An expiry date of the first SSL certificate from the certificate chain.
publicLocation	boolean	Flag informs whether request was executed on public location.
redirectionTime	number	Total number of milliseconds spent on handling all redirect requests, measured in milliseconds.
redirectsCount	number	Number of redirects.
responseBodySizeLimitExceeded	boolean	A flag indicating that the response payload size limit of 10MB has been exceeded.
responseSize	number	Request's response size in bytes.
responseStatusCode	number	Response status code.
startTimestamp	number	Start timestamp.
status	string	Execution status.
tcpConnectTime	number	A TCP connect time measured in milliseconds.
timeToFirstByte	number	A time to first byte measured in milliseconds.
tlsHandshakeTime	number	A TLS handshake time measured in milliseconds.
totalTime	number	A total time measured in milliseconds.

ExecutionStep

Contains detailed information about the monitor's step execution.

Name	Type	Description
monitorType*required	"BROWSER" | "HTTP"	Defines the actual set of fields depending on the value. See one of the following objects: BROWSER -> BMAction HTTP -> MonitorRequestExecutionResult

ExportedLogRecordList

A list of exported log records.

Name	Type	Description
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
results	Array<LogRecord>	A list of retrieved log records.
totalCount*required	number	The total number of entries in the result.
warnings	string	Optional warning messages.

Extension

Name	Type	Description
author*required	AuthorDto	Extension author
dataSources*required	Array<string>	Data sources that extension uses to gather data
extensionName*required	string	Extension name
featureSets*required	Array<string>	Available feature sets
featureSetsDetails*required	ExtensionFeatureSetsDetails	Details of feature sets
fileHash*required	string	SHA-256 hash of uploaded Extension file
minDynatraceVersion*required	string	Minimal Dynatrace version that works with the extension
minEECVersion*required	string	Minimal Extension Execution Controller version that works with the extension
variables*required	Array<string>	Custom variables used in extension configuration
version*required	string	Extension version Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

ExtensionAssetsDto

List of assets imported with the active extension environment configuration.

Name	Type	Description
assets*required	Array<AssetInfoDto>	The list of the imported assets.
errors*required	Array<string>	List of errors during asset import
status*required	string	The status of the assets list.
version*required	string	Version of the active extension environment configuration. Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

ExtensionEnvironmentConfigurationVersion

Name	Type	Description
version*required	string	Extension version Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

ExtensionEventDto

A list of extension events.

Name	Type	Description
content	string	Content of the event
dt.active_gate.id	string	Hexadecimal ID of Active Gate that uses this monitoring configuration. Example: 0x1a2b3c4d
dt.entity.host	string	Host that uses this monitoring configuration. Example: HOST-ABCDEF0123456789
dt.extension.ds	string	Data source that uses this monitoring configuration. Example: snmp
severity	string	Severity of the event
status	"ERROR" | "INFO" | "NONE" | "WARN"	Status of the event
timestamp	string	Timestamp of the event

ExtensionEventsList

Name	Type	Description
extensionEvents	Array<ExtensionEventDto>	A list of extension events.

ExtensionFeatureSetsDetails

Details of feature sets

type: Record<string, FeatureSetDetails | undefined>

ExtensionInfo

A list of extensions with additional metadata.

Name	Type	Description
activeVersion	null | string	Active version in the environment (null if none is active) Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?
extensionName*required	string	Extension name
keywords*required	Array<string>	Extension keywords for the highest version
version*required	string	Highest installed version Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

ExtensionInfoList

Name	Type	Description
extensions*required	Array<ExtensionInfo>	A list of extensions with additional metadata.
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

ExtensionList

Name	Type	Description
extensions*required	Array<MinimalExtension>	A list of extensions.
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

ExtensionMonitoringConfiguration

Name	Type	Description
objectId*required	string	Configuration id
scope*required	string	Configuration scope
value*required	ExtensionMonitoringConfigurationValue	Configuration

ExtensionMonitoringConfigurationsList

Name	Type	Description
items*required	Array<ExtensionMonitoringConfiguration>	A list of extension monitoring configurations.
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

ExtensionStatusDto

Name	Type	Description
status*required	"UNKNOWN" | "OK" | "ERROR" | "PENDING" | "WARNING"	Latest status of given configuration.
timestamp	number	Timestamp of the latest status of given configuration.

ExtensionStatusWithIdDto

Name	Type	Description
configurationId*required	string	Unique ID of the configuration.
status*required	"UNKNOWN" | "OK" | "ERROR" | "PENDING" | "WARNING"	Latest status of given configuration.
timestamp	number	Timestamp of the latest status of given configuration.

ExtensionUploadResponseDto

Name	Type	Description
assetsInfo*required	Array<AssetInfo>	Information about extension assets included
author*required	AuthorDto	Extension author
dataSources*required	Array<string>	Data sources that extension uses to gather data
extensionName*required	string	Extension name
featureSets*required	Array<string>	Available feature sets
featureSetsDetails*required	ExtensionUploadResponseDtoFeatureSetsDetails	Details of feature sets
fileHash*required	string	SHA-256 hash of uploaded Extension file
minDynatraceVersion*required	string	Minimal Dynatrace version that works with the extension
minEECVersion*required	string	Minimal Extension Execution Controller version that works with the extension
variables*required	Array<string>	Custom variables used in extension configuration
version*required	string	Extension version Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

ExtensionUploadResponseDtoFeatureSetsDetails

Details of feature sets

type: Record<string, FeatureSetDetails | undefined>

ExternalVault

Information for synchronization credentials with external vault

Name	Type	Description
locationForSynchronizationId	string	Id of a location used by the synchronizing monitor
passwordSecretName	string	The name of the secret saved in external vault where password is stored.
sourceAuthMethod	"AZURE_KEY_VAULT_CLIENT_SECRET" | "CYBERARK_VAULT_ALLOWED_LOCATION" | "CYBERARK_VAULT_USERNAME_PASSWORD" | "HASHICORP_VAULT_APPROLE" | "HASHICORP_VAULT_CERTIFICATE"	Defines the actual set of fields depending on the value. See one of the following objects: HASHICORP_VAULT_APPROLE -> HashicorpApprole HASHICORP_VAULT_CERTIFICATE -> HashicorpCertificate AZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecret CYBERARK_VAULT_USERNAME_PASSWORD -> CyberArkUsernamePassword CYBERARK_VAULT_ALLOWED_LOCATION -> CyberArkAllowedLocationDto
tokenSecretName	string	The name of the secret saved in external vault where token is stored.
usernameSecretName	string	The name of the secret saved in external vault where username is stored.
vaultUrl	string	External vault URL.

ExternalVaultConfig

Configuration for external vault synchronization for username and password credentials.

Name	Type	Description
credentialsUsedForExternalSynchronization	Array<string>
passwordSecretName	string
sourceAuthMethod	"AZURE_KEY_VAULT_CLIENT_SECRET" | "CYBERARK_VAULT_ALLOWED_LOCATION" | "CYBERARK_VAULT_USERNAME_PASSWORD" | "HASHICORP_VAULT_APPROLE" | "HASHICORP_VAULT_CERTIFICATE"	Defines the actual set of fields depending on the value. See one of the following objects: HASHICORP_VAULT_APPROLE -> HashicorpApproleConfig HASHICORP_VAULT_CERTIFICATE -> HashicorpCertificateConfig AZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecretConfig CYBERARK_VAULT_USERNAME_PASSWORD -> CyberArkUsernamePasswordConfig CYBERARK_VAULT_ALLOWED_LOCATION -> CyberArkAllowedLocationConfig
tokenSecretName	string
type	"AZURE_CERTIFICATE_MODEL" | "AZURE_CLIENT_SECRET_MODEL" | "CYBERARK_VAULT_ALLOWED_LOCATION_MODEL" | "CYBERARK_VAULT_USERNAME_PASSWORD_MODEL" | "HASHICORP_APPROLE_MODEL" | "HASHICORP_CERTIFICATE_MODEL"
usernameSecretName	string
vaultUrl	string

FeatureSetDetails

Additional information about a Feature Set

Name	Type	Description
description	string	Optional description for the feature set
displayName	string	Optional display name of the feature set
isRecommended*required	boolean	Marks the feature set as recommended (selected by default during activation)
metrics	Array<MetricDto>	Feature set metrics

Filter

A dimensional or series filter on a metric.

Name	Type	Description
operands	Array<Filter>	If the type is not, and or or, then holds the contained filters.
referenceInvocation	Invocation	Invocation of a function, e.g. the entitySelector function.
referenceString	string	For filters that match a dimension against a valkue, such as eq or ne, holds the value to compare the dimension against.
referenceValue	number	For the operands of series filters that match against a number, holds the number to compare against.
rollup	Rollup	A way of viewing a series as a single value for the purpose of sorting or series-based filters.
targetDimension	string	If the type applies to a dimension, then holds the target dimension.
targetDimensions	Array<string>	If the type applies to n dimensions, then holds the target dimensions. Currently only used for the remainder filter.
type	"and" | "contains" | "eq" | "existsKey" | "ge" | "gt" | "in" | "le" | "lt" | "ne" | "not" | "or" | "otherwise" | "prefix" | "remainder" | "series" | "suffix"	Type of this filter, determines which other fields are present.Can be any of: eq, ne, prefix, in, remainder, suffix, contains, existsKey, series, or, and, not, ge, gt, le, lt, otherwise.

FilteredCountsDto

Statistics about the security problem, filtered by the management zone and timeframe start ('from') query parameters.

Name	Type	Description
affectedNodes	number	Number of affected nodes
affectedProcessGroupInstances	number	Number of affected processes
affectedProcessGroups	number	Number of affected process groups
exposedProcessGroups	number	Number of exposed process groups
reachableDataAssets	number	Number of reachable data assets
relatedApplications	number	Number of related applications
relatedAttacks	number	Number of related attacks
relatedDatabases	number	Number of related databases
relatedHosts	number	Number of related hosts
relatedKubernetesClusters	number	Number of related Kubernetes clusters
relatedKubernetesWorkloads	number	Number of related Kubernetes workloads
relatedServices	number	Number of related services
vulnerableComponents	number	Number of vulnerable components

FromPosition

The FROM position of a relationship.

Name	Type	Description
fromTypes	Array<string>	A list of monitored entity types that can occupy the FROM position.
id	string	The ID of the relationship.

FunctionDefinition

Information about a function definition.

Name	Type	Description
className	string	The fully qualified class name of the class that includes the function.
displayName	string	A human readable string representation of the function definition.
fileName	string	The file name of the function definition.
functionName	string	The function/method name of the function definition.
parameterTypes	TruncatableListString	A list of values that has possibly been truncated.
returnType	string	The return type of the function.

GlobalCountsDto

Globally calculated statistics about the security problem. No management zone information is taken into account.

Name	Type	Description
affectedNodes	number	Number of affected nodes
affectedProcessGroupInstances	number	Number of affected process group instances
affectedProcessGroups	number	Number of affected process groups
exposedProcessGroups	number	Number of exposed process groups
reachableDataAssets	number	Number of reachable data assets exposed
relatedApplications	number	Number of related applications
relatedAttacks	number	Number of attacks on the exposed security problem
relatedHosts	number	Number of related hosts
relatedKubernetesClusters	number	Number of related kubernetes cluster
relatedKubernetesWorkloads	number	Number of related kubernetes workloads
relatedServices	number	Number of related services
vulnerableComponents	number	Number of vulnerable components

HashicorpApprole

Synchronization credentials with HashiCorp Vault using appRole authentication method

Name	Type	Description
locationForSynchronizationId	string	Id of a location used by the synchronizing monitor
passwordSecretName	string	The name of the secret saved in external vault where password is stored.
pathToCredentials	string	Path to folder where credentials in HashiCorp Vault are stored.
roleId	string	Role ID is similar to username when you want to authenticate in HashiCorp Vault using AppRole.
secretId	string	Secret ID is similar to password when you want to authenticate in HashiCorp Vault using AppRole. ID of token representing secret ID saved in Dynatrace CV.
sourceAuthMethod	"AZURE_KEY_VAULT_CLIENT_SECRET" | "CYBERARK_VAULT_ALLOWED_LOCATION" | "CYBERARK_VAULT_USERNAME_PASSWORD" | "HASHICORP_VAULT_APPROLE" | "HASHICORP_VAULT_CERTIFICATE"	Defines the actual set of fields depending on the value. See one of the following objects: HASHICORP_VAULT_APPROLE -> HashicorpApprole HASHICORP_VAULT_CERTIFICATE -> HashicorpCertificate AZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecret CYBERARK_VAULT_USERNAME_PASSWORD -> CyberArkUsernamePassword CYBERARK_VAULT_ALLOWED_LOCATION -> CyberArkAllowedLocationDto
tokenSecretName	string	The name of the secret saved in external vault where token is stored.
usernameSecretName	string	The name of the secret saved in external vault where username is stored.
vaultNamespace	string	Vault namespace in HashiCorp Vault. It is an information you set as environmental variable VAULT_NAMESPACE if you are accessing HashiCorp Vault from command line.
vaultUrl	string	External vault URL.

HashicorpApproleConfig

Configuration for external vault synchronization for username and password credentials.

Name	Type	Description
credentialsUsedForExternalSynchronization	Array<string>
passwordSecretName	string
pathToCredentials	string
roleId	string
secretId	string
sourceAuthMethod	"AZURE_KEY_VAULT_CLIENT_SECRET" | "CYBERARK_VAULT_ALLOWED_LOCATION" | "CYBERARK_VAULT_USERNAME_PASSWORD" | "HASHICORP_VAULT_APPROLE" | "HASHICORP_VAULT_CERTIFICATE"	Defines the actual set of fields depending on the value. See one of the following objects: HASHICORP_VAULT_APPROLE -> HashicorpApproleConfig HASHICORP_VAULT_CERTIFICATE -> HashicorpCertificateConfig AZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecretConfig CYBERARK_VAULT_USERNAME_PASSWORD -> CyberArkUsernamePasswordConfig CYBERARK_VAULT_ALLOWED_LOCATION -> CyberArkAllowedLocationConfig
tokenSecretName	string
type	"AZURE_CERTIFICATE_MODEL" | "AZURE_CLIENT_SECRET_MODEL" | "CYBERARK_VAULT_ALLOWED_LOCATION_MODEL" | "CYBERARK_VAULT_USERNAME_PASSWORD_MODEL" | "HASHICORP_APPROLE_MODEL" | "HASHICORP_CERTIFICATE_MODEL"
usernameSecretName	string
vaultNamespace	string
vaultUrl	string

HashicorpCertificate

Synchronization credentials with HashiCorp Vault using certificate authentication method

Name	Type	Description
certificate	string	ID of certificate saved in Dynatrace CV. Using this certificate you can authenticate to your HashiCorp Vault.
locationForSynchronizationId	string	Id of a location used by the synchronizing monitor
passwordSecretName	string	The name of the secret saved in external vault where password is stored.
pathToCredentials	string	Path to folder where credentials in HashiCorp Vault are stored.
sourceAuthMethod	"AZURE_KEY_VAULT_CLIENT_SECRET" | "CYBERARK_VAULT_ALLOWED_LOCATION" | "CYBERARK_VAULT_USERNAME_PASSWORD" | "HASHICORP_VAULT_APPROLE" | "HASHICORP_VAULT_CERTIFICATE"	Defines the actual set of fields depending on the value. See one of the following objects: HASHICORP_VAULT_APPROLE -> HashicorpApprole HASHICORP_VAULT_CERTIFICATE -> HashicorpCertificate AZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecret CYBERARK_VAULT_USERNAME_PASSWORD -> CyberArkUsernamePassword CYBERARK_VAULT_ALLOWED_LOCATION -> CyberArkAllowedLocationDto
tokenSecretName	string	The name of the secret saved in external vault where token is stored.
usernameSecretName	string	The name of the secret saved in external vault where username is stored.
vaultUrl	string	External vault URL.

HashicorpCertificateConfig

Configuration for external vault synchronization for username and password credentials.

Name	Type	Description
certificate	string
credentialsUsedForExternalSynchronization	Array<string>
passwordSecretName	string
pathToCredentials	string
sourceAuthMethod	"AZURE_KEY_VAULT_CLIENT_SECRET" | "CYBERARK_VAULT_ALLOWED_LOCATION" | "CYBERARK_VAULT_USERNAME_PASSWORD" | "HASHICORP_VAULT_APPROLE" | "HASHICORP_VAULT_CERTIFICATE"	Defines the actual set of fields depending on the value. See one of the following objects: HASHICORP_VAULT_APPROLE -> HashicorpApproleConfig HASHICORP_VAULT_CERTIFICATE -> HashicorpCertificateConfig AZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecretConfig CYBERARK_VAULT_USERNAME_PASSWORD -> CyberArkUsernamePasswordConfig CYBERARK_VAULT_ALLOWED_LOCATION -> CyberArkAllowedLocationConfig
tokenSecretName	string
type	"AZURE_CERTIFICATE_MODEL" | "AZURE_CLIENT_SECRET_MODEL" | "CYBERARK_VAULT_ALLOWED_LOCATION_MODEL" | "CYBERARK_VAULT_USERNAME_PASSWORD_MODEL" | "HASHICORP_APPROLE_MODEL" | "HASHICORP_CERTIFICATE_MODEL"
usernameSecretName	string
vaultUrl	string

HistoryModificationInfo

Modification information about the setting.

Name	Type	Description
lastModifiedBy	string	The unique identifier of the user who performed the most recent modification.
lastModifiedTime*required	Date	Timestamp when the setting was last modified in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

HttpProtocolDetails

HTTP specific request details.

Name	Type	Description
headers	TruncatableListAttackRequestHeader	A list of values that has possibly been truncated.
parameters	TruncatableListHttpRequestParameter	A list of values that has possibly been truncated.
requestMethod	string	The HTTP request method.

HttpRequestParameter

An HTTP request parameter.

Name	Type	Description
name	string	The name of the parameter.
value	string	The value of the parameter.

Identity

An Identity describing either a user, a group, or the all-users group (applying to all users).

Name	Type	Description
id	string	The user id or user group id if type is 'user' or 'group', missing if type is 'all-users'.
type*required	"all-users" | "group" | "user"	The type of the identity.

Impact

The impact analysis of the problem on other entities/users.

The actual set of fields depends on the type of the impact. Find the list of actual objects in the description of the impactType field or see Problems API v2 - JSON models.

Name	Type	Description
estimatedAffectedUsers*required	number	The estimated number of affected users.
impactType*required	"APPLICATION" | "CUSTOM_APPLICATION" | "MOBILE" | "SERVICE"	Defines the actual set of fields depending on the value. See one of the following objects: SERVICE -> ServiceImpact APPLICATION -> ApplicationImpact MOBILE -> MobileImpact CUSTOM_APPLICATION -> CustomApplicationImpact
impactedEntity*required	EntityStub	A short representation of a monitored entity.

ImpactAnalysis

A list of all impacts of the problem.

Name	Type	Description
impacts*required	Array<Impact>	A list of all impacts of the problem.

InsertPosition

The position where the button should be shown relative to a property in the UI

Name	Type	Description
after*required	string	The path of a property after which the button should be shown in the UI

InvalidLine

Name	Type
error	string
line	number

Invocation

Invocation of a function, e.g. the entitySelector function.

Name	Type	Description
args	Array<string>	Arguments to pass to the function, e.g. entity selector source code.
function	string	Function that is invoked, e.g. entitySelector.

Item

An item of a collection property.

Name	Type	Description
constraints	Array<Constraint>	A list of constraints limiting the values to be accepted.
datasource	DatasourceDefinition	Configuration of a datasource for a property.
description	string	A short description of the item.
displayName	string	The display name of the item.
documentation	string	An extended description and/or links to documentation.
metadata	ItemMetadata	Metadata of the items.
referencedType	string	The type referenced by the item's value.
subType	string	The subtype of the item's value.
type*required	string | RefPointer	The type of the item's value.
uiCustomization	UiCustomization	Customization for UI elements

ItemMetadata

Metadata of the items.

type: Record<string, string | undefined>

LinkedProblem

The properties of the linked problem.

Name	Type	Description
displayId*required	string	The display ID of the problem.
problemId*required	string	The ID of the problem.

LocationCollectionElement

A synthetic location.

Name	Type	Description
capabilities	Array<string>	The list of location's capabilities.
cloudPlatform	"AZURE" | "ALIBABA" | "GOOGLE_CLOUD" | "OTHER" | "AMAZON_EC2" | "DYNATRACE_CLOUD" | "INTEROUTE" | "UNDEFINED"	The cloud provider where the location is hosted. Only applicable to PUBLIC locations.
deploymentType	"UNKNOWN" | "KUBERNETES" | "OPENSHIFT" | "STANDARD"	Location's deployment type
entityId*required	string	The Dynatrace entity ID of the location.
geoCity	string	Location's city.
geoContinent	string	Location's continent.
geoCountry	string	Location's country.
geoLatitude	number	Location's latitude.
geoLocationId*required	string	The Dynatrace GeoLocation ID of the location.
geoLongitude	number	Location's longitude.
ips	Array<string>	The list of IP addresses assigned to the location. Only applicable to PUBLIC locations.
lastModificationTimestamp	number	The timestamp of the last modification of the location.
name*required	string	The name of the location.
nodes	Array<string>	A list of synthetic nodes belonging to the location. You can retrieve the list of available nodes with the GET all nodes call.
stage	"BETA" | "COMING_SOON" | "DELETED" | "GA"	The release stage of the location.
status	"ENABLED" | "DISABLED" | "HIDDEN"	The status of the location.
type*required	"CLUSTER" | "PUBLIC" | "PRIVATE"	The type of the location.

LocationExecutionResults

Results of the execution HTTP monitor's requests at a given location

Name	Type	Description
executionId	string	Execution id.
locationId	string	Location id.
requestResults	Array<MonitorRequestExecutionResult>	The list of the monitor's request results executed on this location.

LogRecord

A single log record.

Name	Type	Description
additionalColumns	LogRecordAdditionalColumns	Additional columns of the log record.
content	string	The content of the log record.
eventType	"K8S" | "LOG" | "SFM"	Type of event
status	"ERROR" | "INFO" | "NONE" | "NOT_APPLICABLE" | "WARN"	The log status (based on the log level).
timestamp	number	The timestamp of the log record, in UTC milliseconds.

LogRecordAdditionalColumns

Additional columns of the log record.

type: Record<string, string[] | undefined>

LogRecordsList

A list of retrieved log records.

Name	Type	Description
nextSliceKey	string	The cursor for the next slice of log records. Always null on Log Management and Analytics, powered by Grail.
results	Array<LogRecord>	A list of retrieved log records.
sliceSize	number	The total number of records in a slice.
warnings	string	Optional warning messages.

METag

The tag of a monitored entity.

Name	Type	Description
context	string	The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the CONTEXTLESS value.
key	string	The key of the tag.
stringRepresentation	string	The string representation of the tag.
value	string	The value of the tag.

MaintenanceWindowEvidence

The maintenance window evidence of the problem.

The maintenance window during which the problem occurred.

Name	Type	Description
displayName*required	string	The display name of the evidence.
endTime	number	The end time of the evidence, in UTC milliseconds.
entity*required	EntityStub	A short representation of a monitored entity.
evidenceType*required	"AVAILABILITY_EVIDENCE" | "EVENT" | "MAINTENANCE_WINDOW" | "METRIC" | "TRANSACTIONAL"	Defines the actual set of fields depending on the value. See one of the following objects: EVENT -> EventEvidence METRIC -> MetricEvidence TRANSACTIONAL -> TransactionalEvidence MAINTENANCE_WINDOW -> MaintenanceWindowEvidence AVAILABILITY_EVIDENCE -> AvailabilityEvidence
groupingEntity	EntityStub	A short representation of a monitored entity.
maintenanceWindowConfigId	string	The ID of the related maintenance window.
rootCauseRelevant*required	boolean	The evidence is (true) or is not (false) a part of the root cause.
startTime*required	number	The start time of the evidence, in UTC milliseconds.

ManagementZone

A short representation of a management zone.

Name	Type	Description
id	string	The ID of the management zone.
name	string	The name of the management zone.

ManagementZoneDetails

The details of the management zone.

Name	Type	Description
id	string	The ID of the management zone.

MetricData

A list of metrics and their data points.

Name	Type	Description
nextPageKey	string	Deprecated. This field is returned for compatibility reasons. It always has the value of null.
resolution*required	string	The timeslot resolution in the result.
result*required	Array<MetricSeriesCollection>	A list of metrics and their data points.
totalCount*required	number	The total number of primary entities in the result. Has the 0 value if none of the requested metrics is suitable for pagination.
warnings*required	Array<string>	A list of warnings

MetricDefaultAggregation

The default aggregation of a metric.

Name	Type	Description
parameter	number	The percentile to be delivered. Valid values are between 0 and 100. Applicable only to the percentile aggregation type.
type*required	"value" | "auto" | "avg" | "count" | "max" | "median" | "min" | "percentile" | "sum"	The type of default aggregation.

MetricDescriptor

The descriptor of a metric.

Name	Type	Description
aggregationTypes	Array<"value" | "auto" | "avg" | "count" | "max" | "median" | "min" | "percentile" | "sum">	The list of allowed aggregations for this metric.
billable	boolean	If truethe usage of metric is billable. Metric expressions don't return this field.
created	number	The timestamp of metric creation. Built-in metrics and metric expressions have the value of null.
dduBillable	boolean	If true the usage of metric consumes Davis data units. Deprecated and always false for Dynatrace Platform Subscription. Superseded by isBillable. Metric expressions don't return this field.
defaultAggregation	MetricDefaultAggregation	The default aggregation of a metric.
description	string	A short description of the metric.
dimensionCardinalities	Array<MetricDimensionCardinality>	The cardinalities of MINT metric dimensions.
dimensionDefinitions	Array<MetricDimensionDefinition>	The fine metric division (for example, process group and process ID for some process-related metric). For ingested metrics, dimensions that doesn't have have any data within the last 15 days are omitted.
displayName	string	The name of the metric in the user interface.
entityType	Array<string>	List of admissible primary entity types for this metric. Can be used for the type predicate in the entitySelector.
impactRelevant	boolean	The metric is (true) or is not (false) impact relevant. An impact-relevant metric is highly dependent on other metrics and changes because an underlying root-cause metric has changed. Metric expressions don't return this field.
lastWritten	number	The timestamp when the metric was last written. Has the value of null for metric expressions or if the data has never been written.
latency	number	The latency of the metric, in minutes. The latency is the expected reporting delay (for example, caused by constraints of cloud vendors or other third-party data sources) between the observation of a metric data point and its availability in Dynatrace. The allowed value range is from 1 to 60 minutes. Metric expressions don't return this field.
maximumValue	number	The maximum allowed value of the metric. Metric expressions don't return this field.
metricId*required	string	The fully qualified key of the metric. If a transformation has been used it is reflected in the metric key.
metricSelector	string	The metric selector that is used when querying a func: metric.
metricValueType	MetricValueType	The value type for the metric.
minimumValue	number	The minimum allowed value of the metric. Metric expressions don't return this field.
resolutionInfSupported	boolean	If 'true', resolution=Inf can be applied to the metric query.
rootCauseRelevant	boolean	The metric is (true) or is not (false) root cause relevant. A root-cause relevant metric represents a strong indicator for a faulty component. Metric expressions don't return this field.
scalar	boolean	Indicates whether the metric expression resolves to a scalar (true) or to a series (false). A scalar result always contains one data point. The amount of data points in a series result depends on the resolution you're using.
tags	Array<string>	The tags applied to the metric. Metric expressions don't return this field.
transformations	Array<"sort" | "filter" | "asGauge" | "default" | "delta" | "evaluateModel" | "fold" | "histogram" | "last" | "lastReal" | "limit" | "merge" | "names" | "parents" | "partition" | "rate" | "rollup" | "setUnit" | "smooth" | "splitBy" | "timeshift" | "toUnit">	Transform operators that could be appended to the current transformation list.
unit	string	The unit of the metric.
unitDisplayFormat	"binary" | "decimal"	The raw value is stored in bits or bytes. The user interface can display it in these numeral systems: Binary: 1 MiB = 1024 KiB = 1,048,576 bytes Decimal: 1 MB = 1000 kB = 1,000,000 bytes If not set, the decimal system is used. Metric expressions don't return this field.
warnings	Array<string>	A list of potential warnings that affect this ID. For example deprecated feature usage etc.

MetricDescriptorCollection

A list of metrics along with their descriptors.

Name	Type	Description
metrics*required	Array<MetricDescriptor>	A list of metric along with their descriptors
nextPageKey	null | string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
totalCount*required	number	The estimated number of metrics in the result.
warnings	Array<string>	A list of potential warnings about the query. For example deprecated feature usage etc.

MetricDimensionCardinality

The dimension cardinalities of a metric.

Name	Type	Description
estimate*required	number	The cardinality estimate of the dimension.
key*required	string	The key of the dimension. It must be unique within the metric.
relative*required	number	The relative cardinality of the dimension expressed as percentage

MetricDimensionDefinition

The dimension of a metric.

Name	Type	Description
displayName*required	string	The display name of the dimension.
index*required	number	The unique 0-based index of the dimension. Appending transformations such as :names or :parents may change the indexes of dimensions. null is used for the dimensions of a metric with flexible dimensions, which can be referenced with their dimension key, but do not have an intrinsic order that could be used for the index.
key*required	string	The key of the dimension. It must be unique within the metric.
name*required	string	The name of the dimension.
type*required	"OTHER" | "ENTITY" | "NUMBER" | "STRING" | "VOID"	The type of the dimension.

MetricDto

Metric gathered by an extension

Name	Type	Description
key	string	Metric key
metadata	MetricMetadataDto	Metric metadata

MetricEvidence

The metric evidence of the problem.

A change of metric behavior that indicates the problem and/or is its root cause.

Name	Type	Description
displayName*required	string	The display name of the evidence.
endTime	number	The end time of the evidence, in UTC milliseconds. The value null indicates that the evidence is still open.
entity*required	EntityStub	A short representation of a monitored entity.
evidenceType*required	"AVAILABILITY_EVIDENCE" | "EVENT" | "MAINTENANCE_WINDOW" | "METRIC" | "TRANSACTIONAL"	Defines the actual set of fields depending on the value. See one of the following objects: EVENT -> EventEvidence METRIC -> MetricEvidence TRANSACTIONAL -> TransactionalEvidence MAINTENANCE_WINDOW -> MaintenanceWindowEvidence AVAILABILITY_EVIDENCE -> AvailabilityEvidence
groupingEntity	EntityStub	A short representation of a monitored entity.
metricId	string	The ID of the metric.
rootCauseRelevant*required	boolean	The evidence is (true) or is not (false) a part of the root cause.
startTime*required	number	The start time of the evidence, in UTC milliseconds.
unit	"Ampere" | "Billion" | "Bit" | "BitPerHour" | "BitPerMinute" | "BitPerSecond" | "Byte" | "BytePerHour" | "BytePerMinute" | "BytePerSecond" | "Cores" | "Count" | "Day" | "DecibelMilliWatt" | "GibiByte" | "GibiBytePerHour" | "GibiBytePerMinute" | "GibiBytePerSecond" | "Giga" | "GigaByte" | "GigaBytePerHour" | "GigaBytePerMinute" | "GigaBytePerSecond" | "Hertz" | "Hour" | "KibiByte" | "KibiBytePerHour" | "KibiBytePerMinute" | "KibiBytePerSecond" | "Kilo" | "KiloByte" | "KiloBytePerHour" | "KiloBytePerMinute" | "KiloBytePerSecond" | "KiloMetrePerHour" | "MSU" | "MebiByte" | "MebiBytePerHour" | "MebiBytePerMinute" | "MebiBytePerSecond" | "Mega" | "MegaByte" | "MegaBytePerHour" | "MegaBytePerMinute" | "MegaBytePerSecond" | "MetrePerHour" | "MetrePerSecond" | "MicroSecond" | "MilliCores" | "MilliSecond" | "MilliSecondPerMinute" | "Million" | "Minute" | "Month" | "NanoSecond" | "NanoSecondPerMinute" | "NotApplicable" | "PerHour" | "PerMinute" | "PerSecond" | "Percent" | "Pixel" | "Promille" | "Ratio" | "Second" | "State" | "Trillion" | "Unspecified" | "Volt" | "Watt" | "Week" | "Year"	The unit of the metric.
valueAfterChangePoint	number	The metric's value after the problem start.
valueBeforeChangePoint	number	The metric's value before the problem start.

MetricIngestError

Name	Type
code	number
invalidLines	Array<InvalidLine>
message	string

MetricMetadataDto

Metric metadata

Name	Type	Description
description	string	A short description of the metric
displayName	string	The name of the metric in the user interface
unit	string	The unit of the metric

MetricQueryDQLTranslation

Metric query translation to DQL.

Name	Type	Description
message	string	Error message - only present if the status is not supported
query	string	The DQL query corresponding to the metric query
status	"not supported" | "success"	The status of the DQL translation, either success or not supported

MetricSeries

Data points per dimension of a metric.

The data is represented by two arrays of the same length: timestamps and values. Entries of the same index from both arrays form a timestamped data point.

Name	Type	Description
dimensionMap*required	MetricSeriesDimensionMap
dimensions*required	Array<string>	Deprecated, refer to dimensionMap instead. The ordered list of dimensions to which the data point list belongs. Each metric can have a certain number of dimensions. Dimensions exceeding this number are aggregated into one, which is shown as null here.
timestamps*required	Array<number>	A list of timestamps of data points. The value of data point for each time from this array is located in values array at the same index.
values*required	Array<number>	A list of values of data points. The timestamp of data point for each value from this array is located in timestamps array at the same index.

MetricSeriesCollection

Data points of a metric.

Name	Type	Description
appliedOptionalFilters	Array<AppliedFilter>	A list of filtered metric keys along with filters that have been applied to these keys, from the optionalFilter parameter.
data*required	Array<MetricSeries>	Data points of the metric.
dataPointCountRatio*required	number	The ratio of queried data points divided by the maximum number of data points per metric that are allowed in a single query.
dimensionCountRatio*required	number	The ratio of queried dimension tuples divided by the maximum number of dimension tuples allowed in a single query.
dql	MetricQueryDQLTranslation	Metric query translation to DQL.
metricId*required	string	The key of the metric. If any transformation is applied, it is included here.
warnings	Array<string>	A list of potential warnings that affect this ID. For example deprecated feature usage etc.

MetricSeriesDimensionMap

type: Record<string, string | undefined>

MetricValueType

The value type for the metric.

Name	Type	Description
type*required	"error" | "score" | "unknown"	The metric value type

MinimalExtension

A list of extensions.

Name	Type	Description
extensionName*required	string	Extension name
version*required	string	Extension version Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

MobileImpact

Analysis of problem impact to a mobile application.

Name	Type	Description
estimatedAffectedUsers*required	number	The estimated number of affected users.
impactType*required	"APPLICATION" | "CUSTOM_APPLICATION" | "MOBILE" | "SERVICE"	Defines the actual set of fields depending on the value. See one of the following objects: SERVICE -> ServiceImpact APPLICATION -> ApplicationImpact MOBILE -> MobileImpact CUSTOM_APPLICATION -> CustomApplicationImpact
impactedEntity*required	EntityStub	A short representation of a monitored entity.

Modification

The additional modification details for this settings object.

Name	Type	Description
first	boolean	If non-moveable settings object is in the first group of non-moveable settings, or in the last (start or end of list).
modifiablePaths*required	Array<string>	Property paths which are modifiable, regardless if the write operation is allowed.
movable	boolean	If settings object can be moved/reordered. Only applicable for ordered list schema.
nonModifiablePaths*required	Array<string>	Property paths which are not modifiable, even if the write operation is allowed.

ModificationInfo

DEPRECATED

The modification info for a single updatable setting. Replaced by resourceContext.

Name	Type	Description
deletable*required	boolean	If settings value can be deleted
first	boolean	If non-moveable settings value is in the first group of non-moveable settings, or in the last (start or end of list)
modifiable*required	boolean	If settings value can be modified
modifiablePaths*required	Array<string>	Property paths which are modifiable, regardless of the state of modifiable
movable*required	boolean	If settings value can be moved/reordered. Only applicable for ordered list schema
nonModifiablePaths*required	Array<string>	Property paths which are not modifiable, when modifiable is true

MonitorEntityIdDto

A DTO for monitor entity ID.

Name	Type	Description
entityId*required	string	Monitor entity ID.

MonitorExecutionResults

Results of the execution of all HTTP monitor's requests.

Name	Type	Description
locationsExecutionResults	Array<LocationExecutionResults>	The list with the results of the requests executed on assigned locations.
monitorId	string	Monitor id.

MonitorRequestExecutionResult

A result of the execution HTTP monitor's request.

Name	Type	Description
cloudPlatform	string	Cloud platform of the location.
customLogs	Array<CustomLogLine>	Custom log messages.
engineId	number	VUC's id on which monitor's request was executed.
failureMessage	string	Request's failure message.
healthStatus	string	Request's health status.
healthStatusCode	number	Request's health status code.
hostNameResolutionTime	number	A hostname resolution time measured in ms.
method	string	Request method type.
monitorType*required	"BROWSER" | "HTTP"	Defines the actual set of fields depending on the value. See one of the following objects: BROWSER -> BMAction HTTP -> MonitorRequestExecutionResult
peerCertificateDetails	string	Request's certificate details.
peerCertificateExpiryDate	number	An expiry date of the first SSL certificate from the certificate chain.
publicLocation	boolean	Flag informs whether request was executed on public location.
redirectionTime	number	Total number of milliseconds spent on handling all redirect requests, measured in ms.
redirectsCount	number	Number of request's redirects.
requestBody	string	Request's request body.
requestHeaders	Array<MonitorRequestHeader>	A list of request's headers
requestId	string	Request id.
requestName	string	Request name.
resolvedIps	Array<string>	Request's resolved ips.'
responseBody	string	Request's response body.
responseBodySizeLimitExceeded	boolean	A flag indicating that the response payload size limit of 10MB has been exceeded.
responseHeaders	Array<MonitorRequestHeader>	A list of request's response headers
responseMessage	string	Request's response message.'
responseSize	number	Request's response size in bytes.
responseStatusCode	number	Request's response status code.
sequenceNumber	number	Request's sequence number.
startTimestamp	number	Request start timestamp.
tcpConnectTime	number	A TCP connect time measured in ms.
timeToFirstByte	number	A time to first byte measured in ms.
tlsHandshakeTime	number	A TLS handshake time measured in ms.
totalTime	number	A total request time measured in ms.
url	string	Request URL address.
waitingTime	number	Waiting time (time to first byte - (DNS lookup time + TCP connect time + TLS handshake time), measured in ms.

MonitorRequestHeader

A header of the Http request

Name	Type	Description
name	string	Header's name.
value	string	Header's value.

MonitoredEntityStateParam

Key-value parameter of the monitoring state.

Name	Type	Description
key	string	The key of the monitoring state paramter.
values	string	The value of the monitoring state paramter.

MonitoredEntityStates

Monitoring state of the process group instance.

Name	Type	Description
entityId	string	The Dynatrace entity ID of the process group instance.
params	Array<MonitoredEntityStateParam>	Additional parameters of the monitoring state.
severity	"deep_monitoring_ok" | "info" | "ok" | "warning"	The type of the monitoring state.
state	"ok" | "agent_injection_status_go_dynamizer_failed" | "agent_injection_status_go_fips_detected_but_feature_disabled" | "agent_injection_status_go_pclntab_failed" | "agent_injection_status_go_vertigo_support_added" | "agent_injection_status_nginx_patched_binary_detected" | "agent_injection_status_php_opcache_disabled" | "agent_injection_status_php_stack_size_too_low" | "agent_injection_suppression" | "aix_enable_full_monitoring_needed" | "bad_installer" | "boshbpm_disabled" | "container_injection_failed" | "containerd_disabled" | "crio_disabled" | "custom_pg_rule_required" | "deep_monitoring_successful" | "deep_monitoring_unsuccessful" | "docker_disabled" | "garden_disabled" | "host_infra_structure_only" | "host_monitoring_disabled" | "network_agent_inactive" | "parent_process_restart_required" | "podman_disabled" | "process_group_different_id_due_to_declarative_grouping" | "process_group_disabled" | "process_group_disabled_via_container_injection_rule" | "process_group_disabled_via_container_injection_rule_restart" | "process_group_disabled_via_global_settings" | "process_group_disabled_via_injection_rule" | "process_group_disabled_via_injection_rule_restart" | "process_group_pgr_group_update_suppressed" | "restart_required" | "restart_required_apache" | "restart_required_docker_deamon" | "restart_required_host_group_inconsistent" | "restart_required_host_id_inconsistent" | "restart_required_outdated_agent_apache_update" | "restart_required_outdated_agent_injected" | "restart_required_using_different_data_storage_dir" | "restart_required_using_different_log_path" | "restart_required_virtualized_container" | "unsupported_state" | "winc_disabled"	The name of the monitoring state.

MonitoredStates

A list of entities and their monitoring states.

Name	Type	Description
monitoringStates	Array<MonitoredEntityStates>	A list of process group instances and their monitoring states.
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
totalCount	number	The total number of entities in the response.

MonitoringConfigurationDto

Name	Type	Description
scope*required	string	The scope this monitoring configuration will be defined for
value	JsonNode	The monitoring configuration

MonitoringConfigurationResponse

Name	Type	Description
code*required	number	The HTTP Status code
objectId*required	string	The identifier of the new configuration

MonitoringConfigurationUpdateDto

Name	Type	Description
value	JsonNode	The monitoring configuration

MuteState

Metadata of the muted state of a security problem in relation to an event.

Name	Type	Description
comment	string	A user's comment.
reason	"OTHER" | "AFFECTED" | "CONFIGURATION_NOT_AFFECTED" | "FALSE_POSITIVE" | "IGNORE" | "INITIAL_STATE" | "VULNERABLE_CODE_NOT_IN_USE"	The reason for the mute state change.
user	string	The user who has muted or unmuted the problem.

NetworkZone

Configuration of a network zone.

Name	Type	Description
alternativeZones	Array<string>	A list of alternative network zones.
description	string	A short description of the network zone.
fallbackMode	"NONE" | "ANY_ACTIVE_GATE" | "ONLY_DEFAULT_ZONE"	The fallback mode of the network zone.
id	string	The ID of the network zone.
numOfConfiguredActiveGates	number	The number of ActiveGates in the network zone.
numOfConfiguredOneAgents	number	The number of OneAgents that are configured to use the network zone as primary.
numOfOneAgentsFromOtherZones	number	The number of OneAgents from other network zones that are using ActiveGates in the network zone. This is a fraction of numOfOneAgentsUsing. One possible reason for switching to another zone is that a firewall is preventing a OneAgent from connecting to any ActiveGate in the preferred network zone.
numOfOneAgentsUsing	number	The number of OneAgents that are using ActiveGates in the network zone.
overridesGlobal	boolean	Indicates if a global network zone is overridden (managed only).
scope	string	Specifies the scope of the network zone (managed only).

NetworkZoneConnectionStatistics

Runtime information about host connections.

Name	Type	Description
hostsConfiguredButNotConnected	Array<string>	Hosts from the network zone that use other zones.
hostsConnectedAsAlternative	Array<string>	Hosts that use the network zone as an alternative.
hostsConnectedAsFailover	Array<string>	Hosts from other zones that use the zone (not configured as an alternative) even though ActiveGates of higher priority are available.
hostsConnectedAsFailoverWithoutActiveGates	Array<string>	Hosts from other zones that use the zone (not configured as an alternative) and no ActiveGates of higher priority are available.

NetworkZoneList

A list of network zones.

Name	Type	Description
networkZones*required	Array<NetworkZone>	A list of network zones.

NetworkZoneSettings

Global network zone configuration.

Name	Type	Description
networkZonesEnabled	boolean	Network zones feature is enabled (true) or disabled (false).

Node

Configuration of a synthetic node.

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

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

NodeCollectionElement

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

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

Nodes

A list of synthetic nodes

Name	Type	Description
nodes*required	Array<NodeCollectionElement>	A list of synthetic nodes

ObjectsList

A list of settings objects.

Name	Type	Description
items*required	Array<SettingsObject>	A list of settings objects.
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize*required	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

PermissionContext

Optional context data

Name	Type	Description
schemaId*required	string	Settings schema id for conditional permission
scope*required	string	Settings scope for conditional permission

Precondition

A precondition for visibility of a property.

Name	Type	Description
expectedValue	AnyValue	The expected value of the property. Only applicable to properties of the EQUALS type.
expectedValues	Array<AnyValue>	A list of valid values of the property. Only applicable to properties of the IN type.
pattern	string	The Regular expression which is matched against the property. Only applicable to properties of the REGEX_MATCH type.
precondition	Precondition	A precondition for visibility of a property.
preconditions	Array<Precondition>	A list of child preconditions to be evaluated. Only applicable to properties of the AND and OR types.
property	string	The property to be evaluated.
type*required	"AND" | "EQUALS" | "IN" | "NOT" | "NULL" | "OR" | "REGEX_MATCH"	The type of the precondition.

PrivateSyntheticLocation

Configuration of a private synthetic location.

Some fields are inherited from the base SyntheticLocation object.

Name	Type	Description
autoUpdateChromium	boolean	Non-containerized location property. Auto upgrade of Chromium is enabled (true) or disabled (false).
availabilityLocationOutage	boolean	Alerting for location outage is enabled (true) or disabled (false). Supported only for private Synthetic locations.
availabilityNodeOutage	boolean	Alerting for node outage is enabled (true) or disabled (false). \n\n If enabled, the outage of any node in the location triggers an alert. Supported only for private Synthetic locations.
availabilityNotificationsEnabled	boolean	Notifications for location and node outage are enabled (true) or disabled (false). Supported only for private Synthetic locations.
browserExecutionSupported	boolean	Containerized location property. Boolean value describes if browser monitors will be executed on this location: false: Browser monitor executions disabled. true: Browser monitor executions enabled.
city	string	The city of the location.
countryCode	string	The country code of the location. To fetch the list of available country codes, use the GET all countries request.
countryName	string	The country name of the location.
deploymentType	"UNKNOWN" | "KUBERNETES" | "OPENSHIFT" | "STANDARD"	The deployment type of the location: STANDARD: The location is deployed on Windows or Linux. KUBERNETES: The location is deployed on Kubernetes.
entityId	string	The Dynatrace entity ID of the location.
geoLocationId	string	The Dynatrace GeoLocation ID of the location.
latitude*required	number	The latitude of the location in DDD.dddd format.
locationNodeOutageDelayInMinutes	number	Alert if location or node outage lasts longer than X minutes. \n\n Only applicable when availabilityLocationOutage or availabilityNodeOutage is set to true. Supported only for private Synthetic locations.
longitude*required	number	The longitude of the location in DDD.dddd format.
namExecutionSupported	boolean	Containerized location property. Boolean value describes if icmp monitors will be executed on this location: false: Icmp monitor executions disabled. true: Icmp monitor executions enabled.
name*required	string	The name of the location.
nodeNames	PrivateSyntheticLocationNodeNames	A mapping id to name of the nodes belonging to the location.
nodes*required	Array<string>	A list of synthetic nodes belonging to the location. You can retrieve the list of available nodes with the GET all nodes call.
regionCode	string	The region code of the location. To fetch the list of available region codes, use the GET regions of the country request.
regionName	string	The region name of the location.
status	"ENABLED" | "DISABLED" | "HIDDEN"	The status of the location: ENABLED: The location is displayed as active in the UI. You can assign monitors to the location. DISABLED: The location is displayed as inactive in the UI. You can't assign monitors to the location. Monitors already assigned to the location will stay there and will be executed from the location. HIDDEN: The location is not displayed in the UI. You can't assign monitors to the location. You can only set location as HIDDEN when no monitor is assigned to it.
type*required	"CLUSTER" | "PUBLIC" | "PRIVATE"
useNewKubernetesVersion	boolean	Containerized location property. Boolean value describes which kubernetes version will be used: false: Version 1.23+ that is older than 1.26 true: Version 1.26+.

PrivateSyntheticLocationNodeNames

A mapping id to name of the nodes belonging to the location.

type: Record<string, string | undefined>

Problem

The properties of a problem.

Name	Type	Description
affectedEntities*required	Array<EntityStub>	A list of all entities that are affected by the problem.
displayId*required	string	The display ID of the problem.
endTime*required	number	The end timestamp of the problem, in UTC milliseconds. Has -1 value, if the problem is still open.
entityTags	Array<METag>	A list of all entity tags of the problem.
evidenceDetails	EvidenceDetails	The evidence details of a problem.
impactAnalysis	ImpactAnalysis	A list of all impacts of the problem.
impactLevel*required	"ENVIRONMENT" | "APPLICATION" | "INFRASTRUCTURE" | "SERVICES"	The impact level of the problem. It shows what is affected by the problem.
impactedEntities*required	Array<EntityStub>	A list of all entities that are impacted by the problem.
k8s.cluster.name	Array<string>	The related Kubernetes cluster names.
k8s.cluster.uid	Array<string>	The related Kubernetes cluster UIDs.
k8s.namespace.name	Array<string>	The related Kubernetes namespace names.
linkedProblemInfo	LinkedProblem	The properties of the linked problem.
managementZones*required	Array<ManagementZone>	A list of all management zones that the problem belongs to.
problemFilters*required	Array<AlertingProfileStub>	A list of alerting profiles that match the problem.
problemId*required	string	The ID of the problem.
recentComments	CommentsList	A list of comments.
rootCauseEntity	EntityStub	A short representation of a monitored entity.
severityLevel*required	"CUSTOM_ALERT" | "AVAILABILITY" | "ERROR" | "INFO" | "MONITORING_UNAVAILABLE" | "PERFORMANCE" | "RESOURCE_CONTENTION"	The severity of the problem.
startTime*required	number	The start timestamp of the problem, in UTC milliseconds.
status*required	"CLOSED" | "OPEN"	The status of the problem.
title*required	string	The name of the problem, displayed in the UI.

ProblemCloseRequestDtoImpl

Name	Type	Description
message*required	string	The text of the closing comment.

ProblemCloseResult

The result of closing a problem.

Name	Type	Description
closeTimestamp*required	number	The timestamp when the user triggered the closing.
closing*required	boolean	True, if the problem is being closed.
comment	Comment	The comment to a problem.
problemId*required	string	The ID of the problem.

Problems

A list of problems.

Name	Type	Description
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
problems*required	Array<Problem>	The result entries.
totalCount*required	number	The total number of entries in the result.
warnings	Array<string>	A list of warnings

ProcessGroupVulnerableFunctions

The vulnerable functions of a process group including their usage.

Name	Type	Description
functionsInUse	Array<VulnerableFunction>	A list of vulnerable functions in use.
functionsNotAvailable	Array<VulnerableFunction>	A list of vulnerable functions with unknown state.
functionsNotInUse	Array<VulnerableFunction>	A list of vulnerable functions not in use.
processGroup	string	The process group identifier.

PropertyDefinition

Configuration of a property in a settings schema.

Name	Type	Description
constraints	Array<Constraint>	A list of constraints limiting the values to be accepted.
datasource	DatasourceDefinition	Configuration of a datasource for a property.
default	AnyValue	The default value to be used when no value is provided. If a non-singleton has the value of null, it means an empty collection.
description	string	A short description of the property.
displayName	string	The display name of the property.
documentation	string	An extended description and/or links to documentation.
forceSecretResubmission	boolean	Defines if value is allowed to be modified when secret properties are not
items	Item	An item of a collection property.
maxObjects*required	number	The maximum number of objects in a collection property. Has the value of 1 for singletons.
metadata	PropertyDefinitionMetadata	Metadata of the property.
migrationPattern	string	Pattern with references to properties to create a new value.
minObjects	number	The minimum number of objects in a collection property.
modificationPolicy	"DEFAULT" | "ALWAYS" | "NEVER"	Modification policy of the property.
nullable*required	boolean	The value can (true) or can't (false) be null.
precondition	Precondition	A precondition for visibility of a property.
referencedType	string	The type referenced by the property value
subType	string	The subtype of the property's value.
type*required	string | RefPointer	The type of the property's value.
uiCustomization	UiCustomization	Customization for UI elements

PropertyDefinitionMetadata

Metadata of the property.

type: Record<string, string | undefined>

ProtocolDetails

Details that are specific to the used protocol.

Name	Type	Description
http	HttpProtocolDetails	HTTP specific request details.

PublicCertificateCredentials

A credentials set of the PUBLIC_CERTIFICATE type.

Name	Type	Description
allowContextlessRequests	boolean	Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope).
allowedEntities	Array<CredentialAccessData>	The set of entities allowed to use the credential.
certificate	string	The certificate in the string format.
certificateFormat	"UNKNOWN" | "PEM" | "PKCS12"	The certificate format.
description	string	A short description of the credentials set.
id	string	The ID of the credentials set.
name*required	string	The name of the credentials set.
ownerAccessOnly	boolean	The credentials set is available to every user (false) or to owner only (true).
password	string	The password of the credential (not supported).
scopeDEPRECATED	"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"	The scope of the credentials set.
scopes*required	Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">	The set of scopes of the credentials set. Limitations: CredentialsScope.APP_ENGINE is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.
type*required	"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"	Defines the actual set of fields depending on the value. See one of the following objects: CERTIFICATE -> CertificateCredentials PUBLIC_CERTIFICATE -> PublicCertificateCredentials USERNAME_PASSWORD -> UserPasswordCredentials TOKEN -> TokenCredentials SNMPV3 -> SNMPV3Credentials AWS_MONITORING_KEY_BASED -> AWSKeyBasedCredentialsDto AWS_MONITORING_ROLE_BASED -> AWSRoleBasedCredentials

PublicSyntheticLocation

Configuration of a public synthetic location.

Some fields are inherited from the base SyntheticLocation object.

Name	Type	Description
browserType	string	The type of the browser the location is using to execute browser monitors.
browserVersion	string	The version of the browser the location is using to execute browser monitors.
capabilities	Array<string>	A list of location capabilities.
city	string	The city of the location.
cloudPlatform	"AZURE" | "ALIBABA" | "GOOGLE_CLOUD" | "OTHER" | "AMAZON_EC2" | "DYNATRACE_CLOUD" | "INTEROUTE" | "UNDEFINED"	The cloud provider where the location is hosted.
countryCode	string	The country code of the location. To fetch the list of available country codes, use the GET all countries request.
countryName	string	The country name of the location.
entityId	string	The Dynatrace entity ID of the location.
geoLocationId	string	The Dynatrace GeoLocation ID of the location.
ips	Array<string>	The list of IP addresses assigned to the location.
latitude*required	number	The latitude of the location in DDD.dddd format.
longitude*required	number	The longitude of the location in DDD.dddd format.
name*required	string	The name of the location.
regionCode	string	The region code of the location. To fetch the list of available region codes, use the GET regions of the country request.
regionName	string	The region name of the location.
stage	"BETA" | "COMING_SOON" | "DELETED" | "GA"	The stage of the location.
status	"ENABLED" | "DISABLED" | "HIDDEN"	The status of the location: ENABLED: The location is displayed as active in the UI. You can assign monitors to the location. DISABLED: The location is displayed as inactive in the UI. You can't assign monitors to the location. Monitors already assigned to the location will stay there and will be executed from the location. HIDDEN: The location is not displayed in the UI. You can't assign monitors to the location. You can only set location as HIDDEN when no monitor is assigned to it.
type*required	"CLUSTER" | "PUBLIC" | "PRIVATE"	Defines the actual set of fields depending on the value. See one of the following objects: PUBLIC -> PublicSyntheticLocation PRIVATE -> PrivateSyntheticLocation CLUSTER -> PrivateSyntheticLocation

RefPointer

Object with a pointer to a JSON object

Name	Type	Description
$ref*required	string	Pointer to a JSON object this object should be logically replaced with.

RegisteredExtensionResultDto

Name	Type	Description
extensionName	string	FQN of the extension registered in the tenant.
extensionVersion	string	Version number of the extension.

RelatedAttacksList

A list of related attacks of the security problem.

Related attacks are attacks on the exposed security problem.

Name	Type	Description
attacks	Array<string>	A list of related attack ids.

RelatedContainerImage

Related container image of a security problem.

Name	Type	Description
affectedEntities	Array<string>	A list of affected entities.
imageId	string	The image ID of the related container image.
imageName	string	The image name of the related container image.
numberOfAffectedEntities	number	The number of affected entities.

RelatedContainerList

A list of related container images.

Name	Type	Description
containerImages	Array<RelatedContainerImage>	A list of related container images.

RelatedEntitiesList

A list of related entities of the security problem.

A related entity is a monitored entity that is directly or indirectly related to an affected entity (for example, it could be a host where an affected process runs).

Each related entity contains a list of corresponding affected entities (for example, an affected process running on this host).

Name	Type	Description
applications	Array<RelatedEntity>	A list of related applications.
databases	Array<string>	A list of related databases.
hosts	Array<RelatedEntity>	A list of related hosts.
kubernetesClusters	Array<RelatedEntity>	A list of related Kubernetes clusters.
kubernetesWorkloads	Array<RelatedEntity>	A list of related Kubernetes workloads.
services	Array<RelatedService>	A list of related services.

RelatedEntity

An entity related to a security problem.

Name	Type	Description
affectedEntities	Array<string>	A list of affected entities related to the entity.
id	string	The Dynatrace entity ID of the entity.
numberOfAffectedEntities	number	The number of affected entities related to the entity.

RelatedService

A service related to a security problem.

Name	Type	Description
affectedEntities	Array<string>	A list of affected entities related to the entity.
exposure	"NOT_AVAILABLE" | "NOT_DETECTED" | "PUBLIC_NETWORK"	The level of exposure of the service.
id	string	The Dynatrace entity ID of the entity.
numberOfAffectedEntities	number	The number of affected entities related to the entity.

Release

Contains data related to a single release of a component. A Release is a combination of a component and a version. A Component can be any form of deployable that can be associated with a version. In the first draft, a Component is always a Service.

The tuple &lt;name, product, stage, version&gt; is always unique.

Name	Type	Description
affectedByProblems	boolean	The entity has one or more problems
affectedBySecurityVulnerabilities	boolean	The entity has one or more security vulnerabilities
instances	Array<ReleaseInstance>	The instances entityIds included in this release
name	string	The entity name
problemCount	number	The number of problems of the entity
product	string	The product name
releaseEntityId	string	The entity id of correlating release.
running	boolean	The related PGI is still running/monitored
securityVulnerabilitiesCount	number	The number of security vulnerabilities of the entity
securityVulnerabilitiesEnabled	boolean	Indicates that the security vulnerabilities feature is enabled
softwareTechs	Array<SoftwareTechs>	The software technologies of the release
stage	string	The stage name
throughput	number	The count of bytes per second of the entity
version	string	The identified release version

ReleaseInstance

Contains data related to a single instance of a release. An instance is a Process Group Instance and has an optional build version.

Name	Type	Description
buildVersion	string	The build version
entityId	string	The entity id of the instance.
problems	Array<string>	List of event Ids of open problems
securityVulnerabilities	Array<string>	List of Security vulnerabilities Ids

Releases

A list of releases.

Name	Type	Description
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
releases	Array<Release>	A list of releases.
releasesWithProblems	number	Number of releases with problems.
totalCount*required	number	The total number of entries in the result.

RemediationAssessment

Assessment of the remediation item.

Name	Type	Description
assessmentAccuracy	"NOT_AVAILABLE" | "FULL" | "REDUCED"	The accuracy of the assessment.
assessmentAccuracyDetails	AssessmentAccuracyDetails	The assessment accuracy details.
dataAssets	"NOT_AVAILABLE" | "NOT_DETECTED" | "REACHABLE"	The reachability of related data assets by affected entities.
exposure	"NOT_AVAILABLE" | "NOT_DETECTED" | "PUBLIC_NETWORK"	The level of exposure of affected entities.
numberOfDataAssets	number	The number of related data assets.
vulnerableFunctionRestartRequired	boolean	Whether a restart is required for the latest vulnerable function data.
vulnerableFunctionUsage	"NOT_AVAILABLE" | "IN_USE" | "NOT_IN_USE"	The usage of vulnerable functions
vulnerableFunctionsInUse	Array<VulnerableFunction>	A list of vulnerable functions that are in use.
vulnerableFunctionsNotAvailable	Array<VulnerableFunction>	A list of vulnerable functions that are not available.
vulnerableFunctionsNotInUse	Array<VulnerableFunction>	A list of vulnerable functions that are not in use.

RemediationDetailsItem

Detailed information of a remediation item for a security problem.

Name	Type	Description
assessment	RemediationAssessment	Assessment of the remediation item.
entityIds	Array<string>
firstAffectedTimestamp	number
id	string
muteState	RemediationItemMuteState	The mute state of a remediation item of a security problem.
name	string
remediationProgress	RemediationProgress	The progress of this remediation item. It contains affected and unaffected entities.
resolvedTimestamp	number
trackingLink	TrackingLink	External tracking link URL associated with the remediable entity of the security problem.
vulnerabilityState	"RESOLVED" | "VULNERABLE"
vulnerableComponents	Array<RemediationItemDetailsVulnerableComponent>	A list of vulnerable components of the remediation item. A vulnerable component is what causes the security problem.

RemediationItem

A possible remediation for a security problem.

Name	Type	Description
assessment	RemediationAssessment	Assessment of the remediation item.
entityIds	Array<string>
firstAffectedTimestamp	number
id	string
muteState	RemediationItemMuteState	The mute state of a remediation item of a security problem.
name	string
remediationProgress	RemediationProgress	The progress of this remediation item. It contains affected and unaffected entities.
resolvedTimestamp	number
trackingLink	TrackingLink	External tracking link URL associated with the remediable entity of the security problem.
vulnerabilityState	"RESOLVED" | "VULNERABLE"
vulnerableComponents	Array<VulnerableComponent>	A list of vulnerable components of the remediation item. A vulnerable component is what causes the security problem.

RemediationItemDetailsVulnerableComponent

A vulnerable component with details for a remediation item (PG).

Name	Type	Description
affectedEntities	Array<string>	A list of affected entities.
displayName	string	The display name of the vulnerable component.
fileName	string	The file name of the vulnerable component.
id	string	The Dynatrace entity ID of the vulnerable component.
loadOrigins	Array<string>	The load origins of the vulnerable components.
numberOfAffectedEntities	number	The number of affected entities.
shortName	string	The short, component-only name of the vulnerable component.

RemediationItemList

A list of remediation items.

Name	Type	Description
remediationItems	Array<RemediationItem>	A list of remediation items.

RemediationItemMuteState

The mute state of a remediation item of a security problem.

Name	Type	Description
comment	string	A short comment about the most recent mute state change.
lastUpdatedTimestamp	number	The timestamp (UTC milliseconds) of the last update of the mute state.
muted	boolean	The remediation is (true) or is not (false) muted.
reason	"OTHER" | "AFFECTED" | "CONFIGURATION_NOT_AFFECTED" | "FALSE_POSITIVE" | "IGNORE" | "INITIAL_STATE" | "VULNERABLE_CODE_NOT_IN_USE"	The reason for the most recent mute state change.
user	string	The user who last changed the mute state.

RemediationItemMuteStateChange

An updated configuration of the remediation item's mute state.

Name	Type	Description
comment*required	string	A comment about the mute state change reason.
muted*required	boolean	The desired mute state of the remediation item.
reason*required	"OTHER" | "AFFECTED" | "CONFIGURATION_NOT_AFFECTED" | "FALSE_POSITIVE" | "IGNORE" | "INITIAL_STATE" | "VULNERABLE_CODE_NOT_IN_USE"	The reason for the mute state change.

RemediationItemMutingSummary

Summary of (un-)muting a remediation item.

Name	Type	Description
muteStateChangeTriggered*required	boolean	Whether a mute state change for the given remediation item was triggered by this request.
reason	"ALREADY_MUTED" | "ALREADY_UNMUTED" | "REMEDIATION_ITEM_NOT_AFFECTED_BY_GIVEN_SECURITY_PROBLEM"	Contains a reason, in case the requested operation was not executed.
remediationItemId*required	string	The id of the remediation item that will be (un-)muted.

RemediationItemsBulkMute

Information on muting several remediation items.

Name	Type	Description
comment	string	A comment about the muting reason.
reason*required	"OTHER" | "CONFIGURATION_NOT_AFFECTED" | "FALSE_POSITIVE" | "IGNORE" | "VULNERABLE_CODE_NOT_IN_USE"	The reason for muting the remediation items.
remediationItemIds*required	Array<string>	The ids of the remediation items to be muted.

RemediationItemsBulkMuteResponse

Response of muting several remediation items.

Name	Type	Description
summary*required	Array<RemediationItemMutingSummary>	The summary of which remediation items were muted and which already were muted previously.

RemediationItemsBulkUnmute

Information on un-muting several remediation items.

Name	Type	Description
comment	string	A comment about the un-muting reason.
reason*required	"AFFECTED"	The reason for un-muting the remediation items.
remediationItemIds*required	Array<string>	The ids of the remediation items to be un-muted.

RemediationItemsBulkUnmuteResponse

Response of un-muting several remediation items.

Name	Type	Description
summary*required	Array<RemediationItemMutingSummary>	The summary of which remediation items were un-muted and which already were un-muted previously.

RemediationItemsBulkUpdateDeleteDto

Contains the external tracking link associations to be applied to the remediation items of the security problem.

Name	Type	Description
deletes	Array<string>	Tracking links to remove from the security problem. List of remediation item IDs of the security problem for which to remove the tracking links.
updates	RemediationItemsBulkUpdateDeleteDtoUpdates	Tracking links to set for the security problem. Map of remediation item ID to tracking link objects. Keys must be valid remediation item IDs of the security problem, the associated value must contain the link to set for the item.

RemediationItemsBulkUpdateDeleteDtoUpdates

Tracking links to set for the security problem.

Map of remediation item ID to tracking link objects.

Keys must be valid remediation item IDs of the security problem, the associated value must contain the link to set for the item.

type: Record<string, TrackingLinkUpdate | undefined>

RemediationProgress

The progress of this remediation item. It contains affected and unaffected entities.

Name	Type	Description
affectedEntities	Array<string>	A list of related entities that are affected by the security problem.
unaffectedEntities	Array<string>	A list of related entities that are affected by the security problem.

RemediationProgressEntity

An affected or unaffected entity of a remediation for a security problem.

Name	Type	Description
assessment	RemediationProgressEntityAssessment	Assessment of the remediation progress entity.
firstAffectedTimestamp	number	The timestamp when the remediation progress entity has first been related to the vulnerability.
id	string	The ID of the remediation progress entity.
name	string	The name of the remediation progress entity.
state	"AFFECTED" | "UNAFFECTED"	The current state of the remediation progress entity.
vulnerableComponents	Array<RemediationProgressVulnerableComponent>	A list of vulnerable components of the remediation item. A vulnerable component is what causes the security problem.

RemediationProgressEntityAssessment

Assessment of the remediation progress entity.

Name	Type	Description
vulnerableFunctionRestartRequired	boolean	Whether a restart is required for the latest vulnerable function data.
vulnerableFunctionUsage	"NOT_AVAILABLE" | "IN_USE" | "NOT_IN_USE"	The usage of vulnerable functions
vulnerableFunctionsInUse	Array<VulnerableFunction>	A list of vulnerable functions that are in use.
vulnerableFunctionsNotAvailable	Array<VulnerableFunction>	A list of vulnerable functions that are not available.
vulnerableFunctionsNotInUse	Array<VulnerableFunction>	A list of vulnerable functions that are not in use.

RemediationProgressEntityList

A list of remediation progress entities.

Name	Type	Description
remediationProgressEntities	Array<RemediationProgressEntity>	A list of remediation progress entities.

RemediationProgressVulnerableComponent

A vulnerable component with details for a remediation progress entity (PGI).

Name	Type	Description
displayName	string	The display name of the vulnerable component.
fileName	string	The file name of the vulnerable component.
id	string	The Dynatrace entity ID of the vulnerable component.
loadOrigins	Array<string>	The load origins of the vulnerable components.
shortName	string	The short, component-only name of the vulnerable component.

RequestInformation

Describes the complete request information of an attack.

Name	Type	Description
host	string	The target host of the request.
path	string	The request path.
protocolDetails	ProtocolDetails	Details that are specific to the used protocol.
url	string	The requested URL.

ResolutionRequest

Name	Type
permissions*required	Array<SinglePermissionRequest>

ResourceContext

The resource context, which contains additional permission information about the object.

Name	Type	Description
modifications*required	Modification	The additional modification details for this settings object.
operations*required	Array<"delete" | "read" | "write">	The allowed operations on this settings object.

RevisionDiff

The diff between two revisions.

Name	Type	Description
appId	string	The id of the app which changed the settings object
jsonAfter	string	The new value of the changed settings value or null if the value has been deleted.
jsonBefore	string	The previous value of the changed settings value or null if the value has been newly created.
jsonPatch	AnyValue	The JSON Patch for this value. May be null if the diff type is not UPDATE.
modificationInfo	HistoryModificationInfo	Modification information about the setting.
objectId	string	The ID of the settings object.
revision	string	The revision of the change.
schemaDisplayName	string	The display name of the schema to which the revision belongs.
schemaId	string	Schema ID to which the revision belongs.
schemaVersion	string	The schema version the new value complies to.
source	string	The source of the change.
summary	string	Summary of the object value corresponding to the summary pattern of the schema.
type	"CREATE" | "DELETE" | "REORDER" | "UPDATE" | "NO_CHANGE"	The type of the difference.

RevisionDiffPage

The paged response payload for diff between revisions of settings.

Name	Type	Description
endTime*required	string	The 'to' time in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') from the original request.
items*required	Array<RevisionDiff>	The list of revisions changes in the current page.
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize*required	number	The number of entries per page.
startTime*required	string	The 'from' time in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') from the original request.

RiskAssessment

Risk assessment of a security problem.

Name	Type	Description
assessmentAccuracy	"NOT_AVAILABLE" | "FULL" | "REDUCED"	The accuracy of the assessment.
assessmentAccuracyDetails	AssessmentAccuracyDetails	The assessment accuracy details.
baseRiskLevel	"NONE" | "CRITICAL" | "HIGH" | "LOW" | "MEDIUM"	The risk level from the CVSS score.
baseRiskScore	number	The risk score (1-10) from the CVSS score.
baseRiskVector	string	The original attack vector of the CVSS assessment.
dataAssets	"NOT_AVAILABLE" | "NOT_DETECTED" | "REACHABLE"	The reachability of related data assets by affected entities.
exposure	"NOT_AVAILABLE" | "NOT_DETECTED" | "PUBLIC_NETWORK"	The level of exposure of affected entities.
publicExploit	"NOT_AVAILABLE" | "AVAILABLE"	The availability status of public exploits.
riskLevel	"NONE" | "CRITICAL" | "HIGH" | "LOW" | "MEDIUM"	The Davis risk level. It is calculated by Dynatrace on the basis of CVSS score.
riskScore	number	The Davis risk score (1-10). It is calculated by Dynatrace on the basis of CVSS score.
riskVector	string	The attack vector calculated by Dynatrace based on the CVSS attack vector.
vulnerableFunctionUsage	"NOT_AVAILABLE" | "IN_USE" | "NOT_IN_USE"	The state of vulnerable code execution.

RiskAssessmentChanges

All changes of the risk assessment.

Name	Type	Description
deltaBaseRiskScore	number	The delta of the risk score.
deltaNumberOfAffectedNodes	number	The delta of the number of currently affected nodes.
deltaNumberOfAffectedProcessGroups	number	The delta of the number of currently affected process groups.
deltaNumberOfReachableDataAssets	number	The delta of the number of data assets that are currently reachable by affected entities.
deltaNumberOfRelatedAttacks	number	The delta of the number of related attacks.
deltaRiskScore	number	The delta of the Davis risk score.
previousExposure	"NOT_AVAILABLE" | "NOT_DETECTED" | "PUBLIC_NETWORK"	The previous level of exposure of affected entities.
previousPublicExploit	"NOT_AVAILABLE" | "AVAILABLE"	The previous availability status of public exploits.
previousVulnerableFunctionUsage	"NOT_AVAILABLE" | "IN_USE" | "NOT_IN_USE"	The previous state of vulnerable code execution.

RiskAssessmentDetails

Risk assessment of a security problem.

Name	Type	Description
assessmentAccuracy	"NOT_AVAILABLE" | "FULL" | "REDUCED"	The accuracy of the assessment.
assessmentAccuracyDetails	AssessmentAccuracyDetails	The assessment accuracy details.
baseRiskLevel	"NONE" | "CRITICAL" | "HIGH" | "LOW" | "MEDIUM"	The risk level from the CVSS score.
baseRiskScore	number	The risk score (1-10) from the CVSS score.
baseRiskVector	string	The original attack vector of the CVSS assessment.
dataAssets	"NOT_AVAILABLE" | "NOT_DETECTED" | "REACHABLE"	The reachability of related data assets by affected entities.
exposure	"NOT_AVAILABLE" | "NOT_DETECTED" | "PUBLIC_NETWORK"	The level of exposure of affected entities.
publicExploit	"NOT_AVAILABLE" | "AVAILABLE"	The availability status of public exploits.
riskLevel	"NONE" | "CRITICAL" | "HIGH" | "LOW" | "MEDIUM"	The Davis risk level. It is calculated by Dynatrace on the basis of CVSS score.
riskScore	number	The Davis risk score (1-10). It is calculated by Dynatrace on the basis of CVSS score.
riskVector	string	The attack vector calculated by Dynatrace based on the CVSS attack vector.
vulnerableFunctionRestartRequired	boolean	Whether a restart is required for new vulnerable function data.
vulnerableFunctionUsage	"NOT_AVAILABLE" | "IN_USE" | "NOT_IN_USE"	The state of vulnerable code execution.

RiskAssessmentSnapshot

A snapshot of the risk assessment of a security problem.

Name	Type	Description
baseRiskScore	number	The risk score (1-10) from the CVSS score.
changes	RiskAssessmentChanges	All changes of the risk assessment.
exposure	"NOT_AVAILABLE" | "NOT_DETECTED" | "PUBLIC_NETWORK"	The level of exposure of affected entities.
numberOfAffectedEntities	number	The number of currently affected entities.
numberOfAffectedNodes	number	The number of currently affected nodes.
numberOfAffectedProcessGroups	number	The number of currently affected process groups.
numberOfReachableDataAssets	number	The number of data assets that are currently reachable by affected entities.
numberOfRelatedAttacks	number	The number of related attacks.
publicExploit	"NOT_AVAILABLE" | "AVAILABLE"	The availability status of public exploits.
riskLevel	"NONE" | "CRITICAL" | "HIGH" | "LOW" | "MEDIUM"	The Davis risk level. It is calculated by Dynatrace on the basis of CVSS score.
riskScore	number	The Davis risk score (1-10). It is calculated by Dynatrace on the basis of CVSS score.
vulnerableFunctionUsage	"NOT_AVAILABLE" | "IN_USE" | "NOT_IN_USE"	The state of vulnerable code execution.

Rollup

A way of viewing a series as a single value for the purpose of sorting or series-based filters.

Name	Type
parameter	number
type	"AUTO" | "AVG" | "COUNT" | "MAX" | "MEDIAN" | "MIN" | "PERCENTILE" | "SUM" | "VALUE"

SLO

Parameters of a service-level objective (SLO).

Name	Type	Description
burnRateMetricKey*required	string	The key for the SLO's error budget burn rate func metric.
denominatorValueDEPRECATED	number	The denominator value used to evaluate the SLO when useRateMetric is set to false.
description	string	A short description of the SLO.
enabled*required	boolean	The SLO is enabled (true) or disabled (false).
error*required	string	The error of the SLO calculation. If the value differs from NONE, there is something wrong with the SLO calculation.
errorBudget*required	number	The error budget of the calculated SLO. The error budget is the difference between the calculated and target values. A positive number means all is good; a negative number means trouble. Has the value of the evaluated error budget or the value of -1: If there is an error with the SLO calculation; in that case check the value of the error property. If the evaluate parameter has not been set to true; in that case the error property will contain no error.
errorBudgetBurnRate*required	SloBurnRate	Error budget burn rate evaluation of a service-level objective (SLO).
errorBudgetMetricKey*required	string	The key for the SLO's error budget func metric.
evaluatedPercentage*required	number	The calculated status value of the SLO. Has the value of the evaluated SLO status or the value of -1: If there is an error with the SLO calculation; in that case check the value of the error property. If the evaluate parameter has not been set to true; in that case the error property will contain no error.
evaluationType*required	"AGGREGATE"	The evaluation type of the SLO.
filter*required	string	The entity filter for the SLO evaluation. The total length of the entitySelector string in SLOs is limited to 1,000 characters. Use the syntax of entity selector.
id*required	string	The ID of the SLO
metricDenominatorDEPRECATED	string	The total count metric (the denominator in rate calculation). Required when the useRateMetric is set to false.
metricExpression*required	string	The percentage-based metric expression for the calculation of the SLO.
metricKey*required	string	The key for the SLO's status func metric.
metricName*required	string	The name that is used to create SLO func metrics keys. Once created, metric name cannot be changed.
metricNumeratorDEPRECATED	string	The metric for the count of successes (the numerator in rate calculation). Required when the useRateMetric is set to false.
metricRateDEPRECATED	string	The percentage-based metric for the calculation of the SLO. Required when the useRateMetric is set to true.
name*required	string	The name of the SLO.
normalizedErrorBudgetMetricKey*required	string	The key for the SLO's normalized error budget func metric.
numeratorValueDEPRECATED	number	The numerator value used to evaluate the SLO when useRateMetric is set to false.
problemFiltersDEPRECATED	Array<string>	The entity filter for fetching the number of problems related to an SLO. Auto-generated in case no filter has been added to the SLO.
relatedOpenProblems	number	Number of open problems related to the SLO. Has the value of -1 if there's an error with fetching SLO related problems.
relatedTotalProblems	number	Total number of problems related to the SLO. Has the value of -1 if there's an error with fetching SLO related problems.
status*required	"WARNING" | "SUCCESS" | "FAILURE"	The status of the calculated SLO.
target*required	number	The target value of the SLO.
timeframe*required	string	The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector.
useRateMetricDEPRECATED	boolean	The type of the metric to use for SLO calculation: true: An existing percentage-based metric. false: A ratio of two metrics. For a list of available metrics, see Built-in metric page or try the GET metrics API call.
warning*required	number	The warning value of the SLO. At warning state the SLO is still fulfilled but is getting close to failure.

SLOs

Contains SLOs and paging information.

Name	Type	Description
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
slo*required	Array<SLO>	The list of SLOs.
totalCount*required	number	The total number of entries in the result.

SNMPV3Credentials

A credentials set of the SNMPV3 type.

Name	Type	Description
allowContextlessRequests	boolean	Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope).
allowedEntities	Array<CredentialAccessData>	The set of entities allowed to use the credential.
authenticationPassword	string	The authentication password in the string format (should not be empty for AUTH_PRIV and AUTH_NO_PRIV security levels)
authenticationProtocol	"MD5" | "SHA" | "SHA224" | "SHA256" | "SHA384" | "SHA512"	The authentication protocol, supported protocols: MD5, SHA, SHA224, SHA256, SHA384, SHA512
description	string	A short description of the credentials set.
id	string	The ID of the credentials set.
name*required	string	The name of the credentials set.
ownerAccessOnly	boolean	The credentials set is available to every user (false) or to owner only (true).
privacyPassword	string	The privacy password in the string format (should not be empty for AUTH_PRIV security level)
privacyProtocol	"AES" | "AES192" | "AES192C" | "AES256" | "AES256C" | "DES"	The privacy protocol
scopeDEPRECATED	"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"	The scope of the credentials set.
scopes*required	Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">	The set of scopes of the credentials set. Limitations: CredentialsScope.APP_ENGINE is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.
securityLevel	"AUTH_NO_PRIV" | "AUTH_PRIV" | "NO_AUTH_NO_PRIV"	The security level, supported levels: AUTH_PRIV, NO_AUTH_NO_PRIV, AUTH_NO_PRIV
type*required	"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"	Defines the actual set of fields depending on the value. See one of the following objects: CERTIFICATE -> CertificateCredentials PUBLIC_CERTIFICATE -> PublicCertificateCredentials USERNAME_PASSWORD -> UserPasswordCredentials TOKEN -> TokenCredentials SNMPV3 -> SNMPV3Credentials AWS_MONITORING_KEY_BASED -> AWSKeyBasedCredentialsDto AWS_MONITORING_ROLE_BASED -> AWSRoleBasedCredentials
username	string	User name value

SchemaConstraintRestDto

Name	Type	Description
byteLimit	number	The maximum allowed size in bytes for the sum over all persisted values for the schema
customMessage	string	A custom message for invalid values.
customValidatorId	string	The ID of a custom validator.
skipAsyncValidation	boolean	Whether to skip validation on a change made from the UI.
type*required	"UNKNOWN" | "CUSTOM_VALIDATOR_REF" | "UNIQUE" | "BYTE_SIZE_LIMIT" | "MULTI_SCOPE_CUSTOM_VALIDATOR_REF" | "MULTI_SCOPE_UNIQUE"	The type of the schema constraint.
uniqueProperties	Array<string>	The list of properties for which the combination of values needs to be unique

SchemaDefinitionRestDto

Name	Type	Description
allowedScopes*required	Array<string>	A list of scopes where the schema can be used.
constraints	Array<ComplexConstraint>	A list of constrains limiting the values to be accepted by the schema.
deletionConstraints	Array<DeletionConstraint>	Constraints limiting the values to be deleted.
description*required	string	A short description of the schema.
displayName*required	string	The display name of the schema.
documentation	string	An extended description of the schema and/or links to documentation.
dynatrace*required	string	The version of the data format.
enums*required	SchemaDefinitionRestDtoEnums	A list of definitions of enum properties.
keyProperty	string	Name of the key property in this schema.
maxObjects*required	number	The maximum amount of objects per scope. Only applicable when multiObject is set to true.
metadata	SchemaDefinitionRestDtoMetadata	Metadata of the setting.
multiObject*required	boolean	Multiple (true) objects per scope are permitted or a single (false) object per scope is permitted.
ordered	boolean	If true the order of objects has semantic significance. Only applicable when multiObject is set to true.
properties*required	SchemaDefinitionRestDtoProperties	A list of schema's properties.
schemaConstraints	Array<SchemaConstraintRestDto>	Constraints limiting the values as a whole to be accepted in this configuration element.
schemaGroups	Array<string>	Names of the groups, which the schema belongs to.
schemaId*required	string	The ID of the schema.
tableColumns	SchemaDefinitionRestDtoTableColumns	Table column definitions for use in the ui.
types*required	SchemaDefinitionRestDtoTypes	A list of definitions of types. A type is a complex property that contains its own set of subproperties.
uiCustomization	UiCustomization	Customization for UI elements
version*required	string	The version of the schema.

SchemaDefinitionRestDtoEnums

A list of definitions of enum properties.

type: Record<string, EnumType | undefined>

SchemaDefinitionRestDtoMetadata

Metadata of the setting.

type: Record<string, string | undefined>

SchemaDefinitionRestDtoProperties

A list of schema's properties.

type: Record<string, PropertyDefinition | undefined>

SchemaDefinitionRestDtoTableColumns

Table column definitions for use in the ui.

type: Record<string, TableColumn | undefined>

SchemaDefinitionRestDtoTypes

A list of definitions of types.

A type is a complex property that contains its own set of subproperties.

type: Record<string, SchemaType | undefined>

SchemaFiles

Name	Type	Description
files*required	Array<string>	A list of schema files.

SchemaList

The list of available settings schemas.

Name	Type	Description
items*required	Array<SchemaStub>	A list of settings schemas.
totalCount*required	number	The number of schemas in the list.

SchemaStub

The short representation of the settings schema.

Name	Type	Description
displayName	string	The name of the schema.
latestSchemaVersion	string	The most recent version of the schema.
multiObject	boolean	Multi-object flag. True if the schema is a multi-object schema
ordered	boolean	Ordered flag. True if the schema is an ordered multi-object schema.
ownerBasedAccessControl	boolean	Owner based access control flag. True if the schema has owner based access control enabled.
schemaId	string	The ID of the schema.

SchemaType

A list of definitions of types.

A type is a complex property that contains its own set of subproperties.

Name	Type	Description
constraints	Array<ComplexConstraint>	A list of constraints limiting the values to be accepted.
description*required	string	A short description of the property.
displayName	string	The display name of the property.
documentation*required	string	An extended description and/or links to documentation.
properties*required	SchemaTypeProperties	Definition of properties that can be persisted.
searchPattern	string	The pattern for the summary search(for example, "Alert after X minutes.") of the configuration in the UI.
summaryPattern*required	string	The pattern for the summary (for example, "Alert after X minutes.") of the configuration in the UI.
type*required	"object"	Type of the reference type.
version*required	string	The version of the type.
versionInfo	string	A short description of the version.

SchemaTypeProperties

Definition of properties that can be persisted.

type: Record<string, PropertyDefinition | undefined>

SchemasList

Name	Type	Description
versions*required	Array<string>	A list of schema versions.

SecurityContextDtoImpl

Name	Type	Description
securityContext	Array<string>	The security context, that will be set for matching entities. If there exists a management zone with this name, it will be set for all matching entities, overriding all automatic management zone rules.

SecurityContextResultDto

The response payload holding the result of the security context application.

Name	Type	Description
entityIds	Array<string>	The entity ids that matched the entity selector and now have the supplied security context set.
managementZoneIds	Array<number>	The management zone ids that is applied to the entity ids, if the security context matched an existing management zone's name, otherwise null.

SecurityProblem

Parameters of a security problem

Name	Type	Description
codeLevelVulnerabilityDetails	CodeLevelVulnerabilityDetails	The details of a code-level vulnerability.
cveIds	Array<string>	A list of CVE IDs of the security problem.
displayId	string	The display ID of the security problem.
externalVulnerabilityId	string	The external vulnerability ID of the security problem.
firstSeenTimestamp	number	The timestamp of the first occurrence of the security problem.
globalCounts	GlobalCountsDto	Globally calculated statistics about the security problem. No management zone information is taken into account.
lastOpenedTimestamp	number	The timestamp when the security problem was last opened.
lastResolvedTimestamp	number	The timestamp when the security problem was last resolved.
lastUpdatedTimestamp	number	The timestamp of the most recent security problem change.
managementZones	Array<ManagementZone>	A list of management zones which the affected entities belong to.
muted	boolean	The security problem is (true) or is not (false) muted.
packageName	string	The package name of the security problem.
riskAssessment	RiskAssessment	Risk assessment of a security problem.
securityProblemId	string	The ID of the security problem.
status	"OPEN" | "RESOLVED"	The status of the security problem.
technology	"KUBERNETES" | "DOTNET" | "GO" | "JAVA" | "NODE_JS" | "PHP" | "PYTHON"	The technology of the security problem.
title	string	The title of the security problem.
url	string	The URL to the security problem details page.
vulnerabilityType	"CODE_LEVEL" | "RUNTIME" | "THIRD_PARTY"	The type of the vulnerability.

SecurityProblemBulkMutingSummary

Summary of (un-)muting a security problem.

Name	Type	Description
muteStateChangeTriggered*required	boolean	Whether a mute state change for the given security problem was triggered by this request.
reason	"ALREADY_MUTED" | "ALREADY_UNMUTED"	Contains a reason, in case the requested operation was not executed.
securityProblemId*required	string	The id of the security problem that was (un-)muted.

SecurityProblemDetails

Parameters of a security problem

Name	Type	Description
affectedEntities	Array<string>	A list of affected entities of the security problem. An affected entity is an entity where a vulnerable component runs.
codeLevelVulnerabilityDetails	CodeLevelVulnerabilityDetails	The details of a code-level vulnerability.
cveIds	Array<string>	A list of CVE IDs of the security problem.
description	string	The description of the security problem.
displayId	string	The display ID of the security problem.
entryPoints	EntryPoints	A list of entry points and a flag which indicates whether this list was truncated or not.
events	Array<SecurityProblemEvent>	An ordered (newest first) list of events of the security problem.
exposedEntities	Array<string>	A list of exposed entities of the security problem. An exposed entity is an affected entity that is exposed to the internet.
externalVulnerabilityId	string	The external vulnerability ID of the security problem.
filteredCounts	FilteredCountsDto	Statistics about the security problem, filtered by the management zone and timeframe start ('from') query parameters.
firstSeenTimestamp	number	The timestamp of the first occurrence of the security problem.
globalCounts	GlobalCountsDto	Globally calculated statistics about the security problem. No management zone information is taken into account.
lastOpenedTimestamp	number	The timestamp when the security problem was last opened.
lastResolvedTimestamp	number	The timestamp when the security problem was last resolved.
lastUpdatedTimestamp	number	The timestamp of the most recent security problem change.
managementZones	Array<ManagementZone>	A list of management zones which the affected entities belong to.
muteStateChangeInProgress	boolean	If true a change of the mute state is in progress.
muted	boolean	The security problem is (true) or is not (false) muted.
packageName	string	The package name of the security problem.
reachableDataAssets	Array<string>	A list of data assets reachable by affected entities of the security problem. A data asset is a service that has database access.
relatedAttacks	RelatedAttacksList	A list of related attacks of the security problem. Related attacks are attacks on the exposed security problem.
relatedContainerImages	RelatedContainerList	A list of related container images.
relatedEntities	RelatedEntitiesList	A list of related entities of the security problem. A related entity is a monitored entity that is directly or indirectly related to an affected entity (for example, it could be a host where an affected process runs). Each related entity contains a list of corresponding affected entities (for example, an affected process running on this host).
remediationDescription	string	Description of how to remediate the vulnerability.
riskAssessment	RiskAssessmentDetails	Risk assessment of a security problem.
securityProblemId	string	The ID of the security problem.
status	"OPEN" | "RESOLVED"	The status of the security problem.
technology	"KUBERNETES" | "DOTNET" | "GO" | "JAVA" | "NODE_JS" | "PHP" | "PYTHON"	The technology of the security problem.
title	string	The title of the security problem.
url	string	The URL to the security problem details page.
vulnerabilityType	"CODE_LEVEL" | "RUNTIME" | "THIRD_PARTY"	The type of the vulnerability.
vulnerableComponents	Array<VulnerableComponent>	A list of vulnerable components of the security problem. A vulnerable component is what causes the security problem.

SecurityProblemEvent

The event of a security problem.

Name	Type	Description
muteState	MuteState	Metadata of the muted state of a security problem in relation to an event.
reason	"ASSESSMENT_CHANGED" | "SECURITY_PROBLEM_CREATED" | "SECURITY_PROBLEM_MUTED" | "SECURITY_PROBLEM_REOPENED" | "SECURITY_PROBLEM_RESOLVED" | "SECURITY_PROBLEM_UNMUTED"	The reason of the event creation.
riskAssessmentSnapshot	RiskAssessmentSnapshot	A snapshot of the risk assessment of a security problem.
timestamp	number	The timestamp when the event occurred.

SecurityProblemEventsList

A list of events for a security problem.

Name	Type	Description
events	Array<SecurityProblemEvent>	A list of events for a security problem.
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

SecurityProblemList

A list of security problems.

Name	Type	Description
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
securityProblems	Array<SecurityProblem>	A list of security problems.
totalCount*required	number	The total number of entries in the result.

SecurityProblemMute

Information on muting a security problem.

Name	Type	Description
comment	string	A comment about the muting reason.
reason*required	"OTHER" | "CONFIGURATION_NOT_AFFECTED" | "FALSE_POSITIVE" | "IGNORE" | "VULNERABLE_CODE_NOT_IN_USE"	The reason for muting a security problem.

SecurityProblemUnmute

Information on un-muting a security problem.

Name	Type	Description
comment	string	A comment about the un-muting reason.
reason*required	"AFFECTED"	The reason for un-muting a security problem.

SecurityProblemsBulkMute

Information on muting several security problems.

Name	Type	Description
comment	string	A comment about the muting reason.
reason*required	"OTHER" | "CONFIGURATION_NOT_AFFECTED" | "FALSE_POSITIVE" | "IGNORE" | "VULNERABLE_CODE_NOT_IN_USE"	The reason for muting the security problems.
securityProblemIds*required	Array<string>	The ids of the security problems to be muted.

SecurityProblemsBulkMuteResponse

Response of muting several security problems.

Name	Type	Description
summary*required	Array<SecurityProblemBulkMutingSummary>	The summary of which security problems were muted and which already were muted previously.

SecurityProblemsBulkUnmute

Information on un-muting several security problems.

Name	Type	Description
comment	string	A comment about the un-muting reason.
reason*required	"AFFECTED"	The reason for un-muting the security problems.
securityProblemIds*required	Array<string>	The ids of the security problems to be un-muted.

SecurityProblemsBulkUnmuteResponse

Response of un-muting several security problems.

Name	Type	Description
summary*required	Array<SecurityProblemBulkMutingSummary>	The summary of which security problems were un-muted and which already were un-muted previously.

ServiceImpact

Analysis of problem impact to a service.

Name	Type	Description
estimatedAffectedUsers*required	number	The estimated number of affected users.
impactType*required	"APPLICATION" | "CUSTOM_APPLICATION" | "MOBILE" | "SERVICE"	Defines the actual set of fields depending on the value. See one of the following objects: SERVICE -> ServiceImpact APPLICATION -> ApplicationImpact MOBILE -> MobileImpact CUSTOM_APPLICATION -> CustomApplicationImpact
impactedEntity*required	EntityStub	A short representation of a monitored entity.
numberOfPotentiallyAffectedServiceCalls	number	The number of potentially impacted services.

SettingsObject

A settings object.

Name	Type	Description
author	string	The user (identified by a user ID or a public token ID) who performed that most recent modification.
created	number	The timestamp of the creation.
createdBy	string	The unique identifier of the user who created the settings object.
externalId	string	The external identifier of the settings object.
modificationInfoDEPRECATED	ModificationInfo	The modification info for a single updatable setting. Replaced by resourceContext.
modified	number	The timestamp of the last modification.
modifiedBy	string	The unique identifier of the user who performed the most recent modification.
objectId	string	The ID of the settings object.
owner	Identity	An Identity describing either a user, a group, or the all-users group (applying to all users).
resourceContext	ResourceContext	The resource context, which contains additional permission information about the object.
schemaId	string	The schema on which the object is based.
schemaVersion	string	The version of the schema on which the object is based.
scope	string	The scope that the object targets. For more details, please see Dynatrace Documentation.
searchSummary	string	A searchable summary string of the setting value. Plain text without Markdown.
summary	string	A short summary of settings. This can contain Markdown and will be escaped accordingly.
updateToken	string	The update token of the object. You can use it to detect simultaneous modifications by different users. It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update. If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
value	AnyValue	The value of the setting. It defines the actual values of settings' parameters. The actual content depends on the object's schema.

SettingsObjectByObjectIdResponse

The response to a get by objectId request.

Name	Type	Description
author	string	The user (identified by a user ID or a public token ID) who performed that most recent modification.
created	number	The timestamp of the creation.
createdBy	string	The unique identifier of the user who created the settings object.
externalId	string	The external identifier of the settings object.
modified	number	The timestamp of the last modification.
modifiedBy	string	The unique identifier of the user who performed the most recent modification.
objectId	string	The ID of the settings object.
owner	Identity	An Identity describing either a user, a group, or the all-users group (applying to all users).
resourceContext	ResourceContext	The resource context, which contains additional permission information about the object.
schemaId	string	The schema on which the object is based.
schemaVersion	string	The version of the schema on which the object is based.
scope	string	The scope that the object targets. For more details, please see Dynatrace Documentation.
searchSummary	string	A searchable summary string of the setting value. Plain text without Markdown.
summary	string	A short summary of settings. This can contain Markdown and will be escaped accordingly.
updateToken	string	The update token of the object. You can use it to detect simultaneous modifications by different users. It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update. If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
value	AnyValue	The value of the setting. It defines the actual values of settings' parameters. The actual content depends on the object's schema.

SettingsObjectCreate

Configuration of a new settings object.

Name	Type	Description
externalId	string	External identifier for the object being created
insertAfter	string	The position of the new object. The new object will be added after the specified one. If null (or unset), the new object will be placed in the last position. If set to an empty string, the new object will be placed in the first position. Only applicable for objects based on schemas with ordered objects (schema's ordered parameter is set to true).
objectId	string	The ID of the settings object that should be replaced. Only applicable if an external identifier is provided.
schemaId*required	string	The schema on which the object is based.
schemaVersion	string	The version of the schema on which the object is based.
scope*required	string	The scope that the object targets. For more details, please see Dynatrace Documentation.
value*required	AnyValue	The value of the setting. It defines the actual values of settings' parameters. The actual content depends on the object's schema.

SettingsObjectResponse

The response to a creation- or update-request.

Name	Type	Description
code*required	number	The HTTP status code for the object.
error	Error
invalidValue	AnyValue	The value of the setting. It defines the actual values of settings' parameters. The actual content depends on the object's schema.
objectId	string	For a successful request, the ID of the created or modified settings object.

SettingsObjectUpdate

An update of a settings object.

Name	Type	Description
insertAfter	string	The position of the updated object. The new object will be moved behind the specified one. insertAfter and insertBefore are evaluated together and only one of both can be set (and be non null). If null (or unset) and insertBefore is null (or unset), the existing object keeps the current position. If set to an empty string, the updated object will be placed in the first position. Only applicable for objects based on schemas with ordered objects (schema's ordered parameter is set to true).
insertBefore	string	The position of the updated object. The new object will be moved in front of the specified one. insertAfter and insertBefore are evaluated together and only one of both can be set (and be non null). If null (or unset) and insertAfter is null (or unset), the existing object keeps the current position. If set to an empty string, the updated object will be placed in the last position. Only applicable for objects based on schemas with ordered objects (schema's ordered parameter is set to true).
schemaVersion	string	The version of the schema on which the object is based.
updateToken	string	The update token of the object. You can use it to detect simultaneous modifications by different users. It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update. If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
value*required	AnyValue	The value of the setting. It defines the actual values of settings' parameters. The actual content depends on the object's schema.

SinglePermissionRequest

A list of permissions.

Name	Type	Description
context	PermissionContext	Optional context data
permission*required	string	Permission to be probed

SloBurnRate

Error budget burn rate evaluation of a service-level objective (SLO).

Name	Type	Description
burnRateType	"NONE" | "FAST" | "SLOW"	The calculated burn rate type. Has a value of 'FAST', 'SLOW' or 'NONE'.
burnRateValue	number	The burn rate of the SLO, calculated for the last hour.
burnRateVisualizationEnabled*required	boolean	The error budget burn rate calculation is enabled (true) or disabled (false). In case of false, no calculated values will be present here.
estimatedTimeToConsumeErrorBudget	number	The estimated time left to consume the error budget in hours.
fastBurnThreshold	number	The threshold between a slow and a fast burn rate.
sloValue	number	The calculated value of the SLO for the timeframe chosen for the burn rate calculation.

SloBurnRateConfig

Error budget burn rate configuration of a service-level objective (SLO).

Name	Type	Description
burnRateVisualizationEnabled	boolean	The error budget burn rate calculation is enabled (true) or disabled (false). In case of false, no calculated values will be present here. If not defined, the error budget burn rate calculation is disabled by default.
fastBurnThreshold	number	The threshold between a slow and a fast burn rate.

SloConfigItemDtoImpl

Name	Type	Description
description	string	The description of the SLO.
enabled	boolean	The SLO is enabled (true) or disabled (false). If not defined, the SLO is disabled by default.
errorBudgetBurnRate	SloBurnRateConfig	Error budget burn rate configuration of a service-level objective (SLO).
evaluationType*required	"AGGREGATE"	The evaluation type of the SLO.
filter	string	The entity filter for the SLO evaluation. The total length of the entitySelector string in SLOs is limited to 1,000 characters. Use the syntax of entity selector.
metricDenominatorDEPRECATED	string	The total count metric (the denominator in rate calculation). Required when the useRateMetric is set to false.
metricExpression	string	The percentage-based metric expression for the calculation of the SLO.
metricName	string	The name that is used to create SLO func metrics keys. Once created, metric name cannot be changed.
metricNumeratorDEPRECATED	string	The metric for the count of successes (the numerator in rate calculation). Required when the useRateMetric is set to false.
metricRateDEPRECATED	string	The percentage-based metric for the calculation of the SLO. Required when the useRateMetric is set to true.
name*required	string	The name of the SLO.
target*required	number	The target value of the SLO.
timeframe*required	string	The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector.
useRateMetricDEPRECATED	null | boolean	The type of the metric to use for SLO calculation: true: An existing percentage-based metric. false: A ratio of two metrics. For a list of available metrics, see Built-in metric page or try the GET metrics API call.
warning*required	number	The warning value of the SLO. At warning state the SLO is still fulfilled but is getting close to failure.

SoftwareTechs

Contains information about the used software technology.

Name	Type	Description
edition	string	The edition of the technology.
technology	string	The type of the technology.
verbatimType	string	The verbatim type of the technology.
version	string	The version of the technology.

StatusAlert

Parameters of a status alert.

Name	Type	Description
alertName*required	string	Name of the alert.
alertThreshold*required	number	Threshold of the alert. Status alerts trigger if they fall below this value, burn rate alerts trigger if they exceed the value.
alertType*required	"BURN_RATE" | "STATUS"	Defines the actual set of fields depending on the value. See one of the following objects: BURN_RATE -> BurnRateAlert STATUS -> StatusAlert

Success

Name	Type	Description
code	number	The HTTP status code
message	string	Detailed message

SuccessEnvelope

Name	Type
details	Success

SyntheticConfigDto

A DTO for synthetic configuration.

Name	Type	Description
bmMonitorTimeout*required	number	bmMonitorTimeout - browser monitor execution timeout (ms)
bmStepTimeout*required	number	bmStepTimeout - browser monitor single step execution timeout (ms)

SyntheticLocation

Configuration of a synthetic location.

countryCode, regionCode, city parameters are optional as they can be retrieved based on latitude and longitude of location.

The actual set of fields depends on the type of the location. Find the list of actual objects in the description of the type field or see Synthetic locations API v2 - JSON models.

Name	Type	Description
city	string	The city of the location.
countryCode	string	The country code of the location. To fetch the list of available country codes, use the GET all countries request.
countryName	string	The country name of the location.
entityId	string	The Dynatrace entity ID of the location.
geoLocationId	string	The Dynatrace GeoLocation ID of the location.
latitude*required	number	The latitude of the location in DDD.dddd format.
longitude*required	number	The longitude of the location in DDD.dddd format.
name*required	string	The name of the location.
regionCode	string	The region code of the location. To fetch the list of available region codes, use the GET regions of the country request.
regionName	string	The region name of the location.
status	"ENABLED" | "DISABLED" | "HIDDEN"	The status of the location: ENABLED: The location is displayed as active in the UI. You can assign monitors to the location. DISABLED: The location is displayed as inactive in the UI. You can't assign monitors to the location. Monitors already assigned to the location will stay there and will be executed from the location. HIDDEN: The location is not displayed in the UI. You can't assign monitors to the location. You can only set location as HIDDEN when no monitor is assigned to it.
type*required	"CLUSTER" | "PUBLIC" | "PRIVATE"	Defines the actual set of fields depending on the value. See one of the following objects: PUBLIC -> PublicSyntheticLocation PRIVATE -> PrivateSyntheticLocation CLUSTER -> PrivateSyntheticLocation

SyntheticLocationIdsDto

A DTO for synthetic Location IDs.

Name	Type	Description
entityId*required	string	Entity ID to be transferred
geoLocationId*required	string	GeoLocation ID to be transferred

SyntheticLocationUpdate

The synthetic location update. This is a base object, the exact type depends on the value of the type field.

Name	Type	Description
type*required	"PUBLIC" | "PRIVATE"	Defines the actual set of fields depending on the value. See one of the following objects: PUBLIC -> SyntheticPublicLocationUpdate PRIVATE -> SyntheticPrivateLocationUpdate

SyntheticLocations

A list of synthetic locations.

Name	Type	Description
locations*required	Array<LocationCollectionElement>	A list of synthetic locations.

SyntheticMonitorConstraintDto

Synthetic monitor constraint.

Name	Type	Description
properties*required	SyntheticMonitorConstraintDtoProperties	The properties of the constraint.
type*required	string	Constraint type.

SyntheticMonitorConstraintDtoProperties

The properties of the constraint.

type: Record<string, string | undefined>

SyntheticMonitorListDto

List of available synthetic monitors.

Name	Type	Description
monitors	Array<SyntheticMonitorSummaryDto>	List of monitors.

SyntheticMonitorOutageHandlingSettingsDto

Outage handling configuration.

Name	Type	Description
globalConsecutiveOutageCountThreshold	number	Number of consecutive failures for all locations.
globalOutages*required	boolean	Generate a problem and send an alert when the monitor is unavailable at all configured locations.
localConsecutiveOutageCountThreshold	number	Number of consecutive failures.
localLocationOutageCountThreshold	number	Number of failing locations.
localOutages*required	boolean	Generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location.

SyntheticMonitorPerformanceThresholdDto

The performance threshold rule.

Name	Type	Description
aggregation	"AVG" | "MAX" | "MIN"	Aggregation type default: "AVG"
dealertingSamples	number	Number of most recent non-violating request executions that closes the problem
samples	number	Number of request executions in analyzed sliding window (sliding window size)
stepIndex	number	Specify the step's index to which a threshold applies.
threshold*required	number	Notify if monitor request takes longer than X milliseconds to execute.
type	"MONITOR" | "STEP"	Type of performance threshold
violatingSamples	number	Number of violating request executions in analyzed sliding window

SyntheticMonitorPerformanceThresholdsDto

Performance thresholds configuration.

Name	Type	Description
enabled*required	boolean	Performance threshold is enabled (true) or disabled (false).
thresholds	Array<SyntheticMonitorPerformanceThresholdDto>	The list of performance threshold rules.

SyntheticMonitorSummaryDto

Basic monitor data.

Name	Type	Description
enabled	boolean	If true, the monitor is enabled. default: true
entityId*required	string	The entity id of the monitor.
name*required	string	The name of the monitor.
type*required	"BROWSER" | "HTTP" | "THIRD_PARTY" | "MULTI_PROTOCOL"

SyntheticMultiProtocolMonitorRequest

Network Availability monitor.

Name	Type	Description
description	string	Monitor description
enabled	boolean	If true, the monitor is enabled. default: true
frequencyMin	number	The frequency of the monitor, in minutes.
locations*required	Array<string>	The locations to which the monitor is assigned.
name*required	string	The name of the monitor.
performanceThresholds	SyntheticMonitorPerformanceThresholdsDto	Performance thresholds configuration.
steps*required	Array<SyntheticMultiProtocolMonitorStepDto>	The steps of the monitor.
syntheticMonitorOutageHandlingSettings	SyntheticMonitorOutageHandlingSettingsDto	Outage handling configuration.
tags	Array<SyntheticTagWithSourceDto>	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 SyntheticTagWithSourceDto model.
type*required	"MULTI_PROTOCOL"	Monitor type.

SyntheticMultiProtocolMonitorResponse

Network Availability monitor.

Name	Type	Description
description	string	Monitor description
enabled	boolean	If true, the monitor is enabled. default: true
entityId*required	string	The entity id of the monitor.
frequencyMin	number	The frequency of the monitor, in minutes.
locations*required	Array<string>	The locations to which the monitor is assigned.
modificationTimestamp	number	The timestamp of the last modification
name*required	string	The name of the monitor.
performanceThresholds	SyntheticMonitorPerformanceThresholdsDto	Performance thresholds configuration.
steps*required	Array<SyntheticMultiProtocolMonitorStepDto>	The steps of the monitor.
syntheticMonitorOutageHandlingSettings*required	SyntheticMonitorOutageHandlingSettingsDto	Outage handling configuration.
tags	Array<SyntheticTagWithSourceDto>	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 SyntheticTagWithSourceDto model.
type*required	"BROWSER" | "HTTP" | "MULTI_PROTOCOL"	Monitor type.

SyntheticMultiProtocolMonitorStepDto

The step of a network availability monitor.

Name	Type	Description
constraints*required	Array<SyntheticMonitorConstraintDto>	The list of constraints which apply to all requests in the step.
name*required	string	Step name.
properties*required	SyntheticMultiProtocolMonitorStepDtoProperties	The properties which apply to all requests in the step.
requestConfigurations*required	Array<SyntheticMultiProtocolRequestConfigurationDto>	Request configurations.
requestType*required	"ICMP" | "TCP" | "DNS"	Request type.
targetFilter	string	Target filter.
targetList	Array<string>	Target list.

SyntheticMultiProtocolMonitorStepDtoProperties

The properties which apply to all requests in the step.

type: Record<string, string | undefined>

SyntheticMultiProtocolRequestConfigurationDto

The configuration of a network availability monitor request.

Name	Type	Description
constraints*required	Array<SyntheticMonitorConstraintDto>	Request constraints.

SyntheticOnDemandBatchStatus

Contains information about on-demand executions triggered within the batch.

Name	Type	Description
batchId*required	string	The identifier of the batch.
batchStatus*required	"SUCCESS" | "FAILED" | "NOT_TRIGGERED" | "FAILED_TO_EXECUTE" | "RUNNING"	The status of the batch.
executedCount*required	number	The number of triggered executions with the result SUCCESS or FAILED.
failedCount*required	number	The number of triggered executions with the result FAILED.
failedExecutions	Array<SyntheticOnDemandFailedExecutionStatus>
failedToExecute	Array<SyntheticOnDemandFailedExecutionStatus>
failedToExecuteCount*required	number	The number of executions that were triggered and timed out because of a problem with the Synthetic engine.
metadata	SyntheticOnDemandBatchStatusMetadata	String to string map of metadata properties for batch
triggeredCount*required	number	The number of triggered executions within the batch.
triggeringProblems	Array<SyntheticOnDemandTriggeringProblemDetails>
triggeringProblemsCount	number	The number of executions that were not triggered due to some problems.
userId*required	string	The name of the user who triggered execution of the batch.

SyntheticOnDemandBatchStatusMetadata

String to string map of metadata properties for batch

type: Record<string, string | undefined>

SyntheticOnDemandExecution

Describes the status of an on-demand execution.

Name	Type	Description
batchId*required	string	The identifier of the batch.
customizedScript	ObjectNode	Customized script properties for this on-demand batch execution.
dataDeliveryTimestamp*required	number	The timestamp when whole data set has been collected on server, in UTC milliseconds.
executionId*required	string	The identifier of the execution.
executionStage*required	"TRIGGERED" | "EXECUTED" | "DATA_RETRIEVED" | "NOT_TRIGGERED" | "TIMED_OUT" | "WAITING"	Execution stage.
executionTimestamp*required	number	The timestamp when execution was finished, in UTC milliseconds.
fullResults	ExecutionFullResults	Contains extended monitor's execution details.
locationId*required	string	The identifier of the location from where the monitor is to be executed.
metadata	SyntheticOnDemandExecutionMetadata	Metadata map for the execution batch.
monitorId*required	string	The identifier of the monitor.
nextExecutionId	number	Next execution id for sequential mode.
processingMode*required	"UNKNOWN" | "NONE" | "STANDARD" | "DISABLE_PROBLEM_DETECTION" | "EXECUTIONS_DETAILS_ONLY"	The processing mode of the execution.
schedulingTimestamp*required	number	The scheduling timestamp, in UTC milliseconds.
simpleResults	ExecutionSimpleResults	Contains basic results of the monitor's on-demand execution.
source*required	"API" | "UI"	The source of the triggering request.
userId*required	string	The name of the user who triggered the on-demand execution.

SyntheticOnDemandExecutionMetadata

Metadata map for the execution batch.

type: Record<string, string | undefined>

SyntheticOnDemandExecutionRequest

Contains parameters for the on-demand execution of monitors identified by tags, applications, or services.

Name	Type	Description
failOnPerformanceIssue	boolean	If true, the execution will fail in case of performance issue. default: true
failOnSslWarning	boolean	Applies to HTTP monitors only. If true, the execution will fail in case of an SSL certificate expiration warning or if the certificate is missing. default: true
group	SyntheticOnDemandExecutionRequestGroup	Contains parameters for the on-demand execution of monitors identified by tags, applications, or services.
metadata	SyntheticOnDemandExecutionRequestMetadata	String to string map of metadata properties for execution
monitors	Array<SyntheticOnDemandExecutionRequestMonitor>	List of monitors to be triggered.
processingMode	"STANDARD" | "DISABLE_PROBLEM_DETECTION" | "EXECUTIONS_DETAILS_ONLY"	The execution's processing mode default: "STANDARD"
stopOnProblem	boolean	If true, no executions will be scheduled if a problem occurs. default: false
takeScreenshotsOnSuccess	boolean	If true, the screenshots will be taken during the execution of a browser monitor. default: false

SyntheticOnDemandExecutionRequestGroup

Contains parameters for the on-demand execution of monitors identified by tags, applications, or services.

Name	Type	Description
applications	Array<string>	List of application identifiers. Only monitors with all applications assigned will be executed.
locations	Array<string>	The locations from where monitors are to be executed.
services	Array<string>	List of service identifiers. Only monitors with all services assigned will be executed.
tags	Array<string>	List of tags. Only monitors with all tags assigned will be executed.

SyntheticOnDemandExecutionRequestMetadata

String to string map of metadata properties for execution

type: Record<string, string | undefined>

SyntheticOnDemandExecutionRequestMonitor

Contains monitors to be executed on demand from the locations specified.

Name	Type	Description
customizedScript	SyntheticOnDemandExecutionRequestMonitorCustomizedScript	Customized script properties for this on-demand batch execution.
executionCount	number	The number of times the monitor is to be executed per location; if not set, the monitor will be executed once. default: 1
locations	Array<string>	The locations from where the monitor is to be executed.
monitorId*required	string	The monitor identifier.
repeatMode	"SEQUENTIAL" | "PARALLEL"	Execution repeat mode. If not set, the mode is SEQUENTIAL. default: "SEQUENTIAL"

SyntheticOnDemandExecutionResult

The result of on-demand synthetic monitor execution.

Name	Type	Description
batchId*required	string	The batch identifier of the triggered executions.
triggered	Array<SyntheticOnDemandTriggeredMonitor>	Monitors for which on-demand executions were triggered.
triggeredCount*required	number	The total number of the triggered executions within the batch.
triggeringProblemsCount*required	number	The total number of problems within the batch.
triggeringProblemsDetails	Array<SyntheticOnDemandTriggeringProblemDetails>	List with the entities for which triggering problems occurred.

SyntheticOnDemandExecutions

Contains a list of synthetic on-demand executions.

Name	Type	Description
executions*required	Array<SyntheticOnDemandExecution>	The list of executions.

SyntheticOnDemandFailedExecutionStatus

Contains information about on-demand executions that failed or failed to be executed.

Name	Type	Description
errorCode*required	string	Error code.
executionId*required	string	The identifier of the execution.
executionStage	"TRIGGERED" | "EXECUTED" | "DATA_RETRIEVED" | "NOT_TRIGGERED" | "TIMED_OUT" | "WAITING"	Execution stage.
executionTimestamp	number	The timestamp when execution was finished, in UTC milliseconds.
failureMessage	string	Failure message.
locationId*required	string	The identifier of the location from where the monitor is to be executed.
monitorId*required	string	The identifier of the monitor.

SyntheticOnDemandTriggeredExecutionDetails

Contains details of the triggered on-demand execution.

Name	Type	Description
executionId*required	string	The execution's identifier.
locationId*required	string	The identifier of the location from which the monitor is to be executed.

SyntheticOnDemandTriggeredMonitor

Contains the list of on-demand executions of the monitor.

Name	Type	Description
executions*required	Array<SyntheticOnDemandTriggeredExecutionDetails>	The list of triggered executions.
monitorId*required	string	The monitor identifier.

SyntheticOnDemandTriggeringProblemDetails

Contains the details of problems encountered while triggering on-demand executions.

Name	Type	Description
cause*required	string	The cause of not triggering entity.
details*required	string	The details of triggering problem.
entityId*required	string	The entity identifier.
executionId*required	number	The execution identifier.
locationId	string	The location identifier.

SyntheticPrivateLocationUpdate

Configuration of a private synthetic location

Name	Type	Description
autoUpdateChromium	boolean	Non-containerized location property. Auto upgrade of Chromium is enabled (true) or disabled (false).
availabilityLocationOutage	boolean	Alerting for location outage is enabled (true) or disabled (false). Supported only for private Synthetic locations.
availabilityNodeOutage	boolean	Alerting for node outage is enabled (true) or disabled (false). \n\n If enabled, the outage of any node in the location triggers an alert. Supported only for private Synthetic locations.
availabilityNotificationsEnabled	boolean	Notifications for location and node outage are enabled (true) or disabled (false). Supported only for private Synthetic locations.
browserExecutionSupported	boolean	Containerized location property. Boolean value describes if browser monitors will be executed on this location: false: Browser monitor executions disabled. true: Browser monitor executions enabled.
city	string	The city of the location.
countryCode	string	The country code of the location. To fetch the list of available country codes, use the GET all countries request.
deploymentType	"UNKNOWN" | "KUBERNETES" | "OPENSHIFT" | "STANDARD"	The deployment type of the location: STANDARD: The location is deployed on Windows or Linux. KUBERNETES: The location is deployed on Kubernetes.
latitude	number	The latitude of the location in DDD.dddd format.
locationNodeOutageDelayInMinutes	number	Alert if location or node outage lasts longer than X minutes. \n\n Only applicable when availabilityLocationOutage or availabilityNodeOutage is set to true. Supported only for private Synthetic locations.
longitude	number	The longitude of the location in DDD.dddd format.
maxActiveGateCount	number	Containerized location property. The maximum number of ActiveGates deployed for the location (required for a Kubernetes location).
minActiveGateCount	number	Containerized location property. The minimum number of ActiveGates deployed for the location (required for a Kubernetes location).
namExecutionSupported	boolean	Containerized location property. Boolean value describes if icmp monitors will be executed on this location: false: Icmp monitor executions disabled. true: Icmp monitor executions enabled.
name	string	The name of the location.
nodeSize	"UNSUPPORTED" | "M" | "S" | "XS"	Containerized location property. The size of a containerized node deployed for the location (required for a Kubernetes location). Accepted values: XS: extra small S: small M: medium The node size L is not supported in containerized locations.
nodes	Array<string>	A list of synthetic nodes belonging to the location. You can retrieve the list of available nodes with the GET all nodes call.
regionCode	string	The region code of the location. To fetch the list of available region codes, use the GET regions of the country request.
status	"ENABLED" | "DISABLED" | "HIDDEN"	The status of the location: ENABLED: The location is displayed as active in the UI. You can assign monitors to the location. DISABLED: The location is displayed as inactive in the UI. You can't assign monitors to the location. Monitors already assigned to the location will stay there and will be executed from the location. HIDDEN: The location is not displayed in the UI. You can't assign monitors to the location. You can only set location as HIDDEN when no monitor is assigned to it.
type*required	"PUBLIC" | "PRIVATE"	Defines the actual set of fields depending on the value. See one of the following objects: PUBLIC -> SyntheticPublicLocationUpdate PRIVATE -> SyntheticPrivateLocationUpdate
useNewKubernetesVersion	boolean	Containerized location property. Boolean value describes which kubernetes version will be used: false: Version 1.23+ that is older than 1.26 true: Version 1.26+.

SyntheticPublicLocationUpdate

The update of a public Synthetic location.

Name	Type	Description
status	"ENABLED" | "DISABLED" | "HIDDEN"	The status of the location: ENABLED: The location is displayed as active in the UI. You can assign monitors to the location. DISABLED: The location is displayed as inactive in the UI. You can't assign monitors to the location. Monitors already assigned to the location will stay there and will be executed from the location. HIDDEN: The location is not displayed in the UI. You can't assign monitors to the location. You can only set location as HIDDEN when no monitor is assigned to it.
type*required	"PUBLIC" | "PRIVATE"	Defines the actual set of fields depending on the value. See one of the following objects: PUBLIC -> SyntheticPublicLocationUpdate PRIVATE -> SyntheticPrivateLocationUpdate

SyntheticPublicLocationsStatus

The status of public synthetic locations.

Name	Type	Description
publicLocationsEnabled*required	boolean	Synthetic monitors can (true) or can't (false) run on public synthetic locations.

SyntheticTagWithSourceDto

The tag with source of a monitored entity.

Name	Type	Description
context	string	The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the CONTEXTLESS value.
key*required	string	The key of the tag.
source	"AUTO" | "USER" | "RULE_BASED"	The source of the tag, such as USER, RULE_BASED or AUTO.
value	string	The value of the tag.

TableColumn

The definition of a table column to be used in the ui.

Name	Type	Description
pattern*required	string	Pattern with references to properties to create a single value for the column.

TenantToken

Tenant token

Name	Type	Description
value	string	The secret of the tenant token.

TenantTokenConfig

Configuration of a tenant token.

Name	Type	Description
active	TenantToken	Tenant token
old	TenantToken	Tenant token

ToPosition

The TO position of a relationship.

Name	Type	Description
id	string	The ID of the relationship.
toTypes	Array<string>	A list of monitored entity types that can occupy the TO position.

TokenCredentials

A credentials set of the TOKEN type.

Name	Type	Description
allowContextlessRequests	boolean	Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope).
allowedEntities	Array<CredentialAccessData>	The set of entities allowed to use the credential.
description	string	A short description of the credentials set.
externalVault	ExternalVault	Information for synchronization credentials with external vault
id	string	The ID of the credentials set.
name*required	string	The name of the credentials set.
ownerAccessOnly	boolean	The credentials set is available to every user (false) or to owner only (true).
scopeDEPRECATED	"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"	The scope of the credentials set.
scopes*required	Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">	The set of scopes of the credentials set. Limitations: CredentialsScope.APP_ENGINE is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.
token	string	Token in the string format.
type*required	"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"	Defines the actual set of fields depending on the value. See one of the following objects: CERTIFICATE -> CertificateCredentials PUBLIC_CERTIFICATE -> PublicCertificateCredentials USERNAME_PASSWORD -> UserPasswordCredentials TOKEN -> TokenCredentials SNMPV3 -> SNMPV3Credentials AWS_MONITORING_KEY_BASED -> AWSKeyBasedCredentialsDto AWS_MONITORING_ROLE_BASED -> AWSRoleBasedCredentials

TrackingLink

External tracking link URL associated with the remediable entity of the security problem.

Name	Type	Description
displayName	string	Display name (title) set for the tracking link, e.g. 'ISSUE-123'.
lastUpdatedTimestamp	number	The timestamp (UTC milliseconds) of the last update of the tracking link.
url	string	URL set for the tracking link, e.g. https://example.com/ISSUE-123
user	string	The user who last changed the tracking link.

TrackingLinkUpdate

External tracking link URL association to be set for the remediable entity of the security problem.

Name	Type	Description
displayName*required	string	The desired tracking link display name (title) set for the remediation item, e.g. 'ISSUE-123'.
url*required	string	The desired tracking link url set for the remediation item, e.g. https://example.com/ISSUE-123 Note that only valid URLs with 'http' or 'https' protocols are supported.

TransactionalEvidence

The transactional evidence of the problem.

A behavior of a metric in an transaction that indicates the problem and/or is its root cause.

Name	Type	Description
displayName*required	string	The display name of the evidence.
endTime	number	The end time of the evidence, in UTC milliseconds
entity*required	EntityStub	A short representation of a monitored entity.
evidenceType*required	"AVAILABILITY_EVIDENCE" | "EVENT" | "MAINTENANCE_WINDOW" | "METRIC" | "TRANSACTIONAL"	Defines the actual set of fields depending on the value. See one of the following objects: EVENT -> EventEvidence METRIC -> MetricEvidence TRANSACTIONAL -> TransactionalEvidence MAINTENANCE_WINDOW -> MaintenanceWindowEvidence AVAILABILITY_EVIDENCE -> AvailabilityEvidence
groupingEntity	EntityStub	A short representation of a monitored entity.
rootCauseRelevant*required	boolean	The evidence is (true) or is not (false) a part of the root cause.
startTime*required	number	The start time of the evidence, in UTC milliseconds.
unit	string	The unit of the metric.
valueAfterChangePoint	number	The metric's value after the problem start.
valueBeforeChangePoint	number	The metric's value before the problem start.

TransferOwnershipRequest

The request to change ownership of an object.

Name	Type	Description
newOwner	Identity	An Identity describing either a user, a group, or the all-users group (applying to all users).

TruncatableListAttackRequestHeader

A list of values that has possibly been truncated.

Name	Type	Description
truncationInfo	TruncationInfo	Information on a possible truncation.
values	Array<AttackRequestHeader>	Values of the list.

TruncatableListHttpRequestParameter

A list of values that has possibly been truncated.

Name	Type	Description
truncationInfo	TruncationInfo	Information on a possible truncation.
values	Array<HttpRequestParameter>	Values of the list.

TruncatableListString

A list of values that has possibly been truncated.

Name	Type	Description
truncationInfo	TruncationInfo	Information on a possible truncation.
values	Array<string>	Values of the list.

TruncationInfo

Information on a possible truncation.

Name	Type	Description
truncated	boolean	If the list/value has been truncated.

UiButtonCustomization

UI customization for defining a button that calls a function when pressed

Name	Type	Description
description	string	The description to be shown in a tooltip when hovering over the button
displayName*required	string	The label of the button
identifier*required	string	The identifier of the function to be called when the button is pressed
insert*required	string | InsertPosition	The position where the button should be shown in the UI

UiCallbackCustomization

UI customization options for defining custom callbacks

Name	Type	Description
buttons	Array<UiButtonCustomization>	UI customization for defining buttons that call functions when pressed

UiCustomization

Customization for UI elements

Name	Type	Description
callback	UiCallbackCustomization	UI customization options for defining custom callbacks
expandable	UiExpandableCustomization	UI customization for expandable section
table	UiTableCustomization	Customization for UI tables
tabs	UiTabsCustomization	UI customization for tabs

UiEmptyStateCustomization

UI customization for empty state in a table

Name	Type	Description
text	string	The text to be shown in the empty state

UiExpandableCustomization

UI customization for expandable section

Name	Type	Description
displayName	string	The display name
expanded	boolean	Defines if the item should be expanded by default
sections	Array<UiExpandableSectionCustomization>	A list of sections

UiExpandableSectionCustomization

Expandable section customization for UI

Name	Type	Description
description	string	The description
displayName*required	string	The display name
expanded	boolean	Defines if the section should be expanded by default
properties*required	Array<string>	A list of properties

UiTabGroupCustomization

Tab group customization for UI

Name	Type	Description
description	string	The description
displayName*required	string	The display name
properties*required	Array<string>	A list of properties

UiTableColumnCustomization

Customization for UI table columns

Name	Type	Description
builtinColumnRef	string	The ui specific builtin column-implementation for this column.
columnRef	string	The referenced column from the 'tableColumns' property of the schema for this column.
displayName	string	The display name for this column.
id	string	The id for this column used for filtering. Required for conflicting or pathed columns - otherwise the ref is used.
items	Array<UiTableColumnItemCustomization>	The possible items of this column.
propertyRef	string	The referenced property for this column.
type	string	The ui specific type for this column.
width	string	The width this column should take up on the table.

UiTableColumnItemCustomization

Customization for UI table column items

Name	Type	Description
displayName	string	The display name of this item.
icon	string	The icon of this item.
value*required	string	The value of this item.

UiTableCustomization

Customization for UI tables

Name	Type	Description
columns	Array<UiTableColumnCustomization>	A list of columns for the UI table
emptyState	UiEmptyStateCustomization	UI customization for empty state in a table

UiTabsCustomization

UI customization for tabs

Name	Type	Description
groups	Array<UiTabGroupCustomization>	A list of groups

Unit

The metadata of a unit.

Name	Type	Description
description	string	A short description of the unit.
displayName	string	The display name of the unit.
displayNamePlural	string	The plural display name of the unit.
symbol	string	The symbol of the unit.
unitId*required	string	The ID of the unit.

UnitConversionResult

The result of a unit conversion.

Name	Type	Description
resultValue*required	number	The result of the unit conversion.
unitId*required	string	The ID of the unit of this conversion result.

UnitList

A list of units along with their properties.

Name	Type	Description
totalCount*required	number	The total number of units in the result.
units*required	Array<Unit>	A list of units.

UpdateJob

Configuration of the ActiveGate update job.

Name	Type	Description
agType	"CLUSTER" | "ENVIRONMENT" | "ENVIRONMENT_MULTI"	The type of the ActiveGate.
cancelable	boolean	The job can (true) or can't (false) be cancelled at the moment.
duration	number	The duration of the update, in milliseconds.
environments	Array<string>	A list of environments (specified by IDs) the ActiveGate can connect to.
error	string	The information about update error.
jobId	string	The ID of the update job.
jobState	"SCHEDULED" | "PENDING" | "FAILED" | "IN_PROGRESS" | "ROLLBACK" | "SKIPPED" | "SUCCEED"	The status of the update job.
startVersion	string	The initial version of the ActiveGate.
targetVersion*required	string	The target version of the update. Specify the version in the <major>.<minor>.<revision>.<timestamp> format. To update to the latest available version, use the latest value.
timestamp	number	The timestamp of the update job completion. The null value means the job is still running.
updateMethod	"AUTOMATIC" | "MANUAL_INSTALLATION" | "ON_DEMAND"	The method of updating the ActiveGate or its component.
updateType	"SYNTHETIC" | "ACTIVE_GATE" | "REMOTE_PLUGIN_AGENT" | "Z_REMOTE"	The component to be updated.

UpdateJobList

A list of update jobs of the ActiveGate.

Name	Type	Description
agId	string	The ID of the ActiveGate.
updateJobs	Array<UpdateJob>	A list of update jobs of the ActiveGate.

UpdateJobsAll

A list of ActiveGates with update jobs.

Name	Type	Description
allUpdateJobs	Array<UpdateJobList>	A list of ActiveGates with update jobs.

UpdatePermissionsRequest

The request to update the permissions of a specific accessor.

Name	Type	Description
permissions	Array<"r" | "w">	The permissions to assign to the specified accessor.

UserPasswordCredentials

A credentials set of the USERNAME_PASSWORD type.

Name	Type	Description
allowContextlessRequests	boolean	Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope).
allowedEntities	Array<CredentialAccessData>	The set of entities allowed to use the credential.
description	string	A short description of the credentials set.
externalVault	ExternalVault	Information for synchronization credentials with external vault
id	string	The ID of the credentials set.
name*required	string	The name of the credentials set.
ownerAccessOnly	boolean	The credentials set is available to every user (false) or to owner only (true).
password	string	The password of the credential.
scopeDEPRECATED	"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"	The scope of the credentials set.
scopes*required	Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">	The set of scopes of the credentials set. Limitations: CredentialsScope.APP_ENGINE is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.
type*required	"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"	Defines the actual set of fields depending on the value. See one of the following objects: CERTIFICATE -> CertificateCredentials PUBLIC_CERTIFICATE -> PublicCertificateCredentials USERNAME_PASSWORD -> UserPasswordCredentials TOKEN -> TokenCredentials SNMPV3 -> SNMPV3Credentials AWS_MONITORING_KEY_BASED -> AWSKeyBasedCredentialsDto AWS_MONITORING_ROLE_BASED -> AWSRoleBasedCredentials
user	string	The username of the credentials set.

ValidationResponse

Name	Type
error	MetricIngestError
linesInvalid	number
linesOk	number
warnings	Warnings

Vulnerability

Describes the exploited vulnerability.

Name	Type	Description
codeLocation	CodeLocation	Information about a code location.
displayName	string	The display name of the vulnerability.
vulnerabilityId	string	The id of the vulnerability.
vulnerableFunction	FunctionDefinition	Information about a function definition.
vulnerableFunctionInput	VulnerableFunctionInput	Describes what got passed into the code level vulnerability.

VulnerableComponent

Vulnerable component of a security problem.

Name	Type	Description
affectedEntities	Array<string>	A list of affected entities.
displayName	string	The display name of the vulnerable component.
fileName	string	The file name of the vulnerable component.
id	string	The Dynatrace entity ID of the vulnerable component.
numberOfAffectedEntities	number	The number of affected entities.
shortName	string	The short, component-only name of the vulnerable component.

VulnerableFunction

Defines an vulnerable function.

Name	Type	Description
className	string	The class name of the vulnerable function.
filePath	string	The file path of the vulnerable function.
functionName	string	The function name of the vulnerable function.

VulnerableFunctionInput

Describes what got passed into the code level vulnerability.

Name	Type	Description
inputSegments	Array<VulnerableFunctionInputSegment>	A list of input segments.
type	"COMMAND" | "HTTP_CLIENT" | "JNDI" | "SQL_STATEMENT"	The type of the input.

VulnerableFunctionInputSegment

Describes one segment that was passed into a vulnerable function.

Name	Type	Description
type	"MALICIOUS_INPUT" | "REGULAR_INPUT" | "TAINTED_INPUT"	The type of the input segment.
value	string	The value of the input segment.

VulnerableFunctionProcessGroups

A vulnerable function including its usage by specific process groups in context of the security problem.

Name	Type	Description
function	VulnerableFunction	Defines an vulnerable function.
processGroupsInUse	Array<string>	The process group identifiers, where this vulnerable function is in use.
processGroupsNotAvailable	Array<string>	The process group identifiers, where information about the usage of this function not available.
processGroupsNotInUse	Array<string>	The process group identifiers, where this vulnerable function is not in use.
usage	"NOT_AVAILABLE" | "IN_USE" | "NOT_IN_USE"	The vulnerable function usage based on the given process groups: IN_USE if at least one process group calls this vulnerable function. NOT_IN_USE if all process groups do not call this vulnerable function. NOT_AVAILABLE if vulnerable function usage could not be calculated for at least one process group and no process group calls this vulnerable function.

VulnerableFunctionsContainer

A list of vulnerable functions, their security problem wide usages and their usages per process group. Optional: A list of vulnerable function usages per process group for a security problem.

Name	Type	Description
vulnerableFunctions	Array<VulnerableFunctionProcessGroups>	A list of vulnerable functions, their security problem wide usages and their usages per process group.
vulnerableFunctionsByProcessGroup	Array<ProcessGroupVulnerableFunctions>	A list of vulnerable function usages per process group for a security problem. The result is sorted based on the following criteria: the number of vulnerable functions in use (descending). the number of vulnerable functions not in use (descending). the number of vulnerable functions not available (descending). the process group identifier (ascending)

WarningLine

Name	Type
line	number
warning	string

Warnings

Name	Type
changedMetricKeys	Array<WarningLine>
message	string

Enums

AbstractCredentialsResponseElementScope

The scope of the credentials set.

Enum keys

All | Extension | Synthetic | Unknown

AbstractCredentialsResponseElementType

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

• USERNAME_PASSWORD -> CredentialsDetailsUsernamePasswordResponseElement
• CERTIFICATE -> CredentialsDetailsCertificateResponseElement
• TOKEN -> CredentialsDetailsTokenResponseElement
• PUBLIC_CERTIFICATE -> CredentialsDetailsCertificateResponseElement

Enum keys

Certificate | PublicCertificate | Token | UsernamePassword

AbstractSloAlertDtoAlertType

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

• BURN_RATE -> BurnRateAlert
• STATUS -> StatusAlert

Enum keys

BurnRate | Status

AccessorPermissionsPermissionsItem

r = read, w = write

Enum keys

R | W

ActiveGateAutoUpdateConfigEffectiveSetting

The actual state of the ActiveGate auto-update.

Applicable only if the setting parameter is set to INHERITED. In that case, the value is taken from the parent setting. Otherwise, it's just a duplicate of the setting value.

Enum keys

Disabled | Enabled

ActiveGateAutoUpdateConfigSetting

The state of the ActiveGate auto-update: enabled, disabled, or inherited.

If set to INHERITED, the setting is inherited from the global configuration set on the environment or Managed cluster level.

Enum keys

Disabled | Enabled | Inherited

ActiveGateAutoUpdateStatus

The current status of auto-updates of the ActiveGate.

Enum keys

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

ActiveGateGlobalAutoUpdateConfigGlobalSetting

The state of auto-updates for all ActiveGates connected to the environment or Managed cluster.

This setting is inherited by all ActiveGates that have the INHERITED setting.

Enum keys

Disabled | Enabled

ActiveGateModuleType

The type of ActiveGate module.

Enum keys

Aws | Azure | BeaconForwarder | CloudFoundry | DbInsight | Debugging | ExtensionsV1 | ExtensionsV2 | Kubernetes | Logs | MemoryDumps | MetricApi | OneAgentRouting | OtlpIngest | RestApi | Synthetic | Vmware | ZOs

ActiveGateOsArchitecture

The OS architecture that the ActiveGate is running on.

Enum keys

Arm | Ppcle | S390 | X86

ActiveGateOsBitness

The OS bitness that the ActiveGate is running on.

Enum keys

_64

ActiveGateOsType

The OS type that the ActiveGate is running on.

Enum keys

Linux | Windows

ActiveGateTokenActiveGateType

The type of the ActiveGate for which the token is valid.

Enum keys

Cluster | Environment

ActiveGateTokenCreateActiveGateType

The type of the ActiveGate for which the token is valid.

Enum keys

Cluster | Environment

ActiveGateTokenInfoDtoState

State of the ActiveGate token.

Enum keys

Absent | Expiring | Invalid | Unknown | Unsupported | Valid

ActiveGateType

The type of the ActiveGate.

Enum keys

Cluster | Environment | EnvironmentMulti

ApiTokenCreateScopesItem

Enum keys

ActiveGateCertManagement | ActiveGateTokenManagementCreate | ActiveGateTokenManagementRead | ActiveGateTokenManagementWrite | ActiveGatesRead | ActiveGatesWrite | AdaptiveTrafficManagementRead | AdvancedSyntheticIntegration | AgentTokenManagementRead | AnalyzersRead | AnalyzersWrite | ApiTokensRead | ApiTokensWrite | AttacksRead | AttacksWrite | AuditLogsRead | BizeventsIngest | CaptureRequestData | CredentialVaultRead | CredentialVaultWrite | DataExport | DataImport | DataPrivacy | Davis | DssFileManagement | DtaqlAccess | EntitiesRead | EntitiesWrite | EventsIngest | EventsRead | ExtensionConfigurationActionsWrite | ExtensionConfigurationsRead | ExtensionConfigurationsWrite | ExtensionEnvironmentRead | ExtensionEnvironmentWrite | ExtensionsRead | ExtensionsWrite | ExternalSyntheticIntegration | GeographicRegionsRead | HubInstall | HubRead | HubWrite | InstallerDownload | JavaScriptMappingFilesRead | JavaScriptMappingFilesWrite | LogExport | LogsIngest | LogsRead | MetricsIngest | MetricsRead | MetricsWrite | NetworkZonesRead | NetworkZonesWrite | OneAgentsRead | OneAgentsWrite | OpenTelemetryTraceIngest | OpenpipelineEvents | OpenpipelineEventsCustom | OpenpipelineEventsSdlc | OpenpipelineEventsSdlcCustom | OpenpipelineEventsSecurity | OpenpipelineEventsSecurityCustom | PluginUpload | ProblemsRead | ProblemsWrite | ReadConfig | ReadSyntheticData | ReleasesRead | RestRequestForwarding | RumBrowserExtension | RumCookieNamesRead | RumJavaScriptTagManagement | SecurityProblemsRead | SecurityProblemsWrite | SettingsRead | SettingsWrite | SloRead | SloWrite | SupportAlert | SyntheticExecutionsRead | SyntheticExecutionsWrite | SyntheticLocationsRead | SyntheticLocationsWrite | TenantTokenManagement | TenantTokenRotationWrite | TracesLookup | UnifiedAnalysisRead | UserSessionAnonymization | WriteConfig

ApiTokenScopesItem

Enum keys

ActiveGateCertManagement | ActiveGateTokenManagementCreate | ActiveGateTokenManagementRead | ActiveGateTokenManagementWrite | ActiveGatesRead | ActiveGatesWrite | AdaptiveTrafficManagementRead | AdvancedSyntheticIntegration | AgentTokenManagementRead | AnalyzersRead | AnalyzersWrite | ApiTokensRead | ApiTokensWrite | AttacksRead | AttacksWrite | AuditLogsRead | BizeventsIngest | CaptureRequestData | CredentialVaultRead | CredentialVaultWrite | DataExport | DataImport | DataPrivacy | Davis | DiagnosticExport | DssFileManagement | DtaqlAccess | EntitiesRead | EntitiesWrite | EventsIngest | EventsRead | ExtensionConfigurationActionsWrite | ExtensionConfigurationsRead | ExtensionConfigurationsWrite | ExtensionEnvironmentRead | ExtensionEnvironmentWrite | ExtensionsRead | ExtensionsWrite | ExternalSyntheticIntegration | GeographicRegionsRead | HubInstall | HubRead | HubWrite | InstallerDownload | JavaScriptMappingFilesRead | JavaScriptMappingFilesWrite | LogExport | LogsIngest | LogsRead | MemoryDump | MetricsIngest | MetricsRead | MetricsWrite | Mobile | NetworkZonesRead | NetworkZonesWrite | OneAgentsRead | OneAgentsWrite | OpenTelemetryTraceIngest | OpenpipelineEvents | OpenpipelineEventsCustom | OpenpipelineEventsSdlc | OpenpipelineEventsSdlcCustom | OpenpipelineEventsSecurity | OpenpipelineEventsSecurityCustom | PluginUpload | ProblemsRead | ProblemsWrite | ReadConfig | ReadSyntheticData | ReleasesRead | RestRequestForwarding | RumBrowserExtension | RumCookieNamesRead | RumJavaScriptTagManagement | SecurityProblemsRead | SecurityProblemsWrite | SettingsRead | SettingsWrite | SloRead | SloWrite | SupportAlert | SyntheticExecutionsRead | SyntheticExecutionsWrite | SyntheticLocationsRead | SyntheticLocationsWrite | TenantTokenManagement | TenantTokenRotationWrite | TracesLookup | UnifiedAnalysisRead | UserSessionAnonymization | ViewDashboard | ViewReport | WriteConfig | WriteSyntheticData

ApiTokenUpdateScopesItem

Enum keys

ActiveGateCertManagement | ActiveGateTokenManagementCreate | ActiveGateTokenManagementRead | ActiveGateTokenManagementWrite | ActiveGatesRead | ActiveGatesWrite | AdaptiveTrafficManagementRead | AdvancedSyntheticIntegration | AgentTokenManagementRead | AnalyzersRead | AnalyzersWrite | ApiTokensRead | ApiTokensWrite | AttacksRead | AttacksWrite | AuditLogsRead | BizeventsIngest | CaptureRequestData | CredentialVaultRead | CredentialVaultWrite | DataExport | DataImport | DataPrivacy | Davis | DssFileManagement | DtaqlAccess | EntitiesRead | EntitiesWrite | EventsIngest | EventsRead | ExtensionConfigurationActionsWrite | ExtensionConfigurationsRead | ExtensionConfigurationsWrite | ExtensionEnvironmentRead | ExtensionEnvironmentWrite | ExtensionsRead | ExtensionsWrite | ExternalSyntheticIntegration | GeographicRegionsRead | HubInstall | HubRead | HubWrite | InstallerDownload | JavaScriptMappingFilesRead | JavaScriptMappingFilesWrite | LogExport | LogsIngest | LogsRead | MetricsIngest | MetricsRead | MetricsWrite | NetworkZonesRead | NetworkZonesWrite | OneAgentsRead | OneAgentsWrite | OpenTelemetryTraceIngest | OpenpipelineEvents | OpenpipelineEventsCustom | OpenpipelineEventsSdlc | OpenpipelineEventsSdlcCustom | OpenpipelineEventsSecurity | OpenpipelineEventsSecurityCustom | PluginUpload | ProblemsRead | ProblemsWrite | ReadConfig | ReadSyntheticData | ReleasesRead | RestRequestForwarding | RumBrowserExtension | RumCookieNamesRead | RumJavaScriptTagManagement | SecurityProblemsRead | SecurityProblemsWrite | SettingsRead | SettingsWrite | SloRead | SloWrite | SupportAlert | SyntheticExecutionsRead | SyntheticExecutionsWrite | SyntheticLocationsRead | SyntheticLocationsWrite | TenantTokenManagement | TenantTokenRotationWrite | TracesLookup | UnifiedAnalysisRead | UserSessionAnonymization | WriteConfig

AssessmentAccuracyDetailsReducedReasonsItem

The reason for a reduced accuracy of the assessment.

Enum keys

LimitedAgentSupport | LimitedByConfiguration

AssetInfoDtoType

The type of the asset.

Enum keys

Alert | AlertTemplate | AwsService | CustomCards | Dashboard | DeclarativeProcesses | DocumentDashboard | DqlLogMetric | DqlLogProcessingRule | GenericRelationship | GenericType | ListScreenFilters | ListScreenInjections | ListScreenLayout | LogEvent | LogMetric | LogProcessingRule | LqlLogMetric | LqlLogProcessingRule | MetricMetadata | MetricQuery | ProcessGroupingRules | ScreenActions | ScreenChartGroups | ScreenDqlTable | ScreenEntitiesLists | ScreenEventsCards | ScreenFilters | ScreenHealthCards | ScreenInjections | ScreenLayout | ScreenLogsCards | ScreenMessageCards | ScreenMetricTables | ScreenProblems | ScreenProperties

AttackAttackType

The type of the attack.

Enum keys

CommandInjection | JndiInjection | SqlInjection | Ssrf

AttackSecurityProblemAssessmentDtoDataAssets

The reachability of data assets by the attacked target.

Enum keys

NotAvailable | NotDetected | Reachable

AttackSecurityProblemAssessmentDtoExposure

The level of exposure of the attacked target

Enum keys

NotAvailable | NotDetected | PublicNetwork

AttackState

The state of the attack.

Enum keys

Allowlisted | Blocked | Exploited

AttackTechnology

The technology of the attack.

Enum keys

Dotnet | Go | Java | NodeJs

AuditLogEntryCategory

The category of the recorded operation.

Enum keys

ActivegateToken | BuildUnitV2 | Config | ManualTaggingService | TenantLifecycle | Token | WebUi

AuditLogEntryEventType

The type of the recorded operation.

• LOGIN -> A user logged in
• LOGOUT -> A user logged out
• CREATE -> An object was created
• UPDATE -> An object was updated
• DELETE -> An object was deleted
• REVOKE -> An Active Gate token was revoked
• TAG_ADD -> A manual tag was added
• TAG_REMOVE -> A manual tag was removed
• TAG_UPDATE -> A manual tag was updated
• REMOTE_CONFIGURATION_MANAGEMENT -> A Remote Configuration Management related operation occurred

Enum keys

Create | Delete | Login | Logout | Reorder | Revoke | TagAdd | TagRemove | TagUpdate | Update

AuditLogEntryUserType

The type of the authentication of the user.

• USER_NAME -> User was logged in the UI
• TOKEN_HASH -> URL Token or DevOps Token, the hash of the token is logged
• SERVICE_NAME -> No authenticated user at all, this action was performed by a system service automatically
• PUBLIC_TOKEN_IDENTIFIER -> API Token, the public token id is logged

Enum keys

PublicTokenIdentifier | ServiceName | TokenHash | UserName

CodeLevelVulnerabilityDetailsType

The type of code level vulnerability.

Enum keys

CmdInjection | ImproperInputValidation | SqlInjection | Ssrf

ComplexConstraintType

The type of the constraint.

Enum keys

CustomValidatorRef | GreaterThan | GreaterThanOrEqual | LessThan | LessThanOrEqual | PropertyCountRange | SecretResubmission | Unknown

ConstraintType

The type of the constraint.

Enum keys

CustomValidatorRef | Length | NoWhitespace | NotBlank | NotEmpty | Pattern | Range | Regex | Trimmed | Unique | Unknown

ConstraintViolationParameterLocation

Enum keys

Header | Path | PayloadBody | Query

CreateAlertQueryTimeFrame

Enum keys

Current | Gtf

CredentialAccessDataType

Enum keys

Application | Unknown | User

CredentialsResponseElementScope

The scope of the credentials set.

Enum keys

AppEngine | Extension | Synthetic

CredentialsResponseElementScopesItem

The set of scopes of the credentials set.

Enum keys

AppEngine | Extension | Synthetic

CredentialsResponseElementType

The type of the credentials set.

Enum keys

AwsMonitoringKeyBased | AwsMonitoringRoleBased | Certificate | PublicCertificate | Snmpv3 | Token | Unknown | UsernamePassword

CredentialsScope

The scope of the credentials set.

Enum keys

AppEngine | Extension | Synthetic

CredentialsScopesItem

The set of scopes of the credentials set.

Limitations: CredentialsScope.APP_ENGINE is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.

Enum keys

AppEngine | Extension | Synthetic

CredentialsType

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

• CERTIFICATE -> CertificateCredentials
• PUBLIC_CERTIFICATE -> PublicCertificateCredentials
• USERNAME_PASSWORD -> UserPasswordCredentials
• TOKEN -> TokenCredentials
• SNMPV3 -> SNMPV3Credentials
• AWS_MONITORING_KEY_BASED -> AWSKeyBasedCredentialsDto
• AWS_MONITORING_ROLE_BASED -> AWSRoleBasedCredentials

Enum keys

AwsMonitoringKeyBased | AwsMonitoringRoleBased | Certificate | PublicCertificate | Snmpv3 | Token | UsernamePassword

DatasourceDefinitionResetValue

When to reset datasource value in the UI on filter change.

Enum keys

Always | InvalidOnly | Never

DavisSecurityAdviceAdviceType

The type of the advice.

Enum keys

Upgrade

DavisSecurityAdviceTechnology

The technology of the vulnerable component.

Enum keys

Dotnet | Go | Java | Kubernetes | NodeJs | Php | Python

DeletionConstraintType

The type of the deletion constraint.

Enum keys

CustomValidatorRef | ReferentialIntegrity | Unknown

EffectivePermissionGranted

Enum keys

Condition | False | True

EntryPointUsageSegmentSegmentType

The type of this input segment.

Enum keys

MaliciousInput | RegularInput | TaintedInput

EntryPointUsageSegmentSourceType

The type of the HTTP request part that contains the value that was used in this segment.

Enum keys

HttpBody | HttpCookie | HttpHeaderName | HttpHeaderValue | HttpOther | HttpParameterName | HttpParameterValue | HttpUrl | Unknown

EntrypointPayloadType

Type of the payload.

Enum keys

HttpBody | HttpCookie | HttpHeaderName | HttpHeaderValue | HttpOther | HttpParameterName | HttpParameterValue | HttpUrl | Unknown

EnumTypeType

The type of the property.

Enum keys

Enum

EventIngestEventType

The type of the event.

Enum keys

AvailabilityEvent | CustomAlert | CustomAnnotation | CustomConfiguration | CustomDeployment | CustomInfo | ErrorEvent | MarkedForTermination | PerformanceEvent | ResourceContentionEvent

EventIngestResultStatus

The status of the ingestion.

Enum keys

InvalidEntityType | InvalidMetadata | InvalidTimestamps | Ok

EventStatus

The status of the event.

Enum keys

Closed | Open

EventTypeSeverityLevel

The severity level associated with the event type.

Enum keys

Availability | CustomAlert | Error | Info | MonitoringUnavailable | Performance | ResourceContention

EvidenceEvidenceType

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

• EVENT -> EventEvidence
• METRIC -> MetricEvidence
• TRANSACTIONAL -> TransactionalEvidence
• MAINTENANCE_WINDOW -> MaintenanceWindowEvidence
• AVAILABILITY_EVIDENCE -> AvailabilityEvidence

Enum keys

AvailabilityEvidence | Event | MaintenanceWindow | Metric | Transactional

ExecutionStepMonitorType

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

• BROWSER -> BMAction
• HTTP -> MonitorRequestExecutionResult

Enum keys

Browser | Http

ExtensionEventDtoStatus

Status of the event

Enum keys

Error | Info | None | Warn

ExtensionStatusDtoStatus

Latest status of given configuration.

Enum keys

Error | Ok | Pending | Unknown | Warning

ExtensionStatusWithIdDtoStatus

Latest status of given configuration.

Enum keys

Error | Ok | Pending | Unknown | Warning

ExternalVaultConfigSourceAuthMethod

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

• HASHICORP_VAULT_APPROLE -> HashicorpApproleConfig
• HASHICORP_VAULT_CERTIFICATE -> HashicorpCertificateConfig
• AZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecretConfig
• CYBERARK_VAULT_USERNAME_PASSWORD -> CyberArkUsernamePasswordConfig
• CYBERARK_VAULT_ALLOWED_LOCATION -> CyberArkAllowedLocationConfig

Enum keys

AzureKeyVaultClientSecret | CyberarkVaultAllowedLocation | CyberarkVaultUsernamePassword | HashicorpVaultApprole | HashicorpVaultCertificate

ExternalVaultConfigType

Enum keys

AzureCertificateModel | AzureClientSecretModel | CyberarkVaultAllowedLocationModel | CyberarkVaultUsernamePasswordModel | HashicorpApproleModel | HashicorpCertificateModel

ExternalVaultSourceAuthMethod

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

• HASHICORP_VAULT_APPROLE -> HashicorpApprole
• HASHICORP_VAULT_CERTIFICATE -> HashicorpCertificate
• AZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecret
• CYBERARK_VAULT_USERNAME_PASSWORD -> CyberArkUsernamePassword
• CYBERARK_VAULT_ALLOWED_LOCATION -> CyberArkAllowedLocationDto

Enum keys

AzureKeyVaultClientSecret | CyberarkVaultAllowedLocation | CyberarkVaultUsernamePassword | HashicorpVaultApprole | HashicorpVaultCertificate

FilterType

Type of this filter, determines which other fields are present.Can be any of:

• eq,
• ne,
• prefix,
• in,
• remainder,
• suffix,
• contains,
• existsKey,
• series,
• or,
• and,
• not,
• ge,
• gt,
• le,
• lt,
• otherwise.

Enum keys

And | Contains | Eq | ExistsKey | Ge | Gt | In | Le | Lt | Ne | Not | Or | Otherwise | Prefix | Remainder | Series | Suffix

GetAllActiveGatesQueryAutoUpdate

Enum keys

Disabled | Enabled

GetAllActiveGatesQueryDisabledModuleItem

Enum keys

Aws | Azure | BeaconForwarder | CloudFoundry | DbInsight | Debugging | ExtensionsV1 | ExtensionsV2 | Kubernetes | Logs | MemoryDumps | MetricApi | OneAgentRouting | OtlpIngest | RestApi | Synthetic | Vmware | ZOs

GetAllActiveGatesQueryEnabledModuleItem

Enum keys

Aws | Azure | BeaconForwarder | CloudFoundry | DbInsight | Debugging | ExtensionsV1 | ExtensionsV2 | Kubernetes | Logs | MemoryDumps | MetricApi | OneAgentRouting | OtlpIngest | RestApi | Synthetic | Vmware | ZOs

GetAllActiveGatesQueryOsArchitecture

Enum keys

Arm | Ppcle | S390 | X86

GetAllActiveGatesQueryOsType

Enum keys

Linux | Windows

GetAllActiveGatesQueryTokenState

Enum keys

Absent | Expiring | Invalid | Unknown | Unsupported | Valid

GetAllActiveGatesQueryType

Enum keys

Environment | EnvironmentMulti

GetAllActiveGatesQueryUpdateStatus

Enum keys

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

GetAllActiveGatesQueryVersionCompareType

Enum keys

Equal | Greater | GreaterEqual | Lower | LowerEqual

GetAllUpdateJobListQueryStartVersionCompareType

Enum keys

Equal | Greater | GreaterEqual | Lower | LowerEqual

GetAllUpdateJobListQueryTargetVersionCompareType

Enum keys

Equal | Greater | GreaterEqual | Lower | LowerEqual

GetAllUpdateJobListQueryUpdateType

Enum keys

ActiveGate | RemotePluginAgent | Synthetic | ZRemote

GetEnvironmentConfigurationEventsQueryStatus

Enum keys

Error | Info | None | Warn

GetExecutionResultPathResultType

Enum keys

Failed | Success

GetExecutionsQueryExecutionStage

Enum keys

DataRetrieved | Executed | Triggered

GetExecutionsQuerySource

Enum keys

Api | Ui

GetExtensionMonitoringConfigurationEventsQueryStatus

Enum keys

Error | Info | None | Warn

GetHostStatsQueryFilter

Enum keys

All | ConfiguredButNotConnectedOnly | ConnectedAsAlternativeOnly | ConnectedAsFailoverOnly | ConnectedAsFailoverWithoutOwnActiveGatesOnly

GetLocationsQueryCapability

Enum keys

Browser | Dns | Http | HttpHighResource | Icmp | Tcp

GetLocationsQueryCloudPlatform

Enum keys

Alibaba | Aws | Azure | GoogleCloud | Other

GetLocationsQueryType

Enum keys

Private | Public

GetNodesQueryAssignedToLocation

Enum keys

False | True

GetPermissionPathAccessorType

Enum keys

Group | User

GetSloByIdQueryTimeFrame

Enum keys

Current | Gtf

GetSloQueryEnabledSlos

Enum keys

All | False | True

GetSloQueryEvaluate

Enum keys

False | True

GetSloQueryTimeFrame

Enum keys

Current | Gtf

GetUpdateJobListByAgIdQueryStartVersionCompareType

Enum keys

Equal | Greater | GreaterEqual | Lower | LowerEqual

GetUpdateJobListByAgIdQueryTargetVersionCompareType

Enum keys

Equal | Greater | GreaterEqual | Lower | LowerEqual

GetUpdateJobListByAgIdQueryUpdateType

Enum keys

ActiveGate | RemotePluginAgent | Synthetic | ZRemote

IdentityType

The type of the identity.

Enum keys

AllUsers | Group | User

ImpactImpactType

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

• SERVICE -> ServiceImpact
• APPLICATION -> ApplicationImpact
• MOBILE -> MobileImpact
• CUSTOM_APPLICATION -> CustomApplicationImpact

Enum keys

Application | CustomApplication | Mobile | Service

ListCredentialsQueryType

Enum keys

AwsMonitoringKeyBased | AwsMonitoringRoleBased | Certificate | Snmpv3 | Token | UsernamePassword

LocationCollectionElementCloudPlatform

The cloud provider where the location is hosted.

Only applicable to PUBLIC locations.

Enum keys

Alibaba | AmazonEc2 | Azure | DynatraceCloud | GoogleCloud | Interoute | Other | Undefined

LocationCollectionElementDeploymentType

Location's deployment type

Enum keys

Kubernetes | Openshift | Standard | Unknown

LocationCollectionElementStage

The release stage of the location.

Enum keys

Beta | ComingSoon | Deleted | Ga

LocationCollectionElementStatus

The status of the location.

Enum keys

Disabled | Enabled | Hidden

LocationCollectionElementType

The type of the location.

Enum keys

Cluster | Private | Public

LogRecordEventType

Type of event

Enum keys

K8S | Log | Sfm

LogRecordStatus

The log status (based on the log level).

Enum keys

Error | Info | None | NotApplicable | Warn

MetricDefaultAggregationType

The type of default aggregation.

Enum keys

Auto | Avg | Count | Max | Median | Min | Percentile | Sum | Value

MetricDescriptorAggregationTypesItem

Enum keys

Auto | Avg | Count | Max | Median | Min | Percentile | Sum | Value

MetricDescriptorTransformationsItem

Enum keys

AsGauge | Default | Delta | EvaluateModel | Filter | Fold | Histogram | Last | LastReal | Limit | Merge | Names | Parents | Partition | Rate | Rollup | SetUnit | Smooth | Sort | SplitBy | Timeshift | ToUnit

MetricDescriptorUnitDisplayFormat

The raw value is stored in bits or bytes. The user interface can display it in these numeral systems:

Binary: 1 MiB = 1024 KiB = 1,048,576 bytes

Decimal: 1 MB = 1000 kB = 1,000,000 bytes

If not set, the decimal system is used.

Metric expressions don't return this field.

Enum keys

Binary | Decimal

MetricDimensionDefinitionType

The type of the dimension.

Enum keys

Entity | Number | Other | String | Void

MetricQueryDQLTranslationStatus

The status of the DQL translation, either success or not supported

Enum keys

NotSupported | Success

MetricValueTypeType

The metric value type

Enum keys

Error | Score | Unknown

MonitoredEntityStatesSeverity

The type of the monitoring state.

Enum keys

DeepMonitoringOk | Info | Ok | Warning

MonitoredEntityStatesState

The name of the monitoring state.

Enum keys

AgentInjectionStatusGoDynamizerFailed | AgentInjectionStatusGoFipsDetectedButFeatureDisabled | AgentInjectionStatusGoPclntabFailed | AgentInjectionStatusGoVertigoSupportAdded | AgentInjectionStatusNginxPatchedBinaryDetected | AgentInjectionStatusPhpOpcacheDisabled | AgentInjectionStatusPhpStackSizeTooLow | AgentInjectionSuppression | AixEnableFullMonitoringNeeded | BadInstaller | BoshbpmDisabled | ContainerInjectionFailed | ContainerdDisabled | CrioDisabled | CustomPgRuleRequired | DeepMonitoringSuccessful | DeepMonitoringUnsuccessful | DockerDisabled | GardenDisabled | HostInfraStructureOnly | HostMonitoringDisabled | NetworkAgentInactive | Ok | ParentProcessRestartRequired | PodmanDisabled | ProcessGroupDifferentIdDueToDeclarativeGrouping | ProcessGroupDisabled | ProcessGroupDisabledViaContainerInjectionRule | ProcessGroupDisabledViaContainerInjectionRuleRestart | ProcessGroupDisabledViaGlobalSettings | ProcessGroupDisabledViaInjectionRule | ProcessGroupDisabledViaInjectionRuleRestart | ProcessGroupPgrGroupUpdateSuppressed | RestartRequired | RestartRequiredApache | RestartRequiredDockerDeamon | RestartRequiredHostGroupInconsistent | RestartRequiredHostIdInconsistent | RestartRequiredOutdatedAgentApacheUpdate | RestartRequiredOutdatedAgentInjected | RestartRequiredUsingDifferentDataStorageDir | RestartRequiredUsingDifferentLogPath | RestartRequiredVirtualizedContainer | UnsupportedState | WincDisabled

MuteStateReason

The reason for the mute state change.

Enum keys

Affected | ConfigurationNotAffected | FalsePositive | Ignore | InitialState | Other | VulnerableCodeNotInUse

NetworkZoneFallbackMode

The fallback mode of the network zone.

Enum keys

AnyActiveGate | None | OnlyDefaultZone

PreconditionType

The type of the precondition.

Enum keys

And | Equals | In | Not | Null | Or | RegexMatch

PrivateSyntheticLocationDeploymentType

The deployment type of the location:

• STANDARD: The location is deployed on Windows or Linux.
• KUBERNETES: The location is deployed on Kubernetes.

Enum keys

Kubernetes | Openshift | Standard | Unknown

PrivateSyntheticLocationStatus

The status of the location:

• ENABLED: The location is displayed as active in the UI. You can assign monitors to the location.
• DISABLED: The location is displayed as inactive in the UI. You can't assign monitors to the location. Monitors already assigned to the location will stay there and will be executed from the location.
• HIDDEN: The location is not displayed in the UI. You can't assign monitors to the location. You can only set location as HIDDEN when no monitor is assigned to it.

Enum keys

Disabled | Enabled | Hidden

PrivateSyntheticLocationType

Enum keys

Cluster | Private | Public

ProblemImpactLevel

The impact level of the problem. It shows what is affected by the problem.

Enum keys

Application | Environment | Infrastructure | Services

ProblemSeverityLevel

The severity of the problem.

Enum keys

Availability | CustomAlert | Error | Info | MonitoringUnavailable | Performance | ResourceContention

ProblemStatus

The status of the problem.

Enum keys

Closed | Open

PropertyDefinitionModificationPolicy

Modification policy of the property.

Enum keys

Always | Default | Never

RelatedServiceExposure

The level of exposure of the service.

Enum keys

NotAvailable | NotDetected | PublicNetwork

RemediationAssessmentAssessmentAccuracy

The accuracy of the assessment.

Enum keys

Full | NotAvailable | Reduced

RemediationAssessmentDataAssets

The reachability of related data assets by affected entities.

Enum keys

NotAvailable | NotDetected | Reachable

RemediationAssessmentExposure

The level of exposure of affected entities.

Enum keys

NotAvailable | NotDetected | PublicNetwork

RemediationAssessmentVulnerableFunctionUsage

The usage of vulnerable functions

Enum keys

InUse | NotAvailable | NotInUse

RemediationDetailsItemVulnerabilityState

Enum keys

Resolved | Vulnerable

RemediationItemMuteStateChangeReason

The reason for the mute state change.

Enum keys

Affected | ConfigurationNotAffected | FalsePositive | Ignore | InitialState | Other | VulnerableCodeNotInUse

RemediationItemMuteStateReason

The reason for the most recent mute state change.

Enum keys

Affected | ConfigurationNotAffected | FalsePositive | Ignore | InitialState | Other | VulnerableCodeNotInUse

RemediationItemMutingSummaryReason

Contains a reason, in case the requested operation was not executed.

Enum keys

AlreadyMuted | AlreadyUnmuted | RemediationItemNotAffectedByGivenSecurityProblem

RemediationItemVulnerabilityState

Enum keys

Resolved | Vulnerable

RemediationItemsBulkMuteReason

The reason for muting the remediation items.

Enum keys

ConfigurationNotAffected | FalsePositive | Ignore | Other | VulnerableCodeNotInUse

RemediationItemsBulkUnmuteReason

The reason for un-muting the remediation items.

Enum keys

Affected

RemediationProgressEntityAssessmentVulnerableFunctionUsage

The usage of vulnerable functions

Enum keys

InUse | NotAvailable | NotInUse

RemediationProgressEntityState

The current state of the remediation progress entity.

Enum keys

Affected | Unaffected

RemovePermissionPathAccessorType

Enum keys

Group | User

ResourceContextOperationsItem

The allowed operations on this settings object.

Enum keys

Delete | Read | Write

RevisionDiffType

The type of the difference.

Enum keys

Create | Delete | NoChange | Reorder | Update

RiskAssessmentAssessmentAccuracy

The accuracy of the assessment.

Enum keys

Full | NotAvailable | Reduced

RiskAssessmentBaseRiskLevel

The risk level from the CVSS score.

Enum keys

Critical | High | Low | Medium | None

RiskAssessmentChangesPreviousExposure

The previous level of exposure of affected entities.

Enum keys

NotAvailable | NotDetected | PublicNetwork

RiskAssessmentChangesPreviousPublicExploit

The previous availability status of public exploits.

Enum keys

Available | NotAvailable

RiskAssessmentChangesPreviousVulnerableFunctionUsage

The previous state of vulnerable code execution.

Enum keys

InUse | NotAvailable | NotInUse

RiskAssessmentDataAssets

The reachability of related data assets by affected entities.

Enum keys

NotAvailable | NotDetected | Reachable

RiskAssessmentDetailsAssessmentAccuracy

The accuracy of the assessment.

Enum keys

Full | NotAvailable | Reduced

RiskAssessmentDetailsBaseRiskLevel

The risk level from the CVSS score.

Enum keys

Critical | High | Low | Medium | None

RiskAssessmentDetailsDataAssets

The reachability of related data assets by affected entities.

Enum keys

NotAvailable | NotDetected | Reachable

RiskAssessmentDetailsExposure

The level of exposure of affected entities.

Enum keys

NotAvailable | NotDetected | PublicNetwork

RiskAssessmentDetailsPublicExploit

The availability status of public exploits.

Enum keys

Available | NotAvailable

RiskAssessmentDetailsRiskLevel

The Davis risk level.

It is calculated by Dynatrace on the basis of CVSS score.

Enum keys

Critical | High | Low | Medium | None

RiskAssessmentDetailsVulnerableFunctionUsage

The state of vulnerable code execution.

Enum keys

InUse | NotAvailable | NotInUse

RiskAssessmentExposure

The level of exposure of affected entities.

Enum keys

NotAvailable | NotDetected | PublicNetwork

RiskAssessmentPublicExploit

The availability status of public exploits.

Enum keys

Available | NotAvailable

RiskAssessmentRiskLevel

The Davis risk level.

It is calculated by Dynatrace on the basis of CVSS score.

Enum keys

Critical | High | Low | Medium | None

RiskAssessmentSnapshotExposure

The level of exposure of affected entities.

Enum keys

NotAvailable | NotDetected | PublicNetwork

RiskAssessmentSnapshotPublicExploit

The availability status of public exploits.

Enum keys

Available | NotAvailable

RiskAssessmentSnapshotRiskLevel

The Davis risk level.

It is calculated by Dynatrace on the basis of CVSS score.

Enum keys

Critical | High | Low | Medium | None

RiskAssessmentSnapshotVulnerableFunctionUsage

The state of vulnerable code execution.

Enum keys

InUse | NotAvailable | NotInUse

RiskAssessmentVulnerableFunctionUsage

The state of vulnerable code execution.

Enum keys

InUse | NotAvailable | NotInUse

RollupType

Enum keys

Auto | Avg | Count | Max | Median | Min | Percentile | Sum | Value

SchemaConstraintRestDtoType

The type of the schema constraint.

Enum keys

ByteSizeLimit | CustomValidatorRef | MultiScopeCustomValidatorRef | MultiScopeUnique | Unique | Unknown

SchemaTypeType

Type of the reference type.

Enum keys

Object

SecurityProblemBulkMutingSummaryReason

Contains a reason, in case the requested operation was not executed.

Enum keys

AlreadyMuted | AlreadyUnmuted

SecurityProblemDetailsStatus

The status of the security problem.

Enum keys

Open | Resolved

SecurityProblemDetailsTechnology

The technology of the security problem.

Enum keys

Dotnet | Go | Java | Kubernetes | NodeJs | Php | Python

SecurityProblemDetailsVulnerabilityType

The type of the vulnerability.

Enum keys

CodeLevel | Runtime | ThirdParty

SecurityProblemEventReason

The reason of the event creation.

Enum keys

AssessmentChanged | SecurityProblemCreated | SecurityProblemMuted | SecurityProblemReopened | SecurityProblemResolved | SecurityProblemUnmuted

SecurityProblemMuteReason

The reason for muting a security problem.

Enum keys

ConfigurationNotAffected | FalsePositive | Ignore | Other | VulnerableCodeNotInUse

SecurityProblemStatus

The status of the security problem.

Enum keys

Open | Resolved

SecurityProblemTechnology

The technology of the security problem.

Enum keys

Dotnet | Go | Java | Kubernetes | NodeJs | Php | Python

SecurityProblemUnmuteReason

The reason for un-muting a security problem.

Enum keys

Affected

SecurityProblemVulnerabilityType

The type of the vulnerability.

Enum keys

CodeLevel | Runtime | ThirdParty

SecurityProblemsBulkMuteReason

The reason for muting the security problems.

Enum keys

ConfigurationNotAffected | FalsePositive | Ignore | Other | VulnerableCodeNotInUse

SecurityProblemsBulkUnmuteReason

The reason for un-muting the security problems.

Enum keys

Affected

SloBurnRateBurnRateType

The calculated burn rate type.

Has a value of 'FAST', 'SLOW' or 'NONE'.

Enum keys

Fast | None | Slow

SloConfigItemDtoImplEvaluationType

The evaluation type of the SLO.

Enum keys

Aggregate

SLOEvaluationType

The evaluation type of the SLO.

Enum keys

Aggregate

SLOStatus

The status of the calculated SLO.

Enum keys

Failure | Success | Warning

SyntheticLocationStatus

The status of the location:

• ENABLED: The location is displayed as active in the UI. You can assign monitors to the location.
• DISABLED: The location is displayed as inactive in the UI. You can't assign monitors to the location. Monitors already assigned to the location will stay there and will be executed from the location.
• HIDDEN: The location is not displayed in the UI. You can't assign monitors to the location. You can only set location as HIDDEN when no monitor is assigned to it.

Enum keys

Disabled | Enabled | Hidden

SyntheticLocationType

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

• PUBLIC -> PublicSyntheticLocation
• PRIVATE -> PrivateSyntheticLocation
• CLUSTER -> PrivateSyntheticLocation

Enum keys

Cluster | Private | Public

SyntheticLocationUpdateType

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

• PUBLIC -> SyntheticPublicLocationUpdate
• PRIVATE -> SyntheticPrivateLocationUpdate

Enum keys

Private | Public

SyntheticMonitorPerformanceThresholdDtoAggregation

Aggregation type

Enum keys

Avg | Max | Min

SyntheticMonitorPerformanceThresholdDtoType

Type of performance threshold

Enum keys

Monitor | Step

SyntheticMonitorSummaryDtoType

Enum keys

Browser | Http | MultiProtocol | ThirdParty

SyntheticMultiProtocolMonitorRequestType

Monitor type.

Enum keys

MultiProtocol

SyntheticMultiProtocolMonitorResponseType

Monitor type.

Enum keys

Browser | Http | MultiProtocol

SyntheticMultiProtocolMonitorStepDtoRequestType

Request type.

Enum keys

Dns | Icmp | Tcp

SyntheticOnDemandBatchStatusBatchStatus

The status of the batch.

Enum keys

Failed | FailedToExecute | NotTriggered | Running | Success

SyntheticOnDemandExecutionExecutionStage

Execution stage.

Enum keys

DataRetrieved | Executed | NotTriggered | TimedOut | Triggered | Waiting

SyntheticOnDemandExecutionProcessingMode

The processing mode of the execution.

Enum keys

DisableProblemDetection | ExecutionsDetailsOnly | None | Standard | Unknown

SyntheticOnDemandExecutionRequestMonitorRepeatMode

Execution repeat mode. If not set, the mode is SEQUENTIAL.

Enum keys

Parallel | Sequential

SyntheticOnDemandExecutionRequestProcessingMode

The execution's processing mode

Enum keys

DisableProblemDetection | ExecutionsDetailsOnly | Standard

SyntheticOnDemandExecutionSource

The source of the triggering request.

Enum keys

Api | Ui

SyntheticOnDemandFailedExecutionStatusExecutionStage

Execution stage.

Enum keys

DataRetrieved | Executed | NotTriggered | TimedOut | Triggered | Waiting

SyntheticTagWithSourceDtoSource

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

Enum keys

Auto | RuleBased | User

UpdateJobAgType

The type of the ActiveGate.

Enum keys

Cluster | Environment | EnvironmentMulti

UpdateJobJobState

The status of the update job.

Enum keys

Failed | InProgress | Pending | Rollback | Scheduled | Skipped | Succeed

UpdateJobUpdateMethod

The method of updating the ActiveGate or its component.

Enum keys

Automatic | ManualInstallation | OnDemand

UpdateJobUpdateType

The component to be updated.

Enum keys

ActiveGate | RemotePluginAgent | Synthetic | ZRemote

UpdatePermissionPathAccessorType

Enum keys

Group | User

UpdatePermissionsRequestPermissionsItem

r = read, w = write

Enum keys

R | W

VulnerableFunctionInputSegmentType

The type of the input segment.

Enum keys

MaliciousInput | RegularInput | TaintedInput

VulnerableFunctionInputType

The type of the input.

Enum keys

Command | HttpClient | Jndi | SqlStatement

VulnerableFunctionProcessGroupsUsage

The vulnerable function usage based on the given process groups:

• IN_USE if at least one process group calls this vulnerable function.
• NOT_IN_USE if all process groups do not call this vulnerable function.
• NOT_AVAILABLE if vulnerable function usage could not be calculated for at least one process group and no process group calls this vulnerable function.

Enum keys

InUse | NotAvailable | NotInUse