@cloudfleet/sdk 0.0.1-c4175a2 → 0.0.1-c4563f6
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 +521 -576
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +520 -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 +774 -252
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +1045 -362
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +265 -209
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +396 -312
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +1359 -838
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +1919 -1542
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +618 -366
- 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,27 @@ 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 of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
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";
|
|
597
|
+
}, {
|
|
598
|
+
readonly type: "string";
|
|
599
|
+
readonly enum: readonly [""];
|
|
600
|
+
}];
|
|
601
|
+
};
|
|
602
|
+
readonly endpoint_public: {
|
|
603
|
+
readonly anyOf: readonly [{
|
|
604
|
+
readonly type: "string";
|
|
605
|
+
readonly format: "uri";
|
|
606
|
+
readonly description: "Deprecated alias of `endpoint`; retained for backward compatibility.";
|
|
607
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
421
608
|
}, {
|
|
422
609
|
readonly type: "string";
|
|
423
610
|
readonly enum: readonly [""];
|
|
@@ -448,15 +635,10 @@ export declare const ClusterSchema: {
|
|
|
448
635
|
readonly description: "Indicates if the cluster is ready to be used.";
|
|
449
636
|
readonly example: true;
|
|
450
637
|
};
|
|
451
|
-
readonly version_channel: {
|
|
452
|
-
readonly type: "string";
|
|
453
|
-
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-]+)*))?$";
|
|
454
|
-
readonly description: "Version of the kubernetes cluster.";
|
|
455
|
-
readonly example: "1.x.x-cfke.x";
|
|
456
|
-
};
|
|
457
638
|
};
|
|
458
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
639
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
459
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.";
|
|
460
642
|
};
|
|
461
643
|
export declare const ClusterUpdateInputSchema: {
|
|
462
644
|
readonly type: "object";
|
|
@@ -472,18 +654,60 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
472
654
|
readonly tier: {
|
|
473
655
|
readonly type: "string";
|
|
474
656
|
readonly description: "Tier of the cluster.";
|
|
657
|
+
readonly default: "basic";
|
|
475
658
|
readonly example: "pro";
|
|
476
|
-
readonly enum: readonly ["basic", "pro"];
|
|
659
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
477
660
|
};
|
|
478
661
|
readonly version_channel: {
|
|
479
662
|
readonly type: "string";
|
|
480
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-]+)*))?$";
|
|
481
664
|
readonly description: "Version of the kubernetes cluster.";
|
|
665
|
+
readonly default: "1.x.x-cfke.x";
|
|
482
666
|
readonly example: "1.x.x-cfke.x";
|
|
483
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
|
+
};
|
|
484
707
|
};
|
|
485
|
-
readonly required: readonly ["
|
|
708
|
+
readonly required: readonly ["name"];
|
|
486
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.";
|
|
487
711
|
};
|
|
488
712
|
export declare const FleetCreateInputSchema: {
|
|
489
713
|
readonly type: "object";
|
|
@@ -492,10 +716,10 @@ export declare const FleetCreateInputSchema: {
|
|
|
492
716
|
readonly type: "object";
|
|
493
717
|
readonly properties: {
|
|
494
718
|
readonly cpu: {
|
|
495
|
-
readonly type: "
|
|
496
|
-
readonly format: "float";
|
|
719
|
+
readonly type: "integer";
|
|
497
720
|
readonly minimum: 0;
|
|
498
|
-
readonly
|
|
721
|
+
readonly maximum: 100000;
|
|
722
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
499
723
|
};
|
|
500
724
|
};
|
|
501
725
|
readonly additionalProperties: false;
|
|
@@ -506,14 +730,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
506
730
|
readonly properties: {
|
|
507
731
|
readonly enabled: {
|
|
508
732
|
readonly type: "boolean";
|
|
509
|
-
readonly default: true;
|
|
510
733
|
};
|
|
511
734
|
readonly project: {
|
|
512
735
|
readonly type: "string";
|
|
513
|
-
readonly
|
|
736
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
737
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
738
|
+
readonly example: "my-cloudfleet-project";
|
|
514
739
|
};
|
|
515
740
|
};
|
|
516
|
-
readonly required: readonly ["
|
|
741
|
+
readonly required: readonly ["enabled"];
|
|
517
742
|
readonly additionalProperties: false;
|
|
518
743
|
};
|
|
519
744
|
readonly hetzner: {
|
|
@@ -521,13 +746,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
521
746
|
readonly properties: {
|
|
522
747
|
readonly enabled: {
|
|
523
748
|
readonly type: "boolean";
|
|
524
|
-
readonly default: true;
|
|
525
749
|
};
|
|
526
750
|
readonly apiKey: {
|
|
527
751
|
readonly type: "string";
|
|
528
|
-
readonly
|
|
752
|
+
readonly maxLength: 64;
|
|
753
|
+
readonly minLength: 64;
|
|
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.";
|
|
529
756
|
};
|
|
530
757
|
};
|
|
758
|
+
readonly required: readonly ["enabled"];
|
|
531
759
|
readonly additionalProperties: false;
|
|
532
760
|
};
|
|
533
761
|
readonly aws: {
|
|
@@ -535,14 +763,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
535
763
|
readonly properties: {
|
|
536
764
|
readonly enabled: {
|
|
537
765
|
readonly type: "boolean";
|
|
538
|
-
readonly default: true;
|
|
539
766
|
};
|
|
540
767
|
readonly controllerRoleArn: {
|
|
541
768
|
readonly type: "string";
|
|
542
|
-
readonly
|
|
769
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
770
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
771
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
543
772
|
};
|
|
544
773
|
};
|
|
545
|
-
readonly required: readonly ["
|
|
774
|
+
readonly required: readonly ["enabled"];
|
|
546
775
|
readonly additionalProperties: false;
|
|
547
776
|
};
|
|
548
777
|
readonly constraints: {
|
|
@@ -554,7 +783,9 @@ export declare const FleetCreateInputSchema: {
|
|
|
554
783
|
readonly type: "string";
|
|
555
784
|
readonly enum: readonly ["on-demand", "spot"];
|
|
556
785
|
};
|
|
786
|
+
readonly minItems: 1;
|
|
557
787
|
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
788
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
558
789
|
};
|
|
559
790
|
readonly 'kubernetes.io/arch': {
|
|
560
791
|
readonly type: "array";
|
|
@@ -562,7 +793,9 @@ export declare const FleetCreateInputSchema: {
|
|
|
562
793
|
readonly type: "string";
|
|
563
794
|
readonly enum: readonly ["amd64", "arm64"];
|
|
564
795
|
};
|
|
796
|
+
readonly minItems: 1;
|
|
565
797
|
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
798
|
+
readonly default: readonly ["amd64"];
|
|
566
799
|
};
|
|
567
800
|
readonly 'cfke.io/instance-family': {
|
|
568
801
|
readonly type: "array";
|
|
@@ -571,6 +804,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
571
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"];
|
|
572
805
|
};
|
|
573
806
|
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
807
|
+
readonly default: readonly [];
|
|
574
808
|
};
|
|
575
809
|
readonly 'topology.kubernetes.io/region': {
|
|
576
810
|
readonly type: "array";
|
|
@@ -579,17 +813,56 @@ export declare const FleetCreateInputSchema: {
|
|
|
579
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"];
|
|
580
814
|
};
|
|
581
815
|
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
816
|
+
readonly default: readonly [];
|
|
582
817
|
};
|
|
583
818
|
};
|
|
584
819
|
readonly additionalProperties: false;
|
|
585
|
-
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
|
+
};
|
|
586
827
|
};
|
|
587
828
|
readonly scalingProfile: {
|
|
588
829
|
readonly type: "string";
|
|
589
|
-
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`).";
|
|
831
|
+
readonly default: "conservative";
|
|
590
832
|
readonly example: "conservative";
|
|
591
833
|
readonly enum: readonly ["aggressive", "conservative"];
|
|
592
834
|
};
|
|
835
|
+
readonly taints: {
|
|
836
|
+
readonly type: "array";
|
|
837
|
+
readonly items: {
|
|
838
|
+
readonly type: "object";
|
|
839
|
+
readonly properties: {
|
|
840
|
+
readonly key: {
|
|
841
|
+
readonly type: "string";
|
|
842
|
+
readonly description: "Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.";
|
|
843
|
+
readonly example: "dedicated";
|
|
844
|
+
};
|
|
845
|
+
readonly value: {
|
|
846
|
+
readonly type: "string";
|
|
847
|
+
readonly maxLength: 63;
|
|
848
|
+
readonly pattern: "^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$";
|
|
849
|
+
readonly description: "Taint value. Optional.";
|
|
850
|
+
readonly example: "ci";
|
|
851
|
+
};
|
|
852
|
+
readonly effect: {
|
|
853
|
+
readonly type: "string";
|
|
854
|
+
readonly description: "Taint effect.";
|
|
855
|
+
readonly example: "NoSchedule";
|
|
856
|
+
readonly enum: readonly ["NoSchedule", "PreferNoSchedule", "NoExecute"];
|
|
857
|
+
};
|
|
858
|
+
};
|
|
859
|
+
readonly required: readonly ["key", "effect"];
|
|
860
|
+
readonly additionalProperties: false;
|
|
861
|
+
};
|
|
862
|
+
readonly maxItems: 50;
|
|
863
|
+
readonly description: "Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.";
|
|
864
|
+
readonly default: readonly [];
|
|
865
|
+
};
|
|
593
866
|
readonly id: {
|
|
594
867
|
readonly type: "string";
|
|
595
868
|
readonly maxLength: 63;
|
|
@@ -601,6 +874,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
601
874
|
};
|
|
602
875
|
readonly required: readonly ["id"];
|
|
603
876
|
readonly additionalProperties: false;
|
|
877
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
604
878
|
};
|
|
605
879
|
export declare const FleetSchema: {
|
|
606
880
|
readonly type: "object";
|
|
@@ -609,10 +883,10 @@ export declare const FleetSchema: {
|
|
|
609
883
|
readonly type: "object";
|
|
610
884
|
readonly properties: {
|
|
611
885
|
readonly cpu: {
|
|
612
|
-
readonly type: "
|
|
613
|
-
readonly format: "float";
|
|
886
|
+
readonly type: "integer";
|
|
614
887
|
readonly minimum: 0;
|
|
615
|
-
readonly
|
|
888
|
+
readonly maximum: 100000;
|
|
889
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
616
890
|
};
|
|
617
891
|
};
|
|
618
892
|
readonly additionalProperties: false;
|
|
@@ -623,14 +897,15 @@ export declare const FleetSchema: {
|
|
|
623
897
|
readonly properties: {
|
|
624
898
|
readonly enabled: {
|
|
625
899
|
readonly type: "boolean";
|
|
626
|
-
readonly default: true;
|
|
627
900
|
};
|
|
628
901
|
readonly project: {
|
|
629
902
|
readonly type: "string";
|
|
630
|
-
readonly
|
|
903
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
904
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
905
|
+
readonly example: "my-cloudfleet-project";
|
|
631
906
|
};
|
|
632
907
|
};
|
|
633
|
-
readonly required: readonly ["
|
|
908
|
+
readonly required: readonly ["enabled"];
|
|
634
909
|
readonly additionalProperties: false;
|
|
635
910
|
};
|
|
636
911
|
readonly hetzner: {
|
|
@@ -638,13 +913,14 @@ export declare const FleetSchema: {
|
|
|
638
913
|
readonly properties: {
|
|
639
914
|
readonly enabled: {
|
|
640
915
|
readonly type: "boolean";
|
|
641
|
-
readonly default: true;
|
|
642
916
|
};
|
|
643
917
|
readonly apiKey: {
|
|
644
918
|
readonly type: "string";
|
|
645
|
-
readonly
|
|
919
|
+
readonly pattern: "^\\*{64}$";
|
|
920
|
+
readonly description: "Redacted Hetzner API token. Returned as 64 asterisks when a token is configured; omitted otherwise. The real value is never echoed by the API.";
|
|
646
921
|
};
|
|
647
922
|
};
|
|
923
|
+
readonly required: readonly ["enabled"];
|
|
648
924
|
readonly additionalProperties: false;
|
|
649
925
|
};
|
|
650
926
|
readonly aws: {
|
|
@@ -652,14 +928,15 @@ export declare const FleetSchema: {
|
|
|
652
928
|
readonly properties: {
|
|
653
929
|
readonly enabled: {
|
|
654
930
|
readonly type: "boolean";
|
|
655
|
-
readonly default: true;
|
|
656
931
|
};
|
|
657
932
|
readonly controllerRoleArn: {
|
|
658
933
|
readonly type: "string";
|
|
659
|
-
readonly
|
|
934
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
935
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
936
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
660
937
|
};
|
|
661
938
|
};
|
|
662
|
-
readonly required: readonly ["
|
|
939
|
+
readonly required: readonly ["enabled"];
|
|
663
940
|
readonly additionalProperties: false;
|
|
664
941
|
};
|
|
665
942
|
readonly constraints: {
|
|
@@ -671,7 +948,9 @@ export declare const FleetSchema: {
|
|
|
671
948
|
readonly type: "string";
|
|
672
949
|
readonly enum: readonly ["on-demand", "spot"];
|
|
673
950
|
};
|
|
951
|
+
readonly minItems: 1;
|
|
674
952
|
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
953
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
675
954
|
};
|
|
676
955
|
readonly 'kubernetes.io/arch': {
|
|
677
956
|
readonly type: "array";
|
|
@@ -679,7 +958,9 @@ export declare const FleetSchema: {
|
|
|
679
958
|
readonly type: "string";
|
|
680
959
|
readonly enum: readonly ["amd64", "arm64"];
|
|
681
960
|
};
|
|
961
|
+
readonly minItems: 1;
|
|
682
962
|
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
963
|
+
readonly default: readonly ["amd64"];
|
|
683
964
|
};
|
|
684
965
|
readonly 'cfke.io/instance-family': {
|
|
685
966
|
readonly type: "array";
|
|
@@ -688,6 +969,7 @@ export declare const FleetSchema: {
|
|
|
688
969
|
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"];
|
|
689
970
|
};
|
|
690
971
|
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
972
|
+
readonly default: readonly [];
|
|
691
973
|
};
|
|
692
974
|
readonly 'topology.kubernetes.io/region': {
|
|
693
975
|
readonly type: "array";
|
|
@@ -696,17 +978,57 @@ export declare const FleetSchema: {
|
|
|
696
978
|
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"];
|
|
697
979
|
};
|
|
698
980
|
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
981
|
+
readonly default: readonly [];
|
|
699
982
|
};
|
|
700
983
|
};
|
|
984
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
701
985
|
readonly additionalProperties: false;
|
|
702
|
-
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.
|
|
986
|
+
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.";
|
|
987
|
+
readonly default: {
|
|
988
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
989
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
990
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
991
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
992
|
+
};
|
|
703
993
|
};
|
|
704
994
|
readonly scalingProfile: {
|
|
705
995
|
readonly type: "string";
|
|
706
|
-
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
996
|
+
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`).";
|
|
997
|
+
readonly default: "conservative";
|
|
707
998
|
readonly example: "conservative";
|
|
708
999
|
readonly enum: readonly ["aggressive", "conservative"];
|
|
709
1000
|
};
|
|
1001
|
+
readonly taints: {
|
|
1002
|
+
readonly type: "array";
|
|
1003
|
+
readonly items: {
|
|
1004
|
+
readonly type: "object";
|
|
1005
|
+
readonly properties: {
|
|
1006
|
+
readonly key: {
|
|
1007
|
+
readonly type: "string";
|
|
1008
|
+
readonly description: "Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.";
|
|
1009
|
+
readonly example: "dedicated";
|
|
1010
|
+
};
|
|
1011
|
+
readonly value: {
|
|
1012
|
+
readonly type: "string";
|
|
1013
|
+
readonly maxLength: 63;
|
|
1014
|
+
readonly pattern: "^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$";
|
|
1015
|
+
readonly description: "Taint value. Optional.";
|
|
1016
|
+
readonly example: "ci";
|
|
1017
|
+
};
|
|
1018
|
+
readonly effect: {
|
|
1019
|
+
readonly type: "string";
|
|
1020
|
+
readonly description: "Taint effect.";
|
|
1021
|
+
readonly example: "NoSchedule";
|
|
1022
|
+
readonly enum: readonly ["NoSchedule", "PreferNoSchedule", "NoExecute"];
|
|
1023
|
+
};
|
|
1024
|
+
};
|
|
1025
|
+
readonly required: readonly ["key", "effect"];
|
|
1026
|
+
readonly additionalProperties: false;
|
|
1027
|
+
};
|
|
1028
|
+
readonly maxItems: 50;
|
|
1029
|
+
readonly description: "Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.";
|
|
1030
|
+
readonly default: readonly [];
|
|
1031
|
+
};
|
|
710
1032
|
readonly id: {
|
|
711
1033
|
readonly type: "string";
|
|
712
1034
|
readonly maxLength: 63;
|
|
@@ -715,9 +1037,30 @@ export declare const FleetSchema: {
|
|
|
715
1037
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
716
1038
|
readonly example: "new-clouds-fleet";
|
|
717
1039
|
};
|
|
1040
|
+
readonly ready: {
|
|
1041
|
+
readonly type: "boolean";
|
|
1042
|
+
readonly description: "Indicates whether the fleet configuration is healthy.";
|
|
1043
|
+
readonly example: true;
|
|
1044
|
+
};
|
|
1045
|
+
readonly status_message: {
|
|
1046
|
+
readonly type: "string";
|
|
1047
|
+
readonly description: "Human-readable reason the fleet is not ready. Present only when `ready` is false.";
|
|
1048
|
+
readonly example: "Invalid provider permissions.";
|
|
1049
|
+
};
|
|
1050
|
+
readonly created_at: {
|
|
1051
|
+
readonly type: "string";
|
|
1052
|
+
readonly description: "Creation date and time of the fleet.";
|
|
1053
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1054
|
+
};
|
|
1055
|
+
readonly updated_at: {
|
|
1056
|
+
readonly type: "string";
|
|
1057
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
1058
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1059
|
+
};
|
|
718
1060
|
};
|
|
719
|
-
readonly required: readonly ["id"];
|
|
1061
|
+
readonly required: readonly ["constraints", "scalingProfile", "taints", "id", "ready", "created_at", "updated_at"];
|
|
720
1062
|
readonly additionalProperties: false;
|
|
1063
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
721
1064
|
};
|
|
722
1065
|
export declare const FleetUpdateInputSchema: {
|
|
723
1066
|
readonly type: "object";
|
|
@@ -726,10 +1069,10 @@ export declare const FleetUpdateInputSchema: {
|
|
|
726
1069
|
readonly type: "object";
|
|
727
1070
|
readonly properties: {
|
|
728
1071
|
readonly cpu: {
|
|
729
|
-
readonly type: "
|
|
730
|
-
readonly format: "float";
|
|
1072
|
+
readonly type: "integer";
|
|
731
1073
|
readonly minimum: 0;
|
|
732
|
-
readonly
|
|
1074
|
+
readonly maximum: 100000;
|
|
1075
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
733
1076
|
};
|
|
734
1077
|
};
|
|
735
1078
|
readonly additionalProperties: false;
|
|
@@ -740,14 +1083,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
740
1083
|
readonly properties: {
|
|
741
1084
|
readonly enabled: {
|
|
742
1085
|
readonly type: "boolean";
|
|
743
|
-
readonly default: true;
|
|
744
1086
|
};
|
|
745
1087
|
readonly project: {
|
|
746
1088
|
readonly type: "string";
|
|
747
|
-
readonly
|
|
1089
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
1090
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
1091
|
+
readonly example: "my-cloudfleet-project";
|
|
748
1092
|
};
|
|
749
1093
|
};
|
|
750
|
-
readonly required: readonly ["
|
|
1094
|
+
readonly required: readonly ["enabled"];
|
|
751
1095
|
readonly additionalProperties: false;
|
|
752
1096
|
};
|
|
753
1097
|
readonly hetzner: {
|
|
@@ -755,13 +1099,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
755
1099
|
readonly properties: {
|
|
756
1100
|
readonly enabled: {
|
|
757
1101
|
readonly type: "boolean";
|
|
758
|
-
readonly default: true;
|
|
759
1102
|
};
|
|
760
1103
|
readonly apiKey: {
|
|
761
1104
|
readonly type: "string";
|
|
762
|
-
readonly
|
|
1105
|
+
readonly maxLength: 64;
|
|
1106
|
+
readonly minLength: 64;
|
|
1107
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
1108
|
+
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.";
|
|
763
1109
|
};
|
|
764
1110
|
};
|
|
1111
|
+
readonly required: readonly ["enabled"];
|
|
765
1112
|
readonly additionalProperties: false;
|
|
766
1113
|
};
|
|
767
1114
|
readonly aws: {
|
|
@@ -769,14 +1116,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
769
1116
|
readonly properties: {
|
|
770
1117
|
readonly enabled: {
|
|
771
1118
|
readonly type: "boolean";
|
|
772
|
-
readonly default: true;
|
|
773
1119
|
};
|
|
774
1120
|
readonly controllerRoleArn: {
|
|
775
1121
|
readonly type: "string";
|
|
776
|
-
readonly
|
|
1122
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
1123
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
1124
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
777
1125
|
};
|
|
778
1126
|
};
|
|
779
|
-
readonly required: readonly ["
|
|
1127
|
+
readonly required: readonly ["enabled"];
|
|
780
1128
|
readonly additionalProperties: false;
|
|
781
1129
|
};
|
|
782
1130
|
readonly constraints: {
|
|
@@ -788,7 +1136,9 @@ export declare const FleetUpdateInputSchema: {
|
|
|
788
1136
|
readonly type: "string";
|
|
789
1137
|
readonly enum: readonly ["on-demand", "spot"];
|
|
790
1138
|
};
|
|
1139
|
+
readonly minItems: 1;
|
|
791
1140
|
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1141
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
792
1142
|
};
|
|
793
1143
|
readonly 'kubernetes.io/arch': {
|
|
794
1144
|
readonly type: "array";
|
|
@@ -796,7 +1146,9 @@ export declare const FleetUpdateInputSchema: {
|
|
|
796
1146
|
readonly type: "string";
|
|
797
1147
|
readonly enum: readonly ["amd64", "arm64"];
|
|
798
1148
|
};
|
|
1149
|
+
readonly minItems: 1;
|
|
799
1150
|
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1151
|
+
readonly default: readonly ["amd64"];
|
|
800
1152
|
};
|
|
801
1153
|
readonly 'cfke.io/instance-family': {
|
|
802
1154
|
readonly type: "array";
|
|
@@ -805,6 +1157,7 @@ export declare const FleetUpdateInputSchema: {
|
|
|
805
1157
|
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"];
|
|
806
1158
|
};
|
|
807
1159
|
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1160
|
+
readonly default: readonly [];
|
|
808
1161
|
};
|
|
809
1162
|
readonly 'topology.kubernetes.io/region': {
|
|
810
1163
|
readonly type: "array";
|
|
@@ -813,19 +1166,79 @@ export declare const FleetUpdateInputSchema: {
|
|
|
813
1166
|
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"];
|
|
814
1167
|
};
|
|
815
1168
|
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1169
|
+
readonly default: readonly [];
|
|
816
1170
|
};
|
|
817
1171
|
};
|
|
818
1172
|
readonly additionalProperties: false;
|
|
819
|
-
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.
|
|
1173
|
+
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.";
|
|
1174
|
+
readonly default: {
|
|
1175
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1176
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1177
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1178
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1179
|
+
};
|
|
820
1180
|
};
|
|
821
1181
|
readonly scalingProfile: {
|
|
822
1182
|
readonly type: "string";
|
|
823
|
-
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
1183
|
+
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`).";
|
|
1184
|
+
readonly default: "conservative";
|
|
824
1185
|
readonly example: "conservative";
|
|
825
1186
|
readonly enum: readonly ["aggressive", "conservative"];
|
|
826
1187
|
};
|
|
1188
|
+
readonly taints: {
|
|
1189
|
+
readonly type: "array";
|
|
1190
|
+
readonly items: {
|
|
1191
|
+
readonly type: "object";
|
|
1192
|
+
readonly properties: {
|
|
1193
|
+
readonly key: {
|
|
1194
|
+
readonly type: "string";
|
|
1195
|
+
readonly description: "Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.";
|
|
1196
|
+
readonly example: "dedicated";
|
|
1197
|
+
};
|
|
1198
|
+
readonly value: {
|
|
1199
|
+
readonly type: "string";
|
|
1200
|
+
readonly maxLength: 63;
|
|
1201
|
+
readonly pattern: "^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$";
|
|
1202
|
+
readonly description: "Taint value. Optional.";
|
|
1203
|
+
readonly example: "ci";
|
|
1204
|
+
};
|
|
1205
|
+
readonly effect: {
|
|
1206
|
+
readonly type: "string";
|
|
1207
|
+
readonly description: "Taint effect.";
|
|
1208
|
+
readonly example: "NoSchedule";
|
|
1209
|
+
readonly enum: readonly ["NoSchedule", "PreferNoSchedule", "NoExecute"];
|
|
1210
|
+
};
|
|
1211
|
+
};
|
|
1212
|
+
readonly required: readonly ["key", "effect"];
|
|
1213
|
+
readonly additionalProperties: false;
|
|
1214
|
+
};
|
|
1215
|
+
readonly maxItems: 50;
|
|
1216
|
+
readonly description: "Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.";
|
|
1217
|
+
readonly default: readonly [];
|
|
1218
|
+
};
|
|
827
1219
|
};
|
|
828
1220
|
readonly additionalProperties: false;
|
|
1221
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
1222
|
+
};
|
|
1223
|
+
export declare const InviteCreateInputSchema: {
|
|
1224
|
+
readonly type: "object";
|
|
1225
|
+
readonly properties: {
|
|
1226
|
+
readonly email: {
|
|
1227
|
+
readonly type: "string";
|
|
1228
|
+
readonly format: "email";
|
|
1229
|
+
readonly description: "Email address of the user to invite.";
|
|
1230
|
+
readonly example: "email@example.com";
|
|
1231
|
+
};
|
|
1232
|
+
readonly role: {
|
|
1233
|
+
readonly type: "string";
|
|
1234
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1235
|
+
readonly default: "User";
|
|
1236
|
+
readonly example: "User";
|
|
1237
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1238
|
+
};
|
|
1239
|
+
};
|
|
1240
|
+
readonly required: readonly ["email"];
|
|
1241
|
+
readonly additionalProperties: false;
|
|
829
1242
|
};
|
|
830
1243
|
export declare const InviteSchema: {
|
|
831
1244
|
readonly type: "object";
|
|
@@ -858,10 +1271,141 @@ export declare const InviteSchema: {
|
|
|
858
1271
|
readonly description: "Generated unique invite code.";
|
|
859
1272
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
860
1273
|
};
|
|
1274
|
+
readonly role: {
|
|
1275
|
+
readonly type: "string";
|
|
1276
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1277
|
+
readonly default: "User";
|
|
1278
|
+
readonly example: "User";
|
|
1279
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1280
|
+
};
|
|
861
1281
|
};
|
|
862
1282
|
readonly required: readonly ["date_created"];
|
|
863
1283
|
readonly additionalProperties: false;
|
|
864
1284
|
};
|
|
1285
|
+
export declare const InvoicePaymentAttemptSchema: {
|
|
1286
|
+
readonly type: "object";
|
|
1287
|
+
readonly properties: {
|
|
1288
|
+
readonly invoice_id: {
|
|
1289
|
+
readonly type: "string";
|
|
1290
|
+
readonly description: "Identifier of the invoice.";
|
|
1291
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
1292
|
+
};
|
|
1293
|
+
readonly number: {
|
|
1294
|
+
readonly type: "string";
|
|
1295
|
+
readonly nullable: true;
|
|
1296
|
+
readonly description: "Invoice number. Null if the invoice has no number.";
|
|
1297
|
+
readonly example: "CF-0042";
|
|
1298
|
+
};
|
|
1299
|
+
readonly amount: {
|
|
1300
|
+
readonly type: "number";
|
|
1301
|
+
readonly format: "float";
|
|
1302
|
+
readonly description: "Amount outstanding when the charge was attempted, in the smallest currency unit.";
|
|
1303
|
+
readonly example: 4200;
|
|
1304
|
+
};
|
|
1305
|
+
readonly currency: {
|
|
1306
|
+
readonly type: "string";
|
|
1307
|
+
readonly description: "Currency of the invoice.";
|
|
1308
|
+
readonly example: "eur";
|
|
1309
|
+
};
|
|
1310
|
+
readonly status: {
|
|
1311
|
+
readonly type: "string";
|
|
1312
|
+
readonly description: "Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).";
|
|
1313
|
+
readonly example: "paid";
|
|
1314
|
+
readonly enum: readonly ["paid", "processing", "requires_action", "failed"];
|
|
1315
|
+
};
|
|
1316
|
+
readonly client_secret: {
|
|
1317
|
+
readonly type: "string";
|
|
1318
|
+
readonly nullable: true;
|
|
1319
|
+
readonly description: "Client secret used to complete customer authentication. Set only when `status` is `requires_action`.";
|
|
1320
|
+
readonly example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH";
|
|
1321
|
+
};
|
|
1322
|
+
readonly failure_code: {
|
|
1323
|
+
readonly type: "string";
|
|
1324
|
+
readonly nullable: true;
|
|
1325
|
+
readonly description: "Decline code. Set only when `status` is `failed`.";
|
|
1326
|
+
readonly example: "insufficient_funds";
|
|
1327
|
+
};
|
|
1328
|
+
readonly failure_message: {
|
|
1329
|
+
readonly type: "string";
|
|
1330
|
+
readonly nullable: true;
|
|
1331
|
+
readonly description: "Explanation of the decline, suitable for display. Set only when `status` is `failed`.";
|
|
1332
|
+
readonly example: "Your card has insufficient funds.";
|
|
1333
|
+
};
|
|
1334
|
+
};
|
|
1335
|
+
readonly required: readonly ["invoice_id", "number", "amount", "currency", "status", "client_secret", "failure_code", "failure_message"];
|
|
1336
|
+
readonly additionalProperties: false;
|
|
1337
|
+
};
|
|
1338
|
+
export declare const InvoicePaymentResultSchema: {
|
|
1339
|
+
readonly type: "object";
|
|
1340
|
+
readonly properties: {
|
|
1341
|
+
readonly code: {
|
|
1342
|
+
readonly type: "string";
|
|
1343
|
+
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).";
|
|
1344
|
+
readonly example: "partially_paid";
|
|
1345
|
+
readonly enum: readonly ["paid", "processing", "action_required", "partially_paid", "failed", "nothing_due", "bank_transfer_due"];
|
|
1346
|
+
};
|
|
1347
|
+
readonly message: {
|
|
1348
|
+
readonly type: "string";
|
|
1349
|
+
readonly description: "Summary of the outcome, suitable for display.";
|
|
1350
|
+
readonly example: "1 of 2 open invoices was paid. Invoice CF-0043 was declined: Your card has insufficient funds.";
|
|
1351
|
+
};
|
|
1352
|
+
readonly results: {
|
|
1353
|
+
readonly type: "array";
|
|
1354
|
+
readonly items: {
|
|
1355
|
+
readonly type: "object";
|
|
1356
|
+
readonly properties: {
|
|
1357
|
+
readonly invoice_id: {
|
|
1358
|
+
readonly type: "string";
|
|
1359
|
+
readonly description: "Identifier of the invoice.";
|
|
1360
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
1361
|
+
};
|
|
1362
|
+
readonly number: {
|
|
1363
|
+
readonly type: "string";
|
|
1364
|
+
readonly description: "Invoice number. Null if the invoice has no number.";
|
|
1365
|
+
readonly example: "CF-0042";
|
|
1366
|
+
};
|
|
1367
|
+
readonly amount: {
|
|
1368
|
+
readonly type: "number";
|
|
1369
|
+
readonly format: "float";
|
|
1370
|
+
readonly description: "Amount outstanding when the charge was attempted, in the smallest currency unit.";
|
|
1371
|
+
readonly example: 4200;
|
|
1372
|
+
};
|
|
1373
|
+
readonly currency: {
|
|
1374
|
+
readonly type: "string";
|
|
1375
|
+
readonly description: "Currency of the invoice.";
|
|
1376
|
+
readonly example: "eur";
|
|
1377
|
+
};
|
|
1378
|
+
readonly status: {
|
|
1379
|
+
readonly type: "string";
|
|
1380
|
+
readonly description: "Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).";
|
|
1381
|
+
readonly example: "paid";
|
|
1382
|
+
readonly enum: readonly ["paid", "processing", "requires_action", "failed"];
|
|
1383
|
+
};
|
|
1384
|
+
readonly client_secret: {
|
|
1385
|
+
readonly type: "string";
|
|
1386
|
+
readonly description: "Client secret used to complete customer authentication. Set only when `status` is `requires_action`.";
|
|
1387
|
+
readonly example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH";
|
|
1388
|
+
};
|
|
1389
|
+
readonly failure_code: {
|
|
1390
|
+
readonly type: "string";
|
|
1391
|
+
readonly description: "Decline code. Set only when `status` is `failed`.";
|
|
1392
|
+
readonly example: "insufficient_funds";
|
|
1393
|
+
};
|
|
1394
|
+
readonly failure_message: {
|
|
1395
|
+
readonly type: "string";
|
|
1396
|
+
readonly description: "Explanation of the decline, suitable for display. Set only when `status` is `failed`.";
|
|
1397
|
+
readonly example: "Your card has insufficient funds.";
|
|
1398
|
+
};
|
|
1399
|
+
};
|
|
1400
|
+
readonly required: readonly ["invoice_id", "number", "amount", "currency", "status", "client_secret", "failure_code", "failure_message"];
|
|
1401
|
+
readonly additionalProperties: false;
|
|
1402
|
+
};
|
|
1403
|
+
readonly description: "One entry per invoice charged, oldest first.";
|
|
1404
|
+
};
|
|
1405
|
+
};
|
|
1406
|
+
readonly required: readonly ["code", "message", "results"];
|
|
1407
|
+
readonly additionalProperties: false;
|
|
1408
|
+
};
|
|
865
1409
|
export declare const InvoiceSchema: {
|
|
866
1410
|
readonly type: "object";
|
|
867
1411
|
readonly properties: {
|
|
@@ -1055,6 +1599,12 @@ export declare const MarketplaceListingSchema: {
|
|
|
1055
1599
|
export declare const OrganizationCreateInputSchema: {
|
|
1056
1600
|
readonly type: "object";
|
|
1057
1601
|
readonly properties: {
|
|
1602
|
+
readonly type: {
|
|
1603
|
+
readonly type: "string";
|
|
1604
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1605
|
+
readonly example: "business";
|
|
1606
|
+
readonly enum: readonly ["business", "personal"];
|
|
1607
|
+
};
|
|
1058
1608
|
readonly email: {
|
|
1059
1609
|
readonly type: "string";
|
|
1060
1610
|
readonly format: "email";
|
|
@@ -1063,11 +1613,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
1063
1613
|
};
|
|
1064
1614
|
readonly first_name: {
|
|
1065
1615
|
readonly type: "string";
|
|
1616
|
+
readonly minLength: 1;
|
|
1066
1617
|
readonly description: "First name of the billing contact person.";
|
|
1067
1618
|
readonly example: "John";
|
|
1068
1619
|
};
|
|
1069
1620
|
readonly last_name: {
|
|
1070
1621
|
readonly type: "string";
|
|
1622
|
+
readonly minLength: 1;
|
|
1071
1623
|
readonly description: "Last name of the billing contact person.";
|
|
1072
1624
|
readonly example: "Doe";
|
|
1073
1625
|
};
|
|
@@ -1085,7 +1637,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
1085
1637
|
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.";
|
|
1086
1638
|
};
|
|
1087
1639
|
};
|
|
1088
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1640
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1641
|
+
readonly additionalProperties: false;
|
|
1642
|
+
};
|
|
1643
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1644
|
+
readonly type: "object";
|
|
1645
|
+
readonly properties: {
|
|
1646
|
+
readonly id: {
|
|
1647
|
+
readonly type: "string";
|
|
1648
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1649
|
+
readonly example: "organization-id";
|
|
1650
|
+
};
|
|
1651
|
+
};
|
|
1652
|
+
readonly required: readonly ["id"];
|
|
1089
1653
|
readonly additionalProperties: false;
|
|
1090
1654
|
};
|
|
1091
1655
|
export declare const OrganizationSchema: {
|
|
@@ -1104,6 +1668,12 @@ export declare const OrganizationSchema: {
|
|
|
1104
1668
|
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1105
1669
|
readonly example: "ACME Corp.";
|
|
1106
1670
|
};
|
|
1671
|
+
readonly type: {
|
|
1672
|
+
readonly type: "string";
|
|
1673
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1674
|
+
readonly example: "business";
|
|
1675
|
+
readonly enum: readonly ["business", "personal"];
|
|
1676
|
+
};
|
|
1107
1677
|
readonly date_created: {
|
|
1108
1678
|
readonly type: "string";
|
|
1109
1679
|
readonly format: "date-time";
|
|
@@ -1135,6 +1705,17 @@ export declare const OrganizationSchema: {
|
|
|
1135
1705
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1136
1706
|
readonly example: 999;
|
|
1137
1707
|
};
|
|
1708
|
+
readonly enterprise_clusters_max: {
|
|
1709
|
+
readonly type: "integer";
|
|
1710
|
+
readonly minimum: 0;
|
|
1711
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1712
|
+
readonly example: 999;
|
|
1713
|
+
};
|
|
1714
|
+
readonly enterprise_clusters_available: {
|
|
1715
|
+
readonly type: "integer";
|
|
1716
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1717
|
+
readonly example: 999;
|
|
1718
|
+
};
|
|
1138
1719
|
readonly fleets_max: {
|
|
1139
1720
|
readonly type: "integer";
|
|
1140
1721
|
readonly minimum: 0;
|
|
@@ -1154,7 +1735,7 @@ export declare const OrganizationSchema: {
|
|
|
1154
1735
|
readonly type: "array";
|
|
1155
1736
|
readonly items: {
|
|
1156
1737
|
readonly type: "string";
|
|
1157
|
-
readonly example: "northamerica-central-
|
|
1738
|
+
readonly example: "northamerica-central-1a";
|
|
1158
1739
|
};
|
|
1159
1740
|
readonly minItems: 1;
|
|
1160
1741
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1188,7 +1769,7 @@ export declare const OrganizationSchema: {
|
|
|
1188
1769
|
readonly example: 500;
|
|
1189
1770
|
};
|
|
1190
1771
|
};
|
|
1191
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1772
|
+
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"];
|
|
1192
1773
|
readonly additionalProperties: false;
|
|
1193
1774
|
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.";
|
|
1194
1775
|
};
|
|
@@ -1197,8 +1778,14 @@ export declare const OrganizationSchema: {
|
|
|
1197
1778
|
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1198
1779
|
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1199
1780
|
};
|
|
1781
|
+
readonly verification: {
|
|
1782
|
+
readonly type: "string";
|
|
1783
|
+
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.";
|
|
1784
|
+
readonly example: "verified";
|
|
1785
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1786
|
+
};
|
|
1200
1787
|
};
|
|
1201
|
-
readonly required: readonly ["id", "date_created", "quota", "status"];
|
|
1788
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1202
1789
|
readonly additionalProperties: false;
|
|
1203
1790
|
};
|
|
1204
1791
|
export declare const PaymentMethodSchema: {
|
|
@@ -1206,26 +1793,19 @@ export declare const PaymentMethodSchema: {
|
|
|
1206
1793
|
readonly properties: {
|
|
1207
1794
|
readonly id: {
|
|
1208
1795
|
readonly type: "string";
|
|
1209
|
-
readonly
|
|
1210
|
-
readonly
|
|
1211
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1212
|
-
};
|
|
1213
|
-
readonly setup: {
|
|
1214
|
-
readonly type: "boolean";
|
|
1215
|
-
readonly description: "Whether organization payment method was set up and ready to use for payments.";
|
|
1216
|
-
readonly example: true;
|
|
1796
|
+
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.";
|
|
1797
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1217
1798
|
};
|
|
1218
1799
|
readonly type: {
|
|
1219
1800
|
readonly type: "string";
|
|
1220
|
-
readonly
|
|
1221
|
-
readonly description: "Payment method type type. Only `card` payments supported at the moment.";
|
|
1801
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1222
1802
|
readonly example: "card";
|
|
1223
|
-
readonly enum: readonly ["card"];
|
|
1803
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1224
1804
|
};
|
|
1225
1805
|
readonly last4: {
|
|
1226
1806
|
readonly type: "string";
|
|
1227
1807
|
readonly nullable: true;
|
|
1228
|
-
readonly description: "Last 4 digits of the payment card number.";
|
|
1808
|
+
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.";
|
|
1229
1809
|
readonly example: "4242";
|
|
1230
1810
|
};
|
|
1231
1811
|
readonly exp_month: {
|
|
@@ -1233,25 +1813,46 @@ export declare const PaymentMethodSchema: {
|
|
|
1233
1813
|
readonly minimum: 1;
|
|
1234
1814
|
readonly maximum: 12;
|
|
1235
1815
|
readonly nullable: true;
|
|
1236
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1237
|
-
readonly example:
|
|
1816
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1817
|
+
readonly example: 12;
|
|
1238
1818
|
};
|
|
1239
1819
|
readonly exp_year: {
|
|
1240
1820
|
readonly type: "integer";
|
|
1241
|
-
readonly minimum: 2024;
|
|
1242
1821
|
readonly nullable: true;
|
|
1243
|
-
readonly description: "Four-digit number representing the card's expiration year.";
|
|
1244
|
-
readonly example:
|
|
1822
|
+
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.";
|
|
1823
|
+
readonly example: 2028;
|
|
1245
1824
|
};
|
|
1246
1825
|
readonly brand: {
|
|
1247
1826
|
readonly type: "string";
|
|
1248
1827
|
readonly nullable: true;
|
|
1249
|
-
readonly description: "Payment card brand
|
|
1828
|
+
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.";
|
|
1250
1829
|
readonly example: "visa";
|
|
1251
|
-
|
|
1830
|
+
};
|
|
1831
|
+
readonly iban: {
|
|
1832
|
+
readonly type: "string";
|
|
1833
|
+
readonly nullable: true;
|
|
1834
|
+
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.";
|
|
1835
|
+
readonly example: "DE11243015658023127510";
|
|
1836
|
+
};
|
|
1837
|
+
readonly bic: {
|
|
1838
|
+
readonly type: "string";
|
|
1839
|
+
readonly nullable: true;
|
|
1840
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1841
|
+
readonly example: "SOGEDEFFXXX";
|
|
1842
|
+
};
|
|
1843
|
+
readonly account_holder_name: {
|
|
1844
|
+
readonly type: "string";
|
|
1845
|
+
readonly nullable: true;
|
|
1846
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1847
|
+
readonly example: "Cloudfleet GmbH";
|
|
1848
|
+
};
|
|
1849
|
+
readonly is_default: {
|
|
1850
|
+
readonly type: "boolean";
|
|
1851
|
+
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).";
|
|
1852
|
+
readonly example: true;
|
|
1252
1853
|
};
|
|
1253
1854
|
};
|
|
1254
|
-
readonly required: readonly ["id", "
|
|
1855
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1255
1856
|
readonly additionalProperties: false;
|
|
1256
1857
|
};
|
|
1257
1858
|
export declare const PlatformQuotaSchema: {
|
|
@@ -1279,6 +1880,17 @@ export declare const PlatformQuotaSchema: {
|
|
|
1279
1880
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1280
1881
|
readonly example: 999;
|
|
1281
1882
|
};
|
|
1883
|
+
readonly enterprise_clusters_max: {
|
|
1884
|
+
readonly type: "integer";
|
|
1885
|
+
readonly minimum: 0;
|
|
1886
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1887
|
+
readonly example: 999;
|
|
1888
|
+
};
|
|
1889
|
+
readonly enterprise_clusters_available: {
|
|
1890
|
+
readonly type: "integer";
|
|
1891
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1892
|
+
readonly example: 999;
|
|
1893
|
+
};
|
|
1282
1894
|
readonly fleets_max: {
|
|
1283
1895
|
readonly type: "integer";
|
|
1284
1896
|
readonly minimum: 0;
|
|
@@ -1298,7 +1910,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1298
1910
|
readonly type: "array";
|
|
1299
1911
|
readonly items: {
|
|
1300
1912
|
readonly type: "string";
|
|
1301
|
-
readonly example: "northamerica-central-
|
|
1913
|
+
readonly example: "northamerica-central-1a";
|
|
1302
1914
|
};
|
|
1303
1915
|
readonly minItems: 1;
|
|
1304
1916
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1332,7 +1944,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1332
1944
|
readonly example: 500;
|
|
1333
1945
|
};
|
|
1334
1946
|
};
|
|
1335
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1947
|
+
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"];
|
|
1336
1948
|
readonly additionalProperties: false;
|
|
1337
1949
|
};
|
|
1338
1950
|
export declare const RegistryRepositorySchema: {
|
|
@@ -1566,6 +2178,57 @@ export declare const RegistryTagSchema: {
|
|
|
1566
2178
|
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
1567
2179
|
readonly additionalProperties: false;
|
|
1568
2180
|
};
|
|
2181
|
+
export declare const RoadmapItemCreateInputSchema: {
|
|
2182
|
+
readonly type: "object";
|
|
2183
|
+
readonly properties: {
|
|
2184
|
+
readonly text: {
|
|
2185
|
+
readonly type: "string";
|
|
2186
|
+
readonly maxLength: 500;
|
|
2187
|
+
readonly minLength: 1;
|
|
2188
|
+
readonly description: "Your suggestion in one or two sentences. It is reviewed before it appears on the roadmap.";
|
|
2189
|
+
readonly example: "Support for ARM nodes on Hetzner.";
|
|
2190
|
+
};
|
|
2191
|
+
};
|
|
2192
|
+
readonly required: readonly ["text"];
|
|
2193
|
+
readonly additionalProperties: false;
|
|
2194
|
+
};
|
|
2195
|
+
export declare const RoadmapItemSchema: {
|
|
2196
|
+
readonly type: "object";
|
|
2197
|
+
readonly properties: {
|
|
2198
|
+
readonly id: {
|
|
2199
|
+
readonly type: "string";
|
|
2200
|
+
readonly description: "Unique identifier of the roadmap item (Mongo ObjectId).";
|
|
2201
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
2202
|
+
};
|
|
2203
|
+
readonly text: {
|
|
2204
|
+
readonly type: "string";
|
|
2205
|
+
readonly description: "Short description of the roadmap item.";
|
|
2206
|
+
readonly example: "Support for ARM nodes on Hetzner.";
|
|
2207
|
+
};
|
|
2208
|
+
readonly vote: {
|
|
2209
|
+
readonly type: "integer";
|
|
2210
|
+
readonly nullable: true;
|
|
2211
|
+
readonly description: "The caller's vote on this item: -1 (down), 1 (up), 2 (double up), or null if the caller has not voted.";
|
|
2212
|
+
readonly example: 1;
|
|
2213
|
+
readonly enum: readonly [-1, 1, 2];
|
|
2214
|
+
};
|
|
2215
|
+
};
|
|
2216
|
+
readonly required: readonly ["id", "text", "vote"];
|
|
2217
|
+
readonly additionalProperties: false;
|
|
2218
|
+
};
|
|
2219
|
+
export declare const RoadmapVoteInputSchema: {
|
|
2220
|
+
readonly type: "object";
|
|
2221
|
+
readonly properties: {
|
|
2222
|
+
readonly value: {
|
|
2223
|
+
readonly type: "integer";
|
|
2224
|
+
readonly description: "Vote value: -1 (down), 1 (up), or 2 (double up).";
|
|
2225
|
+
readonly example: 1;
|
|
2226
|
+
readonly enum: readonly [-1, 1, 2];
|
|
2227
|
+
};
|
|
2228
|
+
};
|
|
2229
|
+
readonly required: readonly ["value"];
|
|
2230
|
+
readonly additionalProperties: false;
|
|
2231
|
+
};
|
|
1569
2232
|
export declare const TicketAttachmentSchema: {
|
|
1570
2233
|
readonly type: "object";
|
|
1571
2234
|
readonly properties: {
|
|
@@ -1623,142 +2286,6 @@ export declare const TicketCreateInputSchema: {
|
|
|
1623
2286
|
readonly required: readonly ["category", "body"];
|
|
1624
2287
|
readonly additionalProperties: false;
|
|
1625
2288
|
};
|
|
1626
|
-
export declare const TicketListResponseSchema: {
|
|
1627
|
-
readonly type: "object";
|
|
1628
|
-
readonly properties: {
|
|
1629
|
-
readonly items: {
|
|
1630
|
-
readonly type: "array";
|
|
1631
|
-
readonly items: {
|
|
1632
|
-
readonly type: "object";
|
|
1633
|
-
readonly properties: {
|
|
1634
|
-
readonly id: {
|
|
1635
|
-
readonly type: "string";
|
|
1636
|
-
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
1637
|
-
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
1638
|
-
};
|
|
1639
|
-
readonly status: {
|
|
1640
|
-
readonly type: "string";
|
|
1641
|
-
readonly description: "Current state of the ticket.";
|
|
1642
|
-
readonly example: "waiting_on_us";
|
|
1643
|
-
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
1644
|
-
};
|
|
1645
|
-
readonly category: {
|
|
1646
|
-
readonly type: "string";
|
|
1647
|
-
readonly description: "Ticket category.";
|
|
1648
|
-
readonly example: "technical";
|
|
1649
|
-
readonly enum: readonly ["billing", "technical", "general"];
|
|
1650
|
-
};
|
|
1651
|
-
readonly summary: {
|
|
1652
|
-
readonly type: "string";
|
|
1653
|
-
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
1654
|
-
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1655
|
-
};
|
|
1656
|
-
readonly closed_at: {
|
|
1657
|
-
readonly type: "string";
|
|
1658
|
-
readonly format: "date-time";
|
|
1659
|
-
readonly nullable: true;
|
|
1660
|
-
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
1661
|
-
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1662
|
-
};
|
|
1663
|
-
readonly date_created: {
|
|
1664
|
-
readonly type: "string";
|
|
1665
|
-
readonly format: "date-time";
|
|
1666
|
-
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
1667
|
-
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1668
|
-
};
|
|
1669
|
-
readonly date_updated: {
|
|
1670
|
-
readonly type: "string";
|
|
1671
|
-
readonly format: "date-time";
|
|
1672
|
-
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
1673
|
-
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1674
|
-
};
|
|
1675
|
-
readonly messages: {
|
|
1676
|
-
readonly type: "array";
|
|
1677
|
-
readonly items: {
|
|
1678
|
-
readonly type: "object";
|
|
1679
|
-
readonly properties: {
|
|
1680
|
-
readonly id: {
|
|
1681
|
-
readonly type: "string";
|
|
1682
|
-
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
1683
|
-
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
1684
|
-
};
|
|
1685
|
-
readonly type: {
|
|
1686
|
-
readonly type: "string";
|
|
1687
|
-
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
1688
|
-
readonly example: "customer_reply";
|
|
1689
|
-
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
1690
|
-
};
|
|
1691
|
-
readonly body: {
|
|
1692
|
-
readonly type: "string";
|
|
1693
|
-
readonly description: "Message body in markdown.";
|
|
1694
|
-
readonly example: "Thanks — that resolved it on my side.";
|
|
1695
|
-
};
|
|
1696
|
-
readonly author_first_name: {
|
|
1697
|
-
readonly type: "string";
|
|
1698
|
-
readonly nullable: true;
|
|
1699
|
-
readonly description: "First name of the author. Null when not provided.";
|
|
1700
|
-
readonly example: "Jane";
|
|
1701
|
-
};
|
|
1702
|
-
readonly author_last_name: {
|
|
1703
|
-
readonly type: "string";
|
|
1704
|
-
readonly nullable: true;
|
|
1705
|
-
readonly description: "Last name of the author. Null when not provided.";
|
|
1706
|
-
readonly example: "Doe";
|
|
1707
|
-
};
|
|
1708
|
-
readonly attachments: {
|
|
1709
|
-
readonly type: "array";
|
|
1710
|
-
readonly items: {
|
|
1711
|
-
readonly type: "object";
|
|
1712
|
-
readonly properties: {
|
|
1713
|
-
readonly id: {
|
|
1714
|
-
readonly type: "string";
|
|
1715
|
-
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
1716
|
-
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1717
|
-
};
|
|
1718
|
-
readonly filename: {
|
|
1719
|
-
readonly type: "string";
|
|
1720
|
-
readonly description: "Original filename as uploaded.";
|
|
1721
|
-
readonly example: "debug.log";
|
|
1722
|
-
};
|
|
1723
|
-
readonly content_type: {
|
|
1724
|
-
readonly type: "string";
|
|
1725
|
-
readonly description: "MIME content type of the attachment.";
|
|
1726
|
-
readonly example: "text/plain";
|
|
1727
|
-
};
|
|
1728
|
-
readonly size: {
|
|
1729
|
-
readonly type: "integer";
|
|
1730
|
-
readonly description: "Size of the attachment in bytes.";
|
|
1731
|
-
readonly example: 12345;
|
|
1732
|
-
};
|
|
1733
|
-
};
|
|
1734
|
-
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1735
|
-
readonly additionalProperties: false;
|
|
1736
|
-
};
|
|
1737
|
-
readonly description: "Attachments associated with this message.";
|
|
1738
|
-
readonly example: readonly [];
|
|
1739
|
-
};
|
|
1740
|
-
readonly date_created: {
|
|
1741
|
-
readonly type: "string";
|
|
1742
|
-
readonly format: "date-time";
|
|
1743
|
-
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
1744
|
-
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1745
|
-
};
|
|
1746
|
-
};
|
|
1747
|
-
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
1748
|
-
readonly additionalProperties: false;
|
|
1749
|
-
};
|
|
1750
|
-
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
1751
|
-
};
|
|
1752
|
-
};
|
|
1753
|
-
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1754
|
-
readonly additionalProperties: false;
|
|
1755
|
-
};
|
|
1756
|
-
readonly description: "Tickets for the organization, ordered newest first. Messages are omitted from list responses.";
|
|
1757
|
-
};
|
|
1758
|
-
};
|
|
1759
|
-
readonly required: readonly ["items"];
|
|
1760
|
-
readonly additionalProperties: false;
|
|
1761
|
-
};
|
|
1762
2289
|
export declare const TicketMessageInputSchema: {
|
|
1763
2290
|
readonly type: "object";
|
|
1764
2291
|
readonly properties: {
|
|
@@ -1795,11 +2322,13 @@ export declare const TicketMessageSchema: {
|
|
|
1795
2322
|
};
|
|
1796
2323
|
readonly author_first_name: {
|
|
1797
2324
|
readonly type: "string";
|
|
2325
|
+
readonly nullable: true;
|
|
1798
2326
|
readonly description: "First name of the author. Null when not provided.";
|
|
1799
2327
|
readonly example: "Jane";
|
|
1800
2328
|
};
|
|
1801
2329
|
readonly author_last_name: {
|
|
1802
2330
|
readonly type: "string";
|
|
2331
|
+
readonly nullable: true;
|
|
1803
2332
|
readonly description: "Last name of the author. Null when not provided.";
|
|
1804
2333
|
readonly example: "Doe";
|
|
1805
2334
|
};
|
|
@@ -1873,6 +2402,7 @@ export declare const TicketSchema: {
|
|
|
1873
2402
|
readonly closed_at: {
|
|
1874
2403
|
readonly type: "string";
|
|
1875
2404
|
readonly format: "date-time";
|
|
2405
|
+
readonly nullable: true;
|
|
1876
2406
|
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
1877
2407
|
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1878
2408
|
};
|
|
@@ -2060,9 +2590,10 @@ export declare const UsageFacetsSchema: {
|
|
|
2060
2590
|
readonly type: "array";
|
|
2061
2591
|
readonly items: {
|
|
2062
2592
|
readonly type: "string";
|
|
2593
|
+
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"];
|
|
2063
2594
|
};
|
|
2064
2595
|
readonly description: "List of unique products";
|
|
2065
|
-
readonly example: readonly ["
|
|
2596
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
2066
2597
|
};
|
|
2067
2598
|
};
|
|
2068
2599
|
readonly additionalProperties: false;
|
|
@@ -2088,7 +2619,8 @@ export declare const UsageResponseSchema: {
|
|
|
2088
2619
|
readonly product: {
|
|
2089
2620
|
readonly type: "string";
|
|
2090
2621
|
readonly description: "The product the usage is associated with";
|
|
2091
|
-
readonly example: "
|
|
2622
|
+
readonly example: "cfke_controlplane_pro";
|
|
2623
|
+
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"];
|
|
2092
2624
|
};
|
|
2093
2625
|
readonly value: {
|
|
2094
2626
|
readonly type: "number";
|
|
@@ -2128,9 +2660,10 @@ export declare const UsageResponseSchema: {
|
|
|
2128
2660
|
readonly type: "array";
|
|
2129
2661
|
readonly items: {
|
|
2130
2662
|
readonly type: "string";
|
|
2663
|
+
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"];
|
|
2131
2664
|
};
|
|
2132
2665
|
readonly description: "List of unique products";
|
|
2133
|
-
readonly example: readonly ["
|
|
2666
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
2134
2667
|
};
|
|
2135
2668
|
};
|
|
2136
2669
|
readonly additionalProperties: false;
|
|
@@ -2156,7 +2689,8 @@ export declare const UsageSchema: {
|
|
|
2156
2689
|
readonly product: {
|
|
2157
2690
|
readonly type: "string";
|
|
2158
2691
|
readonly description: "The product the usage is associated with";
|
|
2159
|
-
readonly example: "
|
|
2692
|
+
readonly example: "cfke_controlplane_pro";
|
|
2693
|
+
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"];
|
|
2160
2694
|
};
|
|
2161
2695
|
readonly value: {
|
|
2162
2696
|
readonly type: "number";
|
|
@@ -2213,18 +2747,6 @@ export declare const UserCreateInputSchema: {
|
|
|
2213
2747
|
readonly minLength: 8;
|
|
2214
2748
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
2215
2749
|
};
|
|
2216
|
-
readonly status: {
|
|
2217
|
-
readonly type: "string";
|
|
2218
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
2219
|
-
readonly example: "active";
|
|
2220
|
-
readonly enum: readonly ["active", "inactive"];
|
|
2221
|
-
};
|
|
2222
|
-
readonly role: {
|
|
2223
|
-
readonly type: "string";
|
|
2224
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
2225
|
-
readonly example: "User";
|
|
2226
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
2227
|
-
};
|
|
2228
2750
|
};
|
|
2229
2751
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
2230
2752
|
readonly additionalProperties: false;
|