@dynatrace-sdk/client-classic-environment-v2 1.8.2 → 1.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +28 -0
- package/README.md +1 -1
- package/cjs/index.js +13220 -5134
- package/docs/DOCS.md +803 -210
- package/dynatrace-metadata.json +1 -1
- package/esm/index.js +13225 -5135
- package/package.json +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/attacks-api.d.ts +166 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/business-events-api.d.ts +3 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +14 -3
- package/types/packages/client/classic-environment-v2/src/lib/apis/index.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +15 -3
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts +189 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/problems-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-network-availability-monitors-api.d.ts +12 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/affected-entities.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/affected-entities.transformation.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/affected-entity.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/affected-entity.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-attack-type.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-attack-type.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-entrypoint-payload-item.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-entrypoint-payload-item.transformation.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-entrypoint.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-entrypoint.transformation.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-list.d.ts +24 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-list.transformation.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-request-header.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-request-header.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem-assessment-dto-data-assets.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem-assessment-dto-data-assets.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem-assessment-dto-exposure.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem-assessment-dto-exposure.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem-assessment-dto.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem-assessment-dto.transformation.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem.transformation.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-state.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-state.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-target.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-target.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-technology.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-technology.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack.d.ts +46 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack.transformation.d.ts +31 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attacker-location.d.ts +17 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attacker-location.transformation.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attacker.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attacker.transformation.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/code-level-vulnerability-details-type.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/code-location.d.ts +35 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/code-location.transformation.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/entity-properties.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/entity-properties.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/entrypoint-payload-type.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/entrypoint-payload-type.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/entrypoint-payload.d.ts +15 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/entrypoint-payload.transformation.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/execute-actions-response.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/execute-actions-response.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-assets-dto.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-info.d.ts +6 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-info.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/function-definition.d.ts +27 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/function-definition.transformation.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/http-protocol-details.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/http-protocol-details.transformation.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/http-request-parameter.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/http-request-parameter.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +66 -8
- package/types/packages/client/classic-environment-v2/src/lib/models/monitor-request-execution-result.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitor-request-execution-result.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-state.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/private-synthetic-location.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/private-synthetic-location.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/protocol-details.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/protocol-details.transformation.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-assessment-assessment-accuracy.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-assessment-assessment-accuracy.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-assessment.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-assessment.transformation.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/request-information.d.ts +19 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/request-information.transformation.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-assessment-accuracy.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-assessment-accuracy.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/security-context-dto-impl.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-context-dto-impl.transformation.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-context-result-dto.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-context-result-dto.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto.d.ts +2 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto.transformation.d.ts +2 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.d.ts +0 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.transformation.d.ts +0 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.d.ts +0 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.transformation.d.ts +0 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-request-configuration-dto.d.ts +0 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-request-configuration-dto.transformation.d.ts +0 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-private-location-update.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-private-location-update.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-attack-request-header.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-attack-request-header.transformation.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-http-request-parameter.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-http-request-parameter.transformation.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-string.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-string.transformation.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/truncation-info.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/truncation-info.transformation.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/vulnerability.d.ts +19 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/vulnerability.transformation.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-input-type.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto-type.d.ts +0 -8
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto-type.transformation.d.ts +0 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto-properties.d.ts +0 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto-properties.transformation.d.ts +0 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto-properties.d.ts +0 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto-properties.transformation.d.ts +0 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-request-configuration-dto-properties.d.ts +0 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-request-configuration-dto-properties.transformation.d.ts +0 -6
package/package.json
CHANGED
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
|
|
2
|
+
import { Attack } from '../models/attack';
|
|
3
|
+
import { AttackList } from '../models/attack-list';
|
|
4
|
+
/**
|
|
5
|
+
* Read attacks
|
|
6
|
+
*/
|
|
7
|
+
export declare class AttacksClient {
|
|
8
|
+
private httpClient;
|
|
9
|
+
/**
|
|
10
|
+
* @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a AttacksClient. Custom http client should implement {HttpClient} interface.
|
|
11
|
+
* @example
|
|
12
|
+
* const attacksClientNodeJs = new AttacksClient(yourCustomImplementation);
|
|
13
|
+
*/
|
|
14
|
+
constructor(httpClientImplementation: HttpClient);
|
|
15
|
+
/**
|
|
16
|
+
* Lists all attacks
|
|
17
|
+
*
|
|
18
|
+
* **Required scope:** environment-api:attacks:read<br/>**One of the following permissions is required:**
|
|
19
|
+
* + environment:roles:manage-security-problems
|
|
20
|
+
* + environment:roles:view-security-problems
|
|
21
|
+
*
|
|
22
|
+
* @returns Success
|
|
23
|
+
*
|
|
24
|
+
* @example <caption>Code example</caption>
|
|
25
|
+
* import { attacksClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
26
|
+
*
|
|
27
|
+
* const data = await attacksClient.getAttacks();
|
|
28
|
+
*/
|
|
29
|
+
getAttacks(config?: {
|
|
30
|
+
/**
|
|
31
|
+
* The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
|
|
32
|
+
*
|
|
33
|
+
* The first page is always returned if you don't specify the **nextPageKey** query parameter.
|
|
34
|
+
*
|
|
35
|
+
* When the **nextPageKey** is set to obtain subsequent pages, you must omit all other query parameters.
|
|
36
|
+
*/ nextPageKey?: string;
|
|
37
|
+
/**
|
|
38
|
+
* The amount of attacks in a single response payload.
|
|
39
|
+
*
|
|
40
|
+
* The maximal allowed page size is 500.
|
|
41
|
+
*
|
|
42
|
+
* If not set, 100 is used.
|
|
43
|
+
*/ pageSize?: number;
|
|
44
|
+
/**
|
|
45
|
+
* Defines the scope of the query. Only attacks matching the specified criteria are included in the response. You can add one or more of the following criteria. Values are *not* case-sensitive and the `EQUALS` operator is used unless otherwise specified.
|
|
46
|
+
*
|
|
47
|
+
* * State: `state("value")`. The state of the attack. Possible values are `EXPLOITED`, `BLOCKED`, and `ALLOWLISTED`.
|
|
48
|
+
* * Attack Type: `attackType("value")`. The type of the attack. Find the possible values in the description of the **attackType** field of the response.
|
|
49
|
+
* * Country Code: `countryCode("value")`. The country code of the attacker. Supported values include all ISO-3166-1 alpha-2 country codes (2-letter). Supplying empty filter value `countryCode()` will return attacks, where location is not available.
|
|
50
|
+
* * Request path contains: `requestPathContains("value")`. Filters for a substring in the request path. The `CONTAINS` operator is used. A maximum of 48 characters are allowed.
|
|
51
|
+
* * Process group name contains: `processGroupNameContains("value")`. Filters for a substring in the targeted process group's name. The `CONTAINS` operator is used.
|
|
52
|
+
* * Vulnerability ID: `vulnerabilityId("123456789")`. The exact ID of the vulnerability.
|
|
53
|
+
* * Source IPs: `sourceIps("93.184.216.34", "63.124.6.12")`. The exact IPv4/IPv6 addresses of the attacker.
|
|
54
|
+
* * Management zone ID: `managementZoneIds("mzId-1", "mzId-2")`.
|
|
55
|
+
* * Management zone name: `managementZones("name-1", "name-2")`. Values are case sensitive.
|
|
56
|
+
* * Technology: `technology("technology-1", "technology-2")`. Find the possible values in the description of the **technology** field of the response. The `EQUALS` operator is used.
|
|
57
|
+
*
|
|
58
|
+
* To set several criteria, separate them with a comma (`,`). Only results matching (**all** criteria are included in the response.
|
|
59
|
+
*
|
|
60
|
+
* Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (`~`) inside quotes:
|
|
61
|
+
* * Tilde `~`
|
|
62
|
+
* * Quote `"`
|
|
63
|
+
*/ attackSelector?: string;
|
|
64
|
+
/**
|
|
65
|
+
* Specifies one or more fields for sorting the attack list. Multiple fields can be concatenated using a comma (`,`) as a separator (e.g. `+state,-timestamp`).
|
|
66
|
+
*
|
|
67
|
+
* You can sort by the following properties with a sign prefix for the sorting order.
|
|
68
|
+
*
|
|
69
|
+
* * `displayId`: The attack's display ID.
|
|
70
|
+
* * `displayName`: The attack's display name.
|
|
71
|
+
* * `attackType`: The type of the attack (e.g. SQL_INJECTION, JNDI_INJECTION, etc.).
|
|
72
|
+
* * `state`: The state of the attack. (`+` low severity state first `-` high severity state first)
|
|
73
|
+
* * `sourceIp`: The IP address of the attacker. Sorts by the numerical IP value.
|
|
74
|
+
* * `requestPath`: The request path where the attack was started.
|
|
75
|
+
* * `timestamp`: When the attack was executed. (`+` old attacks first or `-` new attacks first)
|
|
76
|
+
* If no prefix is set, `+` is used.
|
|
77
|
+
*/ sort?: string;
|
|
78
|
+
/**
|
|
79
|
+
* A list of additional attack properties you can add to the response.
|
|
80
|
+
*
|
|
81
|
+
* The following properties are available (all other properties are always included and you can't remove them from the response):
|
|
82
|
+
*
|
|
83
|
+
* * `attackTarget`: The targeted host/database of an attack.
|
|
84
|
+
* * `request`: The request that was sent from the attacker.
|
|
85
|
+
* * `entrypoint`: The entry point used by an attacker to start a specific attack.
|
|
86
|
+
* * `vulnerability`: The vulnerability utilized by the attack.
|
|
87
|
+
* * `securityProblem`: The related security problem.
|
|
88
|
+
* * `attacker`: The attacker of an attack.
|
|
89
|
+
* * `managementZones`: The related management zones.
|
|
90
|
+
* * `affectedEntities`: The affected entities of an attack.
|
|
91
|
+
*
|
|
92
|
+
* To add properties, specify them in a comma-separated list and prefix each property with a plus (for example, `+attackTarget,+securityProblem`).
|
|
93
|
+
*/ fields?: string;
|
|
94
|
+
/**
|
|
95
|
+
* The start of the requested timeframe.
|
|
96
|
+
*
|
|
97
|
+
* You can use one of the following formats:
|
|
98
|
+
* * Timestamp in UTC milliseconds.
|
|
99
|
+
* * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
|
|
100
|
+
* * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
|
|
101
|
+
* You can also specify relative timeframe without an alignment: `now-NU`.
|
|
102
|
+
* Supported time units for the relative timeframe are:
|
|
103
|
+
* * `m`: minutes
|
|
104
|
+
* * `h`: hours
|
|
105
|
+
* * `d`: days
|
|
106
|
+
* * `w`: weeks
|
|
107
|
+
* * `M`: months
|
|
108
|
+
* * `y`: years
|
|
109
|
+
*
|
|
110
|
+
* If not set, the relative timeframe of thirty days is used (`now-30d`).
|
|
111
|
+
*/ from?: string;
|
|
112
|
+
/**
|
|
113
|
+
* The end of the requested timeframe.
|
|
114
|
+
*
|
|
115
|
+
* You can use one of the following formats:
|
|
116
|
+
* * Timestamp in UTC milliseconds.
|
|
117
|
+
* * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
|
|
118
|
+
* * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
|
|
119
|
+
* You can also specify relative timeframe without an alignment: `now-NU`.
|
|
120
|
+
* Supported time units for the relative timeframe are:
|
|
121
|
+
* * `m`: minutes
|
|
122
|
+
* * `h`: hours
|
|
123
|
+
* * `d`: days
|
|
124
|
+
* * `w`: weeks
|
|
125
|
+
* * `M`: months
|
|
126
|
+
* * `y`: years
|
|
127
|
+
*
|
|
128
|
+
* If not set, the current timestamp is used.
|
|
129
|
+
*/ to?: string;
|
|
130
|
+
abortSignal?: AbortSignal;
|
|
131
|
+
}): Promise<AttackList>;
|
|
132
|
+
/**
|
|
133
|
+
* Gets the specified attack
|
|
134
|
+
*
|
|
135
|
+
* **Required scope:** environment-api:attacks:read<br/>**One of the following permissions is required:**
|
|
136
|
+
* + environment:roles:manage-security-problems
|
|
137
|
+
* + environment:roles:view-security-problems
|
|
138
|
+
*
|
|
139
|
+
* @returns Success
|
|
140
|
+
*
|
|
141
|
+
* @example <caption>Code example</caption>
|
|
142
|
+
* import { attacksClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
143
|
+
*
|
|
144
|
+
* const data = await attacksClient.getAttack({ id: "..." });
|
|
145
|
+
*/
|
|
146
|
+
getAttack(config: {
|
|
147
|
+
/** The ID of the attack. */ id: string;
|
|
148
|
+
/**
|
|
149
|
+
* A list of additional attack properties you can add to the response.
|
|
150
|
+
*
|
|
151
|
+
* The following properties are available (all other properties are always included and you can't remove them from the response):
|
|
152
|
+
*
|
|
153
|
+
* * `attackTarget`: The targeted host/database of an attack.
|
|
154
|
+
* * `request`: The request that was sent from the attacker.
|
|
155
|
+
* * `entrypoint`: The entry point used by an attacker to start a specific attack.
|
|
156
|
+
* * `vulnerability`: The vulnerability utilized by the attack.
|
|
157
|
+
* * `securityProblem`: The related security problem.
|
|
158
|
+
* * `attacker`: The attacker of an attack.
|
|
159
|
+
* * `managementZones`: The related management zones.
|
|
160
|
+
*
|
|
161
|
+
* To add properties, specify them in a comma-separated list and prefix each property with a plus (for example, `+attackTarget,+securityProblem`).
|
|
162
|
+
*/ fields?: string;
|
|
163
|
+
abortSignal?: AbortSignal;
|
|
164
|
+
}): Promise<Attack>;
|
|
165
|
+
}
|
|
166
|
+
export declare const attacksClient: AttacksClient;
|
|
@@ -12,7 +12,9 @@ export declare class BusinessEventsClient {
|
|
|
12
12
|
/**
|
|
13
13
|
* Ingests a business event
|
|
14
14
|
*
|
|
15
|
-
* **Required scope:** storage:events:write<br/>**Required permission:** storage:events:write<br/><br/>The
|
|
15
|
+
* **Required scope:** storage:events:write<br/>**Required permission:** storage:events:write<br/><br/>The maximum payload size of a single request is **5 MiB**. Requests with a greater payload are rejected, and the API returns a 413 response code.
|
|
16
|
+
*
|
|
17
|
+
* The ingestion of business events is subject to licensing (see [licensing documentation](https://www.dynatrace.com/support/help/shortlink/dps-events)).
|
|
16
18
|
*
|
|
17
19
|
* @returns The provided business events are all accepted and will be processed.
|
|
18
20
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
|
|
1
|
+
import { AbortSignal, HttpClient, Binary } from '@dynatrace-sdk/http-client';
|
|
2
2
|
import { ActiveGateGroupsInfoDto } from '../models/active-gate-groups-info-dto';
|
|
3
3
|
import { ErrorEnvelope } from '../models/error-envelope';
|
|
4
4
|
import { ExecuteActionsDto } from '../models/execute-actions-dto';
|
|
@@ -157,8 +157,13 @@ export declare class Extensions_2_0Client {
|
|
|
157
157
|
listSchemaFiles(config: {
|
|
158
158
|
/** The version of the schema. */ schemaVersion: string;
|
|
159
159
|
abortSignal?: AbortSignal;
|
|
160
|
-
acceptType: 'application/json; charset=utf-8'
|
|
160
|
+
acceptType: 'application/json; charset=utf-8';
|
|
161
161
|
}): Promise<SchemaFiles>;
|
|
162
|
+
listSchemaFiles(config: {
|
|
163
|
+
/** The version of the schema. */ schemaVersion: string;
|
|
164
|
+
abortSignal?: AbortSignal;
|
|
165
|
+
acceptType: 'application/octet-stream';
|
|
166
|
+
}): Promise<Binary>;
|
|
162
167
|
/**
|
|
163
168
|
* Gets the extension 2.0 schema file in the specified version
|
|
164
169
|
*
|
|
@@ -690,8 +695,14 @@ export declare class Extensions_2_0Client {
|
|
|
690
695
|
/** The name of the requested extension 2.0. */ extensionName: string;
|
|
691
696
|
/** The version of the requested extension 2.0 */ extensionVersion: string;
|
|
692
697
|
abortSignal?: AbortSignal;
|
|
693
|
-
acceptType: 'application/json; charset=utf-8'
|
|
698
|
+
acceptType: 'application/json; charset=utf-8';
|
|
694
699
|
}): Promise<Extension>;
|
|
700
|
+
extensionDetails(config: {
|
|
701
|
+
/** The name of the requested extension 2.0. */ extensionName: string;
|
|
702
|
+
/** The version of the requested extension 2.0 */ extensionVersion: string;
|
|
703
|
+
abortSignal?: AbortSignal;
|
|
704
|
+
acceptType: 'application/octet-stream';
|
|
705
|
+
}): Promise<Binary>;
|
|
695
706
|
/**
|
|
696
707
|
* Deletes the specified version of the extension 2.0
|
|
697
708
|
*
|
|
@@ -4,6 +4,7 @@ export * from './access-tokens-tenant-tokens-api';
|
|
|
4
4
|
export * from './active-gates-api';
|
|
5
5
|
export * from './active-gates-auto-update-configuration-api';
|
|
6
6
|
export * from './active-gates-auto-update-jobs-api';
|
|
7
|
+
export * from './attacks-api';
|
|
7
8
|
export * from './audit-logs-api';
|
|
8
9
|
export * from './business-events-api';
|
|
9
10
|
export * from './credential-vault-api';
|
|
@@ -19,7 +19,11 @@ export declare class LogsClient {
|
|
|
19
19
|
/**
|
|
20
20
|
* Gets aggregated log records | maturity=EARLY_ADOPTER
|
|
21
21
|
*
|
|
22
|
-
* **Required scope:** storage:logs:read<br/>**
|
|
22
|
+
* **Required scope:** storage:logs:read<br/>**One of the following permissions is required:**
|
|
23
|
+
* + environment:roles:logviewer
|
|
24
|
+
* + storage:logs:read
|
|
25
|
+
*
|
|
26
|
+
* <br/><br/>Returns the aggregated number of occurrences of log values divided into time slots.
|
|
23
27
|
*
|
|
24
28
|
* 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.
|
|
25
29
|
*
|
|
@@ -106,7 +110,11 @@ export declare class LogsClient {
|
|
|
106
110
|
/**
|
|
107
111
|
* Exports log records | maturity=EARLY_ADOPTER
|
|
108
112
|
*
|
|
109
|
-
* **Required scope:** storage:logs:read<br/>**
|
|
113
|
+
* **Required scope:** storage:logs:read<br/>**One of the following permissions is required:**
|
|
114
|
+
* + environment:roles:logviewer
|
|
115
|
+
* + storage:logs:read
|
|
116
|
+
*
|
|
117
|
+
* <br/><br/>Returns the first *X* records (specified in the **pageSize** query parameter).
|
|
110
118
|
*
|
|
111
119
|
* 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.
|
|
112
120
|
*
|
|
@@ -267,7 +275,11 @@ export declare class LogsClient {
|
|
|
267
275
|
/**
|
|
268
276
|
* Reads log records | maturity=EARLY_ADOPTER
|
|
269
277
|
*
|
|
270
|
-
* **Required scope:** storage:logs:read<br/>**
|
|
278
|
+
* **Required scope:** storage:logs:read<br/>**One of the following permissions is required:**
|
|
279
|
+
* + environment:roles:logviewer
|
|
280
|
+
* + storage:logs:read
|
|
281
|
+
*
|
|
282
|
+
* <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.
|
|
271
283
|
*
|
|
272
284
|
* If the query is too large to be processed in a single request, it is divided into slices (slices are unsupported on *Log Management and Analytics, powered by Grail*). 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.
|
|
273
285
|
*
|
package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts
CHANGED
|
@@ -5,6 +5,8 @@ import { EntitiesList } from '../models/entities-list';
|
|
|
5
5
|
import { Entity } from '../models/entity';
|
|
6
6
|
import { EntityType } from '../models/entity-type';
|
|
7
7
|
import { EntityTypeList } from '../models/entity-type-list';
|
|
8
|
+
import { SecurityContextDtoImpl } from '../models/security-context-dto-impl';
|
|
9
|
+
import { SecurityContextResultDto } from '../models/security-context-result-dto';
|
|
8
10
|
/**
|
|
9
11
|
* Manage monitored entities
|
|
10
12
|
*/
|
|
@@ -160,6 +162,193 @@ export declare class MonitoredEntitiesClient {
|
|
|
160
162
|
body: CustomDeviceCreation;
|
|
161
163
|
abortSignal?: AbortSignal;
|
|
162
164
|
}): Promise<CustomDeviceCreationResult | void>;
|
|
165
|
+
/**
|
|
166
|
+
* Sets the given security context for all entities matching the entity selector.
|
|
167
|
+
*
|
|
168
|
+
* **Required scope:** settings:objects:write<br/>**One of the following permissions is required:**
|
|
169
|
+
* + environment:roles:manage-settings
|
|
170
|
+
* + settings:objects:write
|
|
171
|
+
*
|
|
172
|
+
* <br/><br/>Matching entities will have a management zone assigned, if the given security context matches the name of an already existing management zone.
|
|
173
|
+
* This endpoint does not create a new management zone, if there is no management zone with the provided name.
|
|
174
|
+
* Automatic management zone rules will not apply to entities with a set security context. It will need to be removed, to have them apply again.
|
|
175
|
+
*
|
|
176
|
+
* @returns Success
|
|
177
|
+
*
|
|
178
|
+
* @example <caption>Code example</caption>
|
|
179
|
+
* import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
180
|
+
*
|
|
181
|
+
* const data =
|
|
182
|
+
* await monitoredEntitiesClient.setSecurityContext({
|
|
183
|
+
* body: {},
|
|
184
|
+
* });
|
|
185
|
+
*/
|
|
186
|
+
setSecurityContext(config: {
|
|
187
|
+
body: SecurityContextDtoImpl;
|
|
188
|
+
/**
|
|
189
|
+
* Defines the scope of the entities to set the security context for. Only entities that can have management zones are considered for this operation
|
|
190
|
+
*
|
|
191
|
+
* You must set one of these criteria:
|
|
192
|
+
*
|
|
193
|
+
* * Entity type: `type("TYPE")`
|
|
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.
|
|
195
|
+
*
|
|
196
|
+
* You can add one or more of the following criteria. Values are case-sensitive and the `EQUALS` operator is used unless otherwise specified.
|
|
197
|
+
*
|
|
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.
|
|
199
|
+
* * Management zone ID: `mzId(123)`
|
|
200
|
+
* * Management zone name: `mzName("value")`
|
|
201
|
+
* * Entity name:
|
|
202
|
+
* * `entityName.equals`: performs a non-casesensitive `EQUALS` query.
|
|
203
|
+
* * `entityName.startsWith`: changes the operator to `BEGINS WITH`.
|
|
204
|
+
* * `entityName.in`: enables you to provide multiple values. The `EQUALS` operator applies.
|
|
205
|
+
* * `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an argument and makes the value case-sensitive.
|
|
206
|
+
* * Health state (HEALTHY,UNHEALTHY): `healthState("HEALTHY")`
|
|
207
|
+
* * First seen timestamp: `firstSeenTms.<operator>(now-3h)`. Use any timestamp format from the **from** /**to** parameters.
|
|
208
|
+
* The following operators are available:
|
|
209
|
+
* * `lte`: earlier than or at the specified time
|
|
210
|
+
* * `lt`: earlier than the specified time
|
|
211
|
+
* * `gte`: later than or at the specified time
|
|
212
|
+
* * `gt`: later than the specified time
|
|
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.
|
|
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.
|
|
215
|
+
* * Negation: `not(<criterion>)`. Inverts any criterion except for **type**.
|
|
216
|
+
*
|
|
217
|
+
* For more information, see [Entity selector](https://dt-url.net/apientityselector) in Dynatrace Documentation.
|
|
218
|
+
*
|
|
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.
|
|
220
|
+
*
|
|
221
|
+
* The maximum string length is 2,000 characters.
|
|
222
|
+
*/ entitySelector?: string;
|
|
223
|
+
/**
|
|
224
|
+
* The start of the requested timeframe.
|
|
225
|
+
*
|
|
226
|
+
* You can use one of the following formats:
|
|
227
|
+
* * Timestamp in UTC milliseconds.
|
|
228
|
+
* * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
|
|
229
|
+
* * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
|
|
230
|
+
* You can also specify relative timeframe without an alignment: `now-NU`.
|
|
231
|
+
* Supported time units for the relative timeframe are:
|
|
232
|
+
* * `m`: minutes
|
|
233
|
+
* * `h`: hours
|
|
234
|
+
* * `d`: days
|
|
235
|
+
* * `w`: weeks
|
|
236
|
+
* * `M`: months
|
|
237
|
+
* * `y`: years
|
|
238
|
+
*
|
|
239
|
+
* If not set, the relative timeframe of three days is used (`now-3d`).
|
|
240
|
+
*/ from?: string;
|
|
241
|
+
/**
|
|
242
|
+
* The end of the requested timeframe.
|
|
243
|
+
*
|
|
244
|
+
* You can use one of the following formats:
|
|
245
|
+
* * Timestamp in UTC milliseconds.
|
|
246
|
+
* * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
|
|
247
|
+
* * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
|
|
248
|
+
* You can also specify relative timeframe without an alignment: `now-NU`.
|
|
249
|
+
* Supported time units for the relative timeframe are:
|
|
250
|
+
* * `m`: minutes
|
|
251
|
+
* * `h`: hours
|
|
252
|
+
* * `d`: days
|
|
253
|
+
* * `w`: weeks
|
|
254
|
+
* * `M`: months
|
|
255
|
+
* * `y`: years
|
|
256
|
+
*
|
|
257
|
+
* If not set, the current timestamp is used.
|
|
258
|
+
*/ to?: string;
|
|
259
|
+
abortSignal?: AbortSignal;
|
|
260
|
+
}): Promise<SecurityContextResultDto>;
|
|
261
|
+
/**
|
|
262
|
+
* Deletes the security context for all entities matching the entity selector.
|
|
263
|
+
*
|
|
264
|
+
* **Required scope:** settings:objects:write<br/>**One of the following permissions is required:**
|
|
265
|
+
* + environment:roles:manage-settings
|
|
266
|
+
* + settings:objects:write
|
|
267
|
+
*
|
|
268
|
+
* <br/><br/>Automatic management zone rules will apply again to entities without a security context.
|
|
269
|
+
*
|
|
270
|
+
* @returns Success
|
|
271
|
+
*
|
|
272
|
+
* @example <caption>Code example</caption>
|
|
273
|
+
* import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
274
|
+
*
|
|
275
|
+
* const data =
|
|
276
|
+
* await monitoredEntitiesClient.deleteSecurityContext();
|
|
277
|
+
*/
|
|
278
|
+
deleteSecurityContext(config?: {
|
|
279
|
+
/**
|
|
280
|
+
* Defines the scope of the entities to set the security context for. Only entities that can have management zones are considered for this operation
|
|
281
|
+
*
|
|
282
|
+
* You must set one of these criteria:
|
|
283
|
+
*
|
|
284
|
+
* * Entity type: `type("TYPE")`
|
|
285
|
+
* * 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.
|
|
286
|
+
*
|
|
287
|
+
* You can add one or more of the following criteria. Values are case-sensitive and the `EQUALS` operator is used unless otherwise specified.
|
|
288
|
+
*
|
|
289
|
+
* * 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.
|
|
290
|
+
* * Management zone ID: `mzId(123)`
|
|
291
|
+
* * Management zone name: `mzName("value")`
|
|
292
|
+
* * Entity name:
|
|
293
|
+
* * `entityName.equals`: performs a non-casesensitive `EQUALS` query.
|
|
294
|
+
* * `entityName.startsWith`: changes the operator to `BEGINS WITH`.
|
|
295
|
+
* * `entityName.in`: enables you to provide multiple values. The `EQUALS` operator applies.
|
|
296
|
+
* * `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an argument and makes the value case-sensitive.
|
|
297
|
+
* * Health state (HEALTHY,UNHEALTHY): `healthState("HEALTHY")`
|
|
298
|
+
* * First seen timestamp: `firstSeenTms.<operator>(now-3h)`. Use any timestamp format from the **from** /**to** parameters.
|
|
299
|
+
* The following operators are available:
|
|
300
|
+
* * `lte`: earlier than or at the specified time
|
|
301
|
+
* * `lt`: earlier than the specified time
|
|
302
|
+
* * `gte`: later than or at the specified time
|
|
303
|
+
* * `gt`: later than the specified time
|
|
304
|
+
* * 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.
|
|
305
|
+
* * 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.
|
|
306
|
+
* * Negation: `not(<criterion>)`. Inverts any criterion except for **type**.
|
|
307
|
+
*
|
|
308
|
+
* For more information, see [Entity selector](https://dt-url.net/apientityselector) in Dynatrace Documentation.
|
|
309
|
+
*
|
|
310
|
+
* 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.
|
|
311
|
+
*
|
|
312
|
+
* The maximum string length is 2,000 characters.
|
|
313
|
+
*/ entitySelector?: string;
|
|
314
|
+
/**
|
|
315
|
+
* The start of the requested timeframe.
|
|
316
|
+
*
|
|
317
|
+
* You can use one of the following formats:
|
|
318
|
+
* * Timestamp in UTC milliseconds.
|
|
319
|
+
* * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
|
|
320
|
+
* * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
|
|
321
|
+
* You can also specify relative timeframe without an alignment: `now-NU`.
|
|
322
|
+
* Supported time units for the relative timeframe are:
|
|
323
|
+
* * `m`: minutes
|
|
324
|
+
* * `h`: hours
|
|
325
|
+
* * `d`: days
|
|
326
|
+
* * `w`: weeks
|
|
327
|
+
* * `M`: months
|
|
328
|
+
* * `y`: years
|
|
329
|
+
*
|
|
330
|
+
* If not set, the relative timeframe of three days is used (`now-3d`).
|
|
331
|
+
*/ from?: string;
|
|
332
|
+
/**
|
|
333
|
+
* The end of the requested timeframe.
|
|
334
|
+
*
|
|
335
|
+
* You can use one of the following formats:
|
|
336
|
+
* * Timestamp in UTC milliseconds.
|
|
337
|
+
* * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
|
|
338
|
+
* * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
|
|
339
|
+
* You can also specify relative timeframe without an alignment: `now-NU`.
|
|
340
|
+
* Supported time units for the relative timeframe are:
|
|
341
|
+
* * `m`: minutes
|
|
342
|
+
* * `h`: hours
|
|
343
|
+
* * `d`: days
|
|
344
|
+
* * `w`: weeks
|
|
345
|
+
* * `M`: months
|
|
346
|
+
* * `y`: years
|
|
347
|
+
*
|
|
348
|
+
* If not set, the current timestamp is used.
|
|
349
|
+
*/ to?: string;
|
|
350
|
+
abortSignal?: AbortSignal;
|
|
351
|
+
}): Promise<SecurityContextResultDto>;
|
|
163
352
|
/**
|
|
164
353
|
* Gets the properties of the specified monitored entity
|
|
165
354
|
*
|
|
@@ -199,7 +199,7 @@ export declare class ProblemsClient {
|
|
|
199
199
|
/**
|
|
200
200
|
* Closes the specified problem and adds a closing comment on it
|
|
201
201
|
*
|
|
202
|
-
* **Required scope:** environment-api:problems:write<br/>**Required permission:** environment:roles:
|
|
202
|
+
* **Required scope:** environment-api:problems:write<br/>**Required permission:** environment:roles:viewer
|
|
203
203
|
*
|
|
204
204
|
* @returns Success
|
|
205
205
|
*
|
|
@@ -133,10 +133,10 @@ export declare class SettingsObjectsClient {
|
|
|
133
133
|
* * `modified`
|
|
134
134
|
* * `createdBy`
|
|
135
135
|
* * `modifiedBy`
|
|
136
|
-
* * `author`
|
|
136
|
+
* * `author` (deprecated, will not work for future schemas)
|
|
137
137
|
* * `value` with properties and sub-properties separated by dot (for example, `value.owningApp = 'Notebooks'`)
|
|
138
138
|
*
|
|
139
|
-
* If this parameter is omitted, all settings objects will be returned. The maximum nesting depth (via parentheses) is 5. The maximum expression length is
|
|
139
|
+
* If this parameter is omitted, all settings objects will be returned. The maximum nesting depth (via parentheses) is 5. The maximum expression length is 1000 characters.
|
|
140
140
|
*
|
|
141
141
|
* Note that only fields included to the response via `fields` can be used for filtering.
|
|
142
142
|
*/ filter?: string;
|
|
@@ -148,7 +148,7 @@ export declare class SettingsObjectsClient {
|
|
|
148
148
|
* * `modified`
|
|
149
149
|
* * `createdBy`
|
|
150
150
|
* * `modifiedBy`
|
|
151
|
-
* * `author`
|
|
151
|
+
* * `author` (deprecated, will not work for future schemas)
|
|
152
152
|
* * `value` with properties and sub-properties separated by dot (for example, `value.owningApp`)
|
|
153
153
|
*
|
|
154
154
|
* Note that only fields included to the response via `fields` can be used for sorting.
|
|
@@ -29,10 +29,19 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
|
|
|
29
29
|
*/
|
|
30
30
|
getMonitors(config?: {
|
|
31
31
|
/**
|
|
32
|
-
*
|
|
32
|
+
* Defines the scope of the query. Only monitors matching the specified criteria are included into response.
|
|
33
33
|
*
|
|
34
|
-
*
|
|
35
|
-
|
|
34
|
+
* You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the **OR** logic applies.
|
|
35
|
+
* * Monitor type: `type(HTTP,MULTI_PROTOCOL)`. Possible values: 'HTTP', 'BROWSER', 'THIRD_PARTY', 'MULTI_PROTOCOL' (Note that only 'MULTI_PROTOCOL' is currently supported).
|
|
36
|
+
* * Management zone ID: `managementZoneId(1, 2)`.
|
|
37
|
+
* * Synthetic Location ME ID: `location(SYNTHETIC_LOCATION-123)`.
|
|
38
|
+
* * Monitored host ME ID: `monitoredEntity(HOST-123)`.
|
|
39
|
+
* * Monitor tags: `tag([context]key:value,key:value,key)`. Tags in `[context]key:value`, `key:value`, and `key` formats are detected and parsed automatically. If a key-only tag has a colon (`:`) in it, you must escape the colon with a backslash(`\`). Otherwise, the tag will be parsed as a `key:value tag`. All tag values are case-sensitive.
|
|
40
|
+
* * Monitor activity: `active(true)`.
|
|
41
|
+
*
|
|
42
|
+
* To set several criteria, separate them with a comma (`,`).
|
|
43
|
+
* Only results matching **all** criteria are included in the response.
|
|
44
|
+
*/ monitorSelector?: string;
|
|
36
45
|
abortSignal?: AbortSignal;
|
|
37
46
|
}): Promise<SyntheticMonitorListDto>;
|
|
38
47
|
/**
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { FormDataRequestBody, FormDataResponseBody } from '@dynatrace-sdk/http-client';
|
|
2
|
+
import { AffectedEntities } from './affected-entities';
|
|
3
|
+
import * as _AffectedEntityTransformation from './affected-entity.transformation';
|
|
4
|
+
export interface AsJson {
|
|
5
|
+
processGroup?: _AffectedEntityTransformation.AsJson;
|
|
6
|
+
processGroupInstance?: _AffectedEntityTransformation.AsJson;
|
|
7
|
+
}
|
|
8
|
+
export declare function fromJson($model: AsJson): AffectedEntities;
|
|
9
|
+
export declare function toJson($model: AffectedEntities): AsJson;
|
|
10
|
+
export declare function fromFormData(formData: FormDataResponseBody): AffectedEntities;
|
|
11
|
+
export declare function toFormData($model: AffectedEntities): FormDataRequestBody;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { EntrypointPayload } from './entrypoint-payload';
|
|
2
|
+
import { TruncationInfo } from './truncation-info';
|
|
3
|
+
/**
|
|
4
|
+
* A list of values that has possibly been truncated.
|
|
5
|
+
*/
|
|
6
|
+
export interface AttackEntrypointPayloadItem {
|
|
7
|
+
truncationInfo?: TruncationInfo;
|
|
8
|
+
/**
|
|
9
|
+
* Values of the list.
|
|
10
|
+
*/
|
|
11
|
+
values?: EntrypointPayload[];
|
|
12
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { AttackEntrypointPayloadItem } from './attack-entrypoint-payload-item';
|
|
2
|
+
import * as _EntrypointPayloadTransformation from './entrypoint-payload.transformation';
|
|
3
|
+
import * as _TruncationInfoTransformation from './truncation-info.transformation';
|
|
4
|
+
export interface AsJson {
|
|
5
|
+
truncationInfo?: _TruncationInfoTransformation.AsJson;
|
|
6
|
+
values?: _EntrypointPayloadTransformation.AsJson[];
|
|
7
|
+
}
|
|
8
|
+
export declare function fromJson($model: AsJson): AttackEntrypointPayloadItem;
|
|
9
|
+
export declare function toJson($model: AttackEntrypointPayloadItem): AsJson;
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { AttackEntrypointPayloadItem } from './attack-entrypoint-payload-item';
|
|
2
|
+
import { CodeLocation } from './code-location';
|
|
3
|
+
import { FunctionDefinition } from './function-definition';
|
|
4
|
+
/**
|
|
5
|
+
* Describes the entrypoint used by an attacker to start a specific attack.
|
|
6
|
+
*/
|
|
7
|
+
export interface AttackEntrypoint {
|
|
8
|
+
codeLocation?: CodeLocation;
|
|
9
|
+
entrypointFunction?: FunctionDefinition;
|
|
10
|
+
/**
|
|
11
|
+
* All relevant payload data that has been sent during the attack.
|
|
12
|
+
*/
|
|
13
|
+
payload?: AttackEntrypointPayloadItem[];
|
|
14
|
+
}
|