Classic environment v2

• Reference

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.

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

v8.0.0

Version 8

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

OverviewTypesEnums

Types

AWSKeyBasedCredentialsDto

A credentials set of the AWS_MONITORING_KEY_BASED type.

Name	Type	Description
accessKeyID*required	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*required	"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" | "EXTENSION_AUTHENTICATION"	The scope of the credentials set.
scopes*required	Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE" | "EXTENSION_AUTHENTICATION">	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*required	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*required	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*required	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" | "EXTENSION_AUTHENTICATION"	The scope of the credentials set.
scopes*required	Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE" | "EXTENSION_AUTHENTICATION">	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*required	Identity	An Identity describing either a user, a group, or the all-users group (applying to all users).
permissions*required	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	Auto-update configuration for an individual environment ActiveGate.
autoUpdateStatus	"UNKNOWN" | "INCOMPATIBLE" | "OUTDATED" | "SCHEDULED" | "SUPPRESSED" | "UP2DATE" | "UPDATE_IN_PROGRESS" | "UPDATE_PENDING" | "UPDATE_PROBLEM"	The current status of auto-updates of the ActiveGate. Example: OUTDATED
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. Example: default
hostname	string	The name of the host the ActiveGate is running on. Example: exampleHostname
id	string	The ID of the ActiveGate. Example: 0x3efdd091
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. Example: d1bf4a7e-666b-43af-9f45-718g98372e2f
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. Example: exampleNetworkZone
offlineSince	number	The timestamp since when the ActiveGate is offline. The null value means the ActiveGate is online. Example: 1582031917814
osArchitecture	"S390" | "X86" | "ARM" | "PPCLE"	The OS architecture that the ActiveGate is running on. Example: X86
osBitness	"64"	The OS bitness that the ActiveGate is running on. Example: 64
osType	"LINUX" | "WINDOWS"	The OS type that the ActiveGate is running on. Example: WINDOWS
type	"CLUSTER" | "ENVIRONMENT" | "ENVIRONMENT_MULTI"	The type of the ActiveGate. Example: ENVIRONMENT
version	string	The current version of the ActiveGate in the <major>.<minor>.<revision>.<timestamp> format. Example: 1.185.0.20200201-120000

ActiveGateAutoUpdateConfig

Auto-update configuration for an individual environment ActiveGate.

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. Example: ENABLED
setting*required	"ENABLED" | "DISABLED" | "INHERITED"	The state of the environment ActiveGate auto-update: enabled, disabled, or inherited. If set to INHERITED, the setting is inherited from the global environment ActiveGate auto-update configuration. Example: INHERITED
targetVersion	string	The target version of the ActiveGate. Specify the version in the <major>.<minor> format (for example 1.342) or latest, previous, or older. Example: latest
updateWindows	UpdateWindowsConfig	Basic information about all configured update windows

ActiveGateConnectedHosts

Information about hosts currently connected to the ActiveGate

Name	Type	Description
number	number	The number of hosts currently connected to the ActiveGate Example: 150

ActiveGateGlobalAutoUpdateConfig

Global auto-update configuration for environment ActiveGates. Applies to all environment ActiveGates that have the INHERITED auto-update setting.

Name	Type	Description
globalSetting*required	"ENABLED" | "DISABLED"	The state of auto-updates for all environment ActiveGates. This setting is inherited by all environment ActiveGates that have the INHERITED setting.
metadata	ConfigurationMetadata	Metadata useful for debugging
targetVersion	string	Version to update a ActiveGate to when automatic updates are enabled. Supports relative versions latest, previous and older as well as specific version in <major>.<minor> format (for example 1.261). Only applicable when the setting parameter is set to ENABLED. Example: latest
updateWindows	UpdateWindowsConfig	Basic information about all configured update windows

ActiveGateGroup

Information about ActiveGate group.

Name	Type	Description
name	string	Name of ActiveGate group Example: default

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. Example: KUBERNETES
version	string	The version of the ActiveGate module.

ActiveGateModuleAttributes

The attributes of the ActiveGate module.

type: Record<string, string>

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'). Example: 2020-11-22T08:15:30.144Z
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. Example: 2020-11-24T08:15:30.144Z
id*required	string	The ActiveGate token identifier, consisting of prefix and public part of the token. Example: dt0g02.4KWZO5EF
lastUsedDate	string	The token last used date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z'). Example: 2020-11-23T08:15:30.144Z
name*required	string	The name of the token. Example: myToken
owner*required	string	The owner of the token. Example: john.smith
seedToken	boolean	The token is a seed token (true) or an individual token (false). Example: 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." Example: now+6M
name*required	string	The name of the token. Example: myToken
seedToken	boolean	The token is a seed token (true) or an individual token (false). We recommend the individual token option (false). Example: 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'). Example: 2020-11-24T08:15:30.144Z
id*required	string	The ActiveGate token identifier, consisting of prefix and public part of the token. Example: dt0g02.4KWZO5EF
token*required	string	The secret of the token. Example: dt0g02.4KWZO5EF.XT47R5DRADJIZUFOX4UDNOKTSUSABGLN7XSMJG7UXHRXKNY4WLORH4OF4T75MG7E

ActiveGateTokenEnforcement

The status of ActiveGate tokens enforcement.

Name	Type	Description
autoEnforced	boolean	If true, ActiveGate tokens are enforced automatically.
autoEnforcementEstimation	Duration	Defines a period of time.
manualEnforced	boolean	If true, ActiveGate tokens are manually enforced by user.

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. Example: dt0g02.4KWZO5EF
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. Example: AQAAABQBAAAABQ==
pageSize	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

AdaptiveTrafficManagementDto

Name	Type
rootSpansPerMinute	number

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 Example: dt0a01.1.40f...bd9

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>

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 Example: {"dashboardId":"82402bab-7370-4359-924d-88ed13c8919a"}
creationDate	string	Token creation date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') Example: 2020-11-05T08:15:30.144Z
enabled	boolean	The token is enabled (true) or disabled (false). Example: true
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. Example: 2020-11-12T08:15:30.144Z
id	string	The ID of the token, consisting of prefix and public part of the token. Example: dt0c01.ST2EY72KQINMH574WMNVI7YN
lastUsedDate	string	Token last used date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') Example: 2020-11-12T08:15:30.144Z
lastUsedIpAddress	string	Token last used IP address. Example: 34.197.2.44
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. Example: 2020-11-12T08:15:30.144Z
name	string	The name of the token. Example: myToken
owner	string	The owner of the token. Example: john.smith
personalAccessToken	boolean	The token is a personal access token (true) or an API token (false). Example: true
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" | "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" | "extensionDiscoveryJmx.read" | "extensionDiscoveryPmi.read" | "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" | "openpipeline.events_smartscape" | "problems.read" | "problems.write" | "releases.read" | "rumCookieNames.read" | "rumManualInsertionTags.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. Example: now+14d
name*required	string	The name of the token. Example: tokenName
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. Example: false
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" | "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" | "extensionDiscoveryJmx.read" | "extensionDiscoveryPmi.read" | "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" | "openpipeline.events_smartscape" | "problems.read" | "problems.write" | "releases.read" | "rumCookieNames.read" | "rumManualInsertionTags.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). openpipeline.events_smartscape: OpenPipeline - Ingest Smartscape Events (Built-in). bizevents.ingest: Ingest bizevents. 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. rumManualInsertionTags.read: Read RUM manual insertion tags. extensionDiscoveryJmx.read: Read discovered JMX metrics via extensions. extensionDiscoveryPmi.read: Read discovered PMI metrics via extensions.

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'). Example: 2020-11-12T08:15:30.144Z
id	string	The ID of the token, consisting of prefix and public part of the token. Example: dt0c01.ST2EY72KQINMH574WMNVI7YN
token	string	The secret of the token. Example: dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM

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. Example: AQAAABQBAAAABQ==
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. Example: dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM

ApiTokenUpdate

The update of the API token.

Name	Type	Description
enabled	boolean	The token is enabled (true) or disabled (false) Example: true
name	string	The name of the token. Example: myToken
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" | "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" | "extensionDiscoveryJmx.read" | "extensionDiscoveryPmi.read" | "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" | "openpipeline.events_smartscape" | "problems.read" | "problems.write" | "releases.read" | "rumCookieNames.read" | "rumManualInsertionTags.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). openpipeline.events_smartscape: OpenPipeline - Ingest Smartscape Events (Built-in). bizevents.ingest: Ingest bizevents. 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. rumManualInsertionTags.read: Read RUM manual insertion tags. extensionDiscoveryJmx.read: Read discovered JMX metrics via extensions. extensionDiscoveryPmi.read: Read discovered PMI metrics via extensions.

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" | "LIMITED_BY_SERVICE_DETECTION_V2">	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" | "DOCUMENT_SCREEN" | "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" | "OPEN_PIPELINE" | "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. Example: AQAAABQBAAAABQ==
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. Example: AQAAABQBAAAABQ==
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. Example: environment
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

AuthenticationDto

Authentication dto for Browser Monitor step.

Name	Type	Description
authServerAllowlist	string	String containing the allowed servers of KERBEROS authentication. Can be defined only for KERBEROS authentication type.
domain	string	String containing the KERBEROS authentication domain. Can be defined only for KERBEROS authentication type.
inputType*required	"PLAIN" | "SECURE"	Defines the actual set of fields depending on the value. See one of the following objects: SECURE -> SecureAuthenticationDto PLAIN -> PlainAuthenticationDto
type*required	"HTTP_AUTHENTICATION" | "KERBEROS" | "WEBFORM"	Type of authentication.

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*required	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.

BaseWaitConditionDto

Wait condition for Browser Monitor step.

Name	Type	Description
type*required	"NETWORK" | "NEXT_EVENT" | "PAGE_COMPLETE" | "TIME" | "VALIDATION"	Defines the actual set of fields depending on the value. See one of the following objects: TIME -> TimeWaitConditionDto VALIDATION -> ValidationWaitConditionDto PAGE_COMPLETE -> BaseWaitConditionDto NETWORK -> BaseWaitConditionDto NEXT_EVENT -> BaseWaitConditionDto

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.

BrowserPermissionsDto

Permissions settings for browser.

