@dynatrace-sdk/client-classic-environment-v2 7.0.0 → 9.0.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 +46 -15
- package/README.md +3291 -3134
- package/cjs/index.js +231 -23
- package/dynatrace-metadata.json +2 -2
- package/esm/index.js +231 -23
- package/package.json +1 -1
- package/types/index.d.ts +1158 -52
package/types/index.d.ts
CHANGED
|
@@ -356,7 +356,7 @@ export declare class AccessTokensAgentTokensClient {
|
|
|
356
356
|
export declare const accessTokensAgentTokensClient: AccessTokensAgentTokensClient;
|
|
357
357
|
|
|
358
358
|
/**
|
|
359
|
-
* Manage Dynatrace API tokens
|
|
359
|
+
* Manage Dynatrace API tokens - Deprecated in SaaS, use [platform tokens](https://dt-url.net/platform-tokens) in Account Management instead
|
|
360
360
|
*/
|
|
361
361
|
export declare class AccessTokensApiTokensClient {
|
|
362
362
|
private httpClient;
|
|
@@ -383,6 +383,8 @@ export declare class AccessTokensApiTokensClient {
|
|
|
383
383
|
* 1. Specify the number of results per page in the **pageSize** query parameter.
|
|
384
384
|
* 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
|
|
385
385
|
*
|
|
386
|
+
* @deprecated
|
|
387
|
+
*
|
|
386
388
|
* @returns {Promise<ApiTokenList>} Success
|
|
387
389
|
*
|
|
388
390
|
* @example <caption>Code example</caption>
|
|
@@ -502,6 +504,8 @@ export declare class AccessTokensApiTokensClient {
|
|
|
502
504
|
* If no prefix is set, + is used.
|
|
503
505
|
*
|
|
504
506
|
* If not set, tokens are sorted by creation date with newest first.
|
|
507
|
+
*
|
|
508
|
+
* @defaultValue -creationDate
|
|
505
509
|
*/ sort?: string;
|
|
506
510
|
abortSignal?: AbortSignal_2;
|
|
507
511
|
}): Promise<ApiTokenList>;
|
|
@@ -520,6 +524,8 @@ export declare class AccessTokensApiTokensClient {
|
|
|
520
524
|
*
|
|
521
525
|
* Creating personal access tokens requires the `environment:roles:viewer` permission. Creating access tokens requires the `environment:roles:manage-settings` permission.
|
|
522
526
|
*
|
|
527
|
+
* @deprecated
|
|
528
|
+
*
|
|
523
529
|
* @returns {Promise<ApiTokenCreated>} Success. The token has been created. The body of the response contains the token secret.
|
|
524
530
|
*
|
|
525
531
|
* @example <caption>Code example</caption>
|
|
@@ -550,6 +556,10 @@ export declare class AccessTokensApiTokensClient {
|
|
|
550
556
|
* + environment:roles:viewer
|
|
551
557
|
* + api-tokens:tokens:read
|
|
552
558
|
*
|
|
559
|
+
*
|
|
560
|
+
*
|
|
561
|
+
* @deprecated
|
|
562
|
+
*
|
|
553
563
|
* @returns {Promise<ApiToken>} Success
|
|
554
564
|
*
|
|
555
565
|
* @example <caption>Code example</caption>
|
|
@@ -585,6 +595,8 @@ export declare class AccessTokensApiTokensClient {
|
|
|
585
595
|
*
|
|
586
596
|
* <br/><br/>The token secret is **not** exposed.
|
|
587
597
|
*
|
|
598
|
+
* @deprecated
|
|
599
|
+
*
|
|
588
600
|
* @returns {Promise<ApiToken>} Success
|
|
589
601
|
*
|
|
590
602
|
* @example <caption>Code example</caption>
|
|
@@ -614,6 +626,10 @@ export declare class AccessTokensApiTokensClient {
|
|
|
614
626
|
* + environment:roles:viewer
|
|
615
627
|
* + api-tokens:tokens:write
|
|
616
628
|
*
|
|
629
|
+
*
|
|
630
|
+
*
|
|
631
|
+
* @deprecated
|
|
632
|
+
*
|
|
617
633
|
* @example <caption>Code example</caption>
|
|
618
634
|
* import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
619
635
|
*
|
|
@@ -648,6 +664,10 @@ export declare class AccessTokensApiTokensClient {
|
|
|
648
664
|
* + environment:roles:viewer
|
|
649
665
|
* + api-tokens:tokens:write
|
|
650
666
|
*
|
|
667
|
+
*
|
|
668
|
+
*
|
|
669
|
+
* @deprecated
|
|
670
|
+
*
|
|
651
671
|
* @example <caption>Code example</caption>
|
|
652
672
|
* import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
653
673
|
*
|
|
@@ -775,6 +795,35 @@ export declare class AccessTokensTenantTokensClient {
|
|
|
775
795
|
startRotation(config?: {
|
|
776
796
|
abortSignal?: AbortSignal_2;
|
|
777
797
|
} | AbortSignal_2): Promise<TenantTokenConfig>;
|
|
798
|
+
/**
|
|
799
|
+
* Gets tenant token rotation status
|
|
800
|
+
*
|
|
801
|
+
* **One of the following scopes is required:**
|
|
802
|
+
* + environment-api:tenant-token-rotation:write
|
|
803
|
+
* + fleet-management:tenant-token:rotate
|
|
804
|
+
*
|
|
805
|
+
* <br/>**One of the following permissions is required:**
|
|
806
|
+
* + environment:roles:manage-settings
|
|
807
|
+
* + fleet-management:tenant-token:rotate
|
|
808
|
+
*
|
|
809
|
+
* <br/><br/>To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6) in Dynatrace Documentation.
|
|
810
|
+
*
|
|
811
|
+
* @returns {Promise<TenantTokenRotationStatus>} Success. Returns rotation status.
|
|
812
|
+
*
|
|
813
|
+
* @example <caption>Code example</caption>
|
|
814
|
+
* import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
815
|
+
*
|
|
816
|
+
* const data =
|
|
817
|
+
* await accessTokensTenantTokensClient.getRotationStatus();
|
|
818
|
+
*
|
|
819
|
+
* @throws {ErrorEnvelopeError} Failed. Tenant token configuration is unavailable. | Client side error. | Server side error.
|
|
820
|
+
* @throws {InvalidResponseError}
|
|
821
|
+
* @throws {ApiClientError}
|
|
822
|
+
* @throws {ClientRequestError}
|
|
823
|
+
*/
|
|
824
|
+
getRotationStatus(config?: {
|
|
825
|
+
abortSignal?: AbortSignal_2;
|
|
826
|
+
} | AbortSignal_2): Promise<TenantTokenRotationStatus>;
|
|
778
827
|
}
|
|
779
828
|
|
|
780
829
|
export declare const accessTokensTenantTokensClient: AccessTokensTenantTokensClient;
|
|
@@ -793,6 +842,8 @@ export declare interface ActiveGate {
|
|
|
793
842
|
autoUpdateSettings?: ActiveGateAutoUpdateConfig;
|
|
794
843
|
/**
|
|
795
844
|
* The current status of auto-updates of the ActiveGate.
|
|
845
|
+
*
|
|
846
|
+
* @exampleValue OUTDATED
|
|
796
847
|
*/
|
|
797
848
|
autoUpdateStatus?: 'INCOMPATIBLE' | 'OUTDATED' | 'SCHEDULED' | 'SUPPRESSED' | 'UNKNOWN' | 'UP2DATE' | 'UPDATE_IN_PROGRESS' | 'UPDATE_PENDING' | 'UPDATE_PROBLEM';
|
|
798
849
|
/**
|
|
@@ -813,14 +864,20 @@ export declare interface ActiveGate {
|
|
|
813
864
|
fipsMode?: boolean;
|
|
814
865
|
/**
|
|
815
866
|
* The group of the ActiveGate.
|
|
867
|
+
*
|
|
868
|
+
* @exampleValue default
|
|
816
869
|
*/
|
|
817
870
|
group?: string;
|
|
818
871
|
/**
|
|
819
872
|
* The name of the host the ActiveGate is running on.
|
|
873
|
+
*
|
|
874
|
+
* @exampleValue exampleHostname
|
|
820
875
|
*/
|
|
821
876
|
hostname?: string;
|
|
822
877
|
/**
|
|
823
878
|
* The ID of the ActiveGate.
|
|
879
|
+
*
|
|
880
|
+
* @exampleValue 0x3efdd091
|
|
824
881
|
*/
|
|
825
882
|
id?: string;
|
|
826
883
|
/**
|
|
@@ -829,6 +886,8 @@ export declare interface ActiveGate {
|
|
|
829
886
|
loadBalancerAddresses?: string[];
|
|
830
887
|
/**
|
|
831
888
|
* The ID of the main environment for a multi-environment ActiveGate.
|
|
889
|
+
*
|
|
890
|
+
* @exampleValue d1bf4a7e-666b-43af-9f45-718g98372e2f
|
|
832
891
|
*/
|
|
833
892
|
mainEnvironment?: string;
|
|
834
893
|
/**
|
|
@@ -841,32 +900,46 @@ export declare interface ActiveGate {
|
|
|
841
900
|
networkAddresses?: string[];
|
|
842
901
|
/**
|
|
843
902
|
* The network zone of the ActiveGate.
|
|
903
|
+
*
|
|
904
|
+
* @exampleValue exampleNetworkZone
|
|
844
905
|
*/
|
|
845
906
|
networkZone?: string;
|
|
846
907
|
/**
|
|
847
908
|
* The timestamp since when the ActiveGate is offline.
|
|
848
909
|
*
|
|
849
910
|
* The `null` value means the ActiveGate is online.
|
|
911
|
+
*
|
|
912
|
+
* @exampleValue 1582031917814
|
|
850
913
|
*/
|
|
851
914
|
offlineSince?: number;
|
|
852
915
|
/**
|
|
853
916
|
* The OS architecture that the ActiveGate is running on.
|
|
917
|
+
*
|
|
918
|
+
* @exampleValue X86
|
|
854
919
|
*/
|
|
855
920
|
osArchitecture?: 'S390' | 'X86' | 'ARM' | 'PPCLE';
|
|
856
921
|
/**
|
|
857
922
|
* The OS bitness that the ActiveGate is running on.
|
|
923
|
+
*
|
|
924
|
+
* @exampleValue 64
|
|
858
925
|
*/
|
|
859
926
|
osBitness?: '64';
|
|
860
927
|
/**
|
|
861
928
|
* The OS type that the ActiveGate is running on.
|
|
929
|
+
*
|
|
930
|
+
* @exampleValue WINDOWS
|
|
862
931
|
*/
|
|
863
932
|
osType?: 'LINUX' | 'WINDOWS';
|
|
864
933
|
/**
|
|
865
934
|
* The type of the ActiveGate.
|
|
935
|
+
*
|
|
936
|
+
* @exampleValue ENVIRONMENT
|
|
866
937
|
*/
|
|
867
938
|
type?: 'CLUSTER' | 'ENVIRONMENT' | 'ENVIRONMENT_MULTI';
|
|
868
939
|
/**
|
|
869
940
|
* The current version of the ActiveGate in the `<major>.<minor>.<revision>.<timestamp>` format.
|
|
941
|
+
*
|
|
942
|
+
* @exampleValue 1.185.0.20200201-120000
|
|
870
943
|
*/
|
|
871
944
|
version?: string;
|
|
872
945
|
}
|
|
@@ -879,18 +952,24 @@ export declare interface ActiveGateAutoUpdateConfig {
|
|
|
879
952
|
* The actual state of the ActiveGate auto-update.
|
|
880
953
|
*
|
|
881
954
|
* Applicable only if the **setting** parameter is set to `INHERITED`. In that case, the value is taken from the parent setting. Otherwise, it's just a duplicate of the **setting** value.
|
|
955
|
+
*
|
|
956
|
+
* @exampleValue ENABLED
|
|
882
957
|
*/
|
|
883
958
|
effectiveSetting?: 'ENABLED' | 'DISABLED';
|
|
884
959
|
/**
|
|
885
960
|
* The state of the environment ActiveGate auto-update: enabled, disabled, or inherited.
|
|
886
961
|
*
|
|
887
962
|
* If set to `INHERITED`, the setting is inherited from the global environment ActiveGate auto-update configuration.
|
|
963
|
+
*
|
|
964
|
+
* @exampleValue INHERITED
|
|
888
965
|
*/
|
|
889
966
|
setting: 'DISABLED' | 'ENABLED' | 'INHERITED';
|
|
890
967
|
/**
|
|
891
968
|
* The target version of the ActiveGate.
|
|
892
969
|
*
|
|
893
970
|
* Specify the version in the `<major>.<minor>` format (for example `1.342`) or `latest`, `previous`, or `older`.
|
|
971
|
+
*
|
|
972
|
+
* @exampleValue latest
|
|
894
973
|
*/
|
|
895
974
|
targetVersion?: string;
|
|
896
975
|
/**
|
|
@@ -947,6 +1026,8 @@ export declare enum ActiveGateAutoUpdateStatus {
|
|
|
947
1026
|
export declare interface ActiveGateConnectedHosts {
|
|
948
1027
|
/**
|
|
949
1028
|
* The number of hosts currently connected to the ActiveGate
|
|
1029
|
+
*
|
|
1030
|
+
* @exampleValue 150
|
|
950
1031
|
*/
|
|
951
1032
|
number?: number;
|
|
952
1033
|
}
|
|
@@ -971,6 +1052,8 @@ export declare interface ActiveGateGlobalAutoUpdateConfig {
|
|
|
971
1052
|
* Supports relative versions `latest`, `previous` and `older` as well as specific version in `<major>.<minor>` format (for example `1.261`).
|
|
972
1053
|
*
|
|
973
1054
|
* Only applicable when the **setting** parameter is set to `ENABLED`.
|
|
1055
|
+
*
|
|
1056
|
+
* @exampleValue latest
|
|
974
1057
|
*/
|
|
975
1058
|
targetVersion?: string;
|
|
976
1059
|
/**
|
|
@@ -997,6 +1080,8 @@ export declare enum ActiveGateGlobalAutoUpdateConfigGlobalSetting {
|
|
|
997
1080
|
export declare interface ActiveGateGroup {
|
|
998
1081
|
/**
|
|
999
1082
|
* Name of ActiveGate group
|
|
1083
|
+
*
|
|
1084
|
+
* @exampleValue default
|
|
1000
1085
|
*/
|
|
1001
1086
|
name?: string;
|
|
1002
1087
|
}
|
|
@@ -1081,6 +1166,8 @@ export declare interface ActiveGateModule {
|
|
|
1081
1166
|
misconfigured?: boolean;
|
|
1082
1167
|
/**
|
|
1083
1168
|
* The type of ActiveGate module.
|
|
1169
|
+
*
|
|
1170
|
+
* @exampleValue KUBERNETES
|
|
1084
1171
|
*/
|
|
1085
1172
|
type?: 'AWS' | 'AZURE' | 'BEACON_FORWARDER' | 'CLOUD_FOUNDRY' | 'DB_INSIGHT' | 'DEBUGGING' | 'EXTENSIONS_V1' | 'EXTENSIONS_V2' | 'KUBERNETES' | 'LOGS' | 'MEMORY_DUMPS' | 'METRIC_API' | 'ONE_AGENT_ROUTING' | 'OTLP_INGEST' | 'REST_API' | 'SYNTHETIC' | 'VMWARE' | 'Z_OS';
|
|
1086
1173
|
/**
|
|
@@ -1177,6 +1264,10 @@ export declare class ActiveGatesActiveGateGroupsClient {
|
|
|
1177
1264
|
* + environment:roles:manage-settings
|
|
1178
1265
|
* + fleet-management:activegates:read
|
|
1179
1266
|
*
|
|
1267
|
+
* <br/><br/>Deprecated since version 1.343. Use DQL Smartscape nodes to query ActiveGate data instead. See https://dt-url.net/mf03894
|
|
1268
|
+
*
|
|
1269
|
+
* @deprecated
|
|
1270
|
+
*
|
|
1180
1271
|
* @returns {Promise<ActiveGateGroups>} Success
|
|
1181
1272
|
*
|
|
1182
1273
|
* @example <caption>Code example</caption>
|
|
@@ -1591,14 +1682,22 @@ export declare class ActiveGatesAutoUpdateJobsClient {
|
|
|
1591
1682
|
* Specify the comparison operator here.
|
|
1592
1683
|
*/ startVersionCompareType?: 'EQUAL' | 'GREATER' | 'GREATER_EQUAL' | 'LOWER' | 'LOWER_EQUAL';
|
|
1593
1684
|
/** Filters the resulting set of update-jobs by the initial version (required format `<major>.<minor>.<revision>`). */ startVersion?: string;
|
|
1594
|
-
/**
|
|
1685
|
+
/**
|
|
1686
|
+
* Filters the resulting set of update-jobs by the update type.
|
|
1687
|
+
*
|
|
1688
|
+
* @exampleValue ACTIVE_GATE
|
|
1689
|
+
*/ updateType?: 'ACTIVE_GATE' | 'REMOTE_PLUGIN_AGENT' | 'SYNTHETIC' | 'Z_REMOTE';
|
|
1595
1690
|
/**
|
|
1596
1691
|
* Filters the resulting set of update jobs by the specified target version.
|
|
1597
1692
|
*
|
|
1598
1693
|
* Specify the comparison operator here.
|
|
1599
1694
|
*/ targetVersionCompareType?: 'EQUAL' | 'GREATER' | 'GREATER_EQUAL' | 'LOWER' | 'LOWER_EQUAL';
|
|
1600
1695
|
/** Filters the resulting set of update-jobs by the target version (required format `<major>.<minor>.<revision>`). */ targetVersion?: string;
|
|
1601
|
-
/**
|
|
1696
|
+
/**
|
|
1697
|
+
* If `true`, filters the resulting set of update jobs to the most recent update of each type.
|
|
1698
|
+
*
|
|
1699
|
+
* @defaultValue false
|
|
1700
|
+
*/ lastUpdates?: boolean;
|
|
1602
1701
|
abortSignal?: AbortSignal_2;
|
|
1603
1702
|
}): Promise<UpdateJobsAll>;
|
|
1604
1703
|
/**
|
|
@@ -1675,14 +1774,22 @@ export declare class ActiveGatesAutoUpdateJobsClient {
|
|
|
1675
1774
|
* Specify the comparison operator here.
|
|
1676
1775
|
*/ startVersionCompareType?: 'EQUAL' | 'GREATER' | 'GREATER_EQUAL' | 'LOWER' | 'LOWER_EQUAL';
|
|
1677
1776
|
/** Filters the resulting set of update-jobs by the initial version (required format `<major>.<minor>.<revision>`). */ startVersion?: string;
|
|
1678
|
-
/**
|
|
1777
|
+
/**
|
|
1778
|
+
* Filters the resulting set of update-jobs by the update type.
|
|
1779
|
+
*
|
|
1780
|
+
* @exampleValue ACTIVE_GATE
|
|
1781
|
+
*/ updateType?: 'ACTIVE_GATE' | 'REMOTE_PLUGIN_AGENT' | 'SYNTHETIC' | 'Z_REMOTE';
|
|
1679
1782
|
/**
|
|
1680
1783
|
* Filters the resulting set of update jobs by the specified target version.
|
|
1681
1784
|
*
|
|
1682
1785
|
* Specify the comparison operator here.
|
|
1683
1786
|
*/ targetVersionCompareType?: 'EQUAL' | 'GREATER' | 'GREATER_EQUAL' | 'LOWER' | 'LOWER_EQUAL';
|
|
1684
1787
|
/** Filters the resulting set of update-jobs by the target version (required format `<major>.<minor>.<revision>`). */ targetVersion?: string;
|
|
1685
|
-
/**
|
|
1788
|
+
/**
|
|
1789
|
+
* If `true`, filters the resulting set of update jobs to the most recent update of each type.
|
|
1790
|
+
*
|
|
1791
|
+
* @defaultValue false
|
|
1792
|
+
*/ lastUpdates?: boolean;
|
|
1686
1793
|
abortSignal?: AbortSignal_2;
|
|
1687
1794
|
}): Promise<UpdateJobList>;
|
|
1688
1795
|
/**
|
|
@@ -1839,7 +1946,9 @@ export declare class ActiveGatesClient {
|
|
|
1839
1946
|
* + environment:roles:manage-settings
|
|
1840
1947
|
* + fleet-management:activegates:read
|
|
1841
1948
|
*
|
|
1842
|
-
* <br/><br/>The response includes all ActiveGates that are currently connected to the environment or have been connected during last 2 hours.
|
|
1949
|
+
* <br/><br/>The response includes all ActiveGates that are currently connected to the environment or have been connected during last 2 hours. Deprecated since version 1.343. Use DQL Smartscape nodes to query ActiveGate data instead. See https://dt-url.net/mf03894
|
|
1950
|
+
*
|
|
1951
|
+
* @deprecated
|
|
1843
1952
|
*
|
|
1844
1953
|
* @returns {Promise<ActiveGateList>} Success
|
|
1845
1954
|
*
|
|
@@ -1914,6 +2023,10 @@ export declare class ActiveGatesClient {
|
|
|
1914
2023
|
* + environment:roles:manage-settings
|
|
1915
2024
|
* + fleet-management:activegates:read
|
|
1916
2025
|
*
|
|
2026
|
+
* <br/><br/>Deprecated since version 1.343. Use DQL Smartscape nodes to query ActiveGate data instead. See https://dt-url.net/mf03894
|
|
2027
|
+
*
|
|
2028
|
+
* @deprecated
|
|
2029
|
+
*
|
|
1917
2030
|
* @returns {Promise<ActiveGate>} Success
|
|
1918
2031
|
*
|
|
1919
2032
|
* @example <caption>Code example</caption>
|
|
@@ -2173,32 +2286,46 @@ export declare interface ActiveGateToken {
|
|
|
2173
2286
|
activeGateType: 'ENVIRONMENT' | 'CLUSTER';
|
|
2174
2287
|
/**
|
|
2175
2288
|
* The token creation date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
|
|
2289
|
+
*
|
|
2290
|
+
* @exampleValue 2020-11-22T08:15:30.144Z
|
|
2176
2291
|
*/
|
|
2177
2292
|
creationDate: string;
|
|
2178
2293
|
/**
|
|
2179
2294
|
* The token expiration date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
|
|
2180
2295
|
*
|
|
2181
2296
|
* If not set, the token never expires.
|
|
2297
|
+
*
|
|
2298
|
+
* @exampleValue 2020-11-24T08:15:30.144Z
|
|
2182
2299
|
*/
|
|
2183
2300
|
expirationDate?: string;
|
|
2184
2301
|
/**
|
|
2185
2302
|
* The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/rn00tjg) of the token.
|
|
2303
|
+
*
|
|
2304
|
+
* @exampleValue dt0g02.4KWZO5EF
|
|
2186
2305
|
*/
|
|
2187
2306
|
id: string;
|
|
2188
2307
|
/**
|
|
2189
2308
|
* The token last used date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
|
|
2309
|
+
*
|
|
2310
|
+
* @exampleValue 2020-11-23T08:15:30.144Z
|
|
2190
2311
|
*/
|
|
2191
2312
|
lastUsedDate?: string;
|
|
2192
2313
|
/**
|
|
2193
2314
|
* The name of the token.
|
|
2315
|
+
*
|
|
2316
|
+
* @exampleValue myToken
|
|
2194
2317
|
*/
|
|
2195
2318
|
name: string;
|
|
2196
2319
|
/**
|
|
2197
2320
|
* The owner of the token.
|
|
2321
|
+
*
|
|
2322
|
+
* @exampleValue john.smith
|
|
2198
2323
|
*/
|
|
2199
2324
|
owner: string;
|
|
2200
2325
|
/**
|
|
2201
2326
|
* The token is a seed token (`true`) or an individual token (`false`).
|
|
2327
|
+
*
|
|
2328
|
+
* @exampleValue false
|
|
2202
2329
|
*/
|
|
2203
2330
|
seedToken?: boolean;
|
|
2204
2331
|
}
|
|
@@ -2240,16 +2367,22 @@ export declare interface ActiveGateTokenCreate {
|
|
|
2240
2367
|
* If not set, the token never expires.
|
|
2241
2368
|
*
|
|
2242
2369
|
* Ensure that it is not set in the past and does not exceed `2 years` from the moment of creation."
|
|
2370
|
+
*
|
|
2371
|
+
* @exampleValue now+6M
|
|
2243
2372
|
*/
|
|
2244
2373
|
expirationDate?: string;
|
|
2245
2374
|
/**
|
|
2246
2375
|
* The name of the token.
|
|
2376
|
+
*
|
|
2377
|
+
* @exampleValue myToken
|
|
2247
2378
|
*/
|
|
2248
2379
|
name: string;
|
|
2249
2380
|
/**
|
|
2250
2381
|
* The token is a seed token (`true`) or an individual token (`false`).
|
|
2251
2382
|
*
|
|
2252
2383
|
* We recommend the individual token option (false).
|
|
2384
|
+
*
|
|
2385
|
+
* @exampleValue false
|
|
2253
2386
|
*/
|
|
2254
2387
|
seedToken?: boolean;
|
|
2255
2388
|
}
|
|
@@ -2270,14 +2403,20 @@ export declare enum ActiveGateTokenCreateActiveGateType {
|
|
|
2270
2403
|
export declare interface ActiveGateTokenCreated {
|
|
2271
2404
|
/**
|
|
2272
2405
|
* The token expiration date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
|
|
2406
|
+
*
|
|
2407
|
+
* @exampleValue 2020-11-24T08:15:30.144Z
|
|
2273
2408
|
*/
|
|
2274
2409
|
expirationDate?: string;
|
|
2275
2410
|
/**
|
|
2276
2411
|
* The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/rn00tjg) of the token.
|
|
2412
|
+
*
|
|
2413
|
+
* @exampleValue dt0g02.4KWZO5EF
|
|
2277
2414
|
*/
|
|
2278
2415
|
id: string;
|
|
2279
2416
|
/**
|
|
2280
2417
|
* The secret of the token.
|
|
2418
|
+
*
|
|
2419
|
+
* @exampleValue dt0g02.4KWZO5EF.XT47R5DRADJIZUFOX4UDNOKTSUSABGLN7XSMJG7UXHRXKNY4WLORH4OF4T75MG7E
|
|
2281
2420
|
*/
|
|
2282
2421
|
token: string;
|
|
2283
2422
|
}
|
|
@@ -2312,6 +2451,8 @@ export declare interface ActiveGateTokenInfoDto {
|
|
|
2312
2451
|
environmentId?: string;
|
|
2313
2452
|
/**
|
|
2314
2453
|
* The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/rn00tjg) of the token.
|
|
2454
|
+
*
|
|
2455
|
+
* @exampleValue dt0g02.4KWZO5EF
|
|
2315
2456
|
*/
|
|
2316
2457
|
id?: string;
|
|
2317
2458
|
/**
|
|
@@ -2346,6 +2487,8 @@ export declare interface ActiveGateTokenList {
|
|
|
2346
2487
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
2347
2488
|
*
|
|
2348
2489
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
2490
|
+
*
|
|
2491
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
2349
2492
|
*/
|
|
2350
2493
|
nextPageKey?: string;
|
|
2351
2494
|
/**
|
|
@@ -2483,6 +2626,8 @@ export declare interface AffectedEntity {
|
|
|
2483
2626
|
export declare interface AgentConnectionToken {
|
|
2484
2627
|
/**
|
|
2485
2628
|
* The agent connection token
|
|
2629
|
+
*
|
|
2630
|
+
* @exampleValue dt0a01.1.40f...bd9
|
|
2486
2631
|
*/
|
|
2487
2632
|
token?: string;
|
|
2488
2633
|
}
|
|
@@ -2553,48 +2698,70 @@ export declare interface ApiToken {
|
|
|
2553
2698
|
*
|
|
2554
2699
|
* * A `dashboardId` property for dashboard sharing tokens.
|
|
2555
2700
|
* * A `reportId` property for report sharing tokens
|
|
2701
|
+
*
|
|
2702
|
+
* @exampleValue {"dashboardId":"82402bab-7370-4359-924d-88ed13c8919a"}
|
|
2556
2703
|
*/
|
|
2557
2704
|
additionalMetadata?: ApiTokenAdditionalMetadata;
|
|
2558
2705
|
/**
|
|
2559
2706
|
* Token creation date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`)
|
|
2707
|
+
*
|
|
2708
|
+
* @exampleValue 2020-11-05T08:15:30.144Z
|
|
2560
2709
|
*/
|
|
2561
2710
|
creationDate?: string;
|
|
2562
2711
|
/**
|
|
2563
2712
|
* The token is enabled (`true`) or disabled (`false`).
|
|
2713
|
+
*
|
|
2714
|
+
* @exampleValue true
|
|
2564
2715
|
*/
|
|
2565
2716
|
enabled?: boolean;
|
|
2566
2717
|
/**
|
|
2567
2718
|
* Token expiration date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
|
|
2568
2719
|
*
|
|
2569
2720
|
* If not set, the token never expires.
|
|
2721
|
+
*
|
|
2722
|
+
* @exampleValue 2020-11-12T08:15:30.144Z
|
|
2570
2723
|
*/
|
|
2571
2724
|
expirationDate?: string;
|
|
2572
2725
|
/**
|
|
2573
2726
|
* The ID of the token, consisting of prefix and public part of the token.
|
|
2727
|
+
*
|
|
2728
|
+
* @exampleValue dt0c01.ST2EY72KQINMH574WMNVI7YN
|
|
2574
2729
|
*/
|
|
2575
2730
|
id?: string;
|
|
2576
2731
|
/**
|
|
2577
2732
|
* Token last used date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`)
|
|
2733
|
+
*
|
|
2734
|
+
* @exampleValue 2020-11-12T08:15:30.144Z
|
|
2578
2735
|
*/
|
|
2579
2736
|
lastUsedDate?: string;
|
|
2580
2737
|
/**
|
|
2581
2738
|
* Token last used IP address.
|
|
2739
|
+
*
|
|
2740
|
+
* @exampleValue 34.197.2.44
|
|
2582
2741
|
*/
|
|
2583
2742
|
lastUsedIpAddress?: string;
|
|
2584
2743
|
/**
|
|
2585
2744
|
* Token last modified date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`). Updating scopes or name counts as modification, enabling or disabling a token does not.
|
|
2745
|
+
*
|
|
2746
|
+
* @exampleValue 2020-11-12T08:15:30.144Z
|
|
2586
2747
|
*/
|
|
2587
2748
|
modifiedDate?: string;
|
|
2588
2749
|
/**
|
|
2589
2750
|
* The name of the token.
|
|
2751
|
+
*
|
|
2752
|
+
* @exampleValue myToken
|
|
2590
2753
|
*/
|
|
2591
2754
|
name?: string;
|
|
2592
2755
|
/**
|
|
2593
2756
|
* The owner of the token.
|
|
2757
|
+
*
|
|
2758
|
+
* @exampleValue john.smith
|
|
2594
2759
|
*/
|
|
2595
2760
|
owner?: string;
|
|
2596
2761
|
/**
|
|
2597
2762
|
* The token is a [personal access token](https://dt-url.net/wm03sop) (`true`) or an API token (`false`).
|
|
2763
|
+
*
|
|
2764
|
+
* @exampleValue true
|
|
2598
2765
|
*/
|
|
2599
2766
|
personalAccessToken?: boolean;
|
|
2600
2767
|
/**
|
|
@@ -2634,16 +2801,22 @@ export declare interface ApiTokenCreate {
|
|
|
2634
2801
|
* * `y`: years
|
|
2635
2802
|
*
|
|
2636
2803
|
* If not set, the token never expires. Ensure that the expiration date is not set in the past.
|
|
2804
|
+
*
|
|
2805
|
+
* @exampleValue now+14d
|
|
2637
2806
|
*/
|
|
2638
2807
|
expirationDate?: string;
|
|
2639
2808
|
/**
|
|
2640
2809
|
* The name of the token.
|
|
2810
|
+
*
|
|
2811
|
+
* @exampleValue tokenName
|
|
2641
2812
|
*/
|
|
2642
2813
|
name: string;
|
|
2643
2814
|
/**
|
|
2644
2815
|
* The token is a personal access token (`true`) or an API token (`false`).
|
|
2645
2816
|
*
|
|
2646
2817
|
* Personal access tokens are tied to the permissions of their owner.
|
|
2818
|
+
*
|
|
2819
|
+
* @exampleValue false
|
|
2647
2820
|
*/
|
|
2648
2821
|
personalAccessToken?: boolean;
|
|
2649
2822
|
/**
|
|
@@ -2750,14 +2923,20 @@ export declare interface ApiTokenCreate {
|
|
|
2750
2923
|
export declare interface ApiTokenCreated {
|
|
2751
2924
|
/**
|
|
2752
2925
|
* The token expiration date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
|
|
2926
|
+
*
|
|
2927
|
+
* @exampleValue 2020-11-12T08:15:30.144Z
|
|
2753
2928
|
*/
|
|
2754
2929
|
expirationDate?: string;
|
|
2755
2930
|
/**
|
|
2756
2931
|
* The ID of the token, consisting of prefix and public part of the token.
|
|
2932
|
+
*
|
|
2933
|
+
* @exampleValue dt0c01.ST2EY72KQINMH574WMNVI7YN
|
|
2757
2934
|
*/
|
|
2758
2935
|
id?: string;
|
|
2759
2936
|
/**
|
|
2760
2937
|
* The secret of the token.
|
|
2938
|
+
*
|
|
2939
|
+
* @exampleValue dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM
|
|
2761
2940
|
*/
|
|
2762
2941
|
token?: string;
|
|
2763
2942
|
}
|
|
@@ -2871,6 +3050,8 @@ export declare interface ApiTokenList {
|
|
|
2871
3050
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
2872
3051
|
*
|
|
2873
3052
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
3053
|
+
*
|
|
3054
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
2874
3055
|
*/
|
|
2875
3056
|
nextPageKey?: string;
|
|
2876
3057
|
/**
|
|
@@ -2989,6 +3170,8 @@ export declare enum ApiTokenScopesItem {
|
|
|
2989
3170
|
export declare interface ApiTokenSecret {
|
|
2990
3171
|
/**
|
|
2991
3172
|
* The API token.
|
|
3173
|
+
*
|
|
3174
|
+
* @exampleValue dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM
|
|
2992
3175
|
*/
|
|
2993
3176
|
token: string;
|
|
2994
3177
|
}
|
|
@@ -2999,10 +3182,14 @@ export declare interface ApiTokenSecret {
|
|
|
2999
3182
|
export declare interface ApiTokenUpdate {
|
|
3000
3183
|
/**
|
|
3001
3184
|
* The token is enabled (`true`) or disabled (`false`)
|
|
3185
|
+
*
|
|
3186
|
+
* @exampleValue true
|
|
3002
3187
|
*/
|
|
3003
3188
|
enabled?: boolean;
|
|
3004
3189
|
/**
|
|
3005
3190
|
* The name of the token.
|
|
3191
|
+
*
|
|
3192
|
+
* @exampleValue myToken
|
|
3006
3193
|
*/
|
|
3007
3194
|
name?: string;
|
|
3008
3195
|
/**
|
|
@@ -3231,7 +3418,7 @@ export declare interface AssessmentAccuracyDetails {
|
|
|
3231
3418
|
/**
|
|
3232
3419
|
* The reasons for a reduced assessment accuracy.
|
|
3233
3420
|
*/
|
|
3234
|
-
reducedReasons?: Array<'LIMITED_AGENT_SUPPORT' | 'LIMITED_BY_CONFIGURATION'>;
|
|
3421
|
+
reducedReasons?: Array<'LIMITED_AGENT_SUPPORT' | 'LIMITED_BY_CONFIGURATION' | 'LIMITED_BY_SERVICE_DETECTION_V2'>;
|
|
3235
3422
|
}
|
|
3236
3423
|
|
|
3237
3424
|
/**
|
|
@@ -3241,7 +3428,8 @@ export declare interface AssessmentAccuracyDetails {
|
|
|
3241
3428
|
*/
|
|
3242
3429
|
export declare enum AssessmentAccuracyDetailsReducedReasonsItem {
|
|
3243
3430
|
LimitedAgentSupport = "LIMITED_AGENT_SUPPORT",
|
|
3244
|
-
LimitedByConfiguration = "LIMITED_BY_CONFIGURATION"
|
|
3431
|
+
LimitedByConfiguration = "LIMITED_BY_CONFIGURATION",
|
|
3432
|
+
LimitedByServiceDetectionV2 = "LIMITED_BY_SERVICE_DETECTION_V2"
|
|
3245
3433
|
}
|
|
3246
3434
|
|
|
3247
3435
|
/**
|
|
@@ -3492,6 +3680,8 @@ export declare interface AttackList {
|
|
|
3492
3680
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
3493
3681
|
*
|
|
3494
3682
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
3683
|
+
*
|
|
3684
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
3495
3685
|
*/
|
|
3496
3686
|
nextPageKey?: string;
|
|
3497
3687
|
/**
|
|
@@ -3798,6 +3988,8 @@ export declare interface AuditLog {
|
|
|
3798
3988
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
3799
3989
|
*
|
|
3800
3990
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
3991
|
+
*
|
|
3992
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
3801
3993
|
*/
|
|
3802
3994
|
nextPageKey?: string;
|
|
3803
3995
|
/**
|
|
@@ -3836,6 +4028,8 @@ export declare interface AuditLogEntry {
|
|
|
3836
4028
|
'dt.settings.schema_id'?: string;
|
|
3837
4029
|
/**
|
|
3838
4030
|
* The persistence scope for entries of category `CONFIG`, e.g. an ME identifier.
|
|
4031
|
+
*
|
|
4032
|
+
* @exampleValue environment
|
|
3839
4033
|
*/
|
|
3840
4034
|
'dt.settings.scope_id'?: string;
|
|
3841
4035
|
/**
|
|
@@ -4077,6 +4271,8 @@ export declare class AuditLogsClient {
|
|
|
4077
4271
|
* * `-timestamp`: Newest first.
|
|
4078
4272
|
*
|
|
4079
4273
|
* If not set, the newest first sorting is applied.
|
|
4274
|
+
*
|
|
4275
|
+
* @defaultValue -timestamp
|
|
4080
4276
|
*/ sort?: string;
|
|
4081
4277
|
abortSignal?: AbortSignal_2;
|
|
4082
4278
|
}): Promise<AuditLog>;
|
|
@@ -4801,6 +4997,8 @@ export declare interface CommentsList {
|
|
|
4801
4997
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
4802
4998
|
*
|
|
4803
4999
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
5000
|
+
*
|
|
5001
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
4804
5002
|
*/
|
|
4805
5003
|
nextPageKey?: string;
|
|
4806
5004
|
/**
|
|
@@ -4819,6 +5017,8 @@ export declare interface CommentsList {
|
|
|
4819
5017
|
export declare interface ComplexConstraint {
|
|
4820
5018
|
/**
|
|
4821
5019
|
* Defines if modification of any property triggers secret resubmission check.
|
|
5020
|
+
*
|
|
5021
|
+
* @exampleValue false
|
|
4822
5022
|
*/
|
|
4823
5023
|
checkAllProperties?: boolean;
|
|
4824
5024
|
/**
|
|
@@ -4827,14 +5027,20 @@ export declare interface ComplexConstraint {
|
|
|
4827
5027
|
customMessage?: string;
|
|
4828
5028
|
/**
|
|
4829
5029
|
* The ID of a custom validator.
|
|
5030
|
+
*
|
|
5031
|
+
* @exampleValue my-min-max
|
|
4830
5032
|
*/
|
|
4831
5033
|
customValidatorId?: string;
|
|
4832
5034
|
/**
|
|
4833
5035
|
* The maximum number of properties that can be set.
|
|
5036
|
+
*
|
|
5037
|
+
* @exampleValue 2
|
|
4834
5038
|
*/
|
|
4835
5039
|
maximumPropertyCount?: number;
|
|
4836
5040
|
/**
|
|
4837
5041
|
* The minimum number of properties that must be set.
|
|
5042
|
+
*
|
|
5043
|
+
* @exampleValue 1
|
|
4838
5044
|
*/
|
|
4839
5045
|
minimumPropertyCount?: number;
|
|
4840
5046
|
/**
|
|
@@ -4843,10 +5049,14 @@ export declare interface ComplexConstraint {
|
|
|
4843
5049
|
properties?: string[];
|
|
4844
5050
|
/**
|
|
4845
5051
|
* Whether to skip validation on a change made from the UI.
|
|
5052
|
+
*
|
|
5053
|
+
* @exampleValue false
|
|
4846
5054
|
*/
|
|
4847
5055
|
skipAsyncValidation?: boolean;
|
|
4848
5056
|
/**
|
|
4849
5057
|
* The maximum time in seconds the custom validator is allowed to run.
|
|
5058
|
+
*
|
|
5059
|
+
* @exampleValue 5
|
|
4850
5060
|
*/
|
|
4851
5061
|
timeout?: number;
|
|
4852
5062
|
/**
|
|
@@ -4877,14 +5087,20 @@ export declare enum ComplexConstraintType {
|
|
|
4877
5087
|
export declare interface ConfigurationMetadata {
|
|
4878
5088
|
/**
|
|
4879
5089
|
* Dynatrace version.
|
|
5090
|
+
*
|
|
5091
|
+
* @exampleValue 1.192.1
|
|
4880
5092
|
*/
|
|
4881
5093
|
clusterVersion?: string;
|
|
4882
5094
|
/**
|
|
4883
5095
|
* A sorted list of the version numbers of the configuration.
|
|
5096
|
+
*
|
|
5097
|
+
* @exampleValue [4,2]
|
|
4884
5098
|
*/
|
|
4885
5099
|
configurationVersions?: number[];
|
|
4886
5100
|
/**
|
|
4887
5101
|
* A sorted list of version numbers of the configuration.
|
|
5102
|
+
*
|
|
5103
|
+
* @exampleValue ["1.0.4","1.23"]
|
|
4888
5104
|
*/
|
|
4889
5105
|
currentConfigurationVersions?: string[];
|
|
4890
5106
|
}
|
|
@@ -4895,50 +5111,74 @@ export declare interface ConfigurationMetadata {
|
|
|
4895
5111
|
export declare interface Constraint {
|
|
4896
5112
|
/**
|
|
4897
5113
|
* A custom message for invalid values.
|
|
5114
|
+
*
|
|
5115
|
+
* @exampleValue customConstraintMessage
|
|
4898
5116
|
*/
|
|
4899
5117
|
customMessage?: string;
|
|
4900
5118
|
/**
|
|
4901
5119
|
* The ID of a custom validator.
|
|
5120
|
+
*
|
|
5121
|
+
* @exampleValue my-min-max
|
|
4902
5122
|
*/
|
|
4903
5123
|
customValidatorId?: string;
|
|
4904
5124
|
/**
|
|
4905
5125
|
* Whether to disallow usage of dangerous regexes
|
|
5126
|
+
*
|
|
5127
|
+
* @exampleValue true
|
|
4906
5128
|
*/
|
|
4907
5129
|
disallowDangerousRegex?: boolean;
|
|
4908
5130
|
/**
|
|
4909
5131
|
* The maximum allowed length of string values.
|
|
5132
|
+
*
|
|
5133
|
+
* @exampleValue 20
|
|
4910
5134
|
*/
|
|
4911
5135
|
maxLength?: number;
|
|
4912
5136
|
/**
|
|
4913
5137
|
* The maximum allowed value.
|
|
5138
|
+
*
|
|
5139
|
+
* @exampleValue 200
|
|
4914
5140
|
*/
|
|
4915
5141
|
maximum?: number;
|
|
4916
5142
|
/**
|
|
4917
5143
|
* The minimum required length of string values.
|
|
5144
|
+
*
|
|
5145
|
+
* @exampleValue 7
|
|
4918
5146
|
*/
|
|
4919
5147
|
minLength?: number;
|
|
4920
5148
|
/**
|
|
4921
5149
|
* The minimum allowed value.
|
|
5150
|
+
*
|
|
5151
|
+
* @exampleValue 3
|
|
4922
5152
|
*/
|
|
4923
5153
|
minimum?: number;
|
|
4924
5154
|
/**
|
|
4925
5155
|
* The regular expression pattern for valid string values.
|
|
5156
|
+
*
|
|
5157
|
+
* @exampleValue ^([a-z]|[0-9]|\-|\_|\+|\.)+\@([a-z]|[0-9]|-){2,}\.([a-z]|[0-9]|-){2,}(\.[a-z]{2,})?$
|
|
4926
5158
|
*/
|
|
4927
5159
|
pattern?: string;
|
|
4928
5160
|
/**
|
|
4929
5161
|
* Whether to skip validation on a change made from the UI.
|
|
5162
|
+
*
|
|
5163
|
+
* @exampleValue false
|
|
4930
5164
|
*/
|
|
4931
5165
|
skipAsyncValidation?: boolean;
|
|
4932
5166
|
/**
|
|
4933
5167
|
* The maximum time in seconds the custom validator is allowed to run.
|
|
5168
|
+
*
|
|
5169
|
+
* @exampleValue 5
|
|
4934
5170
|
*/
|
|
4935
5171
|
timeout?: number;
|
|
4936
5172
|
/**
|
|
4937
5173
|
* The type of the constraint.
|
|
5174
|
+
*
|
|
5175
|
+
* @exampleValue UNKNOWN
|
|
4938
5176
|
*/
|
|
4939
5177
|
type: 'CUSTOM_VALIDATOR_REF' | 'LENGTH' | 'NOT_BLANK' | 'NOT_EMPTY' | 'NO_WHITESPACE' | 'PATTERN' | 'RANGE' | 'REGEX' | 'TRIMMED' | 'UNIQUE' | 'UNKNOWN';
|
|
4940
5178
|
/**
|
|
4941
5179
|
* A list of properties for which the combination of values must be unique.
|
|
5180
|
+
*
|
|
5181
|
+
* @exampleValue ["my-prop-1","my-prop-2"]
|
|
4942
5182
|
*/
|
|
4943
5183
|
uniqueProperties?: string[];
|
|
4944
5184
|
}
|
|
@@ -4993,7 +5233,7 @@ export declare interface ContainerImageComponent {
|
|
|
4993
5233
|
/**
|
|
4994
5234
|
* Container image component type.
|
|
4995
5235
|
*/
|
|
4996
|
-
type?: 'activegate' | 'codemodules' | 'database-datasource-executor' | 'dynatrace-sql-extension-executor' | 'eec' | 'logmodule' | 'oneagent';
|
|
5236
|
+
type?: 'activegate' | 'codemodules' | 'database-datasource-executor' | 'sql-extension-executor' | 'dynatrace-sql-extension-executor' | 'eec' | 'logmodule' | 'oneagent';
|
|
4997
5237
|
}
|
|
4998
5238
|
|
|
4999
5239
|
/**
|
|
@@ -5005,6 +5245,7 @@ export declare enum ContainerImageComponentType {
|
|
|
5005
5245
|
Activegate = "activegate",
|
|
5006
5246
|
Codemodules = "codemodules",
|
|
5007
5247
|
DatabaseDatasourceExecutor = "database-datasource-executor",
|
|
5248
|
+
SqlExtensionExecutor = "sql-extension-executor",
|
|
5008
5249
|
DynatraceSqlExtensionExecutor = "dynatrace-sql-extension-executor",
|
|
5009
5250
|
Eec = "eec",
|
|
5010
5251
|
Logmodule = "logmodule",
|
|
@@ -5867,6 +6108,8 @@ export declare interface DavisSecurityAdviceList {
|
|
|
5867
6108
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
5868
6109
|
*
|
|
5869
6110
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
6111
|
+
*
|
|
6112
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
5870
6113
|
*/
|
|
5871
6114
|
nextPageKey?: string;
|
|
5872
6115
|
/**
|
|
@@ -6004,11 +6247,15 @@ export declare interface DeletionConstraint {
|
|
|
6004
6247
|
customMessage?: string;
|
|
6005
6248
|
/**
|
|
6006
6249
|
* The ID of a custom validator.
|
|
6250
|
+
*
|
|
6251
|
+
* @exampleValue my-min-max
|
|
6007
6252
|
*/
|
|
6008
6253
|
customValidatorId?: string;
|
|
6009
6254
|
schemaIds?: string[];
|
|
6010
6255
|
/**
|
|
6011
6256
|
* The maximum time in seconds the custom validator is allowed to run.
|
|
6257
|
+
*
|
|
6258
|
+
* @exampleValue 5
|
|
6012
6259
|
*/
|
|
6013
6260
|
timeout?: number;
|
|
6014
6261
|
/**
|
|
@@ -6065,6 +6312,9 @@ export declare interface EffectivePermission {
|
|
|
6065
6312
|
*/
|
|
6066
6313
|
context?: PermissionContext;
|
|
6067
6314
|
granted: 'condition' | 'false' | 'true';
|
|
6315
|
+
/**
|
|
6316
|
+
* @exampleValue settings:objects:write
|
|
6317
|
+
*/
|
|
6068
6318
|
permission: string;
|
|
6069
6319
|
}
|
|
6070
6320
|
|
|
@@ -6083,6 +6333,8 @@ export declare enum EffectivePermissionGranted {
|
|
|
6083
6333
|
export declare interface EffectiveSettingsValue {
|
|
6084
6334
|
/**
|
|
6085
6335
|
* The user (identified by a user ID or a public token ID) who performed that most recent modification.
|
|
6336
|
+
*
|
|
6337
|
+
* @exampleValue john.doe@example.com
|
|
6086
6338
|
*/
|
|
6087
6339
|
author?: string;
|
|
6088
6340
|
/**
|
|
@@ -6099,14 +6351,20 @@ export declare interface EffectiveSettingsValue {
|
|
|
6099
6351
|
modified?: number;
|
|
6100
6352
|
/**
|
|
6101
6353
|
* The origin of the settings value.
|
|
6354
|
+
*
|
|
6355
|
+
* @exampleValue HOST-D3A3C5A146830A79
|
|
6102
6356
|
*/
|
|
6103
6357
|
origin?: string;
|
|
6104
6358
|
/**
|
|
6105
6359
|
* The schema on which the object is based.
|
|
6360
|
+
*
|
|
6361
|
+
* @exampleValue builtin:container.built-in-monitoring-rule
|
|
6106
6362
|
*/
|
|
6107
6363
|
schemaId?: string;
|
|
6108
6364
|
/**
|
|
6109
6365
|
* The version of the schema on which the object is based.
|
|
6366
|
+
*
|
|
6367
|
+
* @exampleValue 1.0.0
|
|
6110
6368
|
*/
|
|
6111
6369
|
schemaVersion?: string;
|
|
6112
6370
|
/**
|
|
@@ -6123,6 +6381,8 @@ export declare interface EffectiveSettingsValue {
|
|
|
6123
6381
|
* It defines the actual values of settings' parameters.
|
|
6124
6382
|
*
|
|
6125
6383
|
* The actual content depends on the object's schema.
|
|
6384
|
+
*
|
|
6385
|
+
* @exampleValue {"autoMonitoring":true}
|
|
6126
6386
|
*/
|
|
6127
6387
|
value?: AnyValue;
|
|
6128
6388
|
}
|
|
@@ -6139,6 +6399,8 @@ export declare interface EffectiveSettingsValuesList {
|
|
|
6139
6399
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
6140
6400
|
*
|
|
6141
6401
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
6402
|
+
*
|
|
6403
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
6142
6404
|
*/
|
|
6143
6405
|
nextPageKey?: string;
|
|
6144
6406
|
/**
|
|
@@ -6237,6 +6499,8 @@ export declare interface EntitiesList {
|
|
|
6237
6499
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
6238
6500
|
*
|
|
6239
6501
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
6502
|
+
*
|
|
6503
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
6240
6504
|
*/
|
|
6241
6505
|
nextPageKey?: string;
|
|
6242
6506
|
/**
|
|
@@ -6442,6 +6706,8 @@ export declare interface EntityTypeList {
|
|
|
6442
6706
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
6443
6707
|
*
|
|
6444
6708
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
6709
|
+
*
|
|
6710
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
6445
6711
|
*/
|
|
6446
6712
|
nextPageKey?: string;
|
|
6447
6713
|
/**
|
|
@@ -6464,14 +6730,20 @@ export declare interface EntityTypeList {
|
|
|
6464
6730
|
export declare interface EntityTypePropertyDto {
|
|
6465
6731
|
/**
|
|
6466
6732
|
* The display-name of the property.
|
|
6733
|
+
*
|
|
6734
|
+
* @exampleValue cpu cores
|
|
6467
6735
|
*/
|
|
6468
6736
|
displayName?: string;
|
|
6469
6737
|
/**
|
|
6470
6738
|
* The ID of the property.
|
|
6739
|
+
*
|
|
6740
|
+
* @exampleValue cpuCores
|
|
6471
6741
|
*/
|
|
6472
6742
|
id?: string;
|
|
6473
6743
|
/**
|
|
6474
6744
|
* The type of the property.
|
|
6745
|
+
*
|
|
6746
|
+
* @exampleValue Number
|
|
6475
6747
|
*/
|
|
6476
6748
|
type?: string;
|
|
6477
6749
|
}
|
|
@@ -6595,18 +6867,26 @@ export declare enum EntryPointUsageSegmentSourceType {
|
|
|
6595
6867
|
export declare interface EnumType {
|
|
6596
6868
|
/**
|
|
6597
6869
|
* A short description of the property.
|
|
6870
|
+
*
|
|
6871
|
+
* @exampleValue typeDescription
|
|
6598
6872
|
*/
|
|
6599
6873
|
description: string;
|
|
6600
6874
|
/**
|
|
6601
6875
|
* The display name of the property.
|
|
6876
|
+
*
|
|
6877
|
+
* @exampleValue typeDisplayName
|
|
6602
6878
|
*/
|
|
6603
6879
|
displayName?: string;
|
|
6604
6880
|
/**
|
|
6605
6881
|
* An extended description and/or links to documentation.
|
|
6882
|
+
*
|
|
6883
|
+
* @exampleValue typeDocumentation
|
|
6606
6884
|
*/
|
|
6607
6885
|
documentation: string;
|
|
6608
6886
|
/**
|
|
6609
6887
|
* An existing Java enum class that holds the allowed values of the enum.
|
|
6888
|
+
*
|
|
6889
|
+
* @exampleValue enumClass
|
|
6610
6890
|
*/
|
|
6611
6891
|
enumClass?: string;
|
|
6612
6892
|
/**
|
|
@@ -6615,6 +6895,8 @@ export declare interface EnumType {
|
|
|
6615
6895
|
items: EnumValue[];
|
|
6616
6896
|
/**
|
|
6617
6897
|
* The type of the property.
|
|
6898
|
+
*
|
|
6899
|
+
* @exampleValue enum
|
|
6618
6900
|
*/
|
|
6619
6901
|
type: 'enum';
|
|
6620
6902
|
}
|
|
@@ -6634,22 +6916,32 @@ export declare enum EnumTypeType {
|
|
|
6634
6916
|
export declare interface EnumValue {
|
|
6635
6917
|
/**
|
|
6636
6918
|
* A short description of the value.
|
|
6919
|
+
*
|
|
6920
|
+
* @exampleValue exampleDescription
|
|
6637
6921
|
*/
|
|
6638
6922
|
description?: string;
|
|
6639
6923
|
/**
|
|
6640
6924
|
* The display name of the value.
|
|
6925
|
+
*
|
|
6926
|
+
* @exampleValue exampleDisplayName
|
|
6641
6927
|
*/
|
|
6642
6928
|
displayName: string;
|
|
6643
6929
|
/**
|
|
6644
6930
|
* The name of the value in an existing Java enum class.
|
|
6931
|
+
*
|
|
6932
|
+
* @exampleValue exampleJavaEnumValue
|
|
6645
6933
|
*/
|
|
6646
6934
|
enumInstance?: string;
|
|
6647
6935
|
/**
|
|
6648
6936
|
* The icon of the value.
|
|
6937
|
+
*
|
|
6938
|
+
* @exampleValue checkmark
|
|
6649
6939
|
*/
|
|
6650
6940
|
icon?: string;
|
|
6651
6941
|
/**
|
|
6652
6942
|
* The allowed value of the enum.
|
|
6943
|
+
*
|
|
6944
|
+
* @exampleValue exampleValue
|
|
6653
6945
|
*/
|
|
6654
6946
|
value: AnyValue;
|
|
6655
6947
|
}
|
|
@@ -6688,12 +6980,16 @@ export declare class ErrorEnvelopeError extends ClientRequestError<ErrorEnvelope
|
|
|
6688
6980
|
declare interface Event_2 {
|
|
6689
6981
|
/**
|
|
6690
6982
|
* The correlation ID of the event.
|
|
6983
|
+
*
|
|
6984
|
+
* @exampleValue 933613657e1c8fcf
|
|
6691
6985
|
*/
|
|
6692
6986
|
correlationId?: string;
|
|
6693
6987
|
/**
|
|
6694
6988
|
* The timestamp when the event was closed, in UTC milliseconds.
|
|
6695
6989
|
*
|
|
6696
6990
|
* Has the value of `null` if the event is still active.
|
|
6991
|
+
*
|
|
6992
|
+
* @exampleValue 1564039524182
|
|
6697
6993
|
*/
|
|
6698
6994
|
endTime?: number;
|
|
6699
6995
|
/**
|
|
@@ -6706,10 +7002,14 @@ declare interface Event_2 {
|
|
|
6706
7002
|
entityTags?: METag[];
|
|
6707
7003
|
/**
|
|
6708
7004
|
* The ID of the event.
|
|
7005
|
+
*
|
|
7006
|
+
* @exampleValue 4293884258445543163_1564039524182
|
|
6709
7007
|
*/
|
|
6710
7008
|
eventId?: string;
|
|
6711
7009
|
/**
|
|
6712
7010
|
* The type of the event.
|
|
7011
|
+
*
|
|
7012
|
+
* @exampleValue LOW_DISK_SPACE
|
|
6713
7013
|
*/
|
|
6714
7014
|
eventType?: string;
|
|
6715
7015
|
/**
|
|
@@ -6728,10 +7028,14 @@ declare interface Event_2 {
|
|
|
6728
7028
|
properties?: EventProperty[];
|
|
6729
7029
|
/**
|
|
6730
7030
|
* The timestamp when the event was raised, in UTC milliseconds.
|
|
7031
|
+
*
|
|
7032
|
+
* @exampleValue 1564039524182
|
|
6731
7033
|
*/
|
|
6732
7034
|
startTime?: number;
|
|
6733
7035
|
/**
|
|
6734
7036
|
* The status of the event.
|
|
7037
|
+
*
|
|
7038
|
+
* @exampleValue OPEN
|
|
6735
7039
|
*/
|
|
6736
7040
|
status?: 'CLOSED' | 'OPEN';
|
|
6737
7041
|
/**
|
|
@@ -6750,6 +7054,8 @@ declare interface Event_2 {
|
|
|
6750
7054
|
suppressProblem?: boolean;
|
|
6751
7055
|
/**
|
|
6752
7056
|
* The title of the event.
|
|
7057
|
+
*
|
|
7058
|
+
* @exampleValue High CPU load on host X
|
|
6753
7059
|
*/
|
|
6754
7060
|
title?: string;
|
|
6755
7061
|
/**
|
|
@@ -6938,6 +7244,8 @@ export declare interface EventList {
|
|
|
6938
7244
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
6939
7245
|
*
|
|
6940
7246
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
7247
|
+
*
|
|
7248
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
6941
7249
|
*/
|
|
6942
7250
|
nextPageKey?: string;
|
|
6943
7251
|
/**
|
|
@@ -6966,6 +7274,8 @@ export declare interface EventPropertiesList {
|
|
|
6966
7274
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
6967
7275
|
*
|
|
6968
7276
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
7277
|
+
*
|
|
7278
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
6969
7279
|
*/
|
|
6970
7280
|
nextPageKey?: string;
|
|
6971
7281
|
/**
|
|
@@ -7002,6 +7312,8 @@ export declare interface EventPropertyDetails {
|
|
|
7002
7312
|
description?: string;
|
|
7003
7313
|
/**
|
|
7004
7314
|
* The display name of the event property.
|
|
7315
|
+
*
|
|
7316
|
+
* @exampleValue Custom description
|
|
7005
7317
|
*/
|
|
7006
7318
|
displayName?: string;
|
|
7007
7319
|
/**
|
|
@@ -7011,6 +7323,8 @@ export declare interface EventPropertyDetails {
|
|
|
7011
7323
|
filterable?: boolean;
|
|
7012
7324
|
/**
|
|
7013
7325
|
* The key of the event property.
|
|
7326
|
+
*
|
|
7327
|
+
* @exampleValue dt.event.description
|
|
7014
7328
|
*/
|
|
7015
7329
|
key?: string;
|
|
7016
7330
|
/**
|
|
@@ -7372,14 +7686,20 @@ export declare interface EventType {
|
|
|
7372
7686
|
description?: string;
|
|
7373
7687
|
/**
|
|
7374
7688
|
* The display name of the event type.
|
|
7689
|
+
*
|
|
7690
|
+
* @exampleValue High CPU
|
|
7375
7691
|
*/
|
|
7376
7692
|
displayName?: string;
|
|
7377
7693
|
/**
|
|
7378
7694
|
* The severity level associated with the event type.
|
|
7695
|
+
*
|
|
7696
|
+
* @exampleValue PERFORMANCE
|
|
7379
7697
|
*/
|
|
7380
7698
|
severityLevel?: 'AVAILABILITY' | 'CUSTOM_ALERT' | 'ERROR' | 'INFO' | 'MONITORING_UNAVAILABLE' | 'PERFORMANCE' | 'RESOURCE_CONTENTION';
|
|
7381
7699
|
/**
|
|
7382
7700
|
* The event type.
|
|
7701
|
+
*
|
|
7702
|
+
* @exampleValue OSI_HIGH_CPU
|
|
7383
7703
|
*/
|
|
7384
7704
|
type?: string;
|
|
7385
7705
|
}
|
|
@@ -7396,6 +7716,8 @@ export declare interface EventTypeList {
|
|
|
7396
7716
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
7397
7717
|
*
|
|
7398
7718
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
7719
|
+
*
|
|
7720
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
7399
7721
|
*/
|
|
7400
7722
|
nextPageKey?: string;
|
|
7401
7723
|
/**
|
|
@@ -7683,6 +8005,8 @@ export declare interface ExportedLogRecordList {
|
|
|
7683
8005
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
7684
8006
|
*
|
|
7685
8007
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
8008
|
+
*
|
|
8009
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
7686
8010
|
*/
|
|
7687
8011
|
nextPageKey?: string;
|
|
7688
8012
|
/**
|
|
@@ -7742,6 +8066,8 @@ export declare interface Extension {
|
|
|
7742
8066
|
variables: string[];
|
|
7743
8067
|
/**
|
|
7744
8068
|
* Extension version
|
|
8069
|
+
*
|
|
8070
|
+
* @exampleValue 1.2.3
|
|
7745
8071
|
*/
|
|
7746
8072
|
version: string;
|
|
7747
8073
|
}
|
|
@@ -7764,6 +8090,8 @@ export declare interface ExtensionAssetsDto {
|
|
|
7764
8090
|
status: string;
|
|
7765
8091
|
/**
|
|
7766
8092
|
* Version of the active extension environment configuration.
|
|
8093
|
+
*
|
|
8094
|
+
* @exampleValue 1.2.3
|
|
7767
8095
|
*/
|
|
7768
8096
|
version: string;
|
|
7769
8097
|
}
|
|
@@ -7771,6 +8099,8 @@ export declare interface ExtensionAssetsDto {
|
|
|
7771
8099
|
export declare interface ExtensionEnvironmentConfigurationVersion {
|
|
7772
8100
|
/**
|
|
7773
8101
|
* Extension version
|
|
8102
|
+
*
|
|
8103
|
+
* @exampleValue 1.2.3
|
|
7774
8104
|
*/
|
|
7775
8105
|
version: string;
|
|
7776
8106
|
}
|
|
@@ -7788,6 +8118,8 @@ export declare interface ExtensionFeatureSetsDetails {
|
|
|
7788
8118
|
export declare interface ExtensionInfo {
|
|
7789
8119
|
/**
|
|
7790
8120
|
* Active version in the environment (null if none is active)
|
|
8121
|
+
*
|
|
8122
|
+
* @exampleValue 1.2.3
|
|
7791
8123
|
*/
|
|
7792
8124
|
activeVersion?: string | null;
|
|
7793
8125
|
/**
|
|
@@ -7800,6 +8132,8 @@ export declare interface ExtensionInfo {
|
|
|
7800
8132
|
keywords: string[];
|
|
7801
8133
|
/**
|
|
7802
8134
|
* Highest installed version
|
|
8135
|
+
*
|
|
8136
|
+
* @exampleValue 1.2.3
|
|
7803
8137
|
*/
|
|
7804
8138
|
version: string;
|
|
7805
8139
|
}
|
|
@@ -7813,6 +8147,8 @@ export declare interface ExtensionInfoList {
|
|
|
7813
8147
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
7814
8148
|
*
|
|
7815
8149
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
8150
|
+
*
|
|
8151
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
7816
8152
|
*/
|
|
7817
8153
|
nextPageKey?: string;
|
|
7818
8154
|
/**
|
|
@@ -7834,6 +8170,8 @@ export declare interface ExtensionList {
|
|
|
7834
8170
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
7835
8171
|
*
|
|
7836
8172
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
8173
|
+
*
|
|
8174
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
7837
8175
|
*/
|
|
7838
8176
|
nextPageKey?: string;
|
|
7839
8177
|
/**
|
|
@@ -7870,6 +8208,8 @@ export declare interface ExtensionMonitoringConfigurationsList {
|
|
|
7870
8208
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
7871
8209
|
*
|
|
7872
8210
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
8211
|
+
*
|
|
8212
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
7873
8213
|
*/
|
|
7874
8214
|
nextPageKey?: string;
|
|
7875
8215
|
/**
|
|
@@ -7970,7 +8310,11 @@ export declare class Extensions_2_0Client {
|
|
|
7970
8310
|
*/
|
|
7971
8311
|
uploadExtension(config: {
|
|
7972
8312
|
body: Blob;
|
|
7973
|
-
/**
|
|
8313
|
+
/**
|
|
8314
|
+
* Only run validation but do not persist the extension even if validation was successful.
|
|
8315
|
+
*
|
|
8316
|
+
* @defaultValue false
|
|
8317
|
+
*/ validateOnly?: boolean;
|
|
7974
8318
|
abortSignal?: AbortSignal_2;
|
|
7975
8319
|
}): Promise<ExtensionUploadResponseDto>;
|
|
7976
8320
|
/**
|
|
@@ -8793,6 +9137,8 @@ export declare class Extensions_2_0Client {
|
|
|
8793
9137
|
* * `-timestamp`: Newest first.
|
|
8794
9138
|
*
|
|
8795
9139
|
* If not set, the newest first sorting is applied.
|
|
9140
|
+
*
|
|
9141
|
+
* @defaultValue -timestamp
|
|
8796
9142
|
*/ sort?: string;
|
|
8797
9143
|
abortSignal?: AbortSignal_2;
|
|
8798
9144
|
}): Promise<AuditLog>;
|
|
@@ -9064,6 +9410,8 @@ export declare interface ExtensionUploadResponseDto {
|
|
|
9064
9410
|
variables: string[];
|
|
9065
9411
|
/**
|
|
9066
9412
|
* Extension version
|
|
9413
|
+
*
|
|
9414
|
+
* @exampleValue 1.2.3
|
|
9067
9415
|
*/
|
|
9068
9416
|
version: string;
|
|
9069
9417
|
}
|
|
@@ -9408,6 +9756,8 @@ export declare class FleetManagementContainerImagesClient {
|
|
|
9408
9756
|
* + environment:roles:agent-install
|
|
9409
9757
|
* + fleet-management:container-images:read
|
|
9410
9758
|
*
|
|
9759
|
+
* <br/><br/>Returns container image references for Dynatrace components from the specified registry. Returned image versions are resolved based on the configured target versions: dynatrace-activegate, dynatrace-eec, dynatrace-sql-extension-executor, and dynatrace-database-datasource-executor image versions are resolved from the ActiveGate target version; dynatrace-oneagent, dynatrace-codemodules, and dynatrace-logmodule image versions are resolved from the OneAgent target version. If no target version is configured for a component, the latest available image is returned.
|
|
9760
|
+
*
|
|
9411
9761
|
* @returns {Promise<ContainerImageData>} Container images data returned
|
|
9412
9762
|
*
|
|
9413
9763
|
* @example <caption>Code example</caption>
|
|
@@ -9973,10 +10323,14 @@ export declare interface HashicorpCertificateConfig extends ExternalVaultConfig
|
|
|
9973
10323
|
export declare interface HistoryModificationInfo {
|
|
9974
10324
|
/**
|
|
9975
10325
|
* The unique identifier of the user who performed the most recent modification.
|
|
10326
|
+
*
|
|
10327
|
+
* @exampleValue fab17b7a-2eb2-4c95-b818-743d94be2c30
|
|
9976
10328
|
*/
|
|
9977
10329
|
lastModifiedBy?: string;
|
|
9978
10330
|
/**
|
|
9979
10331
|
* Reason for system change
|
|
10332
|
+
*
|
|
10333
|
+
* @exampleValue default settings creation
|
|
9980
10334
|
*/
|
|
9981
10335
|
lastModifiedReason?: string;
|
|
9982
10336
|
/**
|
|
@@ -10027,6 +10381,8 @@ export declare interface Identity {
|
|
|
10027
10381
|
id?: string;
|
|
10028
10382
|
/**
|
|
10029
10383
|
* The type of the identity.
|
|
10384
|
+
*
|
|
10385
|
+
* @exampleValue user
|
|
10030
10386
|
*/
|
|
10031
10387
|
type: 'all-users' | 'group' | 'user';
|
|
10032
10388
|
}
|
|
@@ -10144,6 +10500,8 @@ export declare interface InteractionStepDto extends SyntheticBrowserMonitorStepD
|
|
|
10144
10500
|
button: 'MOUSE_LEFT' | 'MOUSE_MIDDLE' | 'MOUSE_RIGHT';
|
|
10145
10501
|
/**
|
|
10146
10502
|
* Target of Browser Monitor step.
|
|
10503
|
+
*
|
|
10504
|
+
* @exampleValue {"locators":[{"type":"CSS","value":"<img>[id='logoIcon']"},{"type":"CSS","value":"<a>[id='externalSite']"}],"window":"ruxitWin[0]"}
|
|
10147
10505
|
*/
|
|
10148
10506
|
target?: TargetDto;
|
|
10149
10507
|
/**
|
|
@@ -10152,6 +10510,8 @@ export declare interface InteractionStepDto extends SyntheticBrowserMonitorStepD
|
|
|
10152
10510
|
validationRules?: ValidationRuleDto[];
|
|
10153
10511
|
/**
|
|
10154
10512
|
* Wait condition for Browser Monitor step.
|
|
10513
|
+
*
|
|
10514
|
+
* @exampleValue {"type":"NETWORK"}
|
|
10155
10515
|
*/
|
|
10156
10516
|
waitCondition?: BaseWaitConditionDto;
|
|
10157
10517
|
}
|
|
@@ -10213,14 +10573,20 @@ export declare interface Item {
|
|
|
10213
10573
|
datasource?: DatasourceDefinition;
|
|
10214
10574
|
/**
|
|
10215
10575
|
* A short description of the item.
|
|
10576
|
+
*
|
|
10577
|
+
* @exampleValue itemDescription
|
|
10216
10578
|
*/
|
|
10217
10579
|
description?: string;
|
|
10218
10580
|
/**
|
|
10219
10581
|
* The display name of the item.
|
|
10582
|
+
*
|
|
10583
|
+
* @exampleValue itemDisplayName
|
|
10220
10584
|
*/
|
|
10221
10585
|
displayName?: string;
|
|
10222
10586
|
/**
|
|
10223
10587
|
* An extended description and/or links to documentation.
|
|
10588
|
+
*
|
|
10589
|
+
* @exampleValue propertyDocumentation
|
|
10224
10590
|
*/
|
|
10225
10591
|
documentation?: string;
|
|
10226
10592
|
/**
|
|
@@ -10229,10 +10595,14 @@ export declare interface Item {
|
|
|
10229
10595
|
metadata?: ItemMetadata;
|
|
10230
10596
|
/**
|
|
10231
10597
|
* The type referenced by the item's value.
|
|
10598
|
+
*
|
|
10599
|
+
* @exampleValue itemReferencedType
|
|
10232
10600
|
*/
|
|
10233
10601
|
referencedType?: string;
|
|
10234
10602
|
/**
|
|
10235
10603
|
* The subtype of the item's value.
|
|
10604
|
+
*
|
|
10605
|
+
* @exampleValue itemSubType
|
|
10236
10606
|
*/
|
|
10237
10607
|
subType?: string;
|
|
10238
10608
|
/**
|
|
@@ -10371,6 +10741,8 @@ export declare interface JavaScriptMappingFileListDto {
|
|
|
10371
10741
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
10372
10742
|
*
|
|
10373
10743
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
10744
|
+
*
|
|
10745
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
10374
10746
|
*/
|
|
10375
10747
|
nextPageKey?: string;
|
|
10376
10748
|
/**
|
|
@@ -10661,10 +11033,14 @@ export declare interface JavaScriptStepDto extends SyntheticBrowserMonitorStepDt
|
|
|
10661
11033
|
javaScript: string;
|
|
10662
11034
|
/**
|
|
10663
11035
|
* Target of Browser Monitor step.
|
|
11036
|
+
*
|
|
11037
|
+
* @exampleValue {"locators":[{"type":"CSS","value":"<img>[id='logoIcon']"},{"type":"CSS","value":"<a>[id='externalSite']"}],"window":"ruxitWin[0]"}
|
|
10664
11038
|
*/
|
|
10665
11039
|
target?: TargetDto;
|
|
10666
11040
|
/**
|
|
10667
11041
|
* Wait condition for Browser Monitor step.
|
|
11042
|
+
*
|
|
11043
|
+
* @exampleValue {"type":"NETWORK"}
|
|
10668
11044
|
*/
|
|
10669
11045
|
waitCondition?: BaseWaitConditionDto;
|
|
10670
11046
|
}
|
|
@@ -10764,6 +11140,8 @@ export declare interface KeyStrokesStepDto extends SyntheticBrowserMonitorStepDt
|
|
|
10764
11140
|
simulateReturnKey?: boolean;
|
|
10765
11141
|
/**
|
|
10766
11142
|
* Target of Browser Monitor step.
|
|
11143
|
+
*
|
|
11144
|
+
* @exampleValue {"locators":[{"type":"CSS","value":"<img>[id='logoIcon']"},{"type":"CSS","value":"<a>[id='externalSite']"}],"window":"ruxitWin[0]"}
|
|
10767
11145
|
*/
|
|
10768
11146
|
target?: TargetDto;
|
|
10769
11147
|
/**
|
|
@@ -10772,6 +11150,8 @@ export declare interface KeyStrokesStepDto extends SyntheticBrowserMonitorStepDt
|
|
|
10772
11150
|
validationRules?: ValidationRuleDto[];
|
|
10773
11151
|
/**
|
|
10774
11152
|
* Wait condition for Browser Monitor step.
|
|
11153
|
+
*
|
|
11154
|
+
* @exampleValue {"type":"NETWORK"}
|
|
10775
11155
|
*/
|
|
10776
11156
|
waitCondition?: BaseWaitConditionDto;
|
|
10777
11157
|
}
|
|
@@ -11201,6 +11581,10 @@ export declare class LogsClient {
|
|
|
11201
11581
|
* The minimum length of a slot is 1 ms.
|
|
11202
11582
|
*
|
|
11203
11583
|
* If not set, 1 is used.
|
|
11584
|
+
*
|
|
11585
|
+
* @defaultValue 1
|
|
11586
|
+
*
|
|
11587
|
+
* @minimum 1
|
|
11204
11588
|
*/ timeBuckets?: number;
|
|
11205
11589
|
/**
|
|
11206
11590
|
* The maximum number of values in each group.
|
|
@@ -11208,6 +11592,10 @@ export declare class LogsClient {
|
|
|
11208
11592
|
* You can get up to 100 values per group.
|
|
11209
11593
|
*
|
|
11210
11594
|
* If not set, 10 is used.
|
|
11595
|
+
*
|
|
11596
|
+
* @defaultValue 10
|
|
11597
|
+
*
|
|
11598
|
+
* @minimum 1
|
|
11211
11599
|
*/ maxGroupValues?: number;
|
|
11212
11600
|
/**
|
|
11213
11601
|
* The groupings to be included in the response.
|
|
@@ -11293,7 +11681,13 @@ export declare class LogsClient {
|
|
|
11293
11681
|
*
|
|
11294
11682
|
* When the **nextPageKey** is set to obtain subsequent pages, you must omit all other query parameters.
|
|
11295
11683
|
*/ nextPageKey?: string;
|
|
11296
|
-
/**
|
|
11684
|
+
/**
|
|
11685
|
+
* The number of results per result page.
|
|
11686
|
+
*
|
|
11687
|
+
* @defaultValue 1000
|
|
11688
|
+
*
|
|
11689
|
+
* @minimum 1
|
|
11690
|
+
*/ pageSize?: number;
|
|
11297
11691
|
/**
|
|
11298
11692
|
* The log search query.
|
|
11299
11693
|
*
|
|
@@ -11307,6 +11701,8 @@ export declare class LogsClient {
|
|
|
11307
11701
|
* Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).
|
|
11308
11702
|
*
|
|
11309
11703
|
* When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected).
|
|
11704
|
+
*
|
|
11705
|
+
* @defaultValue -timestamp
|
|
11310
11706
|
*/ sort?: string;
|
|
11311
11707
|
abortSignal?: AbortSignal_2;
|
|
11312
11708
|
}): Promise<ExportedLogRecordList>;
|
|
@@ -11469,6 +11865,10 @@ export declare class LogsClient {
|
|
|
11469
11865
|
* The maximal allowed limit is 1000.
|
|
11470
11866
|
*
|
|
11471
11867
|
* If not set, 1000 is used.
|
|
11868
|
+
*
|
|
11869
|
+
* @defaultValue 1000
|
|
11870
|
+
*
|
|
11871
|
+
* @minimum 1
|
|
11472
11872
|
*/ limit?: number;
|
|
11473
11873
|
/**
|
|
11474
11874
|
* The log search query.
|
|
@@ -11483,6 +11883,8 @@ export declare class LogsClient {
|
|
|
11483
11883
|
* Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).
|
|
11484
11884
|
*
|
|
11485
11885
|
* When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected).
|
|
11886
|
+
*
|
|
11887
|
+
* @defaultValue -timestamp
|
|
11486
11888
|
*/ sort?: string;
|
|
11487
11889
|
/**
|
|
11488
11890
|
* The cursor for the next slice of results. You can find it in the **nextSliceKey** field of the previous response.
|
|
@@ -11752,7 +12154,7 @@ export declare interface MetricDescriptor {
|
|
|
11752
12154
|
/**
|
|
11753
12155
|
* Transform operators that could be appended to the current transformation list.
|
|
11754
12156
|
*/
|
|
11755
|
-
transformations?: Array<'asGauge' | 'default' | 'delta' | 'evaluateModel' | 'filter' | 'fold' | 'histogram' | 'last' | 'lastReal' | 'limit' | 'merge' | 'names' | 'parents' | 'partition' | 'rate' | 'rollup' | 'setUnit' | 'smooth' | 'sort' | 'splitBy' | 'timeshift' | 'toUnit'>;
|
|
12157
|
+
transformations?: Array<'asGauge' | 'asHistogram' | 'default' | 'delta' | 'evaluateModel' | 'filter' | 'fold' | 'histogram' | 'last' | 'lastReal' | 'limit' | 'merge' | 'names' | 'parents' | 'partition' | 'rate' | 'rollup' | 'setUnit' | 'smooth' | 'sort' | 'splitBy' | 'timeshift' | 'toUnit'>;
|
|
11756
12158
|
/**
|
|
11757
12159
|
* The unit of the metric.
|
|
11758
12160
|
*/
|
|
@@ -11819,6 +12221,7 @@ export declare interface MetricDescriptorCollection {
|
|
|
11819
12221
|
*/
|
|
11820
12222
|
export declare enum MetricDescriptorTransformationsItem {
|
|
11821
12223
|
AsGauge = "asGauge",
|
|
12224
|
+
AsHistogram = "asHistogram",
|
|
11822
12225
|
Default = "default",
|
|
11823
12226
|
Delta = "delta",
|
|
11824
12227
|
EvaluateModel = "evaluateModel",
|
|
@@ -12206,7 +12609,11 @@ export declare class MetricsClient {
|
|
|
12206
12609
|
*
|
|
12207
12610
|
* You can select a full set of related metrics by using a trailing asterisk (`*`) wildcard. For example, `airflow_*` selects all custom airflow metrics, `*` selects all custom metrics.
|
|
12208
12611
|
*/ metricSelector: string;
|
|
12209
|
-
/**
|
|
12612
|
+
/**
|
|
12613
|
+
* The number of days since the metric was last used. Must be between `30` and `1825` (5 years).
|
|
12614
|
+
*
|
|
12615
|
+
* @minimum 30
|
|
12616
|
+
*/ minUnusedDays: number;
|
|
12210
12617
|
abortSignal?: AbortSignal_2;
|
|
12211
12618
|
}): Promise<void>;
|
|
12212
12619
|
/**
|
|
@@ -12676,6 +13083,8 @@ export declare interface MinimalExtension {
|
|
|
12676
13083
|
extensionName: string;
|
|
12677
13084
|
/**
|
|
12678
13085
|
* Extension version
|
|
13086
|
+
*
|
|
13087
|
+
* @exampleValue 1.2.3
|
|
12679
13088
|
*/
|
|
12680
13089
|
version: string;
|
|
12681
13090
|
}
|
|
@@ -13164,7 +13573,7 @@ export declare class MonitoredEntitiesClient {
|
|
|
13164
13573
|
* const data =
|
|
13165
13574
|
* await monitoredEntitiesClient.setSecurityContext({
|
|
13166
13575
|
* entitySelector: "...",
|
|
13167
|
-
* body: {},
|
|
13576
|
+
* body: { securityContext: ["..."] },
|
|
13168
13577
|
* });
|
|
13169
13578
|
*
|
|
13170
13579
|
* @throws {ErrorEnvelopeError} Client side error. | Server side error.
|
|
@@ -14034,6 +14443,8 @@ export declare interface MonitoredStates {
|
|
|
14034
14443
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
14035
14444
|
*
|
|
14036
14445
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
14446
|
+
*
|
|
14447
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
14037
14448
|
*/
|
|
14038
14449
|
nextPageKey?: string;
|
|
14039
14450
|
/**
|
|
@@ -14073,6 +14484,8 @@ export declare interface MonitorExecutionResults {
|
|
|
14073
14484
|
export declare interface MonitoringConfigurationDto {
|
|
14074
14485
|
/**
|
|
14075
14486
|
* The scope this monitoring configuration will be defined for
|
|
14487
|
+
*
|
|
14488
|
+
* @exampleValue HOST-D3A3C5A146830A79
|
|
14076
14489
|
*/
|
|
14077
14490
|
scope: string;
|
|
14078
14491
|
/**
|
|
@@ -14088,6 +14501,8 @@ export declare interface MonitoringConfigurationResponse {
|
|
|
14088
14501
|
code: number;
|
|
14089
14502
|
/**
|
|
14090
14503
|
* The identifier of the new configuration
|
|
14504
|
+
*
|
|
14505
|
+
* @exampleValue 331e416f-9ab7-4694-8408-816026820645
|
|
14091
14506
|
*/
|
|
14092
14507
|
objectId: string;
|
|
14093
14508
|
}
|
|
@@ -14300,10 +14715,14 @@ export declare enum MuteStateReason {
|
|
|
14300
14715
|
export declare interface NavigateStepDto extends SyntheticBrowserMonitorStepDto {
|
|
14301
14716
|
/**
|
|
14302
14717
|
* Authentication dto for Browser Monitor step.
|
|
14718
|
+
*
|
|
14719
|
+
* @exampleValue {"type":"HTTP_AUTHENTICATION"}
|
|
14303
14720
|
*/
|
|
14304
14721
|
authentication?: AuthenticationDto;
|
|
14305
14722
|
/**
|
|
14306
14723
|
* Target of Browser Monitor step.
|
|
14724
|
+
*
|
|
14725
|
+
* @exampleValue {"locators":[{"type":"CSS","value":"<img>[id='logoIcon']"},{"type":"CSS","value":"<a>[id='externalSite']"}],"window":"ruxitWin[0]"}
|
|
14307
14726
|
*/
|
|
14308
14727
|
target?: TargetDto;
|
|
14309
14728
|
/**
|
|
@@ -14316,6 +14735,8 @@ export declare interface NavigateStepDto extends SyntheticBrowserMonitorStepDto
|
|
|
14316
14735
|
validationRules?: ValidationRuleDto[];
|
|
14317
14736
|
/**
|
|
14318
14737
|
* Wait condition for Browser Monitor step.
|
|
14738
|
+
*
|
|
14739
|
+
* @exampleValue {"type":"NETWORK"}
|
|
14319
14740
|
*/
|
|
14320
14741
|
waitCondition?: BaseWaitConditionDto;
|
|
14321
14742
|
}
|
|
@@ -14863,6 +15284,8 @@ export declare interface ObjectsList {
|
|
|
14863
15284
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
14864
15285
|
*
|
|
14865
15286
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
15287
|
+
*
|
|
15288
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
14866
15289
|
*/
|
|
14867
15290
|
nextPageKey?: string;
|
|
14868
15291
|
/**
|
|
@@ -15019,10 +15442,14 @@ export declare const oneAgentRemoteConfigurationManagementClient: OneAgentRemote
|
|
|
15019
15442
|
export declare interface PermissionContext {
|
|
15020
15443
|
/**
|
|
15021
15444
|
* Settings schema id for conditional permission
|
|
15445
|
+
*
|
|
15446
|
+
* @exampleValue service:schema
|
|
15022
15447
|
*/
|
|
15023
15448
|
schemaId: string;
|
|
15024
15449
|
/**
|
|
15025
15450
|
* Settings scope for conditional permission
|
|
15451
|
+
*
|
|
15452
|
+
* @exampleValue environment
|
|
15026
15453
|
*/
|
|
15027
15454
|
scope: string;
|
|
15028
15455
|
}
|
|
@@ -15070,18 +15497,24 @@ export declare interface Precondition {
|
|
|
15070
15497
|
* The expected value of the property.
|
|
15071
15498
|
*
|
|
15072
15499
|
* Only applicable to properties of the `EQUALS` type.
|
|
15500
|
+
*
|
|
15501
|
+
* @exampleValue expectedValue
|
|
15073
15502
|
*/
|
|
15074
15503
|
expectedValue?: AnyValue;
|
|
15075
15504
|
/**
|
|
15076
15505
|
* A list of valid values of the property.
|
|
15077
15506
|
*
|
|
15078
15507
|
* Only applicable to properties of the `IN` type.
|
|
15508
|
+
*
|
|
15509
|
+
* @exampleValue expectedValues
|
|
15079
15510
|
*/
|
|
15080
15511
|
expectedValues?: AnyValue[];
|
|
15081
15512
|
/**
|
|
15082
15513
|
* The Regular expression which is matched against the property.
|
|
15083
15514
|
*
|
|
15084
15515
|
* Only applicable to properties of the `REGEX_MATCH` type.
|
|
15516
|
+
*
|
|
15517
|
+
* @exampleValue example Regex
|
|
15085
15518
|
*/
|
|
15086
15519
|
pattern?: string;
|
|
15087
15520
|
/**
|
|
@@ -15096,10 +15529,14 @@ export declare interface Precondition {
|
|
|
15096
15529
|
preconditions?: Precondition[];
|
|
15097
15530
|
/**
|
|
15098
15531
|
* The property to be evaluated.
|
|
15532
|
+
*
|
|
15533
|
+
* @exampleValue propertyToEvaluate
|
|
15099
15534
|
*/
|
|
15100
15535
|
property?: string;
|
|
15101
15536
|
/**
|
|
15102
15537
|
* The type of the precondition.
|
|
15538
|
+
*
|
|
15539
|
+
* @exampleValue NULL
|
|
15103
15540
|
*/
|
|
15104
15541
|
type: 'AND' | 'EQUALS' | 'IN' | 'NOT' | 'NULL' | 'OR' | 'REGEX_MATCH';
|
|
15105
15542
|
}
|
|
@@ -15192,12 +15629,26 @@ export declare interface PrivateSyntheticLocation {
|
|
|
15192
15629
|
latitude: number;
|
|
15193
15630
|
/**
|
|
15194
15631
|
* Alert if location or node outage lasts longer than *X* minutes. \n\n Only applicable when `availabilityLocationOutage` or `availabilityNodeOutage` is set to `true`. Supported only for private Synthetic locations.
|
|
15632
|
+
*
|
|
15633
|
+
* @minimum 1
|
|
15195
15634
|
*/
|
|
15196
15635
|
locationNodeOutageDelayInMinutes?: number;
|
|
15197
15636
|
/**
|
|
15198
15637
|
* The longitude of the location in `DDD.dddd` format.
|
|
15199
15638
|
*/
|
|
15200
15639
|
longitude: number;
|
|
15640
|
+
/**
|
|
15641
|
+
* Containerized location property. The maximum number of ActiveGates deployed for the location (required for a Kubernetes location).
|
|
15642
|
+
*
|
|
15643
|
+
* @minimum 1
|
|
15644
|
+
*/
|
|
15645
|
+
maxActiveGateCount?: number;
|
|
15646
|
+
/**
|
|
15647
|
+
* Containerized location property. The minimum number of ActiveGates deployed for the location (required for a Kubernetes location).
|
|
15648
|
+
*
|
|
15649
|
+
* @minimum 1
|
|
15650
|
+
*/
|
|
15651
|
+
minActiveGateCount?: number;
|
|
15201
15652
|
/**
|
|
15202
15653
|
* Containerized location property. Boolean value describes if icmp monitors will be executed on this location:
|
|
15203
15654
|
*
|
|
@@ -15214,12 +15665,21 @@ export declare interface PrivateSyntheticLocation {
|
|
|
15214
15665
|
*/
|
|
15215
15666
|
nodeNames?: PrivateSyntheticLocationNodeNames;
|
|
15216
15667
|
/**
|
|
15217
|
-
*
|
|
15668
|
+
* Containerized location property. The size of a containerized node deployed for the location (required for a Kubernetes location). Accepted values:
|
|
15218
15669
|
*
|
|
15219
|
-
*
|
|
15220
|
-
|
|
15221
|
-
|
|
15222
|
-
|
|
15670
|
+
* * `XS`: extra small
|
|
15671
|
+
* * `S`: small
|
|
15672
|
+
* * `M`: medium
|
|
15673
|
+
* The node size `L` is not supported in containerized locations.
|
|
15674
|
+
*/
|
|
15675
|
+
nodeSize?: 'M' | 'S' | 'UNSUPPORTED' | 'XS';
|
|
15676
|
+
/**
|
|
15677
|
+
* A list of synthetic nodes belonging to the location.
|
|
15678
|
+
*
|
|
15679
|
+
* You can retrieve the list of available nodes with the [GET all nodes](https://dt-url.net/miy3rpl) call.
|
|
15680
|
+
*/
|
|
15681
|
+
nodes?: string[];
|
|
15682
|
+
/**
|
|
15223
15683
|
* The region code of the location.
|
|
15224
15684
|
*
|
|
15225
15685
|
* To fetch the list of available region codes, use the [GET regions of the country](https://dt-url.net/az230x0) request.
|
|
@@ -15285,6 +15745,23 @@ export declare interface PrivateSyntheticLocationNodeNames {
|
|
|
15285
15745
|
[propName: string]: string | undefined;
|
|
15286
15746
|
}
|
|
15287
15747
|
|
|
15748
|
+
/**
|
|
15749
|
+
* Containerized location property. The size of a containerized node deployed for the location (required for a Kubernetes location). Accepted values:
|
|
15750
|
+
*
|
|
15751
|
+
* * `XS`: extra small
|
|
15752
|
+
* * `S`: small
|
|
15753
|
+
* * `M`: medium
|
|
15754
|
+
* The node size `L` is not supported in containerized locations.
|
|
15755
|
+
*
|
|
15756
|
+
* @deprecated Use literal values.
|
|
15757
|
+
*/
|
|
15758
|
+
export declare enum PrivateSyntheticLocationNodeSize {
|
|
15759
|
+
M = "M",
|
|
15760
|
+
S = "S",
|
|
15761
|
+
Unsupported = "UNSUPPORTED",
|
|
15762
|
+
Xs = "XS"
|
|
15763
|
+
}
|
|
15764
|
+
|
|
15288
15765
|
/**
|
|
15289
15766
|
* The status of the location:
|
|
15290
15767
|
*
|
|
@@ -15450,6 +15927,8 @@ export declare interface Problems {
|
|
|
15450
15927
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
15451
15928
|
*
|
|
15452
15929
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
15930
|
+
*
|
|
15931
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
15453
15932
|
*/
|
|
15454
15933
|
nextPageKey?: string;
|
|
15455
15934
|
/**
|
|
@@ -15573,7 +16052,7 @@ export declare class ProblemsClient {
|
|
|
15573
16052
|
* * Impact level: `impactLevel("level-11","level-2")` Find the possible values in the description of the **impactLevel** field of the response.
|
|
15574
16053
|
* * Root cause entity: `rootCauseEntity("id-1", "id-2")`.
|
|
15575
16054
|
* * Management zone ID: `managementZoneIds("mZId-1", "mzId-2")`.
|
|
15576
|
-
* * Management zone name: `managementZones("value-1","value-2")`.
|
|
16055
|
+
* * Management zone name (contains, case-insensitive): `managementZones("value-1","value-2")`.
|
|
15577
16056
|
* * Impacted entities: `impactedEntities("id-1", "id-2")`.
|
|
15578
16057
|
* * Affected entities: `affectedEntities("id-1", "id-2")`.
|
|
15579
16058
|
* * Type of affected entities: `affectedEntityTypes("value-1","value-2")`.
|
|
@@ -15903,22 +16382,32 @@ declare interface PropertyDefinition_2 {
|
|
|
15903
16382
|
* The default value to be used when no value is provided.
|
|
15904
16383
|
*
|
|
15905
16384
|
* If a non-singleton has the value of `null`, it means an empty collection.
|
|
16385
|
+
*
|
|
16386
|
+
* @exampleValue propertyDefaultValue
|
|
15906
16387
|
*/
|
|
15907
16388
|
default?: AnyValue;
|
|
15908
16389
|
/**
|
|
15909
16390
|
* A short description of the property.
|
|
16391
|
+
*
|
|
16392
|
+
* @exampleValue propertyDescription
|
|
15910
16393
|
*/
|
|
15911
16394
|
description?: string;
|
|
15912
16395
|
/**
|
|
15913
16396
|
* The display name of the property.
|
|
16397
|
+
*
|
|
16398
|
+
* @exampleValue propertyDisplayName
|
|
15914
16399
|
*/
|
|
15915
16400
|
displayName?: string;
|
|
15916
16401
|
/**
|
|
15917
16402
|
* An extended description and/or links to documentation.
|
|
16403
|
+
*
|
|
16404
|
+
* @exampleValue propertyDocumentation
|
|
15918
16405
|
*/
|
|
15919
16406
|
documentation?: string;
|
|
15920
16407
|
/**
|
|
15921
16408
|
* Defines if value is allowed to be modified when secret properties are not
|
|
16409
|
+
*
|
|
16410
|
+
* @exampleValue true
|
|
15922
16411
|
*/
|
|
15923
16412
|
forceSecretResubmission?: boolean;
|
|
15924
16413
|
/**
|
|
@@ -15941,14 +16430,20 @@ declare interface PropertyDefinition_2 {
|
|
|
15941
16430
|
migrationPattern?: string;
|
|
15942
16431
|
/**
|
|
15943
16432
|
* The minimum number of **objects** in a collection property.
|
|
16433
|
+
*
|
|
16434
|
+
* @exampleValue 1
|
|
15944
16435
|
*/
|
|
15945
16436
|
minObjects?: number;
|
|
15946
16437
|
/**
|
|
15947
16438
|
* Modification policy of the property.
|
|
16439
|
+
*
|
|
16440
|
+
* @exampleValue ALWAYS
|
|
15948
16441
|
*/
|
|
15949
16442
|
modificationPolicy?: 'ALWAYS' | 'DEFAULT' | 'NEVER';
|
|
15950
16443
|
/**
|
|
15951
16444
|
* The value can (`true`) or can't (`false`) be `null`.
|
|
16445
|
+
*
|
|
16446
|
+
* @exampleValue true
|
|
15952
16447
|
*/
|
|
15953
16448
|
nullable: boolean;
|
|
15954
16449
|
/**
|
|
@@ -15957,10 +16452,14 @@ declare interface PropertyDefinition_2 {
|
|
|
15957
16452
|
precondition?: Precondition;
|
|
15958
16453
|
/**
|
|
15959
16454
|
* The type referenced by the property value
|
|
16455
|
+
*
|
|
16456
|
+
* @exampleValue propertyReferencedType
|
|
15960
16457
|
*/
|
|
15961
16458
|
referencedType?: string;
|
|
15962
16459
|
/**
|
|
15963
16460
|
* The subtype of the property's value.
|
|
16461
|
+
*
|
|
16462
|
+
* @exampleValue propertySubType
|
|
15964
16463
|
*/
|
|
15965
16464
|
subType?: string;
|
|
15966
16465
|
/**
|
|
@@ -16135,6 +16634,8 @@ export declare interface ReactNativeMappingFileListDto {
|
|
|
16135
16634
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
16136
16635
|
*
|
|
16137
16636
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
16637
|
+
*
|
|
16638
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
16138
16639
|
*/
|
|
16139
16640
|
nextPageKey?: string;
|
|
16140
16641
|
/**
|
|
@@ -16175,6 +16676,8 @@ export declare interface ReactNativeMappingFileMetadataUpdateDto {
|
|
|
16175
16676
|
export declare interface RefPointer {
|
|
16176
16677
|
/**
|
|
16177
16678
|
* Pointer to a JSON object this object should be logically replaced with.
|
|
16679
|
+
*
|
|
16680
|
+
* @exampleValue refPointerToAnotherJsonObject
|
|
16178
16681
|
*/
|
|
16179
16682
|
$ref: string;
|
|
16180
16683
|
}
|
|
@@ -16330,58 +16833,92 @@ export declare enum RelatedServiceExposure {
|
|
|
16330
16833
|
export declare interface Release {
|
|
16331
16834
|
/**
|
|
16332
16835
|
* The entity has one or more problems
|
|
16836
|
+
*
|
|
16837
|
+
* @exampleValue true
|
|
16333
16838
|
*/
|
|
16334
16839
|
affectedByProblems?: boolean;
|
|
16335
16840
|
/**
|
|
16336
16841
|
* The entity has one or more security vulnerabilities
|
|
16842
|
+
*
|
|
16843
|
+
* @exampleValue true
|
|
16337
16844
|
*/
|
|
16338
16845
|
affectedBySecurityVulnerabilities?: boolean;
|
|
16339
16846
|
/**
|
|
16340
16847
|
* The instances entityIds included in this release
|
|
16848
|
+
*
|
|
16849
|
+
* @exampleValue ["PROCESS_GROUP_INSTANCE-49D94B90FB71C45B","PROCESS_GROUP_INSTANCE-7EA049157C82D1A5"]
|
|
16341
16850
|
*/
|
|
16342
16851
|
instances?: ReleaseInstance[];
|
|
16343
16852
|
/**
|
|
16344
16853
|
* The entity name
|
|
16854
|
+
*
|
|
16855
|
+
* @exampleValue cluster
|
|
16345
16856
|
*/
|
|
16346
16857
|
name?: string;
|
|
16347
16858
|
/**
|
|
16348
16859
|
* The number of problems of the entity
|
|
16860
|
+
*
|
|
16861
|
+
* @exampleValue 4
|
|
16862
|
+
*
|
|
16863
|
+
* @minimum 0
|
|
16349
16864
|
*/
|
|
16350
16865
|
problemCount?: number;
|
|
16351
16866
|
/**
|
|
16352
16867
|
* The product name
|
|
16868
|
+
*
|
|
16869
|
+
* @exampleValue Sockshop
|
|
16353
16870
|
*/
|
|
16354
16871
|
product?: string;
|
|
16355
16872
|
/**
|
|
16356
16873
|
* The entity id of correlating release.
|
|
16874
|
+
*
|
|
16875
|
+
* @exampleValue PROCESS_GROUP-DFDBAC9CBF104253
|
|
16357
16876
|
*/
|
|
16358
16877
|
releaseEntityId?: string;
|
|
16359
16878
|
/**
|
|
16360
16879
|
* The related PGI is still running/monitored
|
|
16880
|
+
*
|
|
16881
|
+
* @exampleValue true
|
|
16361
16882
|
*/
|
|
16362
16883
|
running?: boolean;
|
|
16363
16884
|
/**
|
|
16364
16885
|
* The number of security vulnerabilities of the entity
|
|
16886
|
+
*
|
|
16887
|
+
* @exampleValue 4
|
|
16888
|
+
*
|
|
16889
|
+
* @minimum 0
|
|
16365
16890
|
*/
|
|
16366
16891
|
securityVulnerabilitiesCount?: number;
|
|
16367
16892
|
/**
|
|
16368
16893
|
* Indicates that the security vulnerabilities feature is enabled
|
|
16894
|
+
*
|
|
16895
|
+
* @exampleValue true
|
|
16369
16896
|
*/
|
|
16370
16897
|
securityVulnerabilitiesEnabled?: boolean;
|
|
16371
16898
|
/**
|
|
16372
16899
|
* The software technologies of the release
|
|
16900
|
+
*
|
|
16901
|
+
* @exampleValue [{"edition":"OpenJDK","technology":"JAVA","verbatimType":"Java","version":"1.8.0_242"}]
|
|
16373
16902
|
*/
|
|
16374
16903
|
softwareTechs?: SoftwareTechs[];
|
|
16375
16904
|
/**
|
|
16376
16905
|
* The stage name
|
|
16906
|
+
*
|
|
16907
|
+
* @exampleValue staging
|
|
16377
16908
|
*/
|
|
16378
16909
|
stage?: string;
|
|
16379
16910
|
/**
|
|
16380
16911
|
* The count of bytes per second of the entity
|
|
16912
|
+
*
|
|
16913
|
+
* @exampleValue 923234
|
|
16914
|
+
*
|
|
16915
|
+
* @minimum 0
|
|
16381
16916
|
*/
|
|
16382
16917
|
throughput?: number;
|
|
16383
16918
|
/**
|
|
16384
16919
|
* The identified release version
|
|
16920
|
+
*
|
|
16921
|
+
* @exampleValue 1.195.34.12341232423-012342
|
|
16385
16922
|
*/
|
|
16386
16923
|
version?: string;
|
|
16387
16924
|
}
|
|
@@ -16393,18 +16930,26 @@ export declare interface Release {
|
|
|
16393
16930
|
export declare interface ReleaseInstance {
|
|
16394
16931
|
/**
|
|
16395
16932
|
* The build version
|
|
16933
|
+
*
|
|
16934
|
+
* @exampleValue 223005
|
|
16396
16935
|
*/
|
|
16397
16936
|
buildVersion?: string;
|
|
16398
16937
|
/**
|
|
16399
16938
|
* The entity id of the instance.
|
|
16939
|
+
*
|
|
16940
|
+
* @exampleValue PROCESS_GROUP_INSTANCE-DFDBAC9CBF104253
|
|
16400
16941
|
*/
|
|
16401
16942
|
entityId?: string;
|
|
16402
16943
|
/**
|
|
16403
16944
|
* List of event Ids of open problems
|
|
16945
|
+
*
|
|
16946
|
+
* @exampleValue ["573177299181554914_1616573184015V2"]
|
|
16404
16947
|
*/
|
|
16405
16948
|
problems?: string[];
|
|
16406
16949
|
/**
|
|
16407
16950
|
* List of Security vulnerabilities Ids
|
|
16951
|
+
*
|
|
16952
|
+
* @exampleValue ["SNYK-JAVA-COMFASTERXMLJACKSONCORE-1234567"]
|
|
16408
16953
|
*/
|
|
16409
16954
|
securityVulnerabilities?: string[];
|
|
16410
16955
|
}
|
|
@@ -16417,6 +16962,8 @@ export declare interface Releases {
|
|
|
16417
16962
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
16418
16963
|
*
|
|
16419
16964
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
16965
|
+
*
|
|
16966
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
16420
16967
|
*/
|
|
16421
16968
|
nextPageKey?: string;
|
|
16422
16969
|
/**
|
|
@@ -16518,7 +17065,11 @@ export declare class ReleasesClient {
|
|
|
16518
17065
|
*
|
|
16519
17066
|
* If not set, 100 is used.
|
|
16520
17067
|
*/ pageSize?: number;
|
|
16521
|
-
/**
|
|
17068
|
+
/**
|
|
17069
|
+
* Get your Releases (`false`) or a set of demo Releases (`true`).
|
|
17070
|
+
*
|
|
17071
|
+
* @defaultValue false
|
|
17072
|
+
*/ demo?: boolean;
|
|
16522
17073
|
/**
|
|
16523
17074
|
* Defines the scope of the query. Only Releases matching the provided criteria are included in the response.
|
|
16524
17075
|
*
|
|
@@ -16549,6 +17100,8 @@ export declare class ReleasesClient {
|
|
|
16549
17100
|
* * 'traffic': Traffic
|
|
16550
17101
|
*
|
|
16551
17102
|
* If not set, the ascending order sorting for name is applied.
|
|
17103
|
+
*
|
|
17104
|
+
* @defaultValue name
|
|
16552
17105
|
*/ sort?: string;
|
|
16553
17106
|
abortSignal?: AbortSignal_2;
|
|
16554
17107
|
}): Promise<Releases>;
|
|
@@ -16806,6 +17359,8 @@ export declare interface RemediationItemMuteStateChange {
|
|
|
16806
17359
|
muted: boolean;
|
|
16807
17360
|
/**
|
|
16808
17361
|
* The reason for the mute state change.
|
|
17362
|
+
*
|
|
17363
|
+
* @exampleValue IGNORE
|
|
16809
17364
|
*/
|
|
16810
17365
|
reason: 'AFFECTED' | 'CONFIGURATION_NOT_AFFECTED' | 'FALSE_POSITIVE' | 'IGNORE' | 'INITIAL_STATE' | 'OTHER' | 'VULNERABLE_CODE_NOT_IN_USE';
|
|
16811
17366
|
}
|
|
@@ -17121,10 +17676,14 @@ export declare interface RemediationProgressVulnerableComponent {
|
|
|
17121
17676
|
export declare interface RemoteConfigurationManagementEntityValidationError {
|
|
17122
17677
|
/**
|
|
17123
17678
|
* The ID of the entity for which validation failed.
|
|
17679
|
+
*
|
|
17680
|
+
* @exampleValue entityId
|
|
17124
17681
|
*/
|
|
17125
17682
|
entity?: string;
|
|
17126
17683
|
/**
|
|
17127
17684
|
* The reason of entity validation failure.
|
|
17685
|
+
*
|
|
17686
|
+
* @exampleValue ["RUNNING_IN_CONTAINER"]
|
|
17128
17687
|
*/
|
|
17129
17688
|
reasons?: Array<'CLOUD_NATIVE_NOT_SUPPORTED' | 'NOT_ALLOWED_WITH_CLUSTER_ACTIVE_GATE' | 'NOT_CONNECTED' | 'RUNNING_IN_CONTAINER' | 'STANDALONE_NOT_SUPPORTED' | 'VERSION_NOT_SUPPORTED'>;
|
|
17130
17689
|
}
|
|
@@ -17147,10 +17706,14 @@ export declare enum RemoteConfigurationManagementEntityValidationErrorReasonsIte
|
|
|
17147
17706
|
export declare interface RemoteConfigurationManagementJob {
|
|
17148
17707
|
/**
|
|
17149
17708
|
* Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was finished. This field is present only for finished jobs.
|
|
17709
|
+
*
|
|
17710
|
+
* @exampleValue 2020-11-05T08:15:30.144Z
|
|
17150
17711
|
*/
|
|
17151
17712
|
endTime?: string;
|
|
17152
17713
|
/**
|
|
17153
17714
|
* Type of entities modified by remote configuration management.
|
|
17715
|
+
*
|
|
17716
|
+
* @exampleValue ACTIVE_GATE or ONE_AGENT
|
|
17154
17717
|
*/
|
|
17155
17718
|
entityType?: 'ACTIVE_GATE' | 'ONE_AGENT';
|
|
17156
17719
|
/**
|
|
@@ -17159,10 +17722,14 @@ export declare interface RemoteConfigurationManagementJob {
|
|
|
17159
17722
|
failedEntities?: RemoteIdentityOperationFailedEntityDto[];
|
|
17160
17723
|
/**
|
|
17161
17724
|
* The ID of the remote configuration management job.
|
|
17725
|
+
*
|
|
17726
|
+
* @exampleValue 7974003406714390819
|
|
17162
17727
|
*/
|
|
17163
17728
|
id?: string;
|
|
17164
17729
|
/**
|
|
17165
17730
|
* A list of in-progress remote configuration management jobs.
|
|
17731
|
+
*
|
|
17732
|
+
* @exampleValue ["HOST-D454A967666E7970"]
|
|
17166
17733
|
*/
|
|
17167
17734
|
inProgressEntities?: string[];
|
|
17168
17735
|
/**
|
|
@@ -17171,18 +17738,26 @@ export declare interface RemoteConfigurationManagementJob {
|
|
|
17171
17738
|
operations?: RemoteConfigurationManagementOperation[];
|
|
17172
17739
|
/**
|
|
17173
17740
|
* Number of entities that were already processed at the time the response was created.
|
|
17741
|
+
*
|
|
17742
|
+
* @exampleValue 1
|
|
17174
17743
|
*/
|
|
17175
17744
|
processedEntitiesCount?: number;
|
|
17176
17745
|
/**
|
|
17177
17746
|
* Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was started.
|
|
17747
|
+
*
|
|
17748
|
+
* @exampleValue 2020-11-05T08:15:30.144Z
|
|
17178
17749
|
*/
|
|
17179
17750
|
startTime?: string;
|
|
17180
17751
|
/**
|
|
17181
17752
|
* Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the running remote configuration management job will time-out. This field is present only for running jobs.
|
|
17753
|
+
*
|
|
17754
|
+
* @exampleValue 2020-11-05T08:15:30.144Z
|
|
17182
17755
|
*/
|
|
17183
17756
|
timeoutTime?: string;
|
|
17184
17757
|
/**
|
|
17185
17758
|
* Total number of entities to process.
|
|
17759
|
+
*
|
|
17760
|
+
* @exampleValue 1
|
|
17186
17761
|
*/
|
|
17187
17762
|
totalEntitiesCount?: number;
|
|
17188
17763
|
}
|
|
@@ -17213,22 +17788,32 @@ export declare interface RemoteConfigurationManagementJobList {
|
|
|
17213
17788
|
export declare interface RemoteConfigurationManagementJobPreview {
|
|
17214
17789
|
/**
|
|
17215
17790
|
* The number of entities that are currently configured as defined by remote configuration management operation.
|
|
17791
|
+
*
|
|
17792
|
+
* @exampleValue 1
|
|
17216
17793
|
*/
|
|
17217
17794
|
alreadyConfiguredEntitiesCount?: number;
|
|
17218
17795
|
/**
|
|
17219
17796
|
* The attribute which is affected by the operation.
|
|
17797
|
+
*
|
|
17798
|
+
* @exampleValue networkZone
|
|
17220
17799
|
*/
|
|
17221
17800
|
attribute?: 'group' | 'hostGroup' | 'hostProperty' | 'hostTag' | 'networkZone';
|
|
17222
17801
|
/**
|
|
17223
17802
|
* The operation performed on given attribute.
|
|
17803
|
+
*
|
|
17804
|
+
* @exampleValue set
|
|
17224
17805
|
*/
|
|
17225
17806
|
operation?: 'clear' | 'set';
|
|
17226
17807
|
/**
|
|
17227
17808
|
* The number of entities that will be configured as defined by remote configuration management after it is completed.
|
|
17809
|
+
*
|
|
17810
|
+
* @exampleValue 2
|
|
17228
17811
|
*/
|
|
17229
17812
|
targetEntitiesCount?: number;
|
|
17230
17813
|
/**
|
|
17231
17814
|
* The value which should be assigned to given attribute.
|
|
17815
|
+
*
|
|
17816
|
+
* @exampleValue exampleNetworkZoneName
|
|
17232
17817
|
*/
|
|
17233
17818
|
value?: string;
|
|
17234
17819
|
}
|
|
@@ -17262,18 +17847,26 @@ export declare enum RemoteConfigurationManagementJobPreviewOperation {
|
|
|
17262
17847
|
export declare interface RemoteConfigurationManagementJobSummary {
|
|
17263
17848
|
/**
|
|
17264
17849
|
* Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was finished. This field is present only for finished jobs.
|
|
17850
|
+
*
|
|
17851
|
+
* @exampleValue 2020-11-05T08:15:30.144Z
|
|
17265
17852
|
*/
|
|
17266
17853
|
endTime?: string;
|
|
17267
17854
|
/**
|
|
17268
17855
|
* Type of entities modified by remote configuration management.
|
|
17856
|
+
*
|
|
17857
|
+
* @exampleValue ACTIVE_GATE or ONE_AGENT
|
|
17269
17858
|
*/
|
|
17270
17859
|
entityType?: 'ACTIVE_GATE' | 'ONE_AGENT';
|
|
17271
17860
|
/**
|
|
17272
17861
|
* The ID of the remote configuration management job.
|
|
17862
|
+
*
|
|
17863
|
+
* @exampleValue 7974003406714390819
|
|
17273
17864
|
*/
|
|
17274
17865
|
id?: string;
|
|
17275
17866
|
/**
|
|
17276
17867
|
* Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was started.
|
|
17868
|
+
*
|
|
17869
|
+
* @exampleValue 2020-11-05T08:15:30.144Z
|
|
17277
17870
|
*/
|
|
17278
17871
|
startTime?: string;
|
|
17279
17872
|
}
|
|
@@ -17294,14 +17887,20 @@ export declare enum RemoteConfigurationManagementJobSummaryEntityType {
|
|
|
17294
17887
|
export declare interface RemoteConfigurationManagementOperation {
|
|
17295
17888
|
/**
|
|
17296
17889
|
* The attribute which is affected by the operation.
|
|
17890
|
+
*
|
|
17891
|
+
* @exampleValue networkZone
|
|
17297
17892
|
*/
|
|
17298
17893
|
attribute: 'group' | 'hostGroup' | 'hostProperty' | 'hostTag' | 'networkZone';
|
|
17299
17894
|
/**
|
|
17300
17895
|
* The operation performed on given attribute.
|
|
17896
|
+
*
|
|
17897
|
+
* @exampleValue set
|
|
17301
17898
|
*/
|
|
17302
17899
|
operation: 'clear' | 'set';
|
|
17303
17900
|
/**
|
|
17304
17901
|
* The value which should be assigned to given attribute.
|
|
17902
|
+
*
|
|
17903
|
+
* @exampleValue exampleNetworkZoneName
|
|
17305
17904
|
*/
|
|
17306
17905
|
value?: string;
|
|
17307
17906
|
}
|
|
@@ -17312,6 +17911,8 @@ export declare interface RemoteConfigurationManagementOperation {
|
|
|
17312
17911
|
export declare interface RemoteConfigurationManagementOperationActiveGateRequest {
|
|
17313
17912
|
/**
|
|
17314
17913
|
* A list of entities IDs for which remote configuration management is to be executed.
|
|
17914
|
+
*
|
|
17915
|
+
* @exampleValue ["0x2b7c0b02","0x4928065d"]
|
|
17315
17916
|
*/
|
|
17316
17917
|
entities: string[];
|
|
17317
17918
|
/**
|
|
@@ -17339,6 +17940,8 @@ export declare enum RemoteConfigurationManagementOperationAttribute {
|
|
|
17339
17940
|
export declare interface RemoteConfigurationManagementOperationOneAgentRequest {
|
|
17340
17941
|
/**
|
|
17341
17942
|
* A list of entities IDs for which remote configuration management is to be executed.
|
|
17943
|
+
*
|
|
17944
|
+
* @exampleValue ["HOST-D454A967666E7970","HOST-811760CFF2A5E872"]
|
|
17342
17945
|
*/
|
|
17343
17946
|
entities: string[];
|
|
17344
17947
|
/**
|
|
@@ -17363,18 +17966,26 @@ export declare enum RemoteConfigurationManagementOperationOperation {
|
|
|
17363
17966
|
export declare interface RemoteConfigurationManagementOperationValidationError {
|
|
17364
17967
|
/**
|
|
17365
17968
|
* The attribute which is affected by the operation.
|
|
17969
|
+
*
|
|
17970
|
+
* @exampleValue networkZone
|
|
17366
17971
|
*/
|
|
17367
17972
|
attribute?: 'group' | 'hostGroup' | 'hostProperty' | 'hostTag' | 'networkZone';
|
|
17368
17973
|
/**
|
|
17369
17974
|
* The operation performed on given attribute.
|
|
17975
|
+
*
|
|
17976
|
+
* @exampleValue set
|
|
17370
17977
|
*/
|
|
17371
17978
|
operation?: 'clear' | 'set';
|
|
17372
17979
|
/**
|
|
17373
17980
|
* The reason of validation failure.
|
|
17981
|
+
*
|
|
17982
|
+
* @exampleValue Value must not start with a period
|
|
17374
17983
|
*/
|
|
17375
17984
|
reason?: string;
|
|
17376
17985
|
/**
|
|
17377
17986
|
* The value which should be assigned to given attribute.
|
|
17987
|
+
*
|
|
17988
|
+
* @exampleValue .exampleInvalidNetworkZoneName
|
|
17378
17989
|
*/
|
|
17379
17990
|
value?: string;
|
|
17380
17991
|
}
|
|
@@ -17436,14 +18047,20 @@ export declare class RemoteConfigurationManagementValidationResultError extends
|
|
|
17436
18047
|
export declare interface RemoteIdentityOperationFailedEntityDto {
|
|
17437
18048
|
/**
|
|
17438
18049
|
* Entity ID for which remote configuration management request was failed
|
|
18050
|
+
*
|
|
18051
|
+
* @exampleValue HOST-D454A967666E7970
|
|
17439
18052
|
*/
|
|
17440
18053
|
entityId?: string;
|
|
17441
18054
|
/**
|
|
17442
18055
|
* Communication settings changing failure error description
|
|
18056
|
+
*
|
|
18057
|
+
* @exampleValue Failed to access new tenant: f47ac10b-58cc-4372-a567-0e02b2c3d479
|
|
17443
18058
|
*/
|
|
17444
18059
|
failureMessage?: string;
|
|
17445
18060
|
/**
|
|
17446
18061
|
* Reason of communication settings changing failure.
|
|
18062
|
+
*
|
|
18063
|
+
* @exampleValue CONNECTION_FAILURE
|
|
17447
18064
|
*/
|
|
17448
18065
|
failureReason?: 'CONNECTION_FAILURE' | 'TIMEOUT';
|
|
17449
18066
|
}
|
|
@@ -17630,6 +18247,8 @@ export declare interface RevisionDiff {
|
|
|
17630
18247
|
export declare interface RevisionDiffPage {
|
|
17631
18248
|
/**
|
|
17632
18249
|
* The 'to' time in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') from the original request.
|
|
18250
|
+
*
|
|
18251
|
+
* @exampleValue 2024-06-24T01:02:03Z
|
|
17633
18252
|
*/
|
|
17634
18253
|
endTime: string;
|
|
17635
18254
|
/**
|
|
@@ -17640,6 +18259,8 @@ export declare interface RevisionDiffPage {
|
|
|
17640
18259
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
17641
18260
|
*
|
|
17642
18261
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
18262
|
+
*
|
|
18263
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
17643
18264
|
*/
|
|
17644
18265
|
nextPageKey?: string;
|
|
17645
18266
|
/**
|
|
@@ -17648,6 +18269,8 @@ export declare interface RevisionDiffPage {
|
|
|
17648
18269
|
pageSize: number;
|
|
17649
18270
|
/**
|
|
17650
18271
|
* The 'from' time in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') from the original request.
|
|
18272
|
+
*
|
|
18273
|
+
* @exampleValue 2024-06-10T01:02:03Z
|
|
17651
18274
|
*/
|
|
17652
18275
|
startTime: string;
|
|
17653
18276
|
}
|
|
@@ -18271,6 +18894,8 @@ export declare const rumManualInsertionTagsClient: RumManualInsertionTagsClient;
|
|
|
18271
18894
|
export declare interface SchemaConstraintRestDto {
|
|
18272
18895
|
/**
|
|
18273
18896
|
* The maximum allowed size in bytes for the sum over all persisted values for the schema
|
|
18897
|
+
*
|
|
18898
|
+
* @exampleValue 500000
|
|
18274
18899
|
*/
|
|
18275
18900
|
byteLimit?: number;
|
|
18276
18901
|
/**
|
|
@@ -18279,6 +18904,8 @@ export declare interface SchemaConstraintRestDto {
|
|
|
18279
18904
|
customMessage?: string;
|
|
18280
18905
|
/**
|
|
18281
18906
|
* The ID of a custom validator.
|
|
18907
|
+
*
|
|
18908
|
+
* @exampleValue my-min-max
|
|
18282
18909
|
*/
|
|
18283
18910
|
customValidatorId?: string;
|
|
18284
18911
|
/**
|
|
@@ -18287,6 +18914,8 @@ export declare interface SchemaConstraintRestDto {
|
|
|
18287
18914
|
flattenCollections?: boolean;
|
|
18288
18915
|
/**
|
|
18289
18916
|
* Whether to skip validation on a change made from the UI.
|
|
18917
|
+
*
|
|
18918
|
+
* @exampleValue false
|
|
18290
18919
|
*/
|
|
18291
18920
|
skipAsyncValidation?: boolean;
|
|
18292
18921
|
/**
|
|
@@ -18295,6 +18924,8 @@ export declare interface SchemaConstraintRestDto {
|
|
|
18295
18924
|
type: 'BYTE_SIZE_LIMIT' | 'CUSTOM_VALIDATOR_REF' | 'MULTI_SCOPE_CUSTOM_VALIDATOR_REF' | 'MULTI_SCOPE_UNIQUE' | 'UNIQUE' | 'UNKNOWN';
|
|
18296
18925
|
/**
|
|
18297
18926
|
* The list of properties for which the combination of values needs to be unique
|
|
18927
|
+
*
|
|
18928
|
+
* @exampleValue ["my-prop-1","my-prop-2"]
|
|
18298
18929
|
*/
|
|
18299
18930
|
uniqueProperties?: string[];
|
|
18300
18931
|
}
|
|
@@ -18316,6 +18947,8 @@ export declare enum SchemaConstraintRestDtoType {
|
|
|
18316
18947
|
export declare interface SchemaDefinitionRestDto {
|
|
18317
18948
|
/**
|
|
18318
18949
|
* A list of scopes where the schema can be used.
|
|
18950
|
+
*
|
|
18951
|
+
* @exampleValue ["host","application"]
|
|
18319
18952
|
*/
|
|
18320
18953
|
allowedScopes: string[];
|
|
18321
18954
|
/**
|
|
@@ -18328,10 +18961,14 @@ export declare interface SchemaDefinitionRestDto {
|
|
|
18328
18961
|
deletionConstraints?: DeletionConstraint[];
|
|
18329
18962
|
/**
|
|
18330
18963
|
* A short description of the schema.
|
|
18964
|
+
*
|
|
18965
|
+
* @exampleValue Dynatrace disables monitoring of containers that do not run any applications
|
|
18331
18966
|
*/
|
|
18332
18967
|
description: string;
|
|
18333
18968
|
/**
|
|
18334
18969
|
* The display name of the schema.
|
|
18970
|
+
*
|
|
18971
|
+
* @exampleValue Built-in container monitoring rules
|
|
18335
18972
|
*/
|
|
18336
18973
|
displayName: string;
|
|
18337
18974
|
/**
|
|
@@ -18340,6 +18977,8 @@ export declare interface SchemaDefinitionRestDto {
|
|
|
18340
18977
|
documentation?: string;
|
|
18341
18978
|
/**
|
|
18342
18979
|
* The version of the data format.
|
|
18980
|
+
*
|
|
18981
|
+
* @exampleValue 1
|
|
18343
18982
|
*/
|
|
18344
18983
|
dynatrace: string;
|
|
18345
18984
|
/**
|
|
@@ -18348,6 +18987,8 @@ export declare interface SchemaDefinitionRestDto {
|
|
|
18348
18987
|
enums: SchemaDefinitionRestDtoEnums;
|
|
18349
18988
|
/**
|
|
18350
18989
|
* Name of the key property in this schema.
|
|
18990
|
+
*
|
|
18991
|
+
* @exampleValue keyProperty
|
|
18351
18992
|
*/
|
|
18352
18993
|
keyProperty?: string;
|
|
18353
18994
|
/**
|
|
@@ -18358,12 +18999,16 @@ export declare interface SchemaDefinitionRestDto {
|
|
|
18358
18999
|
* - GENERAL_AVAILABILITY: Features marked "general availability" are the most stable. While the schemas will still evolve over time, care will be taken to only do so in a backward-compatible manner.
|
|
18359
19000
|
*
|
|
18360
19001
|
* In any case, automations should make use of the `schemaVersion` field when writing settings objects.
|
|
19002
|
+
*
|
|
19003
|
+
* @exampleValue GENERAL_AVAILABILITY
|
|
18361
19004
|
*/
|
|
18362
19005
|
maturity?: 'EARLY_ADOPTER' | 'GENERAL_AVAILABILITY' | 'PREVIEW';
|
|
18363
19006
|
/**
|
|
18364
19007
|
* The maximum amount of objects per scope.
|
|
18365
19008
|
*
|
|
18366
19009
|
* Only applicable when **multiObject** is set to `true`.
|
|
19010
|
+
*
|
|
19011
|
+
* @exampleValue 10
|
|
18367
19012
|
*/
|
|
18368
19013
|
maxObjects: number;
|
|
18369
19014
|
/**
|
|
@@ -18390,10 +19035,14 @@ export declare interface SchemaDefinitionRestDto {
|
|
|
18390
19035
|
schemaConstraints?: SchemaConstraintRestDto[];
|
|
18391
19036
|
/**
|
|
18392
19037
|
* Names of the groups, which the schema belongs to.
|
|
19038
|
+
*
|
|
19039
|
+
* @exampleValue ["group:some.1","group:some.2"]
|
|
18393
19040
|
*/
|
|
18394
19041
|
schemaGroups?: string[];
|
|
18395
19042
|
/**
|
|
18396
19043
|
* The ID of the schema.
|
|
19044
|
+
*
|
|
19045
|
+
* @exampleValue builtin:container.built-in-monitoring-rule
|
|
18397
19046
|
*/
|
|
18398
19047
|
schemaId: string;
|
|
18399
19048
|
/**
|
|
@@ -18412,6 +19061,8 @@ export declare interface SchemaDefinitionRestDto {
|
|
|
18412
19061
|
uiCustomization?: UiCustomization;
|
|
18413
19062
|
/**
|
|
18414
19063
|
* The version of the schema.
|
|
19064
|
+
*
|
|
19065
|
+
* @exampleValue 1.4.2
|
|
18415
19066
|
*/
|
|
18416
19067
|
version: string;
|
|
18417
19068
|
}
|
|
@@ -18487,6 +19138,8 @@ export declare interface SchemaList {
|
|
|
18487
19138
|
items: SchemaStub[];
|
|
18488
19139
|
/**
|
|
18489
19140
|
* The number of schemas in the list.
|
|
19141
|
+
*
|
|
19142
|
+
* @exampleValue 1
|
|
18490
19143
|
*/
|
|
18491
19144
|
totalCount: number;
|
|
18492
19145
|
}
|
|
@@ -18504,10 +19157,14 @@ export declare interface SchemasList {
|
|
|
18504
19157
|
export declare interface SchemaStub {
|
|
18505
19158
|
/**
|
|
18506
19159
|
* The name of the schema.
|
|
19160
|
+
*
|
|
19161
|
+
* @exampleValue Built-in container monitoring rules
|
|
18507
19162
|
*/
|
|
18508
19163
|
displayName?: string;
|
|
18509
19164
|
/**
|
|
18510
19165
|
* The most recent version of the schema.
|
|
19166
|
+
*
|
|
19167
|
+
* @exampleValue 1.4.2
|
|
18511
19168
|
*/
|
|
18512
19169
|
latestSchemaVersion?: string;
|
|
18513
19170
|
/**
|
|
@@ -18518,22 +19175,32 @@ export declare interface SchemaStub {
|
|
|
18518
19175
|
* - GENERAL_AVAILABILITY: Features marked "general availability" are the most stable. While the schemas will still evolve over time, care will be taken to only do so in a backward-compatible manner.
|
|
18519
19176
|
*
|
|
18520
19177
|
* In any case, automations should make use of the `schemaVersion` field when writing settings objects.
|
|
19178
|
+
*
|
|
19179
|
+
* @exampleValue GENERAL_AVAILABILITY
|
|
18521
19180
|
*/
|
|
18522
19181
|
maturity?: 'EARLY_ADOPTER' | 'GENERAL_AVAILABILITY' | 'PREVIEW';
|
|
18523
19182
|
/**
|
|
18524
19183
|
* Multi-object flag. `True` if the schema is a multi-object schema
|
|
19184
|
+
*
|
|
19185
|
+
* @exampleValue true
|
|
18525
19186
|
*/
|
|
18526
19187
|
multiObject?: boolean;
|
|
18527
19188
|
/**
|
|
18528
19189
|
* Ordered flag. `True` if the schema is an ordered multi-object schema.
|
|
19190
|
+
*
|
|
19191
|
+
* @exampleValue false
|
|
18529
19192
|
*/
|
|
18530
19193
|
ordered?: boolean;
|
|
18531
19194
|
/**
|
|
18532
19195
|
* Owner based access control flag. `True` if the schema has owner based access control enabled.
|
|
19196
|
+
*
|
|
19197
|
+
* @exampleValue true
|
|
18533
19198
|
*/
|
|
18534
19199
|
ownerBasedAccessControl?: boolean;
|
|
18535
19200
|
/**
|
|
18536
19201
|
* The ID of the schema.
|
|
19202
|
+
*
|
|
19203
|
+
* @exampleValue builtin:container.built-in-monitoring-rule
|
|
18537
19204
|
*/
|
|
18538
19205
|
schemaId?: string;
|
|
18539
19206
|
}
|
|
@@ -18567,14 +19234,20 @@ export declare interface SchemaType {
|
|
|
18567
19234
|
constraints?: ComplexConstraint[];
|
|
18568
19235
|
/**
|
|
18569
19236
|
* A short description of the property.
|
|
19237
|
+
*
|
|
19238
|
+
* @exampleValue typeDescription
|
|
18570
19239
|
*/
|
|
18571
19240
|
description: string;
|
|
18572
19241
|
/**
|
|
18573
19242
|
* The display name of the property.
|
|
19243
|
+
*
|
|
19244
|
+
* @exampleValue typeDisplayName
|
|
18574
19245
|
*/
|
|
18575
19246
|
displayName?: string;
|
|
18576
19247
|
/**
|
|
18577
19248
|
* An extended description and/or links to documentation.
|
|
19249
|
+
*
|
|
19250
|
+
* @exampleValue typeDocumentation
|
|
18578
19251
|
*/
|
|
18579
19252
|
documentation: string;
|
|
18580
19253
|
/**
|
|
@@ -18583,22 +19256,32 @@ export declare interface SchemaType {
|
|
|
18583
19256
|
properties: SchemaTypeProperties;
|
|
18584
19257
|
/**
|
|
18585
19258
|
* The pattern for the summary search(for example, "Alert after *X* minutes.") of the configuration in the UI.
|
|
19259
|
+
*
|
|
19260
|
+
* @exampleValue searchPatternOfType
|
|
18586
19261
|
*/
|
|
18587
19262
|
searchPattern?: string;
|
|
18588
19263
|
/**
|
|
18589
19264
|
* The pattern for the summary (for example, "Alert after *X* minutes.") of the configuration in the UI.
|
|
19265
|
+
*
|
|
19266
|
+
* @exampleValue summaryPatternOfType
|
|
18590
19267
|
*/
|
|
18591
19268
|
summaryPattern: string;
|
|
18592
19269
|
/**
|
|
18593
19270
|
* Type of the reference type.
|
|
19271
|
+
*
|
|
19272
|
+
* @exampleValue object
|
|
18594
19273
|
*/
|
|
18595
19274
|
type: 'object';
|
|
18596
19275
|
/**
|
|
18597
19276
|
* The version of the type.
|
|
19277
|
+
*
|
|
19278
|
+
* @exampleValue 0
|
|
18598
19279
|
*/
|
|
18599
19280
|
version: string;
|
|
18600
19281
|
/**
|
|
18601
19282
|
* A short description of the version.
|
|
19283
|
+
*
|
|
19284
|
+
* @exampleValue Added new property
|
|
18602
19285
|
*/
|
|
18603
19286
|
versionInfo?: string;
|
|
18604
19287
|
}
|
|
@@ -18647,7 +19330,7 @@ export declare interface SecurityContextDtoImpl {
|
|
|
18647
19330
|
/**
|
|
18648
19331
|
* The security context, that will be set for matching entities. If there exists a management zone with this name, it will be set for all matching entities, overriding all automatic management zone rules.
|
|
18649
19332
|
*/
|
|
18650
|
-
securityContext
|
|
19333
|
+
securityContext: string[];
|
|
18651
19334
|
}
|
|
18652
19335
|
|
|
18653
19336
|
/**
|
|
@@ -19008,6 +19691,8 @@ export declare interface SecurityProblemEventsList {
|
|
|
19008
19691
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
19009
19692
|
*
|
|
19010
19693
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
19694
|
+
*
|
|
19695
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
19011
19696
|
*/
|
|
19012
19697
|
nextPageKey?: string;
|
|
19013
19698
|
/**
|
|
@@ -19028,6 +19713,8 @@ export declare interface SecurityProblemList {
|
|
|
19028
19713
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
19029
19714
|
*
|
|
19030
19715
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
19716
|
+
*
|
|
19717
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
19031
19718
|
*/
|
|
19032
19719
|
nextPageKey?: string;
|
|
19033
19720
|
/**
|
|
@@ -19926,6 +20613,8 @@ export declare enum SecurityProblemVulnerabilityType {
|
|
|
19926
20613
|
export declare interface SelectionDto {
|
|
19927
20614
|
/**
|
|
19928
20615
|
* Selection index.
|
|
20616
|
+
*
|
|
20617
|
+
* @minimum 0
|
|
19929
20618
|
*/
|
|
19930
20619
|
index: number;
|
|
19931
20620
|
/**
|
|
@@ -19944,6 +20633,8 @@ export declare interface SelectOptionStepDto extends SyntheticBrowserMonitorStep
|
|
|
19944
20633
|
selections: SelectionDto[];
|
|
19945
20634
|
/**
|
|
19946
20635
|
* Target of Browser Monitor step.
|
|
20636
|
+
*
|
|
20637
|
+
* @exampleValue {"locators":[{"type":"CSS","value":"<img>[id='logoIcon']"},{"type":"CSS","value":"<a>[id='externalSite']"}],"window":"ruxitWin[0]"}
|
|
19947
20638
|
*/
|
|
19948
20639
|
target?: TargetDto;
|
|
19949
20640
|
/**
|
|
@@ -19952,6 +20643,8 @@ export declare interface SelectOptionStepDto extends SyntheticBrowserMonitorStep
|
|
|
19952
20643
|
validationRules?: ValidationRuleDto[];
|
|
19953
20644
|
/**
|
|
19954
20645
|
* Wait condition for Browser Monitor step.
|
|
20646
|
+
*
|
|
20647
|
+
* @exampleValue {"type":"NETWORK"}
|
|
19955
20648
|
*/
|
|
19956
20649
|
waitCondition?: BaseWaitConditionDto;
|
|
19957
20650
|
}
|
|
@@ -20079,6 +20772,8 @@ export declare class ServiceLevelObjectivesClient {
|
|
|
20079
20772
|
* * `-name`: Names in descending order.
|
|
20080
20773
|
*
|
|
20081
20774
|
* If not set, the ascending order is used.
|
|
20775
|
+
*
|
|
20776
|
+
* @defaultValue name
|
|
20082
20777
|
*/ sort?: string;
|
|
20083
20778
|
/**
|
|
20084
20779
|
* The timeframe to calculate the SLO values:
|
|
@@ -20088,10 +20783,18 @@ export declare class ServiceLevelObjectivesClient {
|
|
|
20088
20783
|
*
|
|
20089
20784
|
* If not set, the `CURRENT` value is used.
|
|
20090
20785
|
*/ timeFrame?: 'CURRENT' | 'GTF';
|
|
20091
|
-
/**
|
|
20786
|
+
/**
|
|
20787
|
+
* Get your SLOs (`false`) or a set of demo SLOs (`true`).
|
|
20788
|
+
*
|
|
20789
|
+
* @defaultValue false
|
|
20790
|
+
*/ demo?: boolean;
|
|
20092
20791
|
/** Get your SLOs without them being evaluated (`false`) or with evaluations (`true`) with maximum `pageSize` of 25. */ evaluate?: 'true' | 'false';
|
|
20093
20792
|
/** Get your enabled SLOs (`true`), disabled ones (`false`) or both enabled and disabled ones (`all`). */ enabledSlos?: 'true' | 'false' | 'all';
|
|
20094
|
-
/**
|
|
20793
|
+
/**
|
|
20794
|
+
* Get your global SLOs (`true`) regardless of the selected filter or filter them out (`false`).
|
|
20795
|
+
*
|
|
20796
|
+
* @defaultValue true
|
|
20797
|
+
*/ showGlobalSlos?: boolean;
|
|
20095
20798
|
abortSignal?: AbortSignal_2;
|
|
20096
20799
|
}): Promise<SLOs>;
|
|
20097
20800
|
/**
|
|
@@ -20381,6 +21084,8 @@ export declare const settingsManagementZonesClient: SettingsManagementZonesClien
|
|
|
20381
21084
|
export declare interface SettingsObject {
|
|
20382
21085
|
/**
|
|
20383
21086
|
* The user (identified by a user ID or a public token ID) who performed that most recent modification.
|
|
21087
|
+
*
|
|
21088
|
+
* @exampleValue john.doe@example.com
|
|
20384
21089
|
*/
|
|
20385
21090
|
author?: string;
|
|
20386
21091
|
/**
|
|
@@ -20389,6 +21094,8 @@ export declare interface SettingsObject {
|
|
|
20389
21094
|
created?: number;
|
|
20390
21095
|
/**
|
|
20391
21096
|
* The unique identifier of the user who created the settings object.
|
|
21097
|
+
*
|
|
21098
|
+
* @exampleValue fab17b7a-2eb2-4c95-b818-743d94be2c30
|
|
20392
21099
|
*/
|
|
20393
21100
|
createdBy?: string;
|
|
20394
21101
|
/**
|
|
@@ -20407,10 +21114,14 @@ export declare interface SettingsObject {
|
|
|
20407
21114
|
modified?: number;
|
|
20408
21115
|
/**
|
|
20409
21116
|
* The unique identifier of the user who performed the most recent modification.
|
|
21117
|
+
*
|
|
21118
|
+
* @exampleValue fab17b7a-2eb2-4c95-b818-743d94be2c30
|
|
20410
21119
|
*/
|
|
20411
21120
|
modifiedBy?: string;
|
|
20412
21121
|
/**
|
|
20413
21122
|
* The ID of the settings object.
|
|
21123
|
+
*
|
|
21124
|
+
* @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
|
|
20414
21125
|
*/
|
|
20415
21126
|
objectId?: string;
|
|
20416
21127
|
/**
|
|
@@ -20423,14 +21134,20 @@ export declare interface SettingsObject {
|
|
|
20423
21134
|
resourceContext?: ResourceContext;
|
|
20424
21135
|
/**
|
|
20425
21136
|
* The schema on which the object is based.
|
|
21137
|
+
*
|
|
21138
|
+
* @exampleValue builtin:container.built-in-monitoring-rule
|
|
20426
21139
|
*/
|
|
20427
21140
|
schemaId?: string;
|
|
20428
21141
|
/**
|
|
20429
21142
|
* The version of the schema on which the object is based.
|
|
21143
|
+
*
|
|
21144
|
+
* @exampleValue 1.0.0
|
|
20430
21145
|
*/
|
|
20431
21146
|
schemaVersion?: string;
|
|
20432
21147
|
/**
|
|
20433
21148
|
* The scope that the object targets. For more details, please see [Dynatrace Documentation](https://dt-url.net/ky03459).
|
|
21149
|
+
*
|
|
21150
|
+
* @exampleValue HOST-D3A3C5A146830A79
|
|
20434
21151
|
*/
|
|
20435
21152
|
scope?: string;
|
|
20436
21153
|
/**
|
|
@@ -20447,6 +21164,8 @@ export declare interface SettingsObject {
|
|
|
20447
21164
|
* It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.
|
|
20448
21165
|
*
|
|
20449
21166
|
* If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
|
|
21167
|
+
*
|
|
21168
|
+
* @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
|
|
20450
21169
|
*/
|
|
20451
21170
|
updateToken?: string;
|
|
20452
21171
|
/**
|
|
@@ -20455,6 +21174,8 @@ export declare interface SettingsObject {
|
|
|
20455
21174
|
* It defines the actual values of settings' parameters.
|
|
20456
21175
|
*
|
|
20457
21176
|
* The actual content depends on the object's schema.
|
|
21177
|
+
*
|
|
21178
|
+
* @exampleValue {"autoMonitoring":true}
|
|
20458
21179
|
*/
|
|
20459
21180
|
value?: AnyValue;
|
|
20460
21181
|
}
|
|
@@ -20465,6 +21186,8 @@ export declare interface SettingsObject {
|
|
|
20465
21186
|
export declare interface SettingsObjectByObjectIdResponse {
|
|
20466
21187
|
/**
|
|
20467
21188
|
* The user (identified by a user ID or a public token ID) who performed that most recent modification.
|
|
21189
|
+
*
|
|
21190
|
+
* @exampleValue john.doe@example.com
|
|
20468
21191
|
*/
|
|
20469
21192
|
author?: string;
|
|
20470
21193
|
/**
|
|
@@ -20473,6 +21196,8 @@ export declare interface SettingsObjectByObjectIdResponse {
|
|
|
20473
21196
|
created?: number;
|
|
20474
21197
|
/**
|
|
20475
21198
|
* The unique identifier of the user who created the settings object.
|
|
21199
|
+
*
|
|
21200
|
+
* @exampleValue fab17b7a-2eb2-4c95-b818-743d94be2c30
|
|
20476
21201
|
*/
|
|
20477
21202
|
createdBy?: string;
|
|
20478
21203
|
/**
|
|
@@ -20485,10 +21210,14 @@ export declare interface SettingsObjectByObjectIdResponse {
|
|
|
20485
21210
|
modified?: number;
|
|
20486
21211
|
/**
|
|
20487
21212
|
* The unique identifier of the user who performed the most recent modification.
|
|
21213
|
+
*
|
|
21214
|
+
* @exampleValue fab17b7a-2eb2-4c95-b818-743d94be2c30
|
|
20488
21215
|
*/
|
|
20489
21216
|
modifiedBy?: string;
|
|
20490
21217
|
/**
|
|
20491
21218
|
* The ID of the settings object.
|
|
21219
|
+
*
|
|
21220
|
+
* @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
|
|
20492
21221
|
*/
|
|
20493
21222
|
objectId?: string;
|
|
20494
21223
|
/**
|
|
@@ -20501,14 +21230,20 @@ export declare interface SettingsObjectByObjectIdResponse {
|
|
|
20501
21230
|
resourceContext?: ResourceContext;
|
|
20502
21231
|
/**
|
|
20503
21232
|
* The schema on which the object is based.
|
|
21233
|
+
*
|
|
21234
|
+
* @exampleValue builtin:container.built-in-monitoring-rule
|
|
20504
21235
|
*/
|
|
20505
21236
|
schemaId?: string;
|
|
20506
21237
|
/**
|
|
20507
21238
|
* The version of the schema on which the object is based.
|
|
21239
|
+
*
|
|
21240
|
+
* @exampleValue 1.0.0
|
|
20508
21241
|
*/
|
|
20509
21242
|
schemaVersion?: string;
|
|
20510
21243
|
/**
|
|
20511
21244
|
* The scope that the object targets. For more details, please see [Dynatrace Documentation](https://dt-url.net/ky03459).
|
|
21245
|
+
*
|
|
21246
|
+
* @exampleValue HOST-D3A3C5A146830A79
|
|
20512
21247
|
*/
|
|
20513
21248
|
scope?: string;
|
|
20514
21249
|
/**
|
|
@@ -20525,6 +21260,8 @@ export declare interface SettingsObjectByObjectIdResponse {
|
|
|
20525
21260
|
* It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.
|
|
20526
21261
|
*
|
|
20527
21262
|
* If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
|
|
21263
|
+
*
|
|
21264
|
+
* @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
|
|
20528
21265
|
*/
|
|
20529
21266
|
updateToken?: string;
|
|
20530
21267
|
/**
|
|
@@ -20533,6 +21270,8 @@ export declare interface SettingsObjectByObjectIdResponse {
|
|
|
20533
21270
|
* It defines the actual values of settings' parameters.
|
|
20534
21271
|
*
|
|
20535
21272
|
* The actual content depends on the object's schema.
|
|
21273
|
+
*
|
|
21274
|
+
* @exampleValue {"autoMonitoring":true}
|
|
20536
21275
|
*/
|
|
20537
21276
|
value?: AnyValue;
|
|
20538
21277
|
}
|
|
@@ -20553,24 +21292,34 @@ export declare interface SettingsObjectCreate {
|
|
|
20553
21292
|
* If set to an empty string, the new object will be placed in the first position.
|
|
20554
21293
|
*
|
|
20555
21294
|
* Only applicable for objects based on schemas with ordered objects (schema's `ordered` parameter is set to `true`).
|
|
21295
|
+
*
|
|
21296
|
+
* @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
|
|
20556
21297
|
*/
|
|
20557
21298
|
insertAfter?: string;
|
|
20558
21299
|
/**
|
|
20559
21300
|
* The ID of the settings object that should be replaced.
|
|
20560
21301
|
*
|
|
20561
21302
|
* Only applicable if an external identifier is provided.
|
|
21303
|
+
*
|
|
21304
|
+
* @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
|
|
20562
21305
|
*/
|
|
20563
21306
|
objectId?: string;
|
|
20564
21307
|
/**
|
|
20565
21308
|
* The schema on which the object is based.
|
|
21309
|
+
*
|
|
21310
|
+
* @exampleValue builtin:container.built-in-monitoring-rule
|
|
20566
21311
|
*/
|
|
20567
21312
|
schemaId: string;
|
|
20568
21313
|
/**
|
|
20569
21314
|
* The version of the schema on which the object is based.
|
|
21315
|
+
*
|
|
21316
|
+
* @exampleValue 1.0.0
|
|
20570
21317
|
*/
|
|
20571
21318
|
schemaVersion?: string;
|
|
20572
21319
|
/**
|
|
20573
21320
|
* The scope that the object targets. For more details, please see [Dynatrace Documentation](https://dt-url.net/ky03459).
|
|
21321
|
+
*
|
|
21322
|
+
* @exampleValue HOST-D3A3C5A146830A79
|
|
20574
21323
|
*/
|
|
20575
21324
|
scope: string;
|
|
20576
21325
|
/**
|
|
@@ -20579,6 +21328,8 @@ export declare interface SettingsObjectCreate {
|
|
|
20579
21328
|
* It defines the actual values of settings' parameters.
|
|
20580
21329
|
*
|
|
20581
21330
|
* The actual content depends on the object's schema.
|
|
21331
|
+
*
|
|
21332
|
+
* @exampleValue {"autoMonitoring":true}
|
|
20582
21333
|
*/
|
|
20583
21334
|
value: AnyValue;
|
|
20584
21335
|
}
|
|
@@ -20598,10 +21349,14 @@ export declare interface SettingsObjectResponse {
|
|
|
20598
21349
|
* It defines the actual values of settings' parameters.
|
|
20599
21350
|
*
|
|
20600
21351
|
* The actual content depends on the object's schema.
|
|
21352
|
+
*
|
|
21353
|
+
* @exampleValue {"autoMonitoring":true}
|
|
20601
21354
|
*/
|
|
20602
21355
|
invalidValue?: AnyValue;
|
|
20603
21356
|
/**
|
|
20604
21357
|
* For a successful request, the ID of the created or modified settings object.
|
|
21358
|
+
*
|
|
21359
|
+
* @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
|
|
20605
21360
|
*/
|
|
20606
21361
|
objectId?: string;
|
|
20607
21362
|
}
|
|
@@ -20715,6 +21470,8 @@ export declare class SettingsObjectsClient {
|
|
|
20715
21470
|
* Specify the required top-level fields, separated by commas (for example, `origin,value`).
|
|
20716
21471
|
*
|
|
20717
21472
|
* Supported fields: `summary`, `searchSummary`, `created`, `modified`, `createdBy`, `modifiedBy`, `author`, `origin`, `schemaId`, `schemaVersion`, `value`, `externalId`.
|
|
21473
|
+
*
|
|
21474
|
+
* @defaultValue origin,value
|
|
20718
21475
|
*/ fields?: string;
|
|
20719
21476
|
/**
|
|
20720
21477
|
* The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
|
|
@@ -20730,7 +21487,11 @@ export declare class SettingsObjectsClient {
|
|
|
20730
21487
|
*
|
|
20731
21488
|
* If not set, 100 is used.
|
|
20732
21489
|
*/ pageSize?: number;
|
|
20733
|
-
/**
|
|
21490
|
+
/**
|
|
21491
|
+
* If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
|
|
21492
|
+
*
|
|
21493
|
+
* @defaultValue false
|
|
21494
|
+
*/ adminAccess?: boolean;
|
|
20734
21495
|
abortSignal?: AbortSignal_2;
|
|
20735
21496
|
}): Promise<EffectiveSettingsValuesList>;
|
|
20736
21497
|
/**
|
|
@@ -20793,7 +21554,11 @@ export declare class SettingsObjectsClient {
|
|
|
20793
21554
|
*
|
|
20794
21555
|
* If not set, 100 is used.
|
|
20795
21556
|
*/ pageSize?: number;
|
|
20796
|
-
/**
|
|
21557
|
+
/**
|
|
21558
|
+
* If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
|
|
21559
|
+
*
|
|
21560
|
+
* @defaultValue false
|
|
21561
|
+
*/ adminAccess?: boolean;
|
|
20797
21562
|
abortSignal?: AbortSignal_2;
|
|
20798
21563
|
}): Promise<RevisionDiffPage>;
|
|
20799
21564
|
/**
|
|
@@ -20854,6 +21619,8 @@ export declare class SettingsObjectsClient {
|
|
|
20854
21619
|
* Specify the required top-level fields, separated by commas (for example, `objectId,value`).
|
|
20855
21620
|
*
|
|
20856
21621
|
* Supported fields: `objectId`, `summary`, `searchSummary`, `created`, `modified`, `createdBy`, `modifiedBy`, `author`, `updateToken`, `scope`, `modificationInfo` (deprecated), `resourceContext`, `owner`, `schemaId`, `schemaVersion`, `value`, `externalId`.
|
|
21622
|
+
*
|
|
21623
|
+
* @defaultValue objectId,value
|
|
20857
21624
|
*/ fields?: string;
|
|
20858
21625
|
/**
|
|
20859
21626
|
* The filter parameter, as explained [here](https://dt-url.net/platform-services-filtering).
|
|
@@ -20897,7 +21664,11 @@ export declare class SettingsObjectsClient {
|
|
|
20897
21664
|
*
|
|
20898
21665
|
* If not set, 100 is used.
|
|
20899
21666
|
*/ pageSize?: number;
|
|
20900
|
-
/**
|
|
21667
|
+
/**
|
|
21668
|
+
* If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
|
|
21669
|
+
*
|
|
21670
|
+
* @defaultValue false
|
|
21671
|
+
*/ adminAccess?: boolean;
|
|
20901
21672
|
abortSignal?: AbortSignal_2;
|
|
20902
21673
|
}): Promise<ObjectsList>;
|
|
20903
21674
|
/**
|
|
@@ -20934,8 +21705,16 @@ export declare class SettingsObjectsClient {
|
|
|
20934
21705
|
*/
|
|
20935
21706
|
postSettingsObjects(config: {
|
|
20936
21707
|
body: SettingsObjectCreate[];
|
|
20937
|
-
/**
|
|
20938
|
-
|
|
21708
|
+
/**
|
|
21709
|
+
* If `true`, the request runs only validation of the submitted settings objects, without saving them.
|
|
21710
|
+
*
|
|
21711
|
+
* @defaultValue false
|
|
21712
|
+
*/ validateOnly?: boolean;
|
|
21713
|
+
/**
|
|
21714
|
+
* If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
|
|
21715
|
+
*
|
|
21716
|
+
* @defaultValue false
|
|
21717
|
+
*/ adminAccess?: boolean;
|
|
20939
21718
|
abortSignal?: AbortSignal_2;
|
|
20940
21719
|
}): Promise<SettingsObjectResponse[]>;
|
|
20941
21720
|
/**
|
|
@@ -20962,7 +21741,11 @@ export declare class SettingsObjectsClient {
|
|
|
20962
21741
|
*/
|
|
20963
21742
|
getSettingsObjectByObjectId(config: {
|
|
20964
21743
|
/** The ID of the required settings object. */ objectId: string;
|
|
20965
|
-
/**
|
|
21744
|
+
/**
|
|
21745
|
+
* If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
|
|
21746
|
+
*
|
|
21747
|
+
* @defaultValue false
|
|
21748
|
+
*/ adminAccess?: boolean;
|
|
20966
21749
|
abortSignal?: AbortSignal_2;
|
|
20967
21750
|
}): Promise<SettingsObjectByObjectIdResponse>;
|
|
20968
21751
|
/**
|
|
@@ -20996,8 +21779,16 @@ export declare class SettingsObjectsClient {
|
|
|
20996
21779
|
putSettingsObjectByObjectId(config: {
|
|
20997
21780
|
body: SettingsObjectUpdate;
|
|
20998
21781
|
/** The ID of the required settings object. */ objectId: string;
|
|
20999
|
-
/**
|
|
21000
|
-
|
|
21782
|
+
/**
|
|
21783
|
+
* If `true`, the request runs only validation of the submitted settings object, without saving it.
|
|
21784
|
+
*
|
|
21785
|
+
* @defaultValue false
|
|
21786
|
+
*/ validateOnly?: boolean;
|
|
21787
|
+
/**
|
|
21788
|
+
* If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
|
|
21789
|
+
*
|
|
21790
|
+
* @defaultValue false
|
|
21791
|
+
*/ adminAccess?: boolean;
|
|
21001
21792
|
abortSignal?: AbortSignal_2;
|
|
21002
21793
|
}): Promise<SettingsObjectResponse>;
|
|
21003
21794
|
/**
|
|
@@ -21030,7 +21821,11 @@ export declare class SettingsObjectsClient {
|
|
|
21030
21821
|
*
|
|
21031
21822
|
* If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
|
|
21032
21823
|
*/ updateToken?: string;
|
|
21033
|
-
/**
|
|
21824
|
+
/**
|
|
21825
|
+
* If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
|
|
21826
|
+
*
|
|
21827
|
+
* @defaultValue false
|
|
21828
|
+
*/ adminAccess?: boolean;
|
|
21034
21829
|
abortSignal?: AbortSignal_2;
|
|
21035
21830
|
}): Promise<void>;
|
|
21036
21831
|
/**
|
|
@@ -21054,7 +21849,11 @@ export declare class SettingsObjectsClient {
|
|
|
21054
21849
|
*/
|
|
21055
21850
|
getPermissions(config: {
|
|
21056
21851
|
/** The ID of the required settings object. */ objectId: string;
|
|
21057
|
-
/**
|
|
21852
|
+
/**
|
|
21853
|
+
* If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
|
|
21854
|
+
*
|
|
21855
|
+
* @defaultValue false
|
|
21856
|
+
*/ adminAccess?: boolean;
|
|
21058
21857
|
abortSignal?: AbortSignal_2;
|
|
21059
21858
|
}): Promise<AccessorPermissionsList>;
|
|
21060
21859
|
/**
|
|
@@ -21080,7 +21879,11 @@ export declare class SettingsObjectsClient {
|
|
|
21080
21879
|
addPermission(config: {
|
|
21081
21880
|
body: AccessorPermissions;
|
|
21082
21881
|
/** The ID of the required settings object. */ objectId: string;
|
|
21083
|
-
/**
|
|
21882
|
+
/**
|
|
21883
|
+
* If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
|
|
21884
|
+
*
|
|
21885
|
+
* @defaultValue false
|
|
21886
|
+
*/ adminAccess?: boolean;
|
|
21084
21887
|
abortSignal?: AbortSignal_2;
|
|
21085
21888
|
}): Promise<AccessorPermissions>;
|
|
21086
21889
|
/**
|
|
@@ -21105,7 +21908,11 @@ export declare class SettingsObjectsClient {
|
|
|
21105
21908
|
*/
|
|
21106
21909
|
getPermissionAllUsers(config: {
|
|
21107
21910
|
/** The ID of the required settings object. */ objectId: string;
|
|
21108
|
-
/**
|
|
21911
|
+
/**
|
|
21912
|
+
* If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
|
|
21913
|
+
*
|
|
21914
|
+
* @defaultValue false
|
|
21915
|
+
*/ adminAccess?: boolean;
|
|
21109
21916
|
abortSignal?: AbortSignal_2;
|
|
21110
21917
|
}): Promise<AccessorPermissions>;
|
|
21111
21918
|
/**
|
|
@@ -21130,7 +21937,11 @@ export declare class SettingsObjectsClient {
|
|
|
21130
21937
|
updatePermissionAllUsers(config: {
|
|
21131
21938
|
body: UpdatePermissionsRequest;
|
|
21132
21939
|
/** The ID of the required settings object. */ objectId: string;
|
|
21133
|
-
/**
|
|
21940
|
+
/**
|
|
21941
|
+
* If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
|
|
21942
|
+
*
|
|
21943
|
+
* @defaultValue false
|
|
21944
|
+
*/ adminAccess?: boolean;
|
|
21134
21945
|
abortSignal?: AbortSignal_2;
|
|
21135
21946
|
}): Promise<void>;
|
|
21136
21947
|
/**
|
|
@@ -21153,7 +21964,11 @@ export declare class SettingsObjectsClient {
|
|
|
21153
21964
|
*/
|
|
21154
21965
|
removePermissionAllUsers(config: {
|
|
21155
21966
|
/** The ID of the required settings object. */ objectId: string;
|
|
21156
|
-
/**
|
|
21967
|
+
/**
|
|
21968
|
+
* If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
|
|
21969
|
+
*
|
|
21970
|
+
* @defaultValue false
|
|
21971
|
+
*/ adminAccess?: boolean;
|
|
21157
21972
|
abortSignal?: AbortSignal_2;
|
|
21158
21973
|
}): Promise<void>;
|
|
21159
21974
|
/**
|
|
@@ -21181,7 +21996,11 @@ export declare class SettingsObjectsClient {
|
|
|
21181
21996
|
/** The ID of the required settings object. */ objectId: string;
|
|
21182
21997
|
/** The type of the accessor. */ accessorType: 'group' | 'user';
|
|
21183
21998
|
/** The user uuid or group uuid of the accessor, depending on the type. */ accessorId: string;
|
|
21184
|
-
/**
|
|
21999
|
+
/**
|
|
22000
|
+
* If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
|
|
22001
|
+
*
|
|
22002
|
+
* @defaultValue false
|
|
22003
|
+
*/ adminAccess?: boolean;
|
|
21185
22004
|
abortSignal?: AbortSignal_2;
|
|
21186
22005
|
}): Promise<AccessorPermissions>;
|
|
21187
22006
|
/**
|
|
@@ -21209,7 +22028,11 @@ export declare class SettingsObjectsClient {
|
|
|
21209
22028
|
/** The ID of the required settings object. */ objectId: string;
|
|
21210
22029
|
/** The type of the accessor. */ accessorType: 'group' | 'user';
|
|
21211
22030
|
/** The user uuid or group uuid of the accessor, depending on the type. */ accessorId: string;
|
|
21212
|
-
/**
|
|
22031
|
+
/**
|
|
22032
|
+
* If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
|
|
22033
|
+
*
|
|
22034
|
+
* @defaultValue false
|
|
22035
|
+
*/ adminAccess?: boolean;
|
|
21213
22036
|
abortSignal?: AbortSignal_2;
|
|
21214
22037
|
}): Promise<void>;
|
|
21215
22038
|
/**
|
|
@@ -21235,7 +22058,11 @@ export declare class SettingsObjectsClient {
|
|
|
21235
22058
|
/** The ID of the required settings object. */ objectId: string;
|
|
21236
22059
|
/** The type of the accessor. */ accessorType: 'group' | 'user';
|
|
21237
22060
|
/** The user uuid or group uuid of the accessor, depending on the type. */ accessorId: string;
|
|
21238
|
-
/**
|
|
22061
|
+
/**
|
|
22062
|
+
* If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
|
|
22063
|
+
*
|
|
22064
|
+
* @defaultValue false
|
|
22065
|
+
*/ adminAccess?: boolean;
|
|
21239
22066
|
abortSignal?: AbortSignal_2;
|
|
21240
22067
|
}): Promise<void>;
|
|
21241
22068
|
/**
|
|
@@ -21259,7 +22086,11 @@ export declare class SettingsObjectsClient {
|
|
|
21259
22086
|
transferOwnership(config: {
|
|
21260
22087
|
body: TransferOwnershipRequest;
|
|
21261
22088
|
/** The ID of the required settings object. */ objectId: string;
|
|
21262
|
-
/**
|
|
22089
|
+
/**
|
|
22090
|
+
* If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
|
|
22091
|
+
*
|
|
22092
|
+
* @defaultValue false
|
|
22093
|
+
*/ adminAccess?: boolean;
|
|
21263
22094
|
abortSignal?: AbortSignal_2;
|
|
21264
22095
|
}): Promise<void>;
|
|
21265
22096
|
}
|
|
@@ -21280,6 +22111,8 @@ export declare interface SettingsObjectUpdate {
|
|
|
21280
22111
|
* If set to an empty string, the updated object will be placed in the first position.
|
|
21281
22112
|
*
|
|
21282
22113
|
* Only applicable for objects based on schemas with ordered objects (schema's **ordered** parameter is set to `true`).
|
|
22114
|
+
*
|
|
22115
|
+
* @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
|
|
21283
22116
|
*/
|
|
21284
22117
|
insertAfter?: string;
|
|
21285
22118
|
/**
|
|
@@ -21292,10 +22125,14 @@ export declare interface SettingsObjectUpdate {
|
|
|
21292
22125
|
* If set to an empty string, the updated object will be placed in the last position.
|
|
21293
22126
|
*
|
|
21294
22127
|
* Only applicable for objects based on schemas with ordered objects (schema's **ordered** parameter is set to `true`).
|
|
22128
|
+
*
|
|
22129
|
+
* @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
|
|
21295
22130
|
*/
|
|
21296
22131
|
insertBefore?: string;
|
|
21297
22132
|
/**
|
|
21298
22133
|
* The version of the schema on which the object is based.
|
|
22134
|
+
*
|
|
22135
|
+
* @exampleValue 1.0.0
|
|
21299
22136
|
*/
|
|
21300
22137
|
schemaVersion?: string;
|
|
21301
22138
|
/**
|
|
@@ -21304,6 +22141,8 @@ export declare interface SettingsObjectUpdate {
|
|
|
21304
22141
|
* It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.
|
|
21305
22142
|
*
|
|
21306
22143
|
* If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
|
|
22144
|
+
*
|
|
22145
|
+
* @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
|
|
21307
22146
|
*/
|
|
21308
22147
|
updateToken?: string;
|
|
21309
22148
|
/**
|
|
@@ -21312,6 +22151,8 @@ export declare interface SettingsObjectUpdate {
|
|
|
21312
22151
|
* It defines the actual values of settings' parameters.
|
|
21313
22152
|
*
|
|
21314
22153
|
* The actual content depends on the object's schema.
|
|
22154
|
+
*
|
|
22155
|
+
* @exampleValue {"autoMonitoring":true}
|
|
21315
22156
|
*/
|
|
21316
22157
|
value: AnyValue;
|
|
21317
22158
|
}
|
|
@@ -21356,6 +22197,8 @@ export declare class SettingsSchemasClient {
|
|
|
21356
22197
|
* Specify the required top-level fields, separated by commas (for example, `schemaId,displayName`).
|
|
21357
22198
|
*
|
|
21358
22199
|
* Supported fields: `schemaId`, `displayName`, `maturity`, `latestSchemaVersion`, `multiObject`, `ordered`, `ownerBasedAccessControl`.
|
|
22200
|
+
*
|
|
22201
|
+
* @defaultValue schemaId,displayName,latestSchemaVersion
|
|
21359
22202
|
*/ fields?: string;
|
|
21360
22203
|
abortSignal?: AbortSignal_2;
|
|
21361
22204
|
}): Promise<SchemaList>;
|
|
@@ -21404,6 +22247,8 @@ export declare interface SinglePermissionRequest {
|
|
|
21404
22247
|
context?: PermissionContext;
|
|
21405
22248
|
/**
|
|
21406
22249
|
* Permission to be probed
|
|
22250
|
+
*
|
|
22251
|
+
* @exampleValue settings:objects:write
|
|
21407
22252
|
*/
|
|
21408
22253
|
permission: string;
|
|
21409
22254
|
}
|
|
@@ -21414,26 +22259,36 @@ export declare interface SinglePermissionRequest {
|
|
|
21414
22259
|
export declare interface SLO {
|
|
21415
22260
|
/**
|
|
21416
22261
|
* The key for the SLO's error budget burn rate func metric.
|
|
22262
|
+
*
|
|
22263
|
+
* @exampleValue func:slo.errorBudgetBurnRate.payment_service_availability
|
|
21417
22264
|
*/
|
|
21418
22265
|
burnRateMetricKey: string;
|
|
21419
22266
|
/**
|
|
21420
22267
|
* The denominator value used to evaluate the SLO when **useRateMetric** is set to `false`.
|
|
21421
22268
|
*
|
|
22269
|
+
* @exampleValue 90
|
|
22270
|
+
*
|
|
21422
22271
|
* @deprecated
|
|
21423
22272
|
*/
|
|
21424
22273
|
denominatorValue?: number;
|
|
21425
22274
|
/**
|
|
21426
22275
|
* A short description of the SLO.
|
|
22276
|
+
*
|
|
22277
|
+
* @exampleValue Rate of successful payments per week
|
|
21427
22278
|
*/
|
|
21428
22279
|
description?: string;
|
|
21429
22280
|
/**
|
|
21430
22281
|
* The SLO is enabled (`true`) or disabled (`false`).
|
|
22282
|
+
*
|
|
22283
|
+
* @exampleValue true
|
|
21431
22284
|
*/
|
|
21432
22285
|
enabled: boolean;
|
|
21433
22286
|
/**
|
|
21434
22287
|
* The error of the SLO calculation.
|
|
21435
22288
|
*
|
|
21436
22289
|
* If the value differs from `NONE`, there is something wrong with the SLO calculation.
|
|
22290
|
+
*
|
|
22291
|
+
* @exampleValue NONE
|
|
21437
22292
|
*/
|
|
21438
22293
|
error: string;
|
|
21439
22294
|
/**
|
|
@@ -21445,6 +22300,8 @@ export declare interface SLO {
|
|
|
21445
22300
|
*
|
|
21446
22301
|
* * If there is an error with the SLO calculation; in that case check the value of the **error** property.
|
|
21447
22302
|
* * If the evaluate parameter has not been set to `true`; in that case the **error** property will contain no error.
|
|
22303
|
+
*
|
|
22304
|
+
* @exampleValue 1.25
|
|
21448
22305
|
*/
|
|
21449
22306
|
errorBudget: number;
|
|
21450
22307
|
/**
|
|
@@ -21453,6 +22310,8 @@ export declare interface SLO {
|
|
|
21453
22310
|
errorBudgetBurnRate: SloBurnRate;
|
|
21454
22311
|
/**
|
|
21455
22312
|
* The key for the SLO's error budget func metric.
|
|
22313
|
+
*
|
|
22314
|
+
* @exampleValue func:slo.errorBudget.payment_service_availability
|
|
21456
22315
|
*/
|
|
21457
22316
|
errorBudgetMetricKey: string;
|
|
21458
22317
|
/**
|
|
@@ -21460,18 +22319,26 @@ export declare interface SLO {
|
|
|
21460
22319
|
*
|
|
21461
22320
|
* * If there is an error with the SLO calculation; in that case check the value of the **error** property.
|
|
21462
22321
|
* * If the evaluate parameter has not been set to `true`; in that case the **error** property will contain no error.
|
|
22322
|
+
*
|
|
22323
|
+
* @exampleValue 96.25
|
|
21463
22324
|
*/
|
|
21464
22325
|
evaluatedPercentage: number;
|
|
21465
22326
|
/**
|
|
21466
22327
|
* The evaluation type of the SLO.
|
|
22328
|
+
*
|
|
22329
|
+
* @exampleValue AGGREGATE
|
|
21467
22330
|
*/
|
|
21468
22331
|
evaluationType: 'AGGREGATE';
|
|
21469
22332
|
/**
|
|
21470
22333
|
* The entity filter for the SLO evaluation. The total length of the entitySelector string in SLOs is limited to 1,000 characters. Use the [syntax of entity selector](https://dt-url.net/entityselector).
|
|
22334
|
+
*
|
|
22335
|
+
* @exampleValue type("SERVICE")
|
|
21471
22336
|
*/
|
|
21472
22337
|
filter: string;
|
|
21473
22338
|
/**
|
|
21474
22339
|
* The ID of the SLO
|
|
22340
|
+
*
|
|
22341
|
+
* @exampleValue 123e4567-e89b-42d3-a456-556642440000
|
|
21475
22342
|
*/
|
|
21476
22343
|
id: string;
|
|
21477
22344
|
/**
|
|
@@ -21479,19 +22346,27 @@ export declare interface SLO {
|
|
|
21479
22346
|
*
|
|
21480
22347
|
* Required when the **useRateMetric** is set to `false`.
|
|
21481
22348
|
*
|
|
22349
|
+
* @exampleValue builtin:service.requestCount.server
|
|
22350
|
+
*
|
|
21482
22351
|
* @deprecated
|
|
21483
22352
|
*/
|
|
21484
22353
|
metricDenominator?: string;
|
|
21485
22354
|
/**
|
|
21486
22355
|
* The percentage-based metric expression for the calculation of the SLO.
|
|
22356
|
+
*
|
|
22357
|
+
* @exampleValue (100)*(builtin:service.errors.server.successCount:splitBy())/(builtin:service.requestCount.server:splitBy())
|
|
21487
22358
|
*/
|
|
21488
22359
|
metricExpression: string;
|
|
21489
22360
|
/**
|
|
21490
22361
|
* The key for the SLO's status func metric.
|
|
22362
|
+
*
|
|
22363
|
+
* @exampleValue func:slo.payment_service_availability
|
|
21491
22364
|
*/
|
|
21492
22365
|
metricKey: string;
|
|
21493
22366
|
/**
|
|
21494
22367
|
* The name that is used to create SLO func metrics keys. Once created, metric name cannot be changed.
|
|
22368
|
+
*
|
|
22369
|
+
* @exampleValue payment_service_availability
|
|
21495
22370
|
*/
|
|
21496
22371
|
metricName: string;
|
|
21497
22372
|
/**
|
|
@@ -21499,6 +22374,8 @@ export declare interface SLO {
|
|
|
21499
22374
|
*
|
|
21500
22375
|
* Required when the **useRateMetric** is set to `false`.
|
|
21501
22376
|
*
|
|
22377
|
+
* @exampleValue builtin:service.errors.server.successCount
|
|
22378
|
+
*
|
|
21502
22379
|
* @deprecated
|
|
21503
22380
|
*/
|
|
21504
22381
|
metricNumerator?: string;
|
|
@@ -21507,26 +22384,36 @@ export declare interface SLO {
|
|
|
21507
22384
|
*
|
|
21508
22385
|
* Required when the **useRateMetric** is set to `true`.
|
|
21509
22386
|
*
|
|
22387
|
+
* @exampleValue builtin:service.successes.server.rate
|
|
22388
|
+
*
|
|
21510
22389
|
* @deprecated
|
|
21511
22390
|
*/
|
|
21512
22391
|
metricRate?: string;
|
|
21513
22392
|
/**
|
|
21514
22393
|
* The name of the SLO.
|
|
22394
|
+
*
|
|
22395
|
+
* @exampleValue Payment service availability
|
|
21515
22396
|
*/
|
|
21516
22397
|
name: string;
|
|
21517
22398
|
/**
|
|
21518
22399
|
* The key for the SLO's normalized error budget func metric.
|
|
22400
|
+
*
|
|
22401
|
+
* @exampleValue func:slo.normalizedErrorBudget.payment_service_availability
|
|
21519
22402
|
*/
|
|
21520
22403
|
normalizedErrorBudgetMetricKey: string;
|
|
21521
22404
|
/**
|
|
21522
22405
|
* The numerator value used to evaluate the SLO when **useRateMetric** is set to `false`.
|
|
21523
22406
|
*
|
|
22407
|
+
* @exampleValue 80
|
|
22408
|
+
*
|
|
21524
22409
|
* @deprecated
|
|
21525
22410
|
*/
|
|
21526
22411
|
numeratorValue?: number;
|
|
21527
22412
|
/**
|
|
21528
22413
|
* The entity filter for fetching the number of problems related to an SLO. Auto-generated in case no filter has been added to the SLO.
|
|
21529
22414
|
*
|
|
22415
|
+
* @exampleValue [type("SERVICE")]
|
|
22416
|
+
*
|
|
21530
22417
|
* @deprecated
|
|
21531
22418
|
*/
|
|
21532
22419
|
problemFilters?: string[];
|
|
@@ -21544,14 +22431,20 @@ export declare interface SLO {
|
|
|
21544
22431
|
relatedTotalProblems?: number;
|
|
21545
22432
|
/**
|
|
21546
22433
|
* The status of the calculated SLO.
|
|
22434
|
+
*
|
|
22435
|
+
* @exampleValue WARNING
|
|
21547
22436
|
*/
|
|
21548
22437
|
status: 'FAILURE' | 'SUCCESS' | 'WARNING';
|
|
21549
22438
|
/**
|
|
21550
22439
|
* The target value of the SLO.
|
|
22440
|
+
*
|
|
22441
|
+
* @exampleValue 95
|
|
21551
22442
|
*/
|
|
21552
22443
|
target: number;
|
|
21553
22444
|
/**
|
|
21554
22445
|
* The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector.
|
|
22446
|
+
*
|
|
22447
|
+
* @exampleValue -1d
|
|
21555
22448
|
*/
|
|
21556
22449
|
timeframe: string;
|
|
21557
22450
|
/**
|
|
@@ -21562,6 +22455,8 @@ export declare interface SLO {
|
|
|
21562
22455
|
*
|
|
21563
22456
|
* For a list of available metrics, see [Built-in metric page](https://dt-url.net/be03kow) or try the [GET metrics](https://dt-url.net/8e43kxf) API call.
|
|
21564
22457
|
*
|
|
22458
|
+
* @exampleValue true
|
|
22459
|
+
*
|
|
21565
22460
|
* @deprecated
|
|
21566
22461
|
*/
|
|
21567
22462
|
useRateMetric?: boolean;
|
|
@@ -21569,6 +22464,8 @@ export declare interface SLO {
|
|
|
21569
22464
|
* The warning value of the SLO.
|
|
21570
22465
|
*
|
|
21571
22466
|
* At warning state the SLO is still fulfilled but is getting close to failure.
|
|
22467
|
+
*
|
|
22468
|
+
* @exampleValue 97.5
|
|
21572
22469
|
*/
|
|
21573
22470
|
warning: number;
|
|
21574
22471
|
}
|
|
@@ -21581,28 +22478,40 @@ export declare interface SloBurnRate {
|
|
|
21581
22478
|
* The calculated burn rate type.
|
|
21582
22479
|
*
|
|
21583
22480
|
* Has a value of 'FAST', 'SLOW' or 'NONE'.
|
|
22481
|
+
*
|
|
22482
|
+
* @exampleValue SLOW
|
|
21584
22483
|
*/
|
|
21585
22484
|
burnRateType?: 'FAST' | 'NONE' | 'SLOW';
|
|
21586
22485
|
/**
|
|
21587
22486
|
* The burn rate of the SLO, calculated for the last hour.
|
|
22487
|
+
*
|
|
22488
|
+
* @exampleValue 1.25
|
|
21588
22489
|
*/
|
|
21589
22490
|
burnRateValue?: number;
|
|
21590
22491
|
/**
|
|
21591
22492
|
* The error budget burn rate calculation is enabled (`true`) or disabled (`false`).
|
|
21592
22493
|
*
|
|
21593
22494
|
* In case of `false`, no calculated values will be present here.
|
|
22495
|
+
*
|
|
22496
|
+
* @exampleValue true
|
|
21594
22497
|
*/
|
|
21595
22498
|
burnRateVisualizationEnabled: boolean;
|
|
21596
22499
|
/**
|
|
21597
22500
|
* The estimated time left to consume the error budget in hours.
|
|
22501
|
+
*
|
|
22502
|
+
* @exampleValue 24
|
|
21598
22503
|
*/
|
|
21599
22504
|
estimatedTimeToConsumeErrorBudget?: number;
|
|
21600
22505
|
/**
|
|
21601
22506
|
* The threshold between a slow and a fast burn rate.
|
|
22507
|
+
*
|
|
22508
|
+
* @exampleValue 1.5
|
|
21602
22509
|
*/
|
|
21603
22510
|
fastBurnThreshold?: number;
|
|
21604
22511
|
/**
|
|
21605
22512
|
* The calculated value of the SLO for the timeframe chosen for the burn rate calculation.
|
|
22513
|
+
*
|
|
22514
|
+
* @exampleValue 95
|
|
21606
22515
|
*/
|
|
21607
22516
|
sloValue?: number;
|
|
21608
22517
|
}
|
|
@@ -21630,10 +22539,14 @@ export declare interface SloBurnRateConfig {
|
|
|
21630
22539
|
* In case of `false`, no calculated values will be present here.
|
|
21631
22540
|
*
|
|
21632
22541
|
* If not defined, the error budget burn rate calculation is disabled by default.
|
|
22542
|
+
*
|
|
22543
|
+
* @exampleValue true
|
|
21633
22544
|
*/
|
|
21634
22545
|
burnRateVisualizationEnabled?: boolean;
|
|
21635
22546
|
/**
|
|
21636
22547
|
* The threshold between a slow and a fast burn rate.
|
|
22548
|
+
*
|
|
22549
|
+
* @exampleValue 1.5
|
|
21637
22550
|
*/
|
|
21638
22551
|
fastBurnThreshold?: number;
|
|
21639
22552
|
}
|
|
@@ -21641,12 +22554,16 @@ export declare interface SloBurnRateConfig {
|
|
|
21641
22554
|
export declare interface SloConfigItemDtoImpl {
|
|
21642
22555
|
/**
|
|
21643
22556
|
* The description of the SLO.
|
|
22557
|
+
*
|
|
22558
|
+
* @exampleValue Rate of successful payments per week
|
|
21644
22559
|
*/
|
|
21645
22560
|
description?: string;
|
|
21646
22561
|
/**
|
|
21647
22562
|
* The SLO is enabled (`true`) or disabled (`false`).
|
|
21648
22563
|
*
|
|
21649
22564
|
* If not defined, the SLO is disabled by default.
|
|
22565
|
+
*
|
|
22566
|
+
* @exampleValue true
|
|
21650
22567
|
*/
|
|
21651
22568
|
enabled?: boolean;
|
|
21652
22569
|
/**
|
|
@@ -21655,10 +22572,14 @@ export declare interface SloConfigItemDtoImpl {
|
|
|
21655
22572
|
errorBudgetBurnRate?: SloBurnRateConfig;
|
|
21656
22573
|
/**
|
|
21657
22574
|
* The evaluation type of the SLO.
|
|
22575
|
+
*
|
|
22576
|
+
* @exampleValue AGGREGATE
|
|
21658
22577
|
*/
|
|
21659
22578
|
evaluationType: 'AGGREGATE';
|
|
21660
22579
|
/**
|
|
21661
22580
|
* The entity filter for the SLO evaluation. The total length of the entitySelector string in SLOs is limited to 1,000 characters. Use the [syntax of entity selector](https://dt-url.net/entityselector).
|
|
22581
|
+
*
|
|
22582
|
+
* @exampleValue type("SERVICE")
|
|
21662
22583
|
*/
|
|
21663
22584
|
filter?: string;
|
|
21664
22585
|
/**
|
|
@@ -21666,15 +22587,21 @@ export declare interface SloConfigItemDtoImpl {
|
|
|
21666
22587
|
*
|
|
21667
22588
|
* Required when the **useRateMetric** is set to `false`.
|
|
21668
22589
|
*
|
|
22590
|
+
* @exampleValue builtin:service.requestCount.server
|
|
22591
|
+
*
|
|
21669
22592
|
* @deprecated
|
|
21670
22593
|
*/
|
|
21671
22594
|
metricDenominator?: string;
|
|
21672
22595
|
/**
|
|
21673
22596
|
* The percentage-based metric expression for the calculation of the SLO.
|
|
22597
|
+
*
|
|
22598
|
+
* @exampleValue (100)*(builtin:service.errors.server.successCount:splitBy())/(builtin:service.requestCount.server:splitBy())
|
|
21674
22599
|
*/
|
|
21675
22600
|
metricExpression?: string;
|
|
21676
22601
|
/**
|
|
21677
22602
|
* The name that is used to create SLO func metrics keys. Once created, metric name cannot be changed.
|
|
22603
|
+
*
|
|
22604
|
+
* @exampleValue payment_service_availability
|
|
21678
22605
|
*/
|
|
21679
22606
|
metricName?: string;
|
|
21680
22607
|
/**
|
|
@@ -21682,6 +22609,8 @@ export declare interface SloConfigItemDtoImpl {
|
|
|
21682
22609
|
*
|
|
21683
22610
|
* Required when the **useRateMetric** is set to `false`.
|
|
21684
22611
|
*
|
|
22612
|
+
* @exampleValue builtin:service.errors.server.successCount
|
|
22613
|
+
*
|
|
21685
22614
|
* @deprecated
|
|
21686
22615
|
*/
|
|
21687
22616
|
metricNumerator?: string;
|
|
@@ -21690,19 +22619,27 @@ export declare interface SloConfigItemDtoImpl {
|
|
|
21690
22619
|
*
|
|
21691
22620
|
* Required when the **useRateMetric** is set to `true`.
|
|
21692
22621
|
*
|
|
22622
|
+
* @exampleValue builtin:service.successes.server.rate
|
|
22623
|
+
*
|
|
21693
22624
|
* @deprecated
|
|
21694
22625
|
*/
|
|
21695
22626
|
metricRate?: string;
|
|
21696
22627
|
/**
|
|
21697
22628
|
* The name of the SLO.
|
|
22629
|
+
*
|
|
22630
|
+
* @exampleValue Payment service availability
|
|
21698
22631
|
*/
|
|
21699
22632
|
name: string;
|
|
21700
22633
|
/**
|
|
21701
22634
|
* The target value of the SLO.
|
|
22635
|
+
*
|
|
22636
|
+
* @exampleValue 95
|
|
21702
22637
|
*/
|
|
21703
22638
|
target: number;
|
|
21704
22639
|
/**
|
|
21705
22640
|
* The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector.
|
|
22641
|
+
*
|
|
22642
|
+
* @exampleValue -1d
|
|
21706
22643
|
*/
|
|
21707
22644
|
timeframe: string;
|
|
21708
22645
|
/**
|
|
@@ -21713,6 +22650,8 @@ export declare interface SloConfigItemDtoImpl {
|
|
|
21713
22650
|
*
|
|
21714
22651
|
* For a list of available metrics, see [Built-in metric page](https://dt-url.net/be03kow) or try the [GET metrics](https://dt-url.net/8e43kxf) API call.
|
|
21715
22652
|
*
|
|
22653
|
+
* @exampleValue true
|
|
22654
|
+
*
|
|
21716
22655
|
* @deprecated
|
|
21717
22656
|
*/
|
|
21718
22657
|
useRateMetric?: boolean | null;
|
|
@@ -21720,6 +22659,8 @@ export declare interface SloConfigItemDtoImpl {
|
|
|
21720
22659
|
* The warning value of the SLO.
|
|
21721
22660
|
*
|
|
21722
22661
|
* At warning state the SLO is still fulfilled but is getting close to failure.
|
|
22662
|
+
*
|
|
22663
|
+
* @exampleValue 97.5
|
|
21723
22664
|
*/
|
|
21724
22665
|
warning: number;
|
|
21725
22666
|
}
|
|
@@ -21750,6 +22691,8 @@ export declare interface SLOs {
|
|
|
21750
22691
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
21751
22692
|
*
|
|
21752
22693
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
22694
|
+
*
|
|
22695
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
21753
22696
|
*/
|
|
21754
22697
|
nextPageKey?: string;
|
|
21755
22698
|
/**
|
|
@@ -21813,18 +22756,26 @@ export declare interface SNMPV3Credentials extends Credentials {
|
|
|
21813
22756
|
export declare interface SoftwareTechs {
|
|
21814
22757
|
/**
|
|
21815
22758
|
* The edition of the technology.
|
|
22759
|
+
*
|
|
22760
|
+
* @exampleValue OpenJDK
|
|
21816
22761
|
*/
|
|
21817
22762
|
edition?: string;
|
|
21818
22763
|
/**
|
|
21819
22764
|
* The type of the technology.
|
|
22765
|
+
*
|
|
22766
|
+
* @exampleValue JAVA
|
|
21820
22767
|
*/
|
|
21821
22768
|
technology?: string;
|
|
21822
22769
|
/**
|
|
21823
22770
|
* The verbatim type of the technology.
|
|
22771
|
+
*
|
|
22772
|
+
* @exampleValue Java
|
|
21824
22773
|
*/
|
|
21825
22774
|
verbatimType?: string;
|
|
21826
22775
|
/**
|
|
21827
22776
|
* The version of the technology.
|
|
22777
|
+
*
|
|
22778
|
+
* @exampleValue 11.0.10
|
|
21828
22779
|
*/
|
|
21829
22780
|
version?: string;
|
|
21830
22781
|
}
|
|
@@ -21910,6 +22861,10 @@ export declare interface SyntheticBrowserMonitorConfigurationDto {
|
|
|
21910
22861
|
* JavaScript Agent Settings.
|
|
21911
22862
|
*/
|
|
21912
22863
|
javaScriptSettings?: JavaScriptAgentSettingsDto;
|
|
22864
|
+
/**
|
|
22865
|
+
* Capture performance metrics for pages loaded in cross origin frames. If not defined in request, it will fall back to monitorFrames by default.
|
|
22866
|
+
*/
|
|
22867
|
+
monitorCrossOriginFrames?: boolean;
|
|
21913
22868
|
/**
|
|
21914
22869
|
* Capture performance metrics for pages loaded in frames. If not defined in request, it will be set to false by default.
|
|
21915
22870
|
*/
|
|
@@ -21950,6 +22905,8 @@ export declare interface SyntheticBrowserMonitorRequest {
|
|
|
21950
22905
|
description?: string;
|
|
21951
22906
|
/**
|
|
21952
22907
|
* If true, the monitor is enabled.
|
|
22908
|
+
*
|
|
22909
|
+
* @defaultValue true
|
|
21953
22910
|
*/
|
|
21954
22911
|
enabled?: boolean;
|
|
21955
22912
|
/**
|
|
@@ -21986,6 +22943,8 @@ export declare interface SyntheticBrowserMonitorRequest {
|
|
|
21986
22943
|
steps: SyntheticBrowserMonitorStepDto[];
|
|
21987
22944
|
/**
|
|
21988
22945
|
* Outage handling configuration.
|
|
22946
|
+
*
|
|
22947
|
+
* @exampleValue {"globalConsecutiveOutageCountThreshold":"1","globalOutages":"true","localConsecutiveOutageCountThreshold":"3","localLocationOutageCountThreshold":"3","localOutages":"true"}
|
|
21989
22948
|
*/
|
|
21990
22949
|
syntheticMonitorOutageHandlingSettings?: SyntheticMonitorOutageHandlingSettingsDto;
|
|
21991
22950
|
/**
|
|
@@ -22073,6 +23032,8 @@ export declare interface SyntheticBrowserMonitorResponse {
|
|
|
22073
23032
|
steps: SyntheticBrowserMonitorStepDto[];
|
|
22074
23033
|
/**
|
|
22075
23034
|
* Outage handling configuration.
|
|
23035
|
+
*
|
|
23036
|
+
* @exampleValue {"globalConsecutiveOutageCountThreshold":"1","globalOutages":"true","localConsecutiveOutageCountThreshold":"3","localLocationOutageCountThreshold":"3","localOutages":"true"}
|
|
22076
23037
|
*/
|
|
22077
23038
|
syntheticMonitorOutageHandlingSettings: SyntheticMonitorOutageHandlingSettingsDto;
|
|
22078
23039
|
/**
|
|
@@ -22153,12 +23114,20 @@ export declare enum SyntheticBrowserMonitorStepDtoType {
|
|
|
22153
23114
|
export declare interface SyntheticConfigDto {
|
|
22154
23115
|
/**
|
|
22155
23116
|
* bmMonitorTimeout - browser monitor execution timeout (ms)
|
|
23117
|
+
*
|
|
23118
|
+
* @minimum 60000
|
|
22156
23119
|
*/
|
|
22157
23120
|
bmMonitorTimeout: number;
|
|
22158
23121
|
/**
|
|
22159
23122
|
* bmStepTimeout - browser monitor single step execution timeout (ms)
|
|
23123
|
+
*
|
|
23124
|
+
* @minimum 10000
|
|
22160
23125
|
*/
|
|
22161
23126
|
bmStepTimeout: number;
|
|
23127
|
+
/**
|
|
23128
|
+
* maintenanceWindowsExcludedFromAvailability - exclude periods with maintenance windows from availability calculation
|
|
23129
|
+
*/
|
|
23130
|
+
maintenanceWindowsExcludedFromAvailability: boolean;
|
|
22162
23131
|
}
|
|
22163
23132
|
|
|
22164
23133
|
/**
|
|
@@ -22200,6 +23169,8 @@ export declare enum SyntheticHttpAuthenticationDtoType {
|
|
|
22200
23169
|
export declare interface SyntheticHttpConfigurationDto {
|
|
22201
23170
|
/**
|
|
22202
23171
|
* If true accept any certificate flag.
|
|
23172
|
+
*
|
|
23173
|
+
* @defaultValue true
|
|
22203
23174
|
*/
|
|
22204
23175
|
acceptAnyCertificate?: boolean;
|
|
22205
23176
|
/**
|
|
@@ -22208,10 +23179,14 @@ export declare interface SyntheticHttpConfigurationDto {
|
|
|
22208
23179
|
clientCertificateId?: string;
|
|
22209
23180
|
/**
|
|
22210
23181
|
* If true the step's data aren't stored and displayed.
|
|
23182
|
+
*
|
|
23183
|
+
* @defaultValue false
|
|
22211
23184
|
*/
|
|
22212
23185
|
doNotPersistSensitiveData?: boolean;
|
|
22213
23186
|
/**
|
|
22214
23187
|
* If true follow redirects.
|
|
23188
|
+
*
|
|
23189
|
+
* @defaultValue false
|
|
22215
23190
|
*/
|
|
22216
23191
|
followRedirects?: boolean;
|
|
22217
23192
|
/**
|
|
@@ -22328,6 +23303,8 @@ export declare interface SyntheticHttpMonitorRequest {
|
|
|
22328
23303
|
description?: string;
|
|
22329
23304
|
/**
|
|
22330
23305
|
* If true, the monitor is enabled.
|
|
23306
|
+
*
|
|
23307
|
+
* @defaultValue true
|
|
22331
23308
|
*/
|
|
22332
23309
|
enabled?: boolean;
|
|
22333
23310
|
/**
|
|
@@ -22360,6 +23337,8 @@ export declare interface SyntheticHttpMonitorRequest {
|
|
|
22360
23337
|
steps: SyntheticHttpMonitorStepDto[];
|
|
22361
23338
|
/**
|
|
22362
23339
|
* Outage handling configuration.
|
|
23340
|
+
*
|
|
23341
|
+
* @exampleValue {"globalConsecutiveOutageCountThreshold":"1","globalOutages":"true","localConsecutiveOutageCountThreshold":"3","localLocationOutageCountThreshold":"3","localOutages":"true"}
|
|
22363
23342
|
*/
|
|
22364
23343
|
syntheticMonitorOutageHandlingSettings?: SyntheticMonitorOutageHandlingSettingsDto;
|
|
22365
23344
|
/**
|
|
@@ -22447,6 +23426,8 @@ export declare interface SyntheticHttpMonitorResponse {
|
|
|
22447
23426
|
steps: SyntheticHttpMonitorStepDto[];
|
|
22448
23427
|
/**
|
|
22449
23428
|
* Outage handling configuration.
|
|
23429
|
+
*
|
|
23430
|
+
* @exampleValue {"globalConsecutiveOutageCountThreshold":"1","globalOutages":"true","localConsecutiveOutageCountThreshold":"3","localLocationOutageCountThreshold":"3","localOutages":"true"}
|
|
22450
23431
|
*/
|
|
22451
23432
|
syntheticMonitorOutageHandlingSettings: SyntheticMonitorOutageHandlingSettingsDto;
|
|
22452
23433
|
/**
|
|
@@ -22667,14 +23648,18 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
|
|
|
22667
23648
|
*
|
|
22668
23649
|
* **Required scope:** environment-api:synthetic:write<br/>**Required permission:** environment:roles:manage-settings
|
|
22669
23650
|
*
|
|
22670
|
-
* @returns {Promise<SyntheticConfigDto>} Success. The set of synthetic related parameters has been updated. Response doesn't have a body.
|
|
22671
|
-
*
|
|
22672
23651
|
* @example <caption>Code example</caption>
|
|
22673
23652
|
* import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
22674
23653
|
*
|
|
22675
23654
|
* const data =
|
|
22676
23655
|
* await syntheticLocationsNodesAndConfigurationClient.updateConfiguration(
|
|
22677
|
-
* {
|
|
23656
|
+
* {
|
|
23657
|
+
* body: {
|
|
23658
|
+
* bmMonitorTimeout: 10,
|
|
23659
|
+
* bmStepTimeout: 10,
|
|
23660
|
+
* maintenanceWindowsExcludedFromAvailability: false,
|
|
23661
|
+
* },
|
|
23662
|
+
* },
|
|
22678
23663
|
* );
|
|
22679
23664
|
*
|
|
22680
23665
|
* @throws {ErrorEnvelopeError} Client side error. | Server side error.
|
|
@@ -22685,7 +23670,7 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
|
|
|
22685
23670
|
updateConfiguration(config: {
|
|
22686
23671
|
body: SyntheticConfigDto;
|
|
22687
23672
|
abortSignal?: AbortSignal_2;
|
|
22688
|
-
}): Promise<
|
|
23673
|
+
}): Promise<void>;
|
|
22689
23674
|
/**
|
|
22690
23675
|
* Lists all synthetic locations (both public and private) available for your environment
|
|
22691
23676
|
*
|
|
@@ -22727,7 +23712,6 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
|
|
|
22727
23712
|
* latitude: 10,
|
|
22728
23713
|
* longitude: 10,
|
|
22729
23714
|
* name: "...",
|
|
22730
|
-
* nodes: ["..."],
|
|
22731
23715
|
* type: "CLUSTER",
|
|
22732
23716
|
* },
|
|
22733
23717
|
* },
|
|
@@ -23123,6 +24107,8 @@ export declare interface SyntheticMonitorConstraintDto {
|
|
|
23123
24107
|
properties: SyntheticMonitorConstraintDtoProperties;
|
|
23124
24108
|
/**
|
|
23125
24109
|
* Constraint type. Allowed values depend on monitor type and step/request context. HTTP monitor step constraints: HTTP_STATUSES, HTTP_RESPONSE_PATTERN, HTTP_RESPONSE_REGEX. Network availability monitor(MULTI_PROTOCOL) step constraints: SUCCESS_RATE_PERCENT. Network availability monitor(MULTI_PROTOCOL) request configuration constraints are request-type specific, for example ICMP_SUCCESS_RATE_PERCENT (ICMP) and DNS_STATUS_CODE (DNS).
|
|
24110
|
+
*
|
|
24111
|
+
* @exampleValue ICMP_SUCCESS_RATE_PERCENT
|
|
23126
24112
|
*/
|
|
23127
24113
|
type: string;
|
|
23128
24114
|
}
|
|
@@ -23218,22 +24204,32 @@ export declare enum SyntheticMonitorOutageHandlingSettingsDtoOrigin {
|
|
|
23218
24204
|
export declare interface SyntheticMonitorPerformanceThresholdDto {
|
|
23219
24205
|
/**
|
|
23220
24206
|
* Aggregation type
|
|
24207
|
+
*
|
|
24208
|
+
* @defaultValue AVG
|
|
23221
24209
|
*/
|
|
23222
24210
|
aggregation?: 'AVG' | 'MAX' | 'MIN';
|
|
23223
24211
|
/**
|
|
23224
24212
|
* Number of most recent non-violating request executions that closes the problem.
|
|
24213
|
+
*
|
|
24214
|
+
* @minimum 1
|
|
23225
24215
|
*/
|
|
23226
24216
|
dealertingSamples?: number;
|
|
23227
24217
|
/**
|
|
23228
24218
|
* Number of request executions in analyzed sliding window (sliding window size).
|
|
24219
|
+
*
|
|
24220
|
+
* @minimum 1
|
|
23229
24221
|
*/
|
|
23230
24222
|
samples?: number;
|
|
23231
24223
|
/**
|
|
23232
24224
|
* Specify the step's index to which a threshold applies. If threshold is monitor-level, no index is needed.
|
|
24225
|
+
*
|
|
24226
|
+
* @minimum 0
|
|
23233
24227
|
*/
|
|
23234
24228
|
stepIndex?: number;
|
|
23235
24229
|
/**
|
|
23236
24230
|
* Notify if monitor request takes longer than *X* time units to execute. For network availability monitors the time unit is milliseconds, for browser and HTTP monitors - seconds.
|
|
24231
|
+
*
|
|
24232
|
+
* @minimum 0
|
|
23237
24233
|
*/
|
|
23238
24234
|
threshold: number;
|
|
23239
24235
|
/**
|
|
@@ -23242,6 +24238,8 @@ export declare interface SyntheticMonitorPerformanceThresholdDto {
|
|
|
23242
24238
|
type?: 'STEP' | 'MONITOR';
|
|
23243
24239
|
/**
|
|
23244
24240
|
* Number of violating request executions in analyzed sliding window.
|
|
24241
|
+
*
|
|
24242
|
+
* @minimum 1
|
|
23245
24243
|
*/
|
|
23246
24244
|
violatingSamples?: number;
|
|
23247
24245
|
}
|
|
@@ -23306,7 +24304,7 @@ export declare interface SyntheticMonitorSummaryDto {
|
|
|
23306
24304
|
/**
|
|
23307
24305
|
* The entity id of the monitor.
|
|
23308
24306
|
*/
|
|
23309
|
-
entityId
|
|
24307
|
+
entityId: string;
|
|
23310
24308
|
/**
|
|
23311
24309
|
* The name of the monitor.
|
|
23312
24310
|
*/
|
|
@@ -23314,7 +24312,7 @@ export declare interface SyntheticMonitorSummaryDto {
|
|
|
23314
24312
|
/**
|
|
23315
24313
|
* The type of the monitor.
|
|
23316
24314
|
*/
|
|
23317
|
-
type
|
|
24315
|
+
type: 'MULTI_PROTOCOL' | 'BROWSER' | 'HTTP';
|
|
23318
24316
|
}
|
|
23319
24317
|
|
|
23320
24318
|
/**
|
|
@@ -23338,6 +24336,8 @@ export declare interface SyntheticMultiProtocolMonitorRequest {
|
|
|
23338
24336
|
description?: string;
|
|
23339
24337
|
/**
|
|
23340
24338
|
* If true, the monitor is enabled.
|
|
24339
|
+
*
|
|
24340
|
+
* @defaultValue true
|
|
23341
24341
|
*/
|
|
23342
24342
|
enabled?: boolean;
|
|
23343
24343
|
/**
|
|
@@ -23366,6 +24366,8 @@ export declare interface SyntheticMultiProtocolMonitorRequest {
|
|
|
23366
24366
|
steps: SyntheticMultiProtocolMonitorStepDto[];
|
|
23367
24367
|
/**
|
|
23368
24368
|
* Outage handling configuration.
|
|
24369
|
+
*
|
|
24370
|
+
* @exampleValue {"globalConsecutiveOutageCountThreshold":"1","globalOutages":"true","localConsecutiveOutageCountThreshold":"3","localLocationOutageCountThreshold":"3","localOutages":"true"}
|
|
23369
24371
|
*/
|
|
23370
24372
|
syntheticMonitorOutageHandlingSettings?: SyntheticMonitorOutageHandlingSettingsDto;
|
|
23371
24373
|
/**
|
|
@@ -23437,6 +24439,8 @@ export declare interface SyntheticMultiProtocolMonitorResponse {
|
|
|
23437
24439
|
steps: SyntheticMultiProtocolMonitorStepDto[];
|
|
23438
24440
|
/**
|
|
23439
24441
|
* Outage handling configuration.
|
|
24442
|
+
*
|
|
24443
|
+
* @exampleValue {"globalConsecutiveOutageCountThreshold":"1","globalOutages":"true","localConsecutiveOutageCountThreshold":"3","localLocationOutageCountThreshold":"3","localOutages":"true"}
|
|
23440
24444
|
*/
|
|
23441
24445
|
syntheticMonitorOutageHandlingSettings: SyntheticMonitorOutageHandlingSettingsDto;
|
|
23442
24446
|
/**
|
|
@@ -23564,7 +24568,7 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
|
|
|
23564
24568
|
* * Management zone ID: `managementZoneId(1, 2)`.
|
|
23565
24569
|
* * Synthetic Location ME ID: `location(SYNTHETIC_LOCATION-123)`.
|
|
23566
24570
|
* * Monitored host ME ID: `monitoredEntity(HOST-123)`.
|
|
23567
|
-
* * 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.
|
|
24571
|
+
* * 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. Values listed within a single `tag(...)` are combined with **OR**. To require multiple tags (**AND**), specify several `tag(...)` selectors. For example, `tag(tag-a),tag(tag-b)` matches only monitors that have **both** tags, while `tag(tag-a,tag-b)` matches monitors that have **either**.
|
|
23568
24572
|
* * Monitor enablement: `enabled(true)`.
|
|
23569
24573
|
*
|
|
23570
24574
|
* To set several criteria, separate them with a comma (`,`).
|
|
@@ -23844,10 +24848,14 @@ export declare enum SyntheticOnDemandExecutionProcessingMode {
|
|
|
23844
24848
|
export declare interface SyntheticOnDemandExecutionRequest {
|
|
23845
24849
|
/**
|
|
23846
24850
|
* If true, the execution will fail in case of performance issue.
|
|
24851
|
+
*
|
|
24852
|
+
* @defaultValue true
|
|
23847
24853
|
*/
|
|
23848
24854
|
failOnPerformanceIssue?: boolean;
|
|
23849
24855
|
/**
|
|
23850
24856
|
* Applies to HTTP monitors only. If true, the execution will fail in case of an SSL certificate expiration warning or if the certificate is missing.
|
|
24857
|
+
*
|
|
24858
|
+
* @defaultValue true
|
|
23851
24859
|
*/
|
|
23852
24860
|
failOnSslWarning?: boolean;
|
|
23853
24861
|
/**
|
|
@@ -23864,14 +24872,20 @@ export declare interface SyntheticOnDemandExecutionRequest {
|
|
|
23864
24872
|
monitors?: SyntheticOnDemandExecutionRequestMonitor[];
|
|
23865
24873
|
/**
|
|
23866
24874
|
* The execution's processing mode
|
|
24875
|
+
*
|
|
24876
|
+
* @defaultValue STANDARD
|
|
23867
24877
|
*/
|
|
23868
24878
|
processingMode?: 'STANDARD' | 'DISABLE_PROBLEM_DETECTION' | 'EXECUTIONS_DETAILS_ONLY';
|
|
23869
24879
|
/**
|
|
23870
24880
|
* If true, no executions will be scheduled if a problem occurs.
|
|
24881
|
+
*
|
|
24882
|
+
* @defaultValue false
|
|
23871
24883
|
*/
|
|
23872
24884
|
stopOnProblem?: boolean;
|
|
23873
24885
|
/**
|
|
23874
24886
|
* If true, the screenshots will be taken during the execution of a browser monitor.
|
|
24887
|
+
*
|
|
24888
|
+
* @defaultValue false
|
|
23875
24889
|
*/
|
|
23876
24890
|
takeScreenshotsOnSuccess?: boolean;
|
|
23877
24891
|
}
|
|
@@ -23915,6 +24929,8 @@ export declare interface SyntheticOnDemandExecutionRequestMonitor {
|
|
|
23915
24929
|
customizedScript?: SyntheticOnDemandExecutionRequestMonitorCustomizedScript;
|
|
23916
24930
|
/**
|
|
23917
24931
|
* The number of times the monitor is to be executed per location; if not set, the monitor will be executed once.
|
|
24932
|
+
*
|
|
24933
|
+
* @defaultValue 1
|
|
23918
24934
|
*/
|
|
23919
24935
|
executionCount?: number;
|
|
23920
24936
|
/**
|
|
@@ -23927,6 +24943,8 @@ export declare interface SyntheticOnDemandExecutionRequestMonitor {
|
|
|
23927
24943
|
monitorId: string;
|
|
23928
24944
|
/**
|
|
23929
24945
|
* Execution repeat mode. If not set, the mode is SEQUENTIAL.
|
|
24946
|
+
*
|
|
24947
|
+
* @defaultValue SEQUENTIAL
|
|
23930
24948
|
*/
|
|
23931
24949
|
repeatMode?: 'SEQUENTIAL' | 'PARALLEL';
|
|
23932
24950
|
}
|
|
@@ -23992,7 +25010,7 @@ export declare interface SyntheticOnDemandExecutions {
|
|
|
23992
25010
|
/**
|
|
23993
25011
|
* The list of executions.
|
|
23994
25012
|
*/
|
|
23995
|
-
executions
|
|
25013
|
+
executions?: SyntheticOnDemandExecution[];
|
|
23996
25014
|
}
|
|
23997
25015
|
|
|
23998
25016
|
/**
|
|
@@ -24438,6 +25456,8 @@ export declare interface SyntheticPrivateLocationUpdate extends SyntheticLocatio
|
|
|
24438
25456
|
latitude: number;
|
|
24439
25457
|
/**
|
|
24440
25458
|
* Alert if location or node outage lasts longer than *X* minutes. \n\n Only applicable when `availabilityLocationOutage` or `availabilityNodeOutage` is set to `true`. Supported only for private Synthetic locations.
|
|
25459
|
+
*
|
|
25460
|
+
* @minimum 1
|
|
24441
25461
|
*/
|
|
24442
25462
|
locationNodeOutageDelayInMinutes?: number;
|
|
24443
25463
|
/**
|
|
@@ -24446,10 +25466,14 @@ export declare interface SyntheticPrivateLocationUpdate extends SyntheticLocatio
|
|
|
24446
25466
|
longitude: number;
|
|
24447
25467
|
/**
|
|
24448
25468
|
* Containerized location property. The maximum number of ActiveGates deployed for the location (required for a Kubernetes location).
|
|
25469
|
+
*
|
|
25470
|
+
* @minimum 1
|
|
24449
25471
|
*/
|
|
24450
25472
|
maxActiveGateCount?: number;
|
|
24451
25473
|
/**
|
|
24452
25474
|
* Containerized location property. The minimum number of ActiveGates deployed for the location (required for a Kubernetes location).
|
|
25475
|
+
*
|
|
25476
|
+
* @minimum 1
|
|
24453
25477
|
*/
|
|
24454
25478
|
minActiveGateCount?: number;
|
|
24455
25479
|
/**
|
|
@@ -24608,12 +25632,34 @@ export declare interface TenantTokenConfig {
|
|
|
24608
25632
|
old?: TenantToken;
|
|
24609
25633
|
}
|
|
24610
25634
|
|
|
25635
|
+
/**
|
|
25636
|
+
* Status of tenant token rotation.
|
|
25637
|
+
*/
|
|
25638
|
+
export declare interface TenantTokenRotationStatus {
|
|
25639
|
+
/**
|
|
25640
|
+
* Rotation status. ACTIVE when a secondary token exists, otherwise INACTIVE.
|
|
25641
|
+
*/
|
|
25642
|
+
status?: 'ACTIVE' | 'INACTIVE';
|
|
25643
|
+
}
|
|
25644
|
+
|
|
25645
|
+
/**
|
|
25646
|
+
* Rotation status. ACTIVE when a secondary token exists, otherwise INACTIVE.
|
|
25647
|
+
*
|
|
25648
|
+
* @deprecated Use literal values.
|
|
25649
|
+
*/
|
|
25650
|
+
export declare enum TenantTokenRotationStatusStatus {
|
|
25651
|
+
Active = "ACTIVE",
|
|
25652
|
+
Inactive = "INACTIVE"
|
|
25653
|
+
}
|
|
25654
|
+
|
|
24611
25655
|
/**
|
|
24612
25656
|
* Test device of a Browser Monitor.
|
|
24613
25657
|
*/
|
|
24614
25658
|
export declare interface TestDeviceDto {
|
|
24615
25659
|
/**
|
|
24616
25660
|
* Device height in px.
|
|
25661
|
+
*
|
|
25662
|
+
* @minimum 0
|
|
24617
25663
|
*/
|
|
24618
25664
|
height: number;
|
|
24619
25665
|
/**
|
|
@@ -24630,6 +25676,8 @@ export declare interface TestDeviceDto {
|
|
|
24630
25676
|
touchEnabled?: boolean;
|
|
24631
25677
|
/**
|
|
24632
25678
|
* Device width in px.
|
|
25679
|
+
*
|
|
25680
|
+
* @minimum 0
|
|
24633
25681
|
*/
|
|
24634
25682
|
width: number;
|
|
24635
25683
|
}
|
|
@@ -24654,6 +25702,8 @@ export declare interface TimeoutSettingsDto {
|
|
|
24654
25702
|
export declare interface TimeWaitConditionDto extends BaseWaitConditionDto {
|
|
24655
25703
|
/**
|
|
24656
25704
|
* Wait time in milliseconds.
|
|
25705
|
+
*
|
|
25706
|
+
* @minimum 0
|
|
24657
25707
|
*/
|
|
24658
25708
|
milliseconds: number;
|
|
24659
25709
|
}
|
|
@@ -24664,6 +25714,8 @@ export declare interface TimeWaitConditionDto extends BaseWaitConditionDto {
|
|
|
24664
25714
|
export declare interface TokenCredentials extends Credentials {
|
|
24665
25715
|
/**
|
|
24666
25716
|
* Information for synchronization credentials with external vault
|
|
25717
|
+
*
|
|
25718
|
+
* @exampleValue {"description":"Sample credentials for demo purposes.","externalVault":{"passwordSecretName":"password","pathToCredentials":"kv/credentials","roleId":"00e4858c-ec33-bc99-4e7e-34de6967de6c","secretId":"CREDENTIALS_VAULT-XXXXXXXXXXXXXXXX","sourceAuthMethod":"HASHICORP_VAULT_APPROLE","usernameSecretName":"username","vaultNamespace":"admin","vaultUrl":"https://vault-cluster.vault.fb17d2fc-be92-4230-afa2-91dbfda3cbad.aws.hashicorp.cloud:8200"},"id":"CREDENTIALS_VAULT-C43F2C2E6395AD23","name":"Sample username-password credentials synchronized with Hashicorp vault","owner":"user@domain.com","ownerAccessOnly":true,"scope":"SYNTHETIC","type":"USERNAME_PASSWORD"}
|
|
24667
25719
|
*/
|
|
24668
25720
|
externalVault?: ExternalVault;
|
|
24669
25721
|
/**
|
|
@@ -24938,18 +25990,26 @@ export declare interface UiTabGroupCustomization {
|
|
|
24938
25990
|
export declare interface UiTableColumnCustomization {
|
|
24939
25991
|
/**
|
|
24940
25992
|
* The ui specific builtin column-implementation for this column.
|
|
25993
|
+
*
|
|
25994
|
+
* @exampleValue summary
|
|
24941
25995
|
*/
|
|
24942
25996
|
builtinColumnRef?: string;
|
|
24943
25997
|
/**
|
|
24944
25998
|
* The referenced column from the 'tableColumns' property of the schema for this column.
|
|
25999
|
+
*
|
|
26000
|
+
* @exampleValue myCustomColumn
|
|
24945
26001
|
*/
|
|
24946
26002
|
columnRef?: string;
|
|
24947
26003
|
/**
|
|
24948
26004
|
* The display name for this column.
|
|
26005
|
+
*
|
|
26006
|
+
* @exampleValue Color
|
|
24949
26007
|
*/
|
|
24950
26008
|
displayName?: string;
|
|
24951
26009
|
/**
|
|
24952
26010
|
* The id for this column used for filtering. Required for conflicting or pathed columns - otherwise the ref is used.
|
|
26011
|
+
*
|
|
26012
|
+
* @exampleValue color
|
|
24953
26013
|
*/
|
|
24954
26014
|
id?: string;
|
|
24955
26015
|
/**
|
|
@@ -24958,14 +26018,20 @@ export declare interface UiTableColumnCustomization {
|
|
|
24958
26018
|
items?: UiTableColumnItemCustomization[];
|
|
24959
26019
|
/**
|
|
24960
26020
|
* The referenced property for this column.
|
|
26021
|
+
*
|
|
26022
|
+
* @exampleValue apiColor
|
|
24961
26023
|
*/
|
|
24962
26024
|
propertyRef?: string;
|
|
24963
26025
|
/**
|
|
24964
26026
|
* The ui specific type for this column.
|
|
26027
|
+
*
|
|
26028
|
+
* @exampleValue cell-color-picker
|
|
24965
26029
|
*/
|
|
24966
26030
|
type?: string;
|
|
24967
26031
|
/**
|
|
24968
26032
|
* The width this column should take up on the table.
|
|
26033
|
+
*
|
|
26034
|
+
* @exampleValue 10%
|
|
24969
26035
|
*/
|
|
24970
26036
|
width?: string;
|
|
24971
26037
|
}
|
|
@@ -24976,14 +26042,20 @@ export declare interface UiTableColumnCustomization {
|
|
|
24976
26042
|
export declare interface UiTableColumnItemCustomization {
|
|
24977
26043
|
/**
|
|
24978
26044
|
* The display name of this item.
|
|
26045
|
+
*
|
|
26046
|
+
* @exampleValue Active
|
|
24979
26047
|
*/
|
|
24980
26048
|
displayName?: string;
|
|
24981
26049
|
/**
|
|
24982
26050
|
* The icon of this item.
|
|
26051
|
+
*
|
|
26052
|
+
* @exampleValue CRITICAL
|
|
24983
26053
|
*/
|
|
24984
26054
|
icon?: string;
|
|
24985
26055
|
/**
|
|
24986
26056
|
* The value of this item.
|
|
26057
|
+
*
|
|
26058
|
+
* @exampleValue ACTIVE
|
|
24987
26059
|
*/
|
|
24988
26060
|
value: string;
|
|
24989
26061
|
}
|
|
@@ -25090,14 +26162,20 @@ export declare enum UpdateJavaScriptMappingFileMetadataPathFileType {
|
|
|
25090
26162
|
export declare interface UpdateJob {
|
|
25091
26163
|
/**
|
|
25092
26164
|
* The type of the ActiveGate.
|
|
26165
|
+
*
|
|
26166
|
+
* @exampleValue ENVIRONMENT
|
|
25093
26167
|
*/
|
|
25094
26168
|
agType?: 'CLUSTER' | 'ENVIRONMENT' | 'ENVIRONMENT_MULTI';
|
|
25095
26169
|
/**
|
|
25096
26170
|
* The job can (`true`) or can't (`false`) be cancelled at the moment.
|
|
26171
|
+
*
|
|
26172
|
+
* @exampleValue false
|
|
25097
26173
|
*/
|
|
25098
26174
|
cancelable?: boolean;
|
|
25099
26175
|
/**
|
|
25100
26176
|
* The duration of the update, in milliseconds.
|
|
26177
|
+
*
|
|
26178
|
+
* @exampleValue 3608000
|
|
25101
26179
|
*/
|
|
25102
26180
|
duration?: number;
|
|
25103
26181
|
/**
|
|
@@ -25110,14 +26188,20 @@ export declare interface UpdateJob {
|
|
|
25110
26188
|
error?: string;
|
|
25111
26189
|
/**
|
|
25112
26190
|
* The ID of the update job.
|
|
26191
|
+
*
|
|
26192
|
+
* @exampleValue -3524498778810258605
|
|
25113
26193
|
*/
|
|
25114
26194
|
jobId?: string;
|
|
25115
26195
|
/**
|
|
25116
26196
|
* The status of the update job.
|
|
26197
|
+
*
|
|
26198
|
+
* @exampleValue SUCCEED
|
|
25117
26199
|
*/
|
|
25118
26200
|
jobState?: 'FAILED' | 'IN_PROGRESS' | 'PENDING' | 'ROLLBACK' | 'SCHEDULED' | 'SKIPPED' | 'SUCCEED';
|
|
25119
26201
|
/**
|
|
25120
26202
|
* The initial version of the ActiveGate.
|
|
26203
|
+
*
|
|
26204
|
+
* @exampleValue 1.185.0.20200201-120000
|
|
25121
26205
|
*/
|
|
25122
26206
|
startVersion?: string;
|
|
25123
26207
|
/**
|
|
@@ -25126,20 +26210,28 @@ export declare interface UpdateJob {
|
|
|
25126
26210
|
* Specify the version in the `<major>.<minor>.<revision>.<timestamp>` format.
|
|
25127
26211
|
*
|
|
25128
26212
|
* To update to the latest available version, use the `latest` value.
|
|
26213
|
+
*
|
|
26214
|
+
* @exampleValue 1.190.0.20200301-130000
|
|
25129
26215
|
*/
|
|
25130
26216
|
targetVersion: string;
|
|
25131
26217
|
/**
|
|
25132
26218
|
* The timestamp of the update job completion.
|
|
25133
26219
|
*
|
|
25134
26220
|
* The `null` value means the job is still running.
|
|
26221
|
+
*
|
|
26222
|
+
* @exampleValue 1582031917814
|
|
25135
26223
|
*/
|
|
25136
26224
|
timestamp?: number;
|
|
25137
26225
|
/**
|
|
25138
26226
|
* The method of updating the ActiveGate or its component.
|
|
26227
|
+
*
|
|
26228
|
+
* @exampleValue AUTOMATIC
|
|
25139
26229
|
*/
|
|
25140
26230
|
updateMethod?: 'AUTOMATIC' | 'MANUAL_INSTALLATION' | 'ON_DEMAND';
|
|
25141
26231
|
/**
|
|
25142
26232
|
* The component to be updated.
|
|
26233
|
+
*
|
|
26234
|
+
* @exampleValue ACTIVE_GATE
|
|
25143
26235
|
*/
|
|
25144
26236
|
updateType?: 'ACTIVE_GATE' | 'REMOTE_PLUGIN_AGENT' | 'SYNTHETIC' | 'Z_REMOTE';
|
|
25145
26237
|
}
|
|
@@ -25176,6 +26268,8 @@ export declare enum UpdateJobJobState {
|
|
|
25176
26268
|
export declare interface UpdateJobList {
|
|
25177
26269
|
/**
|
|
25178
26270
|
* The ID of the ActiveGate.
|
|
26271
|
+
*
|
|
26272
|
+
* @exampleValue 0x3efdd092
|
|
25179
26273
|
*/
|
|
25180
26274
|
agId?: string;
|
|
25181
26275
|
/**
|
|
@@ -25251,10 +26345,14 @@ export declare enum UpdatePermissionsRequestPermissionsItem {
|
|
|
25251
26345
|
export declare interface UpdateWindow {
|
|
25252
26346
|
/**
|
|
25253
26347
|
* Identifier of maintenance window
|
|
26348
|
+
*
|
|
26349
|
+
* @exampleValue vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h
|
|
25254
26350
|
*/
|
|
25255
26351
|
id: string;
|
|
25256
26352
|
/**
|
|
25257
26353
|
* The name of maintenance window
|
|
26354
|
+
*
|
|
26355
|
+
* @exampleValue Daily maintenance window
|
|
25258
26356
|
*/
|
|
25259
26357
|
name?: string;
|
|
25260
26358
|
}
|
|
@@ -25307,6 +26405,8 @@ export declare enum UploadJavaScriptMappingFilePathFileType {
|
|
|
25307
26405
|
export declare interface UserPasswordCredentials extends Credentials {
|
|
25308
26406
|
/**
|
|
25309
26407
|
* Information for synchronization credentials with external vault
|
|
26408
|
+
*
|
|
26409
|
+
* @exampleValue {"description":"Sample credentials for demo purposes.","externalVault":{"passwordSecretName":"password","pathToCredentials":"kv/credentials","roleId":"00e4858c-ec33-bc99-4e7e-34de6967de6c","secretId":"CREDENTIALS_VAULT-XXXXXXXXXXXXXXXX","sourceAuthMethod":"HASHICORP_VAULT_APPROLE","usernameSecretName":"username","vaultNamespace":"admin","vaultUrl":"https://vault-cluster.vault.fb17d2fc-be92-4230-afa2-91dbfda3cbad.aws.hashicorp.cloud:8200"},"id":"CREDENTIALS_VAULT-C43F2C2E6395AD23","name":"Sample username-password credentials synchronized with Hashicorp vault","owner":"user@domain.com","ownerAccessOnly":true,"scope":"SYNTHETIC","type":"USERNAME_PASSWORD"}
|
|
25310
26410
|
*/
|
|
25311
26411
|
externalVault?: ExternalVault;
|
|
25312
26412
|
/**
|
|
@@ -25314,7 +26414,7 @@ export declare interface UserPasswordCredentials extends Credentials {
|
|
|
25314
26414
|
*/
|
|
25315
26415
|
password?: string;
|
|
25316
26416
|
/**
|
|
25317
|
-
* The username of the credentials set.
|
|
26417
|
+
* The username of the credentials set. Must not contain any ":" character.
|
|
25318
26418
|
*/
|
|
25319
26419
|
user?: string;
|
|
25320
26420
|
}
|
|
@@ -25348,6 +26448,8 @@ export declare interface ValidationRuleDto {
|
|
|
25348
26448
|
regex?: boolean;
|
|
25349
26449
|
/**
|
|
25350
26450
|
* Target of Browser Monitor step.
|
|
26451
|
+
*
|
|
26452
|
+
* @exampleValue {"locators":[{"type":"CSS","value":"<img>[id='logoIcon']"},{"type":"CSS","value":"<a>[id='externalSite']"}],"window":"ruxitWin[0]"}
|
|
25351
26453
|
*/
|
|
25352
26454
|
target?: TargetDto;
|
|
25353
26455
|
/**
|
|
@@ -25373,10 +26475,14 @@ export declare enum ValidationRuleDtoType {
|
|
|
25373
26475
|
export declare interface ValidationWaitConditionDto extends BaseWaitConditionDto {
|
|
25374
26476
|
/**
|
|
25375
26477
|
* Validation timeout in milliseconds.
|
|
26478
|
+
*
|
|
26479
|
+
* @minimum 0
|
|
25376
26480
|
*/
|
|
25377
26481
|
timeoutInMilliseconds: number;
|
|
25378
26482
|
/**
|
|
25379
26483
|
* Validation rule of Browser Monitor step.
|
|
26484
|
+
*
|
|
26485
|
+
* @exampleValue {"failIfFound":false,"matchingPattern":"some text to match","regex":false,"target":{"locators":[{"type":"CSS","value":"<img>[id='logoIcon']"},{"type":"CSS","value":"<a>[id='externalSite']"}],"window":"ruxitWin[0]"},"type":"TEXT_MATCH"}
|
|
25380
26486
|
*/
|
|
25381
26487
|
validationRule: ValidationRuleDto;
|
|
25382
26488
|
}
|