@cloudfleet/sdk 0.0.1-c034297 → 0.0.1-c21ba6a
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/README.md +26 -2
- package/dist/@tanstack/react-query.gen.d.ts +489 -588
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +447 -382
- package/dist/@tanstack/react-query.gen.js.map +1 -1
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +1 -4
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/types.gen.d.ts +1 -1
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +2 -2
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.js +3 -3
- package/dist/client/utils.gen.js.map +1 -1
- package/dist/core/params.gen.js +4 -4
- package/dist/core/params.gen.js.map +1 -1
- package/dist/schemas.gen.d.ts +566 -225
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +757 -317
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +243 -214
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +347 -312
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +1164 -789
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +1719 -1472
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +530 -352
- package/dist/zod.gen.js.map +1 -1
- package/package.json +10 -13
package/dist/schemas.gen.d.ts
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
export declare const BillingContactSchema: {
|
|
2
2
|
readonly type: "object";
|
|
3
3
|
readonly properties: {
|
|
4
|
+
readonly type: {
|
|
5
|
+
readonly type: "string";
|
|
6
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
7
|
+
readonly example: "business";
|
|
8
|
+
readonly enum: readonly ["business", "personal"];
|
|
9
|
+
};
|
|
4
10
|
readonly company: {
|
|
5
11
|
readonly type: "string";
|
|
6
12
|
readonly maxLength: 120;
|
|
@@ -76,7 +82,7 @@ export declare const BillingContactSchema: {
|
|
|
76
82
|
readonly enum: readonly ["ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "at_vat", "au_abn", "au_arn", "ba_tin", "bb_tin", "be_vat", "bg_uic", "bg_vat", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", "cy_vat", "cz_vat", "de_stn", "de_vat", "dk_vat", "do_rcn", "ec_ruc", "ee_vat", "eg_tin", "es_cif", "es_vat", "eu_oss_vat", "fi_vat", "fr_vat", "gb_vat", "ge_vat", "gn_nif", "gr_vat", "hk_br", "hr_oib", "hr_vat", "hu_tin", "hu_vat", "id_npwp", "ie_vat", "il_vat", "in_gst", "is_vat", "it_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "lt_vat", "lu_vat", "lv_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mt_vat", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "nl_vat", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "pl_vat", "pt_vat", "ro_tin", "ro_vat", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "se_vat", "sg_gst", "sg_uen", "si_tin", "si_vat", "sk_vat", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "xi_vat", "za_vat", "zm_tin", "zw_tin", ""];
|
|
77
83
|
};
|
|
78
84
|
};
|
|
79
|
-
readonly required: readonly ["email", "individual_name"];
|
|
85
|
+
readonly required: readonly ["type", "email", "individual_name"];
|
|
80
86
|
readonly additionalProperties: false;
|
|
81
87
|
};
|
|
82
88
|
export declare const BillingCreditsSchema: {
|
|
@@ -211,9 +217,8 @@ export declare const ChartSchema: {
|
|
|
211
217
|
};
|
|
212
218
|
readonly status: {
|
|
213
219
|
readonly type: "string";
|
|
214
|
-
readonly description: "Status of the chart deployment.";
|
|
215
|
-
readonly example: "
|
|
216
|
-
readonly enum: readonly ["InstallSucceeded", "InstallFailed", "UpgradeSucceeded", "UpgradeFailed", "TestSucceeded", "TestFailed", "RollbackSucceeded", "RollbackFailed", "UninstallSucceeded", "UninstallFailed", "ArtifactFailed", "DependencyNotReady", "Progressing", "SourceNotReady"];
|
|
220
|
+
readonly description: "Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).";
|
|
221
|
+
readonly example: "InstallSucceeded";
|
|
217
222
|
};
|
|
218
223
|
readonly version_current: {
|
|
219
224
|
readonly type: "string";
|
|
@@ -270,15 +275,9 @@ export declare const ClusterCreateInputSchema: {
|
|
|
270
275
|
readonly tier: {
|
|
271
276
|
readonly type: "string";
|
|
272
277
|
readonly description: "Tier of the cluster.";
|
|
278
|
+
readonly default: "basic";
|
|
273
279
|
readonly example: "pro";
|
|
274
|
-
readonly enum: readonly ["basic", "pro"];
|
|
275
|
-
};
|
|
276
|
-
readonly region: {
|
|
277
|
-
readonly type: "string";
|
|
278
|
-
readonly description: "Cloudfleet control plane region. One of \"staging-1a\", \"northamerica-central-1\", \"europe-central-1a\", \"northamerica-central-1a\". This field can not be updated after creation.";
|
|
279
|
-
readonly default: "staging-1a";
|
|
280
|
-
readonly example: "northamerica-central-1a";
|
|
281
|
-
readonly enum: readonly ["staging-1a", "northamerica-central-1", "europe-central-1a", "northamerica-central-1a"];
|
|
280
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
282
281
|
};
|
|
283
282
|
readonly version_channel: {
|
|
284
283
|
readonly type: "string";
|
|
@@ -286,11 +285,93 @@ export declare const ClusterCreateInputSchema: {
|
|
|
286
285
|
readonly description: "Version of the kubernetes cluster.";
|
|
287
286
|
readonly default: "1.x.x-cfke.x";
|
|
288
287
|
readonly example: "1.x.x-cfke.x";
|
|
289
|
-
|
|
288
|
+
};
|
|
289
|
+
readonly release_channel: {
|
|
290
|
+
readonly type: "string";
|
|
291
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
292
|
+
readonly default: "rapid";
|
|
293
|
+
readonly example: "rapid";
|
|
294
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
295
|
+
};
|
|
296
|
+
readonly features: {
|
|
297
|
+
readonly type: "object";
|
|
298
|
+
readonly properties: {
|
|
299
|
+
readonly gpu_sharing_strategy: {
|
|
300
|
+
readonly type: "string";
|
|
301
|
+
readonly description: "GPU sharing strategy.";
|
|
302
|
+
readonly default: "none";
|
|
303
|
+
readonly example: "none";
|
|
304
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
305
|
+
};
|
|
306
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
307
|
+
readonly type: "integer";
|
|
308
|
+
readonly minimum: 2;
|
|
309
|
+
readonly maximum: 48;
|
|
310
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
311
|
+
readonly default: 4;
|
|
312
|
+
readonly example: 10;
|
|
313
|
+
};
|
|
314
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
315
|
+
readonly type: "boolean";
|
|
316
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
317
|
+
readonly example: false;
|
|
318
|
+
};
|
|
319
|
+
};
|
|
320
|
+
readonly additionalProperties: false;
|
|
321
|
+
readonly description: "Cluster feature toggles.";
|
|
322
|
+
readonly default: {
|
|
323
|
+
readonly gpu_sharing_strategy: "none";
|
|
324
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
325
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
326
|
+
};
|
|
327
|
+
};
|
|
328
|
+
readonly region: {
|
|
329
|
+
readonly type: "string";
|
|
330
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
331
|
+
readonly example: "europe-central-1a";
|
|
332
|
+
};
|
|
333
|
+
readonly networking: {
|
|
334
|
+
readonly type: "object";
|
|
335
|
+
readonly properties: {
|
|
336
|
+
readonly pod_cidr: {
|
|
337
|
+
readonly type: "string";
|
|
338
|
+
readonly description: "CIDR block for pod IPs.";
|
|
339
|
+
readonly default: "10.244.0.0/16";
|
|
340
|
+
};
|
|
341
|
+
readonly service_cidr: {
|
|
342
|
+
readonly type: "string";
|
|
343
|
+
readonly description: "CIDR block for service IPs.";
|
|
344
|
+
readonly default: "10.96.0.0/12";
|
|
345
|
+
};
|
|
346
|
+
readonly dual_stack: {
|
|
347
|
+
readonly type: "boolean";
|
|
348
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
349
|
+
};
|
|
350
|
+
readonly pod_cidr_v6: {
|
|
351
|
+
readonly type: "string";
|
|
352
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
353
|
+
readonly default: "2001:db8:1:2::/48";
|
|
354
|
+
};
|
|
355
|
+
readonly service_cidr_v6: {
|
|
356
|
+
readonly type: "string";
|
|
357
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
358
|
+
readonly default: "2001:db8:1:1::/112";
|
|
359
|
+
};
|
|
360
|
+
};
|
|
361
|
+
readonly additionalProperties: false;
|
|
362
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
363
|
+
readonly default: {
|
|
364
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
365
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
366
|
+
readonly dual_stack: false;
|
|
367
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
368
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
369
|
+
};
|
|
290
370
|
};
|
|
291
371
|
};
|
|
292
|
-
readonly required: readonly ["name", "
|
|
372
|
+
readonly required: readonly ["name", "region"];
|
|
293
373
|
readonly additionalProperties: false;
|
|
374
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
294
375
|
};
|
|
295
376
|
export declare const ClusterJoinInformationSchema: {
|
|
296
377
|
readonly type: "object";
|
|
@@ -311,11 +392,21 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
311
392
|
readonly description: "Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.";
|
|
312
393
|
readonly example: "10.96.0.10";
|
|
313
394
|
};
|
|
395
|
+
readonly pod_cidr: {
|
|
396
|
+
readonly type: "string";
|
|
397
|
+
readonly description: "Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.";
|
|
398
|
+
readonly example: "10.244.0.0/16";
|
|
399
|
+
};
|
|
314
400
|
readonly auth_key: {
|
|
315
401
|
readonly type: "string";
|
|
316
402
|
readonly description: "Authentication key for the cluster.";
|
|
317
403
|
readonly example: "tskey-auth-kBV8wr1dk911CNTRL-...";
|
|
318
404
|
};
|
|
405
|
+
readonly login_server: {
|
|
406
|
+
readonly type: "string";
|
|
407
|
+
readonly description: "Coordination server the node registers against. Empty on data plane v1 clusters, where the node advertises its own tag instead. A non-empty value requires a client that declares the dataplane-v2 capability.";
|
|
408
|
+
readonly example: "https://415026b6-f00f-44f8-968d-fc6ef4d0fc6d.fabric.europe-central-1a.cfke.io";
|
|
409
|
+
};
|
|
319
410
|
readonly bootstrap_token: {
|
|
320
411
|
readonly type: "string";
|
|
321
412
|
readonly description: "Bootstrap token for the cluster.";
|
|
@@ -373,7 +464,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
373
464
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
374
465
|
};
|
|
375
466
|
};
|
|
376
|
-
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
467
|
+
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "pod_cidr", "auth_key", "login_server", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
377
468
|
readonly additionalProperties: false;
|
|
378
469
|
};
|
|
379
470
|
export declare const ClusterSchema: {
|
|
@@ -390,15 +481,100 @@ export declare const ClusterSchema: {
|
|
|
390
481
|
readonly tier: {
|
|
391
482
|
readonly type: "string";
|
|
392
483
|
readonly description: "Tier of the cluster.";
|
|
484
|
+
readonly default: "basic";
|
|
393
485
|
readonly example: "pro";
|
|
394
|
-
readonly enum: readonly ["basic", "pro"];
|
|
486
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
487
|
+
};
|
|
488
|
+
readonly version_channel: {
|
|
489
|
+
readonly type: "string";
|
|
490
|
+
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
491
|
+
readonly description: "Version of the kubernetes cluster.";
|
|
492
|
+
readonly default: "1.x.x-cfke.x";
|
|
493
|
+
readonly example: "1.x.x-cfke.x";
|
|
494
|
+
};
|
|
495
|
+
readonly release_channel: {
|
|
496
|
+
readonly type: "string";
|
|
497
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
498
|
+
readonly default: "rapid";
|
|
499
|
+
readonly example: "rapid";
|
|
500
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
501
|
+
};
|
|
502
|
+
readonly features: {
|
|
503
|
+
readonly type: "object";
|
|
504
|
+
readonly properties: {
|
|
505
|
+
readonly gpu_sharing_strategy: {
|
|
506
|
+
readonly type: "string";
|
|
507
|
+
readonly description: "GPU sharing strategy.";
|
|
508
|
+
readonly default: "none";
|
|
509
|
+
readonly example: "none";
|
|
510
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
511
|
+
};
|
|
512
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
513
|
+
readonly type: "integer";
|
|
514
|
+
readonly minimum: 2;
|
|
515
|
+
readonly maximum: 48;
|
|
516
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
517
|
+
readonly default: 4;
|
|
518
|
+
readonly example: 10;
|
|
519
|
+
};
|
|
520
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
521
|
+
readonly type: "boolean";
|
|
522
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
523
|
+
readonly example: false;
|
|
524
|
+
};
|
|
525
|
+
};
|
|
526
|
+
readonly required: readonly ["gpu_sharing_strategy", "gpu_max_shared_clients_per_gpu", "cilium_socket_lb_host_namespace_only"];
|
|
527
|
+
readonly additionalProperties: false;
|
|
528
|
+
readonly description: "Cluster feature toggles.";
|
|
529
|
+
readonly default: {
|
|
530
|
+
readonly gpu_sharing_strategy: "none";
|
|
531
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
532
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
533
|
+
};
|
|
395
534
|
};
|
|
396
535
|
readonly region: {
|
|
397
536
|
readonly type: "string";
|
|
398
|
-
readonly description: "Cloudfleet control plane region.
|
|
399
|
-
readonly
|
|
400
|
-
|
|
401
|
-
|
|
537
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
538
|
+
readonly example: "europe-central-1a";
|
|
539
|
+
};
|
|
540
|
+
readonly networking: {
|
|
541
|
+
readonly type: "object";
|
|
542
|
+
readonly properties: {
|
|
543
|
+
readonly pod_cidr: {
|
|
544
|
+
readonly type: "string";
|
|
545
|
+
readonly description: "CIDR block for pod IPs.";
|
|
546
|
+
readonly default: "10.244.0.0/16";
|
|
547
|
+
};
|
|
548
|
+
readonly service_cidr: {
|
|
549
|
+
readonly type: "string";
|
|
550
|
+
readonly description: "CIDR block for service IPs.";
|
|
551
|
+
readonly default: "10.96.0.0/12";
|
|
552
|
+
};
|
|
553
|
+
readonly dual_stack: {
|
|
554
|
+
readonly type: "boolean";
|
|
555
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
556
|
+
};
|
|
557
|
+
readonly pod_cidr_v6: {
|
|
558
|
+
readonly type: "string";
|
|
559
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
560
|
+
readonly default: "2001:db8:1:2::/48";
|
|
561
|
+
};
|
|
562
|
+
readonly service_cidr_v6: {
|
|
563
|
+
readonly type: "string";
|
|
564
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
565
|
+
readonly default: "2001:db8:1:1::/112";
|
|
566
|
+
};
|
|
567
|
+
};
|
|
568
|
+
readonly required: readonly ["pod_cidr", "service_cidr", "dual_stack", "pod_cidr_v6", "service_cidr_v6"];
|
|
569
|
+
readonly additionalProperties: false;
|
|
570
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
571
|
+
readonly default: {
|
|
572
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
573
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
574
|
+
readonly dual_stack: false;
|
|
575
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
576
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
577
|
+
};
|
|
402
578
|
};
|
|
403
579
|
readonly id: {
|
|
404
580
|
readonly type: "string";
|
|
@@ -408,16 +584,16 @@ export declare const ClusterSchema: {
|
|
|
408
584
|
};
|
|
409
585
|
readonly status: {
|
|
410
586
|
readonly type: "string";
|
|
411
|
-
readonly description: "Status of the cluster.
|
|
412
|
-
readonly example: "
|
|
413
|
-
readonly enum: readonly ["
|
|
587
|
+
readonly description: "Status of the cluster.";
|
|
588
|
+
readonly example: "deployed";
|
|
589
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
414
590
|
};
|
|
415
591
|
readonly endpoint: {
|
|
416
592
|
readonly anyOf: readonly [{
|
|
417
593
|
readonly type: "string";
|
|
418
594
|
readonly format: "uri";
|
|
419
|
-
readonly description: "URL signed by
|
|
420
|
-
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
595
|
+
readonly description: "URL signed by a public CA of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
596
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
421
597
|
}, {
|
|
422
598
|
readonly type: "string";
|
|
423
599
|
readonly enum: readonly [""];
|
|
@@ -427,7 +603,7 @@ export declare const ClusterSchema: {
|
|
|
427
603
|
readonly anyOf: readonly [{
|
|
428
604
|
readonly type: "string";
|
|
429
605
|
readonly format: "uri";
|
|
430
|
-
readonly description: "
|
|
606
|
+
readonly description: "Deprecated alias of `endpoint`; retained for backward compatibility.";
|
|
431
607
|
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
432
608
|
}, {
|
|
433
609
|
readonly type: "string";
|
|
@@ -459,15 +635,10 @@ export declare const ClusterSchema: {
|
|
|
459
635
|
readonly description: "Indicates if the cluster is ready to be used.";
|
|
460
636
|
readonly example: true;
|
|
461
637
|
};
|
|
462
|
-
readonly version_channel: {
|
|
463
|
-
readonly type: "string";
|
|
464
|
-
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
465
|
-
readonly description: "Version of the kubernetes cluster.";
|
|
466
|
-
readonly example: "1.x.x-cfke.x";
|
|
467
|
-
};
|
|
468
638
|
};
|
|
469
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
639
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
470
640
|
readonly additionalProperties: false;
|
|
641
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
471
642
|
};
|
|
472
643
|
export declare const ClusterUpdateInputSchema: {
|
|
473
644
|
readonly type: "object";
|
|
@@ -483,18 +654,60 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
483
654
|
readonly tier: {
|
|
484
655
|
readonly type: "string";
|
|
485
656
|
readonly description: "Tier of the cluster.";
|
|
657
|
+
readonly default: "basic";
|
|
486
658
|
readonly example: "pro";
|
|
487
|
-
readonly enum: readonly ["basic", "pro"];
|
|
659
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
488
660
|
};
|
|
489
661
|
readonly version_channel: {
|
|
490
662
|
readonly type: "string";
|
|
491
663
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
492
664
|
readonly description: "Version of the kubernetes cluster.";
|
|
665
|
+
readonly default: "1.x.x-cfke.x";
|
|
493
666
|
readonly example: "1.x.x-cfke.x";
|
|
494
667
|
};
|
|
668
|
+
readonly release_channel: {
|
|
669
|
+
readonly type: "string";
|
|
670
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
671
|
+
readonly default: "rapid";
|
|
672
|
+
readonly example: "rapid";
|
|
673
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
674
|
+
};
|
|
675
|
+
readonly features: {
|
|
676
|
+
readonly type: "object";
|
|
677
|
+
readonly properties: {
|
|
678
|
+
readonly gpu_sharing_strategy: {
|
|
679
|
+
readonly type: "string";
|
|
680
|
+
readonly description: "GPU sharing strategy.";
|
|
681
|
+
readonly default: "none";
|
|
682
|
+
readonly example: "none";
|
|
683
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
684
|
+
};
|
|
685
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
686
|
+
readonly type: "integer";
|
|
687
|
+
readonly minimum: 2;
|
|
688
|
+
readonly maximum: 48;
|
|
689
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
690
|
+
readonly default: 4;
|
|
691
|
+
readonly example: 10;
|
|
692
|
+
};
|
|
693
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
694
|
+
readonly type: "boolean";
|
|
695
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
696
|
+
readonly example: false;
|
|
697
|
+
};
|
|
698
|
+
};
|
|
699
|
+
readonly additionalProperties: false;
|
|
700
|
+
readonly description: "Cluster feature toggles.";
|
|
701
|
+
readonly default: {
|
|
702
|
+
readonly gpu_sharing_strategy: "none";
|
|
703
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
704
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
705
|
+
};
|
|
706
|
+
};
|
|
495
707
|
};
|
|
496
|
-
readonly required: readonly ["
|
|
708
|
+
readonly required: readonly ["name"];
|
|
497
709
|
readonly additionalProperties: false;
|
|
710
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
498
711
|
};
|
|
499
712
|
export declare const FleetCreateInputSchema: {
|
|
500
713
|
readonly type: "object";
|
|
@@ -538,8 +751,8 @@ export declare const FleetCreateInputSchema: {
|
|
|
538
751
|
readonly type: "string";
|
|
539
752
|
readonly maxLength: 64;
|
|
540
753
|
readonly minLength: 64;
|
|
541
|
-
readonly pattern: "^[A-Za-z0-9]
|
|
542
|
-
readonly description: "Hetzner Cloud API token with read
|
|
754
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
755
|
+
readonly description: "Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.";
|
|
543
756
|
};
|
|
544
757
|
};
|
|
545
758
|
readonly required: readonly ["enabled"];
|
|
@@ -591,6 +804,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
591
804
|
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
592
805
|
};
|
|
593
806
|
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
807
|
+
readonly default: readonly [];
|
|
594
808
|
};
|
|
595
809
|
readonly 'topology.kubernetes.io/region': {
|
|
596
810
|
readonly type: "array";
|
|
@@ -599,14 +813,21 @@ export declare const FleetCreateInputSchema: {
|
|
|
599
813
|
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
600
814
|
};
|
|
601
815
|
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
816
|
+
readonly default: readonly [];
|
|
602
817
|
};
|
|
603
818
|
};
|
|
604
819
|
readonly additionalProperties: false;
|
|
605
|
-
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.
|
|
820
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
821
|
+
readonly default: {
|
|
822
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
823
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
824
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
825
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
826
|
+
};
|
|
606
827
|
};
|
|
607
828
|
readonly scalingProfile: {
|
|
608
829
|
readonly type: "string";
|
|
609
|
-
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
830
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
610
831
|
readonly default: "conservative";
|
|
611
832
|
readonly example: "conservative";
|
|
612
833
|
readonly enum: readonly ["aggressive", "conservative"];
|
|
@@ -622,6 +843,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
622
843
|
};
|
|
623
844
|
readonly required: readonly ["id"];
|
|
624
845
|
readonly additionalProperties: false;
|
|
846
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
625
847
|
};
|
|
626
848
|
export declare const FleetSchema: {
|
|
627
849
|
readonly type: "object";
|
|
@@ -716,6 +938,7 @@ export declare const FleetSchema: {
|
|
|
716
938
|
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
717
939
|
};
|
|
718
940
|
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
941
|
+
readonly default: readonly [];
|
|
719
942
|
};
|
|
720
943
|
readonly 'topology.kubernetes.io/region': {
|
|
721
944
|
readonly type: "array";
|
|
@@ -724,14 +947,22 @@ export declare const FleetSchema: {
|
|
|
724
947
|
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
725
948
|
};
|
|
726
949
|
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
950
|
+
readonly default: readonly [];
|
|
727
951
|
};
|
|
728
952
|
};
|
|
953
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
729
954
|
readonly additionalProperties: false;
|
|
730
|
-
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.
|
|
955
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
956
|
+
readonly default: {
|
|
957
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
958
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
959
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
960
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
961
|
+
};
|
|
731
962
|
};
|
|
732
963
|
readonly scalingProfile: {
|
|
733
964
|
readonly type: "string";
|
|
734
|
-
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
965
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
735
966
|
readonly default: "conservative";
|
|
736
967
|
readonly example: "conservative";
|
|
737
968
|
readonly enum: readonly ["aggressive", "conservative"];
|
|
@@ -744,9 +975,30 @@ export declare const FleetSchema: {
|
|
|
744
975
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
745
976
|
readonly example: "new-clouds-fleet";
|
|
746
977
|
};
|
|
978
|
+
readonly ready: {
|
|
979
|
+
readonly type: "boolean";
|
|
980
|
+
readonly description: "Indicates whether the fleet configuration is healthy.";
|
|
981
|
+
readonly example: true;
|
|
982
|
+
};
|
|
983
|
+
readonly status_message: {
|
|
984
|
+
readonly type: "string";
|
|
985
|
+
readonly description: "Human-readable reason the fleet is not ready. Present only when `ready` is false.";
|
|
986
|
+
readonly example: "Invalid provider permissions.";
|
|
987
|
+
};
|
|
988
|
+
readonly created_at: {
|
|
989
|
+
readonly type: "string";
|
|
990
|
+
readonly description: "Creation date and time of the fleet.";
|
|
991
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
992
|
+
};
|
|
993
|
+
readonly updated_at: {
|
|
994
|
+
readonly type: "string";
|
|
995
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
996
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
997
|
+
};
|
|
747
998
|
};
|
|
748
|
-
readonly required: readonly ["scalingProfile", "id"];
|
|
999
|
+
readonly required: readonly ["constraints", "scalingProfile", "id", "ready", "created_at", "updated_at"];
|
|
749
1000
|
readonly additionalProperties: false;
|
|
1001
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
750
1002
|
};
|
|
751
1003
|
export declare const FleetUpdateInputSchema: {
|
|
752
1004
|
readonly type: "object";
|
|
@@ -790,8 +1042,8 @@ export declare const FleetUpdateInputSchema: {
|
|
|
790
1042
|
readonly type: "string";
|
|
791
1043
|
readonly maxLength: 64;
|
|
792
1044
|
readonly minLength: 64;
|
|
793
|
-
readonly pattern: "^[A-Za-z0-9]
|
|
794
|
-
readonly description: "Hetzner Cloud API token with read
|
|
1045
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
1046
|
+
readonly description: "Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.";
|
|
795
1047
|
};
|
|
796
1048
|
};
|
|
797
1049
|
readonly required: readonly ["enabled"];
|
|
@@ -824,6 +1076,7 @@ export declare const FleetUpdateInputSchema: {
|
|
|
824
1076
|
};
|
|
825
1077
|
readonly minItems: 1;
|
|
826
1078
|
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1079
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
827
1080
|
};
|
|
828
1081
|
readonly 'kubernetes.io/arch': {
|
|
829
1082
|
readonly type: "array";
|
|
@@ -833,6 +1086,7 @@ export declare const FleetUpdateInputSchema: {
|
|
|
833
1086
|
};
|
|
834
1087
|
readonly minItems: 1;
|
|
835
1088
|
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1089
|
+
readonly default: readonly ["amd64"];
|
|
836
1090
|
};
|
|
837
1091
|
readonly 'cfke.io/instance-family': {
|
|
838
1092
|
readonly type: "array";
|
|
@@ -841,6 +1095,7 @@ export declare const FleetUpdateInputSchema: {
|
|
|
841
1095
|
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
842
1096
|
};
|
|
843
1097
|
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1098
|
+
readonly default: readonly [];
|
|
844
1099
|
};
|
|
845
1100
|
readonly 'topology.kubernetes.io/region': {
|
|
846
1101
|
readonly type: "array";
|
|
@@ -849,19 +1104,47 @@ export declare const FleetUpdateInputSchema: {
|
|
|
849
1104
|
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
850
1105
|
};
|
|
851
1106
|
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1107
|
+
readonly default: readonly [];
|
|
852
1108
|
};
|
|
853
1109
|
};
|
|
854
1110
|
readonly additionalProperties: false;
|
|
855
|
-
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.
|
|
1111
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
1112
|
+
readonly default: {
|
|
1113
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1114
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1115
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1116
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1117
|
+
};
|
|
856
1118
|
};
|
|
857
1119
|
readonly scalingProfile: {
|
|
858
1120
|
readonly type: "string";
|
|
859
|
-
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
1121
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
1122
|
+
readonly default: "conservative";
|
|
860
1123
|
readonly example: "conservative";
|
|
861
1124
|
readonly enum: readonly ["aggressive", "conservative"];
|
|
862
1125
|
};
|
|
863
1126
|
};
|
|
864
|
-
readonly
|
|
1127
|
+
readonly additionalProperties: false;
|
|
1128
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
1129
|
+
};
|
|
1130
|
+
export declare const InviteCreateInputSchema: {
|
|
1131
|
+
readonly type: "object";
|
|
1132
|
+
readonly properties: {
|
|
1133
|
+
readonly email: {
|
|
1134
|
+
readonly type: "string";
|
|
1135
|
+
readonly format: "email";
|
|
1136
|
+
readonly description: "Email address of the user to invite.";
|
|
1137
|
+
readonly example: "email@example.com";
|
|
1138
|
+
};
|
|
1139
|
+
readonly role: {
|
|
1140
|
+
readonly type: "string";
|
|
1141
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1142
|
+
readonly default: "User";
|
|
1143
|
+
readonly example: "User";
|
|
1144
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1145
|
+
};
|
|
1146
|
+
};
|
|
1147
|
+
readonly required: readonly ["email"];
|
|
865
1148
|
readonly additionalProperties: false;
|
|
866
1149
|
};
|
|
867
1150
|
export declare const InviteSchema: {
|
|
@@ -895,10 +1178,141 @@ export declare const InviteSchema: {
|
|
|
895
1178
|
readonly description: "Generated unique invite code.";
|
|
896
1179
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
897
1180
|
};
|
|
1181
|
+
readonly role: {
|
|
1182
|
+
readonly type: "string";
|
|
1183
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1184
|
+
readonly default: "User";
|
|
1185
|
+
readonly example: "User";
|
|
1186
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1187
|
+
};
|
|
898
1188
|
};
|
|
899
1189
|
readonly required: readonly ["date_created"];
|
|
900
1190
|
readonly additionalProperties: false;
|
|
901
1191
|
};
|
|
1192
|
+
export declare const InvoicePaymentAttemptSchema: {
|
|
1193
|
+
readonly type: "object";
|
|
1194
|
+
readonly properties: {
|
|
1195
|
+
readonly invoice_id: {
|
|
1196
|
+
readonly type: "string";
|
|
1197
|
+
readonly description: "Identifier of the invoice.";
|
|
1198
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
1199
|
+
};
|
|
1200
|
+
readonly number: {
|
|
1201
|
+
readonly type: "string";
|
|
1202
|
+
readonly nullable: true;
|
|
1203
|
+
readonly description: "Invoice number. Null if the invoice has no number.";
|
|
1204
|
+
readonly example: "CF-0042";
|
|
1205
|
+
};
|
|
1206
|
+
readonly amount: {
|
|
1207
|
+
readonly type: "number";
|
|
1208
|
+
readonly format: "float";
|
|
1209
|
+
readonly description: "Amount outstanding when the charge was attempted, in the smallest currency unit.";
|
|
1210
|
+
readonly example: 4200;
|
|
1211
|
+
};
|
|
1212
|
+
readonly currency: {
|
|
1213
|
+
readonly type: "string";
|
|
1214
|
+
readonly description: "Currency of the invoice.";
|
|
1215
|
+
readonly example: "eur";
|
|
1216
|
+
};
|
|
1217
|
+
readonly status: {
|
|
1218
|
+
readonly type: "string";
|
|
1219
|
+
readonly description: "Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).";
|
|
1220
|
+
readonly example: "paid";
|
|
1221
|
+
readonly enum: readonly ["paid", "processing", "requires_action", "failed"];
|
|
1222
|
+
};
|
|
1223
|
+
readonly client_secret: {
|
|
1224
|
+
readonly type: "string";
|
|
1225
|
+
readonly nullable: true;
|
|
1226
|
+
readonly description: "Client secret used to complete customer authentication. Set only when `status` is `requires_action`.";
|
|
1227
|
+
readonly example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH";
|
|
1228
|
+
};
|
|
1229
|
+
readonly failure_code: {
|
|
1230
|
+
readonly type: "string";
|
|
1231
|
+
readonly nullable: true;
|
|
1232
|
+
readonly description: "Decline code. Set only when `status` is `failed`.";
|
|
1233
|
+
readonly example: "insufficient_funds";
|
|
1234
|
+
};
|
|
1235
|
+
readonly failure_message: {
|
|
1236
|
+
readonly type: "string";
|
|
1237
|
+
readonly nullable: true;
|
|
1238
|
+
readonly description: "Explanation of the decline, suitable for display. Set only when `status` is `failed`.";
|
|
1239
|
+
readonly example: "Your card has insufficient funds.";
|
|
1240
|
+
};
|
|
1241
|
+
};
|
|
1242
|
+
readonly required: readonly ["invoice_id", "number", "amount", "currency", "status", "client_secret", "failure_code", "failure_message"];
|
|
1243
|
+
readonly additionalProperties: false;
|
|
1244
|
+
};
|
|
1245
|
+
export declare const InvoicePaymentResultSchema: {
|
|
1246
|
+
readonly type: "object";
|
|
1247
|
+
readonly properties: {
|
|
1248
|
+
readonly code: {
|
|
1249
|
+
readonly type: "string";
|
|
1250
|
+
readonly description: "Overall outcome: `paid` (nothing outstanding), `processing` (all accepted, not yet settled), `action_required` (one or more await customer authentication), `partially_paid`, `failed`, `nothing_due`, or `bank_transfer_due` (the organization pays by bank transfer; nothing was charged).";
|
|
1251
|
+
readonly example: "partially_paid";
|
|
1252
|
+
readonly enum: readonly ["paid", "processing", "action_required", "partially_paid", "failed", "nothing_due", "bank_transfer_due"];
|
|
1253
|
+
};
|
|
1254
|
+
readonly message: {
|
|
1255
|
+
readonly type: "string";
|
|
1256
|
+
readonly description: "Summary of the outcome, suitable for display.";
|
|
1257
|
+
readonly example: "1 of 2 open invoices was paid. Invoice CF-0043 was declined: Your card has insufficient funds.";
|
|
1258
|
+
};
|
|
1259
|
+
readonly results: {
|
|
1260
|
+
readonly type: "array";
|
|
1261
|
+
readonly items: {
|
|
1262
|
+
readonly type: "object";
|
|
1263
|
+
readonly properties: {
|
|
1264
|
+
readonly invoice_id: {
|
|
1265
|
+
readonly type: "string";
|
|
1266
|
+
readonly description: "Identifier of the invoice.";
|
|
1267
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
1268
|
+
};
|
|
1269
|
+
readonly number: {
|
|
1270
|
+
readonly type: "string";
|
|
1271
|
+
readonly description: "Invoice number. Null if the invoice has no number.";
|
|
1272
|
+
readonly example: "CF-0042";
|
|
1273
|
+
};
|
|
1274
|
+
readonly amount: {
|
|
1275
|
+
readonly type: "number";
|
|
1276
|
+
readonly format: "float";
|
|
1277
|
+
readonly description: "Amount outstanding when the charge was attempted, in the smallest currency unit.";
|
|
1278
|
+
readonly example: 4200;
|
|
1279
|
+
};
|
|
1280
|
+
readonly currency: {
|
|
1281
|
+
readonly type: "string";
|
|
1282
|
+
readonly description: "Currency of the invoice.";
|
|
1283
|
+
readonly example: "eur";
|
|
1284
|
+
};
|
|
1285
|
+
readonly status: {
|
|
1286
|
+
readonly type: "string";
|
|
1287
|
+
readonly description: "Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).";
|
|
1288
|
+
readonly example: "paid";
|
|
1289
|
+
readonly enum: readonly ["paid", "processing", "requires_action", "failed"];
|
|
1290
|
+
};
|
|
1291
|
+
readonly client_secret: {
|
|
1292
|
+
readonly type: "string";
|
|
1293
|
+
readonly description: "Client secret used to complete customer authentication. Set only when `status` is `requires_action`.";
|
|
1294
|
+
readonly example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH";
|
|
1295
|
+
};
|
|
1296
|
+
readonly failure_code: {
|
|
1297
|
+
readonly type: "string";
|
|
1298
|
+
readonly description: "Decline code. Set only when `status` is `failed`.";
|
|
1299
|
+
readonly example: "insufficient_funds";
|
|
1300
|
+
};
|
|
1301
|
+
readonly failure_message: {
|
|
1302
|
+
readonly type: "string";
|
|
1303
|
+
readonly description: "Explanation of the decline, suitable for display. Set only when `status` is `failed`.";
|
|
1304
|
+
readonly example: "Your card has insufficient funds.";
|
|
1305
|
+
};
|
|
1306
|
+
};
|
|
1307
|
+
readonly required: readonly ["invoice_id", "number", "amount", "currency", "status", "client_secret", "failure_code", "failure_message"];
|
|
1308
|
+
readonly additionalProperties: false;
|
|
1309
|
+
};
|
|
1310
|
+
readonly description: "One entry per invoice charged, oldest first.";
|
|
1311
|
+
};
|
|
1312
|
+
};
|
|
1313
|
+
readonly required: readonly ["code", "message", "results"];
|
|
1314
|
+
readonly additionalProperties: false;
|
|
1315
|
+
};
|
|
902
1316
|
export declare const InvoiceSchema: {
|
|
903
1317
|
readonly type: "object";
|
|
904
1318
|
readonly properties: {
|
|
@@ -1092,6 +1506,12 @@ export declare const MarketplaceListingSchema: {
|
|
|
1092
1506
|
export declare const OrganizationCreateInputSchema: {
|
|
1093
1507
|
readonly type: "object";
|
|
1094
1508
|
readonly properties: {
|
|
1509
|
+
readonly type: {
|
|
1510
|
+
readonly type: "string";
|
|
1511
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1512
|
+
readonly example: "business";
|
|
1513
|
+
readonly enum: readonly ["business", "personal"];
|
|
1514
|
+
};
|
|
1095
1515
|
readonly email: {
|
|
1096
1516
|
readonly type: "string";
|
|
1097
1517
|
readonly format: "email";
|
|
@@ -1100,11 +1520,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
1100
1520
|
};
|
|
1101
1521
|
readonly first_name: {
|
|
1102
1522
|
readonly type: "string";
|
|
1523
|
+
readonly minLength: 1;
|
|
1103
1524
|
readonly description: "First name of the billing contact person.";
|
|
1104
1525
|
readonly example: "John";
|
|
1105
1526
|
};
|
|
1106
1527
|
readonly last_name: {
|
|
1107
1528
|
readonly type: "string";
|
|
1529
|
+
readonly minLength: 1;
|
|
1108
1530
|
readonly description: "Last name of the billing contact person.";
|
|
1109
1531
|
readonly example: "Doe";
|
|
1110
1532
|
};
|
|
@@ -1122,7 +1544,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
1122
1544
|
readonly description: "Password for the root account. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.";
|
|
1123
1545
|
};
|
|
1124
1546
|
};
|
|
1125
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1547
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1548
|
+
readonly additionalProperties: false;
|
|
1549
|
+
};
|
|
1550
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1551
|
+
readonly type: "object";
|
|
1552
|
+
readonly properties: {
|
|
1553
|
+
readonly id: {
|
|
1554
|
+
readonly type: "string";
|
|
1555
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1556
|
+
readonly example: "organization-id";
|
|
1557
|
+
};
|
|
1558
|
+
};
|
|
1559
|
+
readonly required: readonly ["id"];
|
|
1126
1560
|
readonly additionalProperties: false;
|
|
1127
1561
|
};
|
|
1128
1562
|
export declare const OrganizationSchema: {
|
|
@@ -1141,6 +1575,12 @@ export declare const OrganizationSchema: {
|
|
|
1141
1575
|
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1142
1576
|
readonly example: "ACME Corp.";
|
|
1143
1577
|
};
|
|
1578
|
+
readonly type: {
|
|
1579
|
+
readonly type: "string";
|
|
1580
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1581
|
+
readonly example: "business";
|
|
1582
|
+
readonly enum: readonly ["business", "personal"];
|
|
1583
|
+
};
|
|
1144
1584
|
readonly date_created: {
|
|
1145
1585
|
readonly type: "string";
|
|
1146
1586
|
readonly format: "date-time";
|
|
@@ -1172,6 +1612,17 @@ export declare const OrganizationSchema: {
|
|
|
1172
1612
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1173
1613
|
readonly example: 999;
|
|
1174
1614
|
};
|
|
1615
|
+
readonly enterprise_clusters_max: {
|
|
1616
|
+
readonly type: "integer";
|
|
1617
|
+
readonly minimum: 0;
|
|
1618
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1619
|
+
readonly example: 999;
|
|
1620
|
+
};
|
|
1621
|
+
readonly enterprise_clusters_available: {
|
|
1622
|
+
readonly type: "integer";
|
|
1623
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1624
|
+
readonly example: 999;
|
|
1625
|
+
};
|
|
1175
1626
|
readonly fleets_max: {
|
|
1176
1627
|
readonly type: "integer";
|
|
1177
1628
|
readonly minimum: 0;
|
|
@@ -1191,7 +1642,7 @@ export declare const OrganizationSchema: {
|
|
|
1191
1642
|
readonly type: "array";
|
|
1192
1643
|
readonly items: {
|
|
1193
1644
|
readonly type: "string";
|
|
1194
|
-
readonly example: "northamerica-central-
|
|
1645
|
+
readonly example: "northamerica-central-1a";
|
|
1195
1646
|
};
|
|
1196
1647
|
readonly minItems: 1;
|
|
1197
1648
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1225,7 +1676,7 @@ export declare const OrganizationSchema: {
|
|
|
1225
1676
|
readonly example: 500;
|
|
1226
1677
|
};
|
|
1227
1678
|
};
|
|
1228
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1679
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "enterprise_clusters_max", "enterprise_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1229
1680
|
readonly additionalProperties: false;
|
|
1230
1681
|
readonly description: "For security reasons, platform quota is controlled by Cloudfleet and can be updated only by Cloudfleet administrators. Please open a support ticket if you need to change the platform quota.";
|
|
1231
1682
|
};
|
|
@@ -1234,8 +1685,14 @@ export declare const OrganizationSchema: {
|
|
|
1234
1685
|
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1235
1686
|
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1236
1687
|
};
|
|
1688
|
+
readonly verification: {
|
|
1689
|
+
readonly type: "string";
|
|
1690
|
+
readonly description: "Verification status of the organization, which determines the assigned quota. `none` when billing information is incomplete, `submitted` when billing information is complete but the organization is not yet verified, `verified` when the organization is verified.";
|
|
1691
|
+
readonly example: "verified";
|
|
1692
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1693
|
+
};
|
|
1237
1694
|
};
|
|
1238
|
-
readonly required: readonly ["id", "date_created", "quota", "status"];
|
|
1695
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1239
1696
|
readonly additionalProperties: false;
|
|
1240
1697
|
};
|
|
1241
1698
|
export declare const PaymentMethodSchema: {
|
|
@@ -1243,26 +1700,19 @@ export declare const PaymentMethodSchema: {
|
|
|
1243
1700
|
readonly properties: {
|
|
1244
1701
|
readonly id: {
|
|
1245
1702
|
readonly type: "string";
|
|
1246
|
-
readonly
|
|
1247
|
-
readonly
|
|
1248
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1249
|
-
};
|
|
1250
|
-
readonly setup: {
|
|
1251
|
-
readonly type: "boolean";
|
|
1252
|
-
readonly description: "Whether organization payment method was set up and ready to use for payments.";
|
|
1253
|
-
readonly example: true;
|
|
1703
|
+
readonly description: "Payment method identifier. Stripe payment method id for cards/SEPA; the constant `bank_transfer` for the invoice/bank-transfer method. Used to set as default or delete the payment method.";
|
|
1704
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1254
1705
|
};
|
|
1255
1706
|
readonly type: {
|
|
1256
1707
|
readonly type: "string";
|
|
1257
|
-
readonly
|
|
1258
|
-
readonly description: "Payment method type type. Only `card` payments supported at the moment.";
|
|
1708
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1259
1709
|
readonly example: "card";
|
|
1260
|
-
readonly enum: readonly ["card"];
|
|
1710
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1261
1711
|
};
|
|
1262
1712
|
readonly last4: {
|
|
1263
1713
|
readonly type: "string";
|
|
1264
1714
|
readonly nullable: true;
|
|
1265
|
-
readonly description: "Last 4 digits of the payment card number.";
|
|
1715
|
+
readonly description: "Last 4 digits of the payment card number, of the bank account (IBAN) for SEPA Direct Debit, or of the destination IBAN for bank transfer.";
|
|
1266
1716
|
readonly example: "4242";
|
|
1267
1717
|
};
|
|
1268
1718
|
readonly exp_month: {
|
|
@@ -1270,25 +1720,46 @@ export declare const PaymentMethodSchema: {
|
|
|
1270
1720
|
readonly minimum: 1;
|
|
1271
1721
|
readonly maximum: 12;
|
|
1272
1722
|
readonly nullable: true;
|
|
1273
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1274
|
-
readonly example:
|
|
1723
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1724
|
+
readonly example: 12;
|
|
1275
1725
|
};
|
|
1276
1726
|
readonly exp_year: {
|
|
1277
1727
|
readonly type: "integer";
|
|
1278
|
-
readonly minimum: 2024;
|
|
1279
1728
|
readonly nullable: true;
|
|
1280
|
-
readonly description: "Four-digit number representing the card's expiration year.";
|
|
1281
|
-
readonly example:
|
|
1729
|
+
readonly description: "Four-digit number representing the card's expiration year. May be in the past for an expired card still on file. Null for SEPA Direct Debit and bank transfer.";
|
|
1730
|
+
readonly example: 2028;
|
|
1282
1731
|
};
|
|
1283
1732
|
readonly brand: {
|
|
1284
1733
|
readonly type: "string";
|
|
1285
1734
|
readonly nullable: true;
|
|
1286
|
-
readonly description: "Payment card brand
|
|
1735
|
+
readonly description: "Payment card brand as reported by Stripe, e.g. `visa`, `mastercard`, `amex`, `cartes_bancaires`, or `unknown`. Null for SEPA Direct Debit and bank transfer.";
|
|
1287
1736
|
readonly example: "visa";
|
|
1288
|
-
|
|
1737
|
+
};
|
|
1738
|
+
readonly iban: {
|
|
1739
|
+
readonly type: "string";
|
|
1740
|
+
readonly nullable: true;
|
|
1741
|
+
readonly description: "Full destination IBAN to send bank transfers to. Set only for `bank_transfer`; null otherwise. This is Cloudfleet's virtual receiving account, shown in full so the customer can pay into it.";
|
|
1742
|
+
readonly example: "DE11243015658023127510";
|
|
1743
|
+
};
|
|
1744
|
+
readonly bic: {
|
|
1745
|
+
readonly type: "string";
|
|
1746
|
+
readonly nullable: true;
|
|
1747
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1748
|
+
readonly example: "SOGEDEFFXXX";
|
|
1749
|
+
};
|
|
1750
|
+
readonly account_holder_name: {
|
|
1751
|
+
readonly type: "string";
|
|
1752
|
+
readonly nullable: true;
|
|
1753
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1754
|
+
readonly example: "Cloudfleet GmbH";
|
|
1755
|
+
};
|
|
1756
|
+
readonly is_default: {
|
|
1757
|
+
readonly type: "boolean";
|
|
1758
|
+
readonly description: "Whether this payment method is the default used for invoices and active subscriptions. Always false for `bank_transfer` (it cannot be a Stripe default payment method).";
|
|
1759
|
+
readonly example: true;
|
|
1289
1760
|
};
|
|
1290
1761
|
};
|
|
1291
|
-
readonly required: readonly ["id", "
|
|
1762
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1292
1763
|
readonly additionalProperties: false;
|
|
1293
1764
|
};
|
|
1294
1765
|
export declare const PlatformQuotaSchema: {
|
|
@@ -1316,6 +1787,17 @@ export declare const PlatformQuotaSchema: {
|
|
|
1316
1787
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1317
1788
|
readonly example: 999;
|
|
1318
1789
|
};
|
|
1790
|
+
readonly enterprise_clusters_max: {
|
|
1791
|
+
readonly type: "integer";
|
|
1792
|
+
readonly minimum: 0;
|
|
1793
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1794
|
+
readonly example: 999;
|
|
1795
|
+
};
|
|
1796
|
+
readonly enterprise_clusters_available: {
|
|
1797
|
+
readonly type: "integer";
|
|
1798
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1799
|
+
readonly example: 999;
|
|
1800
|
+
};
|
|
1319
1801
|
readonly fleets_max: {
|
|
1320
1802
|
readonly type: "integer";
|
|
1321
1803
|
readonly minimum: 0;
|
|
@@ -1335,7 +1817,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1335
1817
|
readonly type: "array";
|
|
1336
1818
|
readonly items: {
|
|
1337
1819
|
readonly type: "string";
|
|
1338
|
-
readonly example: "northamerica-central-
|
|
1820
|
+
readonly example: "northamerica-central-1a";
|
|
1339
1821
|
};
|
|
1340
1822
|
readonly minItems: 1;
|
|
1341
1823
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1369,7 +1851,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1369
1851
|
readonly example: 500;
|
|
1370
1852
|
};
|
|
1371
1853
|
};
|
|
1372
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1854
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "enterprise_clusters_max", "enterprise_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1373
1855
|
readonly additionalProperties: false;
|
|
1374
1856
|
};
|
|
1375
1857
|
export declare const RegistryRepositorySchema: {
|
|
@@ -1660,142 +2142,6 @@ export declare const TicketCreateInputSchema: {
|
|
|
1660
2142
|
readonly required: readonly ["category", "body"];
|
|
1661
2143
|
readonly additionalProperties: false;
|
|
1662
2144
|
};
|
|
1663
|
-
export declare const TicketListResponseSchema: {
|
|
1664
|
-
readonly type: "object";
|
|
1665
|
-
readonly properties: {
|
|
1666
|
-
readonly items: {
|
|
1667
|
-
readonly type: "array";
|
|
1668
|
-
readonly items: {
|
|
1669
|
-
readonly type: "object";
|
|
1670
|
-
readonly properties: {
|
|
1671
|
-
readonly id: {
|
|
1672
|
-
readonly type: "string";
|
|
1673
|
-
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
1674
|
-
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
1675
|
-
};
|
|
1676
|
-
readonly status: {
|
|
1677
|
-
readonly type: "string";
|
|
1678
|
-
readonly description: "Current state of the ticket.";
|
|
1679
|
-
readonly example: "waiting_on_us";
|
|
1680
|
-
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
1681
|
-
};
|
|
1682
|
-
readonly category: {
|
|
1683
|
-
readonly type: "string";
|
|
1684
|
-
readonly description: "Ticket category.";
|
|
1685
|
-
readonly example: "technical";
|
|
1686
|
-
readonly enum: readonly ["billing", "technical", "general"];
|
|
1687
|
-
};
|
|
1688
|
-
readonly summary: {
|
|
1689
|
-
readonly type: "string";
|
|
1690
|
-
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
1691
|
-
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1692
|
-
};
|
|
1693
|
-
readonly closed_at: {
|
|
1694
|
-
readonly type: "string";
|
|
1695
|
-
readonly format: "date-time";
|
|
1696
|
-
readonly nullable: true;
|
|
1697
|
-
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
1698
|
-
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1699
|
-
};
|
|
1700
|
-
readonly date_created: {
|
|
1701
|
-
readonly type: "string";
|
|
1702
|
-
readonly format: "date-time";
|
|
1703
|
-
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
1704
|
-
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1705
|
-
};
|
|
1706
|
-
readonly date_updated: {
|
|
1707
|
-
readonly type: "string";
|
|
1708
|
-
readonly format: "date-time";
|
|
1709
|
-
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
1710
|
-
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1711
|
-
};
|
|
1712
|
-
readonly messages: {
|
|
1713
|
-
readonly type: "array";
|
|
1714
|
-
readonly items: {
|
|
1715
|
-
readonly type: "object";
|
|
1716
|
-
readonly properties: {
|
|
1717
|
-
readonly id: {
|
|
1718
|
-
readonly type: "string";
|
|
1719
|
-
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
1720
|
-
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
1721
|
-
};
|
|
1722
|
-
readonly type: {
|
|
1723
|
-
readonly type: "string";
|
|
1724
|
-
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
1725
|
-
readonly example: "customer_reply";
|
|
1726
|
-
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
1727
|
-
};
|
|
1728
|
-
readonly body: {
|
|
1729
|
-
readonly type: "string";
|
|
1730
|
-
readonly description: "Message body in markdown.";
|
|
1731
|
-
readonly example: "Thanks — that resolved it on my side.";
|
|
1732
|
-
};
|
|
1733
|
-
readonly author_first_name: {
|
|
1734
|
-
readonly type: "string";
|
|
1735
|
-
readonly nullable: true;
|
|
1736
|
-
readonly description: "First name of the author. Null when not provided.";
|
|
1737
|
-
readonly example: "Jane";
|
|
1738
|
-
};
|
|
1739
|
-
readonly author_last_name: {
|
|
1740
|
-
readonly type: "string";
|
|
1741
|
-
readonly nullable: true;
|
|
1742
|
-
readonly description: "Last name of the author. Null when not provided.";
|
|
1743
|
-
readonly example: "Doe";
|
|
1744
|
-
};
|
|
1745
|
-
readonly attachments: {
|
|
1746
|
-
readonly type: "array";
|
|
1747
|
-
readonly items: {
|
|
1748
|
-
readonly type: "object";
|
|
1749
|
-
readonly properties: {
|
|
1750
|
-
readonly id: {
|
|
1751
|
-
readonly type: "string";
|
|
1752
|
-
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
1753
|
-
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1754
|
-
};
|
|
1755
|
-
readonly filename: {
|
|
1756
|
-
readonly type: "string";
|
|
1757
|
-
readonly description: "Original filename as uploaded.";
|
|
1758
|
-
readonly example: "debug.log";
|
|
1759
|
-
};
|
|
1760
|
-
readonly content_type: {
|
|
1761
|
-
readonly type: "string";
|
|
1762
|
-
readonly description: "MIME content type of the attachment.";
|
|
1763
|
-
readonly example: "text/plain";
|
|
1764
|
-
};
|
|
1765
|
-
readonly size: {
|
|
1766
|
-
readonly type: "integer";
|
|
1767
|
-
readonly description: "Size of the attachment in bytes.";
|
|
1768
|
-
readonly example: 12345;
|
|
1769
|
-
};
|
|
1770
|
-
};
|
|
1771
|
-
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1772
|
-
readonly additionalProperties: false;
|
|
1773
|
-
};
|
|
1774
|
-
readonly description: "Attachments associated with this message.";
|
|
1775
|
-
readonly example: readonly [];
|
|
1776
|
-
};
|
|
1777
|
-
readonly date_created: {
|
|
1778
|
-
readonly type: "string";
|
|
1779
|
-
readonly format: "date-time";
|
|
1780
|
-
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
1781
|
-
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1782
|
-
};
|
|
1783
|
-
};
|
|
1784
|
-
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
1785
|
-
readonly additionalProperties: false;
|
|
1786
|
-
};
|
|
1787
|
-
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
1788
|
-
};
|
|
1789
|
-
};
|
|
1790
|
-
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1791
|
-
readonly additionalProperties: false;
|
|
1792
|
-
};
|
|
1793
|
-
readonly description: "Tickets for the organization, ordered newest first. Messages are omitted from list responses.";
|
|
1794
|
-
};
|
|
1795
|
-
};
|
|
1796
|
-
readonly required: readonly ["items"];
|
|
1797
|
-
readonly additionalProperties: false;
|
|
1798
|
-
};
|
|
1799
2145
|
export declare const TicketMessageInputSchema: {
|
|
1800
2146
|
readonly type: "object";
|
|
1801
2147
|
readonly properties: {
|
|
@@ -1832,11 +2178,13 @@ export declare const TicketMessageSchema: {
|
|
|
1832
2178
|
};
|
|
1833
2179
|
readonly author_first_name: {
|
|
1834
2180
|
readonly type: "string";
|
|
2181
|
+
readonly nullable: true;
|
|
1835
2182
|
readonly description: "First name of the author. Null when not provided.";
|
|
1836
2183
|
readonly example: "Jane";
|
|
1837
2184
|
};
|
|
1838
2185
|
readonly author_last_name: {
|
|
1839
2186
|
readonly type: "string";
|
|
2187
|
+
readonly nullable: true;
|
|
1840
2188
|
readonly description: "Last name of the author. Null when not provided.";
|
|
1841
2189
|
readonly example: "Doe";
|
|
1842
2190
|
};
|
|
@@ -1910,6 +2258,7 @@ export declare const TicketSchema: {
|
|
|
1910
2258
|
readonly closed_at: {
|
|
1911
2259
|
readonly type: "string";
|
|
1912
2260
|
readonly format: "date-time";
|
|
2261
|
+
readonly nullable: true;
|
|
1913
2262
|
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
1914
2263
|
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1915
2264
|
};
|
|
@@ -2097,9 +2446,10 @@ export declare const UsageFacetsSchema: {
|
|
|
2097
2446
|
readonly type: "array";
|
|
2098
2447
|
readonly items: {
|
|
2099
2448
|
readonly type: "string";
|
|
2449
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
2100
2450
|
};
|
|
2101
2451
|
readonly description: "List of unique products";
|
|
2102
|
-
readonly example: readonly ["
|
|
2452
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
2103
2453
|
};
|
|
2104
2454
|
};
|
|
2105
2455
|
readonly additionalProperties: false;
|
|
@@ -2125,7 +2475,8 @@ export declare const UsageResponseSchema: {
|
|
|
2125
2475
|
readonly product: {
|
|
2126
2476
|
readonly type: "string";
|
|
2127
2477
|
readonly description: "The product the usage is associated with";
|
|
2128
|
-
readonly example: "
|
|
2478
|
+
readonly example: "cfke_controlplane_pro";
|
|
2479
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
2129
2480
|
};
|
|
2130
2481
|
readonly value: {
|
|
2131
2482
|
readonly type: "number";
|
|
@@ -2165,9 +2516,10 @@ export declare const UsageResponseSchema: {
|
|
|
2165
2516
|
readonly type: "array";
|
|
2166
2517
|
readonly items: {
|
|
2167
2518
|
readonly type: "string";
|
|
2519
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
2168
2520
|
};
|
|
2169
2521
|
readonly description: "List of unique products";
|
|
2170
|
-
readonly example: readonly ["
|
|
2522
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
2171
2523
|
};
|
|
2172
2524
|
};
|
|
2173
2525
|
readonly additionalProperties: false;
|
|
@@ -2193,7 +2545,8 @@ export declare const UsageSchema: {
|
|
|
2193
2545
|
readonly product: {
|
|
2194
2546
|
readonly type: "string";
|
|
2195
2547
|
readonly description: "The product the usage is associated with";
|
|
2196
|
-
readonly example: "
|
|
2548
|
+
readonly example: "cfke_controlplane_pro";
|
|
2549
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
2197
2550
|
};
|
|
2198
2551
|
readonly value: {
|
|
2199
2552
|
readonly type: "number";
|
|
@@ -2250,18 +2603,6 @@ export declare const UserCreateInputSchema: {
|
|
|
2250
2603
|
readonly minLength: 8;
|
|
2251
2604
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
2252
2605
|
};
|
|
2253
|
-
readonly status: {
|
|
2254
|
-
readonly type: "string";
|
|
2255
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
2256
|
-
readonly example: "active";
|
|
2257
|
-
readonly enum: readonly ["active", "inactive"];
|
|
2258
|
-
};
|
|
2259
|
-
readonly role: {
|
|
2260
|
-
readonly type: "string";
|
|
2261
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
2262
|
-
readonly example: "User";
|
|
2263
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
2264
|
-
};
|
|
2265
2606
|
};
|
|
2266
2607
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
2267
2608
|
readonly additionalProperties: false;
|