Name	Type	Description
camera	boolean	Camera permission. If not defined in request, it will be set to false by default.
location	boolean	Location permission. If not defined in request, it will be set to false by default.
microphone	boolean	Microphone permission. If not defined in request, it will be set to false by default.
notifications	boolean	Notifications permission. If not defined in request, it will be set to false by default.

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*required	string	String containing the certificate file bytes encoded in Base64 without carriage return.
certificateFormat*required	"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*required	string	The password of the credential encoded in Base64. Must be empty for PEM certificates.
scopeDEPRECATED	"EXTENSION" | "SYNTHETIC" | "APP_ENGINE" | "EXTENSION_AUTHENTICATION"	The scope of the credentials set.
scopes*required	Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE" | "EXTENSION_AUTHENTICATION">	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

ChromiumStartupFlagsDto

Chromium startup flags of a Browser Monitor.

Name	Type	Description
autoplay-policy	"no-user-gesture-required" | "document-user-activation-required"	autoplay-policy type.
disable-features	ChromiumStartupFlagsDtoDisableFeatures	disable-features map
disable-site-isolation-trials	boolean	disable-site-isolation-trials flag.
disable-web-security	boolean	disable-web-security flag. If no value is passed, it will be set to false by default.
host-resolver-rules	string	host-resolver-rules.
ignore-certificate-errors	boolean	ignore-certificate-errors flag.
ssl-version-max	string	ssl-version-max.
ssl-version-min	string	ssl-version-min.
test-type	boolean	test-type flag.

ChromiumStartupFlagsDtoDisableFeatures

disable-features map

type: Record<string, boolean>

ClientCertificateDto

Client certificate.

Name	Type	Description
credentialId*required	string	Certificate CV id.
domain*required	string	Domain certificate will be applied to.

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. Example: AQAAABQBAAAABQ==
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. Example: false
customMessage	string	A custom message for invalid values.
customValidatorId	string	The ID of a custom validator. Example: my-min-max
maximumPropertyCount	number	The maximum number of properties that can be set. Example: 2
minimumPropertyCount	number	The minimum number of properties that must be set. Example: 1
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. Example: false
timeout	number	The maximum time in seconds the custom validator is allowed to run. Example: 5
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. Example: 1.192.1
configurationVersions	Array<number>	A sorted list of the version numbers of the configuration. Example: [4,2]
currentConfigurationVersions	Array<string>	A sorted list of version numbers of the configuration. Example: ["1.0.4","1.23"]

Constraint

A constraint on the values accepted for a settings property.

Name	Type	Description
customMessage	string	A custom message for invalid values. Example: customConstraintMessage
customValidatorId	string	The ID of a custom validator. Example: my-min-max
disallowDangerousRegex	boolean	Whether to disallow usage of dangerous regexes Example: true
maxLength	number	The maximum allowed length of string values. Example: 20
maximum	number	The maximum allowed value. Example: 200
minLength	number	The minimum required length of string values. Example: 7
minimum	number	The minimum allowed value. Example: 3
pattern	string	The regular expression pattern for valid string values. Example: ^([a-z]|[0-9]|-|_|+|.)+@([a-z]|[0-9]|-){2,}.([a-z]|[0-9]|-){2,}(.[a-z]{2,})?$
skipAsyncValidation	boolean	Whether to skip validation on a change made from the UI. Example: false
timeout	number	The maximum time in seconds the custom validator is allowed to run. Example: 5
type*required	"UNKNOWN" | "CUSTOM_VALIDATOR_REF" | "LENGTH" | "NOT_BLANK" | "NOT_EMPTY" | "NO_WHITESPACE" | "PATTERN" | "RANGE" | "REGEX" | "TRIMMED" | "UNIQUE"	The type of the constraint. Example: UNKNOWN
uniqueProperties	Array<string>	A list of properties for which the combination of values must be unique. Example: ["my-prop-1","my-prop-2"]

ConstraintViolation

A list of constraint violations

Name	Type
location	string
message	string
parameterLocation	"HEADER" | "PATH" | "PAYLOAD_BODY" | "QUERY"
path	string

ContainerImageComponent

Information about component type and images registry URI.

Name	Type	Description
imageUri	string	Registry URI of the container image component.
type	"activegate" | "codemodules" | "database-datasource-executor" | "sql-extension-executor" | "dynatrace-sql-extension-executor" | "eec" | "logmodule" | "oneagent"	Container image component type.

ContainerImageData

Information about images registry and components with URI.

Name	Type	Description
components	Array<ContainerImageComponent>	List of container image components.
registry	string	Registry name containing container images.

CookieStepDto

Cookie step of Browser Monitor.

Name	Type	Description
cookies*required	Array<SyntheticMonitorCookieDto>	Field containing the list of cookies.
entityId	string	Entity Id.
name*required	string	The name of Browser Monitor step.
type*required	"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"	Defines the actual set of fields depending on the value. See one of the following objects: NAVIGATE -> NavigateStepDto CLICK -> InteractionStepDto TAP -> InteractionStepDto KEYSTROKES -> KeyStrokesStepDto JAVASCRIPT -> JavaScriptStepDto SELECT_OPTION -> SelectOptionStepDto COOKIE -> CookieStepDto

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" | "EXTENSION_AUTHENTICATION"	The scope of the credentials set.
scopes*required	Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE" | "EXTENSION_AUTHENTICATION">	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

CredentialsDetailsList

A list of detailed credentials sets for Synthetic monitors.

Name	Type	Description
allowPlaybackWithPrefilledCredentials	boolean
credentials*required	Array<AbstractCredentialsResponseElement>	A list of credentials sets for Synthetic monitors.

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" | "EXTENSION_AUTHENTICATION"	The scope of the credentials set.
scopes	Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE" | "EXTENSION_AUTHENTICATION">	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>

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*required	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*required	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*required	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*required	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*required	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*required	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*required	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. Example: AQAAABQBAAAABQ==
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. Example: my-min-max
schemaIds	Array<string>
timeout	number	The maximum time in seconds the custom validator is allowed to run. Example: 5
type*required	"UNKNOWN" | "CUSTOM_VALIDATOR_REF" | "REFERENTIAL_INTEGRITY"	The type of the deletion constraint.

Duration

Defines a period of time.

Name	Type	Description
unit	"DAYS" | "HOURS" | "MILLIS" | "MINUTES" | "SECONDS"	The unit of time. If not set, millisecond is used.
value*required	number	The amount of time.

EffectivePermission

Name	Type	Description
context	PermissionContext	Optional context data
granted*required	"condition" | "false" | "true"
permission*required	string	Example: settings:objects:write

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. Example: john.doe@example.com
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. Example: HOST-D3A3C5A146830A79
schemaId	string	The schema on which the object is based. Example: builtin:container.built-in-monitoring-rule
schemaVersion	string	The version of the schema on which the object is based. Example: 1.0.0
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. Example: {"autoMonitoring":true}

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. Example: AQAAABQBAAAABQ==
pageSize*required	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

EnablementDto

Browser monitor enablement settings.

Name	Type	Description
enableOnGrail*required	boolean	Enable 3rd gen JS agent reporting. Relevant only for grail-enabled SaaS environments.
origin	"UNKNOWN" | "DEFAULT" | "MONITOR" | "TENANT"	Indicates the origin of these settings.

EnrichedManagementZoneDto

Name	Type	Description
id	string	The ID of the management zone.
name	string	The name of the management zone.
sourceSetting	string	The path to the settings object in the Settings API.

EnrichedTagDto

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.
source	string	The source where the tag comes from. Possible values are: Auto tags Environment tags User provided tags
sourceSetting	string	The path to the settings object in the Settings API. Only available for tags with the Auto tags source.
stringRepresentation	string	The string representation of the tag.
value	string	The value of the tag.

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. Example: AQAAABQBAAAABQ==
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<EnrichedManagementZoneDto>	A set of management zones to which the entity belongs.
properties	EntityProperties	A list of additional properties of the entity.
tags	Array<EnrichedTagDto>	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[]>

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[]>

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	Indicates whether the entity creation limit for this type has been exceeded. When true, Dynatrace automatically triggers a cleanup process for this entity type. New entities will still be created, and no action is required. This applies only for builtin-types. For generic types creation and update gets blocked. You can recognize a generic type by containing ':' in the name for example my:type.
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. Example: AQAAABQBAAAABQ==
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. Example: cpu cores
id	string	The ID of the property. Example: cpuCores
type	string	The type of the property. Example: Number

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. Example: typeDescription
displayName	string	The display name of the property. Example: typeDisplayName
documentation*required	string	An extended description and/or links to documentation. Example: typeDocumentation
enumClass	string	An existing Java enum class that holds the allowed values of the enum. Example: enumClass
items*required	Array<EnumValue>	A list of allowed values of the enum.
type*required	"enum"	The type of the property. Example: enum

EnumValue

An allowed value for an enum property.

Name	Type	Description
description	string	A short description of the value. Example: exampleDescription
displayName*required	string	The display name of the value. Example: exampleDisplayName
enumInstance	string	The name of the value in an existing Java enum class. Example: exampleJavaEnumValue
icon	string	The icon of the value. Example: checkmark
value*required	AnyValue	The allowed value of the enum. Example: exampleValue

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. Example: 933613657e1c8fcf
endTime	number	The timestamp when the event was closed, in UTC milliseconds. Has the value of null if the event is still active. Example: 1564039524182
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. Example: 4293884258445543163_1564039524182
eventType	string	The type of the event. Example: LOW_DISK_SPACE
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. Example: 1564039524182
status	"CLOSED" | "OPEN"	The status of the event. Example: OPEN
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. Example: High CPU load on host X
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*required	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*required	string	The ID of the event.
eventType*required	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. Note that the entityId filter bypasses this time constraint, allowing events to be ingested for entities that have been inactive for more than 24 hours. 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" | "WARNING"	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>

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. Example: AQAAABQBAAAABQ==
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. Example: AQAAABQBAAAABQ==
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. Example: Custom description
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. Example: dt.event.description
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. Example: High CPU
severityLevel	"CUSTOM_ALERT" | "AVAILABILITY" | "ERROR" | "INFO" | "MONITORING_UNAVAILABLE" | "PERFORMANCE" | "RESOURCE_CONTENTION"	The severity level associated with the event type. Example: PERFORMANCE
type	string	The event type. Example: OSI_HIGH_CPU

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. Example: AQAAABQBAAAABQ==
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>

