@cloudfleet/sdk 0.0.1-cfddf24 → 0.0.1-d3aa845
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 +420 -386
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +428 -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 +437 -225
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +587 -317
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +237 -215
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +338 -312
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +1049 -790
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +1650 -1477
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +481 -350
- package/dist/zod.gen.js.map +1 -1
- package/package.json +8 -11
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,6 +392,11 @@ 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.";
|
|
@@ -373,7 +459,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
373
459
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
374
460
|
};
|
|
375
461
|
};
|
|
376
|
-
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
462
|
+
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "pod_cidr", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
377
463
|
readonly additionalProperties: false;
|
|
378
464
|
};
|
|
379
465
|
export declare const ClusterSchema: {
|
|
@@ -390,15 +476,100 @@ export declare const ClusterSchema: {
|
|
|
390
476
|
readonly tier: {
|
|
391
477
|
readonly type: "string";
|
|
392
478
|
readonly description: "Tier of the cluster.";
|
|
479
|
+
readonly default: "basic";
|
|
393
480
|
readonly example: "pro";
|
|
394
|
-
readonly enum: readonly ["basic", "pro"];
|
|
481
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
482
|
+
};
|
|
483
|
+
readonly version_channel: {
|
|
484
|
+
readonly type: "string";
|
|
485
|
+
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-]+)*))?$";
|
|
486
|
+
readonly description: "Version of the kubernetes cluster.";
|
|
487
|
+
readonly default: "1.x.x-cfke.x";
|
|
488
|
+
readonly example: "1.x.x-cfke.x";
|
|
489
|
+
};
|
|
490
|
+
readonly release_channel: {
|
|
491
|
+
readonly type: "string";
|
|
492
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
493
|
+
readonly default: "rapid";
|
|
494
|
+
readonly example: "rapid";
|
|
495
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
496
|
+
};
|
|
497
|
+
readonly features: {
|
|
498
|
+
readonly type: "object";
|
|
499
|
+
readonly properties: {
|
|
500
|
+
readonly gpu_sharing_strategy: {
|
|
501
|
+
readonly type: "string";
|
|
502
|
+
readonly description: "GPU sharing strategy.";
|
|
503
|
+
readonly default: "none";
|
|
504
|
+
readonly example: "none";
|
|
505
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
506
|
+
};
|
|
507
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
508
|
+
readonly type: "integer";
|
|
509
|
+
readonly minimum: 2;
|
|
510
|
+
readonly maximum: 48;
|
|
511
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
512
|
+
readonly default: 4;
|
|
513
|
+
readonly example: 10;
|
|
514
|
+
};
|
|
515
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
516
|
+
readonly type: "boolean";
|
|
517
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
518
|
+
readonly example: false;
|
|
519
|
+
};
|
|
520
|
+
};
|
|
521
|
+
readonly required: readonly ["gpu_sharing_strategy", "gpu_max_shared_clients_per_gpu", "cilium_socket_lb_host_namespace_only"];
|
|
522
|
+
readonly additionalProperties: false;
|
|
523
|
+
readonly description: "Cluster feature toggles.";
|
|
524
|
+
readonly default: {
|
|
525
|
+
readonly gpu_sharing_strategy: "none";
|
|
526
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
527
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
528
|
+
};
|
|
395
529
|
};
|
|
396
530
|
readonly region: {
|
|
397
531
|
readonly type: "string";
|
|
398
|
-
readonly description: "Cloudfleet control plane region.
|
|
399
|
-
readonly
|
|
400
|
-
|
|
401
|
-
|
|
532
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
533
|
+
readonly example: "europe-central-1a";
|
|
534
|
+
};
|
|
535
|
+
readonly networking: {
|
|
536
|
+
readonly type: "object";
|
|
537
|
+
readonly properties: {
|
|
538
|
+
readonly pod_cidr: {
|
|
539
|
+
readonly type: "string";
|
|
540
|
+
readonly description: "CIDR block for pod IPs.";
|
|
541
|
+
readonly default: "10.244.0.0/16";
|
|
542
|
+
};
|
|
543
|
+
readonly service_cidr: {
|
|
544
|
+
readonly type: "string";
|
|
545
|
+
readonly description: "CIDR block for service IPs.";
|
|
546
|
+
readonly default: "10.96.0.0/12";
|
|
547
|
+
};
|
|
548
|
+
readonly dual_stack: {
|
|
549
|
+
readonly type: "boolean";
|
|
550
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
551
|
+
};
|
|
552
|
+
readonly pod_cidr_v6: {
|
|
553
|
+
readonly type: "string";
|
|
554
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
555
|
+
readonly default: "2001:db8:1:2::/48";
|
|
556
|
+
};
|
|
557
|
+
readonly service_cidr_v6: {
|
|
558
|
+
readonly type: "string";
|
|
559
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
560
|
+
readonly default: "2001:db8:1:1::/112";
|
|
561
|
+
};
|
|
562
|
+
};
|
|
563
|
+
readonly required: readonly ["pod_cidr", "service_cidr", "dual_stack", "pod_cidr_v6", "service_cidr_v6"];
|
|
564
|
+
readonly additionalProperties: false;
|
|
565
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
566
|
+
readonly default: {
|
|
567
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
568
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
569
|
+
readonly dual_stack: false;
|
|
570
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
571
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
572
|
+
};
|
|
402
573
|
};
|
|
403
574
|
readonly id: {
|
|
404
575
|
readonly type: "string";
|
|
@@ -408,16 +579,16 @@ export declare const ClusterSchema: {
|
|
|
408
579
|
};
|
|
409
580
|
readonly status: {
|
|
410
581
|
readonly type: "string";
|
|
411
|
-
readonly description: "Status of the cluster.
|
|
412
|
-
readonly example: "
|
|
413
|
-
readonly enum: readonly ["
|
|
582
|
+
readonly description: "Status of the cluster.";
|
|
583
|
+
readonly example: "deployed";
|
|
584
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
414
585
|
};
|
|
415
586
|
readonly endpoint: {
|
|
416
587
|
readonly anyOf: readonly [{
|
|
417
588
|
readonly type: "string";
|
|
418
589
|
readonly format: "uri";
|
|
419
|
-
readonly description: "URL signed by
|
|
420
|
-
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
590
|
+
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.";
|
|
591
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
421
592
|
}, {
|
|
422
593
|
readonly type: "string";
|
|
423
594
|
readonly enum: readonly [""];
|
|
@@ -427,7 +598,7 @@ export declare const ClusterSchema: {
|
|
|
427
598
|
readonly anyOf: readonly [{
|
|
428
599
|
readonly type: "string";
|
|
429
600
|
readonly format: "uri";
|
|
430
|
-
readonly description: "
|
|
601
|
+
readonly description: "Deprecated alias of `endpoint`; retained for backward compatibility.";
|
|
431
602
|
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
432
603
|
}, {
|
|
433
604
|
readonly type: "string";
|
|
@@ -459,15 +630,10 @@ export declare const ClusterSchema: {
|
|
|
459
630
|
readonly description: "Indicates if the cluster is ready to be used.";
|
|
460
631
|
readonly example: true;
|
|
461
632
|
};
|
|
462
|
-
readonly version_channel: {
|
|
463
|
-
readonly type: "string";
|
|
464
|
-
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
465
|
-
readonly description: "Version of the kubernetes cluster.";
|
|
466
|
-
readonly example: "1.x.x-cfke.x";
|
|
467
|
-
};
|
|
468
633
|
};
|
|
469
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
634
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
470
635
|
readonly additionalProperties: false;
|
|
636
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
471
637
|
};
|
|
472
638
|
export declare const ClusterUpdateInputSchema: {
|
|
473
639
|
readonly type: "object";
|
|
@@ -483,18 +649,60 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
483
649
|
readonly tier: {
|
|
484
650
|
readonly type: "string";
|
|
485
651
|
readonly description: "Tier of the cluster.";
|
|
652
|
+
readonly default: "basic";
|
|
486
653
|
readonly example: "pro";
|
|
487
|
-
readonly enum: readonly ["basic", "pro"];
|
|
654
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
488
655
|
};
|
|
489
656
|
readonly version_channel: {
|
|
490
657
|
readonly type: "string";
|
|
491
658
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
492
659
|
readonly description: "Version of the kubernetes cluster.";
|
|
660
|
+
readonly default: "1.x.x-cfke.x";
|
|
493
661
|
readonly example: "1.x.x-cfke.x";
|
|
494
662
|
};
|
|
663
|
+
readonly release_channel: {
|
|
664
|
+
readonly type: "string";
|
|
665
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
666
|
+
readonly default: "rapid";
|
|
667
|
+
readonly example: "rapid";
|
|
668
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
669
|
+
};
|
|
670
|
+
readonly features: {
|
|
671
|
+
readonly type: "object";
|
|
672
|
+
readonly properties: {
|
|
673
|
+
readonly gpu_sharing_strategy: {
|
|
674
|
+
readonly type: "string";
|
|
675
|
+
readonly description: "GPU sharing strategy.";
|
|
676
|
+
readonly default: "none";
|
|
677
|
+
readonly example: "none";
|
|
678
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
679
|
+
};
|
|
680
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
681
|
+
readonly type: "integer";
|
|
682
|
+
readonly minimum: 2;
|
|
683
|
+
readonly maximum: 48;
|
|
684
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
685
|
+
readonly default: 4;
|
|
686
|
+
readonly example: 10;
|
|
687
|
+
};
|
|
688
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
689
|
+
readonly type: "boolean";
|
|
690
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
691
|
+
readonly example: false;
|
|
692
|
+
};
|
|
693
|
+
};
|
|
694
|
+
readonly additionalProperties: false;
|
|
695
|
+
readonly description: "Cluster feature toggles.";
|
|
696
|
+
readonly default: {
|
|
697
|
+
readonly gpu_sharing_strategy: "none";
|
|
698
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
699
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
700
|
+
};
|
|
701
|
+
};
|
|
495
702
|
};
|
|
496
|
-
readonly required: readonly ["
|
|
703
|
+
readonly required: readonly ["name"];
|
|
497
704
|
readonly additionalProperties: false;
|
|
705
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
498
706
|
};
|
|
499
707
|
export declare const FleetCreateInputSchema: {
|
|
500
708
|
readonly type: "object";
|
|
@@ -538,8 +746,8 @@ export declare const FleetCreateInputSchema: {
|
|
|
538
746
|
readonly type: "string";
|
|
539
747
|
readonly maxLength: 64;
|
|
540
748
|
readonly minLength: 64;
|
|
541
|
-
readonly pattern: "^[A-Za-z0-9]
|
|
542
|
-
readonly description: "Hetzner Cloud API token with read
|
|
749
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
750
|
+
readonly description: "Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.";
|
|
543
751
|
};
|
|
544
752
|
};
|
|
545
753
|
readonly required: readonly ["enabled"];
|
|
@@ -591,6 +799,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
591
799
|
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
592
800
|
};
|
|
593
801
|
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
802
|
+
readonly default: readonly [];
|
|
594
803
|
};
|
|
595
804
|
readonly 'topology.kubernetes.io/region': {
|
|
596
805
|
readonly type: "array";
|
|
@@ -599,14 +808,21 @@ export declare const FleetCreateInputSchema: {
|
|
|
599
808
|
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
600
809
|
};
|
|
601
810
|
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
811
|
+
readonly default: readonly [];
|
|
602
812
|
};
|
|
603
813
|
};
|
|
604
814
|
readonly additionalProperties: false;
|
|
605
|
-
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.
|
|
815
|
+
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.";
|
|
816
|
+
readonly default: {
|
|
817
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
818
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
819
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
820
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
821
|
+
};
|
|
606
822
|
};
|
|
607
823
|
readonly scalingProfile: {
|
|
608
824
|
readonly type: "string";
|
|
609
|
-
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
825
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
610
826
|
readonly default: "conservative";
|
|
611
827
|
readonly example: "conservative";
|
|
612
828
|
readonly enum: readonly ["aggressive", "conservative"];
|
|
@@ -622,6 +838,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
622
838
|
};
|
|
623
839
|
readonly required: readonly ["id"];
|
|
624
840
|
readonly additionalProperties: false;
|
|
841
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
625
842
|
};
|
|
626
843
|
export declare const FleetSchema: {
|
|
627
844
|
readonly type: "object";
|
|
@@ -716,6 +933,7 @@ export declare const FleetSchema: {
|
|
|
716
933
|
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
717
934
|
};
|
|
718
935
|
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
936
|
+
readonly default: readonly [];
|
|
719
937
|
};
|
|
720
938
|
readonly 'topology.kubernetes.io/region': {
|
|
721
939
|
readonly type: "array";
|
|
@@ -724,14 +942,22 @@ export declare const FleetSchema: {
|
|
|
724
942
|
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
725
943
|
};
|
|
726
944
|
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
945
|
+
readonly default: readonly [];
|
|
727
946
|
};
|
|
728
947
|
};
|
|
948
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
729
949
|
readonly additionalProperties: false;
|
|
730
|
-
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.
|
|
950
|
+
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.";
|
|
951
|
+
readonly default: {
|
|
952
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
953
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
954
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
955
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
956
|
+
};
|
|
731
957
|
};
|
|
732
958
|
readonly scalingProfile: {
|
|
733
959
|
readonly type: "string";
|
|
734
|
-
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
960
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
735
961
|
readonly default: "conservative";
|
|
736
962
|
readonly example: "conservative";
|
|
737
963
|
readonly enum: readonly ["aggressive", "conservative"];
|
|
@@ -744,9 +970,30 @@ export declare const FleetSchema: {
|
|
|
744
970
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
745
971
|
readonly example: "new-clouds-fleet";
|
|
746
972
|
};
|
|
973
|
+
readonly ready: {
|
|
974
|
+
readonly type: "boolean";
|
|
975
|
+
readonly description: "Indicates whether the fleet configuration is healthy.";
|
|
976
|
+
readonly example: true;
|
|
977
|
+
};
|
|
978
|
+
readonly status_message: {
|
|
979
|
+
readonly type: "string";
|
|
980
|
+
readonly description: "Human-readable reason the fleet is not ready. Present only when `ready` is false.";
|
|
981
|
+
readonly example: "Invalid provider permissions.";
|
|
982
|
+
};
|
|
983
|
+
readonly created_at: {
|
|
984
|
+
readonly type: "string";
|
|
985
|
+
readonly description: "Creation date and time of the fleet.";
|
|
986
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
987
|
+
};
|
|
988
|
+
readonly updated_at: {
|
|
989
|
+
readonly type: "string";
|
|
990
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
991
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
992
|
+
};
|
|
747
993
|
};
|
|
748
|
-
readonly required: readonly ["scalingProfile", "id"];
|
|
994
|
+
readonly required: readonly ["constraints", "scalingProfile", "id", "ready", "created_at", "updated_at"];
|
|
749
995
|
readonly additionalProperties: false;
|
|
996
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
750
997
|
};
|
|
751
998
|
export declare const FleetUpdateInputSchema: {
|
|
752
999
|
readonly type: "object";
|
|
@@ -790,8 +1037,8 @@ export declare const FleetUpdateInputSchema: {
|
|
|
790
1037
|
readonly type: "string";
|
|
791
1038
|
readonly maxLength: 64;
|
|
792
1039
|
readonly minLength: 64;
|
|
793
|
-
readonly pattern: "^[A-Za-z0-9]
|
|
794
|
-
readonly description: "Hetzner Cloud API token with read
|
|
1040
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
1041
|
+
readonly description: "Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.";
|
|
795
1042
|
};
|
|
796
1043
|
};
|
|
797
1044
|
readonly required: readonly ["enabled"];
|
|
@@ -824,6 +1071,7 @@ export declare const FleetUpdateInputSchema: {
|
|
|
824
1071
|
};
|
|
825
1072
|
readonly minItems: 1;
|
|
826
1073
|
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1074
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
827
1075
|
};
|
|
828
1076
|
readonly 'kubernetes.io/arch': {
|
|
829
1077
|
readonly type: "array";
|
|
@@ -833,6 +1081,7 @@ export declare const FleetUpdateInputSchema: {
|
|
|
833
1081
|
};
|
|
834
1082
|
readonly minItems: 1;
|
|
835
1083
|
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1084
|
+
readonly default: readonly ["amd64"];
|
|
836
1085
|
};
|
|
837
1086
|
readonly 'cfke.io/instance-family': {
|
|
838
1087
|
readonly type: "array";
|
|
@@ -841,6 +1090,7 @@ export declare const FleetUpdateInputSchema: {
|
|
|
841
1090
|
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
842
1091
|
};
|
|
843
1092
|
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1093
|
+
readonly default: readonly [];
|
|
844
1094
|
};
|
|
845
1095
|
readonly 'topology.kubernetes.io/region': {
|
|
846
1096
|
readonly type: "array";
|
|
@@ -849,19 +1099,47 @@ export declare const FleetUpdateInputSchema: {
|
|
|
849
1099
|
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
850
1100
|
};
|
|
851
1101
|
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1102
|
+
readonly default: readonly [];
|
|
852
1103
|
};
|
|
853
1104
|
};
|
|
854
1105
|
readonly additionalProperties: false;
|
|
855
|
-
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.
|
|
1106
|
+
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.";
|
|
1107
|
+
readonly default: {
|
|
1108
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1109
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1110
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1111
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1112
|
+
};
|
|
856
1113
|
};
|
|
857
1114
|
readonly scalingProfile: {
|
|
858
1115
|
readonly type: "string";
|
|
859
|
-
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
1116
|
+
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`).";
|
|
1117
|
+
readonly default: "conservative";
|
|
860
1118
|
readonly example: "conservative";
|
|
861
1119
|
readonly enum: readonly ["aggressive", "conservative"];
|
|
862
1120
|
};
|
|
863
1121
|
};
|
|
864
|
-
readonly
|
|
1122
|
+
readonly additionalProperties: false;
|
|
1123
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
1124
|
+
};
|
|
1125
|
+
export declare const InviteCreateInputSchema: {
|
|
1126
|
+
readonly type: "object";
|
|
1127
|
+
readonly properties: {
|
|
1128
|
+
readonly email: {
|
|
1129
|
+
readonly type: "string";
|
|
1130
|
+
readonly format: "email";
|
|
1131
|
+
readonly description: "Email address of the user to invite.";
|
|
1132
|
+
readonly example: "email@example.com";
|
|
1133
|
+
};
|
|
1134
|
+
readonly role: {
|
|
1135
|
+
readonly type: "string";
|
|
1136
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1137
|
+
readonly default: "User";
|
|
1138
|
+
readonly example: "User";
|
|
1139
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1140
|
+
};
|
|
1141
|
+
};
|
|
1142
|
+
readonly required: readonly ["email"];
|
|
865
1143
|
readonly additionalProperties: false;
|
|
866
1144
|
};
|
|
867
1145
|
export declare const InviteSchema: {
|
|
@@ -895,6 +1173,13 @@ export declare const InviteSchema: {
|
|
|
895
1173
|
readonly description: "Generated unique invite code.";
|
|
896
1174
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
897
1175
|
};
|
|
1176
|
+
readonly role: {
|
|
1177
|
+
readonly type: "string";
|
|
1178
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1179
|
+
readonly default: "User";
|
|
1180
|
+
readonly example: "User";
|
|
1181
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1182
|
+
};
|
|
898
1183
|
};
|
|
899
1184
|
readonly required: readonly ["date_created"];
|
|
900
1185
|
readonly additionalProperties: false;
|
|
@@ -1092,6 +1377,12 @@ export declare const MarketplaceListingSchema: {
|
|
|
1092
1377
|
export declare const OrganizationCreateInputSchema: {
|
|
1093
1378
|
readonly type: "object";
|
|
1094
1379
|
readonly properties: {
|
|
1380
|
+
readonly type: {
|
|
1381
|
+
readonly type: "string";
|
|
1382
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1383
|
+
readonly example: "business";
|
|
1384
|
+
readonly enum: readonly ["business", "personal"];
|
|
1385
|
+
};
|
|
1095
1386
|
readonly email: {
|
|
1096
1387
|
readonly type: "string";
|
|
1097
1388
|
readonly format: "email";
|
|
@@ -1100,11 +1391,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
1100
1391
|
};
|
|
1101
1392
|
readonly first_name: {
|
|
1102
1393
|
readonly type: "string";
|
|
1394
|
+
readonly minLength: 1;
|
|
1103
1395
|
readonly description: "First name of the billing contact person.";
|
|
1104
1396
|
readonly example: "John";
|
|
1105
1397
|
};
|
|
1106
1398
|
readonly last_name: {
|
|
1107
1399
|
readonly type: "string";
|
|
1400
|
+
readonly minLength: 1;
|
|
1108
1401
|
readonly description: "Last name of the billing contact person.";
|
|
1109
1402
|
readonly example: "Doe";
|
|
1110
1403
|
};
|
|
@@ -1122,7 +1415,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
1122
1415
|
readonly description: "Password for the root account. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.";
|
|
1123
1416
|
};
|
|
1124
1417
|
};
|
|
1125
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1418
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1419
|
+
readonly additionalProperties: false;
|
|
1420
|
+
};
|
|
1421
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1422
|
+
readonly type: "object";
|
|
1423
|
+
readonly properties: {
|
|
1424
|
+
readonly id: {
|
|
1425
|
+
readonly type: "string";
|
|
1426
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1427
|
+
readonly example: "organization-id";
|
|
1428
|
+
};
|
|
1429
|
+
};
|
|
1430
|
+
readonly required: readonly ["id"];
|
|
1126
1431
|
readonly additionalProperties: false;
|
|
1127
1432
|
};
|
|
1128
1433
|
export declare const OrganizationSchema: {
|
|
@@ -1141,6 +1446,12 @@ export declare const OrganizationSchema: {
|
|
|
1141
1446
|
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1142
1447
|
readonly example: "ACME Corp.";
|
|
1143
1448
|
};
|
|
1449
|
+
readonly type: {
|
|
1450
|
+
readonly type: "string";
|
|
1451
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1452
|
+
readonly example: "business";
|
|
1453
|
+
readonly enum: readonly ["business", "personal"];
|
|
1454
|
+
};
|
|
1144
1455
|
readonly date_created: {
|
|
1145
1456
|
readonly type: "string";
|
|
1146
1457
|
readonly format: "date-time";
|
|
@@ -1172,6 +1483,17 @@ export declare const OrganizationSchema: {
|
|
|
1172
1483
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1173
1484
|
readonly example: 999;
|
|
1174
1485
|
};
|
|
1486
|
+
readonly enterprise_clusters_max: {
|
|
1487
|
+
readonly type: "integer";
|
|
1488
|
+
readonly minimum: 0;
|
|
1489
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1490
|
+
readonly example: 999;
|
|
1491
|
+
};
|
|
1492
|
+
readonly enterprise_clusters_available: {
|
|
1493
|
+
readonly type: "integer";
|
|
1494
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1495
|
+
readonly example: 999;
|
|
1496
|
+
};
|
|
1175
1497
|
readonly fleets_max: {
|
|
1176
1498
|
readonly type: "integer";
|
|
1177
1499
|
readonly minimum: 0;
|
|
@@ -1191,7 +1513,7 @@ export declare const OrganizationSchema: {
|
|
|
1191
1513
|
readonly type: "array";
|
|
1192
1514
|
readonly items: {
|
|
1193
1515
|
readonly type: "string";
|
|
1194
|
-
readonly example: "northamerica-central-
|
|
1516
|
+
readonly example: "northamerica-central-1a";
|
|
1195
1517
|
};
|
|
1196
1518
|
readonly minItems: 1;
|
|
1197
1519
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1225,7 +1547,7 @@ export declare const OrganizationSchema: {
|
|
|
1225
1547
|
readonly example: 500;
|
|
1226
1548
|
};
|
|
1227
1549
|
};
|
|
1228
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1550
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "enterprise_clusters_max", "enterprise_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1229
1551
|
readonly additionalProperties: false;
|
|
1230
1552
|
readonly description: "For security reasons, platform quota is controlled by Cloudfleet and can be updated only by Cloudfleet administrators. Please open a support ticket if you need to change the platform quota.";
|
|
1231
1553
|
};
|
|
@@ -1234,8 +1556,14 @@ export declare const OrganizationSchema: {
|
|
|
1234
1556
|
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1235
1557
|
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1236
1558
|
};
|
|
1559
|
+
readonly verification: {
|
|
1560
|
+
readonly type: "string";
|
|
1561
|
+
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.";
|
|
1562
|
+
readonly example: "verified";
|
|
1563
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1564
|
+
};
|
|
1237
1565
|
};
|
|
1238
|
-
readonly required: readonly ["id", "date_created", "quota", "status"];
|
|
1566
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1239
1567
|
readonly additionalProperties: false;
|
|
1240
1568
|
};
|
|
1241
1569
|
export declare const PaymentMethodSchema: {
|
|
@@ -1243,26 +1571,19 @@ export declare const PaymentMethodSchema: {
|
|
|
1243
1571
|
readonly properties: {
|
|
1244
1572
|
readonly id: {
|
|
1245
1573
|
readonly type: "string";
|
|
1246
|
-
readonly
|
|
1247
|
-
readonly
|
|
1248
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1249
|
-
};
|
|
1250
|
-
readonly setup: {
|
|
1251
|
-
readonly type: "boolean";
|
|
1252
|
-
readonly description: "Whether organization payment method was set up and ready to use for payments.";
|
|
1253
|
-
readonly example: true;
|
|
1574
|
+
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.";
|
|
1575
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1254
1576
|
};
|
|
1255
1577
|
readonly type: {
|
|
1256
1578
|
readonly type: "string";
|
|
1257
|
-
readonly
|
|
1258
|
-
readonly description: "Payment method type type. Only `card` payments supported at the moment.";
|
|
1579
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1259
1580
|
readonly example: "card";
|
|
1260
|
-
readonly enum: readonly ["card"];
|
|
1581
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1261
1582
|
};
|
|
1262
1583
|
readonly last4: {
|
|
1263
1584
|
readonly type: "string";
|
|
1264
1585
|
readonly nullable: true;
|
|
1265
|
-
readonly description: "Last 4 digits of the payment card number.";
|
|
1586
|
+
readonly description: "Last 4 digits of the payment card number, of the bank account (IBAN) for SEPA Direct Debit, or of the destination IBAN for bank transfer.";
|
|
1266
1587
|
readonly example: "4242";
|
|
1267
1588
|
};
|
|
1268
1589
|
readonly exp_month: {
|
|
@@ -1270,25 +1591,46 @@ export declare const PaymentMethodSchema: {
|
|
|
1270
1591
|
readonly minimum: 1;
|
|
1271
1592
|
readonly maximum: 12;
|
|
1272
1593
|
readonly nullable: true;
|
|
1273
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1274
|
-
readonly example:
|
|
1594
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1595
|
+
readonly example: 12;
|
|
1275
1596
|
};
|
|
1276
1597
|
readonly exp_year: {
|
|
1277
1598
|
readonly type: "integer";
|
|
1278
|
-
readonly minimum: 2024;
|
|
1279
1599
|
readonly nullable: true;
|
|
1280
|
-
readonly description: "Four-digit number representing the card's expiration year.";
|
|
1281
|
-
readonly example:
|
|
1600
|
+
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.";
|
|
1601
|
+
readonly example: 2028;
|
|
1282
1602
|
};
|
|
1283
1603
|
readonly brand: {
|
|
1284
1604
|
readonly type: "string";
|
|
1285
1605
|
readonly nullable: true;
|
|
1286
|
-
readonly description: "Payment card brand
|
|
1606
|
+
readonly description: "Payment card brand as reported by Stripe, e.g. `visa`, `mastercard`, `amex`, `cartes_bancaires`, or `unknown`. Null for SEPA Direct Debit and bank transfer.";
|
|
1287
1607
|
readonly example: "visa";
|
|
1288
|
-
|
|
1608
|
+
};
|
|
1609
|
+
readonly iban: {
|
|
1610
|
+
readonly type: "string";
|
|
1611
|
+
readonly nullable: true;
|
|
1612
|
+
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.";
|
|
1613
|
+
readonly example: "DE11243015658023127510";
|
|
1614
|
+
};
|
|
1615
|
+
readonly bic: {
|
|
1616
|
+
readonly type: "string";
|
|
1617
|
+
readonly nullable: true;
|
|
1618
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1619
|
+
readonly example: "SOGEDEFFXXX";
|
|
1620
|
+
};
|
|
1621
|
+
readonly account_holder_name: {
|
|
1622
|
+
readonly type: "string";
|
|
1623
|
+
readonly nullable: true;
|
|
1624
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1625
|
+
readonly example: "Cloudfleet GmbH";
|
|
1626
|
+
};
|
|
1627
|
+
readonly is_default: {
|
|
1628
|
+
readonly type: "boolean";
|
|
1629
|
+
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).";
|
|
1630
|
+
readonly example: true;
|
|
1289
1631
|
};
|
|
1290
1632
|
};
|
|
1291
|
-
readonly required: readonly ["id", "
|
|
1633
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1292
1634
|
readonly additionalProperties: false;
|
|
1293
1635
|
};
|
|
1294
1636
|
export declare const PlatformQuotaSchema: {
|
|
@@ -1316,6 +1658,17 @@ export declare const PlatformQuotaSchema: {
|
|
|
1316
1658
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1317
1659
|
readonly example: 999;
|
|
1318
1660
|
};
|
|
1661
|
+
readonly enterprise_clusters_max: {
|
|
1662
|
+
readonly type: "integer";
|
|
1663
|
+
readonly minimum: 0;
|
|
1664
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1665
|
+
readonly example: 999;
|
|
1666
|
+
};
|
|
1667
|
+
readonly enterprise_clusters_available: {
|
|
1668
|
+
readonly type: "integer";
|
|
1669
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1670
|
+
readonly example: 999;
|
|
1671
|
+
};
|
|
1319
1672
|
readonly fleets_max: {
|
|
1320
1673
|
readonly type: "integer";
|
|
1321
1674
|
readonly minimum: 0;
|
|
@@ -1335,7 +1688,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1335
1688
|
readonly type: "array";
|
|
1336
1689
|
readonly items: {
|
|
1337
1690
|
readonly type: "string";
|
|
1338
|
-
readonly example: "northamerica-central-
|
|
1691
|
+
readonly example: "northamerica-central-1a";
|
|
1339
1692
|
};
|
|
1340
1693
|
readonly minItems: 1;
|
|
1341
1694
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1369,7 +1722,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1369
1722
|
readonly example: 500;
|
|
1370
1723
|
};
|
|
1371
1724
|
};
|
|
1372
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1725
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "enterprise_clusters_max", "enterprise_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1373
1726
|
readonly additionalProperties: false;
|
|
1374
1727
|
};
|
|
1375
1728
|
export declare const RegistryRepositorySchema: {
|
|
@@ -1660,142 +2013,6 @@ export declare const TicketCreateInputSchema: {
|
|
|
1660
2013
|
readonly required: readonly ["category", "body"];
|
|
1661
2014
|
readonly additionalProperties: false;
|
|
1662
2015
|
};
|
|
1663
|
-
export declare const TicketListResponseSchema: {
|
|
1664
|
-
readonly type: "object";
|
|
1665
|
-
readonly properties: {
|
|
1666
|
-
readonly items: {
|
|
1667
|
-
readonly type: "array";
|
|
1668
|
-
readonly items: {
|
|
1669
|
-
readonly type: "object";
|
|
1670
|
-
readonly properties: {
|
|
1671
|
-
readonly id: {
|
|
1672
|
-
readonly type: "string";
|
|
1673
|
-
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
1674
|
-
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
1675
|
-
};
|
|
1676
|
-
readonly status: {
|
|
1677
|
-
readonly type: "string";
|
|
1678
|
-
readonly description: "Current state of the ticket.";
|
|
1679
|
-
readonly example: "waiting_on_us";
|
|
1680
|
-
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
1681
|
-
};
|
|
1682
|
-
readonly category: {
|
|
1683
|
-
readonly type: "string";
|
|
1684
|
-
readonly description: "Ticket category.";
|
|
1685
|
-
readonly example: "technical";
|
|
1686
|
-
readonly enum: readonly ["billing", "technical", "general"];
|
|
1687
|
-
};
|
|
1688
|
-
readonly summary: {
|
|
1689
|
-
readonly type: "string";
|
|
1690
|
-
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
1691
|
-
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1692
|
-
};
|
|
1693
|
-
readonly closed_at: {
|
|
1694
|
-
readonly type: "string";
|
|
1695
|
-
readonly format: "date-time";
|
|
1696
|
-
readonly nullable: true;
|
|
1697
|
-
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
1698
|
-
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1699
|
-
};
|
|
1700
|
-
readonly date_created: {
|
|
1701
|
-
readonly type: "string";
|
|
1702
|
-
readonly format: "date-time";
|
|
1703
|
-
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
1704
|
-
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1705
|
-
};
|
|
1706
|
-
readonly date_updated: {
|
|
1707
|
-
readonly type: "string";
|
|
1708
|
-
readonly format: "date-time";
|
|
1709
|
-
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
1710
|
-
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1711
|
-
};
|
|
1712
|
-
readonly messages: {
|
|
1713
|
-
readonly type: "array";
|
|
1714
|
-
readonly items: {
|
|
1715
|
-
readonly type: "object";
|
|
1716
|
-
readonly properties: {
|
|
1717
|
-
readonly id: {
|
|
1718
|
-
readonly type: "string";
|
|
1719
|
-
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
1720
|
-
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
1721
|
-
};
|
|
1722
|
-
readonly type: {
|
|
1723
|
-
readonly type: "string";
|
|
1724
|
-
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
1725
|
-
readonly example: "customer_reply";
|
|
1726
|
-
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
1727
|
-
};
|
|
1728
|
-
readonly body: {
|
|
1729
|
-
readonly type: "string";
|
|
1730
|
-
readonly description: "Message body in markdown.";
|
|
1731
|
-
readonly example: "Thanks — that resolved it on my side.";
|
|
1732
|
-
};
|
|
1733
|
-
readonly author_first_name: {
|
|
1734
|
-
readonly type: "string";
|
|
1735
|
-
readonly nullable: true;
|
|
1736
|
-
readonly description: "First name of the author. Null when not provided.";
|
|
1737
|
-
readonly example: "Jane";
|
|
1738
|
-
};
|
|
1739
|
-
readonly author_last_name: {
|
|
1740
|
-
readonly type: "string";
|
|
1741
|
-
readonly nullable: true;
|
|
1742
|
-
readonly description: "Last name of the author. Null when not provided.";
|
|
1743
|
-
readonly example: "Doe";
|
|
1744
|
-
};
|
|
1745
|
-
readonly attachments: {
|
|
1746
|
-
readonly type: "array";
|
|
1747
|
-
readonly items: {
|
|
1748
|
-
readonly type: "object";
|
|
1749
|
-
readonly properties: {
|
|
1750
|
-
readonly id: {
|
|
1751
|
-
readonly type: "string";
|
|
1752
|
-
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
1753
|
-
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1754
|
-
};
|
|
1755
|
-
readonly filename: {
|
|
1756
|
-
readonly type: "string";
|
|
1757
|
-
readonly description: "Original filename as uploaded.";
|
|
1758
|
-
readonly example: "debug.log";
|
|
1759
|
-
};
|
|
1760
|
-
readonly content_type: {
|
|
1761
|
-
readonly type: "string";
|
|
1762
|
-
readonly description: "MIME content type of the attachment.";
|
|
1763
|
-
readonly example: "text/plain";
|
|
1764
|
-
};
|
|
1765
|
-
readonly size: {
|
|
1766
|
-
readonly type: "integer";
|
|
1767
|
-
readonly description: "Size of the attachment in bytes.";
|
|
1768
|
-
readonly example: 12345;
|
|
1769
|
-
};
|
|
1770
|
-
};
|
|
1771
|
-
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1772
|
-
readonly additionalProperties: false;
|
|
1773
|
-
};
|
|
1774
|
-
readonly description: "Attachments associated with this message.";
|
|
1775
|
-
readonly example: readonly [];
|
|
1776
|
-
};
|
|
1777
|
-
readonly date_created: {
|
|
1778
|
-
readonly type: "string";
|
|
1779
|
-
readonly format: "date-time";
|
|
1780
|
-
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
1781
|
-
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1782
|
-
};
|
|
1783
|
-
};
|
|
1784
|
-
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
1785
|
-
readonly additionalProperties: false;
|
|
1786
|
-
};
|
|
1787
|
-
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
1788
|
-
};
|
|
1789
|
-
};
|
|
1790
|
-
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1791
|
-
readonly additionalProperties: false;
|
|
1792
|
-
};
|
|
1793
|
-
readonly description: "Tickets for the organization, ordered newest first. Messages are omitted from list responses.";
|
|
1794
|
-
};
|
|
1795
|
-
};
|
|
1796
|
-
readonly required: readonly ["items"];
|
|
1797
|
-
readonly additionalProperties: false;
|
|
1798
|
-
};
|
|
1799
2016
|
export declare const TicketMessageInputSchema: {
|
|
1800
2017
|
readonly type: "object";
|
|
1801
2018
|
readonly properties: {
|
|
@@ -1832,11 +2049,13 @@ export declare const TicketMessageSchema: {
|
|
|
1832
2049
|
};
|
|
1833
2050
|
readonly author_first_name: {
|
|
1834
2051
|
readonly type: "string";
|
|
2052
|
+
readonly nullable: true;
|
|
1835
2053
|
readonly description: "First name of the author. Null when not provided.";
|
|
1836
2054
|
readonly example: "Jane";
|
|
1837
2055
|
};
|
|
1838
2056
|
readonly author_last_name: {
|
|
1839
2057
|
readonly type: "string";
|
|
2058
|
+
readonly nullable: true;
|
|
1840
2059
|
readonly description: "Last name of the author. Null when not provided.";
|
|
1841
2060
|
readonly example: "Doe";
|
|
1842
2061
|
};
|
|
@@ -1910,6 +2129,7 @@ export declare const TicketSchema: {
|
|
|
1910
2129
|
readonly closed_at: {
|
|
1911
2130
|
readonly type: "string";
|
|
1912
2131
|
readonly format: "date-time";
|
|
2132
|
+
readonly nullable: true;
|
|
1913
2133
|
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
1914
2134
|
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1915
2135
|
};
|
|
@@ -2097,9 +2317,10 @@ export declare const UsageFacetsSchema: {
|
|
|
2097
2317
|
readonly type: "array";
|
|
2098
2318
|
readonly items: {
|
|
2099
2319
|
readonly type: "string";
|
|
2320
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
2100
2321
|
};
|
|
2101
2322
|
readonly description: "List of unique products";
|
|
2102
|
-
readonly example: readonly ["
|
|
2323
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
2103
2324
|
};
|
|
2104
2325
|
};
|
|
2105
2326
|
readonly additionalProperties: false;
|
|
@@ -2125,7 +2346,8 @@ export declare const UsageResponseSchema: {
|
|
|
2125
2346
|
readonly product: {
|
|
2126
2347
|
readonly type: "string";
|
|
2127
2348
|
readonly description: "The product the usage is associated with";
|
|
2128
|
-
readonly example: "
|
|
2349
|
+
readonly example: "cfke_controlplane_pro";
|
|
2350
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
2129
2351
|
};
|
|
2130
2352
|
readonly value: {
|
|
2131
2353
|
readonly type: "number";
|
|
@@ -2165,9 +2387,10 @@ export declare const UsageResponseSchema: {
|
|
|
2165
2387
|
readonly type: "array";
|
|
2166
2388
|
readonly items: {
|
|
2167
2389
|
readonly type: "string";
|
|
2390
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
2168
2391
|
};
|
|
2169
2392
|
readonly description: "List of unique products";
|
|
2170
|
-
readonly example: readonly ["
|
|
2393
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
2171
2394
|
};
|
|
2172
2395
|
};
|
|
2173
2396
|
readonly additionalProperties: false;
|
|
@@ -2193,7 +2416,8 @@ export declare const UsageSchema: {
|
|
|
2193
2416
|
readonly product: {
|
|
2194
2417
|
readonly type: "string";
|
|
2195
2418
|
readonly description: "The product the usage is associated with";
|
|
2196
|
-
readonly example: "
|
|
2419
|
+
readonly example: "cfke_controlplane_pro";
|
|
2420
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
2197
2421
|
};
|
|
2198
2422
|
readonly value: {
|
|
2199
2423
|
readonly type: "number";
|
|
@@ -2250,18 +2474,6 @@ export declare const UserCreateInputSchema: {
|
|
|
2250
2474
|
readonly minLength: 8;
|
|
2251
2475
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
2252
2476
|
};
|
|
2253
|
-
readonly status: {
|
|
2254
|
-
readonly type: "string";
|
|
2255
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
2256
|
-
readonly example: "active";
|
|
2257
|
-
readonly enum: readonly ["active", "inactive"];
|
|
2258
|
-
};
|
|
2259
|
-
readonly role: {
|
|
2260
|
-
readonly type: "string";
|
|
2261
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
2262
|
-
readonly example: "User";
|
|
2263
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
2264
|
-
};
|
|
2265
2477
|
};
|
|
2266
2478
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
2267
2479
|
readonly additionalProperties: false;
|