@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.
- package/CHANGELOG.md +21 -0
- package/LICENSE +174 -0
- package/cjs/index.js +1098 -1027
- package/docs/DOCS.md +362 -96
- package/dynatrace-metadata.json +1 -1
- package/esm/index.js +1099 -1027
- package/package.json +3 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-active-gate-tokens-api.d.ts +10 -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 +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/apis/davis-security-advisor-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/events-api.d.ts +10 -6
- package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +24 -24
- package/types/packages/client/classic-environment-v2/src/lib/apis/hub-items-api.d.ts +11 -11
- package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-api.d.ts +5 -5
- 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 +8 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-custom-tags-api.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-monitoring-state-api.d.ts +1 -1
- 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 +8 -8
- 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 +12 -12
- 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/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-module.d.ts +3 -3
- 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.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-created.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token.d.ts +15 -15
- 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/complex-constraint.d.ts +10 -10
- 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.d.ts +8 -8
- package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-config.d.ts +0 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-username-password-config.d.ts +0 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/datasource-definition.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/deletion-constraint.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/description-block.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/effective-settings-value.d.ts +10 -10
- 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 +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/entity.d.ts +10 -10
- 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 +7 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/error.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-property-details.d.ts +8 -8
- package/types/packages/client/classic-environment-v2/src/lib/models/event-type.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event.d.ts +16 -16
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-release.d.ts +31 -19
- package/types/packages/client/classic-environment-v2/src/lib/models/extension1-details.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/extension1-release.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/extension2-details.d.ts +12 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault.d.ts +5 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/filter.d.ts +11 -11
- package/types/packages/client/classic-environment-v2/src/lib/models/image.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +3 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/invocation.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/item-details.d.ts +29 -29
- package/types/packages/client/classic-environment-v2/src/lib/models/item-overview.d.ts +5 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/item.d.ts +7 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/log-record.d.ts +7 -7
- 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 +19 -19
- 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-ingest-error.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-series-collection.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 +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-state.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states.d.ts +2 -2
- 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 +8 -5
- 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/precondition.d.ts +8 -8
- package/types/packages/client/classic-environment-v2/src/lib/models/problem.d.ts +21 -21
- package/types/packages/client/classic-environment-v2/src/lib/models/property-definition.d.ts +11 -11
- package/types/packages/client/classic-environment-v2/src/lib/models/related-item.d.ts +5 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/release.d.ts +24 -24
- package/types/packages/client/classic-environment-v2/src/lib/models/rollup.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-type.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-create.d.ts +7 -7
- 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 +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object.d.ts +7 -7
- 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 +25 -25
- package/types/packages/client/classic-environment-v2/src/lib/models/success.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-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 +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution.d.ts +8 -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 +2 -2
- 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/ui-expandable-section-customization.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/ui-tab-group-customization.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/update-job.d.ts +10 -10
- package/types/packages/client/classic-environment-v2/src/lib/models/upload-extension-body.d.ts +0 -18
|
@@ -21,7 +21,7 @@ export declare class HubItemsClient {
|
|
|
21
21
|
* Retrieves the image associated with the given url.
|
|
22
22
|
* Can only obtain images used in hub items.
|
|
23
23
|
*
|
|
24
|
-
* **Required scope:** environment-api:hub:read
|
|
24
|
+
* **Required scope:** environment-api:hub:read<br/>**Required permission:** environment:roles:viewer
|
|
25
25
|
*/
|
|
26
26
|
getImage(config: {
|
|
27
27
|
encodedUrl: string;
|
|
@@ -30,14 +30,14 @@ export declare class HubItemsClient {
|
|
|
30
30
|
/**
|
|
31
31
|
* Lists all the available category groupings of items
|
|
32
32
|
*
|
|
33
|
-
* **Required scope:** environment-api:hub:read
|
|
33
|
+
* **Required scope:** environment-api:hub:read<br/>**Required permission:** environment:roles:viewer
|
|
34
34
|
* @returns OK
|
|
35
35
|
*/
|
|
36
36
|
listCategories(abortSignal?: AbortSignal): Promise<CategoryList>;
|
|
37
37
|
/**
|
|
38
38
|
* Registers the given extension version in the environment (using the recommended version if no other release is registered)
|
|
39
39
|
*
|
|
40
|
-
* **Required scope:** environment-api:hub:write
|
|
40
|
+
* **Required scope:** environment-api:hub:write<br/>**Required permission:** environment:roles:manage-settings
|
|
41
41
|
* @returns OK
|
|
42
42
|
*/
|
|
43
43
|
addToEnvironment(config: {
|
|
@@ -48,7 +48,7 @@ export declare class HubItemsClient {
|
|
|
48
48
|
/**
|
|
49
49
|
* The details of the given extension
|
|
50
50
|
*
|
|
51
|
-
* **Required scope:** environment-api:hub:read
|
|
51
|
+
* **Required scope:** environment-api:hub:read<br/>**Required permission:** environment:roles:viewer
|
|
52
52
|
* @returns OK
|
|
53
53
|
*/
|
|
54
54
|
getExtensionDetails(config: {
|
|
@@ -58,7 +58,7 @@ export declare class HubItemsClient {
|
|
|
58
58
|
/**
|
|
59
59
|
* Updates the given extension to the latest compatible published version
|
|
60
60
|
*
|
|
61
|
-
* **Required scope:** environment-api:hub:write
|
|
61
|
+
* **Required scope:** environment-api:hub:write<br/>**Required permission:** environment:roles:manage-settings
|
|
62
62
|
* @returns OK
|
|
63
63
|
*/
|
|
64
64
|
update(config: {
|
|
@@ -69,7 +69,7 @@ export declare class HubItemsClient {
|
|
|
69
69
|
/**
|
|
70
70
|
* Sets or updates the release notes of the specified extension release
|
|
71
71
|
*
|
|
72
|
-
* **Required scope:** environment-api:hub:write
|
|
72
|
+
* **Required scope:** environment-api:hub:write<br/>**Required permission:** environment:roles:manage-settings
|
|
73
73
|
*/
|
|
74
74
|
updateReleaseNotes(config: {
|
|
75
75
|
body: ExtensionReleaseNotes;
|
|
@@ -80,7 +80,7 @@ export declare class HubItemsClient {
|
|
|
80
80
|
/**
|
|
81
81
|
* Create/Replace metadata for an extension that does not have Dynatrace distributed metadata.
|
|
82
82
|
*
|
|
83
|
-
* **Required scope:** environment-api:hub:write
|
|
83
|
+
* **Required scope:** environment-api:hub:write<br/>**Required permission:** environment:roles:manage-settings
|
|
84
84
|
*/
|
|
85
85
|
uploadMetadataForExtension(config: {
|
|
86
86
|
body: UploadMetadataForExtensionBody;
|
|
@@ -90,7 +90,7 @@ export declare class HubItemsClient {
|
|
|
90
90
|
/**
|
|
91
91
|
* Artifact of the given version of an item
|
|
92
92
|
*
|
|
93
|
-
* **Required scope:** environment-api:hub:read
|
|
93
|
+
* **Required scope:** environment-api:hub:read<br/>**Required permission:** environment:roles:viewer
|
|
94
94
|
* @returns Ok - download file
|
|
95
95
|
*/
|
|
96
96
|
getArtifact(config: {
|
|
@@ -101,7 +101,7 @@ export declare class HubItemsClient {
|
|
|
101
101
|
/**
|
|
102
102
|
* The details of the given extension version 1
|
|
103
103
|
*
|
|
104
|
-
* **Required scope:** environment-api:hub:read
|
|
104
|
+
* **Required scope:** environment-api:hub:read<br/>**Required permission:** environment:roles:viewer
|
|
105
105
|
* @returns OK
|
|
106
106
|
*/
|
|
107
107
|
getDetails(config: {
|
|
@@ -111,7 +111,7 @@ export declare class HubItemsClient {
|
|
|
111
111
|
/**
|
|
112
112
|
* The details of the given technology
|
|
113
113
|
*
|
|
114
|
-
* **Required scope:** environment-api:hub:read
|
|
114
|
+
* **Required scope:** environment-api:hub:read<br/>**Required permission:** environment:roles:viewer
|
|
115
115
|
* @returns OK
|
|
116
116
|
*/
|
|
117
117
|
getTechnologyDetails(config: {
|
|
@@ -121,7 +121,7 @@ export declare class HubItemsClient {
|
|
|
121
121
|
/**
|
|
122
122
|
* Lists all the available items in your environment
|
|
123
123
|
*
|
|
124
|
-
* **Required scope:** environment-api:hub:read
|
|
124
|
+
* **Required scope:** environment-api:hub:read<br/>**Required permission:** environment:roles:viewer
|
|
125
125
|
* @returns OK
|
|
126
126
|
*/
|
|
127
127
|
listItems(config: {
|
|
@@ -19,7 +19,7 @@ export declare class LogsClient {
|
|
|
19
19
|
/**
|
|
20
20
|
* Pushes log records to Dynatrace | maturity=EARLY_ADOPTER
|
|
21
21
|
*
|
|
22
|
-
* **Required scope:** storage:logs:write<br/><br/>Ingested logs are stored in the indexed log storage.
|
|
22
|
+
* **Required scope:** storage:logs:write<br/>**Required permission:** storage:logs:write<br/><br/>Ingested logs are stored in the indexed log storage.
|
|
23
23
|
*
|
|
24
24
|
* This endpoint requires an ActiveGate with the **Log Analytics Collector** module enabled.
|
|
25
25
|
*
|
|
@@ -68,7 +68,7 @@ export declare class LogsClient {
|
|
|
68
68
|
/**
|
|
69
69
|
* Exports log records | maturity=EARLY_ADOPTER
|
|
70
70
|
*
|
|
71
|
-
* **Required scope:** environment-api<br/><br/>Returns the first *X* records (specified in the **pageSize** query parameter).
|
|
71
|
+
* **Required scope:** environment-api<br/>**Required permission:** environment:roles:logviewer<br/><br/>Returns the first *X* records (specified in the **pageSize** query parameter).
|
|
72
72
|
*
|
|
73
73
|
* Unlike the **search** API, this API does not split the result into slices and has no limit for the total number of records. Log records are sorted by the criteria specified in the **sort** query parameter.
|
|
74
74
|
*
|
|
@@ -139,7 +139,7 @@ export declare class LogsClient {
|
|
|
139
139
|
/**
|
|
140
140
|
* Gets aggregated log records | maturity=EARLY_ADOPTER
|
|
141
141
|
*
|
|
142
|
-
* **Required scope:** storage:logs:read<br/><br/>Returns the aggregated number of occurrences of log values divided into time slots.
|
|
142
|
+
* **Required scope:** storage:logs:read<br/>**Required permission:** environment:roles:logviewer<br/><br/>Returns the aggregated number of occurrences of log values divided into time slots.
|
|
143
143
|
*
|
|
144
144
|
* It is possible that the timeframe covered by results exceeds the specified timeframe. In that case the request returns fewer time slots than specified in the **timeBuckets** query parameter.
|
|
145
145
|
* @returns Success
|
|
@@ -216,7 +216,7 @@ export declare class LogsClient {
|
|
|
216
216
|
/**
|
|
217
217
|
* Reads log records | maturity=EARLY_ADOPTER
|
|
218
218
|
*
|
|
219
|
-
* **Required scope:** storage:logs:read<br/><br/>Returns the first *X* records (specified in the **limit** query parameter). Log records are sorted by the criteria specified in the **sort** query parameter.
|
|
219
|
+
* **Required scope:** storage:logs:read<br/>**Required permission:** environment:roles:logviewer<br/><br/>Returns the first *X* records (specified in the **limit** query parameter). Log records are sorted by the criteria specified in the **sort** query parameter.
|
|
220
220
|
*
|
|
221
221
|
* If the query is too large to be processed in a single request, it is divided into slices. In that case the first response contains the **nextSliceKey** cursor for the second slice. Use it in the **nextSliceKey** query parameter to obtain the second slice, which contains **nextSliceKey** cursor for the third slice, and so on.
|
|
222
222
|
*
|
|
@@ -17,7 +17,7 @@ export declare class MetricsClient {
|
|
|
17
17
|
/**
|
|
18
18
|
* Gets the descriptor of the specified metric
|
|
19
19
|
*
|
|
20
|
-
* **Required scope:** environment-api:metrics:read
|
|
20
|
+
* **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer
|
|
21
21
|
* @returns Success
|
|
22
22
|
*/
|
|
23
23
|
metric(config: {
|
|
@@ -32,7 +32,7 @@ export declare class MetricsClient {
|
|
|
32
32
|
/**
|
|
33
33
|
* Deletes the specified metric
|
|
34
34
|
*
|
|
35
|
-
* **Required scope:** environment-api:metrics:write<br/><br/>Deletion cannot be undone! You can't delete a metric if it has data points ingested within the last two hours.
|
|
35
|
+
* **Required scope:** environment-api:metrics:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>Deletion cannot be undone! You can't delete a metric if it has data points ingested within the last two hours.
|
|
36
36
|
*/
|
|
37
37
|
delete(config: {
|
|
38
38
|
/** The key of the required metric. */ metricKey: string;
|
|
@@ -41,7 +41,7 @@ export declare class MetricsClient {
|
|
|
41
41
|
/**
|
|
42
42
|
* Lists all available metrics
|
|
43
43
|
*
|
|
44
|
-
* **Required scope:** environment-api:metrics:read<br/><br/>You can narrow down the output by selecting metrics in the **metricSelector** field.
|
|
44
|
+
* **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer<br/><br/>You can narrow down the output by selecting metrics in the **metricSelector** field.
|
|
45
45
|
*
|
|
46
46
|
* You can additionally limit the output by using pagination:
|
|
47
47
|
*
|
|
@@ -164,7 +164,7 @@ export declare class MetricsClient {
|
|
|
164
164
|
/**
|
|
165
165
|
* Gets data points of the specified metrics
|
|
166
166
|
*
|
|
167
|
-
* **Required scope:** environment-api:metrics:read<br/><br/>The following limits apply:
|
|
167
|
+
* **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer<br/><br/>The following limits apply:
|
|
168
168
|
* * The amount of aggregated data points in the response is limited to 1,000
|
|
169
169
|
* * The amount of series in the response is limited to 1,000
|
|
170
170
|
* * The amount of data points per series is limited to 10,080 (minutes of one week)
|
|
@@ -306,7 +306,7 @@ export declare class MetricsClient {
|
|
|
306
306
|
/**
|
|
307
307
|
* Pushes metric data points to Dynatrace
|
|
308
308
|
*
|
|
309
|
-
* **Required scope:** storage:metrics:write
|
|
309
|
+
* **Required scope:** storage:metrics:write<br/>**Required permission:** storage:metrics:write
|
|
310
310
|
* @returns The provided metric data points are accepted and will be processed in the background.
|
|
311
311
|
*/
|
|
312
312
|
ingest(config: {
|
|
@@ -16,7 +16,7 @@ export declare class MetricsUnitsClient {
|
|
|
16
16
|
/**
|
|
17
17
|
* Converts a value from a source unit into a target unit
|
|
18
18
|
*
|
|
19
|
-
* **Required scope:** environment-api:metrics:read<br/><br/>If no target unit is set, the request finds an appropriate target unit automatically, taking into account the preferred number format (if specified).
|
|
19
|
+
* **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer<br/><br/>If no target unit is set, the request finds an appropriate target unit automatically, taking into account the preferred number format (if specified).
|
|
20
20
|
* @returns Success
|
|
21
21
|
*/
|
|
22
22
|
convert(config: {
|
|
@@ -40,7 +40,7 @@ export declare class MetricsUnitsClient {
|
|
|
40
40
|
/**
|
|
41
41
|
* Gets the properties of the specified unit
|
|
42
42
|
*
|
|
43
|
-
* **Required scope:** environment-api:metrics:read
|
|
43
|
+
* **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer
|
|
44
44
|
* @returns Success
|
|
45
45
|
*/
|
|
46
46
|
unit(config: {
|
|
@@ -50,7 +50,7 @@ export declare class MetricsUnitsClient {
|
|
|
50
50
|
/**
|
|
51
51
|
* Lists all available units
|
|
52
52
|
*
|
|
53
|
-
* **Required scope:** environment-api:metrics:read<br/><br/>You can narrow down the output by providing filter criteria in the **unitSelector** field.
|
|
53
|
+
* **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer<br/><br/>You can narrow down the output by providing filter criteria in the **unitSelector** field.
|
|
54
54
|
* @returns Success
|
|
55
55
|
*/
|
|
56
56
|
allUnits(config: {
|
package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts
CHANGED
|
@@ -23,7 +23,7 @@ export declare class MonitoredEntitiesClient {
|
|
|
23
23
|
* + environment-api
|
|
24
24
|
* + environment-api:entities:read
|
|
25
25
|
*
|
|
26
|
-
* <br/><br/>Lists entities observed within the specified timeframe along with their properties.
|
|
26
|
+
* <br/>**Required permission:** environment:roles:viewer<br/><br/>Lists entities observed within the specified timeframe along with their properties.
|
|
27
27
|
*
|
|
28
28
|
* When you query entities of the `SERVICE_METHOD` type, only the following requests are returned:
|
|
29
29
|
*
|
|
@@ -144,6 +144,8 @@ export declare class MonitoredEntitiesClient {
|
|
|
144
144
|
* **One of the following scopes is required:**
|
|
145
145
|
* + environment-api
|
|
146
146
|
* + environment-api:entities:read
|
|
147
|
+
*
|
|
148
|
+
* <br/>**Required permission:** environment:roles:viewer
|
|
147
149
|
* @returns Success
|
|
148
150
|
*/
|
|
149
151
|
getEntity(config: {
|
|
@@ -199,6 +201,8 @@ export declare class MonitoredEntitiesClient {
|
|
|
199
201
|
* **One of the following scopes is required:**
|
|
200
202
|
* + environment-api
|
|
201
203
|
* + environment-api:entities:read
|
|
204
|
+
*
|
|
205
|
+
* <br/>**Required permission:** environment:roles:viewer
|
|
202
206
|
* @returns Success
|
|
203
207
|
*/
|
|
204
208
|
getEntityType(config: {
|
|
@@ -212,7 +216,7 @@ export declare class MonitoredEntitiesClient {
|
|
|
212
216
|
* + environment-api
|
|
213
217
|
* + environment-api:entities:read
|
|
214
218
|
*
|
|
215
|
-
* <br/><br/>You can limit the output by using pagination:
|
|
219
|
+
* <br/>**Required permission:** environment:roles:viewer<br/><br/>You can limit the output by using pagination:
|
|
216
220
|
* 1. Specify the number of results per page in the **pageSize** query parameter.
|
|
217
221
|
* 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
|
|
218
222
|
* @returns Success
|
|
@@ -240,6 +244,8 @@ export declare class MonitoredEntitiesClient {
|
|
|
240
244
|
* **One of the following scopes is required:**
|
|
241
245
|
* + environment-api
|
|
242
246
|
* + environment-api:entities:write
|
|
247
|
+
*
|
|
248
|
+
* <br/>**Required permission:** environment:roles:manage-settings
|
|
243
249
|
* @returns Success
|
|
244
250
|
*/
|
|
245
251
|
pushCustomDevice(config: {
|
|
@@ -17,7 +17,7 @@ export declare class MonitoredEntitiesCustomTagsClient {
|
|
|
17
17
|
/**
|
|
18
18
|
* Gets a list of custom tags applied to the specified entities
|
|
19
19
|
*
|
|
20
|
-
* **Required scope:** environment-api:entities:read<br/><br/>Automatically applied tags and imported tags are not included.
|
|
20
|
+
* **Required scope:** environment-api:entities:read<br/>**Required permission:** environment:roles:viewer<br/><br/>Automatically applied tags and imported tags are not included.
|
|
21
21
|
* @returns Success
|
|
22
22
|
*/
|
|
23
23
|
getTags(config: {
|
|
@@ -97,7 +97,7 @@ export declare class MonitoredEntitiesCustomTagsClient {
|
|
|
97
97
|
/**
|
|
98
98
|
* Adds custom tags to the specified entities
|
|
99
99
|
*
|
|
100
|
-
* **Required scope:** environment-api:entities:write<br/><br/>All existing tags remain unaffected.
|
|
100
|
+
* **Required scope:** environment-api:entities:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>All existing tags remain unaffected.
|
|
101
101
|
* @returns Success
|
|
102
102
|
*/
|
|
103
103
|
postTags(config: {
|
|
@@ -178,7 +178,7 @@ export declare class MonitoredEntitiesCustomTagsClient {
|
|
|
178
178
|
/**
|
|
179
179
|
* Deletes the specified tag from the specified entities
|
|
180
180
|
*
|
|
181
|
-
* **Required scope:** environment-api:entities:write
|
|
181
|
+
* **Required scope:** environment-api:entities:write<br/>**Required permission:** environment:roles:manage-settings
|
|
182
182
|
* @returns Success
|
|
183
183
|
*/
|
|
184
184
|
deleteTags(config: {
|
|
@@ -14,7 +14,7 @@ export declare class MonitoredEntitiesMonitoringStateClient {
|
|
|
14
14
|
/**
|
|
15
15
|
* Lists monitoring states of entities
|
|
16
16
|
*
|
|
17
|
-
* **Required scope:** environment-api:entities:read<br/><br/>Only porcess group instances are supported.
|
|
17
|
+
* **Required scope:** environment-api:entities:read<br/>**Required permission:** environment:roles:viewer<br/><br/>Only porcess group instances are supported.
|
|
18
18
|
* @returns Success
|
|
19
19
|
*/
|
|
20
20
|
getStates(config: {
|
|
@@ -19,7 +19,7 @@ export declare class NetworkZonesClient {
|
|
|
19
19
|
/**
|
|
20
20
|
* Gets parameters of the specified network zone
|
|
21
21
|
*
|
|
22
|
-
* **Required scope:** environment-api:network-zones:read
|
|
22
|
+
* **Required scope:** environment-api:network-zones:read<br/>**Required permission:** environment:roles:viewer
|
|
23
23
|
* @returns Success
|
|
24
24
|
*/
|
|
25
25
|
getSingleNetworkZone(config: {
|
|
@@ -29,7 +29,7 @@ export declare class NetworkZonesClient {
|
|
|
29
29
|
/**
|
|
30
30
|
* Updates an existing network zone or creates a new one
|
|
31
31
|
*
|
|
32
|
-
* **Required scope:** environment-api:network-zones:write<br/><br/>If the network zone with the specified ID does not exist, a new network zone is created.
|
|
32
|
+
* **Required scope:** environment-api:network-zones:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>If the network zone with the specified ID does not exist, a new network zone is created.
|
|
33
33
|
*
|
|
34
34
|
* The ID is not case sensitive. Dynatrace stores the ID in lowercase.
|
|
35
35
|
* @returns Success. The new network zone has been created. The response body contains the ID of the new network zone.
|
|
@@ -48,7 +48,7 @@ export declare class NetworkZonesClient {
|
|
|
48
48
|
/**
|
|
49
49
|
* Deletes the specified network zone
|
|
50
50
|
*
|
|
51
|
-
* **Required scope:** environment-api:network-zones:write<br/><br/>You can only delete an empty network zone (a zone that no ActiveGate or OneAgent is using).
|
|
51
|
+
* **Required scope:** environment-api:network-zones:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>You can only delete an empty network zone (a zone that no ActiveGate or OneAgent is using).
|
|
52
52
|
*
|
|
53
53
|
* If the network zone is used as an alternative zone for any OneAgent, it will be automatically removed from the list of possible alternatives.
|
|
54
54
|
*/
|
|
@@ -59,14 +59,14 @@ export declare class NetworkZonesClient {
|
|
|
59
59
|
/**
|
|
60
60
|
* Lists all existing network zones
|
|
61
61
|
*
|
|
62
|
-
* **Required scope:** environment-api:network-zones:read
|
|
62
|
+
* **Required scope:** environment-api:network-zones:read<br/>**Required permission:** environment:roles:viewer
|
|
63
63
|
* @returns Success
|
|
64
64
|
*/
|
|
65
65
|
getAllNetworkZones(abortSignal?: AbortSignal): Promise<NetworkZoneList>;
|
|
66
66
|
/**
|
|
67
67
|
* Gets the statistics about hosts using the network zone
|
|
68
68
|
*
|
|
69
|
-
* **Required scope:** environment-api:network-zones:read
|
|
69
|
+
* **Required scope:** environment-api:network-zones:read<br/>**Required permission:** environment:roles:manage-settings
|
|
70
70
|
* @returns Success
|
|
71
71
|
*/
|
|
72
72
|
getHostStats(config: {
|
|
@@ -87,14 +87,14 @@ export declare class NetworkZonesClient {
|
|
|
87
87
|
/**
|
|
88
88
|
* Gets the global configuration of network zones
|
|
89
89
|
*
|
|
90
|
-
* **Required scope:** environment-api:network-zones:read
|
|
90
|
+
* **Required scope:** environment-api:network-zones:read<br/>**Required permission:** environment:roles:viewer
|
|
91
91
|
* @returns Success
|
|
92
92
|
*/
|
|
93
93
|
getNetworkZoneSettings(abortSignal?: AbortSignal): Promise<NetworkZoneSettings>;
|
|
94
94
|
/**
|
|
95
95
|
* Updates the global configuration of network zones
|
|
96
96
|
*
|
|
97
|
-
* **Required scope:** environment-api:network-zones:write
|
|
97
|
+
* **Required scope:** environment-api:network-zones:write<br/>**Required permission:** environment:roles:manage-settings
|
|
98
98
|
*/
|
|
99
99
|
updateNetworkZoneSettings(config: {
|
|
100
100
|
body: NetworkZoneSettings;
|
|
@@ -20,7 +20,7 @@ export declare class ProblemsClient {
|
|
|
20
20
|
/**
|
|
21
21
|
* Closes the specified problem and adds a closing comment on it
|
|
22
22
|
*
|
|
23
|
-
* **Required scope:** environment-api:problems:write
|
|
23
|
+
* **Required scope:** environment-api:problems:write<br/>**Required permission:** environment:roles:viewer
|
|
24
24
|
* @returns Success
|
|
25
25
|
*/
|
|
26
26
|
closeProblem(config: {
|
|
@@ -31,7 +31,7 @@ export declare class ProblemsClient {
|
|
|
31
31
|
/**
|
|
32
32
|
* Gets all comments on the specified problem
|
|
33
33
|
*
|
|
34
|
-
* **Required scope:** environment-api:problems:read
|
|
34
|
+
* **Required scope:** environment-api:problems:read<br/>**Required permission:** environment:roles:viewer
|
|
35
35
|
* @returns Success
|
|
36
36
|
*/
|
|
37
37
|
getComments(config: {
|
|
@@ -55,7 +55,7 @@ export declare class ProblemsClient {
|
|
|
55
55
|
/**
|
|
56
56
|
* Adds a new comment on the specified problem
|
|
57
57
|
*
|
|
58
|
-
* **Required scope:** environment-api:problems:write
|
|
58
|
+
* **Required scope:** environment-api:problems:write<br/>**Required permission:** environment:roles:viewer
|
|
59
59
|
*/
|
|
60
60
|
createComment(config: {
|
|
61
61
|
body: CommentRequestDtoImpl;
|
|
@@ -65,7 +65,7 @@ export declare class ProblemsClient {
|
|
|
65
65
|
/**
|
|
66
66
|
* Gets the specified comment on a problem
|
|
67
67
|
*
|
|
68
|
-
* **Required scope:** environment-api:problems:read
|
|
68
|
+
* **Required scope:** environment-api:problems:read<br/>**Required permission:** environment:roles:viewer
|
|
69
69
|
* @returns Success
|
|
70
70
|
*/
|
|
71
71
|
getComment(config: {
|
|
@@ -76,7 +76,7 @@ export declare class ProblemsClient {
|
|
|
76
76
|
/**
|
|
77
77
|
* Updates the specified comment on a problem
|
|
78
78
|
*
|
|
79
|
-
* **Required scope:** environment-api:problems:write
|
|
79
|
+
* **Required scope:** environment-api:problems:write<br/>**Required permission:** environment:roles:viewer
|
|
80
80
|
*/
|
|
81
81
|
updateComment(config: {
|
|
82
82
|
body: CommentRequestDtoImpl;
|
|
@@ -87,7 +87,7 @@ export declare class ProblemsClient {
|
|
|
87
87
|
/**
|
|
88
88
|
* Deletes the specified comment from a problem
|
|
89
89
|
*
|
|
90
|
-
* **Required scope:** environment-api:problems:write
|
|
90
|
+
* **Required scope:** environment-api:problems:write<br/>**Required permission:** environment:roles:viewer
|
|
91
91
|
*/
|
|
92
92
|
deleteComment(config: {
|
|
93
93
|
/** The ID of the required problem. */ problemId: string;
|
|
@@ -97,7 +97,7 @@ export declare class ProblemsClient {
|
|
|
97
97
|
/**
|
|
98
98
|
* Gets the properties of the specified problem
|
|
99
99
|
*
|
|
100
|
-
* **Required scope:** environment-api:problems:read
|
|
100
|
+
* **Required scope:** environment-api:problems:read<br/>**Required permission:** environment:roles:viewer
|
|
101
101
|
* @returns Success
|
|
102
102
|
*/
|
|
103
103
|
getProblem(config: {
|
|
@@ -118,7 +118,7 @@ export declare class ProblemsClient {
|
|
|
118
118
|
/**
|
|
119
119
|
* Lists problems observed within the specified timeframe
|
|
120
120
|
*
|
|
121
|
-
* **Required scope:** environment-api:problems:read
|
|
121
|
+
* **Required scope:** environment-api:problems:read<br/>**Required permission:** environment:roles:viewer
|
|
122
122
|
* @returns Success
|
|
123
123
|
*/
|
|
124
124
|
getProblems(config: {
|
|
@@ -14,7 +14,7 @@ export declare class ReleasesClient {
|
|
|
14
14
|
/**
|
|
15
15
|
* Returns all releases
|
|
16
16
|
*
|
|
17
|
-
* **Required scope:** environment-api:releases:read
|
|
17
|
+
* **Required scope:** environment-api:releases:read<br/>**Required permission:** environment:roles:viewer
|
|
18
18
|
* @returns Success
|
|
19
19
|
*/
|
|
20
20
|
getReleases(config: {
|
package/types/packages/client/classic-environment-v2/src/lib/apis/security-problems-api.d.ts
CHANGED
|
@@ -29,7 +29,7 @@ export declare class SecurityProblemsClient {
|
|
|
29
29
|
/**
|
|
30
30
|
* Mutes several remediation items | maturity=EARLY_ADOPTER
|
|
31
31
|
*
|
|
32
|
-
* **Required scope:** environment-api:security-problems:write
|
|
32
|
+
* **Required scope:** environment-api:security-problems:write<br/>**Required permission:** environment:roles:manage-security-problems
|
|
33
33
|
* @returns Success. The remediation item(s) have been muted.
|
|
34
34
|
*/
|
|
35
35
|
bulkMuteRemediationItems(config: {
|
|
@@ -40,7 +40,7 @@ export declare class SecurityProblemsClient {
|
|
|
40
40
|
/**
|
|
41
41
|
* Mutes several security problems | maturity=EARLY_ADOPTER
|
|
42
42
|
*
|
|
43
|
-
* **Required scope:** environment-api:security-problems:write
|
|
43
|
+
* **Required scope:** environment-api:security-problems:write<br/>**Required permission:** environment:roles:manage-security-problems
|
|
44
44
|
* @returns Success. The security problem(s) have been muted.
|
|
45
45
|
*/
|
|
46
46
|
bulkMuteSecurityProblems(config: {
|
|
@@ -50,7 +50,7 @@ export declare class SecurityProblemsClient {
|
|
|
50
50
|
/**
|
|
51
51
|
* Un-mutes several remediation items | maturity=EARLY_ADOPTER
|
|
52
52
|
*
|
|
53
|
-
* **Required scope:** environment-api:security-problems:write
|
|
53
|
+
* **Required scope:** environment-api:security-problems:write<br/>**Required permission:** environment:roles:manage-security-problems
|
|
54
54
|
* @returns Success. The remediation item(s) have been un-muted.
|
|
55
55
|
*/
|
|
56
56
|
bulkUnmuteRemediationItems(config: {
|
|
@@ -61,7 +61,7 @@ export declare class SecurityProblemsClient {
|
|
|
61
61
|
/**
|
|
62
62
|
* Un-mutes several security problems | maturity=EARLY_ADOPTER
|
|
63
63
|
*
|
|
64
|
-
* **Required scope:** environment-api:security-problems:write
|
|
64
|
+
* **Required scope:** environment-api:security-problems:write<br/>**Required permission:** environment:roles:manage-security-problems
|
|
65
65
|
* @returns Success. The security problem(s) have been un-muted.
|
|
66
66
|
*/
|
|
67
67
|
bulkUnmuteSecurityProblems(config: {
|
|
@@ -71,7 +71,7 @@ export declare class SecurityProblemsClient {
|
|
|
71
71
|
/**
|
|
72
72
|
* Lists all events of a security problem
|
|
73
73
|
*
|
|
74
|
-
* **Required scope:** environment-api:security-problems:read
|
|
74
|
+
* **Required scope:** environment-api:security-problems:read<br/>**Required permission:** environment:roles:manage-security-problems
|
|
75
75
|
* @returns Success. The response contains the list of security problem events.
|
|
76
76
|
*/
|
|
77
77
|
getEventsForSecurityProblem(config: {
|
|
@@ -117,7 +117,7 @@ export declare class SecurityProblemsClient {
|
|
|
117
117
|
/**
|
|
118
118
|
* Lists remediation items of a third-party security problem
|
|
119
119
|
*
|
|
120
|
-
* **Required scope:** environment-api:security-problems:read
|
|
120
|
+
* **Required scope:** environment-api:security-problems:read<br/>**Required permission:** environment:roles:manage-security-problems
|
|
121
121
|
* @returns Success. The response contains the list of remediation items of a problem.
|
|
122
122
|
*/
|
|
123
123
|
getRemediationItems(config: {
|
|
@@ -147,7 +147,7 @@ export declare class SecurityProblemsClient {
|
|
|
147
147
|
/**
|
|
148
148
|
* Gets parameters of a security problem
|
|
149
149
|
*
|
|
150
|
-
* **Required scope:** environment-api:security-problems:read
|
|
150
|
+
* **Required scope:** environment-api:security-problems:read<br/>**Required permission:** environment:roles:manage-security-problems
|
|
151
151
|
* @returns Success. The response contains parameters of the security problem.
|
|
152
152
|
*/
|
|
153
153
|
getSecurityProblem(config: {
|
|
@@ -198,7 +198,7 @@ export declare class SecurityProblemsClient {
|
|
|
198
198
|
/**
|
|
199
199
|
* Lists all security problems
|
|
200
200
|
*
|
|
201
|
-
* **Required scope:** environment-api:security-problems:read
|
|
201
|
+
* **Required scope:** environment-api:security-problems:read<br/>**Required permission:** environment:roles:manage-security-problems
|
|
202
202
|
* @returns Success. The response contains the list of security problems.
|
|
203
203
|
*/
|
|
204
204
|
getSecurityProblems(config: {
|
|
@@ -357,7 +357,7 @@ export declare class SecurityProblemsClient {
|
|
|
357
357
|
/**
|
|
358
358
|
* Lists all vulnerable functions and their usage for a third-party security problem
|
|
359
359
|
*
|
|
360
|
-
* **Required scope:** environment-api:security-problems:read
|
|
360
|
+
* **Required scope:** environment-api:security-problems:read<br/>**Required permission:** environment:roles:manage-security-problems
|
|
361
361
|
* @returns Success. The response contains the list of vulnerable functions.
|
|
362
362
|
*/
|
|
363
363
|
getVulnerableFunctions(config: {
|
|
@@ -389,7 +389,7 @@ export declare class SecurityProblemsClient {
|
|
|
389
389
|
/**
|
|
390
390
|
* Mutes a security problem
|
|
391
391
|
*
|
|
392
|
-
* **Required scope:** environment-api:security-problems:write
|
|
392
|
+
* **Required scope:** environment-api:security-problems:write<br/>**Required permission:** environment:roles:manage-security-problems
|
|
393
393
|
*/
|
|
394
394
|
muteSecurityProblem(config: {
|
|
395
395
|
body: SecurityProblemMute;
|
|
@@ -399,7 +399,7 @@ export declare class SecurityProblemsClient {
|
|
|
399
399
|
/**
|
|
400
400
|
* Sets the mute state of a remediation item | maturity=EARLY_ADOPTER
|
|
401
401
|
*
|
|
402
|
-
* **Required scope:** environment-api:security-problems:write
|
|
402
|
+
* **Required scope:** environment-api:security-problems:write<br/>**Required permission:** environment:roles:manage-security-problems
|
|
403
403
|
*/
|
|
404
404
|
setRemediationItemMuteState(config: {
|
|
405
405
|
body: RemediationItemMuteStateChange;
|
|
@@ -410,7 +410,7 @@ export declare class SecurityProblemsClient {
|
|
|
410
410
|
/**
|
|
411
411
|
* Un-mutes a security problem
|
|
412
412
|
*
|
|
413
|
-
* **Required scope:** environment-api:security-problems:write
|
|
413
|
+
* **Required scope:** environment-api:security-problems:write<br/>**Required permission:** environment:roles:manage-security-problems
|
|
414
414
|
*/
|
|
415
415
|
unmuteSecurityProblem(config: {
|
|
416
416
|
body: SecurityProblemUnmute;
|
package/types/packages/client/classic-environment-v2/src/lib/apis/service-level-objectives-api.d.ts
CHANGED
|
@@ -22,7 +22,7 @@ export declare class ServiceLevelObjectivesClient {
|
|
|
22
22
|
/**
|
|
23
23
|
* Creates an alert of the provided alert type for an SLO
|
|
24
24
|
*
|
|
25
|
-
* **Required scope:** environment-api:slo:write
|
|
25
|
+
* **Required scope:** environment-api:slo:write<br/>**Required permission:** environment:roles:manage-settings
|
|
26
26
|
*/
|
|
27
27
|
createAlert(config: {
|
|
28
28
|
body: AbstractSloAlertDto;
|
|
@@ -76,7 +76,7 @@ export declare class ServiceLevelObjectivesClient {
|
|
|
76
76
|
/**
|
|
77
77
|
* Lists all available SLOs along with calculated values
|
|
78
78
|
*
|
|
79
|
-
* **Required scope:** environment-api:slo:read<br/><br/>By default the values are calculated for the SLO's own timeframe. You can use a custom timeframe:
|
|
79
|
+
* **Required scope:** environment-api:slo:read<br/>**Required permission:** environment:roles:viewer<br/><br/>By default the values are calculated for the SLO's own timeframe. You can use a custom timeframe:
|
|
80
80
|
*
|
|
81
81
|
* 1. Set the **timeFrame** parameter to `GTF`.
|
|
82
82
|
* 2. Provide the timeframe in **from** and **to** parameters.
|
|
@@ -172,7 +172,7 @@ export declare class ServiceLevelObjectivesClient {
|
|
|
172
172
|
/**
|
|
173
173
|
* Creates a new SLO
|
|
174
174
|
*
|
|
175
|
-
* **Required scope:** environment-api:slo:write
|
|
175
|
+
* **Required scope:** environment-api:slo:write<br/>**Required permission:** environment:roles:manage-settings
|
|
176
176
|
*/
|
|
177
177
|
createSlo(config: {
|
|
178
178
|
body: SloConfigItemDtoImpl;
|
|
@@ -181,7 +181,7 @@ export declare class ServiceLevelObjectivesClient {
|
|
|
181
181
|
/**
|
|
182
182
|
* Gets parameters and calculated values of a specific SLO
|
|
183
183
|
*
|
|
184
|
-
* **Required scope:** environment-api:slo:read<br/><br/>If **from** and **to** parameters are provided, the SLO is calculated for that timeframe; otherwise the SLO's own timeframe is used.
|
|
184
|
+
* **Required scope:** environment-api:slo:read<br/>**Required permission:** environment:roles:viewer<br/><br/>If **from** and **to** parameters are provided, the SLO is calculated for that timeframe; otherwise the SLO's own timeframe is used.
|
|
185
185
|
* @returns Success. The response contains the parameters and calculated values of the requested SLO.
|
|
186
186
|
*/
|
|
187
187
|
getSloById(config: {
|
|
@@ -235,7 +235,7 @@ export declare class ServiceLevelObjectivesClient {
|
|
|
235
235
|
/**
|
|
236
236
|
* Updates an existing SLO
|
|
237
237
|
*
|
|
238
|
-
* **Required scope:** environment-api:slo:write
|
|
238
|
+
* **Required scope:** environment-api:slo:write<br/>**Required permission:** environment:roles:manage-settings
|
|
239
239
|
*/
|
|
240
240
|
updateSloById(config: {
|
|
241
241
|
body: SloConfigItemDtoImpl;
|
|
@@ -245,7 +245,7 @@ export declare class ServiceLevelObjectivesClient {
|
|
|
245
245
|
/**
|
|
246
246
|
* Deletes an SLO
|
|
247
247
|
*
|
|
248
|
-
* **Required scope:** environment-api:slo:write
|
|
248
|
+
* **Required scope:** environment-api:slo:write<br/>**Required permission:** environment:roles:manage-settings
|
|
249
249
|
*/
|
|
250
250
|
deleteSlo(config: {
|
|
251
251
|
id: string;
|
|
@@ -12,7 +12,7 @@ export declare class SyntheticHttpMonitorExecutionsClient {
|
|
|
12
12
|
/**
|
|
13
13
|
* Gets detailed information about the last execution of the specified HTTP monitor | maturity=EARLY_ADOPTER
|
|
14
14
|
*
|
|
15
|
-
* **Required scope:** environment-api:synthetic-execution:read
|
|
15
|
+
* **Required scope:** environment-api:synthetic-execution:read<br/>**Required permission:** environment:roles:viewer
|
|
16
16
|
* @returns Success. The response contains detailed data.
|
|
17
17
|
*/
|
|
18
18
|
getExecutionResult(config: {
|
|
@@ -12,14 +12,14 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
|
|
|
12
12
|
/**
|
|
13
13
|
* Gets set of synthetic related parameters defined for whole tenant (affects all monitors and all private locations). | maturity=EARLY_ADOPTER
|
|
14
14
|
*
|
|
15
|
-
* **Required scope:** environment-api:synthetic:read
|
|
15
|
+
* **Required scope:** environment-api:synthetic:read<br/>**Required permission:** environment:roles:manage-settings
|
|
16
16
|
* @returns Success. The response contains synthetic related parameters defined for whole tenant.
|
|
17
17
|
*/
|
|
18
18
|
getConfiguration(abortSignal?: AbortSignal): Promise<SyntheticConfigDto>;
|
|
19
19
|
/**
|
|
20
20
|
* Updates set of synthetic related parameters defined for whole tenant (affects all monitors and all private locations). | maturity=EARLY_ADOPTER
|
|
21
21
|
*
|
|
22
|
-
* **Required scope:** environment-api:synthetic:write
|
|
22
|
+
* **Required scope:** environment-api:synthetic:write<br/>**Required permission:** environment:roles:manage-settings
|
|
23
23
|
* @returns Success. The set of synthetic related parameters has been updated. Response doesn't have a body.
|
|
24
24
|
*/
|
|
25
25
|
updateConfiguration(config: {
|
|
@@ -29,14 +29,14 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
|
|
|
29
29
|
/**
|
|
30
30
|
* Checks the status of public synthetic locations
|
|
31
31
|
*
|
|
32
|
-
* **Required scope:** environment-api:synthetic:read
|
|
32
|
+
* **Required scope:** environment-api:synthetic:read<br/>**Required permission:** environment:roles:manage-settings
|
|
33
33
|
* @returns Success. The response contains the public locations status.
|
|
34
34
|
*/
|
|
35
35
|
getLocationsStatus(abortSignal?: AbortSignal): Promise<SyntheticPublicLocationsStatus>;
|
|
36
36
|
/**
|
|
37
37
|
* Changes the status of public synthetic locations
|
|
38
38
|
*
|
|
39
|
-
* **Required scope:** environment-api:synthetic:write
|
|
39
|
+
* **Required scope:** environment-api:synthetic:write<br/>**Required permission:** environment:roles:manage-settings
|
|
40
40
|
*/
|
|
41
41
|
updateLocationsStatus(config: {
|
|
42
42
|
body: SyntheticPublicLocationsStatus;
|