ExecuteActionsResponse

Name	Type	Description
agIdDEPRECATED	string	Active Gate id for actions execution
agIds	Array<string>	Active Gate ids for actions execution
agNameDEPRECATED	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. Example: AQAAABQBAAAABQ==
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 Example: 1.2.3 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. Example: 1.2.3 Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

ExtensionEnvironmentConfigurationVersion

Name	Type	Description
version*required	string	Extension version Example: 1.2.3 Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

ExtensionFeatureSetsDetails

Details of feature sets

type: Record<string, FeatureSetDetails>

ExtensionInfo

A list of extensions with additional metadata.

Name	Type	Description
activeVersion	null | string	Active version in the environment (null if none is active) Example: 1.2.3 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 Example: 1.2.3 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. Example: AQAAABQBAAAABQ==
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. Example: AQAAABQBAAAABQ==
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. Example: AQAAABQBAAAABQ==
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" | "WARNING" | "OK" | "ERROR" | "PENDING"	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" | "WARNING" | "OK" | "ERROR" | "PENDING"	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 Example: 1.2.3 Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

ExtensionUploadResponseDtoFeatureSetsDetails

Details of feature sets

type: Record<string, FeatureSetDetails>

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

FilteredRequestsDto

Filtered requests of a Browser Monitor.

Name	Type	Description
mode*required	"BLOCK" | "ALLOW"	Filter mode for filtered requests.
requests*required	Array<RequestFilterDto>	Requests to be filtered.

FrameworkOptionsDto

JS framework options of a JS Agent.

Name	Type	Description
activeXObject	boolean	activeXObject support. If not defined in request, it will be set to false by default.
angular	boolean	Angular support. If not defined in request, it will be set to false by default.
dojo	boolean	Dojo support. If not defined in request, it will be set to false by default.
extJs	boolean	extJs support. If not defined in request, it will be set to false by default.
icefaces	boolean	icefaces support. If not defined in request, it will be set to false by default.
jQuery	boolean	jquery support. If not defined in request, it will be set to false by default.
mooTools	boolean	mooTools support. If not defined in request, it will be set to false by default.
prototype	boolean	prototype support. If not defined in request, it will be set to false by default.

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*required	string	Path to folder where credentials in HashiCorp Vault are stored.
roleId*required	string	Role ID is similar to username when you want to authenticate in HashiCorp Vault using AppRole.
secretId*required	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*required	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. Example: fab17b7a-2eb2-4c95-b818-743d94be2c30
lastModifiedReason	string	Reason for system change Example: default settings creation
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. Example: user

IgnoredErrorCodesDto

Ignored Error Codes of a Browser Monitor.

Name	Type	Description
matchingDocumentRequests	string	Ignoring status codes will be applied to requests matching pattern.
statusCodes	string	Status codes to be ignored.

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

InteractionStepDto

Interaction step of Browser Monitor.

Name	Type	Description
button*required	"MOUSE_LEFT" | "MOUSE_MIDDLE" | "MOUSE_RIGHT"	Integer containing the button index.
entityId	string	Entity Id.
name*required	string	The name of Browser Monitor step.
target	TargetDto	Target of Browser Monitor step.
type*required	"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"	Defines the actual set of fields depending on the value. See one of the following objects: NAVIGATE -> NavigateStepDto CLICK -> InteractionStepDto TAP -> InteractionStepDto KEYSTROKES -> KeyStrokesStepDto JAVASCRIPT -> JavaScriptStepDto SELECT_OPTION -> SelectOptionStepDto COOKIE -> CookieStepDto
validationRules	Array<ValidationRuleDto>	List of validation rules for the step to perform.
waitCondition	BaseWaitConditionDto	Wait condition for Browser Monitor step.

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. Example: itemDescription
displayName	string	The display name of the item. Example: itemDisplayName
documentation	string	An extended description and/or links to documentation. Example: propertyDocumentation
metadata	ItemMetadata	Metadata of the items.
referencedType	string	The type referenced by the item's value. Example: itemReferencedType
subType	string	The subtype of the item's value. Example: itemSubType
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>

JavaProcessContainer

Name	Type
agentVersion	string
id	string
name	string
properties	JavaProcessContainerProperties

JavaProcessContainerList

Name	Type
items*required	Array<JavaProcessContainer>

JavaProcessContainerProperties

type: Record<string, string[]>

JavaScriptAgentSettingsDto

JavaScript Agent Settings.

Name	Type	Description
customProperties	string	Custom configuration properties
experimentalValues	boolean	Experimental values support. If not defined in request, it will be set to false by default.
fetchRequests	boolean	Capture fetch() requests. If not defined in request, it will be set to true by default.
javaScriptErrors	boolean	Enable this setting to monitor JavaScript errors. The window.onError handler is used for capturing JavaScript errors. If not defined in request, it will be set to true by default.
javaScriptFrameworkSupport	FrameworkOptionsDto	JS framework options of a JS Agent.
timedActions	boolean	Within JavaScript frameworks, XHRs are often sent via setTimeout methods. Enable this setting to detect actions that trigger such XHRs. If not defined in request, it will be set to true by default.
timeoutSettings	TimeoutSettingsDto	Timeout settings of a Browser Monitor.
visuallyCompleteOptions	VisuallyCompleteOptionsDto	Visually Complete Options of a Browser Monitor.
xmlHttpRequests	boolean	Capture xml Http requests (XHR). If not defined in request, it will be set to true by default.

JavaScriptMappingFileDto

Name	Type	Description
fileName	string	The name of the file.
fileType	"MINIFIED" | "SOURCE" | "SOURCEMAP"	The type of the file.
minifiedJsFileUrl	string	The minified JavaScript file URL to which the mapping file belongs to.
numberOfFiles	number	The number of files.
pinned	boolean	Whether the file is pinned and therefore not automatically deleted.
size	number	The size of the file, in KB.
uploadTimestamp	number	The timestamp of the file upload, in UTC milliseconds.
zipped	boolean	Whether several files are zipped into one file.

JavaScriptMappingFileListDto

Name	Type	Description
jsMappingFiles	Array<JavaScriptMappingFileDto>	A list of JavaScript mapping files.
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. Example: AQAAABQBAAAABQ==
pageSize	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

JavaScriptMappingFileMetadataDto

Name	Type	Description
pinned	boolean	Whether the file is pinned and therefore not automatically deleted.

JavaScriptStepDto

JavaScript step of Browser Monitor.

Name	Type	Description
entityId	string	Entity Id.
javaScript*required	string	String containing a script in JavaScript.
name*required	string	The name of Browser Monitor step.
target	TargetDto	Target of Browser Monitor step.
type*required	"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"	Defines the actual set of fields depending on the value. See one of the following objects: NAVIGATE -> NavigateStepDto CLICK -> InteractionStepDto TAP -> InteractionStepDto KEYSTROKES -> KeyStrokesStepDto JAVASCRIPT -> JavaScriptStepDto SELECT_OPTION -> SelectOptionStepDto COOKIE -> CookieStepDto
waitCondition	BaseWaitConditionDto	Wait condition for Browser Monitor step.

KeyPerformanceMetrics

The key performance metrics configuration.

Name	Type	Description
loadActionKpm	"USER_ACTION_DURATION" | "VISUALLY_COMPLETE" | "SPEED_INDEX" | "DOM_INTERACTIVE" | "LOAD_EVENT_START" | "LOAD_EVENT_END" | "RESPONSE_START" | "RESPONSE_END" | "LARGEST_CONTENTFUL_PAINT" | "CUMULATIVE_LAYOUT_SHIFT"	Load action key performance metric.
xhrActionKpm	"USER_ACTION_DURATION" | "VISUALLY_COMPLETE" | "RESPONSE_START" | "RESPONSE_END"	XHR action key performance metric.

KeyStrokesStepDto

Key strokes step of Browser Monitor.

Name	Type	Description
entityId	string	Entity Id.
input*required	KeystrokesInputDto	Key strokes step input.
name*required	string	The name of Browser Monitor step.
simulateBlurEvent	boolean	Boolean value set to true if blur event should be simulated.
simulateReturnKey	boolean	Boolean value set to true if return key should be simulated.
target	TargetDto	Target of Browser Monitor step.
type*required	"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"	Defines the actual set of fields depending on the value. See one of the following objects: NAVIGATE -> NavigateStepDto CLICK -> InteractionStepDto TAP -> InteractionStepDto KEYSTROKES -> KeyStrokesStepDto JAVASCRIPT -> JavaScriptStepDto SELECT_OPTION -> SelectOptionStepDto COOKIE -> CookieStepDto
validationRules	Array<ValidationRuleDto>	List of validation rules for the step to perform.
waitCondition	BaseWaitConditionDto	Wait condition for Browser Monitor step.

KeystrokesInputDto

Key strokes step input.

Name	Type	Description
type*required	"PLAIN" | "SECURE"	Defines the actual set of fields depending on the value. See one of the following objects: SECURE -> SecureKeystrokesInputDto PLAIN -> PlainKeystrokesInputDto

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.

LocatorDto

Browser Monitor locator.

Name	Type	Description
type*required	"CSS" | "DOM"	Enum value of the locator type.
value*required	string	Value of the locator.

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	string	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[]>

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*required	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*required	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	"auto" | "avg" | "count" | "max" | "median" | "min" | "percentile" | "sum" | "value"	The type of default aggregation.

MetricDescriptor

The descriptor of a metric.

Name	Type	Description
aggregationTypes	Array<"auto" | "avg" | "count" | "max" | "median" | "min" | "percentile" | "sum" | "value">	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<"asGauge" | "default" | "delta" | "evaluateModel" | "filter" | "fold" | "histogram" | "last" | "lastReal" | "limit" | "merge" | "names" | "parents" | "partition" | "rate" | "rollup" | "setUnit" | "smooth" | "sort" | "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*required	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*required	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*required	"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*required	number	The metric's value after the problem start.
valueBeforeChangePoint*required	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>

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 Example: 1.2.3 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.

MonitorPropertyDto

Property of a Browser Monitor.

