@dynatrace-sdk/client-classic-environment-v2 6.1.0 → 8.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 +47 -0
- package/README.md +3717 -3140
- package/cjs/index.js +2996 -2243
- package/dynatrace-metadata.json +2 -2
- package/esm/index.js +3021 -2250
- package/package.json +1 -1
- package/types/index.d.ts +1547 -112
package/types/index.d.ts
CHANGED
|
@@ -502,6 +502,8 @@ export declare class AccessTokensApiTokensClient {
|
|
|
502
502
|
* If no prefix is set, + is used.
|
|
503
503
|
*
|
|
504
504
|
* If not set, tokens are sorted by creation date with newest first.
|
|
505
|
+
*
|
|
506
|
+
* @defaultValue -creationDate
|
|
505
507
|
*/ sort?: string;
|
|
506
508
|
abortSignal?: AbortSignal_2;
|
|
507
509
|
}): Promise<ApiTokenList>;
|
|
@@ -775,6 +777,35 @@ export declare class AccessTokensTenantTokensClient {
|
|
|
775
777
|
startRotation(config?: {
|
|
776
778
|
abortSignal?: AbortSignal_2;
|
|
777
779
|
} | AbortSignal_2): Promise<TenantTokenConfig>;
|
|
780
|
+
/**
|
|
781
|
+
* Gets tenant token rotation status
|
|
782
|
+
*
|
|
783
|
+
* **One of the following scopes is required:**
|
|
784
|
+
* + environment-api:tenant-token-rotation:write
|
|
785
|
+
* + fleet-management:tenant-token:rotate
|
|
786
|
+
*
|
|
787
|
+
* <br/>**One of the following permissions is required:**
|
|
788
|
+
* + environment:roles:manage-settings
|
|
789
|
+
* + fleet-management:tenant-token:rotate
|
|
790
|
+
*
|
|
791
|
+
* <br/><br/>To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6) in Dynatrace Documentation.
|
|
792
|
+
*
|
|
793
|
+
* @returns {Promise<TenantTokenRotationStatus>} Success. Returns rotation status.
|
|
794
|
+
*
|
|
795
|
+
* @example <caption>Code example</caption>
|
|
796
|
+
* import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
797
|
+
*
|
|
798
|
+
* const data =
|
|
799
|
+
* await accessTokensTenantTokensClient.getRotationStatus();
|
|
800
|
+
*
|
|
801
|
+
* @throws {ErrorEnvelopeError} Failed. Tenant token configuration is unavailable. | Client side error. | Server side error.
|
|
802
|
+
* @throws {InvalidResponseError}
|
|
803
|
+
* @throws {ApiClientError}
|
|
804
|
+
* @throws {ClientRequestError}
|
|
805
|
+
*/
|
|
806
|
+
getRotationStatus(config?: {
|
|
807
|
+
abortSignal?: AbortSignal_2;
|
|
808
|
+
} | AbortSignal_2): Promise<TenantTokenRotationStatus>;
|
|
778
809
|
}
|
|
779
810
|
|
|
780
811
|
export declare const accessTokensTenantTokensClient: AccessTokensTenantTokensClient;
|
|
@@ -788,11 +819,13 @@ export declare interface ActiveGate {
|
|
|
788
819
|
*/
|
|
789
820
|
activeGateTokens?: ActiveGateTokenInfoDto[];
|
|
790
821
|
/**
|
|
791
|
-
*
|
|
822
|
+
* Auto-update configuration for an individual environment ActiveGate.
|
|
792
823
|
*/
|
|
793
824
|
autoUpdateSettings?: ActiveGateAutoUpdateConfig;
|
|
794
825
|
/**
|
|
795
826
|
* The current status of auto-updates of the ActiveGate.
|
|
827
|
+
*
|
|
828
|
+
* @exampleValue OUTDATED
|
|
796
829
|
*/
|
|
797
830
|
autoUpdateStatus?: 'INCOMPATIBLE' | 'OUTDATED' | 'SCHEDULED' | 'SUPPRESSED' | 'UNKNOWN' | 'UP2DATE' | 'UPDATE_IN_PROGRESS' | 'UPDATE_PENDING' | 'UPDATE_PROBLEM';
|
|
798
831
|
/**
|
|
@@ -813,14 +846,20 @@ export declare interface ActiveGate {
|
|
|
813
846
|
fipsMode?: boolean;
|
|
814
847
|
/**
|
|
815
848
|
* The group of the ActiveGate.
|
|
849
|
+
*
|
|
850
|
+
* @exampleValue default
|
|
816
851
|
*/
|
|
817
852
|
group?: string;
|
|
818
853
|
/**
|
|
819
854
|
* The name of the host the ActiveGate is running on.
|
|
855
|
+
*
|
|
856
|
+
* @exampleValue exampleHostname
|
|
820
857
|
*/
|
|
821
858
|
hostname?: string;
|
|
822
859
|
/**
|
|
823
860
|
* The ID of the ActiveGate.
|
|
861
|
+
*
|
|
862
|
+
* @exampleValue 0x3efdd091
|
|
824
863
|
*/
|
|
825
864
|
id?: string;
|
|
826
865
|
/**
|
|
@@ -829,6 +868,8 @@ export declare interface ActiveGate {
|
|
|
829
868
|
loadBalancerAddresses?: string[];
|
|
830
869
|
/**
|
|
831
870
|
* The ID of the main environment for a multi-environment ActiveGate.
|
|
871
|
+
*
|
|
872
|
+
* @exampleValue d1bf4a7e-666b-43af-9f45-718g98372e2f
|
|
832
873
|
*/
|
|
833
874
|
mainEnvironment?: string;
|
|
834
875
|
/**
|
|
@@ -841,52 +882,82 @@ export declare interface ActiveGate {
|
|
|
841
882
|
networkAddresses?: string[];
|
|
842
883
|
/**
|
|
843
884
|
* The network zone of the ActiveGate.
|
|
885
|
+
*
|
|
886
|
+
* @exampleValue exampleNetworkZone
|
|
844
887
|
*/
|
|
845
888
|
networkZone?: string;
|
|
846
889
|
/**
|
|
847
890
|
* The timestamp since when the ActiveGate is offline.
|
|
848
891
|
*
|
|
849
892
|
* The `null` value means the ActiveGate is online.
|
|
893
|
+
*
|
|
894
|
+
* @exampleValue 1582031917814
|
|
850
895
|
*/
|
|
851
896
|
offlineSince?: number;
|
|
852
897
|
/**
|
|
853
898
|
* The OS architecture that the ActiveGate is running on.
|
|
899
|
+
*
|
|
900
|
+
* @exampleValue X86
|
|
854
901
|
*/
|
|
855
902
|
osArchitecture?: 'S390' | 'X86' | 'ARM' | 'PPCLE';
|
|
856
903
|
/**
|
|
857
904
|
* The OS bitness that the ActiveGate is running on.
|
|
905
|
+
*
|
|
906
|
+
* @exampleValue 64
|
|
858
907
|
*/
|
|
859
908
|
osBitness?: '64';
|
|
860
909
|
/**
|
|
861
910
|
* The OS type that the ActiveGate is running on.
|
|
911
|
+
*
|
|
912
|
+
* @exampleValue WINDOWS
|
|
862
913
|
*/
|
|
863
914
|
osType?: 'LINUX' | 'WINDOWS';
|
|
864
915
|
/**
|
|
865
916
|
* The type of the ActiveGate.
|
|
917
|
+
*
|
|
918
|
+
* @exampleValue ENVIRONMENT
|
|
866
919
|
*/
|
|
867
920
|
type?: 'CLUSTER' | 'ENVIRONMENT' | 'ENVIRONMENT_MULTI';
|
|
868
921
|
/**
|
|
869
922
|
* The current version of the ActiveGate in the `<major>.<minor>.<revision>.<timestamp>` format.
|
|
923
|
+
*
|
|
924
|
+
* @exampleValue 1.185.0.20200201-120000
|
|
870
925
|
*/
|
|
871
926
|
version?: string;
|
|
872
927
|
}
|
|
873
928
|
|
|
874
929
|
/**
|
|
875
|
-
*
|
|
930
|
+
* Auto-update configuration for an individual environment ActiveGate.
|
|
876
931
|
*/
|
|
877
932
|
export declare interface ActiveGateAutoUpdateConfig {
|
|
878
933
|
/**
|
|
879
934
|
* The actual state of the ActiveGate auto-update.
|
|
880
935
|
*
|
|
881
936
|
* 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.
|
|
937
|
+
*
|
|
938
|
+
* @exampleValue ENABLED
|
|
882
939
|
*/
|
|
883
940
|
effectiveSetting?: 'ENABLED' | 'DISABLED';
|
|
884
941
|
/**
|
|
885
|
-
* The state of the ActiveGate auto-update: enabled, disabled, or inherited.
|
|
942
|
+
* The state of the environment ActiveGate auto-update: enabled, disabled, or inherited.
|
|
943
|
+
*
|
|
944
|
+
* If set to `INHERITED`, the setting is inherited from the global environment ActiveGate auto-update configuration.
|
|
886
945
|
*
|
|
887
|
-
*
|
|
946
|
+
* @exampleValue INHERITED
|
|
888
947
|
*/
|
|
889
948
|
setting: 'DISABLED' | 'ENABLED' | 'INHERITED';
|
|
949
|
+
/**
|
|
950
|
+
* The target version of the ActiveGate.
|
|
951
|
+
*
|
|
952
|
+
* Specify the version in the `<major>.<minor>` format (for example `1.342`) or `latest`, `previous`, or `older`.
|
|
953
|
+
*
|
|
954
|
+
* @exampleValue latest
|
|
955
|
+
*/
|
|
956
|
+
targetVersion?: string;
|
|
957
|
+
/**
|
|
958
|
+
* Basic information about all configured update windows
|
|
959
|
+
*/
|
|
960
|
+
updateWindows?: UpdateWindowsConfig;
|
|
890
961
|
}
|
|
891
962
|
|
|
892
963
|
/**
|
|
@@ -902,9 +973,9 @@ export declare enum ActiveGateAutoUpdateConfigEffectiveSetting {
|
|
|
902
973
|
}
|
|
903
974
|
|
|
904
975
|
/**
|
|
905
|
-
* The state of the ActiveGate auto-update: enabled, disabled, or inherited.
|
|
976
|
+
* The state of the environment ActiveGate auto-update: enabled, disabled, or inherited.
|
|
906
977
|
*
|
|
907
|
-
* If set to `INHERITED`, the setting is inherited from the global
|
|
978
|
+
* If set to `INHERITED`, the setting is inherited from the global environment ActiveGate auto-update configuration.
|
|
908
979
|
*
|
|
909
980
|
* @deprecated Use literal values.
|
|
910
981
|
*/
|
|
@@ -937,30 +1008,46 @@ export declare enum ActiveGateAutoUpdateStatus {
|
|
|
937
1008
|
export declare interface ActiveGateConnectedHosts {
|
|
938
1009
|
/**
|
|
939
1010
|
* The number of hosts currently connected to the ActiveGate
|
|
1011
|
+
*
|
|
1012
|
+
* @exampleValue 150
|
|
940
1013
|
*/
|
|
941
1014
|
number?: number;
|
|
942
1015
|
}
|
|
943
1016
|
|
|
944
1017
|
/**
|
|
945
|
-
* Global configuration
|
|
1018
|
+
* Global auto-update configuration for environment ActiveGates. Applies to all environment ActiveGates that have the `INHERITED` auto-update setting.
|
|
946
1019
|
*/
|
|
947
1020
|
export declare interface ActiveGateGlobalAutoUpdateConfig {
|
|
948
1021
|
/**
|
|
949
|
-
* The state of auto-updates for all
|
|
1022
|
+
* The state of auto-updates for all environment ActiveGates.
|
|
950
1023
|
*
|
|
951
|
-
* This setting is inherited by all ActiveGates that have the `INHERITED` setting.
|
|
1024
|
+
* This setting is inherited by all environment ActiveGates that have the `INHERITED` setting.
|
|
952
1025
|
*/
|
|
953
1026
|
globalSetting: 'ENABLED' | 'DISABLED';
|
|
954
1027
|
/**
|
|
955
1028
|
* Metadata useful for debugging
|
|
956
1029
|
*/
|
|
957
1030
|
metadata?: ConfigurationMetadata;
|
|
1031
|
+
/**
|
|
1032
|
+
* Version to update a ActiveGate to when automatic updates are enabled.
|
|
1033
|
+
*
|
|
1034
|
+
* Supports relative versions `latest`, `previous` and `older` as well as specific version in `<major>.<minor>` format (for example `1.261`).
|
|
1035
|
+
*
|
|
1036
|
+
* Only applicable when the **setting** parameter is set to `ENABLED`.
|
|
1037
|
+
*
|
|
1038
|
+
* @exampleValue latest
|
|
1039
|
+
*/
|
|
1040
|
+
targetVersion?: string;
|
|
1041
|
+
/**
|
|
1042
|
+
* Basic information about all configured update windows
|
|
1043
|
+
*/
|
|
1044
|
+
updateWindows?: UpdateWindowsConfig;
|
|
958
1045
|
}
|
|
959
1046
|
|
|
960
1047
|
/**
|
|
961
|
-
* The state of auto-updates for all
|
|
1048
|
+
* The state of auto-updates for all environment ActiveGates.
|
|
962
1049
|
*
|
|
963
|
-
* This setting is inherited by all ActiveGates that have the `INHERITED` setting.
|
|
1050
|
+
* This setting is inherited by all environment ActiveGates that have the `INHERITED` setting.
|
|
964
1051
|
*
|
|
965
1052
|
* @deprecated Use literal values.
|
|
966
1053
|
*/
|
|
@@ -975,6 +1062,8 @@ export declare enum ActiveGateGlobalAutoUpdateConfigGlobalSetting {
|
|
|
975
1062
|
export declare interface ActiveGateGroup {
|
|
976
1063
|
/**
|
|
977
1064
|
* Name of ActiveGate group
|
|
1065
|
+
*
|
|
1066
|
+
* @exampleValue default
|
|
978
1067
|
*/
|
|
979
1068
|
name?: string;
|
|
980
1069
|
}
|
|
@@ -1059,6 +1148,8 @@ export declare interface ActiveGateModule {
|
|
|
1059
1148
|
misconfigured?: boolean;
|
|
1060
1149
|
/**
|
|
1061
1150
|
* The type of ActiveGate module.
|
|
1151
|
+
*
|
|
1152
|
+
* @exampleValue KUBERNETES
|
|
1062
1153
|
*/
|
|
1063
1154
|
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';
|
|
1064
1155
|
/**
|
|
@@ -1155,6 +1246,10 @@ export declare class ActiveGatesActiveGateGroupsClient {
|
|
|
1155
1246
|
* + environment:roles:manage-settings
|
|
1156
1247
|
* + fleet-management:activegates:read
|
|
1157
1248
|
*
|
|
1249
|
+
* <br/><br/>Deprecated since version 1.343. Use DQL Smartscape nodes to query ActiveGate data instead. See https://dt-url.net/mf03894
|
|
1250
|
+
*
|
|
1251
|
+
* @deprecated
|
|
1252
|
+
*
|
|
1158
1253
|
* @returns {Promise<ActiveGateGroups>} Success
|
|
1159
1254
|
*
|
|
1160
1255
|
* @example <caption>Code example</caption>
|
|
@@ -1283,7 +1378,18 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
|
|
|
1283
1378
|
*
|
|
1284
1379
|
* const data =
|
|
1285
1380
|
* await activeGatesAutoUpdateConfigurationClient.putGlobalAutoUpdateConfigForTenant(
|
|
1286
|
-
* {
|
|
1381
|
+
* {
|
|
1382
|
+
* body: {
|
|
1383
|
+
* globalSetting: "ENABLED",
|
|
1384
|
+
* updateWindows: {
|
|
1385
|
+
* windows: [
|
|
1386
|
+
* {
|
|
1387
|
+
* id: "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h",
|
|
1388
|
+
* },
|
|
1389
|
+
* ],
|
|
1390
|
+
* },
|
|
1391
|
+
* },
|
|
1392
|
+
* },
|
|
1287
1393
|
* );
|
|
1288
1394
|
*
|
|
1289
1395
|
* @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
|
|
@@ -1317,7 +1423,18 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
|
|
|
1317
1423
|
*
|
|
1318
1424
|
* const data =
|
|
1319
1425
|
* await activeGatesAutoUpdateConfigurationClient.validateGlobalAutoUpdateConfigForTenant(
|
|
1320
|
-
* {
|
|
1426
|
+
* {
|
|
1427
|
+
* body: {
|
|
1428
|
+
* globalSetting: "ENABLED",
|
|
1429
|
+
* updateWindows: {
|
|
1430
|
+
* windows: [
|
|
1431
|
+
* {
|
|
1432
|
+
* id: "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h",
|
|
1433
|
+
* },
|
|
1434
|
+
* ],
|
|
1435
|
+
* },
|
|
1436
|
+
* },
|
|
1437
|
+
* },
|
|
1321
1438
|
* );
|
|
1322
1439
|
*
|
|
1323
1440
|
* @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
|
|
@@ -1387,7 +1504,19 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
|
|
|
1387
1504
|
*
|
|
1388
1505
|
* const data =
|
|
1389
1506
|
* await activeGatesAutoUpdateConfigurationClient.putAutoUpdateConfigById(
|
|
1390
|
-
* {
|
|
1507
|
+
* {
|
|
1508
|
+
* agId: "...",
|
|
1509
|
+
* body: {
|
|
1510
|
+
* setting: "INHERITED",
|
|
1511
|
+
* updateWindows: {
|
|
1512
|
+
* windows: [
|
|
1513
|
+
* {
|
|
1514
|
+
* id: "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h",
|
|
1515
|
+
* },
|
|
1516
|
+
* ],
|
|
1517
|
+
* },
|
|
1518
|
+
* },
|
|
1519
|
+
* },
|
|
1391
1520
|
* );
|
|
1392
1521
|
*
|
|
1393
1522
|
* @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
|
|
@@ -1422,7 +1551,19 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
|
|
|
1422
1551
|
*
|
|
1423
1552
|
* const data =
|
|
1424
1553
|
* await activeGatesAutoUpdateConfigurationClient.validateAutoUpdateConfigById(
|
|
1425
|
-
* {
|
|
1554
|
+
* {
|
|
1555
|
+
* agId: "...",
|
|
1556
|
+
* body: {
|
|
1557
|
+
* setting: "INHERITED",
|
|
1558
|
+
* updateWindows: {
|
|
1559
|
+
* windows: [
|
|
1560
|
+
* {
|
|
1561
|
+
* id: "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h",
|
|
1562
|
+
* },
|
|
1563
|
+
* ],
|
|
1564
|
+
* },
|
|
1565
|
+
* },
|
|
1566
|
+
* },
|
|
1426
1567
|
* );
|
|
1427
1568
|
*
|
|
1428
1569
|
* @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
|
|
@@ -1523,14 +1664,22 @@ export declare class ActiveGatesAutoUpdateJobsClient {
|
|
|
1523
1664
|
* Specify the comparison operator here.
|
|
1524
1665
|
*/ startVersionCompareType?: 'EQUAL' | 'GREATER' | 'GREATER_EQUAL' | 'LOWER' | 'LOWER_EQUAL';
|
|
1525
1666
|
/** Filters the resulting set of update-jobs by the initial version (required format `<major>.<minor>.<revision>`). */ startVersion?: string;
|
|
1526
|
-
/**
|
|
1667
|
+
/**
|
|
1668
|
+
* Filters the resulting set of update-jobs by the update type.
|
|
1669
|
+
*
|
|
1670
|
+
* @exampleValue ACTIVE_GATE
|
|
1671
|
+
*/ updateType?: 'ACTIVE_GATE' | 'REMOTE_PLUGIN_AGENT' | 'SYNTHETIC' | 'Z_REMOTE';
|
|
1527
1672
|
/**
|
|
1528
1673
|
* Filters the resulting set of update jobs by the specified target version.
|
|
1529
1674
|
*
|
|
1530
1675
|
* Specify the comparison operator here.
|
|
1531
1676
|
*/ targetVersionCompareType?: 'EQUAL' | 'GREATER' | 'GREATER_EQUAL' | 'LOWER' | 'LOWER_EQUAL';
|
|
1532
1677
|
/** Filters the resulting set of update-jobs by the target version (required format `<major>.<minor>.<revision>`). */ targetVersion?: string;
|
|
1533
|
-
/**
|
|
1678
|
+
/**
|
|
1679
|
+
* If `true`, filters the resulting set of update jobs to the most recent update of each type.
|
|
1680
|
+
*
|
|
1681
|
+
* @defaultValue false
|
|
1682
|
+
*/ lastUpdates?: boolean;
|
|
1534
1683
|
abortSignal?: AbortSignal_2;
|
|
1535
1684
|
}): Promise<UpdateJobsAll>;
|
|
1536
1685
|
/**
|
|
@@ -1607,14 +1756,22 @@ export declare class ActiveGatesAutoUpdateJobsClient {
|
|
|
1607
1756
|
* Specify the comparison operator here.
|
|
1608
1757
|
*/ startVersionCompareType?: 'EQUAL' | 'GREATER' | 'GREATER_EQUAL' | 'LOWER' | 'LOWER_EQUAL';
|
|
1609
1758
|
/** Filters the resulting set of update-jobs by the initial version (required format `<major>.<minor>.<revision>`). */ startVersion?: string;
|
|
1610
|
-
/**
|
|
1759
|
+
/**
|
|
1760
|
+
* Filters the resulting set of update-jobs by the update type.
|
|
1761
|
+
*
|
|
1762
|
+
* @exampleValue ACTIVE_GATE
|
|
1763
|
+
*/ updateType?: 'ACTIVE_GATE' | 'REMOTE_PLUGIN_AGENT' | 'SYNTHETIC' | 'Z_REMOTE';
|
|
1611
1764
|
/**
|
|
1612
1765
|
* Filters the resulting set of update jobs by the specified target version.
|
|
1613
1766
|
*
|
|
1614
1767
|
* Specify the comparison operator here.
|
|
1615
1768
|
*/ targetVersionCompareType?: 'EQUAL' | 'GREATER' | 'GREATER_EQUAL' | 'LOWER' | 'LOWER_EQUAL';
|
|
1616
1769
|
/** Filters the resulting set of update-jobs by the target version (required format `<major>.<minor>.<revision>`). */ targetVersion?: string;
|
|
1617
|
-
/**
|
|
1770
|
+
/**
|
|
1771
|
+
* If `true`, filters the resulting set of update jobs to the most recent update of each type.
|
|
1772
|
+
*
|
|
1773
|
+
* @defaultValue false
|
|
1774
|
+
*/ lastUpdates?: boolean;
|
|
1618
1775
|
abortSignal?: AbortSignal_2;
|
|
1619
1776
|
}): Promise<UpdateJobList>;
|
|
1620
1777
|
/**
|
|
@@ -1771,7 +1928,9 @@ export declare class ActiveGatesClient {
|
|
|
1771
1928
|
* + environment:roles:manage-settings
|
|
1772
1929
|
* + fleet-management:activegates:read
|
|
1773
1930
|
*
|
|
1774
|
-
* <br/><br/>The response includes all ActiveGates that are currently connected to the environment or have been connected during last 2 hours.
|
|
1931
|
+
* <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
|
|
1932
|
+
*
|
|
1933
|
+
* @deprecated
|
|
1775
1934
|
*
|
|
1776
1935
|
* @returns {Promise<ActiveGateList>} Success
|
|
1777
1936
|
*
|
|
@@ -1846,6 +2005,10 @@ export declare class ActiveGatesClient {
|
|
|
1846
2005
|
* + environment:roles:manage-settings
|
|
1847
2006
|
* + fleet-management:activegates:read
|
|
1848
2007
|
*
|
|
2008
|
+
* <br/><br/>Deprecated since version 1.343. Use DQL Smartscape nodes to query ActiveGate data instead. See https://dt-url.net/mf03894
|
|
2009
|
+
*
|
|
2010
|
+
* @deprecated
|
|
2011
|
+
*
|
|
1849
2012
|
* @returns {Promise<ActiveGate>} Success
|
|
1850
2013
|
*
|
|
1851
2014
|
* @example <caption>Code example</caption>
|
|
@@ -2105,32 +2268,46 @@ export declare interface ActiveGateToken {
|
|
|
2105
2268
|
activeGateType: 'ENVIRONMENT' | 'CLUSTER';
|
|
2106
2269
|
/**
|
|
2107
2270
|
* The token creation date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
|
|
2271
|
+
*
|
|
2272
|
+
* @exampleValue 2020-11-22T08:15:30.144Z
|
|
2108
2273
|
*/
|
|
2109
2274
|
creationDate: string;
|
|
2110
2275
|
/**
|
|
2111
2276
|
* The token expiration date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
|
|
2112
2277
|
*
|
|
2113
2278
|
* If not set, the token never expires.
|
|
2279
|
+
*
|
|
2280
|
+
* @exampleValue 2020-11-24T08:15:30.144Z
|
|
2114
2281
|
*/
|
|
2115
2282
|
expirationDate?: string;
|
|
2116
2283
|
/**
|
|
2117
2284
|
* The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/rn00tjg) of the token.
|
|
2285
|
+
*
|
|
2286
|
+
* @exampleValue dt0g02.4KWZO5EF
|
|
2118
2287
|
*/
|
|
2119
2288
|
id: string;
|
|
2120
2289
|
/**
|
|
2121
2290
|
* The token last used date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
|
|
2291
|
+
*
|
|
2292
|
+
* @exampleValue 2020-11-23T08:15:30.144Z
|
|
2122
2293
|
*/
|
|
2123
2294
|
lastUsedDate?: string;
|
|
2124
2295
|
/**
|
|
2125
2296
|
* The name of the token.
|
|
2297
|
+
*
|
|
2298
|
+
* @exampleValue myToken
|
|
2126
2299
|
*/
|
|
2127
2300
|
name: string;
|
|
2128
2301
|
/**
|
|
2129
2302
|
* The owner of the token.
|
|
2303
|
+
*
|
|
2304
|
+
* @exampleValue john.smith
|
|
2130
2305
|
*/
|
|
2131
2306
|
owner: string;
|
|
2132
2307
|
/**
|
|
2133
2308
|
* The token is a seed token (`true`) or an individual token (`false`).
|
|
2309
|
+
*
|
|
2310
|
+
* @exampleValue false
|
|
2134
2311
|
*/
|
|
2135
2312
|
seedToken?: boolean;
|
|
2136
2313
|
}
|
|
@@ -2172,16 +2349,22 @@ export declare interface ActiveGateTokenCreate {
|
|
|
2172
2349
|
* If not set, the token never expires.
|
|
2173
2350
|
*
|
|
2174
2351
|
* Ensure that it is not set in the past and does not exceed `2 years` from the moment of creation."
|
|
2352
|
+
*
|
|
2353
|
+
* @exampleValue now+6M
|
|
2175
2354
|
*/
|
|
2176
2355
|
expirationDate?: string;
|
|
2177
2356
|
/**
|
|
2178
2357
|
* The name of the token.
|
|
2358
|
+
*
|
|
2359
|
+
* @exampleValue myToken
|
|
2179
2360
|
*/
|
|
2180
2361
|
name: string;
|
|
2181
2362
|
/**
|
|
2182
2363
|
* The token is a seed token (`true`) or an individual token (`false`).
|
|
2183
2364
|
*
|
|
2184
2365
|
* We recommend the individual token option (false).
|
|
2366
|
+
*
|
|
2367
|
+
* @exampleValue false
|
|
2185
2368
|
*/
|
|
2186
2369
|
seedToken?: boolean;
|
|
2187
2370
|
}
|
|
@@ -2202,14 +2385,20 @@ export declare enum ActiveGateTokenCreateActiveGateType {
|
|
|
2202
2385
|
export declare interface ActiveGateTokenCreated {
|
|
2203
2386
|
/**
|
|
2204
2387
|
* The token expiration date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
|
|
2388
|
+
*
|
|
2389
|
+
* @exampleValue 2020-11-24T08:15:30.144Z
|
|
2205
2390
|
*/
|
|
2206
2391
|
expirationDate?: string;
|
|
2207
2392
|
/**
|
|
2208
2393
|
* The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/rn00tjg) of the token.
|
|
2394
|
+
*
|
|
2395
|
+
* @exampleValue dt0g02.4KWZO5EF
|
|
2209
2396
|
*/
|
|
2210
2397
|
id: string;
|
|
2211
2398
|
/**
|
|
2212
2399
|
* The secret of the token.
|
|
2400
|
+
*
|
|
2401
|
+
* @exampleValue dt0g02.4KWZO5EF.XT47R5DRADJIZUFOX4UDNOKTSUSABGLN7XSMJG7UXHRXKNY4WLORH4OF4T75MG7E
|
|
2213
2402
|
*/
|
|
2214
2403
|
token: string;
|
|
2215
2404
|
}
|
|
@@ -2244,6 +2433,8 @@ export declare interface ActiveGateTokenInfoDto {
|
|
|
2244
2433
|
environmentId?: string;
|
|
2245
2434
|
/**
|
|
2246
2435
|
* The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/rn00tjg) of the token.
|
|
2436
|
+
*
|
|
2437
|
+
* @exampleValue dt0g02.4KWZO5EF
|
|
2247
2438
|
*/
|
|
2248
2439
|
id?: string;
|
|
2249
2440
|
/**
|
|
@@ -2278,6 +2469,8 @@ export declare interface ActiveGateTokenList {
|
|
|
2278
2469
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
2279
2470
|
*
|
|
2280
2471
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
2472
|
+
*
|
|
2473
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
2281
2474
|
*/
|
|
2282
2475
|
nextPageKey?: string;
|
|
2283
2476
|
/**
|
|
@@ -2301,6 +2494,48 @@ export declare enum ActiveGateType {
|
|
|
2301
2494
|
EnvironmentMulti = "ENVIRONMENT_MULTI"
|
|
2302
2495
|
}
|
|
2303
2496
|
|
|
2497
|
+
/**
|
|
2498
|
+
* Read sampling configuration for Adaptive Traffic Management
|
|
2499
|
+
*/
|
|
2500
|
+
export declare class AdaptiveTrafficManagementClient {
|
|
2501
|
+
private httpClient;
|
|
2502
|
+
private shouldTransformDates;
|
|
2503
|
+
/**
|
|
2504
|
+
* @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a AdaptiveTrafficManagementClient. Custom http client should implement {HttpClient} interface.
|
|
2505
|
+
* @param {ApiClientOptions} [options] - Optional configuration for SDK Client.
|
|
2506
|
+
* @example
|
|
2507
|
+
* const adaptiveTrafficManagementClientNodeJs = new AdaptiveTrafficManagementClient(yourCustomImplementation);
|
|
2508
|
+
*/
|
|
2509
|
+
constructor(httpClientImplementation: HttpClient, options?: ApiClientOptions);
|
|
2510
|
+
/**
|
|
2511
|
+
* Gets sampling configuration.
|
|
2512
|
+
*
|
|
2513
|
+
* **Required scope:** adaptive-traffic-management:sampling-configuration:read
|
|
2514
|
+
*
|
|
2515
|
+
* @returns {Promise<AdaptiveTrafficManagementDto>} Success
|
|
2516
|
+
*
|
|
2517
|
+
* @example <caption>Code example</caption>
|
|
2518
|
+
* import { adaptiveTrafficManagementClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
2519
|
+
*
|
|
2520
|
+
* const data =
|
|
2521
|
+
* await adaptiveTrafficManagementClient.getRootSpansPerMinute();
|
|
2522
|
+
*
|
|
2523
|
+
* @throws {ErrorEnvelopeError} Client side error. | Server side error.
|
|
2524
|
+
* @throws {InvalidResponseError}
|
|
2525
|
+
* @throws {ApiClientError}
|
|
2526
|
+
* @throws {ClientRequestError}
|
|
2527
|
+
*/
|
|
2528
|
+
getRootSpansPerMinute(config?: {
|
|
2529
|
+
abortSignal?: AbortSignal_2;
|
|
2530
|
+
} | AbortSignal_2): Promise<AdaptiveTrafficManagementDto>;
|
|
2531
|
+
}
|
|
2532
|
+
|
|
2533
|
+
export declare const adaptiveTrafficManagementClient: AdaptiveTrafficManagementClient;
|
|
2534
|
+
|
|
2535
|
+
export declare interface AdaptiveTrafficManagementDto {
|
|
2536
|
+
rootSpansPerMinute?: number;
|
|
2537
|
+
}
|
|
2538
|
+
|
|
2304
2539
|
/**
|
|
2305
2540
|
* A list of custom tags added to monitored entities.
|
|
2306
2541
|
*/
|
|
@@ -2373,6 +2608,8 @@ export declare interface AffectedEntity {
|
|
|
2373
2608
|
export declare interface AgentConnectionToken {
|
|
2374
2609
|
/**
|
|
2375
2610
|
* The agent connection token
|
|
2611
|
+
*
|
|
2612
|
+
* @exampleValue dt0a01.1.40f...bd9
|
|
2376
2613
|
*/
|
|
2377
2614
|
token?: string;
|
|
2378
2615
|
}
|
|
@@ -2443,54 +2680,76 @@ export declare interface ApiToken {
|
|
|
2443
2680
|
*
|
|
2444
2681
|
* * A `dashboardId` property for dashboard sharing tokens.
|
|
2445
2682
|
* * A `reportId` property for report sharing tokens
|
|
2683
|
+
*
|
|
2684
|
+
* @exampleValue {"dashboardId":"82402bab-7370-4359-924d-88ed13c8919a"}
|
|
2446
2685
|
*/
|
|
2447
2686
|
additionalMetadata?: ApiTokenAdditionalMetadata;
|
|
2448
2687
|
/**
|
|
2449
2688
|
* Token creation date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`)
|
|
2689
|
+
*
|
|
2690
|
+
* @exampleValue 2020-11-05T08:15:30.144Z
|
|
2450
2691
|
*/
|
|
2451
2692
|
creationDate?: string;
|
|
2452
2693
|
/**
|
|
2453
2694
|
* The token is enabled (`true`) or disabled (`false`).
|
|
2695
|
+
*
|
|
2696
|
+
* @exampleValue true
|
|
2454
2697
|
*/
|
|
2455
2698
|
enabled?: boolean;
|
|
2456
2699
|
/**
|
|
2457
2700
|
* Token expiration date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
|
|
2458
2701
|
*
|
|
2459
2702
|
* If not set, the token never expires.
|
|
2703
|
+
*
|
|
2704
|
+
* @exampleValue 2020-11-12T08:15:30.144Z
|
|
2460
2705
|
*/
|
|
2461
2706
|
expirationDate?: string;
|
|
2462
2707
|
/**
|
|
2463
2708
|
* The ID of the token, consisting of prefix and public part of the token.
|
|
2709
|
+
*
|
|
2710
|
+
* @exampleValue dt0c01.ST2EY72KQINMH574WMNVI7YN
|
|
2464
2711
|
*/
|
|
2465
2712
|
id?: string;
|
|
2466
2713
|
/**
|
|
2467
2714
|
* Token last used date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`)
|
|
2715
|
+
*
|
|
2716
|
+
* @exampleValue 2020-11-12T08:15:30.144Z
|
|
2468
2717
|
*/
|
|
2469
2718
|
lastUsedDate?: string;
|
|
2470
2719
|
/**
|
|
2471
2720
|
* Token last used IP address.
|
|
2721
|
+
*
|
|
2722
|
+
* @exampleValue 34.197.2.44
|
|
2472
2723
|
*/
|
|
2473
2724
|
lastUsedIpAddress?: string;
|
|
2474
2725
|
/**
|
|
2475
2726
|
* 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.
|
|
2727
|
+
*
|
|
2728
|
+
* @exampleValue 2020-11-12T08:15:30.144Z
|
|
2476
2729
|
*/
|
|
2477
2730
|
modifiedDate?: string;
|
|
2478
2731
|
/**
|
|
2479
2732
|
* The name of the token.
|
|
2733
|
+
*
|
|
2734
|
+
* @exampleValue myToken
|
|
2480
2735
|
*/
|
|
2481
2736
|
name?: string;
|
|
2482
2737
|
/**
|
|
2483
2738
|
* The owner of the token.
|
|
2739
|
+
*
|
|
2740
|
+
* @exampleValue john.smith
|
|
2484
2741
|
*/
|
|
2485
2742
|
owner?: string;
|
|
2486
2743
|
/**
|
|
2487
2744
|
* The token is a [personal access token](https://dt-url.net/wm03sop) (`true`) or an API token (`false`).
|
|
2745
|
+
*
|
|
2746
|
+
* @exampleValue true
|
|
2488
2747
|
*/
|
|
2489
2748
|
personalAccessToken?: boolean;
|
|
2490
2749
|
/**
|
|
2491
2750
|
* A list of scopes assigned to the token.
|
|
2492
2751
|
*/
|
|
2493
|
-
scopes?: Array<'ActiveGateCertManagement' | 'AdvancedSyntheticIntegration' | 'CaptureRequestData' | 'DTAQLAccess' | 'DataExport' | 'DataImport' | 'DataPrivacy' | 'Davis' | 'DiagnosticExport' | 'DssFileManagement' | 'ExternalSyntheticIntegration' | 'InstallerDownload' | 'LogExport' | 'MemoryDump' | 'Mobile' | 'PluginUpload' | 'ReadConfig' | 'ReadSyntheticData' | 'RestRequestForwarding' | 'RumBrowserExtension' | 'RumJavaScriptTagManagement' | 'SupportAlert' | 'TenantTokenManagement' | 'UserSessionAnonymization' | 'ViewDashboard' | 'ViewReport' | 'WriteConfig' | 'WriteSyntheticData' | 'activeGateTokenManagement.create' | 'activeGateTokenManagement.read' | 'activeGateTokenManagement.write' | 'activeGates.read' | 'activeGates.write' | 'adaptiveTrafficManagement.read' | 'agentTokenManagement.read' | 'apiTokens.read' | 'apiTokens.write' | 'attacks.read' | 'attacks.write' | 'auditLogs.read' | 'bizevents.ingest' | 'credentialVault.read' | 'credentialVault.write' | 'entities.read' | 'entities.write' | 'events.ingest' | 'events.read' | 'extensionConfigurationActions.write' | 'extensionConfigurations.read' | 'extensionConfigurations.write' | 'extensionDiscoveryJmx.read' | 'extensionDiscoveryPmi.read' | 'extensionEnvironment.read' | 'extensionEnvironment.write' | 'extensions.read' | 'extensions.write' | 'geographicRegions.read' | 'hub.install' | 'hub.read' | 'hub.write' | 'javaScriptMappingFiles.read' | 'javaScriptMappingFiles.write' | 'logs.ingest' | 'logs.read' | 'metrics.ingest' | 'metrics.read' | 'metrics.write' | 'networkZones.read' | 'networkZones.write' | 'oneAgents.read' | 'oneAgents.write' | 'openTelemetryTrace.ingest' | 'openpipeline.events' | 'openpipeline.events.custom' | 'openpipeline.events_sdlc' | 'openpipeline.events_sdlc.custom' | 'openpipeline.events_security' | 'openpipeline.events_security.custom' | 'problems.read' | 'problems.write' | 'releases.read' | 'rumCookieNames.read' | 'rumManualInsertionTags.read' | 'securityProblems.read' | 'securityProblems.write' | 'settings.read' | 'settings.write' | 'slo.read' | 'slo.write' | 'syntheticExecutions.read' | 'syntheticExecutions.write' | 'syntheticLocations.read' | 'syntheticLocations.write' | 'tenantTokenRotation.write' | 'traces.lookup' | 'unifiedAnalysis.read'>;
|
|
2752
|
+
scopes?: Array<'ActiveGateCertManagement' | 'AdvancedSyntheticIntegration' | 'CaptureRequestData' | 'DTAQLAccess' | 'DataExport' | 'DataImport' | 'DataPrivacy' | 'Davis' | 'DiagnosticExport' | 'DssFileManagement' | 'ExternalSyntheticIntegration' | 'InstallerDownload' | 'LogExport' | 'MemoryDump' | 'Mobile' | 'PluginUpload' | 'ReadConfig' | 'ReadSyntheticData' | 'RestRequestForwarding' | 'RumBrowserExtension' | 'RumJavaScriptTagManagement' | 'SupportAlert' | 'TenantTokenManagement' | 'UserSessionAnonymization' | 'ViewDashboard' | 'ViewReport' | 'WriteConfig' | 'WriteSyntheticData' | 'activeGateTokenManagement.create' | 'activeGateTokenManagement.read' | 'activeGateTokenManagement.write' | 'activeGates.read' | 'activeGates.write' | 'adaptiveTrafficManagement.read' | 'agentTokenManagement.read' | 'apiTokens.read' | 'apiTokens.write' | 'attacks.read' | 'attacks.write' | 'auditLogs.read' | 'bizevents.ingest' | 'credentialVault.read' | 'credentialVault.write' | 'entities.read' | 'entities.write' | 'events.ingest' | 'events.read' | 'extensionConfigurationActions.write' | 'extensionConfigurations.read' | 'extensionConfigurations.write' | 'extensionDiscoveryJmx.read' | 'extensionDiscoveryPmi.read' | 'extensionEnvironment.read' | 'extensionEnvironment.write' | 'extensions.read' | 'extensions.write' | 'geographicRegions.read' | 'hub.install' | 'hub.read' | 'hub.write' | 'javaScriptMappingFiles.read' | 'javaScriptMappingFiles.write' | 'logs.ingest' | 'logs.read' | 'metrics.ingest' | 'metrics.read' | 'metrics.write' | 'networkZones.read' | 'networkZones.write' | 'oneAgents.read' | 'oneAgents.write' | 'openTelemetryTrace.ingest' | 'openpipeline.events' | 'openpipeline.events.custom' | 'openpipeline.events_sdlc' | 'openpipeline.events_sdlc.custom' | 'openpipeline.events_security' | 'openpipeline.events_security.custom' | 'openpipeline.events_smartscape' | 'problems.read' | 'problems.write' | 'releases.read' | 'rumCookieNames.read' | 'rumManualInsertionTags.read' | 'securityProblems.read' | 'securityProblems.write' | 'settings.read' | 'settings.write' | 'slo.read' | 'slo.write' | 'syntheticExecutions.read' | 'syntheticExecutions.write' | 'syntheticLocations.read' | 'syntheticLocations.write' | 'tenantTokenRotation.write' | 'traces.lookup' | 'unifiedAnalysis.read'>;
|
|
2494
2753
|
}
|
|
2495
2754
|
|
|
2496
2755
|
/**
|
|
@@ -2524,16 +2783,22 @@ export declare interface ApiTokenCreate {
|
|
|
2524
2783
|
* * `y`: years
|
|
2525
2784
|
*
|
|
2526
2785
|
* If not set, the token never expires. Ensure that the expiration date is not set in the past.
|
|
2786
|
+
*
|
|
2787
|
+
* @exampleValue now+14d
|
|
2527
2788
|
*/
|
|
2528
2789
|
expirationDate?: string;
|
|
2529
2790
|
/**
|
|
2530
2791
|
* The name of the token.
|
|
2792
|
+
*
|
|
2793
|
+
* @exampleValue tokenName
|
|
2531
2794
|
*/
|
|
2532
2795
|
name: string;
|
|
2533
2796
|
/**
|
|
2534
2797
|
* The token is a personal access token (`true`) or an API token (`false`).
|
|
2535
2798
|
*
|
|
2536
2799
|
* Personal access tokens are tied to the permissions of their owner.
|
|
2800
|
+
*
|
|
2801
|
+
* @exampleValue false
|
|
2537
2802
|
*/
|
|
2538
2803
|
personalAccessToken?: boolean;
|
|
2539
2804
|
/**
|
|
@@ -2578,6 +2843,7 @@ export declare interface ApiTokenCreate {
|
|
|
2578
2843
|
* * `openpipeline.events_security.custom`: OpenPipeline - Ingest Security Events (Custom).
|
|
2579
2844
|
* * `openpipeline.events_sdlc`: OpenPipeline - Ingest Software Development Lifecycle Events (Built-in).
|
|
2580
2845
|
* * `openpipeline.events_sdlc.custom`: OpenPipeline - Ingest Software Development Lifecycle Events (Custom).
|
|
2846
|
+
* * `openpipeline.events_smartscape`: OpenPipeline - Ingest Smartscape Events (Built-in).
|
|
2581
2847
|
* * `bizevents.ingest`: Ingest bizevents.
|
|
2582
2848
|
* * `networkZones.read`: Read network zones.
|
|
2583
2849
|
* * `networkZones.write`: Write network zones.
|
|
@@ -2630,7 +2896,7 @@ export declare interface ApiTokenCreate {
|
|
|
2630
2896
|
* * `extensionDiscoveryJmx.read`: Read discovered JMX metrics via extensions.
|
|
2631
2897
|
* * `extensionDiscoveryPmi.read`: Read discovered PMI metrics via extensions.
|
|
2632
2898
|
*/
|
|
2633
|
-
scopes: Array<'InstallerDownload' | 'DataExport' | 'PluginUpload' | 'SupportAlert' | 'AdvancedSyntheticIntegration' | 'ExternalSyntheticIntegration' | 'RumBrowserExtension' | 'LogExport' | 'ReadConfig' | 'WriteConfig' | 'DTAQLAccess' | 'UserSessionAnonymization' | 'DataPrivacy' | 'CaptureRequestData' | 'Davis' | 'DssFileManagement' | 'RumJavaScriptTagManagement' | 'TenantTokenManagement' | 'ActiveGateCertManagement' | 'RestRequestForwarding' | 'ReadSyntheticData' | 'DataImport' | 'syntheticExecutions.write' | 'syntheticExecutions.read' | 'auditLogs.read' | 'metrics.read' | 'metrics.write' | 'entities.read' | 'entities.write' | 'problems.read' | 'problems.write' | 'events.read' | 'events.ingest' | 'openpipeline.events' | 'openpipeline.events.custom' | 'openpipeline.events_security' | 'openpipeline.events_security.custom' | 'openpipeline.events_sdlc' | 'openpipeline.events_sdlc.custom' | 'bizevents.ingest' | 'networkZones.read' | 'networkZones.write' | 'activeGates.read' | 'activeGates.write' | 'activeGateTokenManagement.read' | 'activeGateTokenManagement.create' | 'activeGateTokenManagement.write' | 'agentTokenManagement.read' | 'credentialVault.read' | 'credentialVault.write' | 'extensions.read' | 'extensions.write' | 'extensionConfigurations.read' | 'extensionConfigurations.write' | 'extensionEnvironment.read' | 'extensionEnvironment.write' | 'metrics.ingest' | 'attacks.read' | 'attacks.write' | 'securityProblems.read' | 'securityProblems.write' | 'syntheticLocations.read' | 'syntheticLocations.write' | 'settings.read' | 'settings.write' | 'tenantTokenRotation.write' | 'slo.read' | 'slo.write' | 'releases.read' | 'apiTokens.read' | 'apiTokens.write' | 'openTelemetryTrace.ingest' | 'logs.read' | 'logs.ingest' | 'geographicRegions.read' | 'oneAgents.read' | 'oneAgents.write' | 'traces.lookup' | 'unifiedAnalysis.read' | 'hub.read' | 'hub.write' | 'hub.install' | 'javaScriptMappingFiles.read' | 'javaScriptMappingFiles.write' | 'extensionConfigurationActions.write' | 'rumCookieNames.read' | 'adaptiveTrafficManagement.read' | 'rumManualInsertionTags.read' | 'extensionDiscoveryJmx.read' | 'extensionDiscoveryPmi.read'>;
|
|
2899
|
+
scopes: Array<'InstallerDownload' | 'DataExport' | 'PluginUpload' | 'SupportAlert' | 'AdvancedSyntheticIntegration' | 'ExternalSyntheticIntegration' | 'RumBrowserExtension' | 'LogExport' | 'ReadConfig' | 'WriteConfig' | 'DTAQLAccess' | 'UserSessionAnonymization' | 'DataPrivacy' | 'CaptureRequestData' | 'Davis' | 'DssFileManagement' | 'RumJavaScriptTagManagement' | 'TenantTokenManagement' | 'ActiveGateCertManagement' | 'RestRequestForwarding' | 'ReadSyntheticData' | 'DataImport' | 'syntheticExecutions.write' | 'syntheticExecutions.read' | 'auditLogs.read' | 'metrics.read' | 'metrics.write' | 'entities.read' | 'entities.write' | 'problems.read' | 'problems.write' | 'events.read' | 'events.ingest' | 'openpipeline.events' | 'openpipeline.events.custom' | 'openpipeline.events_security' | 'openpipeline.events_security.custom' | 'openpipeline.events_sdlc' | 'openpipeline.events_sdlc.custom' | 'openpipeline.events_smartscape' | 'bizevents.ingest' | 'networkZones.read' | 'networkZones.write' | 'activeGates.read' | 'activeGates.write' | 'activeGateTokenManagement.read' | 'activeGateTokenManagement.create' | 'activeGateTokenManagement.write' | 'agentTokenManagement.read' | 'credentialVault.read' | 'credentialVault.write' | 'extensions.read' | 'extensions.write' | 'extensionConfigurations.read' | 'extensionConfigurations.write' | 'extensionEnvironment.read' | 'extensionEnvironment.write' | 'metrics.ingest' | 'attacks.read' | 'attacks.write' | 'securityProblems.read' | 'securityProblems.write' | 'syntheticLocations.read' | 'syntheticLocations.write' | 'settings.read' | 'settings.write' | 'tenantTokenRotation.write' | 'slo.read' | 'slo.write' | 'releases.read' | 'apiTokens.read' | 'apiTokens.write' | 'openTelemetryTrace.ingest' | 'logs.read' | 'logs.ingest' | 'geographicRegions.read' | 'oneAgents.read' | 'oneAgents.write' | 'traces.lookup' | 'unifiedAnalysis.read' | 'hub.read' | 'hub.write' | 'hub.install' | 'javaScriptMappingFiles.read' | 'javaScriptMappingFiles.write' | 'extensionConfigurationActions.write' | 'rumCookieNames.read' | 'adaptiveTrafficManagement.read' | 'rumManualInsertionTags.read' | 'extensionDiscoveryJmx.read' | 'extensionDiscoveryPmi.read'>;
|
|
2634
2900
|
}
|
|
2635
2901
|
|
|
2636
2902
|
/**
|
|
@@ -2639,14 +2905,20 @@ export declare interface ApiTokenCreate {
|
|
|
2639
2905
|
export declare interface ApiTokenCreated {
|
|
2640
2906
|
/**
|
|
2641
2907
|
* The token expiration date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
|
|
2908
|
+
*
|
|
2909
|
+
* @exampleValue 2020-11-12T08:15:30.144Z
|
|
2642
2910
|
*/
|
|
2643
2911
|
expirationDate?: string;
|
|
2644
2912
|
/**
|
|
2645
2913
|
* The ID of the token, consisting of prefix and public part of the token.
|
|
2914
|
+
*
|
|
2915
|
+
* @exampleValue dt0c01.ST2EY72KQINMH574WMNVI7YN
|
|
2646
2916
|
*/
|
|
2647
2917
|
id?: string;
|
|
2648
2918
|
/**
|
|
2649
2919
|
* The secret of the token.
|
|
2920
|
+
*
|
|
2921
|
+
* @exampleValue dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM
|
|
2650
2922
|
*/
|
|
2651
2923
|
token?: string;
|
|
2652
2924
|
}
|
|
@@ -2694,6 +2966,7 @@ export declare enum ApiTokenCreateScopesItem {
|
|
|
2694
2966
|
OpenpipelineEventsSecurityCustom = "openpipeline.events_security.custom",
|
|
2695
2967
|
OpenpipelineEventsSdlc = "openpipeline.events_sdlc",
|
|
2696
2968
|
OpenpipelineEventsSdlcCustom = "openpipeline.events_sdlc.custom",
|
|
2969
|
+
OpenpipelineEventsSmartscape = "openpipeline.events_smartscape",
|
|
2697
2970
|
BizeventsIngest = "bizevents.ingest",
|
|
2698
2971
|
NetworkZonesRead = "networkZones.read",
|
|
2699
2972
|
NetworkZonesWrite = "networkZones.write",
|
|
@@ -2759,6 +3032,8 @@ export declare interface ApiTokenList {
|
|
|
2759
3032
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
2760
3033
|
*
|
|
2761
3034
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
3035
|
+
*
|
|
3036
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
2762
3037
|
*/
|
|
2763
3038
|
nextPageKey?: string;
|
|
2764
3039
|
/**
|
|
@@ -2853,6 +3128,7 @@ export declare enum ApiTokenScopesItem {
|
|
|
2853
3128
|
OpenpipelineEventsSdlcCustom = "openpipeline.events_sdlc.custom",
|
|
2854
3129
|
OpenpipelineEventsSecurity = "openpipeline.events_security",
|
|
2855
3130
|
OpenpipelineEventsSecurityCustom = "openpipeline.events_security.custom",
|
|
3131
|
+
OpenpipelineEventsSmartscape = "openpipeline.events_smartscape",
|
|
2856
3132
|
ProblemsRead = "problems.read",
|
|
2857
3133
|
ProblemsWrite = "problems.write",
|
|
2858
3134
|
ReleasesRead = "releases.read",
|
|
@@ -2876,6 +3152,8 @@ export declare enum ApiTokenScopesItem {
|
|
|
2876
3152
|
export declare interface ApiTokenSecret {
|
|
2877
3153
|
/**
|
|
2878
3154
|
* The API token.
|
|
3155
|
+
*
|
|
3156
|
+
* @exampleValue dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM
|
|
2879
3157
|
*/
|
|
2880
3158
|
token: string;
|
|
2881
3159
|
}
|
|
@@ -2886,10 +3164,14 @@ export declare interface ApiTokenSecret {
|
|
|
2886
3164
|
export declare interface ApiTokenUpdate {
|
|
2887
3165
|
/**
|
|
2888
3166
|
* The token is enabled (`true`) or disabled (`false`)
|
|
3167
|
+
*
|
|
3168
|
+
* @exampleValue true
|
|
2889
3169
|
*/
|
|
2890
3170
|
enabled?: boolean;
|
|
2891
3171
|
/**
|
|
2892
3172
|
* The name of the token.
|
|
3173
|
+
*
|
|
3174
|
+
* @exampleValue myToken
|
|
2893
3175
|
*/
|
|
2894
3176
|
name?: string;
|
|
2895
3177
|
/**
|
|
@@ -2936,6 +3218,7 @@ export declare interface ApiTokenUpdate {
|
|
|
2936
3218
|
* * `openpipeline.events_security.custom`: OpenPipeline - Ingest Security Events (Custom).
|
|
2937
3219
|
* * `openpipeline.events_sdlc`: OpenPipeline - Ingest Software Development Lifecycle Events (Built-in).
|
|
2938
3220
|
* * `openpipeline.events_sdlc.custom`: OpenPipeline - Ingest Software Development Lifecycle Events (Custom).
|
|
3221
|
+
* * `openpipeline.events_smartscape`: OpenPipeline - Ingest Smartscape Events (Built-in).
|
|
2939
3222
|
* * `bizevents.ingest`: Ingest bizevents.
|
|
2940
3223
|
* * `networkZones.read`: Read network zones.
|
|
2941
3224
|
* * `networkZones.write`: Write network zones.
|
|
@@ -2988,7 +3271,7 @@ export declare interface ApiTokenUpdate {
|
|
|
2988
3271
|
* * `extensionDiscoveryJmx.read`: Read discovered JMX metrics via extensions.
|
|
2989
3272
|
* * `extensionDiscoveryPmi.read`: Read discovered PMI metrics via extensions.
|
|
2990
3273
|
*/
|
|
2991
|
-
scopes?: Array<'InstallerDownload' | 'DataExport' | 'PluginUpload' | 'SupportAlert' | 'AdvancedSyntheticIntegration' | 'ExternalSyntheticIntegration' | 'RumBrowserExtension' | 'LogExport' | 'ReadConfig' | 'WriteConfig' | 'DTAQLAccess' | 'UserSessionAnonymization' | 'DataPrivacy' | 'CaptureRequestData' | 'Davis' | 'DssFileManagement' | 'RumJavaScriptTagManagement' | 'TenantTokenManagement' | 'ActiveGateCertManagement' | 'RestRequestForwarding' | 'ReadSyntheticData' | 'DataImport' | 'syntheticExecutions.write' | 'syntheticExecutions.read' | 'auditLogs.read' | 'metrics.read' | 'metrics.write' | 'entities.read' | 'entities.write' | 'problems.read' | 'problems.write' | 'events.read' | 'events.ingest' | 'openpipeline.events' | 'openpipeline.events.custom' | 'openpipeline.events_security' | 'openpipeline.events_security.custom' | 'openpipeline.events_sdlc' | 'openpipeline.events_sdlc.custom' | 'bizevents.ingest' | 'networkZones.read' | 'networkZones.write' | 'activeGates.read' | 'activeGates.write' | 'activeGateTokenManagement.read' | 'activeGateTokenManagement.create' | 'activeGateTokenManagement.write' | 'agentTokenManagement.read' | 'credentialVault.read' | 'credentialVault.write' | 'extensions.read' | 'extensions.write' | 'extensionConfigurations.read' | 'extensionConfigurations.write' | 'extensionEnvironment.read' | 'extensionEnvironment.write' | 'metrics.ingest' | 'attacks.read' | 'attacks.write' | 'securityProblems.read' | 'securityProblems.write' | 'syntheticLocations.read' | 'syntheticLocations.write' | 'settings.read' | 'settings.write' | 'tenantTokenRotation.write' | 'slo.read' | 'slo.write' | 'releases.read' | 'apiTokens.read' | 'apiTokens.write' | 'openTelemetryTrace.ingest' | 'logs.read' | 'logs.ingest' | 'geographicRegions.read' | 'oneAgents.read' | 'oneAgents.write' | 'traces.lookup' | 'unifiedAnalysis.read' | 'hub.read' | 'hub.write' | 'hub.install' | 'javaScriptMappingFiles.read' | 'javaScriptMappingFiles.write' | 'extensionConfigurationActions.write' | 'rumCookieNames.read' | 'adaptiveTrafficManagement.read' | 'rumManualInsertionTags.read' | 'extensionDiscoveryJmx.read' | 'extensionDiscoveryPmi.read'>;
|
|
3274
|
+
scopes?: Array<'InstallerDownload' | 'DataExport' | 'PluginUpload' | 'SupportAlert' | 'AdvancedSyntheticIntegration' | 'ExternalSyntheticIntegration' | 'RumBrowserExtension' | 'LogExport' | 'ReadConfig' | 'WriteConfig' | 'DTAQLAccess' | 'UserSessionAnonymization' | 'DataPrivacy' | 'CaptureRequestData' | 'Davis' | 'DssFileManagement' | 'RumJavaScriptTagManagement' | 'TenantTokenManagement' | 'ActiveGateCertManagement' | 'RestRequestForwarding' | 'ReadSyntheticData' | 'DataImport' | 'syntheticExecutions.write' | 'syntheticExecutions.read' | 'auditLogs.read' | 'metrics.read' | 'metrics.write' | 'entities.read' | 'entities.write' | 'problems.read' | 'problems.write' | 'events.read' | 'events.ingest' | 'openpipeline.events' | 'openpipeline.events.custom' | 'openpipeline.events_security' | 'openpipeline.events_security.custom' | 'openpipeline.events_sdlc' | 'openpipeline.events_sdlc.custom' | 'openpipeline.events_smartscape' | 'bizevents.ingest' | 'networkZones.read' | 'networkZones.write' | 'activeGates.read' | 'activeGates.write' | 'activeGateTokenManagement.read' | 'activeGateTokenManagement.create' | 'activeGateTokenManagement.write' | 'agentTokenManagement.read' | 'credentialVault.read' | 'credentialVault.write' | 'extensions.read' | 'extensions.write' | 'extensionConfigurations.read' | 'extensionConfigurations.write' | 'extensionEnvironment.read' | 'extensionEnvironment.write' | 'metrics.ingest' | 'attacks.read' | 'attacks.write' | 'securityProblems.read' | 'securityProblems.write' | 'syntheticLocations.read' | 'syntheticLocations.write' | 'settings.read' | 'settings.write' | 'tenantTokenRotation.write' | 'slo.read' | 'slo.write' | 'releases.read' | 'apiTokens.read' | 'apiTokens.write' | 'openTelemetryTrace.ingest' | 'logs.read' | 'logs.ingest' | 'geographicRegions.read' | 'oneAgents.read' | 'oneAgents.write' | 'traces.lookup' | 'unifiedAnalysis.read' | 'hub.read' | 'hub.write' | 'hub.install' | 'javaScriptMappingFiles.read' | 'javaScriptMappingFiles.write' | 'extensionConfigurationActions.write' | 'rumCookieNames.read' | 'adaptiveTrafficManagement.read' | 'rumManualInsertionTags.read' | 'extensionDiscoveryJmx.read' | 'extensionDiscoveryPmi.read'>;
|
|
2992
3275
|
}
|
|
2993
3276
|
|
|
2994
3277
|
/**
|
|
@@ -3034,6 +3317,7 @@ export declare enum ApiTokenUpdateScopesItem {
|
|
|
3034
3317
|
OpenpipelineEventsSecurityCustom = "openpipeline.events_security.custom",
|
|
3035
3318
|
OpenpipelineEventsSdlc = "openpipeline.events_sdlc",
|
|
3036
3319
|
OpenpipelineEventsSdlcCustom = "openpipeline.events_sdlc.custom",
|
|
3320
|
+
OpenpipelineEventsSmartscape = "openpipeline.events_smartscape",
|
|
3037
3321
|
BizeventsIngest = "bizevents.ingest",
|
|
3038
3322
|
NetworkZonesRead = "networkZones.read",
|
|
3039
3323
|
NetworkZonesWrite = "networkZones.write",
|
|
@@ -3116,7 +3400,7 @@ export declare interface AssessmentAccuracyDetails {
|
|
|
3116
3400
|
/**
|
|
3117
3401
|
* The reasons for a reduced assessment accuracy.
|
|
3118
3402
|
*/
|
|
3119
|
-
reducedReasons?: Array<'LIMITED_AGENT_SUPPORT' | 'LIMITED_BY_CONFIGURATION'>;
|
|
3403
|
+
reducedReasons?: Array<'LIMITED_AGENT_SUPPORT' | 'LIMITED_BY_CONFIGURATION' | 'LIMITED_BY_SERVICE_DETECTION_V2'>;
|
|
3120
3404
|
}
|
|
3121
3405
|
|
|
3122
3406
|
/**
|
|
@@ -3126,7 +3410,8 @@ export declare interface AssessmentAccuracyDetails {
|
|
|
3126
3410
|
*/
|
|
3127
3411
|
export declare enum AssessmentAccuracyDetailsReducedReasonsItem {
|
|
3128
3412
|
LimitedAgentSupport = "LIMITED_AGENT_SUPPORT",
|
|
3129
|
-
LimitedByConfiguration = "LIMITED_BY_CONFIGURATION"
|
|
3413
|
+
LimitedByConfiguration = "LIMITED_BY_CONFIGURATION",
|
|
3414
|
+
LimitedByServiceDetectionV2 = "LIMITED_BY_SERVICE_DETECTION_V2"
|
|
3130
3415
|
}
|
|
3131
3416
|
|
|
3132
3417
|
/**
|
|
@@ -3156,7 +3441,7 @@ export declare interface AssetInfoDto {
|
|
|
3156
3441
|
/**
|
|
3157
3442
|
* The type of the asset.
|
|
3158
3443
|
*/
|
|
3159
|
-
type?: 'ALERT' | 'ALERT_TEMPLATE' | 'AWS_SERVICE' | 'CUSTOM_CARDS' | 'DASHBOARD' | 'DECLARATIVE_PROCESSES' | 'DOCUMENT_DASHBOARD' | 'DQL_LOG_METRIC' | 'DQL_LOG_PROCESSING_RULE' | 'GENERIC_RELATIONSHIP' | 'GENERIC_TYPE' | 'LIST_SCREEN_FILTERS' | 'LIST_SCREEN_INJECTIONS' | 'LIST_SCREEN_LAYOUT' | 'LOG_EVENT' | 'LOG_METRIC' | 'LOG_PROCESSING_RULE' | 'LQL_LOG_METRIC' | 'LQL_LOG_PROCESSING_RULE' | 'METRIC_METADATA' | 'METRIC_QUERY' | 'OPEN_PIPELINE' | 'PROCESS_GROUPING_RULES' | 'SCREEN_ACTIONS' | 'SCREEN_CHART_GROUPS' | 'SCREEN_DQL_TABLE' | 'SCREEN_ENTITIES_LISTS' | 'SCREEN_EVENTS_CARDS' | 'SCREEN_FILTERS' | 'SCREEN_HEALTH_CARDS' | 'SCREEN_INJECTIONS' | 'SCREEN_LAYOUT' | 'SCREEN_LOGS_CARDS' | 'SCREEN_MESSAGE_CARDS' | 'SCREEN_METRIC_TABLES' | 'SCREEN_PROBLEMS' | 'SCREEN_PROPERTIES';
|
|
3444
|
+
type?: 'ALERT' | 'ALERT_TEMPLATE' | 'AWS_SERVICE' | 'CUSTOM_CARDS' | 'DASHBOARD' | 'DECLARATIVE_PROCESSES' | 'DOCUMENT_DASHBOARD' | 'DOCUMENT_SCREEN' | 'DQL_LOG_METRIC' | 'DQL_LOG_PROCESSING_RULE' | 'GENERIC_RELATIONSHIP' | 'GENERIC_TYPE' | 'LIST_SCREEN_FILTERS' | 'LIST_SCREEN_INJECTIONS' | 'LIST_SCREEN_LAYOUT' | 'LOG_EVENT' | 'LOG_METRIC' | 'LOG_PROCESSING_RULE' | 'LQL_LOG_METRIC' | 'LQL_LOG_PROCESSING_RULE' | 'METRIC_METADATA' | 'METRIC_QUERY' | 'OPEN_PIPELINE' | 'PROCESS_GROUPING_RULES' | 'SCREEN_ACTIONS' | 'SCREEN_CHART_GROUPS' | 'SCREEN_DQL_TABLE' | 'SCREEN_ENTITIES_LISTS' | 'SCREEN_EVENTS_CARDS' | 'SCREEN_FILTERS' | 'SCREEN_HEALTH_CARDS' | 'SCREEN_INJECTIONS' | 'SCREEN_LAYOUT' | 'SCREEN_LOGS_CARDS' | 'SCREEN_MESSAGE_CARDS' | 'SCREEN_METRIC_TABLES' | 'SCREEN_PROBLEMS' | 'SCREEN_PROPERTIES';
|
|
3160
3445
|
}
|
|
3161
3446
|
|
|
3162
3447
|
/**
|
|
@@ -3172,6 +3457,7 @@ export declare enum AssetInfoDtoType {
|
|
|
3172
3457
|
Dashboard = "DASHBOARD",
|
|
3173
3458
|
DeclarativeProcesses = "DECLARATIVE_PROCESSES",
|
|
3174
3459
|
DocumentDashboard = "DOCUMENT_DASHBOARD",
|
|
3460
|
+
DocumentScreen = "DOCUMENT_SCREEN",
|
|
3175
3461
|
DqlLogMetric = "DQL_LOG_METRIC",
|
|
3176
3462
|
DqlLogProcessingRule = "DQL_LOG_PROCESSING_RULE",
|
|
3177
3463
|
GenericRelationship = "GENERIC_RELATIONSHIP",
|
|
@@ -3376,6 +3662,8 @@ export declare interface AttackList {
|
|
|
3376
3662
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
3377
3663
|
*
|
|
3378
3664
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
3665
|
+
*
|
|
3666
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
3379
3667
|
*/
|
|
3380
3668
|
nextPageKey?: string;
|
|
3381
3669
|
/**
|
|
@@ -3682,6 +3970,8 @@ export declare interface AuditLog {
|
|
|
3682
3970
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
3683
3971
|
*
|
|
3684
3972
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
3973
|
+
*
|
|
3974
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
3685
3975
|
*/
|
|
3686
3976
|
nextPageKey?: string;
|
|
3687
3977
|
/**
|
|
@@ -3720,6 +4010,8 @@ export declare interface AuditLogEntry {
|
|
|
3720
4010
|
'dt.settings.schema_id'?: string;
|
|
3721
4011
|
/**
|
|
3722
4012
|
* The persistence scope for entries of category `CONFIG`, e.g. an ME identifier.
|
|
4013
|
+
*
|
|
4014
|
+
* @exampleValue environment
|
|
3723
4015
|
*/
|
|
3724
4016
|
'dt.settings.scope_id'?: string;
|
|
3725
4017
|
/**
|
|
@@ -3961,6 +4253,8 @@ export declare class AuditLogsClient {
|
|
|
3961
4253
|
* * `-timestamp`: Newest first.
|
|
3962
4254
|
*
|
|
3963
4255
|
* If not set, the newest first sorting is applied.
|
|
4256
|
+
*
|
|
4257
|
+
* @defaultValue -timestamp
|
|
3964
4258
|
*/ sort?: string;
|
|
3965
4259
|
abortSignal?: AbortSignal_2;
|
|
3966
4260
|
}): Promise<AuditLog>;
|
|
@@ -4377,7 +4671,11 @@ export declare class BusinessEventsClient {
|
|
|
4377
4671
|
/**
|
|
4378
4672
|
* Ingests a business event
|
|
4379
4673
|
*
|
|
4380
|
-
* **
|
|
4674
|
+
* **One of the following scopes is required:**
|
|
4675
|
+
* + storage:events:write
|
|
4676
|
+
* + openpipeline:bizevents:ingest
|
|
4677
|
+
*
|
|
4678
|
+
* <br/><br/>The maximum payload size of a single request is **5 MiB**. Requests with a greater payload are rejected, and the API returns a 413 response code.
|
|
4381
4679
|
*
|
|
4382
4680
|
* The ingestion of business events is subject to licensing (see [licensing documentation](https://www.dynatrace.com/support/help/shortlink/dps-events)).
|
|
4383
4681
|
*
|
|
@@ -4681,6 +4979,8 @@ export declare interface CommentsList {
|
|
|
4681
4979
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
4682
4980
|
*
|
|
4683
4981
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
4982
|
+
*
|
|
4983
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
4684
4984
|
*/
|
|
4685
4985
|
nextPageKey?: string;
|
|
4686
4986
|
/**
|
|
@@ -4699,6 +4999,8 @@ export declare interface CommentsList {
|
|
|
4699
4999
|
export declare interface ComplexConstraint {
|
|
4700
5000
|
/**
|
|
4701
5001
|
* Defines if modification of any property triggers secret resubmission check.
|
|
5002
|
+
*
|
|
5003
|
+
* @exampleValue false
|
|
4702
5004
|
*/
|
|
4703
5005
|
checkAllProperties?: boolean;
|
|
4704
5006
|
/**
|
|
@@ -4707,14 +5009,20 @@ export declare interface ComplexConstraint {
|
|
|
4707
5009
|
customMessage?: string;
|
|
4708
5010
|
/**
|
|
4709
5011
|
* The ID of a custom validator.
|
|
5012
|
+
*
|
|
5013
|
+
* @exampleValue my-min-max
|
|
4710
5014
|
*/
|
|
4711
5015
|
customValidatorId?: string;
|
|
4712
5016
|
/**
|
|
4713
5017
|
* The maximum number of properties that can be set.
|
|
5018
|
+
*
|
|
5019
|
+
* @exampleValue 2
|
|
4714
5020
|
*/
|
|
4715
5021
|
maximumPropertyCount?: number;
|
|
4716
5022
|
/**
|
|
4717
5023
|
* The minimum number of properties that must be set.
|
|
5024
|
+
*
|
|
5025
|
+
* @exampleValue 1
|
|
4718
5026
|
*/
|
|
4719
5027
|
minimumPropertyCount?: number;
|
|
4720
5028
|
/**
|
|
@@ -4723,10 +5031,14 @@ export declare interface ComplexConstraint {
|
|
|
4723
5031
|
properties?: string[];
|
|
4724
5032
|
/**
|
|
4725
5033
|
* Whether to skip validation on a change made from the UI.
|
|
5034
|
+
*
|
|
5035
|
+
* @exampleValue false
|
|
4726
5036
|
*/
|
|
4727
5037
|
skipAsyncValidation?: boolean;
|
|
4728
5038
|
/**
|
|
4729
5039
|
* The maximum time in seconds the custom validator is allowed to run.
|
|
5040
|
+
*
|
|
5041
|
+
* @exampleValue 5
|
|
4730
5042
|
*/
|
|
4731
5043
|
timeout?: number;
|
|
4732
5044
|
/**
|
|
@@ -4757,14 +5069,20 @@ export declare enum ComplexConstraintType {
|
|
|
4757
5069
|
export declare interface ConfigurationMetadata {
|
|
4758
5070
|
/**
|
|
4759
5071
|
* Dynatrace version.
|
|
5072
|
+
*
|
|
5073
|
+
* @exampleValue 1.192.1
|
|
4760
5074
|
*/
|
|
4761
5075
|
clusterVersion?: string;
|
|
4762
5076
|
/**
|
|
4763
5077
|
* A sorted list of the version numbers of the configuration.
|
|
5078
|
+
*
|
|
5079
|
+
* @exampleValue [4,2]
|
|
4764
5080
|
*/
|
|
4765
5081
|
configurationVersions?: number[];
|
|
4766
5082
|
/**
|
|
4767
5083
|
* A sorted list of version numbers of the configuration.
|
|
5084
|
+
*
|
|
5085
|
+
* @exampleValue ["1.0.4","1.23"]
|
|
4768
5086
|
*/
|
|
4769
5087
|
currentConfigurationVersions?: string[];
|
|
4770
5088
|
}
|
|
@@ -4775,50 +5093,74 @@ export declare interface ConfigurationMetadata {
|
|
|
4775
5093
|
export declare interface Constraint {
|
|
4776
5094
|
/**
|
|
4777
5095
|
* A custom message for invalid values.
|
|
5096
|
+
*
|
|
5097
|
+
* @exampleValue customConstraintMessage
|
|
4778
5098
|
*/
|
|
4779
5099
|
customMessage?: string;
|
|
4780
5100
|
/**
|
|
4781
5101
|
* The ID of a custom validator.
|
|
5102
|
+
*
|
|
5103
|
+
* @exampleValue my-min-max
|
|
4782
5104
|
*/
|
|
4783
5105
|
customValidatorId?: string;
|
|
4784
5106
|
/**
|
|
4785
5107
|
* Whether to disallow usage of dangerous regexes
|
|
5108
|
+
*
|
|
5109
|
+
* @exampleValue true
|
|
4786
5110
|
*/
|
|
4787
5111
|
disallowDangerousRegex?: boolean;
|
|
4788
5112
|
/**
|
|
4789
5113
|
* The maximum allowed length of string values.
|
|
5114
|
+
*
|
|
5115
|
+
* @exampleValue 20
|
|
4790
5116
|
*/
|
|
4791
5117
|
maxLength?: number;
|
|
4792
5118
|
/**
|
|
4793
5119
|
* The maximum allowed value.
|
|
5120
|
+
*
|
|
5121
|
+
* @exampleValue 200
|
|
4794
5122
|
*/
|
|
4795
5123
|
maximum?: number;
|
|
4796
5124
|
/**
|
|
4797
5125
|
* The minimum required length of string values.
|
|
5126
|
+
*
|
|
5127
|
+
* @exampleValue 7
|
|
4798
5128
|
*/
|
|
4799
5129
|
minLength?: number;
|
|
4800
5130
|
/**
|
|
4801
5131
|
* The minimum allowed value.
|
|
5132
|
+
*
|
|
5133
|
+
* @exampleValue 3
|
|
4802
5134
|
*/
|
|
4803
5135
|
minimum?: number;
|
|
4804
5136
|
/**
|
|
4805
5137
|
* The regular expression pattern for valid string values.
|
|
5138
|
+
*
|
|
5139
|
+
* @exampleValue ^([a-z]|[0-9]|\-|\_|\+|\.)+\@([a-z]|[0-9]|-){2,}\.([a-z]|[0-9]|-){2,}(\.[a-z]{2,})?$
|
|
4806
5140
|
*/
|
|
4807
5141
|
pattern?: string;
|
|
4808
5142
|
/**
|
|
4809
5143
|
* Whether to skip validation on a change made from the UI.
|
|
5144
|
+
*
|
|
5145
|
+
* @exampleValue false
|
|
4810
5146
|
*/
|
|
4811
5147
|
skipAsyncValidation?: boolean;
|
|
4812
5148
|
/**
|
|
4813
5149
|
* The maximum time in seconds the custom validator is allowed to run.
|
|
5150
|
+
*
|
|
5151
|
+
* @exampleValue 5
|
|
4814
5152
|
*/
|
|
4815
5153
|
timeout?: number;
|
|
4816
5154
|
/**
|
|
4817
5155
|
* The type of the constraint.
|
|
5156
|
+
*
|
|
5157
|
+
* @exampleValue UNKNOWN
|
|
4818
5158
|
*/
|
|
4819
5159
|
type: 'CUSTOM_VALIDATOR_REF' | 'LENGTH' | 'NOT_BLANK' | 'NOT_EMPTY' | 'NO_WHITESPACE' | 'PATTERN' | 'RANGE' | 'REGEX' | 'TRIMMED' | 'UNIQUE' | 'UNKNOWN';
|
|
4820
5160
|
/**
|
|
4821
5161
|
* A list of properties for which the combination of values must be unique.
|
|
5162
|
+
*
|
|
5163
|
+
* @exampleValue ["my-prop-1","my-prop-2"]
|
|
4822
5164
|
*/
|
|
4823
5165
|
uniqueProperties?: string[];
|
|
4824
5166
|
}
|
|
@@ -4862,6 +5204,50 @@ export declare enum ConstraintViolationParameterLocation {
|
|
|
4862
5204
|
Query = "QUERY"
|
|
4863
5205
|
}
|
|
4864
5206
|
|
|
5207
|
+
/**
|
|
5208
|
+
* Information about component type and images registry URI.
|
|
5209
|
+
*/
|
|
5210
|
+
export declare interface ContainerImageComponent {
|
|
5211
|
+
/**
|
|
5212
|
+
* Registry URI of the container image component.
|
|
5213
|
+
*/
|
|
5214
|
+
imageUri?: string;
|
|
5215
|
+
/**
|
|
5216
|
+
* Container image component type.
|
|
5217
|
+
*/
|
|
5218
|
+
type?: 'activegate' | 'codemodules' | 'database-datasource-executor' | 'sql-extension-executor' | 'dynatrace-sql-extension-executor' | 'eec' | 'logmodule' | 'oneagent';
|
|
5219
|
+
}
|
|
5220
|
+
|
|
5221
|
+
/**
|
|
5222
|
+
* Container image component type.
|
|
5223
|
+
*
|
|
5224
|
+
* @deprecated Use literal values.
|
|
5225
|
+
*/
|
|
5226
|
+
export declare enum ContainerImageComponentType {
|
|
5227
|
+
Activegate = "activegate",
|
|
5228
|
+
Codemodules = "codemodules",
|
|
5229
|
+
DatabaseDatasourceExecutor = "database-datasource-executor",
|
|
5230
|
+
SqlExtensionExecutor = "sql-extension-executor",
|
|
5231
|
+
DynatraceSqlExtensionExecutor = "dynatrace-sql-extension-executor",
|
|
5232
|
+
Eec = "eec",
|
|
5233
|
+
Logmodule = "logmodule",
|
|
5234
|
+
Oneagent = "oneagent"
|
|
5235
|
+
}
|
|
5236
|
+
|
|
5237
|
+
/**
|
|
5238
|
+
* Information about images registry and components with URI.
|
|
5239
|
+
*/
|
|
5240
|
+
export declare interface ContainerImageData {
|
|
5241
|
+
/**
|
|
5242
|
+
* List of container image components.
|
|
5243
|
+
*/
|
|
5244
|
+
components?: ContainerImageComponent[];
|
|
5245
|
+
/**
|
|
5246
|
+
* Registry name containing container images.
|
|
5247
|
+
*/
|
|
5248
|
+
registry?: string;
|
|
5249
|
+
}
|
|
5250
|
+
|
|
4865
5251
|
/**
|
|
4866
5252
|
* Cookie step of Browser Monitor.
|
|
4867
5253
|
*/
|
|
@@ -5704,6 +6090,8 @@ export declare interface DavisSecurityAdviceList {
|
|
|
5704
6090
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
5705
6091
|
*
|
|
5706
6092
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
6093
|
+
*
|
|
6094
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
5707
6095
|
*/
|
|
5708
6096
|
nextPageKey?: string;
|
|
5709
6097
|
/**
|
|
@@ -5841,11 +6229,15 @@ export declare interface DeletionConstraint {
|
|
|
5841
6229
|
customMessage?: string;
|
|
5842
6230
|
/**
|
|
5843
6231
|
* The ID of a custom validator.
|
|
6232
|
+
*
|
|
6233
|
+
* @exampleValue my-min-max
|
|
5844
6234
|
*/
|
|
5845
6235
|
customValidatorId?: string;
|
|
5846
6236
|
schemaIds?: string[];
|
|
5847
6237
|
/**
|
|
5848
6238
|
* The maximum time in seconds the custom validator is allowed to run.
|
|
6239
|
+
*
|
|
6240
|
+
* @exampleValue 5
|
|
5849
6241
|
*/
|
|
5850
6242
|
timeout?: number;
|
|
5851
6243
|
/**
|
|
@@ -5902,6 +6294,9 @@ export declare interface EffectivePermission {
|
|
|
5902
6294
|
*/
|
|
5903
6295
|
context?: PermissionContext;
|
|
5904
6296
|
granted: 'condition' | 'false' | 'true';
|
|
6297
|
+
/**
|
|
6298
|
+
* @exampleValue settings:objects:write
|
|
6299
|
+
*/
|
|
5905
6300
|
permission: string;
|
|
5906
6301
|
}
|
|
5907
6302
|
|
|
@@ -5920,6 +6315,8 @@ export declare enum EffectivePermissionGranted {
|
|
|
5920
6315
|
export declare interface EffectiveSettingsValue {
|
|
5921
6316
|
/**
|
|
5922
6317
|
* The user (identified by a user ID or a public token ID) who performed that most recent modification.
|
|
6318
|
+
*
|
|
6319
|
+
* @exampleValue john.doe@example.com
|
|
5923
6320
|
*/
|
|
5924
6321
|
author?: string;
|
|
5925
6322
|
/**
|
|
@@ -5936,14 +6333,20 @@ export declare interface EffectiveSettingsValue {
|
|
|
5936
6333
|
modified?: number;
|
|
5937
6334
|
/**
|
|
5938
6335
|
* The origin of the settings value.
|
|
6336
|
+
*
|
|
6337
|
+
* @exampleValue HOST-D3A3C5A146830A79
|
|
5939
6338
|
*/
|
|
5940
6339
|
origin?: string;
|
|
5941
6340
|
/**
|
|
5942
6341
|
* The schema on which the object is based.
|
|
6342
|
+
*
|
|
6343
|
+
* @exampleValue builtin:container.built-in-monitoring-rule
|
|
5943
6344
|
*/
|
|
5944
6345
|
schemaId?: string;
|
|
5945
6346
|
/**
|
|
5946
6347
|
* The version of the schema on which the object is based.
|
|
6348
|
+
*
|
|
6349
|
+
* @exampleValue 1.0.0
|
|
5947
6350
|
*/
|
|
5948
6351
|
schemaVersion?: string;
|
|
5949
6352
|
/**
|
|
@@ -5960,6 +6363,8 @@ export declare interface EffectiveSettingsValue {
|
|
|
5960
6363
|
* It defines the actual values of settings' parameters.
|
|
5961
6364
|
*
|
|
5962
6365
|
* The actual content depends on the object's schema.
|
|
6366
|
+
*
|
|
6367
|
+
* @exampleValue {"autoMonitoring":true}
|
|
5963
6368
|
*/
|
|
5964
6369
|
value?: AnyValue;
|
|
5965
6370
|
}
|
|
@@ -5976,6 +6381,8 @@ export declare interface EffectiveSettingsValuesList {
|
|
|
5976
6381
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
5977
6382
|
*
|
|
5978
6383
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
6384
|
+
*
|
|
6385
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
5979
6386
|
*/
|
|
5980
6387
|
nextPageKey?: string;
|
|
5981
6388
|
/**
|
|
@@ -6074,6 +6481,8 @@ export declare interface EntitiesList {
|
|
|
6074
6481
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
6075
6482
|
*
|
|
6076
6483
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
6484
|
+
*
|
|
6485
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
6077
6486
|
*/
|
|
6078
6487
|
nextPageKey?: string;
|
|
6079
6488
|
/**
|
|
@@ -6279,6 +6688,8 @@ export declare interface EntityTypeList {
|
|
|
6279
6688
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
6280
6689
|
*
|
|
6281
6690
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
6691
|
+
*
|
|
6692
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
6282
6693
|
*/
|
|
6283
6694
|
nextPageKey?: string;
|
|
6284
6695
|
/**
|
|
@@ -6301,14 +6712,20 @@ export declare interface EntityTypeList {
|
|
|
6301
6712
|
export declare interface EntityTypePropertyDto {
|
|
6302
6713
|
/**
|
|
6303
6714
|
* The display-name of the property.
|
|
6715
|
+
*
|
|
6716
|
+
* @exampleValue cpu cores
|
|
6304
6717
|
*/
|
|
6305
6718
|
displayName?: string;
|
|
6306
6719
|
/**
|
|
6307
6720
|
* The ID of the property.
|
|
6721
|
+
*
|
|
6722
|
+
* @exampleValue cpuCores
|
|
6308
6723
|
*/
|
|
6309
6724
|
id?: string;
|
|
6310
6725
|
/**
|
|
6311
6726
|
* The type of the property.
|
|
6727
|
+
*
|
|
6728
|
+
* @exampleValue Number
|
|
6312
6729
|
*/
|
|
6313
6730
|
type?: string;
|
|
6314
6731
|
}
|
|
@@ -6432,18 +6849,26 @@ export declare enum EntryPointUsageSegmentSourceType {
|
|
|
6432
6849
|
export declare interface EnumType {
|
|
6433
6850
|
/**
|
|
6434
6851
|
* A short description of the property.
|
|
6852
|
+
*
|
|
6853
|
+
* @exampleValue typeDescription
|
|
6435
6854
|
*/
|
|
6436
6855
|
description: string;
|
|
6437
6856
|
/**
|
|
6438
6857
|
* The display name of the property.
|
|
6858
|
+
*
|
|
6859
|
+
* @exampleValue typeDisplayName
|
|
6439
6860
|
*/
|
|
6440
6861
|
displayName?: string;
|
|
6441
6862
|
/**
|
|
6442
6863
|
* An extended description and/or links to documentation.
|
|
6864
|
+
*
|
|
6865
|
+
* @exampleValue typeDocumentation
|
|
6443
6866
|
*/
|
|
6444
6867
|
documentation: string;
|
|
6445
6868
|
/**
|
|
6446
6869
|
* An existing Java enum class that holds the allowed values of the enum.
|
|
6870
|
+
*
|
|
6871
|
+
* @exampleValue enumClass
|
|
6447
6872
|
*/
|
|
6448
6873
|
enumClass?: string;
|
|
6449
6874
|
/**
|
|
@@ -6452,6 +6877,8 @@ export declare interface EnumType {
|
|
|
6452
6877
|
items: EnumValue[];
|
|
6453
6878
|
/**
|
|
6454
6879
|
* The type of the property.
|
|
6880
|
+
*
|
|
6881
|
+
* @exampleValue enum
|
|
6455
6882
|
*/
|
|
6456
6883
|
type: 'enum';
|
|
6457
6884
|
}
|
|
@@ -6471,22 +6898,32 @@ export declare enum EnumTypeType {
|
|
|
6471
6898
|
export declare interface EnumValue {
|
|
6472
6899
|
/**
|
|
6473
6900
|
* A short description of the value.
|
|
6901
|
+
*
|
|
6902
|
+
* @exampleValue exampleDescription
|
|
6474
6903
|
*/
|
|
6475
6904
|
description?: string;
|
|
6476
6905
|
/**
|
|
6477
6906
|
* The display name of the value.
|
|
6907
|
+
*
|
|
6908
|
+
* @exampleValue exampleDisplayName
|
|
6478
6909
|
*/
|
|
6479
6910
|
displayName: string;
|
|
6480
6911
|
/**
|
|
6481
6912
|
* The name of the value in an existing Java enum class.
|
|
6913
|
+
*
|
|
6914
|
+
* @exampleValue exampleJavaEnumValue
|
|
6482
6915
|
*/
|
|
6483
6916
|
enumInstance?: string;
|
|
6484
6917
|
/**
|
|
6485
6918
|
* The icon of the value.
|
|
6919
|
+
*
|
|
6920
|
+
* @exampleValue checkmark
|
|
6486
6921
|
*/
|
|
6487
6922
|
icon?: string;
|
|
6488
6923
|
/**
|
|
6489
6924
|
* The allowed value of the enum.
|
|
6925
|
+
*
|
|
6926
|
+
* @exampleValue exampleValue
|
|
6490
6927
|
*/
|
|
6491
6928
|
value: AnyValue;
|
|
6492
6929
|
}
|
|
@@ -6525,12 +6962,16 @@ export declare class ErrorEnvelopeError extends ClientRequestError<ErrorEnvelope
|
|
|
6525
6962
|
declare interface Event_2 {
|
|
6526
6963
|
/**
|
|
6527
6964
|
* The correlation ID of the event.
|
|
6965
|
+
*
|
|
6966
|
+
* @exampleValue 933613657e1c8fcf
|
|
6528
6967
|
*/
|
|
6529
6968
|
correlationId?: string;
|
|
6530
6969
|
/**
|
|
6531
6970
|
* The timestamp when the event was closed, in UTC milliseconds.
|
|
6532
6971
|
*
|
|
6533
6972
|
* Has the value of `null` if the event is still active.
|
|
6973
|
+
*
|
|
6974
|
+
* @exampleValue 1564039524182
|
|
6534
6975
|
*/
|
|
6535
6976
|
endTime?: number;
|
|
6536
6977
|
/**
|
|
@@ -6543,10 +6984,14 @@ declare interface Event_2 {
|
|
|
6543
6984
|
entityTags?: METag[];
|
|
6544
6985
|
/**
|
|
6545
6986
|
* The ID of the event.
|
|
6987
|
+
*
|
|
6988
|
+
* @exampleValue 4293884258445543163_1564039524182
|
|
6546
6989
|
*/
|
|
6547
6990
|
eventId?: string;
|
|
6548
6991
|
/**
|
|
6549
6992
|
* The type of the event.
|
|
6993
|
+
*
|
|
6994
|
+
* @exampleValue LOW_DISK_SPACE
|
|
6550
6995
|
*/
|
|
6551
6996
|
eventType?: string;
|
|
6552
6997
|
/**
|
|
@@ -6565,10 +7010,14 @@ declare interface Event_2 {
|
|
|
6565
7010
|
properties?: EventProperty[];
|
|
6566
7011
|
/**
|
|
6567
7012
|
* The timestamp when the event was raised, in UTC milliseconds.
|
|
7013
|
+
*
|
|
7014
|
+
* @exampleValue 1564039524182
|
|
6568
7015
|
*/
|
|
6569
7016
|
startTime?: number;
|
|
6570
7017
|
/**
|
|
6571
7018
|
* The status of the event.
|
|
7019
|
+
*
|
|
7020
|
+
* @exampleValue OPEN
|
|
6572
7021
|
*/
|
|
6573
7022
|
status?: 'CLOSED' | 'OPEN';
|
|
6574
7023
|
/**
|
|
@@ -6587,6 +7036,8 @@ declare interface Event_2 {
|
|
|
6587
7036
|
suppressProblem?: boolean;
|
|
6588
7037
|
/**
|
|
6589
7038
|
* The title of the event.
|
|
7039
|
+
*
|
|
7040
|
+
* @exampleValue High CPU load on host X
|
|
6590
7041
|
*/
|
|
6591
7042
|
title?: string;
|
|
6592
7043
|
/**
|
|
@@ -6775,6 +7226,8 @@ export declare interface EventList {
|
|
|
6775
7226
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
6776
7227
|
*
|
|
6777
7228
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
7229
|
+
*
|
|
7230
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
6778
7231
|
*/
|
|
6779
7232
|
nextPageKey?: string;
|
|
6780
7233
|
/**
|
|
@@ -6803,6 +7256,8 @@ export declare interface EventPropertiesList {
|
|
|
6803
7256
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
6804
7257
|
*
|
|
6805
7258
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
7259
|
+
*
|
|
7260
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
6806
7261
|
*/
|
|
6807
7262
|
nextPageKey?: string;
|
|
6808
7263
|
/**
|
|
@@ -6839,6 +7294,8 @@ export declare interface EventPropertyDetails {
|
|
|
6839
7294
|
description?: string;
|
|
6840
7295
|
/**
|
|
6841
7296
|
* The display name of the event property.
|
|
7297
|
+
*
|
|
7298
|
+
* @exampleValue Custom description
|
|
6842
7299
|
*/
|
|
6843
7300
|
displayName?: string;
|
|
6844
7301
|
/**
|
|
@@ -6848,6 +7305,8 @@ export declare interface EventPropertyDetails {
|
|
|
6848
7305
|
filterable?: boolean;
|
|
6849
7306
|
/**
|
|
6850
7307
|
* The key of the event property.
|
|
7308
|
+
*
|
|
7309
|
+
* @exampleValue dt.event.description
|
|
6851
7310
|
*/
|
|
6852
7311
|
key?: string;
|
|
6853
7312
|
/**
|
|
@@ -6872,7 +7331,11 @@ export declare class EventsClient {
|
|
|
6872
7331
|
/**
|
|
6873
7332
|
* Lists all event properties
|
|
6874
7333
|
*
|
|
6875
|
-
* **
|
|
7334
|
+
* **One of the following scopes is required:**
|
|
7335
|
+
* + storage:events:read
|
|
7336
|
+
* + environment-api:events:read
|
|
7337
|
+
*
|
|
7338
|
+
* <br/>**One of the following permissions is required:**
|
|
6876
7339
|
* + environment:roles:viewer
|
|
6877
7340
|
* + storage:events:read
|
|
6878
7341
|
*
|
|
@@ -6908,7 +7371,11 @@ export declare class EventsClient {
|
|
|
6908
7371
|
/**
|
|
6909
7372
|
* Gets the details of an event property
|
|
6910
7373
|
*
|
|
6911
|
-
* **
|
|
7374
|
+
* **One of the following scopes is required:**
|
|
7375
|
+
* + storage:events:read
|
|
7376
|
+
* + environment-api:events:read
|
|
7377
|
+
*
|
|
7378
|
+
* <br/>**One of the following permissions is required:**
|
|
6912
7379
|
* + environment:roles:viewer
|
|
6913
7380
|
* + storage:events:read
|
|
6914
7381
|
*
|
|
@@ -6933,11 +7400,15 @@ export declare class EventsClient {
|
|
|
6933
7400
|
/**
|
|
6934
7401
|
* Lists all event types
|
|
6935
7402
|
*
|
|
6936
|
-
* **
|
|
6937
|
-
* + environment:roles:viewer
|
|
7403
|
+
* **One of the following scopes is required:**
|
|
6938
7404
|
* + storage:events:read
|
|
7405
|
+
* + environment-api:events:read
|
|
6939
7406
|
*
|
|
6940
|
-
*
|
|
7407
|
+
* <br/>**One of the following permissions is required:**
|
|
7408
|
+
* + environment:roles:viewer
|
|
7409
|
+
* + storage:events:read
|
|
7410
|
+
*
|
|
7411
|
+
* @returns {Promise<EventTypeList>} Success
|
|
6941
7412
|
*
|
|
6942
7413
|
* @example <caption>Code example</caption>
|
|
6943
7414
|
* import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -6969,7 +7440,11 @@ export declare class EventsClient {
|
|
|
6969
7440
|
/**
|
|
6970
7441
|
* Gets the properties of an event type
|
|
6971
7442
|
*
|
|
6972
|
-
* **
|
|
7443
|
+
* **One of the following scopes is required:**
|
|
7444
|
+
* + storage:events:read
|
|
7445
|
+
* + environment-api:events:read
|
|
7446
|
+
*
|
|
7447
|
+
* <br/>**One of the following permissions is required:**
|
|
6973
7448
|
* + environment:roles:viewer
|
|
6974
7449
|
* + storage:events:read
|
|
6975
7450
|
*
|
|
@@ -7118,12 +7593,13 @@ export declare class EventsClient {
|
|
|
7118
7593
|
* Ingests a custom event
|
|
7119
7594
|
*
|
|
7120
7595
|
* **One of the following scopes is required:**
|
|
7596
|
+
* + openpipeline:events.davis:ingest
|
|
7121
7597
|
* + storage:events:write
|
|
7122
7598
|
* + environment-api:events:write
|
|
7123
7599
|
*
|
|
7124
7600
|
* <br/>**One of the following permissions is required:**
|
|
7125
7601
|
* + environment:roles:viewer
|
|
7126
|
-
* +
|
|
7602
|
+
* + openpipeline:events.davis:ingest
|
|
7127
7603
|
*
|
|
7128
7604
|
* <br/><br/>The ingestion of custom events is subject to licensing (see [licensing documentation](https://www.dynatrace.com/support/help/shortlink/dps-events)).
|
|
7129
7605
|
*
|
|
@@ -7192,14 +7668,20 @@ export declare interface EventType {
|
|
|
7192
7668
|
description?: string;
|
|
7193
7669
|
/**
|
|
7194
7670
|
* The display name of the event type.
|
|
7671
|
+
*
|
|
7672
|
+
* @exampleValue High CPU
|
|
7195
7673
|
*/
|
|
7196
7674
|
displayName?: string;
|
|
7197
7675
|
/**
|
|
7198
7676
|
* The severity level associated with the event type.
|
|
7677
|
+
*
|
|
7678
|
+
* @exampleValue PERFORMANCE
|
|
7199
7679
|
*/
|
|
7200
7680
|
severityLevel?: 'AVAILABILITY' | 'CUSTOM_ALERT' | 'ERROR' | 'INFO' | 'MONITORING_UNAVAILABLE' | 'PERFORMANCE' | 'RESOURCE_CONTENTION';
|
|
7201
7681
|
/**
|
|
7202
7682
|
* The event type.
|
|
7683
|
+
*
|
|
7684
|
+
* @exampleValue OSI_HIGH_CPU
|
|
7203
7685
|
*/
|
|
7204
7686
|
type?: string;
|
|
7205
7687
|
}
|
|
@@ -7216,6 +7698,8 @@ export declare interface EventTypeList {
|
|
|
7216
7698
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
7217
7699
|
*
|
|
7218
7700
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
7701
|
+
*
|
|
7702
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
7219
7703
|
*/
|
|
7220
7704
|
nextPageKey?: string;
|
|
7221
7705
|
/**
|
|
@@ -7503,6 +7987,8 @@ export declare interface ExportedLogRecordList {
|
|
|
7503
7987
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
7504
7988
|
*
|
|
7505
7989
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
7990
|
+
*
|
|
7991
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
7506
7992
|
*/
|
|
7507
7993
|
nextPageKey?: string;
|
|
7508
7994
|
/**
|
|
@@ -7562,6 +8048,8 @@ export declare interface Extension {
|
|
|
7562
8048
|
variables: string[];
|
|
7563
8049
|
/**
|
|
7564
8050
|
* Extension version
|
|
8051
|
+
*
|
|
8052
|
+
* @exampleValue 1.2.3
|
|
7565
8053
|
*/
|
|
7566
8054
|
version: string;
|
|
7567
8055
|
}
|
|
@@ -7584,6 +8072,8 @@ export declare interface ExtensionAssetsDto {
|
|
|
7584
8072
|
status: string;
|
|
7585
8073
|
/**
|
|
7586
8074
|
* Version of the active extension environment configuration.
|
|
8075
|
+
*
|
|
8076
|
+
* @exampleValue 1.2.3
|
|
7587
8077
|
*/
|
|
7588
8078
|
version: string;
|
|
7589
8079
|
}
|
|
@@ -7591,6 +8081,8 @@ export declare interface ExtensionAssetsDto {
|
|
|
7591
8081
|
export declare interface ExtensionEnvironmentConfigurationVersion {
|
|
7592
8082
|
/**
|
|
7593
8083
|
* Extension version
|
|
8084
|
+
*
|
|
8085
|
+
* @exampleValue 1.2.3
|
|
7594
8086
|
*/
|
|
7595
8087
|
version: string;
|
|
7596
8088
|
}
|
|
@@ -7608,6 +8100,8 @@ export declare interface ExtensionFeatureSetsDetails {
|
|
|
7608
8100
|
export declare interface ExtensionInfo {
|
|
7609
8101
|
/**
|
|
7610
8102
|
* Active version in the environment (null if none is active)
|
|
8103
|
+
*
|
|
8104
|
+
* @exampleValue 1.2.3
|
|
7611
8105
|
*/
|
|
7612
8106
|
activeVersion?: string | null;
|
|
7613
8107
|
/**
|
|
@@ -7620,6 +8114,8 @@ export declare interface ExtensionInfo {
|
|
|
7620
8114
|
keywords: string[];
|
|
7621
8115
|
/**
|
|
7622
8116
|
* Highest installed version
|
|
8117
|
+
*
|
|
8118
|
+
* @exampleValue 1.2.3
|
|
7623
8119
|
*/
|
|
7624
8120
|
version: string;
|
|
7625
8121
|
}
|
|
@@ -7633,6 +8129,8 @@ export declare interface ExtensionInfoList {
|
|
|
7633
8129
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
7634
8130
|
*
|
|
7635
8131
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
8132
|
+
*
|
|
8133
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
7636
8134
|
*/
|
|
7637
8135
|
nextPageKey?: string;
|
|
7638
8136
|
/**
|
|
@@ -7654,6 +8152,8 @@ export declare interface ExtensionList {
|
|
|
7654
8152
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
7655
8153
|
*
|
|
7656
8154
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
8155
|
+
*
|
|
8156
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
7657
8157
|
*/
|
|
7658
8158
|
nextPageKey?: string;
|
|
7659
8159
|
/**
|
|
@@ -7690,6 +8190,8 @@ export declare interface ExtensionMonitoringConfigurationsList {
|
|
|
7690
8190
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
7691
8191
|
*
|
|
7692
8192
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
8193
|
+
*
|
|
8194
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
7693
8195
|
*/
|
|
7694
8196
|
nextPageKey?: string;
|
|
7695
8197
|
/**
|
|
@@ -7729,6 +8231,10 @@ export declare class Extensions_2_0Client {
|
|
|
7729
8231
|
* + environment:roles:manage-settings
|
|
7730
8232
|
* + extensions:definitions:read
|
|
7731
8233
|
*
|
|
8234
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8235
|
+
*
|
|
8236
|
+
* @deprecated
|
|
8237
|
+
*
|
|
7732
8238
|
* @returns {Promise<ExtensionList>} Success
|
|
7733
8239
|
*
|
|
7734
8240
|
* @example <caption>Code example</caption>
|
|
@@ -7766,6 +8272,10 @@ export declare class Extensions_2_0Client {
|
|
|
7766
8272
|
* + environment:roles:manage-settings
|
|
7767
8273
|
* + extensions:definitions:write
|
|
7768
8274
|
*
|
|
8275
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8276
|
+
*
|
|
8277
|
+
* @deprecated
|
|
8278
|
+
*
|
|
7769
8279
|
* @returns {Promise<ExtensionUploadResponseDto>} The extension is valid | Success. The extension 2.0 has been uploaded.
|
|
7770
8280
|
*
|
|
7771
8281
|
* @example <caption>Code example</caption>
|
|
@@ -7782,13 +8292,19 @@ export declare class Extensions_2_0Client {
|
|
|
7782
8292
|
*/
|
|
7783
8293
|
uploadExtension(config: {
|
|
7784
8294
|
body: Blob;
|
|
7785
|
-
/**
|
|
8295
|
+
/**
|
|
8296
|
+
* Only run validation but do not persist the extension even if validation was successful.
|
|
8297
|
+
*
|
|
8298
|
+
* @defaultValue false
|
|
8299
|
+
*/ validateOnly?: boolean;
|
|
7786
8300
|
abortSignal?: AbortSignal_2;
|
|
7787
8301
|
}): Promise<ExtensionUploadResponseDto>;
|
|
7788
8302
|
/**
|
|
7789
8303
|
* Lists all Java processes discovered in the environment that are available for JMX metric collection. | maturity=EARLY_ADOPTER
|
|
7790
8304
|
*
|
|
7791
|
-
* **Required scope:** extensions:discovery.jmx:read
|
|
8305
|
+
* **Required scope:** extensions:discovery.jmx:read<br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8306
|
+
*
|
|
8307
|
+
* @deprecated
|
|
7792
8308
|
*
|
|
7793
8309
|
* @returns {Promise<JavaProcessContainerList[]>} Success
|
|
7794
8310
|
*
|
|
@@ -7809,7 +8325,9 @@ export declare class Extensions_2_0Client {
|
|
|
7809
8325
|
/**
|
|
7810
8326
|
* Retrieves details of a specified Java process discovered in the environment for JMX metric collection. | maturity=EARLY_ADOPTER
|
|
7811
8327
|
*
|
|
7812
|
-
* **Required scope:** extensions:discovery.jmx:read
|
|
8328
|
+
* **Required scope:** extensions:discovery.jmx:read<br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8329
|
+
*
|
|
8330
|
+
* @deprecated
|
|
7813
8331
|
*
|
|
7814
8332
|
* @returns {Promise<JavaProcessDetails>} Success
|
|
7815
8333
|
*
|
|
@@ -7833,7 +8351,9 @@ export declare class Extensions_2_0Client {
|
|
|
7833
8351
|
/**
|
|
7834
8352
|
* Lists all Java processes discovered in the environment that are available for PMI metric collection. | maturity=EARLY_ADOPTER
|
|
7835
8353
|
*
|
|
7836
|
-
* **Required scope:** extensions:discovery.pmi:read
|
|
8354
|
+
* **Required scope:** extensions:discovery.pmi:read<br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8355
|
+
*
|
|
8356
|
+
* @deprecated
|
|
7837
8357
|
*
|
|
7838
8358
|
* @returns {Promise<JavaProcessContainerList[]>} Success
|
|
7839
8359
|
*
|
|
@@ -7854,7 +8374,9 @@ export declare class Extensions_2_0Client {
|
|
|
7854
8374
|
/**
|
|
7855
8375
|
* Retrieves details of a specified Java process discovered in the environment for PMI metric collection. | maturity=EARLY_ADOPTER
|
|
7856
8376
|
*
|
|
7857
|
-
* **Required scope:** extensions:discovery.pmi:read
|
|
8377
|
+
* **Required scope:** extensions:discovery.pmi:read<br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8378
|
+
*
|
|
8379
|
+
* @deprecated
|
|
7858
8380
|
*
|
|
7859
8381
|
* @returns {Promise<PmiProcessDetails>} Success
|
|
7860
8382
|
*
|
|
@@ -7882,6 +8404,10 @@ export declare class Extensions_2_0Client {
|
|
|
7882
8404
|
* + environment:roles:manage-settings
|
|
7883
8405
|
* + extensions:definitions:read
|
|
7884
8406
|
*
|
|
8407
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8408
|
+
*
|
|
8409
|
+
* @deprecated
|
|
8410
|
+
*
|
|
7885
8411
|
* @returns {Promise<ExtensionInfoList>} Success
|
|
7886
8412
|
*
|
|
7887
8413
|
* @example <caption>Code example</caption>
|
|
@@ -7920,6 +8446,10 @@ export declare class Extensions_2_0Client {
|
|
|
7920
8446
|
* + environment:roles:manage-settings
|
|
7921
8447
|
* + extensions:definitions:read
|
|
7922
8448
|
*
|
|
8449
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8450
|
+
*
|
|
8451
|
+
* @deprecated
|
|
8452
|
+
*
|
|
7923
8453
|
* @returns {Promise<SchemasList>} Success
|
|
7924
8454
|
*
|
|
7925
8455
|
* @example <caption>Code example</caption>
|
|
@@ -7942,6 +8472,10 @@ export declare class Extensions_2_0Client {
|
|
|
7942
8472
|
* + environment:roles:manage-settings
|
|
7943
8473
|
* + extensions:definitions:read
|
|
7944
8474
|
*
|
|
8475
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8476
|
+
*
|
|
8477
|
+
* @deprecated
|
|
8478
|
+
*
|
|
7945
8479
|
* @returns {Promise<SchemaFiles | Binary>} Success
|
|
7946
8480
|
*
|
|
7947
8481
|
* @example <caption>Code example</caption>
|
|
@@ -7974,6 +8508,10 @@ export declare class Extensions_2_0Client {
|
|
|
7974
8508
|
* + environment:roles:manage-settings
|
|
7975
8509
|
* + extensions:definitions:read
|
|
7976
8510
|
*
|
|
8511
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8512
|
+
*
|
|
8513
|
+
* @deprecated
|
|
8514
|
+
*
|
|
7977
8515
|
* @returns {Promise<JsonNode>} Success
|
|
7978
8516
|
*
|
|
7979
8517
|
* @example <caption>Code example</caption>
|
|
@@ -8001,6 +8539,10 @@ export declare class Extensions_2_0Client {
|
|
|
8001
8539
|
* + environment:roles:manage-settings
|
|
8002
8540
|
* + extensions:definitions:read
|
|
8003
8541
|
*
|
|
8542
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8543
|
+
*
|
|
8544
|
+
* @deprecated
|
|
8545
|
+
*
|
|
8004
8546
|
* @returns {Promise<ExtensionList>} Success
|
|
8005
8547
|
*
|
|
8006
8548
|
* @example <caption>Code example</caption>
|
|
@@ -8041,6 +8583,10 @@ export declare class Extensions_2_0Client {
|
|
|
8041
8583
|
* + environment:roles:manage-settings
|
|
8042
8584
|
* + extensions:definitions:write
|
|
8043
8585
|
*
|
|
8586
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8587
|
+
*
|
|
8588
|
+
* @deprecated
|
|
8589
|
+
*
|
|
8044
8590
|
* @returns {Promise<RegisteredExtensionResultDto>} Success. The extension version is installed and active. If the requested version was already the active environment configuration, this is an idempotent no-op (no backend state changes).
|
|
8045
8591
|
*
|
|
8046
8592
|
* @example <caption>Code example</caption>
|
|
@@ -8067,6 +8613,10 @@ export declare class Extensions_2_0Client {
|
|
|
8067
8613
|
* + environment:roles:manage-settings
|
|
8068
8614
|
* + extensions:definitions:read
|
|
8069
8615
|
*
|
|
8616
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8617
|
+
*
|
|
8618
|
+
* @deprecated
|
|
8619
|
+
*
|
|
8070
8620
|
* @returns {Promise<ExtensionEnvironmentConfigurationVersion>} Success
|
|
8071
8621
|
*
|
|
8072
8622
|
* @example <caption>Code example</caption>
|
|
@@ -8093,6 +8643,10 @@ export declare class Extensions_2_0Client {
|
|
|
8093
8643
|
* + environment:roles:manage-settings
|
|
8094
8644
|
* + extensions:definitions:write
|
|
8095
8645
|
*
|
|
8646
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8647
|
+
*
|
|
8648
|
+
* @deprecated
|
|
8649
|
+
*
|
|
8096
8650
|
* @returns {Promise<ExtensionEnvironmentConfigurationVersion>} Success. Environment configuration updated.
|
|
8097
8651
|
*
|
|
8098
8652
|
* @example <caption>Code example</caption>
|
|
@@ -8120,6 +8674,10 @@ export declare class Extensions_2_0Client {
|
|
|
8120
8674
|
* + environment:roles:manage-settings
|
|
8121
8675
|
* + extensions:definitions:write
|
|
8122
8676
|
*
|
|
8677
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8678
|
+
*
|
|
8679
|
+
* @deprecated
|
|
8680
|
+
*
|
|
8123
8681
|
* @returns {Promise<ExtensionEnvironmentConfigurationVersion>} Success. Environment configuration created. If the requested version was already active, this is an idempotent no-op (no backend state changes).
|
|
8124
8682
|
*
|
|
8125
8683
|
* @example <caption>Code example</caption>
|
|
@@ -8147,6 +8705,10 @@ export declare class Extensions_2_0Client {
|
|
|
8147
8705
|
* + environment:roles:manage-settings
|
|
8148
8706
|
* + extensions:definitions:write
|
|
8149
8707
|
*
|
|
8708
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8709
|
+
*
|
|
8710
|
+
* @deprecated
|
|
8711
|
+
*
|
|
8150
8712
|
* @returns {Promise<ExtensionEnvironmentConfigurationVersion>} Success. Environment configuration deactivated.
|
|
8151
8713
|
*
|
|
8152
8714
|
* @example <caption>Code example</caption>
|
|
@@ -8173,6 +8735,10 @@ export declare class Extensions_2_0Client {
|
|
|
8173
8735
|
* + environment:roles:manage-settings
|
|
8174
8736
|
* + extensions:definitions:read
|
|
8175
8737
|
*
|
|
8738
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8739
|
+
*
|
|
8740
|
+
* @deprecated
|
|
8741
|
+
*
|
|
8176
8742
|
* @returns {Promise<ExtensionAssetsDto>} Success
|
|
8177
8743
|
*
|
|
8178
8744
|
* @example <caption>Code example</caption>
|
|
@@ -8199,6 +8765,10 @@ export declare class Extensions_2_0Client {
|
|
|
8199
8765
|
* + environment:roles:manage-settings
|
|
8200
8766
|
* + extensions:definitions:read
|
|
8201
8767
|
*
|
|
8768
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8769
|
+
*
|
|
8770
|
+
* @deprecated
|
|
8771
|
+
*
|
|
8202
8772
|
* @returns {Promise<AlertTemplateDto>} Success
|
|
8203
8773
|
*
|
|
8204
8774
|
* @example <caption>Code example</caption>
|
|
@@ -8226,6 +8796,10 @@ export declare class Extensions_2_0Client {
|
|
|
8226
8796
|
* + environment:roles:manage-settings
|
|
8227
8797
|
* + extensions:configurations:read
|
|
8228
8798
|
*
|
|
8799
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8800
|
+
*
|
|
8801
|
+
* @deprecated
|
|
8802
|
+
*
|
|
8229
8803
|
* @returns {Promise<ExtensionMonitoringConfigurationsList>} Success
|
|
8230
8804
|
*
|
|
8231
8805
|
* @example <caption>Code example</caption>
|
|
@@ -8268,6 +8842,10 @@ export declare class Extensions_2_0Client {
|
|
|
8268
8842
|
* + environment:roles:manage-settings
|
|
8269
8843
|
* + extensions:configurations:write
|
|
8270
8844
|
*
|
|
8845
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8846
|
+
*
|
|
8847
|
+
* @deprecated
|
|
8848
|
+
*
|
|
8271
8849
|
* @returns {Promise<MonitoringConfigurationResponse[] | (MonitoringConfigurationResponse | ErrorEnvelope)[]>} Success | Multi-Status, if not all requests resulted in the same status
|
|
8272
8850
|
*
|
|
8273
8851
|
* @example <caption>Code example</caption>
|
|
@@ -8302,6 +8880,10 @@ export declare class Extensions_2_0Client {
|
|
|
8302
8880
|
* + environment:roles:manage-settings
|
|
8303
8881
|
* + extensions:configurations:read
|
|
8304
8882
|
*
|
|
8883
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8884
|
+
*
|
|
8885
|
+
* @deprecated
|
|
8886
|
+
*
|
|
8305
8887
|
* @returns {Promise<ExtensionStatusWithIdDto[]>} Success
|
|
8306
8888
|
*
|
|
8307
8889
|
* @example <caption>Code example</caption>
|
|
@@ -8327,6 +8909,10 @@ export declare class Extensions_2_0Client {
|
|
|
8327
8909
|
* + environment:roles:manage-settings
|
|
8328
8910
|
* + extensions:configurations:read
|
|
8329
8911
|
*
|
|
8912
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8913
|
+
*
|
|
8914
|
+
* @deprecated
|
|
8915
|
+
*
|
|
8330
8916
|
* @returns {Promise<ExtensionMonitoringConfiguration>} Success
|
|
8331
8917
|
*
|
|
8332
8918
|
* @example <caption>Code example</caption>
|
|
@@ -8354,6 +8940,10 @@ export declare class Extensions_2_0Client {
|
|
|
8354
8940
|
* + environment:roles:manage-settings
|
|
8355
8941
|
* + extensions:configurations:write
|
|
8356
8942
|
*
|
|
8943
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8944
|
+
*
|
|
8945
|
+
* @deprecated
|
|
8946
|
+
*
|
|
8357
8947
|
* @returns {Promise<MonitoringConfigurationResponse>} Success
|
|
8358
8948
|
*
|
|
8359
8949
|
* @example <caption>Code example</caption>
|
|
@@ -8384,6 +8974,10 @@ export declare class Extensions_2_0Client {
|
|
|
8384
8974
|
* + environment:roles:manage-settings
|
|
8385
8975
|
* + extensions:configurations:write
|
|
8386
8976
|
*
|
|
8977
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
8978
|
+
*
|
|
8979
|
+
* @deprecated
|
|
8980
|
+
*
|
|
8387
8981
|
* @example <caption>Code example</caption>
|
|
8388
8982
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
8389
8983
|
*
|
|
@@ -8410,6 +9004,10 @@ export declare class Extensions_2_0Client {
|
|
|
8410
9004
|
* + environment:roles:manage-settings
|
|
8411
9005
|
* + extensions:configuration.actions:write
|
|
8412
9006
|
*
|
|
9007
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
9008
|
+
*
|
|
9009
|
+
* @deprecated
|
|
9010
|
+
*
|
|
8413
9011
|
* @returns {Promise<ExecuteActionsResponse>} Accepted. Response doesn't have a body.
|
|
8414
9012
|
*
|
|
8415
9013
|
* @example <caption>Code example</caption>
|
|
@@ -8442,6 +9040,10 @@ export declare class Extensions_2_0Client {
|
|
|
8442
9040
|
* + environment:roles:manage-settings
|
|
8443
9041
|
* + extensions:configurations:read
|
|
8444
9042
|
*
|
|
9043
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
9044
|
+
*
|
|
9045
|
+
* @deprecated
|
|
9046
|
+
*
|
|
8445
9047
|
* @returns {Promise<AuditLog>} Success
|
|
8446
9048
|
*
|
|
8447
9049
|
* @example <caption>Code example</caption>
|
|
@@ -8517,6 +9119,8 @@ export declare class Extensions_2_0Client {
|
|
|
8517
9119
|
* * `-timestamp`: Newest first.
|
|
8518
9120
|
*
|
|
8519
9121
|
* If not set, the newest first sorting is applied.
|
|
9122
|
+
*
|
|
9123
|
+
* @defaultValue -timestamp
|
|
8520
9124
|
*/ sort?: string;
|
|
8521
9125
|
abortSignal?: AbortSignal_2;
|
|
8522
9126
|
}): Promise<AuditLog>;
|
|
@@ -8527,6 +9131,10 @@ export declare class Extensions_2_0Client {
|
|
|
8527
9131
|
* + environment:roles:manage-settings
|
|
8528
9132
|
* + extensions:configurations:read
|
|
8529
9133
|
*
|
|
9134
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
9135
|
+
*
|
|
9136
|
+
* @deprecated
|
|
9137
|
+
*
|
|
8530
9138
|
* @returns {Promise<ExtensionStatusDto>} Success
|
|
8531
9139
|
*
|
|
8532
9140
|
* @example <caption>Code example</caption>
|
|
@@ -8554,6 +9162,10 @@ export declare class Extensions_2_0Client {
|
|
|
8554
9162
|
* + environment:roles:manage-settings
|
|
8555
9163
|
* + extensions:definitions:read
|
|
8556
9164
|
*
|
|
9165
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
9166
|
+
*
|
|
9167
|
+
* @deprecated
|
|
9168
|
+
*
|
|
8557
9169
|
* @returns {Promise<Extension | Binary>} Success
|
|
8558
9170
|
*
|
|
8559
9171
|
* @example <caption>Code example</caption>
|
|
@@ -8589,6 +9201,10 @@ export declare class Extensions_2_0Client {
|
|
|
8589
9201
|
* + environment:roles:manage-settings
|
|
8590
9202
|
* + extensions:definitions:write
|
|
8591
9203
|
*
|
|
9204
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
9205
|
+
*
|
|
9206
|
+
* @deprecated
|
|
9207
|
+
*
|
|
8592
9208
|
* @returns {Promise<Extension>} Success. The extension 2.0 version has been deleted.
|
|
8593
9209
|
*
|
|
8594
9210
|
* @example <caption>Code example</caption>
|
|
@@ -8616,6 +9232,10 @@ export declare class Extensions_2_0Client {
|
|
|
8616
9232
|
* + environment:roles:manage-settings
|
|
8617
9233
|
* + extensions:configurations:write
|
|
8618
9234
|
*
|
|
9235
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
9236
|
+
*
|
|
9237
|
+
* @deprecated
|
|
9238
|
+
*
|
|
8619
9239
|
* @returns {Promise<ActiveGateGroupsInfoDto>} Success
|
|
8620
9240
|
*
|
|
8621
9241
|
* @example <caption>Code example</caption>
|
|
@@ -8648,6 +9268,10 @@ export declare class Extensions_2_0Client {
|
|
|
8648
9268
|
* + environment:roles:manage-settings
|
|
8649
9269
|
* + extensions:definitions:read
|
|
8650
9270
|
*
|
|
9271
|
+
* <br/><br/>Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
9272
|
+
*
|
|
9273
|
+
* @deprecated
|
|
9274
|
+
*
|
|
8651
9275
|
* @returns {Promise<SchemaDefinitionRestDto>} Success
|
|
8652
9276
|
*
|
|
8653
9277
|
* @example <caption>Code example</caption>
|
|
@@ -8768,6 +9392,8 @@ export declare interface ExtensionUploadResponseDto {
|
|
|
8768
9392
|
variables: string[];
|
|
8769
9393
|
/**
|
|
8770
9394
|
* Extension version
|
|
9395
|
+
*
|
|
9396
|
+
* @exampleValue 1.2.3
|
|
8771
9397
|
*/
|
|
8772
9398
|
version: string;
|
|
8773
9399
|
}
|
|
@@ -9088,6 +9714,54 @@ export declare enum FilterType {
|
|
|
9088
9714
|
Suffix = "suffix"
|
|
9089
9715
|
}
|
|
9090
9716
|
|
|
9717
|
+
/**
|
|
9718
|
+
* Get data of container images
|
|
9719
|
+
*/
|
|
9720
|
+
export declare class FleetManagementContainerImagesClient {
|
|
9721
|
+
private httpClient;
|
|
9722
|
+
private shouldTransformDates;
|
|
9723
|
+
/**
|
|
9724
|
+
* @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a FleetManagementContainerImagesClient. Custom http client should implement {HttpClient} interface.
|
|
9725
|
+
* @param {ApiClientOptions} [options] - Optional configuration for SDK Client.
|
|
9726
|
+
* @example
|
|
9727
|
+
* const fleetManagementContainerImagesClientNodeJs = new FleetManagementContainerImagesClient(yourCustomImplementation);
|
|
9728
|
+
*/
|
|
9729
|
+
constructor(httpClientImplementation: HttpClient, options?: ApiClientOptions);
|
|
9730
|
+
/**
|
|
9731
|
+
* Returns container images data
|
|
9732
|
+
*
|
|
9733
|
+
* **One of the following scopes is required:**
|
|
9734
|
+
* + environment-api:deployment:download
|
|
9735
|
+
* + fleet-management:container-images:read
|
|
9736
|
+
*
|
|
9737
|
+
* <br/>**One of the following permissions is required:**
|
|
9738
|
+
* + environment:roles:agent-install
|
|
9739
|
+
* + fleet-management:container-images:read
|
|
9740
|
+
*
|
|
9741
|
+
* <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.
|
|
9742
|
+
*
|
|
9743
|
+
* @returns {Promise<ContainerImageData>} Container images data returned
|
|
9744
|
+
*
|
|
9745
|
+
* @example <caption>Code example</caption>
|
|
9746
|
+
* import { fleetManagementContainerImagesClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
9747
|
+
*
|
|
9748
|
+
* const data =
|
|
9749
|
+
* await fleetManagementContainerImagesClient.getContainerImages();
|
|
9750
|
+
*
|
|
9751
|
+
* @throws {ErrorEnvelopeError} Failed. The input is invalid. | Internal server error. | Client side error. | Server side error.
|
|
9752
|
+
* @throws {InvalidResponseError}
|
|
9753
|
+
* @throws {ApiClientError}
|
|
9754
|
+
* @throws {ClientRequestError}
|
|
9755
|
+
*/
|
|
9756
|
+
getContainerImages(config?: {
|
|
9757
|
+
/** Registry name containing the container images. For a list of registries, see [Dynatrace Documentation](https://dt-url.net/mf239va) */ registry?: string;
|
|
9758
|
+
/** Partial registry name filter. Returns images for the first registry whose name contains this value. Ignored when 'registry' is provided. */ registryFilter?: string;
|
|
9759
|
+
abortSignal?: AbortSignal_2;
|
|
9760
|
+
}): Promise<ContainerImageData>;
|
|
9761
|
+
}
|
|
9762
|
+
|
|
9763
|
+
export declare const fleetManagementContainerImagesClient: FleetManagementContainerImagesClient;
|
|
9764
|
+
|
|
9091
9765
|
/**
|
|
9092
9766
|
* JS framework options of a JS Agent.
|
|
9093
9767
|
*/
|
|
@@ -9631,10 +10305,14 @@ export declare interface HashicorpCertificateConfig extends ExternalVaultConfig
|
|
|
9631
10305
|
export declare interface HistoryModificationInfo {
|
|
9632
10306
|
/**
|
|
9633
10307
|
* The unique identifier of the user who performed the most recent modification.
|
|
10308
|
+
*
|
|
10309
|
+
* @exampleValue fab17b7a-2eb2-4c95-b818-743d94be2c30
|
|
9634
10310
|
*/
|
|
9635
10311
|
lastModifiedBy?: string;
|
|
9636
10312
|
/**
|
|
9637
10313
|
* Reason for system change
|
|
10314
|
+
*
|
|
10315
|
+
* @exampleValue default settings creation
|
|
9638
10316
|
*/
|
|
9639
10317
|
lastModifiedReason?: string;
|
|
9640
10318
|
/**
|
|
@@ -9685,6 +10363,8 @@ export declare interface Identity {
|
|
|
9685
10363
|
id?: string;
|
|
9686
10364
|
/**
|
|
9687
10365
|
* The type of the identity.
|
|
10366
|
+
*
|
|
10367
|
+
* @exampleValue user
|
|
9688
10368
|
*/
|
|
9689
10369
|
type: 'all-users' | 'group' | 'user';
|
|
9690
10370
|
}
|
|
@@ -9802,6 +10482,8 @@ export declare interface InteractionStepDto extends SyntheticBrowserMonitorStepD
|
|
|
9802
10482
|
button: 'MOUSE_LEFT' | 'MOUSE_MIDDLE' | 'MOUSE_RIGHT';
|
|
9803
10483
|
/**
|
|
9804
10484
|
* Target of Browser Monitor step.
|
|
10485
|
+
*
|
|
10486
|
+
* @exampleValue {"locators":[{"type":"CSS","value":"<img>[id='logoIcon']"},{"type":"CSS","value":"<a>[id='externalSite']"}],"window":"ruxitWin[0]"}
|
|
9805
10487
|
*/
|
|
9806
10488
|
target?: TargetDto;
|
|
9807
10489
|
/**
|
|
@@ -9810,6 +10492,8 @@ export declare interface InteractionStepDto extends SyntheticBrowserMonitorStepD
|
|
|
9810
10492
|
validationRules?: ValidationRuleDto[];
|
|
9811
10493
|
/**
|
|
9812
10494
|
* Wait condition for Browser Monitor step.
|
|
10495
|
+
*
|
|
10496
|
+
* @exampleValue {"type":"NETWORK"}
|
|
9813
10497
|
*/
|
|
9814
10498
|
waitCondition?: BaseWaitConditionDto;
|
|
9815
10499
|
}
|
|
@@ -9871,14 +10555,20 @@ export declare interface Item {
|
|
|
9871
10555
|
datasource?: DatasourceDefinition;
|
|
9872
10556
|
/**
|
|
9873
10557
|
* A short description of the item.
|
|
10558
|
+
*
|
|
10559
|
+
* @exampleValue itemDescription
|
|
9874
10560
|
*/
|
|
9875
10561
|
description?: string;
|
|
9876
10562
|
/**
|
|
9877
10563
|
* The display name of the item.
|
|
10564
|
+
*
|
|
10565
|
+
* @exampleValue itemDisplayName
|
|
9878
10566
|
*/
|
|
9879
10567
|
displayName?: string;
|
|
9880
10568
|
/**
|
|
9881
10569
|
* An extended description and/or links to documentation.
|
|
10570
|
+
*
|
|
10571
|
+
* @exampleValue propertyDocumentation
|
|
9882
10572
|
*/
|
|
9883
10573
|
documentation?: string;
|
|
9884
10574
|
/**
|
|
@@ -9887,10 +10577,14 @@ export declare interface Item {
|
|
|
9887
10577
|
metadata?: ItemMetadata;
|
|
9888
10578
|
/**
|
|
9889
10579
|
* The type referenced by the item's value.
|
|
10580
|
+
*
|
|
10581
|
+
* @exampleValue itemReferencedType
|
|
9890
10582
|
*/
|
|
9891
10583
|
referencedType?: string;
|
|
9892
10584
|
/**
|
|
9893
10585
|
* The subtype of the item's value.
|
|
10586
|
+
*
|
|
10587
|
+
* @exampleValue itemSubType
|
|
9894
10588
|
*/
|
|
9895
10589
|
subType?: string;
|
|
9896
10590
|
/**
|
|
@@ -10029,6 +10723,8 @@ export declare interface JavaScriptMappingFileListDto {
|
|
|
10029
10723
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
10030
10724
|
*
|
|
10031
10725
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
10726
|
+
*
|
|
10727
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
10032
10728
|
*/
|
|
10033
10729
|
nextPageKey?: string;
|
|
10034
10730
|
/**
|
|
@@ -10319,10 +11015,14 @@ export declare interface JavaScriptStepDto extends SyntheticBrowserMonitorStepDt
|
|
|
10319
11015
|
javaScript: string;
|
|
10320
11016
|
/**
|
|
10321
11017
|
* Target of Browser Monitor step.
|
|
11018
|
+
*
|
|
11019
|
+
* @exampleValue {"locators":[{"type":"CSS","value":"<img>[id='logoIcon']"},{"type":"CSS","value":"<a>[id='externalSite']"}],"window":"ruxitWin[0]"}
|
|
10322
11020
|
*/
|
|
10323
11021
|
target?: TargetDto;
|
|
10324
11022
|
/**
|
|
10325
11023
|
* Wait condition for Browser Monitor step.
|
|
11024
|
+
*
|
|
11025
|
+
* @exampleValue {"type":"NETWORK"}
|
|
10326
11026
|
*/
|
|
10327
11027
|
waitCondition?: BaseWaitConditionDto;
|
|
10328
11028
|
}
|
|
@@ -10422,6 +11122,8 @@ export declare interface KeyStrokesStepDto extends SyntheticBrowserMonitorStepDt
|
|
|
10422
11122
|
simulateReturnKey?: boolean;
|
|
10423
11123
|
/**
|
|
10424
11124
|
* Target of Browser Monitor step.
|
|
11125
|
+
*
|
|
11126
|
+
* @exampleValue {"locators":[{"type":"CSS","value":"<img>[id='logoIcon']"},{"type":"CSS","value":"<a>[id='externalSite']"}],"window":"ruxitWin[0]"}
|
|
10425
11127
|
*/
|
|
10426
11128
|
target?: TargetDto;
|
|
10427
11129
|
/**
|
|
@@ -10430,6 +11132,8 @@ export declare interface KeyStrokesStepDto extends SyntheticBrowserMonitorStepDt
|
|
|
10430
11132
|
validationRules?: ValidationRuleDto[];
|
|
10431
11133
|
/**
|
|
10432
11134
|
* Wait condition for Browser Monitor step.
|
|
11135
|
+
*
|
|
11136
|
+
* @exampleValue {"type":"NETWORK"}
|
|
10433
11137
|
*/
|
|
10434
11138
|
waitCondition?: BaseWaitConditionDto;
|
|
10435
11139
|
}
|
|
@@ -10859,6 +11563,10 @@ export declare class LogsClient {
|
|
|
10859
11563
|
* The minimum length of a slot is 1 ms.
|
|
10860
11564
|
*
|
|
10861
11565
|
* If not set, 1 is used.
|
|
11566
|
+
*
|
|
11567
|
+
* @defaultValue 1
|
|
11568
|
+
*
|
|
11569
|
+
* @minimum 1
|
|
10862
11570
|
*/ timeBuckets?: number;
|
|
10863
11571
|
/**
|
|
10864
11572
|
* The maximum number of values in each group.
|
|
@@ -10866,6 +11574,10 @@ export declare class LogsClient {
|
|
|
10866
11574
|
* You can get up to 100 values per group.
|
|
10867
11575
|
*
|
|
10868
11576
|
* If not set, 10 is used.
|
|
11577
|
+
*
|
|
11578
|
+
* @defaultValue 10
|
|
11579
|
+
*
|
|
11580
|
+
* @minimum 1
|
|
10869
11581
|
*/ maxGroupValues?: number;
|
|
10870
11582
|
/**
|
|
10871
11583
|
* The groupings to be included in the response.
|
|
@@ -10951,7 +11663,13 @@ export declare class LogsClient {
|
|
|
10951
11663
|
*
|
|
10952
11664
|
* When the **nextPageKey** is set to obtain subsequent pages, you must omit all other query parameters.
|
|
10953
11665
|
*/ nextPageKey?: string;
|
|
10954
|
-
/**
|
|
11666
|
+
/**
|
|
11667
|
+
* The number of results per result page.
|
|
11668
|
+
*
|
|
11669
|
+
* @defaultValue 1000
|
|
11670
|
+
*
|
|
11671
|
+
* @minimum 1
|
|
11672
|
+
*/ pageSize?: number;
|
|
10955
11673
|
/**
|
|
10956
11674
|
* The log search query.
|
|
10957
11675
|
*
|
|
@@ -10965,13 +11683,19 @@ export declare class LogsClient {
|
|
|
10965
11683
|
* Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).
|
|
10966
11684
|
*
|
|
10967
11685
|
* 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).
|
|
11686
|
+
*
|
|
11687
|
+
* @defaultValue -timestamp
|
|
10968
11688
|
*/ sort?: string;
|
|
10969
11689
|
abortSignal?: AbortSignal_2;
|
|
10970
11690
|
}): Promise<ExportedLogRecordList>;
|
|
10971
11691
|
/**
|
|
10972
11692
|
* Pushes log records to Dynatrace
|
|
10973
11693
|
*
|
|
10974
|
-
* **
|
|
11694
|
+
* **One of the following scopes is required:**
|
|
11695
|
+
* + openpipeline:logs:ingest
|
|
11696
|
+
* + storage:logs:write
|
|
11697
|
+
*
|
|
11698
|
+
* <br/><br/>Ingested logs are stored in Dynatrace.
|
|
10975
11699
|
*
|
|
10976
11700
|
* If you are using this API endpoint on an Environment ActiveGate, the Log Analytics Collector module must be enabled.
|
|
10977
11701
|
* This endpoint is not available on Containerized ActiveGate (including Kubernetes deployments).
|
|
@@ -11123,6 +11847,10 @@ export declare class LogsClient {
|
|
|
11123
11847
|
* The maximal allowed limit is 1000.
|
|
11124
11848
|
*
|
|
11125
11849
|
* If not set, 1000 is used.
|
|
11850
|
+
*
|
|
11851
|
+
* @defaultValue 1000
|
|
11852
|
+
*
|
|
11853
|
+
* @minimum 1
|
|
11126
11854
|
*/ limit?: number;
|
|
11127
11855
|
/**
|
|
11128
11856
|
* The log search query.
|
|
@@ -11137,6 +11865,8 @@ export declare class LogsClient {
|
|
|
11137
11865
|
* Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).
|
|
11138
11866
|
*
|
|
11139
11867
|
* 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).
|
|
11868
|
+
*
|
|
11869
|
+
* @defaultValue -timestamp
|
|
11140
11870
|
*/ sort?: string;
|
|
11141
11871
|
/**
|
|
11142
11872
|
* The cursor for the next slice of results. You can find it in the **nextSliceKey** field of the previous response.
|
|
@@ -11860,13 +12590,19 @@ export declare class MetricsClient {
|
|
|
11860
12590
|
*
|
|
11861
12591
|
* 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.
|
|
11862
12592
|
*/ metricSelector: string;
|
|
11863
|
-
/**
|
|
12593
|
+
/**
|
|
12594
|
+
* The number of days since the metric was last used. Must be between `30` and `1825` (5 years).
|
|
12595
|
+
*
|
|
12596
|
+
* @minimum 30
|
|
12597
|
+
*/ minUnusedDays: number;
|
|
11864
12598
|
abortSignal?: AbortSignal_2;
|
|
11865
12599
|
}): Promise<void>;
|
|
11866
12600
|
/**
|
|
11867
12601
|
* Pushes metric data points to Dynatrace
|
|
11868
12602
|
*
|
|
11869
|
-
* **
|
|
12603
|
+
* **One of the following scopes is required:**
|
|
12604
|
+
* + storage:metrics:write
|
|
12605
|
+
* + openpipeline:metrics:ingest
|
|
11870
12606
|
*
|
|
11871
12607
|
* @returns {Promise<ValidationResponse>} The provided metric data points are accepted and will be processed in the background.
|
|
11872
12608
|
*
|
|
@@ -12328,6 +13064,8 @@ export declare interface MinimalExtension {
|
|
|
12328
13064
|
extensionName: string;
|
|
12329
13065
|
/**
|
|
12330
13066
|
* Extension version
|
|
13067
|
+
*
|
|
13068
|
+
* @exampleValue 1.2.3
|
|
12331
13069
|
*/
|
|
12332
13070
|
version: string;
|
|
12333
13071
|
}
|
|
@@ -12816,7 +13554,7 @@ export declare class MonitoredEntitiesClient {
|
|
|
12816
13554
|
* const data =
|
|
12817
13555
|
* await monitoredEntitiesClient.setSecurityContext({
|
|
12818
13556
|
* entitySelector: "...",
|
|
12819
|
-
* body: {},
|
|
13557
|
+
* body: { securityContext: ["..."] },
|
|
12820
13558
|
* });
|
|
12821
13559
|
*
|
|
12822
13560
|
* @throws {ErrorEnvelopeError} Client side error. | Server side error.
|
|
@@ -13686,6 +14424,8 @@ export declare interface MonitoredStates {
|
|
|
13686
14424
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
13687
14425
|
*
|
|
13688
14426
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
14427
|
+
*
|
|
14428
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
13689
14429
|
*/
|
|
13690
14430
|
nextPageKey?: string;
|
|
13691
14431
|
/**
|
|
@@ -13725,6 +14465,8 @@ export declare interface MonitorExecutionResults {
|
|
|
13725
14465
|
export declare interface MonitoringConfigurationDto {
|
|
13726
14466
|
/**
|
|
13727
14467
|
* The scope this monitoring configuration will be defined for
|
|
14468
|
+
*
|
|
14469
|
+
* @exampleValue HOST-D3A3C5A146830A79
|
|
13728
14470
|
*/
|
|
13729
14471
|
scope: string;
|
|
13730
14472
|
/**
|
|
@@ -13740,6 +14482,8 @@ export declare interface MonitoringConfigurationResponse {
|
|
|
13740
14482
|
code: number;
|
|
13741
14483
|
/**
|
|
13742
14484
|
* The identifier of the new configuration
|
|
14485
|
+
*
|
|
14486
|
+
* @exampleValue 331e416f-9ab7-4694-8408-816026820645
|
|
13743
14487
|
*/
|
|
13744
14488
|
objectId: string;
|
|
13745
14489
|
}
|
|
@@ -13952,10 +14696,14 @@ export declare enum MuteStateReason {
|
|
|
13952
14696
|
export declare interface NavigateStepDto extends SyntheticBrowserMonitorStepDto {
|
|
13953
14697
|
/**
|
|
13954
14698
|
* Authentication dto for Browser Monitor step.
|
|
14699
|
+
*
|
|
14700
|
+
* @exampleValue {"type":"HTTP_AUTHENTICATION"}
|
|
13955
14701
|
*/
|
|
13956
14702
|
authentication?: AuthenticationDto;
|
|
13957
14703
|
/**
|
|
13958
14704
|
* Target of Browser Monitor step.
|
|
14705
|
+
*
|
|
14706
|
+
* @exampleValue {"locators":[{"type":"CSS","value":"<img>[id='logoIcon']"},{"type":"CSS","value":"<a>[id='externalSite']"}],"window":"ruxitWin[0]"}
|
|
13959
14707
|
*/
|
|
13960
14708
|
target?: TargetDto;
|
|
13961
14709
|
/**
|
|
@@ -13968,6 +14716,8 @@ export declare interface NavigateStepDto extends SyntheticBrowserMonitorStepDto
|
|
|
13968
14716
|
validationRules?: ValidationRuleDto[];
|
|
13969
14717
|
/**
|
|
13970
14718
|
* Wait condition for Browser Monitor step.
|
|
14719
|
+
*
|
|
14720
|
+
* @exampleValue {"type":"NETWORK"}
|
|
13971
14721
|
*/
|
|
13972
14722
|
waitCondition?: BaseWaitConditionDto;
|
|
13973
14723
|
}
|
|
@@ -14515,6 +15265,8 @@ export declare interface ObjectsList {
|
|
|
14515
15265
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
14516
15266
|
*
|
|
14517
15267
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
15268
|
+
*
|
|
15269
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
14518
15270
|
*/
|
|
14519
15271
|
nextPageKey?: string;
|
|
14520
15272
|
/**
|
|
@@ -14671,10 +15423,14 @@ export declare const oneAgentRemoteConfigurationManagementClient: OneAgentRemote
|
|
|
14671
15423
|
export declare interface PermissionContext {
|
|
14672
15424
|
/**
|
|
14673
15425
|
* Settings schema id for conditional permission
|
|
15426
|
+
*
|
|
15427
|
+
* @exampleValue service:schema
|
|
14674
15428
|
*/
|
|
14675
15429
|
schemaId: string;
|
|
14676
15430
|
/**
|
|
14677
15431
|
* Settings scope for conditional permission
|
|
15432
|
+
*
|
|
15433
|
+
* @exampleValue environment
|
|
14678
15434
|
*/
|
|
14679
15435
|
scope: string;
|
|
14680
15436
|
}
|
|
@@ -14722,18 +15478,24 @@ export declare interface Precondition {
|
|
|
14722
15478
|
* The expected value of the property.
|
|
14723
15479
|
*
|
|
14724
15480
|
* Only applicable to properties of the `EQUALS` type.
|
|
15481
|
+
*
|
|
15482
|
+
* @exampleValue expectedValue
|
|
14725
15483
|
*/
|
|
14726
15484
|
expectedValue?: AnyValue;
|
|
14727
15485
|
/**
|
|
14728
15486
|
* A list of valid values of the property.
|
|
14729
15487
|
*
|
|
14730
15488
|
* Only applicable to properties of the `IN` type.
|
|
15489
|
+
*
|
|
15490
|
+
* @exampleValue expectedValues
|
|
14731
15491
|
*/
|
|
14732
15492
|
expectedValues?: AnyValue[];
|
|
14733
15493
|
/**
|
|
14734
15494
|
* The Regular expression which is matched against the property.
|
|
14735
15495
|
*
|
|
14736
15496
|
* Only applicable to properties of the `REGEX_MATCH` type.
|
|
15497
|
+
*
|
|
15498
|
+
* @exampleValue example Regex
|
|
14737
15499
|
*/
|
|
14738
15500
|
pattern?: string;
|
|
14739
15501
|
/**
|
|
@@ -14748,10 +15510,14 @@ export declare interface Precondition {
|
|
|
14748
15510
|
preconditions?: Precondition[];
|
|
14749
15511
|
/**
|
|
14750
15512
|
* The property to be evaluated.
|
|
15513
|
+
*
|
|
15514
|
+
* @exampleValue propertyToEvaluate
|
|
14751
15515
|
*/
|
|
14752
15516
|
property?: string;
|
|
14753
15517
|
/**
|
|
14754
15518
|
* The type of the precondition.
|
|
15519
|
+
*
|
|
15520
|
+
* @exampleValue NULL
|
|
14755
15521
|
*/
|
|
14756
15522
|
type: 'AND' | 'EQUALS' | 'IN' | 'NOT' | 'NULL' | 'OR' | 'REGEX_MATCH';
|
|
14757
15523
|
}
|
|
@@ -14844,12 +15610,26 @@ export declare interface PrivateSyntheticLocation {
|
|
|
14844
15610
|
latitude: number;
|
|
14845
15611
|
/**
|
|
14846
15612
|
* 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.
|
|
15613
|
+
*
|
|
15614
|
+
* @minimum 1
|
|
14847
15615
|
*/
|
|
14848
15616
|
locationNodeOutageDelayInMinutes?: number;
|
|
14849
15617
|
/**
|
|
14850
15618
|
* The longitude of the location in `DDD.dddd` format.
|
|
14851
15619
|
*/
|
|
14852
15620
|
longitude: number;
|
|
15621
|
+
/**
|
|
15622
|
+
* Containerized location property. The maximum number of ActiveGates deployed for the location (required for a Kubernetes location).
|
|
15623
|
+
*
|
|
15624
|
+
* @minimum 1
|
|
15625
|
+
*/
|
|
15626
|
+
maxActiveGateCount?: number;
|
|
15627
|
+
/**
|
|
15628
|
+
* Containerized location property. The minimum number of ActiveGates deployed for the location (required for a Kubernetes location).
|
|
15629
|
+
*
|
|
15630
|
+
* @minimum 1
|
|
15631
|
+
*/
|
|
15632
|
+
minActiveGateCount?: number;
|
|
14853
15633
|
/**
|
|
14854
15634
|
* Containerized location property. Boolean value describes if icmp monitors will be executed on this location:
|
|
14855
15635
|
*
|
|
@@ -14865,6 +15645,15 @@ export declare interface PrivateSyntheticLocation {
|
|
|
14865
15645
|
* A mapping id to name of the nodes belonging to the location.
|
|
14866
15646
|
*/
|
|
14867
15647
|
nodeNames?: PrivateSyntheticLocationNodeNames;
|
|
15648
|
+
/**
|
|
15649
|
+
* Containerized location property. The size of a containerized node deployed for the location (required for a Kubernetes location). Accepted values:
|
|
15650
|
+
*
|
|
15651
|
+
* * `XS`: extra small
|
|
15652
|
+
* * `S`: small
|
|
15653
|
+
* * `M`: medium
|
|
15654
|
+
* The node size `L` is not supported in containerized locations.
|
|
15655
|
+
*/
|
|
15656
|
+
nodeSize?: 'M' | 'S' | 'UNSUPPORTED' | 'XS';
|
|
14868
15657
|
/**
|
|
14869
15658
|
* A list of synthetic nodes belonging to the location.
|
|
14870
15659
|
*
|
|
@@ -14937,6 +15726,23 @@ export declare interface PrivateSyntheticLocationNodeNames {
|
|
|
14937
15726
|
[propName: string]: string | undefined;
|
|
14938
15727
|
}
|
|
14939
15728
|
|
|
15729
|
+
/**
|
|
15730
|
+
* Containerized location property. The size of a containerized node deployed for the location (required for a Kubernetes location). Accepted values:
|
|
15731
|
+
*
|
|
15732
|
+
* * `XS`: extra small
|
|
15733
|
+
* * `S`: small
|
|
15734
|
+
* * `M`: medium
|
|
15735
|
+
* The node size `L` is not supported in containerized locations.
|
|
15736
|
+
*
|
|
15737
|
+
* @deprecated Use literal values.
|
|
15738
|
+
*/
|
|
15739
|
+
export declare enum PrivateSyntheticLocationNodeSize {
|
|
15740
|
+
M = "M",
|
|
15741
|
+
S = "S",
|
|
15742
|
+
Unsupported = "UNSUPPORTED",
|
|
15743
|
+
Xs = "XS"
|
|
15744
|
+
}
|
|
15745
|
+
|
|
14940
15746
|
/**
|
|
14941
15747
|
* The status of the location:
|
|
14942
15748
|
*
|
|
@@ -15102,6 +15908,8 @@ export declare interface Problems {
|
|
|
15102
15908
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
15103
15909
|
*
|
|
15104
15910
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
15911
|
+
*
|
|
15912
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
15105
15913
|
*/
|
|
15106
15914
|
nextPageKey?: string;
|
|
15107
15915
|
/**
|
|
@@ -15327,7 +16135,13 @@ export declare class ProblemsClient {
|
|
|
15327
16135
|
/**
|
|
15328
16136
|
* Closes the specified problem and adds a closing comment on it
|
|
15329
16137
|
*
|
|
15330
|
-
* **
|
|
16138
|
+
* **One of the following scopes is required:**
|
|
16139
|
+
* + openpipeline:events.davis:ingest
|
|
16140
|
+
* + environment-api:problems:write
|
|
16141
|
+
*
|
|
16142
|
+
* <br/>**One of the following permissions is required:**
|
|
16143
|
+
* + environment:roles:viewer
|
|
16144
|
+
* + openpipeline:events.davis:ingest
|
|
15331
16145
|
*
|
|
15332
16146
|
* @returns {Promise<ProblemCloseResult | void>} Success
|
|
15333
16147
|
*
|
|
@@ -15549,22 +16363,32 @@ declare interface PropertyDefinition_2 {
|
|
|
15549
16363
|
* The default value to be used when no value is provided.
|
|
15550
16364
|
*
|
|
15551
16365
|
* If a non-singleton has the value of `null`, it means an empty collection.
|
|
16366
|
+
*
|
|
16367
|
+
* @exampleValue propertyDefaultValue
|
|
15552
16368
|
*/
|
|
15553
16369
|
default?: AnyValue;
|
|
15554
16370
|
/**
|
|
15555
16371
|
* A short description of the property.
|
|
16372
|
+
*
|
|
16373
|
+
* @exampleValue propertyDescription
|
|
15556
16374
|
*/
|
|
15557
16375
|
description?: string;
|
|
15558
16376
|
/**
|
|
15559
16377
|
* The display name of the property.
|
|
16378
|
+
*
|
|
16379
|
+
* @exampleValue propertyDisplayName
|
|
15560
16380
|
*/
|
|
15561
16381
|
displayName?: string;
|
|
15562
16382
|
/**
|
|
15563
16383
|
* An extended description and/or links to documentation.
|
|
16384
|
+
*
|
|
16385
|
+
* @exampleValue propertyDocumentation
|
|
15564
16386
|
*/
|
|
15565
16387
|
documentation?: string;
|
|
15566
16388
|
/**
|
|
15567
16389
|
* Defines if value is allowed to be modified when secret properties are not
|
|
16390
|
+
*
|
|
16391
|
+
* @exampleValue true
|
|
15568
16392
|
*/
|
|
15569
16393
|
forceSecretResubmission?: boolean;
|
|
15570
16394
|
/**
|
|
@@ -15587,14 +16411,20 @@ declare interface PropertyDefinition_2 {
|
|
|
15587
16411
|
migrationPattern?: string;
|
|
15588
16412
|
/**
|
|
15589
16413
|
* The minimum number of **objects** in a collection property.
|
|
16414
|
+
*
|
|
16415
|
+
* @exampleValue 1
|
|
15590
16416
|
*/
|
|
15591
16417
|
minObjects?: number;
|
|
15592
16418
|
/**
|
|
15593
16419
|
* Modification policy of the property.
|
|
16420
|
+
*
|
|
16421
|
+
* @exampleValue ALWAYS
|
|
15594
16422
|
*/
|
|
15595
16423
|
modificationPolicy?: 'ALWAYS' | 'DEFAULT' | 'NEVER';
|
|
15596
16424
|
/**
|
|
15597
16425
|
* The value can (`true`) or can't (`false`) be `null`.
|
|
16426
|
+
*
|
|
16427
|
+
* @exampleValue true
|
|
15598
16428
|
*/
|
|
15599
16429
|
nullable: boolean;
|
|
15600
16430
|
/**
|
|
@@ -15603,10 +16433,14 @@ declare interface PropertyDefinition_2 {
|
|
|
15603
16433
|
precondition?: Precondition;
|
|
15604
16434
|
/**
|
|
15605
16435
|
* The type referenced by the property value
|
|
16436
|
+
*
|
|
16437
|
+
* @exampleValue propertyReferencedType
|
|
15606
16438
|
*/
|
|
15607
16439
|
referencedType?: string;
|
|
15608
16440
|
/**
|
|
15609
16441
|
* The subtype of the property's value.
|
|
16442
|
+
*
|
|
16443
|
+
* @exampleValue propertySubType
|
|
15610
16444
|
*/
|
|
15611
16445
|
subType?: string;
|
|
15612
16446
|
/**
|
|
@@ -15781,6 +16615,8 @@ export declare interface ReactNativeMappingFileListDto {
|
|
|
15781
16615
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
15782
16616
|
*
|
|
15783
16617
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
16618
|
+
*
|
|
16619
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
15784
16620
|
*/
|
|
15785
16621
|
nextPageKey?: string;
|
|
15786
16622
|
/**
|
|
@@ -15821,6 +16657,8 @@ export declare interface ReactNativeMappingFileMetadataUpdateDto {
|
|
|
15821
16657
|
export declare interface RefPointer {
|
|
15822
16658
|
/**
|
|
15823
16659
|
* Pointer to a JSON object this object should be logically replaced with.
|
|
16660
|
+
*
|
|
16661
|
+
* @exampleValue refPointerToAnotherJsonObject
|
|
15824
16662
|
*/
|
|
15825
16663
|
$ref: string;
|
|
15826
16664
|
}
|
|
@@ -15976,58 +16814,92 @@ export declare enum RelatedServiceExposure {
|
|
|
15976
16814
|
export declare interface Release {
|
|
15977
16815
|
/**
|
|
15978
16816
|
* The entity has one or more problems
|
|
16817
|
+
*
|
|
16818
|
+
* @exampleValue true
|
|
15979
16819
|
*/
|
|
15980
16820
|
affectedByProblems?: boolean;
|
|
15981
16821
|
/**
|
|
15982
16822
|
* The entity has one or more security vulnerabilities
|
|
16823
|
+
*
|
|
16824
|
+
* @exampleValue true
|
|
15983
16825
|
*/
|
|
15984
16826
|
affectedBySecurityVulnerabilities?: boolean;
|
|
15985
16827
|
/**
|
|
15986
16828
|
* The instances entityIds included in this release
|
|
16829
|
+
*
|
|
16830
|
+
* @exampleValue ["PROCESS_GROUP_INSTANCE-49D94B90FB71C45B","PROCESS_GROUP_INSTANCE-7EA049157C82D1A5"]
|
|
15987
16831
|
*/
|
|
15988
16832
|
instances?: ReleaseInstance[];
|
|
15989
16833
|
/**
|
|
15990
16834
|
* The entity name
|
|
16835
|
+
*
|
|
16836
|
+
* @exampleValue cluster
|
|
15991
16837
|
*/
|
|
15992
16838
|
name?: string;
|
|
15993
16839
|
/**
|
|
15994
16840
|
* The number of problems of the entity
|
|
16841
|
+
*
|
|
16842
|
+
* @exampleValue 4
|
|
16843
|
+
*
|
|
16844
|
+
* @minimum 0
|
|
15995
16845
|
*/
|
|
15996
16846
|
problemCount?: number;
|
|
15997
16847
|
/**
|
|
15998
16848
|
* The product name
|
|
16849
|
+
*
|
|
16850
|
+
* @exampleValue Sockshop
|
|
15999
16851
|
*/
|
|
16000
16852
|
product?: string;
|
|
16001
16853
|
/**
|
|
16002
16854
|
* The entity id of correlating release.
|
|
16855
|
+
*
|
|
16856
|
+
* @exampleValue PROCESS_GROUP-DFDBAC9CBF104253
|
|
16003
16857
|
*/
|
|
16004
16858
|
releaseEntityId?: string;
|
|
16005
16859
|
/**
|
|
16006
16860
|
* The related PGI is still running/monitored
|
|
16861
|
+
*
|
|
16862
|
+
* @exampleValue true
|
|
16007
16863
|
*/
|
|
16008
16864
|
running?: boolean;
|
|
16009
16865
|
/**
|
|
16010
16866
|
* The number of security vulnerabilities of the entity
|
|
16867
|
+
*
|
|
16868
|
+
* @exampleValue 4
|
|
16869
|
+
*
|
|
16870
|
+
* @minimum 0
|
|
16011
16871
|
*/
|
|
16012
16872
|
securityVulnerabilitiesCount?: number;
|
|
16013
16873
|
/**
|
|
16014
16874
|
* Indicates that the security vulnerabilities feature is enabled
|
|
16875
|
+
*
|
|
16876
|
+
* @exampleValue true
|
|
16015
16877
|
*/
|
|
16016
16878
|
securityVulnerabilitiesEnabled?: boolean;
|
|
16017
16879
|
/**
|
|
16018
16880
|
* The software technologies of the release
|
|
16881
|
+
*
|
|
16882
|
+
* @exampleValue [{"edition":"OpenJDK","technology":"JAVA","verbatimType":"Java","version":"1.8.0_242"}]
|
|
16019
16883
|
*/
|
|
16020
16884
|
softwareTechs?: SoftwareTechs[];
|
|
16021
16885
|
/**
|
|
16022
16886
|
* The stage name
|
|
16887
|
+
*
|
|
16888
|
+
* @exampleValue staging
|
|
16023
16889
|
*/
|
|
16024
16890
|
stage?: string;
|
|
16025
16891
|
/**
|
|
16026
16892
|
* The count of bytes per second of the entity
|
|
16027
|
-
|
|
16893
|
+
*
|
|
16894
|
+
* @exampleValue 923234
|
|
16895
|
+
*
|
|
16896
|
+
* @minimum 0
|
|
16897
|
+
*/
|
|
16028
16898
|
throughput?: number;
|
|
16029
16899
|
/**
|
|
16030
16900
|
* The identified release version
|
|
16901
|
+
*
|
|
16902
|
+
* @exampleValue 1.195.34.12341232423-012342
|
|
16031
16903
|
*/
|
|
16032
16904
|
version?: string;
|
|
16033
16905
|
}
|
|
@@ -16039,18 +16911,26 @@ export declare interface Release {
|
|
|
16039
16911
|
export declare interface ReleaseInstance {
|
|
16040
16912
|
/**
|
|
16041
16913
|
* The build version
|
|
16914
|
+
*
|
|
16915
|
+
* @exampleValue 223005
|
|
16042
16916
|
*/
|
|
16043
16917
|
buildVersion?: string;
|
|
16044
16918
|
/**
|
|
16045
16919
|
* The entity id of the instance.
|
|
16920
|
+
*
|
|
16921
|
+
* @exampleValue PROCESS_GROUP_INSTANCE-DFDBAC9CBF104253
|
|
16046
16922
|
*/
|
|
16047
16923
|
entityId?: string;
|
|
16048
16924
|
/**
|
|
16049
16925
|
* List of event Ids of open problems
|
|
16926
|
+
*
|
|
16927
|
+
* @exampleValue ["573177299181554914_1616573184015V2"]
|
|
16050
16928
|
*/
|
|
16051
16929
|
problems?: string[];
|
|
16052
16930
|
/**
|
|
16053
16931
|
* List of Security vulnerabilities Ids
|
|
16932
|
+
*
|
|
16933
|
+
* @exampleValue ["SNYK-JAVA-COMFASTERXMLJACKSONCORE-1234567"]
|
|
16054
16934
|
*/
|
|
16055
16935
|
securityVulnerabilities?: string[];
|
|
16056
16936
|
}
|
|
@@ -16063,6 +16943,8 @@ export declare interface Releases {
|
|
|
16063
16943
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
16064
16944
|
*
|
|
16065
16945
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
16946
|
+
*
|
|
16947
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
16066
16948
|
*/
|
|
16067
16949
|
nextPageKey?: string;
|
|
16068
16950
|
/**
|
|
@@ -16164,7 +17046,11 @@ export declare class ReleasesClient {
|
|
|
16164
17046
|
*
|
|
16165
17047
|
* If not set, 100 is used.
|
|
16166
17048
|
*/ pageSize?: number;
|
|
16167
|
-
/**
|
|
17049
|
+
/**
|
|
17050
|
+
* Get your Releases (`false`) or a set of demo Releases (`true`).
|
|
17051
|
+
*
|
|
17052
|
+
* @defaultValue false
|
|
17053
|
+
*/ demo?: boolean;
|
|
16168
17054
|
/**
|
|
16169
17055
|
* Defines the scope of the query. Only Releases matching the provided criteria are included in the response.
|
|
16170
17056
|
*
|
|
@@ -16195,6 +17081,8 @@ export declare class ReleasesClient {
|
|
|
16195
17081
|
* * 'traffic': Traffic
|
|
16196
17082
|
*
|
|
16197
17083
|
* If not set, the ascending order sorting for name is applied.
|
|
17084
|
+
*
|
|
17085
|
+
* @defaultValue name
|
|
16198
17086
|
*/ sort?: string;
|
|
16199
17087
|
abortSignal?: AbortSignal_2;
|
|
16200
17088
|
}): Promise<Releases>;
|
|
@@ -16452,6 +17340,8 @@ export declare interface RemediationItemMuteStateChange {
|
|
|
16452
17340
|
muted: boolean;
|
|
16453
17341
|
/**
|
|
16454
17342
|
* The reason for the mute state change.
|
|
17343
|
+
*
|
|
17344
|
+
* @exampleValue IGNORE
|
|
16455
17345
|
*/
|
|
16456
17346
|
reason: 'AFFECTED' | 'CONFIGURATION_NOT_AFFECTED' | 'FALSE_POSITIVE' | 'IGNORE' | 'INITIAL_STATE' | 'OTHER' | 'VULNERABLE_CODE_NOT_IN_USE';
|
|
16457
17347
|
}
|
|
@@ -16767,10 +17657,14 @@ export declare interface RemediationProgressVulnerableComponent {
|
|
|
16767
17657
|
export declare interface RemoteConfigurationManagementEntityValidationError {
|
|
16768
17658
|
/**
|
|
16769
17659
|
* The ID of the entity for which validation failed.
|
|
17660
|
+
*
|
|
17661
|
+
* @exampleValue entityId
|
|
16770
17662
|
*/
|
|
16771
17663
|
entity?: string;
|
|
16772
17664
|
/**
|
|
16773
17665
|
* The reason of entity validation failure.
|
|
17666
|
+
*
|
|
17667
|
+
* @exampleValue ["RUNNING_IN_CONTAINER"]
|
|
16774
17668
|
*/
|
|
16775
17669
|
reasons?: Array<'CLOUD_NATIVE_NOT_SUPPORTED' | 'NOT_ALLOWED_WITH_CLUSTER_ACTIVE_GATE' | 'NOT_CONNECTED' | 'RUNNING_IN_CONTAINER' | 'STANDALONE_NOT_SUPPORTED' | 'VERSION_NOT_SUPPORTED'>;
|
|
16776
17670
|
}
|
|
@@ -16793,10 +17687,14 @@ export declare enum RemoteConfigurationManagementEntityValidationErrorReasonsIte
|
|
|
16793
17687
|
export declare interface RemoteConfigurationManagementJob {
|
|
16794
17688
|
/**
|
|
16795
17689
|
* 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.
|
|
17690
|
+
*
|
|
17691
|
+
* @exampleValue 2020-11-05T08:15:30.144Z
|
|
16796
17692
|
*/
|
|
16797
17693
|
endTime?: string;
|
|
16798
17694
|
/**
|
|
16799
17695
|
* Type of entities modified by remote configuration management.
|
|
17696
|
+
*
|
|
17697
|
+
* @exampleValue ACTIVE_GATE or ONE_AGENT
|
|
16800
17698
|
*/
|
|
16801
17699
|
entityType?: 'ACTIVE_GATE' | 'ONE_AGENT';
|
|
16802
17700
|
/**
|
|
@@ -16805,10 +17703,14 @@ export declare interface RemoteConfigurationManagementJob {
|
|
|
16805
17703
|
failedEntities?: RemoteIdentityOperationFailedEntityDto[];
|
|
16806
17704
|
/**
|
|
16807
17705
|
* The ID of the remote configuration management job.
|
|
17706
|
+
*
|
|
17707
|
+
* @exampleValue 7974003406714390819
|
|
16808
17708
|
*/
|
|
16809
17709
|
id?: string;
|
|
16810
17710
|
/**
|
|
16811
17711
|
* A list of in-progress remote configuration management jobs.
|
|
17712
|
+
*
|
|
17713
|
+
* @exampleValue ["HOST-D454A967666E7970"]
|
|
16812
17714
|
*/
|
|
16813
17715
|
inProgressEntities?: string[];
|
|
16814
17716
|
/**
|
|
@@ -16817,18 +17719,26 @@ export declare interface RemoteConfigurationManagementJob {
|
|
|
16817
17719
|
operations?: RemoteConfigurationManagementOperation[];
|
|
16818
17720
|
/**
|
|
16819
17721
|
* Number of entities that were already processed at the time the response was created.
|
|
17722
|
+
*
|
|
17723
|
+
* @exampleValue 1
|
|
16820
17724
|
*/
|
|
16821
17725
|
processedEntitiesCount?: number;
|
|
16822
17726
|
/**
|
|
16823
17727
|
* Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was started.
|
|
17728
|
+
*
|
|
17729
|
+
* @exampleValue 2020-11-05T08:15:30.144Z
|
|
16824
17730
|
*/
|
|
16825
17731
|
startTime?: string;
|
|
16826
17732
|
/**
|
|
16827
17733
|
* 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.
|
|
17734
|
+
*
|
|
17735
|
+
* @exampleValue 2020-11-05T08:15:30.144Z
|
|
16828
17736
|
*/
|
|
16829
17737
|
timeoutTime?: string;
|
|
16830
17738
|
/**
|
|
16831
17739
|
* Total number of entities to process.
|
|
17740
|
+
*
|
|
17741
|
+
* @exampleValue 1
|
|
16832
17742
|
*/
|
|
16833
17743
|
totalEntitiesCount?: number;
|
|
16834
17744
|
}
|
|
@@ -16859,22 +17769,32 @@ export declare interface RemoteConfigurationManagementJobList {
|
|
|
16859
17769
|
export declare interface RemoteConfigurationManagementJobPreview {
|
|
16860
17770
|
/**
|
|
16861
17771
|
* The number of entities that are currently configured as defined by remote configuration management operation.
|
|
17772
|
+
*
|
|
17773
|
+
* @exampleValue 1
|
|
16862
17774
|
*/
|
|
16863
17775
|
alreadyConfiguredEntitiesCount?: number;
|
|
16864
17776
|
/**
|
|
16865
17777
|
* The attribute which is affected by the operation.
|
|
17778
|
+
*
|
|
17779
|
+
* @exampleValue networkZone
|
|
16866
17780
|
*/
|
|
16867
17781
|
attribute?: 'group' | 'hostGroup' | 'hostProperty' | 'hostTag' | 'networkZone';
|
|
16868
17782
|
/**
|
|
16869
17783
|
* The operation performed on given attribute.
|
|
17784
|
+
*
|
|
17785
|
+
* @exampleValue set
|
|
16870
17786
|
*/
|
|
16871
17787
|
operation?: 'clear' | 'set';
|
|
16872
17788
|
/**
|
|
16873
17789
|
* The number of entities that will be configured as defined by remote configuration management after it is completed.
|
|
17790
|
+
*
|
|
17791
|
+
* @exampleValue 2
|
|
16874
17792
|
*/
|
|
16875
17793
|
targetEntitiesCount?: number;
|
|
16876
17794
|
/**
|
|
16877
17795
|
* The value which should be assigned to given attribute.
|
|
17796
|
+
*
|
|
17797
|
+
* @exampleValue exampleNetworkZoneName
|
|
16878
17798
|
*/
|
|
16879
17799
|
value?: string;
|
|
16880
17800
|
}
|
|
@@ -16908,18 +17828,26 @@ export declare enum RemoteConfigurationManagementJobPreviewOperation {
|
|
|
16908
17828
|
export declare interface RemoteConfigurationManagementJobSummary {
|
|
16909
17829
|
/**
|
|
16910
17830
|
* 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.
|
|
17831
|
+
*
|
|
17832
|
+
* @exampleValue 2020-11-05T08:15:30.144Z
|
|
16911
17833
|
*/
|
|
16912
17834
|
endTime?: string;
|
|
16913
17835
|
/**
|
|
16914
17836
|
* Type of entities modified by remote configuration management.
|
|
17837
|
+
*
|
|
17838
|
+
* @exampleValue ACTIVE_GATE or ONE_AGENT
|
|
16915
17839
|
*/
|
|
16916
17840
|
entityType?: 'ACTIVE_GATE' | 'ONE_AGENT';
|
|
16917
17841
|
/**
|
|
16918
17842
|
* The ID of the remote configuration management job.
|
|
17843
|
+
*
|
|
17844
|
+
* @exampleValue 7974003406714390819
|
|
16919
17845
|
*/
|
|
16920
17846
|
id?: string;
|
|
16921
17847
|
/**
|
|
16922
17848
|
* Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was started.
|
|
17849
|
+
*
|
|
17850
|
+
* @exampleValue 2020-11-05T08:15:30.144Z
|
|
16923
17851
|
*/
|
|
16924
17852
|
startTime?: string;
|
|
16925
17853
|
}
|
|
@@ -16940,14 +17868,20 @@ export declare enum RemoteConfigurationManagementJobSummaryEntityType {
|
|
|
16940
17868
|
export declare interface RemoteConfigurationManagementOperation {
|
|
16941
17869
|
/**
|
|
16942
17870
|
* The attribute which is affected by the operation.
|
|
17871
|
+
*
|
|
17872
|
+
* @exampleValue networkZone
|
|
16943
17873
|
*/
|
|
16944
17874
|
attribute: 'group' | 'hostGroup' | 'hostProperty' | 'hostTag' | 'networkZone';
|
|
16945
17875
|
/**
|
|
16946
17876
|
* The operation performed on given attribute.
|
|
17877
|
+
*
|
|
17878
|
+
* @exampleValue set
|
|
16947
17879
|
*/
|
|
16948
17880
|
operation: 'clear' | 'set';
|
|
16949
17881
|
/**
|
|
16950
17882
|
* The value which should be assigned to given attribute.
|
|
17883
|
+
*
|
|
17884
|
+
* @exampleValue exampleNetworkZoneName
|
|
16951
17885
|
*/
|
|
16952
17886
|
value?: string;
|
|
16953
17887
|
}
|
|
@@ -16958,6 +17892,8 @@ export declare interface RemoteConfigurationManagementOperation {
|
|
|
16958
17892
|
export declare interface RemoteConfigurationManagementOperationActiveGateRequest {
|
|
16959
17893
|
/**
|
|
16960
17894
|
* A list of entities IDs for which remote configuration management is to be executed.
|
|
17895
|
+
*
|
|
17896
|
+
* @exampleValue ["0x2b7c0b02","0x4928065d"]
|
|
16961
17897
|
*/
|
|
16962
17898
|
entities: string[];
|
|
16963
17899
|
/**
|
|
@@ -16985,6 +17921,8 @@ export declare enum RemoteConfigurationManagementOperationAttribute {
|
|
|
16985
17921
|
export declare interface RemoteConfigurationManagementOperationOneAgentRequest {
|
|
16986
17922
|
/**
|
|
16987
17923
|
* A list of entities IDs for which remote configuration management is to be executed.
|
|
17924
|
+
*
|
|
17925
|
+
* @exampleValue ["HOST-D454A967666E7970","HOST-811760CFF2A5E872"]
|
|
16988
17926
|
*/
|
|
16989
17927
|
entities: string[];
|
|
16990
17928
|
/**
|
|
@@ -17009,18 +17947,26 @@ export declare enum RemoteConfigurationManagementOperationOperation {
|
|
|
17009
17947
|
export declare interface RemoteConfigurationManagementOperationValidationError {
|
|
17010
17948
|
/**
|
|
17011
17949
|
* The attribute which is affected by the operation.
|
|
17950
|
+
*
|
|
17951
|
+
* @exampleValue networkZone
|
|
17012
17952
|
*/
|
|
17013
17953
|
attribute?: 'group' | 'hostGroup' | 'hostProperty' | 'hostTag' | 'networkZone';
|
|
17014
17954
|
/**
|
|
17015
17955
|
* The operation performed on given attribute.
|
|
17956
|
+
*
|
|
17957
|
+
* @exampleValue set
|
|
17016
17958
|
*/
|
|
17017
17959
|
operation?: 'clear' | 'set';
|
|
17018
17960
|
/**
|
|
17019
17961
|
* The reason of validation failure.
|
|
17962
|
+
*
|
|
17963
|
+
* @exampleValue Value must not start with a period
|
|
17020
17964
|
*/
|
|
17021
17965
|
reason?: string;
|
|
17022
17966
|
/**
|
|
17023
17967
|
* The value which should be assigned to given attribute.
|
|
17968
|
+
*
|
|
17969
|
+
* @exampleValue .exampleInvalidNetworkZoneName
|
|
17024
17970
|
*/
|
|
17025
17971
|
value?: string;
|
|
17026
17972
|
}
|
|
@@ -17082,14 +18028,20 @@ export declare class RemoteConfigurationManagementValidationResultError extends
|
|
|
17082
18028
|
export declare interface RemoteIdentityOperationFailedEntityDto {
|
|
17083
18029
|
/**
|
|
17084
18030
|
* Entity ID for which remote configuration management request was failed
|
|
18031
|
+
*
|
|
18032
|
+
* @exampleValue HOST-D454A967666E7970
|
|
17085
18033
|
*/
|
|
17086
18034
|
entityId?: string;
|
|
17087
18035
|
/**
|
|
17088
18036
|
* Communication settings changing failure error description
|
|
18037
|
+
*
|
|
18038
|
+
* @exampleValue Failed to access new tenant: f47ac10b-58cc-4372-a567-0e02b2c3d479
|
|
17089
18039
|
*/
|
|
17090
18040
|
failureMessage?: string;
|
|
17091
18041
|
/**
|
|
17092
18042
|
* Reason of communication settings changing failure.
|
|
18043
|
+
*
|
|
18044
|
+
* @exampleValue CONNECTION_FAILURE
|
|
17093
18045
|
*/
|
|
17094
18046
|
failureReason?: 'CONNECTION_FAILURE' | 'TIMEOUT';
|
|
17095
18047
|
}
|
|
@@ -17276,6 +18228,8 @@ export declare interface RevisionDiff {
|
|
|
17276
18228
|
export declare interface RevisionDiffPage {
|
|
17277
18229
|
/**
|
|
17278
18230
|
* The 'to' time in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') from the original request.
|
|
18231
|
+
*
|
|
18232
|
+
* @exampleValue 2024-06-24T01:02:03Z
|
|
17279
18233
|
*/
|
|
17280
18234
|
endTime: string;
|
|
17281
18235
|
/**
|
|
@@ -17286,6 +18240,8 @@ export declare interface RevisionDiffPage {
|
|
|
17286
18240
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
17287
18241
|
*
|
|
17288
18242
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
18243
|
+
*
|
|
18244
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
17289
18245
|
*/
|
|
17290
18246
|
nextPageKey?: string;
|
|
17291
18247
|
/**
|
|
@@ -17294,6 +18250,8 @@ export declare interface RevisionDiffPage {
|
|
|
17294
18250
|
pageSize: number;
|
|
17295
18251
|
/**
|
|
17296
18252
|
* The 'from' time in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') from the original request.
|
|
18253
|
+
*
|
|
18254
|
+
* @exampleValue 2024-06-10T01:02:03Z
|
|
17297
18255
|
*/
|
|
17298
18256
|
startTime: string;
|
|
17299
18257
|
}
|
|
@@ -17917,6 +18875,8 @@ export declare const rumManualInsertionTagsClient: RumManualInsertionTagsClient;
|
|
|
17917
18875
|
export declare interface SchemaConstraintRestDto {
|
|
17918
18876
|
/**
|
|
17919
18877
|
* The maximum allowed size in bytes for the sum over all persisted values for the schema
|
|
18878
|
+
*
|
|
18879
|
+
* @exampleValue 500000
|
|
17920
18880
|
*/
|
|
17921
18881
|
byteLimit?: number;
|
|
17922
18882
|
/**
|
|
@@ -17925,6 +18885,8 @@ export declare interface SchemaConstraintRestDto {
|
|
|
17925
18885
|
customMessage?: string;
|
|
17926
18886
|
/**
|
|
17927
18887
|
* The ID of a custom validator.
|
|
18888
|
+
*
|
|
18889
|
+
* @exampleValue my-min-max
|
|
17928
18890
|
*/
|
|
17929
18891
|
customValidatorId?: string;
|
|
17930
18892
|
/**
|
|
@@ -17933,6 +18895,8 @@ export declare interface SchemaConstraintRestDto {
|
|
|
17933
18895
|
flattenCollections?: boolean;
|
|
17934
18896
|
/**
|
|
17935
18897
|
* Whether to skip validation on a change made from the UI.
|
|
18898
|
+
*
|
|
18899
|
+
* @exampleValue false
|
|
17936
18900
|
*/
|
|
17937
18901
|
skipAsyncValidation?: boolean;
|
|
17938
18902
|
/**
|
|
@@ -17941,6 +18905,8 @@ export declare interface SchemaConstraintRestDto {
|
|
|
17941
18905
|
type: 'BYTE_SIZE_LIMIT' | 'CUSTOM_VALIDATOR_REF' | 'MULTI_SCOPE_CUSTOM_VALIDATOR_REF' | 'MULTI_SCOPE_UNIQUE' | 'UNIQUE' | 'UNKNOWN';
|
|
17942
18906
|
/**
|
|
17943
18907
|
* The list of properties for which the combination of values needs to be unique
|
|
18908
|
+
*
|
|
18909
|
+
* @exampleValue ["my-prop-1","my-prop-2"]
|
|
17944
18910
|
*/
|
|
17945
18911
|
uniqueProperties?: string[];
|
|
17946
18912
|
}
|
|
@@ -17962,6 +18928,8 @@ export declare enum SchemaConstraintRestDtoType {
|
|
|
17962
18928
|
export declare interface SchemaDefinitionRestDto {
|
|
17963
18929
|
/**
|
|
17964
18930
|
* A list of scopes where the schema can be used.
|
|
18931
|
+
*
|
|
18932
|
+
* @exampleValue ["host","application"]
|
|
17965
18933
|
*/
|
|
17966
18934
|
allowedScopes: string[];
|
|
17967
18935
|
/**
|
|
@@ -17974,10 +18942,14 @@ export declare interface SchemaDefinitionRestDto {
|
|
|
17974
18942
|
deletionConstraints?: DeletionConstraint[];
|
|
17975
18943
|
/**
|
|
17976
18944
|
* A short description of the schema.
|
|
18945
|
+
*
|
|
18946
|
+
* @exampleValue Dynatrace disables monitoring of containers that do not run any applications
|
|
17977
18947
|
*/
|
|
17978
18948
|
description: string;
|
|
17979
18949
|
/**
|
|
17980
18950
|
* The display name of the schema.
|
|
18951
|
+
*
|
|
18952
|
+
* @exampleValue Built-in container monitoring rules
|
|
17981
18953
|
*/
|
|
17982
18954
|
displayName: string;
|
|
17983
18955
|
/**
|
|
@@ -17986,6 +18958,8 @@ export declare interface SchemaDefinitionRestDto {
|
|
|
17986
18958
|
documentation?: string;
|
|
17987
18959
|
/**
|
|
17988
18960
|
* The version of the data format.
|
|
18961
|
+
*
|
|
18962
|
+
* @exampleValue 1
|
|
17989
18963
|
*/
|
|
17990
18964
|
dynatrace: string;
|
|
17991
18965
|
/**
|
|
@@ -17994,6 +18968,8 @@ export declare interface SchemaDefinitionRestDto {
|
|
|
17994
18968
|
enums: SchemaDefinitionRestDtoEnums;
|
|
17995
18969
|
/**
|
|
17996
18970
|
* Name of the key property in this schema.
|
|
18971
|
+
*
|
|
18972
|
+
* @exampleValue keyProperty
|
|
17997
18973
|
*/
|
|
17998
18974
|
keyProperty?: string;
|
|
17999
18975
|
/**
|
|
@@ -18004,12 +18980,16 @@ export declare interface SchemaDefinitionRestDto {
|
|
|
18004
18980
|
* - 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.
|
|
18005
18981
|
*
|
|
18006
18982
|
* In any case, automations should make use of the `schemaVersion` field when writing settings objects.
|
|
18983
|
+
*
|
|
18984
|
+
* @exampleValue GENERAL_AVAILABILITY
|
|
18007
18985
|
*/
|
|
18008
18986
|
maturity?: 'EARLY_ADOPTER' | 'GENERAL_AVAILABILITY' | 'PREVIEW';
|
|
18009
18987
|
/**
|
|
18010
18988
|
* The maximum amount of objects per scope.
|
|
18011
18989
|
*
|
|
18012
18990
|
* Only applicable when **multiObject** is set to `true`.
|
|
18991
|
+
*
|
|
18992
|
+
* @exampleValue 10
|
|
18013
18993
|
*/
|
|
18014
18994
|
maxObjects: number;
|
|
18015
18995
|
/**
|
|
@@ -18036,10 +19016,14 @@ export declare interface SchemaDefinitionRestDto {
|
|
|
18036
19016
|
schemaConstraints?: SchemaConstraintRestDto[];
|
|
18037
19017
|
/**
|
|
18038
19018
|
* Names of the groups, which the schema belongs to.
|
|
19019
|
+
*
|
|
19020
|
+
* @exampleValue ["group:some.1","group:some.2"]
|
|
18039
19021
|
*/
|
|
18040
19022
|
schemaGroups?: string[];
|
|
18041
19023
|
/**
|
|
18042
19024
|
* The ID of the schema.
|
|
19025
|
+
*
|
|
19026
|
+
* @exampleValue builtin:container.built-in-monitoring-rule
|
|
18043
19027
|
*/
|
|
18044
19028
|
schemaId: string;
|
|
18045
19029
|
/**
|
|
@@ -18058,6 +19042,8 @@ export declare interface SchemaDefinitionRestDto {
|
|
|
18058
19042
|
uiCustomization?: UiCustomization;
|
|
18059
19043
|
/**
|
|
18060
19044
|
* The version of the schema.
|
|
19045
|
+
*
|
|
19046
|
+
* @exampleValue 1.4.2
|
|
18061
19047
|
*/
|
|
18062
19048
|
version: string;
|
|
18063
19049
|
}
|
|
@@ -18133,6 +19119,8 @@ export declare interface SchemaList {
|
|
|
18133
19119
|
items: SchemaStub[];
|
|
18134
19120
|
/**
|
|
18135
19121
|
* The number of schemas in the list.
|
|
19122
|
+
*
|
|
19123
|
+
* @exampleValue 1
|
|
18136
19124
|
*/
|
|
18137
19125
|
totalCount: number;
|
|
18138
19126
|
}
|
|
@@ -18150,10 +19138,14 @@ export declare interface SchemasList {
|
|
|
18150
19138
|
export declare interface SchemaStub {
|
|
18151
19139
|
/**
|
|
18152
19140
|
* The name of the schema.
|
|
19141
|
+
*
|
|
19142
|
+
* @exampleValue Built-in container monitoring rules
|
|
18153
19143
|
*/
|
|
18154
19144
|
displayName?: string;
|
|
18155
19145
|
/**
|
|
18156
19146
|
* The most recent version of the schema.
|
|
19147
|
+
*
|
|
19148
|
+
* @exampleValue 1.4.2
|
|
18157
19149
|
*/
|
|
18158
19150
|
latestSchemaVersion?: string;
|
|
18159
19151
|
/**
|
|
@@ -18164,22 +19156,32 @@ export declare interface SchemaStub {
|
|
|
18164
19156
|
* - 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.
|
|
18165
19157
|
*
|
|
18166
19158
|
* In any case, automations should make use of the `schemaVersion` field when writing settings objects.
|
|
19159
|
+
*
|
|
19160
|
+
* @exampleValue GENERAL_AVAILABILITY
|
|
18167
19161
|
*/
|
|
18168
19162
|
maturity?: 'EARLY_ADOPTER' | 'GENERAL_AVAILABILITY' | 'PREVIEW';
|
|
18169
19163
|
/**
|
|
18170
19164
|
* Multi-object flag. `True` if the schema is a multi-object schema
|
|
19165
|
+
*
|
|
19166
|
+
* @exampleValue true
|
|
18171
19167
|
*/
|
|
18172
19168
|
multiObject?: boolean;
|
|
18173
19169
|
/**
|
|
18174
19170
|
* Ordered flag. `True` if the schema is an ordered multi-object schema.
|
|
19171
|
+
*
|
|
19172
|
+
* @exampleValue false
|
|
18175
19173
|
*/
|
|
18176
19174
|
ordered?: boolean;
|
|
18177
19175
|
/**
|
|
18178
19176
|
* Owner based access control flag. `True` if the schema has owner based access control enabled.
|
|
19177
|
+
*
|
|
19178
|
+
* @exampleValue true
|
|
18179
19179
|
*/
|
|
18180
19180
|
ownerBasedAccessControl?: boolean;
|
|
18181
19181
|
/**
|
|
18182
19182
|
* The ID of the schema.
|
|
19183
|
+
*
|
|
19184
|
+
* @exampleValue builtin:container.built-in-monitoring-rule
|
|
18183
19185
|
*/
|
|
18184
19186
|
schemaId?: string;
|
|
18185
19187
|
}
|
|
@@ -18213,14 +19215,20 @@ export declare interface SchemaType {
|
|
|
18213
19215
|
constraints?: ComplexConstraint[];
|
|
18214
19216
|
/**
|
|
18215
19217
|
* A short description of the property.
|
|
19218
|
+
*
|
|
19219
|
+
* @exampleValue typeDescription
|
|
18216
19220
|
*/
|
|
18217
19221
|
description: string;
|
|
18218
19222
|
/**
|
|
18219
19223
|
* The display name of the property.
|
|
19224
|
+
*
|
|
19225
|
+
* @exampleValue typeDisplayName
|
|
18220
19226
|
*/
|
|
18221
19227
|
displayName?: string;
|
|
18222
19228
|
/**
|
|
18223
19229
|
* An extended description and/or links to documentation.
|
|
19230
|
+
*
|
|
19231
|
+
* @exampleValue typeDocumentation
|
|
18224
19232
|
*/
|
|
18225
19233
|
documentation: string;
|
|
18226
19234
|
/**
|
|
@@ -18229,22 +19237,32 @@ export declare interface SchemaType {
|
|
|
18229
19237
|
properties: SchemaTypeProperties;
|
|
18230
19238
|
/**
|
|
18231
19239
|
* The pattern for the summary search(for example, "Alert after *X* minutes.") of the configuration in the UI.
|
|
19240
|
+
*
|
|
19241
|
+
* @exampleValue searchPatternOfType
|
|
18232
19242
|
*/
|
|
18233
19243
|
searchPattern?: string;
|
|
18234
19244
|
/**
|
|
18235
19245
|
* The pattern for the summary (for example, "Alert after *X* minutes.") of the configuration in the UI.
|
|
19246
|
+
*
|
|
19247
|
+
* @exampleValue summaryPatternOfType
|
|
18236
19248
|
*/
|
|
18237
19249
|
summaryPattern: string;
|
|
18238
19250
|
/**
|
|
18239
19251
|
* Type of the reference type.
|
|
19252
|
+
*
|
|
19253
|
+
* @exampleValue object
|
|
18240
19254
|
*/
|
|
18241
19255
|
type: 'object';
|
|
18242
19256
|
/**
|
|
18243
19257
|
* The version of the type.
|
|
19258
|
+
*
|
|
19259
|
+
* @exampleValue 0
|
|
18244
19260
|
*/
|
|
18245
19261
|
version: string;
|
|
18246
19262
|
/**
|
|
18247
19263
|
* A short description of the version.
|
|
19264
|
+
*
|
|
19265
|
+
* @exampleValue Added new property
|
|
18248
19266
|
*/
|
|
18249
19267
|
versionInfo?: string;
|
|
18250
19268
|
}
|
|
@@ -18293,7 +19311,7 @@ export declare interface SecurityContextDtoImpl {
|
|
|
18293
19311
|
/**
|
|
18294
19312
|
* 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.
|
|
18295
19313
|
*/
|
|
18296
|
-
securityContext
|
|
19314
|
+
securityContext: string[];
|
|
18297
19315
|
}
|
|
18298
19316
|
|
|
18299
19317
|
/**
|
|
@@ -18654,6 +19672,8 @@ export declare interface SecurityProblemEventsList {
|
|
|
18654
19672
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
18655
19673
|
*
|
|
18656
19674
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
19675
|
+
*
|
|
19676
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
18657
19677
|
*/
|
|
18658
19678
|
nextPageKey?: string;
|
|
18659
19679
|
/**
|
|
@@ -18674,6 +19694,8 @@ export declare interface SecurityProblemList {
|
|
|
18674
19694
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
18675
19695
|
*
|
|
18676
19696
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
19697
|
+
*
|
|
19698
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
18677
19699
|
*/
|
|
18678
19700
|
nextPageKey?: string;
|
|
18679
19701
|
/**
|
|
@@ -19572,6 +20594,8 @@ export declare enum SecurityProblemVulnerabilityType {
|
|
|
19572
20594
|
export declare interface SelectionDto {
|
|
19573
20595
|
/**
|
|
19574
20596
|
* Selection index.
|
|
20597
|
+
*
|
|
20598
|
+
* @minimum 0
|
|
19575
20599
|
*/
|
|
19576
20600
|
index: number;
|
|
19577
20601
|
/**
|
|
@@ -19590,6 +20614,8 @@ export declare interface SelectOptionStepDto extends SyntheticBrowserMonitorStep
|
|
|
19590
20614
|
selections: SelectionDto[];
|
|
19591
20615
|
/**
|
|
19592
20616
|
* Target of Browser Monitor step.
|
|
20617
|
+
*
|
|
20618
|
+
* @exampleValue {"locators":[{"type":"CSS","value":"<img>[id='logoIcon']"},{"type":"CSS","value":"<a>[id='externalSite']"}],"window":"ruxitWin[0]"}
|
|
19593
20619
|
*/
|
|
19594
20620
|
target?: TargetDto;
|
|
19595
20621
|
/**
|
|
@@ -19598,6 +20624,8 @@ export declare interface SelectOptionStepDto extends SyntheticBrowserMonitorStep
|
|
|
19598
20624
|
validationRules?: ValidationRuleDto[];
|
|
19599
20625
|
/**
|
|
19600
20626
|
* Wait condition for Browser Monitor step.
|
|
20627
|
+
*
|
|
20628
|
+
* @exampleValue {"type":"NETWORK"}
|
|
19601
20629
|
*/
|
|
19602
20630
|
waitCondition?: BaseWaitConditionDto;
|
|
19603
20631
|
}
|
|
@@ -19725,6 +20753,8 @@ export declare class ServiceLevelObjectivesClient {
|
|
|
19725
20753
|
* * `-name`: Names in descending order.
|
|
19726
20754
|
*
|
|
19727
20755
|
* If not set, the ascending order is used.
|
|
20756
|
+
*
|
|
20757
|
+
* @defaultValue name
|
|
19728
20758
|
*/ sort?: string;
|
|
19729
20759
|
/**
|
|
19730
20760
|
* The timeframe to calculate the SLO values:
|
|
@@ -19734,10 +20764,18 @@ export declare class ServiceLevelObjectivesClient {
|
|
|
19734
20764
|
*
|
|
19735
20765
|
* If not set, the `CURRENT` value is used.
|
|
19736
20766
|
*/ timeFrame?: 'CURRENT' | 'GTF';
|
|
19737
|
-
/**
|
|
20767
|
+
/**
|
|
20768
|
+
* Get your SLOs (`false`) or a set of demo SLOs (`true`).
|
|
20769
|
+
*
|
|
20770
|
+
* @defaultValue false
|
|
20771
|
+
*/ demo?: boolean;
|
|
19738
20772
|
/** Get your SLOs without them being evaluated (`false`) or with evaluations (`true`) with maximum `pageSize` of 25. */ evaluate?: 'true' | 'false';
|
|
19739
20773
|
/** Get your enabled SLOs (`true`), disabled ones (`false`) or both enabled and disabled ones (`all`). */ enabledSlos?: 'true' | 'false' | 'all';
|
|
19740
|
-
/**
|
|
20774
|
+
/**
|
|
20775
|
+
* Get your global SLOs (`true`) regardless of the selected filter or filter them out (`false`).
|
|
20776
|
+
*
|
|
20777
|
+
* @defaultValue true
|
|
20778
|
+
*/ showGlobalSlos?: boolean;
|
|
19741
20779
|
abortSignal?: AbortSignal_2;
|
|
19742
20780
|
}): Promise<SLOs>;
|
|
19743
20781
|
/**
|
|
@@ -20027,6 +21065,8 @@ export declare const settingsManagementZonesClient: SettingsManagementZonesClien
|
|
|
20027
21065
|
export declare interface SettingsObject {
|
|
20028
21066
|
/**
|
|
20029
21067
|
* The user (identified by a user ID or a public token ID) who performed that most recent modification.
|
|
21068
|
+
*
|
|
21069
|
+
* @exampleValue john.doe@example.com
|
|
20030
21070
|
*/
|
|
20031
21071
|
author?: string;
|
|
20032
21072
|
/**
|
|
@@ -20035,6 +21075,8 @@ export declare interface SettingsObject {
|
|
|
20035
21075
|
created?: number;
|
|
20036
21076
|
/**
|
|
20037
21077
|
* The unique identifier of the user who created the settings object.
|
|
21078
|
+
*
|
|
21079
|
+
* @exampleValue fab17b7a-2eb2-4c95-b818-743d94be2c30
|
|
20038
21080
|
*/
|
|
20039
21081
|
createdBy?: string;
|
|
20040
21082
|
/**
|
|
@@ -20053,10 +21095,14 @@ export declare interface SettingsObject {
|
|
|
20053
21095
|
modified?: number;
|
|
20054
21096
|
/**
|
|
20055
21097
|
* The unique identifier of the user who performed the most recent modification.
|
|
21098
|
+
*
|
|
21099
|
+
* @exampleValue fab17b7a-2eb2-4c95-b818-743d94be2c30
|
|
20056
21100
|
*/
|
|
20057
21101
|
modifiedBy?: string;
|
|
20058
21102
|
/**
|
|
20059
21103
|
* The ID of the settings object.
|
|
21104
|
+
*
|
|
21105
|
+
* @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
|
|
20060
21106
|
*/
|
|
20061
21107
|
objectId?: string;
|
|
20062
21108
|
/**
|
|
@@ -20069,14 +21115,20 @@ export declare interface SettingsObject {
|
|
|
20069
21115
|
resourceContext?: ResourceContext;
|
|
20070
21116
|
/**
|
|
20071
21117
|
* The schema on which the object is based.
|
|
21118
|
+
*
|
|
21119
|
+
* @exampleValue builtin:container.built-in-monitoring-rule
|
|
20072
21120
|
*/
|
|
20073
21121
|
schemaId?: string;
|
|
20074
21122
|
/**
|
|
20075
21123
|
* The version of the schema on which the object is based.
|
|
21124
|
+
*
|
|
21125
|
+
* @exampleValue 1.0.0
|
|
20076
21126
|
*/
|
|
20077
21127
|
schemaVersion?: string;
|
|
20078
21128
|
/**
|
|
20079
21129
|
* The scope that the object targets. For more details, please see [Dynatrace Documentation](https://dt-url.net/ky03459).
|
|
21130
|
+
*
|
|
21131
|
+
* @exampleValue HOST-D3A3C5A146830A79
|
|
20080
21132
|
*/
|
|
20081
21133
|
scope?: string;
|
|
20082
21134
|
/**
|
|
@@ -20093,6 +21145,8 @@ export declare interface SettingsObject {
|
|
|
20093
21145
|
* 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.
|
|
20094
21146
|
*
|
|
20095
21147
|
* If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
|
|
21148
|
+
*
|
|
21149
|
+
* @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
|
|
20096
21150
|
*/
|
|
20097
21151
|
updateToken?: string;
|
|
20098
21152
|
/**
|
|
@@ -20101,6 +21155,8 @@ export declare interface SettingsObject {
|
|
|
20101
21155
|
* It defines the actual values of settings' parameters.
|
|
20102
21156
|
*
|
|
20103
21157
|
* The actual content depends on the object's schema.
|
|
21158
|
+
*
|
|
21159
|
+
* @exampleValue {"autoMonitoring":true}
|
|
20104
21160
|
*/
|
|
20105
21161
|
value?: AnyValue;
|
|
20106
21162
|
}
|
|
@@ -20111,6 +21167,8 @@ export declare interface SettingsObject {
|
|
|
20111
21167
|
export declare interface SettingsObjectByObjectIdResponse {
|
|
20112
21168
|
/**
|
|
20113
21169
|
* The user (identified by a user ID or a public token ID) who performed that most recent modification.
|
|
21170
|
+
*
|
|
21171
|
+
* @exampleValue john.doe@example.com
|
|
20114
21172
|
*/
|
|
20115
21173
|
author?: string;
|
|
20116
21174
|
/**
|
|
@@ -20119,6 +21177,8 @@ export declare interface SettingsObjectByObjectIdResponse {
|
|
|
20119
21177
|
created?: number;
|
|
20120
21178
|
/**
|
|
20121
21179
|
* The unique identifier of the user who created the settings object.
|
|
21180
|
+
*
|
|
21181
|
+
* @exampleValue fab17b7a-2eb2-4c95-b818-743d94be2c30
|
|
20122
21182
|
*/
|
|
20123
21183
|
createdBy?: string;
|
|
20124
21184
|
/**
|
|
@@ -20131,10 +21191,14 @@ export declare interface SettingsObjectByObjectIdResponse {
|
|
|
20131
21191
|
modified?: number;
|
|
20132
21192
|
/**
|
|
20133
21193
|
* The unique identifier of the user who performed the most recent modification.
|
|
21194
|
+
*
|
|
21195
|
+
* @exampleValue fab17b7a-2eb2-4c95-b818-743d94be2c30
|
|
20134
21196
|
*/
|
|
20135
21197
|
modifiedBy?: string;
|
|
20136
21198
|
/**
|
|
20137
21199
|
* The ID of the settings object.
|
|
21200
|
+
*
|
|
21201
|
+
* @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
|
|
20138
21202
|
*/
|
|
20139
21203
|
objectId?: string;
|
|
20140
21204
|
/**
|
|
@@ -20147,14 +21211,20 @@ export declare interface SettingsObjectByObjectIdResponse {
|
|
|
20147
21211
|
resourceContext?: ResourceContext;
|
|
20148
21212
|
/**
|
|
20149
21213
|
* The schema on which the object is based.
|
|
21214
|
+
*
|
|
21215
|
+
* @exampleValue builtin:container.built-in-monitoring-rule
|
|
20150
21216
|
*/
|
|
20151
21217
|
schemaId?: string;
|
|
20152
21218
|
/**
|
|
20153
21219
|
* The version of the schema on which the object is based.
|
|
21220
|
+
*
|
|
21221
|
+
* @exampleValue 1.0.0
|
|
20154
21222
|
*/
|
|
20155
21223
|
schemaVersion?: string;
|
|
20156
21224
|
/**
|
|
20157
21225
|
* The scope that the object targets. For more details, please see [Dynatrace Documentation](https://dt-url.net/ky03459).
|
|
21226
|
+
*
|
|
21227
|
+
* @exampleValue HOST-D3A3C5A146830A79
|
|
20158
21228
|
*/
|
|
20159
21229
|
scope?: string;
|
|
20160
21230
|
/**
|
|
@@ -20171,6 +21241,8 @@ export declare interface SettingsObjectByObjectIdResponse {
|
|
|
20171
21241
|
* 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.
|
|
20172
21242
|
*
|
|
20173
21243
|
* If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
|
|
21244
|
+
*
|
|
21245
|
+
* @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
|
|
20174
21246
|
*/
|
|
20175
21247
|
updateToken?: string;
|
|
20176
21248
|
/**
|
|
@@ -20179,6 +21251,8 @@ export declare interface SettingsObjectByObjectIdResponse {
|
|
|
20179
21251
|
* It defines the actual values of settings' parameters.
|
|
20180
21252
|
*
|
|
20181
21253
|
* The actual content depends on the object's schema.
|
|
21254
|
+
*
|
|
21255
|
+
* @exampleValue {"autoMonitoring":true}
|
|
20182
21256
|
*/
|
|
20183
21257
|
value?: AnyValue;
|
|
20184
21258
|
}
|
|
@@ -20199,24 +21273,34 @@ export declare interface SettingsObjectCreate {
|
|
|
20199
21273
|
* If set to an empty string, the new object will be placed in the first position.
|
|
20200
21274
|
*
|
|
20201
21275
|
* Only applicable for objects based on schemas with ordered objects (schema's `ordered` parameter is set to `true`).
|
|
21276
|
+
*
|
|
21277
|
+
* @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
|
|
20202
21278
|
*/
|
|
20203
21279
|
insertAfter?: string;
|
|
20204
21280
|
/**
|
|
20205
21281
|
* The ID of the settings object that should be replaced.
|
|
20206
21282
|
*
|
|
20207
21283
|
* Only applicable if an external identifier is provided.
|
|
21284
|
+
*
|
|
21285
|
+
* @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
|
|
20208
21286
|
*/
|
|
20209
21287
|
objectId?: string;
|
|
20210
21288
|
/**
|
|
20211
21289
|
* The schema on which the object is based.
|
|
21290
|
+
*
|
|
21291
|
+
* @exampleValue builtin:container.built-in-monitoring-rule
|
|
20212
21292
|
*/
|
|
20213
21293
|
schemaId: string;
|
|
20214
21294
|
/**
|
|
20215
21295
|
* The version of the schema on which the object is based.
|
|
21296
|
+
*
|
|
21297
|
+
* @exampleValue 1.0.0
|
|
20216
21298
|
*/
|
|
20217
21299
|
schemaVersion?: string;
|
|
20218
21300
|
/**
|
|
20219
21301
|
* The scope that the object targets. For more details, please see [Dynatrace Documentation](https://dt-url.net/ky03459).
|
|
21302
|
+
*
|
|
21303
|
+
* @exampleValue HOST-D3A3C5A146830A79
|
|
20220
21304
|
*/
|
|
20221
21305
|
scope: string;
|
|
20222
21306
|
/**
|
|
@@ -20225,6 +21309,8 @@ export declare interface SettingsObjectCreate {
|
|
|
20225
21309
|
* It defines the actual values of settings' parameters.
|
|
20226
21310
|
*
|
|
20227
21311
|
* The actual content depends on the object's schema.
|
|
21312
|
+
*
|
|
21313
|
+
* @exampleValue {"autoMonitoring":true}
|
|
20228
21314
|
*/
|
|
20229
21315
|
value: AnyValue;
|
|
20230
21316
|
}
|
|
@@ -20244,10 +21330,14 @@ export declare interface SettingsObjectResponse {
|
|
|
20244
21330
|
* It defines the actual values of settings' parameters.
|
|
20245
21331
|
*
|
|
20246
21332
|
* The actual content depends on the object's schema.
|
|
21333
|
+
*
|
|
21334
|
+
* @exampleValue {"autoMonitoring":true}
|
|
20247
21335
|
*/
|
|
20248
21336
|
invalidValue?: AnyValue;
|
|
20249
21337
|
/**
|
|
20250
21338
|
* For a successful request, the ID of the created or modified settings object.
|
|
21339
|
+
*
|
|
21340
|
+
* @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
|
|
20251
21341
|
*/
|
|
20252
21342
|
objectId?: string;
|
|
20253
21343
|
}
|
|
@@ -20361,6 +21451,8 @@ export declare class SettingsObjectsClient {
|
|
|
20361
21451
|
* Specify the required top-level fields, separated by commas (for example, `origin,value`).
|
|
20362
21452
|
*
|
|
20363
21453
|
* Supported fields: `summary`, `searchSummary`, `created`, `modified`, `createdBy`, `modifiedBy`, `author`, `origin`, `schemaId`, `schemaVersion`, `value`, `externalId`.
|
|
21454
|
+
*
|
|
21455
|
+
* @defaultValue origin,value
|
|
20364
21456
|
*/ fields?: string;
|
|
20365
21457
|
/**
|
|
20366
21458
|
* The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
|
|
@@ -20376,7 +21468,11 @@ export declare class SettingsObjectsClient {
|
|
|
20376
21468
|
*
|
|
20377
21469
|
* If not set, 100 is used.
|
|
20378
21470
|
*/ pageSize?: number;
|
|
20379
|
-
/**
|
|
21471
|
+
/**
|
|
21472
|
+
* 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
|
|
21473
|
+
*
|
|
21474
|
+
* @defaultValue false
|
|
21475
|
+
*/ adminAccess?: boolean;
|
|
20380
21476
|
abortSignal?: AbortSignal_2;
|
|
20381
21477
|
}): Promise<EffectiveSettingsValuesList>;
|
|
20382
21478
|
/**
|
|
@@ -20439,7 +21535,11 @@ export declare class SettingsObjectsClient {
|
|
|
20439
21535
|
*
|
|
20440
21536
|
* If not set, 100 is used.
|
|
20441
21537
|
*/ pageSize?: number;
|
|
20442
|
-
/**
|
|
21538
|
+
/**
|
|
21539
|
+
* 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
|
|
21540
|
+
*
|
|
21541
|
+
* @defaultValue false
|
|
21542
|
+
*/ adminAccess?: boolean;
|
|
20443
21543
|
abortSignal?: AbortSignal_2;
|
|
20444
21544
|
}): Promise<RevisionDiffPage>;
|
|
20445
21545
|
/**
|
|
@@ -20500,6 +21600,8 @@ export declare class SettingsObjectsClient {
|
|
|
20500
21600
|
* Specify the required top-level fields, separated by commas (for example, `objectId,value`).
|
|
20501
21601
|
*
|
|
20502
21602
|
* Supported fields: `objectId`, `summary`, `searchSummary`, `created`, `modified`, `createdBy`, `modifiedBy`, `author`, `updateToken`, `scope`, `modificationInfo` (deprecated), `resourceContext`, `owner`, `schemaId`, `schemaVersion`, `value`, `externalId`.
|
|
21603
|
+
*
|
|
21604
|
+
* @defaultValue objectId,value
|
|
20503
21605
|
*/ fields?: string;
|
|
20504
21606
|
/**
|
|
20505
21607
|
* The filter parameter, as explained [here](https://dt-url.net/platform-services-filtering).
|
|
@@ -20543,7 +21645,11 @@ export declare class SettingsObjectsClient {
|
|
|
20543
21645
|
*
|
|
20544
21646
|
* If not set, 100 is used.
|
|
20545
21647
|
*/ pageSize?: number;
|
|
20546
|
-
/**
|
|
21648
|
+
/**
|
|
21649
|
+
* 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
|
|
21650
|
+
*
|
|
21651
|
+
* @defaultValue false
|
|
21652
|
+
*/ adminAccess?: boolean;
|
|
20547
21653
|
abortSignal?: AbortSignal_2;
|
|
20548
21654
|
}): Promise<ObjectsList>;
|
|
20549
21655
|
/**
|
|
@@ -20580,8 +21686,16 @@ export declare class SettingsObjectsClient {
|
|
|
20580
21686
|
*/
|
|
20581
21687
|
postSettingsObjects(config: {
|
|
20582
21688
|
body: SettingsObjectCreate[];
|
|
20583
|
-
/**
|
|
20584
|
-
|
|
21689
|
+
/**
|
|
21690
|
+
* If `true`, the request runs only validation of the submitted settings objects, without saving them.
|
|
21691
|
+
*
|
|
21692
|
+
* @defaultValue false
|
|
21693
|
+
*/ validateOnly?: boolean;
|
|
21694
|
+
/**
|
|
21695
|
+
* 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
|
|
21696
|
+
*
|
|
21697
|
+
* @defaultValue false
|
|
21698
|
+
*/ adminAccess?: boolean;
|
|
20585
21699
|
abortSignal?: AbortSignal_2;
|
|
20586
21700
|
}): Promise<SettingsObjectResponse[]>;
|
|
20587
21701
|
/**
|
|
@@ -20608,7 +21722,11 @@ export declare class SettingsObjectsClient {
|
|
|
20608
21722
|
*/
|
|
20609
21723
|
getSettingsObjectByObjectId(config: {
|
|
20610
21724
|
/** The ID of the required settings object. */ objectId: string;
|
|
20611
|
-
/**
|
|
21725
|
+
/**
|
|
21726
|
+
* 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
|
|
21727
|
+
*
|
|
21728
|
+
* @defaultValue false
|
|
21729
|
+
*/ adminAccess?: boolean;
|
|
20612
21730
|
abortSignal?: AbortSignal_2;
|
|
20613
21731
|
}): Promise<SettingsObjectByObjectIdResponse>;
|
|
20614
21732
|
/**
|
|
@@ -20642,8 +21760,16 @@ export declare class SettingsObjectsClient {
|
|
|
20642
21760
|
putSettingsObjectByObjectId(config: {
|
|
20643
21761
|
body: SettingsObjectUpdate;
|
|
20644
21762
|
/** The ID of the required settings object. */ objectId: string;
|
|
20645
|
-
/**
|
|
20646
|
-
|
|
21763
|
+
/**
|
|
21764
|
+
* If `true`, the request runs only validation of the submitted settings object, without saving it.
|
|
21765
|
+
*
|
|
21766
|
+
* @defaultValue false
|
|
21767
|
+
*/ validateOnly?: boolean;
|
|
21768
|
+
/**
|
|
21769
|
+
* 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
|
|
21770
|
+
*
|
|
21771
|
+
* @defaultValue false
|
|
21772
|
+
*/ adminAccess?: boolean;
|
|
20647
21773
|
abortSignal?: AbortSignal_2;
|
|
20648
21774
|
}): Promise<SettingsObjectResponse>;
|
|
20649
21775
|
/**
|
|
@@ -20676,7 +21802,11 @@ export declare class SettingsObjectsClient {
|
|
|
20676
21802
|
*
|
|
20677
21803
|
* If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
|
|
20678
21804
|
*/ updateToken?: string;
|
|
20679
|
-
/**
|
|
21805
|
+
/**
|
|
21806
|
+
* 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
|
|
21807
|
+
*
|
|
21808
|
+
* @defaultValue false
|
|
21809
|
+
*/ adminAccess?: boolean;
|
|
20680
21810
|
abortSignal?: AbortSignal_2;
|
|
20681
21811
|
}): Promise<void>;
|
|
20682
21812
|
/**
|
|
@@ -20700,7 +21830,11 @@ export declare class SettingsObjectsClient {
|
|
|
20700
21830
|
*/
|
|
20701
21831
|
getPermissions(config: {
|
|
20702
21832
|
/** The ID of the required settings object. */ objectId: string;
|
|
20703
|
-
/**
|
|
21833
|
+
/**
|
|
21834
|
+
* 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
|
|
21835
|
+
*
|
|
21836
|
+
* @defaultValue false
|
|
21837
|
+
*/ adminAccess?: boolean;
|
|
20704
21838
|
abortSignal?: AbortSignal_2;
|
|
20705
21839
|
}): Promise<AccessorPermissionsList>;
|
|
20706
21840
|
/**
|
|
@@ -20726,7 +21860,11 @@ export declare class SettingsObjectsClient {
|
|
|
20726
21860
|
addPermission(config: {
|
|
20727
21861
|
body: AccessorPermissions;
|
|
20728
21862
|
/** The ID of the required settings object. */ objectId: string;
|
|
20729
|
-
/**
|
|
21863
|
+
/**
|
|
21864
|
+
* 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
|
|
21865
|
+
*
|
|
21866
|
+
* @defaultValue false
|
|
21867
|
+
*/ adminAccess?: boolean;
|
|
20730
21868
|
abortSignal?: AbortSignal_2;
|
|
20731
21869
|
}): Promise<AccessorPermissions>;
|
|
20732
21870
|
/**
|
|
@@ -20751,7 +21889,11 @@ export declare class SettingsObjectsClient {
|
|
|
20751
21889
|
*/
|
|
20752
21890
|
getPermissionAllUsers(config: {
|
|
20753
21891
|
/** The ID of the required settings object. */ objectId: string;
|
|
20754
|
-
/**
|
|
21892
|
+
/**
|
|
21893
|
+
* 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
|
|
21894
|
+
*
|
|
21895
|
+
* @defaultValue false
|
|
21896
|
+
*/ adminAccess?: boolean;
|
|
20755
21897
|
abortSignal?: AbortSignal_2;
|
|
20756
21898
|
}): Promise<AccessorPermissions>;
|
|
20757
21899
|
/**
|
|
@@ -20776,7 +21918,11 @@ export declare class SettingsObjectsClient {
|
|
|
20776
21918
|
updatePermissionAllUsers(config: {
|
|
20777
21919
|
body: UpdatePermissionsRequest;
|
|
20778
21920
|
/** The ID of the required settings object. */ objectId: string;
|
|
20779
|
-
/**
|
|
21921
|
+
/**
|
|
21922
|
+
* 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
|
|
21923
|
+
*
|
|
21924
|
+
* @defaultValue false
|
|
21925
|
+
*/ adminAccess?: boolean;
|
|
20780
21926
|
abortSignal?: AbortSignal_2;
|
|
20781
21927
|
}): Promise<void>;
|
|
20782
21928
|
/**
|
|
@@ -20799,7 +21945,11 @@ export declare class SettingsObjectsClient {
|
|
|
20799
21945
|
*/
|
|
20800
21946
|
removePermissionAllUsers(config: {
|
|
20801
21947
|
/** The ID of the required settings object. */ objectId: string;
|
|
20802
|
-
/**
|
|
21948
|
+
/**
|
|
21949
|
+
* 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
|
|
21950
|
+
*
|
|
21951
|
+
* @defaultValue false
|
|
21952
|
+
*/ adminAccess?: boolean;
|
|
20803
21953
|
abortSignal?: AbortSignal_2;
|
|
20804
21954
|
}): Promise<void>;
|
|
20805
21955
|
/**
|
|
@@ -20827,7 +21977,11 @@ export declare class SettingsObjectsClient {
|
|
|
20827
21977
|
/** The ID of the required settings object. */ objectId: string;
|
|
20828
21978
|
/** The type of the accessor. */ accessorType: 'group' | 'user';
|
|
20829
21979
|
/** The user uuid or group uuid of the accessor, depending on the type. */ accessorId: string;
|
|
20830
|
-
/**
|
|
21980
|
+
/**
|
|
21981
|
+
* 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
|
|
21982
|
+
*
|
|
21983
|
+
* @defaultValue false
|
|
21984
|
+
*/ adminAccess?: boolean;
|
|
20831
21985
|
abortSignal?: AbortSignal_2;
|
|
20832
21986
|
}): Promise<AccessorPermissions>;
|
|
20833
21987
|
/**
|
|
@@ -20855,7 +22009,11 @@ export declare class SettingsObjectsClient {
|
|
|
20855
22009
|
/** The ID of the required settings object. */ objectId: string;
|
|
20856
22010
|
/** The type of the accessor. */ accessorType: 'group' | 'user';
|
|
20857
22011
|
/** The user uuid or group uuid of the accessor, depending on the type. */ accessorId: string;
|
|
20858
|
-
/**
|
|
22012
|
+
/**
|
|
22013
|
+
* 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
|
|
22014
|
+
*
|
|
22015
|
+
* @defaultValue false
|
|
22016
|
+
*/ adminAccess?: boolean;
|
|
20859
22017
|
abortSignal?: AbortSignal_2;
|
|
20860
22018
|
}): Promise<void>;
|
|
20861
22019
|
/**
|
|
@@ -20881,7 +22039,11 @@ export declare class SettingsObjectsClient {
|
|
|
20881
22039
|
/** The ID of the required settings object. */ objectId: string;
|
|
20882
22040
|
/** The type of the accessor. */ accessorType: 'group' | 'user';
|
|
20883
22041
|
/** The user uuid or group uuid of the accessor, depending on the type. */ accessorId: string;
|
|
20884
|
-
/**
|
|
22042
|
+
/**
|
|
22043
|
+
* 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
|
|
22044
|
+
*
|
|
22045
|
+
* @defaultValue false
|
|
22046
|
+
*/ adminAccess?: boolean;
|
|
20885
22047
|
abortSignal?: AbortSignal_2;
|
|
20886
22048
|
}): Promise<void>;
|
|
20887
22049
|
/**
|
|
@@ -20905,7 +22067,11 @@ export declare class SettingsObjectsClient {
|
|
|
20905
22067
|
transferOwnership(config: {
|
|
20906
22068
|
body: TransferOwnershipRequest;
|
|
20907
22069
|
/** The ID of the required settings object. */ objectId: string;
|
|
20908
|
-
/**
|
|
22070
|
+
/**
|
|
22071
|
+
* 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
|
|
22072
|
+
*
|
|
22073
|
+
* @defaultValue false
|
|
22074
|
+
*/ adminAccess?: boolean;
|
|
20909
22075
|
abortSignal?: AbortSignal_2;
|
|
20910
22076
|
}): Promise<void>;
|
|
20911
22077
|
}
|
|
@@ -20926,6 +22092,8 @@ export declare interface SettingsObjectUpdate {
|
|
|
20926
22092
|
* If set to an empty string, the updated object will be placed in the first position.
|
|
20927
22093
|
*
|
|
20928
22094
|
* Only applicable for objects based on schemas with ordered objects (schema's **ordered** parameter is set to `true`).
|
|
22095
|
+
*
|
|
22096
|
+
* @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
|
|
20929
22097
|
*/
|
|
20930
22098
|
insertAfter?: string;
|
|
20931
22099
|
/**
|
|
@@ -20938,10 +22106,14 @@ export declare interface SettingsObjectUpdate {
|
|
|
20938
22106
|
* If set to an empty string, the updated object will be placed in the last position.
|
|
20939
22107
|
*
|
|
20940
22108
|
* Only applicable for objects based on schemas with ordered objects (schema's **ordered** parameter is set to `true`).
|
|
22109
|
+
*
|
|
22110
|
+
* @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
|
|
20941
22111
|
*/
|
|
20942
22112
|
insertBefore?: string;
|
|
20943
22113
|
/**
|
|
20944
22114
|
* The version of the schema on which the object is based.
|
|
22115
|
+
*
|
|
22116
|
+
* @exampleValue 1.0.0
|
|
20945
22117
|
*/
|
|
20946
22118
|
schemaVersion?: string;
|
|
20947
22119
|
/**
|
|
@@ -20950,6 +22122,8 @@ export declare interface SettingsObjectUpdate {
|
|
|
20950
22122
|
* 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.
|
|
20951
22123
|
*
|
|
20952
22124
|
* If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
|
|
22125
|
+
*
|
|
22126
|
+
* @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
|
|
20953
22127
|
*/
|
|
20954
22128
|
updateToken?: string;
|
|
20955
22129
|
/**
|
|
@@ -20958,6 +22132,8 @@ export declare interface SettingsObjectUpdate {
|
|
|
20958
22132
|
* It defines the actual values of settings' parameters.
|
|
20959
22133
|
*
|
|
20960
22134
|
* The actual content depends on the object's schema.
|
|
22135
|
+
*
|
|
22136
|
+
* @exampleValue {"autoMonitoring":true}
|
|
20961
22137
|
*/
|
|
20962
22138
|
value: AnyValue;
|
|
20963
22139
|
}
|
|
@@ -21002,6 +22178,8 @@ export declare class SettingsSchemasClient {
|
|
|
21002
22178
|
* Specify the required top-level fields, separated by commas (for example, `schemaId,displayName`).
|
|
21003
22179
|
*
|
|
21004
22180
|
* Supported fields: `schemaId`, `displayName`, `maturity`, `latestSchemaVersion`, `multiObject`, `ordered`, `ownerBasedAccessControl`.
|
|
22181
|
+
*
|
|
22182
|
+
* @defaultValue schemaId,displayName,latestSchemaVersion
|
|
21005
22183
|
*/ fields?: string;
|
|
21006
22184
|
abortSignal?: AbortSignal_2;
|
|
21007
22185
|
}): Promise<SchemaList>;
|
|
@@ -21050,6 +22228,8 @@ export declare interface SinglePermissionRequest {
|
|
|
21050
22228
|
context?: PermissionContext;
|
|
21051
22229
|
/**
|
|
21052
22230
|
* Permission to be probed
|
|
22231
|
+
*
|
|
22232
|
+
* @exampleValue settings:objects:write
|
|
21053
22233
|
*/
|
|
21054
22234
|
permission: string;
|
|
21055
22235
|
}
|
|
@@ -21060,26 +22240,36 @@ export declare interface SinglePermissionRequest {
|
|
|
21060
22240
|
export declare interface SLO {
|
|
21061
22241
|
/**
|
|
21062
22242
|
* The key for the SLO's error budget burn rate func metric.
|
|
22243
|
+
*
|
|
22244
|
+
* @exampleValue func:slo.errorBudgetBurnRate.payment_service_availability
|
|
21063
22245
|
*/
|
|
21064
22246
|
burnRateMetricKey: string;
|
|
21065
22247
|
/**
|
|
21066
22248
|
* The denominator value used to evaluate the SLO when **useRateMetric** is set to `false`.
|
|
21067
22249
|
*
|
|
22250
|
+
* @exampleValue 90
|
|
22251
|
+
*
|
|
21068
22252
|
* @deprecated
|
|
21069
22253
|
*/
|
|
21070
22254
|
denominatorValue?: number;
|
|
21071
22255
|
/**
|
|
21072
22256
|
* A short description of the SLO.
|
|
22257
|
+
*
|
|
22258
|
+
* @exampleValue Rate of successful payments per week
|
|
21073
22259
|
*/
|
|
21074
22260
|
description?: string;
|
|
21075
22261
|
/**
|
|
21076
22262
|
* The SLO is enabled (`true`) or disabled (`false`).
|
|
22263
|
+
*
|
|
22264
|
+
* @exampleValue true
|
|
21077
22265
|
*/
|
|
21078
22266
|
enabled: boolean;
|
|
21079
22267
|
/**
|
|
21080
22268
|
* The error of the SLO calculation.
|
|
21081
22269
|
*
|
|
21082
22270
|
* If the value differs from `NONE`, there is something wrong with the SLO calculation.
|
|
22271
|
+
*
|
|
22272
|
+
* @exampleValue NONE
|
|
21083
22273
|
*/
|
|
21084
22274
|
error: string;
|
|
21085
22275
|
/**
|
|
@@ -21091,6 +22281,8 @@ export declare interface SLO {
|
|
|
21091
22281
|
*
|
|
21092
22282
|
* * If there is an error with the SLO calculation; in that case check the value of the **error** property.
|
|
21093
22283
|
* * If the evaluate parameter has not been set to `true`; in that case the **error** property will contain no error.
|
|
22284
|
+
*
|
|
22285
|
+
* @exampleValue 1.25
|
|
21094
22286
|
*/
|
|
21095
22287
|
errorBudget: number;
|
|
21096
22288
|
/**
|
|
@@ -21099,6 +22291,8 @@ export declare interface SLO {
|
|
|
21099
22291
|
errorBudgetBurnRate: SloBurnRate;
|
|
21100
22292
|
/**
|
|
21101
22293
|
* The key for the SLO's error budget func metric.
|
|
22294
|
+
*
|
|
22295
|
+
* @exampleValue func:slo.errorBudget.payment_service_availability
|
|
21102
22296
|
*/
|
|
21103
22297
|
errorBudgetMetricKey: string;
|
|
21104
22298
|
/**
|
|
@@ -21106,18 +22300,26 @@ export declare interface SLO {
|
|
|
21106
22300
|
*
|
|
21107
22301
|
* * If there is an error with the SLO calculation; in that case check the value of the **error** property.
|
|
21108
22302
|
* * If the evaluate parameter has not been set to `true`; in that case the **error** property will contain no error.
|
|
22303
|
+
*
|
|
22304
|
+
* @exampleValue 96.25
|
|
21109
22305
|
*/
|
|
21110
22306
|
evaluatedPercentage: number;
|
|
21111
22307
|
/**
|
|
21112
22308
|
* The evaluation type of the SLO.
|
|
22309
|
+
*
|
|
22310
|
+
* @exampleValue AGGREGATE
|
|
21113
22311
|
*/
|
|
21114
22312
|
evaluationType: 'AGGREGATE';
|
|
21115
22313
|
/**
|
|
21116
22314
|
* 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).
|
|
22315
|
+
*
|
|
22316
|
+
* @exampleValue type("SERVICE")
|
|
21117
22317
|
*/
|
|
21118
22318
|
filter: string;
|
|
21119
22319
|
/**
|
|
21120
22320
|
* The ID of the SLO
|
|
22321
|
+
*
|
|
22322
|
+
* @exampleValue 123e4567-e89b-42d3-a456-556642440000
|
|
21121
22323
|
*/
|
|
21122
22324
|
id: string;
|
|
21123
22325
|
/**
|
|
@@ -21125,19 +22327,27 @@ export declare interface SLO {
|
|
|
21125
22327
|
*
|
|
21126
22328
|
* Required when the **useRateMetric** is set to `false`.
|
|
21127
22329
|
*
|
|
22330
|
+
* @exampleValue builtin:service.requestCount.server
|
|
22331
|
+
*
|
|
21128
22332
|
* @deprecated
|
|
21129
22333
|
*/
|
|
21130
22334
|
metricDenominator?: string;
|
|
21131
22335
|
/**
|
|
21132
22336
|
* The percentage-based metric expression for the calculation of the SLO.
|
|
22337
|
+
*
|
|
22338
|
+
* @exampleValue (100)*(builtin:service.errors.server.successCount:splitBy())/(builtin:service.requestCount.server:splitBy())
|
|
21133
22339
|
*/
|
|
21134
22340
|
metricExpression: string;
|
|
21135
22341
|
/**
|
|
21136
22342
|
* The key for the SLO's status func metric.
|
|
22343
|
+
*
|
|
22344
|
+
* @exampleValue func:slo.payment_service_availability
|
|
21137
22345
|
*/
|
|
21138
22346
|
metricKey: string;
|
|
21139
22347
|
/**
|
|
21140
22348
|
* The name that is used to create SLO func metrics keys. Once created, metric name cannot be changed.
|
|
22349
|
+
*
|
|
22350
|
+
* @exampleValue payment_service_availability
|
|
21141
22351
|
*/
|
|
21142
22352
|
metricName: string;
|
|
21143
22353
|
/**
|
|
@@ -21145,6 +22355,8 @@ export declare interface SLO {
|
|
|
21145
22355
|
*
|
|
21146
22356
|
* Required when the **useRateMetric** is set to `false`.
|
|
21147
22357
|
*
|
|
22358
|
+
* @exampleValue builtin:service.errors.server.successCount
|
|
22359
|
+
*
|
|
21148
22360
|
* @deprecated
|
|
21149
22361
|
*/
|
|
21150
22362
|
metricNumerator?: string;
|
|
@@ -21153,26 +22365,36 @@ export declare interface SLO {
|
|
|
21153
22365
|
*
|
|
21154
22366
|
* Required when the **useRateMetric** is set to `true`.
|
|
21155
22367
|
*
|
|
22368
|
+
* @exampleValue builtin:service.successes.server.rate
|
|
22369
|
+
*
|
|
21156
22370
|
* @deprecated
|
|
21157
22371
|
*/
|
|
21158
22372
|
metricRate?: string;
|
|
21159
22373
|
/**
|
|
21160
22374
|
* The name of the SLO.
|
|
22375
|
+
*
|
|
22376
|
+
* @exampleValue Payment service availability
|
|
21161
22377
|
*/
|
|
21162
22378
|
name: string;
|
|
21163
22379
|
/**
|
|
21164
22380
|
* The key for the SLO's normalized error budget func metric.
|
|
22381
|
+
*
|
|
22382
|
+
* @exampleValue func:slo.normalizedErrorBudget.payment_service_availability
|
|
21165
22383
|
*/
|
|
21166
22384
|
normalizedErrorBudgetMetricKey: string;
|
|
21167
22385
|
/**
|
|
21168
22386
|
* The numerator value used to evaluate the SLO when **useRateMetric** is set to `false`.
|
|
21169
22387
|
*
|
|
22388
|
+
* @exampleValue 80
|
|
22389
|
+
*
|
|
21170
22390
|
* @deprecated
|
|
21171
22391
|
*/
|
|
21172
22392
|
numeratorValue?: number;
|
|
21173
22393
|
/**
|
|
21174
22394
|
* 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.
|
|
21175
22395
|
*
|
|
22396
|
+
* @exampleValue [type("SERVICE")]
|
|
22397
|
+
*
|
|
21176
22398
|
* @deprecated
|
|
21177
22399
|
*/
|
|
21178
22400
|
problemFilters?: string[];
|
|
@@ -21190,14 +22412,20 @@ export declare interface SLO {
|
|
|
21190
22412
|
relatedTotalProblems?: number;
|
|
21191
22413
|
/**
|
|
21192
22414
|
* The status of the calculated SLO.
|
|
22415
|
+
*
|
|
22416
|
+
* @exampleValue WARNING
|
|
21193
22417
|
*/
|
|
21194
22418
|
status: 'FAILURE' | 'SUCCESS' | 'WARNING';
|
|
21195
22419
|
/**
|
|
21196
22420
|
* The target value of the SLO.
|
|
22421
|
+
*
|
|
22422
|
+
* @exampleValue 95
|
|
21197
22423
|
*/
|
|
21198
22424
|
target: number;
|
|
21199
22425
|
/**
|
|
21200
22426
|
* The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector.
|
|
22427
|
+
*
|
|
22428
|
+
* @exampleValue -1d
|
|
21201
22429
|
*/
|
|
21202
22430
|
timeframe: string;
|
|
21203
22431
|
/**
|
|
@@ -21208,6 +22436,8 @@ export declare interface SLO {
|
|
|
21208
22436
|
*
|
|
21209
22437
|
* 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.
|
|
21210
22438
|
*
|
|
22439
|
+
* @exampleValue true
|
|
22440
|
+
*
|
|
21211
22441
|
* @deprecated
|
|
21212
22442
|
*/
|
|
21213
22443
|
useRateMetric?: boolean;
|
|
@@ -21215,6 +22445,8 @@ export declare interface SLO {
|
|
|
21215
22445
|
* The warning value of the SLO.
|
|
21216
22446
|
*
|
|
21217
22447
|
* At warning state the SLO is still fulfilled but is getting close to failure.
|
|
22448
|
+
*
|
|
22449
|
+
* @exampleValue 97.5
|
|
21218
22450
|
*/
|
|
21219
22451
|
warning: number;
|
|
21220
22452
|
}
|
|
@@ -21227,28 +22459,40 @@ export declare interface SloBurnRate {
|
|
|
21227
22459
|
* The calculated burn rate type.
|
|
21228
22460
|
*
|
|
21229
22461
|
* Has a value of 'FAST', 'SLOW' or 'NONE'.
|
|
22462
|
+
*
|
|
22463
|
+
* @exampleValue SLOW
|
|
21230
22464
|
*/
|
|
21231
22465
|
burnRateType?: 'FAST' | 'NONE' | 'SLOW';
|
|
21232
22466
|
/**
|
|
21233
22467
|
* The burn rate of the SLO, calculated for the last hour.
|
|
22468
|
+
*
|
|
22469
|
+
* @exampleValue 1.25
|
|
21234
22470
|
*/
|
|
21235
22471
|
burnRateValue?: number;
|
|
21236
22472
|
/**
|
|
21237
22473
|
* The error budget burn rate calculation is enabled (`true`) or disabled (`false`).
|
|
21238
22474
|
*
|
|
21239
22475
|
* In case of `false`, no calculated values will be present here.
|
|
22476
|
+
*
|
|
22477
|
+
* @exampleValue true
|
|
21240
22478
|
*/
|
|
21241
22479
|
burnRateVisualizationEnabled: boolean;
|
|
21242
22480
|
/**
|
|
21243
22481
|
* The estimated time left to consume the error budget in hours.
|
|
22482
|
+
*
|
|
22483
|
+
* @exampleValue 24
|
|
21244
22484
|
*/
|
|
21245
22485
|
estimatedTimeToConsumeErrorBudget?: number;
|
|
21246
22486
|
/**
|
|
21247
22487
|
* The threshold between a slow and a fast burn rate.
|
|
22488
|
+
*
|
|
22489
|
+
* @exampleValue 1.5
|
|
21248
22490
|
*/
|
|
21249
22491
|
fastBurnThreshold?: number;
|
|
21250
22492
|
/**
|
|
21251
22493
|
* The calculated value of the SLO for the timeframe chosen for the burn rate calculation.
|
|
22494
|
+
*
|
|
22495
|
+
* @exampleValue 95
|
|
21252
22496
|
*/
|
|
21253
22497
|
sloValue?: number;
|
|
21254
22498
|
}
|
|
@@ -21276,10 +22520,14 @@ export declare interface SloBurnRateConfig {
|
|
|
21276
22520
|
* In case of `false`, no calculated values will be present here.
|
|
21277
22521
|
*
|
|
21278
22522
|
* If not defined, the error budget burn rate calculation is disabled by default.
|
|
22523
|
+
*
|
|
22524
|
+
* @exampleValue true
|
|
21279
22525
|
*/
|
|
21280
22526
|
burnRateVisualizationEnabled?: boolean;
|
|
21281
22527
|
/**
|
|
21282
22528
|
* The threshold between a slow and a fast burn rate.
|
|
22529
|
+
*
|
|
22530
|
+
* @exampleValue 1.5
|
|
21283
22531
|
*/
|
|
21284
22532
|
fastBurnThreshold?: number;
|
|
21285
22533
|
}
|
|
@@ -21287,12 +22535,16 @@ export declare interface SloBurnRateConfig {
|
|
|
21287
22535
|
export declare interface SloConfigItemDtoImpl {
|
|
21288
22536
|
/**
|
|
21289
22537
|
* The description of the SLO.
|
|
22538
|
+
*
|
|
22539
|
+
* @exampleValue Rate of successful payments per week
|
|
21290
22540
|
*/
|
|
21291
22541
|
description?: string;
|
|
21292
22542
|
/**
|
|
21293
22543
|
* The SLO is enabled (`true`) or disabled (`false`).
|
|
21294
22544
|
*
|
|
21295
22545
|
* If not defined, the SLO is disabled by default.
|
|
22546
|
+
*
|
|
22547
|
+
* @exampleValue true
|
|
21296
22548
|
*/
|
|
21297
22549
|
enabled?: boolean;
|
|
21298
22550
|
/**
|
|
@@ -21301,10 +22553,14 @@ export declare interface SloConfigItemDtoImpl {
|
|
|
21301
22553
|
errorBudgetBurnRate?: SloBurnRateConfig;
|
|
21302
22554
|
/**
|
|
21303
22555
|
* The evaluation type of the SLO.
|
|
22556
|
+
*
|
|
22557
|
+
* @exampleValue AGGREGATE
|
|
21304
22558
|
*/
|
|
21305
22559
|
evaluationType: 'AGGREGATE';
|
|
21306
22560
|
/**
|
|
21307
22561
|
* 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).
|
|
22562
|
+
*
|
|
22563
|
+
* @exampleValue type("SERVICE")
|
|
21308
22564
|
*/
|
|
21309
22565
|
filter?: string;
|
|
21310
22566
|
/**
|
|
@@ -21312,15 +22568,21 @@ export declare interface SloConfigItemDtoImpl {
|
|
|
21312
22568
|
*
|
|
21313
22569
|
* Required when the **useRateMetric** is set to `false`.
|
|
21314
22570
|
*
|
|
22571
|
+
* @exampleValue builtin:service.requestCount.server
|
|
22572
|
+
*
|
|
21315
22573
|
* @deprecated
|
|
21316
22574
|
*/
|
|
21317
22575
|
metricDenominator?: string;
|
|
21318
22576
|
/**
|
|
21319
22577
|
* The percentage-based metric expression for the calculation of the SLO.
|
|
22578
|
+
*
|
|
22579
|
+
* @exampleValue (100)*(builtin:service.errors.server.successCount:splitBy())/(builtin:service.requestCount.server:splitBy())
|
|
21320
22580
|
*/
|
|
21321
22581
|
metricExpression?: string;
|
|
21322
22582
|
/**
|
|
21323
22583
|
* The name that is used to create SLO func metrics keys. Once created, metric name cannot be changed.
|
|
22584
|
+
*
|
|
22585
|
+
* @exampleValue payment_service_availability
|
|
21324
22586
|
*/
|
|
21325
22587
|
metricName?: string;
|
|
21326
22588
|
/**
|
|
@@ -21328,6 +22590,8 @@ export declare interface SloConfigItemDtoImpl {
|
|
|
21328
22590
|
*
|
|
21329
22591
|
* Required when the **useRateMetric** is set to `false`.
|
|
21330
22592
|
*
|
|
22593
|
+
* @exampleValue builtin:service.errors.server.successCount
|
|
22594
|
+
*
|
|
21331
22595
|
* @deprecated
|
|
21332
22596
|
*/
|
|
21333
22597
|
metricNumerator?: string;
|
|
@@ -21336,19 +22600,27 @@ export declare interface SloConfigItemDtoImpl {
|
|
|
21336
22600
|
*
|
|
21337
22601
|
* Required when the **useRateMetric** is set to `true`.
|
|
21338
22602
|
*
|
|
22603
|
+
* @exampleValue builtin:service.successes.server.rate
|
|
22604
|
+
*
|
|
21339
22605
|
* @deprecated
|
|
21340
22606
|
*/
|
|
21341
22607
|
metricRate?: string;
|
|
21342
22608
|
/**
|
|
21343
22609
|
* The name of the SLO.
|
|
22610
|
+
*
|
|
22611
|
+
* @exampleValue Payment service availability
|
|
21344
22612
|
*/
|
|
21345
22613
|
name: string;
|
|
21346
22614
|
/**
|
|
21347
22615
|
* The target value of the SLO.
|
|
22616
|
+
*
|
|
22617
|
+
* @exampleValue 95
|
|
21348
22618
|
*/
|
|
21349
22619
|
target: number;
|
|
21350
22620
|
/**
|
|
21351
22621
|
* The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector.
|
|
22622
|
+
*
|
|
22623
|
+
* @exampleValue -1d
|
|
21352
22624
|
*/
|
|
21353
22625
|
timeframe: string;
|
|
21354
22626
|
/**
|
|
@@ -21359,6 +22631,8 @@ export declare interface SloConfigItemDtoImpl {
|
|
|
21359
22631
|
*
|
|
21360
22632
|
* 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.
|
|
21361
22633
|
*
|
|
22634
|
+
* @exampleValue true
|
|
22635
|
+
*
|
|
21362
22636
|
* @deprecated
|
|
21363
22637
|
*/
|
|
21364
22638
|
useRateMetric?: boolean | null;
|
|
@@ -21366,6 +22640,8 @@ export declare interface SloConfigItemDtoImpl {
|
|
|
21366
22640
|
* The warning value of the SLO.
|
|
21367
22641
|
*
|
|
21368
22642
|
* At warning state the SLO is still fulfilled but is getting close to failure.
|
|
22643
|
+
*
|
|
22644
|
+
* @exampleValue 97.5
|
|
21369
22645
|
*/
|
|
21370
22646
|
warning: number;
|
|
21371
22647
|
}
|
|
@@ -21396,6 +22672,8 @@ export declare interface SLOs {
|
|
|
21396
22672
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
21397
22673
|
*
|
|
21398
22674
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
22675
|
+
*
|
|
22676
|
+
* @exampleValue AQAAABQBAAAABQ==
|
|
21399
22677
|
*/
|
|
21400
22678
|
nextPageKey?: string;
|
|
21401
22679
|
/**
|
|
@@ -21459,18 +22737,26 @@ export declare interface SNMPV3Credentials extends Credentials {
|
|
|
21459
22737
|
export declare interface SoftwareTechs {
|
|
21460
22738
|
/**
|
|
21461
22739
|
* The edition of the technology.
|
|
22740
|
+
*
|
|
22741
|
+
* @exampleValue OpenJDK
|
|
21462
22742
|
*/
|
|
21463
22743
|
edition?: string;
|
|
21464
22744
|
/**
|
|
21465
22745
|
* The type of the technology.
|
|
22746
|
+
*
|
|
22747
|
+
* @exampleValue JAVA
|
|
21466
22748
|
*/
|
|
21467
22749
|
technology?: string;
|
|
21468
22750
|
/**
|
|
21469
22751
|
* The verbatim type of the technology.
|
|
22752
|
+
*
|
|
22753
|
+
* @exampleValue Java
|
|
21470
22754
|
*/
|
|
21471
22755
|
verbatimType?: string;
|
|
21472
22756
|
/**
|
|
21473
22757
|
* The version of the technology.
|
|
22758
|
+
*
|
|
22759
|
+
* @exampleValue 11.0.10
|
|
21474
22760
|
*/
|
|
21475
22761
|
version?: string;
|
|
21476
22762
|
}
|
|
@@ -21596,6 +22882,8 @@ export declare interface SyntheticBrowserMonitorRequest {
|
|
|
21596
22882
|
description?: string;
|
|
21597
22883
|
/**
|
|
21598
22884
|
* If true, the monitor is enabled.
|
|
22885
|
+
*
|
|
22886
|
+
* @defaultValue true
|
|
21599
22887
|
*/
|
|
21600
22888
|
enabled?: boolean;
|
|
21601
22889
|
/**
|
|
@@ -21626,16 +22914,14 @@ export declare interface SyntheticBrowserMonitorRequest {
|
|
|
21626
22914
|
* Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed.
|
|
21627
22915
|
*/
|
|
21628
22916
|
primaryGrailTags?: SyntheticMonitorPrimaryGrailTagDto[];
|
|
21629
|
-
/**
|
|
21630
|
-
* [FEATURE DISABLED] Security context as a list of strings. Up to 10 values, max 200 characters per value. Those fields are only available for SaaS and not for Managed.
|
|
21631
|
-
*/
|
|
21632
|
-
securityContext?: string[];
|
|
21633
22917
|
/**
|
|
21634
22918
|
* The steps of the monitor.
|
|
21635
22919
|
*/
|
|
21636
22920
|
steps: SyntheticBrowserMonitorStepDto[];
|
|
21637
22921
|
/**
|
|
21638
22922
|
* Outage handling configuration.
|
|
22923
|
+
*
|
|
22924
|
+
* @exampleValue {"globalConsecutiveOutageCountThreshold":"1","globalOutages":"true","localConsecutiveOutageCountThreshold":"3","localLocationOutageCountThreshold":"3","localOutages":"true"}
|
|
21639
22925
|
*/
|
|
21640
22926
|
syntheticMonitorOutageHandlingSettings?: SyntheticMonitorOutageHandlingSettingsDto;
|
|
21641
22927
|
/**
|
|
@@ -21717,16 +23003,14 @@ export declare interface SyntheticBrowserMonitorResponse {
|
|
|
21717
23003
|
* Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed.
|
|
21718
23004
|
*/
|
|
21719
23005
|
primaryGrailTags?: SyntheticMonitorPrimaryGrailTagDto[];
|
|
21720
|
-
/**
|
|
21721
|
-
* [FEATURE DISABLED] Security context as a list of strings. Up to 10 values, max 200 characters per value. Those fields are only available for SaaS and not for Managed.
|
|
21722
|
-
*/
|
|
21723
|
-
securityContext?: string[];
|
|
21724
23006
|
/**
|
|
21725
23007
|
* The steps of the monitor.
|
|
21726
23008
|
*/
|
|
21727
23009
|
steps: SyntheticBrowserMonitorStepDto[];
|
|
21728
23010
|
/**
|
|
21729
23011
|
* Outage handling configuration.
|
|
23012
|
+
*
|
|
23013
|
+
* @exampleValue {"globalConsecutiveOutageCountThreshold":"1","globalOutages":"true","localConsecutiveOutageCountThreshold":"3","localLocationOutageCountThreshold":"3","localOutages":"true"}
|
|
21730
23014
|
*/
|
|
21731
23015
|
syntheticMonitorOutageHandlingSettings: SyntheticMonitorOutageHandlingSettingsDto;
|
|
21732
23016
|
/**
|
|
@@ -21738,7 +23022,7 @@ export declare interface SyntheticBrowserMonitorResponse {
|
|
|
21738
23022
|
/**
|
|
21739
23023
|
* Monitor type.
|
|
21740
23024
|
*/
|
|
21741
|
-
type: 'MULTI_PROTOCOL' | 'BROWSER';
|
|
23025
|
+
type: 'MULTI_PROTOCOL' | 'BROWSER' | 'HTTP';
|
|
21742
23026
|
}
|
|
21743
23027
|
|
|
21744
23028
|
/**
|
|
@@ -21748,7 +23032,8 @@ export declare interface SyntheticBrowserMonitorResponse {
|
|
|
21748
23032
|
*/
|
|
21749
23033
|
export declare enum SyntheticBrowserMonitorResponseType {
|
|
21750
23034
|
MultiProtocol = "MULTI_PROTOCOL",
|
|
21751
|
-
Browser = "BROWSER"
|
|
23035
|
+
Browser = "BROWSER",
|
|
23036
|
+
Http = "HTTP"
|
|
21752
23037
|
}
|
|
21753
23038
|
|
|
21754
23039
|
/**
|
|
@@ -21806,10 +23091,14 @@ export declare enum SyntheticBrowserMonitorStepDtoType {
|
|
|
21806
23091
|
export declare interface SyntheticConfigDto {
|
|
21807
23092
|
/**
|
|
21808
23093
|
* bmMonitorTimeout - browser monitor execution timeout (ms)
|
|
23094
|
+
*
|
|
23095
|
+
* @minimum 60000
|
|
21809
23096
|
*/
|
|
21810
23097
|
bmMonitorTimeout: number;
|
|
21811
23098
|
/**
|
|
21812
23099
|
* bmStepTimeout - browser monitor single step execution timeout (ms)
|
|
23100
|
+
*
|
|
23101
|
+
* @minimum 10000
|
|
21813
23102
|
*/
|
|
21814
23103
|
bmStepTimeout: number;
|
|
21815
23104
|
}
|
|
@@ -21853,6 +23142,8 @@ export declare enum SyntheticHttpAuthenticationDtoType {
|
|
|
21853
23142
|
export declare interface SyntheticHttpConfigurationDto {
|
|
21854
23143
|
/**
|
|
21855
23144
|
* If true accept any certificate flag.
|
|
23145
|
+
*
|
|
23146
|
+
* @defaultValue true
|
|
21856
23147
|
*/
|
|
21857
23148
|
acceptAnyCertificate?: boolean;
|
|
21858
23149
|
/**
|
|
@@ -21861,10 +23152,14 @@ export declare interface SyntheticHttpConfigurationDto {
|
|
|
21861
23152
|
clientCertificateId?: string;
|
|
21862
23153
|
/**
|
|
21863
23154
|
* If true the step's data aren't stored and displayed.
|
|
23155
|
+
*
|
|
23156
|
+
* @defaultValue false
|
|
21864
23157
|
*/
|
|
21865
23158
|
doNotPersistSensitiveData?: boolean;
|
|
21866
23159
|
/**
|
|
21867
23160
|
* If true follow redirects.
|
|
23161
|
+
*
|
|
23162
|
+
* @defaultValue false
|
|
21868
23163
|
*/
|
|
21869
23164
|
followRedirects?: boolean;
|
|
21870
23165
|
/**
|
|
@@ -21981,6 +23276,8 @@ export declare interface SyntheticHttpMonitorRequest {
|
|
|
21981
23276
|
description?: string;
|
|
21982
23277
|
/**
|
|
21983
23278
|
* If true, the monitor is enabled.
|
|
23279
|
+
*
|
|
23280
|
+
* @defaultValue true
|
|
21984
23281
|
*/
|
|
21985
23282
|
enabled?: boolean;
|
|
21986
23283
|
/**
|
|
@@ -22007,16 +23304,14 @@ export declare interface SyntheticHttpMonitorRequest {
|
|
|
22007
23304
|
* Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed.
|
|
22008
23305
|
*/
|
|
22009
23306
|
primaryGrailTags?: SyntheticMonitorPrimaryGrailTagDto[];
|
|
22010
|
-
/**
|
|
22011
|
-
* [FEATURE DISABLED] Security context as a list of strings. Up to 10 values, max 200 characters per value. Those fields are only available for SaaS and not for Managed.
|
|
22012
|
-
*/
|
|
22013
|
-
securityContext?: string[];
|
|
22014
23307
|
/**
|
|
22015
23308
|
* The steps of the monitor.
|
|
22016
23309
|
*/
|
|
22017
23310
|
steps: SyntheticHttpMonitorStepDto[];
|
|
22018
23311
|
/**
|
|
22019
23312
|
* Outage handling configuration.
|
|
23313
|
+
*
|
|
23314
|
+
* @exampleValue {"globalConsecutiveOutageCountThreshold":"1","globalOutages":"true","localConsecutiveOutageCountThreshold":"3","localLocationOutageCountThreshold":"3","localOutages":"true"}
|
|
22020
23315
|
*/
|
|
22021
23316
|
syntheticMonitorOutageHandlingSettings?: SyntheticMonitorOutageHandlingSettingsDto;
|
|
22022
23317
|
/**
|
|
@@ -22098,16 +23393,14 @@ export declare interface SyntheticHttpMonitorResponse {
|
|
|
22098
23393
|
* Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed.
|
|
22099
23394
|
*/
|
|
22100
23395
|
primaryGrailTags?: SyntheticMonitorPrimaryGrailTagDto[];
|
|
22101
|
-
/**
|
|
22102
|
-
* [FEATURE DISABLED] Security context as a list of strings. Up to 10 values, max 200 characters per value. Those fields are only available for SaaS and not for Managed.
|
|
22103
|
-
*/
|
|
22104
|
-
securityContext?: string[];
|
|
22105
23396
|
/**
|
|
22106
23397
|
* The steps of the monitor.
|
|
22107
23398
|
*/
|
|
22108
23399
|
steps: SyntheticHttpMonitorStepDto[];
|
|
22109
23400
|
/**
|
|
22110
23401
|
* Outage handling configuration.
|
|
23402
|
+
*
|
|
23403
|
+
* @exampleValue {"globalConsecutiveOutageCountThreshold":"1","globalOutages":"true","localConsecutiveOutageCountThreshold":"3","localLocationOutageCountThreshold":"3","localOutages":"true"}
|
|
22111
23404
|
*/
|
|
22112
23405
|
syntheticMonitorOutageHandlingSettings: SyntheticMonitorOutageHandlingSettingsDto;
|
|
22113
23406
|
/**
|
|
@@ -22119,7 +23412,7 @@ export declare interface SyntheticHttpMonitorResponse {
|
|
|
22119
23412
|
/**
|
|
22120
23413
|
* Monitor type.
|
|
22121
23414
|
*/
|
|
22122
|
-
type: 'MULTI_PROTOCOL' | 'BROWSER';
|
|
23415
|
+
type: 'MULTI_PROTOCOL' | 'BROWSER' | 'HTTP';
|
|
22123
23416
|
}
|
|
22124
23417
|
|
|
22125
23418
|
/**
|
|
@@ -22129,7 +23422,8 @@ export declare interface SyntheticHttpMonitorResponse {
|
|
|
22129
23422
|
*/
|
|
22130
23423
|
export declare enum SyntheticHttpMonitorResponseType {
|
|
22131
23424
|
MultiProtocol = "MULTI_PROTOCOL",
|
|
22132
|
-
Browser = "BROWSER"
|
|
23425
|
+
Browser = "BROWSER",
|
|
23426
|
+
Http = "HTTP"
|
|
22133
23427
|
}
|
|
22134
23428
|
|
|
22135
23429
|
/**
|
|
@@ -22783,6 +24077,8 @@ export declare interface SyntheticMonitorConstraintDto {
|
|
|
22783
24077
|
properties: SyntheticMonitorConstraintDtoProperties;
|
|
22784
24078
|
/**
|
|
22785
24079
|
* 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).
|
|
24080
|
+
*
|
|
24081
|
+
* @exampleValue ICMP_SUCCESS_RATE_PERCENT
|
|
22786
24082
|
*/
|
|
22787
24083
|
type: string;
|
|
22788
24084
|
}
|
|
@@ -22878,30 +24174,42 @@ export declare enum SyntheticMonitorOutageHandlingSettingsDtoOrigin {
|
|
|
22878
24174
|
export declare interface SyntheticMonitorPerformanceThresholdDto {
|
|
22879
24175
|
/**
|
|
22880
24176
|
* Aggregation type
|
|
24177
|
+
*
|
|
24178
|
+
* @defaultValue AVG
|
|
22881
24179
|
*/
|
|
22882
24180
|
aggregation?: 'AVG' | 'MAX' | 'MIN';
|
|
22883
24181
|
/**
|
|
22884
24182
|
* Number of most recent non-violating request executions that closes the problem.
|
|
24183
|
+
*
|
|
24184
|
+
* @minimum 1
|
|
22885
24185
|
*/
|
|
22886
24186
|
dealertingSamples?: number;
|
|
22887
24187
|
/**
|
|
22888
24188
|
* Number of request executions in analyzed sliding window (sliding window size).
|
|
24189
|
+
*
|
|
24190
|
+
* @minimum 1
|
|
22889
24191
|
*/
|
|
22890
24192
|
samples?: number;
|
|
22891
24193
|
/**
|
|
22892
24194
|
* Specify the step's index to which a threshold applies. If threshold is monitor-level, no index is needed.
|
|
24195
|
+
*
|
|
24196
|
+
* @minimum 0
|
|
22893
24197
|
*/
|
|
22894
24198
|
stepIndex?: number;
|
|
22895
24199
|
/**
|
|
22896
24200
|
* 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.
|
|
24201
|
+
*
|
|
24202
|
+
* @minimum 0
|
|
22897
24203
|
*/
|
|
22898
24204
|
threshold: number;
|
|
22899
24205
|
/**
|
|
22900
|
-
* Type of performance threshold
|
|
24206
|
+
* Type of performance threshold
|
|
22901
24207
|
*/
|
|
22902
|
-
type?: '
|
|
24208
|
+
type?: 'STEP' | 'MONITOR';
|
|
22903
24209
|
/**
|
|
22904
24210
|
* Number of violating request executions in analyzed sliding window.
|
|
24211
|
+
*
|
|
24212
|
+
* @minimum 1
|
|
22905
24213
|
*/
|
|
22906
24214
|
violatingSamples?: number;
|
|
22907
24215
|
}
|
|
@@ -22918,13 +24226,13 @@ export declare enum SyntheticMonitorPerformanceThresholdDtoAggregation {
|
|
|
22918
24226
|
}
|
|
22919
24227
|
|
|
22920
24228
|
/**
|
|
22921
|
-
* Type of performance threshold
|
|
24229
|
+
* Type of performance threshold
|
|
22922
24230
|
*
|
|
22923
24231
|
* @deprecated Use literal values.
|
|
22924
24232
|
*/
|
|
22925
24233
|
export declare enum SyntheticMonitorPerformanceThresholdDtoType {
|
|
22926
|
-
|
|
22927
|
-
|
|
24234
|
+
Step = "STEP",
|
|
24235
|
+
Monitor = "MONITOR"
|
|
22928
24236
|
}
|
|
22929
24237
|
|
|
22930
24238
|
/**
|
|
@@ -22970,18 +24278,22 @@ export declare interface SyntheticMonitorSummaryDto {
|
|
|
22970
24278
|
/**
|
|
22971
24279
|
* The name of the monitor.
|
|
22972
24280
|
*/
|
|
22973
|
-
name
|
|
22974
|
-
|
|
24281
|
+
name?: string;
|
|
24282
|
+
/**
|
|
24283
|
+
* The type of the monitor.
|
|
24284
|
+
*/
|
|
24285
|
+
type: 'MULTI_PROTOCOL' | 'BROWSER' | 'HTTP';
|
|
22975
24286
|
}
|
|
22976
24287
|
|
|
22977
24288
|
/**
|
|
24289
|
+
* The type of the monitor.
|
|
24290
|
+
*
|
|
22978
24291
|
* @deprecated Use literal values.
|
|
22979
24292
|
*/
|
|
22980
24293
|
export declare enum SyntheticMonitorSummaryDtoType {
|
|
22981
|
-
Browser = "BROWSER",
|
|
22982
|
-
Http = "HTTP",
|
|
22983
24294
|
MultiProtocol = "MULTI_PROTOCOL",
|
|
22984
|
-
|
|
24295
|
+
Browser = "BROWSER",
|
|
24296
|
+
Http = "HTTP"
|
|
22985
24297
|
}
|
|
22986
24298
|
|
|
22987
24299
|
/**
|
|
@@ -22994,6 +24306,8 @@ export declare interface SyntheticMultiProtocolMonitorRequest {
|
|
|
22994
24306
|
description?: string;
|
|
22995
24307
|
/**
|
|
22996
24308
|
* If true, the monitor is enabled.
|
|
24309
|
+
*
|
|
24310
|
+
* @defaultValue true
|
|
22997
24311
|
*/
|
|
22998
24312
|
enabled?: boolean;
|
|
22999
24313
|
/**
|
|
@@ -23016,16 +24330,14 @@ export declare interface SyntheticMultiProtocolMonitorRequest {
|
|
|
23016
24330
|
* Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed.
|
|
23017
24331
|
*/
|
|
23018
24332
|
primaryGrailTags?: SyntheticMonitorPrimaryGrailTagDto[];
|
|
23019
|
-
/**
|
|
23020
|
-
* [FEATURE DISABLED] Security context as a list of strings. Up to 10 values, max 200 characters per value. Those fields are only available for SaaS and not for Managed.
|
|
23021
|
-
*/
|
|
23022
|
-
securityContext?: string[];
|
|
23023
24333
|
/**
|
|
23024
24334
|
* The steps of the monitor.
|
|
23025
24335
|
*/
|
|
23026
24336
|
steps: SyntheticMultiProtocolMonitorStepDto[];
|
|
23027
24337
|
/**
|
|
23028
24338
|
* Outage handling configuration.
|
|
24339
|
+
*
|
|
24340
|
+
* @exampleValue {"globalConsecutiveOutageCountThreshold":"1","globalOutages":"true","localConsecutiveOutageCountThreshold":"3","localLocationOutageCountThreshold":"3","localOutages":"true"}
|
|
23029
24341
|
*/
|
|
23030
24342
|
syntheticMonitorOutageHandlingSettings?: SyntheticMonitorOutageHandlingSettingsDto;
|
|
23031
24343
|
/**
|
|
@@ -23091,16 +24403,14 @@ export declare interface SyntheticMultiProtocolMonitorResponse {
|
|
|
23091
24403
|
* Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed.
|
|
23092
24404
|
*/
|
|
23093
24405
|
primaryGrailTags?: SyntheticMonitorPrimaryGrailTagDto[];
|
|
23094
|
-
/**
|
|
23095
|
-
* [FEATURE DISABLED] Security context as a list of strings. Up to 10 values, max 200 characters per value. Those fields are only available for SaaS and not for Managed.
|
|
23096
|
-
*/
|
|
23097
|
-
securityContext?: string[];
|
|
23098
24406
|
/**
|
|
23099
24407
|
* The steps of the monitor.
|
|
23100
24408
|
*/
|
|
23101
24409
|
steps: SyntheticMultiProtocolMonitorStepDto[];
|
|
23102
24410
|
/**
|
|
23103
24411
|
* Outage handling configuration.
|
|
24412
|
+
*
|
|
24413
|
+
* @exampleValue {"globalConsecutiveOutageCountThreshold":"1","globalOutages":"true","localConsecutiveOutageCountThreshold":"3","localLocationOutageCountThreshold":"3","localOutages":"true"}
|
|
23104
24414
|
*/
|
|
23105
24415
|
syntheticMonitorOutageHandlingSettings: SyntheticMonitorOutageHandlingSettingsDto;
|
|
23106
24416
|
/**
|
|
@@ -23112,7 +24422,7 @@ export declare interface SyntheticMultiProtocolMonitorResponse {
|
|
|
23112
24422
|
/**
|
|
23113
24423
|
* Monitor type.
|
|
23114
24424
|
*/
|
|
23115
|
-
type: 'MULTI_PROTOCOL' | 'BROWSER';
|
|
24425
|
+
type: 'MULTI_PROTOCOL' | 'BROWSER' | 'HTTP';
|
|
23116
24426
|
}
|
|
23117
24427
|
|
|
23118
24428
|
/**
|
|
@@ -23122,7 +24432,8 @@ export declare interface SyntheticMultiProtocolMonitorResponse {
|
|
|
23122
24432
|
*/
|
|
23123
24433
|
export declare enum SyntheticMultiProtocolMonitorResponseType {
|
|
23124
24434
|
MultiProtocol = "MULTI_PROTOCOL",
|
|
23125
|
-
Browser = "BROWSER"
|
|
24435
|
+
Browser = "BROWSER",
|
|
24436
|
+
Http = "HTTP"
|
|
23126
24437
|
}
|
|
23127
24438
|
|
|
23128
24439
|
/**
|
|
@@ -23227,7 +24538,7 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
|
|
|
23227
24538
|
* * Management zone ID: `managementZoneId(1, 2)`.
|
|
23228
24539
|
* * Synthetic Location ME ID: `location(SYNTHETIC_LOCATION-123)`.
|
|
23229
24540
|
* * Monitored host ME ID: `monitoredEntity(HOST-123)`.
|
|
23230
|
-
* * 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.
|
|
24541
|
+
* * 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**.
|
|
23231
24542
|
* * Monitor enablement: `enabled(true)`.
|
|
23232
24543
|
*
|
|
23233
24544
|
* To set several criteria, separate them with a comma (`,`).
|
|
@@ -23238,9 +24549,7 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
|
|
|
23238
24549
|
/**
|
|
23239
24550
|
* Creates a synthetic monitor definition. | maturity=EARLY_ADOPTER
|
|
23240
24551
|
*
|
|
23241
|
-
* **Required scope:** environment-api:synthetic-monitors:write<br/>**
|
|
23242
|
-
* + environment:roles:manage-settings
|
|
23243
|
-
* + synthetic:monitors:write
|
|
24552
|
+
* **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:manage-settings
|
|
23244
24553
|
*
|
|
23245
24554
|
* @returns {Promise<MonitorEntityIdDto>} Success
|
|
23246
24555
|
*
|
|
@@ -23509,10 +24818,14 @@ export declare enum SyntheticOnDemandExecutionProcessingMode {
|
|
|
23509
24818
|
export declare interface SyntheticOnDemandExecutionRequest {
|
|
23510
24819
|
/**
|
|
23511
24820
|
* If true, the execution will fail in case of performance issue.
|
|
24821
|
+
*
|
|
24822
|
+
* @defaultValue true
|
|
23512
24823
|
*/
|
|
23513
24824
|
failOnPerformanceIssue?: boolean;
|
|
23514
24825
|
/**
|
|
23515
24826
|
* 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.
|
|
24827
|
+
*
|
|
24828
|
+
* @defaultValue true
|
|
23516
24829
|
*/
|
|
23517
24830
|
failOnSslWarning?: boolean;
|
|
23518
24831
|
/**
|
|
@@ -23529,14 +24842,20 @@ export declare interface SyntheticOnDemandExecutionRequest {
|
|
|
23529
24842
|
monitors?: SyntheticOnDemandExecutionRequestMonitor[];
|
|
23530
24843
|
/**
|
|
23531
24844
|
* The execution's processing mode
|
|
24845
|
+
*
|
|
24846
|
+
* @defaultValue STANDARD
|
|
23532
24847
|
*/
|
|
23533
24848
|
processingMode?: 'STANDARD' | 'DISABLE_PROBLEM_DETECTION' | 'EXECUTIONS_DETAILS_ONLY';
|
|
23534
24849
|
/**
|
|
23535
24850
|
* If true, no executions will be scheduled if a problem occurs.
|
|
24851
|
+
*
|
|
24852
|
+
* @defaultValue false
|
|
23536
24853
|
*/
|
|
23537
24854
|
stopOnProblem?: boolean;
|
|
23538
24855
|
/**
|
|
23539
24856
|
* If true, the screenshots will be taken during the execution of a browser monitor.
|
|
24857
|
+
*
|
|
24858
|
+
* @defaultValue false
|
|
23540
24859
|
*/
|
|
23541
24860
|
takeScreenshotsOnSuccess?: boolean;
|
|
23542
24861
|
}
|
|
@@ -23580,6 +24899,8 @@ export declare interface SyntheticOnDemandExecutionRequestMonitor {
|
|
|
23580
24899
|
customizedScript?: SyntheticOnDemandExecutionRequestMonitorCustomizedScript;
|
|
23581
24900
|
/**
|
|
23582
24901
|
* The number of times the monitor is to be executed per location; if not set, the monitor will be executed once.
|
|
24902
|
+
*
|
|
24903
|
+
* @defaultValue 1
|
|
23583
24904
|
*/
|
|
23584
24905
|
executionCount?: number;
|
|
23585
24906
|
/**
|
|
@@ -23592,6 +24913,8 @@ export declare interface SyntheticOnDemandExecutionRequestMonitor {
|
|
|
23592
24913
|
monitorId: string;
|
|
23593
24914
|
/**
|
|
23594
24915
|
* Execution repeat mode. If not set, the mode is SEQUENTIAL.
|
|
24916
|
+
*
|
|
24917
|
+
* @defaultValue SEQUENTIAL
|
|
23595
24918
|
*/
|
|
23596
24919
|
repeatMode?: 'SEQUENTIAL' | 'PARALLEL';
|
|
23597
24920
|
}
|
|
@@ -24103,6 +25426,8 @@ export declare interface SyntheticPrivateLocationUpdate extends SyntheticLocatio
|
|
|
24103
25426
|
latitude: number;
|
|
24104
25427
|
/**
|
|
24105
25428
|
* 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.
|
|
25429
|
+
*
|
|
25430
|
+
* @minimum 1
|
|
24106
25431
|
*/
|
|
24107
25432
|
locationNodeOutageDelayInMinutes?: number;
|
|
24108
25433
|
/**
|
|
@@ -24111,10 +25436,14 @@ export declare interface SyntheticPrivateLocationUpdate extends SyntheticLocatio
|
|
|
24111
25436
|
longitude: number;
|
|
24112
25437
|
/**
|
|
24113
25438
|
* Containerized location property. The maximum number of ActiveGates deployed for the location (required for a Kubernetes location).
|
|
25439
|
+
*
|
|
25440
|
+
* @minimum 1
|
|
24114
25441
|
*/
|
|
24115
25442
|
maxActiveGateCount?: number;
|
|
24116
25443
|
/**
|
|
24117
25444
|
* Containerized location property. The minimum number of ActiveGates deployed for the location (required for a Kubernetes location).
|
|
25445
|
+
*
|
|
25446
|
+
* @minimum 1
|
|
24118
25447
|
*/
|
|
24119
25448
|
minActiveGateCount?: number;
|
|
24120
25449
|
/**
|
|
@@ -24273,12 +25602,34 @@ export declare interface TenantTokenConfig {
|
|
|
24273
25602
|
old?: TenantToken;
|
|
24274
25603
|
}
|
|
24275
25604
|
|
|
25605
|
+
/**
|
|
25606
|
+
* Status of tenant token rotation.
|
|
25607
|
+
*/
|
|
25608
|
+
export declare interface TenantTokenRotationStatus {
|
|
25609
|
+
/**
|
|
25610
|
+
* Rotation status. ACTIVE when a secondary token exists, otherwise INACTIVE.
|
|
25611
|
+
*/
|
|
25612
|
+
status?: 'ACTIVE' | 'INACTIVE';
|
|
25613
|
+
}
|
|
25614
|
+
|
|
25615
|
+
/**
|
|
25616
|
+
* Rotation status. ACTIVE when a secondary token exists, otherwise INACTIVE.
|
|
25617
|
+
*
|
|
25618
|
+
* @deprecated Use literal values.
|
|
25619
|
+
*/
|
|
25620
|
+
export declare enum TenantTokenRotationStatusStatus {
|
|
25621
|
+
Active = "ACTIVE",
|
|
25622
|
+
Inactive = "INACTIVE"
|
|
25623
|
+
}
|
|
25624
|
+
|
|
24276
25625
|
/**
|
|
24277
25626
|
* Test device of a Browser Monitor.
|
|
24278
25627
|
*/
|
|
24279
25628
|
export declare interface TestDeviceDto {
|
|
24280
25629
|
/**
|
|
24281
25630
|
* Device height in px.
|
|
25631
|
+
*
|
|
25632
|
+
* @minimum 0
|
|
24282
25633
|
*/
|
|
24283
25634
|
height: number;
|
|
24284
25635
|
/**
|
|
@@ -24295,6 +25646,8 @@ export declare interface TestDeviceDto {
|
|
|
24295
25646
|
touchEnabled?: boolean;
|
|
24296
25647
|
/**
|
|
24297
25648
|
* Device width in px.
|
|
25649
|
+
*
|
|
25650
|
+
* @minimum 0
|
|
24298
25651
|
*/
|
|
24299
25652
|
width: number;
|
|
24300
25653
|
}
|
|
@@ -24319,6 +25672,8 @@ export declare interface TimeoutSettingsDto {
|
|
|
24319
25672
|
export declare interface TimeWaitConditionDto extends BaseWaitConditionDto {
|
|
24320
25673
|
/**
|
|
24321
25674
|
* Wait time in milliseconds.
|
|
25675
|
+
*
|
|
25676
|
+
* @minimum 0
|
|
24322
25677
|
*/
|
|
24323
25678
|
milliseconds: number;
|
|
24324
25679
|
}
|
|
@@ -24329,6 +25684,8 @@ export declare interface TimeWaitConditionDto extends BaseWaitConditionDto {
|
|
|
24329
25684
|
export declare interface TokenCredentials extends Credentials {
|
|
24330
25685
|
/**
|
|
24331
25686
|
* Information for synchronization credentials with external vault
|
|
25687
|
+
*
|
|
25688
|
+
* @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"}
|
|
24332
25689
|
*/
|
|
24333
25690
|
externalVault?: ExternalVault;
|
|
24334
25691
|
/**
|
|
@@ -24603,18 +25960,26 @@ export declare interface UiTabGroupCustomization {
|
|
|
24603
25960
|
export declare interface UiTableColumnCustomization {
|
|
24604
25961
|
/**
|
|
24605
25962
|
* The ui specific builtin column-implementation for this column.
|
|
25963
|
+
*
|
|
25964
|
+
* @exampleValue summary
|
|
24606
25965
|
*/
|
|
24607
25966
|
builtinColumnRef?: string;
|
|
24608
25967
|
/**
|
|
24609
25968
|
* The referenced column from the 'tableColumns' property of the schema for this column.
|
|
25969
|
+
*
|
|
25970
|
+
* @exampleValue myCustomColumn
|
|
24610
25971
|
*/
|
|
24611
25972
|
columnRef?: string;
|
|
24612
25973
|
/**
|
|
24613
25974
|
* The display name for this column.
|
|
25975
|
+
*
|
|
25976
|
+
* @exampleValue Color
|
|
24614
25977
|
*/
|
|
24615
25978
|
displayName?: string;
|
|
24616
25979
|
/**
|
|
24617
25980
|
* The id for this column used for filtering. Required for conflicting or pathed columns - otherwise the ref is used.
|
|
25981
|
+
*
|
|
25982
|
+
* @exampleValue color
|
|
24618
25983
|
*/
|
|
24619
25984
|
id?: string;
|
|
24620
25985
|
/**
|
|
@@ -24623,14 +25988,20 @@ export declare interface UiTableColumnCustomization {
|
|
|
24623
25988
|
items?: UiTableColumnItemCustomization[];
|
|
24624
25989
|
/**
|
|
24625
25990
|
* The referenced property for this column.
|
|
25991
|
+
*
|
|
25992
|
+
* @exampleValue apiColor
|
|
24626
25993
|
*/
|
|
24627
25994
|
propertyRef?: string;
|
|
24628
25995
|
/**
|
|
24629
25996
|
* The ui specific type for this column.
|
|
25997
|
+
*
|
|
25998
|
+
* @exampleValue cell-color-picker
|
|
24630
25999
|
*/
|
|
24631
26000
|
type?: string;
|
|
24632
26001
|
/**
|
|
24633
26002
|
* The width this column should take up on the table.
|
|
26003
|
+
*
|
|
26004
|
+
* @exampleValue 10%
|
|
24634
26005
|
*/
|
|
24635
26006
|
width?: string;
|
|
24636
26007
|
}
|
|
@@ -24641,14 +26012,20 @@ export declare interface UiTableColumnCustomization {
|
|
|
24641
26012
|
export declare interface UiTableColumnItemCustomization {
|
|
24642
26013
|
/**
|
|
24643
26014
|
* The display name of this item.
|
|
26015
|
+
*
|
|
26016
|
+
* @exampleValue Active
|
|
24644
26017
|
*/
|
|
24645
26018
|
displayName?: string;
|
|
24646
26019
|
/**
|
|
24647
26020
|
* The icon of this item.
|
|
26021
|
+
*
|
|
26022
|
+
* @exampleValue CRITICAL
|
|
24648
26023
|
*/
|
|
24649
26024
|
icon?: string;
|
|
24650
26025
|
/**
|
|
24651
26026
|
* The value of this item.
|
|
26027
|
+
*
|
|
26028
|
+
* @exampleValue ACTIVE
|
|
24652
26029
|
*/
|
|
24653
26030
|
value: string;
|
|
24654
26031
|
}
|
|
@@ -24755,14 +26132,20 @@ export declare enum UpdateJavaScriptMappingFileMetadataPathFileType {
|
|
|
24755
26132
|
export declare interface UpdateJob {
|
|
24756
26133
|
/**
|
|
24757
26134
|
* The type of the ActiveGate.
|
|
26135
|
+
*
|
|
26136
|
+
* @exampleValue ENVIRONMENT
|
|
24758
26137
|
*/
|
|
24759
26138
|
agType?: 'CLUSTER' | 'ENVIRONMENT' | 'ENVIRONMENT_MULTI';
|
|
24760
26139
|
/**
|
|
24761
26140
|
* The job can (`true`) or can't (`false`) be cancelled at the moment.
|
|
26141
|
+
*
|
|
26142
|
+
* @exampleValue false
|
|
24762
26143
|
*/
|
|
24763
26144
|
cancelable?: boolean;
|
|
24764
26145
|
/**
|
|
24765
26146
|
* The duration of the update, in milliseconds.
|
|
26147
|
+
*
|
|
26148
|
+
* @exampleValue 3608000
|
|
24766
26149
|
*/
|
|
24767
26150
|
duration?: number;
|
|
24768
26151
|
/**
|
|
@@ -24775,14 +26158,20 @@ export declare interface UpdateJob {
|
|
|
24775
26158
|
error?: string;
|
|
24776
26159
|
/**
|
|
24777
26160
|
* The ID of the update job.
|
|
26161
|
+
*
|
|
26162
|
+
* @exampleValue -3524498778810258605
|
|
24778
26163
|
*/
|
|
24779
26164
|
jobId?: string;
|
|
24780
26165
|
/**
|
|
24781
26166
|
* The status of the update job.
|
|
26167
|
+
*
|
|
26168
|
+
* @exampleValue SUCCEED
|
|
24782
26169
|
*/
|
|
24783
26170
|
jobState?: 'FAILED' | 'IN_PROGRESS' | 'PENDING' | 'ROLLBACK' | 'SCHEDULED' | 'SKIPPED' | 'SUCCEED';
|
|
24784
26171
|
/**
|
|
24785
26172
|
* The initial version of the ActiveGate.
|
|
26173
|
+
*
|
|
26174
|
+
* @exampleValue 1.185.0.20200201-120000
|
|
24786
26175
|
*/
|
|
24787
26176
|
startVersion?: string;
|
|
24788
26177
|
/**
|
|
@@ -24791,20 +26180,28 @@ export declare interface UpdateJob {
|
|
|
24791
26180
|
* Specify the version in the `<major>.<minor>.<revision>.<timestamp>` format.
|
|
24792
26181
|
*
|
|
24793
26182
|
* To update to the latest available version, use the `latest` value.
|
|
26183
|
+
*
|
|
26184
|
+
* @exampleValue 1.190.0.20200301-130000
|
|
24794
26185
|
*/
|
|
24795
26186
|
targetVersion: string;
|
|
24796
26187
|
/**
|
|
24797
26188
|
* The timestamp of the update job completion.
|
|
24798
26189
|
*
|
|
24799
26190
|
* The `null` value means the job is still running.
|
|
26191
|
+
*
|
|
26192
|
+
* @exampleValue 1582031917814
|
|
24800
26193
|
*/
|
|
24801
26194
|
timestamp?: number;
|
|
24802
26195
|
/**
|
|
24803
26196
|
* The method of updating the ActiveGate or its component.
|
|
26197
|
+
*
|
|
26198
|
+
* @exampleValue AUTOMATIC
|
|
24804
26199
|
*/
|
|
24805
26200
|
updateMethod?: 'AUTOMATIC' | 'MANUAL_INSTALLATION' | 'ON_DEMAND';
|
|
24806
26201
|
/**
|
|
24807
26202
|
* The component to be updated.
|
|
26203
|
+
*
|
|
26204
|
+
* @exampleValue ACTIVE_GATE
|
|
24808
26205
|
*/
|
|
24809
26206
|
updateType?: 'ACTIVE_GATE' | 'REMOTE_PLUGIN_AGENT' | 'SYNTHETIC' | 'Z_REMOTE';
|
|
24810
26207
|
}
|
|
@@ -24841,6 +26238,8 @@ export declare enum UpdateJobJobState {
|
|
|
24841
26238
|
export declare interface UpdateJobList {
|
|
24842
26239
|
/**
|
|
24843
26240
|
* The ID of the ActiveGate.
|
|
26241
|
+
*
|
|
26242
|
+
* @exampleValue 0x3efdd092
|
|
24844
26243
|
*/
|
|
24845
26244
|
agId?: string;
|
|
24846
26245
|
/**
|
|
@@ -24910,6 +26309,34 @@ export declare enum UpdatePermissionsRequestPermissionsItem {
|
|
|
24910
26309
|
W = "w"
|
|
24911
26310
|
}
|
|
24912
26311
|
|
|
26312
|
+
/**
|
|
26313
|
+
* Basic information about one maintenance window
|
|
26314
|
+
*/
|
|
26315
|
+
export declare interface UpdateWindow {
|
|
26316
|
+
/**
|
|
26317
|
+
* Identifier of maintenance window
|
|
26318
|
+
*
|
|
26319
|
+
* @exampleValue vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h
|
|
26320
|
+
*/
|
|
26321
|
+
id: string;
|
|
26322
|
+
/**
|
|
26323
|
+
* The name of maintenance window
|
|
26324
|
+
*
|
|
26325
|
+
* @exampleValue Daily maintenance window
|
|
26326
|
+
*/
|
|
26327
|
+
name?: string;
|
|
26328
|
+
}
|
|
26329
|
+
|
|
26330
|
+
/**
|
|
26331
|
+
* Basic information about all configured update windows
|
|
26332
|
+
*/
|
|
26333
|
+
export declare interface UpdateWindowsConfig {
|
|
26334
|
+
/**
|
|
26335
|
+
* List of update windows when the OneAgent update can start. If there is no value and update should be performed, the update will start at earliest convenience.
|
|
26336
|
+
*/
|
|
26337
|
+
windows: UpdateWindow[];
|
|
26338
|
+
}
|
|
26339
|
+
|
|
24913
26340
|
export declare interface UploadJavaScriptMappingFileAliasBody {
|
|
24914
26341
|
/**
|
|
24915
26342
|
* JavaScript mapping file to upload.
|
|
@@ -24948,6 +26375,8 @@ export declare enum UploadJavaScriptMappingFilePathFileType {
|
|
|
24948
26375
|
export declare interface UserPasswordCredentials extends Credentials {
|
|
24949
26376
|
/**
|
|
24950
26377
|
* Information for synchronization credentials with external vault
|
|
26378
|
+
*
|
|
26379
|
+
* @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"}
|
|
24951
26380
|
*/
|
|
24952
26381
|
externalVault?: ExternalVault;
|
|
24953
26382
|
/**
|
|
@@ -24989,6 +26418,8 @@ export declare interface ValidationRuleDto {
|
|
|
24989
26418
|
regex?: boolean;
|
|
24990
26419
|
/**
|
|
24991
26420
|
* Target of Browser Monitor step.
|
|
26421
|
+
*
|
|
26422
|
+
* @exampleValue {"locators":[{"type":"CSS","value":"<img>[id='logoIcon']"},{"type":"CSS","value":"<a>[id='externalSite']"}],"window":"ruxitWin[0]"}
|
|
24992
26423
|
*/
|
|
24993
26424
|
target?: TargetDto;
|
|
24994
26425
|
/**
|
|
@@ -25014,10 +26445,14 @@ export declare enum ValidationRuleDtoType {
|
|
|
25014
26445
|
export declare interface ValidationWaitConditionDto extends BaseWaitConditionDto {
|
|
25015
26446
|
/**
|
|
25016
26447
|
* Validation timeout in milliseconds.
|
|
26448
|
+
*
|
|
26449
|
+
* @minimum 0
|
|
25017
26450
|
*/
|
|
25018
26451
|
timeoutInMilliseconds: number;
|
|
25019
26452
|
/**
|
|
25020
26453
|
* Validation rule of Browser Monitor step.
|
|
26454
|
+
*
|
|
26455
|
+
* @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"}
|
|
25021
26456
|
*/
|
|
25022
26457
|
validationRule: ValidationRuleDto;
|
|
25023
26458
|
}
|