@dynatrace-sdk/client-classic-environment-v2 0.6.7 → 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.
- package/CHANGELOG.md +30 -0
- package/LICENSE +174 -0
- package/README.md +39 -0
- package/cjs/index.js +3976 -1164
- package/docs/DOCS.md +9780 -4761
- package/dynatrace-metadata.json +2 -2
- package/esm/index.js +3977 -1164
- package/package.json +3 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-active-gate-tokens-api.d.ts +14 -10
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-api-tokens-api.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-tenant-tokens-api.d.ts +3 -3
- 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/active-gates-auto-update-configuration-api.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-jobs-api.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/apis/audit-logs-api.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/credential-vault-api.d.ts +12 -11
- package/types/packages/client/classic-environment-v2/src/lib/apis/davis-security-advisor-api.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/events-api.d.ts +24 -16
- package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +34 -23
- package/types/packages/client/classic-environment-v2/src/lib/apis/hub-items-api.d.ts +162 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/index.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +8 -8
- package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-api.d.ts +13 -12
- package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-units-api.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts +31 -11
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-custom-tags-api.d.ts +21 -21
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-monitoring-state-api.d.ts +59 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/network-zones-api.d.ts +7 -7
- package/types/packages/client/classic-environment-v2/src/lib/apis/problems-api.d.ts +14 -14
- package/types/packages/client/classic-environment-v2/src/lib/apis/releases-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/security-problems-api.d.ts +85 -20
- package/types/packages/client/classic-environment-v2/src/lib/apis/service-level-objectives-api.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-http-monitor-executions-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-on-demand-monitor-executions-api.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token-created.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token-info-dto.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create-scopes-item.d.ts +0 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create.d.ts +0 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-scopes-item.d.ts +0 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update-scopes-item.d.ts +0 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update.d.ts +0 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/asset-info-dto-type.d.ts +35 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/asset-info-dto.d.ts +28 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/asset-schema-details-dto.d.ts +27 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/category-list.d.ts +15 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/category.d.ts +27 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/comment.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/comments-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/complex-constraint.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/configuration-metadata.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/constraint-violation-parameter-location.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/constraint.d.ts +12 -12
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-id.d.ts +17 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-config.d.ts +20 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-dto.d.ts +38 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-username-password-config.d.ts +22 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-username-password.d.ts +43 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/deletion-constraint.d.ts +22 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/description-block-type.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/description-block.d.ts +36 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/effective-settings-value.d.ts +16 -11
- package/types/packages/client/classic-environment-v2/src/lib/models/effective-settings-values-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/entity-icon.d.ts +7 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/entity-type.d.ts +10 -10
- package/types/packages/client/classic-environment-v2/src/lib/models/entity.d.ts +13 -13
- package/types/packages/client/classic-environment-v2/src/lib/models/enum-type.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/enum-value.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event-evidence.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event-ingest-results.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event-properties-list.d.ts +35 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/event-property-details.d.ts +13 -16
- package/types/packages/client/classic-environment-v2/src/lib/models/event-type-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event.d.ts +13 -13
- package/types/packages/client/classic-environment-v2/src/lib/models/execution-simple-results.d.ts +10 -10
- package/types/packages/client/classic-environment-v2/src/lib/models/exported-log-record-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-assets-dto.d.ts +28 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-release-feature-sets.d.ts +15 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-release-notes.d.ts +17 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-release.d.ts +81 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension1-details.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension1-release.d.ts +32 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension2-details.d.ts +33 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault-config-source-auth-method.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault-config-type.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault-config.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault-source-auth-method.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/filter.d.ts +9 -9
- package/types/packages/client/classic-environment-v2/src/lib/models/filtered-counts-dto.d.ts +77 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/global-counts-dto.d.ts +72 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/image.d.ts +27 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +60 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/item-details-type.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/item-details.d.ts +98 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/item-list.d.ts +32 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/item-overview-type.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/item-overview.d.ts +85 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/item.d.ts +10 -10
- package/types/packages/client/classic-environment-v2/src/lib/models/list-items-query-item-type.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.d.ts +5 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/log-record.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-data.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-default-aggregation.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-descriptor.d.ts +43 -43
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-dimension-cardinality.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-series.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-state-param.d.ts +22 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-severity.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-state.d.ts +50 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states.d.ts +29 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-states.d.ts +23 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/network-zone-fallback-mode.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/network-zone.d.ts +6 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/object-node.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/objects-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/precondition.d.ts +7 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/problem.d.ts +16 -16
- package/types/packages/client/classic-environment-v2/src/lib/models/property-definition.d.ts +14 -14
- package/types/packages/client/classic-environment-v2/src/lib/models/registered-extension-result-dto.d.ts +19 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/related-item-type.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/related-item.d.ts +36 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/release-instance.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/release.d.ts +14 -14
- package/types/packages/client/classic-environment-v2/src/lib/models/releases.d.ts +10 -10
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-muting-summary-reason.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-muting-summary.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-mute-reason.d.ts +16 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-mute-response.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-mute.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-unmute-reason.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-unmute-response.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-unmute.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-definition-rest-dto.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-bulk-muting-summary-reason.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-bulk-muting-summary.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-details.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-events-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-mute.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-unmute.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-mute-reason.d.ts +16 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-mute-response.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-mute.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-unmute-reason.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-unmute-response.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-unmute.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-create.d.ts +20 -13
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-response.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-update.d.ts +16 -16
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object.d.ts +26 -21
- package/types/packages/client/classic-environment-v2/src/lib/models/sl-os.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/slo-burn-rate.d.ts +12 -12
- package/types/packages/client/classic-environment-v2/src/lib/models/slo-config-item-dto-impl.d.ts +24 -24
- package/types/packages/client/classic-environment-v2/src/lib/models/slo.d.ts +36 -36
- package/types/packages/client/classic-environment-v2/src/lib/models/software-techs.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-execution-stage.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-processing-mode.d.ts +16 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request-monitor-custom-script.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request-monitor.d.ts +4 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-failed-execution-status-execution-stage.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/technology-details.d.ts +17 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/ui-button-customization.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/ui-customization.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/update-job.d.ts +15 -15
- package/types/packages/client/classic-environment-v2/src/lib/models/upload-metadata-for-extension-body.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/event-property-detail.d.ts +0 -32
- 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.
|
|
3
|
+
"version": "0.6.11",
|
|
4
|
+
"license": "Apache-2.0",
|
|
4
5
|
"dependencies": {
|
|
5
|
-
"@dynatrace-sdk/http-client": "^0.4.
|
|
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
|
|
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,9 +40,13 @@ export declare class AccessTokensActiveGateTokensClient {
|
|
|
40
40
|
abortSignal?: AbortSignal;
|
|
41
41
|
}): Promise<ActiveGateTokenList>;
|
|
42
42
|
/**
|
|
43
|
-
* Creates a new ActiveGate token
|
|
43
|
+
* Creates a new ActiveGate token
|
|
44
44
|
*
|
|
45
|
-
* **
|
|
45
|
+
* **One of the following scopes is required:**
|
|
46
|
+
* + environment-api:activegate-tokens:create
|
|
47
|
+
* + environment-api:activegate-tokens:write
|
|
48
|
+
*
|
|
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.
|
|
46
50
|
* @returns Success. The token has been created. The body of the response contains the token secret.
|
|
47
51
|
*/
|
|
48
52
|
createToken(config: {
|
|
@@ -50,22 +54,22 @@ export declare class AccessTokensActiveGateTokensClient {
|
|
|
50
54
|
abortSignal?: AbortSignal;
|
|
51
55
|
}): Promise<ActiveGateTokenCreated>;
|
|
52
56
|
/**
|
|
53
|
-
* Gets metadata of an ActiveGate token
|
|
57
|
+
* Gets metadata of an ActiveGate token
|
|
54
58
|
*
|
|
55
|
-
* **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.
|
|
56
60
|
* @returns Success. The response contains the metadata of the tokens.
|
|
57
61
|
*/
|
|
58
62
|
getToken(config: {
|
|
59
|
-
/** The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/
|
|
63
|
+
/** The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/rn00tjg) of the token. */ activeGateTokenIdentifier: string;
|
|
60
64
|
abortSignal?: AbortSignal;
|
|
61
65
|
}): Promise<ActiveGateToken>;
|
|
62
66
|
/**
|
|
63
|
-
* Deletes an ActiveGate token
|
|
67
|
+
* Deletes an ActiveGate token
|
|
64
68
|
*
|
|
65
|
-
* **Required scope:** environment-api:activegate-tokens:write
|
|
69
|
+
* **Required scope:** environment-api:activegate-tokens:write<br/>**Required permission:** environment:roles:manage-settings
|
|
66
70
|
*/
|
|
67
71
|
revokeToken(config: {
|
|
68
|
-
/** The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/
|
|
72
|
+
/** The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/rn00tjg) of the token to be deleted. */ activeGateTokenIdentifier: string;
|
|
69
73
|
abortSignal?: AbortSignal;
|
|
70
74
|
}): Promise<void>;
|
|
71
75
|
}
|
package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-api-tokens-api.d.ts
CHANGED
|
@@ -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
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
|
|
2
2
|
import { AbstractCredentialsResponseElement } from '../models/abstract-credentials-response-element';
|
|
3
3
|
import { Credentials } from '../models/credentials';
|
|
4
|
+
import { CredentialsId } from '../models/credentials-id';
|
|
4
5
|
import { CredentialsList } from '../models/credentials-list';
|
|
5
6
|
import { CredentialsResponseElement } from '../models/credentials-response-element';
|
|
6
7
|
import { ListCredentialsQueryType } from '../models/list-credentials-query-type';
|
|
@@ -16,9 +17,9 @@ export declare class CredentialVaultClient {
|
|
|
16
17
|
*/
|
|
17
18
|
constructor(httpClientImplementation: HttpClient);
|
|
18
19
|
/**
|
|
19
|
-
* Lists all sets of credentials for synthetic monitors stored in your environment
|
|
20
|
+
* Lists all sets of credentials for synthetic monitors stored in your environment.
|
|
20
21
|
*
|
|
21
|
-
* **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.
|
|
22
23
|
* @returns Success
|
|
23
24
|
*/
|
|
24
25
|
listCredentials(config: {
|
|
@@ -43,19 +44,19 @@ export declare class CredentialVaultClient {
|
|
|
43
44
|
abortSignal?: AbortSignal;
|
|
44
45
|
}): Promise<CredentialsList>;
|
|
45
46
|
/**
|
|
46
|
-
* Creates a new credentials set
|
|
47
|
+
* Creates a new credentials set.
|
|
47
48
|
*
|
|
48
|
-
* **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.
|
|
49
50
|
* @returns Success. The new credentials set has been created. The response contains the ID of the set.
|
|
50
51
|
*/
|
|
51
52
|
createCredentials(config: {
|
|
52
53
|
body: Credentials;
|
|
53
54
|
abortSignal?: AbortSignal;
|
|
54
|
-
}): Promise<
|
|
55
|
+
}): Promise<CredentialsId>;
|
|
55
56
|
/**
|
|
56
|
-
* Gets the metadata of the specified credentials set
|
|
57
|
+
* Gets the metadata of the specified credentials set.
|
|
57
58
|
*
|
|
58
|
-
* **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.
|
|
59
60
|
* @returns Success. The response contains the metadata of the credentials set.
|
|
60
61
|
*/
|
|
61
62
|
getCredentials(config: {
|
|
@@ -63,20 +64,20 @@ export declare class CredentialVaultClient {
|
|
|
63
64
|
abortSignal?: AbortSignal;
|
|
64
65
|
}): Promise<CredentialsResponseElement>;
|
|
65
66
|
/**
|
|
66
|
-
* Updates the specified credentials set
|
|
67
|
+
* Updates the specified credentials set.
|
|
67
68
|
*
|
|
68
|
-
* **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.
|
|
69
70
|
* @returns Success. The new credentials set has been created. The response contains the ID of the set.
|
|
70
71
|
*/
|
|
71
72
|
updateCredentials(config: {
|
|
72
73
|
body: Credentials;
|
|
73
74
|
/** The Dynatrace entity ID of the credentials set to be updated. */ id: string;
|
|
74
75
|
abortSignal?: AbortSignal;
|
|
75
|
-
}): Promise<
|
|
76
|
+
}): Promise<CredentialsId | void>;
|
|
76
77
|
/**
|
|
77
78
|
* Deletes the specified credentials set
|
|
78
79
|
*
|
|
79
|
-
* **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.
|
|
80
81
|
*/
|
|
81
82
|
removeCredentials(config: {
|
|
82
83
|
/** The ID of the credentials set to be deleted. */ id: string;
|
package/types/packages/client/classic-environment-v2/src/lib/apis/davis-security-advisor-api.d.ts
CHANGED
|
@@ -12,9 +12,9 @@ export declare class DavisSecurityAdvisorClient {
|
|
|
12
12
|
*/
|
|
13
13
|
constructor(httpClientImplementation: HttpClient);
|
|
14
14
|
/**
|
|
15
|
-
* Provides advice for security problems.
|
|
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: {
|
|
@@ -3,7 +3,7 @@ import { Event } from '../models/event';
|
|
|
3
3
|
import { EventIngest } from '../models/event-ingest';
|
|
4
4
|
import { EventIngestResults } from '../models/event-ingest-results';
|
|
5
5
|
import { EventList } from '../models/event-list';
|
|
6
|
-
import {
|
|
6
|
+
import { EventPropertiesList } from '../models/event-properties-list';
|
|
7
7
|
import { EventPropertyDetails } from '../models/event-property-details';
|
|
8
8
|
import { EventType } from '../models/event-type';
|
|
9
9
|
import { EventTypeList } from '../models/event-type-list';
|
|
@@ -21,7 +21,15 @@ export declare class EventsClient {
|
|
|
21
21
|
/**
|
|
22
22
|
* Ingests a custom event
|
|
23
23
|
*
|
|
24
|
-
* **
|
|
24
|
+
* **One of the following scopes is required:**
|
|
25
|
+
* + storage:events:write
|
|
26
|
+
* + environment-api:events:write
|
|
27
|
+
*
|
|
28
|
+
* <br/>**One of the following permissions is required:**
|
|
29
|
+
* + environment:roles:viewer
|
|
30
|
+
* + storage:events:write
|
|
31
|
+
*
|
|
32
|
+
* <br/><br/>The ingestion of custom events consumes [Davis Data Units](https://dt-url.net/ddu) (DDUs) from the events pool.
|
|
25
33
|
* @returns The event ingest request was received by the server. The response body indicates for each event whether its creation was successful.
|
|
26
34
|
*/
|
|
27
35
|
createEvent(config: {
|
|
@@ -31,7 +39,7 @@ export declare class EventsClient {
|
|
|
31
39
|
/**
|
|
32
40
|
* Gets the properties of an event
|
|
33
41
|
*
|
|
34
|
-
* **Required scope:** environment-api:events:read
|
|
42
|
+
* **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
|
|
35
43
|
* @returns Success. The response contains the configuration of the event.
|
|
36
44
|
*/
|
|
37
45
|
getEvent(config: {
|
|
@@ -41,7 +49,7 @@ export declare class EventsClient {
|
|
|
41
49
|
/**
|
|
42
50
|
* Lists all event properties
|
|
43
51
|
*
|
|
44
|
-
* **Required scope:** environment-api:events:read
|
|
52
|
+
* **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
|
|
45
53
|
* @returns Success
|
|
46
54
|
*/
|
|
47
55
|
getEventProperties(config: {
|
|
@@ -60,21 +68,21 @@ export declare class EventsClient {
|
|
|
60
68
|
* If not set, 100 is used.
|
|
61
69
|
*/ pageSize?: number;
|
|
62
70
|
abortSignal?: AbortSignal;
|
|
63
|
-
}): Promise<
|
|
71
|
+
}): Promise<EventPropertiesList>;
|
|
64
72
|
/**
|
|
65
73
|
* Gets the details of an event property
|
|
66
74
|
*
|
|
67
|
-
* **Required scope:** environment-api:events:read
|
|
75
|
+
* **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
|
|
68
76
|
* @returns Success
|
|
69
77
|
*/
|
|
70
78
|
getEventProperty(config: {
|
|
71
79
|
/** The event property key you're inquiring. */ propertyKey: string;
|
|
72
80
|
abortSignal?: AbortSignal;
|
|
73
|
-
}): Promise<
|
|
81
|
+
}): Promise<EventPropertyDetails>;
|
|
74
82
|
/**
|
|
75
83
|
* Gets the properties of an event type
|
|
76
84
|
*
|
|
77
|
-
* **Required scope:** environment-api:events:read
|
|
85
|
+
* **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
|
|
78
86
|
* @returns Success
|
|
79
87
|
*/
|
|
80
88
|
getEventType(config: {
|
|
@@ -84,7 +92,7 @@ export declare class EventsClient {
|
|
|
84
92
|
/**
|
|
85
93
|
* Lists all event types
|
|
86
94
|
*
|
|
87
|
-
* **Required scope:** environment-api:events:read
|
|
95
|
+
* **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
|
|
88
96
|
* @returns Success
|
|
89
97
|
*/
|
|
90
98
|
getEventTypes(config: {
|
|
@@ -107,7 +115,7 @@ export declare class EventsClient {
|
|
|
107
115
|
/**
|
|
108
116
|
* Lists events within the specified timeframe
|
|
109
117
|
*
|
|
110
|
-
* **Required scope:** environment-api:events:read
|
|
118
|
+
* **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
|
|
111
119
|
* @returns Success. The response contains the list of events.
|
|
112
120
|
*/
|
|
113
121
|
getEvents(config: {
|
|
@@ -185,16 +193,16 @@ export declare class EventsClient {
|
|
|
185
193
|
* * Entity type: `type("TYPE")`
|
|
186
194
|
* * Dynatrace entity ID: `entityId("id")`. You can specify several IDs, separated by a comma (`entityId("id-1","id-2")`). All requested entities must be of the same type.
|
|
187
195
|
*
|
|
188
|
-
* You can add one or
|
|
196
|
+
* You can add one or more of the following criteria. Values are case-sensitive and the `EQUALS` operator is used unless otherwise specified.
|
|
189
197
|
*
|
|
190
|
-
* * Tag: `tag("value")`. Tags in `[context]key:value`, `key:value`, and `value` formats are detected and parsed automatically. Any colons (`:`) that are part of the key or value must be escaped with a backslash(`\`)
|
|
198
|
+
* * Tag: `tag("value")`. Tags in `[context]key:value`, `key:value`, and `value` formats are detected and parsed automatically. Any colons (`:`) that are part of the key or value must be escaped with a backslash(`\`). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.
|
|
191
199
|
* * Management zone ID: `mzId(123)`
|
|
192
200
|
* * Management zone name: `mzName("value")`
|
|
193
201
|
* * Entity name:
|
|
194
202
|
* * `entityName.equals`: performs a non-casesensitive `EQUALS` query.
|
|
195
203
|
* * `entityName.startsWith`: changes the operator to `BEGINS WITH`.
|
|
196
204
|
* * `entityName.in`: enables you to provide multiple values. The `EQUALS` operator applies.
|
|
197
|
-
* * `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an
|
|
205
|
+
* * `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an argument and makes the value case-sensitive.
|
|
198
206
|
* * Health state (HEALTHY,UNHEALTHY): `healthState("HEALTHY")`
|
|
199
207
|
* * First seen timestamp: `firstSeenTms.<operator>(now-3h)`. Use any timestamp format from the **from** /**to** parameters.
|
|
200
208
|
* The following operators are available:
|
|
@@ -203,14 +211,14 @@ export declare class EventsClient {
|
|
|
203
211
|
* * `gte`: later than or at the specified time
|
|
204
212
|
* * `gt`: later than the specified time
|
|
205
213
|
* * Entity attribute: `<attribute>("value1","value2")` and `<attribute>.exists()`. To fetch the list of available attributes, execute the [GET entity type](https://dt-url.net/2ka3ivt) request and check the **properties** field of the response.
|
|
206
|
-
* * Relationships: `fromRelationships.<relationshipName>()` and `toRelationships.<relationshipName>()`.
|
|
214
|
+
* * Relationships: `fromRelationships.<relationshipName>()` and `toRelationships.<relationshipName>()`. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the [GET entity type](https://dt-url.net/2ka3ivt) request and check the **fromRelationships** and **toRelationships** fields.
|
|
207
215
|
* * Negation: `not(<criterion>)`. Inverts any criterion except for **type**.
|
|
208
216
|
*
|
|
209
217
|
* For more information, see [Entity selector](https://dt-url.net/apientityselector) in Dynatrace Documentation.
|
|
210
218
|
*
|
|
211
|
-
* To set several criteria, separate them with a comma (`,`). For example, `type("HOST"),healthState("HEALTHY")`. Only results matching **all** criteria are included in response.
|
|
219
|
+
* To set several criteria, separate them with a comma (`,`). For example, `type("HOST"),healthState("HEALTHY")`. Only results matching **all** criteria are included in the response.
|
|
212
220
|
*
|
|
213
|
-
*
|
|
221
|
+
* The maximum string length is 2,000 characters.
|
|
214
222
|
*
|
|
215
223
|
* The number of entities that can be selected is limited to 10000.
|
|
216
224
|
*/ entitySelector?: string;
|