Name	Type	Description
name*required	string	Property name.
value*required	string	Property value.

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*required	string	Header's name.
value*required	string	Header's value.

MonitoredEntityStateParam

Key-value parameter of the monitoring state.

Name	Type	Description
key	string	The key of the monitoring state parameter.
values	string	The value of the monitoring state parameter.

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 process group instances 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. Example: AQAAABQBAAAABQ==
pageSize	number	The number of entries per page.
totalCount	number	The total number of unique process group instances in the response.

MonitoringConfigurationDto

Name	Type	Description
scope*required	string	The scope this monitoring configuration will be defined for Example: HOST-D3A3C5A146830A79
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 Example: 331e416f-9ab7-4694-8408-816026820645

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.

NavigateStepDto

Step of Browser Monitor that navigates to a website.

Name	Type	Description
authentication	AuthenticationDto	Authentication dto for Browser Monitor step.
entityId	string	Entity Id.
name*required	string	The name of Browser Monitor step.
target	TargetDto	Target of Browser Monitor step.
type*required	"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"	Defines the actual set of fields depending on the value. See one of the following objects: NAVIGATE -> NavigateStepDto CLICK -> InteractionStepDto TAP -> InteractionStepDto KEYSTROKES -> KeyStrokesStepDto JAVASCRIPT -> JavaScriptStepDto SELECT_OPTION -> SelectOptionStepDto COOKIE -> CookieStepDto
url*required	string	Field containing the url that the monitor should navigate to.
validationRules	Array<ValidationRuleDto>	List of validation rules for the step to perform.
waitCondition	BaseWaitConditionDto	Wait condition for Browser Monitor step.

NetworkThrottlingDto

Network throttling of a Browser Monitor.

Name	Type	Description
download	number	Download throughput. If not defined in request, it will be set to -1 by default.
latency	number	Latency. If not defined in request, it will be set to 0 by default.
name	string	Predefined network type. If not defined in request, it will be set to "" by default.
upload	number	Upload throughput. If not defined in request, it will be set to -1 by default.

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.
capabilities*required	Array<string>	The list of node's capabilities.
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.
capabilities*required	Array<string>	The list of node's capabilities.
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. Example: AQAAABQBAAAABQ==
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 Example: service:schema
scope*required	string	Settings scope for conditional permission Example: environment

PlainAuthenticationDto

Plain authentication dto for Browser Monitor step.

Name	Type	Description
authServerAllowlist	string	String containing the allowed servers of KERBEROS authentication. Can be defined only for KERBEROS authentication type.
domain	string	String containing the KERBEROS authentication domain. Can be defined only for KERBEROS authentication type.
inputType*required	"PLAIN" | "SECURE"	Defines the actual set of fields depending on the value. See one of the following objects: SECURE -> SecureAuthenticationDto PLAIN -> PlainAuthenticationDto
password*required	string	String containing the password.
type*required	"HTTP_AUTHENTICATION" | "KERBEROS" | "WEBFORM"	Type of authentication.
username*required	string	String containing the username.

PlainKeystrokesInputDto

Credential-based input for keystrokes step.

Name	Type	Description
masked	boolean	Boolean value set to true only if key strokes input textValue field is encoded by recorder and should be decoded by VUP. Set to false by default.
textValue*required	string	String value containing the text.
type*required	"PLAIN" | "SECURE"	Defines the actual set of fields depending on the value. See one of the following objects: SECURE -> SecureKeystrokesInputDto PLAIN -> PlainKeystrokesInputDto

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. Example: expectedValue
expectedValues	Array<AnyValue>	A list of valid values of the property. Only applicable to properties of the IN type. Example: expectedValues
pattern	string	The Regular expression which is matched against the property. Only applicable to properties of the REGEX_MATCH type. Example: example Regex
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. Example: propertyToEvaluate
type*required	"EQUALS" | "AND" | "IN" | "NOT" | "NULL" | "OR" | "REGEX_MATCH"	The type of the precondition. Example: NULL

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.
fipsMode	"ENABLED" | "DISABLED" | "ENABLED_WITH_CORPORATE_PROXY"	Containerized location property indicating whether FIPS mode is enabled on this location: DISABLED: FIPS is not enabled on the location. ENABLED: FIPS is enabled on the location. ENABLED_WITH_CORPORATE_PROXY: FIPS with corporate proxy is enabled on this location. Default: DISABLED
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. Minimum: 1
longitude*required	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). Minimum: 1
minActiveGateCount	number	Containerized location property. The minimum number of ActiveGates deployed for the location (required for a Kubernetes location). Minimum: 1
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.
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*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>

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. Example: AQAAABQBAAAABQ==
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. Example: propertyDefaultValue
description	string	A short description of the property. Example: propertyDescription
displayName	string	The display name of the property. Example: propertyDisplayName
documentation	string	An extended description and/or links to documentation. Example: propertyDocumentation
forceSecretResubmission	boolean	Defines if value is allowed to be modified when secret properties are not Example: true
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. Example: 1
modificationPolicy	"DEFAULT" | "ALWAYS" | "NEVER"	Modification policy of the property. Example: ALWAYS
nullable*required	boolean	The value can (true) or can't (false) be null. Example: true
precondition	Precondition	A precondition for visibility of a property.
referencedType	string	The type referenced by the property value Example: propertyReferencedType
subType	string	The subtype of the property's value. Example: propertySubType
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>

ProtocolDetails

Details that are specific to the used protocol.

Name	Type	Description
http	HttpProtocolDetails	HTTP specific request details.

ProxyDto

Browser Monitor proxy.

Name	Type	Description
pacUrl*required	string	pacUrl

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*required	string	The certificate in the string format.
certificateFormat*required	"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*required	string	The password of the credential (not supported).
scopeDEPRECATED	"EXTENSION" | "SYNTHETIC" | "APP_ENGINE" | "EXTENSION_AUTHENTICATION"	The scope of the credentials set.
scopes*required	Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE" | "EXTENSION_AUTHENTICATION">	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*required	string	The type of the browser the location is using to execute browser monitors.
browserVersion*required	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*required	"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*required	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*required	"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

PutBody

Name	Type	Description
file*required	Binary | Buffer | Blob | File	React Native mapping file to upload

ReactNativeMappingFileDto

A list of React Native mapping files.

Name	Type	Description
appId	string	The ID of the application the mapping file belongs to.
appInternalId	string	The internal ID of the application the mapping file belongs to.
bundleName	string	The name of the bundle.
bundleVersion	string	The version of the bundle.
fileName	string	The name of the mapping file.
metadata	ReactNativeMappingFileMetadataDto
platform	"ANDROID" | "IOS"	The platform (operating system) the mapping file belongs to.

ReactNativeMappingFileListDto

Name	Type	Description
mappingFiles	Array<ReactNativeMappingFileDto>	A list of React Native mapping files.
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. Example: AQAAABQBAAAABQ==
pageSize	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

ReactNativeMappingFileMetadataDto

Name	Type	Description
pinned	boolean	Whether the file is pinned and therefore not automatically deleted.
storedSizeInBytes	number	File size in bytes, as it is stored.
uploadTimestampInMilliseconds	number	Upload timestamp in milliseconds.

ReactNativeMappingFileMetadataUpdateDto

Name	Type	Description
pinned	boolean	Whether the file is pinned and therefore not automatically deleted.

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. Example: refPointerToAnotherJsonObject

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 <name, product, stage, version> is always unique.

Name	Type	Description
affectedByProblems	boolean	The entity has one or more problems Example: true
affectedBySecurityVulnerabilities	boolean	The entity has one or more security vulnerabilities Example: true
instances	Array<ReleaseInstance>	The instances entityIds included in this release Example: ["PROCESS_GROUP_INSTANCE-49D94B90FB71C45B","PROCESS_GROUP_INSTANCE-7EA049157C82D1A5"]
name	string	The entity name Example: cluster
problemCount	number	The number of problems of the entity Example: 4 Minimum: 0
product	string	The product name Example: Sockshop
releaseEntityId	string	The entity id of correlating release. Example: PROCESS_GROUP-DFDBAC9CBF104253
running	boolean	The related PGI is still running/monitored Example: true
securityVulnerabilitiesCount	number	The number of security vulnerabilities of the entity Example: 4 Minimum: 0
securityVulnerabilitiesEnabled	boolean	Indicates that the security vulnerabilities feature is enabled Example: true
softwareTechs	Array<SoftwareTechs>	The software technologies of the release Example: [{"edition":"OpenJDK","technology":"JAVA","verbatimType":"Java","version":"1.8.0_242"}]
stage	string	The stage name Example: staging
throughput	number	The count of bytes per second of the entity Example: 923234 Minimum: 0
version	string	The identified release version Example: 1.195.34.12341232423-012342

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 Example: 223005
entityId	string	The entity id of the instance. Example: PROCESS_GROUP_INSTANCE-DFDBAC9CBF104253
problems	Array<string>	List of event Ids of open problems Example: ["573177299181554914_1616573184015V2"]
securityVulnerabilities	Array<string>	List of Security vulnerabilities Ids Example: ["SNYK-JAVA-COMFASTERXMLJACKSONCORE-1234567"]

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. Example: AQAAABQBAAAABQ==
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. Example: IGNORE

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>

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.

RemoteConfigurationManagementEntityValidationError

Entity validation error for remote configuration management.

Name	Type	Description
entity	string	The ID of the entity for which validation failed. Example: entityId
reasons	Array<"CLOUD_NATIVE_NOT_SUPPORTED" | "NOT_ALLOWED_WITH_CLUSTER_ACTIVE_GATE" | "NOT_CONNECTED" | "RUNNING_IN_CONTAINER" | "STANDALONE_NOT_SUPPORTED" | "VERSION_NOT_SUPPORTED">	The reason of entity validation failure. Example: ["RUNNING_IN_CONTAINER"]

RemoteConfigurationManagementJob

Remote configuration management job.

