@cloudfleet/sdk 0.0.1-c034297 → 0.0.1-c229303
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 +446 -372
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +478 -392
- 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 +479 -225
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +642 -317
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +249 -211
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +357 -304
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +1113 -789
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +1697 -1474
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +503 -349
- package/dist/zod.gen.js.map +1 -1
- package/package.json +9 -12
package/dist/schemas.gen.d.ts
CHANGED
|
@@ -1,6 +1,49 @@
|
|
|
1
|
+
export declare const BasicPriceConsentInputSchema: {
|
|
2
|
+
readonly type: "object";
|
|
3
|
+
readonly properties: {
|
|
4
|
+
readonly decision: {
|
|
5
|
+
readonly type: "string";
|
|
6
|
+
readonly description: "The administrator's decision on the new Basic price. `accepted` continues to paid billing when the signup credit runs out; `rejected` opts out (clusters are suspended, never charged). A `rejected` org can later be flipped back to `accepted`.";
|
|
7
|
+
readonly example: "accepted";
|
|
8
|
+
readonly enum: readonly ["accepted", "rejected"];
|
|
9
|
+
};
|
|
10
|
+
};
|
|
11
|
+
readonly required: readonly ["decision"];
|
|
12
|
+
readonly additionalProperties: false;
|
|
13
|
+
};
|
|
14
|
+
export declare const BasicPriceConsentSchema: {
|
|
15
|
+
readonly type: "object";
|
|
16
|
+
readonly properties: {
|
|
17
|
+
readonly status: {
|
|
18
|
+
readonly type: "string";
|
|
19
|
+
readonly description: "Consent status for the new Basic price. `not_applicable` when the organization is not in scope for the migration. `pending` when the organization must opt in but no admin has decided yet. `accepted` / `rejected` reflect the recorded decision.";
|
|
20
|
+
readonly example: "pending";
|
|
21
|
+
readonly enum: readonly ["not_applicable", "pending", "accepted", "rejected"];
|
|
22
|
+
};
|
|
23
|
+
readonly decided_at: {
|
|
24
|
+
readonly type: "string";
|
|
25
|
+
readonly format: "date-time";
|
|
26
|
+
readonly description: "When the current decision was recorded. Absent while `not_applicable` or `pending`.";
|
|
27
|
+
readonly example: "2026-09-05T10:12:00.000Z";
|
|
28
|
+
};
|
|
29
|
+
readonly decided_by: {
|
|
30
|
+
readonly type: "string";
|
|
31
|
+
readonly description: "User id of the administrator who recorded the current decision. Absent while `not_applicable` or `pending`.";
|
|
32
|
+
readonly example: "2b7a5c9e-1f4d-4a1b-9c3e-8d2f6a0b1c2d";
|
|
33
|
+
};
|
|
34
|
+
};
|
|
35
|
+
readonly required: readonly ["status"];
|
|
36
|
+
readonly additionalProperties: false;
|
|
37
|
+
};
|
|
1
38
|
export declare const BillingContactSchema: {
|
|
2
39
|
readonly type: "object";
|
|
3
40
|
readonly properties: {
|
|
41
|
+
readonly type: {
|
|
42
|
+
readonly type: "string";
|
|
43
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
44
|
+
readonly example: "business";
|
|
45
|
+
readonly enum: readonly ["business", "personal"];
|
|
46
|
+
};
|
|
4
47
|
readonly company: {
|
|
5
48
|
readonly type: "string";
|
|
6
49
|
readonly maxLength: 120;
|
|
@@ -76,7 +119,7 @@ export declare const BillingContactSchema: {
|
|
|
76
119
|
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
120
|
};
|
|
78
121
|
};
|
|
79
|
-
readonly required: readonly ["email", "individual_name"];
|
|
122
|
+
readonly required: readonly ["type", "email", "individual_name"];
|
|
80
123
|
readonly additionalProperties: false;
|
|
81
124
|
};
|
|
82
125
|
export declare const BillingCreditsSchema: {
|
|
@@ -211,9 +254,8 @@ export declare const ChartSchema: {
|
|
|
211
254
|
};
|
|
212
255
|
readonly status: {
|
|
213
256
|
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"];
|
|
257
|
+
readonly description: "Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).";
|
|
258
|
+
readonly example: "InstallSucceeded";
|
|
217
259
|
};
|
|
218
260
|
readonly version_current: {
|
|
219
261
|
readonly type: "string";
|
|
@@ -270,15 +312,9 @@ export declare const ClusterCreateInputSchema: {
|
|
|
270
312
|
readonly tier: {
|
|
271
313
|
readonly type: "string";
|
|
272
314
|
readonly description: "Tier of the cluster.";
|
|
315
|
+
readonly default: "basic";
|
|
273
316
|
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"];
|
|
317
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
282
318
|
};
|
|
283
319
|
readonly version_channel: {
|
|
284
320
|
readonly type: "string";
|
|
@@ -286,11 +322,93 @@ export declare const ClusterCreateInputSchema: {
|
|
|
286
322
|
readonly description: "Version of the kubernetes cluster.";
|
|
287
323
|
readonly default: "1.x.x-cfke.x";
|
|
288
324
|
readonly example: "1.x.x-cfke.x";
|
|
289
|
-
|
|
325
|
+
};
|
|
326
|
+
readonly release_channel: {
|
|
327
|
+
readonly type: "string";
|
|
328
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
329
|
+
readonly default: "rapid";
|
|
330
|
+
readonly example: "rapid";
|
|
331
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
332
|
+
};
|
|
333
|
+
readonly features: {
|
|
334
|
+
readonly type: "object";
|
|
335
|
+
readonly properties: {
|
|
336
|
+
readonly gpu_sharing_strategy: {
|
|
337
|
+
readonly type: "string";
|
|
338
|
+
readonly description: "GPU sharing strategy.";
|
|
339
|
+
readonly default: "none";
|
|
340
|
+
readonly example: "none";
|
|
341
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
342
|
+
};
|
|
343
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
344
|
+
readonly type: "integer";
|
|
345
|
+
readonly minimum: 2;
|
|
346
|
+
readonly maximum: 48;
|
|
347
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
348
|
+
readonly default: 4;
|
|
349
|
+
readonly example: 10;
|
|
350
|
+
};
|
|
351
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
352
|
+
readonly type: "boolean";
|
|
353
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
354
|
+
readonly example: false;
|
|
355
|
+
};
|
|
356
|
+
};
|
|
357
|
+
readonly additionalProperties: false;
|
|
358
|
+
readonly description: "Cluster feature toggles.";
|
|
359
|
+
readonly default: {
|
|
360
|
+
readonly gpu_sharing_strategy: "none";
|
|
361
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
362
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
363
|
+
};
|
|
364
|
+
};
|
|
365
|
+
readonly region: {
|
|
366
|
+
readonly type: "string";
|
|
367
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
368
|
+
readonly example: "europe-central-1a";
|
|
369
|
+
};
|
|
370
|
+
readonly networking: {
|
|
371
|
+
readonly type: "object";
|
|
372
|
+
readonly properties: {
|
|
373
|
+
readonly pod_cidr: {
|
|
374
|
+
readonly type: "string";
|
|
375
|
+
readonly description: "CIDR block for pod IPs.";
|
|
376
|
+
readonly default: "10.244.0.0/16";
|
|
377
|
+
};
|
|
378
|
+
readonly service_cidr: {
|
|
379
|
+
readonly type: "string";
|
|
380
|
+
readonly description: "CIDR block for service IPs.";
|
|
381
|
+
readonly default: "10.96.0.0/12";
|
|
382
|
+
};
|
|
383
|
+
readonly dual_stack: {
|
|
384
|
+
readonly type: "boolean";
|
|
385
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
386
|
+
};
|
|
387
|
+
readonly pod_cidr_v6: {
|
|
388
|
+
readonly type: "string";
|
|
389
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
390
|
+
readonly default: "2001:db8:1:2::/48";
|
|
391
|
+
};
|
|
392
|
+
readonly service_cidr_v6: {
|
|
393
|
+
readonly type: "string";
|
|
394
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
395
|
+
readonly default: "2001:db8:1:1::/112";
|
|
396
|
+
};
|
|
397
|
+
};
|
|
398
|
+
readonly additionalProperties: false;
|
|
399
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
400
|
+
readonly default: {
|
|
401
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
402
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
403
|
+
readonly dual_stack: false;
|
|
404
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
405
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
406
|
+
};
|
|
290
407
|
};
|
|
291
408
|
};
|
|
292
|
-
readonly required: readonly ["name", "
|
|
409
|
+
readonly required: readonly ["name", "region"];
|
|
293
410
|
readonly additionalProperties: false;
|
|
411
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
294
412
|
};
|
|
295
413
|
export declare const ClusterJoinInformationSchema: {
|
|
296
414
|
readonly type: "object";
|
|
@@ -311,11 +429,21 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
311
429
|
readonly description: "Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.";
|
|
312
430
|
readonly example: "10.96.0.10";
|
|
313
431
|
};
|
|
432
|
+
readonly pod_cidr: {
|
|
433
|
+
readonly type: "string";
|
|
434
|
+
readonly description: "Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.";
|
|
435
|
+
readonly example: "10.244.0.0/16";
|
|
436
|
+
};
|
|
314
437
|
readonly auth_key: {
|
|
315
438
|
readonly type: "string";
|
|
316
439
|
readonly description: "Authentication key for the cluster.";
|
|
317
440
|
readonly example: "tskey-auth-kBV8wr1dk911CNTRL-...";
|
|
318
441
|
};
|
|
442
|
+
readonly login_server: {
|
|
443
|
+
readonly type: "string";
|
|
444
|
+
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.";
|
|
445
|
+
readonly example: "https://415026b6-f00f-44f8-968d-fc6ef4d0fc6d.fabric.europe-central-1a.cfke.io";
|
|
446
|
+
};
|
|
319
447
|
readonly bootstrap_token: {
|
|
320
448
|
readonly type: "string";
|
|
321
449
|
readonly description: "Bootstrap token for the cluster.";
|
|
@@ -373,7 +501,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
373
501
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
374
502
|
};
|
|
375
503
|
};
|
|
376
|
-
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
504
|
+
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "pod_cidr", "auth_key", "login_server", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
377
505
|
readonly additionalProperties: false;
|
|
378
506
|
};
|
|
379
507
|
export declare const ClusterSchema: {
|
|
@@ -390,15 +518,100 @@ export declare const ClusterSchema: {
|
|
|
390
518
|
readonly tier: {
|
|
391
519
|
readonly type: "string";
|
|
392
520
|
readonly description: "Tier of the cluster.";
|
|
521
|
+
readonly default: "basic";
|
|
393
522
|
readonly example: "pro";
|
|
394
|
-
readonly enum: readonly ["basic", "pro"];
|
|
523
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
524
|
+
};
|
|
525
|
+
readonly version_channel: {
|
|
526
|
+
readonly type: "string";
|
|
527
|
+
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-]+)*))?$";
|
|
528
|
+
readonly description: "Version of the kubernetes cluster.";
|
|
529
|
+
readonly default: "1.x.x-cfke.x";
|
|
530
|
+
readonly example: "1.x.x-cfke.x";
|
|
531
|
+
};
|
|
532
|
+
readonly release_channel: {
|
|
533
|
+
readonly type: "string";
|
|
534
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
535
|
+
readonly default: "rapid";
|
|
536
|
+
readonly example: "rapid";
|
|
537
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
538
|
+
};
|
|
539
|
+
readonly features: {
|
|
540
|
+
readonly type: "object";
|
|
541
|
+
readonly properties: {
|
|
542
|
+
readonly gpu_sharing_strategy: {
|
|
543
|
+
readonly type: "string";
|
|
544
|
+
readonly description: "GPU sharing strategy.";
|
|
545
|
+
readonly default: "none";
|
|
546
|
+
readonly example: "none";
|
|
547
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
548
|
+
};
|
|
549
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
550
|
+
readonly type: "integer";
|
|
551
|
+
readonly minimum: 2;
|
|
552
|
+
readonly maximum: 48;
|
|
553
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
554
|
+
readonly default: 4;
|
|
555
|
+
readonly example: 10;
|
|
556
|
+
};
|
|
557
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
558
|
+
readonly type: "boolean";
|
|
559
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
560
|
+
readonly example: false;
|
|
561
|
+
};
|
|
562
|
+
};
|
|
563
|
+
readonly required: readonly ["gpu_sharing_strategy", "gpu_max_shared_clients_per_gpu", "cilium_socket_lb_host_namespace_only"];
|
|
564
|
+
readonly additionalProperties: false;
|
|
565
|
+
readonly description: "Cluster feature toggles.";
|
|
566
|
+
readonly default: {
|
|
567
|
+
readonly gpu_sharing_strategy: "none";
|
|
568
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
569
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
570
|
+
};
|
|
395
571
|
};
|
|
396
572
|
readonly region: {
|
|
397
573
|
readonly type: "string";
|
|
398
|
-
readonly description: "Cloudfleet control plane region.
|
|
399
|
-
readonly
|
|
400
|
-
|
|
401
|
-
|
|
574
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
575
|
+
readonly example: "europe-central-1a";
|
|
576
|
+
};
|
|
577
|
+
readonly networking: {
|
|
578
|
+
readonly type: "object";
|
|
579
|
+
readonly properties: {
|
|
580
|
+
readonly pod_cidr: {
|
|
581
|
+
readonly type: "string";
|
|
582
|
+
readonly description: "CIDR block for pod IPs.";
|
|
583
|
+
readonly default: "10.244.0.0/16";
|
|
584
|
+
};
|
|
585
|
+
readonly service_cidr: {
|
|
586
|
+
readonly type: "string";
|
|
587
|
+
readonly description: "CIDR block for service IPs.";
|
|
588
|
+
readonly default: "10.96.0.0/12";
|
|
589
|
+
};
|
|
590
|
+
readonly dual_stack: {
|
|
591
|
+
readonly type: "boolean";
|
|
592
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
593
|
+
};
|
|
594
|
+
readonly pod_cidr_v6: {
|
|
595
|
+
readonly type: "string";
|
|
596
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
597
|
+
readonly default: "2001:db8:1:2::/48";
|
|
598
|
+
};
|
|
599
|
+
readonly service_cidr_v6: {
|
|
600
|
+
readonly type: "string";
|
|
601
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
602
|
+
readonly default: "2001:db8:1:1::/112";
|
|
603
|
+
};
|
|
604
|
+
};
|
|
605
|
+
readonly required: readonly ["pod_cidr", "service_cidr", "dual_stack", "pod_cidr_v6", "service_cidr_v6"];
|
|
606
|
+
readonly additionalProperties: false;
|
|
607
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
608
|
+
readonly default: {
|
|
609
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
610
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
611
|
+
readonly dual_stack: false;
|
|
612
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
613
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
614
|
+
};
|
|
402
615
|
};
|
|
403
616
|
readonly id: {
|
|
404
617
|
readonly type: "string";
|
|
@@ -408,16 +621,16 @@ export declare const ClusterSchema: {
|
|
|
408
621
|
};
|
|
409
622
|
readonly status: {
|
|
410
623
|
readonly type: "string";
|
|
411
|
-
readonly description: "Status of the cluster.
|
|
412
|
-
readonly example: "
|
|
413
|
-
readonly enum: readonly ["
|
|
624
|
+
readonly description: "Status of the cluster.";
|
|
625
|
+
readonly example: "deployed";
|
|
626
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
414
627
|
};
|
|
415
628
|
readonly endpoint: {
|
|
416
629
|
readonly anyOf: readonly [{
|
|
417
630
|
readonly type: "string";
|
|
418
631
|
readonly format: "uri";
|
|
419
|
-
readonly description: "URL signed by
|
|
420
|
-
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
632
|
+
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.";
|
|
633
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
421
634
|
}, {
|
|
422
635
|
readonly type: "string";
|
|
423
636
|
readonly enum: readonly [""];
|
|
@@ -427,7 +640,7 @@ export declare const ClusterSchema: {
|
|
|
427
640
|
readonly anyOf: readonly [{
|
|
428
641
|
readonly type: "string";
|
|
429
642
|
readonly format: "uri";
|
|
430
|
-
readonly description: "
|
|
643
|
+
readonly description: "Deprecated alias of `endpoint`; retained for backward compatibility.";
|
|
431
644
|
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
432
645
|
}, {
|
|
433
646
|
readonly type: "string";
|
|
@@ -459,15 +672,10 @@ export declare const ClusterSchema: {
|
|
|
459
672
|
readonly description: "Indicates if the cluster is ready to be used.";
|
|
460
673
|
readonly example: true;
|
|
461
674
|
};
|
|
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
675
|
};
|
|
469
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
676
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
470
677
|
readonly additionalProperties: false;
|
|
678
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
471
679
|
};
|
|
472
680
|
export declare const ClusterUpdateInputSchema: {
|
|
473
681
|
readonly type: "object";
|
|
@@ -483,18 +691,60 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
483
691
|
readonly tier: {
|
|
484
692
|
readonly type: "string";
|
|
485
693
|
readonly description: "Tier of the cluster.";
|
|
694
|
+
readonly default: "basic";
|
|
486
695
|
readonly example: "pro";
|
|
487
|
-
readonly enum: readonly ["basic", "pro"];
|
|
696
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
488
697
|
};
|
|
489
698
|
readonly version_channel: {
|
|
490
699
|
readonly type: "string";
|
|
491
700
|
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
701
|
readonly description: "Version of the kubernetes cluster.";
|
|
702
|
+
readonly default: "1.x.x-cfke.x";
|
|
493
703
|
readonly example: "1.x.x-cfke.x";
|
|
494
704
|
};
|
|
705
|
+
readonly release_channel: {
|
|
706
|
+
readonly type: "string";
|
|
707
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
708
|
+
readonly default: "rapid";
|
|
709
|
+
readonly example: "rapid";
|
|
710
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
711
|
+
};
|
|
712
|
+
readonly features: {
|
|
713
|
+
readonly type: "object";
|
|
714
|
+
readonly properties: {
|
|
715
|
+
readonly gpu_sharing_strategy: {
|
|
716
|
+
readonly type: "string";
|
|
717
|
+
readonly description: "GPU sharing strategy.";
|
|
718
|
+
readonly default: "none";
|
|
719
|
+
readonly example: "none";
|
|
720
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
721
|
+
};
|
|
722
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
723
|
+
readonly type: "integer";
|
|
724
|
+
readonly minimum: 2;
|
|
725
|
+
readonly maximum: 48;
|
|
726
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
727
|
+
readonly default: 4;
|
|
728
|
+
readonly example: 10;
|
|
729
|
+
};
|
|
730
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
731
|
+
readonly type: "boolean";
|
|
732
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
733
|
+
readonly example: false;
|
|
734
|
+
};
|
|
735
|
+
};
|
|
736
|
+
readonly additionalProperties: false;
|
|
737
|
+
readonly description: "Cluster feature toggles.";
|
|
738
|
+
readonly default: {
|
|
739
|
+
readonly gpu_sharing_strategy: "none";
|
|
740
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
741
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
742
|
+
};
|
|
743
|
+
};
|
|
495
744
|
};
|
|
496
|
-
readonly required: readonly ["
|
|
745
|
+
readonly required: readonly ["name"];
|
|
497
746
|
readonly additionalProperties: false;
|
|
747
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
498
748
|
};
|
|
499
749
|
export declare const FleetCreateInputSchema: {
|
|
500
750
|
readonly type: "object";
|
|
@@ -538,8 +788,8 @@ export declare const FleetCreateInputSchema: {
|
|
|
538
788
|
readonly type: "string";
|
|
539
789
|
readonly maxLength: 64;
|
|
540
790
|
readonly minLength: 64;
|
|
541
|
-
readonly pattern: "^[A-Za-z0-9]
|
|
542
|
-
readonly description: "Hetzner Cloud API token with read
|
|
791
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
792
|
+
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
793
|
};
|
|
544
794
|
};
|
|
545
795
|
readonly required: readonly ["enabled"];
|
|
@@ -591,6 +841,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
591
841
|
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
842
|
};
|
|
593
843
|
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
844
|
+
readonly default: readonly [];
|
|
594
845
|
};
|
|
595
846
|
readonly 'topology.kubernetes.io/region': {
|
|
596
847
|
readonly type: "array";
|
|
@@ -599,14 +850,21 @@ export declare const FleetCreateInputSchema: {
|
|
|
599
850
|
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
851
|
};
|
|
601
852
|
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
853
|
+
readonly default: readonly [];
|
|
602
854
|
};
|
|
603
855
|
};
|
|
604
856
|
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.
|
|
857
|
+
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.";
|
|
858
|
+
readonly default: {
|
|
859
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
860
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
861
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
862
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
863
|
+
};
|
|
606
864
|
};
|
|
607
865
|
readonly scalingProfile: {
|
|
608
866
|
readonly type: "string";
|
|
609
|
-
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
867
|
+
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
868
|
readonly default: "conservative";
|
|
611
869
|
readonly example: "conservative";
|
|
612
870
|
readonly enum: readonly ["aggressive", "conservative"];
|
|
@@ -622,6 +880,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
622
880
|
};
|
|
623
881
|
readonly required: readonly ["id"];
|
|
624
882
|
readonly additionalProperties: false;
|
|
883
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
625
884
|
};
|
|
626
885
|
export declare const FleetSchema: {
|
|
627
886
|
readonly type: "object";
|
|
@@ -716,6 +975,7 @@ export declare const FleetSchema: {
|
|
|
716
975
|
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
976
|
};
|
|
718
977
|
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
978
|
+
readonly default: readonly [];
|
|
719
979
|
};
|
|
720
980
|
readonly 'topology.kubernetes.io/region': {
|
|
721
981
|
readonly type: "array";
|
|
@@ -724,14 +984,22 @@ export declare const FleetSchema: {
|
|
|
724
984
|
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
985
|
};
|
|
726
986
|
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
987
|
+
readonly default: readonly [];
|
|
727
988
|
};
|
|
728
989
|
};
|
|
990
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
729
991
|
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.
|
|
992
|
+
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.";
|
|
993
|
+
readonly default: {
|
|
994
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
995
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
996
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
997
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
998
|
+
};
|
|
731
999
|
};
|
|
732
1000
|
readonly scalingProfile: {
|
|
733
1001
|
readonly type: "string";
|
|
734
|
-
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
1002
|
+
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
1003
|
readonly default: "conservative";
|
|
736
1004
|
readonly example: "conservative";
|
|
737
1005
|
readonly enum: readonly ["aggressive", "conservative"];
|
|
@@ -744,9 +1012,30 @@ export declare const FleetSchema: {
|
|
|
744
1012
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
745
1013
|
readonly example: "new-clouds-fleet";
|
|
746
1014
|
};
|
|
1015
|
+
readonly ready: {
|
|
1016
|
+
readonly type: "boolean";
|
|
1017
|
+
readonly description: "Indicates whether the fleet configuration is healthy.";
|
|
1018
|
+
readonly example: true;
|
|
1019
|
+
};
|
|
1020
|
+
readonly status_message: {
|
|
1021
|
+
readonly type: "string";
|
|
1022
|
+
readonly description: "Human-readable reason the fleet is not ready. Present only when `ready` is false.";
|
|
1023
|
+
readonly example: "Invalid provider permissions.";
|
|
1024
|
+
};
|
|
1025
|
+
readonly created_at: {
|
|
1026
|
+
readonly type: "string";
|
|
1027
|
+
readonly description: "Creation date and time of the fleet.";
|
|
1028
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1029
|
+
};
|
|
1030
|
+
readonly updated_at: {
|
|
1031
|
+
readonly type: "string";
|
|
1032
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
1033
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1034
|
+
};
|
|
747
1035
|
};
|
|
748
|
-
readonly required: readonly ["scalingProfile", "id"];
|
|
1036
|
+
readonly required: readonly ["constraints", "scalingProfile", "id", "ready", "created_at", "updated_at"];
|
|
749
1037
|
readonly additionalProperties: false;
|
|
1038
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
750
1039
|
};
|
|
751
1040
|
export declare const FleetUpdateInputSchema: {
|
|
752
1041
|
readonly type: "object";
|
|
@@ -790,8 +1079,8 @@ export declare const FleetUpdateInputSchema: {
|
|
|
790
1079
|
readonly type: "string";
|
|
791
1080
|
readonly maxLength: 64;
|
|
792
1081
|
readonly minLength: 64;
|
|
793
|
-
readonly pattern: "^[A-Za-z0-9]
|
|
794
|
-
readonly description: "Hetzner Cloud API token with read
|
|
1082
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
1083
|
+
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
1084
|
};
|
|
796
1085
|
};
|
|
797
1086
|
readonly required: readonly ["enabled"];
|
|
@@ -824,6 +1113,7 @@ export declare const FleetUpdateInputSchema: {
|
|
|
824
1113
|
};
|
|
825
1114
|
readonly minItems: 1;
|
|
826
1115
|
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1116
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
827
1117
|
};
|
|
828
1118
|
readonly 'kubernetes.io/arch': {
|
|
829
1119
|
readonly type: "array";
|
|
@@ -833,6 +1123,7 @@ export declare const FleetUpdateInputSchema: {
|
|
|
833
1123
|
};
|
|
834
1124
|
readonly minItems: 1;
|
|
835
1125
|
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1126
|
+
readonly default: readonly ["amd64"];
|
|
836
1127
|
};
|
|
837
1128
|
readonly 'cfke.io/instance-family': {
|
|
838
1129
|
readonly type: "array";
|
|
@@ -841,6 +1132,7 @@ export declare const FleetUpdateInputSchema: {
|
|
|
841
1132
|
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
1133
|
};
|
|
843
1134
|
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1135
|
+
readonly default: readonly [];
|
|
844
1136
|
};
|
|
845
1137
|
readonly 'topology.kubernetes.io/region': {
|
|
846
1138
|
readonly type: "array";
|
|
@@ -849,19 +1141,47 @@ export declare const FleetUpdateInputSchema: {
|
|
|
849
1141
|
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
1142
|
};
|
|
851
1143
|
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1144
|
+
readonly default: readonly [];
|
|
852
1145
|
};
|
|
853
1146
|
};
|
|
854
1147
|
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.
|
|
1148
|
+
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.";
|
|
1149
|
+
readonly default: {
|
|
1150
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1151
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1152
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1153
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1154
|
+
};
|
|
856
1155
|
};
|
|
857
1156
|
readonly scalingProfile: {
|
|
858
1157
|
readonly type: "string";
|
|
859
|
-
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
1158
|
+
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`).";
|
|
1159
|
+
readonly default: "conservative";
|
|
860
1160
|
readonly example: "conservative";
|
|
861
1161
|
readonly enum: readonly ["aggressive", "conservative"];
|
|
862
1162
|
};
|
|
863
1163
|
};
|
|
864
|
-
readonly
|
|
1164
|
+
readonly additionalProperties: false;
|
|
1165
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
1166
|
+
};
|
|
1167
|
+
export declare const InviteCreateInputSchema: {
|
|
1168
|
+
readonly type: "object";
|
|
1169
|
+
readonly properties: {
|
|
1170
|
+
readonly email: {
|
|
1171
|
+
readonly type: "string";
|
|
1172
|
+
readonly format: "email";
|
|
1173
|
+
readonly description: "Email address of the user to invite.";
|
|
1174
|
+
readonly example: "email@example.com";
|
|
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
|
+
};
|
|
1183
|
+
};
|
|
1184
|
+
readonly required: readonly ["email"];
|
|
865
1185
|
readonly additionalProperties: false;
|
|
866
1186
|
};
|
|
867
1187
|
export declare const InviteSchema: {
|
|
@@ -895,6 +1215,13 @@ export declare const InviteSchema: {
|
|
|
895
1215
|
readonly description: "Generated unique invite code.";
|
|
896
1216
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
897
1217
|
};
|
|
1218
|
+
readonly role: {
|
|
1219
|
+
readonly type: "string";
|
|
1220
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1221
|
+
readonly default: "User";
|
|
1222
|
+
readonly example: "User";
|
|
1223
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1224
|
+
};
|
|
898
1225
|
};
|
|
899
1226
|
readonly required: readonly ["date_created"];
|
|
900
1227
|
readonly additionalProperties: false;
|
|
@@ -1092,6 +1419,12 @@ export declare const MarketplaceListingSchema: {
|
|
|
1092
1419
|
export declare const OrganizationCreateInputSchema: {
|
|
1093
1420
|
readonly type: "object";
|
|
1094
1421
|
readonly properties: {
|
|
1422
|
+
readonly type: {
|
|
1423
|
+
readonly type: "string";
|
|
1424
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1425
|
+
readonly example: "business";
|
|
1426
|
+
readonly enum: readonly ["business", "personal"];
|
|
1427
|
+
};
|
|
1095
1428
|
readonly email: {
|
|
1096
1429
|
readonly type: "string";
|
|
1097
1430
|
readonly format: "email";
|
|
@@ -1100,11 +1433,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
1100
1433
|
};
|
|
1101
1434
|
readonly first_name: {
|
|
1102
1435
|
readonly type: "string";
|
|
1436
|
+
readonly minLength: 1;
|
|
1103
1437
|
readonly description: "First name of the billing contact person.";
|
|
1104
1438
|
readonly example: "John";
|
|
1105
1439
|
};
|
|
1106
1440
|
readonly last_name: {
|
|
1107
1441
|
readonly type: "string";
|
|
1442
|
+
readonly minLength: 1;
|
|
1108
1443
|
readonly description: "Last name of the billing contact person.";
|
|
1109
1444
|
readonly example: "Doe";
|
|
1110
1445
|
};
|
|
@@ -1122,7 +1457,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
1122
1457
|
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
1458
|
};
|
|
1124
1459
|
};
|
|
1125
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1460
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1461
|
+
readonly additionalProperties: false;
|
|
1462
|
+
};
|
|
1463
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1464
|
+
readonly type: "object";
|
|
1465
|
+
readonly properties: {
|
|
1466
|
+
readonly id: {
|
|
1467
|
+
readonly type: "string";
|
|
1468
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1469
|
+
readonly example: "organization-id";
|
|
1470
|
+
};
|
|
1471
|
+
};
|
|
1472
|
+
readonly required: readonly ["id"];
|
|
1126
1473
|
readonly additionalProperties: false;
|
|
1127
1474
|
};
|
|
1128
1475
|
export declare const OrganizationSchema: {
|
|
@@ -1141,6 +1488,12 @@ export declare const OrganizationSchema: {
|
|
|
1141
1488
|
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1142
1489
|
readonly example: "ACME Corp.";
|
|
1143
1490
|
};
|
|
1491
|
+
readonly type: {
|
|
1492
|
+
readonly type: "string";
|
|
1493
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1494
|
+
readonly example: "business";
|
|
1495
|
+
readonly enum: readonly ["business", "personal"];
|
|
1496
|
+
};
|
|
1144
1497
|
readonly date_created: {
|
|
1145
1498
|
readonly type: "string";
|
|
1146
1499
|
readonly format: "date-time";
|
|
@@ -1172,6 +1525,17 @@ export declare const OrganizationSchema: {
|
|
|
1172
1525
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1173
1526
|
readonly example: 999;
|
|
1174
1527
|
};
|
|
1528
|
+
readonly enterprise_clusters_max: {
|
|
1529
|
+
readonly type: "integer";
|
|
1530
|
+
readonly minimum: 0;
|
|
1531
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1532
|
+
readonly example: 999;
|
|
1533
|
+
};
|
|
1534
|
+
readonly enterprise_clusters_available: {
|
|
1535
|
+
readonly type: "integer";
|
|
1536
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1537
|
+
readonly example: 999;
|
|
1538
|
+
};
|
|
1175
1539
|
readonly fleets_max: {
|
|
1176
1540
|
readonly type: "integer";
|
|
1177
1541
|
readonly minimum: 0;
|
|
@@ -1191,7 +1555,7 @@ export declare const OrganizationSchema: {
|
|
|
1191
1555
|
readonly type: "array";
|
|
1192
1556
|
readonly items: {
|
|
1193
1557
|
readonly type: "string";
|
|
1194
|
-
readonly example: "northamerica-central-
|
|
1558
|
+
readonly example: "northamerica-central-1a";
|
|
1195
1559
|
};
|
|
1196
1560
|
readonly minItems: 1;
|
|
1197
1561
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1225,7 +1589,7 @@ export declare const OrganizationSchema: {
|
|
|
1225
1589
|
readonly example: 500;
|
|
1226
1590
|
};
|
|
1227
1591
|
};
|
|
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"];
|
|
1592
|
+
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
1593
|
readonly additionalProperties: false;
|
|
1230
1594
|
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
1595
|
};
|
|
@@ -1234,8 +1598,14 @@ export declare const OrganizationSchema: {
|
|
|
1234
1598
|
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1235
1599
|
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1236
1600
|
};
|
|
1601
|
+
readonly verification: {
|
|
1602
|
+
readonly type: "string";
|
|
1603
|
+
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.";
|
|
1604
|
+
readonly example: "verified";
|
|
1605
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1606
|
+
};
|
|
1237
1607
|
};
|
|
1238
|
-
readonly required: readonly ["id", "date_created", "quota", "status"];
|
|
1608
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1239
1609
|
readonly additionalProperties: false;
|
|
1240
1610
|
};
|
|
1241
1611
|
export declare const PaymentMethodSchema: {
|
|
@@ -1243,26 +1613,19 @@ export declare const PaymentMethodSchema: {
|
|
|
1243
1613
|
readonly properties: {
|
|
1244
1614
|
readonly id: {
|
|
1245
1615
|
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;
|
|
1616
|
+
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.";
|
|
1617
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1254
1618
|
};
|
|
1255
1619
|
readonly type: {
|
|
1256
1620
|
readonly type: "string";
|
|
1257
|
-
readonly
|
|
1258
|
-
readonly description: "Payment method type type. Only `card` payments supported at the moment.";
|
|
1621
|
+
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
1622
|
readonly example: "card";
|
|
1260
|
-
readonly enum: readonly ["card"];
|
|
1623
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1261
1624
|
};
|
|
1262
1625
|
readonly last4: {
|
|
1263
1626
|
readonly type: "string";
|
|
1264
1627
|
readonly nullable: true;
|
|
1265
|
-
readonly description: "Last 4 digits of the payment card number.";
|
|
1628
|
+
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
1629
|
readonly example: "4242";
|
|
1267
1630
|
};
|
|
1268
1631
|
readonly exp_month: {
|
|
@@ -1270,25 +1633,46 @@ export declare const PaymentMethodSchema: {
|
|
|
1270
1633
|
readonly minimum: 1;
|
|
1271
1634
|
readonly maximum: 12;
|
|
1272
1635
|
readonly nullable: true;
|
|
1273
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1274
|
-
readonly example:
|
|
1636
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1637
|
+
readonly example: 12;
|
|
1275
1638
|
};
|
|
1276
1639
|
readonly exp_year: {
|
|
1277
1640
|
readonly type: "integer";
|
|
1278
|
-
readonly minimum: 2024;
|
|
1279
1641
|
readonly nullable: true;
|
|
1280
|
-
readonly description: "Four-digit number representing the card's expiration year.";
|
|
1281
|
-
readonly example:
|
|
1642
|
+
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.";
|
|
1643
|
+
readonly example: 2028;
|
|
1282
1644
|
};
|
|
1283
1645
|
readonly brand: {
|
|
1284
1646
|
readonly type: "string";
|
|
1285
1647
|
readonly nullable: true;
|
|
1286
|
-
readonly description: "Payment card brand
|
|
1648
|
+
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
1649
|
readonly example: "visa";
|
|
1288
|
-
|
|
1650
|
+
};
|
|
1651
|
+
readonly iban: {
|
|
1652
|
+
readonly type: "string";
|
|
1653
|
+
readonly nullable: true;
|
|
1654
|
+
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.";
|
|
1655
|
+
readonly example: "DE11243015658023127510";
|
|
1656
|
+
};
|
|
1657
|
+
readonly bic: {
|
|
1658
|
+
readonly type: "string";
|
|
1659
|
+
readonly nullable: true;
|
|
1660
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1661
|
+
readonly example: "SOGEDEFFXXX";
|
|
1662
|
+
};
|
|
1663
|
+
readonly account_holder_name: {
|
|
1664
|
+
readonly type: "string";
|
|
1665
|
+
readonly nullable: true;
|
|
1666
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1667
|
+
readonly example: "Cloudfleet GmbH";
|
|
1668
|
+
};
|
|
1669
|
+
readonly is_default: {
|
|
1670
|
+
readonly type: "boolean";
|
|
1671
|
+
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).";
|
|
1672
|
+
readonly example: true;
|
|
1289
1673
|
};
|
|
1290
1674
|
};
|
|
1291
|
-
readonly required: readonly ["id", "
|
|
1675
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1292
1676
|
readonly additionalProperties: false;
|
|
1293
1677
|
};
|
|
1294
1678
|
export declare const PlatformQuotaSchema: {
|
|
@@ -1316,6 +1700,17 @@ export declare const PlatformQuotaSchema: {
|
|
|
1316
1700
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1317
1701
|
readonly example: 999;
|
|
1318
1702
|
};
|
|
1703
|
+
readonly enterprise_clusters_max: {
|
|
1704
|
+
readonly type: "integer";
|
|
1705
|
+
readonly minimum: 0;
|
|
1706
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1707
|
+
readonly example: 999;
|
|
1708
|
+
};
|
|
1709
|
+
readonly enterprise_clusters_available: {
|
|
1710
|
+
readonly type: "integer";
|
|
1711
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1712
|
+
readonly example: 999;
|
|
1713
|
+
};
|
|
1319
1714
|
readonly fleets_max: {
|
|
1320
1715
|
readonly type: "integer";
|
|
1321
1716
|
readonly minimum: 0;
|
|
@@ -1335,7 +1730,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1335
1730
|
readonly type: "array";
|
|
1336
1731
|
readonly items: {
|
|
1337
1732
|
readonly type: "string";
|
|
1338
|
-
readonly example: "northamerica-central-
|
|
1733
|
+
readonly example: "northamerica-central-1a";
|
|
1339
1734
|
};
|
|
1340
1735
|
readonly minItems: 1;
|
|
1341
1736
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1369,7 +1764,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1369
1764
|
readonly example: 500;
|
|
1370
1765
|
};
|
|
1371
1766
|
};
|
|
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"];
|
|
1767
|
+
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
1768
|
readonly additionalProperties: false;
|
|
1374
1769
|
};
|
|
1375
1770
|
export declare const RegistryRepositorySchema: {
|
|
@@ -1660,142 +2055,6 @@ export declare const TicketCreateInputSchema: {
|
|
|
1660
2055
|
readonly required: readonly ["category", "body"];
|
|
1661
2056
|
readonly additionalProperties: false;
|
|
1662
2057
|
};
|
|
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
2058
|
export declare const TicketMessageInputSchema: {
|
|
1800
2059
|
readonly type: "object";
|
|
1801
2060
|
readonly properties: {
|
|
@@ -1832,11 +2091,13 @@ export declare const TicketMessageSchema: {
|
|
|
1832
2091
|
};
|
|
1833
2092
|
readonly author_first_name: {
|
|
1834
2093
|
readonly type: "string";
|
|
2094
|
+
readonly nullable: true;
|
|
1835
2095
|
readonly description: "First name of the author. Null when not provided.";
|
|
1836
2096
|
readonly example: "Jane";
|
|
1837
2097
|
};
|
|
1838
2098
|
readonly author_last_name: {
|
|
1839
2099
|
readonly type: "string";
|
|
2100
|
+
readonly nullable: true;
|
|
1840
2101
|
readonly description: "Last name of the author. Null when not provided.";
|
|
1841
2102
|
readonly example: "Doe";
|
|
1842
2103
|
};
|
|
@@ -1910,6 +2171,7 @@ export declare const TicketSchema: {
|
|
|
1910
2171
|
readonly closed_at: {
|
|
1911
2172
|
readonly type: "string";
|
|
1912
2173
|
readonly format: "date-time";
|
|
2174
|
+
readonly nullable: true;
|
|
1913
2175
|
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
1914
2176
|
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1915
2177
|
};
|
|
@@ -2097,9 +2359,10 @@ export declare const UsageFacetsSchema: {
|
|
|
2097
2359
|
readonly type: "array";
|
|
2098
2360
|
readonly items: {
|
|
2099
2361
|
readonly type: "string";
|
|
2362
|
+
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
2363
|
};
|
|
2101
2364
|
readonly description: "List of unique products";
|
|
2102
|
-
readonly example: readonly ["
|
|
2365
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
2103
2366
|
};
|
|
2104
2367
|
};
|
|
2105
2368
|
readonly additionalProperties: false;
|
|
@@ -2125,7 +2388,8 @@ export declare const UsageResponseSchema: {
|
|
|
2125
2388
|
readonly product: {
|
|
2126
2389
|
readonly type: "string";
|
|
2127
2390
|
readonly description: "The product the usage is associated with";
|
|
2128
|
-
readonly example: "
|
|
2391
|
+
readonly example: "cfke_controlplane_pro";
|
|
2392
|
+
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
2393
|
};
|
|
2130
2394
|
readonly value: {
|
|
2131
2395
|
readonly type: "number";
|
|
@@ -2165,9 +2429,10 @@ export declare const UsageResponseSchema: {
|
|
|
2165
2429
|
readonly type: "array";
|
|
2166
2430
|
readonly items: {
|
|
2167
2431
|
readonly type: "string";
|
|
2432
|
+
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
2433
|
};
|
|
2169
2434
|
readonly description: "List of unique products";
|
|
2170
|
-
readonly example: readonly ["
|
|
2435
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
2171
2436
|
};
|
|
2172
2437
|
};
|
|
2173
2438
|
readonly additionalProperties: false;
|
|
@@ -2193,7 +2458,8 @@ export declare const UsageSchema: {
|
|
|
2193
2458
|
readonly product: {
|
|
2194
2459
|
readonly type: "string";
|
|
2195
2460
|
readonly description: "The product the usage is associated with";
|
|
2196
|
-
readonly example: "
|
|
2461
|
+
readonly example: "cfke_controlplane_pro";
|
|
2462
|
+
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
2463
|
};
|
|
2198
2464
|
readonly value: {
|
|
2199
2465
|
readonly type: "number";
|
|
@@ -2250,18 +2516,6 @@ export declare const UserCreateInputSchema: {
|
|
|
2250
2516
|
readonly minLength: 8;
|
|
2251
2517
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
2252
2518
|
};
|
|
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
2519
|
};
|
|
2266
2520
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
2267
2521
|
readonly additionalProperties: false;
|