@dynatrace-sdk/client-classic-environment-v2 3.5.0 → 3.6.1
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 +19 -0
- package/README.md +994 -246
- package/cjs/index.js +5325 -3529
- package/dynatrace-metadata.json +2 -2
- package/esm/index.js +3388 -1600
- package/package.json +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-api.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +251 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/index.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/accessor-permissions-list.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/accessor-permissions-list.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/accessor-permissions-permissions-item.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/accessor-permissions-permissions-item.transformation.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/accessor-permissions.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/accessor-permissions.transformation.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-category.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-category.transformation.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/effective-permission.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/effective-permission.transformation.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/get-permission-path-accessor-type.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/get-permission-path-accessor-type.transformation.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +182 -162
- package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.d.ts +8 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-state.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-state.transformation.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/private-synthetic-location-node-names.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/private-synthetic-location-node-names.transformation.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/private-synthetic-location.d.ts +5 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/private-synthetic-location.transformation.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remove-permission-path-accessor-type.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remove-permission-path-accessor-type.transformation.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/resolution-request.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/resolution-request.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/revision-diff.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-create.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-update.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/slo.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/slo.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/transfer-ownership-request.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/transfer-ownership-request.transformation.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/update-permission-path-accessor-type.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/update-permission-path-accessor-type.transformation.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/update-permissions-request-permissions-item.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/update-permissions-request-permissions-item.transformation.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/update-permissions-request.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/update-permissions-request.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/error-serializer.d.ts +0 -3
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/3.6.1)
|
|
4
4
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
5
5
|
|
|
6
6
|
|
|
@@ -1820,8 +1820,8 @@ The response includes all ActiveGates that are currently connected to the enviro
|
|
|
1820
1820
|
| --- | --- | --- |
|
|
1821
1821
|
|config.autoUpdate|"ENABLED" | "DISABLED"|Filters the resulting set of ActiveGates by the actual state of auto-update. |
|
|
1822
1822
|
|config.containerized|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Filters the resulting set of ActiveGates to those which are running in container (<code>true</code>) or not (<code>false</code>). |
|
|
1823
|
-
|config.disabledModule|"SYNTHETIC" | "AWS" | "AZURE" | "BEACON_FORWARDER" | "CLOUD_FOUNDRY" | "DB_INSIGHT" | "EXTENSIONS_V1" | "EXTENSIONS_V2" | "KUBERNETES" | "LOGS" | "MEMORY_DUMPS" | "METRIC_API" | "ONE_AGENT_ROUTING" | "OTLP_INGEST" | "REST_API" | "VMWARE" | "Z_OS"
|
|
1824
|
-
|config.enabledModule|"SYNTHETIC" | "AWS" | "AZURE" | "BEACON_FORWARDER" | "CLOUD_FOUNDRY" | "DB_INSIGHT" | "EXTENSIONS_V1" | "EXTENSIONS_V2" | "KUBERNETES" | "LOGS" | "MEMORY_DUMPS" | "METRIC_API" | "ONE_AGENT_ROUTING" | "OTLP_INGEST" | "REST_API" | "VMWARE" | "Z_OS"
|
|
1823
|
+
|config.disabledModule|Array<"SYNTHETIC" | "AWS" | "AZURE" | "BEACON_FORWARDER" | "CLOUD_FOUNDRY" | "DB_INSIGHT" | "EXTENSIONS_V1" | "EXTENSIONS_V2" | "KUBERNETES" | "LOGS" | "MEMORY_DUMPS" | "METRIC_API" | "ONE_AGENT_ROUTING" | "OTLP_INGEST" | "REST_API" | "VMWARE" | "Z_OS">|Filters the resulting set of ActiveGates by the disabled modules. |
|
|
1824
|
+
|config.enabledModule|Array<"SYNTHETIC" | "AWS" | "AZURE" | "BEACON_FORWARDER" | "CLOUD_FOUNDRY" | "DB_INSIGHT" | "EXTENSIONS_V1" | "EXTENSIONS_V2" | "KUBERNETES" | "LOGS" | "MEMORY_DUMPS" | "METRIC_API" | "ONE_AGENT_ROUTING" | "OTLP_INGEST" | "REST_API" | "VMWARE" | "Z_OS">|Filters the resulting set of ActiveGates by the enabled modules. |
|
|
1825
1825
|
|config.group|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Filters the resulting set of ActiveGates by the group.</p> <p>You can specify a partial name. In that case, the <code>CONTAINS</code> operator is used.</p> |
|
|
1826
1826
|
|config.hostname|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Filters the resulting set of ActiveGates by the name of the host it's running on.</p> <p>You can specify a partial name. In that case, the <code>CONTAINS</code> operator is used.</p> |
|
|
1827
1827
|
|config.loadBalancerAddress|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Filters the resulting set of ActiveGates by the Load Balancer address.</p> <p>You can specify a partial address. In that case, the <code>CONTAINS</code> operator is used.</p> |
|
|
@@ -2518,7 +2518,7 @@ The credentials set itself (username/certificate and password) is not included i
|
|
|
2518
2518
|
|config.nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
2519
2519
|
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The amount of credentials in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p> |
|
|
2520
2520
|
|config.scope|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Filters credentials with specified scope. |
|
|
2521
|
-
|config.type|"
|
|
2521
|
+
|config.type|"CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"|Filters the result by the specified credentials type. |
|
|
2522
2522
|
|config.user|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Filters credentials accessible to the user (owned by the user or the ones that are accessible for all). |
|
|
2523
2523
|
|
|
2524
2524
|
|
|
@@ -9215,6 +9215,72 @@ import { settingsObjectsClient } from '@dynatrace-sdk/client-classic-environment
|
|
|
9215
9215
|
```
|
|
9216
9216
|
|
|
9217
9217
|
|
|
9218
|
+
<a name="addpermission"></a>
|
|
9219
|
+
### addPermission
|
|
9220
|
+
|
|
9221
|
+
<div class="padding-bottom--md">
|
|
9222
|
+
<strong>settingsObjectsClient.addPermission(config): Promise<<a href="#accessorpermissions" target="_blank" rel="noopener noreferrer">AccessorPermissions</a>></strong>
|
|
9223
|
+
|
|
9224
|
+
<div class="padding-left--md">
|
|
9225
|
+
|
|
9226
|
+
Add the permissions for a single accessor on this object.
|
|
9227
|
+
|
|
9228
|
+
**Required scope:** settings:objects:write
|
|
9229
|
+
**Required permission:** settings:objects:write
|
|
9230
|
+
|
|
9231
|
+
Add the permissions for a single accessor on this object, anyone with read/write permissions is allowed to add more permissions.
|
|
9232
|
+
|
|
9233
|
+
|
|
9234
|
+
|
|
9235
|
+
</div>
|
|
9236
|
+
|
|
9237
|
+
|
|
9238
|
+
#### Parameters
|
|
9239
|
+
|
|
9240
|
+
| Name | Type | Description |
|
|
9241
|
+
| --- | --- | --- |
|
|
9242
|
+
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
9243
|
+
|config.body<sup>*required</sup>|<a href="#accessorpermissions">AccessorPermissions</a>| |
|
|
9244
|
+
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
9245
|
+
|
|
9246
|
+
|
|
9247
|
+
|
|
9248
|
+
|
|
9249
|
+
#### Returns
|
|
9250
|
+
|
|
9251
|
+
| Return type | Status code | Description |
|
|
9252
|
+
|---|---|---|
|
|
9253
|
+
|[AccessorPermissions](#accessorpermissions)|201|Created|
|
|
9254
|
+
|
|
9255
|
+
|
|
9256
|
+
#### Throws
|
|
9257
|
+
|
|
9258
|
+
| Error Type | Error Message |
|
|
9259
|
+
|---|---|
|
|
9260
|
+
|ErrorEnvelopeError|If accessor id already exists. \| Failed. Forbidden. \| No object available for the given objectId. \| Client side error. \| Server side error.|
|
|
9261
|
+
|
|
9262
|
+
|
|
9263
|
+
<details>
|
|
9264
|
+
<summary>
|
|
9265
|
+
Code example
|
|
9266
|
+
</summary>
|
|
9267
|
+
|
|
9268
|
+
```ts
|
|
9269
|
+
import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
9270
|
+
|
|
9271
|
+
const data = await settingsObjectsClient.addPermission({
|
|
9272
|
+
objectId: "...",
|
|
9273
|
+
body: { accessor: { type: IdentityType.User } },
|
|
9274
|
+
});
|
|
9275
|
+
```
|
|
9276
|
+
|
|
9277
|
+
</details>
|
|
9278
|
+
|
|
9279
|
+
|
|
9280
|
+
|
|
9281
|
+
</div>
|
|
9282
|
+
|
|
9283
|
+
|
|
9218
9284
|
<a name="deletesettingsobjectbyobjectid"></a>
|
|
9219
9285
|
### deleteSettingsObjectByObjectId
|
|
9220
9286
|
|
|
@@ -9239,6 +9305,7 @@ Deletes the specified settings object
|
|
|
9239
9305
|
|
|
9240
9306
|
| Name | Type | Description |
|
|
9241
9307
|
| --- | --- | --- |
|
|
9308
|
+
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
9242
9309
|
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
9243
9310
|
|config.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> |
|
|
9244
9311
|
|
|
@@ -9313,6 +9380,7 @@ If no object along the hierarchy is persisted, the default value as defined in t
|
|
|
9313
9380
|
|
|
9314
9381
|
| Name | Type | Description |
|
|
9315
9382
|
| --- | --- | --- |
|
|
9383
|
+
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
9316
9384
|
|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>origin,value</code>).</p> <p>Supported fields: <code>summary</code>, <code>searchSummary</code>, <code>created</code>, <code>modified</code>, <code>createdBy</code>, <code>modifiedBy</code>, <code>author</code>, <code>origin</code>, <code>schemaId</code>, <code>schemaVersion</code>, <code>value</code>, <code>externalId</code>.</p> |
|
|
9317
9385
|
|config.nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
9318
9386
|
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The amount of settings objects in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p> |
|
|
@@ -9352,6 +9420,203 @@ const data =
|
|
|
9352
9420
|
|
|
9353
9421
|
|
|
9354
9422
|
|
|
9423
|
+
</div>
|
|
9424
|
+
|
|
9425
|
+
|
|
9426
|
+
<a name="getpermission"></a>
|
|
9427
|
+
### getPermission
|
|
9428
|
+
|
|
9429
|
+
<div class="padding-bottom--md">
|
|
9430
|
+
<strong>settingsObjectsClient.getPermission(config): Promise<<a href="#accessorpermissions">AccessorPermissions</a>></strong>
|
|
9431
|
+
|
|
9432
|
+
<div class="padding-left--md">
|
|
9433
|
+
|
|
9434
|
+
Get current permissions of the accessor on this object.
|
|
9435
|
+
|
|
9436
|
+
**Required scope:** settings:objects:read
|
|
9437
|
+
**Required permission:** settings:objects:read
|
|
9438
|
+
|
|
9439
|
+
Get current permissions of the accessor on this object.
|
|
9440
|
+
|
|
9441
|
+
|
|
9442
|
+
|
|
9443
|
+
</div>
|
|
9444
|
+
|
|
9445
|
+
|
|
9446
|
+
#### Parameters
|
|
9447
|
+
|
|
9448
|
+
| Name | Type | Description |
|
|
9449
|
+
| --- | --- | --- |
|
|
9450
|
+
|config.accessorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The user uuid or group uuid of the accessor, depending on the type. |
|
|
9451
|
+
|config.accessorType<sup>*required</sup>|"group" | "user"|The type of the accessor. |
|
|
9452
|
+
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
9453
|
+
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
9454
|
+
|
|
9455
|
+
|
|
9456
|
+
|
|
9457
|
+
|
|
9458
|
+
#### Returns
|
|
9459
|
+
|
|
9460
|
+
| Return type | Status code | Description |
|
|
9461
|
+
|---|---|---|
|
|
9462
|
+
|[AccessorPermissions](#accessorpermissions)|200|Success|
|
|
9463
|
+
|
|
9464
|
+
|
|
9465
|
+
#### Throws
|
|
9466
|
+
|
|
9467
|
+
| Error Type | Error Message |
|
|
9468
|
+
|---|---|
|
|
9469
|
+
|ErrorEnvelopeError|No object available for the given objectId or the accessor doesn't have any permissions on this object. \| Client side error. \| Server side error.|
|
|
9470
|
+
|
|
9471
|
+
|
|
9472
|
+
<details>
|
|
9473
|
+
<summary>
|
|
9474
|
+
Code example
|
|
9475
|
+
</summary>
|
|
9476
|
+
|
|
9477
|
+
```ts
|
|
9478
|
+
import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
9479
|
+
|
|
9480
|
+
const data = await settingsObjectsClient.getPermission({
|
|
9481
|
+
objectId: "...",
|
|
9482
|
+
accessorType: GetPermissionPathAccessorType.Group,
|
|
9483
|
+
accessorId: "...",
|
|
9484
|
+
});
|
|
9485
|
+
```
|
|
9486
|
+
|
|
9487
|
+
</details>
|
|
9488
|
+
|
|
9489
|
+
|
|
9490
|
+
|
|
9491
|
+
</div>
|
|
9492
|
+
|
|
9493
|
+
|
|
9494
|
+
<a name="getpermissionallusers"></a>
|
|
9495
|
+
### getPermissionAllUsers
|
|
9496
|
+
|
|
9497
|
+
<div class="padding-bottom--md">
|
|
9498
|
+
<strong>settingsObjectsClient.getPermissionAllUsers(config): Promise<<a href="#accessorpermissions" target="_blank" rel="noopener noreferrer">AccessorPermissions</a>></strong>
|
|
9499
|
+
|
|
9500
|
+
<div class="padding-left--md">
|
|
9501
|
+
|
|
9502
|
+
Get current permissions of the all-users accessor on this object.
|
|
9503
|
+
|
|
9504
|
+
**Required scope:** settings:objects:read
|
|
9505
|
+
**Required permission:** settings:objects:read
|
|
9506
|
+
|
|
9507
|
+
Get current permissions of the all-users accessor on this object.
|
|
9508
|
+
|
|
9509
|
+
|
|
9510
|
+
|
|
9511
|
+
</div>
|
|
9512
|
+
|
|
9513
|
+
|
|
9514
|
+
#### Parameters
|
|
9515
|
+
|
|
9516
|
+
| Name | Type | Description |
|
|
9517
|
+
| --- | --- | --- |
|
|
9518
|
+
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
9519
|
+
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
9520
|
+
|
|
9521
|
+
|
|
9522
|
+
|
|
9523
|
+
|
|
9524
|
+
#### Returns
|
|
9525
|
+
|
|
9526
|
+
| Return type | Status code | Description |
|
|
9527
|
+
|---|---|---|
|
|
9528
|
+
|[AccessorPermissions](#accessorpermissions)|200|Success|
|
|
9529
|
+
|
|
9530
|
+
|
|
9531
|
+
#### Throws
|
|
9532
|
+
|
|
9533
|
+
| Error Type | Error Message |
|
|
9534
|
+
|---|---|
|
|
9535
|
+
|ErrorEnvelopeError|No object available for the given objectId or the all-users accessor doesn't have any permissions on this object. \| Client side error. \| Server side error.|
|
|
9536
|
+
|
|
9537
|
+
|
|
9538
|
+
<details>
|
|
9539
|
+
<summary>
|
|
9540
|
+
Code example
|
|
9541
|
+
</summary>
|
|
9542
|
+
|
|
9543
|
+
```ts
|
|
9544
|
+
import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
9545
|
+
|
|
9546
|
+
const data =
|
|
9547
|
+
await settingsObjectsClient.getPermissionAllUsers({
|
|
9548
|
+
objectId: "...",
|
|
9549
|
+
});
|
|
9550
|
+
```
|
|
9551
|
+
|
|
9552
|
+
</details>
|
|
9553
|
+
|
|
9554
|
+
|
|
9555
|
+
|
|
9556
|
+
</div>
|
|
9557
|
+
|
|
9558
|
+
|
|
9559
|
+
<a name="getpermissions"></a>
|
|
9560
|
+
### getPermissions
|
|
9561
|
+
|
|
9562
|
+
<div class="padding-bottom--md">
|
|
9563
|
+
<strong>settingsObjectsClient.getPermissions(config): Promise<Array<<a href="#accessorpermissionslist">AccessorPermissionsList</a>>></strong>
|
|
9564
|
+
|
|
9565
|
+
<div class="padding-left--md">
|
|
9566
|
+
|
|
9567
|
+
Get current permissions on this object.
|
|
9568
|
+
|
|
9569
|
+
**Required scope:** settings:objects:read
|
|
9570
|
+
**Required permission:** settings:objects:read
|
|
9571
|
+
|
|
9572
|
+
Get current permissions on this object.
|
|
9573
|
+
|
|
9574
|
+
|
|
9575
|
+
|
|
9576
|
+
</div>
|
|
9577
|
+
|
|
9578
|
+
|
|
9579
|
+
#### Parameters
|
|
9580
|
+
|
|
9581
|
+
| Name | Type | Description |
|
|
9582
|
+
| --- | --- | --- |
|
|
9583
|
+
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
9584
|
+
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
9585
|
+
|
|
9586
|
+
|
|
9587
|
+
|
|
9588
|
+
|
|
9589
|
+
#### Returns
|
|
9590
|
+
|
|
9591
|
+
| Return type | Status code | Description |
|
|
9592
|
+
|---|---|---|
|
|
9593
|
+
|[AccessorPermissionsList](#accessorpermissionslist)|200|Success|
|
|
9594
|
+
|
|
9595
|
+
|
|
9596
|
+
#### Throws
|
|
9597
|
+
|
|
9598
|
+
| Error Type | Error Message |
|
|
9599
|
+
|---|---|
|
|
9600
|
+
|ErrorEnvelopeError|No object available for the given objectId. \| Client side error. \| Server side error.|
|
|
9601
|
+
|
|
9602
|
+
|
|
9603
|
+
<details>
|
|
9604
|
+
<summary>
|
|
9605
|
+
Code example
|
|
9606
|
+
</summary>
|
|
9607
|
+
|
|
9608
|
+
```ts
|
|
9609
|
+
import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
9610
|
+
|
|
9611
|
+
const data = await settingsObjectsClient.getPermissions({
|
|
9612
|
+
objectId: "...",
|
|
9613
|
+
});
|
|
9614
|
+
```
|
|
9615
|
+
|
|
9616
|
+
</details>
|
|
9617
|
+
|
|
9618
|
+
|
|
9619
|
+
|
|
9355
9620
|
</div>
|
|
9356
9621
|
|
|
9357
9622
|
|
|
@@ -9359,7 +9624,7 @@ const data =
|
|
|
9359
9624
|
### getSettingsHistory
|
|
9360
9625
|
|
|
9361
9626
|
<div class="padding-bottom--md">
|
|
9362
|
-
<strong>settingsObjectsClient.getSettingsHistory(config): Promise<<a href="#revisiondiffpage">RevisionDiffPage</a>></strong>
|
|
9627
|
+
<strong>settingsObjectsClient.getSettingsHistory(config): Promise<<a href="#revisiondiffpage" target="_blank" rel="noopener noreferrer">RevisionDiffPage</a>></strong>
|
|
9363
9628
|
|
|
9364
9629
|
<div class="padding-left--md">
|
|
9365
9630
|
|
|
@@ -9379,6 +9644,7 @@ Gets the history of settings objects
|
|
|
9379
9644
|
|
|
9380
9645
|
| Name | Type | Description |
|
|
9381
9646
|
| --- | --- | --- |
|
|
9647
|
+
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
9382
9648
|
|config.fields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A list of fields to be included to the response.Specify the required top-level fields, separated by commas (for example, <strong>revision,modificationInfo</strong>). Supported fields: <strong>revision</strong>, <strong>jsonPatch</strong>, <strong>jsonBefore</strong>, <strong>jsonAfter</strong>, <strong>objectId</strong>, <strong>type</strong>, <strong>schemaVersion</strong>, <strong>modificationInfo</strong>.(optional, default to revision, modificationInfo) |
|
|
9383
9649
|
|config.filter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The filter parameter, as explained <a href="https://dt-url.net/platform-services-filtering" target="_blank" rel="noopener noreferrer" >here</a>. Filtering is supported on the following fields:</p> <ul> <li><code>objectId</code></li> <li><code>modificationInfo.lastModifiedTime</code></li> </ul> <p>The fields can only be combined with <code>and</code> as a boolean operator. If this parameter is omitted or does not include a range for <strong>modificationInfo.lastModifiedTime</strong>, only revisions of the last 2 weeks are returned. (optional)</p> |
|
|
9384
9650
|
|config.nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
@@ -9427,7 +9693,7 @@ const data =
|
|
|
9427
9693
|
### getSettingsObjectByObjectId
|
|
9428
9694
|
|
|
9429
9695
|
<div class="padding-bottom--md">
|
|
9430
|
-
<strong>settingsObjectsClient.getSettingsObjectByObjectId(config): Promise<<a href="#settingsobjectbyobjectidresponse"
|
|
9696
|
+
<strong>settingsObjectsClient.getSettingsObjectByObjectId(config): Promise<<a href="#settingsobjectbyobjectidresponse">SettingsObjectByObjectIdResponse</a>></strong>
|
|
9431
9697
|
|
|
9432
9698
|
<div class="padding-left--md">
|
|
9433
9699
|
|
|
@@ -9447,6 +9713,7 @@ Gets the specified settings object
|
|
|
9447
9713
|
|
|
9448
9714
|
| Name | Type | Description |
|
|
9449
9715
|
| --- | --- | --- |
|
|
9716
|
+
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
9450
9717
|
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
9451
9718
|
|
|
9452
9719
|
|
|
@@ -9491,7 +9758,7 @@ const data =
|
|
|
9491
9758
|
### getSettingsObjects
|
|
9492
9759
|
|
|
9493
9760
|
<div class="padding-bottom--md">
|
|
9494
|
-
<strong>settingsObjectsClient.getSettingsObjects(config): Promise<<a href="#objectslist">ObjectsList</a>></strong>
|
|
9761
|
+
<strong>settingsObjectsClient.getSettingsObjects(config): Promise<<a href="#objectslist" target="_blank" rel="noopener noreferrer">ObjectsList</a>></strong>
|
|
9495
9762
|
|
|
9496
9763
|
<div class="padding-left--md">
|
|
9497
9764
|
|
|
@@ -9519,6 +9786,7 @@ To query the effective values (including schema defaults) please see /settings/e
|
|
|
9519
9786
|
|
|
9520
9787
|
| Name | Type | Description |
|
|
9521
9788
|
| --- | --- | --- |
|
|
9789
|
+
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
9522
9790
|
|config.externalIds|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>A list of comma-separated external IDs that the requested objects have.</p> <p>Each external ID has a maximum length of 500 characters.</p> <p>Only considered on load of the first page, when the <strong>nextPageKey</strong> is not set.</p> |
|
|
9523
9791
|
|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>objectId,value</code>).</p> <p>Supported fields: <code>objectId</code>, <code>summary</code>, <code>searchSummary</code>, <code>created</code>, <code>modified</code>, <code>createdBy</code>, <code>modifiedBy</code>, <code>author</code>, <code>updateToken</code>, <code>scope</code>, <code>modificationInfo</code> (deprecated), <code>resourceContext</code>, <code>owner</code>, <code>schemaId</code>, <code>schemaVersion</code>, <code>value</code>, <code>externalId</code>.</p> |
|
|
9524
9792
|
|config.filter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The filter parameter, as explained <a href="https://dt-url.net/platform-services-filtering" target="_blank" rel="noopener noreferrer" >here</a>.</p> <p>Filtering is supported on the following fields:</p> <ul> <li><code>created</code></li> <li><code>modified</code></li> <li><code>createdBy</code></li> <li><code>modifiedBy</code></li> <li><code>author</code> (deprecated, will not work for future schemas)</li> <li><code>value</code> with properties and sub-properties separated by dot (for example, <code>value.owningApp = 'Notebooks'</code>)</li> </ul> <p>If this parameter is omitted, all settings objects will be returned. The maximum nesting depth (via parentheses) is 5. The maximum expression length is 1024 characters.</p> <p>Note that only fields included to the response via <code>fields</code> can be used for filtering.</p> |
|
|
@@ -9568,7 +9836,7 @@ const data =
|
|
|
9568
9836
|
### postSettingsObjects
|
|
9569
9837
|
|
|
9570
9838
|
<div class="padding-bottom--md">
|
|
9571
|
-
<strong>settingsObjectsClient.postSettingsObjects(config): Promise<Array<<a href="#settingsobjectresponse"
|
|
9839
|
+
<strong>settingsObjectsClient.postSettingsObjects(config): Promise<Array<<a href="#settingsobjectresponse">SettingsObjectResponse</a>>></strong>
|
|
9572
9840
|
|
|
9573
9841
|
<div class="padding-left--md">
|
|
9574
9842
|
|
|
@@ -9592,7 +9860,8 @@ You can upload several objects at once. In that case each object returns its own
|
|
|
9592
9860
|
|
|
9593
9861
|
| Name | Type | Description |
|
|
9594
9862
|
| --- | --- | --- |
|
|
9595
|
-
|config.
|
|
9863
|
+
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
9864
|
+
|config.body<sup>*required</sup>|Array<<a href="#settingsobjectcreate" target="_blank" rel="noopener noreferrer">SettingsObjectCreate</a>>| |
|
|
9596
9865
|
|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. |
|
|
9597
9866
|
|
|
9598
9867
|
|
|
@@ -9646,7 +9915,7 @@ const data =
|
|
|
9646
9915
|
### putSettingsObjectByObjectId
|
|
9647
9916
|
|
|
9648
9917
|
<div class="padding-bottom--md">
|
|
9649
|
-
<strong>settingsObjectsClient.putSettingsObjectByObjectId(config): Promise<<a href="#settingsobjectresponse"
|
|
9918
|
+
<strong>settingsObjectsClient.putSettingsObjectByObjectId(config): Promise<<a href="#settingsobjectresponse">SettingsObjectResponse</a>></strong>
|
|
9650
9919
|
|
|
9651
9920
|
<div class="padding-left--md">
|
|
9652
9921
|
|
|
@@ -9672,7 +9941,8 @@ Some schemas don't allow passing of the masked secret. In that case you nee
|
|
|
9672
9941
|
|
|
9673
9942
|
| Name | Type | Description |
|
|
9674
9943
|
| --- | --- | --- |
|
|
9675
|
-
|config.
|
|
9944
|
+
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
9945
|
+
|config.body<sup>*required</sup>|<a href="#settingsobjectupdate" target="_blank" rel="noopener noreferrer">SettingsObjectUpdate</a>| |
|
|
9676
9946
|
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
9677
9947
|
|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. |
|
|
9678
9948
|
|
|
@@ -9713,6 +9983,139 @@ const data =
|
|
|
9713
9983
|
|
|
9714
9984
|
|
|
9715
9985
|
|
|
9986
|
+
</div>
|
|
9987
|
+
|
|
9988
|
+
|
|
9989
|
+
<a name="removepermission"></a>
|
|
9990
|
+
### removePermission
|
|
9991
|
+
|
|
9992
|
+
<div class="padding-bottom--md">
|
|
9993
|
+
<strong>settingsObjectsClient.removePermission(config): Promise<void></strong>
|
|
9994
|
+
|
|
9995
|
+
<div class="padding-left--md">
|
|
9996
|
+
|
|
9997
|
+
Remove the permissions for an existing accessor on this object.
|
|
9998
|
+
|
|
9999
|
+
**Required scope:** settings:objects:write
|
|
10000
|
+
**Required permission:** settings:objects:write
|
|
10001
|
+
|
|
10002
|
+
Remove the permissions for an existing accessor on this object, anyone with read/write permissions is allowed to delete permissions.
|
|
10003
|
+
|
|
10004
|
+
|
|
10005
|
+
|
|
10006
|
+
</div>
|
|
10007
|
+
|
|
10008
|
+
|
|
10009
|
+
#### Parameters
|
|
10010
|
+
|
|
10011
|
+
| Name | Type | Description |
|
|
10012
|
+
| --- | --- | --- |
|
|
10013
|
+
|config.accessorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The user uuid or group uuid of the accessor, depending on the type. |
|
|
10014
|
+
|config.accessorType<sup>*required</sup>|"group" | "user"|The type of the accessor. |
|
|
10015
|
+
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
10016
|
+
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
10017
|
+
|
|
10018
|
+
|
|
10019
|
+
|
|
10020
|
+
|
|
10021
|
+
#### Returns
|
|
10022
|
+
|
|
10023
|
+
| Return type | Status code | Description |
|
|
10024
|
+
|---|---|---|
|
|
10025
|
+
|void|204|Success|
|
|
10026
|
+
|
|
10027
|
+
|
|
10028
|
+
#### Throws
|
|
10029
|
+
|
|
10030
|
+
| Error Type | Error Message |
|
|
10031
|
+
|---|---|
|
|
10032
|
+
|ErrorEnvelopeError|No object available for the given objectId or the accessor doesn't have any permissions on this object. \| Client side error. \| Server side error.|
|
|
10033
|
+
|
|
10034
|
+
|
|
10035
|
+
<details>
|
|
10036
|
+
<summary>
|
|
10037
|
+
Code example
|
|
10038
|
+
</summary>
|
|
10039
|
+
|
|
10040
|
+
```ts
|
|
10041
|
+
import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
10042
|
+
|
|
10043
|
+
const data = await settingsObjectsClient.removePermission({
|
|
10044
|
+
objectId: "...",
|
|
10045
|
+
accessorType: RemovePermissionPathAccessorType.Group,
|
|
10046
|
+
accessorId: "...",
|
|
10047
|
+
});
|
|
10048
|
+
```
|
|
10049
|
+
|
|
10050
|
+
</details>
|
|
10051
|
+
|
|
10052
|
+
|
|
10053
|
+
|
|
10054
|
+
</div>
|
|
10055
|
+
|
|
10056
|
+
|
|
10057
|
+
<a name="removepermissionallusers"></a>
|
|
10058
|
+
### removePermissionAllUsers
|
|
10059
|
+
|
|
10060
|
+
<div class="padding-bottom--md">
|
|
10061
|
+
<strong>settingsObjectsClient.removePermissionAllUsers(config): Promise<void></strong>
|
|
10062
|
+
|
|
10063
|
+
<div class="padding-left--md">
|
|
10064
|
+
|
|
10065
|
+
Remove the permissions for an existing all-users accessor on this object.
|
|
10066
|
+
|
|
10067
|
+
**Required scope:** settings:objects:write
|
|
10068
|
+
**Required permission:** settings:objects:write
|
|
10069
|
+
|
|
10070
|
+
Remove the permissions for an existing all-users accessor on this object, anyone with read/write permissions is allowed to delete permissions.
|
|
10071
|
+
|
|
10072
|
+
|
|
10073
|
+
|
|
10074
|
+
</div>
|
|
10075
|
+
|
|
10076
|
+
|
|
10077
|
+
#### Parameters
|
|
10078
|
+
|
|
10079
|
+
| Name | Type | Description |
|
|
10080
|
+
| --- | --- | --- |
|
|
10081
|
+
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
10082
|
+
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
10083
|
+
|
|
10084
|
+
|
|
10085
|
+
|
|
10086
|
+
|
|
10087
|
+
#### Returns
|
|
10088
|
+
|
|
10089
|
+
| Return type | Status code | Description |
|
|
10090
|
+
|---|---|---|
|
|
10091
|
+
|void|204|Success|
|
|
10092
|
+
|
|
10093
|
+
|
|
10094
|
+
#### Throws
|
|
10095
|
+
|
|
10096
|
+
| Error Type | Error Message |
|
|
10097
|
+
|---|---|
|
|
10098
|
+
|ErrorEnvelopeError|No object available for the given objectId or the all-users accessor doesn't have any permissions on this object. \| Client side error. \| Server side error.|
|
|
10099
|
+
|
|
10100
|
+
|
|
10101
|
+
<details>
|
|
10102
|
+
<summary>
|
|
10103
|
+
Code example
|
|
10104
|
+
</summary>
|
|
10105
|
+
|
|
10106
|
+
```ts
|
|
10107
|
+
import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
10108
|
+
|
|
10109
|
+
const data =
|
|
10110
|
+
await settingsObjectsClient.removePermissionAllUsers({
|
|
10111
|
+
objectId: "...",
|
|
10112
|
+
});
|
|
10113
|
+
```
|
|
10114
|
+
|
|
10115
|
+
</details>
|
|
10116
|
+
|
|
10117
|
+
|
|
10118
|
+
|
|
9716
10119
|
</div>
|
|
9717
10120
|
|
|
9718
10121
|
|
|
@@ -9720,7 +10123,7 @@ const data =
|
|
|
9720
10123
|
### resolveEffectivePermissions
|
|
9721
10124
|
|
|
9722
10125
|
<div class="padding-bottom--md">
|
|
9723
|
-
<strong>settingsObjectsClient.resolveEffectivePermissions(config): Promise<Array<<a href="#effectivepermission"
|
|
10126
|
+
<strong>settingsObjectsClient.resolveEffectivePermissions(config): Promise<Array<<a href="#effectivepermission">EffectivePermission</a>>></strong>
|
|
9724
10127
|
|
|
9725
10128
|
<div class="padding-left--md">
|
|
9726
10129
|
|
|
@@ -9745,7 +10148,219 @@ Get the effective settings permissions of the calling user in the environment
|
|
|
9745
10148
|
|
|
9746
10149
|
| Name | Type |
|
|
9747
10150
|
| --- | --- |
|
|
9748
|
-
|config.body<sup>*required</sup>|<a href="#resolutionrequest">ResolutionRequest</a>|
|
|
10151
|
+
|config.body<sup>*required</sup>|<a href="#resolutionrequest" target="_blank" rel="noopener noreferrer">ResolutionRequest</a>|
|
|
10152
|
+
|
|
10153
|
+
|
|
10154
|
+
|
|
10155
|
+
|
|
10156
|
+
#### Returns
|
|
10157
|
+
|
|
10158
|
+
| Return type | Status code | Description |
|
|
10159
|
+
|---|---|---|
|
|
10160
|
+
|[EffectivePermission](#effectivepermission)|200|Success|
|
|
10161
|
+
|
|
10162
|
+
|
|
10163
|
+
#### Throws
|
|
10164
|
+
|
|
10165
|
+
| Error Type | Error Message |
|
|
10166
|
+
|---|---|
|
|
10167
|
+
|ErrorEnvelopeError|Failed. Forbidden. No access to any settings. \| Client side error. \| Server side error.|
|
|
10168
|
+
|
|
10169
|
+
|
|
10170
|
+
<details>
|
|
10171
|
+
<summary>
|
|
10172
|
+
Code example
|
|
10173
|
+
</summary>
|
|
10174
|
+
|
|
10175
|
+
```ts
|
|
10176
|
+
import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
10177
|
+
|
|
10178
|
+
const data =
|
|
10179
|
+
await settingsObjectsClient.resolveEffectivePermissions({
|
|
10180
|
+
body: {
|
|
10181
|
+
permissions: [
|
|
10182
|
+
{
|
|
10183
|
+
context: {
|
|
10184
|
+
schemaId: "service:schema",
|
|
10185
|
+
scope: "environment",
|
|
10186
|
+
},
|
|
10187
|
+
permission: "settings:objects:write",
|
|
10188
|
+
},
|
|
10189
|
+
],
|
|
10190
|
+
},
|
|
10191
|
+
});
|
|
10192
|
+
```
|
|
10193
|
+
|
|
10194
|
+
</details>
|
|
10195
|
+
|
|
10196
|
+
|
|
10197
|
+
|
|
10198
|
+
</div>
|
|
10199
|
+
|
|
10200
|
+
|
|
10201
|
+
<a name="transferownership"></a>
|
|
10202
|
+
### transferOwnership
|
|
10203
|
+
|
|
10204
|
+
<div class="padding-bottom--md">
|
|
10205
|
+
<strong>settingsObjectsClient.transferOwnership(config): Promise<void></strong>
|
|
10206
|
+
|
|
10207
|
+
<div class="padding-left--md">
|
|
10208
|
+
|
|
10209
|
+
Transfer ownership of the object.
|
|
10210
|
+
|
|
10211
|
+
**Required scope:** settings:objects:write
|
|
10212
|
+
**Required permission:** settings:objects:write
|
|
10213
|
+
|
|
10214
|
+
Transfer ownership of the object, only the owner or the main admin is allowed to transfer the ownership (IAM permission needed).
|
|
10215
|
+
|
|
10216
|
+
|
|
10217
|
+
|
|
10218
|
+
</div>
|
|
10219
|
+
|
|
10220
|
+
|
|
10221
|
+
#### Parameters
|
|
10222
|
+
|
|
10223
|
+
| Name | Type | Description |
|
|
10224
|
+
| --- | --- | --- |
|
|
10225
|
+
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
10226
|
+
|config.body<sup>*required</sup>|<a href="#transferownershiprequest">TransferOwnershipRequest</a>| |
|
|
10227
|
+
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
10228
|
+
|
|
10229
|
+
|
|
10230
|
+
|
|
10231
|
+
|
|
10232
|
+
#### Returns
|
|
10233
|
+
|
|
10234
|
+
| Return type | Status code | Description |
|
|
10235
|
+
|---|---|---|
|
|
10236
|
+
|void|204|Success. Response doesn't have a body.|
|
|
10237
|
+
|
|
10238
|
+
|
|
10239
|
+
#### Throws
|
|
10240
|
+
|
|
10241
|
+
| Error Type | Error Message |
|
|
10242
|
+
|---|---|
|
|
10243
|
+
|ErrorEnvelopeError|Failed. The input is invalid. \| Failed. Forbidden. \| No object available for the given objectId. \| Client side error. \| Server side error.|
|
|
10244
|
+
|
|
10245
|
+
|
|
10246
|
+
<details>
|
|
10247
|
+
<summary>
|
|
10248
|
+
Code example
|
|
10249
|
+
</summary>
|
|
10250
|
+
|
|
10251
|
+
```ts
|
|
10252
|
+
import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
10253
|
+
|
|
10254
|
+
const data = await settingsObjectsClient.transferOwnership({
|
|
10255
|
+
objectId: "...",
|
|
10256
|
+
body: { newOwner: { type: IdentityType.User } },
|
|
10257
|
+
});
|
|
10258
|
+
```
|
|
10259
|
+
|
|
10260
|
+
</details>
|
|
10261
|
+
|
|
10262
|
+
|
|
10263
|
+
|
|
10264
|
+
</div>
|
|
10265
|
+
|
|
10266
|
+
|
|
10267
|
+
<a name="updatepermission"></a>
|
|
10268
|
+
### updatePermission
|
|
10269
|
+
|
|
10270
|
+
<div class="padding-bottom--md">
|
|
10271
|
+
<strong>settingsObjectsClient.updatePermission(config): Promise<void></strong>
|
|
10272
|
+
|
|
10273
|
+
<div class="padding-left--md">
|
|
10274
|
+
|
|
10275
|
+
Update the permissions for an existing accessor on this object.
|
|
10276
|
+
|
|
10277
|
+
**Required scope:** settings:objects:write
|
|
10278
|
+
**Required permission:** settings:objects:write
|
|
10279
|
+
|
|
10280
|
+
Update the permissions for an existing accessor on this object, anyone with read/write permissions is allowed to update permissions.
|
|
10281
|
+
|
|
10282
|
+
|
|
10283
|
+
|
|
10284
|
+
</div>
|
|
10285
|
+
|
|
10286
|
+
|
|
10287
|
+
#### Parameters
|
|
10288
|
+
|
|
10289
|
+
| Name | Type | Description |
|
|
10290
|
+
| --- | --- | --- |
|
|
10291
|
+
|config.accessorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The user uuid or group uuid of the accessor, depending on the type. |
|
|
10292
|
+
|config.accessorType<sup>*required</sup>|"group" | "user"|The type of the accessor. |
|
|
10293
|
+
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
10294
|
+
|config.body<sup>*required</sup>|<a href="#updatepermissionsrequest" target="_blank" rel="noopener noreferrer">UpdatePermissionsRequest</a>| |
|
|
10295
|
+
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
10296
|
+
|
|
10297
|
+
|
|
10298
|
+
|
|
10299
|
+
|
|
10300
|
+
#### Returns
|
|
10301
|
+
|
|
10302
|
+
| Return type | Status code | Description |
|
|
10303
|
+
|---|---|---|
|
|
10304
|
+
|void|200|Success|
|
|
10305
|
+
|
|
10306
|
+
|
|
10307
|
+
#### Throws
|
|
10308
|
+
|
|
10309
|
+
| Error Type | Error Message |
|
|
10310
|
+
|---|---|
|
|
10311
|
+
|ErrorEnvelopeError|If permission list is empty, contains unsupported entries or unsupported combinations of entries. \| No object available for the given objectId or the accessor doesn't have any permissions on this object. \| Client side error. \| Server side error.|
|
|
10312
|
+
|
|
10313
|
+
|
|
10314
|
+
<details>
|
|
10315
|
+
<summary>
|
|
10316
|
+
Code example
|
|
10317
|
+
</summary>
|
|
10318
|
+
|
|
10319
|
+
```ts
|
|
10320
|
+
import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
10321
|
+
|
|
10322
|
+
const data = await settingsObjectsClient.updatePermission({
|
|
10323
|
+
objectId: "...",
|
|
10324
|
+
accessorType: UpdatePermissionPathAccessorType.Group,
|
|
10325
|
+
accessorId: "...",
|
|
10326
|
+
body: {},
|
|
10327
|
+
});
|
|
10328
|
+
```
|
|
10329
|
+
|
|
10330
|
+
</details>
|
|
10331
|
+
|
|
10332
|
+
|
|
10333
|
+
|
|
10334
|
+
</div>
|
|
10335
|
+
|
|
10336
|
+
|
|
10337
|
+
<a name="updatepermissionallusers"></a>
|
|
10338
|
+
### updatePermissionAllUsers
|
|
10339
|
+
|
|
10340
|
+
<div class="padding-bottom--md">
|
|
10341
|
+
<strong>settingsObjectsClient.updatePermissionAllUsers(config): Promise<void></strong>
|
|
10342
|
+
|
|
10343
|
+
<div class="padding-left--md">
|
|
10344
|
+
|
|
10345
|
+
Update the permissions for an existing all-users accessor on this object.
|
|
10346
|
+
|
|
10347
|
+
**Required scope:** settings:objects:write
|
|
10348
|
+
**Required permission:** settings:objects:write
|
|
10349
|
+
|
|
10350
|
+
Update the permissions for an existing all-users accessor on this object, anyone with read/write permissions is allowed to update permissions.
|
|
10351
|
+
|
|
10352
|
+
|
|
10353
|
+
|
|
10354
|
+
</div>
|
|
10355
|
+
|
|
10356
|
+
|
|
10357
|
+
#### Parameters
|
|
10358
|
+
|
|
10359
|
+
| Name | Type | Description |
|
|
10360
|
+
| --- | --- | --- |
|
|
10361
|
+
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
10362
|
+
|config.body<sup>*required</sup>|<a href="#updatepermissionsrequest">UpdatePermissionsRequest</a>| |
|
|
10363
|
+
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
9749
10364
|
|
|
9750
10365
|
|
|
9751
10366
|
|
|
@@ -9754,14 +10369,14 @@ Get the effective settings permissions of the calling user in the environment
|
|
|
9754
10369
|
|
|
9755
10370
|
| Return type | Status code | Description |
|
|
9756
10371
|
|---|---|---|
|
|
9757
|
-
|
|
|
10372
|
+
|void|200|Success|
|
|
9758
10373
|
|
|
9759
10374
|
|
|
9760
10375
|
#### Throws
|
|
9761
10376
|
|
|
9762
10377
|
| Error Type | Error Message |
|
|
9763
10378
|
|---|---|
|
|
9764
|
-
|ErrorEnvelopeError|
|
|
10379
|
+
|ErrorEnvelopeError|If permission list is empty, contains unsupported entries or unsupported combinations of entries. \| No object available for the given objectId or the all-users accessor doesn't have any permissions on this object. \| Client side error. \| Server side error.|
|
|
9765
10380
|
|
|
9766
10381
|
|
|
9767
10382
|
<details>
|
|
@@ -9773,7 +10388,8 @@ Code example
|
|
|
9773
10388
|
import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
9774
10389
|
|
|
9775
10390
|
const data =
|
|
9776
|
-
await settingsObjectsClient.
|
|
10391
|
+
await settingsObjectsClient.updatePermissionAllUsers({
|
|
10392
|
+
objectId: "...",
|
|
9777
10393
|
body: {},
|
|
9778
10394
|
});
|
|
9779
10395
|
```
|
|
@@ -10575,6 +11191,7 @@ Lists all synthetic nodes available in your environment
|
|
|
10575
11191
|
| Name | Type | Description |
|
|
10576
11192
|
| --- | --- | --- |
|
|
10577
11193
|
|config.assignedToLocation|"TRUE" | "FALSE"|Filters the resulting set of nodes to those which are assigned to a synthetic location or not. |
|
|
11194
|
+
|config.isContainerized|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true, returns only containerized nodes. |
|
|
10578
11195
|
|
|
10579
11196
|
|
|
10580
11197
|
|
|
@@ -11583,10 +12200,10 @@ A credentials set of the `AWS_MONITORING_KEY_BASED` type.
|
|
|
11583
12200
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
11584
12201
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
11585
12202
|
|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>). |
|
|
11586
|
-
|~~scope~~<sup>**DEPRECATED**</sup>|"
|
|
11587
|
-
|scopes<sup>*required</sup>|Array<"
|
|
12203
|
+
|~~scope~~<sup>**DEPRECATED**</sup>|"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"|The scope of the credentials set. |
|
|
12204
|
+
|scopes<sup>*required</sup>|Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">|<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> |
|
|
11588
12205
|
|secretKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Secret access key of the credential. |
|
|
11589
|
-
|type|"
|
|
12206
|
+
|type|"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>CERTIFICATE</code> -> CertificateCredentials</li> <li><code>PUBLIC_CERTIFICATE</code> -> PublicCertificateCredentials</li> <li><code>USERNAME_PASSWORD</code> -> UserPasswordCredentials</li> <li><code>TOKEN</code> -> TokenCredentials</li> <li><code>SNMPV3</code> -> SNMPV3Credentials</li> <li><code>AWS_MONITORING_KEY_BASED</code> -> AWSKeyBasedCredentialsDto</li> <li><code>AWS_MONITORING_ROLE_BASED</code> -> AWSRoleBasedCredentials</li> </ul> |
|
|
11590
12207
|
|
|
11591
12208
|
### AWSRoleBasedCredentials
|
|
11592
12209
|
|
|
@@ -11602,9 +12219,9 @@ A credentials set of the `AWS_MONITORING_ROLE_BASED` type.
|
|
|
11602
12219
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
11603
12220
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
11604
12221
|
|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>). |
|
|
11605
|
-
|~~scope~~<sup>**DEPRECATED**</sup>|"
|
|
11606
|
-
|scopes<sup>*required</sup>|Array<"
|
|
11607
|
-
|type|"
|
|
12222
|
+
|~~scope~~<sup>**DEPRECATED**</sup>|"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"|The scope of the credentials set. |
|
|
12223
|
+
|scopes<sup>*required</sup>|Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">|<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> |
|
|
12224
|
+
|type|"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>CERTIFICATE</code> -> CertificateCredentials</li> <li><code>PUBLIC_CERTIFICATE</code> -> PublicCertificateCredentials</li> <li><code>USERNAME_PASSWORD</code> -> UserPasswordCredentials</li> <li><code>TOKEN</code> -> TokenCredentials</li> <li><code>SNMPV3</code> -> SNMPV3Credentials</li> <li><code>AWS_MONITORING_KEY_BASED</code> -> AWSKeyBasedCredentialsDto</li> <li><code>AWS_MONITORING_ROLE_BASED</code> -> AWSRoleBasedCredentials</li> </ul> |
|
|
11608
12225
|
|
|
11609
12226
|
### AbstractCredentialsResponseElement
|
|
11610
12227
|
|
|
@@ -11619,7 +12236,7 @@ Credentials set.
|
|
|
11619
12236
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
11620
12237
|
|owner<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The owner of the credential (user for which used API token was created). |
|
|
11621
12238
|
|ownerAccessOnly<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Flag indicating that this credential is visible only to the owner. |
|
|
11622
|
-
|scope|"
|
|
12239
|
+
|scope|"ALL" | "EXTENSION" | "SYNTHETIC" | "UNKNOWN"|The scope of the credentials set. |
|
|
11623
12240
|
|type<sup>*required</sup>|"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>USERNAME_PASSWORD</code> -> CredentialsDetailsUsernamePasswordResponseElement</li> <li><code>CERTIFICATE</code> -> CredentialsDetailsCertificateResponseElement</li> <li><code>TOKEN</code> -> CredentialsDetailsTokenResponseElement</li> <li><code>PUBLIC_CERTIFICATE</code> -> CredentialsDetailsCertificateResponseElement</li> </ul> |
|
|
11624
12241
|
|
|
11625
12242
|
### AbstractSloAlertDto
|
|
@@ -11630,6 +12247,23 @@ Credentials set.
|
|
|
11630
12247
|
|alertThreshold<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Threshold of the alert. Status alerts trigger if they fall below this value, burn rate alerts trigger if they exceed the value. |
|
|
11631
12248
|
|alertType<sup>*required</sup>|"BURN_RATE" | "STATUS"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>BURN_RATE</code> -> BurnRateAlert</li> <li><code>STATUS</code> -> StatusAlert</li> </ul> |
|
|
11632
12249
|
|
|
12250
|
+
### AccessorPermissions
|
|
12251
|
+
|
|
12252
|
+
An accessor identity and it's associated permissions.
|
|
12253
|
+
|
|
12254
|
+
| Name | Type | Description |
|
|
12255
|
+
| --- | --- | --- |
|
|
12256
|
+
|accessor|<a href="#identity" target="_blank" rel="noopener noreferrer">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users). |
|
|
12257
|
+
|permissions|Array<"r" | "w">|The permissions associated with the accessor. |
|
|
12258
|
+
|
|
12259
|
+
### AccessorPermissionsList
|
|
12260
|
+
|
|
12261
|
+
All configured permissions of an object (excluding owner).
|
|
12262
|
+
|
|
12263
|
+
| Name | Type |
|
|
12264
|
+
| --- | --- |
|
|
12265
|
+
|accessors|Array<<a href="#accessorpermissions">AccessorPermissions</a>>|
|
|
12266
|
+
|
|
11633
12267
|
### ActiveGate
|
|
11634
12268
|
|
|
11635
12269
|
Parameters of the ActiveGate.
|
|
@@ -12134,7 +12768,7 @@ An entry of the audit log.
|
|
|
12134
12768
|
|
|
12135
12769
|
| Name | Type | Description |
|
|
12136
12770
|
| --- | --- | --- |
|
|
12137
|
-
|category<sup>*required</sup>|"TOKEN" | "ACTIVEGATE_TOKEN" | "CONFIG" | "MANUAL_TAGGING_SERVICE" | "WEB_UI"|The category of the recorded operation. |
|
|
12771
|
+
|category<sup>*required</sup>|"TOKEN" | "ACTIVEGATE_TOKEN" | "CONFIG" | "MANUAL_TAGGING_SERVICE" | "TENANT_LIFECYCLE" | "WEB_UI"|The category of the recorded operation. |
|
|
12138
12772
|
|dt.settings.key|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The key of the affected object of a setting for entries of category <code>CONFIG</code>. |
|
|
12139
12773
|
|dt.settings.object_id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the affected object of a setting for entries of category <code>CONFIG</code>. |
|
|
12140
12774
|
|dt.settings.object_summary|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The value summary for entries of category <code>CONFIG</code>. |
|
|
@@ -12295,15 +12929,15 @@ A credentials set of the `CERTIFICATE` type.
|
|
|
12295
12929
|
|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). |
|
|
12296
12930
|
|allowedEntities|Array<<a href="#credentialaccessdata" target="_blank" rel="noopener noreferrer">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
12297
12931
|
|certificate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The certificate in the string format. |
|
|
12298
|
-
|certificateFormat|"
|
|
12932
|
+
|certificateFormat|"UNKNOWN" | "PEM" | "PKCS12"|The certificate format. |
|
|
12299
12933
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
12300
12934
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
12301
12935
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
12302
12936
|
|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>). |
|
|
12303
12937
|
|password|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The password of the credential (Base64 encoded). |
|
|
12304
|
-
|~~scope~~<sup>**DEPRECATED**</sup>|"
|
|
12305
|
-
|scopes<sup>*required</sup>|Array<"
|
|
12306
|
-
|type|"
|
|
12938
|
+
|~~scope~~<sup>**DEPRECATED**</sup>|"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"|The scope of the credentials set. |
|
|
12939
|
+
|scopes<sup>*required</sup>|Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">|<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> |
|
|
12940
|
+
|type|"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>CERTIFICATE</code> -> CertificateCredentials</li> <li><code>PUBLIC_CERTIFICATE</code> -> PublicCertificateCredentials</li> <li><code>USERNAME_PASSWORD</code> -> UserPasswordCredentials</li> <li><code>TOKEN</code> -> TokenCredentials</li> <li><code>SNMPV3</code> -> SNMPV3Credentials</li> <li><code>AWS_MONITORING_KEY_BASED</code> -> AWSKeyBasedCredentialsDto</li> <li><code>AWS_MONITORING_ROLE_BASED</code> -> AWSRoleBasedCredentials</li> </ul> |
|
|
12307
12941
|
|
|
12308
12942
|
### CloudEvent
|
|
12309
12943
|
|
|
@@ -12468,9 +13102,9 @@ The actual set of fields depends on the type of credentials. Find the list of ac
|
|
|
12468
13102
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
12469
13103
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
12470
13104
|
|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>). |
|
|
12471
|
-
|~~scope~~<sup>**DEPRECATED**</sup>|"
|
|
12472
|
-
|scopes<sup>*required</sup>|Array<"
|
|
12473
|
-
|type|"
|
|
13105
|
+
|~~scope~~<sup>**DEPRECATED**</sup>|"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"|The scope of the credentials set. |
|
|
13106
|
+
|scopes<sup>*required</sup>|Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">|<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> |
|
|
13107
|
+
|type|"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>CERTIFICATE</code> -> CertificateCredentials</li> <li><code>PUBLIC_CERTIFICATE</code> -> PublicCertificateCredentials</li> <li><code>USERNAME_PASSWORD</code> -> UserPasswordCredentials</li> <li><code>TOKEN</code> -> TokenCredentials</li> <li><code>SNMPV3</code> -> SNMPV3Credentials</li> <li><code>AWS_MONITORING_KEY_BASED</code> -> AWSKeyBasedCredentialsDto</li> <li><code>AWS_MONITORING_ROLE_BASED</code> -> AWSRoleBasedCredentials</li> </ul> |
|
|
12474
13108
|
|
|
12475
13109
|
### CredentialsDetailsCertificateResponseElement
|
|
12476
13110
|
|
|
@@ -12488,7 +13122,7 @@ Details of certificate credentials set.
|
|
|
12488
13122
|
|owner<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The owner of the credential (user for which used API token was created). |
|
|
12489
13123
|
|ownerAccessOnly<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Flag indicating that this credential is visible only to the owner. |
|
|
12490
13124
|
|password|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Base64 encoded password |
|
|
12491
|
-
|scope|"
|
|
13125
|
+
|scope|"ALL" | "EXTENSION" | "SYNTHETIC" | "UNKNOWN"|The scope of the credentials set. |
|
|
12492
13126
|
|type<sup>*required</sup>|"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>USERNAME_PASSWORD</code> -> CredentialsDetailsUsernamePasswordResponseElement</li> <li><code>CERTIFICATE</code> -> CredentialsDetailsCertificateResponseElement</li> <li><code>TOKEN</code> -> CredentialsDetailsTokenResponseElement</li> <li><code>PUBLIC_CERTIFICATE</code> -> CredentialsDetailsCertificateResponseElement</li> </ul> |
|
|
12493
13127
|
|
|
12494
13128
|
### CredentialsDetailsTokenResponseElement
|
|
@@ -12504,7 +13138,7 @@ Details of the token credentials set.
|
|
|
12504
13138
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
12505
13139
|
|owner<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The owner of the credential (user for which used API token was created). |
|
|
12506
13140
|
|ownerAccessOnly<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Flag indicating that this credential is visible only to the owner. |
|
|
12507
|
-
|scope|"
|
|
13141
|
+
|scope|"ALL" | "EXTENSION" | "SYNTHETIC" | "UNKNOWN"|The scope of the credentials set. |
|
|
12508
13142
|
|token|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Plain text token value |
|
|
12509
13143
|
|type<sup>*required</sup>|"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>USERNAME_PASSWORD</code> -> CredentialsDetailsUsernamePasswordResponseElement</li> <li><code>CERTIFICATE</code> -> CredentialsDetailsCertificateResponseElement</li> <li><code>TOKEN</code> -> CredentialsDetailsTokenResponseElement</li> <li><code>PUBLIC_CERTIFICATE</code> -> CredentialsDetailsCertificateResponseElement</li> </ul> |
|
|
12510
13144
|
|
|
@@ -12522,7 +13156,7 @@ Details of username and password credentials set.
|
|
|
12522
13156
|
|owner<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The owner of the credential (user for which used API token was created). |
|
|
12523
13157
|
|ownerAccessOnly<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Flag indicating that this credential is visible only to the owner. |
|
|
12524
13158
|
|password|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Plain text password value |
|
|
12525
|
-
|scope|"
|
|
13159
|
+
|scope|"ALL" | "EXTENSION" | "SYNTHETIC" | "UNKNOWN"|The scope of the credentials set. |
|
|
12526
13160
|
|type<sup>*required</sup>|"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>USERNAME_PASSWORD</code> -> CredentialsDetailsUsernamePasswordResponseElement</li> <li><code>CERTIFICATE</code> -> CredentialsDetailsCertificateResponseElement</li> <li><code>TOKEN</code> -> CredentialsDetailsTokenResponseElement</li> <li><code>PUBLIC_CERTIFICATE</code> -> CredentialsDetailsCertificateResponseElement</li> </ul> |
|
|
12527
13161
|
|username|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Plain text username value |
|
|
12528
13162
|
|
|
@@ -12560,9 +13194,9 @@ Metadata of the credentials set.
|
|
|
12560
13194
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
12561
13195
|
|owner<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The owner of the credential (user for which used API token was created). |
|
|
12562
13196
|
|ownerAccessOnly<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Flag indicating that this credential is visible only to the owner. |
|
|
12563
|
-
|scope|"
|
|
12564
|
-
|scopes|Array<"
|
|
12565
|
-
|type<sup>*required</sup>|"UNKNOWN" | "
|
|
13197
|
+
|scope|"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"|The scope of the credentials set. |
|
|
13198
|
+
|scopes|Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">|The set of scopes of the credentials set. |
|
|
13199
|
+
|type<sup>*required</sup>|"UNKNOWN" | "CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"|The type of the credentials set. |
|
|
12566
13200
|
|
|
12567
13201
|
### CustomApplicationImpact
|
|
12568
13202
|
|
|
@@ -12763,8 +13397,8 @@ A constraint on the values that are going to be deleted.
|
|
|
12763
13397
|
| Name | Type | Description |
|
|
12764
13398
|
| --- | --- | --- |
|
|
12765
13399
|
|context|<a href="#permissioncontext">PermissionContext</a>|Optional context data |
|
|
12766
|
-
|granted
|
|
12767
|
-
|permission
|
|
13400
|
+
|granted<sup>*required</sup>|"condition" | "false" | "true"| |
|
|
13401
|
+
|permission<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
12768
13402
|
|
|
12769
13403
|
### EffectiveSettingsValue
|
|
12770
13404
|
|
|
@@ -13596,7 +14230,7 @@ An Identity describing either a user, a group, or the all-users group (applying
|
|
|
13596
14230
|
| Name | Type | Description |
|
|
13597
14231
|
| --- | --- | --- |
|
|
13598
14232
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The user id or user group id if type is 'user' or 'group', missing if type is 'all-users'. |
|
|
13599
|
-
|type<sup>*required</sup>|"
|
|
14233
|
+
|type<sup>*required</sup>|"all-users" | "group" | "user"|The type of the identity. |
|
|
13600
14234
|
|
|
13601
14235
|
### Impact
|
|
13602
14236
|
|
|
@@ -14091,7 +14725,7 @@ Monitoring state of the process group instance.
|
|
|
14091
14725
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Dynatrace entity ID of the process group instance. |
|
|
14092
14726
|
|params|Array<<a href="#monitoredentitystateparam" target="_blank" rel="noopener noreferrer">MonitoredEntityStateParam</a>>|Additional parameters of the monitoring state. |
|
|
14093
14727
|
|severity|"deep_monitoring_ok" | "info" | "ok" | "warning"|The type of the monitoring state. |
|
|
14094
|
-
|state|"ok" | "agent_injection_status_go_dynamizer_failed" | "agent_injection_status_go_pclntab_failed" | "agent_injection_status_go_vertigo_support_added" | "agent_injection_status_nginx_patched_binary_detected" | "agent_injection_status_php_opcache_disabled" | "agent_injection_status_php_stack_size_too_low" | "agent_injection_suppression" | "aix_enable_full_monitoring_needed" | "bad_installer" | "boshbpm_disabled" | "container_injection_failed" | "containerd_disabled" | "crio_disabled" | "custom_pg_rule_required" | "deep_monitoring_successful" | "deep_monitoring_unsuccessful" | "docker_disabled" | "garden_disabled" | "host_infra_structure_only" | "host_monitoring_disabled" | "network_agent_inactive" | "parent_process_restart_required" | "podman_disabled" | "process_group_different_id_due_to_declarative_grouping" | "process_group_disabled" | "process_group_disabled_via_container_injection_rule" | "process_group_disabled_via_container_injection_rule_restart" | "process_group_disabled_via_global_settings" | "process_group_disabled_via_injection_rule" | "process_group_disabled_via_injection_rule_restart" | "restart_required" | "restart_required_apache" | "restart_required_docker_deamon" | "restart_required_host_group_inconsistent" | "restart_required_host_id_inconsistent" | "restart_required_outdated_agent_apache_update" | "restart_required_outdated_agent_injected" | "restart_required_using_different_data_storage_dir" | "restart_required_using_different_log_path" | "restart_required_virtualized_container" | "unsupported_state" | "winc_disabled"|The name of the monitoring state. |
|
|
14728
|
+
|state|"ok" | "agent_injection_status_go_dynamizer_failed" | "agent_injection_status_go_fips_detected_but_feature_disabled" | "agent_injection_status_go_pclntab_failed" | "agent_injection_status_go_vertigo_support_added" | "agent_injection_status_nginx_patched_binary_detected" | "agent_injection_status_php_opcache_disabled" | "agent_injection_status_php_stack_size_too_low" | "agent_injection_suppression" | "aix_enable_full_monitoring_needed" | "bad_installer" | "boshbpm_disabled" | "container_injection_failed" | "containerd_disabled" | "crio_disabled" | "custom_pg_rule_required" | "deep_monitoring_successful" | "deep_monitoring_unsuccessful" | "docker_disabled" | "garden_disabled" | "host_infra_structure_only" | "host_monitoring_disabled" | "network_agent_inactive" | "parent_process_restart_required" | "podman_disabled" | "process_group_different_id_due_to_declarative_grouping" | "process_group_disabled" | "process_group_disabled_via_container_injection_rule" | "process_group_disabled_via_container_injection_rule_restart" | "process_group_disabled_via_global_settings" | "process_group_disabled_via_injection_rule" | "process_group_disabled_via_injection_rule_restart" | "restart_required" | "restart_required_apache" | "restart_required_docker_deamon" | "restart_required_host_group_inconsistent" | "restart_required_host_id_inconsistent" | "restart_required_outdated_agent_apache_update" | "restart_required_outdated_agent_injected" | "restart_required_using_different_data_storage_dir" | "restart_required_using_different_log_path" | "restart_required_virtualized_container" | "unsupported_state" | "winc_disabled"|The name of the monitoring state. |
|
|
14095
14729
|
|
|
14096
14730
|
### MonitoredStates
|
|
14097
14731
|
|
|
@@ -14285,6 +14919,7 @@ Configuration of a private synthetic location.
|
|
|
14285
14919
|
|longitude<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The longitude of the location in <code>DDD.dddd</code> format. |
|
|
14286
14920
|
|namExecutionSupported|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>Boolean value describes if icmp monitors will be executed on this location:</p> <ul> <li><code>false</code>: Icmp monitor executions disabled.</li> <li><code>true</code>: Icmp monitor executions enabled.</li> </ul> |
|
|
14287
14921
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the location. |
|
|
14922
|
+
|nodeNames|<a href="#privatesyntheticlocationnodenames">PrivateSyntheticLocationNodeNames</a>|A mapping id to name of the nodes belonging to the location. |
|
|
14288
14923
|
|nodes<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>A list of synthetic nodes belonging to the location.</p> <p>You can retrieve the list of available nodes with the <a href="https://dt-url.net/miy3rpl" target="_blank" rel="noopener noreferrer" >GET all nodes</a> call.</p> |
|
|
14289
14924
|
|regionCode|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The region code of the location.</p> <p>To fetch the list of available region codes, use the <a href="https://dt-url.net/az230x0" target="_blank" rel="noopener noreferrer" >GET regions of the country</a> request.</p> |
|
|
14290
14925
|
|regionName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The region name of the location. |
|
|
@@ -14292,29 +14927,35 @@ Configuration of a private synthetic location.
|
|
|
14292
14927
|
|type<sup>*required</sup>|"CLUSTER" | "PUBLIC" | "PRIVATE"| |
|
|
14293
14928
|
|useNewKubernetesVersion|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>Boolean value describes which kubernetes version will be used:</p> <ul> <li><code>false</code>: Version 1.23+ that is older than 1.26</li> <li><code>true</code>: Version 1.26+.</li> </ul> |
|
|
14294
14929
|
|
|
14930
|
+
### PrivateSyntheticLocationNodeNames
|
|
14931
|
+
|
|
14932
|
+
A mapping id to name of the nodes belonging to the location.
|
|
14933
|
+
|
|
14934
|
+
**type**: Record<string, string | undefined>
|
|
14935
|
+
|
|
14295
14936
|
### Problem
|
|
14296
14937
|
|
|
14297
14938
|
The properties of a problem.
|
|
14298
14939
|
|
|
14299
14940
|
| Name | Type | Description |
|
|
14300
14941
|
| --- | --- | --- |
|
|
14301
|
-
|affectedEntities<sup>*required</sup>|Array<<a href="#entitystub">EntityStub</a>>|A list of all entities that are affected by the problem. |
|
|
14942
|
+
|affectedEntities<sup>*required</sup>|Array<<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>>|A list of all entities that are affected by the problem. |
|
|
14302
14943
|
|displayId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display ID of the problem. |
|
|
14303
14944
|
|endTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The end timestamp of the problem, in UTC milliseconds.</p> <p>Has <code>-1</code> value, if the problem is still open.</p> |
|
|
14304
|
-
|entityTags|Array<<a href="#metag"
|
|
14305
|
-
|evidenceDetails|<a href="#evidencedetails">EvidenceDetails</a>|The evidence details of a problem. |
|
|
14306
|
-
|impactAnalysis|<a href="#impactanalysis"
|
|
14307
|
-
|impactLevel<sup>*required</sup>|"
|
|
14308
|
-
|impactedEntities<sup>*required</sup>|Array<<a href="#entitystub">EntityStub</a>>|A list of all entities that are impacted by the problem. |
|
|
14945
|
+
|entityTags|Array<<a href="#metag">METag</a>>|A list of all entity tags of the problem. |
|
|
14946
|
+
|evidenceDetails|<a href="#evidencedetails" target="_blank" rel="noopener noreferrer">EvidenceDetails</a>|The evidence details of a problem. |
|
|
14947
|
+
|impactAnalysis|<a href="#impactanalysis">ImpactAnalysis</a>|A list of all impacts of the problem. |
|
|
14948
|
+
|impactLevel<sup>*required</sup>|"ENVIRONMENT" | "APPLICATION" | "INFRASTRUCTURE" | "SERVICES"|The impact level of the problem. It shows what is affected by the problem. |
|
|
14949
|
+
|impactedEntities<sup>*required</sup>|Array<<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>>|A list of all entities that are impacted by the problem. |
|
|
14309
14950
|
|k8s.cluster.name|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The related Kubernetes cluster names. |
|
|
14310
14951
|
|k8s.cluster.uid|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The related Kubernetes cluster UIDs. |
|
|
14311
14952
|
|k8s.namespace.name|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The related Kubernetes namespace names. |
|
|
14312
|
-
|linkedProblemInfo|<a href="#linkedproblem"
|
|
14313
|
-
|managementZones<sup>*required</sup>|Array<<a href="#managementzone">ManagementZone</a>>|A list of all management zones that the problem belongs to. |
|
|
14314
|
-
|problemFilters<sup>*required</sup>|Array<<a href="#alertingprofilestub"
|
|
14953
|
+
|linkedProblemInfo|<a href="#linkedproblem">LinkedProblem</a>|The properties of the linked problem. |
|
|
14954
|
+
|managementZones<sup>*required</sup>|Array<<a href="#managementzone" target="_blank" rel="noopener noreferrer">ManagementZone</a>>|A list of all management zones that the problem belongs to. |
|
|
14955
|
+
|problemFilters<sup>*required</sup>|Array<<a href="#alertingprofilestub">AlertingProfileStub</a>>|A list of alerting profiles that match the problem. |
|
|
14315
14956
|
|problemId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the problem. |
|
|
14316
|
-
|recentComments|<a href="#commentslist">CommentsList</a>|A list of comments. |
|
|
14317
|
-
|rootCauseEntity|<a href="#entitystub"
|
|
14957
|
+
|recentComments|<a href="#commentslist" target="_blank" rel="noopener noreferrer">CommentsList</a>|A list of comments. |
|
|
14958
|
+
|rootCauseEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
14318
14959
|
|severityLevel<sup>*required</sup>|"CUSTOM_ALERT" | "AVAILABILITY" | "ERROR" | "INFO" | "MONITORING_UNAVAILABLE" | "PERFORMANCE" | "RESOURCE_CONTENTION"|The severity of the problem. |
|
|
14319
14960
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start timestamp of the problem, in UTC milliseconds. |
|
|
14320
14961
|
|status<sup>*required</sup>|"CLOSED" | "OPEN"|The status of the problem. |
|
|
@@ -14334,7 +14975,7 @@ The result of closing a problem.
|
|
|
14334
14975
|
| --- | --- | --- |
|
|
14335
14976
|
|closeTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the user triggered the closing. |
|
|
14336
14977
|
|closing<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True, if the problem is being closed. |
|
|
14337
|
-
|comment|<a href="#comment">Comment</a>|The comment to a problem. |
|
|
14978
|
+
|comment|<a href="#comment" target="_blank" rel="noopener noreferrer">Comment</a>|The comment to a problem. |
|
|
14338
14979
|
|problemId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the problem. |
|
|
14339
14980
|
|
|
14340
14981
|
### Problems
|
|
@@ -14345,7 +14986,7 @@ A list of problems.
|
|
|
14345
14986
|
| --- | --- | --- |
|
|
14346
14987
|
|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> |
|
|
14347
14988
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
14348
|
-
|problems<sup>*required</sup>|Array<<a href="#problem"
|
|
14989
|
+
|problems<sup>*required</sup>|Array<<a href="#problem">Problem</a>>|The result entries. |
|
|
14349
14990
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
14350
14991
|
|warnings|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of warnings |
|
|
14351
14992
|
|
|
@@ -14355,9 +14996,9 @@ The vulnerable functions of a process group including their usage.
|
|
|
14355
14996
|
|
|
14356
14997
|
| Name | Type | Description |
|
|
14357
14998
|
| --- | --- | --- |
|
|
14358
|
-
|functionsInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions in use. |
|
|
14359
|
-
|functionsNotAvailable|Array<<a href="#vulnerablefunction"
|
|
14360
|
-
|functionsNotInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions not in use. |
|
|
14999
|
+
|functionsInUse|Array<<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>>|A list of vulnerable functions in use. |
|
|
15000
|
+
|functionsNotAvailable|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions with unknown state. |
|
|
15001
|
+
|functionsNotInUse|Array<<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>>|A list of vulnerable functions not in use. |
|
|
14361
15002
|
|processGroup|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The process group identifier. |
|
|
14362
15003
|
|
|
14363
15004
|
### PropertyDefinition
|
|
@@ -14366,25 +15007,25 @@ Configuration of a property in a settings schema.
|
|
|
14366
15007
|
|
|
14367
15008
|
| Name | Type | Description |
|
|
14368
15009
|
| --- | --- | --- |
|
|
14369
|
-
|constraints|Array<<a href="#constraint"
|
|
14370
|
-
|datasource|<a href="#datasourcedefinition">DatasourceDefinition</a>|Configuration of a datasource for a property. |
|
|
15010
|
+
|constraints|Array<<a href="#constraint">Constraint</a>>|A list of constraints limiting the values to be accepted. |
|
|
15011
|
+
|datasource|<a href="#datasourcedefinition" target="_blank" rel="noopener noreferrer">DatasourceDefinition</a>|Configuration of a datasource for a property. |
|
|
14371
15012
|
|default|AnyValue|<p>The default value to be used when no value is provided.</p> <p>If a non-singleton has the value of <code>null</code>, it means an empty collection.</p> |
|
|
14372
15013
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the property. |
|
|
14373
15014
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the property. |
|
|
14374
15015
|
|documentation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description and/or links to documentation. |
|
|
14375
15016
|
|forceSecretResubmission|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Defines if value is allowed to be modified when secret properties are not |
|
|
14376
|
-
|items|<a href="#item"
|
|
15017
|
+
|items|<a href="#item">Item</a>|An item of a collection property. |
|
|
14377
15018
|
|maxObjects<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The maximum number of <strong>objects</strong> in a collection property.</p> <p>Has the value of <code>1</code> for singletons.</p> |
|
|
14378
|
-
|metadata|<a href="#propertydefinitionmetadata">PropertyDefinitionMetadata</a>|Metadata of the property. |
|
|
15019
|
+
|metadata|<a href="#propertydefinitionmetadata" target="_blank" rel="noopener noreferrer">PropertyDefinitionMetadata</a>|Metadata of the property. |
|
|
14379
15020
|
|migrationPattern|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Pattern with references to properties to create a new value. |
|
|
14380
15021
|
|minObjects|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The minimum number of <strong>objects</strong> in a collection property. |
|
|
14381
15022
|
|modificationPolicy|"DEFAULT" | "ALWAYS" | "NEVER"|Modification policy of the property. |
|
|
14382
15023
|
|nullable<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The value can (<code>true</code>) or can't (<code>false</code>) be <code>null</code>. |
|
|
14383
|
-
|precondition|<a href="#precondition"
|
|
15024
|
+
|precondition|<a href="#precondition">Precondition</a>|A precondition for visibility of a property. |
|
|
14384
15025
|
|referencedType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type referenced by the property value |
|
|
14385
15026
|
|subType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The subtype of the property's value. |
|
|
14386
|
-
|type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | <a href="#refpointer">RefPointer</a>|The type of the property's value. |
|
|
14387
|
-
|uiCustomization|<a href="#uicustomization"
|
|
15027
|
+
|type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | <a href="#refpointer" target="_blank" rel="noopener noreferrer">RefPointer</a>|The type of the property's value. |
|
|
15028
|
+
|uiCustomization|<a href="#uicustomization">UiCustomization</a>|Customization for UI elements |
|
|
14388
15029
|
|
|
14389
15030
|
### PropertyDefinitionMetadata
|
|
14390
15031
|
|
|
@@ -14398,7 +15039,7 @@ Details that are specific to the used protocol.
|
|
|
14398
15039
|
|
|
14399
15040
|
| Name | Type | Description |
|
|
14400
15041
|
| --- | --- | --- |
|
|
14401
|
-
|http|<a href="#httpprotocoldetails">HttpProtocolDetails</a>|HTTP specific request details. |
|
|
15042
|
+
|http|<a href="#httpprotocoldetails" target="_blank" rel="noopener noreferrer">HttpProtocolDetails</a>|HTTP specific request details. |
|
|
14402
15043
|
|
|
14403
15044
|
### PublicCertificateCredentials
|
|
14404
15045
|
|
|
@@ -14407,17 +15048,17 @@ A credentials set of the `PUBLIC_CERTIFICATE` type.
|
|
|
14407
15048
|
| Name | Type | Description |
|
|
14408
15049
|
| --- | --- | --- |
|
|
14409
15050
|
|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). |
|
|
14410
|
-
|allowedEntities|Array<<a href="#credentialaccessdata"
|
|
15051
|
+
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
14411
15052
|
|certificate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The certificate in the string format. |
|
|
14412
|
-
|certificateFormat|"
|
|
15053
|
+
|certificateFormat|"UNKNOWN" | "PEM" | "PKCS12"|The certificate format. |
|
|
14413
15054
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
14414
15055
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
14415
15056
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
14416
15057
|
|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>). |
|
|
14417
15058
|
|password|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The password of the credential (not supported). |
|
|
14418
|
-
|~~scope~~<sup>**DEPRECATED**</sup>|"
|
|
14419
|
-
|scopes<sup>*required</sup>|Array<"
|
|
14420
|
-
|type|"
|
|
15059
|
+
|~~scope~~<sup>**DEPRECATED**</sup>|"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"|The scope of the credentials set. |
|
|
15060
|
+
|scopes<sup>*required</sup>|Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">|<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> |
|
|
15061
|
+
|type|"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>CERTIFICATE</code> -> CertificateCredentials</li> <li><code>PUBLIC_CERTIFICATE</code> -> PublicCertificateCredentials</li> <li><code>USERNAME_PASSWORD</code> -> UserPasswordCredentials</li> <li><code>TOKEN</code> -> TokenCredentials</li> <li><code>SNMPV3</code> -> SNMPV3Credentials</li> <li><code>AWS_MONITORING_KEY_BASED</code> -> AWSKeyBasedCredentialsDto</li> <li><code>AWS_MONITORING_ROLE_BASED</code> -> AWSRoleBasedCredentials</li> </ul> |
|
|
14421
15062
|
|
|
14422
15063
|
### PublicSyntheticLocation
|
|
14423
15064
|
|
|
@@ -14488,7 +15129,7 @@ A list of related container images.
|
|
|
14488
15129
|
|
|
14489
15130
|
| Name | Type | Description |
|
|
14490
15131
|
| --- | --- | --- |
|
|
14491
|
-
|containerImages|Array<<a href="#relatedcontainerimage">RelatedContainerImage</a>>|A list of related container images. |
|
|
15132
|
+
|containerImages|Array<<a href="#relatedcontainerimage" target="_blank" rel="noopener noreferrer">RelatedContainerImage</a>>|A list of related container images. |
|
|
14492
15133
|
|
|
14493
15134
|
### RelatedEntitiesList
|
|
14494
15135
|
|
|
@@ -14500,12 +15141,12 @@ Each related entity contains a list of corresponding affected entities (for exam
|
|
|
14500
15141
|
|
|
14501
15142
|
| Name | Type | Description |
|
|
14502
15143
|
| --- | --- | --- |
|
|
14503
|
-
|applications|Array<<a href="#relatedentity"
|
|
15144
|
+
|applications|Array<<a href="#relatedentity">RelatedEntity</a>>|A list of related applications. |
|
|
14504
15145
|
|databases|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of related databases. |
|
|
14505
|
-
|hosts|Array<<a href="#relatedentity">RelatedEntity</a>>|A list of related hosts. |
|
|
14506
|
-
|kubernetesClusters|Array<<a href="#relatedentity"
|
|
14507
|
-
|kubernetesWorkloads|Array<<a href="#relatedentity">RelatedEntity</a>>|A list of related Kubernetes workloads. |
|
|
14508
|
-
|services|Array<<a href="#relatedservice"
|
|
15146
|
+
|hosts|Array<<a href="#relatedentity" target="_blank" rel="noopener noreferrer">RelatedEntity</a>>|A list of related hosts. |
|
|
15147
|
+
|kubernetesClusters|Array<<a href="#relatedentity">RelatedEntity</a>>|A list of related Kubernetes clusters. |
|
|
15148
|
+
|kubernetesWorkloads|Array<<a href="#relatedentity" target="_blank" rel="noopener noreferrer">RelatedEntity</a>>|A list of related Kubernetes workloads. |
|
|
15149
|
+
|services|Array<<a href="#relatedservice">RelatedService</a>>|A list of related services. |
|
|
14509
15150
|
|
|
14510
15151
|
### RelatedEntity
|
|
14511
15152
|
|
|
@@ -14541,7 +15182,7 @@ The tuple &lt;name, product, stage, version&gt; is always unique.
|
|
|
14541
15182
|
| --- | --- | --- |
|
|
14542
15183
|
|affectedByProblems|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The entity has one or more problems |
|
|
14543
15184
|
|affectedBySecurityVulnerabilities|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The entity has one or more security vulnerabilities |
|
|
14544
|
-
|instances|Array<<a href="#releaseinstance">ReleaseInstance</a>>|The instances entityIds included in this release |
|
|
15185
|
+
|instances|Array<<a href="#releaseinstance" target="_blank" rel="noopener noreferrer">ReleaseInstance</a>>|The instances entityIds included in this release |
|
|
14545
15186
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The entity name |
|
|
14546
15187
|
|problemCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of problems of the entity |
|
|
14547
15188
|
|product|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The product name |
|
|
@@ -14549,7 +15190,7 @@ The tuple &lt;name, product, stage, version&gt; is always unique.
|
|
|
14549
15190
|
|running|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The related PGI is still running/monitored |
|
|
14550
15191
|
|securityVulnerabilitiesCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of security vulnerabilities of the entity |
|
|
14551
15192
|
|securityVulnerabilitiesEnabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Indicates that the security vulnerabilities feature is enabled |
|
|
14552
|
-
|softwareTechs|Array<<a href="#softwaretechs"
|
|
15193
|
+
|softwareTechs|Array<<a href="#softwaretechs">SoftwareTechs</a>>|The software technologies of the release |
|
|
14553
15194
|
|stage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The stage name |
|
|
14554
15195
|
|throughput|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The count of bytes per second of the entity |
|
|
14555
15196
|
|version|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identified release version |
|
|
@@ -14574,7 +15215,7 @@ A list of releases.
|
|
|
14574
15215
|
| --- | --- | --- |
|
|
14575
15216
|
|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> |
|
|
14576
15217
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
14577
|
-
|releases|Array<<a href="#release">Release</a>>|A list of releases. |
|
|
15218
|
+
|releases|Array<<a href="#release" target="_blank" rel="noopener noreferrer">Release</a>>|A list of releases. |
|
|
14578
15219
|
|releasesWithProblems|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of releases with problems. |
|
|
14579
15220
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
14580
15221
|
|
|
@@ -14585,15 +15226,15 @@ Assessment of the remediation item.
|
|
|
14585
15226
|
| Name | Type | Description |
|
|
14586
15227
|
| --- | --- | --- |
|
|
14587
15228
|
|assessmentAccuracy|"NOT_AVAILABLE" | "FULL" | "REDUCED"|The accuracy of the assessment. |
|
|
14588
|
-
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails"
|
|
15229
|
+
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails">AssessmentAccuracyDetails</a>|The assessment accuracy details. |
|
|
14589
15230
|
|dataAssets|"NOT_AVAILABLE" | "NOT_DETECTED" | "REACHABLE"|The reachability of related data assets by affected entities. |
|
|
14590
15231
|
|exposure|"NOT_AVAILABLE" | "NOT_DETECTED" | "PUBLIC_NETWORK"|The level of exposure of affected entities. |
|
|
14591
15232
|
|numberOfDataAssets|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of related data assets. |
|
|
14592
15233
|
|vulnerableFunctionRestartRequired|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether a restart is required for the latest vulnerable function data. |
|
|
14593
15234
|
|vulnerableFunctionUsage|"NOT_AVAILABLE" | "IN_USE" | "NOT_IN_USE"|The usage of vulnerable functions |
|
|
14594
|
-
|vulnerableFunctionsInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are in use. |
|
|
14595
|
-
|vulnerableFunctionsNotAvailable|Array<<a href="#vulnerablefunction"
|
|
14596
|
-
|vulnerableFunctionsNotInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are not in use. |
|
|
15235
|
+
|vulnerableFunctionsInUse|Array<<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>>|A list of vulnerable functions that are in use. |
|
|
15236
|
+
|vulnerableFunctionsNotAvailable|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are not available. |
|
|
15237
|
+
|vulnerableFunctionsNotInUse|Array<<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>>|A list of vulnerable functions that are not in use. |
|
|
14597
15238
|
|
|
14598
15239
|
### RemediationDetailsItem
|
|
14599
15240
|
|
|
@@ -14601,17 +15242,17 @@ Detailed information of a remediation item for a security problem.
|
|
|
14601
15242
|
|
|
14602
15243
|
| Name | Type | Description |
|
|
14603
15244
|
| --- | --- | --- |
|
|
14604
|
-
|assessment|<a href="#remediationassessment"
|
|
15245
|
+
|assessment|<a href="#remediationassessment">RemediationAssessment</a>|Assessment of the remediation item. |
|
|
14605
15246
|
|entityIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |
|
|
14606
15247
|
|firstAffectedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
14607
15248
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
14608
|
-
|muteState|<a href="#remediationitemmutestate">RemediationItemMuteState</a>|The mute state of a remediation item of a security problem. |
|
|
15249
|
+
|muteState|<a href="#remediationitemmutestate" target="_blank" rel="noopener noreferrer">RemediationItemMuteState</a>|The mute state of a remediation item of a security problem. |
|
|
14609
15250
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
14610
|
-
|remediationProgress|<a href="#remediationprogress"
|
|
15251
|
+
|remediationProgress|<a href="#remediationprogress">RemediationProgress</a>|The progress of this remediation item. It contains affected and unaffected entities. |
|
|
14611
15252
|
|resolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
14612
|
-
|trackingLink|<a href="#trackinglink">TrackingLink</a>|External tracking link URL associated with the remediable entity of the security problem. |
|
|
15253
|
+
|trackingLink|<a href="#trackinglink" target="_blank" rel="noopener noreferrer">TrackingLink</a>|External tracking link URL associated with the remediable entity of the security problem. |
|
|
14613
15254
|
|vulnerabilityState|"RESOLVED" | "VULNERABLE"| |
|
|
14614
|
-
|vulnerableComponents|Array<<a href="#remediationitemdetailsvulnerablecomponent"
|
|
15255
|
+
|vulnerableComponents|Array<<a href="#remediationitemdetailsvulnerablecomponent">RemediationItemDetailsVulnerableComponent</a>>|<p>A list of vulnerable components of the remediation item.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
14615
15256
|
|
|
14616
15257
|
### RemediationItem
|
|
14617
15258
|
|
|
@@ -14619,17 +15260,17 @@ A possible remediation for a security problem.
|
|
|
14619
15260
|
|
|
14620
15261
|
| Name | Type | Description |
|
|
14621
15262
|
| --- | --- | --- |
|
|
14622
|
-
|assessment|<a href="#remediationassessment">RemediationAssessment</a>|Assessment of the remediation item. |
|
|
15263
|
+
|assessment|<a href="#remediationassessment" target="_blank" rel="noopener noreferrer">RemediationAssessment</a>|Assessment of the remediation item. |
|
|
14623
15264
|
|entityIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |
|
|
14624
15265
|
|firstAffectedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
14625
15266
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
14626
|
-
|muteState|<a href="#remediationitemmutestate"
|
|
15267
|
+
|muteState|<a href="#remediationitemmutestate">RemediationItemMuteState</a>|The mute state of a remediation item of a security problem. |
|
|
14627
15268
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
14628
|
-
|remediationProgress|<a href="#remediationprogress">RemediationProgress</a>|The progress of this remediation item. It contains affected and unaffected entities. |
|
|
15269
|
+
|remediationProgress|<a href="#remediationprogress" target="_blank" rel="noopener noreferrer">RemediationProgress</a>|The progress of this remediation item. It contains affected and unaffected entities. |
|
|
14629
15270
|
|resolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
14630
|
-
|trackingLink|<a href="#trackinglink"
|
|
15271
|
+
|trackingLink|<a href="#trackinglink">TrackingLink</a>|External tracking link URL associated with the remediable entity of the security problem. |
|
|
14631
15272
|
|vulnerabilityState|"RESOLVED" | "VULNERABLE"| |
|
|
14632
|
-
|vulnerableComponents|Array<<a href="#vulnerablecomponent">VulnerableComponent</a>>|<p>A list of vulnerable components of the remediation item.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
15273
|
+
|vulnerableComponents|Array<<a href="#vulnerablecomponent" target="_blank" rel="noopener noreferrer">VulnerableComponent</a>>|<p>A list of vulnerable components of the remediation item.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
14633
15274
|
|
|
14634
15275
|
### RemediationItemDetailsVulnerableComponent
|
|
14635
15276
|
|
|
@@ -14651,7 +15292,7 @@ A list of remediation items.
|
|
|
14651
15292
|
|
|
14652
15293
|
| Name | Type | Description |
|
|
14653
15294
|
| --- | --- | --- |
|
|
14654
|
-
|remediationItems|Array<<a href="#remediationitem"
|
|
15295
|
+
|remediationItems|Array<<a href="#remediationitem">RemediationItem</a>>|A list of remediation items. |
|
|
14655
15296
|
|
|
14656
15297
|
### RemediationItemMuteState
|
|
14657
15298
|
|
|
@@ -14701,7 +15342,7 @@ Response of muting several remediation items.
|
|
|
14701
15342
|
|
|
14702
15343
|
| Name | Type | Description |
|
|
14703
15344
|
| --- | --- | --- |
|
|
14704
|
-
|summary<sup>*required</sup>|Array<<a href="#remediationitemmutingsummary">RemediationItemMutingSummary</a>>|The summary of which remediation items were muted and which already were muted previously. |
|
|
15345
|
+
|summary<sup>*required</sup>|Array<<a href="#remediationitemmutingsummary" target="_blank" rel="noopener noreferrer">RemediationItemMutingSummary</a>>|The summary of which remediation items were muted and which already were muted previously. |
|
|
14705
15346
|
|
|
14706
15347
|
### RemediationItemsBulkUnmute
|
|
14707
15348
|
|
|
@@ -14719,7 +15360,7 @@ Response of un-muting several remediation items.
|
|
|
14719
15360
|
|
|
14720
15361
|
| Name | Type | Description |
|
|
14721
15362
|
| --- | --- | --- |
|
|
14722
|
-
|summary<sup>*required</sup>|Array<<a href="#remediationitemmutingsummary"
|
|
15363
|
+
|summary<sup>*required</sup>|Array<<a href="#remediationitemmutingsummary">RemediationItemMutingSummary</a>>|The summary of which remediation items were un-muted and which already were un-muted previously. |
|
|
14723
15364
|
|
|
14724
15365
|
### RemediationItemsBulkUpdateDeleteDto
|
|
14725
15366
|
|
|
@@ -14728,7 +15369,7 @@ Contains the external tracking link associations to be applied to the remediatio
|
|
|
14728
15369
|
| Name | Type | Description |
|
|
14729
15370
|
| --- | --- | --- |
|
|
14730
15371
|
|deletes|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>Tracking links to remove from the security problem.</p> <p>List of remediation item IDs of the security problem for which to remove the tracking links.</p> |
|
|
14731
|
-
|updates|<a href="#remediationitemsbulkupdatedeletedtoupdates">RemediationItemsBulkUpdateDeleteDtoUpdates</a>|<p>Tracking links to set for the security problem.</p> <p>Map of remediation item ID to tracking link objects.</p> <p>Keys must be valid remediation item IDs of the security problem, the associated value must contain the link to set for the item.</p> |
|
|
15372
|
+
|updates|<a href="#remediationitemsbulkupdatedeletedtoupdates" target="_blank" rel="noopener noreferrer">RemediationItemsBulkUpdateDeleteDtoUpdates</a>|<p>Tracking links to set for the security problem.</p> <p>Map of remediation item ID to tracking link objects.</p> <p>Keys must be valid remediation item IDs of the security problem, the associated value must contain the link to set for the item.</p> |
|
|
14732
15373
|
|
|
14733
15374
|
### RemediationItemsBulkUpdateDeleteDtoUpdates
|
|
14734
15375
|
|
|
@@ -14755,12 +15396,12 @@ An affected or unaffected entity of a remediation for a security problem.
|
|
|
14755
15396
|
|
|
14756
15397
|
| Name | Type | Description |
|
|
14757
15398
|
| --- | --- | --- |
|
|
14758
|
-
|assessment|<a href="#remediationprogressentityassessment"
|
|
15399
|
+
|assessment|<a href="#remediationprogressentityassessment">RemediationProgressEntityAssessment</a>|Assessment of the remediation progress entity. |
|
|
14759
15400
|
|firstAffectedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the remediation progress entity has first been related to the vulnerability. |
|
|
14760
15401
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the remediation progress entity. |
|
|
14761
15402
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the remediation progress entity. |
|
|
14762
15403
|
|state|"AFFECTED" | "UNAFFECTED"|The current state of the remediation progress entity. |
|
|
14763
|
-
|vulnerableComponents|Array<<a href="#remediationprogressvulnerablecomponent">RemediationProgressVulnerableComponent</a>>|<p>A list of vulnerable components of the remediation item.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
15404
|
+
|vulnerableComponents|Array<<a href="#remediationprogressvulnerablecomponent" target="_blank" rel="noopener noreferrer">RemediationProgressVulnerableComponent</a>>|<p>A list of vulnerable components of the remediation item.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
14764
15405
|
|
|
14765
15406
|
### RemediationProgressEntityAssessment
|
|
14766
15407
|
|
|
@@ -14770,9 +15411,9 @@ Assessment of the remediation progress entity.
|
|
|
14770
15411
|
| --- | --- | --- |
|
|
14771
15412
|
|vulnerableFunctionRestartRequired|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether a restart is required for the latest vulnerable function data. |
|
|
14772
15413
|
|vulnerableFunctionUsage|"NOT_AVAILABLE" | "IN_USE" | "NOT_IN_USE"|The usage of vulnerable functions |
|
|
14773
|
-
|vulnerableFunctionsInUse|Array<<a href="#vulnerablefunction"
|
|
14774
|
-
|vulnerableFunctionsNotAvailable|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are not available. |
|
|
14775
|
-
|vulnerableFunctionsNotInUse|Array<<a href="#vulnerablefunction"
|
|
15414
|
+
|vulnerableFunctionsInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are in use. |
|
|
15415
|
+
|vulnerableFunctionsNotAvailable|Array<<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>>|A list of vulnerable functions that are not available. |
|
|
15416
|
+
|vulnerableFunctionsNotInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are not in use. |
|
|
14776
15417
|
|
|
14777
15418
|
### RemediationProgressEntityList
|
|
14778
15419
|
|
|
@@ -14780,7 +15421,7 @@ A list of remediation progress entities.
|
|
|
14780
15421
|
|
|
14781
15422
|
| Name | Type | Description |
|
|
14782
15423
|
| --- | --- | --- |
|
|
14783
|
-
|remediationProgressEntities|Array<<a href="#remediationprogressentity">RemediationProgressEntity</a>>|A list of remediation progress entities. |
|
|
15424
|
+
|remediationProgressEntities|Array<<a href="#remediationprogressentity" target="_blank" rel="noopener noreferrer">RemediationProgressEntity</a>>|A list of remediation progress entities. |
|
|
14784
15425
|
|
|
14785
15426
|
### RemediationProgressVulnerableComponent
|
|
14786
15427
|
|
|
@@ -14802,14 +15443,14 @@ Describes the complete request information of an attack.
|
|
|
14802
15443
|
| --- | --- | --- |
|
|
14803
15444
|
|host|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The target host of the request. |
|
|
14804
15445
|
|path|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The request path. |
|
|
14805
|
-
|protocolDetails|<a href="#protocoldetails"
|
|
15446
|
+
|protocolDetails|<a href="#protocoldetails">ProtocolDetails</a>|Details that are specific to the used protocol. |
|
|
14806
15447
|
|url|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The requested URL. |
|
|
14807
15448
|
|
|
14808
15449
|
### ResolutionRequest
|
|
14809
15450
|
|
|
14810
15451
|
| Name | Type |
|
|
14811
15452
|
| --- | --- |
|
|
14812
|
-
|permissions
|
|
15453
|
+
|permissions<sup>*required</sup>|Array<<a href="#singlepermissionrequest" target="_blank" rel="noopener noreferrer">SinglePermissionRequest</a>>|
|
|
14813
15454
|
|
|
14814
15455
|
### ResourceContext
|
|
14815
15456
|
|
|
@@ -14817,7 +15458,7 @@ The resource context, which contains additional permission information about the
|
|
|
14817
15458
|
|
|
14818
15459
|
| Name | Type | Description |
|
|
14819
15460
|
| --- | --- | --- |
|
|
14820
|
-
|modifications<sup>*required</sup>|<a href="#modification"
|
|
15461
|
+
|modifications<sup>*required</sup>|<a href="#modification">Modification</a>|The additional modification details for this settings object. |
|
|
14821
15462
|
|operations<sup>*required</sup>|Array<"delete" | "read" | "write">|The allowed operations on this settings object. |
|
|
14822
15463
|
|
|
14823
15464
|
### RevisionDiff
|
|
@@ -14829,10 +15470,10 @@ The diff between two revisions.
|
|
|
14829
15470
|
|jsonAfter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The new value of the changed settings value or null if the value has been deleted. |
|
|
14830
15471
|
|jsonBefore|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The previous value of the changed settings value or null if the value has been newly created. |
|
|
14831
15472
|
|jsonPatch|AnyValue|The JSON Patch for this value. May be null if the diff type is not UPDATE. |
|
|
14832
|
-
|modificationInfo|<a href="#historymodificationinfo">HistoryModificationInfo</a>|Modification information about the setting. |
|
|
15473
|
+
|modificationInfo|<a href="#historymodificationinfo" target="_blank" rel="noopener noreferrer">HistoryModificationInfo</a>|Modification information about the setting. |
|
|
14833
15474
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
|
|
14834
15475
|
|revision|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The revision of the change. |
|
|
14835
|
-
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema version the new value complies to |
|
|
15476
|
+
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema version the new value complies to. |
|
|
14836
15477
|
|type|"CREATE" | "DELETE" | "UPDATE" | "NO_CHANGE" | "REORDER"|The type of the difference. |
|
|
14837
15478
|
|
|
14838
15479
|
### RevisionDiffPage
|
|
@@ -14842,7 +15483,7 @@ The paged response payload for diff between revisions of settings.
|
|
|
14842
15483
|
| Name | Type | Description |
|
|
14843
15484
|
| --- | --- | --- |
|
|
14844
15485
|
|endTime<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The 'to' time in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') from the original request. |
|
|
14845
|
-
|items<sup>*required</sup>|Array<<a href="#revisiondiff"
|
|
15486
|
+
|items<sup>*required</sup>|Array<<a href="#revisiondiff">RevisionDiff</a>>|The list of revisions changes in the current page. |
|
|
14846
15487
|
|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> |
|
|
14847
15488
|
|pageSize<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
14848
15489
|
|startTime<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The 'from' time in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') from the original request. |
|
|
@@ -14854,7 +15495,7 @@ Risk assessment of a security problem.
|
|
|
14854
15495
|
| Name | Type | Description |
|
|
14855
15496
|
| --- | --- | --- |
|
|
14856
15497
|
|assessmentAccuracy|"NOT_AVAILABLE" | "FULL" | "REDUCED"|The accuracy of the assessment. |
|
|
14857
|
-
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails">AssessmentAccuracyDetails</a>|The assessment accuracy details. |
|
|
15498
|
+
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails" target="_blank" rel="noopener noreferrer">AssessmentAccuracyDetails</a>|The assessment accuracy details. |
|
|
14858
15499
|
|baseRiskLevel|"NONE" | "CRITICAL" | "HIGH" | "LOW" | "MEDIUM"|The risk level from the CVSS score. |
|
|
14859
15500
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score. |
|
|
14860
15501
|
|baseRiskVector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The original attack vector of the CVSS assessment. |
|
|
@@ -14889,7 +15530,7 @@ Risk assessment of a security problem.
|
|
|
14889
15530
|
| Name | Type | Description |
|
|
14890
15531
|
| --- | --- | --- |
|
|
14891
15532
|
|assessmentAccuracy|"NOT_AVAILABLE" | "FULL" | "REDUCED"|The accuracy of the assessment. |
|
|
14892
|
-
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails"
|
|
15533
|
+
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails">AssessmentAccuracyDetails</a>|The assessment accuracy details. |
|
|
14893
15534
|
|baseRiskLevel|"NONE" | "CRITICAL" | "HIGH" | "LOW" | "MEDIUM"|The risk level from the CVSS score. |
|
|
14894
15535
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score. |
|
|
14895
15536
|
|baseRiskVector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The original attack vector of the CVSS assessment. |
|
|
@@ -14909,7 +15550,7 @@ A snapshot of the risk assessment of a security problem.
|
|
|
14909
15550
|
| Name | Type | Description |
|
|
14910
15551
|
| --- | --- | --- |
|
|
14911
15552
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score. |
|
|
14912
|
-
|changes|<a href="#riskassessmentchanges">RiskAssessmentChanges</a>|All changes of the risk assessment. |
|
|
15553
|
+
|changes|<a href="#riskassessmentchanges" target="_blank" rel="noopener noreferrer">RiskAssessmentChanges</a>|All changes of the risk assessment. |
|
|
14913
15554
|
|exposure|"NOT_AVAILABLE" | "NOT_DETECTED" | "PUBLIC_NETWORK"|The level of exposure of affected entities. |
|
|
14914
15555
|
|numberOfAffectedEntities|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of currently affected entities. |
|
|
14915
15556
|
|numberOfAffectedNodes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of currently affected nodes. |
|
|
@@ -14942,7 +15583,7 @@ Parameters of a service-level objective (SLO).
|
|
|
14942
15583
|
|enabled<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The SLO is enabled (<code>true</code>) or disabled (<code>false</code>). |
|
|
14943
15584
|
|error<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The error of the SLO calculation.</p> <p>If the value differs from <code>NONE</code>, there is something wrong with the SLO calculation.</p> |
|
|
14944
15585
|
|errorBudget<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The error budget of the calculated SLO.</p> <p>The error budget is the difference between the calculated and target values. A positive number means all is good; a negative number means trouble.</p> <p>Has the value of the evaluated error budget or the value of <code>-1</code>:</p> <ul> <li>If there is an error with the SLO calculation; in that case check the value of the <strong>error</strong> property.</li> <li>If the evaluate parameter has not been set to <code>true</code>; in that case the <strong>error</strong> property will contain no error.</li> </ul> |
|
|
14945
|
-
|errorBudgetBurnRate<sup>*required</sup>|<a href="#sloburnrate"
|
|
15586
|
+
|errorBudgetBurnRate<sup>*required</sup>|<a href="#sloburnrate">SloBurnRate</a>|Error budget burn rate evaluation of a service-level objective (SLO). |
|
|
14946
15587
|
|errorBudgetMetricKey<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The key for the SLO's error budget func metric. |
|
|
14947
15588
|
|evaluatedPercentage<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The calculated status value of the SLO. Has the value of the evaluated SLO status or the value of <code>-1</code>:</p> <ul> <li>If there is an error with the SLO calculation; in that case check the value of the <strong>error</strong> property.</li> <li>If the evaluate parameter has not been set to <code>true</code>; in that case the <strong>error</strong> property will contain no error.</li> </ul> |
|
|
14948
15589
|
|evaluationType<sup>*required</sup>|"AGGREGATE"|The evaluation type of the SLO. |
|
|
@@ -14951,6 +15592,7 @@ Parameters of a service-level objective (SLO).
|
|
|
14951
15592
|
|~~metricDenominator~~<sup>**DEPRECATED**</sup>|[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> |
|
|
14952
15593
|
|metricExpression<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The percentage-based metric expression for the calculation of the SLO. |
|
|
14953
15594
|
|metricKey<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The key for the SLO's status func metric. |
|
|
15595
|
+
|metricName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name that is used to create SLO func metrics keys. Once created, metric name cannot be changed. |
|
|
14954
15596
|
|~~metricNumerator~~<sup>**DEPRECATED**</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The metric for the count of successes (the numerator in rate calculation).</p> <p>Required when the <strong>useRateMetric</strong> is set to <code>false</code>.</p> |
|
|
14955
15597
|
|~~metricRate~~<sup>**DEPRECATED**</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The percentage-based metric for the calculation of the SLO.</p> <p>Required when the <strong>useRateMetric</strong> is set to <code>true</code>.</p> |
|
|
14956
15598
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the SLO. |
|
|
@@ -14973,7 +15615,7 @@ Contains SLOs and paging information.
|
|
|
14973
15615
|
| --- | --- | --- |
|
|
14974
15616
|
|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> |
|
|
14975
15617
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
14976
|
-
|slo<sup>*required</sup>|Array<<a href="#slo">SLO</a>>|The list of SLOs. |
|
|
15618
|
+
|slo<sup>*required</sup>|Array<<a href="#slo" target="_blank" rel="noopener noreferrer">SLO</a>>|The list of SLOs. |
|
|
14977
15619
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
14978
15620
|
|
|
14979
15621
|
### SNMPV3Credentials
|
|
@@ -14983,7 +15625,7 @@ A credentials set of the `SNMPV3` type.
|
|
|
14983
15625
|
| Name | Type | Description |
|
|
14984
15626
|
| --- | --- | --- |
|
|
14985
15627
|
|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). |
|
|
14986
|
-
|allowedEntities|Array<<a href="#credentialaccessdata"
|
|
15628
|
+
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
14987
15629
|
|authenticationPassword|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The authentication password in the string format (should not be empty for AUTH_PRIV and AUTH_NO_PRIV security levels) |
|
|
14988
15630
|
|authenticationProtocol|"MD5" | "SHA" | "SHA224" | "SHA256" | "SHA384" | "SHA512"|The authentication protocol, supported protocols: MD5, SHA, SHA224, SHA256, SHA384, SHA512 |
|
|
14989
15631
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
@@ -14992,10 +15634,10 @@ A credentials set of the `SNMPV3` type.
|
|
|
14992
15634
|
|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>). |
|
|
14993
15635
|
|privacyPassword|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The privacy password in the string format (should not be empty for AUTH_PRIV security level) |
|
|
14994
15636
|
|privacyProtocol|"AES" | "AES192" | "AES192C" | "AES256" | "AES256C" | "DES"|The privacy protocol |
|
|
14995
|
-
|~~scope~~<sup>**DEPRECATED**</sup>|"
|
|
14996
|
-
|scopes<sup>*required</sup>|Array<"
|
|
15637
|
+
|~~scope~~<sup>**DEPRECATED**</sup>|"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"|The scope of the credentials set. |
|
|
15638
|
+
|scopes<sup>*required</sup>|Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">|<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> |
|
|
14997
15639
|
|securityLevel|"AUTH_NO_PRIV" | "AUTH_PRIV" | "NO_AUTH_NO_PRIV"|The security level, supported levels: AUTH_PRIV, NO_AUTH_NO_PRIV, AUTH_NO_PRIV |
|
|
14998
|
-
|type|"
|
|
15640
|
+
|type|"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>CERTIFICATE</code> -> CertificateCredentials</li> <li><code>PUBLIC_CERTIFICATE</code> -> PublicCertificateCredentials</li> <li><code>USERNAME_PASSWORD</code> -> UserPasswordCredentials</li> <li><code>TOKEN</code> -> TokenCredentials</li> <li><code>SNMPV3</code> -> SNMPV3Credentials</li> <li><code>AWS_MONITORING_KEY_BASED</code> -> AWSKeyBasedCredentialsDto</li> <li><code>AWS_MONITORING_ROLE_BASED</code> -> AWSRoleBasedCredentials</li> </ul> |
|
|
14999
15641
|
|username|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|User name value |
|
|
15000
15642
|
|
|
15001
15643
|
### SchemaConstraintRestDto
|
|
@@ -15013,25 +15655,25 @@ A credentials set of the `SNMPV3` type.
|
|
|
15013
15655
|
| Name | Type | Description |
|
|
15014
15656
|
| --- | --- | --- |
|
|
15015
15657
|
|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. |
|
|
15016
|
-
|constraints|Array<<a href="#complexconstraint">ComplexConstraint</a>>|A list of constrains limiting the values to be accepted by the schema. |
|
|
15017
|
-
|deletionConstraints|Array<<a href="#deletionconstraint"
|
|
15658
|
+
|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. |
|
|
15659
|
+
|deletionConstraints|Array<<a href="#deletionconstraint">DeletionConstraint</a>>|Constraints limiting the values to be deleted. |
|
|
15018
15660
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the schema. |
|
|
15019
15661
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the schema. |
|
|
15020
15662
|
|documentation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description of the schema and/or links to documentation. |
|
|
15021
15663
|
|dynatrace<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the data format. |
|
|
15022
|
-
|enums<sup>*required</sup>|<a href="#schemadefinitionrestdtoenums">SchemaDefinitionRestDtoEnums</a>|A list of definitions of enum properties. |
|
|
15664
|
+
|enums<sup>*required</sup>|<a href="#schemadefinitionrestdtoenums" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoEnums</a>|A list of definitions of enum properties. |
|
|
15023
15665
|
|keyProperty|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Name of the key property in this schema. |
|
|
15024
15666
|
|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> |
|
|
15025
|
-
|metadata|<a href="#schemadefinitionrestdtometadata"
|
|
15667
|
+
|metadata|<a href="#schemadefinitionrestdtometadata">SchemaDefinitionRestDtoMetadata</a>|Metadata of the setting. |
|
|
15026
15668
|
|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. |
|
|
15027
15669
|
|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> |
|
|
15028
|
-
|properties<sup>*required</sup>|<a href="#schemadefinitionrestdtoproperties">SchemaDefinitionRestDtoProperties</a>|A list of schema's properties. |
|
|
15029
|
-
|schemaConstraints|Array<<a href="#schemaconstraintrestdto"
|
|
15670
|
+
|properties<sup>*required</sup>|<a href="#schemadefinitionrestdtoproperties" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoProperties</a>|A list of schema's properties. |
|
|
15671
|
+
|schemaConstraints|Array<<a href="#schemaconstraintrestdto">SchemaConstraintRestDto</a>>|Constraints limiting the values as a whole to be accepted in this configuration element. |
|
|
15030
15672
|
|schemaGroups|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Names of the groups, which the schema belongs to. |
|
|
15031
15673
|
|schemaId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the schema. |
|
|
15032
|
-
|tableColumns|<a href="#schemadefinitionrestdtotablecolumns">SchemaDefinitionRestDtoTableColumns</a>|Table column definitions for use in the ui. |
|
|
15033
|
-
|types<sup>*required</sup>|<a href="#schemadefinitionrestdtotypes"
|
|
15034
|
-
|uiCustomization|<a href="#uicustomization">UiCustomization</a>|Customization for UI elements |
|
|
15674
|
+
|tableColumns|<a href="#schemadefinitionrestdtotablecolumns" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoTableColumns</a>|Table column definitions for use in the ui. |
|
|
15675
|
+
|types<sup>*required</sup>|<a href="#schemadefinitionrestdtotypes">SchemaDefinitionRestDtoTypes</a>|<p>A list of definitions of types.</p> <p>A type is a complex property that contains its own set of subproperties.</p> |
|
|
15676
|
+
|uiCustomization|<a href="#uicustomization" target="_blank" rel="noopener noreferrer">UiCustomization</a>|Customization for UI elements |
|
|
15035
15677
|
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema. |
|
|
15036
15678
|
|
|
15037
15679
|
### SchemaDefinitionRestDtoEnums
|
|
@@ -15078,7 +15720,7 @@ The list of available settings schemas.
|
|
|
15078
15720
|
|
|
15079
15721
|
| Name | Type | Description |
|
|
15080
15722
|
| --- | --- | --- |
|
|
15081
|
-
|items<sup>*required</sup>|Array<<a href="#schemastub"
|
|
15723
|
+
|items<sup>*required</sup>|Array<<a href="#schemastub">SchemaStub</a>>|A list of settings schemas. |
|
|
15082
15724
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of schemas in the list. |
|
|
15083
15725
|
|
|
15084
15726
|
### SchemaStub
|
|
@@ -15101,11 +15743,11 @@ A list of definitions of types.
|
|
|
15101
15743
|
|
|
15102
15744
|
| Name | Type | Description |
|
|
15103
15745
|
| --- | --- | --- |
|
|
15104
|
-
|constraints|Array<<a href="#complexconstraint">ComplexConstraint</a>>|A list of constraints limiting the values to be accepted. |
|
|
15746
|
+
|constraints|Array<<a href="#complexconstraint" target="_blank" rel="noopener noreferrer">ComplexConstraint</a>>|A list of constraints limiting the values to be accepted. |
|
|
15105
15747
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the property. |
|
|
15106
15748
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the property. |
|
|
15107
15749
|
|documentation<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description and/or links to documentation. |
|
|
15108
|
-
|properties<sup>*required</sup>|<a href="#schematypeproperties"
|
|
15750
|
+
|properties<sup>*required</sup>|<a href="#schematypeproperties">SchemaTypeProperties</a>|Definition of properties that can be persisted. |
|
|
15109
15751
|
|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. |
|
|
15110
15752
|
|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. |
|
|
15111
15753
|
|type<sup>*required</sup>|"object"|Type of the reference type. |
|
|
@@ -15145,19 +15787,19 @@ Parameters of a security problem
|
|
|
15145
15787
|
|
|
15146
15788
|
| Name | Type | Description |
|
|
15147
15789
|
| --- | --- | --- |
|
|
15148
|
-
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails">CodeLevelVulnerabilityDetails</a>|The details of a code-level vulnerability. |
|
|
15790
|
+
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails" target="_blank" rel="noopener noreferrer">CodeLevelVulnerabilityDetails</a>|The details of a code-level vulnerability. |
|
|
15149
15791
|
|cveIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of CVE IDs of the security problem. |
|
|
15150
15792
|
|displayId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display ID of the security problem. |
|
|
15151
15793
|
|externalVulnerabilityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external vulnerability ID of the security problem. |
|
|
15152
15794
|
|firstSeenTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the first occurrence of the security problem. |
|
|
15153
|
-
|globalCounts|<a href="#globalcountsdto"
|
|
15795
|
+
|globalCounts|<a href="#globalcountsdto">GlobalCountsDto</a>|Globally calculated statistics about the security problem. No management zone information is taken into account. |
|
|
15154
15796
|
|lastOpenedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last opened. |
|
|
15155
15797
|
|lastResolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last resolved. |
|
|
15156
15798
|
|lastUpdatedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the most recent security problem change. |
|
|
15157
|
-
|managementZones|Array<<a href="#managementzone">ManagementZone</a>>|A list of management zones which the affected entities belong to. |
|
|
15799
|
+
|managementZones|Array<<a href="#managementzone" target="_blank" rel="noopener noreferrer">ManagementZone</a>>|A list of management zones which the affected entities belong to. |
|
|
15158
15800
|
|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. |
|
|
15159
15801
|
|packageName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The package name of the security problem. |
|
|
15160
|
-
|riskAssessment|<a href="#riskassessment"
|
|
15802
|
+
|riskAssessment|<a href="#riskassessment">RiskAssessment</a>|Risk assessment of a security problem. |
|
|
15161
15803
|
|securityProblemId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the security problem. |
|
|
15162
15804
|
|status|"OPEN" | "RESOLVED"|The status of the security problem. |
|
|
15163
15805
|
|technology|"KUBERNETES" | "DOTNET" | "GO" | "JAVA" | "NODE_JS" | "PHP" | "PYTHON"|The technology of the security problem. |
|
|
@@ -15182,37 +15824,37 @@ Parameters of a security problem
|
|
|
15182
15824
|
| Name | Type | Description |
|
|
15183
15825
|
| --- | --- | --- |
|
|
15184
15826
|
|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> |
|
|
15185
|
-
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails">CodeLevelVulnerabilityDetails</a>|The details of a code-level vulnerability. |
|
|
15827
|
+
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails" target="_blank" rel="noopener noreferrer">CodeLevelVulnerabilityDetails</a>|The details of a code-level vulnerability. |
|
|
15186
15828
|
|cveIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of CVE IDs of the security problem. |
|
|
15187
15829
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the security problem. |
|
|
15188
15830
|
|displayId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display ID of the security problem. |
|
|
15189
|
-
|entryPoints|<a href="#entrypoints"
|
|
15190
|
-
|events|Array<<a href="#securityproblemevent">SecurityProblemEvent</a>>|An ordered (newest first) list of events of the security problem. |
|
|
15831
|
+
|entryPoints|<a href="#entrypoints">EntryPoints</a>|A list of entry points and a flag which indicates whether this list was truncated or not. |
|
|
15832
|
+
|events|Array<<a href="#securityproblemevent" target="_blank" rel="noopener noreferrer">SecurityProblemEvent</a>>|An ordered (newest first) list of events of the security problem. |
|
|
15191
15833
|
|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> |
|
|
15192
15834
|
|externalVulnerabilityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external vulnerability ID of the security problem. |
|
|
15193
|
-
|filteredCounts|<a href="#filteredcountsdto"
|
|
15835
|
+
|filteredCounts|<a href="#filteredcountsdto">FilteredCountsDto</a>|Statistics about the security problem, filtered by the management zone and timeframe start ('from') query parameters. |
|
|
15194
15836
|
|firstSeenTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the first occurrence of the security problem. |
|
|
15195
|
-
|globalCounts|<a href="#globalcountsdto">GlobalCountsDto</a>|Globally calculated statistics about the security problem. No management zone information is taken into account. |
|
|
15837
|
+
|globalCounts|<a href="#globalcountsdto" target="_blank" rel="noopener noreferrer">GlobalCountsDto</a>|Globally calculated statistics about the security problem. No management zone information is taken into account. |
|
|
15196
15838
|
|lastOpenedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last opened. |
|
|
15197
15839
|
|lastResolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last resolved. |
|
|
15198
15840
|
|lastUpdatedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the most recent security problem change. |
|
|
15199
|
-
|managementZones|Array<<a href="#managementzone"
|
|
15841
|
+
|managementZones|Array<<a href="#managementzone">ManagementZone</a>>|A list of management zones which the affected entities belong to. |
|
|
15200
15842
|
|muteStateChangeInProgress|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code> a change of the mute state is in progress. |
|
|
15201
15843
|
|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. |
|
|
15202
15844
|
|packageName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The package name of the security problem. |
|
|
15203
15845
|
|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> |
|
|
15204
|
-
|relatedAttacks|<a href="#relatedattackslist">RelatedAttacksList</a>|<p>A list of related attacks of the security problem.</p> <p>Related attacks are attacks on the exposed security problem.</p> |
|
|
15205
|
-
|relatedContainerImages|<a href="#relatedcontainerlist"
|
|
15206
|
-
|relatedEntities|<a href="#relatedentitieslist">RelatedEntitiesList</a>|<p>A list of related entities of the security problem.</p> <p>A related entity is a monitored entity that is directly or indirectly related to an <em>affected entity</em> (for example, it could be a host where an affected process runs).</p> <p>Each related entity contains a list of corresponding affected entities (for example, an affected process running on this host).</p> |
|
|
15846
|
+
|relatedAttacks|<a href="#relatedattackslist" target="_blank" rel="noopener noreferrer">RelatedAttacksList</a>|<p>A list of related attacks of the security problem.</p> <p>Related attacks are attacks on the exposed security problem.</p> |
|
|
15847
|
+
|relatedContainerImages|<a href="#relatedcontainerlist">RelatedContainerList</a>|A list of related container images. |
|
|
15848
|
+
|relatedEntities|<a href="#relatedentitieslist" target="_blank" rel="noopener noreferrer">RelatedEntitiesList</a>|<p>A list of related entities of the security problem.</p> <p>A related entity is a monitored entity that is directly or indirectly related to an <em>affected entity</em> (for example, it could be a host where an affected process runs).</p> <p>Each related entity contains a list of corresponding affected entities (for example, an affected process running on this host).</p> |
|
|
15207
15849
|
|remediationDescription|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Description of how to remediate the vulnerability. |
|
|
15208
|
-
|riskAssessment|<a href="#riskassessmentdetails"
|
|
15850
|
+
|riskAssessment|<a href="#riskassessmentdetails">RiskAssessmentDetails</a>|Risk assessment of a security problem. |
|
|
15209
15851
|
|securityProblemId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the security problem. |
|
|
15210
15852
|
|status|"OPEN" | "RESOLVED"|The status of the security problem. |
|
|
15211
15853
|
|technology|"KUBERNETES" | "DOTNET" | "GO" | "JAVA" | "NODE_JS" | "PHP" | "PYTHON"|The technology of the security problem. |
|
|
15212
15854
|
|title|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The title of the security problem. |
|
|
15213
15855
|
|url|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The URL to the security problem details page. |
|
|
15214
15856
|
|vulnerabilityType|"CODE_LEVEL" | "RUNTIME" | "THIRD_PARTY"|The type of the vulnerability. |
|
|
15215
|
-
|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> |
|
|
15857
|
+
|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> |
|
|
15216
15858
|
|
|
15217
15859
|
### SecurityProblemEvent
|
|
15218
15860
|
|
|
@@ -15220,9 +15862,9 @@ The event of a security problem.
|
|
|
15220
15862
|
|
|
15221
15863
|
| Name | Type | Description |
|
|
15222
15864
|
| --- | --- | --- |
|
|
15223
|
-
|muteState|<a href="#mutestate"
|
|
15865
|
+
|muteState|<a href="#mutestate">MuteState</a>|Metadata of the muted state of a security problem in relation to an event. |
|
|
15224
15866
|
|reason|"ASSESSMENT_CHANGED" | "SECURITY_PROBLEM_CREATED" | "SECURITY_PROBLEM_MUTED" | "SECURITY_PROBLEM_REOPENED" | "SECURITY_PROBLEM_RESOLVED" | "SECURITY_PROBLEM_UNMUTED"|The reason of the event creation. |
|
|
15225
|
-
|riskAssessmentSnapshot|<a href="#riskassessmentsnapshot">RiskAssessmentSnapshot</a>|A snapshot of the risk assessment of a security problem. |
|
|
15867
|
+
|riskAssessmentSnapshot|<a href="#riskassessmentsnapshot" target="_blank" rel="noopener noreferrer">RiskAssessmentSnapshot</a>|A snapshot of the risk assessment of a security problem. |
|
|
15226
15868
|
|timestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the event occurred. |
|
|
15227
15869
|
|
|
15228
15870
|
### SecurityProblemEventsList
|
|
@@ -15231,7 +15873,7 @@ A list of events for a security problem.
|
|
|
15231
15873
|
|
|
15232
15874
|
| Name | Type | Description |
|
|
15233
15875
|
| --- | --- | --- |
|
|
15234
|
-
|events|Array<<a href="#securityproblemevent"
|
|
15876
|
+
|events|Array<<a href="#securityproblemevent">SecurityProblemEvent</a>>|A list of events for a security problem. |
|
|
15235
15877
|
|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> |
|
|
15236
15878
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
15237
15879
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -15244,7 +15886,7 @@ A list of security problems.
|
|
|
15244
15886
|
| --- | --- | --- |
|
|
15245
15887
|
|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> |
|
|
15246
15888
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
15247
|
-
|securityProblems|Array<<a href="#securityproblem">SecurityProblem</a>>|A list of security problems. |
|
|
15889
|
+
|securityProblems|Array<<a href="#securityproblem" target="_blank" rel="noopener noreferrer">SecurityProblem</a>>|A list of security problems. |
|
|
15248
15890
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
15249
15891
|
|
|
15250
15892
|
### SecurityProblemMute
|
|
@@ -15281,7 +15923,7 @@ Response of muting several security problems.
|
|
|
15281
15923
|
|
|
15282
15924
|
| Name | Type | Description |
|
|
15283
15925
|
| --- | --- | --- |
|
|
15284
|
-
|summary<sup>*required</sup>|Array<<a href="#securityproblembulkmutingsummary"
|
|
15926
|
+
|summary<sup>*required</sup>|Array<<a href="#securityproblembulkmutingsummary">SecurityProblemBulkMutingSummary</a>>|The summary of which security problems were muted and which already were muted previously. |
|
|
15285
15927
|
|
|
15286
15928
|
### SecurityProblemsBulkUnmute
|
|
15287
15929
|
|
|
@@ -15299,7 +15941,7 @@ Response of un-muting several security problems.
|
|
|
15299
15941
|
|
|
15300
15942
|
| Name | Type | Description |
|
|
15301
15943
|
| --- | --- | --- |
|
|
15302
|
-
|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. |
|
|
15944
|
+
|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. |
|
|
15303
15945
|
|
|
15304
15946
|
### ServiceImpact
|
|
15305
15947
|
|
|
@@ -15309,7 +15951,7 @@ Analysis of problem impact to a service.
|
|
|
15309
15951
|
| --- | --- | --- |
|
|
15310
15952
|
|estimatedAffectedUsers<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of affected users. |
|
|
15311
15953
|
|impactType<sup>*required</sup>|"APPLICATION" | "CUSTOM_APPLICATION" | "MOBILE" | "SERVICE"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>SERVICE</code> -> ServiceImpact</li> <li><code>APPLICATION</code> -> ApplicationImpact</li> <li><code>MOBILE</code> -> MobileImpact</li> <li><code>CUSTOM_APPLICATION</code> -> CustomApplicationImpact</li> </ul> |
|
|
15312
|
-
|impactedEntity<sup>*required</sup>|<a href="#entitystub"
|
|
15954
|
+
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
15313
15955
|
|numberOfPotentiallyAffectedServiceCalls|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of potentially impacted services. |
|
|
15314
15956
|
|
|
15315
15957
|
### SettingsObject
|
|
@@ -15322,12 +15964,12 @@ A settings object.
|
|
|
15322
15964
|
|created|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the creation. |
|
|
15323
15965
|
|createdBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who created the settings object. |
|
|
15324
15966
|
|externalId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external identifier of the settings object. |
|
|
15325
|
-
|~~modificationInfo~~<sup>**DEPRECATED**</sup>|<a href="#modificationinfo">ModificationInfo</a>|The modification info for a single updatable setting. Replaced by <code>resourceContext</code>. |
|
|
15967
|
+
|~~modificationInfo~~<sup>**DEPRECATED**</sup>|<a href="#modificationinfo" target="_blank" rel="noopener noreferrer">ModificationInfo</a>|The modification info for a single updatable setting. Replaced by <code>resourceContext</code>. |
|
|
15326
15968
|
|modified|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification. |
|
|
15327
15969
|
|modifiedBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who performed the most recent modification. |
|
|
15328
15970
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
|
|
15329
|
-
|owner|<a href="#identity"
|
|
15330
|
-
|resourceContext|<a href="#resourcecontext">ResourceContext</a>|The resource context, which contains additional permission information about the object. |
|
|
15971
|
+
|owner|<a href="#identity">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users). |
|
|
15972
|
+
|resourceContext|<a href="#resourcecontext" target="_blank" rel="noopener noreferrer">ResourceContext</a>|The resource context, which contains additional permission information about the object. |
|
|
15331
15973
|
|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema on which the object is based. |
|
|
15332
15974
|
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema on which the object is based. |
|
|
15333
15975
|
|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>. |
|
|
@@ -15349,8 +15991,8 @@ The response to a get by objectId request.
|
|
|
15349
15991
|
|modified|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification. |
|
|
15350
15992
|
|modifiedBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who performed the most recent modification. |
|
|
15351
15993
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
|
|
15352
|
-
|owner|<a href="#identity"
|
|
15353
|
-
|resourceContext|<a href="#resourcecontext">ResourceContext</a>|The resource context, which contains additional permission information about the object. |
|
|
15994
|
+
|owner|<a href="#identity">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users). |
|
|
15995
|
+
|resourceContext|<a href="#resourcecontext" target="_blank" rel="noopener noreferrer">ResourceContext</a>|The resource context, which contains additional permission information about the object. |
|
|
15354
15996
|
|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema on which the object is based. |
|
|
15355
15997
|
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema on which the object is based. |
|
|
15356
15998
|
|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>. |
|
|
@@ -15366,7 +16008,7 @@ Configuration of a new settings object.
|
|
|
15366
16008
|
| Name | Type | Description |
|
|
15367
16009
|
| --- | --- | --- |
|
|
15368
16010
|
|externalId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|External identifier for the object being created |
|
|
15369
|
-
|insertAfter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The position of the new object. The new object will be added after the specified one.</p> <p>If <code>null</code
|
|
16011
|
+
|insertAfter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The position of the new object. The new object will be added after the specified one.</p> <p>If <code>null</code> (or unset), the new object will be placed in the last position.</p> <p>If set to an empty string, the new object will be placed in the first position.</p> <p>Only applicable for objects based on schemas with ordered objects (schema's <code>ordered</code> parameter is set to <code>true</code>).</p> |
|
|
15370
16012
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The ID of the settings object that should be replaced.</p> <p>Only applicable if an external identifier is provided.</p> |
|
|
15371
16013
|
|schemaId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema on which the object is based. |
|
|
15372
16014
|
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema on which the object is based. |
|
|
@@ -15380,7 +16022,7 @@ The response to a creation- or update-request.
|
|
|
15380
16022
|
| Name | Type | Description |
|
|
15381
16023
|
| --- | --- | --- |
|
|
15382
16024
|
|code<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The HTTP status code for the object. |
|
|
15383
|
-
|error|<a href="#error"
|
|
16025
|
+
|error|<a href="#error">Error</a>| |
|
|
15384
16026
|
|invalidValue|AnyValue|<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> |
|
|
15385
16027
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|For a successful request, the ID of the created or modified settings object. |
|
|
15386
16028
|
|
|
@@ -15390,8 +16032,8 @@ An update of a settings object.
|
|
|
15390
16032
|
|
|
15391
16033
|
| Name | Type | Description |
|
|
15392
16034
|
| --- | --- | --- |
|
|
15393
|
-
|insertAfter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The position of the updated object. The new object will be moved behind the specified one.</p> <p><strong>insertAfter</strong> and <strong>insertBefore</strong> are evaluated together and only one of both can be set.</p> <p>If <code>null</code> and <strong>insertBefore</strong>
|
|
15394
|
-
|insertBefore|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The position of the updated object. The new object will be moved in front of the specified one.</p> <p><strong>insertAfter</strong> and <strong>insertBefore</strong> are evaluated together and only one of both can be set.</p> <p>If <code>null</code> and <strong>insertAfter</strong>
|
|
16035
|
+
|insertAfter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The position of the updated object. The new object will be moved behind the specified one.</p> <p><strong>insertAfter</strong> and <strong>insertBefore</strong> are evaluated together and only one of both can be set (and be non <code>null</code>).</p> <p>If <code>null</code> (or unset) and <strong>insertBefore</strong> is <code>null</code> (or unset), the existing object keeps the current position.</p> <p>If set to an empty string, the updated object will be placed in the first position.</p> <p>Only applicable for objects based on schemas with ordered objects (schema's <strong>ordered</strong> parameter is set to <code>true</code>).</p> |
|
|
16036
|
+
|insertBefore|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The position of the updated object. The new object will be moved in front of the specified one.</p> <p><strong>insertAfter</strong> and <strong>insertBefore</strong> are evaluated together and only one of both can be set (and be non <code>null</code>).</p> <p>If <code>null</code> (or unset) and <strong>insertAfter</strong> is <code>null</code> (or unset), the existing object keeps the current position.</p> <p>If set to an empty string, the updated object will be placed in the last position.</p> <p>Only applicable for objects based on schemas with ordered objects (schema's <strong>ordered</strong> parameter is set to <code>true</code>).</p> |
|
|
15395
16037
|
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema on which the object is based. |
|
|
15396
16038
|
|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> |
|
|
15397
16039
|
|value<sup>*required</sup>|AnyValue|<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> |
|
|
@@ -15402,7 +16044,7 @@ A list of permissions.
|
|
|
15402
16044
|
|
|
15403
16045
|
| Name | Type | Description |
|
|
15404
16046
|
| --- | --- | --- |
|
|
15405
|
-
|context|<a href="#permissioncontext">PermissionContext</a>|Optional context data |
|
|
16047
|
+
|context|<a href="#permissioncontext" target="_blank" rel="noopener noreferrer">PermissionContext</a>|Optional context data |
|
|
15406
16048
|
|permission<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Permission to be probed |
|
|
15407
16049
|
|
|
15408
16050
|
### SloBurnRate
|
|
@@ -15433,7 +16075,7 @@ Error budget burn rate configuration of a service-level objective (SLO).
|
|
|
15433
16075
|
| --- | --- | --- |
|
|
15434
16076
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the SLO. |
|
|
15435
16077
|
|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> |
|
|
15436
|
-
|errorBudgetBurnRate|<a href="#sloburnrateconfig"
|
|
16078
|
+
|errorBudgetBurnRate|<a href="#sloburnrateconfig">SloBurnRateConfig</a>|Error budget burn rate configuration of a service-level objective (SLO). |
|
|
15437
16079
|
|evaluationType<sup>*required</sup>|"AGGREGATE"|The evaluation type of the SLO. |
|
|
15438
16080
|
|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>. |
|
|
15439
16081
|
|~~metricDenominator~~<sup>**DEPRECATED**</sup>|[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> |
|
|
@@ -15479,7 +16121,7 @@ Parameters of a status alert.
|
|
|
15479
16121
|
|
|
15480
16122
|
| Name | Type |
|
|
15481
16123
|
| --- | --- |
|
|
15482
|
-
|details|<a href="#success">Success</a>|
|
|
16124
|
+
|details|<a href="#success" target="_blank" rel="noopener noreferrer">Success</a>|
|
|
15483
16125
|
|
|
15484
16126
|
### SyntheticConfigDto
|
|
15485
16127
|
|
|
@@ -15536,7 +16178,7 @@ A list of synthetic locations.
|
|
|
15536
16178
|
|
|
15537
16179
|
| Name | Type | Description |
|
|
15538
16180
|
| --- | --- | --- |
|
|
15539
|
-
|locations<sup>*required</sup>|Array<<a href="#locationcollectionelement"
|
|
16181
|
+
|locations<sup>*required</sup>|Array<<a href="#locationcollectionelement">LocationCollectionElement</a>>|A list of synthetic locations. |
|
|
15540
16182
|
|
|
15541
16183
|
### SyntheticMonitorListDto
|
|
15542
16184
|
|
|
@@ -15544,7 +16186,7 @@ List of available synthetic monitors.
|
|
|
15544
16186
|
|
|
15545
16187
|
| Name | Type | Description |
|
|
15546
16188
|
| --- | --- | --- |
|
|
15547
|
-
|monitors|Array<<a href="#syntheticmonitorsummarydto">SyntheticMonitorSummaryDto</a>>|List of monitors. |
|
|
16189
|
+
|monitors|Array<<a href="#syntheticmonitorsummarydto" target="_blank" rel="noopener noreferrer">SyntheticMonitorSummaryDto</a>>|List of monitors. |
|
|
15548
16190
|
|
|
15549
16191
|
### SyntheticMonitorOutageHandlingSettingsDto
|
|
15550
16192
|
|
|
@@ -15578,7 +16220,7 @@ Performance thresholds configuration.
|
|
|
15578
16220
|
| Name | Type | Description |
|
|
15579
16221
|
| --- | --- | --- |
|
|
15580
16222
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Performance threshold is enabled (<code>true</code>) or disabled (<code>false</code>). |
|
|
15581
|
-
|thresholds|Array<<a href="#syntheticmonitorperformancethresholddto"
|
|
16223
|
+
|thresholds|Array<<a href="#syntheticmonitorperformancethresholddto">SyntheticMonitorPerformanceThresholdDto</a>>|The list of performance threshold rules. |
|
|
15582
16224
|
|
|
15583
16225
|
### SyntheticMonitorSummaryDto
|
|
15584
16226
|
|
|
@@ -15597,7 +16239,7 @@ The network availability monitor constraint.
|
|
|
15597
16239
|
|
|
15598
16240
|
| Name | Type | Description |
|
|
15599
16241
|
| --- | --- | --- |
|
|
15600
|
-
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorconstraintdtoproperties">SyntheticMultiProtocolMonitorConstraintDtoProperties</a>|The properties of the constraint. |
|
|
16242
|
+
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorconstraintdtoproperties" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorConstraintDtoProperties</a>|The properties of the constraint. |
|
|
15601
16243
|
|type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Constraint type. |
|
|
15602
16244
|
|
|
15603
16245
|
### SyntheticMultiProtocolMonitorConstraintDtoProperties
|
|
@@ -15619,10 +16261,10 @@ Network Availability monitor.
|
|
|
15619
16261
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
15620
16262
|
|modificationTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification |
|
|
15621
16263
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
15622
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto"
|
|
15623
|
-
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor. |
|
|
15624
|
-
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto"
|
|
15625
|
-
|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> |
|
|
16264
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
16265
|
+
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor. |
|
|
16266
|
+
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
|
|
16267
|
+
|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> |
|
|
15626
16268
|
|type<sup>*required</sup>|"BROWSER" | "HTTP" | "THIRD_PARTY" | "MULTI_PROTOCOL"| |
|
|
15627
16269
|
|
|
15628
16270
|
### SyntheticMultiProtocolMonitorStepDto
|
|
@@ -15631,10 +16273,10 @@ The step of a network availability monitor.
|
|
|
15631
16273
|
|
|
15632
16274
|
| Name | Type | Description |
|
|
15633
16275
|
| --- | --- | --- |
|
|
15634
|
-
|constraints<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorconstraintdto"
|
|
16276
|
+
|constraints<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorconstraintdto">SyntheticMultiProtocolMonitorConstraintDto</a>>|The list of constraints which apply to all requests in the step. |
|
|
15635
16277
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Step name. |
|
|
15636
|
-
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorstepdtoproperties">SyntheticMultiProtocolMonitorStepDtoProperties</a>|The properties which apply to all requests in the step. |
|
|
15637
|
-
|requestConfigurations<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolrequestconfigurationdto"
|
|
16278
|
+
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorstepdtoproperties" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorStepDtoProperties</a>|The properties which apply to all requests in the step. |
|
|
16279
|
+
|requestConfigurations<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolrequestconfigurationdto">SyntheticMultiProtocolRequestConfigurationDto</a>>|Request configurations. |
|
|
15638
16280
|
|requestType<sup>*required</sup>|"ICMP" | "TCP" | "DNS"|Request type. |
|
|
15639
16281
|
|targetFilter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Target filter. |
|
|
15640
16282
|
|targetList<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Target list. |
|
|
@@ -15656,10 +16298,10 @@ Network availability monitor.
|
|
|
15656
16298
|
|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. |
|
|
15657
16299
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
15658
16300
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
15659
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
15660
|
-
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto"
|
|
15661
|
-
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
|
|
15662
|
-
|tags|Array<<a href="#synthetictagwithsourcedto"
|
|
16301
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
16302
|
+
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor. |
|
|
16303
|
+
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
|
|
16304
|
+
|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> |
|
|
15663
16305
|
|type<sup>*required</sup>|"MULTI_PROTOCOL"|Monitor type. |
|
|
15664
16306
|
|
|
15665
16307
|
### SyntheticMultiProtocolRequestConfigurationDto
|
|
@@ -15668,7 +16310,7 @@ The configuration of a network availability monitor request.
|
|
|
15668
16310
|
|
|
15669
16311
|
| Name | Type | Description |
|
|
15670
16312
|
| --- | --- | --- |
|
|
15671
|
-
|constraints<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorconstraintdto">SyntheticMultiProtocolMonitorConstraintDto</a>>|Request constraints. |
|
|
16313
|
+
|constraints<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorconstraintdto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorConstraintDto</a>>|Request constraints. |
|
|
15672
16314
|
|
|
15673
16315
|
### SyntheticOnDemandBatchStatus
|
|
15674
16316
|
|
|
@@ -15677,15 +16319,15 @@ Contains information about on-demand executions triggered within the batch.
|
|
|
15677
16319
|
| Name | Type | Description |
|
|
15678
16320
|
| --- | --- | --- |
|
|
15679
16321
|
|batchId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the batch. |
|
|
15680
|
-
|batchStatus<sup>*required</sup>|"SUCCESS" | "FAILED" | "
|
|
16322
|
+
|batchStatus<sup>*required</sup>|"SUCCESS" | "FAILED" | "NOT_TRIGGERED" | "FAILED_TO_EXECUTE" | "RUNNING"|The status of the batch. |
|
|
15681
16323
|
|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. |
|
|
15682
16324
|
|failedCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of triggered executions with the result FAILED. |
|
|
15683
|
-
|failedExecutions|Array<<a href="#syntheticondemandfailedexecutionstatus"
|
|
15684
|
-
|failedToExecute|Array<<a href="#syntheticondemandfailedexecutionstatus">SyntheticOnDemandFailedExecutionStatus</a>>| |
|
|
16325
|
+
|failedExecutions|Array<<a href="#syntheticondemandfailedexecutionstatus">SyntheticOnDemandFailedExecutionStatus</a>>| |
|
|
16326
|
+
|failedToExecute|Array<<a href="#syntheticondemandfailedexecutionstatus" target="_blank" rel="noopener noreferrer">SyntheticOnDemandFailedExecutionStatus</a>>| |
|
|
15685
16327
|
|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. |
|
|
15686
|
-
|metadata|<a href="#syntheticondemandbatchstatusmetadata"
|
|
16328
|
+
|metadata|<a href="#syntheticondemandbatchstatusmetadata">SyntheticOnDemandBatchStatusMetadata</a>|String to string map of metadata properties for batch |
|
|
15687
16329
|
|triggeredCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of triggered executions within the batch. |
|
|
15688
|
-
|triggeringProblems|Array<<a href="#syntheticondemandtriggeringproblemdetails">SyntheticOnDemandTriggeringProblemDetails</a>>| |
|
|
16330
|
+
|triggeringProblems|Array<<a href="#syntheticondemandtriggeringproblemdetails" target="_blank" rel="noopener noreferrer">SyntheticOnDemandTriggeringProblemDetails</a>>| |
|
|
15689
16331
|
|triggeringProblemsCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of executions that were not triggered due to some problems. |
|
|
15690
16332
|
|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. |
|
|
15691
16333
|
|
|
@@ -15707,14 +16349,14 @@ Describes the status of an on-demand execution.
|
|
|
15707
16349
|
|executionId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the execution. |
|
|
15708
16350
|
|executionStage<sup>*required</sup>|"TRIGGERED" | "EXECUTED" | "DATA_RETRIEVED" | "NOT_TRIGGERED" | "TIMED_OUT" | "WAITING"|Execution stage. |
|
|
15709
16351
|
|executionTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when execution was finished, in UTC milliseconds. |
|
|
15710
|
-
|fullResults|<a href="#executionfullresults"
|
|
16352
|
+
|fullResults|<a href="#executionfullresults">ExecutionFullResults</a>|Contains extended monitor's execution details. |
|
|
15711
16353
|
|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. |
|
|
15712
|
-
|metadata|<a href="#syntheticondemandexecutionmetadata">SyntheticOnDemandExecutionMetadata</a>|Metadata map for the execution batch. |
|
|
16354
|
+
|metadata|<a href="#syntheticondemandexecutionmetadata" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionMetadata</a>|Metadata map for the execution batch. |
|
|
15713
16355
|
|monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the monitor. |
|
|
15714
16356
|
|nextExecutionId|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Next execution id for sequential mode. |
|
|
15715
16357
|
|processingMode<sup>*required</sup>|"UNKNOWN" | "NONE" | "STANDARD" | "DISABLE_PROBLEM_DETECTION" | "EXECUTIONS_DETAILS_ONLY"|The processing mode of the execution. |
|
|
15716
16358
|
|schedulingTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The scheduling timestamp, in UTC milliseconds. |
|
|
15717
|
-
|simpleResults|<a href="#executionsimpleresults"
|
|
16359
|
+
|simpleResults|<a href="#executionsimpleresults">ExecutionSimpleResults</a>|Contains basic results of the monitor's on-demand execution. |
|
|
15718
16360
|
|source<sup>*required</sup>|"API" | "UI"|The source of the triggering request. |
|
|
15719
16361
|
|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. |
|
|
15720
16362
|
|
|
@@ -15732,9 +16374,9 @@ Contains parameters for the on-demand execution of monitors identified by tags,
|
|
|
15732
16374
|
| --- | --- | --- |
|
|
15733
16375
|
|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>|
|
|
15734
16376
|
|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>|
|
|
15735
|
-
|group|<a href="#syntheticondemandexecutionrequestgroup">SyntheticOnDemandExecutionRequestGroup</a>|Contains parameters for the on-demand execution of monitors identified by tags, applications, or services. |
|
|
15736
|
-
|metadata|<a href="#syntheticondemandexecutionrequestmetadata"
|
|
15737
|
-
|monitors|Array<<a href="#syntheticondemandexecutionrequestmonitor">SyntheticOnDemandExecutionRequestMonitor</a>>|List of monitors to be triggered. |
|
|
16377
|
+
|group|<a href="#syntheticondemandexecutionrequestgroup" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionRequestGroup</a>|Contains parameters for the on-demand execution of monitors identified by tags, applications, or services. |
|
|
16378
|
+
|metadata|<a href="#syntheticondemandexecutionrequestmetadata">SyntheticOnDemandExecutionRequestMetadata</a>|String to string map of metadata properties for execution |
|
|
16379
|
+
|monitors|Array<<a href="#syntheticondemandexecutionrequestmonitor" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionRequestMonitor</a>>|List of monitors to be triggered. |
|
|
15738
16380
|
|processingMode|"STANDARD" | "DISABLE_PROBLEM_DETECTION" | "EXECUTIONS_DETAILS_ONLY"|The execution's processing mode <i>default:</i> <code>"STANDARD"</code>|
|
|
15739
16381
|
|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>|
|
|
15740
16382
|
|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>|
|
|
@@ -15775,10 +16417,10 @@ The result of on-demand synthetic monitor execution.
|
|
|
15775
16417
|
| Name | Type | Description |
|
|
15776
16418
|
| --- | --- | --- |
|
|
15777
16419
|
|batchId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The batch identifier of the triggered executions. |
|
|
15778
|
-
|triggered|Array<<a href="#syntheticondemandtriggeredmonitor"
|
|
16420
|
+
|triggered|Array<<a href="#syntheticondemandtriggeredmonitor">SyntheticOnDemandTriggeredMonitor</a>>|Monitors for which on-demand executions were triggered. |
|
|
15779
16421
|
|triggeredCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of the triggered executions within the batch. |
|
|
15780
16422
|
|triggeringProblemsCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of problems within the batch. |
|
|
15781
|
-
|triggeringProblemsDetails|Array<<a href="#syntheticondemandtriggeringproblemdetails">SyntheticOnDemandTriggeringProblemDetails</a>>|List with the entities for which triggering problems occurred. |
|
|
16423
|
+
|triggeringProblemsDetails|Array<<a href="#syntheticondemandtriggeringproblemdetails" target="_blank" rel="noopener noreferrer">SyntheticOnDemandTriggeringProblemDetails</a>>|List with the entities for which triggering problems occurred. |
|
|
15782
16424
|
|
|
15783
16425
|
### SyntheticOnDemandExecutions
|
|
15784
16426
|
|
|
@@ -15786,7 +16428,7 @@ Contains a list of synthetic on-demand executions.
|
|
|
15786
16428
|
|
|
15787
16429
|
| Name | Type | Description |
|
|
15788
16430
|
| --- | --- | --- |
|
|
15789
|
-
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandexecution"
|
|
16431
|
+
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandexecution">SyntheticOnDemandExecution</a>>|The list of executions. |
|
|
15790
16432
|
|
|
15791
16433
|
### SyntheticOnDemandFailedExecutionStatus
|
|
15792
16434
|
|
|
@@ -15817,7 +16459,7 @@ Contains the list of on-demand executions of the monitor.
|
|
|
15817
16459
|
|
|
15818
16460
|
| Name | Type | Description |
|
|
15819
16461
|
| --- | --- | --- |
|
|
15820
|
-
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandtriggeredexecutiondetails">SyntheticOnDemandTriggeredExecutionDetails</a>>|The list of triggered executions. |
|
|
16462
|
+
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandtriggeredexecutiondetails" target="_blank" rel="noopener noreferrer">SyntheticOnDemandTriggeredExecutionDetails</a>>|The list of triggered executions. |
|
|
15821
16463
|
|monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The monitor identifier. |
|
|
15822
16464
|
|
|
15823
16465
|
### SyntheticOnDemandTriggeringProblemDetails
|
|
@@ -15881,7 +16523,7 @@ The tag with source of a monitored entity.
|
|
|
15881
16523
|
| --- | --- | --- |
|
|
15882
16524
|
|context|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The origin of the tag, such as AWS or Cloud Foundry.</p> <p>Custom tags use the <code>CONTEXTLESS</code> value.</p> |
|
|
15883
16525
|
|key<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The key of the tag. |
|
|
15884
|
-
|source|"
|
|
16526
|
+
|source|"AUTO" | "USER" | "RULE_BASED"|The source of the tag, such as USER, RULE_BASED or AUTO. |
|
|
15885
16527
|
|value|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The value of the tag. |
|
|
15886
16528
|
|
|
15887
16529
|
### TableColumn
|
|
@@ -15906,8 +16548,8 @@ Configuration of a [tenant token](https://dt-url.net/b403ss9).
|
|
|
15906
16548
|
|
|
15907
16549
|
| Name | Type | Description |
|
|
15908
16550
|
| --- | --- | --- |
|
|
15909
|
-
|active|<a href="#tenanttoken"
|
|
15910
|
-
|old|<a href="#tenanttoken">TenantToken</a>|Tenant token |
|
|
16551
|
+
|active|<a href="#tenanttoken">TenantToken</a>|Tenant token |
|
|
16552
|
+
|old|<a href="#tenanttoken" target="_blank" rel="noopener noreferrer">TenantToken</a>|Tenant token |
|
|
15911
16553
|
|
|
15912
16554
|
### ToPosition
|
|
15913
16555
|
|
|
@@ -15925,16 +16567,16 @@ A credentials set of the `TOKEN` type.
|
|
|
15925
16567
|
| Name | Type | Description |
|
|
15926
16568
|
| --- | --- | --- |
|
|
15927
16569
|
|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). |
|
|
15928
|
-
|allowedEntities|Array<<a href="#credentialaccessdata"
|
|
16570
|
+
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
15929
16571
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
15930
|
-
|externalVault|<a href="#externalvault">ExternalVault</a>|Information for synchronization credentials with external vault |
|
|
16572
|
+
|externalVault|<a href="#externalvault" target="_blank" rel="noopener noreferrer">ExternalVault</a>|Information for synchronization credentials with external vault |
|
|
15931
16573
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
15932
16574
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
15933
16575
|
|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>). |
|
|
15934
|
-
|~~scope~~<sup>**DEPRECATED**</sup>|"
|
|
15935
|
-
|scopes<sup>*required</sup>|Array<"
|
|
16576
|
+
|~~scope~~<sup>**DEPRECATED**</sup>|"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"|The scope of the credentials set. |
|
|
16577
|
+
|scopes<sup>*required</sup>|Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">|<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> |
|
|
15936
16578
|
|token|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Token in the string format. |
|
|
15937
|
-
|type|"
|
|
16579
|
+
|type|"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>CERTIFICATE</code> -> CertificateCredentials</li> <li><code>PUBLIC_CERTIFICATE</code> -> PublicCertificateCredentials</li> <li><code>USERNAME_PASSWORD</code> -> UserPasswordCredentials</li> <li><code>TOKEN</code> -> TokenCredentials</li> <li><code>SNMPV3</code> -> SNMPV3Credentials</li> <li><code>AWS_MONITORING_KEY_BASED</code> -> AWSKeyBasedCredentialsDto</li> <li><code>AWS_MONITORING_ROLE_BASED</code> -> AWSRoleBasedCredentials</li> </ul> |
|
|
15938
16580
|
|
|
15939
16581
|
### TrackingLink
|
|
15940
16582
|
|
|
@@ -15966,15 +16608,23 @@ A behavior of a metric in an transaction that indicates the problem and/or is it
|
|
|
15966
16608
|
| --- | --- | --- |
|
|
15967
16609
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
15968
16610
|
|endTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The end time of the evidence, in UTC milliseconds |
|
|
15969
|
-
|entity<sup>*required</sup>|<a href="#entitystub"
|
|
16611
|
+
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
15970
16612
|
|evidenceType<sup>*required</sup>|"AVAILABILITY_EVIDENCE" | "EVENT" | "MAINTENANCE_WINDOW" | "METRIC" | "TRANSACTIONAL"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>EVENT</code> -> EventEvidence</li> <li><code>METRIC</code> -> MetricEvidence</li> <li><code>TRANSACTIONAL</code> -> TransactionalEvidence</li> <li><code>MAINTENANCE_WINDOW</code> -> MaintenanceWindowEvidence</li> <li><code>AVAILABILITY_EVIDENCE</code> -> AvailabilityEvidence</li> </ul> |
|
|
15971
|
-
|groupingEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
16613
|
+
|groupingEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
15972
16614
|
|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. |
|
|
15973
16615
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds. |
|
|
15974
16616
|
|unit|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unit of the metric. |
|
|
15975
16617
|
|valueAfterChangePoint|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The metric's value after the problem start. |
|
|
15976
16618
|
|valueBeforeChangePoint|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The metric's value before the problem start. |
|
|
15977
16619
|
|
|
16620
|
+
### TransferOwnershipRequest
|
|
16621
|
+
|
|
16622
|
+
The request to change ownership of an object.
|
|
16623
|
+
|
|
16624
|
+
| Name | Type | Description |
|
|
16625
|
+
| --- | --- | --- |
|
|
16626
|
+
|newOwner|<a href="#identity">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users). |
|
|
16627
|
+
|
|
15978
16628
|
### TruncatableListAttackRequestHeader
|
|
15979
16629
|
|
|
15980
16630
|
A list of values that has possibly been truncated.
|
|
@@ -16187,6 +16837,14 @@ A list of ActiveGates with update jobs.
|
|
|
16187
16837
|
| --- | --- | --- |
|
|
16188
16838
|
|allUpdateJobs|Array<<a href="#updatejoblist" target="_blank" rel="noopener noreferrer">UpdateJobList</a>>|A list of ActiveGates with update jobs. |
|
|
16189
16839
|
|
|
16840
|
+
### UpdatePermissionsRequest
|
|
16841
|
+
|
|
16842
|
+
The request to update the permissions of a specific accessor.
|
|
16843
|
+
|
|
16844
|
+
| Name | Type | Description |
|
|
16845
|
+
| --- | --- | --- |
|
|
16846
|
+
|permissions|Array<"r" | "w">|The permissions to assign to the specified accessor. |
|
|
16847
|
+
|
|
16190
16848
|
### UserPasswordCredentials
|
|
16191
16849
|
|
|
16192
16850
|
A credentials set of the `USERNAME_PASSWORD` type.
|
|
@@ -16201,9 +16859,9 @@ A credentials set of the `USERNAME_PASSWORD` type.
|
|
|
16201
16859
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
16202
16860
|
|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>). |
|
|
16203
16861
|
|password|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The password of the credential. |
|
|
16204
|
-
|~~scope~~<sup>**DEPRECATED**</sup>|"
|
|
16205
|
-
|scopes<sup>*required</sup>|Array<"
|
|
16206
|
-
|type|"
|
|
16862
|
+
|~~scope~~<sup>**DEPRECATED**</sup>|"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"|The scope of the credentials set. |
|
|
16863
|
+
|scopes<sup>*required</sup>|Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">|<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> |
|
|
16864
|
+
|type|"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>CERTIFICATE</code> -> CertificateCredentials</li> <li><code>PUBLIC_CERTIFICATE</code> -> PublicCertificateCredentials</li> <li><code>USERNAME_PASSWORD</code> -> UserPasswordCredentials</li> <li><code>TOKEN</code> -> TokenCredentials</li> <li><code>SNMPV3</code> -> SNMPV3Credentials</li> <li><code>AWS_MONITORING_KEY_BASED</code> -> AWSKeyBasedCredentialsDto</li> <li><code>AWS_MONITORING_ROLE_BASED</code> -> AWSRoleBasedCredentials</li> </ul> |
|
|
16207
16865
|
|user|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The username of the credentials set. |
|
|
16208
16866
|
|
|
16209
16867
|
### ValidationResponse
|
|
@@ -16366,6 +17024,24 @@ Defines the actual set of fields depending on the value. See one of the followin
|
|
|
16366
17024
|
</div>
|
|
16367
17025
|
|
|
16368
17026
|
|
|
17027
|
+
</div>
|
|
17028
|
+
|
|
17029
|
+
<a name="accessorpermissionspermissionsitem"></a>
|
|
17030
|
+
### AccessorPermissionsPermissionsItem
|
|
17031
|
+
|
|
17032
|
+
<div class="padding-left--md">
|
|
17033
|
+
|
|
17034
|
+
r = read, w = write
|
|
17035
|
+
|
|
17036
|
+
#### Enum keys
|
|
17037
|
+
|
|
17038
|
+
<div class="padding-left--md">
|
|
17039
|
+
|
|
17040
|
+
`R` | `W`
|
|
17041
|
+
|
|
17042
|
+
</div>
|
|
17043
|
+
|
|
17044
|
+
|
|
16369
17045
|
</div>
|
|
16370
17046
|
|
|
16371
17047
|
<a name="activegateautoupdateconfigeffectivesetting"></a>
|
|
@@ -16781,7 +17457,7 @@ The category of the recorded operation.
|
|
|
16781
17457
|
|
|
16782
17458
|
<div class="padding-left--md">
|
|
16783
17459
|
|
|
16784
|
-
`ActivegateToken` | `Config` | `ManualTaggingService` | `Token` | `WebUi`
|
|
17460
|
+
`ActivegateToken` | `Config` | `ManualTaggingService` | `TenantLifecycle` | `Token` | `WebUi`
|
|
16785
17461
|
|
|
16786
17462
|
</div>
|
|
16787
17463
|
|
|
@@ -17858,6 +18534,24 @@ Type of this filter, determines which other fields are present.Can be any of:
|
|
|
17858
18534
|
</div>
|
|
17859
18535
|
|
|
17860
18536
|
|
|
18537
|
+
</div>
|
|
18538
|
+
|
|
18539
|
+
<a name="getpermissionpathaccessortype"></a>
|
|
18540
|
+
### GetPermissionPathAccessorType
|
|
18541
|
+
|
|
18542
|
+
<div class="padding-left--md">
|
|
18543
|
+
|
|
18544
|
+
|
|
18545
|
+
|
|
18546
|
+
#### Enum keys
|
|
18547
|
+
|
|
18548
|
+
<div class="padding-left--md">
|
|
18549
|
+
|
|
18550
|
+
`Group` | `User`
|
|
18551
|
+
|
|
18552
|
+
</div>
|
|
18553
|
+
|
|
18554
|
+
|
|
17861
18555
|
</div>
|
|
17862
18556
|
|
|
17863
18557
|
<a name="getslobyidquerytimeframe"></a>
|
|
@@ -18318,7 +19012,7 @@ The name of the monitoring state.
|
|
|
18318
19012
|
|
|
18319
19013
|
<div class="padding-left--md">
|
|
18320
19014
|
|
|
18321
|
-
`AgentInjectionStatusGoDynamizerFailed` | `AgentInjectionStatusGoPclntabFailed` | `AgentInjectionStatusGoVertigoSupportAdded` | `AgentInjectionStatusNginxPatchedBinaryDetected` | `AgentInjectionStatusPhpOpcacheDisabled` | `AgentInjectionStatusPhpStackSizeTooLow` | `AgentInjectionSuppression` | `AixEnableFullMonitoringNeeded` | `BadInstaller` | `BoshbpmDisabled` | `ContainerInjectionFailed` | `ContainerdDisabled` | `CrioDisabled` | `CustomPgRuleRequired` | `DeepMonitoringSuccessful` | `DeepMonitoringUnsuccessful` | `DockerDisabled` | `GardenDisabled` | `HostInfraStructureOnly` | `HostMonitoringDisabled` | `NetworkAgentInactive` | `Ok` | `ParentProcessRestartRequired` | `PodmanDisabled` | `ProcessGroupDifferentIdDueToDeclarativeGrouping` | `ProcessGroupDisabled` | `ProcessGroupDisabledViaContainerInjectionRule` | `ProcessGroupDisabledViaContainerInjectionRuleRestart` | `ProcessGroupDisabledViaGlobalSettings` | `ProcessGroupDisabledViaInjectionRule` | `ProcessGroupDisabledViaInjectionRuleRestart` | `RestartRequired` | `RestartRequiredApache` | `RestartRequiredDockerDeamon` | `RestartRequiredHostGroupInconsistent` | `RestartRequiredHostIdInconsistent` | `RestartRequiredOutdatedAgentApacheUpdate` | `RestartRequiredOutdatedAgentInjected` | `RestartRequiredUsingDifferentDataStorageDir` | `RestartRequiredUsingDifferentLogPath` | `RestartRequiredVirtualizedContainer` | `UnsupportedState` | `WincDisabled`
|
|
19015
|
+
`AgentInjectionStatusGoDynamizerFailed` | `AgentInjectionStatusGoFipsDetectedButFeatureDisabled` | `AgentInjectionStatusGoPclntabFailed` | `AgentInjectionStatusGoVertigoSupportAdded` | `AgentInjectionStatusNginxPatchedBinaryDetected` | `AgentInjectionStatusPhpOpcacheDisabled` | `AgentInjectionStatusPhpStackSizeTooLow` | `AgentInjectionSuppression` | `AixEnableFullMonitoringNeeded` | `BadInstaller` | `BoshbpmDisabled` | `ContainerInjectionFailed` | `ContainerdDisabled` | `CrioDisabled` | `CustomPgRuleRequired` | `DeepMonitoringSuccessful` | `DeepMonitoringUnsuccessful` | `DockerDisabled` | `GardenDisabled` | `HostInfraStructureOnly` | `HostMonitoringDisabled` | `NetworkAgentInactive` | `Ok` | `ParentProcessRestartRequired` | `PodmanDisabled` | `ProcessGroupDifferentIdDueToDeclarativeGrouping` | `ProcessGroupDisabled` | `ProcessGroupDisabledViaContainerInjectionRule` | `ProcessGroupDisabledViaContainerInjectionRuleRestart` | `ProcessGroupDisabledViaGlobalSettings` | `ProcessGroupDisabledViaInjectionRule` | `ProcessGroupDisabledViaInjectionRuleRestart` | `RestartRequired` | `RestartRequiredApache` | `RestartRequiredDockerDeamon` | `RestartRequiredHostGroupInconsistent` | `RestartRequiredHostIdInconsistent` | `RestartRequiredOutdatedAgentApacheUpdate` | `RestartRequiredOutdatedAgentInjected` | `RestartRequiredUsingDifferentDataStorageDir` | `RestartRequiredUsingDifferentLogPath` | `RestartRequiredVirtualizedContainer` | `UnsupportedState` | `WincDisabled`
|
|
18322
19016
|
|
|
18323
19017
|
</div>
|
|
18324
19018
|
|
|
@@ -18762,6 +19456,24 @@ The current state of the remediation progress entity.
|
|
|
18762
19456
|
</div>
|
|
18763
19457
|
|
|
18764
19458
|
|
|
19459
|
+
</div>
|
|
19460
|
+
|
|
19461
|
+
<a name="removepermissionpathaccessortype"></a>
|
|
19462
|
+
### RemovePermissionPathAccessorType
|
|
19463
|
+
|
|
19464
|
+
<div class="padding-left--md">
|
|
19465
|
+
|
|
19466
|
+
|
|
19467
|
+
|
|
19468
|
+
#### Enum keys
|
|
19469
|
+
|
|
19470
|
+
<div class="padding-left--md">
|
|
19471
|
+
|
|
19472
|
+
`Group` | `User`
|
|
19473
|
+
|
|
19474
|
+
</div>
|
|
19475
|
+
|
|
19476
|
+
|
|
18765
19477
|
</div>
|
|
18766
19478
|
|
|
18767
19479
|
<a name="resourcecontextoperationsitem"></a>
|
|
@@ -19200,42 +19912,6 @@ The state of vulnerable code execution.
|
|
|
19200
19912
|
</div>
|
|
19201
19913
|
|
|
19202
19914
|
|
|
19203
|
-
</div>
|
|
19204
|
-
|
|
19205
|
-
<a name="sloevaluationtype"></a>
|
|
19206
|
-
### SLOEvaluationType
|
|
19207
|
-
|
|
19208
|
-
<div class="padding-left--md">
|
|
19209
|
-
|
|
19210
|
-
The evaluation type of the SLO.
|
|
19211
|
-
|
|
19212
|
-
#### Enum keys
|
|
19213
|
-
|
|
19214
|
-
<div class="padding-left--md">
|
|
19215
|
-
|
|
19216
|
-
`Aggregate`
|
|
19217
|
-
|
|
19218
|
-
</div>
|
|
19219
|
-
|
|
19220
|
-
|
|
19221
|
-
</div>
|
|
19222
|
-
|
|
19223
|
-
<a name="slostatus"></a>
|
|
19224
|
-
### SLOStatus
|
|
19225
|
-
|
|
19226
|
-
<div class="padding-left--md">
|
|
19227
|
-
|
|
19228
|
-
The status of the calculated SLO.
|
|
19229
|
-
|
|
19230
|
-
#### Enum keys
|
|
19231
|
-
|
|
19232
|
-
<div class="padding-left--md">
|
|
19233
|
-
|
|
19234
|
-
`Failure` | `Success` | `Warning`
|
|
19235
|
-
|
|
19236
|
-
</div>
|
|
19237
|
-
|
|
19238
|
-
|
|
19239
19915
|
</div>
|
|
19240
19916
|
|
|
19241
19917
|
<a name="schemaconstraintrestdtotype"></a>
|
|
@@ -19526,6 +20202,42 @@ The evaluation type of the SLO.
|
|
|
19526
20202
|
</div>
|
|
19527
20203
|
|
|
19528
20204
|
|
|
20205
|
+
</div>
|
|
20206
|
+
|
|
20207
|
+
<a name="sloevaluationtype"></a>
|
|
20208
|
+
### SLOEvaluationType
|
|
20209
|
+
|
|
20210
|
+
<div class="padding-left--md">
|
|
20211
|
+
|
|
20212
|
+
The evaluation type of the SLO.
|
|
20213
|
+
|
|
20214
|
+
#### Enum keys
|
|
20215
|
+
|
|
20216
|
+
<div class="padding-left--md">
|
|
20217
|
+
|
|
20218
|
+
`Aggregate`
|
|
20219
|
+
|
|
20220
|
+
</div>
|
|
20221
|
+
|
|
20222
|
+
|
|
20223
|
+
</div>
|
|
20224
|
+
|
|
20225
|
+
<a name="slostatus"></a>
|
|
20226
|
+
### SLOStatus
|
|
20227
|
+
|
|
20228
|
+
<div class="padding-left--md">
|
|
20229
|
+
|
|
20230
|
+
The status of the calculated SLO.
|
|
20231
|
+
|
|
20232
|
+
#### Enum keys
|
|
20233
|
+
|
|
20234
|
+
<div class="padding-left--md">
|
|
20235
|
+
|
|
20236
|
+
`Failure` | `Success` | `Warning`
|
|
20237
|
+
|
|
20238
|
+
</div>
|
|
20239
|
+
|
|
20240
|
+
|
|
19529
20241
|
</div>
|
|
19530
20242
|
|
|
19531
20243
|
<a name="syntheticlocationstatus"></a>
|
|
@@ -19897,6 +20609,42 @@ The component to be updated.
|
|
|
19897
20609
|
</div>
|
|
19898
20610
|
|
|
19899
20611
|
|
|
20612
|
+
</div>
|
|
20613
|
+
|
|
20614
|
+
<a name="updatepermissionpathaccessortype"></a>
|
|
20615
|
+
### UpdatePermissionPathAccessorType
|
|
20616
|
+
|
|
20617
|
+
<div class="padding-left--md">
|
|
20618
|
+
|
|
20619
|
+
|
|
20620
|
+
|
|
20621
|
+
#### Enum keys
|
|
20622
|
+
|
|
20623
|
+
<div class="padding-left--md">
|
|
20624
|
+
|
|
20625
|
+
`Group` | `User`
|
|
20626
|
+
|
|
20627
|
+
</div>
|
|
20628
|
+
|
|
20629
|
+
|
|
20630
|
+
</div>
|
|
20631
|
+
|
|
20632
|
+
<a name="updatepermissionsrequestpermissionsitem"></a>
|
|
20633
|
+
### UpdatePermissionsRequestPermissionsItem
|
|
20634
|
+
|
|
20635
|
+
<div class="padding-left--md">
|
|
20636
|
+
|
|
20637
|
+
r = read, w = write
|
|
20638
|
+
|
|
20639
|
+
#### Enum keys
|
|
20640
|
+
|
|
20641
|
+
<div class="padding-left--md">
|
|
20642
|
+
|
|
20643
|
+
`R` | `W`
|
|
20644
|
+
|
|
20645
|
+
</div>
|
|
20646
|
+
|
|
20647
|
+
|
|
19900
20648
|
</div>
|
|
19901
20649
|
|
|
19902
20650
|
<a name="vulnerablefunctioninputsegmenttype"></a>
|