Name	Type	Description
endTime	string	Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was finished. This field is present only for finished jobs. Example: 2020-11-05T08:15:30.144Z
entityType	"ACTIVE_GATE" | "ONE_AGENT"	Type of entities modified by remote configuration management. Example: ACTIVE_GATE or ONE_AGENT
failedEntities	Array<RemoteIdentityOperationFailedEntityDto>	A list of failed remote configuration management jobs.
id	string	The ID of the remote configuration management job. Example: 7974003406714390819
inProgressEntities	Array<string>	A list of in-progress remote configuration management jobs. Example: ["HOST-D454A967666E7970"]
operations	Array<RemoteConfigurationManagementOperation>	A list of executed (successful and failed) remote configuration management jobs.
processedEntitiesCount	number	Number of entities that were already processed at the time the response was created. Example: 1
startTime	string	Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was started. Example: 2020-11-05T08:15:30.144Z
timeoutTime	string	Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the running remote configuration management job will time-out. This field is present only for running jobs. Example: 2020-11-05T08:15:30.144Z
totalEntitiesCount	number	Total number of entities to process. Example: 1

RemoteConfigurationManagementJobList

A list of remote configuration management jobs.

Name	Type	Description
jobs	Array<RemoteConfigurationManagementJobSummary>	A list of remote configuration management jobs.

RemoteConfigurationManagementJobPreview

A preview of remote configuration management job.

Name	Type	Description
alreadyConfiguredEntitiesCount	number	The number of entities that are currently configured as defined by remote configuration management operation. Example: 1
attribute	"group" | "hostGroup" | "hostProperty" | "hostTag" | "networkZone"	The attribute which is affected by the operation. Example: networkZone
operation	"clear" | "set"	The operation performed on given attribute. Example: set
targetEntitiesCount	number	The number of entities that will be configured as defined by remote configuration management after it is completed. Example: 2
value	string	The value which should be assigned to given attribute. Example: exampleNetworkZoneName

RemoteConfigurationManagementJobSummary

Remote configuration management job with basic data.

Name	Type	Description
endTime	string	Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was finished. This field is present only for finished jobs. Example: 2020-11-05T08:15:30.144Z
entityType	"ACTIVE_GATE" | "ONE_AGENT"	Type of entities modified by remote configuration management. Example: ACTIVE_GATE or ONE_AGENT
id	string	The ID of the remote configuration management job. Example: 7974003406714390819
startTime	string	Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was started. Example: 2020-11-05T08:15:30.144Z

RemoteConfigurationManagementOperation

Definition of a single remote configuration management operation.

Name	Type	Description
attribute*required	"group" | "hostGroup" | "hostProperty" | "hostTag" | "networkZone"	The attribute which is affected by the operation. Example: networkZone
operation*required	"clear" | "set"	The operation performed on given attribute. Example: set
value	string	The value which should be assigned to given attribute. Example: exampleNetworkZoneName

RemoteConfigurationManagementOperationActiveGateRequest

Remote configuration management operation creation request.

Name	Type	Description
entities*required	Array<string>	A list of entities IDs for which remote configuration management is to be executed. Example: ["0x2b7c0b02","0x4928065d"]
operations*required	Array<RemoteConfigurationManagementOperation>	A list of remote configuration management operations to be executed.

RemoteConfigurationManagementOperationOneAgentRequest

Remote configuration management operation creation request.

Name	Type	Description
entities*required	Array<string>	A list of entities IDs for which remote configuration management is to be executed. Example: ["HOST-D454A967666E7970","HOST-811760CFF2A5E872"]
operations*required	Array<RemoteConfigurationManagementOperation>	A list of remote configuration management operations to be executed.

RemoteConfigurationManagementOperationValidationError

Validation error of remote configuration management operation definition.

Name	Type	Description
attribute	"group" | "hostGroup" | "hostProperty" | "hostTag" | "networkZone"	The attribute which is affected by the operation. Example: networkZone
operation	"clear" | "set"	The operation performed on given attribute. Example: set
reason	string	The reason of validation failure. Example: Value must not start with a period
value	string	The value which should be assigned to given attribute. Example: .exampleInvalidNetworkZoneName

RemoteConfigurationManagementPreviewList

A list of remote configuration management jobs previews.

Name	Type	Description
previews	Array<RemoteConfigurationManagementJobPreview>	A list of remote configuration management jobs previews.

RemoteConfigurationManagementValidationResult

The result of remote configuration management validation.

Name	Type	Description
invalidEntities	Array<RemoteConfigurationManagementEntityValidationError>	A list of validation errors for entities.
invalidOperations	Array<RemoteConfigurationManagementOperationValidationError>	A list of validation errors for operations.

RemoteIdentityOperationFailedEntityDto

Failed remote configuration management information.

Name	Type	Description
entityId	string	Entity ID for which remote configuration management request was failed Example: HOST-D454A967666E7970
failureMessage	string	Communication settings changing failure error description Example: Failed to access new tenant: f47ac10b-58cc-4372-a567-0e02b2c3d479
failureReason	"CONNECTION_FAILURE" | "TIMEOUT"	Reason of communication settings changing failure. Example: CONNECTION_FAILURE

RequestFilterDto

Request filter for Browser Monitor.

Name	Type	Description
matchingPattern*required	string	Regex for request that filter will be applied to.
type*required	"REGEX" | "STARTS_WITH" | "ENDS_WITH" | "CONTAINS" | "EQUALS"	Filter type.

RequestHeaderOptionsDto

Header Options of a Browser Monitor.

Name	Type	Description
matchingPatterns*required	Array<string>	Apply headers to requests matching pattern.
requestHeaders*required	Array<MonitorRequestHeader>	Request headers list.

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.
ownerAfter	Identity	An Identity describing either a user, a group, or the all-users group (applying to all users).
ownerBefore	Identity	An Identity describing either a user, a group, or the all-users group (applying to all users).
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. Example: 2024-06-24T01:02:03Z
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. Example: AQAAABQBAAAABQ==
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. Example: 2024-06-10T01:02:03Z

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. Example: func:slo.errorBudgetBurnRate.payment_service_availability
denominatorValueDEPRECATED	number	The denominator value used to evaluate the SLO when useRateMetric is set to false. Example: 90
description	string	A short description of the SLO. Example: Rate of successful payments per week
enabled*required	boolean	The SLO is enabled (true) or disabled (false). Example: true
error*required	string	The error of the SLO calculation. If the value differs from NONE, there is something wrong with the SLO calculation. Example: NONE
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. Example: 1.25
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. Example: func:slo.errorBudget.payment_service_availability
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. Example: 96.25
evaluationType*required	"AGGREGATE"	The evaluation type of the SLO. Example: AGGREGATE
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. Example: type("SERVICE")
id*required	string	The ID of the SLO Example: 123e4567-e89b-42d3-a456-556642440000
metricDenominatorDEPRECATED	string	The total count metric (the denominator in rate calculation). Required when the useRateMetric is set to false. Example: builtin:service.requestCount.server
metricExpression*required	string	The percentage-based metric expression for the calculation of the SLO. Example: (100)*(builtin:service.errors.server.successCount:splitBy())/(builtin:service.requestCount.server:splitBy())
metricKey*required	string	The key for the SLO's status func metric. Example: func:slo.payment_service_availability
metricName*required	string	The name that is used to create SLO func metrics keys. Once created, metric name cannot be changed. Example: payment_service_availability
metricNumeratorDEPRECATED	string	The metric for the count of successes (the numerator in rate calculation). Required when the useRateMetric is set to false. Example: builtin:service.errors.server.successCount
metricRateDEPRECATED	string	The percentage-based metric for the calculation of the SLO. Required when the useRateMetric is set to true. Example: builtin:service.successes.server.rate
name*required	string	The name of the SLO. Example: Payment service availability
normalizedErrorBudgetMetricKey*required	string	The key for the SLO's normalized error budget func metric. Example: func:slo.normalizedErrorBudget.payment_service_availability
numeratorValueDEPRECATED	number	The numerator value used to evaluate the SLO when useRateMetric is set to false. Example: 80
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. Example: [type("SERVICE")]
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. Example: WARNING
target*required	number	The target value of the SLO. Example: 95
timeframe*required	string	The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector. Example: -1d
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. Example: true
warning*required	number	The warning value of the SLO. At warning state the SLO is still fulfilled but is getting close to failure. Example: 97.5

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. Example: AQAAABQBAAAABQ==
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" | "EXTENSION_AUTHENTICATION"	The scope of the credentials set.
scopes*required	Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE" | "EXTENSION_AUTHENTICATION">	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*required	"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*required	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 Example: 500000
customMessage	string	A custom message for invalid values.
customValidatorId	string	The ID of a custom validator. Example: my-min-max
flattenCollections	boolean	Whether to flatten collection properties when checking for uniqueness, so only disjoint collections are considered unique
skipAsyncValidation	boolean	Whether to skip validation on a change made from the UI. Example: false
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 Example: ["my-prop-1","my-prop-2"]

SchemaDefinitionRestDto

Name	Type	Description
allowedScopes*required	Array<string>	A list of scopes where the schema can be used. Example: ["host","application"]
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. Example: Dynatrace disables monitoring of containers that do not run any applications
displayName*required	string	The display name of the schema. Example: Built-in container monitoring rules
documentation	string	An extended description of the schema and/or links to documentation.
dynatrace*required	string	The version of the data format. Example: 1
enums*required	SchemaDefinitionRestDtoEnums	A list of definitions of enum properties.
keyProperty	string	Name of the key property in this schema. Example: keyProperty
maturity	"EARLY_ADOPTER" | "GENERAL_AVAILABILITY" | "PREVIEW"	The maturity of the schema. Possible values: PREVIEW: Preview features are not generally available, but might be available in specific environments as part of early-access programs. These are the most likely to change in incompatible ways. EARLY_ADOPTER: Features marked "early adopter" are available in all environments, but are not mature enough to warrant the "general availability" designation. We don't expect incompatible changes for these, but please be aware, that these are not fully stable yet and incompatible changes may be necessary in rare cases. GENERAL_AVAILABILITY: Features marked "general availability" are the most stable. While the schemas will still evolve over time, care will be taken to only do so in a backward-compatible manner. In any case, automations should make use of the schemaVersion field when writing settings objects. Example: GENERAL_AVAILABILITY
maxObjects*required	number	The maximum amount of objects per scope. Only applicable when multiObject is set to true. Example: 10
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. Example: ["group:some.1","group:some.2"]
schemaId*required	string	The ID of the schema. Example: builtin:container.built-in-monitoring-rule
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. Example: 1.4.2

