@dynatrace-sdk/client-classic-environment-v2 1.13.2 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/README.md +477 -132
- package/cjs/index.js +1738 -936
- package/esm/index.js +1660 -850
- package/package.json +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/credential-vault-api.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/index.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-management-zones-api.d.ts +38 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-privacy-operations-sync-api-api.d.ts +64 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-schemas-api.d.ts +10 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-network-availability-monitors-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token-create.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create-scopes-item.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-scopes-item.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update-scopes-item.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-category.d.ts +1 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-event-type.d.ts +0 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-response-element-scope.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-response-element-scopes-item.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-scope.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-scopes-item.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/davis-security-advice-technology.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-locations-query-capability.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/get-locations-query-capability.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +20 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.d.ts +8 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/management-zone-details.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/management-zone-details.transformation.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/paginated-personal-data-response-data.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/paginated-personal-data-response-data.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/paginated-personal-data-response.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/paginated-personal-data-response.transformation.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/personal-data-request.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/personal-data-request.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/pii-relationships-item.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/pii-relationships-item.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/pii.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/pii.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-stub.d.ts +11 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-stub.transformation.d.ts +5 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/schema.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/schema.transformation.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-details-technology.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-technology.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-by-object-id-response.d.ts +70 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-by-object-id-response.transformation.d.ts +20 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.d.ts +8 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.transformation.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-triggering-problem-details.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-triggering-problem-details.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/value.d.ts +15 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/value.transformation.d.ts +9 -0
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @dynatrace-sdk/client-classic-environment-v2
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/2.0.0)
|
|
4
4
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
5
5
|
|
|
6
6
|
|
|
@@ -1865,7 +1865,7 @@ import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment
|
|
|
1865
1865
|
const data = await credentialVaultClient.createCredentials({
|
|
1866
1866
|
body: {
|
|
1867
1867
|
name: "...",
|
|
1868
|
-
scopes: [CredentialsScopesItem.
|
|
1868
|
+
scopes: [CredentialsScopesItem.AppEngine],
|
|
1869
1869
|
},
|
|
1870
1870
|
});
|
|
1871
1871
|
```
|
|
@@ -2139,7 +2139,7 @@ const data = await credentialVaultClient.updateCredentials({
|
|
|
2139
2139
|
id: "...",
|
|
2140
2140
|
body: {
|
|
2141
2141
|
name: "...",
|
|
2142
|
-
scopes: [CredentialsScopesItem.
|
|
2142
|
+
scopes: [CredentialsScopesItem.AppEngine],
|
|
2143
2143
|
},
|
|
2144
2144
|
});
|
|
2145
2145
|
```
|
|
@@ -7617,6 +7617,71 @@ const data =
|
|
|
7617
7617
|
|
|
7618
7618
|
|
|
7619
7619
|
|
|
7620
|
+
</div>
|
|
7621
|
+
|
|
7622
|
+
## settingsManagementZonesClient
|
|
7623
|
+
|
|
7624
|
+
```js
|
|
7625
|
+
import { settingsManagementZonesClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
7626
|
+
```
|
|
7627
|
+
|
|
7628
|
+
|
|
7629
|
+
<a name="getmanagementzonedetails"></a>
|
|
7630
|
+
### getManagementZoneDetails
|
|
7631
|
+
|
|
7632
|
+
<div class="padding-bottom--md">
|
|
7633
|
+
<strong>settingsManagementZonesClient.getManagementZoneDetails(config): Promise<<a href="#managementzonedetails">ManagementZoneDetails</a>></strong>
|
|
7634
|
+
|
|
7635
|
+
<div class="padding-left--md">
|
|
7636
|
+
|
|
7637
|
+
Reads management zone details.
|
|
7638
|
+
|
|
7639
|
+
**Required scope:** settings:objects:read
|
|
7640
|
+
**One of the following permissions is required:**
|
|
7641
|
+
+ environment:roles:manage-settings
|
|
7642
|
+
+ settings:objects:read
|
|
7643
|
+
|
|
7644
|
+
|
|
7645
|
+
|
|
7646
|
+
Allows to convert from an objectId to the ID of the management zone, and can serve as a replacement for the old config endpoint for that purpose.
|
|
7647
|
+
|
|
7648
|
+
|
|
7649
|
+
|
|
7650
|
+
</div>
|
|
7651
|
+
|
|
7652
|
+
|
|
7653
|
+
#### Parameters
|
|
7654
|
+
|
|
7655
|
+
| Name | Type | Description |
|
|
7656
|
+
| --- | --- | --- |
|
|
7657
|
+
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
7658
|
+
|
|
7659
|
+
|
|
7660
|
+
|
|
7661
|
+
|
|
7662
|
+
#### Returns
|
|
7663
|
+
|
|
7664
|
+
Success
|
|
7665
|
+
|
|
7666
|
+
|
|
7667
|
+
<details>
|
|
7668
|
+
<summary>
|
|
7669
|
+
Code example
|
|
7670
|
+
</summary>
|
|
7671
|
+
|
|
7672
|
+
```ts
|
|
7673
|
+
import { settingsManagementZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
7674
|
+
|
|
7675
|
+
const data =
|
|
7676
|
+
await settingsManagementZonesClient.getManagementZoneDetails(
|
|
7677
|
+
{ objectId: "..." },
|
|
7678
|
+
);
|
|
7679
|
+
```
|
|
7680
|
+
|
|
7681
|
+
</details>
|
|
7682
|
+
|
|
7683
|
+
|
|
7684
|
+
|
|
7620
7685
|
</div>
|
|
7621
7686
|
|
|
7622
7687
|
## settingsObjectsClient
|
|
@@ -7682,7 +7747,7 @@ const data =
|
|
|
7682
7747
|
### getEffectiveSettingsValues
|
|
7683
7748
|
|
|
7684
7749
|
<div class="padding-bottom--md">
|
|
7685
|
-
<strong>settingsObjectsClient.getEffectiveSettingsValues(config): Promise<<a href="#effectivesettingsvalueslist">EffectiveSettingsValuesList</a>></strong>
|
|
7750
|
+
<strong>settingsObjectsClient.getEffectiveSettingsValues(config): Promise<<a href="#effectivesettingsvalueslist" target="_blank" rel="noopener noreferrer">EffectiveSettingsValuesList</a>></strong>
|
|
7686
7751
|
|
|
7687
7752
|
<div class="padding-left--md">
|
|
7688
7753
|
|
|
@@ -7747,7 +7812,7 @@ const data =
|
|
|
7747
7812
|
### getSettingsObjectByObjectId
|
|
7748
7813
|
|
|
7749
7814
|
<div class="padding-bottom--md">
|
|
7750
|
-
<strong>settingsObjectsClient.getSettingsObjectByObjectId(config): Promise<<a href="#
|
|
7815
|
+
<strong>settingsObjectsClient.getSettingsObjectByObjectId(config): Promise<<a href="#settingsobjectbyobjectidresponse">SettingsObjectByObjectIdResponse</a>></strong>
|
|
7751
7816
|
|
|
7752
7817
|
<div class="padding-left--md">
|
|
7753
7818
|
|
|
@@ -7802,7 +7867,7 @@ const data =
|
|
|
7802
7867
|
### getSettingsObjects
|
|
7803
7868
|
|
|
7804
7869
|
<div class="padding-bottom--md">
|
|
7805
|
-
<strong>settingsObjectsClient.getSettingsObjects(config): Promise<<a href="#objectslist">ObjectsList</a>></strong>
|
|
7870
|
+
<strong>settingsObjectsClient.getSettingsObjects(config): Promise<<a href="#objectslist" target="_blank" rel="noopener noreferrer">ObjectsList</a>></strong>
|
|
7806
7871
|
|
|
7807
7872
|
<div class="padding-left--md">
|
|
7808
7873
|
|
|
@@ -7870,7 +7935,7 @@ const data =
|
|
|
7870
7935
|
### postSettingsObjects
|
|
7871
7936
|
|
|
7872
7937
|
<div class="padding-bottom--md">
|
|
7873
|
-
<strong>settingsObjectsClient.postSettingsObjects(config): Promise<Array<<a href="#settingsobjectresponse"
|
|
7938
|
+
<strong>settingsObjectsClient.postSettingsObjects(config): Promise<Array<<a href="#settingsobjectresponse">SettingsObjectResponse</a>>></strong>
|
|
7874
7939
|
|
|
7875
7940
|
<div class="padding-left--md">
|
|
7876
7941
|
|
|
@@ -7894,7 +7959,7 @@ You can upload several objects at once. In that case each object returns its own
|
|
|
7894
7959
|
|
|
7895
7960
|
| Name | Type | Description |
|
|
7896
7961
|
| --- | --- | --- |
|
|
7897
|
-
|config.body<sup>*required</sup>|Array<<a href="#settingsobjectcreate">SettingsObjectCreate</a>>| |
|
|
7962
|
+
|config.body<sup>*required</sup>|Array<<a href="#settingsobjectcreate" target="_blank" rel="noopener noreferrer">SettingsObjectCreate</a>>| |
|
|
7898
7963
|
|config.validateOnly|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code>, the request runs only validation of the submitted settings objects, without saving them. |
|
|
7899
7964
|
|
|
7900
7965
|
|
|
@@ -7937,7 +8002,7 @@ const data =
|
|
|
7937
8002
|
### putSettingsObjectByObjectId
|
|
7938
8003
|
|
|
7939
8004
|
<div class="padding-bottom--md">
|
|
7940
|
-
<strong>settingsObjectsClient.putSettingsObjectByObjectId(config): Promise<<a href="#settingsobjectresponse"
|
|
8005
|
+
<strong>settingsObjectsClient.putSettingsObjectByObjectId(config): Promise<<a href="#settingsobjectresponse">SettingsObjectResponse</a>></strong>
|
|
7941
8006
|
|
|
7942
8007
|
<div class="padding-left--md">
|
|
7943
8008
|
|
|
@@ -7963,7 +8028,7 @@ Some schemas don't allow passing of the masked secret. In that case you nee
|
|
|
7963
8028
|
|
|
7964
8029
|
| Name | Type | Description |
|
|
7965
8030
|
| --- | --- | --- |
|
|
7966
|
-
|config.body<sup>*required</sup>|<a href="#settingsobjectupdate">SettingsObjectUpdate</a>| |
|
|
8031
|
+
|config.body<sup>*required</sup>|<a href="#settingsobjectupdate" target="_blank" rel="noopener noreferrer">SettingsObjectUpdate</a>| |
|
|
7967
8032
|
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
7968
8033
|
|config.validateOnly|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code>, the request runs only validation of the submitted settings object, without saving it. |
|
|
7969
8034
|
|
|
@@ -7994,6 +8059,128 @@ const data =
|
|
|
7994
8059
|
|
|
7995
8060
|
|
|
7996
8061
|
|
|
8062
|
+
</div>
|
|
8063
|
+
|
|
8064
|
+
## settingsPrivacyOperationsSyncApiClient
|
|
8065
|
+
|
|
8066
|
+
```js
|
|
8067
|
+
import { settingsPrivacyOperationsSyncApiClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
8068
|
+
```
|
|
8069
|
+
|
|
8070
|
+
|
|
8071
|
+
<a name="deletepersonaldatasync"></a>
|
|
8072
|
+
### deletePersonalDataSync
|
|
8073
|
+
|
|
8074
|
+
<div class="padding-bottom--md">
|
|
8075
|
+
<strong>settingsPrivacyOperationsSyncApiClient.deletePersonalDataSync(config): Promise<void></strong>
|
|
8076
|
+
|
|
8077
|
+
<div class="padding-left--md">
|
|
8078
|
+
|
|
8079
|
+
Delete all internal personal data the Settings 2.0 Platform stores for the specified user
|
|
8080
|
+
|
|
8081
|
+
**Required scope:** settings:operations.privacy:write
|
|
8082
|
+
**Required permission:** settings:operations.privacy:write
|
|
8083
|
+
|
|
8084
|
+
|
|
8085
|
+
|
|
8086
|
+
</div>
|
|
8087
|
+
|
|
8088
|
+
|
|
8089
|
+
#### Parameters
|
|
8090
|
+
|
|
8091
|
+
| Name | Type |
|
|
8092
|
+
| --- | --- |
|
|
8093
|
+
|config.body<sup>*required</sup>|<a href="#personaldatarequest">PersonalDataRequest</a>|
|
|
8094
|
+
|
|
8095
|
+
|
|
8096
|
+
|
|
8097
|
+
|
|
8098
|
+
|
|
8099
|
+
<details>
|
|
8100
|
+
<summary>
|
|
8101
|
+
Code example
|
|
8102
|
+
</summary>
|
|
8103
|
+
|
|
8104
|
+
```ts
|
|
8105
|
+
import { settingsPrivacyOperationsSyncApiClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
8106
|
+
|
|
8107
|
+
const data =
|
|
8108
|
+
await settingsPrivacyOperationsSyncApiClient.deletePersonalDataSync(
|
|
8109
|
+
{
|
|
8110
|
+
body: {
|
|
8111
|
+
email: "user@foo.com",
|
|
8112
|
+
userId: "da7d78b7-4e94-46d4-b76d-934eff92af9a",
|
|
8113
|
+
},
|
|
8114
|
+
},
|
|
8115
|
+
);
|
|
8116
|
+
```
|
|
8117
|
+
|
|
8118
|
+
</details>
|
|
8119
|
+
|
|
8120
|
+
|
|
8121
|
+
|
|
8122
|
+
</div>
|
|
8123
|
+
|
|
8124
|
+
|
|
8125
|
+
<a name="exportpersonaldatasync"></a>
|
|
8126
|
+
### exportPersonalDataSync
|
|
8127
|
+
|
|
8128
|
+
<div class="padding-bottom--md">
|
|
8129
|
+
<strong>settingsPrivacyOperationsSyncApiClient.exportPersonalDataSync(config): Promise<<a href="#paginatedpersonaldataresponse" target="_blank" rel="noopener noreferrer">PaginatedPersonalDataResponse</a>></strong>
|
|
8130
|
+
|
|
8131
|
+
<div class="padding-left--md">
|
|
8132
|
+
|
|
8133
|
+
Export all internal personal data the Settings 2.0 Platform stores for the specified user
|
|
8134
|
+
|
|
8135
|
+
**Required scope:** settings:operations.privacy:read
|
|
8136
|
+
**Required permission:** settings:operations.privacy:read
|
|
8137
|
+
|
|
8138
|
+
Export all internal personal data the Settings 2.0 Platform stores for the specified user in a paged response.
|
|
8139
|
+
The amount of elements in a single response page is limited to 100.
|
|
8140
|
+
|
|
8141
|
+
|
|
8142
|
+
|
|
8143
|
+
</div>
|
|
8144
|
+
|
|
8145
|
+
|
|
8146
|
+
#### Parameters
|
|
8147
|
+
|
|
8148
|
+
| Name | Type | Description |
|
|
8149
|
+
| --- | --- | --- |
|
|
8150
|
+
|config.body<sup>*required</sup>|<a href="#personaldatarequest">PersonalDataRequest</a>| |
|
|
8151
|
+
|config.pageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The page to retrieve (optional; if not set, a PersonalDataRequestDto must be provided and the first page of data will be returned) |
|
|
8152
|
+
|
|
8153
|
+
|
|
8154
|
+
|
|
8155
|
+
|
|
8156
|
+
#### Returns
|
|
8157
|
+
|
|
8158
|
+
Success
|
|
8159
|
+
|
|
8160
|
+
|
|
8161
|
+
<details>
|
|
8162
|
+
<summary>
|
|
8163
|
+
Code example
|
|
8164
|
+
</summary>
|
|
8165
|
+
|
|
8166
|
+
```ts
|
|
8167
|
+
import { settingsPrivacyOperationsSyncApiClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
8168
|
+
|
|
8169
|
+
const data =
|
|
8170
|
+
await settingsPrivacyOperationsSyncApiClient.exportPersonalDataSync(
|
|
8171
|
+
{
|
|
8172
|
+
body: {
|
|
8173
|
+
email: "user@foo.com",
|
|
8174
|
+
userId: "da7d78b7-4e94-46d4-b76d-934eff92af9a",
|
|
8175
|
+
},
|
|
8176
|
+
},
|
|
8177
|
+
);
|
|
8178
|
+
```
|
|
8179
|
+
|
|
8180
|
+
</details>
|
|
8181
|
+
|
|
8182
|
+
|
|
8183
|
+
|
|
7997
8184
|
</div>
|
|
7998
8185
|
|
|
7999
8186
|
## settingsSchemasClient
|
|
@@ -8007,7 +8194,7 @@ import { settingsSchemasClient } from '@dynatrace-sdk/client-classic-environment
|
|
|
8007
8194
|
### getAvailableSchemaDefinitions
|
|
8008
8195
|
|
|
8009
8196
|
<div class="padding-bottom--md">
|
|
8010
|
-
<strong>settingsSchemasClient.getAvailableSchemaDefinitions(
|
|
8197
|
+
<strong>settingsSchemasClient.getAvailableSchemaDefinitions(config): Promise<<a href="#schemalist" target="_blank" rel="noopener noreferrer">SchemaList</a>></strong>
|
|
8011
8198
|
|
|
8012
8199
|
<div class="padding-left--md">
|
|
8013
8200
|
|
|
@@ -8023,6 +8210,14 @@ Lists available settings schemas
|
|
|
8023
8210
|
</div>
|
|
8024
8211
|
|
|
8025
8212
|
|
|
8213
|
+
#### Parameters
|
|
8214
|
+
|
|
8215
|
+
| Name | Type | Description |
|
|
8216
|
+
| --- | --- | --- |
|
|
8217
|
+
|config.fields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>A list of fields to be included to the response. The provided set of fields replaces the default set.</p> <p>Specify the required top-level fields, separated by commas (for example, <code>schemaId,displayName</code>).</p> <p>Supported fields: <code>schemaId</code>, <code>displayName</code>, <code>latestSchemaVersion</code>, <code>multiObject</code>, <code>ordered</code>.</p> |
|
|
8218
|
+
|
|
8219
|
+
|
|
8220
|
+
|
|
8026
8221
|
|
|
8027
8222
|
#### Returns
|
|
8028
8223
|
|
|
@@ -8513,6 +8708,7 @@ Lists all synthetic locations (both public and private) available for your envir
|
|
|
8513
8708
|
|
|
8514
8709
|
| Name | Type | Description |
|
|
8515
8710
|
| --- | --- | --- |
|
|
8711
|
+
|config.capability|GetLocationsQueryCapability|Filters the resulting set of locations to those which support specific capability. |
|
|
8516
8712
|
|config.cloudPlatform|GetLocationsQueryCloudPlatform|Filters the resulting set of locations to those which are hosted on a specific cloud platform. |
|
|
8517
8713
|
|config.type|GetLocationsQueryType|Filters the resulting set of locations to those of a specific type. |
|
|
8518
8714
|
|
|
@@ -9068,7 +9264,7 @@ Gets all synthetic monitors. Currently network availability monitors only. | mat
|
|
|
9068
9264
|
|
|
9069
9265
|
| Name | Type | Description |
|
|
9070
9266
|
| --- | --- | --- |
|
|
9071
|
-
|config.monitorSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only monitors matching the specified criteria are included into response.</p> <p>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 <strong>OR</strong> logic applies.</p> <ul> <li>Monitor type: <code>type(HTTP,MULTI_PROTOCOL)</code>. Possible values: 'HTTP', 'BROWSER', 'THIRD_PARTY', 'MULTI_PROTOCOL' (Note that only 'MULTI_PROTOCOL' is currently supported).</li> <li>Management zone ID: <code>managementZoneId(1, 2)</code>.</li> <li>Synthetic Location ME ID: <code>location(SYNTHETIC_LOCATION-123)</code>.</li> <li>Monitored host ME ID: <code>monitoredEntity(HOST-123)</code>.</li> <li>Monitor tags: <code>tag([context]key:value,key:value,key)</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>key</code> formats are detected and parsed automatically. If a key-only tag has a colon (<code>:</code>) in it, you must escape the colon with a backslash(<code>\\</code>). Otherwise, the tag will be parsed as a <code>key:value tag</code>. All tag values are case-sensitive.</li> <li>Monitor
|
|
9267
|
+
|config.monitorSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only monitors matching the specified criteria are included into response.</p> <p>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 <strong>OR</strong> logic applies.</p> <ul> <li>Monitor type: <code>type(HTTP,MULTI_PROTOCOL)</code>. Possible values: 'HTTP', 'BROWSER', 'THIRD_PARTY', 'MULTI_PROTOCOL' (Note that only 'MULTI_PROTOCOL' is currently supported).</li> <li>Management zone ID: <code>managementZoneId(1, 2)</code>.</li> <li>Synthetic Location ME ID: <code>location(SYNTHETIC_LOCATION-123)</code>.</li> <li>Monitored host ME ID: <code>monitoredEntity(HOST-123)</code>.</li> <li>Monitor tags: <code>tag([context]key:value,key:value,key)</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>key</code> formats are detected and parsed automatically. If a key-only tag has a colon (<code>:</code>) in it, you must escape the colon with a backslash(<code>\\</code>). Otherwise, the tag will be parsed as a <code>key:value tag</code>. All tag values are case-sensitive.</li> <li>Monitor enablement: <code>enabled(true)</code>.</li> </ul> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> |
|
|
9072
9268
|
|
|
9073
9269
|
|
|
9074
9270
|
|
|
@@ -9622,7 +9818,7 @@ Parameters of a new ActiveGate token.
|
|
|
9622
9818
|
| Name | Type | Description |
|
|
9623
9819
|
| --- | --- | --- |
|
|
9624
9820
|
|activeGateType<sup>*required</sup>|ActiveGateTokenCreateActiveGateType| |
|
|
9625
|
-
|expirationDate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The expiration date of the token.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the token never expires.</p> |
|
|
9821
|
+
|expirationDate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The expiration date of the token.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the token never expires.</p> <p>Ensure that it is not set in the past and does not exceed <code>2 years</code> from the moment of creation."</p> |
|
|
9626
9822
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the token. |
|
|
9627
9823
|
|seedToken|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>The token is a seed token (<code>true</code>) or an individual token (<code>false</code>).</p> <p>We recommend the individual token option (false).</p> |
|
|
9628
9824
|
|
|
@@ -9789,7 +9985,7 @@ Parameters of a new API token.
|
|
|
9789
9985
|
|expirationDate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The expiration date of the token.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the token never expires. Ensure that the expiration date is not set in the past.</p> |
|
|
9790
9986
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the token. |
|
|
9791
9987
|
|personalAccessToken|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>The token is a personal access token (<code>true</code>) or an API token (<code>false</code>).</p> <p>Personal access tokens are tied to the permissions of their owner.</p> |
|
|
9792
|
-
|scopes<sup>*required</sup>|Array<ApiTokenCreateScopesItem>|<p>A list of the scopes to be assigned to the token.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>openpipeline.events</code>: OpenPipeline - Ingest Events.</li> <li><code>openpipeline.events.custom</code>: OpenPipeline - Ingest Events (Custom).</li> <li><code>openpipeline.events_security</code>: OpenPipeline - Ingest Events, Application Security.</li> <li><code>openpipeline.events_security.custom</code>: OpenPipeline - Ingest Events, Application Security (Custom).</li> <li><code>bizevents.ingest</code>: Ingest bizevents.</li> <li><code>analyzers.read</code>: Read analyzers.</li> <li><code>analyzers.write</code>: Write & execute analyzers.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>unifiedAnalysis.read</code>: Read Unified Analysis page.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> <li><code>extensionConfigurationActions.write</code>: Actions for extension monitoring configurations.</li> <li><code>adaptiveTrafficManagement.read</code>: Read sampling configuration for Adaptive Traffic Management.</li> </ul> |
|
|
9988
|
+
|scopes<sup>*required</sup>|Array<ApiTokenCreateScopesItem>|<p>A list of the scopes to be assigned to the token.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>openpipeline.events</code>: OpenPipeline - Ingest Events.</li> <li><code>openpipeline.events.custom</code>: OpenPipeline - Ingest Events (Custom).</li> <li><code>openpipeline.events_security</code>: OpenPipeline - Ingest Events, Application Security.</li> <li><code>openpipeline.events_security.custom</code>: OpenPipeline - Ingest Events, Application Security (Custom).</li> <li><code>bizevents.ingest</code>: Ingest bizevents.</li> <li><code>analyzers.read</code>: Read analyzers.</li> <li><code>analyzers.write</code>: Write & execute analyzers.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>unifiedAnalysis.read</code>: Read Unified Analysis page.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> <li><code>extensionConfigurationActions.write</code>: Actions for extension monitoring configurations.</li> <li><code>rumCookieNames.read</code>: Read RUM cookie names.</li> <li><code>adaptiveTrafficManagement.read</code>: Read sampling configuration for Adaptive Traffic Management.</li> </ul> |
|
|
9793
9989
|
|
|
9794
9990
|
### ApiTokenCreated
|
|
9795
9991
|
|
|
@@ -9840,7 +10036,7 @@ The update of the API token.
|
|
|
9840
10036
|
| --- | --- | --- |
|
|
9841
10037
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The token is enabled (<code>true</code>) or disabled (<code>false</code>) |
|
|
9842
10038
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the token. |
|
|
9843
|
-
|scopes|Array<ApiTokenUpdateScopesItem>|<p>The list of scopes assigned to the token.</p> <p>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.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>openpipeline.events</code>: OpenPipeline - Ingest Events.</li> <li><code>openpipeline.events.custom</code>: OpenPipeline - Ingest Events (Custom).</li> <li><code>openpipeline.events_security</code>: OpenPipeline - Ingest Events, Application Security.</li> <li><code>openpipeline.events_security.custom</code>: OpenPipeline - Ingest Events, Application Security (Custom).</li> <li><code>bizevents.ingest</code>: Ingest bizevents.</li> <li><code>analyzers.read</code>: Read analyzers.</li> <li><code>analyzers.write</code>: Write & execute analyzers.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>unifiedAnalysis.read</code>: Read Unified Analysis page.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> <li><code>extensionConfigurationActions.write</code>: Actions for extension monitoring configurations.</li> <li><code>adaptiveTrafficManagement.read</code>: Read sampling configuration for Adaptive Traffic Management.</li> </ul> |
|
|
10039
|
+
|scopes|Array<ApiTokenUpdateScopesItem>|<p>The list of scopes assigned to the token.</p> <p>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.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>openpipeline.events</code>: OpenPipeline - Ingest Events.</li> <li><code>openpipeline.events.custom</code>: OpenPipeline - Ingest Events (Custom).</li> <li><code>openpipeline.events_security</code>: OpenPipeline - Ingest Events, Application Security.</li> <li><code>openpipeline.events_security.custom</code>: OpenPipeline - Ingest Events, Application Security (Custom).</li> <li><code>bizevents.ingest</code>: Ingest bizevents.</li> <li><code>analyzers.read</code>: Read analyzers.</li> <li><code>analyzers.write</code>: Write & execute analyzers.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>unifiedAnalysis.read</code>: Read Unified Analysis page.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> <li><code>extensionConfigurationActions.write</code>: Actions for extension monitoring configurations.</li> <li><code>rumCookieNames.read</code>: Read RUM cookie names.</li> <li><code>adaptiveTrafficManagement.read</code>: Read sampling configuration for Adaptive Traffic Management.</li> </ul> |
|
|
9844
10040
|
|
|
9845
10041
|
### ApplicationImpact
|
|
9846
10042
|
|
|
@@ -10264,7 +10460,7 @@ A credentials set of the `CERTIFICATE` type.
|
|
|
10264
10460
|
|ownerAccessOnly|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The credentials set is available to every user (<code>false</code>) or to owner only (<code>true</code>). |
|
|
10265
10461
|
|password|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The password of the credential (Base64 encoded). |
|
|
10266
10462
|
|scope|CredentialsScope| |
|
|
10267
|
-
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>
|
|
10463
|
+
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
10268
10464
|
|type|CredentialsType| |
|
|
10269
10465
|
|
|
10270
10466
|
### CloudEvent
|
|
@@ -10472,7 +10668,7 @@ The actual set of fields depends on the type of credentials. Find the list of ac
|
|
|
10472
10668
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
10473
10669
|
|ownerAccessOnly|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The credentials set is available to every user (<code>false</code>) or to owner only (<code>true</code>). |
|
|
10474
10670
|
|scope|CredentialsScope| |
|
|
10475
|
-
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>
|
|
10671
|
+
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
10476
10672
|
|type|CredentialsType| |
|
|
10477
10673
|
|
|
10478
10674
|
### CredentialsDetailsCertificateResponseElement
|
|
@@ -12076,6 +12272,17 @@ A short representation of a management zone.
|
|
|
12076
12272
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the management zone. |
|
|
12077
12273
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the management zone. |
|
|
12078
12274
|
|
|
12275
|
+
### ManagementZoneDetails
|
|
12276
|
+
|
|
12277
|
+
|
|
12278
|
+
|
|
12279
|
+
|
|
12280
|
+
The details of the management zone.
|
|
12281
|
+
|
|
12282
|
+
| Name | Type | Description |
|
|
12283
|
+
| --- | --- | --- |
|
|
12284
|
+
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the management zone. |
|
|
12285
|
+
|
|
12079
12286
|
### MetricData
|
|
12080
12287
|
|
|
12081
12288
|
|
|
@@ -12638,6 +12845,52 @@ A list of settings objects.
|
|
|
12638
12845
|
|pageSize<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
12639
12846
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
12640
12847
|
|
|
12848
|
+
### PaginatedPersonalDataResponse
|
|
12849
|
+
|
|
12850
|
+
|
|
12851
|
+
|
|
12852
|
+
|
|
12853
|
+
The response payload to the personal data request.
|
|
12854
|
+
|
|
12855
|
+
| Name | Type | Description |
|
|
12856
|
+
| --- | --- | --- |
|
|
12857
|
+
|data<sup>*required</sup>|<a href="#paginatedpersonaldataresponsedata">PaginatedPersonalDataResponseData</a>| |
|
|
12858
|
+
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|In case of paginated results, this contains the pageKey for the next page. |
|
|
12859
|
+
|
|
12860
|
+
### PaginatedPersonalDataResponseData
|
|
12861
|
+
|
|
12862
|
+
|
|
12863
|
+
|
|
12864
|
+
|
|
12865
|
+
The data of the response payload to the personal data request.
|
|
12866
|
+
|
|
12867
|
+
| Name | Type | Description |
|
|
12868
|
+
| --- | --- | --- |
|
|
12869
|
+
|schemas<sup>*required</sup>|Array<<a href="#schema" target="_blank" rel="noopener noreferrer">Schema</a>>|The list of settings schemas containing personal data. |
|
|
12870
|
+
|
|
12871
|
+
### PersonalDataRequest
|
|
12872
|
+
|
|
12873
|
+
|
|
12874
|
+
|
|
12875
|
+
|
|
12876
|
+
The request payload for the exporting personal data
|
|
12877
|
+
|
|
12878
|
+
| Name | Type | Description |
|
|
12879
|
+
| --- | --- | --- |
|
|
12880
|
+
|email<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|User's e-mail |
|
|
12881
|
+
|userId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|IAM user UUID |
|
|
12882
|
+
|
|
12883
|
+
### Pii
|
|
12884
|
+
|
|
12885
|
+
|
|
12886
|
+
|
|
12887
|
+
|
|
12888
|
+
The information about relationships of the user to the settings object.
|
|
12889
|
+
|
|
12890
|
+
| Name | Type | Description |
|
|
12891
|
+
| --- | --- | --- |
|
|
12892
|
+
|relationships<sup>*required</sup>|Array<PiiRelationshipsItem>|A list of user relationships. |
|
|
12893
|
+
|
|
12641
12894
|
### Precondition
|
|
12642
12895
|
|
|
12643
12896
|
|
|
@@ -12834,7 +13087,7 @@ A credentials set of the `PUBLIC_CERTIFICATE` type.
|
|
|
12834
13087
|
|ownerAccessOnly|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The credentials set is available to every user (<code>false</code>) or to owner only (<code>true</code>). |
|
|
12835
13088
|
|password|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The password of the credential (not supported). |
|
|
12836
13089
|
|scope|CredentialsScope| |
|
|
12837
|
-
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>
|
|
13090
|
+
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
12838
13091
|
|type|CredentialsType| |
|
|
12839
13092
|
|
|
12840
13093
|
### PublicSyntheticLocation
|
|
@@ -13464,6 +13717,19 @@ Contains SLOs and paging information.
|
|
|
13464
13717
|
|slo<sup>*required</sup>|Array<<a href="#slo" target="_blank" rel="noopener noreferrer">SLO</a>>|The list of SLOs. |
|
|
13465
13718
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
13466
13719
|
|
|
13720
|
+
### Schema
|
|
13721
|
+
|
|
13722
|
+
|
|
13723
|
+
|
|
13724
|
+
|
|
13725
|
+
The information about settings schema containing personal data.
|
|
13726
|
+
|
|
13727
|
+
| Name | Type | Description |
|
|
13728
|
+
| --- | --- | --- |
|
|
13729
|
+
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the schema. |
|
|
13730
|
+
|id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the schema. |
|
|
13731
|
+
|values<sup>*required</sup>|Array<<a href="#value">Value</a>>|The list of settings values containing personal data. |
|
|
13732
|
+
|
|
13467
13733
|
### SchemaConstraintRestDto
|
|
13468
13734
|
|
|
13469
13735
|
|
|
@@ -13489,25 +13755,25 @@ Contains SLOs and paging information.
|
|
|
13489
13755
|
| Name | Type | Description |
|
|
13490
13756
|
| --- | --- | --- |
|
|
13491
13757
|
|allowedScopes<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of scopes where the schema can be used. |
|
|
13492
|
-
|constraints|Array<<a href="#complexconstraint">ComplexConstraint</a>>|A list of constrains limiting the values to be accepted by the schema. |
|
|
13493
|
-
|deletionConstraints|Array<<a href="#deletionconstraint"
|
|
13758
|
+
|constraints|Array<<a href="#complexconstraint" target="_blank" rel="noopener noreferrer">ComplexConstraint</a>>|A list of constrains limiting the values to be accepted by the schema. |
|
|
13759
|
+
|deletionConstraints|Array<<a href="#deletionconstraint">DeletionConstraint</a>>|Constraints limiting the values to be deleted. |
|
|
13494
13760
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the schema. |
|
|
13495
13761
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the schema. |
|
|
13496
13762
|
|documentation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description of the schema and/or links to documentation. |
|
|
13497
13763
|
|dynatrace<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the data format. |
|
|
13498
|
-
|enums<sup>*required</sup>|<a href="#schemadefinitionrestdtoenums">SchemaDefinitionRestDtoEnums</a>| |
|
|
13764
|
+
|enums<sup>*required</sup>|<a href="#schemadefinitionrestdtoenums" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoEnums</a>| |
|
|
13499
13765
|
|keyProperty|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Name of the key property in this schema. |
|
|
13500
13766
|
|maxObjects<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The maximum amount of objects per scope.</p> <p>Only applicable when <strong>multiObject</strong> is set to <code>true</code>.</p> |
|
|
13501
|
-
|metadata|<a href="#schemadefinitionrestdtometadata"
|
|
13767
|
+
|metadata|<a href="#schemadefinitionrestdtometadata">SchemaDefinitionRestDtoMetadata</a>| |
|
|
13502
13768
|
|multiObject<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Multiple (<code>true</code>) objects per scope are permitted or a single (<code>false</code>) object per scope is permitted. |
|
|
13503
13769
|
|ordered|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>If <code>true</code> the order of objects has semantic significance.</p> <p>Only applicable when <strong>multiObject</strong> is set to <code>true</code>.</p> |
|
|
13504
|
-
|properties<sup>*required</sup>|<a href="#schemadefinitionrestdtoproperties">SchemaDefinitionRestDtoProperties</a>| |
|
|
13505
|
-
|schemaConstraints|Array<<a href="#schemaconstraintrestdto"
|
|
13770
|
+
|properties<sup>*required</sup>|<a href="#schemadefinitionrestdtoproperties" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoProperties</a>| |
|
|
13771
|
+
|schemaConstraints|Array<<a href="#schemaconstraintrestdto">SchemaConstraintRestDto</a>>|Constraints limiting the values as a whole to be accepted in this configuration element. |
|
|
13506
13772
|
|schemaGroups|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Names of the groups, which the schema belongs to. |
|
|
13507
13773
|
|schemaId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the schema. |
|
|
13508
|
-
|tableColumns|<a href="#schemadefinitionrestdtotablecolumns">SchemaDefinitionRestDtoTableColumns</a>| |
|
|
13509
|
-
|types<sup>*required</sup>|<a href="#schemadefinitionrestdtotypes"
|
|
13510
|
-
|uiCustomization|<a href="#uicustomization">UiCustomization</a>| |
|
|
13774
|
+
|tableColumns|<a href="#schemadefinitionrestdtotablecolumns" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoTableColumns</a>| |
|
|
13775
|
+
|types<sup>*required</sup>|<a href="#schemadefinitionrestdtotypes">SchemaDefinitionRestDtoTypes</a>| |
|
|
13776
|
+
|uiCustomization|<a href="#uicustomization" target="_blank" rel="noopener noreferrer">UiCustomization</a>| |
|
|
13511
13777
|
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema. |
|
|
13512
13778
|
|
|
13513
13779
|
### SchemaDefinitionRestDtoEnums
|
|
@@ -13567,7 +13833,7 @@ The list of available settings schemas.
|
|
|
13567
13833
|
|
|
13568
13834
|
| Name | Type | Description |
|
|
13569
13835
|
| --- | --- | --- |
|
|
13570
|
-
|items<sup>*required</sup>|Array<<a href="#schemastub"
|
|
13836
|
+
|items<sup>*required</sup>|Array<<a href="#schemastub">SchemaStub</a>>|A list of settings schemas. |
|
|
13571
13837
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of schemas in the list. |
|
|
13572
13838
|
|
|
13573
13839
|
### SchemaStub
|
|
@@ -13579,9 +13845,11 @@ The short representation of the settings schema.
|
|
|
13579
13845
|
|
|
13580
13846
|
| Name | Type | Description |
|
|
13581
13847
|
| --- | --- | --- |
|
|
13582
|
-
|displayName
|
|
13583
|
-
|latestSchemaVersion
|
|
13584
|
-
|
|
|
13848
|
+
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the schema. |
|
|
13849
|
+
|latestSchemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The most recent version of the schema. |
|
|
13850
|
+
|multiObject|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Multi-object flag. <code>True</code> if the schema is a multi-object schema |
|
|
13851
|
+
|ordered|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Ordered flag. <code>True</code> if the schema is an ordered multi-object schema. |
|
|
13852
|
+
|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the schema. |
|
|
13585
13853
|
|
|
13586
13854
|
### SchemaType
|
|
13587
13855
|
|
|
@@ -13594,11 +13862,11 @@ A list of definitions of types.
|
|
|
13594
13862
|
|
|
13595
13863
|
| Name | Type | Description |
|
|
13596
13864
|
| --- | --- | --- |
|
|
13597
|
-
|constraints|Array<<a href="#complexconstraint">ComplexConstraint</a>>|A list of constraints limiting the values to be accepted. |
|
|
13865
|
+
|constraints|Array<<a href="#complexconstraint" target="_blank" rel="noopener noreferrer">ComplexConstraint</a>>|A list of constraints limiting the values to be accepted. |
|
|
13598
13866
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the property. |
|
|
13599
13867
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the property. |
|
|
13600
13868
|
|documentation<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description and/or links to documentation. |
|
|
13601
|
-
|properties<sup>*required</sup>|<a href="#schematypeproperties"
|
|
13869
|
+
|properties<sup>*required</sup>|<a href="#schematypeproperties">SchemaTypeProperties</a>| |
|
|
13602
13870
|
|searchPattern|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The pattern for the summary search(for example, "Alert after <em>X</em> minutes.") of the configuration in the UI. |
|
|
13603
13871
|
|summaryPattern<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The pattern for the summary (for example, "Alert after <em>X</em> minutes.") of the configuration in the UI. |
|
|
13604
13872
|
|type<sup>*required</sup>|Object| |
|
|
@@ -13655,19 +13923,19 @@ Parameters of a security problem
|
|
|
13655
13923
|
|
|
13656
13924
|
| Name | Type | Description |
|
|
13657
13925
|
| --- | --- | --- |
|
|
13658
|
-
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails">CodeLevelVulnerabilityDetails</a>| |
|
|
13926
|
+
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails" target="_blank" rel="noopener noreferrer">CodeLevelVulnerabilityDetails</a>| |
|
|
13659
13927
|
|cveIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of CVE IDs of the security problem. |
|
|
13660
13928
|
|displayId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display ID of the security problem. |
|
|
13661
13929
|
|externalVulnerabilityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external vulnerability ID of the security problem. |
|
|
13662
13930
|
|firstSeenTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the first occurrence of the security problem. |
|
|
13663
|
-
|globalCounts|<a href="#globalcountsdto"
|
|
13931
|
+
|globalCounts|<a href="#globalcountsdto">GlobalCountsDto</a>| |
|
|
13664
13932
|
|lastOpenedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last opened. |
|
|
13665
13933
|
|lastResolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last resolved. |
|
|
13666
13934
|
|lastUpdatedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the most recent security problem change. |
|
|
13667
|
-
|managementZones|Array<<a href="#managementzone">ManagementZone</a>>|A list of management zones which the affected entities belong to. |
|
|
13935
|
+
|managementZones|Array<<a href="#managementzone" target="_blank" rel="noopener noreferrer">ManagementZone</a>>|A list of management zones which the affected entities belong to. |
|
|
13668
13936
|
|muted|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The security problem is (<code>true</code>) or is not (<code>false</code>) muted. |
|
|
13669
13937
|
|packageName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The package name of the security problem. |
|
|
13670
|
-
|riskAssessment|<a href="#riskassessment"
|
|
13938
|
+
|riskAssessment|<a href="#riskassessment">RiskAssessment</a>| |
|
|
13671
13939
|
|securityProblemId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the security problem. |
|
|
13672
13940
|
|status|SecurityProblemStatus| |
|
|
13673
13941
|
|technology|SecurityProblemTechnology| |
|
|
@@ -13698,37 +13966,37 @@ Parameters of a security problem
|
|
|
13698
13966
|
| Name | Type | Description |
|
|
13699
13967
|
| --- | --- | --- |
|
|
13700
13968
|
|affectedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>A list of affected entities of the security problem.</p> <p>An affected entity is an entity where a vulnerable component runs.</p> |
|
|
13701
|
-
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails">CodeLevelVulnerabilityDetails</a>| |
|
|
13969
|
+
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails" target="_blank" rel="noopener noreferrer">CodeLevelVulnerabilityDetails</a>| |
|
|
13702
13970
|
|cveIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of CVE IDs of the security problem. |
|
|
13703
13971
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the security problem. |
|
|
13704
13972
|
|displayId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display ID of the security problem. |
|
|
13705
|
-
|entryPoints|<a href="#entrypoints"
|
|
13706
|
-
|events|Array<<a href="#securityproblemevent">SecurityProblemEvent</a>>|An ordered (newest first) list of events of the security problem. |
|
|
13973
|
+
|entryPoints|<a href="#entrypoints">EntryPoints</a>| |
|
|
13974
|
+
|events|Array<<a href="#securityproblemevent" target="_blank" rel="noopener noreferrer">SecurityProblemEvent</a>>|An ordered (newest first) list of events of the security problem. |
|
|
13707
13975
|
|exposedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>A list of exposed entities of the security problem.</p> <p>An exposed entity is an affected entity that is exposed to the internet.</p> |
|
|
13708
13976
|
|externalVulnerabilityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external vulnerability ID of the security problem. |
|
|
13709
|
-
|filteredCounts|<a href="#filteredcountsdto"
|
|
13977
|
+
|filteredCounts|<a href="#filteredcountsdto">FilteredCountsDto</a>| |
|
|
13710
13978
|
|firstSeenTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the first occurrence of the security problem. |
|
|
13711
|
-
|globalCounts|<a href="#globalcountsdto">GlobalCountsDto</a>| |
|
|
13979
|
+
|globalCounts|<a href="#globalcountsdto" target="_blank" rel="noopener noreferrer">GlobalCountsDto</a>| |
|
|
13712
13980
|
|lastOpenedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last opened. |
|
|
13713
13981
|
|lastResolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last resolved. |
|
|
13714
13982
|
|lastUpdatedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the most recent security problem change. |
|
|
13715
|
-
|managementZones|Array<<a href="#managementzone"
|
|
13983
|
+
|managementZones|Array<<a href="#managementzone">ManagementZone</a>>|A list of management zones which the affected entities belong to. |
|
|
13716
13984
|
|muteStateChangeInProgress|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code> a change of the mute state is in progress. |
|
|
13717
13985
|
|muted|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The security problem is (<code>true</code>) or is not (<code>false</code>) muted. |
|
|
13718
13986
|
|packageName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The package name of the security problem. |
|
|
13719
13987
|
|reachableDataAssets|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>A list of data assets reachable by affected entities of the security problem.</p> <p>A data asset is a service that has database access.</p> |
|
|
13720
|
-
|relatedAttacks|<a href="#relatedattackslist">RelatedAttacksList</a>| |
|
|
13721
|
-
|relatedContainerImages|<a href="#relatedcontainerlist"
|
|
13722
|
-
|relatedEntities|<a href="#relatedentitieslist">RelatedEntitiesList</a>| |
|
|
13988
|
+
|relatedAttacks|<a href="#relatedattackslist" target="_blank" rel="noopener noreferrer">RelatedAttacksList</a>| |
|
|
13989
|
+
|relatedContainerImages|<a href="#relatedcontainerlist">RelatedContainerList</a>| |
|
|
13990
|
+
|relatedEntities|<a href="#relatedentitieslist" target="_blank" rel="noopener noreferrer">RelatedEntitiesList</a>| |
|
|
13723
13991
|
|remediationDescription|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Description of how to remediate the vulnerability. |
|
|
13724
|
-
|riskAssessment|<a href="#riskassessmentdetails"
|
|
13992
|
+
|riskAssessment|<a href="#riskassessmentdetails">RiskAssessmentDetails</a>| |
|
|
13725
13993
|
|securityProblemId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the security problem. |
|
|
13726
13994
|
|status|SecurityProblemDetailsStatus| |
|
|
13727
13995
|
|technology|SecurityProblemDetailsTechnology| |
|
|
13728
13996
|
|title|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The title of the security problem. |
|
|
13729
13997
|
|url|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The URL to the security problem details page. |
|
|
13730
13998
|
|vulnerabilityType|SecurityProblemDetailsVulnerabilityType| |
|
|
13731
|
-
|vulnerableComponents|Array<<a href="#vulnerablecomponent">VulnerableComponent</a>>|<p>A list of vulnerable components of the security problem.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
13999
|
+
|vulnerableComponents|Array<<a href="#vulnerablecomponent" target="_blank" rel="noopener noreferrer">VulnerableComponent</a>>|<p>A list of vulnerable components of the security problem.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
13732
14000
|
|
|
13733
14001
|
### SecurityProblemEvent
|
|
13734
14002
|
|
|
@@ -13739,9 +14007,9 @@ The event of a security problem.
|
|
|
13739
14007
|
|
|
13740
14008
|
| Name | Type | Description |
|
|
13741
14009
|
| --- | --- | --- |
|
|
13742
|
-
|muteState|<a href="#mutestate"
|
|
14010
|
+
|muteState|<a href="#mutestate">MuteState</a>| |
|
|
13743
14011
|
|reason|SecurityProblemEventReason| |
|
|
13744
|
-
|riskAssessmentSnapshot|<a href="#riskassessmentsnapshot">RiskAssessmentSnapshot</a>| |
|
|
14012
|
+
|riskAssessmentSnapshot|<a href="#riskassessmentsnapshot" target="_blank" rel="noopener noreferrer">RiskAssessmentSnapshot</a>| |
|
|
13745
14013
|
|timestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the event occurred. |
|
|
13746
14014
|
|
|
13747
14015
|
### SecurityProblemEventsList
|
|
@@ -13753,7 +14021,7 @@ A list of events for a security problem.
|
|
|
13753
14021
|
|
|
13754
14022
|
| Name | Type | Description |
|
|
13755
14023
|
| --- | --- | --- |
|
|
13756
|
-
|events|Array<<a href="#securityproblemevent"
|
|
14024
|
+
|events|Array<<a href="#securityproblemevent">SecurityProblemEvent</a>>|A list of events for a security problem. |
|
|
13757
14025
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p> |
|
|
13758
14026
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
13759
14027
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -13769,7 +14037,7 @@ A list of security problems.
|
|
|
13769
14037
|
| --- | --- | --- |
|
|
13770
14038
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p> |
|
|
13771
14039
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
13772
|
-
|securityProblems|Array<<a href="#securityproblem">SecurityProblem</a>>|A list of security problems. |
|
|
14040
|
+
|securityProblems|Array<<a href="#securityproblem" target="_blank" rel="noopener noreferrer">SecurityProblem</a>>|A list of security problems. |
|
|
13773
14041
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
13774
14042
|
|
|
13775
14043
|
### SecurityProblemMute
|
|
@@ -13818,7 +14086,7 @@ Response of muting several security problems.
|
|
|
13818
14086
|
|
|
13819
14087
|
| Name | Type | Description |
|
|
13820
14088
|
| --- | --- | --- |
|
|
13821
|
-
|summary<sup>*required</sup>|Array<<a href="#securityproblembulkmutingsummary"
|
|
14089
|
+
|summary<sup>*required</sup>|Array<<a href="#securityproblembulkmutingsummary">SecurityProblemBulkMutingSummary</a>>|The summary of which security problems were muted and which already were muted previously. |
|
|
13822
14090
|
|
|
13823
14091
|
### SecurityProblemsBulkUnmute
|
|
13824
14092
|
|
|
@@ -13842,7 +14110,7 @@ Response of un-muting several security problems.
|
|
|
13842
14110
|
|
|
13843
14111
|
| Name | Type | Description |
|
|
13844
14112
|
| --- | --- | --- |
|
|
13845
|
-
|summary<sup>*required</sup>|Array<<a href="#securityproblembulkmutingsummary">SecurityProblemBulkMutingSummary</a>>|The summary of which security problems were un-muted and which already were un-muted previously. |
|
|
14113
|
+
|summary<sup>*required</sup>|Array<<a href="#securityproblembulkmutingsummary" target="_blank" rel="noopener noreferrer">SecurityProblemBulkMutingSummary</a>>|The summary of which security problems were un-muted and which already were un-muted previously. |
|
|
13846
14114
|
|
|
13847
14115
|
### ServiceImpact
|
|
13848
14116
|
|
|
@@ -13855,7 +14123,7 @@ Analysis of problem impact to a service.
|
|
|
13855
14123
|
| --- | --- | --- |
|
|
13856
14124
|
|estimatedAffectedUsers<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of affected users. |
|
|
13857
14125
|
|impactType<sup>*required</sup>|ImpactImpactType| |
|
|
13858
|
-
|impactedEntity<sup>*required</sup>|<a href="#entitystub"
|
|
14126
|
+
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>| |
|
|
13859
14127
|
|numberOfPotentiallyAffectedServiceCalls|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of potentially impacted services. |
|
|
13860
14128
|
|
|
13861
14129
|
### SettingsObject
|
|
@@ -13871,7 +14139,31 @@ A settings object.
|
|
|
13871
14139
|
|created|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the creation. |
|
|
13872
14140
|
|createdBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who created the settings object. |
|
|
13873
14141
|
|externalId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external identifier of the settings object. |
|
|
13874
|
-
|modificationInfo|<a href="#modificationinfo">ModificationInfo</a>| |
|
|
14142
|
+
|modificationInfo|<a href="#modificationinfo" target="_blank" rel="noopener noreferrer">ModificationInfo</a>| |
|
|
14143
|
+
|modified|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification. |
|
|
14144
|
+
|modifiedBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who performed the most recent modification. |
|
|
14145
|
+
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
|
|
14146
|
+
|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema on which the object is based. |
|
|
14147
|
+
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema on which the object is based. |
|
|
14148
|
+
|scope|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The scope that the object targets. For more details, please see <a href="https://dt-url.net/ky03459" target="_blank" rel="noopener noreferrer" >Dynatrace Documentation</a>. |
|
|
14149
|
+
|searchSummary|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A searchable summary string of the setting value. Plain text without Markdown. |
|
|
14150
|
+
|summary|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short summary of settings. This can contain Markdown and will be escaped accordingly. |
|
|
14151
|
+
|updateToken|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The update token of the object. You can use it to detect simultaneous modifications by different users.</p> <p>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.</p> <p>If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.</p> |
|
|
14152
|
+
|value|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)|<p>The value of the setting.</p> <p>It defines the actual values of settings' parameters.</p> <p>The actual content depends on the object's schema.</p> |
|
|
14153
|
+
|
|
14154
|
+
### SettingsObjectByObjectIdResponse
|
|
14155
|
+
|
|
14156
|
+
|
|
14157
|
+
|
|
14158
|
+
|
|
14159
|
+
The response to a get by objectId request.
|
|
14160
|
+
|
|
14161
|
+
| Name | Type | Description |
|
|
14162
|
+
| --- | --- | --- |
|
|
14163
|
+
|author|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The user (identified by a user ID or a public token ID) who performed that most recent modification. |
|
|
14164
|
+
|created|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the creation. |
|
|
14165
|
+
|createdBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who created the settings object. |
|
|
14166
|
+
|externalId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external identifier of the settings object. |
|
|
13875
14167
|
|modified|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification. |
|
|
13876
14168
|
|modifiedBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who performed the most recent modification. |
|
|
13877
14169
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
|
|
@@ -13910,7 +14202,7 @@ The response to a creation- or update-request.
|
|
|
13910
14202
|
| Name | Type | Description |
|
|
13911
14203
|
| --- | --- | --- |
|
|
13912
14204
|
|code<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The HTTP status code for the object. |
|
|
13913
|
-
|error|<a href="#error"
|
|
14205
|
+
|error|<a href="#error">Error</a>| |
|
|
13914
14206
|
|invalidValue|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)|<p>The value of the setting.</p> <p>It defines the actual values of settings' parameters.</p> <p>The actual content depends on the object's schema.</p> |
|
|
13915
14207
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|For a successful request, the ID of the created or modified settings object. |
|
|
13916
14208
|
|
|
@@ -13968,7 +14260,7 @@ Error budget burn rate configuration of a service-level objective (SLO).
|
|
|
13968
14260
|
| --- | --- | --- |
|
|
13969
14261
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the SLO. |
|
|
13970
14262
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>The SLO is enabled (<code>true</code>) or disabled (<code>false</code>).</p> <p>If not defined, the SLO is disabled by default.</p> |
|
|
13971
|
-
|errorBudgetBurnRate|<a href="#sloburnrateconfig">SloBurnRateConfig</a>| |
|
|
14263
|
+
|errorBudgetBurnRate|<a href="#sloburnrateconfig" target="_blank" rel="noopener noreferrer">SloBurnRateConfig</a>| |
|
|
13972
14264
|
|evaluationType<sup>*required</sup>|Aggregate| |
|
|
13973
14265
|
|filter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The entity filter for the SLO evaluation. The total length of the entitySelector string in SLOs is limited to 1,000 characters. Use the <a href="https://dt-url.net/entityselector" target="_blank" rel="noopener noreferrer" >syntax of entity selector</a>. |
|
|
13974
14266
|
|metricDenominator|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The total count metric (the denominator in rate calculation).</p> <p>Required when the <strong>useRateMetric</strong> is set to <code>false</code>.</p> |
|
|
@@ -14030,7 +14322,7 @@ Parameters of a status alert.
|
|
|
14030
14322
|
|
|
14031
14323
|
| Name | Type |
|
|
14032
14324
|
| --- | --- |
|
|
14033
|
-
|details|<a href="#success"
|
|
14325
|
+
|details|<a href="#success">Success</a>|
|
|
14034
14326
|
|
|
14035
14327
|
### SyntheticConfigDto
|
|
14036
14328
|
|
|
@@ -14100,7 +14392,7 @@ A list of synthetic locations.
|
|
|
14100
14392
|
|
|
14101
14393
|
| Name | Type | Description |
|
|
14102
14394
|
| --- | --- | --- |
|
|
14103
|
-
|locations<sup>*required</sup>|Array<<a href="#locationcollectionelement">LocationCollectionElement</a>>|A list of synthetic locations. |
|
|
14395
|
+
|locations<sup>*required</sup>|Array<<a href="#locationcollectionelement" target="_blank" rel="noopener noreferrer">LocationCollectionElement</a>>|A list of synthetic locations. |
|
|
14104
14396
|
|
|
14105
14397
|
### SyntheticMonitorListDto
|
|
14106
14398
|
|
|
@@ -14111,7 +14403,7 @@ List of available synthetic monitors.
|
|
|
14111
14403
|
|
|
14112
14404
|
| Name | Type | Description |
|
|
14113
14405
|
| --- | --- | --- |
|
|
14114
|
-
|monitors|Array<<a href="#syntheticmonitorsummarydto"
|
|
14406
|
+
|monitors|Array<<a href="#syntheticmonitorsummarydto">SyntheticMonitorSummaryDto</a>>|List of monitors. |
|
|
14115
14407
|
|
|
14116
14408
|
### SyntheticMonitorOutageHandlingSettingsDto
|
|
14117
14409
|
|
|
@@ -14154,7 +14446,7 @@ Performance thresholds configuration.
|
|
|
14154
14446
|
| Name | Type | Description |
|
|
14155
14447
|
| --- | --- | --- |
|
|
14156
14448
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Performance threshold is enabled (<code>true</code>) or disabled (<code>false</code>). |
|
|
14157
|
-
|thresholds|Array<<a href="#syntheticmonitorperformancethresholddto">SyntheticMonitorPerformanceThresholdDto</a>>|The list of performance threshold rules. |
|
|
14449
|
+
|thresholds|Array<<a href="#syntheticmonitorperformancethresholddto" target="_blank" rel="noopener noreferrer">SyntheticMonitorPerformanceThresholdDto</a>>|The list of performance threshold rules. |
|
|
14158
14450
|
|
|
14159
14451
|
### SyntheticMonitorSummaryDto
|
|
14160
14452
|
|
|
@@ -14179,7 +14471,7 @@ The network availability monitor constraint.
|
|
|
14179
14471
|
|
|
14180
14472
|
| Name | Type | Description |
|
|
14181
14473
|
| --- | --- | --- |
|
|
14182
|
-
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorconstraintdtoproperties"
|
|
14474
|
+
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorconstraintdtoproperties">SyntheticMultiProtocolMonitorConstraintDtoProperties</a>| |
|
|
14183
14475
|
|type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Constraint type. |
|
|
14184
14476
|
|
|
14185
14477
|
### SyntheticMultiProtocolMonitorConstraintDtoProperties
|
|
@@ -14198,16 +14490,17 @@ Network Availability monitor.
|
|
|
14198
14490
|
|
|
14199
14491
|
| Name | Type | Description |
|
|
14200
14492
|
| --- | --- | --- |
|
|
14201
|
-
|active|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If false, the monitor is disabled. <i>default:</i> <code>true</code>|
|
|
14202
14493
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor description |
|
|
14494
|
+
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled. <i>default:</i> <code>true</code>|
|
|
14203
14495
|
|entityId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The entity id of the monitor. |
|
|
14204
14496
|
|frequencyMin<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. |
|
|
14205
14497
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
14498
|
+
|modificationTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification |
|
|
14206
14499
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
14207
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>| |
|
|
14208
|
-
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto"
|
|
14209
|
-
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>| |
|
|
14210
|
-
|tags|Array<<a href="#synthetictagwithsourcedto"
|
|
14500
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorPerformanceThresholdsDto</a>| |
|
|
14501
|
+
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor. |
|
|
14502
|
+
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorOutageHandlingSettingsDto</a>| |
|
|
14503
|
+
|tags|Array<<a href="#synthetictagwithsourcedto">SyntheticTagWithSourceDto</a>>|<p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |
|
|
14211
14504
|
|type<sup>*required</sup>|SyntheticMultiProtocolMonitorDtoType| |
|
|
14212
14505
|
|
|
14213
14506
|
### SyntheticMultiProtocolMonitorStepDto
|
|
@@ -14219,10 +14512,10 @@ The step of a network availability monitor.
|
|
|
14219
14512
|
|
|
14220
14513
|
| Name | Type | Description |
|
|
14221
14514
|
| --- | --- | --- |
|
|
14222
|
-
|constraints<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorconstraintdto">SyntheticMultiProtocolMonitorConstraintDto</a>>|The list of constraints which apply to all requests in the step. |
|
|
14515
|
+
|constraints<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorconstraintdto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorConstraintDto</a>>|The list of constraints which apply to all requests in the step. |
|
|
14223
14516
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Step name. |
|
|
14224
|
-
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorstepdtoproperties"
|
|
14225
|
-
|requestConfigurations<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolrequestconfigurationdto">SyntheticMultiProtocolRequestConfigurationDto</a>>|Request configurations. |
|
|
14517
|
+
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorstepdtoproperties">SyntheticMultiProtocolMonitorStepDtoProperties</a>| |
|
|
14518
|
+
|requestConfigurations<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolrequestconfigurationdto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolRequestConfigurationDto</a>>|Request configurations. |
|
|
14226
14519
|
|requestType<sup>*required</sup>|SyntheticMultiProtocolMonitorStepDtoRequestType| |
|
|
14227
14520
|
|targetFilter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Target filter. |
|
|
14228
14521
|
|targetList<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Target list. |
|
|
@@ -14243,15 +14536,15 @@ Network availability monitor.
|
|
|
14243
14536
|
|
|
14244
14537
|
| Name | Type | Description |
|
|
14245
14538
|
| --- | --- | --- |
|
|
14246
|
-
|active|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If false, the monitor is disabled. <i>default:</i> <code>true</code>|
|
|
14247
14539
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor description |
|
|
14540
|
+
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled. <i>default:</i> <code>true</code>|
|
|
14248
14541
|
|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. |
|
|
14249
14542
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
14250
14543
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
14251
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto"
|
|
14252
|
-
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor. |
|
|
14253
|
-
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto"
|
|
14254
|
-
|tags|Array<<a href="#synthetictagwithsourcedto">SyntheticTagWithSourceDto</a>>|<p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |
|
|
14544
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>| |
|
|
14545
|
+
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor. |
|
|
14546
|
+
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>| |
|
|
14547
|
+
|tags|Array<<a href="#synthetictagwithsourcedto" target="_blank" rel="noopener noreferrer">SyntheticTagWithSourceDto</a>>|<p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |
|
|
14255
14548
|
|type<sup>*required</sup>|MultiProtocol| |
|
|
14256
14549
|
|
|
14257
14550
|
### SyntheticMultiProtocolRequestConfigurationDto
|
|
@@ -14263,7 +14556,7 @@ The configuration of a network availability monitor request.
|
|
|
14263
14556
|
|
|
14264
14557
|
| Name | Type | Description |
|
|
14265
14558
|
| --- | --- | --- |
|
|
14266
|
-
|constraints<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorconstraintdto"
|
|
14559
|
+
|constraints<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorconstraintdto">SyntheticMultiProtocolMonitorConstraintDto</a>>|Request constraints. |
|
|
14267
14560
|
|
|
14268
14561
|
### SyntheticOnDemandBatchStatus
|
|
14269
14562
|
|
|
@@ -14278,12 +14571,12 @@ Contains information about on-demand executions triggered within the batch.
|
|
|
14278
14571
|
|batchStatus<sup>*required</sup>|SyntheticOnDemandBatchStatusBatchStatus| |
|
|
14279
14572
|
|executedCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of triggered executions with the result SUCCESS or FAILED. |
|
|
14280
14573
|
|failedCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of triggered executions with the result FAILED. |
|
|
14281
|
-
|failedExecutions|Array<<a href="#syntheticondemandfailedexecutionstatus">SyntheticOnDemandFailedExecutionStatus</a>>| |
|
|
14282
|
-
|failedToExecute|Array<<a href="#syntheticondemandfailedexecutionstatus"
|
|
14574
|
+
|failedExecutions|Array<<a href="#syntheticondemandfailedexecutionstatus" target="_blank" rel="noopener noreferrer">SyntheticOnDemandFailedExecutionStatus</a>>| |
|
|
14575
|
+
|failedToExecute|Array<<a href="#syntheticondemandfailedexecutionstatus">SyntheticOnDemandFailedExecutionStatus</a>>| |
|
|
14283
14576
|
|failedToExecuteCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of executions that were triggered and timed out because of a problem with the Synthetic engine. |
|
|
14284
|
-
|metadata|<a href="#syntheticondemandbatchstatusmetadata">SyntheticOnDemandBatchStatusMetadata</a>| |
|
|
14577
|
+
|metadata|<a href="#syntheticondemandbatchstatusmetadata" target="_blank" rel="noopener noreferrer">SyntheticOnDemandBatchStatusMetadata</a>| |
|
|
14285
14578
|
|triggeredCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of triggered executions within the batch. |
|
|
14286
|
-
|triggeringProblems|Array<<a href="#syntheticondemandtriggeringproblemdetails"
|
|
14579
|
+
|triggeringProblems|Array<<a href="#syntheticondemandtriggeringproblemdetails">SyntheticOnDemandTriggeringProblemDetails</a>>| |
|
|
14287
14580
|
|triggeringProblemsCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of executions that were not triggered due to some problems. |
|
|
14288
14581
|
|userId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the user who triggered execution of the batch. |
|
|
14289
14582
|
|
|
@@ -14309,14 +14602,14 @@ Describes the status of an on-demand execution.
|
|
|
14309
14602
|
|executionId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the execution. |
|
|
14310
14603
|
|executionStage<sup>*required</sup>|SyntheticOnDemandExecutionExecutionStage| |
|
|
14311
14604
|
|executionTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when execution was finished, in UTC milliseconds. |
|
|
14312
|
-
|fullResults|<a href="#executionfullresults">ExecutionFullResults</a>| |
|
|
14605
|
+
|fullResults|<a href="#executionfullresults" target="_blank" rel="noopener noreferrer">ExecutionFullResults</a>| |
|
|
14313
14606
|
|locationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the location from where the monitor is to be executed. |
|
|
14314
|
-
|metadata|<a href="#syntheticondemandexecutionmetadata"
|
|
14607
|
+
|metadata|<a href="#syntheticondemandexecutionmetadata">SyntheticOnDemandExecutionMetadata</a>| |
|
|
14315
14608
|
|monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the monitor. |
|
|
14316
14609
|
|nextExecutionId|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Next execution id for sequential mode. |
|
|
14317
14610
|
|processingMode<sup>*required</sup>|SyntheticOnDemandExecutionProcessingMode| |
|
|
14318
14611
|
|schedulingTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The scheduling timestamp, in UTC milliseconds. |
|
|
14319
|
-
|simpleResults|<a href="#executionsimpleresults">ExecutionSimpleResults</a>| |
|
|
14612
|
+
|simpleResults|<a href="#executionsimpleresults" target="_blank" rel="noopener noreferrer">ExecutionSimpleResults</a>| |
|
|
14320
14613
|
|source<sup>*required</sup>|SyntheticOnDemandExecutionSource| |
|
|
14321
14614
|
|userId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the user who triggered the on-demand execution. |
|
|
14322
14615
|
|
|
@@ -14338,9 +14631,9 @@ Contains parameters for the on-demand execution of monitors identified by tags,
|
|
|
14338
14631
|
| --- | --- | --- |
|
|
14339
14632
|
|failOnPerformanceIssue|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the execution will fail in case of performance issue. <i>default:</i> <code>true</code>|
|
|
14340
14633
|
|failOnSslWarning|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Applies to HTTP monitors only. If true, the execution will fail in case of an SSL certificate expiration warning or if the certificate is missing. <i>default:</i> <code>true</code>|
|
|
14341
|
-
|group|<a href="#syntheticondemandexecutionrequestgroup"
|
|
14342
|
-
|metadata|<a href="#syntheticondemandexecutionrequestmetadata">SyntheticOnDemandExecutionRequestMetadata</a>| |
|
|
14343
|
-
|monitors|Array<<a href="#syntheticondemandexecutionrequestmonitor"
|
|
14634
|
+
|group|<a href="#syntheticondemandexecutionrequestgroup">SyntheticOnDemandExecutionRequestGroup</a>| |
|
|
14635
|
+
|metadata|<a href="#syntheticondemandexecutionrequestmetadata" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionRequestMetadata</a>| |
|
|
14636
|
+
|monitors|Array<<a href="#syntheticondemandexecutionrequestmonitor">SyntheticOnDemandExecutionRequestMonitor</a>>|List of monitors to be triggered. |
|
|
14344
14637
|
|processingMode|SyntheticOnDemandExecutionRequestProcessingMode| <i>default:</i> <code>"STANDARD"</code>|
|
|
14345
14638
|
|stopOnProblem|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, no executions will be scheduled if a problem occurs. <i>default:</i> <code>false</code>|
|
|
14346
14639
|
|takeScreenshotsOnSuccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the screenshots will be taken during the execution of a browser monitor. <i>default:</i> <code>false</code>|
|
|
@@ -14391,10 +14684,10 @@ The result of on-demand synthetic monitor execution.
|
|
|
14391
14684
|
| Name | Type | Description |
|
|
14392
14685
|
| --- | --- | --- |
|
|
14393
14686
|
|batchId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The batch identifier of the triggered executions. |
|
|
14394
|
-
|triggered|Array<<a href="#syntheticondemandtriggeredmonitor">SyntheticOnDemandTriggeredMonitor</a>>|Monitors for which on-demand executions were triggered. |
|
|
14687
|
+
|triggered|Array<<a href="#syntheticondemandtriggeredmonitor" target="_blank" rel="noopener noreferrer">SyntheticOnDemandTriggeredMonitor</a>>|Monitors for which on-demand executions were triggered. |
|
|
14395
14688
|
|triggeredCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of the triggered executions within the batch. |
|
|
14396
14689
|
|triggeringProblemsCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of problems within the batch. |
|
|
14397
|
-
|triggeringProblemsDetails|Array<<a href="#syntheticondemandtriggeringproblemdetails"
|
|
14690
|
+
|triggeringProblemsDetails|Array<<a href="#syntheticondemandtriggeringproblemdetails">SyntheticOnDemandTriggeringProblemDetails</a>>|List with the entities for which triggering problems occurred. |
|
|
14398
14691
|
|
|
14399
14692
|
### SyntheticOnDemandExecutions
|
|
14400
14693
|
|
|
@@ -14405,7 +14698,7 @@ Contains a list of synthetic on-demand executions.
|
|
|
14405
14698
|
|
|
14406
14699
|
| Name | Type | Description |
|
|
14407
14700
|
| --- | --- | --- |
|
|
14408
|
-
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandexecution">SyntheticOnDemandExecution</a>>|The list of executions. |
|
|
14701
|
+
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandexecution" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecution</a>>|The list of executions. |
|
|
14409
14702
|
|
|
14410
14703
|
### SyntheticOnDemandFailedExecutionStatus
|
|
14411
14704
|
|
|
@@ -14445,7 +14738,7 @@ Contains the list of on-demand executions of the monitor.
|
|
|
14445
14738
|
|
|
14446
14739
|
| Name | Type | Description |
|
|
14447
14740
|
| --- | --- | --- |
|
|
14448
|
-
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandtriggeredexecutiondetails"
|
|
14741
|
+
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandtriggeredexecutiondetails">SyntheticOnDemandTriggeredExecutionDetails</a>>|The list of triggered executions. |
|
|
14449
14742
|
|monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The monitor identifier. |
|
|
14450
14743
|
|
|
14451
14744
|
### SyntheticOnDemandTriggeringProblemDetails
|
|
@@ -14460,6 +14753,7 @@ Contains the details of problems encountered while triggering on-demand executio
|
|
|
14460
14753
|
|cause<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The cause of not triggering entity. |
|
|
14461
14754
|
|details<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The details of triggering problem. |
|
|
14462
14755
|
|entityId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The entity identifier. |
|
|
14756
|
+
|executionId<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The execution identifier. |
|
|
14463
14757
|
|locationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The location identifier. |
|
|
14464
14758
|
|
|
14465
14759
|
### SyntheticPrivateLocationUpdate
|
|
@@ -14557,8 +14851,8 @@ Configuration of a [tenant token](https://dt-url.net/b403ss9).
|
|
|
14557
14851
|
|
|
14558
14852
|
| Name | Type |
|
|
14559
14853
|
| --- | --- |
|
|
14560
|
-
|active|<a href="#tenanttoken">TenantToken</a>|
|
|
14561
|
-
|old|<a href="#tenanttoken"
|
|
14854
|
+
|active|<a href="#tenanttoken" target="_blank" rel="noopener noreferrer">TenantToken</a>|
|
|
14855
|
+
|old|<a href="#tenanttoken">TenantToken</a>|
|
|
14562
14856
|
|
|
14563
14857
|
### ToPosition
|
|
14564
14858
|
|
|
@@ -14582,14 +14876,14 @@ A credentials set of the `TOKEN` type.
|
|
|
14582
14876
|
| Name | Type | Description |
|
|
14583
14877
|
| --- | --- | --- |
|
|
14584
14878
|
|allowContextlessRequests|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope). |
|
|
14585
|
-
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
14879
|
+
|allowedEntities|Array<<a href="#credentialaccessdata" target="_blank" rel="noopener noreferrer">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
14586
14880
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
14587
|
-
|externalVault|<a href="#externalvault"
|
|
14881
|
+
|externalVault|<a href="#externalvault">ExternalVault</a>| |
|
|
14588
14882
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
14589
14883
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
14590
14884
|
|ownerAccessOnly|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The credentials set is available to every user (<code>false</code>) or to owner only (<code>true</code>). |
|
|
14591
14885
|
|scope|CredentialsScope| |
|
|
14592
|
-
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>
|
|
14886
|
+
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
14593
14887
|
|token|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Token in the string format. |
|
|
14594
14888
|
|type|CredentialsType| |
|
|
14595
14889
|
|
|
@@ -14632,9 +14926,9 @@ A behavior of a metric in an transaction that indicates the problem and/or is it
|
|
|
14632
14926
|
| --- | --- | --- |
|
|
14633
14927
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
14634
14928
|
|endTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The end time of the evidence, in UTC milliseconds |
|
|
14635
|
-
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>| |
|
|
14929
|
+
|entity<sup>*required</sup>|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>| |
|
|
14636
14930
|
|evidenceType<sup>*required</sup>|EvidenceEvidenceType| |
|
|
14637
|
-
|groupingEntity|<a href="#entitystub"
|
|
14931
|
+
|groupingEntity|<a href="#entitystub">EntityStub</a>| |
|
|
14638
14932
|
|rootCauseRelevant<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The evidence is (<code>true</code>) or is not (<code>false</code>) a part of the root cause. |
|
|
14639
14933
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds. |
|
|
14640
14934
|
|unit|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unit of the metric. |
|
|
@@ -14650,8 +14944,8 @@ A list of values that has possibly been truncated.
|
|
|
14650
14944
|
|
|
14651
14945
|
| Name | Type | Description |
|
|
14652
14946
|
| --- | --- | --- |
|
|
14653
|
-
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>| |
|
|
14654
|
-
|values|Array<<a href="#attackrequestheader"
|
|
14947
|
+
|truncationInfo|<a href="#truncationinfo" target="_blank" rel="noopener noreferrer">TruncationInfo</a>| |
|
|
14948
|
+
|values|Array<<a href="#attackrequestheader">AttackRequestHeader</a>>|Values of the list. |
|
|
14655
14949
|
|
|
14656
14950
|
### TruncatableListHttpRequestParameter
|
|
14657
14951
|
|
|
@@ -14662,8 +14956,8 @@ A list of values that has possibly been truncated.
|
|
|
14662
14956
|
|
|
14663
14957
|
| Name | Type | Description |
|
|
14664
14958
|
| --- | --- | --- |
|
|
14665
|
-
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>| |
|
|
14666
|
-
|values|Array<<a href="#httprequestparameter"
|
|
14959
|
+
|truncationInfo|<a href="#truncationinfo" target="_blank" rel="noopener noreferrer">TruncationInfo</a>| |
|
|
14960
|
+
|values|Array<<a href="#httprequestparameter">HttpRequestParameter</a>>|Values of the list. |
|
|
14667
14961
|
|
|
14668
14962
|
### TruncatableListString
|
|
14669
14963
|
|
|
@@ -14674,7 +14968,7 @@ A list of values that has possibly been truncated.
|
|
|
14674
14968
|
|
|
14675
14969
|
| Name | Type | Description |
|
|
14676
14970
|
| --- | --- | --- |
|
|
14677
|
-
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>| |
|
|
14971
|
+
|truncationInfo|<a href="#truncationinfo" target="_blank" rel="noopener noreferrer">TruncationInfo</a>| |
|
|
14678
14972
|
|values|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Values of the list. |
|
|
14679
14973
|
|
|
14680
14974
|
### TruncationInfo
|
|
@@ -14700,7 +14994,7 @@ UI customization for defining a button that calls a function when pressed
|
|
|
14700
14994
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description to be shown in a tooltip when hovering over the button |
|
|
14701
14995
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The label of the button |
|
|
14702
14996
|
|identifier<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the function to be called when the button is pressed |
|
|
14703
|
-
|insert<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | <a href="#insertposition"
|
|
14997
|
+
|insert<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | <a href="#insertposition">InsertPosition</a>|The position where the button should be shown in the UI |
|
|
14704
14998
|
|
|
14705
14999
|
### UiCallbackCustomization
|
|
14706
15000
|
|
|
@@ -14711,7 +15005,7 @@ UI customization options for defining custom callbacks
|
|
|
14711
15005
|
|
|
14712
15006
|
| Name | Type | Description |
|
|
14713
15007
|
| --- | --- | --- |
|
|
14714
|
-
|buttons|Array<<a href="#uibuttoncustomization">UiButtonCustomization</a>>|UI customization for defining buttons that call functions when pressed |
|
|
15008
|
+
|buttons|Array<<a href="#uibuttoncustomization" target="_blank" rel="noopener noreferrer">UiButtonCustomization</a>>|UI customization for defining buttons that call functions when pressed |
|
|
14715
15009
|
|
|
14716
15010
|
### UiCustomization
|
|
14717
15011
|
|
|
@@ -14722,10 +15016,10 @@ Customization for UI elements
|
|
|
14722
15016
|
|
|
14723
15017
|
| Name | Type |
|
|
14724
15018
|
| --- | --- |
|
|
14725
|
-
|callback|<a href="#uicallbackcustomization"
|
|
14726
|
-
|expandable|<a href="#uiexpandablecustomization">UiExpandableCustomization</a>|
|
|
14727
|
-
|table|<a href="#uitablecustomization"
|
|
14728
|
-
|tabs|<a href="#uitabscustomization">UiTabsCustomization</a>|
|
|
15019
|
+
|callback|<a href="#uicallbackcustomization">UiCallbackCustomization</a>|
|
|
15020
|
+
|expandable|<a href="#uiexpandablecustomization" target="_blank" rel="noopener noreferrer">UiExpandableCustomization</a>|
|
|
15021
|
+
|table|<a href="#uitablecustomization">UiTableCustomization</a>|
|
|
15022
|
+
|tabs|<a href="#uitabscustomization" target="_blank" rel="noopener noreferrer">UiTabsCustomization</a>|
|
|
14729
15023
|
|
|
14730
15024
|
### UiEmptyStateCustomization
|
|
14731
15025
|
|
|
@@ -14749,7 +15043,7 @@ UI customization for expandable section
|
|
|
14749
15043
|
| --- | --- | --- |
|
|
14750
15044
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name |
|
|
14751
15045
|
|expanded|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Defines if the item should be expanded by default |
|
|
14752
|
-
|sections|Array<<a href="#uiexpandablesectioncustomization"
|
|
15046
|
+
|sections|Array<<a href="#uiexpandablesectioncustomization">UiExpandableSectionCustomization</a>>|A list of sections |
|
|
14753
15047
|
|
|
14754
15048
|
### UiExpandableSectionCustomization
|
|
14755
15049
|
|
|
@@ -14791,7 +15085,7 @@ Customization for UI table columns
|
|
|
14791
15085
|
|columnRef|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The referenced column from the 'tableColumns' property of the schema for this column. |
|
|
14792
15086
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name for this column. |
|
|
14793
15087
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The id for this column used for filtering. Required for conflicting or pathed columns - otherwise the ref is used. |
|
|
14794
|
-
|items|Array<<a href="#uitablecolumnitemcustomization">UiTableColumnItemCustomization</a>>|The possible items of this column. |
|
|
15088
|
+
|items|Array<<a href="#uitablecolumnitemcustomization" target="_blank" rel="noopener noreferrer">UiTableColumnItemCustomization</a>>|The possible items of this column. |
|
|
14795
15089
|
|propertyRef|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The referenced property for this column. |
|
|
14796
15090
|
|type|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ui specific type for this column. |
|
|
14797
15091
|
|width|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The width this column should take up on the table. |
|
|
@@ -14818,8 +15112,8 @@ Customization for UI tables
|
|
|
14818
15112
|
|
|
14819
15113
|
| Name | Type | Description |
|
|
14820
15114
|
| --- | --- | --- |
|
|
14821
|
-
|columns|Array<<a href="#uitablecolumncustomization"
|
|
14822
|
-
|emptyState|<a href="#uiemptystatecustomization">UiEmptyStateCustomization</a>| |
|
|
15115
|
+
|columns|Array<<a href="#uitablecolumncustomization">UiTableColumnCustomization</a>>|A list of columns for the UI table |
|
|
15116
|
+
|emptyState|<a href="#uiemptystatecustomization" target="_blank" rel="noopener noreferrer">UiEmptyStateCustomization</a>| |
|
|
14823
15117
|
|
|
14824
15118
|
### UiTabsCustomization
|
|
14825
15119
|
|
|
@@ -14830,7 +15124,7 @@ UI customization for tabs
|
|
|
14830
15124
|
|
|
14831
15125
|
| Name | Type | Description |
|
|
14832
15126
|
| --- | --- | --- |
|
|
14833
|
-
|groups|Array<<a href="#uitabgroupcustomization"
|
|
15127
|
+
|groups|Array<<a href="#uitabgroupcustomization">UiTabGroupCustomization</a>>|A list of groups |
|
|
14834
15128
|
|
|
14835
15129
|
### Unit
|
|
14836
15130
|
|
|
@@ -14869,7 +15163,7 @@ A list of units along with their properties.
|
|
|
14869
15163
|
| Name | Type | Description |
|
|
14870
15164
|
| --- | --- | --- |
|
|
14871
15165
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of units in the result. |
|
|
14872
|
-
|units<sup>*required</sup>|Array<<a href="#unit">Unit</a>>|A list of units. |
|
|
15166
|
+
|units<sup>*required</sup>|Array<<a href="#unit" target="_blank" rel="noopener noreferrer">Unit</a>>|A list of units. |
|
|
14873
15167
|
|
|
14874
15168
|
### UpdateJob
|
|
14875
15169
|
|
|
@@ -14903,7 +15197,7 @@ A list of update jobs of the ActiveGate.
|
|
|
14903
15197
|
| Name | Type | Description |
|
|
14904
15198
|
| --- | --- | --- |
|
|
14905
15199
|
|agId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the ActiveGate. |
|
|
14906
|
-
|updateJobs|Array<<a href="#updatejob"
|
|
15200
|
+
|updateJobs|Array<<a href="#updatejob">UpdateJob</a>>|A list of update jobs of the ActiveGate. |
|
|
14907
15201
|
|
|
14908
15202
|
### UpdateJobsAll
|
|
14909
15203
|
|
|
@@ -14914,7 +15208,7 @@ A list of ActiveGates with update jobs.
|
|
|
14914
15208
|
|
|
14915
15209
|
| Name | Type | Description |
|
|
14916
15210
|
| --- | --- | --- |
|
|
14917
|
-
|allUpdateJobs|Array<<a href="#updatejoblist">UpdateJobList</a>>|A list of ActiveGates with update jobs. |
|
|
15211
|
+
|allUpdateJobs|Array<<a href="#updatejoblist" target="_blank" rel="noopener noreferrer">UpdateJobList</a>>|A list of ActiveGates with update jobs. |
|
|
14918
15212
|
|
|
14919
15213
|
### UserPasswordCredentials
|
|
14920
15214
|
|
|
@@ -14926,15 +15220,15 @@ A credentials set of the `USERNAME_PASSWORD` type.
|
|
|
14926
15220
|
| Name | Type | Description |
|
|
14927
15221
|
| --- | --- | --- |
|
|
14928
15222
|
|allowContextlessRequests|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope). |
|
|
14929
|
-
|allowedEntities|Array<<a href="#credentialaccessdata"
|
|
15223
|
+
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
14930
15224
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
14931
|
-
|externalVault|<a href="#externalvault">ExternalVault</a>| |
|
|
15225
|
+
|externalVault|<a href="#externalvault" target="_blank" rel="noopener noreferrer">ExternalVault</a>| |
|
|
14932
15226
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
14933
15227
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
14934
15228
|
|ownerAccessOnly|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The credentials set is available to every user (<code>false</code>) or to owner only (<code>true</code>). |
|
|
14935
15229
|
|password|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The password of the credential. |
|
|
14936
15230
|
|scope|CredentialsScope| |
|
|
14937
|
-
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>
|
|
15231
|
+
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
14938
15232
|
|type|CredentialsType| |
|
|
14939
15233
|
|user|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The username of the credentials set. |
|
|
14940
15234
|
|
|
@@ -14947,10 +15241,23 @@ A credentials set of the `USERNAME_PASSWORD` type.
|
|
|
14947
15241
|
|
|
14948
15242
|
| Name | Type |
|
|
14949
15243
|
| --- | --- |
|
|
14950
|
-
|error|<a href="#metricingesterror"
|
|
15244
|
+
|error|<a href="#metricingesterror">MetricIngestError</a>|
|
|
14951
15245
|
|linesInvalid|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|
|
|
14952
15246
|
|linesOk|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|
|
|
14953
|
-
|warnings|<a href="#warnings">Warnings</a>|
|
|
15247
|
+
|warnings|<a href="#warnings" target="_blank" rel="noopener noreferrer">Warnings</a>|
|
|
15248
|
+
|
|
15249
|
+
### Value
|
|
15250
|
+
|
|
15251
|
+
|
|
15252
|
+
|
|
15253
|
+
|
|
15254
|
+
The information about settings value containing personal data.
|
|
15255
|
+
|
|
15256
|
+
| Name | Type | Description |
|
|
15257
|
+
| --- | --- | --- |
|
|
15258
|
+
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short summary of the settings object. This can contain Markdown and will be escaped accordingly. |
|
|
15259
|
+
|objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
|
|
15260
|
+
|pii<sup>*required</sup>|<a href="#pii">Pii</a>| |
|
|
14954
15261
|
|
|
14955
15262
|
### Vulnerability
|
|
14956
15263
|
|
|
@@ -15369,7 +15676,7 @@ The type of the ActiveGate.
|
|
|
15369
15676
|
|
|
15370
15677
|
<div class="padding-left--md">
|
|
15371
15678
|
|
|
15372
|
-
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdaptiveTrafficManagementRead` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `OpenpipelineEvents` | `OpenpipelineEventsCustom` | `OpenpipelineEventsSecurity` | `OpenpipelineEventsSecurityCustom` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `WriteConfig`
|
|
15679
|
+
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdaptiveTrafficManagementRead` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `OpenpipelineEvents` | `OpenpipelineEventsCustom` | `OpenpipelineEventsSecurity` | `OpenpipelineEventsSecurityCustom` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumCookieNamesRead` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `WriteConfig`
|
|
15373
15680
|
|
|
15374
15681
|
</div>
|
|
15375
15682
|
|
|
@@ -15387,7 +15694,7 @@ The type of the ActiveGate.
|
|
|
15387
15694
|
|
|
15388
15695
|
<div class="padding-left--md">
|
|
15389
15696
|
|
|
15390
|
-
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdaptiveTrafficManagementRead` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DiagnosticExport` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MemoryDump` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `Mobile` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `OpenpipelineEvents` | `OpenpipelineEventsCustom` | `OpenpipelineEventsSecurity` | `OpenpipelineEventsSecurityCustom` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `ViewDashboard` | `ViewReport` | `WriteConfig` | `WriteSyntheticData`
|
|
15697
|
+
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdaptiveTrafficManagementRead` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DiagnosticExport` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MemoryDump` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `Mobile` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `OpenpipelineEvents` | `OpenpipelineEventsCustom` | `OpenpipelineEventsSecurity` | `OpenpipelineEventsSecurityCustom` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumCookieNamesRead` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsPrivacyRead` | `SettingsPrivacyWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `ViewDashboard` | `ViewReport` | `WriteConfig` | `WriteSyntheticData`
|
|
15391
15698
|
|
|
15392
15699
|
</div>
|
|
15393
15700
|
|
|
@@ -15405,7 +15712,7 @@ The type of the ActiveGate.
|
|
|
15405
15712
|
|
|
15406
15713
|
<div class="padding-left--md">
|
|
15407
15714
|
|
|
15408
|
-
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdaptiveTrafficManagementRead` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `OpenpipelineEvents` | `OpenpipelineEventsCustom` | `OpenpipelineEventsSecurity` | `OpenpipelineEventsSecurityCustom` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `WriteConfig`
|
|
15715
|
+
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdaptiveTrafficManagementRead` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `OpenpipelineEvents` | `OpenpipelineEventsCustom` | `OpenpipelineEventsSecurity` | `OpenpipelineEventsSecurityCustom` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumCookieNamesRead` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `WriteConfig`
|
|
15409
15716
|
|
|
15410
15717
|
</div>
|
|
15411
15718
|
|
|
@@ -15531,7 +15838,7 @@ The category of the recorded operation.
|
|
|
15531
15838
|
|
|
15532
15839
|
<div class="padding-left--md">
|
|
15533
15840
|
|
|
15534
|
-
`
|
|
15841
|
+
`ActivegateToken` | `Config` | `ManualTaggingService` | `Token` | `WebUi`
|
|
15535
15842
|
|
|
15536
15843
|
</div>
|
|
15537
15844
|
|
|
@@ -15560,7 +15867,7 @@ The type of the recorded operation.
|
|
|
15560
15867
|
|
|
15561
15868
|
<div class="padding-left--md">
|
|
15562
15869
|
|
|
15563
|
-
`Create` | `Delete` | `Login` | `Logout` | `
|
|
15870
|
+
`Create` | `Delete` | `Login` | `Logout` | `Revoke` | `TagAdd` | `TagRemove` | `TagUpdate` | `Update`
|
|
15564
15871
|
|
|
15565
15872
|
</div>
|
|
15566
15873
|
|
|
@@ -15727,7 +16034,7 @@ The set of scopes of the credentials set.
|
|
|
15727
16034
|
|
|
15728
16035
|
<div class="padding-left--md">
|
|
15729
16036
|
|
|
15730
|
-
`Extension` | `Synthetic`
|
|
16037
|
+
`AppEngine` | `Extension` | `Synthetic`
|
|
15731
16038
|
|
|
15732
16039
|
</div>
|
|
15733
16040
|
|
|
@@ -15777,11 +16084,13 @@ The scope of the credentials set.
|
|
|
15777
16084
|
|
|
15778
16085
|
The set of scopes of the credentials set.
|
|
15779
16086
|
|
|
16087
|
+
Limitations: `CredentialsScope.APP_ENGINE` is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.
|
|
16088
|
+
|
|
15780
16089
|
#### Enum keys
|
|
15781
16090
|
|
|
15782
16091
|
<div class="padding-left--md">
|
|
15783
16092
|
|
|
15784
|
-
`Extension` | `Synthetic`
|
|
16093
|
+
`AppEngine` | `Extension` | `Synthetic`
|
|
15785
16094
|
|
|
15786
16095
|
</div>
|
|
15787
16096
|
|
|
@@ -15858,7 +16167,7 @@ The technology of the vulnerable component.
|
|
|
15858
16167
|
|
|
15859
16168
|
<div class="padding-left--md">
|
|
15860
16169
|
|
|
15861
|
-
`Dotnet` | `Go` | `Java` | `Kubernetes` | `NodeJs` | `Php`
|
|
16170
|
+
`Dotnet` | `Go` | `Java` | `Kubernetes` | `NodeJs` | `Php` | `Python`
|
|
15862
16171
|
|
|
15863
16172
|
</div>
|
|
15864
16173
|
|
|
@@ -16513,6 +16822,24 @@ Type of this filter, determines which other fields are present.Can be any of:
|
|
|
16513
16822
|
</div>
|
|
16514
16823
|
|
|
16515
16824
|
|
|
16825
|
+
</div>
|
|
16826
|
+
|
|
16827
|
+
<a name="getlocationsquerycapability"></a>
|
|
16828
|
+
### GetLocationsQueryCapability
|
|
16829
|
+
|
|
16830
|
+
<div class="padding-left--md">
|
|
16831
|
+
|
|
16832
|
+
|
|
16833
|
+
|
|
16834
|
+
#### Enum keys
|
|
16835
|
+
|
|
16836
|
+
<div class="padding-left--md">
|
|
16837
|
+
|
|
16838
|
+
`Browser` | `Dns` | `Http` | `Icmp` | `Tcp`
|
|
16839
|
+
|
|
16840
|
+
</div>
|
|
16841
|
+
|
|
16842
|
+
|
|
16516
16843
|
</div>
|
|
16517
16844
|
|
|
16518
16845
|
<a name="getlocationsquerycloudplatform"></a>
|
|
@@ -17032,6 +17359,24 @@ The fallback mode of the network zone.
|
|
|
17032
17359
|
</div>
|
|
17033
17360
|
|
|
17034
17361
|
|
|
17362
|
+
</div>
|
|
17363
|
+
|
|
17364
|
+
<a name="piirelationshipsitem"></a>
|
|
17365
|
+
### PiiRelationshipsItem
|
|
17366
|
+
|
|
17367
|
+
<div class="padding-left--md">
|
|
17368
|
+
|
|
17369
|
+
|
|
17370
|
+
|
|
17371
|
+
#### Enum keys
|
|
17372
|
+
|
|
17373
|
+
<div class="padding-left--md">
|
|
17374
|
+
|
|
17375
|
+
`Creator` | `LastModifier` | `Modifier` | `Owner`
|
|
17376
|
+
|
|
17377
|
+
</div>
|
|
17378
|
+
|
|
17379
|
+
|
|
17035
17380
|
</div>
|
|
17036
17381
|
|
|
17037
17382
|
<a name="preconditiontype"></a>
|
|
@@ -17897,7 +18242,7 @@ The technology of the security problem.
|
|
|
17897
18242
|
|
|
17898
18243
|
<div class="padding-left--md">
|
|
17899
18244
|
|
|
17900
|
-
`Dotnet` | `Go` | `Java` | `Kubernetes` | `NodeJs` | `Php`
|
|
18245
|
+
`Dotnet` | `Go` | `Java` | `Kubernetes` | `NodeJs` | `Php` | `Python`
|
|
17901
18246
|
|
|
17902
18247
|
</div>
|
|
17903
18248
|
|
|
@@ -17987,7 +18332,7 @@ The technology of the security problem.
|
|
|
17987
18332
|
|
|
17988
18333
|
<div class="padding-left--md">
|
|
17989
18334
|
|
|
17990
|
-
`Dotnet` | `Go` | `Java` | `Kubernetes` | `NodeJs` | `Php`
|
|
18335
|
+
`Dotnet` | `Go` | `Java` | `Kubernetes` | `NodeJs` | `Php` | `Python`
|
|
17991
18336
|
|
|
17992
18337
|
</div>
|
|
17993
18338
|
|