Classic Environment V2
Documentation of the Dynatrace Environment API v2. Resources here generally supersede those in v1. Migration of resources from v1 is in progress.
If you miss a resource, consider using the Dynatrace Environment API v1. To read about use cases and examples, see Dynatrace Documentation .
Notes about compatibility:
- Operations marked as early adopter or preview may be changed in non-compatible ways, although we try to avoid this.
- We may add new enum constants without incrementing the API version; thus, clients need to handle unknown enum constants gracefully.
npm install @dynatrace-sdk/client-classic-environment-v2
accessTokensActiveGateTokensClient​
import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
createToken​
Creates a new ActiveGate token
One of the following scopes is required:
- environment-api:activegate-tokens:create
- environment-api:activegate-tokens:write
Required permission: environment:roles:manage-settings
The newly created token will be owned by the same user who owns the token used for authentication of the call.
Parameters​
Name | Type |
---|---|
config.body*required | ActiveGateTokenCreate |
Returns​
Success. The token has been created. The body of the response contains the token secret.
Code example
import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await accessTokensActiveGateTokensClient.createToken({
body: { name: "myToken" },
});
getToken​
Gets metadata of an ActiveGate token
Required scope: environment-api:activegate-tokens:read Required permission: environment:roles:manage-settings
The token secret is not exposed.
Parameters​
Name | Type | Description |
---|---|---|
config.activeGateTokenIdentifier*required | string | The ActiveGate token identifier, consisting of prefix and public part of the token. |
Returns​
Success. The response contains the metadata of the tokens.
Code example
import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await accessTokensActiveGateTokensClient.getToken({
activeGateTokenIdentifier: "...",
});
listTokens​
Lists all available ActiveGate tokens
Required scope: environment-api:activegate-tokens:read Required permission: environment:roles:manage-settings
You can limit the output by using pagination:
- Specify the number of results per page in the pageSize query parameter.
- Use the cursor from the nextPageKey field of the previous response in the nextPageKey query parameter to obtain subsequent pages.
Parameters​
Name | Type | Description |
---|---|---|
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of ActiveGate tokens in a single response payload. The maximal allowed page size is 3000 and the minimal size is 100. If not set, 100 is used. |
Returns​
Success. The response contains the list of ActiveGate tokens.
Code example
import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await accessTokensActiveGateTokensClient.listTokens();
revokeToken​
Deletes an ActiveGate token
Required scope: environment-api:activegate-tokens:write Required permission: environment:roles:manage-settings
Parameters​
Name | Type | Description |
---|---|---|
config.activeGateTokenIdentifier*required | string | The ActiveGate token identifier, consisting of prefix and public part of the token to be deleted. |
Code example
import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await accessTokensActiveGateTokensClient.revokeToken({
activeGateTokenIdentifier: "...",
});
accessTokensApiTokensClient​
import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
createApiToken​
Creates a new API token
Required scope: environment-api:api-tokens:write Required permission: environment:roles:viewer
The newly created token will be owned by the same user who owns the token used for authentication of the call.
Creating personal access tokens requires the environment:roles:viewer
permission. Creating access tokens requires the environment:roles:manage-settings
permission.
Parameters​
Name | Type |
---|---|
config.body*required | ApiTokenCreate |
Returns​
Success. The token has been created. The body of the response contains the token secret.
Code example
import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await accessTokensApiTokensClient.createApiToken({
body: { name: "tokenName", scopes: ["metrics.read"] },
});
deleteApiToken​
Deletes an API token
Required scope: environment-api:api-tokens:write Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.id*required | string | The ID of the token to be deleted. You can specify either the ID or the secret of the token. You can't delete the token you're using for authentication of the request. |
Code example
import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await accessTokensApiTokensClient.deleteApiToken({
id: "...",
});
getApiToken​
Gets API token metadata by token ID
Required scope: environment-api:api-tokens:read Required permission: environment:roles:viewer
The token secret is not exposed.
Parameters​
Name | Type |
---|---|
config.id*required | string |
Returns​
Success
Code example
import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await accessTokensApiTokensClient.getApiToken({
id: "...",
});
listApiTokens​
Lists all available API tokens
Required scope: environment-api:api-tokens:read Required permission: environment:roles:viewer
You can limit the output by using pagination:
- Specify the number of results per page in the pageSize query parameter.
- Use the cursor from the nextPageKey field of the previous response in the nextPageKey query parameter to obtain subsequent pages.
Parameters​
Name | Type | Description |
---|---|---|
config.apiTokenSelector | string | Filters the resulting sets of tokens. Only tokens matching the specified criteria are included into response. You can set one or more of the following criteria:
To set multiple criteria, separate them with commas ( |
config.fields | string | Specifies the fields to be included in the response. The following fields are included by default:
To remove fields from the response, specify them with the minus ( You can include additional fields:
To add fields to the response, specify them with the plus ( Alternatively, you can define the desired set of fields in the response. Specify the required fields as a comma-separated list, without operators (for example, The fields string must be URL-encoded. |
config.from | string | Filters tokens based on the last usage time. The start of the requested timeframe. You can use one of the following formats:
|
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of API tokens in a single response payload. The maximal allowed page size is 10000 and the minimal allowed page size is 100. If not set, 200 is used. |
config.sort | string | The sort order of the token list. You can sort by the following properties with a sign prefix for the sort order:
If no prefix is set, + is used. If not set, tokens are sorted by creation date with newest first. default:"-creationDate" |
config.to | string | Filters tokens based on the last usage time. The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success
Code example
import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await accessTokensApiTokensClient.listApiTokens();
lookupApiToken​
Gets API token metadata by token secret
Required scope: environment-api:api-tokens:read Required permission: environment:roles:viewer
Parameters​
Name | Type |
---|---|
config.body*required | ApiTokenSecret |
Returns​
Success
Code example
import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await accessTokensApiTokensClient.lookupApiToken({
body: {
token:
"dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM",
},
});
updateApiToken​
Updates an API token
Required scope: environment-api:api-tokens:write Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | ApiTokenUpdate | |
config.id*required | string | The ID of the token to be updated. You can't disable the token you're using for authentication of the request. |
Code example
import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await accessTokensApiTokensClient.updateApiToken({
id: "...",
body: {},
});
accessTokensTenantTokensClient​
import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
cancelRotation​
Cancels tenant token rotation
Required scope: environment-api:tenant-token-rotation:write Required permission: environment:roles:manage-settings
To learn how to rotate tokens, see Token rotation in Dynatrace Documentation.
Returns​
Success. Rotation process has been cancelled. The current tenant token remains valid.
Code example
import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await accessTokensTenantTokensClient.cancelRotation();
finishRotation​
Finishes tenant token rotation
Required scope: environment-api:tenant-token-rotation:write Required permission: environment:roles:manage-settings
To learn how to rotate tokens, see Token rotation in Dynatrace Documentation.
Returns​
Success. The rotation process is completed. The active field of the response contains the new tenant token.
Code example
import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await accessTokensTenantTokensClient.finishRotation();
startRotation​
Starts tenant token rotation
Required scope: environment-api:tenant-token-rotation:write Required permission: environment:roles:manage-settings
To learn how to rotate tokens, see Token rotation in Dynatrace Documentation.
Returns​
Success. The new tenant token is created and will replace the old one. The active field of the response contains the new tenant token.
Code example
import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await accessTokensTenantTokensClient.startRotation();
activeGatesAutoUpdateConfigurationClient​
import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
getAutoUpdateConfigById​
Gets the configuration of auto-update for the specified ActiveGate
Required scope: environment-api:activegates:read Required permission: environment:roles:manage-settings
Parameters​
Name | Type | Description |
---|---|---|
config.agId*required | string | The ID of the required ActiveGate. |
Returns​
Success
Code example
import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data =
await activeGatesAutoUpdateConfigurationClient.getAutoUpdateConfigById({
agId: "...",
});
getGlobalAutoUpdateConfigForTenant​
Gets the global auto-update configuration of environment ActiveGates.
Required scope: environment-api:activegates:read Required permission: environment:roles:manage-settings
Returns​
Success
Code example
import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data =
await activeGatesAutoUpdateConfigurationClient.getGlobalAutoUpdateConfigForTenant();
putAutoUpdateConfigById​
Updates the configuration of auto-update for the specified ActiveGate
Required scope: environment-api:activegates:write Required permission: environment:roles:manage-settings
Parameters​
Name | Type | Description |
---|---|---|
config.agId*required | string | The ID of the required ActiveGate. |
config.body*required | ActiveGateAutoUpdateConfig |
Code example
import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data =
await activeGatesAutoUpdateConfigurationClient.putAutoUpdateConfigById({
agId: "...",
body: {},
});
putGlobalAutoUpdateConfigForTenant​
Puts the global auto-update configuration of environment ActiveGates.
Required scope: environment-api:activegates:write Required permission: environment:roles:manage-settings
Parameters​
Name | Type |
---|---|
config.body*required | ActiveGateGlobalAutoUpdateConfig |
Code example
import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data =
await activeGatesAutoUpdateConfigurationClient.putGlobalAutoUpdateConfigForTenant(
{ body: {} }
);
validateAutoUpdateConfigById​
Validates the payload for the POST /activeGates/{agId}/autoUpdate
request.
Required scope: environment-api:activegates:write Required permission: environment:roles:manage-settings
Parameters​
Name | Type | Description |
---|---|---|
config.agId*required | string | The ID of the required ActiveGate. |
config.body*required | ActiveGateAutoUpdateConfig |
Code example
import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data =
await activeGatesAutoUpdateConfigurationClient.validateAutoUpdateConfigById({
agId: "...",
body: {},
});
validateGlobalAutoUpdateConfigForTenant​
Validates the payload for the POST /activeGates/autoUpdate
request.
Required scope: environment-api:activegates:write Required permission: environment:roles:manage-settings
Parameters​
Name | Type |
---|---|
config.body*required | ActiveGateGlobalAutoUpdateConfig |
Code example
import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data =
await activeGatesAutoUpdateConfigurationClient.validateGlobalAutoUpdateConfigForTenant(
{ body: {} }
);
activeGatesAutoUpdateJobsClient​
import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";
createUpdateJobForAg​
Creates a new update job for the specified ActiveGate
Required scope: environment-api:activegates:write Required permission: environment:roles:manage-settings
Parameters​
Name | Type | Description |
---|---|---|
config.agId*required | string | The ID of the required ActiveGate. |
config.body*required | UpdateJob |
Returns​
Success. The update-job have been created.
Code example
import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await activeGatesAutoUpdateJobsClient.createUpdateJobForAg({
agId: "...",
body: { targetVersion: "1.190.0.20200301-130000" },
});
deleteUpdateJobByJobIdForAg​
Deletes the specified update job
Required scope: environment-api:activegates:write Required permission: environment:roles:manage-settings
Parameters​
Name | Type | Description |
---|---|---|
config.agId*required | string | The ID of the required ActiveGate. |
config.jobId*required | string | A unique identifier for a update-job of ActiveGate. |
Code example
import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await activeGatesAutoUpdateJobsClient.deleteUpdateJobByJobIdForAg({
agId: "...",
jobId: "...",
});
getAllUpdateJobList​
List ActiveGates with update jobs
Required scope: environment-api:activegates:read Required permission: environment:roles:manage-settings
The response includes ActiveGates that have both completed (successful and failed) jobs and jobs in progress.
Parameters​
Name | Type | Description |
---|---|---|
config.from | string | The start of the requested timeframe for update jobs. You can use one of the following formats:
If not set, the relative timeframe of one day is used ( Maximum timeframe is 31 days. |
config.lastUpdates | boolean | If true , filters the resulting set of update jobs to the most recent update of each type. default: false |
config.startVersion | string | Filters the resulting set of update-jobs by the initial version (required format <major>.<minor>.<revision> ). |
config.startVersionCompareType | GetAllUpdateJobListQueryStartVersionCompareType | Filters the resulting set of update jobs by the specified initial version. Specify the comparison operator here. default:"EQUAL" |
config.targetVersion | string | Filters the resulting set of update-jobs by the target version (required format <major>.<minor>.<revision> ). |
config.targetVersionCompareType | GetAllUpdateJobListQueryTargetVersionCompareType | Filters the resulting set of update jobs by the specified target version. Specify the comparison operator here. default:"EQUAL" |
config.to | string | The end of the requested timeframe for update jobs. You can use one of the following formats:
If not set, the current timestamp is used. |
config.updateType | GetAllUpdateJobListQueryUpdateType | Filters the resulting set of update-jobs by the update type. |
Returns​
Success
Code example
import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await activeGatesAutoUpdateJobsClient.getAllUpdateJobList();
getUpdateJobByJobIdForAg​
Gets the parameters of the specified update job
Required scope: environment-api:activegates:read Required permission: environment:roles:manage-settings
Parameters​
Name | Type | Description |
---|---|---|
config.agId*required | string | The ID of the required ActiveGate. |
config.jobId*required | string | A unique identifier for a update-job of ActiveGate. |
Returns​
Success
Code example
import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await activeGatesAutoUpdateJobsClient.getUpdateJobByJobIdForAg({
agId: "...",
jobId: "...",
});
getUpdateJobListByAgId​
Lists update jobs for the specified ActiveGate
Required scope: environment-api:activegates:read Required permission: environment:roles:manage-settings
The job can update the ActiveGate to the specified version or the latest available one.
Parameters​
Name | Type | Description |
---|---|---|
config.agId*required | string | The ID of the required ActiveGate. |
config.from | string | The start of the requested timeframe for update jobs. You can use one of the following formats:
If not set, the relative timeframe of one week is used ( Maximum timeframe is 31 days. |
config.lastUpdates | boolean | If true , filters the resulting set of update jobs to the most recent update of each type. default: false |
config.startVersion | string | Filters the resulting set of update-jobs by the initial version (required format <major>.<minor>.<revision> ). |
config.startVersionCompareType | GetUpdateJobListByAgIdQueryStartVersionCompareType | Filters the resulting set of update jobs by the specified initial version. Specify the comparison operator here. default:"EQUAL" |
config.targetVersion | string | Filters the resulting set of update-jobs by the target version (required format <major>.<minor>.<revision> ). |
config.targetVersionCompareType | GetUpdateJobListByAgIdQueryTargetVersionCompareType | Filters the resulting set of update jobs by the specified target version. Specify the comparison operator here. default:"EQUAL" |
config.to | string | The end of the requested timeframe for update jobs. You can use one of the following formats:
If not set, the current timestamp is used. |
config.updateType | GetUpdateJobListByAgIdQueryUpdateType | Filters the resulting set of update-jobs by the update type. |
Returns​
Success
Code example
import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await activeGatesAutoUpdateJobsClient.getUpdateJobListByAgId({
agId: "...",
});
validateUpdateJobForAg​
Validates the payload for the POST /activeGates/{agId}/updateJobs
request.
Required scope: environment-api:activegates:write Required permission: environment:roles:manage-settings
Parameters​
Name | Type | Description |
---|---|---|
config.agId*required | string | The ID of the required ActiveGate. |
config.body*required | UpdateJob |
Code example
import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await activeGatesAutoUpdateJobsClient.validateUpdateJobForAg({
agId: "...",
body: { targetVersion: "1.190.0.20200301-130000" },
});
activeGatesClient​
import { activeGatesClient } from "@dynatrace-sdk/client-classic-environment-v2";
getAllActiveGates​
Lists all available ActiveGates
Required scope: environment-api:activegates:read Required permission: environment:roles:manage-settings
The response includes all ActiveGates that are currently connected to the environment or have been connected during last 2 hours.
Parameters​
Name | Type | Description |
---|---|---|
config.autoUpdate | GetAllActiveGatesQueryAutoUpdate | Filters the resulting set of ActiveGates by the actual state of auto-update. |
config.containerized | boolean | Filters the resulting set of ActiveGates to those which are running in container (true ) or not (false ). |
config.disabledModule | Array<GetAllActiveGatesQueryDisabledModuleItem> | Filters the resulting set of ActiveGates by the disabled modules. |
config.enabledModule | Array<GetAllActiveGatesQueryEnabledModuleItem> | Filters the resulting set of ActiveGates by the enabled modules. |
config.group | string | Filters the resulting set of ActiveGates by the group. You can specify a partial name. In that case, the |
config.hostname | string | Filters the resulting set of ActiveGates by the name of the host it's running on. You can specify a partial name. In that case, the |
config.loadBalancerAddress | string | Filters the resulting set of ActiveGates by the Load Balancer address. You can specify a partial address. In that case, the |
config.networkAddress | string | Filters the resulting set of ActiveGates by the network address. You can specify a partial address. In that case, the |
config.networkZone | string | Filters the resulting set of ActiveGates by the network zone. You can specify a partial name. In that case, the |
config.online | boolean | Filters the resulting set of ActiveGates by the communication status. |
config.osArchitecture | GetAllActiveGatesQueryOsArchitecture | Filters the resulting set of ActiveGates by the OS architecture of the host it's running on. |
config.osType | GetAllActiveGatesQueryOsType | Filters the resulting set of ActiveGates by the OS type of the host it's running on. |
config.tokenExpirationSet | boolean | Filters the resulting set of ActiveGates to those with set expiration date for authorization token. |
config.tokenState | GetAllActiveGatesQueryTokenState | Filters the resulting set of ActiveGates to those with authorization token in specified state. |
config.type | GetAllActiveGatesQueryType | Filters the resulting set of ActiveGates by the ActiveGate type. |
config.updateStatus | GetAllActiveGatesQueryUpdateStatus | Filters the resulting set of ActiveGates by the auto-update status. |
config.version | string | Filters the resulting set of ActiveGates by the specified version. Specify the version in |
config.versionCompareType | GetAllActiveGatesQueryVersionCompareType | Filters the resulting set of ActiveGates by the specified version. Specify the comparison operator here. default:"EQUAL" |
Returns​
Success
Code example
import { activeGatesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await activeGatesClient.getAllActiveGates();
getOneActiveGateById​
Gets the details of the specified ActiveGate
Required scope: environment-api:activegates:read Required permission: environment:roles:manage-settings
Parameters​
Name | Type | Description |
---|---|---|
config.agId*required | string | The ID of the required ActiveGate. |
Returns​
Success
Code example
import { activeGatesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await activeGatesClient.getOneActiveGateById({
agId: "...",
});
attacksClient​
import { attacksClient } from "@dynatrace-sdk/client-classic-environment-v2";
getAttack​
Gets the specified attack
Required scope: environment-api:attacks:read One of the following permissions is required:
- environment:roles:manage-security-problems
- environment:roles:view-security-problems
Parameters​
Name | Type | Description |
---|---|---|
config.fields | string | A list of additional attack properties you can add to the response. The following properties are available (all other properties are always included and you can't remove them from the response):
To add properties, specify them in a comma-separated list and prefix each property with a plus (for example, |
config.id*required | string | The ID of the attack. |
Returns​
Success
Code example
import { attacksClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await attacksClient.getAttack({ id: "..." });
getAttacks​
Lists all attacks
Required scope: environment-api:attacks:read One of the following permissions is required:
- environment:roles:manage-security-problems
- environment:roles:view-security-problems
Parameters​
Name | Type | Description |
---|---|---|
config.attackSelector | string | Defines the scope of the query. Only attacks matching the specified criteria are included in the response. You can add one or more of the following criteria. Values are not case-sensitive and the
To set several criteria, separate them with a comma ( Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (
|
config.fields | string | A list of additional attack properties you can add to the response. The following properties are available (all other properties are always included and you can't remove them from the response):
To add properties, specify them in a comma-separated list and prefix each property with a plus (for example, |
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of thirty days is used ( |
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of attacks in a single response payload. The maximal allowed page size is 500. If not set, 100 is used. |
config.sort | string | Specifies one or more fields for sorting the attack list. Multiple fields can be concatenated using a comma ( You can sort by the following properties with a sign prefix for the sorting order.
|
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success
Code example
import { attacksClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await attacksClient.getAttacks();
auditLogsClient​
import { auditLogsClient } from "@dynatrace-sdk/client-classic-environment-v2";
getLog​
Gets the specified entry of the audit log | maturity=EARLY_ADOPTER
Required scope: environment-api:audit-logs:read Required permission: environment:roles:manage-settings
Parameters​
Name | Type | Description |
---|---|---|
config.id*required | string | The ID of the required log entry. |
Returns​
Success
Code example
import { auditLogsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await auditLogsClient.getLog({ id: "..." });
getLogs​
Gets the audit log of your Dynatrace environment | maturity=EARLY_ADOPTER
Required scope: environment-api:audit-logs:read Required permission: environment:roles:manage-settings
You can limit the output by using pagination:
- Specify the number of results per page in the pageSize query parameter.
- Use the cursor from the nextPageKey field of the previous response in the nextPageKey query parameter to obtain subsequent pages.
Parameters​
Name | Type | Description |
---|---|---|
config.filter | string | Filters the audit log. You can use the following criteria:
For each criterion, you can specify multiple alternatives with comma-separated values. In this case, the OR logic applies. For example, You can specify multiple comma-separated criteria, such as Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (
|
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of two weeks is used ( |
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of log entries in a single response payload. The maximal allowed page size is 5000. If not set, 1000 is used. |
config.sort | string | The sorting of audit log entries:
If not set, the newest first sorting is applied. default:"-timestamp" |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success
Code example
import { auditLogsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await auditLogsClient.getLogs();
businessEventsClient​
import { businessEventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
ingest​
Ingests a business event
Required scope: storage:events:write Required permission: storage:events:write
The maximum payload size of a single request is 5 MiB. Requests with a greater payload are rejected, and the API returns a 413 response code.
The ingestion of business events is subject to licensing (see licensing documentation).
Returns​
The provided business events are all accepted and will be processed.
Code example
import { businessEventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await businessEventsClient.ingest({
type: "application/cloudevent+json",
body: {
specversion: "1.0",
id: "1",
source: "custom.source",
type: "com.mycompany.shop.checkout",
dtcontext:
'dt.session_id="234234234324235345345",dt.entity.rum_application="APPLICATION-53453458340758",host.name="123.123.123.123"',
dataschema: "http://dynatrace.com/schema/bizevents/generic/1.0",
traceparent: "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00",
data: {
id: "OR-838475",
paymentType: "paypal",
plannedDeliveryDate: "01.01.2021",
total: 234,
},
},
});
credentialVaultClient​
import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
createCredentials​
Creates a new credentials set.
Required scope: environment-api:credentials:write Required permission: environment:roles:viewer
The body must not provide an ID. An ID is assigned automatically by the Dynatrace server.
Parameters​
Name | Type |
---|---|
config.body*required | Credentials |
Returns​
Success. The new credentials set has been created. The response contains the ID of the set.
Code example
import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await credentialVaultClient.createCredentials({
body: {
name: "...",
scopes: [CredentialsScopesItem.All],
},
});
getCredentials​
Gets the metadata of the specified credentials set.
Required scope: environment-api:credentials:read Required permission: environment:roles:viewer
The credentials set itself (e.g. username/certificate and password) is not included in the response.
Parameters​
Name | Type | Description |
---|---|---|
config.id*required | string | The Dynatrace entity ID of the required credentials set. |
Returns​
Success. The response contains the metadata of the credentials set.
Code example
import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await credentialVaultClient.getCredentials({
id: "...",
});
getCredentialsDetails​
Gets the details of the specified credentials set.
Required scope: environment-api:credentials:read
The credentials set including username/certificate, password or token is included in the response.
Parameters​
Name | Type | Description |
---|---|---|
config.id*required | string | The Dynatrace entity ID of the required credentials set. |
Returns​
Success. The response contains the details of the credentials set.
Code example
import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await credentialVaultClient.getCredentialsDetails({
id: "...",
});
listCredentials​
Lists all sets of credentials in your environment.
Required scope: environment-api:credentials:read Required permission: environment:roles:viewer
The credentials set itself (username/certificate and password) is not included in the response.
Parameters​
Name | Type | Description |
---|---|---|
config.name | string | Filters the result by the name. When in quotation marks, whole phrase is taken. Case insensitive. |
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of credentials in a single response payload. The maximal allowed page size is 500. If not set, 100 is used. |
config.scope | string | Filters credentials with specified scope. |
config.type | ListCredentialsQueryType | Filters the result by the specified credentials type. |
config.user | string | Filters credentials accessible to the user (owned by the user or the ones that are accessible for all). |
Returns​
Success
Code example
import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await credentialVaultClient.listCredentials();
removeCredentials​
Deletes the specified credentials set
Required scope: environment-api:credentials:write Required permission: environment:roles:viewer
Provide credential ID in the path.
Parameters​
Name | Type | Description |
---|---|---|
config.id*required | string | The ID of the credentials set to be deleted. |
Code example
import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await credentialVaultClient.removeCredentials({
id: "...",
});
updateCredentials​
Updates the specified credentials set.
Required scope: environment-api:credentials:write Required permission: environment:roles:viewer
The body must not provide an ID. The ID should be provided in the path.
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | Credentials | |
config.id*required | string | The Dynatrace entity ID of the credentials set to be updated. |
Returns​
Success. The new credentials set has been created. The response contains the ID of the set.
Code example
import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await credentialVaultClient.updateCredentials({
id: "...",
body: {
name: "...",
scopes: [CredentialsScopesItem.All],
},
});
davisSecurityAdvisorClient​
import { davisSecurityAdvisorClient } from "@dynatrace-sdk/client-classic-environment-v2";
getAdviceForSecurityProblems​
Provides advice for security problems.
Required scope: environment-api:security-problems:read One of the following permissions is required:
- environment:roles:manage-security-problems
- environment:roles:view-security-problems
You can narrow down the output by providing the management zone and pagination. If you specify a management zone, only problems originating from that zone are included to the request.
Parameters​
Name | Type | Description |
---|---|---|
config.managementZoneFilter | string | To specify management zones, use one of the options listed below. For each option you can specify multiple comma-separated values. If several values are specified, the OR logic applies. All values are case-sensitive and must be quoted.
You can specify several comma-separated criteria (for example, |
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of security advices in a single response payload. The maximal allowed page size is 500. If not set, 5 is used. |
Returns​
Success
Code example
import { davisSecurityAdvisorClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await davisSecurityAdvisorClient.getAdviceForSecurityProblems();
eventsClient​
import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
createEvent​
Ingests a custom event
One of the following scopes is required:
- storage:events:write
- environment-api:events:write
One of the following permissions is required:
- environment:roles:viewer
- storage:events:write
The ingestion of custom events is subject to licensing (see licensing documentation).
Parameters​
Name | Type |
---|---|
config.body*required | EventIngest |
Returns​
The event ingest request was received by the server. The response body indicates for each event whether its creation was successful.
Code example
import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await eventsClient.createEvent({
body: { title: "..." },
});
getEvent​
Gets the properties of an event
Required scope: environment-api:events:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.eventId*required | string | The ID of the required event. |
Returns​
Success. The response contains the configuration of the event.
Code example
import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await eventsClient.getEvent({
eventId: "...",
});
getEventProperties​
Lists all event properties
Required scope: environment-api:events:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of event properties in a single response payload. The maximal allowed page size is 500. If not set, 100 is used. |
Returns​
Success
Code example
import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await eventsClient.getEventProperties();
getEventProperty​
Gets the details of an event property
Required scope: environment-api:events:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.propertyKey*required | string | The event property key you're inquiring. |
Returns​
Success
Code example
import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await eventsClient.getEventProperty({
propertyKey: "...",
});
getEventType​
Gets the properties of an event type
Required scope: environment-api:events:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.eventType*required | string | The event type you're inquiring. |
Returns​
Success
Code example
import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await eventsClient.getEventType({
eventType: "...",
});
getEventTypes​
Lists all event types
Required scope: environment-api:events:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of event types in a single response payload. The maximal allowed page size is 500. If not set, 100 is used. |
Returns​
Success
Code example
import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await eventsClient.getEventTypes();
getEvents​
Lists events within the specified timeframe
Required scope: environment-api:events:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.entitySelector | string | The entity scope of the query. You must set one of these criteria:
You can add one or more of the following criteria. Values are case-sensitive and the
For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma ( The maximum string length is 2,000 characters. The number of entities that can be selected is limited to 10000. |
config.eventSelector | string | Defines the scope of the query. Only events matching the specified criteria are included in the response. You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the OR logic applies.
To set several criteria, separate them with commas ( |
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of two hours is used ( |
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of events in a single response payload. The maximal allowed page size is 1000. If not set, 100 is used. |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success. The response contains the list of events.
Code example
import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await eventsClient.getEvents();
extensions_2_0Client​
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
activateExtensionEnvironmentConfiguration​
Activates the environment configuration from the specified version of the extension 2.0
Required scope: environment-api:extensions:write One of the following permissions is required:
- environment:roles:manage-settings
- extensions:definitions:write
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | ExtensionEnvironmentConfigurationVersion | |
config.extensionName*required | string | The name of the requested extension 2.0. |
Returns​
Success. Environment configuration created.
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data =
await extensions_2_0Client.activateExtensionEnvironmentConfiguration({
extensionName: "...",
body: { version: "1.2.3" },
});
createMonitoringConfiguration​
Creates new monitoring configuration for the specified extension 2.0
Required scope: environment-api:extension-configurations:write One of the following permissions is required:
- environment:roles:manage-settings
- extensions:configurations:write
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | Array<MonitoringConfigurationDto> | |
config.extensionName*required | string | The name of the requested extension 2.0. |
Returns​
Success | Multi-Status, if not all requests resulted in the same status
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.createMonitoringConfiguration({
extensionName: "...",
body: [{ scope: "HOST-D3A3C5A146830A79" }],
});
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | Array<MonitoringConfigurationDto> | |
config.extensionName*required | string | The name of the requested extension 2.0. |
deleteEnvironmentConfiguration​
Deactivates the environment configuration of the specified extension 2.0
Required scope: environment-api:extensions:write One of the following permissions is required:
- environment:roles:manage-settings
- extensions:definitions:write
Parameters​
Name | Type | Description |
---|---|---|
config.extensionName*required | string | The name of the requested extension 2.0. |
Returns​
Success. Environment configuration deactivated.
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.deleteEnvironmentConfiguration({
extensionName: "...",
});
executeExtensionMonitoringConfigurationActions​
Executes Data Source action of Active Gate or Host
Required scope: environment-api:extension-configuration-actions:write One of the following permissions is required:
- environment:roles:manage-settings
- extensions:configuration.actions:write
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | ExecuteActionsDto | |
config.configurationId*required | string | The ID of the requested monitoring configuration. |
config.extensionName*required | string | The name of the requested extension 2.0. |
Returns​
Accepted. Response doesn't have a body.
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data =
await extensions_2_0Client.executeExtensionMonitoringConfigurationActions({
extensionName: "...",
configurationId: "...",
body: {},
});
extensionConfigurationSchema​
Gets the configuration schema of the specified version of the extension 2.0
Required scope: environment-api:extension-configurations:read One of the following permissions is required:
- environment:roles:manage-settings
- extensions:definitions:read
Parameters​
Name | Type | Description |
---|---|---|
config.extensionName*required | string | The name of the requested extension 2.0. |
config.extensionVersion*required | string | The version of the requested extension 2.0 |
Returns​
Success
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.extensionConfigurationSchema({
extensionName: "...",
extensionVersion: "...",
});
extensionDetails​
Gets details of the specified version of the extension 2.0
Required scope: environment-api:extensions:read One of the following permissions is required:
- environment:roles:manage-settings
- extensions:definitions:read
Parameters​
Name | Type | Description |
---|---|---|
config.acceptType*required | "application/json; charset=utf-8" | |
config.extensionName*required | string | The name of the requested extension 2.0. |
config.extensionVersion*required | string | The version of the requested extension 2.0 |
Returns​
Success
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.extensionDetails({
acceptType: "application/json; charset=utf-8",
extensionName: "...",
extensionVersion: "...",
});
Parameters​
Name | Type | Description |
---|---|---|
config.acceptType*required | "application/octet-stream" | |
config.extensionName*required | string | The name of the requested extension 2.0. |
config.extensionVersion*required | string | The version of the requested extension 2.0 |
extensionMonitoringConfigurations​
Lists all the monitoring configurations of the specified extension 2.0
Required scope: environment-api:extension-configurations:read One of the following permissions is required:
- environment:roles:manage-settings
- extensions:configurations:read
Parameters​
Name | Type | Description |
---|---|---|
config.active | boolean | Filters the resulting set of configurations by the active state. |
config.extensionName*required | string | The name of the requested extension 2.0. |
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of extensions in a single response payload. The maximal allowed page size is 100. If not set, 20 is used. |
config.version | string | Filters the resulting set of configurations by extension 2.0 version. |
Returns​
Success
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.extensionMonitoringConfigurations({
extensionName: "...",
});
getActiveEnvironmentConfiguration​
Gets the active environment configuration version of the specified extension 2.0
Required scope: environment-api:extensions:read One of the following permissions is required:
- environment:roles:manage-settings
- extensions:definitions:read
Parameters​
Name | Type | Description |
---|---|---|
config.extensionName*required | string | The name of the requested extension 2.0. |
Returns​
Success
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.getActiveEnvironmentConfiguration({
extensionName: "...",
});
getActiveGateGroupsInfo​
List all activeGate groups available for extension
Required scope: environment-api:extension-configurations:write One of the following permissions is required:
- environment:roles:manage-settings
- extensions:configurations:write
Parameters​
Name | Type | Description |
---|---|---|
config.extensionName*required | string | The name of the requested extension 2.0. |
config.extensionVersion*required | string | The version of the requested extension 2.0 |
Returns​
Success
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.getActiveGateGroupsInfo({
extensionName: "...",
extensionVersion: "...",
});
getEnvironmentConfigurationAssetsInfo​
Gets the information about assets in an active extension 2.0
Required scope: environment-api:extensions:read One of the following permissions is required:
- environment:roles:manage-settings
- extensions:definitions:read
Parameters​
Name | Type | Description |
---|---|---|
config.extensionName*required | string | The name of the requested extension 2.0. |
Returns​
Success
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.getEnvironmentConfigurationAssetsInfo({
extensionName: "...",
});
getEnvironmentConfigurationEvents​
List of the latest extension environment configuration events
Required scope: environment-api:extensions:read One of the following permissions is required:
- environment:roles:manage-settings
- extensions:definitions:read
Parameters​
Name | Type | Description |
---|---|---|
config.content | string | Content of the event |
config.extensionName*required | string | The name of the requested extension 2.0. |
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of two hours is used ( |
config.status | GetEnvironmentConfigurationEventsQueryStatus | Status of the event |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
List of the latest extension environment configuration events
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.getEnvironmentConfigurationEvents({
extensionName: "...",
});
getExtensionMonitoringConfigurationEvents​
Gets the list of the events linked to specific monitoring configuration
Required scope: environment-api:extension-configurations:read One of the following permissions is required:
- environment:roles:manage-settings
- extensions:configurations:read
Parameters​
Name | Type | Description |
---|---|---|
config.configurationId*required | string | The ID of the requested monitoring configuration. |
config.content | string | Content of the event |
config.dtActiveGateId | string | Hexadecimal ID of Active Gate that uses this monitoring configuration. Example: |
config.dtEntityHost | string | Host that uses this monitoring configuration. Example: |
config.dtExtensionDs | string | Data source that uses this monitoring configuration. Example: |
config.extensionName*required | string | The name of the requested extension 2.0. |
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of two hours is used ( |
config.status | GetExtensionMonitoringConfigurationEventsQueryStatus | Status of the event |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data =
await extensions_2_0Client.getExtensionMonitoringConfigurationEvents({
extensionName: "...",
configurationId: "...",
});
getExtensionMonitoringConfigurationStatus​
Gets the most recent status of the execution of given monitoring configuration
Required scope: environment-api:extension-configurations:read One of the following permissions is required:
- environment:roles:manage-settings
- extensions:configurations:read
Parameters​
Name | Type | Description |
---|---|---|
config.configurationId*required | string | The ID of the requested monitoring configuration. |
config.extensionName*required | string | The name of the requested extension 2.0. |
Returns​
Success
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data =
await extensions_2_0Client.getExtensionMonitoringConfigurationStatus({
extensionName: "...",
configurationId: "...",
});
getSchemaFile​
Gets the extension 2.0 schema file in the specified version
Required scope: environment-api:extensions:read One of the following permissions is required:
- environment:roles:manage-settings
- extensions:definitions:read
Parameters​
Name | Type | Description |
---|---|---|
config.fileName*required | string | The name of the schema file. |
config.schemaVersion*required | string | The version of the schema. |
Returns​
Success
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.getSchemaFile({
schemaVersion: "...",
fileName: "...",
});
installExtension​
Installs Extension from HUB
Required scope: environment-api:extensions:write One of the following permissions is required:
- environment:roles:manage-settings
- extensions:definitions:write
Parameters​
Name | Type | Description |
---|---|---|
config.extensionName*required | string | The name of the requested extension 2.0. |
config.version | string | Filters the resulting set of configurations by extension 2.0 version. |
Returns​
Success. The extension 2.0 has been uploaded.
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.installExtension({
extensionName: "...",
});
listExtensionInfos​
Lists all the extensions 2.0 available in your environment with additional metadata
Required scope: environment-api:extensions:read One of the following permissions is required:
- environment:roles:manage-settings
- extensions:definitions:read
Parameters​
Name | Type | Description |
---|---|---|
config.name | string | Filters the resulting set of extensions 2.0 by name. You can specify a partial name. In that case, the CONTAINS operator is used. |
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of extensions in a single response payload. The maximal allowed page size is 100. If not set, 20 is used. |
Returns​
Success
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.listExtensionInfos();
listExtensionVersions​
Lists all versions of the extension 2.0
Required scope: environment-api:extensions:read One of the following permissions is required:
- environment:roles:manage-settings
- extensions:definitions:read
Parameters​
Name | Type | Description |
---|---|---|
config.extensionName*required | string | The name of the requested extension 2.0. |
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of extensions in a single response payload. The maximal allowed page size is 100. If not set, 20 is used. |
Returns​
Success
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.listExtensionVersions({
extensionName: "...",
});
listExtensions​
Lists all the extensions 2.0 available in your environment
Required scope: environment-api:extensions:read One of the following permissions is required:
- environment:roles:manage-settings
- extensions:definitions:read
Parameters​
Name | Type | Description |
---|---|---|
config.name | string | Filters the resulting set of extensions 2.0 by name. You can specify a partial name. In that case, the CONTAINS operator is used. |
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of extensions in a single response payload. The maximal allowed page size is 100. If not set, 20 is used. |
Returns​
Success
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.listExtensions();
listSchemaFiles​
Lists all the files available for the specified extension 2.0 schema version
Required scope: environment-api:extensions:read One of the following permissions is required:
- environment:roles:manage-settings
- extensions:definitions:read
Parameters​
Name | Type | Description |
---|---|---|
config.acceptType*required | "application/json; charset=utf-8" | |
config.schemaVersion*required | string | The version of the schema. |
Returns​
Success
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.listSchemaFiles({
acceptType: "application/json; charset=utf-8",
schemaVersion: "...",
});
Parameters​
Name | Type | Description |
---|---|---|
config.acceptType*required | "application/octet-stream" | |
config.schemaVersion*required | string | The version of the schema. |
listSchemas​
Lists all the extension 2.0 schemas versions available in your environment
Required scope: environment-api:extensions:read One of the following permissions is required:
- environment:roles:manage-settings
- extensions:definitions:read
Returns​
Success
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.listSchemas();
monitoringConfigurationDetails​
Gets the details of the specified monitoring configuration
Required scope: environment-api:extension-configurations:read One of the following permissions is required:
- environment:roles:manage-settings
- extensions:configurations:read
Parameters​
Name | Type | Description |
---|---|---|
config.configurationId*required | string | The ID of the requested monitoring configuration. |
config.extensionName*required | string | The name of the requested extension 2.0. |
Returns​
Success
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.monitoringConfigurationDetails({
extensionName: "...",
configurationId: "...",
});
removeExtension​
Deletes the specified version of the extension 2.0
Required scope: environment-api:extensions:write One of the following permissions is required:
- environment:roles:manage-settings
- extensions:definitions:write
Parameters​
Name | Type | Description |
---|---|---|
config.extensionName*required | string | The name of the requested extension 2.0. |
config.extensionVersion*required | string | The version of the requested extension 2.0 |
Returns​
Success. The extension 2.0 version has been deleted.
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.removeExtension({
extensionName: "...",
extensionVersion: "...",
});
removeMonitoringConfiguration​
Deletes the specified monitoring configuration
Required scope: environment-api:extension-configurations:write One of the following permissions is required:
- environment:roles:manage-settings
- extensions:configurations:write
Parameters​
Name | Type | Description |
---|---|---|
config.configurationId*required | string | The ID of the requested monitoring configuration. |
config.extensionName*required | string | The name of the requested extension 2.0. |
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.removeMonitoringConfiguration({
extensionName: "...",
configurationId: "...",
});
updateExtensionEnvironmentConfiguration​
Updates the active environment configuration version of the extension 2.0
Required scope: environment-api:extensions:write One of the following permissions is required:
- environment:roles:manage-settings
- extensions:definitions:write
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | ExtensionEnvironmentConfigurationVersion | |
config.extensionName*required | string | The name of the requested extension 2.0. |
Returns​
Success. Environment configuration updated.
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.updateExtensionEnvironmentConfiguration(
{ extensionName: "...", body: { version: "1.2.3" } }
);
updateMonitoringConfiguration​
Updates the specified monitoring configuration
Required scope: environment-api:extension-configurations:write One of the following permissions is required:
- environment:roles:manage-settings
- extensions:configurations:write
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | MonitoringConfigurationUpdateDto | |
config.configurationId*required | string | The ID of the requested monitoring configuration. |
config.extensionName*required | string | The name of the requested extension 2.0. |
Returns​
Success
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.updateMonitoringConfiguration({
extensionName: "...",
configurationId: "...",
body: {},
});
uploadExtension​
Uploads or verifies a new extension 2.0
Required scope: environment-api:extensions:write One of the following permissions is required:
- environment:roles:manage-settings
- extensions:definitions:write
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | Blob | |
config.type*required | "application/octet-stream" | "multipart/form-data" | |
config.validateOnly | boolean | Only run validation but do not persist the extension even if validation was successful. default: false |
Returns​
The extension is valid | Success. The extension 2.0 has been uploaded.
Code example
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await extensions_2_0Client.uploadExtension({
type: "application/octet-stream",
body: new Blob(),
});
logsClient​
import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
exportLogRecords​
Exports log records | maturity=EARLY_ADOPTER
Required scope: storage:logs:read One of the following permissions is required:
- environment:roles:logviewer
- storage:logs:read
Returns the first X records (specified in the pageSize query parameter).
Unlike the search API, this API does not split the result into slices and has no limit for the total number of records. Log records are sorted by the criteria specified in the sort query parameter.
In order to fetch large amount of records (exceeding the pageSize value), one should repeat the export call with nextPageKey param.
Disabled on Log Management and Analytics, powered by Grail.
Parameters​
Name | Type | Description |
---|---|---|
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of two weeks is used ( |
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The number of results per result page. default: 1000 |
config.query | string | The log search query. The query must use the Dynatrace search query language. default:"" |
config.sort | string | Defines the ordering of the log records. Each field has a sign prefix (+/-) for sorting order. If no sign prefix is set, then the Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first). When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected). default:"-timestamp" |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success
Code example
import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await logsClient.exportLogRecords();
getLogHistogramData​
Gets aggregated log records | maturity=EARLY_ADOPTER
Required scope: storage:logs:read One of the following permissions is required:
- environment:roles:logviewer
- storage:logs:read
Returns the aggregated number of occurrences of log values divided into time slots.
It is possible that the timeframe covered by results exceeds the specified timeframe. In that case the request returns fewer time slots than specified in the timeBuckets query parameter.
If Log Management and Analytics, powered by Grail is enabled, then a bearer OAuth token (with storage:logs:read and storage:buckets:read scopes) needs to be used for authentication.
Please note that Dynatrace API explorer does not currently support OAuth authentication.
Parameters​
Name | Type | Description |
---|---|---|
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of two weeks is used ( |
config.groupBy | Array<string> | The groupings to be included in the response. You can specify several groups in the following format: If not set, all possible groups are returned. You can use this option to check for possible grouping values. Unique log data attributes (high-cardinality attributes) for example, |
config.maxGroupValues | number | The maximum number of values in each group. You can get up to 100 values per group. If not set, 10 is used. default:10 |
config.query | string | The log search query. The query must use the Dynatrace search query language. default:"" |
config.timeBuckets | number | The number of time slots in the result. The query timeframe is divided equally into the specified number of slots. The minimum length of a slot is 1 ms. If not set, 1 is used. default:1 |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success
Code example
import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await logsClient.getLogHistogramData();
getLogRecords​
Reads log records | maturity=EARLY_ADOPTER
Required scope: storage:logs:read One of the following permissions is required:
- environment:roles:logviewer
- storage:logs:read
Returns the first X records (specified in the limit query parameter). Log records are sorted by the criteria specified in the sort query parameter.
If the query is too large to be processed in a single request, it is divided into slices (slices are unsupported on Log Management and Analytics, powered by Grail). In that case the first response contains the nextSliceKey cursor for the second slice. Use it in the nextSliceKey query parameter to obtain the second slice, which contains nextSliceKey cursor for the third slice, and so on.
Results can be distributed unevenly between slices and some slices might be empty.
If Log Management and Analytics, powered by Grail is enabled, then a bearer OAuth token (with storage:logs:read and storage:buckets:read scopes) needs to be used for authentication.
Please note that Dynatrace API explorer does not currently support OAuth authentication.
Parameters​
Name | Type | Description |
---|---|---|
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of two weeks is used ( |
config.limit | number | The desired amount of log records. The maximal allowed limit is 1000. If not set, 1000 is used. default:1000 |
config.nextSliceKey | string | The cursor for the next slice of results. You can find it in the nextSliceKey field of the previous response. The first slice is always returned if you don't specify this parameter. If this parameter is set, all other query parameters are ignored. Unsupported on Log Management and Analytics, powered by Grail. |
config.query | string | The log search query. The query must use the Dynatrace search query language. default:"" |
config.sort | string | Defines the ordering of the log records. Each field has a sign prefix (+/-) for sorting order. If no sign prefix is set, then the Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first). When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected). default:"-timestamp" |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success
Code example
import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await logsClient.getLogRecords();
storeLog​
Pushes log records to Dynatrace
Required scope: storage:logs:write Required permission: storage:logs:write
Ingested logs are stored in the indexed log storage.
This endpoint requires an ActiveGate with the Log Analytics Collector module enabled.
The maximum payload size of a single request is 5 MB. Requests with a greater payload are rejected, and the API returns a 413 response code.
If the ingested payload is a JSON array, the maximum array size is 50000. Requests with a greater payload are rejected, and the API returns a 413 response code.
Log events per minute (SaaS):
Grail tenants: no limit, other tenants: 1M per minute by default.
If your log data stream within your cluster exceeds the limit, all log events above the limit are ignored.
Log events per minute (Managed):
1k/minute per cluster by default.
If your log data stream within your cluster exceeds the limit, all log events above the limit are ignored.
If you increase resources (RAM) in your nodes, you can increase the limit based on the cluster resources size using an API call or Cluster Management Console (CMC).
Refresh cluster limit using the API call
See Update log events per cluster for Log Monitoring.
Refresh cluster limit using Cluster Management Console (CMC)
-
In the CMC, select Environments and the environment for which you wish to update the total log events per cluster.
-
On the environment details page, in the Cluster overload prevention settings section, select the Refresh cluster limit.
High-cardinality attributes:
Unique log data attributes (high-cardinality attributes) such as span_id
and trace_id
generate unnecessarily excessive facet lists that may impact log viewer performance. Because of this, they aren't listed in log viewer facets. You can still use them in a log viewer advanced search query.
Returns​
Only a part of input events were ingested due to event invalidity. For details, check the response body.
Code example
import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await logsClient.storeLog({
type: "application/json",
body: [
{
content: "Exception: Custom error log sent via Generic Log Ingest",
"log.source": "/var/log/syslog",
timestamp: "2022-01-17T22:12:31.0000",
severity: "error",
"custom.attribute": "attribute value",
},
{
content: "Exception: Custom error log sent via Generic Log Ingest",
"log.source": "/var/log/syslog",
timestamp: "2022-01-17T22:12:35.0000",
},
{
content: "Exception: Custom error log sent via Generic Log Ingest",
"log.source": "/var/log/syslog",
},
{
content: "Exception: Custom error log sent via Generic Log Ingest",
},
],
});
metricsClient​
import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";
allMetrics​
Lists all available metrics
Required scope: environment-api:metrics:read Required permission: environment:roles:viewer
You can narrow down the output by selecting metrics in the metricSelector field.
You can additionally limit the output by using pagination:
-
Specify the number of results per page in the pageSize query parameter.
-
Then use the cursor from the nextPageKey field of the response in the nextPageKey query parameter to obtain subsequent pages. All other query parameters must be omitted.
Parameters​
Name | Type | Description |
---|---|---|
config.acceptType*required | "application/json; charset=utf-8" | "text/csv; header=absent; charset=utf-8" | "text/csv; header=present; charset=utf-8" | |
config.fields | string | Defines the list of metric properties included in the response.
To add properties, list them with leading plus To specify several properties, join them with a comma (for example If you specify just one property, the response contains the metric key and the specified property. To return metric keys only, specify |
config.metadataSelector | string | The metadata scope of the query. Only metrics with specified properties are included to the response. You can set one or more of the following criteria. Values are case-sensitive and the
To set several criteria, separate them with a comma ( For example, to list metrics that have the tags feature AND cloud with a unit of Percent OR MegaByte AND a dimension with a dimension key location, use this metadataSelector: |
config.metricSelector | string | Selects metrics for the query by their keys. You can specify multiple metric keys separated by commas (for example, You can select a full set of related metrics by using a trailing asterisk ( You can set additional transformation operators, separated by a colon ( Only If the metric key contains any symbols you must quote (
For example, to query the metric with the key of ext:selfmonitoring.jmx.Agents: Type "APACHE" you must specify this selector:
To find metrics based on a search term, rather than metricId, use the text query parameter instead of this one. |
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of metric schemata in a single response payload. The maximal allowed page size is 500. If not set, 100 is used. If a value higher than 500 is used, only 500 results per page are returned. |
config.text | string | Metric registry search term. Only show metrics that contain the term in their key, display name, or description. Use the metricSelector parameter instead of this one to select a complete metric hierarchy instead of doing a text-based search. |
config.writtenSince | string | Filters the resulted set of metrics to those that have data points within the specified timeframe. You can use one of the following formats:
|
Returns​
Success
Code example
import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await metricsClient.allMetrics({
acceptType: "application/json; charset=utf-8",
});
delete​
Deletes the specified metric
Required scope: environment-api:metrics:write Required permission: environment:roles:manage-settings
Deletion cannot be undone! You can't delete a metric if it has data points ingested within the last two hours.
Parameters​
Name | Type | Description |
---|---|---|
config.metricKey*required | string | The key of the required metric. |
Code example
import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await metricsClient.delete({
metricKey: "...",
});
ingest​
Pushes metric data points to Dynatrace
Required scope: storage:metrics:write Required permission: storage:metrics:write
Parameters​
Name | Type |
---|---|
config.body*required | string |
Returns​
The provided metric data points are accepted and will be processed in the background.
Code example
import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await metricsClient.ingest({
body: "server.cpu.temperature,cpu.id=0 42",
});
metric​
Gets the descriptor of the specified metric
Required scope: environment-api:metrics:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.acceptType*required | "application/json; charset=utf-8" | "text/csv; header=absent; charset=utf-8" | "text/csv; header=present; charset=utf-8" | |
config.metricKey*required | string | The key of the required metric. You can set additional transformation operators, separated by a colon ( |
Returns​
Success
Code example
import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await metricsClient.metric({
acceptType: "application/json; charset=utf-8",
metricKey: "...",
});
query​
Gets data points of the specified metrics
Required scope: environment-api:metrics:read Required permission: environment:roles:viewer
The following limits apply:
- The amount of aggregated data points in the response is limited to 1,000
- The amount of series in the response is limited to 1,000
- The amount of data points per series is limited to 10,080 (minutes of one week)
- The overall amount of data points is limited to 100,000
The dataPointCountRatio specifies the ratio of queried data points divided by the maximum number of data points per metric that are allowed in a single query. The dimensionCountRatio specifies the ratio of queried dimension tuples divided by the maximum number of dimension tuples allowed in a single query.
Parameters​
Name | Type | Description |
---|---|---|
config.acceptType*required | "application/json; charset=utf-8" | "text/csv; header=absent; charset=utf-8" | "text/csv; header=present; charset=utf-8" | |
config.entitySelector | string | Specifies the entity scope of the query. Only data points delivered by matched entities are included in response. You must set one of these criteria:
You can add one or more of the following criteria. Values are case-sensitive and the
For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma ( The maximum string length is 2,000 characters. Use the To set a universal scope matching all entities, omit this parameter. |
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of two hours is used ( |
config.metricSelector | string | Selects metrics for the query by their keys. You can select up to 10 metrics for one query. You can specify multiple metric keys separated by commas (for example, If the metric key contains any symbols you must quote (
For example, to query the metric with the key of ext:selfmonitoring.jmx.Agents: Type "APACHE" you must specify this selector:
You can set additional transformation operators, separated by a colon ( |
config.mzSelector | string | The management zone scope of the query. Only metrics data relating to the specified management zones are included to the response. You can set one or more of the following criteria. Values are case-sensitive and the
|
config.resolution | string | The desired resolution of data points. You can use one of the following options:
Valid units for the timespan are:
If not set, the default is 120 data points. For example:
|
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success
Code example
import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await metricsClient.query({
acceptType: "application/json; charset=utf-8",
});
metricsUnitsClient​
import { metricsUnitsClient } from "@dynatrace-sdk/client-classic-environment-v2";
allUnits​
Lists all available units
Required scope: environment-api:metrics:read Required permission: environment:roles:viewer
You can narrow down the output by providing filter criteria in the unitSelector field.
Parameters​
Name | Type | Description |
---|---|---|
config.fields | string | Defines the list of properties to be included in the response. The ID of the unit is always included. The following additional properties are available:
By default, the ID, the display name, and the symbol are included. To add properties, list them with leading plus To specify several properties, join them with a comma (for example If you specify just one property, the response contains the unitId and the specified property. To return unit IDs only, specify |
config.unitSelector | string | Selects units to be included to the response. Available criteria:
|
Returns​
Success
Code example
import { metricsUnitsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await metricsUnitsClient.allUnits();
convert​
Converts a value from a source unit into a target unit
Required scope: environment-api:metrics:read Required permission: environment:roles:viewer
If no target unit is set, the request finds an appropriate target unit automatically, taking into account the preferred number format (if specified).
Parameters​
Name | Type | Description |
---|---|---|
config.numberFormat | string | The preferred number format of the target value. You can specify the following formats:
`Only used if the target unit if not set. |
config.targetUnit | string | The ID of the target unit. If not set, the request finds an appropriate target unit automatically, based on the specified number format. |
config.unitId*required | string | The ID of the source unit. |
config.value*required | number | The value to be converted. |
Returns​
Success
Code example
import { metricsUnitsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await metricsUnitsClient.convert({
unitId: "...",
value: 10,
});
unit​
Gets the properties of the specified unit
Required scope: environment-api:metrics:read Required permission: environment:roles:viewer
Parameters​
Name | Type |
---|---|
config.unitId*required | string |
Returns​
Success
Code example
import { metricsUnitsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await metricsUnitsClient.unit({
unitId: "...",
});
monitoredEntitiesClient​
import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
deleteSecurityContext​
Deletes the security context for all entities matching the entity selector.
Required scope: settings:objects:write One of the following permissions is required:
- environment:roles:manage-settings
- settings:objects:write
Automatic management zone rules will apply again to entities without a security context.
Parameters​
Name | Type | Description |
---|---|---|
config.entitySelector | string | Defines the scope of the entities to set the security context for. Only entities that can have management zones are considered for this operation You must set one of these criteria:
You can add one or more of the following criteria. Values are case-sensitive and the
For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma ( The maximum string length is 2,000 characters. |
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of three days is used ( |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success
Code example
import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await monitoredEntitiesClient.deleteSecurityContext();
getEntities​
Gets the information about monitored entities
Required scope: environment-api:entities:read Required permission: environment:roles:viewer
Lists entities observed within the specified timeframe along with their properties.
When you query entities of the SERVICE_METHOD
type, only the following requests are returned:
- Key requests
- Top X requests that are used for baselining
- Requests that have caused a problem
You can limit the output by using pagination:
- Specify the number of results per page in the pageSize query parameter.
- Use the cursor from the nextPageKey field of the previous response in the nextPageKey query parameter to obtain subsequent pages.
Parameters​
Name | Type | Description |
---|---|---|
config.entitySelector | string | Defines the scope of the query. Only entities matching the specified criteria are included into response. You must set one of these criteria:
You can add one or more of the following criteria. Values are case-sensitive and the
For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma ( The maximum string length is 2,000 characters. The field is required when you're querying the first page of results. |
config.fields | string | Defines the list of entity properties included in the response. The ID and the name of an entity are always included to the response. To add properties, list them with leading plus Use the GET entity type request to fetch the list of properties available for your entity type. Fields from the properties object must be specified in the When requesting large amounts of relationship fields, throttling can apply. |
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of three days is used ( |
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of entities. If not set, 50 is used. |
config.sort | string | Defines the ordering of the entities returned. This field is optional, each field has a sign prefix (+/-), which corresponds to sorting order ( + for ascending and - for descending). If no sign prefix is set, then default ascending sorting order will be applied. Currently ordering is only available for the display name (for example |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success
Code example
import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await monitoredEntitiesClient.getEntities();
getEntity​
Gets the properties of the specified monitored entity
Required scope: environment-api:entities:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.entityId*required | string | The ID of the required entity. |
config.fields | string | Defines the list of entity properties included in the response. The ID and the name of an entity are always included to the response. To add properties, list them with leading plus Use the GET entity type request to fetch the list of properties available for your entity type. Fields from the properties object must be specified in the When requesting large amounts of relationship fields, throttling can apply. |
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of three days is used ( |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success
Code example
import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await monitoredEntitiesClient.getEntity({
entityId: "...",
});
getEntityType​
Gets a list of properties for the specified entity type
Required scope: environment-api:entities:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.type*required | string | The required entity type. |
Returns​
Success
Code example
import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await monitoredEntitiesClient.getEntityType({
type: "...",
});
getEntityTypes​
Gets a list of properties for all entity types
Required scope: environment-api:entities:read Required permission: environment:roles:viewer
You can limit the output by using pagination:
- Specify the number of results per page in the pageSize query parameter.
- Use the cursor from the nextPageKey field of the previous response in the nextPageKey query parameter to obtain subsequent pages.
Parameters​
Name | Type | Description |
---|---|---|
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of entity types in a single response payload. The maximal allowed page size is 500. If not set, 50 is used. |
Returns​
Success
Code example
import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await monitoredEntitiesClient.getEntityTypes();
pushCustomDevice​
Creates or updates a custom device
Required scope: environment-api:entities:write Required permission: environment:roles:manage-settings
Parameters​
Name | Type |
---|---|
config.body*required | CustomDeviceCreation |
Returns​
Success
Code example
import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await monitoredEntitiesClient.pushCustomDevice({
body: { customDeviceId: "...", displayName: "..." },
});
setSecurityContext​
Sets the given security context for all entities matching the entity selector.
Required scope: settings:objects:write One of the following permissions is required:
- environment:roles:manage-settings
- settings:objects:write
Matching entities will have a management zone assigned, if the given security context matches the name of an already existing management zone. This endpoint does not create a new management zone, if there is no management zone with the provided name. Automatic management zone rules will not apply to entities with a set security context. It will need to be removed, to have them apply again.
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | SecurityContextDtoImpl | |
config.entitySelector | string | Defines the scope of the entities to set the security context for. Only entities that can have management zones are considered for this operation You must set one of these criteria:
You can add one or more of the following criteria. Values are case-sensitive and the
For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma ( The maximum string length is 2,000 characters. |
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of three days is used ( |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success
Code example
import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await monitoredEntitiesClient.setSecurityContext({
body: {},
});
monitoredEntitiesCustomTagsClient​
import { monitoredEntitiesCustomTagsClient } from "@dynatrace-sdk/client-classic-environment-v2";
deleteTags​
Deletes the specified tag from the specified entities
Required scope: environment-api:entities:write Required permission: environment:roles:manage-settings
Parameters​
Name | Type | Description |
---|---|---|
config.deleteAllWithKey | boolean |
If not set, |
config.entitySelector*required | string | Specifies the entities where you want to delete tags. You must set one of these criteria:
You can add one or more of the following criteria. Values are case-sensitive and the
For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma ( The maximum string length is 2,000 characters. |
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of 24 hours is used ( |
config.key*required | string | The key of the tag to be deleted. If deleteAllWithKey is For value-only tags, specify the value here. |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
config.value | string | The value of the tag to be deleted. The value is ignored if deleteAllWithKey is For value-only tags, specify the value in the key parameter. |
Returns​
Success
Code example
import { monitoredEntitiesCustomTagsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await monitoredEntitiesCustomTagsClient.deleteTags({
key: "...",
entitySelector: "...",
});
getTags​
Gets a list of custom tags applied to the specified entities
Required scope: environment-api:entities:read Required permission: environment:roles:viewer
Automatically applied tags and imported tags are not included.
Parameters​
Name | Type | Description |
---|---|---|
config.entitySelector*required | string | Specifies the entities where you want to read tags. You must set one of these criteria:
You can add one or more of the following criteria. Values are case-sensitive and the
For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma ( The maximum string length is 2,000 characters. |
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of 24 hours is used ( |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success
Code example
import { monitoredEntitiesCustomTagsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await monitoredEntitiesCustomTagsClient.getTags({
entitySelector: "...",
});
postTags​
Adds custom tags to the specified entities
Required scope: environment-api:entities:write Required permission: environment:roles:manage-settings
All existing tags remain unaffected.
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | AddEntityTags | |
config.entitySelector*required | string | Specifies the entities where you want to update tags. You must set one of these criteria:
You can add one or more of the following criteria. Values are case-sensitive and the
For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma ( The maximum string length is 2,000 characters. |
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of 24 hours is used ( |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success
Code example
import { monitoredEntitiesCustomTagsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await monitoredEntitiesCustomTagsClient.postTags({
entitySelector: "...",
body: { tags: [{ key: "..." }] },
});
monitoredEntitiesMonitoringStateClient​
import { monitoredEntitiesMonitoringStateClient } from "@dynatrace-sdk/client-classic-environment-v2";
getStates​
Lists monitoring states of entities
Required scope: environment-api:entities:read Required permission: environment:roles:viewer
Only process group instances are supported.
Parameters​
Name | Type | Description |
---|---|---|
config.entitySelector | string | Specifies the process group instances where you're querying the state. Use the You must set one of these criteria:
You can add one or more of the following criteria. Values are case-sensitive and the
For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma ( The maximum string length is 2,000 characters. |
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of monitoring states in a single response payload. The maximal allowed page size is 500. If not set, 500 is used. |
Returns​
Success
Code example
import { monitoredEntitiesMonitoringStateClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await monitoredEntitiesMonitoringStateClient.getStates();
networkZonesClient​
import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
createOrUpdateNetworkZone​
Updates an existing network zone or creates a new one
Required scope: environment-api:network-zones:write Required permission: environment:roles:manage-settings
If the network zone with the specified ID does not exist, a new network zone is created.
The ID is not case sensitive. Dynatrace stores the ID in lowercase.
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | NetworkZone | |
config.id*required | string | The ID of the network zone to be updated. If you set the ID in the body as well, it must match this ID. The ID is not case sensitive. Dynatrace stores the ID in lowercase. |
Returns​
Success. The new network zone has been created. The response body contains the ID of the new network zone.
Code example
import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await networkZonesClient.createOrUpdateNetworkZone({
id: "...",
body: {},
});
deleteNetworkZone​
Deletes the specified network zone
Required scope: environment-api:network-zones:write Required permission: environment:roles:manage-settings
You can only delete an empty network zone (a zone that no ActiveGate or OneAgent is using).
If the network zone is used as an alternative zone for any OneAgent, it will be automatically removed from the list of possible alternatives.
Parameters​
Name | Type | Description |
---|---|---|
config.id*required | string | The ID of the network zone to be deleted. |
Code example
import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await networkZonesClient.deleteNetworkZone({
id: "...",
});
getAllNetworkZones​
Lists all existing network zones
Required scope: environment-api:network-zones:read Required permission: environment:roles:viewer
Returns​
Success
Code example
import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await networkZonesClient.getAllNetworkZones();
getHostStats​
Gets the statistics about hosts using the network zone
Required scope: environment-api:network-zones:read Required permission: environment:roles:manage-settings
Parameters​
Name | Type | Description |
---|---|---|
config.filter | GetHostStatsQueryFilter | Filters the resulting set of hosts:
If not set, "all" |
config.id*required | string | The ID of the required network zone. |
Returns​
Success
Code example
import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await networkZonesClient.getHostStats({
id: "...",
});
getNetworkZoneSettings​
Gets the global configuration of network zones
Required scope: environment-api:network-zones:read Required permission: environment:roles:viewer
Returns​
Success
Code example
import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await networkZonesClient.getNetworkZoneSettings();
getSingleNetworkZone​
Gets parameters of the specified network zone
Required scope: environment-api:network-zones:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.id*required | string | The ID of the required network zone. |
Returns​
Success
Code example
import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await networkZonesClient.getSingleNetworkZone({
id: "...",
});
updateNetworkZoneSettings​
Updates the global configuration of network zones
Required scope: environment-api:network-zones:write Required permission: environment:roles:manage-settings
Parameters​
Name | Type |
---|---|
config.body*required | NetworkZoneSettings |
Code example
import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await networkZonesClient.updateNetworkZoneSettings({
body: {},
});
problemsClient​
import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
closeProblem​
Closes the specified problem and adds a closing comment on it
Required scope: environment-api:problems:write Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | ProblemCloseRequestDtoImpl | |
config.problemId*required | string | The ID of the required problem. |
Returns​
Success
Code example
import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await problemsClient.closeProblem({
problemId: "...",
body: { message: "..." },
});
createComment​
Adds a new comment on the specified problem
Required scope: environment-api:problems:write Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | CommentRequestDtoImpl | |
config.problemId*required | string | The ID of the required problem. |
Code example
import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await problemsClient.createComment({
problemId: "...",
body: { message: "..." },
});
deleteComment​
Deletes the specified comment from a problem
Required scope: environment-api:problems:write Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.commentId*required | string | The ID of the required comment. |
config.problemId*required | string | The ID of the required problem. |
Code example
import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await problemsClient.deleteComment({
problemId: "...",
commentId: "...",
});
getComment​
Gets the specified comment on a problem
Required scope: environment-api:problems:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.commentId*required | string | The ID of the required comment. |
config.problemId*required | string | The ID of the required problem. |
Returns​
Success
Code example
import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await problemsClient.getComment({
problemId: "...",
commentId: "...",
});
getComments​
Gets all comments on the specified problem
Required scope: environment-api:problems:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters except the optional fields parameter. |
config.pageSize | number | The amount of comments in a single response payload. The maximal allowed page size is 500. If not set, 10 is used. |
config.problemId*required | string | The ID of the required problem. |
Returns​
Success
Code example
import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await problemsClient.getComments({
problemId: "...",
});
getProblem​
Gets the properties of the specified problem
Required scope: environment-api:problems:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.fields | string | A list of additional problem properties you can add to the response. The following properties are available (all other properties are always included and you can't remove them from the response):
To add properties, specify them as a comma-separated list (for example, |
config.problemId*required | string | The ID of the required problem. |
Returns​
Success
Code example
import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await problemsClient.getProblem({
problemId: "...",
});
getProblems​
Lists problems observed within the specified timeframe
Required scope: environment-api:problems:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.entitySelector | string | The entity scope of the query. You must set one of these criteria:
You can add one or more of the following criteria. Values are case-sensitive and the
For more information, see Entity selector in Dynatrace Documentation. To set several criteria, separate them with a comma ( The maximum string length is 2,000 characters. The maximum number of entities that may be selected is limited to 10000. |
config.fields | string | A list of additional problem properties you can add to the response. The following properties are available (all other properties are always included and you can't remove them from the response):
To add properties, specify them as a comma-separated list (for example, The field is valid only for the current page of results. You must set it for each page you're requesting. |
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of two hours is used ( |
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters except the optional fields parameter. |
config.pageSize | number | The amount of problems in a single response payload. The maximal allowed page size is 500. If not set, 50 is used. |
config.problemSelector | string | Defines the scope of the query. Only problems matching the specified criteria are included into response. You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the OR logic applies. All values must be quoted.
To set several criteria, separate them with a comma ( |
config.sort | string | Specifies a set of comma-separated ( You can sort by the following properties with a sign prefix for the sorting order.
If no prefix is set, You can specify several levels of sorting. For example, |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success
Code example
import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await problemsClient.getProblems();
updateComment​
Updates the specified comment on a problem
Required scope: environment-api:problems:write Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | CommentRequestDtoImpl | |
config.commentId*required | string | The ID of the required comment. |
config.problemId*required | string | The ID of the required problem. |
Code example
import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await problemsClient.updateComment({
problemId: "...",
commentId: "...",
body: { message: "..." },
});
releasesClient​
import { releasesClient } from "@dynatrace-sdk/client-classic-environment-v2";
getReleases​
Returns all releases
Required scope: environment-api:releases:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.demo | boolean | Get your Releases (false ) or a set of demo Releases (true ). default: false |
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of two weeks is used ( |
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of Releases in a single response payload. The maximal allowed page size is 1000. If not set, 100 is used. |
config.releasesSelector | string | Defines the scope of the query. Only Releases matching the provided criteria are included in the response. You can add one or several of the criteria listed below.
To set several criteria, separate them with comma (,). Only results matching all criteria are included in the response. e.g., .../api/v2/releases?releasesSelector=name("Server"),monitoringState("Active"),healthState("HEALTHY"),releasesVersion("1.0.7"). The special characters ~ and " need to be escaped using a ~ (e.g. double quote search entityName("~""). default:"" |
config.sort | string | Specifies the field that is used for sorting the releases list. The field has a sign prefix (+/-) which corresponds to the sorting order ('+' for ascending and '-' for descending). If no sign prefix is set, then the default ascending sorting order will be applied. You can sort by the following properties:
If not set, the ascending order sorting for name is applied. default:"name" |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success
Code example
import { releasesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await releasesClient.getReleases();
securityProblemsClient​
import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
bulkMuteRemediationItems​
Mutes several remediation items
Required scope: environment-api:security-problems:write Required permission: environment:roles:manage-security-problems
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | RemediationItemsBulkMute | |
config.id*required | string | The ID of the requested third-party security problem. |
Returns​
Success. The remediation item(s) have been muted.
Code example
import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await securityProblemsClient.bulkMuteRemediationItems({
id: "...",
body: { remediationItemIds: ["..."] },
});
bulkMuteSecurityProblems​
Mutes several security problems
Required scope: environment-api:security-problems:write Required permission: environment:roles:manage-security-problems
Parameters​
Name | Type |
---|---|
config.body*required | SecurityProblemsBulkMute |
Returns​
Success. The security problem(s) have been muted.
Code example
import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await securityProblemsClient.bulkMuteSecurityProblems({
body: { securityProblemIds: ["..."] },
});
bulkUnmuteRemediationItems​
Un-mutes several remediation items
Required scope: environment-api:security-problems:write Required permission: environment:roles:manage-security-problems
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | RemediationItemsBulkUnmute | |
config.id*required | string | The ID of the requested third-party security problem. |
Returns​
Success. The remediation item(s) have been un-muted.
Code example
import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await securityProblemsClient.bulkUnmuteRemediationItems({
id: "...",
body: { remediationItemIds: ["..."] },
});
bulkUnmuteSecurityProblems​
Un-mutes several security problems
Required scope: environment-api:security-problems:write Required permission: environment:roles:manage-security-problems
Parameters​
Name | Type |
---|---|
config.body*required | SecurityProblemsBulkUnmute |
Returns​
Success. The security problem(s) have been un-muted.
Code example
import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await securityProblemsClient.bulkUnmuteSecurityProblems({
body: { securityProblemIds: ["..."] },
});
getEventsForSecurityProblem​
Lists all events of a security problem
Required scope: environment-api:security-problems:read One of the following permissions is required:
- environment:roles:manage-security-problems
- environment:roles:view-security-problems
Parameters​
Name | Type | Description |
---|---|---|
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of thirty days is used ( |
config.id*required | string | The ID of the requested security problem. |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success. The response contains the list of security problem events.
Code example
import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await securityProblemsClient.getEventsForSecurityProblem({
id: "...",
});
getRemediationItem​
Gets parameters of a remediation item of a security problem
Required scope: environment-api:security-problems:read One of the following permissions is required:
- environment:roles:manage-security-problems
- environment:roles:view-security-problems
Parameters​
Name | Type | Description |
---|---|---|
config.id*required | string | The ID of the requested third-party security problem. |
config.remediationItemId*required | string | The ID of the remediation item. |
Returns​
Success. The response contains details of a single remediation item of a security problem.
Code example
import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await securityProblemsClient.getRemediationItem({
id: "...",
remediationItemId: "...",
});
getRemediationItems​
Lists remediation items of a third-party security problem
Required scope: environment-api:security-problems:read One of the following permissions is required:
- environment:roles:manage-security-problems
- environment:roles:view-security-problems
Parameters​
Name | Type | Description |
---|---|---|
config.id*required | string | The ID of the requested third-party security problem. |
config.remediationItemSelector | string | Defines the scope of the query. Only remediable entities matching the specified criteria are included in the response. You can add one or more of the following criteria. Values are not case-sensitive and the
To set several criteria, separate them with a comma ( Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (
|
Returns​
Success. The response contains the list of remediation items of a problem.
Code example
import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await securityProblemsClient.getRemediationItems({
id: "...",
});
getRemediationProgressEntities​
Lists remediation progress entities
Required scope: environment-api:security-problems:read One of the following permissions is required:
- environment:roles:manage-security-problems
- environment:roles:view-security-problems
Parameters​
Name | Type | Description |
---|---|---|
config.id*required | string | The ID of the requested third-party security problem. |
config.remediationItemId*required | string | The ID of the remediation item. |
config.remediationProgressEntitySelector | string | Defines the scope of the query. Only remediation progress entities matching the specified criteria are included in the response. You can add one or more of the following criteria. Values are not case-sensitive and the
To set several criteria, separate them with a comma ( Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (
|
Returns​
Success. The response contains a list of remediation progress entities of a remediation item of a security problem. The number of entities returned is limited.
Code example
import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await securityProblemsClient.getRemediationProgressEntities({
id: "...",
remediationItemId: "...",
});
getSecurityProblem​
Gets parameters of a security problem
Required scope: environment-api:security-problems:read One of the following permissions is required:
- environment:roles:manage-security-problems
- environment:roles:view-security-problems
Parameters​
Name | Type | Description |
---|---|---|
config.fields | string | A list of additional security problem properties you can add to the response. The following properties are available (all other properties are always included and you can't remove them from the response):
To add properties, specify them in a comma-separated list and prefix each property with a plus (for example, |
config.from | string | Based on the timeframe start the affected-, related- and vulnerable entities are being calculated. You can use one of the following formats:
If not set, the default timeframe start of 24 hours in the past is used ( The timeframe start must not be older than 365 days. |
config.id*required | string | The ID of the requested security problem. |
Returns​
Success. The response contains parameters of the security problem.
Code example
import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await securityProblemsClient.getSecurityProblem({
id: "...",
});
getSecurityProblems​
Lists all security problems
Required scope: environment-api:security-problems:read One of the following permissions is required:
- environment:roles:manage-security-problems
- environment:roles:view-security-problems
Parameters​
Name | Type | Description |
---|---|---|
config.fields | string | A list of additional security problem properties you can add to the response. The following properties are available (all other properties are always included and you can't remove them from the response):
To add properties, specify them in a comma-separated list and prefix each property with a plus (for example, |
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of thirty days is used ( |
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of security problems in a single response payload. The maximal allowed page size is 500. If not set, 100 is used. |
config.securityProblemSelector | string | Defines the scope of the query. Only security problems matching the specified criteria are included in the response. You can add one or more of the following criteria. Values are not case-sensitive and the
Risk score and risk category are mutually exclusive (cannot be used at the same time). To set several criteria, separate them with a comma ( Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (
|
config.sort | string | Specifies one or more fields for sorting the security problem list. Multiple fields can be concatenated using a comma ( You can sort by the following properties with a sign prefix for the sorting order.
If no prefix is set, |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. The end of the timeframe must not be older than 365 days. |
Returns​
Success. The response contains the list of security problems.
Code example
import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await securityProblemsClient.getSecurityProblems();
getVulnerableFunctions​
Lists all vulnerable functions and their usage for a third-party security problem
Required scope: environment-api:security-problems:read One of the following permissions is required:
- environment:roles:manage-security-problems
- environment:roles:view-security-problems
Parameters​
Name | Type | Description |
---|---|---|
config.groupBy | string | Defines additional grouping types in which vulnerable functions should be displayed. You can add one of the following grouping types.
|
config.id*required | string | The ID of the requested third-party security problem. |
config.vulnerableFunctionsSelector | string | Defines the scope of the query. Only vulnerable functions matching the specified criteria are included in the response. You can add the following criteria. Values are not case sensitive and the
Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (
|
Returns​
Success. The response contains the list of vulnerable functions.
Code example
import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await securityProblemsClient.getVulnerableFunctions({
id: "...",
});
muteSecurityProblem​
Mutes a security problem
Required scope: environment-api:security-problems:write Required permission: environment:roles:manage-security-problems
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | SecurityProblemMute | |
config.id*required | string | The ID of the requested security problem. |
Code example
import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await securityProblemsClient.muteSecurityProblem({
id: "...",
body: {},
});
setRemediationItemMuteState​
Sets the mute state of a remediation item
Required scope: environment-api:security-problems:write Required permission: environment:roles:manage-security-problems
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | RemediationItemMuteStateChange | |
config.id*required | string | The ID of the requested third-party security problem. |
config.remediationItemId*required | string | The ID of the remediation item. |
Code example
import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await securityProblemsClient.setRemediationItemMuteState({
id: "...",
remediationItemId: "...",
body: { comment: "...", muted: false },
});
trackingLinkBulkUpdateAndDelete​
Updates the external tracking links of the remediation items. | maturity=EARLY_ADOPTER
Required scope: environment-api:security-problems:write Required permission: environment:roles:manage-security-problems
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | RemediationItemsBulkUpdateDeleteDto | |
config.id*required | string | The ID of the requested third-party security problem. |
Code example
import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await securityProblemsClient.trackingLinkBulkUpdateAndDelete({
id: "...",
body: {},
});
unmuteSecurityProblem​
Un-mutes a security problem
Required scope: environment-api:security-problems:write Required permission: environment:roles:manage-security-problems
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | SecurityProblemUnmute | |
config.id*required | string | The ID of the requested security problem. |
Code example
import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await securityProblemsClient.unmuteSecurityProblem({
id: "...",
body: {},
});
serviceLevelObjectivesClient​
import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
createAlert​
Creates an alert of the provided alert type for an SLO
Required scope: environment-api:slo:write One of the following permissions is required:
- environment:roles:manage-settings
- settings:objects:write
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | AbstractSloAlertDto | |
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of two weeks is used ( |
config.id*required | string | The ID of the required SLO. |
config.timeFrame | CreateAlertQueryTimeFrame | The timeframe to calculate the SLO values:
If not set, the "CURRENT" |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success. The new alert has been created. The response contains the parameters of the new alert. The location response header contains the ID of the new alert.
Code example
import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await serviceLevelObjectivesClient.createAlert({
id: "...",
body: { alertName: "...", alertThreshold: 10 },
});
createSlo​
Creates a new SLO
Required scope: environment-api:slo:write One of the following permissions is required:
- environment:roles:manage-settings
- settings:objects:write
Parameters​
Name | Type |
---|---|
config.body*required | SloConfigItemDtoImpl |
Code example
import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await serviceLevelObjectivesClient.createSlo({
body: {
name: "Payment service availability",
target: 95,
timeframe: "-1d",
warning: 97.5,
},
});
deleteSlo​
Deletes an SLO
Required scope: environment-api:slo:write One of the following permissions is required:
- environment:roles:manage-settings
- settings:objects:write
Parameters​
Name | Type |
---|---|
config.id*required | string |
Code example
import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await serviceLevelObjectivesClient.deleteSlo({
id: "...",
});
getSlo​
Lists all available SLOs along with calculated values
Required scope: environment-api:slo:read One of the following permissions is required:
- environment:roles:viewer
- settings:objects:read
By default the values are calculated for the SLO's own timeframe. You can use a custom timeframe:
- Set the timeFrame parameter to
GTF
. - Provide the timeframe in from and to parameters.
Parameters​
Name | Type | Description |
---|---|---|
config.demo | boolean | Get your SLOs (false ) or a set of demo SLOs (true ). default: false |
config.enabledSlos | GetSloQueryEnabledSlos | Get your enabled SLOs (true ), disabled ones (false ) or both enabled and disabled ones (all ). default: "true" |
config.evaluate | GetSloQueryEvaluate | Get your SLOs without them being evaluated (false ) or with evaluations (true ) with maximum pageSize of 25. default: "false" |
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of two weeks is used ( |
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of SLOs in a single response payload. The maximal allowed page size is 10000. If not set, 10 is used. |
config.showGlobalSlos | boolean | Get your global SLOs (true ) regardless of the selected filter or filter them out (false ). default: true |
config.sloSelector | string | The scope of the query. Only SLOs matching the provided criteria are included in the response. You can add one or several of the criteria listed below.
To set several criteria, separate them with comma (
The special characters "" |
config.sort | string | The sorting of SLO entries:
If not set, the ascending order is used. default:"name" |
config.timeFrame | GetSloQueryTimeFrame | The timeframe to calculate the SLO values:
If not set, the "CURRENT" |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success. The response contains the parameters and calculated values of the requested SLO.
Code example
import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await serviceLevelObjectivesClient.getSlo();
getSloById​
Gets parameters and calculated values of a specific SLO
Required scope: environment-api:slo:read One of the following permissions is required:
- environment:roles:viewer
- settings:objects:read
If from and to parameters are provided, the SLO is calculated for that timeframe; otherwise the SLO's own timeframe is used.
Parameters​
Name | Type | Description |
---|---|---|
config.from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of two weeks is used ( |
config.id*required | string | The ID of the required SLO. |
config.timeFrame | GetSloByIdQueryTimeFrame | The timeframe to calculate the SLO values:
If not set, the "CURRENT" |
config.to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. |
Returns​
Success. The response contains the parameters and calculated values of the requested SLO.
Code example
import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await serviceLevelObjectivesClient.getSloById({
id: "...",
});
updateSloById​
Updates an existing SLO
Required scope: environment-api:slo:write One of the following permissions is required:
- environment:roles:manage-settings
- settings:objects:write
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | SloConfigItemDtoImpl | |
config.id*required | string | The ID of the required SLO. |
Code example
import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await serviceLevelObjectivesClient.updateSloById({
id: "...",
body: {
name: "Payment service availability",
target: 95,
timeframe: "-1d",
warning: 97.5,
},
});
settingsObjectsClient​
import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
deleteSettingsObjectByObjectId​
Deletes the specified settings object
Required scope: settings:objects:write One of the following permissions is required:
- environment:roles:manage-settings
- settings:objects:write
Parameters​
Name | Type | Description |
---|---|---|
config.objectId*required | string | The ID of the required settings object. |
config.updateToken | string | The update token of the object. You can use it to detect simultaneous modifications by different users. It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update. If omitted on update/deletion, the operation overrides the current value or deletes it without any checks. |
Code example
import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await settingsObjectsClient.deleteSettingsObjectByObjectId({
objectId: "...",
});
getEffectiveSettingsValues​
Lists effective settings values
Required scope: settings:objects:read One of the following permissions is required:
- environment:roles:manage-settings
- settings:objects:read
Lists effective settings values for selected schemas at a selected scope (or entity). This operation evaluates the hierarchy of persisted objects (see /settings/objects)
It will always return a result for a schema/scope combination, even if the schema would not be relevant to the given scope/entity.
If no object along the hierarchy is persisted, the default value as defined in the schema will be returned.
Parameters​
Name | Type | Description |
---|---|---|
config.fields | string | A list of fields to be included to the response. The provided set of fields replaces the default set. Specify the required top-level fields, separated by commas (for example, Supported fields: "origin,value" |
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of settings objects in a single response payload. The maximal allowed page size is 500. If not set, 100 is used. |
config.schemaIds | string | A list of comma-separated schema IDs to which the requested objects belong. Only considered on load of the first page, when the nextPageKey is not set. |
config.scope | string | The scope that the requested objects target. The selection only matches objects directly targeting the specified scope. For example, To load the first page, when the nextPageKey is not set, this parameter is required. |
Returns​
Success
Code example
import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await settingsObjectsClient.getEffectiveSettingsValues();
getSettingsObjectByObjectId​
Gets the specified settings object
Required scope: settings:objects:read One of the following permissions is required:
- environment:roles:manage-settings
- settings:objects:read
Parameters​
Name | Type | Description |
---|---|---|
config.objectId*required | string | The ID of the required settings object. |
Returns​
Success
Code example
import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await settingsObjectsClient.getSettingsObjectByObjectId({
objectId: "...",
});
getSettingsObjects​
Lists persisted settings objects
Required scope: settings:objects:read One of the following permissions is required:
- environment:roles:manage-settings
- settings:objects:read
Lists persisted settings objects for selected schemas at selected scopes (or entities).
If nothing is persisted or if all persisted settings objects are not accessible due to missing permissions, no items will be returned.
To query the effective values (including schema defaults) please see /settings/effectiveValues.
Parameters​
Name | Type | Description |
---|---|---|
config.externalIds | string | A list of comma-separated external IDs that the requested objects have. Each external ID has a maximum length of 500 characters. Only considered on load of the first page, when the nextPageKey is not set. |
config.fields | string | A list of fields to be included to the response. The provided set of fields replaces the default set. Specify the required top-level fields, separated by commas (for example, Supported fields: "objectId,value" |
config.filter | string | The filter parameter, as explained here. Filtering is supported on the following fields:
If this parameter is omitted, all settings objects will be returned. The maximum nesting depth (via parentheses) is 5. The maximum expression length is 1000 characters. Note that only fields included to the response via |
config.nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. |
config.pageSize | number | The amount of settings objects in a single response payload. The maximal allowed page size is 500. If not set, 100 is used. |
config.schemaIds | string | A list of comma-separated schema IDs to which the requested objects belong. To load the first page, when the nextPageKey is not set, either this parameter or scopes is required. To load all objects belonging to the given schema IDs leave the scopes parameter empty. |
config.scopes | string | A list of comma-separated scopes, that the requested objects target. The selection only matches objects directly targeting the specified scopes. For example, To load the first page, when the nextPageKey is not set, either this parameter or schemaIds is required. To load all objects belonging to the given scopes leave the schemaIds parameter empty. |
config.sort | string | The sort parameter, as explained here. Sorting is supported on the following fields:
Note that only fields included to the response via |
Returns​
Success. Accessible objects returned.
Code example
import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await settingsObjectsClient.getSettingsObjects();
postSettingsObjects​
Creates a new settings object
Required scope: settings:objects:write One of the following permissions is required:
- environment:roles:manage-settings
- settings:objects:write
You can upload several objects at once. In that case each object returns its own response code. Check the response body for details.
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | Array<SettingsObjectCreate> | |
config.validateOnly | boolean | If true , the request runs only validation of the submitted settings objects, without saving them. default: false |
Returns​
Success | Multi-status: different objects in the payload resulted in different statuses.
Code example
import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await settingsObjectsClient.postSettingsObjects({
body: [
{
schemaId: "builtin:container.built-in-monitoring-rule",
scope: "HOST-D3A3C5A146830A79",
},
],
});
putSettingsObjectByObjectId​
Updates an existing settings object
Required scope: settings:objects:write One of the following permissions is required:
- environment:roles:manage-settings
- settings:objects:write
To update a property of the secret
type you need to pass the new value unmasked. To keep the current value, send the current masked secret. You can obtain it via GET an object endpoint.
Some schemas don't allow passing of the masked secret. In that case you need to send the unmasked secret with every update of the object.
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | SettingsObjectUpdate | |
config.objectId*required | string | The ID of the required settings object. |
Returns​
Success
Code example
import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await settingsObjectsClient.putSettingsObjectByObjectId({
objectId: "...",
body: {},
});
settingsSchemasClient​
import { settingsSchemasClient } from "@dynatrace-sdk/client-classic-environment-v2";
getAvailableSchemaDefinitions​
Lists available settings schemas
Required scope: settings:schemas:read One of the following permissions is required:
- environment:roles:manage-settings
- settings:schemas:read
Returns​
Success
Code example
import { settingsSchemasClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await settingsSchemasClient.getAvailableSchemaDefinitions();
getSchemaDefinition​
Gets parameters of the specified settings schema
Required scope: settings:schemas:read One of the following permissions is required:
- environment:roles:manage-settings
- settings:schemas:read
Parameters​
Name | Type | Description |
---|---|---|
config.schemaId*required | string | The ID of the required schema. |
config.schemaVersion | string | The version of the required schema. If not set, the most recent version is returned. |
Returns​
Success
Code example
import { settingsSchemasClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await settingsSchemasClient.getSchemaDefinition({
schemaId: "...",
});
syntheticHttpMonitorExecutionsClient​
import { syntheticHttpMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";
getExecutionResult​
Gets detailed information about the last execution of the specified HTTP monitor
Required scope: environment-api:synthetic-execution:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.locationId | string | Filters the results to those executed by specified Synthetic location. Specify the ID of the location. |
config.monitorId*required | string | Identifier of the HTTP monitor for which last execution result is returned. |
config.resultType*required | GetExecutionResultPathResultType | Defines the result type of the last HTTP monitor's execution. |
Returns​
Success. The response contains detailed data.
Code example
import { syntheticHttpMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await syntheticHttpMonitorExecutionsClient.getExecutionResult({
monitorId: "...",
resultType: GetExecutionResultPathResultType.Success,
});
syntheticLocationsNodesAndConfigurationClient​
import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
addLocation​
Creates a new private synthetic location
Required scope: environment-api:synthetic:write Required permission: environment:roles:manage-settings
Parameters​
Name | Type |
---|---|
config.body*required | PrivateSyntheticLocation |
Returns​
Success. The private location has been created. The response contains the ID of the new location.
Code example
import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await syntheticLocationsNodesAndConfigurationClient.addLocation({
body: {},
});
getConfiguration​
Gets set of synthetic related parameters defined for whole tenant (affects all monitors and all private locations). | maturity=EARLY_ADOPTER
Required scope: environment-api:synthetic:read Required permission: environment:roles:manage-settings
Returns​
Success. The response contains synthetic related parameters defined for whole tenant.
Code example
import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data =
await syntheticLocationsNodesAndConfigurationClient.getConfiguration();
getLocation​
Gets properties of the specified location
Required scope: environment-api:synthetic:read Required permission: environment:roles:manage-settings
Parameters​
Name | Type | Description |
---|---|---|
config.locationId*required | string | The Dynatrace entity ID of the required location. |
Returns​
Success. The response contains parameters of the synthetic location.
Code example
import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await syntheticLocationsNodesAndConfigurationClient.getLocation({
locationId: "...",
});
getLocationDemploymentApplyCommands​
Gets list of commands to deploy synthetic location in Kubernetes/Openshift cluster | maturity=EARLY_ADOPTER
Required scope: environment-api:synthetic:read Required permission: environment:roles:manage-settings
Parameters​
Name | Type | Description |
---|---|---|
config.filename | string | Filename |
config.namespace | string | Namespace |
config.platform | string | Container platform, currently supported are: KUBERNETES and OPENSHIFT. Default value is KUBERNETES. |
Returns​
Success. The response contains the list of commands that needs to be executed to deploy a synthetic location.
Code example
import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data =
await syntheticLocationsNodesAndConfigurationClient.getLocationDemploymentApplyCommands();
getLocationDemploymentDeleteCommands​
Gets list of commands to delete synthetic location in Kubernetes/Openshift cluster | maturity=EARLY_ADOPTER
Required scope: environment-api:synthetic:read Required permission: environment:roles:manage-settings
Parameters​
Name | Type | Description |
---|---|---|
config.filename | string | Filename |
config.locationId*required | string | The Dynatrace entity ID of the required location. |
config.namespace | string | Namespace |
config.platform | string | Container platform, currently supported are: KUBERNETES and OPENSHIFT. Default value is KUBERNETES. |
Returns​
Success. The response contains the list of commands that needs to be executed to delete a synthetic location.
Code example
import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data =
await syntheticLocationsNodesAndConfigurationClient.getLocationDemploymentDeleteCommands(
{ locationId: "..." }
);
getLocationDemploymentYaml​
Gets yaml file content to deploy location in Kubernetes/Openshift cluster | maturity=EARLY_ADOPTER
Required scope: environment-api:synthetic:read Required permission: environment:roles:manage-settings
Parameters​
Name | Type | Description |
---|---|---|
config.activeGateName | string | Active gate name |
config.locationId*required | string | The Dynatrace entity ID of the required location. |
config.namespace | string | Namespace |
config.platform | string | Container platform, currently supported are: KUBERNETES and OPENSHIFT. Default value is KUBERNETES. |
Returns​
Success. The response contains the content of deployment yaml file.
Code example
import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data =
await syntheticLocationsNodesAndConfigurationClient.getLocationDemploymentYaml(
{ locationId: "..." }
);
getLocations​
Lists all synthetic locations (both public and private) available for your environment
Required scope: environment-api:synthetic:read Required permission: environment:roles:manage-settings
Parameters​
Name | Type | Description |
---|---|---|
config.cloudPlatform | GetLocationsQueryCloudPlatform | Filters the resulting set of locations to those which are hosted on a specific cloud platform. |
config.type | GetLocationsQueryType | Filters the resulting set of locations to those of a specific type. |
Returns​
Success
Code example
import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await syntheticLocationsNodesAndConfigurationClient.getLocations();
getLocationsStatus​
Checks the status of public synthetic locations
Required scope: environment-api:synthetic:read Required permission: environment:roles:manage-settings
Returns​
Success. The response contains the public locations status.
Code example
import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data =
await syntheticLocationsNodesAndConfigurationClient.getLocationsStatus();
getNode​
Lists properties of the specified synthetic node
Required scope: environment-api:synthetic:read Required permission: environment:roles:manage-settings
Parameters​
Name | Type | Description |
---|---|---|
config.nodeId*required | string | The ID of the required synthetic node. |
Returns​
Success
Code example
import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await syntheticLocationsNodesAndConfigurationClient.getNode({
nodeId: "...",
});
getNodes​
Lists all synthetic nodes available in your environment
Required scope: environment-api:synthetic:read Required permission: environment:roles:manage-settings
Returns​
Success
Code example
import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await syntheticLocationsNodesAndConfigurationClient.getNodes();
removeLocation​
Deletes the specified private synthetic location
Required scope: environment-api:synthetic:write Required permission: environment:roles:manage-settings
Parameters​
Name | Type | Description |
---|---|---|
config.locationId*required | string | The Dynatrace entity ID of the private synthetic location to be deleted. |
Code example
import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await syntheticLocationsNodesAndConfigurationClient.removeLocation(
{ locationId: "..." }
);
updateConfiguration​
Updates set of synthetic related parameters defined for whole tenant (affects all monitors and all private locations). | maturity=EARLY_ADOPTER
Required scope: environment-api:synthetic:write Required permission: environment:roles:manage-settings
Parameters​
Name | Type |
---|---|
config.body*required | SyntheticConfigDto |
Returns​
Success. The set of synthetic related parameters has been updated. Response doesn't have a body.
Code example
import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data =
await syntheticLocationsNodesAndConfigurationClient.updateConfiguration({
body: { bmMonitorTimeout: 10, bmStepTimeout: 10 },
});
updateLocation​
Updates the specified synthetic location
Required scope: environment-api:synthetic:write Required permission: environment:roles:manage-settings
For public locations you can only change the location status.
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | SyntheticLocationUpdate | |
config.locationId*required | string | The Dynatrace entity ID of the synthetic location to be updated. |
Code example
import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await syntheticLocationsNodesAndConfigurationClient.updateLocation(
{ locationId: "...", body: {} }
);
updateLocationsStatus​
Changes the status of public synthetic locations
Required scope: environment-api:synthetic:write Required permission: environment:roles:manage-settings
Parameters​
Name | Type |
---|---|
config.body*required | SyntheticPublicLocationsStatus |
Code example
import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data =
await syntheticLocationsNodesAndConfigurationClient.updateLocationsStatus({
body: { publicLocationsEnabled: false },
});
syntheticNetworkAvailabilityMonitorsClient​
import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
createMonitor​
Creates a synthetic monitor definition. Currently network availability monitors only. | maturity=EARLY_ADOPTER
Required scope: environment-api:synthetic-monitors:write Required permission: environment:roles:viewer
Parameters​
Name | Type |
---|---|
config.body*required | SyntheticMultiProtocolMonitorUpdateDto |
Returns​
Success
Code example
import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await syntheticNetworkAvailabilityMonitorsClient.createMonitor({});
deleteMonitor​
Deletes a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
Required scope: environment-api:synthetic-monitors:write Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.monitorId*required | string | The identifier of the monitor. |
Code example
import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await syntheticNetworkAvailabilityMonitorsClient.deleteMonitor({
monitorId: "...",
});
getMonitor​
Gets a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
Required scope: environment-api:synthetic-monitors:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.monitorId*required | string | The identifier of the monitor. |
Returns​
Success
Code example
import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await syntheticNetworkAvailabilityMonitorsClient.getMonitor({
monitorId: "...",
});
getMonitors​
Gets all synthetic monitors. Currently network availability monitors only. | maturity=EARLY_ADOPTER
Required scope: environment-api:synthetic-monitors:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.monitorSelector | string | Defines the scope of the query. Only monitors matching the specified criteria are included into response. You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the OR logic applies.
To set several criteria, separate them with a comma ( |
Returns​
Success
Code example
import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await syntheticNetworkAvailabilityMonitorsClient.getMonitors();
updateMonitor​
Updates a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
Required scope: environment-api:synthetic-monitors:write Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.body*required | SyntheticMultiProtocolMonitorUpdateDto | |
config.monitorId*required | string | The identifier of the monitor. |
Code example
import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await syntheticNetworkAvailabilityMonitorsClient.updateMonitor({
monitorId: "...",
});
syntheticOnDemandMonitorExecutionsClient​
import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";
execute​
Triggers on-demand executions for synthetic monitors
Required scope: environment-api:synthetic-execution:write Required permission: environment:roles:viewer
Parameters​
Name | Type |
---|---|
config.body*required | SyntheticOnDemandExecutionRequest |
Returns​
Success. The monitor's execution response details
Code example
import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await syntheticOnDemandMonitorExecutionsClient.execute({
body: {},
});
getBatch​
Gets summary information and the list of failed executions for the given batch ID
Required scope: environment-api:synthetic-execution:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.batchId*required | number | The batch identifier of the executions. |
Returns​
Success
Code example
import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await syntheticOnDemandMonitorExecutionsClient.getBatch({
batchId: 10,
});
getExecution​
Gets basic results of the specified on-demand execution
Required scope: environment-api:synthetic-execution:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.executionId*required | number | The identifier of the on-demand execution. |
Returns​
Success. The response contains basic information about the on-demand execution.
Code example
import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await syntheticOnDemandMonitorExecutionsClient.getExecution({
executionId: 10,
});
getExecutionFullReport​
Gets detailed results of the specified on-demand execution
Required scope: environment-api:synthetic-execution:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.executionId*required | number | The identifier of the on-demand execution. |
Returns​
Success. The response contains detailed information about the on-demand execution.
Code example
import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data =
await syntheticOnDemandMonitorExecutionsClient.getExecutionFullReport({
executionId: 10,
});
getExecutions​
Gets the list of all on-demand executions of synthetic monitors
Required scope: environment-api:synthetic-execution:read Required permission: environment:roles:viewer
Parameters​
Name | Type | Description |
---|---|---|
config.batchId | number | Filters the resulting set of the executions by batch. Specify the ID of the batch. |
config.dataDeliveryFrom | string | The start of the requested timeframe for data delivering timestamps. You can use one of the following formats:
If not set, the maximum relative timeframe of six hours is used ( |
config.dataDeliveryTo | string | The end of the requested timeframe for data delivering timestamps. You can use one of the following formats:
If not set, the current timestamp is used. |
config.executionFrom | string | The start of the requested timeframe for execution timestamps. You can use one of the following formats:
If not set, the maximum relative timeframe of six hours is used ( |
config.executionStage | GetExecutionsQueryExecutionStage | Filters the resulting set of executions by their stage. |
config.executionTo | string | The end of the requested timeframe for execution timestamps. You can use one of the following formats:
If not set, the current timestamp is used. |
config.locationId | string | Filters the resulting set of the executions by Synthetic location. Specify the ID of the location. |
config.monitorId | string | Filters the resulting set of the executions by monitor synthetic monitor. Specify the ID of the monitor. |
config.schedulingFrom | string | The start of the requested timeframe for scheduling timestamps. You can use one of the following formats:
If not set, the maximum relative timeframe of six hours is used ( |
config.schedulingTo | string | The end of the requested timeframe for scheduling timestamps. You can use one of the following formats:
If not set, the current timestamp is used. |
config.source | GetExecutionsQuerySource | Filters the resulting set of the executions by the source of the triggering request. |
config.userId | string | Filters the resulting set of executions by scheduled user. |
Returns​
Success
Code example
import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";
const data = await syntheticOnDemandMonitorExecutionsClient.getExecutions();
Types​
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 | |
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 | AbstractCredentialsResponseElementScope | |
type*required | AbstractCredentialsResponseElementType |
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 | AbstractSloAlertDtoAlertType |
ActiveGate​
Parameters of the ActiveGate.
Name | Type | Description |
---|---|---|
activeGateTokens | Array<ActiveGateTokenInfoDto> | A list of the ActiveGate tokens. |
autoUpdateSettings | ActiveGateAutoUpdateConfig | |
autoUpdateStatus | ActiveGateAutoUpdateStatus | |
connectedHosts | ActiveGateConnectedHosts | |
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. |
group | string | The group of the ActiveGate. |
hostname | string | The name of the host the ActiveGate is running on. |
id | string | The ID of the ActiveGate. |
loadBalancerAddresses | Array<string> | A list of Load Balancer addresses of the ActiveGate. |
mainEnvironment | string | The ID of the main environment for a multi-environment ActiveGate. |
modules | Array<ActiveGateModule> | A list of modules of the ActiveGate. |
networkAddresses | Array<string> | A list of network addresses of the ActiveGate. |
networkZone | string | The network zone of the ActiveGate. |
offlineSince | number | The timestamp since when the ActiveGate is offline. The |
osArchitecture | ActiveGateOsArchitecture | |
osBitness | _64 | |
osType | ActiveGateOsType | |
type | ActiveGateType | |
version | string | The current version of the ActiveGate in the <major>.<minor>.<revision>.<timestamp> format. |
ActiveGateAutoUpdateConfig​
Configuration of the ActiveGate auto-updates.
Name | Type |
---|---|
effectiveSetting | ActiveGateAutoUpdateConfigEffectiveSetting |
setting*required | ActiveGateAutoUpdateConfigSetting |
ActiveGateConnectedHosts​
Information about hosts currently connected to the ActiveGate
Name | Type | Description |
---|---|---|
number | number | The number of hosts currently connected to the ActiveGate |
ActiveGateGlobalAutoUpdateConfig​
Global configuration of ActiveGates auto-update.
Name | Type |
---|---|
globalSetting*required | ActiveGateGlobalAutoUpdateConfigGlobalSetting |
metadata | ConfigurationMetadata |
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. |
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 | |
enabled | boolean | The module is enabled (true ) or disabled (false ). |
misconfigured | boolean | The module is misconfigured (true ) or not (false ). |
type | ActiveGateModuleType | |
version | string | The version of the ActiveGate module. |
ActiveGateModuleAttributes​
The attributes of the ActiveGate module.
ActiveGateToken​
Metadata of an ActiveGate token.
Name | Type | Description |
---|---|---|
activeGateType*required | ActiveGateTokenActiveGateType | |
creationDate*required | string | The token creation date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z' ). |
expirationDate | string | The token expiration date in ISO 8601 format ( If not set, the token never expires. |
id*required | string | The ActiveGate token identifier, consisting of prefix and public part of the token. |
lastUsedDate | string | The token last used date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z' ). |
name*required | string | The name of the token. |
owner*required | string | The owner of the token. |
seedToken | boolean | The token is a seed token (true ) or an individual token (false ). |
ActiveGateTokenCreate​
Parameters of a new ActiveGate token.
Name | Type | Description |
---|---|---|
activeGateType*required | ActiveGateTokenCreateActiveGateType | |
expirationDate | string | The expiration date of the token. You can use one of the following formats:
If not set, the token never expires. |
name*required | string | The name of the token. |
seedToken | boolean | The token is a seed token ( We recommend the individual token option (false). |
ActiveGateTokenCreated​
The newly created ActiveGate token.
Name | Type | Description |
---|---|---|
expirationDate | string | The token expiration date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z' ). |
id*required | string | The ActiveGate token identifier, consisting of prefix and public part of the token. |
token*required | string | The secret of the token. |
ActiveGateTokenInfoDto​
Information about ActiveGate token.
Name | Type | Description |
---|---|---|
environmentId | string | The environment ID to which the token belongs. Only available if more than one environment is supported. |
id | string | The ActiveGate token identifier, consisting of prefix and public part of the token. |
state | ActiveGateTokenInfoDtoState |
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 Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
pageSize | number | The number of entries per page. |
totalCount*required | number | The total number of entries in the result. |
AddEntityTag​
The custom tag to be added to monitored entities.
Name | Type | Description |
---|---|---|
key*required | string | The key of the custom tag to be added to monitored entities. |
value | string | The value of the custom tag to be added to monitored entities. May be null |
AddEntityTags​
A list of tags to be added to monitored entities.
Name | Type | Description |
---|---|---|
tags*required | Array<AddEntityTag> | A list of tags to be added to monitored entities. |
AddedEntityTags​
A list of custom tags added to monitored entities.
Name | Type | Description |
---|---|---|
appliedTags | Array<METag> | A list of added custom tags. |
matchedEntitiesCount | number | The number of monitored entities where the tags have been added. |
AffectedEntities​
Information about affected entities of an attack.
Name | Type |
---|---|
processGroup | AffectedEntity |
processGroupInstance | AffectedEntity |
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. |
AggregatedLog​
Aggregated log records.
Name | Type |
---|---|
aggregationResult | AggregatedLogAggregationResult |
AggregatedLogAggregationResult​
Aggregated log records.
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 | |
creationDate | string | Token creation date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z' ) |
enabled | boolean | The token is enabled (true ) or disabled (false ). |
expirationDate | string | Token expiration date in ISO 8601 format ( If not set, the token never expires. |
id | string | The ID of the token, consisting of prefix and public part of the token. |
lastUsedDate | string | Token last used date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z' ) |
lastUsedIpAddress | string | Token last used IP address. |
modifiedDate | string | Token last modified date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z' ). Updating scopes or name counts as modification, enabling or disabling a token does not. |
name | string | The name of the token. |
owner | string | The owner of the token. |
personalAccessToken | boolean | The token is a personal access token (true ) or an API token (false ). |
scopes | Array<ApiTokenScopesItem> | 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:
If not set, the token never expires. Ensure that the expiration date is not set in the past. |
name*required | string | The name of the token. |
personalAccessToken | boolean | The token is a personal access token ( Personal access tokens are tied to the permissions of their owner. |
scopes*required | Array<ApiTokenCreateScopesItem> | A list of the scopes to be assigned to the token.
|
ApiTokenCreated​
The newly created token.
Name | Type | Description |
---|---|---|
expirationDate | string | The token expiration date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z' ). |
id | string | The ID of the token, consisting of prefix and public part of the token. |
token | string | The secret of the token. |
ApiTokenList​
A list of API tokens.
Name | Type | Description |
---|---|---|
apiTokens | Array<ApiToken> | A list of API tokens. |
nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
pageSize | number | The number of entries per page. |
totalCount*required | number | The total number of entries in the result. |
ApiTokenSecret​
Name | Type | Description |
---|---|---|
token*required | string | The API token. |
ApiTokenUpdate​
The update of the API token.
Name | Type | Description |
---|---|---|
enabled | boolean | The token is enabled (true ) or disabled (false ) |
name | string | The name of the token. |
scopes | Array<ApiTokenUpdateScopesItem> | 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.
|
ApplicationImpact​
Analysis of problem impact to an application.
Name | Type | Description |
---|---|---|
estimatedAffectedUsers*required | number | The estimated number of affected users. |
impactType*required | ImpactImpactType | |
impactedEntity*required | EntityStub |
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 |
AssetInfo​
Assets types and its count
Name | Type |
---|---|
assetType | string |
count | number |
AssetInfoDto​
Metadata for an extension asset.
Name | Type | Description |
---|---|---|
assetSchemaDetails | AssetSchemaDetailsDto | |
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 | AssetInfoDtoType |
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 | |
attackId | string | The ID of the attack. |
attackTarget | AttackTarget | |
attackType | AttackAttackType | |
attacker | Attacker | |
displayId | string | The display ID of the attack. |
displayName | string | The display name of the attack. |
entrypoint | AttackEntrypoint | |
managementZones | Array<ManagementZone> | A list of management zones which the affected entities belong to. |
request | RequestInformation | |
securityProblem | AttackSecurityProblem | |
state | AttackState | |
technology | AttackTechnology | |
timestamp | number | The timestamp when the attack occurred. |
vulnerability | Vulnerability |
AttackEntrypoint​
Describes the entrypoint used by an attacker to start a specific attack.
Name | Type | Description |
---|---|---|
codeLocation | CodeLocation | |
entrypointFunction | FunctionDefinition | |
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 | |
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 Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
pageSize | number | The number of entries per page. |
totalCount*required | number | The total number of entries in the result. |
AttackRequestHeader​
A header element of the attack's request.
Name | Type | Description |
---|---|---|
name | string | The name of the header element. |
value | string | The value of the header element. |
AttackSecurityProblem​
Assessment information and the ID of a security problem related to an attack.
Name | Type | Description |
---|---|---|
assessment | AttackSecurityProblemAssessmentDto | |
securityProblemId | string | The security problem ID. |
AttackSecurityProblemAssessmentDto​
The assessment of a security problem related to an attack.
Name | Type | Description |
---|---|---|
dataAssets | AttackSecurityProblemAssessmentDtoDataAssets | |
exposure | AttackSecurityProblemAssessmentDtoExposure | |
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 | |
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 Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
pageSize | number | The number of entries per page. |
totalCount*required | number | The total number of entries in the result. |
AuditLogEntry​
An entry of the audit log.
Name | Type | Description |
---|---|---|
category*required | AuditLogEntryCategory | |
entityId | string | The ID of an entity from the category. For example, it can be config ID for the |
environmentId*required | string | The ID of the Dynatrace environment where the recorded operation occurred. |
eventType*required | AuditLogEntryEventType | |
logId*required | string | The ID of the log entry. |
message | string | The logged message. |
patch | AuditLogEntryPatch | |
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 | AuditLogEntryUserType |
AuthorDto​
Extension author
Name | Type | Description |
---|---|---|
name | string | Author name |
AvailabilityEvidence​
The availability evidence of the problem.
Indicates an entity that has been unavailable during the problem lifespan and that might be related to the root cause.
Name | Type | Description |
---|---|---|
displayName*required | string | The display name of the evidence. |
endTime | number | The end time of the evidence, in UTC milliseconds. |
entity*required | EntityStub | |
evidenceType*required | EvidenceEvidenceType | |
groupingEntity | EntityStub | |
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 | ExternalVaultSourceAuthMethod | |
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 |
---|---|
clientId | string |
clientSecret | string |
credentialsUsedForExternalSynchronization | Array<string> |
passwordSecretName | string |
sourceAuthMethod | ExternalVaultConfigSourceAuthMethod |
tenantId | string |
tokenSecretName | string |
type | ExternalVaultConfigType |
usernameSecretName | string |
vaultUrl | string |
BMAction​
Contains detailed information about Browser monitor action.
Name | Type | Description |
---|---|---|
apdexType | string | 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 | ExecutionStepMonitorType | |
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 | string | The type of the action. |
userActionPropertyCount | number | The total number of properties in the action. |
visuallyCompleteTime | number | The amount of time until the page is visually complete, in milliseconds. |
BizEventIngestError​
Name | Type |
---|---|
id | string |
index | number |
message | string |
source | string |
BizEventIngestResult​
Result received after ingesting business events.
Name | Type | Description |
---|---|---|
errors | Array<BizEventIngestError> | A list of business events ingest errors. |
BurnRateAlert​
Parameters of an error budget burn rate alert.
Name | Type | Description |
---|---|---|
alertName*required | string | Name of the alert. |
alertThreshold*required | number | Threshold of the alert. Status alerts trigger if they fall below this value, burn rate alerts trigger if they exceed the value. |
alertType*required | AbstractSloAlertDtoAlertType |
CertificateCredentials​
A credentials set of the CERTIFICATE
type.
Name | Type | Description |
---|---|---|
allowContextlessRequests | boolean | Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope). |
allowedEntities | Array<CredentialAccessData> | The set of entities allowed to use the credential. |
certificate | string | The certificate in the string format. |
certificateFormat | string | The certificate format. |
description | string | A short description of the credentials set. |
id | string | The ID of the credentials set. |
name*required | string | The name of the credentials set. |
ownerAccessOnly | boolean | The credentials set is available to every user (false ) or to owner only (true ). |
password | string | The password of the credential (Base64 encoded). |
scope | CredentialsScope | |
scopes*required | Array<CredentialsScopesItem> | The set of scopes of the credentials set. |
type | CredentialsType |
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 | CodeLevelVulnerabilityDetailsType | |
vulnerabilityLocation | string | The code location of the vulnerability. |
vulnerableFunction | string | The vulnerable function of the vulnerability. |
vulnerableFunctionInput | VulnerableFunctionInput |
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 | |
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 Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
pageSize | number | The number of entries per page. |
totalCount*required | number | The total number of entries in the result. |
ComplexConstraint​
A constraint on the values accepted for a complex settings property.
Name | Type | Description |
---|---|---|
checkAllProperties | boolean | Defines if modification of any property triggers secret resubmission check. |
customMessage | string | A custom message for invalid values. |
customValidatorId | string | The ID of a custom validator. |
maximumPropertyCount | number | The maximum number of properties that can be set. |
minimumPropertyCount | number | The minimum number of properties that must be set. |
properties | Array<string> | A list of properties (defined by IDs) that are used to check the constraint. |
type*required | ComplexConstraintType |
ConfigurationMetadata​
Metadata useful for debugging
Name | Type | Description |
---|---|---|
clusterVersion | string | Dynatrace version. |
configurationVersions | Array<number> | A sorted list of the version numbers of the configuration. |
currentConfigurationVersions | Array<string> | A sorted list of version numbers of the configuration. |
Constraint​
A constraint on the values accepted for a settings property.
Name | Type | Description |
---|---|---|
customMessage | string | A custom message for invalid values. |
customValidatorId | string | The ID of a custom validator. |
maxLength | number | The maximum allowed length of string values. |
maximum | number | The maximum allowed value. |
minLength | number | The minimum required length of string values. |
minimum | number | The minimum allowed value. |
pattern | string | The regular expression pattern for valid string values. |
type*required | ConstraintType | |
uniqueProperties | Array<string> | A list of properties for which the combination of values must be unique. |
ConstraintViolation​
A list of constraint violations
Name | Type |
---|---|
location | string |
message | string |
parameterLocation | ConstraintViolationParameterLocation |
path | string |
CredentialAccessData​
The set of entities allowed to use the credential.
Name | Type |
---|---|
id | string |
type | CredentialAccessDataType |
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 ). |
scope | CredentialsScope | |
scopes*required | Array<CredentialsScopesItem> | The set of scopes of the credentials set. |
type | CredentialsType |
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 | |
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 | AbstractCredentialsResponseElementScope | |
type*required | AbstractCredentialsResponseElementType |
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 | |
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 | AbstractCredentialsResponseElementScope | |
token | string | Plain text token value |
type*required | AbstractCredentialsResponseElementType |
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 | |
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 | AbstractCredentialsResponseElementScope | |
type*required | AbstractCredentialsResponseElementType | |
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 | |
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 | CredentialsResponseElementScope | |
scopes | Array<CredentialsResponseElementScopesItem> | The set of scopes of the credentials set. |
type*required | CredentialsResponseElementType |
CustomApplicationImpact​
Analysis of problem impact to a custom application.
Name | Type | Description |
---|---|---|
estimatedAffectedUsers*required | number | The estimated number of affected users. |
impactType*required | ImpactImpactType | |
impactedEntity*required | EntityStub |
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 If you send a value, the existing values will be overwritten. If you send |
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 |
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 |
properties | CustomDeviceCreationProperties | |
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 |
CustomDeviceCreationProperties​
The list of key-value pair properties that will be shown beneath the infographics of your custom device.
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 |
---|---|
accountName | string |
applicationId | string |
certificate | string |
credentialsUsedForExternalSynchronization | Array<string> |
folderName | string |
passwordSecretName | string |
safeName | string |
sourceAuthMethod | ExternalVaultConfigSourceAuthMethod |
tokenSecretName | string |
type | ExternalVaultConfigType |
usernameSecretName | string |
vaultUrl | string |
CyberArkAllowedLocationDto​
Synchronization credentials with CyberArk Vault using allowed machines (location) authentication method.
Name | Type | Description |
---|---|---|
accountName | string | Account name that stores the username and password to retrieve and synchronize with the Dynatrace Credential Vault: This is NOT the name of the account logged into the CyberArk Central Credential Provider. |
applicationId | string | Application ID connected to CyberArk Vault. |
certificate | string | [Optional] Certificate used for authentication to CyberArk application. ID of certificate credential saved in Dynatrace CV. |
folderName | string | [Optional] Folder name where credentials in CyberArk Vault are stored. Default folder name is 'Root'. |
locationForSynchronizationId | string | Id of a location used by the synchronizing monitor |
passwordSecretName | string | The name of the secret saved in external vault where password is stored. |
safeName | string | Safe name connected to CyberArk Vault. |
sourceAuthMethod | ExternalVaultSourceAuthMethod | |
tokenSecretName | string | The name of the secret saved in external vault where token is stored. |
usernameSecretName | string | The name of the secret saved in external vault where username is stored. |
vaultUrl | string | External vault URL. |
CyberArkUsernamePassword​
Synchronization credentials with CyberArk Vault using username password authentication method.
Name | Type | Description |
---|---|---|
accountName | string | Account name that stores the username and password to retrieve and synchronize with the Dynatrace Credential Vault: This is NOT the name of the account logged into the CyberArk Central Credential Provider. |
applicationId | string | Application ID connected to CyberArk Vault. |
certificate | string | [Optional] Certificate used for authentication to CyberArk application. ID of certificate credential saved in Dynatrace CV. |
folderName | string | [Optional] Folder name where credentials in CyberArk Vault are stored. Default folder name is 'Root'. |
locationForSynchronizationId | string | Id of a location used by the synchronizing monitor |
passwordSecretName | string | The name of the secret saved in external vault where password is stored. |
safeName | string | Safe name connected to CyberArk Vault. |
sourceAuthMethod | ExternalVaultSourceAuthMethod | |
tokenSecretName | string | The name of the secret saved in external vault where token is stored. |
usernamePasswordForCPM | string | Dynatrace credential ID of the username-password pair used for authentication to the CyberArk Central Credential Provider |
usernameSecretName | string | The name of the secret saved in external vault where username is stored. |
vaultUrl | string | External vault URL. |
CyberArkUsernamePasswordConfig​
Configuration for external vault synchronization for username and password credentials.
Name | Type |
---|---|
accountName | string |
applicationId | string |
certificate | string |
credentialsUsedForExternalSynchronization | Array<string> |
folderName | string |
passwordSecretName | string |
safeName | string |
sourceAuthMethod | ExternalVaultConfigSourceAuthMethod |
tokenSecretName | string |
type | ExternalVaultConfigType |
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 | DatasourceDefinitionResetValue | |
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 | |
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 | DavisSecurityAdviceTechnology | |
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 Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
pageSize | number | The number of entries per page. |
totalCount*required | number | The total number of entries in the result. |
DeletedEntityTags​
Deleted custom tag.
Name | Type | Description |
---|---|---|
matchedEntitiesCount | number | The number of monitored entities where the tag has been deleted. |
DeletionConstraint​
A constraint on the values that are going to be deleted.
Name | Type | Description |
---|---|---|
customMessage | string | A custom message for invalid values. |
customValidatorId | string | The ID of a custom validator. |
EffectiveSettingsValue​
An effective settings value.
Name | Type | Description |
---|---|---|
author | string | The user (identified by a user ID or a public token ID) who performed that most recent modification. |
created | number | The timestamp of the creation. |
externalId | string | The external identifier of the settings object. |
modified | number | The timestamp of the last modification. |
origin | string | The origin of the settings value. |
schemaId | string | The schema on which the object is based. |
schemaVersion | string | The version of the schema on which the object is based. |
searchSummary | string | A searchable summary string of the setting value. Plain text without Markdown. |
summary | string | A short summary of settings. This can contain Markdown and will be escaped accordingly. |
value | SettingsValue |
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 Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
pageSize*required | number | The number of entries per page. |
totalCount*required | number | The total number of entries in the result. |
EntitiesList​
A list of monitored entities along with their properties.
Name | Type | Description |
---|---|---|
entities | Array<Entity> | A list of monitored entities. |
nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
pageSize | number | The number of entries per page. |
totalCount*required | number | The total number of entries in the result. |
Entity​
The properties of a monitored entity.
Name | Type | Description |
---|---|---|
displayName | string | The name of the entity, displayed in the UI. |
entityId | string | The ID of the entity. |
firstSeenTms | number | The timestamp at which the entity was first seen, in UTC milliseconds. |
fromRelationships | EntityFromRelationships | |
icon | EntityIcon | |
lastSeenTms | number | The timestamp at which the entity was last seen, in UTC milliseconds. |
managementZones | Array<ManagementZone> | A set of management zones to which the entity belongs. |
properties | EntityProperties | |
tags | Array<METag> | A set of tags assigned to the entity. |
toRelationships | EntityToRelationships | |
type | string | The type of the entity. |
EntityFromRelationships​
A list of relationships where the entity occupies the FROM position.
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.
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 | |
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.
EntityType​
A list of properties of the monitored entity type.
Name | Type | Description |
---|---|---|
dimensionKey | string | The dimension key used within metrics for this monitored entity. |
displayName | string | The display name of the monitored entity. |
entityLimitExceeded | boolean | Whether the entity creation limit for the given type has been exceeded |
fromRelationships | Array<ToPosition> | A list of possible relationships where the monitored entity type occupies the FROM position |
managementZones | string | The placeholder for the list of management zones of an actual entity. |
properties | Array<EntityTypePropertyDto> | A list of additional properties of the monitored entity type. |
tags | string | The placeholder for the list of tags of an actual entity. |
toRelationships | Array<FromPosition> | A list of possible relationships where the monitored entity type occupies the TO position. |
type | string | The type of the monitored entity. |
EntityTypeList​
A list of properties of all available entity types.
Name | Type | Description |
---|---|---|
nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
pageSize | number | The number of entries per page. |
totalCount*required | number | The total number of entries in the result. |
types | Array<EntityType> | The list of meta information for all available entity-types |
EntityTypePropertyDto​
The property of a monitored entity.
Name | Type | Description |
---|---|---|
displayName | string | The display-name of the property. |
id | string | The ID of the property. |
type | string | The type of the property. |
EntryPoint​
Information about an entry point of a code-level vulnerability.
Name | Type | Description |
---|---|---|
sourceHttpPath | string | Source HTTP path of entry points. |
usageSegments | Array<EntryPointUsageSegment> | List of entry point usage segments. |
EntryPointUsageSegment​
Describes one segment that was passed into a usage and the associated source name and type.
Name | Type | Description |
---|---|---|
segmentType | EntryPointUsageSegmentSegmentType | |
segmentValue | string | The value of this input segment. |
sourceArgumentName | string | The name used in the source for this segment. |
sourceType | EntryPointUsageSegmentSourceType |
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 | EntrypointPayloadType | |
value | string | Value of the payload. |
EnumType​
Definition of an enum property.
Name | Type | Description |
---|---|---|
description*required | string | A short description of the property. |
displayName | string | The display name of the property. |
documentation*required | string | An extended description and/or links to documentation. |
enumClass | string | An existing Java enum class that holds the allowed values of the enum. |
items*required | Array<EnumValue> | A list of allowed values of the enum. |
type*required | Enum |
EnumValue​
An allowed value for an enum property.
Name | Type | Description |
---|---|---|
description | string | A short description of the value. |
displayName*required | string | The display name of the value. |
enumInstance | string | The name of the value in an existing Java enum class. |
icon | string | The icon of the value. |
value*required | EnumValueValue |
Error​
Name | Type | Description |
---|---|---|
code | number | The HTTP status code |
constraintViolations | Array<ConstraintViolation> | A list of constraint violations |
message | string | The error message |
ErrorEnvelope​
Name | Type |
---|---|
error | Error |
Event​
Configuration of an event.
Name | Type | Description |
---|---|---|
correlationId | string | The correlation ID of the event. |
endTime | number | The timestamp when the event was closed, in UTC milliseconds. Has the value of |
entityId | EntityStub | |
entityTags | Array<METag> | A list of tags of the related entity. |
eventId | string | The ID of the event. |
eventType | string | The type of the event. |
frequentEvent | boolean | If A frequent event doesn't raise a problem. |
managementZones | Array<ManagementZone> | A list of all management zones that the event belongs to. |
properties | Array<EventProperty> | A list of event properties. |
startTime | number | The timestamp when the event was raised, in UTC milliseconds. |
status | EventStatus | |
suppressAlert | boolean | The alerting status during a maintenance:
|
suppressProblem | boolean | The problem detection status during a maintenance:
|
title | string | The title of the event. |
underMaintenance | boolean | If true , the event happened while the monitored system was under maintenance. |
EventEvidence​
The event evidence of the problem.
An event that occurred during the problem lifespan that might be related to the root cause.
Name | Type | Description |
---|---|---|
data | Event | |
displayName*required | string | The display name of the evidence. |
endTime | number | The end timestamp of the event, in UTC milliseconds. Has |
entity*required | EntityStub | |
eventId | string | The ID of the event. |
eventType | string | The type of the event. |
evidenceType*required | EvidenceEvidenceType | |
groupingEntity | EntityStub | |
rootCauseRelevant*required | boolean | The evidence is (true ) or is not (false ) a part of the root cause. |
startTime*required | number | The start time of the evidence, in UTC milliseconds. |
EventIngest​
The configuration of an event to be ingested.
Name | Type | Description |
---|---|---|
endTime | number | The end time of the event, in UTC milliseconds. If not set, the start time plus timeout is used. |
entitySelector | string | The entity selector, defining a set of Dynatrace entities to be associated with the event. Only entities that have been active within the last 24 hours can be selected. If not set, the event is associated with the environment ( |
eventType*required | EventIngestEventType | |
properties | EventIngestProperties | |
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. |
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.
Keys with prefix dt.*
are generally disallowed, with the exceptions of dt.event.*
, dt.davis.*
and dt.entity.*
. These reserved keys may be used to set event properties with predefined semantics within the Dynatrace product.
dt.entity.*
keys may be used to provide additional information on an event, but will not lead to the event being tied to the specified entities.
All other keys are interpreted as user-defined event properties.
Values of Dynatrace-reserved properties 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.
EventIngestResult​
The result of a created event report.
Name | Type | Description |
---|---|---|
correlationId | string | The correlation ID of the created event. |
status | EventIngestResultStatus |
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 Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
pageSize | number | The number of entries per page. |
totalCount*required | number | The total number of entries in the result. |
warnings | Array<string> | A list of warnings. |
EventPropertiesList​
A list of event properties.
Name | Type | Description |
---|---|---|
eventProperties | Array<EventPropertyDetails> | A list of event properties. |
nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
pageSize | number | The number of entries per page. |
totalCount*required | number | The total number of entries in the result. |
EventProperty​
A property of an event.
Name | Type | Description |
---|---|---|
key | string | The key of the event property. |
value | string | The value of the event property. |
EventPropertyDetails​
Configuration of an event property.
Name | Type | Description |
---|---|---|
description | string | A short description of the event property. |
displayName | string | The display name of the event property. |
key | string | The key of the event property. |
writable | boolean | The property can (true ) or cannot (false ) be set during event ingestion. |
EventType​
Configuration of an event type.
Name | Type | Description |
---|---|---|
description | string | A short description of the event type. |
displayName | string | The display name of the event type. |
severityLevel | EventTypeSeverityLevel | |
type | string | The event type. |
EventTypeList​
A list of event types.
Name | Type | Description |
---|---|---|
eventTypeInfos | Array<EventType> | A list of event types. |
nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
pageSize | number | The number of entries per page. |
totalCount*required | number | The total number of entries in the result. |
Evidence​
An evidence of a root cause.
The actual set of fields depends on the type of the evidence. Find the list of actual objects in the description of the evidenceType field or see Problems API v2 - JSON models.
Name | Type | Description |
---|---|---|
displayName*required | string | The display name of the evidence. |
entity*required | EntityStub | |
evidenceType*required | EvidenceEvidenceType | |
groupingEntity | EntityStub | |
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 |
---|---|
actions | ExecuteActionsDtoActions |
ExecuteActionsDtoActions​
Data Source defined action objects
ExecuteActionsResponse​
Name | Type | Description |
---|---|---|
agName | string | Active Gate name for actions execution |
ExecutionFullResults​
Contains extended monitor's execution details.
Name | Type | Description |
---|---|---|
errorCode | string | Error code. |
executionStepCount | number | Number executed steps. |
executionSteps | Array<ExecutionStep> | Details about the monitor's step execution. |
failedStepName | string | Failed step name. |
failedStepSequenceId | number | Failed step sequence id. |
failureMessage | string | Failure message. |
status | string | Execution status. |
ExecutionSimpleResults​
Contains basic results of the monitor's on-demand execution.
Name | Type | Description |
---|---|---|
chromeError | boolean | Informs whether is Chrome error. |
engineId | number | Synthetic engine id on which monitor was executed. |
errorCode | string | Error code. |
executedSteps | number | Number of the executed steps by Synthetic engine |
failureMessage | string | Failure message. |
hostNameResolutionTime | number | A hostname resolution time measured in milliseconds. |
httperror | boolean | Informs whether is HTTP error. |
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 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 |
---|---|
monitorType*required | ExecutionStepMonitorType |
ExportedLogRecordList​
A list of exported log records.
Name | Type | Description |
---|---|---|
nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
pageSize | number | The number of entries per page. |
results | Array<LogRecord> | A list of retrieved log records. |
totalCount*required | number | The total number of entries in the result. |
Extension​
Name | Type | Description |
---|---|---|
author*required | AuthorDto | |
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 | |
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 |
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. |
ExtensionEnvironmentConfigurationVersion​
Name | Type | Description |
---|---|---|
version*required | string | Extension version |
ExtensionEventDto​
A list of extension events.
Name | Type | Description |
---|---|---|
content | string | Content of the event |
dt.active_gate.id | string | Hexadecimal ID of Active Gate that uses this monitoring configuration. Example: |
dt.entity.host | string | Host that uses this monitoring configuration. Example: |
dt.extension.ds | string | Data source that uses this monitoring configuration. Example: |
severity | string | Severity of the event |
status | ExtensionEventDtoStatus | |
timestamp | string | Timestamp of the event |
ExtensionEventsList​
Name | Type | Description |
---|---|---|
extensionEvents | Array<ExtensionEventDto> | A list of extension events. |
ExtensionFeatureSetsDetails​
Details of feature sets
ExtensionInfo​
A list of extensions with additional metadata.
Name | Type | Description |
---|---|---|
activeVersion | string | Active version in the environment (null if none is active) |
extensionName*required | string | Extension name |
keywords*required | Array<string> | Extension keywords for the highest version |
version*required | string | Highest installed version |
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 Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
pageSize | number | The number of entries per page. |
totalCount*required | number | The total number of entries in the result. |
ExtensionList​
Name | Type | Description |
---|---|---|
extensions*required | Array<MinimalExtension> | A list of extensions. |
nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
pageSize | number | The number of entries per page. |
totalCount*required | number | The total number of entries in the result. |
ExtensionMonitoringConfiguration​
Name | Type | Description |
---|---|---|
objectId*required | string | Configuration id |
scope*required | string | Configuration scope |
value*required | ExtensionMonitoringConfigurationValue |
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 Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
pageSize | number | The number of entries per page. |
totalCount*required | number | The total number of entries in the result. |
ExtensionStatusDto​
Name | Type | Description |
---|---|---|
status*required | ExtensionStatusDtoStatus | |
timestamp*required | 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 | |
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 | |
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 |
ExtensionUploadResponseDtoFeatureSetsDetails​
Details of feature sets
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 | ExternalVaultSourceAuthMethod | |
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 |
---|---|
credentialsUsedForExternalSynchronization | Array<string> |
passwordSecretName | string |
sourceAuthMethod | ExternalVaultConfigSourceAuthMethod |
tokenSecretName | string |
type | ExternalVaultConfigType |
usernameSecretName | string |
vaultUrl | string |
FeatureSetDetails​
Additional information about a Feature Set
Name | Type | Description |
---|---|---|
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 | |
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 | |
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 | FilterType |
FilteredCountsDto​
Statistics about the security problem, filtered by the management zone and timeframe start ('from') query parameters.
Name | Type | Description |
---|---|---|
affectedNodes | number | Number of affected nodes |
affectedProcessGroupInstances | number | Number of affected processes |
affectedProcessGroups | number | Number of affected process groups |
exposedProcessGroups | number | Number of exposed process groups |
reachableDataAssets | number | Number of reachable data assets |
relatedApplications | number | Number of related applications |
relatedAttacks | number | Number of related attacks |
relatedDatabases | number | Number of related databases |
relatedHosts | number | Number of related hosts |
relatedKubernetesClusters | number | Number of related Kubernetes clusters |
relatedKubernetesWorkloads | number | Number of related Kubernetes workloads |
relatedServices | number | Number of related services |
vulnerableComponents | number | Number of vulnerable components |
FromPosition​
The FROM position of a relationship.
Name | Type | Description |
---|---|---|
fromTypes | Array<string> | A list of monitored entity types that can occupy the FROM position. |
id | string | The ID of the relationship. |
FunctionDefinition​
Information about a function definition.
Name | Type | Description |
---|---|---|
className | string | The fully qualified class name of the class that includes the function. |
displayName | string | A human readable string representation of the function definition. |
fileName | string | The file name of the function definition. |
functionName | string | The function/method name of the function definition. |
parameterTypes | TruncatableListString | |
returnType | string | The return type of the function. |
GlobalCountsDto​
Globally calculated statistics about the security problem. No management zone information is taken into account.
Name | Type | Description |
---|---|---|
affectedNodes | number | Number of affected nodes |
affectedProcessGroupInstances | number | Number of affected process group instances |
affectedProcessGroups | number | Number of affected process groups |
exposedProcessGroups | number | Number of exposed process groups |
reachableDataAssets | number | Number of reachable data assets exposed |
relatedApplications | number | Number of related applications |
relatedAttacks | number | Number of attacks on the exposed security problem |
relatedHosts | number | Number of related hosts |
relatedKubernetesClusters | number | Number of related kubernetes cluster |
relatedKubernetesWorkloads | number | Number of related kubernetes workloads |
relatedServices | number | Number of related services |
vulnerableComponents | number | Number of vulnerable components |
HashicorpApprole​
Synchronization credentials with HashiCorp Vault using appRole authentication method
Name | Type | Description |
---|---|---|
locationForSynchronizationId | string | Id of a location used by the synchronizing monitor |
passwordSecretName | string | The name of the secret saved in external vault where password is stored. |
pathToCredentials | string | Path to folder where credentials in HashiCorp Vault are stored. |
roleId | string | Role ID is similar to username when you want to authenticate in HashiCorp Vault using AppRole. |
secretId | string | Secret ID is similar to password when you want to authenticate in HashiCorp Vault using AppRole. ID of token representing secret ID saved in Dynatrace CV. |
sourceAuthMethod | ExternalVaultSourceAuthMethod | |
tokenSecretName | string | The name of the secret saved in external vault where token is stored. |
usernameSecretName | string | The name of the secret saved in external vault where username is stored. |
vaultNamespace | string | Vault namespace in HashiCorp Vault. It is an information you set as environmental variable VAULT_NAMESPACE if you are accessing HashiCorp Vault from command line. |
vaultUrl | string | External vault URL. |
HashicorpApproleConfig​
Configuration for external vault synchronization for username and password credentials.
Name | Type |
---|---|
credentialsUsedForExternalSynchronization | Array<string> |
passwordSecretName | string |
pathToCredentials | string |
roleId | string |
secretId | string |
sourceAuthMethod | ExternalVaultConfigSourceAuthMethod |
tokenSecretName | string |
type | ExternalVaultConfigType |
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 | ExternalVaultSourceAuthMethod | |
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 |
---|---|
certificate | string |
credentialsUsedForExternalSynchronization | Array<string> |
passwordSecretName | string |
pathToCredentials | string |
sourceAuthMethod | ExternalVaultConfigSourceAuthMethod |
tokenSecretName | string |
type | ExternalVaultConfigType |
usernameSecretName | string |
vaultUrl | string |
HttpProtocolDetails​
HTTP specific request details.
Name | Type | Description |
---|---|---|
headers | TruncatableListAttackRequestHeader | |
parameters | TruncatableListHttpRequestParameter | |
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. |
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 | ImpactImpactType | |
impactedEntity*required | EntityStub |
ImpactAnalysis​
A list of all impacts of the problem.
Name | Type | Description |
---|---|---|
impacts*required | Array<Impact> | A list of all impacts of the problem. |
InsertPosition​
The position where the button should be shown relative to a property in the UI
Name | Type | Description |
---|---|---|
after*required | string | The path of a property after which the button should be shown in the UI |
InvalidLine​
Name | Type |
---|---|
error | string |
line | number |
Invocation​
Invocation of a function, e.g. the entitySelector
function.
Name | Type | Description |
---|---|---|
args | Array<string> | Arguments to pass to the function, e.g. entity selector source code. |
function | string | Function that is invoked, e.g. entitySelector . |
Item​
An item of a collection property.
Name | Type | Description |
---|---|---|
constraints | Array<Constraint> | A list of constraints limiting the values to be accepted. |
datasource | DatasourceDefinition | |
description | string | A short description of the item. |
displayName | string | The display name of the item. |
documentation | string | An extended description and/or links to documentation. |
metadata | ItemMetadata | |
referencedType | string | The type referenced by the item's value. |
subType | string | The subtype of the item's value. |
type*required | ItemType | |
uiCustomization | UiCustomization |
ItemMetadata​
Metadata of the items.
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 |
---|---|---|
cloudPlatform | LocationCollectionElementCloudPlatform | |
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 |
name*required | string | The name of the location. |
stage | LocationCollectionElementStage | |
status | LocationCollectionElementStatus | |
type*required | LocationCollectionElementType |
LocationExecutionResults​
Results of the execution HTTP monitor's requests at a given location
Name | Type | Description |
---|---|---|
executionId | string | Execution id. |
locationId | string | Location id. |
requestResults | Array<MonitorRequestExecutionResult> | The list of the monitor's request results executed on this location. |
LogRecord​
A single log record.
Name | Type | Description |
---|---|---|
additionalColumns | LogRecordAdditionalColumns | |
content | string | The content of the log record. |
eventType | LogRecordEventType | |
status | LogRecordStatus | |
timestamp | number | The timestamp of the log record, in UTC milliseconds. |
LogRecordAdditionalColumns​
Additional columns of the log record.
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. |
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 |
key | string | The key of the tag. |
stringRepresentation | string | The string representation of the tag. |
value | string | The value of the tag. |
MaintenanceWindowEvidence​
The maintenance window evidence of the problem.
The maintenance window during which the problem occurred.
Name | Type | Description |
---|---|---|
displayName*required | string | The display name of the evidence. |
endTime | number | The end time of the evidence, in UTC milliseconds. |
entity*required | EntityStub | |
evidenceType*required | EvidenceEvidenceType | |
groupingEntity | EntityStub | |
maintenanceWindowConfigId | string | The ID of the related maintenance window. |
rootCauseRelevant*required | boolean | The evidence is (true ) or is not (false ) a part of the root cause. |
startTime*required | number | The start time of the evidence, in UTC milliseconds. |
ManagementZone​
A short representation of a management zone.
Name | Type | Description |
---|---|---|
id | string | The ID of the management zone. |
name | string | The name of the management zone. |
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 |
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 Applicable only to the |
type*required | MetricDefaultAggregationType |
MetricDescriptor​
The descriptor of a metric.
Name | Type | Description |
---|---|---|
aggregationTypes | Array<MetricDescriptorAggregationTypesItem> | The list of allowed aggregations for this metric. |
billable | boolean | If Metric expressions don't return this field. |
created | number | The timestamp of metric creation. Built-in metrics and metric expressions have the value of |
dduBillable | boolean | If Metric expressions don't return this field. |
defaultAggregation | MetricDefaultAggregation | |
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 ( 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 |
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 | |
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 ( 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 ( |
tags | Array<string> | The tags applied to the metric. Metric expressions don't return this field. |
transformations | Array<MetricDescriptorTransformationsItem> | Transform operators that could be appended to the current transformation list. |
unit | string | The unit of the metric. |
unitDisplayFormat | MetricDescriptorUnitDisplayFormat | |
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 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. |
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 | MetricDimensionDefinitionType |
MetricDto​
Metric gathered by an extension
Name | Type | Description |
---|---|---|
key | string | Metric key |
metadata | MetricMetadataDto |
MetricEvidence​
The metric evidence of the problem.
A change of metric behavior that indicates the problem and/or is its root cause.
Name | Type | Description |
---|---|---|
displayName*required | string | The display name of the evidence. |
endTime | number | The end time of the evidence, in UTC milliseconds. The value |
entity*required | EntityStub | |
evidenceType*required | EvidenceEvidenceType | |
groupingEntity | EntityStub | |
metricId | string | The ID of the metric. |
rootCauseRelevant*required | boolean | The evidence is (true ) or is not (false ) a part of the root cause. |
startTime*required | number | The start time of the evidence, in UTC milliseconds. |
unit | string | The unit of the metric. |
valueAfterChangePoint | number | The metric's value after the problem start. |
valueBeforeChangePoint | number | The metric's value before the problem start. |
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 |
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> | 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 |
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. |
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​
MetricValueType​
The value type for the metric.
Name | Type |
---|---|
type*required | MetricValueTypeType |
MinimalExtension​
A list of extensions.
Name | Type | Description |
---|---|---|
extensionName*required | string | Extension name |
version*required | string | Extension version |
MobileImpact​
Analysis of problem impact to a mobile application.
Name | Type | Description |
---|---|---|
estimatedAffectedUsers*required | number | The estimated number of affected users. |
impactType*required | ImpactImpactType | |
impactedEntity*required | EntityStub |
ModificationInfo​
The modification info for a single updatable setting.
Name | Type | Description |
---|---|---|
deletable | 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 | boolean | If settings value can be modified |
modifiablePaths | Array<string> | Property paths which are modifiable, regardless of the state of modifiable |
movable | boolean | If settings value can be moved/reordered. Only applicable for ordered list schema |
nonModifiablePaths | Array<string> | Property paths which are not modifiable, when modifiable is true |
MonitorEntityIdDto​
A DTO for monitor entity ID.
Name | Type | Description |
---|---|---|
entityId*required | string | Monitor entity ID. |
MonitorExecutionResults​
Results of the execution of all HTTP monitor's requests.
Name | Type | Description |
---|---|---|
locationsExecutionResults | Array<LocationExecutionResults> | The list with the results of the requests executed on assigned locations. |
monitorId | string | Monitor id. |
MonitorRequestExecutionResult​
A result of the execution HTTP monitor's request.
Name | Type | Description |
---|---|---|
cloudPlatform | string | Cloud platform of the location. |
customLogs | Array<CustomLogLine> | Custom log messages. |
engineId | number | VUC's id on which monitor's request was executed. |
failureMessage | string | Request's failure message. |
healthStatus | string | Request's health status. |
healthStatusCode | number | Request's health status code. |
hostNameResolutionTime | number | A hostname resolution time measured in ms. |
method | string | Request method type. |
monitorType*required | ExecutionStepMonitorType | |
peerCertificateDetails | string | Request's certificate details. |
peerCertificateExpiryDate | number | An expiry date of the first SSL certificate from the certificate chain. |
publicLocation | boolean | Flag informs whether request was executed on public location. |
redirectionTime | number | Total number of milliseconds spent on handling all redirect requests, measured in ms. |
redirectsCount | number | Number of request's redirects. |
requestBody | string | Request's request body. |
requestHeaders | Array<MonitorRequestHeader> | A list of request's headers |
requestId | string | Request id. |
requestName | string | Request name. |
resolvedIps | Array<string> | Request's resolved ips.' |
responseBody | string | Request's response body. |
responseBodySizeLimitExceeded | boolean | A flag indicating that the response payload size limit of 10MB has been exceeded. |
responseHeaders | Array<MonitorRequestHeader> | A list of request's response headers |
responseMessage | string | Request's response message.' |
responseSize | number | Request's response size in bytes. |
responseStatusCode | number | Request's response status code. |
sequenceNumber | number | Request's sequence number. |
startTimestamp | number | Request start timestamp. |
tcpConnectTime | number | A TCP connect time measured in ms. |
timeToFirstByte | number | A time to first byte measured in ms. |
tlsHandshakeTime | number | A TLS handshake time measured in ms. |
totalTime | number | A total request time measured in ms. |
url | string | Request URL address. |
waitingTime | number | Waiting time (time to first byte - (DNS lookup time + TCP connect time + TLS handshake time), measured in ms. |
MonitorRequestHeader​
A header of the Http request
Name | Type | Description |
---|---|---|
name | string | Header's name. |
value | string | Header's value. |
MonitoredEntityStateParam​
Key-value parameter of the monitoring state.
Name | Type | Description |
---|---|---|
key | string | The key of the monitoring state paramter. |
values | string | The value of the monitoring state paramter. |
MonitoredEntityStates​
Monitoring state of the process group instance.
Name | Type | Description |
---|---|---|
entityId | string | The Dynatrace entity ID of the process group instance. |
params | Array<MonitoredEntityStateParam> | Additional parameters of the monitoring state. |
severity | MonitoredEntityStatesSeverity | |
state | MonitoredEntityStatesState |
MonitoredStates​
A list of entities and their monitoring states.
Name | Type | Description |
---|---|---|
monitoringStates | Array<MonitoredEntityStates> | A list of process group instances and their monitoring states. |
nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
pageSize | number | The number of entries per page. |
totalCount | number | The total number of entities in the response. |
MonitoringConfigurationDto​
Name | Type | Description |
---|---|---|
scope*required | string | The scope this monitoring configuration will be defined for |
value | JsonNode |
MonitoringConfigurationResponse​
Name | Type | Description |
---|---|---|
code*required | number | The HTTP Status code |
objectId*required | string | The identifier of the new configuration |
MonitoringConfigurationUpdateDto​
Name | Type |
---|---|
value | JsonNode |
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 | MuteStateReason | |
user | string | The user who has muted or unmuted the problem. |
NetworkZone​
Configuration of a network zone.
Name | Type | Description |
---|---|---|
alternativeZones | Array<string> | A list of alternative network zones. |
description | string | A short description of the network zone. |
fallbackMode | NetworkZoneFallbackMode | |
id | string | The ID of the network zone. |
numOfConfiguredActiveGates | number | The number of ActiveGates in the network zone. |
numOfConfiguredOneAgents | number | The number of OneAgents that are configured to use the network zone as primary. |
numOfOneAgentsFromOtherZones | number | The number of OneAgents from other network zones that are using ActiveGates in the network zone. This is a fraction of numOfOneAgentsUsing. One possible reason for switching to another zone is that a firewall is preventing a OneAgent from connecting to any ActiveGate in the preferred network zone. |
numOfOneAgentsUsing | number | The number of OneAgents that are using ActiveGates in the network zone. |
overridesGlobal | boolean | Indicates if a global network zone is overridden (managed only). |
scope | string | Specifies the scope of the network zone (managed only). |
NetworkZoneConnectionStatistics​
Runtime information about host connections.
Name | Type | Description |
---|---|---|
hostsConfiguredButNotConnected | Array<string> | Hosts from the network zone that use other zones. |
hostsConnectedAsAlternative | Array<string> | Hosts that use the network zone as an alternative. |
hostsConnectedAsFailover | Array<string> | Hosts from other zones that use the zone (not configured as an alternative) even though ActiveGates of higher priority are available. |
hostsConnectedAsFailoverWithoutActiveGates | Array<string> | Hosts from other zones that use the zone (not configured as an alternative) and no ActiveGates of higher priority are available. |
NetworkZoneList​
A list of network zones.
Name | Type | Description |
---|---|---|
networkZones*required | Array<NetworkZone> | A list of network zones. |
NetworkZoneSettings​
Global network zone configuration.
Name | Type | Description |
---|---|---|
networkZonesEnabled | boolean | Network zones feature is enabled (true ) or disabled (false ). |
Node​
Configuration of a synthetic node.
A synthetic node is an ActiveGate that is able to execute synthetic monitors.
Name | Type | Description |
---|---|---|
activeGateVersion*required | string | The version of the Active Gate. |
autoUpdateEnabled*required | boolean | The Active Gate has the Auto update option enabled ('true') or not ('false') |
browserMonitorsEnabled*required | boolean | The synthetic node is able to execute browser monitors (true ) or not (false ). |
browserType*required | string | The browser type. |
browserVersion*required | string | The browser version. |
entityId*required | string | The ID of the synthetic node. |
healthCheckStatus*required | string | The health check status of the synthetic node. |
hostname*required | string | The hostname of the synthetic node. |
ips*required | Array<string> | The IP of the synthetic node. |
oneAgentRoutingEnabled*required | boolean | The Active Gate has the One Agent routing enabled ('true') or not ('false'). |
operatingSystem*required | string | The Active Gate's host operating system. |
playerVersion*required | string | The version of the synthetic player. |
status*required | string | The status of the synthetic node. |
version*required | string | The version of the synthetic node. |