@northflank/js-client 0.8.1 → 0.8.2
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/dist/cjs/api-client.d.ts +167 -56
- package/dist/cjs/api-client.js +1 -1
- package/dist/esm/api-client.d.ts +167 -56
- package/dist/esm/api-client.js +1 -1
- package/package.json +1 -1
package/dist/cjs/api-client.d.ts
CHANGED
|
@@ -1857,10 +1857,13 @@ type ListCloudClustersResult = {
|
|
|
1857
1857
|
/** Set this flag to disable public IP assignment for nodes in this node pool. */
|
|
1858
1858
|
'enablePrivateNodes'?: boolean;
|
|
1859
1859
|
};
|
|
1860
|
-
/**
|
|
1861
|
-
'
|
|
1862
|
-
|
|
1863
|
-
|
|
1860
|
+
/** Azure specific settings. */
|
|
1861
|
+
'azure'?: {
|
|
1862
|
+
/** When 'provider' is 'azure', at least one system node pool is required per cluster. */
|
|
1863
|
+
'systemPool'?: boolean;
|
|
1864
|
+
/** When 'provider' is 'azure', set this flag to use public node IPs. */
|
|
1865
|
+
'enablePublicNodeIp'?: boolean;
|
|
1866
|
+
};
|
|
1864
1867
|
/** AWS specific node pool settings. */
|
|
1865
1868
|
'aws'?: {
|
|
1866
1869
|
/** Specify a launch template to use for this node pool. When using a launch template, the disk size selection on the node pool level will be ignored. */
|
|
@@ -2036,8 +2039,12 @@ type ListCloudClustersResult = {
|
|
|
2036
2039
|
'teamId': string;
|
|
2037
2040
|
}[];
|
|
2038
2041
|
};
|
|
2039
|
-
/** GCP specific data. Required when `provider` is `gcp
|
|
2042
|
+
/** GCP specific data. Required when `provider` is `gcp` */
|
|
2040
2043
|
'gcp'?: {
|
|
2044
|
+
'networking'?: {
|
|
2045
|
+
'network'?: string;
|
|
2046
|
+
'subnetwork'?: string;
|
|
2047
|
+
};
|
|
2041
2048
|
'enableAuthorizedIpRanges'?: boolean;
|
|
2042
2049
|
'authorizedIpRanges'?: string[];
|
|
2043
2050
|
/** GCP Project ID */
|
|
@@ -2048,7 +2055,7 @@ type ListCloudClustersResult = {
|
|
|
2048
2055
|
'enablePublicAccessCidrs'?: boolean;
|
|
2049
2056
|
'publicAccessCidrs'?: string[];
|
|
2050
2057
|
'subnetConfiguration'?: {
|
|
2051
|
-
/** The mode of the AWS subnet */
|
|
2058
|
+
/** The mode of the AWS subnet configuration */
|
|
2052
2059
|
'mode': 'default-subnets-for-azs' | 'explicit-subnets';
|
|
2053
2060
|
/** Id of the VPC */
|
|
2054
2061
|
'vpcId'?: string;
|
|
@@ -2190,10 +2197,13 @@ type CreateCloudClusterResult = {
|
|
|
2190
2197
|
/** Set this flag to disable public IP assignment for nodes in this node pool. */
|
|
2191
2198
|
'enablePrivateNodes'?: boolean;
|
|
2192
2199
|
};
|
|
2193
|
-
/**
|
|
2194
|
-
'
|
|
2195
|
-
|
|
2196
|
-
|
|
2200
|
+
/** Azure specific settings. */
|
|
2201
|
+
'azure'?: {
|
|
2202
|
+
/** When 'provider' is 'azure', at least one system node pool is required per cluster. */
|
|
2203
|
+
'systemPool'?: boolean;
|
|
2204
|
+
/** When 'provider' is 'azure', set this flag to use public node IPs. */
|
|
2205
|
+
'enablePublicNodeIp'?: boolean;
|
|
2206
|
+
};
|
|
2197
2207
|
/** AWS specific node pool settings. */
|
|
2198
2208
|
'aws'?: {
|
|
2199
2209
|
/** Specify a launch template to use for this node pool. When using a launch template, the disk size selection on the node pool level will be ignored. */
|
|
@@ -2366,8 +2376,12 @@ type CreateCloudClusterResult = {
|
|
|
2366
2376
|
'teamId': string;
|
|
2367
2377
|
}[];
|
|
2368
2378
|
};
|
|
2369
|
-
/** GCP specific data. Required when `provider` is `gcp
|
|
2379
|
+
/** GCP specific data. Required when `provider` is `gcp` */
|
|
2370
2380
|
'gcp'?: {
|
|
2381
|
+
'networking'?: {
|
|
2382
|
+
'network'?: string;
|
|
2383
|
+
'subnetwork'?: string;
|
|
2384
|
+
};
|
|
2371
2385
|
'enableAuthorizedIpRanges'?: boolean;
|
|
2372
2386
|
'authorizedIpRanges'?: string[];
|
|
2373
2387
|
/** GCP Project ID */
|
|
@@ -2378,7 +2392,7 @@ type CreateCloudClusterResult = {
|
|
|
2378
2392
|
'enablePublicAccessCidrs'?: boolean;
|
|
2379
2393
|
'publicAccessCidrs'?: string[];
|
|
2380
2394
|
'subnetConfiguration'?: {
|
|
2381
|
-
/** The mode of the AWS subnet */
|
|
2395
|
+
/** The mode of the AWS subnet configuration */
|
|
2382
2396
|
'mode': 'default-subnets-for-azs' | 'explicit-subnets';
|
|
2383
2397
|
/** Id of the VPC */
|
|
2384
2398
|
'vpcId'?: string;
|
|
@@ -2515,10 +2529,13 @@ type CreateCloudClusterData = {
|
|
|
2515
2529
|
/** Set this flag to disable public IP assignment for nodes in this node pool. */
|
|
2516
2530
|
'enablePrivateNodes'?: boolean;
|
|
2517
2531
|
};
|
|
2518
|
-
/**
|
|
2519
|
-
'
|
|
2520
|
-
|
|
2521
|
-
|
|
2532
|
+
/** Azure specific settings. */
|
|
2533
|
+
'azure'?: {
|
|
2534
|
+
/** When 'provider' is 'azure', at least one system node pool is required per cluster. */
|
|
2535
|
+
'systemPool'?: boolean;
|
|
2536
|
+
/** When 'provider' is 'azure', set this flag to use public node IPs. */
|
|
2537
|
+
'enablePublicNodeIp'?: boolean;
|
|
2538
|
+
};
|
|
2522
2539
|
/** AWS specific node pool settings. */
|
|
2523
2540
|
'aws'?: {
|
|
2524
2541
|
/** Specify a launch template to use for this node pool. When using a launch template, the disk size selection on the node pool level will be ignored. */
|
|
@@ -2691,8 +2708,12 @@ type CreateCloudClusterData = {
|
|
|
2691
2708
|
'teamId': string;
|
|
2692
2709
|
}[];
|
|
2693
2710
|
};
|
|
2694
|
-
/** GCP specific data. Required when `provider` is `gcp
|
|
2711
|
+
/** GCP specific data. Required when `provider` is `gcp` */
|
|
2695
2712
|
'gcp'?: {
|
|
2713
|
+
'networking'?: {
|
|
2714
|
+
'network'?: string;
|
|
2715
|
+
'subnetwork'?: string;
|
|
2716
|
+
};
|
|
2696
2717
|
'enableAuthorizedIpRanges'?: boolean;
|
|
2697
2718
|
'authorizedIpRanges'?: string[];
|
|
2698
2719
|
/** GCP Project ID */
|
|
@@ -2703,7 +2724,7 @@ type CreateCloudClusterData = {
|
|
|
2703
2724
|
'enablePublicAccessCidrs'?: boolean;
|
|
2704
2725
|
'publicAccessCidrs'?: string[];
|
|
2705
2726
|
'subnetConfiguration'?: {
|
|
2706
|
-
/** The mode of the AWS subnet */
|
|
2727
|
+
/** The mode of the AWS subnet configuration */
|
|
2707
2728
|
'mode': 'default-subnets-for-azs' | 'explicit-subnets';
|
|
2708
2729
|
/** Id of the VPC */
|
|
2709
2730
|
'vpcId'?: string;
|
|
@@ -2828,10 +2849,13 @@ type PutCloudClusterResult = {
|
|
|
2828
2849
|
/** Set this flag to disable public IP assignment for nodes in this node pool. */
|
|
2829
2850
|
'enablePrivateNodes'?: boolean;
|
|
2830
2851
|
};
|
|
2831
|
-
/**
|
|
2832
|
-
'
|
|
2833
|
-
|
|
2834
|
-
|
|
2852
|
+
/** Azure specific settings. */
|
|
2853
|
+
'azure'?: {
|
|
2854
|
+
/** When 'provider' is 'azure', at least one system node pool is required per cluster. */
|
|
2855
|
+
'systemPool'?: boolean;
|
|
2856
|
+
/** When 'provider' is 'azure', set this flag to use public node IPs. */
|
|
2857
|
+
'enablePublicNodeIp'?: boolean;
|
|
2858
|
+
};
|
|
2835
2859
|
/** AWS specific node pool settings. */
|
|
2836
2860
|
'aws'?: {
|
|
2837
2861
|
/** Specify a launch template to use for this node pool. When using a launch template, the disk size selection on the node pool level will be ignored. */
|
|
@@ -3004,8 +3028,12 @@ type PutCloudClusterResult = {
|
|
|
3004
3028
|
'teamId': string;
|
|
3005
3029
|
}[];
|
|
3006
3030
|
};
|
|
3007
|
-
/** GCP specific data. Required when `provider` is `gcp
|
|
3031
|
+
/** GCP specific data. Required when `provider` is `gcp` */
|
|
3008
3032
|
'gcp'?: {
|
|
3033
|
+
'networking'?: {
|
|
3034
|
+
'network'?: string;
|
|
3035
|
+
'subnetwork'?: string;
|
|
3036
|
+
};
|
|
3009
3037
|
'enableAuthorizedIpRanges'?: boolean;
|
|
3010
3038
|
'authorizedIpRanges'?: string[];
|
|
3011
3039
|
/** GCP Project ID */
|
|
@@ -3016,7 +3044,7 @@ type PutCloudClusterResult = {
|
|
|
3016
3044
|
'enablePublicAccessCidrs'?: boolean;
|
|
3017
3045
|
'publicAccessCidrs'?: string[];
|
|
3018
3046
|
'subnetConfiguration'?: {
|
|
3019
|
-
/** The mode of the AWS subnet */
|
|
3047
|
+
/** The mode of the AWS subnet configuration */
|
|
3020
3048
|
'mode': 'default-subnets-for-azs' | 'explicit-subnets';
|
|
3021
3049
|
/** Id of the VPC */
|
|
3022
3050
|
'vpcId'?: string;
|
|
@@ -3153,10 +3181,13 @@ type PutCloudClusterData = {
|
|
|
3153
3181
|
/** Set this flag to disable public IP assignment for nodes in this node pool. */
|
|
3154
3182
|
'enablePrivateNodes'?: boolean;
|
|
3155
3183
|
};
|
|
3156
|
-
/**
|
|
3157
|
-
'
|
|
3158
|
-
|
|
3159
|
-
|
|
3184
|
+
/** Azure specific settings. */
|
|
3185
|
+
'azure'?: {
|
|
3186
|
+
/** When 'provider' is 'azure', at least one system node pool is required per cluster. */
|
|
3187
|
+
'systemPool'?: boolean;
|
|
3188
|
+
/** When 'provider' is 'azure', set this flag to use public node IPs. */
|
|
3189
|
+
'enablePublicNodeIp'?: boolean;
|
|
3190
|
+
};
|
|
3160
3191
|
/** AWS specific node pool settings. */
|
|
3161
3192
|
'aws'?: {
|
|
3162
3193
|
/** Specify a launch template to use for this node pool. When using a launch template, the disk size selection on the node pool level will be ignored. */
|
|
@@ -3329,8 +3360,12 @@ type PutCloudClusterData = {
|
|
|
3329
3360
|
'teamId': string;
|
|
3330
3361
|
}[];
|
|
3331
3362
|
};
|
|
3332
|
-
/** GCP specific data. Required when `provider` is `gcp
|
|
3363
|
+
/** GCP specific data. Required when `provider` is `gcp` */
|
|
3333
3364
|
'gcp'?: {
|
|
3365
|
+
'networking'?: {
|
|
3366
|
+
'network'?: string;
|
|
3367
|
+
'subnetwork'?: string;
|
|
3368
|
+
};
|
|
3334
3369
|
'enableAuthorizedIpRanges'?: boolean;
|
|
3335
3370
|
'authorizedIpRanges'?: string[];
|
|
3336
3371
|
/** GCP Project ID */
|
|
@@ -3341,7 +3376,7 @@ type PutCloudClusterData = {
|
|
|
3341
3376
|
'enablePublicAccessCidrs'?: boolean;
|
|
3342
3377
|
'publicAccessCidrs'?: string[];
|
|
3343
3378
|
'subnetConfiguration'?: {
|
|
3344
|
-
/** The mode of the AWS subnet */
|
|
3379
|
+
/** The mode of the AWS subnet configuration */
|
|
3345
3380
|
'mode': 'default-subnets-for-azs' | 'explicit-subnets';
|
|
3346
3381
|
/** Id of the VPC */
|
|
3347
3382
|
'vpcId'?: string;
|
|
@@ -3466,10 +3501,13 @@ type GetCloudClusterResult = {
|
|
|
3466
3501
|
/** Set this flag to disable public IP assignment for nodes in this node pool. */
|
|
3467
3502
|
'enablePrivateNodes'?: boolean;
|
|
3468
3503
|
};
|
|
3469
|
-
/**
|
|
3470
|
-
'
|
|
3471
|
-
|
|
3472
|
-
|
|
3504
|
+
/** Azure specific settings. */
|
|
3505
|
+
'azure'?: {
|
|
3506
|
+
/** When 'provider' is 'azure', at least one system node pool is required per cluster. */
|
|
3507
|
+
'systemPool'?: boolean;
|
|
3508
|
+
/** When 'provider' is 'azure', set this flag to use public node IPs. */
|
|
3509
|
+
'enablePublicNodeIp'?: boolean;
|
|
3510
|
+
};
|
|
3473
3511
|
/** AWS specific node pool settings. */
|
|
3474
3512
|
'aws'?: {
|
|
3475
3513
|
/** Specify a launch template to use for this node pool. When using a launch template, the disk size selection on the node pool level will be ignored. */
|
|
@@ -3642,8 +3680,12 @@ type GetCloudClusterResult = {
|
|
|
3642
3680
|
'teamId': string;
|
|
3643
3681
|
}[];
|
|
3644
3682
|
};
|
|
3645
|
-
/** GCP specific data. Required when `provider` is `gcp
|
|
3683
|
+
/** GCP specific data. Required when `provider` is `gcp` */
|
|
3646
3684
|
'gcp'?: {
|
|
3685
|
+
'networking'?: {
|
|
3686
|
+
'network'?: string;
|
|
3687
|
+
'subnetwork'?: string;
|
|
3688
|
+
};
|
|
3647
3689
|
'enableAuthorizedIpRanges'?: boolean;
|
|
3648
3690
|
'authorizedIpRanges'?: string[];
|
|
3649
3691
|
/** GCP Project ID */
|
|
@@ -3654,7 +3696,7 @@ type GetCloudClusterResult = {
|
|
|
3654
3696
|
'enablePublicAccessCidrs'?: boolean;
|
|
3655
3697
|
'publicAccessCidrs'?: string[];
|
|
3656
3698
|
'subnetConfiguration'?: {
|
|
3657
|
-
/** The mode of the AWS subnet */
|
|
3699
|
+
/** The mode of the AWS subnet configuration */
|
|
3658
3700
|
'mode': 'default-subnets-for-azs' | 'explicit-subnets';
|
|
3659
3701
|
/** Id of the VPC */
|
|
3660
3702
|
'vpcId'?: string;
|
|
@@ -3803,10 +3845,13 @@ type PatchCloudClusterResult = {
|
|
|
3803
3845
|
/** Set this flag to disable public IP assignment for nodes in this node pool. */
|
|
3804
3846
|
'enablePrivateNodes'?: boolean;
|
|
3805
3847
|
};
|
|
3806
|
-
/**
|
|
3807
|
-
'
|
|
3808
|
-
|
|
3809
|
-
|
|
3848
|
+
/** Azure specific settings. */
|
|
3849
|
+
'azure'?: {
|
|
3850
|
+
/** When 'provider' is 'azure', at least one system node pool is required per cluster. */
|
|
3851
|
+
'systemPool'?: boolean;
|
|
3852
|
+
/** When 'provider' is 'azure', set this flag to use public node IPs. */
|
|
3853
|
+
'enablePublicNodeIp'?: boolean;
|
|
3854
|
+
};
|
|
3810
3855
|
/** AWS specific node pool settings. */
|
|
3811
3856
|
'aws'?: {
|
|
3812
3857
|
/** Specify a launch template to use for this node pool. When using a launch template, the disk size selection on the node pool level will be ignored. */
|
|
@@ -3979,8 +4024,12 @@ type PatchCloudClusterResult = {
|
|
|
3979
4024
|
'teamId': string;
|
|
3980
4025
|
}[];
|
|
3981
4026
|
};
|
|
3982
|
-
/** GCP specific data. Required when `provider` is `gcp
|
|
4027
|
+
/** GCP specific data. Required when `provider` is `gcp` */
|
|
3983
4028
|
'gcp'?: {
|
|
4029
|
+
'networking'?: {
|
|
4030
|
+
'network'?: string;
|
|
4031
|
+
'subnetwork'?: string;
|
|
4032
|
+
};
|
|
3984
4033
|
'enableAuthorizedIpRanges'?: boolean;
|
|
3985
4034
|
'authorizedIpRanges'?: string[];
|
|
3986
4035
|
/** GCP Project ID */
|
|
@@ -3991,7 +4040,7 @@ type PatchCloudClusterResult = {
|
|
|
3991
4040
|
'enablePublicAccessCidrs'?: boolean;
|
|
3992
4041
|
'publicAccessCidrs'?: string[];
|
|
3993
4042
|
'subnetConfiguration'?: {
|
|
3994
|
-
/** The mode of the AWS subnet */
|
|
4043
|
+
/** The mode of the AWS subnet configuration */
|
|
3995
4044
|
'mode': 'default-subnets-for-azs' | 'explicit-subnets';
|
|
3996
4045
|
/** Id of the VPC */
|
|
3997
4046
|
'vpcId'?: string;
|
|
@@ -4108,10 +4157,13 @@ type PatchCloudClusterData = {
|
|
|
4108
4157
|
/** Set this flag to disable public IP assignment for nodes in this node pool. */
|
|
4109
4158
|
'enablePrivateNodes'?: boolean;
|
|
4110
4159
|
};
|
|
4111
|
-
/**
|
|
4112
|
-
'
|
|
4113
|
-
|
|
4114
|
-
|
|
4160
|
+
/** Azure specific settings. */
|
|
4161
|
+
'azure'?: {
|
|
4162
|
+
/** When 'provider' is 'azure', at least one system node pool is required per cluster. */
|
|
4163
|
+
'systemPool'?: boolean;
|
|
4164
|
+
/** When 'provider' is 'azure', set this flag to use public node IPs. */
|
|
4165
|
+
'enablePublicNodeIp'?: boolean;
|
|
4166
|
+
};
|
|
4115
4167
|
/** AWS specific node pool settings. */
|
|
4116
4168
|
'aws'?: {
|
|
4117
4169
|
/** Specify a launch template to use for this node pool. When using a launch template, the disk size selection on the node pool level will be ignored. */
|
|
@@ -4278,8 +4330,12 @@ type PatchCloudClusterData = {
|
|
|
4278
4330
|
'teamId': string;
|
|
4279
4331
|
}[];
|
|
4280
4332
|
};
|
|
4281
|
-
/** GCP specific data. Required when `provider` is `gcp
|
|
4333
|
+
/** GCP specific data. Required when `provider` is `gcp` */
|
|
4282
4334
|
'gcp'?: {
|
|
4335
|
+
'networking'?: {
|
|
4336
|
+
'network'?: string;
|
|
4337
|
+
'subnetwork'?: string;
|
|
4338
|
+
};
|
|
4283
4339
|
'enableAuthorizedIpRanges'?: boolean;
|
|
4284
4340
|
'authorizedIpRanges'?: string[];
|
|
4285
4341
|
/** GCP Project ID */
|
|
@@ -4290,7 +4346,7 @@ type PatchCloudClusterData = {
|
|
|
4290
4346
|
'enablePublicAccessCidrs'?: boolean;
|
|
4291
4347
|
'publicAccessCidrs'?: string[];
|
|
4292
4348
|
'subnetConfiguration'?: {
|
|
4293
|
-
/** The mode of the AWS subnet */
|
|
4349
|
+
/** The mode of the AWS subnet configuration */
|
|
4294
4350
|
'mode': 'default-subnets-for-azs' | 'explicit-subnets';
|
|
4295
4351
|
/** Id of the VPC */
|
|
4296
4352
|
'vpcId'?: string;
|
|
@@ -9389,11 +9445,14 @@ type CreateAddonResult = {
|
|
|
9389
9445
|
};
|
|
9390
9446
|
/** The type of the backup to be performed. Example: "snapshot" */
|
|
9391
9447
|
'backupType': 'dump' | 'snapshot';
|
|
9448
|
+
'customDestinationId'?: string;
|
|
9392
9449
|
/** List of destinations for which a backup should be created of this backup. Only applicable for snapshot backups. */
|
|
9393
9450
|
'additionalDestinations'?: {
|
|
9451
|
+
/** Additional custom back up destination that should be used to store the snapshot. Example: "example-backup-destination" */
|
|
9394
9452
|
'destinationId': string;
|
|
9395
|
-
/**
|
|
9453
|
+
/** Retention time of the additional back up in days. */
|
|
9396
9454
|
'retentionTime'?: number;
|
|
9455
|
+
/** The type of backup destination to use Example: "custom" */
|
|
9397
9456
|
'type': 'custom';
|
|
9398
9457
|
}[];
|
|
9399
9458
|
/** The compression algorithm of the backup. Only applicable for dump backups. Defaults to `gz`. Example: "gz" */
|
|
@@ -9561,11 +9620,14 @@ type CreateAddonData = {
|
|
|
9561
9620
|
};
|
|
9562
9621
|
/** The type of the backup to be performed. Example: "snapshot" */
|
|
9563
9622
|
'backupType': 'dump' | 'snapshot';
|
|
9623
|
+
'customDestinationId'?: string;
|
|
9564
9624
|
/** List of destinations for which a backup should be created of this backup. Only applicable for snapshot backups. */
|
|
9565
9625
|
'additionalDestinations'?: {
|
|
9626
|
+
/** Additional custom back up destination that should be used to store the snapshot. Example: "example-backup-destination" */
|
|
9566
9627
|
'destinationId': string;
|
|
9567
|
-
/**
|
|
9628
|
+
/** Retention time of the additional back up in days. */
|
|
9568
9629
|
'retentionTime'?: number;
|
|
9630
|
+
/** The type of backup destination to use Example: "custom" */
|
|
9569
9631
|
'type': 'custom';
|
|
9570
9632
|
}[];
|
|
9571
9633
|
/** The compression algorithm of the backup. Only applicable for dump backups. Defaults to `gz`. Example: "gz" */
|
|
@@ -9692,11 +9754,14 @@ type PutAddonResult = {
|
|
|
9692
9754
|
};
|
|
9693
9755
|
/** The type of the backup to be performed. Example: "snapshot" */
|
|
9694
9756
|
'backupType': 'dump' | 'snapshot';
|
|
9757
|
+
'customDestinationId'?: string;
|
|
9695
9758
|
/** List of destinations for which a backup should be created of this backup. Only applicable for snapshot backups. */
|
|
9696
9759
|
'additionalDestinations'?: {
|
|
9760
|
+
/** Additional custom back up destination that should be used to store the snapshot. Example: "example-backup-destination" */
|
|
9697
9761
|
'destinationId': string;
|
|
9698
|
-
/**
|
|
9762
|
+
/** Retention time of the additional back up in days. */
|
|
9699
9763
|
'retentionTime'?: number;
|
|
9764
|
+
/** The type of backup destination to use Example: "custom" */
|
|
9700
9765
|
'type': 'custom';
|
|
9701
9766
|
}[];
|
|
9702
9767
|
/** The compression algorithm of the backup. Only applicable for dump backups. Defaults to `gz`. Example: "gz" */
|
|
@@ -9864,11 +9929,14 @@ type PutAddonData = {
|
|
|
9864
9929
|
};
|
|
9865
9930
|
/** The type of the backup to be performed. Example: "snapshot" */
|
|
9866
9931
|
'backupType': 'dump' | 'snapshot';
|
|
9932
|
+
'customDestinationId'?: string;
|
|
9867
9933
|
/** List of destinations for which a backup should be created of this backup. Only applicable for snapshot backups. */
|
|
9868
9934
|
'additionalDestinations'?: {
|
|
9935
|
+
/** Additional custom back up destination that should be used to store the snapshot. Example: "example-backup-destination" */
|
|
9869
9936
|
'destinationId': string;
|
|
9870
|
-
/**
|
|
9937
|
+
/** Retention time of the additional back up in days. */
|
|
9871
9938
|
'retentionTime'?: number;
|
|
9939
|
+
/** The type of backup destination to use Example: "custom" */
|
|
9872
9940
|
'type': 'custom';
|
|
9873
9941
|
}[];
|
|
9874
9942
|
/** The compression algorithm of the backup. Only applicable for dump backups. Defaults to `gz`. Example: "gz" */
|
|
@@ -10082,11 +10150,14 @@ type PatchAddonResult = {
|
|
|
10082
10150
|
};
|
|
10083
10151
|
/** The type of the backup to be performed. Example: "snapshot" */
|
|
10084
10152
|
'backupType': 'dump' | 'snapshot';
|
|
10153
|
+
'customDestinationId'?: string;
|
|
10085
10154
|
/** List of destinations for which a backup should be created of this backup. Only applicable for snapshot backups. */
|
|
10086
10155
|
'additionalDestinations'?: {
|
|
10156
|
+
/** Additional custom back up destination that should be used to store the snapshot. Example: "example-backup-destination" */
|
|
10087
10157
|
'destinationId': string;
|
|
10088
|
-
/**
|
|
10158
|
+
/** Retention time of the additional back up in days. */
|
|
10089
10159
|
'retentionTime'?: number;
|
|
10160
|
+
/** The type of backup destination to use Example: "custom" */
|
|
10090
10161
|
'type': 'custom';
|
|
10091
10162
|
}[];
|
|
10092
10163
|
/** The compression algorithm of the backup. Only applicable for dump backups. Defaults to `gz`. Example: "gz" */
|
|
@@ -10230,11 +10301,14 @@ type PatchAddonData = {
|
|
|
10230
10301
|
};
|
|
10231
10302
|
/** The type of the backup to be performed. Example: "snapshot" */
|
|
10232
10303
|
'backupType': 'dump' | 'snapshot';
|
|
10304
|
+
'customDestinationId'?: string;
|
|
10233
10305
|
/** List of destinations for which a backup should be created of this backup. Only applicable for snapshot backups. */
|
|
10234
10306
|
'additionalDestinations'?: {
|
|
10307
|
+
/** Additional custom back up destination that should be used to store the snapshot. Example: "example-backup-destination" */
|
|
10235
10308
|
'destinationId': string;
|
|
10236
|
-
/**
|
|
10309
|
+
/** Retention time of the additional back up in days. */
|
|
10237
10310
|
'retentionTime'?: number;
|
|
10311
|
+
/** The type of backup destination to use Example: "custom" */
|
|
10238
10312
|
'type': 'custom';
|
|
10239
10313
|
}[];
|
|
10240
10314
|
/** The compression algorithm of the backup. Only applicable for dump backups. Defaults to `gz`. Example: "gz" */
|
|
@@ -10291,6 +10365,19 @@ type GetAddonBackupschedulesResult = {
|
|
|
10291
10365
|
'id': string;
|
|
10292
10366
|
/** The type of backup being performed. Example: "snapshot" */
|
|
10293
10367
|
'backupType': 'dump' | 'snapshot';
|
|
10368
|
+
/** The compression algorithm of the backup. Only applicable for dump backups. Defaults to `gz`. Example: "gz" */
|
|
10369
|
+
'backupCompressionType'?: 'gz' | 'zstd';
|
|
10370
|
+
/** List of destinations for which a backup should be created of this backup. Only applicable for snapshot backups. */
|
|
10371
|
+
'additionalDestinations'?: {
|
|
10372
|
+
/** Additional custom back up destination that should be used to store the snapshot. Example: "example-backup-destination" */
|
|
10373
|
+
'destinationId': string;
|
|
10374
|
+
/** Retention time of the additional back up in days. */
|
|
10375
|
+
'retentionTime'?: number;
|
|
10376
|
+
/** The type of backup destination to use Example: "custom" */
|
|
10377
|
+
'type': 'custom';
|
|
10378
|
+
}[];
|
|
10379
|
+
/** Custom backup destination in which the dump back up should be stored. Example: "example-backup-destination" */
|
|
10380
|
+
'customDestinationId'?: string;
|
|
10294
10381
|
/** Information about the scheduling for the backup schedule. */
|
|
10295
10382
|
'scheduling': {
|
|
10296
10383
|
/** The interval between backups. Each addon can only have one backup schedule of each interval for each backup type. Example: "weekly" */
|
|
@@ -10367,11 +10454,14 @@ type CreateAddonBackupscheduleData = {
|
|
|
10367
10454
|
};
|
|
10368
10455
|
/** The type of the backup to be performed. Example: "snapshot" */
|
|
10369
10456
|
'backupType': 'dump' | 'snapshot';
|
|
10457
|
+
'customDestinationId'?: string;
|
|
10370
10458
|
/** List of destinations for which a backup should be created of this backup. Only applicable for snapshot backups. */
|
|
10371
10459
|
'additionalDestinations'?: {
|
|
10460
|
+
/** Additional custom back up destination that should be used to store the snapshot. Example: "example-backup-destination" */
|
|
10372
10461
|
'destinationId': string;
|
|
10373
|
-
/**
|
|
10462
|
+
/** Retention time of the additional back up in days. */
|
|
10374
10463
|
'retentionTime'?: number;
|
|
10464
|
+
/** The type of backup destination to use Example: "custom" */
|
|
10375
10465
|
'type': 'custom';
|
|
10376
10466
|
}[];
|
|
10377
10467
|
/** The compression algorithm of the backup. Only applicable for dump backups. Defaults to `gz`. Example: "gz" */
|
|
@@ -10431,9 +10521,22 @@ type GetAddonBackupsResult = {
|
|
|
10431
10521
|
};
|
|
10432
10522
|
/** The size of the backup, in bytes Example: "1234" */
|
|
10433
10523
|
'size': string;
|
|
10524
|
+
/** The compression algorithm of the backup. Only applicable for dump backups. Defaults to `gz`. Example: "gz" */
|
|
10525
|
+
'compressionType'?: 'gz' | 'zstd';
|
|
10526
|
+
/** List of destinations for which a backup should be created of this backup. Only applicable for snapshot backups. */
|
|
10527
|
+
'additionalDestinations'?: {
|
|
10528
|
+
/** Additional custom back up destination that should be used to store the snapshot. Example: "example-backup-destination" */
|
|
10529
|
+
'destinationId': string;
|
|
10530
|
+
/** Retention time of the additional back up in days. */
|
|
10531
|
+
'retentionTime'?: number;
|
|
10532
|
+
/** The type of backup destination to use Example: "custom" */
|
|
10533
|
+
'type': 'custom';
|
|
10534
|
+
}[];
|
|
10434
10535
|
/** The version of the addon at the time of the backup. If the backup type is `snapshot`, the addon will be restored to this version when the backup is restored. Example: "4.4.8" */
|
|
10435
10536
|
'addonVersion'?: string;
|
|
10436
10537
|
};
|
|
10538
|
+
/** Custom backup destination in which the dump back up should be stored. Example: "example-backup-destination" */
|
|
10539
|
+
'customDestinationId'?: string;
|
|
10437
10540
|
}[];
|
|
10438
10541
|
};
|
|
10439
10542
|
type GetAddonBackupsCall = ((opts: GetAddonBackupsRequest) => Promise<ApiCallResponse<GetAddonBackupsResult>>) & {
|
|
@@ -10515,11 +10618,15 @@ type BackupAddonData = {
|
|
|
10515
10618
|
'backupType'?: 'dump' | 'snapshot';
|
|
10516
10619
|
/** The compression algorithm of the backup. Only applicable for dump backups. Defaults to `gz`. Example: "gz" */
|
|
10517
10620
|
'compressionType'?: 'gz' | 'zstd';
|
|
10621
|
+
/** Custom destination to store the backup in. Only applicable for dump backups. If not specified, backup is stored in Northflank-managed destination. */
|
|
10622
|
+
'customDestinationId'?: string;
|
|
10518
10623
|
/** List of destinations for which a backup should additionally be created. Only applicable for snapshot backups. */
|
|
10519
10624
|
'additionalDestinations'?: {
|
|
10625
|
+
/** Additional custom back up destination that should be used to store the snapshot. Example: "example-backup-destination" */
|
|
10520
10626
|
'destinationId': string;
|
|
10521
|
-
/**
|
|
10627
|
+
/** Retention time of the additional back up in days. */
|
|
10522
10628
|
'retentionTime'?: number;
|
|
10629
|
+
/** The type of backup destination to use Example: "custom" */
|
|
10523
10630
|
'type': 'custom';
|
|
10524
10631
|
}[];
|
|
10525
10632
|
};
|
|
@@ -10875,11 +10982,15 @@ type ImportAddonBackupData = {
|
|
|
10875
10982
|
'connectionString': string;
|
|
10876
10983
|
/** The compression algorithm for storing the imported file. Defaults to `gz`. Example: "gz" */
|
|
10877
10984
|
'compressionType'?: 'gz' | 'zstd';
|
|
10985
|
+
/** Custom destination to store the imported backup in. If not specified, backup is stored in Northflank-managed destination. */
|
|
10986
|
+
'customDestinationId': string;
|
|
10878
10987
|
} | {
|
|
10879
10988
|
/** The name of the backup. If not provided, a default name will be generated containing the current date. Example: "Example Backup" */
|
|
10880
10989
|
'name'?: string;
|
|
10881
10990
|
/** A url pointing to an existing backup stored as a GNU zip (.gz) file. Example: "https://example.com/backup.db.gz" */
|
|
10882
10991
|
'importUrl': string;
|
|
10992
|
+
/** Custom destination to store the imported backup in. If not specified, backup is stored in Northflank-managed destination. */
|
|
10993
|
+
'customDestinationId': string;
|
|
10883
10994
|
};
|
|
10884
10995
|
/** Imports a database from an external archive or existing live database. */
|
|
10885
10996
|
declare class ImportAddonBackupEndpoint extends PostApiEndpoint<ImportAddonBackupRequest, ImportAddonBackupResult> {
|