SchemaDefinitionRestDtoEnums

A list of definitions of enum properties.

type: Record<string, EnumType>

SchemaDefinitionRestDtoMetadata

Metadata of the setting.

type: Record<string, string>

SchemaDefinitionRestDtoProperties

A list of schema's properties.

type: Record<string, PropertyDefinition>

SchemaDefinitionRestDtoTableColumns

Table column definitions for use in the ui.

type: Record<string, TableColumn>

SchemaDefinitionRestDtoTypes

A list of definitions of types.

A type is a complex property that contains its own set of subproperties.

type: Record<string, SchemaType>

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. Example: 1

SchemaStub

The short representation of the settings schema.

Name	Type	Description
displayName	string	The name of the schema. Example: Built-in container monitoring rules
latestSchemaVersion	string	The most recent version of the schema. Example: 1.4.2
maturity	"EARLY_ADOPTER" | "GENERAL_AVAILABILITY" | "PREVIEW"	The maturity of the schema. Possible values: PREVIEW: Preview features are not generally available, but might be available in specific environments as part of early-access programs. These are the most likely to change in incompatible ways. EARLY_ADOPTER: Features marked "early adopter" are available in all environments, but are not mature enough to warrant the "general availability" designation. We don't expect incompatible changes for these, but please be aware, that these are not fully stable yet and incompatible changes may be necessary in rare cases. GENERAL_AVAILABILITY: Features marked "general availability" are the most stable. While the schemas will still evolve over time, care will be taken to only do so in a backward-compatible manner. In any case, automations should make use of the schemaVersion field when writing settings objects. Example: GENERAL_AVAILABILITY
multiObject	boolean	Multi-object flag. True if the schema is a multi-object schema Example: true
ordered	boolean	Ordered flag. True if the schema is an ordered multi-object schema. Example: false
ownerBasedAccessControl	boolean	Owner based access control flag. True if the schema has owner based access control enabled. Example: true
schemaId	string	The ID of the schema. Example: builtin:container.built-in-monitoring-rule

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. Example: typeDescription
displayName	string	The display name of the property. Example: typeDisplayName
documentation*required	string	An extended description and/or links to documentation. Example: typeDocumentation
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. Example: searchPatternOfType
summaryPattern*required	string	The pattern for the summary (for example, "Alert after X minutes.") of the configuration in the UI. Example: summaryPatternOfType
type*required	"object"	Type of the reference type. Example: object
version*required	string	The version of the type. Example: 0
versionInfo	string	A short description of the version. Example: Added new property

SchemaTypeProperties

Definition of properties that can be persisted.

type: Record<string, PropertyDefinition>

SchemasList

Name	Type	Description
versions*required	Array<string>	A list of schema versions.

SecureAuthenticationDto

Secure authentication dto for Browser Monitor step.

Name	Type	Description
authServerAllowlist	string	String containing the allowed servers of KERBEROS authentication. Can be defined only for KERBEROS authentication type.
credentialId*required	string	Id of the username and password credential which will be used for authentication.
domain	string	String containing the KERBEROS authentication domain. Can be defined only for KERBEROS authentication type.
inputType*required	"PLAIN" | "SECURE"	Defines the actual set of fields depending on the value. See one of the following objects: SECURE -> SecureAuthenticationDto PLAIN -> PlainAuthenticationDto
type*required	"HTTP_AUTHENTICATION" | "KERBEROS" | "WEBFORM"	Type of authentication.

SecureKeystrokesInputDto

Credential-based input for keystrokes step.

Name	Type	Description
credentialField*required	"TOKEN" | "USERNAME" | "PASSWORD"	Enum value of the credential field.
credentialId*required	string	String value containing the credential id.
type*required	"PLAIN" | "SECURE"	Defines the actual set of fields depending on the value. See one of the following objects: SECURE -> SecureKeystrokesInputDto PLAIN -> PlainKeystrokesInputDto

SecurityContextDtoImpl

Name	Type	Description
securityContext*required	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" | "VULNERABILITY_DEPRECATED" | "VULNERABILITY_ID_CHANGED"	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. Example: AQAAABQBAAAABQ==
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. Example: AQAAABQBAAAABQ==
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.

SelectOptionStepDto

Select option step of Browser Monitor.

Name	Type	Description
entityId	string	Entity Id.
name*required	string	The name of Browser Monitor step.
selections*required	Array<SelectionDto>	Field containing the credential.
target	TargetDto	Target of Browser Monitor step.
type*required	"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"	Defines the actual set of fields depending on the value. See one of the following objects: NAVIGATE -> NavigateStepDto CLICK -> InteractionStepDto TAP -> InteractionStepDto KEYSTROKES -> KeyStrokesStepDto JAVASCRIPT -> JavaScriptStepDto SELECT_OPTION -> SelectOptionStepDto COOKIE -> CookieStepDto
validationRules	Array<ValidationRuleDto>	List of validation rules for the step to perform.
waitCondition	BaseWaitConditionDto	Wait condition for Browser Monitor step.

SelectionDto

Option selection for Browser Monitor step.

Name	Type	Description
index*required	number	Selection index. Minimum: 0
value*required	string	Selection value.

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*required	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. Example: john.doe@example.com
created	number	The timestamp of the creation.
createdBy	string	The unique identifier of the user who created the settings object. Example: fab17b7a-2eb2-4c95-b818-743d94be2c30
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. Example: fab17b7a-2eb2-4c95-b818-743d94be2c30
objectId	string	The ID of the settings object. Example: Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
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. Example: builtin:container.built-in-monitoring-rule
schemaVersion	string	The version of the schema on which the object is based. Example: 1.0.0
scope	string	The scope that the object targets. For more details, please see Dynatrace Documentation. Example: HOST-D3A3C5A146830A79
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. Example: Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
value	AnyValue	The value of the setting. It defines the actual values of settings' parameters. The actual content depends on the object's schema. Example: {"autoMonitoring":true}

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. Example: john.doe@example.com
created	number	The timestamp of the creation.
createdBy	string	The unique identifier of the user who created the settings object. Example: fab17b7a-2eb2-4c95-b818-743d94be2c30
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. Example: fab17b7a-2eb2-4c95-b818-743d94be2c30
objectId	string	The ID of the settings object. Example: Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
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. Example: builtin:container.built-in-monitoring-rule
schemaVersion	string	The version of the schema on which the object is based. Example: 1.0.0
scope	string	The scope that the object targets. For more details, please see Dynatrace Documentation. Example: HOST-D3A3C5A146830A79
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. Example: Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
value	AnyValue	The value of the setting. It defines the actual values of settings' parameters. The actual content depends on the object's schema. Example: {"autoMonitoring":true}

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). Example: Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
objectId	string	The ID of the settings object that should be replaced. Only applicable if an external identifier is provided. Example: Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
schemaId*required	string	The schema on which the object is based. Example: builtin:container.built-in-monitoring-rule
schemaVersion	string	The version of the schema on which the object is based. Example: 1.0.0
scope*required	string	The scope that the object targets. For more details, please see Dynatrace Documentation. Example: HOST-D3A3C5A146830A79
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. Example: {"autoMonitoring":true}

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. Example: {"autoMonitoring":true}
objectId	string	For a successful request, the ID of the created or modified settings object. Example: Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=

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). Example: Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
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). Example: Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
schemaVersion	string	The version of the schema on which the object is based. Example: 1.0.0
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. Example: Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
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. Example: {"autoMonitoring":true}

SinglePermissionRequest

A list of permissions.

Name	Type	Description
context	PermissionContext	Optional context data
permission*required	string	Permission to be probed Example: settings:objects:write

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'. Example: SLOW
burnRateValue	number	The burn rate of the SLO, calculated for the last hour. Example: 1.25
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. Example: true
estimatedTimeToConsumeErrorBudget	number	The estimated time left to consume the error budget in hours. Example: 24
fastBurnThreshold	number	The threshold between a slow and a fast burn rate. Example: 1.5
sloValue	number	The calculated value of the SLO for the timeframe chosen for the burn rate calculation. Example: 95

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. Example: true
fastBurnThreshold	number	The threshold between a slow and a fast burn rate. Example: 1.5

SloConfigItemDtoImpl

Name	Type	Description
description	string	The description of the SLO. Example: Rate of successful payments per week
enabled	boolean	The SLO is enabled (true) or disabled (false). If not defined, the SLO is disabled by default. Example: true
errorBudgetBurnRate	SloBurnRateConfig	Error budget burn rate configuration of a service-level objective (SLO).
evaluationType*required	"AGGREGATE"	The evaluation type of the SLO. Example: AGGREGATE
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. Example: type("SERVICE")
metricDenominatorDEPRECATED	string	The total count metric (the denominator in rate calculation). Required when the useRateMetric is set to false. Example: builtin:service.requestCount.server
metricExpression	string	The percentage-based metric expression for the calculation of the SLO. Example: (100)*(builtin:service.errors.server.successCount:splitBy())/(builtin:service.requestCount.server:splitBy())
metricName	string	The name that is used to create SLO func metrics keys. Once created, metric name cannot be changed. Example: payment_service_availability
metricNumeratorDEPRECATED	string	The metric for the count of successes (the numerator in rate calculation). Required when the useRateMetric is set to false. Example: builtin:service.errors.server.successCount
metricRateDEPRECATED	string	The percentage-based metric for the calculation of the SLO. Required when the useRateMetric is set to true. Example: builtin:service.successes.server.rate
name*required	string	The name of the SLO. Example: Payment service availability
target*required	number	The target value of the SLO. Example: 95
timeframe*required	string	The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector. Example: -1d
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. Example: true
warning*required	number	The warning value of the SLO. At warning state the SLO is still fulfilled but is getting close to failure. Example: 97.5

SoftwareTechs

Contains information about the used software technology.

Name	Type	Description
edition	string	The edition of the technology. Example: OpenJDK
technology	string	The type of the technology. Example: JAVA
verbatimType	string	The verbatim type of the technology. Example: Java
version	string	The version of the technology. Example: 11.0.10

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

SyntheticBrowserMonitorConfigurationDto

Browser Monitor configuration.

