@dynatrace-sdk/client-classic-environment-v2 0.6.8 → 0.6.11

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.
Files changed (115) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/LICENSE +174 -0
  3. package/cjs/index.js +1098 -1027
  4. package/docs/DOCS.md +362 -96
  5. package/dynatrace-metadata.json +1 -1
  6. package/esm/index.js +1099 -1027
  7. package/package.json +3 -2
  8. package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-active-gate-tokens-api.d.ts +10 -10
  9. package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-api-tokens-api.d.ts +6 -6
  10. package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-tenant-tokens-api.d.ts +3 -3
  11. package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-api.d.ts +2 -2
  12. package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-configuration-api.d.ts +6 -6
  13. package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-jobs-api.d.ts +6 -6
  14. package/types/packages/client/classic-environment-v2/src/lib/apis/audit-logs-api.d.ts +2 -2
  15. package/types/packages/client/classic-environment-v2/src/lib/apis/credential-vault-api.d.ts +5 -5
  16. package/types/packages/client/classic-environment-v2/src/lib/apis/davis-security-advisor-api.d.ts +1 -1
  17. package/types/packages/client/classic-environment-v2/src/lib/apis/events-api.d.ts +10 -6
  18. package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +24 -24
  19. package/types/packages/client/classic-environment-v2/src/lib/apis/hub-items-api.d.ts +11 -11
  20. package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +4 -4
  21. package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-api.d.ts +5 -5
  22. package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-units-api.d.ts +3 -3
  23. package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts +8 -2
  24. package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-custom-tags-api.d.ts +3 -3
  25. package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-monitoring-state-api.d.ts +1 -1
  26. package/types/packages/client/classic-environment-v2/src/lib/apis/network-zones-api.d.ts +7 -7
  27. package/types/packages/client/classic-environment-v2/src/lib/apis/problems-api.d.ts +8 -8
  28. package/types/packages/client/classic-environment-v2/src/lib/apis/releases-api.d.ts +1 -1
  29. package/types/packages/client/classic-environment-v2/src/lib/apis/security-problems-api.d.ts +12 -12
  30. package/types/packages/client/classic-environment-v2/src/lib/apis/service-level-objectives-api.d.ts +6 -6
  31. package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-http-monitor-executions-api.d.ts +1 -1
  32. package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts +4 -4
  33. package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-on-demand-monitor-executions-api.d.ts +5 -5
  34. package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-module.d.ts +3 -3
  35. package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token-created.d.ts +1 -1
  36. package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token-info-dto.d.ts +1 -1
  37. package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token.d.ts +1 -1
  38. package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create.d.ts +5 -5
  39. package/types/packages/client/classic-environment-v2/src/lib/models/api-token-created.d.ts +5 -5
  40. package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update.d.ts +5 -5
  41. package/types/packages/client/classic-environment-v2/src/lib/models/api-token.d.ts +15 -15
  42. package/types/packages/client/classic-environment-v2/src/lib/models/comment.d.ts +5 -5
  43. package/types/packages/client/classic-environment-v2/src/lib/models/complex-constraint.d.ts +10 -10
  44. package/types/packages/client/classic-environment-v2/src/lib/models/configuration-metadata.d.ts +5 -5
  45. package/types/packages/client/classic-environment-v2/src/lib/models/constraint.d.ts +8 -8
  46. package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-config.d.ts +0 -2
  47. package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-username-password-config.d.ts +0 -2
  48. package/types/packages/client/classic-environment-v2/src/lib/models/datasource-definition.d.ts +2 -2
  49. package/types/packages/client/classic-environment-v2/src/lib/models/deletion-constraint.d.ts +5 -5
  50. package/types/packages/client/classic-environment-v2/src/lib/models/description-block.d.ts +6 -6
  51. package/types/packages/client/classic-environment-v2/src/lib/models/effective-settings-value.d.ts +10 -10
  52. package/types/packages/client/classic-environment-v2/src/lib/models/entity-icon.d.ts +7 -7
  53. package/types/packages/client/classic-environment-v2/src/lib/models/entity-type.d.ts +5 -5
  54. package/types/packages/client/classic-environment-v2/src/lib/models/entity.d.ts +10 -10
  55. package/types/packages/client/classic-environment-v2/src/lib/models/enum-type.d.ts +5 -5
  56. package/types/packages/client/classic-environment-v2/src/lib/models/enum-value.d.ts +7 -7
  57. package/types/packages/client/classic-environment-v2/src/lib/models/error.d.ts +5 -5
  58. package/types/packages/client/classic-environment-v2/src/lib/models/event-evidence.d.ts +5 -5
  59. package/types/packages/client/classic-environment-v2/src/lib/models/event-ingest-results.d.ts +5 -5
  60. package/types/packages/client/classic-environment-v2/src/lib/models/event-property-details.d.ts +8 -8
  61. package/types/packages/client/classic-environment-v2/src/lib/models/event-type.d.ts +5 -5
  62. package/types/packages/client/classic-environment-v2/src/lib/models/event.d.ts +16 -16
  63. package/types/packages/client/classic-environment-v2/src/lib/models/extension-release.d.ts +31 -19
  64. package/types/packages/client/classic-environment-v2/src/lib/models/extension1-details.d.ts +2 -2
  65. package/types/packages/client/classic-environment-v2/src/lib/models/extension1-release.d.ts +6 -6
  66. package/types/packages/client/classic-environment-v2/src/lib/models/extension2-details.d.ts +12 -7
  67. package/types/packages/client/classic-environment-v2/src/lib/models/external-vault.d.ts +5 -0
  68. package/types/packages/client/classic-environment-v2/src/lib/models/filter.d.ts +11 -11
  69. package/types/packages/client/classic-environment-v2/src/lib/models/image.d.ts +2 -2
  70. package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +3 -1
  71. package/types/packages/client/classic-environment-v2/src/lib/models/invocation.d.ts +5 -5
  72. package/types/packages/client/classic-environment-v2/src/lib/models/item-details.d.ts +29 -29
  73. package/types/packages/client/classic-environment-v2/src/lib/models/item-overview.d.ts +5 -2
  74. package/types/packages/client/classic-environment-v2/src/lib/models/item.d.ts +7 -7
  75. package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.d.ts +1 -1
  76. package/types/packages/client/classic-environment-v2/src/lib/models/log-record.d.ts +7 -7
  77. package/types/packages/client/classic-environment-v2/src/lib/models/metric-default-aggregation.d.ts +2 -2
  78. package/types/packages/client/classic-environment-v2/src/lib/models/metric-descriptor.d.ts +19 -19
  79. package/types/packages/client/classic-environment-v2/src/lib/models/metric-dimension-cardinality.d.ts +5 -5
  80. package/types/packages/client/classic-environment-v2/src/lib/models/metric-ingest-error.d.ts +2 -2
  81. package/types/packages/client/classic-environment-v2/src/lib/models/metric-series-collection.d.ts +5 -5
  82. package/types/packages/client/classic-environment-v2/src/lib/models/metric-series.d.ts +2 -2
  83. package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-state-param.d.ts +5 -5
  84. package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-state.d.ts +2 -0
  85. package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states.d.ts +2 -2
  86. package/types/packages/client/classic-environment-v2/src/lib/models/network-zone-fallback-mode.d.ts +14 -0
  87. package/types/packages/client/classic-environment-v2/src/lib/models/network-zone.d.ts +8 -5
  88. package/types/packages/client/classic-environment-v2/src/lib/models/object-node.d.ts +12 -0
  89. package/types/packages/client/classic-environment-v2/src/lib/models/precondition.d.ts +8 -8
  90. package/types/packages/client/classic-environment-v2/src/lib/models/problem.d.ts +21 -21
  91. package/types/packages/client/classic-environment-v2/src/lib/models/property-definition.d.ts +11 -11
  92. package/types/packages/client/classic-environment-v2/src/lib/models/related-item.d.ts +5 -2
  93. package/types/packages/client/classic-environment-v2/src/lib/models/release.d.ts +24 -24
  94. package/types/packages/client/classic-environment-v2/src/lib/models/rollup.d.ts +2 -2
  95. package/types/packages/client/classic-environment-v2/src/lib/models/schema-type.d.ts +2 -2
  96. package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-create.d.ts +7 -7
  97. package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-response.d.ts +2 -2
  98. package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-update.d.ts +2 -2
  99. package/types/packages/client/classic-environment-v2/src/lib/models/settings-object.d.ts +7 -7
  100. package/types/packages/client/classic-environment-v2/src/lib/models/slo-burn-rate.d.ts +12 -12
  101. package/types/packages/client/classic-environment-v2/src/lib/models/slo-config-item-dto-impl.d.ts +24 -24
  102. package/types/packages/client/classic-environment-v2/src/lib/models/slo.d.ts +25 -25
  103. package/types/packages/client/classic-environment-v2/src/lib/models/success.d.ts +5 -5
  104. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-execution-stage.d.ts +2 -1
  105. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request-monitor-custom-script.d.ts +12 -0
  106. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request-monitor.d.ts +3 -0
  107. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution.d.ts +8 -0
  108. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-failed-execution-status-execution-stage.d.ts +2 -1
  109. package/types/packages/client/classic-environment-v2/src/lib/models/technology-details.d.ts +2 -2
  110. package/types/packages/client/classic-environment-v2/src/lib/models/ui-button-customization.d.ts +5 -5
  111. package/types/packages/client/classic-environment-v2/src/lib/models/ui-customization.d.ts +2 -2
  112. package/types/packages/client/classic-environment-v2/src/lib/models/ui-expandable-section-customization.d.ts +5 -5
  113. package/types/packages/client/classic-environment-v2/src/lib/models/ui-tab-group-customization.d.ts +5 -5
  114. package/types/packages/client/classic-environment-v2/src/lib/models/update-job.d.ts +10 -10
  115. package/types/packages/client/classic-environment-v2/src/lib/models/upload-extension-body.d.ts +0 -18
package/package.json CHANGED
@@ -1,8 +1,9 @@
1
1
  {
2
2
  "name": "@dynatrace-sdk/client-classic-environment-v2",
3
- "version": "0.6.8",
3
+ "version": "0.6.11",
4
+ "license": "Apache-2.0",
4
5
  "dependencies": {
5
- "@dynatrace-sdk/http-client": "^0.4.9"
6
+ "@dynatrace-sdk/http-client": "^0.4.11"
6
7
  },
7
8
  "main": "./cjs/index.js",
8
9
  "module": "./esm/index.js",
@@ -15,9 +15,9 @@ export declare class AccessTokensActiveGateTokensClient {
15
15
  */
16
16
  constructor(httpClientImplementation: HttpClient);
17
17
  /**
18
- * Lists all available ActiveGate tokens | maturity=EARLY_ADOPTER
18
+ * Lists all available ActiveGate tokens
19
19
  *
20
- * **Required scope:** environment-api:activegate-tokens:read<br/><br/>You can limit the output by using pagination:
20
+ * **Required scope:** environment-api:activegate-tokens:read<br/>**Required permission:** environment:roles:manage-settings<br/><br/>You can limit the output by using pagination:
21
21
  * 1. Specify the number of results per page in the **pageSize** query parameter.
22
22
  * 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
23
23
  * @returns Success. The response contains the list of ActiveGate tokens.
@@ -40,13 +40,13 @@ export declare class AccessTokensActiveGateTokensClient {
40
40
  abortSignal?: AbortSignal;
41
41
  }): Promise<ActiveGateTokenList>;
42
42
  /**
43
- * Creates a new ActiveGate token | maturity=EARLY_ADOPTER
43
+ * Creates a new ActiveGate token
44
44
  *
45
45
  * **One of the following scopes is required:**
46
46
  * + environment-api:activegate-tokens:create
47
47
  * + environment-api:activegate-tokens:write
48
48
  *
49
- * <br/><br/>The newly created token will be owned by the same user who owns the token used for authentication of the call.
49
+ * <br/>**Required permission:** environment:roles:manage-settings<br/><br/>The newly created token will be owned by the same user who owns the token used for authentication of the call.
50
50
  * @returns Success. The token has been created. The body of the response contains the token secret.
51
51
  */
52
52
  createToken(config: {
@@ -54,22 +54,22 @@ export declare class AccessTokensActiveGateTokensClient {
54
54
  abortSignal?: AbortSignal;
55
55
  }): Promise<ActiveGateTokenCreated>;
56
56
  /**
57
- * Gets metadata of an ActiveGate token | maturity=EARLY_ADOPTER
57
+ * Gets metadata of an ActiveGate token
58
58
  *
59
- * **Required scope:** environment-api:activegate-tokens:read<br/><br/>The token secret is **not** exposed.
59
+ * **Required scope:** environment-api:activegate-tokens:read<br/>**Required permission:** environment:roles:manage-settings<br/><br/>The token secret is **not** exposed.
60
60
  * @returns Success. The response contains the metadata of the tokens.
61
61
  */
62
62
  getToken(config: {
63
- /** The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/2903ss4) of the token. */ activeGateTokenIdentifier: string;
63
+ /** The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/rn00tjg) of the token. */ activeGateTokenIdentifier: string;
64
64
  abortSignal?: AbortSignal;
65
65
  }): Promise<ActiveGateToken>;
66
66
  /**
67
- * Deletes an ActiveGate token | maturity=EARLY_ADOPTER
67
+ * Deletes an ActiveGate token
68
68
  *
69
- * **Required scope:** environment-api:activegate-tokens:write
69
+ * **Required scope:** environment-api:activegate-tokens:write<br/>**Required permission:** environment:roles:manage-settings
70
70
  */
71
71
  revokeToken(config: {
72
- /** The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/2903ss4) of the token to be deleted. */ activeGateTokenIdentifier: string;
72
+ /** The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/rn00tjg) of the token to be deleted. */ activeGateTokenIdentifier: string;
73
73
  abortSignal?: AbortSignal;
74
74
  }): Promise<void>;
75
75
  }
@@ -19,7 +19,7 @@ export declare class AccessTokensApiTokensClient {
19
19
  /**
20
20
  * Lists all available API tokens
21
21
  *
22
- * **Required scope:** environment-api:api-tokens:read<br/><br/>You can limit the output by using pagination:
22
+ * **Required scope:** environment-api:api-tokens:read<br/>**Required permission:** environment:roles:viewer<br/><br/>You can limit the output by using pagination:
23
23
  * 1. Specify the number of results per page in the **pageSize** query parameter.
24
24
  * 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
25
25
  * @returns Success
@@ -136,7 +136,7 @@ export declare class AccessTokensApiTokensClient {
136
136
  /**
137
137
  * Creates a new API token
138
138
  *
139
- * **Required scope:** environment-api:api-tokens:write<br/><br/>The newly created token will be owned by the same user who owns the token used for authentication of the call.
139
+ * **Required scope:** environment-api:api-tokens:write<br/>**Required permission:** environment:roles:viewer<br/><br/>The newly created token will be owned by the same user who owns the token used for authentication of the call.
140
140
  * @returns Success. The token has been created. The body of the response contains the token secret.
141
141
  */
142
142
  createApiToken(config: {
@@ -146,7 +146,7 @@ export declare class AccessTokensApiTokensClient {
146
146
  /**
147
147
  * Gets API token metadata by token ID
148
148
  *
149
- * **Required scope:** environment-api:api-tokens:read<br/><br/>The token secret is **not** exposed.
149
+ * **Required scope:** environment-api:api-tokens:read<br/>**Required permission:** environment:roles:viewer<br/><br/>The token secret is **not** exposed.
150
150
  * @returns Success
151
151
  */
152
152
  getApiToken(config: {
@@ -156,7 +156,7 @@ export declare class AccessTokensApiTokensClient {
156
156
  /**
157
157
  * Updates an API token
158
158
  *
159
- * **Required scope:** environment-api:api-tokens:write
159
+ * **Required scope:** environment-api:api-tokens:write<br/>**Required permission:** environment:roles:viewer
160
160
  */
161
161
  updateApiToken(config: {
162
162
  body: ApiTokenUpdate;
@@ -170,7 +170,7 @@ export declare class AccessTokensApiTokensClient {
170
170
  /**
171
171
  * Deletes an API token
172
172
  *
173
- * **Required scope:** environment-api:api-tokens:write
173
+ * **Required scope:** environment-api:api-tokens:write<br/>**Required permission:** environment:roles:viewer
174
174
  */
175
175
  deleteApiToken(config: {
176
176
  /**
@@ -185,7 +185,7 @@ export declare class AccessTokensApiTokensClient {
185
185
  /**
186
186
  * Gets API token metadata by token secret
187
187
  *
188
- * **Required scope:** environment-api:api-tokens:read
188
+ * **Required scope:** environment-api:api-tokens:read<br/>**Required permission:** environment:roles:viewer
189
189
  * @returns Success
190
190
  */
191
191
  lookupApiToken(config: {
@@ -14,21 +14,21 @@ export declare class AccessTokensTenantTokensClient {
14
14
  /**
15
15
  * Cancels tenant token rotation
16
16
  *
17
- * **Required scope:** environment-api:tenant-token-rotation:write<br/><br/>To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6) in Dynatrace Documentation.
17
+ * **Required scope:** environment-api:tenant-token-rotation:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6) in Dynatrace Documentation.
18
18
  * @returns Success. Rotation process has been cancelled. The current tenant token remains valid.
19
19
  */
20
20
  cancelRotation(abortSignal?: AbortSignal): Promise<TenantTokenConfig>;
21
21
  /**
22
22
  * Finishes tenant token rotation
23
23
  *
24
- * **Required scope:** environment-api:tenant-token-rotation:write<br/><br/>To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6) in Dynatrace Documentation.
24
+ * **Required scope:** environment-api:tenant-token-rotation:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6) in Dynatrace Documentation.
25
25
  * @returns Success. The rotation process is completed. The **active** field of the response contains the new tenant token.
26
26
  */
27
27
  finishRotation(abortSignal?: AbortSignal): Promise<TenantTokenConfig>;
28
28
  /**
29
29
  * Starts tenant token rotation
30
30
  *
31
- * **Required scope:** environment-api:tenant-token-rotation:write<br/><br/>To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6) in Dynatrace Documentation.
31
+ * **Required scope:** environment-api:tenant-token-rotation:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6) in Dynatrace Documentation.
32
32
  * @returns Success. The new tenant token is created and will replace the old one. The **active** field of the response contains the new tenant token.
33
33
  */
34
34
  startRotation(abortSignal?: AbortSignal): Promise<TenantTokenConfig>;
@@ -23,7 +23,7 @@ export declare class ActiveGatesClient {
23
23
  /**
24
24
  * Lists all available ActiveGates
25
25
  *
26
- * **Required scope:** environment-api:activegates:read<br/><br/>The response includes all ActiveGates that are currently connected to the environment or have been connected during last 2 hours.
26
+ * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings<br/><br/>The response includes all ActiveGates that are currently connected to the environment or have been connected during last 2 hours.
27
27
  * @returns Success
28
28
  */
29
29
  getAllActiveGates(config: {
@@ -77,7 +77,7 @@ export declare class ActiveGatesClient {
77
77
  /**
78
78
  * Gets the details of the specified ActiveGate
79
79
  *
80
- * **Required scope:** environment-api:activegates:read
80
+ * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings
81
81
  * @returns Success
82
82
  */
83
83
  getOneActiveGateById(config: {
@@ -15,7 +15,7 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
15
15
  /**
16
16
  * Gets the configuration of auto-update for the specified ActiveGate
17
17
  *
18
- * **Required scope:** environment-api:activegates:read
18
+ * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings
19
19
  * @returns Success
20
20
  */
21
21
  getAutoUpdateConfigById(config: {
@@ -25,7 +25,7 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
25
25
  /**
26
26
  * Updates the configuration of auto-update for the specified ActiveGate
27
27
  *
28
- * **Required scope:** environment-api:activegates:write
28
+ * **Required scope:** environment-api:activegates:write<br/>**Required permission:** environment:roles:manage-settings
29
29
  */
30
30
  putAutoUpdateConfigById(config: {
31
31
  body: ActiveGateAutoUpdateConfig;
@@ -35,7 +35,7 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
35
35
  /**
36
36
  * Validates the payload for the `POST /activeGates/{agId}/autoUpdate` request.
37
37
  *
38
- * **Required scope:** environment-api:activegates:write
38
+ * **Required scope:** environment-api:activegates:write<br/>**Required permission:** environment:roles:manage-settings
39
39
  */
40
40
  validateAutoUpdateConfigById(config: {
41
41
  body: ActiveGateAutoUpdateConfig;
@@ -45,14 +45,14 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
45
45
  /**
46
46
  * Gets the global auto-update configuration of environment ActiveGates.
47
47
  *
48
- * **Required scope:** environment-api:activegates:read
48
+ * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings
49
49
  * @returns Success
50
50
  */
51
51
  getGlobalAutoUpdateConfigForTenant(abortSignal?: AbortSignal): Promise<ActiveGateGlobalAutoUpdateConfig>;
52
52
  /**
53
53
  * Puts the global auto-update configuration of environment ActiveGates.
54
54
  *
55
- * **Required scope:** environment-api:activegates:write
55
+ * **Required scope:** environment-api:activegates:write<br/>**Required permission:** environment:roles:manage-settings
56
56
  */
57
57
  putGlobalAutoUpdateConfigForTenant(config: {
58
58
  body: ActiveGateGlobalAutoUpdateConfig;
@@ -61,7 +61,7 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
61
61
  /**
62
62
  * Validates the payload for the `POST /activeGates/autoUpdate` request.
63
63
  *
64
- * **Required scope:** environment-api:activegates:write
64
+ * **Required scope:** environment-api:activegates:write<br/>**Required permission:** environment:roles:manage-settings
65
65
  */
66
66
  validateGlobalAutoUpdateConfigForTenant(config: {
67
67
  body: ActiveGateGlobalAutoUpdateConfig;
@@ -22,7 +22,7 @@ export declare class ActiveGatesAutoUpdateJobsClient {
22
22
  /**
23
23
  * List ActiveGates with update jobs
24
24
  *
25
- * **Required scope:** environment-api:activegates:read<br/><br/>The response includes ActiveGates that have both completed (successful and failed) jobs and jobs in progress.
25
+ * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings<br/><br/>The response includes ActiveGates that have both completed (successful and failed) jobs and jobs in progress.
26
26
  * @returns Success
27
27
  */
28
28
  getAllUpdateJobList(config: {
@@ -83,7 +83,7 @@ export declare class ActiveGatesAutoUpdateJobsClient {
83
83
  /**
84
84
  * Lists update jobs for the specified ActiveGate
85
85
  *
86
- * **Required scope:** environment-api:activegates:read<br/><br/>The job can update the ActiveGate to the specified version or the latest available one.
86
+ * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings<br/><br/>The job can update the ActiveGate to the specified version or the latest available one.
87
87
  * @returns Success
88
88
  */
89
89
  getUpdateJobListByAgId(config: {
@@ -145,7 +145,7 @@ export declare class ActiveGatesAutoUpdateJobsClient {
145
145
  /**
146
146
  * Creates a new update job for the specified ActiveGate
147
147
  *
148
- * **Required scope:** environment-api:activegates:write
148
+ * **Required scope:** environment-api:activegates:write<br/>**Required permission:** environment:roles:manage-settings
149
149
  * @returns Success. The update-job have been created.
150
150
  */
151
151
  createUpdateJobForAg(config: {
@@ -156,7 +156,7 @@ export declare class ActiveGatesAutoUpdateJobsClient {
156
156
  /**
157
157
  * Gets the parameters of the specified update job
158
158
  *
159
- * **Required scope:** environment-api:activegates:read
159
+ * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings
160
160
  * @returns Success
161
161
  */
162
162
  getUpdateJobByJobIdForAg(config: {
@@ -167,7 +167,7 @@ export declare class ActiveGatesAutoUpdateJobsClient {
167
167
  /**
168
168
  * Deletes the specified update job
169
169
  *
170
- * **Required scope:** environment-api:activegates:write
170
+ * **Required scope:** environment-api:activegates:write<br/>**Required permission:** environment:roles:manage-settings
171
171
  */
172
172
  deleteUpdateJobByJobIdForAg(config: {
173
173
  /** The ID of the required ActiveGate. */ agId: string;
@@ -177,7 +177,7 @@ export declare class ActiveGatesAutoUpdateJobsClient {
177
177
  /**
178
178
  * Validates the payload for the `POST /activeGates/{agId}/updateJobs` request.
179
179
  *
180
- * **Required scope:** environment-api:activegates:write
180
+ * **Required scope:** environment-api:activegates:write<br/>**Required permission:** environment:roles:manage-settings
181
181
  */
182
182
  validateUpdateJobForAg(config: {
183
183
  body: UpdateJob;
@@ -15,7 +15,7 @@ export declare class AuditLogsClient {
15
15
  /**
16
16
  * Gets the specified entry of the audit log | maturity=EARLY_ADOPTER
17
17
  *
18
- * **Required scope:** environment-api:audit-logs:read
18
+ * **Required scope:** environment-api:audit-logs:read<br/>**Required permission:** environment:roles:manage-settings
19
19
  * @returns Success
20
20
  */
21
21
  getLog(config: {
@@ -25,7 +25,7 @@ export declare class AuditLogsClient {
25
25
  /**
26
26
  * Gets the audit log of your Dynatrace environment | maturity=EARLY_ADOPTER
27
27
  *
28
- * **Required scope:** environment-api:audit-logs:read<br/><br/>You can limit the output by using pagination:
28
+ * **Required scope:** environment-api:audit-logs:read<br/>**Required permission:** environment:roles:manage-settings<br/><br/>You can limit the output by using pagination:
29
29
  * 1. Specify the number of results per page in the **pageSize** query parameter.
30
30
  * 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
31
31
  * @returns Success
@@ -19,7 +19,7 @@ export declare class CredentialVaultClient {
19
19
  /**
20
20
  * Lists all sets of credentials for synthetic monitors stored in your environment.
21
21
  *
22
- * **Required scope:** environment-api:credentials:read<br/><br/>The credentials set itself (username/certificate and password) is not included in the response.
22
+ * **Required scope:** environment-api:credentials:read<br/>**Required permission:** environment:roles:viewer<br/><br/>The credentials set itself (username/certificate and password) is not included in the response.
23
23
  * @returns Success
24
24
  */
25
25
  listCredentials(config: {
@@ -46,7 +46,7 @@ export declare class CredentialVaultClient {
46
46
  /**
47
47
  * Creates a new credentials set.
48
48
  *
49
- * **Required scope:** environment-api:credentials:write<br/><br/>The body must not provide an ID. An ID is assigned automatically by the Dynatrace server.
49
+ * **Required scope:** environment-api:credentials:write<br/>**Required permission:** environment:roles:viewer<br/><br/>The body must not provide an ID. An ID is assigned automatically by the Dynatrace server.
50
50
  * @returns Success. The new credentials set has been created. The response contains the ID of the set.
51
51
  */
52
52
  createCredentials(config: {
@@ -56,7 +56,7 @@ export declare class CredentialVaultClient {
56
56
  /**
57
57
  * Gets the metadata of the specified credentials set.
58
58
  *
59
- * **Required scope:** environment-api:credentials:read<br/><br/>The credentials set itself (e.g. username/certificate and password) is not included in the response.
59
+ * **Required scope:** environment-api:credentials:read<br/>**Required permission:** environment:roles:viewer<br/><br/>The credentials set itself (e.g. username/certificate and password) is not included in the response.
60
60
  * @returns Success. The response contains the metadata of the credentials set.
61
61
  */
62
62
  getCredentials(config: {
@@ -66,7 +66,7 @@ export declare class CredentialVaultClient {
66
66
  /**
67
67
  * Updates the specified credentials set.
68
68
  *
69
- * **Required scope:** environment-api:credentials:write<br/><br/>The body must not provide an ID. The ID should be provided in the path.
69
+ * **Required scope:** environment-api:credentials:write<br/>**Required permission:** environment:roles:viewer<br/><br/>The body must not provide an ID. The ID should be provided in the path.
70
70
  * @returns Success. The new credentials set has been created. The response contains the ID of the set.
71
71
  */
72
72
  updateCredentials(config: {
@@ -77,7 +77,7 @@ export declare class CredentialVaultClient {
77
77
  /**
78
78
  * Deletes the specified credentials set
79
79
  *
80
- * **Required scope:** environment-api:credentials:write<br/><br/>Provide credential ID in the path.
80
+ * **Required scope:** environment-api:credentials:write<br/>**Required permission:** environment:roles:viewer<br/><br/>Provide credential ID in the path.
81
81
  */
82
82
  removeCredentials(config: {
83
83
  /** The ID of the credentials set to be deleted. */ id: string;
@@ -14,7 +14,7 @@ export declare class DavisSecurityAdvisorClient {
14
14
  /**
15
15
  * Provides advice for security problems.
16
16
  *
17
- * **Required scope:** environment-api:security-problems:read<br/><br/>You can narrow down the output by providing the management zone and pagination. If you specify a management zone, only problems originating from that zone are included to the request.
17
+ * **Required scope:** environment-api:security-problems:read<br/>**Required permission:** environment:roles:manage-security-problems<br/><br/>You can narrow down the output by providing the management zone and pagination. If you specify a management zone, only problems originating from that zone are included to the request.
18
18
  * @returns Success
19
19
  */
20
20
  getAdviceForSecurityProblems(config: {
@@ -25,6 +25,10 @@ export declare class EventsClient {
25
25
  * + storage:events:write
26
26
  * + environment-api:events:write
27
27
  *
28
+ * <br/>**One of the following permissions is required:**
29
+ * + environment:roles:viewer
30
+ * + storage:events:write
31
+ *
28
32
  * <br/><br/>The ingestion of custom events consumes [Davis Data Units](https://dt-url.net/ddu) (DDUs) from the events pool.
29
33
  * @returns The event ingest request was received by the server. The response body indicates for each event whether its creation was successful.
30
34
  */
@@ -35,7 +39,7 @@ export declare class EventsClient {
35
39
  /**
36
40
  * Gets the properties of an event
37
41
  *
38
- * **Required scope:** environment-api:events:read
42
+ * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
39
43
  * @returns Success. The response contains the configuration of the event.
40
44
  */
41
45
  getEvent(config: {
@@ -45,7 +49,7 @@ export declare class EventsClient {
45
49
  /**
46
50
  * Lists all event properties
47
51
  *
48
- * **Required scope:** environment-api:events:read
52
+ * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
49
53
  * @returns Success
50
54
  */
51
55
  getEventProperties(config: {
@@ -68,7 +72,7 @@ export declare class EventsClient {
68
72
  /**
69
73
  * Gets the details of an event property
70
74
  *
71
- * **Required scope:** environment-api:events:read
75
+ * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
72
76
  * @returns Success
73
77
  */
74
78
  getEventProperty(config: {
@@ -78,7 +82,7 @@ export declare class EventsClient {
78
82
  /**
79
83
  * Gets the properties of an event type
80
84
  *
81
- * **Required scope:** environment-api:events:read
85
+ * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
82
86
  * @returns Success
83
87
  */
84
88
  getEventType(config: {
@@ -88,7 +92,7 @@ export declare class EventsClient {
88
92
  /**
89
93
  * Lists all event types
90
94
  *
91
- * **Required scope:** environment-api:events:read
95
+ * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
92
96
  * @returns Success
93
97
  */
94
98
  getEventTypes(config: {
@@ -111,7 +115,7 @@ export declare class EventsClient {
111
115
  /**
112
116
  * Lists events within the specified timeframe
113
117
  *
114
- * **Required scope:** environment-api:events:read
118
+ * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
115
119
  * @returns Success. The response contains the list of events.
116
120
  */
117
121
  getEvents(config: {
@@ -18,7 +18,6 @@ import { MonitoringConfigurationUpdateDto } from '../models/monitoring-configura
18
18
  import { SchemaDefinitionRestDto } from '../models/schema-definition-rest-dto';
19
19
  import { SchemaFiles } from '../models/schema-files';
20
20
  import { SchemasList } from '../models/schemas-list';
21
- import { UploadExtensionBody } from '../models/upload-extension-body';
22
21
  /**
23
22
  * Manage Extensions 2.0 life cycle
24
23
  */
@@ -33,7 +32,7 @@ export declare class Extensions_2_0Client {
33
32
  /**
34
33
  * Gets the active environment configuration version of the specified extension 2.0
35
34
  *
36
- * **Required scope:** environment-api:extensions:read
35
+ * **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
37
36
  * @returns Success
38
37
  */
39
38
  getActiveEnvironmentConfiguration(config: {
@@ -43,7 +42,7 @@ export declare class Extensions_2_0Client {
43
42
  /**
44
43
  * Updates the active environment configuration version of the extension 2.0
45
44
  *
46
- * **Required scope:** environment-api:extensions:write
45
+ * **Required scope:** environment-api:extensions:write<br/>**Required permission:** environment:roles:manage-settings
47
46
  * @returns Success. Environment configuration updated.
48
47
  */
49
48
  updateExtensionEnvironmentConfiguration(config: {
@@ -54,7 +53,7 @@ export declare class Extensions_2_0Client {
54
53
  /**
55
54
  * Activates the environment configuration from the specified version of the extension 2.0
56
55
  *
57
- * **Required scope:** environment-api:extensions:write
56
+ * **Required scope:** environment-api:extensions:write<br/>**Required permission:** environment:roles:manage-settings
58
57
  * @returns Success. Environment configuration created.
59
58
  */
60
59
  activateExtensionEnvironmentConfiguration(config: {
@@ -65,7 +64,7 @@ export declare class Extensions_2_0Client {
65
64
  /**
66
65
  * Deactivates the environment configuration of the specified extension 2.0
67
66
  *
68
- * **Required scope:** environment-api:extensions:write
67
+ * **Required scope:** environment-api:extensions:write<br/>**Required permission:** environment:roles:manage-settings
69
68
  * @returns Success. Environment configuration deactivated.
70
69
  */
71
70
  deleteEnvironmentConfiguration(config: {
@@ -75,7 +74,7 @@ export declare class Extensions_2_0Client {
75
74
  /**
76
75
  * Lists all the monitoring configurations of the specified extension 2.0
77
76
  *
78
- * **Required scope:** environment-api:extension-configurations:read
77
+ * **Required scope:** environment-api:extension-configurations:read<br/>**Required permission:** environment:roles:manage-settings
79
78
  * @returns Success
80
79
  */
81
80
  extensionMonitoringConfigurations(config: {
@@ -101,7 +100,7 @@ export declare class Extensions_2_0Client {
101
100
  /**
102
101
  * Creates new monitoring configuration for the specified extension 2.0
103
102
  *
104
- * **Required scope:** environment-api:extension-configurations:write
103
+ * **Required scope:** environment-api:extension-configurations:write<br/>**Required permission:** environment:roles:manage-settings
105
104
  * @returns Success | Multi-Status, if not all requests resulted in the same status
106
105
  */
107
106
  createMonitoringConfiguration(config: {
@@ -117,7 +116,7 @@ export declare class Extensions_2_0Client {
117
116
  /**
118
117
  * Gets the configuration schema of the specified version of the extension 2.0
119
118
  *
120
- * **Required scope:** environment-api:extension-configurations:read
119
+ * **Required scope:** environment-api:extension-configurations:read<br/>**Required permission:** environment:roles:manage-settings
121
120
  * @returns Success
122
121
  */
123
122
  extensionConfigurationSchema(config: {
@@ -128,7 +127,7 @@ export declare class Extensions_2_0Client {
128
127
  /**
129
128
  * Gets details of the specified version of the extension 2.0
130
129
  *
131
- * **Required scope:** environment-api:extensions:read
130
+ * **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
132
131
  * @returns Success
133
132
  */
134
133
  extensionDetails(config: {
@@ -140,7 +139,7 @@ export declare class Extensions_2_0Client {
140
139
  /**
141
140
  * Deletes the specified version of the extension 2.0
142
141
  *
143
- * **Required scope:** environment-api:extensions:write
142
+ * **Required scope:** environment-api:extensions:write<br/>**Required permission:** environment:roles:manage-settings
144
143
  * @returns Success. The extension 2.0 version has been deleted.
145
144
  */
146
145
  removeExtension(config: {
@@ -151,7 +150,7 @@ export declare class Extensions_2_0Client {
151
150
  /**
152
151
  * Gets the information about assets in an active extension 2.0
153
152
  *
154
- * **Required scope:** environment-api:extensions:read
153
+ * **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
155
154
  * @returns Success
156
155
  */
157
156
  getEnvironmentConfigurationAssetsInfo(config: {
@@ -161,7 +160,7 @@ export declare class Extensions_2_0Client {
161
160
  /**
162
161
  * List of the latest extension environment configuration events
163
162
  *
164
- * **Required scope:** environment-api:extensions:read
163
+ * **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
165
164
  * @returns List of the latest extension environment configuration events
166
165
  */
167
166
  getEnvironmentConfigurationEvents(config: {
@@ -209,7 +208,7 @@ export declare class Extensions_2_0Client {
209
208
  /**
210
209
  * Gets the list of the events linked to specific monitoring configuration
211
210
  *
212
- * **Required scope:** environment-api:extension-configurations:read
211
+ * **Required scope:** environment-api:extension-configurations:read<br/>**Required permission:** environment:roles:manage-settings
213
212
  * @returns Success
214
213
  */
215
214
  getExtensionMonitoringConfigurationEvents(config: {
@@ -273,7 +272,7 @@ export declare class Extensions_2_0Client {
273
272
  /**
274
273
  * Gets the most recent status of the execution of given monitoring configuration
275
274
  *
276
- * **Required scope:** environment-api:extension-configurations:read
275
+ * **Required scope:** environment-api:extension-configurations:read<br/>**Required permission:** environment:roles:manage-settings
277
276
  * @returns Success
278
277
  */
279
278
  getExtensionMonitoringConfigurationStatus(config: {
@@ -284,7 +283,7 @@ export declare class Extensions_2_0Client {
284
283
  /**
285
284
  * Gets the extension 2.0 schema file in the specified version
286
285
  *
287
- * **Required scope:** environment-api:extensions:read
286
+ * **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
288
287
  * @returns Success
289
288
  */
290
289
  getSchemaFile(config: {
@@ -295,7 +294,7 @@ export declare class Extensions_2_0Client {
295
294
  /**
296
295
  * Lists all versions of the extension 2.0
297
296
  *
298
- * **Required scope:** environment-api:extensions:read
297
+ * **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
299
298
  * @returns Success
300
299
  */
301
300
  listExtensionVersions(config: {
@@ -319,7 +318,7 @@ export declare class Extensions_2_0Client {
319
318
  /**
320
319
  * Lists all the extensions 2.0 available in your environment
321
320
  *
322
- * **Required scope:** environment-api:extensions:read
321
+ * **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
323
322
  * @returns Success
324
323
  */
325
324
  listExtensions(config: {
@@ -343,18 +342,19 @@ export declare class Extensions_2_0Client {
343
342
  /**
344
343
  * Uploads or verifies a new extension 2.0
345
344
  *
346
- * **Required scope:** environment-api:extensions:write
345
+ * **Required scope:** environment-api:extensions:write<br/>**Required permission:** environment:roles:manage-settings
347
346
  * @returns The extension is valid | Success. The extension 2.0 has been uploaded.
348
347
  */
349
348
  uploadExtension(config: {
350
- body: UploadExtensionBody;
349
+ body: Blob;
350
+ type: 'application/octet-stream' | 'multipart/form-data';
351
351
  /** Only run validation but do not persist the extension even if validation was successful. */ validateOnly?: boolean;
352
352
  abortSignal?: AbortSignal;
353
353
  }): Promise<ExtensionUploadResponseDto>;
354
354
  /**
355
355
  * Lists all the files available for the specified extension 2.0 schema version
356
356
  *
357
- * **Required scope:** environment-api:extensions:read
357
+ * **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
358
358
  * @returns Success
359
359
  */
360
360
  listSchemaFiles(config: {
@@ -365,14 +365,14 @@ export declare class Extensions_2_0Client {
365
365
  /**
366
366
  * Lists all the extension 2.0 schemas versions available in your environment
367
367
  *
368
- * **Required scope:** environment-api:extensions:read
368
+ * **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
369
369
  * @returns Success
370
370
  */
371
371
  listSchemas(abortSignal?: AbortSignal): Promise<SchemasList>;
372
372
  /**
373
373
  * Gets the details of the specified monitoring configuration
374
374
  *
375
- * **Required scope:** environment-api:extension-configurations:read
375
+ * **Required scope:** environment-api:extension-configurations:read<br/>**Required permission:** environment:roles:manage-settings
376
376
  * @returns Success
377
377
  */
378
378
  monitoringConfigurationDetails(config: {
@@ -383,7 +383,7 @@ export declare class Extensions_2_0Client {
383
383
  /**
384
384
  * Updates the specified monitoring configuration
385
385
  *
386
- * **Required scope:** environment-api:extension-configurations:write
386
+ * **Required scope:** environment-api:extension-configurations:write<br/>**Required permission:** environment:roles:manage-settings
387
387
  * @returns Success
388
388
  */
389
389
  updateMonitoringConfiguration(config: {
@@ -395,7 +395,7 @@ export declare class Extensions_2_0Client {
395
395
  /**
396
396
  * Deletes the specified monitoring configuration
397
397
  *
398
- * **Required scope:** environment-api:extension-configurations:write
398
+ * **Required scope:** environment-api:extension-configurations:write<br/>**Required permission:** environment:roles:manage-settings
399
399
  */
400
400
  removeMonitoringConfiguration(config: {
401
401
  /** The name of the requested extension 2.0. */ extensionName: string;