Name	Type	Description
blockedRequests	Array<string>	All requests matching the specified patterns will be blocked during the execution of the monitor.
browserPermissions	BrowserPermissionsDto	Permissions settings for browser.
bypassCSP	boolean	Bypass ContentSecurity Policy for monitored pages. If not defined in request, it will be set to false by default.
chromiumStartupFlags	ChromiumStartupFlagsDto	Chromium startup flags of a Browser Monitor.
clientCertificates	Array<ClientCertificateDto>	Identifier of stored client's certificate.
cookies	Array<SyntheticMonitorCookieDto>	Cookies list.
device*required	TestDeviceDto	Test device of a Browser Monitor.
enablement	EnablementDto	Browser monitor enablement settings.
experimentalProperties	Array<MonitorPropertyDto>	Experimental properties list.
filteredRequests	FilteredRequestsDto	Filtered requests of a Browser Monitor.
ignoredErrorCodes	IgnoredErrorCodesDto	Ignored Error Codes of a Browser Monitor.
javaScriptSettings	JavaScriptAgentSettingsDto	JavaScript Agent Settings.
monitorFrames	boolean	Capture performance metrics for pages loaded in frames. If not defined in request, it will be set to false by default.
networkThrottling	NetworkThrottlingDto	Network throttling of a Browser Monitor.
proxy	ProxyDto	Browser Monitor proxy.
requestHeaderOptions	RequestHeaderOptionsDto	Header Options of a Browser Monitor.
useIESupportedAgent	boolean	useIESupportedAgent flag. If not defined in request, it will be set to false by default.
userAgent	string	User agent

SyntheticBrowserMonitorRequest

Browser monitor update.

Name	Type	Description
configuration*required	SyntheticBrowserMonitorConfigurationDto	Browser Monitor configuration.
description	string	Monitor description
enabled	boolean	If true, the monitor is enabled. Default: true
frequencyMin	number	The frequency of the monitor, in minutes. Default value depends on the monitor type (1 minute for MULTI_PROTOCOL and HTTP, 15 minutes for BROWSER).
keyPerformanceMetrics	KeyPerformanceMetrics	The key performance metrics configuration.
locations*required	Array<string>	The locations to which the monitor is assigned.
manuallyAssignedEntities	Array<string>	Manually assigned entities.
name*required	string	The name of the monitor.
performanceThresholds	SyntheticMonitorPerformanceThresholdsDto	Performance thresholds configuration.
primaryGrailTags	Array<SyntheticMonitorPrimaryGrailTagDto>	Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed.
steps*required	Array<SyntheticBrowserMonitorStepDto>	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	"BROWSER" | "HTTP" | "MULTI_PROTOCOL"	Monitor type.

SyntheticBrowserMonitorResponse

Browser Monitor.

Name	Type	Description
automaticallyAssignedEntities	Array<string>	Automatically assigned entities.
configuration*required	SyntheticBrowserMonitorConfigurationDto	Browser Monitor configuration.
description	string	Monitor description
enabled	boolean	If true, the monitor is enabled.
entityId*required	string	The entity id of the monitor.
frequencyMin	number	The frequency of the monitor, in minutes.
keyPerformanceMetrics*required	KeyPerformanceMetrics	The key performance metrics configuration.
locations	Array<string>	The locations to which the monitor is assigned.
manuallyAssignedEntities	Array<string>	Manually assigned entities.
modificationTimestamp	number	The timestamp of the last modification
name	string	The name of the monitor.
performanceThresholds	SyntheticMonitorPerformanceThresholdsDto	Performance thresholds configuration.
primaryGrailTags	Array<SyntheticMonitorPrimaryGrailTagDto>	Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed.
steps*required	Array<SyntheticBrowserMonitorStepDto>	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.

SyntheticBrowserMonitorStepDto

Base step of Browser Monitor.

Name	Type	Description
entityId	string	Entity Id.
name*required	string	The name of Browser Monitor step.
type*required	"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"	Defines the actual set of fields depending on the value. See one of the following objects: NAVIGATE -> NavigateStepDto CLICK -> InteractionStepDto TAP -> InteractionStepDto KEYSTROKES -> KeyStrokesStepDto JAVASCRIPT -> JavaScriptStepDto SELECT_OPTION -> SelectOptionStepDto COOKIE -> CookieStepDto

SyntheticConfigDto

A DTO for synthetic configuration.

Name	Type	Description
bmMonitorTimeout*required	number	bmMonitorTimeout - browser monitor execution timeout (ms) Minimum: 60000
bmStepTimeout*required	number	bmStepTimeout - browser monitor single step execution timeout (ms) Minimum: 10000

SyntheticHttpAuthenticationDto

The Http step's authentication.

Name	Type	Description
credentials*required	string	Credential vault identifier.
kdcIp	string	KDC IP in case KERBEROS auth type is selected.
realmName	string	Realm name in case KERBEROS type is selected.
type*required	"KERBEROS" | "BASIC_AUTHENTICATION" | "NTLM"	Authentication type.

SyntheticHttpConfigurationDto

The Http step's configuration.

Name	Type	Description
acceptAnyCertificate	boolean	If true accept any certificate flag. Default: true
clientCertificateId	string	Identifier of stored client's certificate.
doNotPersistSensitiveData	boolean	If true the step's data aren't stored and displayed. Default: false
followRedirects	boolean	If true follow redirects. Default: false
headers	Array<MonitorRequestHeader>	The headers.
sslCertificateExpirationDaysToAlert	number	Number of days within SSL certificate expires.

SyntheticHttpMonitorAdvancedDto

Http monitor's settings.

Name	Type	Description
connectTimeout	number	Connect timeout per request in ms.
dnsQueryTimeout	number	DNS query timeout in ms.
maxCustomScriptSize	number	Maximum size of each pre- or post- execution script size in bytes.
maxHeaderSize	number	Maximum size of each request header in bytes.
maxRequestBodySize	number	Maximum request body size in bytes.
maxResponseBodyReadByScriptSize	number	Maximum size of response body read by post-execution script in bytes.
maxResponseBodySize	number	Maximum response body size in bytes.
monitorExecutionTimeout	number	Monitor execution timeout in ms.
requestTimeout	number	Request timeout in ms.
scriptExecutionTimeout	number	Pre- or post- execution script timeout in ms.

SyntheticHttpMonitorRequest

Http monitor's settings.

Name	Type	Description
advancedSettings	SyntheticHttpMonitorAdvancedDto	Http monitor's settings.
cookies	Array<SyntheticMonitorCookieDto>	The cookies of the monitor.
description	string	Monitor description
enabled	boolean	If true, the monitor is enabled. Default: true
frequencyMin	number	The frequency of the monitor, in minutes. Default value depends on the monitor type (1 minute for MULTI_PROTOCOL and HTTP, 15 minutes for BROWSER).
locations*required	Array<string>	The locations to which the monitor is assigned.
manuallyAssignedEntities	Array<string>	Manually assigned entities.
name*required	string	The name of the monitor.
performanceThresholds	SyntheticMonitorPerformanceThresholdsDto	Performance thresholds configuration.
primaryGrailTags	Array<SyntheticMonitorPrimaryGrailTagDto>	Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed.
steps*required	Array<SyntheticHttpMonitorStepDto>	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	"BROWSER" | "HTTP" | "MULTI_PROTOCOL"	Monitor type.

SyntheticHttpMonitorResponse

Http monitor.

Name	Type	Description
advancedSettings	SyntheticHttpMonitorAdvancedDto	Http monitor's settings.
automaticallyAssignedEntities	Array<string>	Automatically assigned entities.
cookies	Array<SyntheticMonitorCookieDto>	The cookies of the monitor.
description	string	Monitor description
enabled	boolean	If true, the monitor is enabled.
entityId*required	string	The entity id of the monitor.
frequencyMin	number	The frequency of the monitor, in minutes.
locations	Array<string>	The locations to which the monitor is assigned.
manuallyAssignedEntities	Array<string>	Manually assigned entities.
modificationTimestamp	number	The timestamp of the last modification
name	string	The name of the monitor.
performanceThresholds	SyntheticMonitorPerformanceThresholdsDto	Performance thresholds configuration.
primaryGrailTags	Array<SyntheticMonitorPrimaryGrailTagDto>	Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed.
steps*required	Array<SyntheticHttpMonitorStepDto>	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.

SyntheticHttpMonitorStepDto

The step of a Http monitor.

Name	Type	Description
authentication	SyntheticHttpAuthenticationDto	The Http step's authentication.
configuration	SyntheticHttpConfigurationDto	The Http step's configuration.
constraints*required	Array<SyntheticMonitorConstraintDto>	The list of constraints.
entityId	string	Entity Id.
methodType*required	"DELETE" | "GET" | "POST" | "PUT" | "HEAD" | "OPTIONS" | "PATCH"	Method type.
name*required	string	Step name.
postScript	string	PostScript.
preScript	string	PreScript.
requestBody	string	Request body.
requestTimeout	number	Request timeout in s.
url*required	string	Step url.

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. The allowed type and properties depend on the monitor and step/request context.

Name	Type	Description
properties*required	SyntheticMonitorConstraintDtoProperties	Constraint properties. Most constraint types use operator and value keys. Some protocol-specific constraints may use additional keys, for example DNS_STATUS_CODE can use status.
type*required	string	Constraint type. Allowed values depend on monitor type and step/request context. HTTP monitor step constraints: HTTP_STATUSES, HTTP_RESPONSE_PATTERN, HTTP_RESPONSE_REGEX. Network availability monitor(MULTI_PROTOCOL) step constraints: SUCCESS_RATE_PERCENT. Network availability monitor(MULTI_PROTOCOL) request configuration constraints are request-type specific, for example ICMP_SUCCESS_RATE_PERCENT (ICMP) and DNS_STATUS_CODE (DNS). Example: ICMP_SUCCESS_RATE_PERCENT

SyntheticMonitorConstraintDtoProperties

Constraint properties. Most constraint types use operator and value keys. Some protocol-specific constraints may use additional keys, for example DNS_STATUS_CODE can use status.

type: Record<string, string>

SyntheticMonitorCookieDto

Cookie dto for Synthetic Monitor step.

Name	Type	Description
domain*required	string	Cookie domain.
name*required	string	Cookie name.
path	string	Cookie path.
value*required	string	Cookie value.

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.
origin	"UNKNOWN" | "DEFAULT" | "MONITOR" | "TENANT"	Indicates the origin of these settings.
retryOnError	boolean	Only Browser Monitor property. If set to true, execution retry will take place in case the monitor fails.

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. Minimum: 1
samples	number	Number of request executions in analyzed sliding window (sliding window size). Minimum: 1
stepIndex	number	Specify the step's index to which a threshold applies. If threshold is monitor-level, no index is needed. Minimum: 0
threshold*required	number	Notify if monitor request takes longer than X time units to execute. For network availability monitors the time unit is milliseconds, for browser and HTTP monitors - seconds. Minimum: 0
type	"MONITOR" | "STEP"	Type of performance threshold
violatingSamples	number	Number of violating request executions in analyzed sliding window. Minimum: 1

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.

SyntheticMonitorPrimaryGrailTagDto

Primary grail tag key-value pair.

Name	Type	Description
key*required	string	Tag key.
value*required	string	Tag value.

SyntheticMonitorSummaryDto

Basic monitor data.

Name	Type	Description
enabled	boolean	If true, the monitor is enabled.
entityId*required	string	The entity id of the monitor.
name	string	The name of the monitor.
type*required	"BROWSER" | "HTTP" | "MULTI_PROTOCOL"	The type of the monitor.

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. Default value depends on the monitor type (1 minute for MULTI_PROTOCOL and HTTP, 15 minutes for BROWSER).
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.
primaryGrailTags	Array<SyntheticMonitorPrimaryGrailTagDto>	Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed.
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	"BROWSER" | "HTTP" | "MULTI_PROTOCOL"	Monitor type.

SyntheticMultiProtocolMonitorResponse

Network availability monitor.

Name	Type	Description
description	string	Monitor description
enabled	boolean	If true, the monitor is enabled.
entityId*required	string	The entity id of the monitor.
frequencyMin	number	The frequency of the monitor, in minutes.
locations	Array<string>	The locations to which the monitor is assigned.
modificationTimestamp	number	The timestamp of the last modification
name	string	The name of the monitor.
performanceThresholds	SyntheticMonitorPerformanceThresholdsDto	Performance thresholds configuration.
primaryGrailTags	Array<SyntheticMonitorPrimaryGrailTagDto>	Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed.
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>

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>

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

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>

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	string	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.
fipsMode	"ENABLED" | "DISABLED" | "ENABLED_WITH_CORPORATE_PROXY"	Containerized location property indicating whether FIPS mode is enabled on this location: DISABLED: FIPS is not enabled on the location. ENABLED: FIPS is enabled on the location. ENABLED_WITH_CORPORATE_PROXY: FIPS with corporate proxy is enabled on this location. Default: DISABLED
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. Minimum: 1
longitude*required	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). Minimum: 1
minActiveGateCount	number	Containerized location property. The minimum number of ActiveGates deployed for the location (required for a Kubernetes location). Minimum: 1
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.
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*required	"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.

TargetDto

Target of Browser Monitor step.

Name	Type	Description
locators*required	Array<LocatorDto>	List of locators.
window*required	string	Target window.

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

TenantTokenRotationStatus

Status of tenant token rotation.

Name	Type	Description
status	"ACTIVE" | "INACTIVE"	Rotation status. ACTIVE when a secondary token exists, otherwise INACTIVE.

TestDeviceDto

Test device of a Browser Monitor.

Name	Type	Description
height*required	number	Device height in px. Minimum: 0
mobile	boolean	Device is mobile. If not defined in request, it will be set to false by default.
name*required	string	Device name.
touchEnabled	boolean	Device is touch enabled. If not defined in request, it will be set to false by default.
width*required	number	Device width in px. Minimum: 0

TimeWaitConditionDto

Time wait condition for Browser Monitor step.

Name	Type	Description
milliseconds*required	number	Wait time in milliseconds. Minimum: 0
type*required	"NETWORK" | "NEXT_EVENT" | "PAGE_COMPLETE" | "TIME" | "VALIDATION"	Defines the actual set of fields depending on the value. See one of the following objects: TIME -> TimeWaitConditionDto VALIDATION -> ValidationWaitConditionDto PAGE_COMPLETE -> BaseWaitConditionDto NETWORK -> BaseWaitConditionDto NEXT_EVENT -> BaseWaitConditionDto

TimeoutSettingsDto

Timeout settings of a Browser Monitor.

Name	Type	Description
temporaryActionLimit	number	Cascading setTimeout calls number limit. If not defined in request, it will be set to 1 by default.
temporaryActionTotalTimeout	number	No additional timeout actions will be created once this time limit is reached. Value must be higher than 0 ms. If not defined in request, it will be set to 100 by default.

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" | "EXTENSION_AUTHENTICATION"	The scope of the credentials set.
scopes*required	Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE" | "EXTENSION_AUTHENTICATION">	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*required	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*required	string	The unit of the metric.
valueAfterChangePoint*required	number	The metric's value after the problem start.
valueBeforeChangePoint*required	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. Example: summary
columnRef	string	The referenced column from the 'tableColumns' property of the schema for this column. Example: myCustomColumn
displayName	string	The display name for this column. Example: Color
id	string	The id for this column used for filtering. Required for conflicting or pathed columns - otherwise the ref is used. Example: color
items	Array<UiTableColumnItemCustomization>	The possible items of this column.
propertyRef	string	The referenced property for this column. Example: apiColor
type	string	The ui specific type for this column. Example: cell-color-picker
width	string	The width this column should take up on the table. Example: 10%

UiTableColumnItemCustomization

Customization for UI table column items

Name	Type	Description
displayName	string	The display name of this item. Example: Active
icon	string	The icon of this item. Example: CRITICAL
value*required	string	The value of this item. Example: ACTIVE

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. Example: ENVIRONMENT
cancelable	boolean	The job can (true) or can't (false) be cancelled at the moment. Example: false
duration	number	The duration of the update, in milliseconds. Example: 3608000
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. Example: -3524498778810258605
jobState	"SCHEDULED" | "PENDING" | "FAILED" | "IN_PROGRESS" | "ROLLBACK" | "SKIPPED" | "SUCCEED"	The status of the update job. Example: SUCCEED
startVersion	string	The initial version of the ActiveGate. Example: 1.185.0.20200201-120000
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. Example: 1.190.0.20200301-130000
timestamp	number	The timestamp of the update job completion. The null value means the job is still running. Example: 1582031917814
updateMethod	"AUTOMATIC" | "MANUAL_INSTALLATION" | "ON_DEMAND"	The method of updating the ActiveGate or its component. Example: AUTOMATIC
updateType	"SYNTHETIC" | "ACTIVE_GATE" | "REMOTE_PLUGIN_AGENT" | "Z_REMOTE"	The component to be updated. Example: ACTIVE_GATE

UpdateJobList

A list of update jobs of the ActiveGate.

Name	Type	Description
agId	string	The ID of the ActiveGate. Example: 0x3efdd092
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*required	Array<"r" | "w">	The permissions to assign to the specified accessor.

UpdateWindow

Basic information about one maintenance window

Name	Type	Description
id*required	string	Identifier of maintenance window Example: vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h
name	string	The name of maintenance window Example: Daily maintenance window

UpdateWindowsConfig

Basic information about all configured update windows

Name	Type	Description
windows*required	Array<UpdateWindow>	List of update windows when the OneAgent update can start. If there is no value and update should be performed, the update will start at earliest convenience.

UploadJavaScriptMappingFileAliasBody

Name	Type	Description
file*required	Binary | Buffer | Blob | File	JavaScript mapping file to upload.

UploadJavaScriptMappingFileBody

Name	Type	Description
file*required	Binary | Buffer | Blob | File	JavaScript mapping file to upload.

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" | "EXTENSION_AUTHENTICATION"	The scope of the credentials set.
scopes*required	Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE" | "EXTENSION_AUTHENTICATION">	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

ValidationRuleDto

Validation rule of Browser Monitor step.

Name	Type	Description
failIfFound*required	boolean	Boolean value, true if we should fail on found pattern. If not defined in request, it will be set to false by default.
matchingPattern*required	string	Text pattern that should match on the website.
regex	boolean	Boolean value, true if the "matchingPattern" value is a regex. If not defined in request, it will be set to false by default.
target	TargetDto	Target of Browser Monitor step.
type*required	"TEXT_MATCH" | "CONTENT_MATCH" | "ELEMENT_MATCH"	Type of validation.

ValidationWaitConditionDto

Validation wait condition for Browser Monitor step.

Name	Type	Description
timeoutInMilliseconds*required	number	Validation timeout in milliseconds. Minimum: 0
type*required	"NETWORK" | "NEXT_EVENT" | "PAGE_COMPLETE" | "TIME" | "VALIDATION"	Defines the actual set of fields depending on the value. See one of the following objects: TIME -> TimeWaitConditionDto VALIDATION -> ValidationWaitConditionDto PAGE_COMPLETE -> BaseWaitConditionDto NETWORK -> BaseWaitConditionDto NEXT_EVENT -> BaseWaitConditionDto
validationRule*required	ValidationRuleDto	Validation rule of Browser Monitor step.

VisuallyCompleteOptionsDto

Visually Complete Options of a Browser Monitor.

Name	Type	Description
excludedElements	Array<string>	Query CSS selectors to specify mutation nodes (elements that change) to ignore in Visually complete and Speed index calculation.
excludedUrls	Array<string>	Use regular expressions to define URLs for images and iFrames to exclude from detection by the Visually complete module.
imageSizeThreshold	number	Use this setting to define the minimum visible area per element (in pixels) for an element to be counted towards Visually complete and Speed index. If not defined in request, it will be set to 50 by default.
inactivityTimeout	number	The time the Visually complete module waits for inactivity and no further mutations on the page after the load action. If not defined in request, it will be set to 1000 by default.
mutationTimeout	number	The time the Visually complete module waits after an XHR or custom action closes to start the calculation. If not defined in request, it will be set to 50 by default.

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

AnyValue

A schema representing an arbitrary value type.

type: string | number | number | boolean | Array<any> | Record<string &#124; any>