@cloudfleet/sdk 0.0.1-2caaedc → 0.0.1-2d09a49
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 +1199 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1215 -0
- package/dist/@tanstack/react-query.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +104 -123
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/types.gen.d.ts +6 -3
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +7 -3
- 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/core/serverSentEvents.gen.d.ts +1 -1
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -1
- package/dist/core/serverSentEvents.gen.js +3 -4
- package/dist/core/serverSentEvents.gen.js.map +1 -1
- package/dist/schemas.gen.d.ts +932 -140
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +1867 -213
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +262 -186
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +377 -257
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +8 -8
- package/dist/types.gen.d.ts +1469 -736
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3415 -1208
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1280 -293
- package/dist/zod.gen.js.map +1 -1
- package/package.json +27 -11
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,6 +429,11 @@ 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.";
|
|
@@ -373,7 +496,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
373
496
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
374
497
|
};
|
|
375
498
|
};
|
|
376
|
-
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
499
|
+
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "pod_cidr", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
377
500
|
readonly additionalProperties: false;
|
|
378
501
|
};
|
|
379
502
|
export declare const ClusterSchema: {
|
|
@@ -390,15 +513,100 @@ export declare const ClusterSchema: {
|
|
|
390
513
|
readonly tier: {
|
|
391
514
|
readonly type: "string";
|
|
392
515
|
readonly description: "Tier of the cluster.";
|
|
516
|
+
readonly default: "basic";
|
|
393
517
|
readonly example: "pro";
|
|
394
|
-
readonly enum: readonly ["basic", "pro"];
|
|
518
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
519
|
+
};
|
|
520
|
+
readonly version_channel: {
|
|
521
|
+
readonly type: "string";
|
|
522
|
+
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-]+)*))?$";
|
|
523
|
+
readonly description: "Version of the kubernetes cluster.";
|
|
524
|
+
readonly default: "1.x.x-cfke.x";
|
|
525
|
+
readonly example: "1.x.x-cfke.x";
|
|
526
|
+
};
|
|
527
|
+
readonly release_channel: {
|
|
528
|
+
readonly type: "string";
|
|
529
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
530
|
+
readonly default: "rapid";
|
|
531
|
+
readonly example: "rapid";
|
|
532
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
533
|
+
};
|
|
534
|
+
readonly features: {
|
|
535
|
+
readonly type: "object";
|
|
536
|
+
readonly properties: {
|
|
537
|
+
readonly gpu_sharing_strategy: {
|
|
538
|
+
readonly type: "string";
|
|
539
|
+
readonly description: "GPU sharing strategy.";
|
|
540
|
+
readonly default: "none";
|
|
541
|
+
readonly example: "none";
|
|
542
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
543
|
+
};
|
|
544
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
545
|
+
readonly type: "integer";
|
|
546
|
+
readonly minimum: 2;
|
|
547
|
+
readonly maximum: 48;
|
|
548
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
549
|
+
readonly default: 4;
|
|
550
|
+
readonly example: 10;
|
|
551
|
+
};
|
|
552
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
553
|
+
readonly type: "boolean";
|
|
554
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
555
|
+
readonly example: false;
|
|
556
|
+
};
|
|
557
|
+
};
|
|
558
|
+
readonly required: readonly ["gpu_sharing_strategy", "gpu_max_shared_clients_per_gpu", "cilium_socket_lb_host_namespace_only"];
|
|
559
|
+
readonly additionalProperties: false;
|
|
560
|
+
readonly description: "Cluster feature toggles.";
|
|
561
|
+
readonly default: {
|
|
562
|
+
readonly gpu_sharing_strategy: "none";
|
|
563
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
564
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
565
|
+
};
|
|
395
566
|
};
|
|
396
567
|
readonly region: {
|
|
397
568
|
readonly type: "string";
|
|
398
|
-
readonly description: "Cloudfleet control plane region.
|
|
399
|
-
readonly
|
|
400
|
-
|
|
401
|
-
|
|
569
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
570
|
+
readonly example: "europe-central-1a";
|
|
571
|
+
};
|
|
572
|
+
readonly networking: {
|
|
573
|
+
readonly type: "object";
|
|
574
|
+
readonly properties: {
|
|
575
|
+
readonly pod_cidr: {
|
|
576
|
+
readonly type: "string";
|
|
577
|
+
readonly description: "CIDR block for pod IPs.";
|
|
578
|
+
readonly default: "10.244.0.0/16";
|
|
579
|
+
};
|
|
580
|
+
readonly service_cidr: {
|
|
581
|
+
readonly type: "string";
|
|
582
|
+
readonly description: "CIDR block for service IPs.";
|
|
583
|
+
readonly default: "10.96.0.0/12";
|
|
584
|
+
};
|
|
585
|
+
readonly dual_stack: {
|
|
586
|
+
readonly type: "boolean";
|
|
587
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
588
|
+
};
|
|
589
|
+
readonly pod_cidr_v6: {
|
|
590
|
+
readonly type: "string";
|
|
591
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
592
|
+
readonly default: "2001:db8:1:2::/48";
|
|
593
|
+
};
|
|
594
|
+
readonly service_cidr_v6: {
|
|
595
|
+
readonly type: "string";
|
|
596
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
597
|
+
readonly default: "2001:db8:1:1::/112";
|
|
598
|
+
};
|
|
599
|
+
};
|
|
600
|
+
readonly required: readonly ["pod_cidr", "service_cidr", "dual_stack", "pod_cidr_v6", "service_cidr_v6"];
|
|
601
|
+
readonly additionalProperties: false;
|
|
602
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
603
|
+
readonly default: {
|
|
604
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
605
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
606
|
+
readonly dual_stack: false;
|
|
607
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
608
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
609
|
+
};
|
|
402
610
|
};
|
|
403
611
|
readonly id: {
|
|
404
612
|
readonly type: "string";
|
|
@@ -408,16 +616,27 @@ export declare const ClusterSchema: {
|
|
|
408
616
|
};
|
|
409
617
|
readonly status: {
|
|
410
618
|
readonly type: "string";
|
|
411
|
-
readonly description: "Status of the cluster.
|
|
412
|
-
readonly example: "
|
|
413
|
-
readonly enum: readonly ["
|
|
619
|
+
readonly description: "Status of the cluster.";
|
|
620
|
+
readonly example: "deployed";
|
|
621
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
414
622
|
};
|
|
415
623
|
readonly endpoint: {
|
|
416
624
|
readonly anyOf: readonly [{
|
|
417
625
|
readonly type: "string";
|
|
418
626
|
readonly format: "uri";
|
|
419
|
-
readonly description: "URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
420
|
-
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
627
|
+
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.";
|
|
628
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
629
|
+
}, {
|
|
630
|
+
readonly type: "string";
|
|
631
|
+
readonly enum: readonly [""];
|
|
632
|
+
}];
|
|
633
|
+
};
|
|
634
|
+
readonly endpoint_public: {
|
|
635
|
+
readonly anyOf: readonly [{
|
|
636
|
+
readonly type: "string";
|
|
637
|
+
readonly format: "uri";
|
|
638
|
+
readonly description: "Deprecated alias of `endpoint`; retained for backward compatibility.";
|
|
639
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
421
640
|
}, {
|
|
422
641
|
readonly type: "string";
|
|
423
642
|
readonly enum: readonly [""];
|
|
@@ -448,15 +667,10 @@ export declare const ClusterSchema: {
|
|
|
448
667
|
readonly description: "Indicates if the cluster is ready to be used.";
|
|
449
668
|
readonly example: true;
|
|
450
669
|
};
|
|
451
|
-
readonly version_channel: {
|
|
452
|
-
readonly type: "string";
|
|
453
|
-
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
454
|
-
readonly description: "Version of the kubernetes cluster.";
|
|
455
|
-
readonly example: "1.x.x-cfke.x";
|
|
456
|
-
};
|
|
457
670
|
};
|
|
458
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
671
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
459
672
|
readonly additionalProperties: false;
|
|
673
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
460
674
|
};
|
|
461
675
|
export declare const ClusterUpdateInputSchema: {
|
|
462
676
|
readonly type: "object";
|
|
@@ -472,18 +686,60 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
472
686
|
readonly tier: {
|
|
473
687
|
readonly type: "string";
|
|
474
688
|
readonly description: "Tier of the cluster.";
|
|
689
|
+
readonly default: "basic";
|
|
475
690
|
readonly example: "pro";
|
|
476
|
-
readonly enum: readonly ["basic", "pro"];
|
|
691
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
477
692
|
};
|
|
478
693
|
readonly version_channel: {
|
|
479
694
|
readonly type: "string";
|
|
480
695
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
481
696
|
readonly description: "Version of the kubernetes cluster.";
|
|
697
|
+
readonly default: "1.x.x-cfke.x";
|
|
482
698
|
readonly example: "1.x.x-cfke.x";
|
|
483
699
|
};
|
|
700
|
+
readonly release_channel: {
|
|
701
|
+
readonly type: "string";
|
|
702
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
703
|
+
readonly default: "rapid";
|
|
704
|
+
readonly example: "rapid";
|
|
705
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
706
|
+
};
|
|
707
|
+
readonly features: {
|
|
708
|
+
readonly type: "object";
|
|
709
|
+
readonly properties: {
|
|
710
|
+
readonly gpu_sharing_strategy: {
|
|
711
|
+
readonly type: "string";
|
|
712
|
+
readonly description: "GPU sharing strategy.";
|
|
713
|
+
readonly default: "none";
|
|
714
|
+
readonly example: "none";
|
|
715
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
716
|
+
};
|
|
717
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
718
|
+
readonly type: "integer";
|
|
719
|
+
readonly minimum: 2;
|
|
720
|
+
readonly maximum: 48;
|
|
721
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
722
|
+
readonly default: 4;
|
|
723
|
+
readonly example: 10;
|
|
724
|
+
};
|
|
725
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
726
|
+
readonly type: "boolean";
|
|
727
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
728
|
+
readonly example: false;
|
|
729
|
+
};
|
|
730
|
+
};
|
|
731
|
+
readonly additionalProperties: false;
|
|
732
|
+
readonly description: "Cluster feature toggles.";
|
|
733
|
+
readonly default: {
|
|
734
|
+
readonly gpu_sharing_strategy: "none";
|
|
735
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
736
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
737
|
+
};
|
|
738
|
+
};
|
|
484
739
|
};
|
|
485
|
-
readonly required: readonly ["
|
|
740
|
+
readonly required: readonly ["name"];
|
|
486
741
|
readonly additionalProperties: false;
|
|
742
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
487
743
|
};
|
|
488
744
|
export declare const FleetCreateInputSchema: {
|
|
489
745
|
readonly type: "object";
|
|
@@ -492,13 +748,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
492
748
|
readonly type: "object";
|
|
493
749
|
readonly properties: {
|
|
494
750
|
readonly cpu: {
|
|
495
|
-
readonly type: "
|
|
496
|
-
readonly format: "float";
|
|
751
|
+
readonly type: "integer";
|
|
497
752
|
readonly minimum: 0;
|
|
498
|
-
readonly
|
|
753
|
+
readonly maximum: 100000;
|
|
754
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
499
755
|
};
|
|
500
756
|
};
|
|
501
|
-
readonly required: readonly ["cpu"];
|
|
502
757
|
readonly additionalProperties: false;
|
|
503
758
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
504
759
|
};
|
|
@@ -507,14 +762,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
507
762
|
readonly properties: {
|
|
508
763
|
readonly enabled: {
|
|
509
764
|
readonly type: "boolean";
|
|
510
|
-
readonly default: true;
|
|
511
765
|
};
|
|
512
766
|
readonly project: {
|
|
513
767
|
readonly type: "string";
|
|
514
|
-
readonly
|
|
768
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
769
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
770
|
+
readonly example: "my-cloudfleet-project";
|
|
515
771
|
};
|
|
516
772
|
};
|
|
517
|
-
readonly required: readonly ["
|
|
773
|
+
readonly required: readonly ["enabled"];
|
|
518
774
|
readonly additionalProperties: false;
|
|
519
775
|
};
|
|
520
776
|
readonly hetzner: {
|
|
@@ -522,14 +778,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
522
778
|
readonly properties: {
|
|
523
779
|
readonly enabled: {
|
|
524
780
|
readonly type: "boolean";
|
|
525
|
-
readonly default: true;
|
|
526
781
|
};
|
|
527
782
|
readonly apiKey: {
|
|
528
783
|
readonly type: "string";
|
|
529
|
-
readonly
|
|
784
|
+
readonly maxLength: 64;
|
|
785
|
+
readonly minLength: 64;
|
|
786
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
787
|
+
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.";
|
|
530
788
|
};
|
|
531
789
|
};
|
|
532
|
-
readonly required: readonly ["
|
|
790
|
+
readonly required: readonly ["enabled"];
|
|
533
791
|
readonly additionalProperties: false;
|
|
534
792
|
};
|
|
535
793
|
readonly aws: {
|
|
@@ -537,15 +795,74 @@ export declare const FleetCreateInputSchema: {
|
|
|
537
795
|
readonly properties: {
|
|
538
796
|
readonly enabled: {
|
|
539
797
|
readonly type: "boolean";
|
|
540
|
-
readonly default: true;
|
|
541
798
|
};
|
|
542
799
|
readonly controllerRoleArn: {
|
|
543
800
|
readonly type: "string";
|
|
544
|
-
readonly
|
|
801
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
802
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
803
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
804
|
+
};
|
|
805
|
+
};
|
|
806
|
+
readonly required: readonly ["enabled"];
|
|
807
|
+
readonly additionalProperties: false;
|
|
808
|
+
};
|
|
809
|
+
readonly constraints: {
|
|
810
|
+
readonly type: "object";
|
|
811
|
+
readonly properties: {
|
|
812
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
813
|
+
readonly type: "array";
|
|
814
|
+
readonly items: {
|
|
815
|
+
readonly type: "string";
|
|
816
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
817
|
+
};
|
|
818
|
+
readonly minItems: 1;
|
|
819
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
820
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
821
|
+
};
|
|
822
|
+
readonly 'kubernetes.io/arch': {
|
|
823
|
+
readonly type: "array";
|
|
824
|
+
readonly items: {
|
|
825
|
+
readonly type: "string";
|
|
826
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
827
|
+
};
|
|
828
|
+
readonly minItems: 1;
|
|
829
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
830
|
+
readonly default: readonly ["amd64"];
|
|
831
|
+
};
|
|
832
|
+
readonly 'cfke.io/instance-family': {
|
|
833
|
+
readonly type: "array";
|
|
834
|
+
readonly items: {
|
|
835
|
+
readonly type: "string";
|
|
836
|
+
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"];
|
|
837
|
+
};
|
|
838
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
839
|
+
readonly default: readonly [];
|
|
840
|
+
};
|
|
841
|
+
readonly 'topology.kubernetes.io/region': {
|
|
842
|
+
readonly type: "array";
|
|
843
|
+
readonly items: {
|
|
844
|
+
readonly type: "string";
|
|
845
|
+
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"];
|
|
846
|
+
};
|
|
847
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
848
|
+
readonly default: readonly [];
|
|
545
849
|
};
|
|
546
850
|
};
|
|
547
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
548
851
|
readonly additionalProperties: false;
|
|
852
|
+
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.";
|
|
853
|
+
readonly default: {
|
|
854
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
855
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
856
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
857
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
858
|
+
};
|
|
859
|
+
};
|
|
860
|
+
readonly scalingProfile: {
|
|
861
|
+
readonly type: "string";
|
|
862
|
+
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`).";
|
|
863
|
+
readonly default: "conservative";
|
|
864
|
+
readonly example: "conservative";
|
|
865
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
549
866
|
};
|
|
550
867
|
readonly id: {
|
|
551
868
|
readonly type: "string";
|
|
@@ -558,6 +875,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
558
875
|
};
|
|
559
876
|
readonly required: readonly ["id"];
|
|
560
877
|
readonly additionalProperties: false;
|
|
878
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
561
879
|
};
|
|
562
880
|
export declare const FleetSchema: {
|
|
563
881
|
readonly type: "object";
|
|
@@ -566,13 +884,12 @@ export declare const FleetSchema: {
|
|
|
566
884
|
readonly type: "object";
|
|
567
885
|
readonly properties: {
|
|
568
886
|
readonly cpu: {
|
|
569
|
-
readonly type: "
|
|
570
|
-
readonly format: "float";
|
|
887
|
+
readonly type: "integer";
|
|
571
888
|
readonly minimum: 0;
|
|
572
|
-
readonly
|
|
889
|
+
readonly maximum: 100000;
|
|
890
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
573
891
|
};
|
|
574
892
|
};
|
|
575
|
-
readonly required: readonly ["cpu"];
|
|
576
893
|
readonly additionalProperties: false;
|
|
577
894
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
578
895
|
};
|
|
@@ -581,14 +898,15 @@ export declare const FleetSchema: {
|
|
|
581
898
|
readonly properties: {
|
|
582
899
|
readonly enabled: {
|
|
583
900
|
readonly type: "boolean";
|
|
584
|
-
readonly default: true;
|
|
585
901
|
};
|
|
586
902
|
readonly project: {
|
|
587
903
|
readonly type: "string";
|
|
588
|
-
readonly
|
|
904
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
905
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
906
|
+
readonly example: "my-cloudfleet-project";
|
|
589
907
|
};
|
|
590
908
|
};
|
|
591
|
-
readonly required: readonly ["
|
|
909
|
+
readonly required: readonly ["enabled"];
|
|
592
910
|
readonly additionalProperties: false;
|
|
593
911
|
};
|
|
594
912
|
readonly hetzner: {
|
|
@@ -596,14 +914,14 @@ export declare const FleetSchema: {
|
|
|
596
914
|
readonly properties: {
|
|
597
915
|
readonly enabled: {
|
|
598
916
|
readonly type: "boolean";
|
|
599
|
-
readonly default: true;
|
|
600
917
|
};
|
|
601
918
|
readonly apiKey: {
|
|
602
919
|
readonly type: "string";
|
|
603
|
-
readonly
|
|
920
|
+
readonly pattern: "^\\*{64}$";
|
|
921
|
+
readonly description: "Redacted Hetzner API token. Returned as 64 asterisks when a token is configured; omitted otherwise. The real value is never echoed by the API.";
|
|
604
922
|
};
|
|
605
923
|
};
|
|
606
|
-
readonly required: readonly ["
|
|
924
|
+
readonly required: readonly ["enabled"];
|
|
607
925
|
readonly additionalProperties: false;
|
|
608
926
|
};
|
|
609
927
|
readonly aws: {
|
|
@@ -611,16 +929,76 @@ export declare const FleetSchema: {
|
|
|
611
929
|
readonly properties: {
|
|
612
930
|
readonly enabled: {
|
|
613
931
|
readonly type: "boolean";
|
|
614
|
-
readonly default: true;
|
|
615
932
|
};
|
|
616
933
|
readonly controllerRoleArn: {
|
|
617
934
|
readonly type: "string";
|
|
618
|
-
readonly
|
|
935
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
936
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
937
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
619
938
|
};
|
|
620
939
|
};
|
|
621
|
-
readonly required: readonly ["
|
|
940
|
+
readonly required: readonly ["enabled"];
|
|
622
941
|
readonly additionalProperties: false;
|
|
623
942
|
};
|
|
943
|
+
readonly constraints: {
|
|
944
|
+
readonly type: "object";
|
|
945
|
+
readonly properties: {
|
|
946
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
947
|
+
readonly type: "array";
|
|
948
|
+
readonly items: {
|
|
949
|
+
readonly type: "string";
|
|
950
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
951
|
+
};
|
|
952
|
+
readonly minItems: 1;
|
|
953
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
954
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
955
|
+
};
|
|
956
|
+
readonly 'kubernetes.io/arch': {
|
|
957
|
+
readonly type: "array";
|
|
958
|
+
readonly items: {
|
|
959
|
+
readonly type: "string";
|
|
960
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
961
|
+
};
|
|
962
|
+
readonly minItems: 1;
|
|
963
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
964
|
+
readonly default: readonly ["amd64"];
|
|
965
|
+
};
|
|
966
|
+
readonly 'cfke.io/instance-family': {
|
|
967
|
+
readonly type: "array";
|
|
968
|
+
readonly items: {
|
|
969
|
+
readonly type: "string";
|
|
970
|
+
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"];
|
|
971
|
+
};
|
|
972
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
973
|
+
readonly default: readonly [];
|
|
974
|
+
};
|
|
975
|
+
readonly 'topology.kubernetes.io/region': {
|
|
976
|
+
readonly type: "array";
|
|
977
|
+
readonly items: {
|
|
978
|
+
readonly type: "string";
|
|
979
|
+
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"];
|
|
980
|
+
};
|
|
981
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
982
|
+
readonly default: readonly [];
|
|
983
|
+
};
|
|
984
|
+
};
|
|
985
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
986
|
+
readonly additionalProperties: false;
|
|
987
|
+
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.";
|
|
988
|
+
readonly default: {
|
|
989
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
990
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
991
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
992
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
993
|
+
};
|
|
994
|
+
};
|
|
995
|
+
readonly scalingProfile: {
|
|
996
|
+
readonly type: "string";
|
|
997
|
+
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`).";
|
|
998
|
+
readonly default: "conservative";
|
|
999
|
+
readonly example: "conservative";
|
|
1000
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
1001
|
+
};
|
|
624
1002
|
readonly id: {
|
|
625
1003
|
readonly type: "string";
|
|
626
1004
|
readonly maxLength: 63;
|
|
@@ -629,9 +1007,30 @@ export declare const FleetSchema: {
|
|
|
629
1007
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
630
1008
|
readonly example: "new-clouds-fleet";
|
|
631
1009
|
};
|
|
1010
|
+
readonly ready: {
|
|
1011
|
+
readonly type: "boolean";
|
|
1012
|
+
readonly description: "Indicates whether the fleet configuration is healthy.";
|
|
1013
|
+
readonly example: true;
|
|
1014
|
+
};
|
|
1015
|
+
readonly status_message: {
|
|
1016
|
+
readonly type: "string";
|
|
1017
|
+
readonly description: "Human-readable reason the fleet is not ready. Present only when `ready` is false.";
|
|
1018
|
+
readonly example: "Invalid provider permissions.";
|
|
1019
|
+
};
|
|
1020
|
+
readonly created_at: {
|
|
1021
|
+
readonly type: "string";
|
|
1022
|
+
readonly description: "Creation date and time of the fleet.";
|
|
1023
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1024
|
+
};
|
|
1025
|
+
readonly updated_at: {
|
|
1026
|
+
readonly type: "string";
|
|
1027
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
1028
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1029
|
+
};
|
|
632
1030
|
};
|
|
633
|
-
readonly required: readonly ["id"];
|
|
1031
|
+
readonly required: readonly ["constraints", "scalingProfile", "id", "ready", "created_at", "updated_at"];
|
|
634
1032
|
readonly additionalProperties: false;
|
|
1033
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
635
1034
|
};
|
|
636
1035
|
export declare const FleetUpdateInputSchema: {
|
|
637
1036
|
readonly type: "object";
|
|
@@ -640,13 +1039,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
640
1039
|
readonly type: "object";
|
|
641
1040
|
readonly properties: {
|
|
642
1041
|
readonly cpu: {
|
|
643
|
-
readonly type: "
|
|
644
|
-
readonly format: "float";
|
|
1042
|
+
readonly type: "integer";
|
|
645
1043
|
readonly minimum: 0;
|
|
646
|
-
readonly
|
|
1044
|
+
readonly maximum: 100000;
|
|
1045
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
647
1046
|
};
|
|
648
1047
|
};
|
|
649
|
-
readonly required: readonly ["cpu"];
|
|
650
1048
|
readonly additionalProperties: false;
|
|
651
1049
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
652
1050
|
};
|
|
@@ -655,14 +1053,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
655
1053
|
readonly properties: {
|
|
656
1054
|
readonly enabled: {
|
|
657
1055
|
readonly type: "boolean";
|
|
658
|
-
readonly default: true;
|
|
659
1056
|
};
|
|
660
1057
|
readonly project: {
|
|
661
1058
|
readonly type: "string";
|
|
662
|
-
readonly
|
|
1059
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
1060
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
1061
|
+
readonly example: "my-cloudfleet-project";
|
|
663
1062
|
};
|
|
664
1063
|
};
|
|
665
|
-
readonly required: readonly ["
|
|
1064
|
+
readonly required: readonly ["enabled"];
|
|
666
1065
|
readonly additionalProperties: false;
|
|
667
1066
|
};
|
|
668
1067
|
readonly hetzner: {
|
|
@@ -670,14 +1069,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
670
1069
|
readonly properties: {
|
|
671
1070
|
readonly enabled: {
|
|
672
1071
|
readonly type: "boolean";
|
|
673
|
-
readonly default: true;
|
|
674
1072
|
};
|
|
675
1073
|
readonly apiKey: {
|
|
676
1074
|
readonly type: "string";
|
|
677
|
-
readonly
|
|
1075
|
+
readonly maxLength: 64;
|
|
1076
|
+
readonly minLength: 64;
|
|
1077
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
1078
|
+
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.";
|
|
678
1079
|
};
|
|
679
1080
|
};
|
|
680
|
-
readonly required: readonly ["
|
|
1081
|
+
readonly required: readonly ["enabled"];
|
|
681
1082
|
readonly additionalProperties: false;
|
|
682
1083
|
};
|
|
683
1084
|
readonly aws: {
|
|
@@ -685,17 +1086,97 @@ export declare const FleetUpdateInputSchema: {
|
|
|
685
1086
|
readonly properties: {
|
|
686
1087
|
readonly enabled: {
|
|
687
1088
|
readonly type: "boolean";
|
|
688
|
-
readonly default: true;
|
|
689
1089
|
};
|
|
690
1090
|
readonly controllerRoleArn: {
|
|
691
1091
|
readonly type: "string";
|
|
692
|
-
readonly
|
|
1092
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
1093
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
1094
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
1095
|
+
};
|
|
1096
|
+
};
|
|
1097
|
+
readonly required: readonly ["enabled"];
|
|
1098
|
+
readonly additionalProperties: false;
|
|
1099
|
+
};
|
|
1100
|
+
readonly constraints: {
|
|
1101
|
+
readonly type: "object";
|
|
1102
|
+
readonly properties: {
|
|
1103
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
1104
|
+
readonly type: "array";
|
|
1105
|
+
readonly items: {
|
|
1106
|
+
readonly type: "string";
|
|
1107
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
1108
|
+
};
|
|
1109
|
+
readonly minItems: 1;
|
|
1110
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1111
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
1112
|
+
};
|
|
1113
|
+
readonly 'kubernetes.io/arch': {
|
|
1114
|
+
readonly type: "array";
|
|
1115
|
+
readonly items: {
|
|
1116
|
+
readonly type: "string";
|
|
1117
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
1118
|
+
};
|
|
1119
|
+
readonly minItems: 1;
|
|
1120
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1121
|
+
readonly default: readonly ["amd64"];
|
|
1122
|
+
};
|
|
1123
|
+
readonly 'cfke.io/instance-family': {
|
|
1124
|
+
readonly type: "array";
|
|
1125
|
+
readonly items: {
|
|
1126
|
+
readonly type: "string";
|
|
1127
|
+
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"];
|
|
1128
|
+
};
|
|
1129
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1130
|
+
readonly default: readonly [];
|
|
1131
|
+
};
|
|
1132
|
+
readonly 'topology.kubernetes.io/region': {
|
|
1133
|
+
readonly type: "array";
|
|
1134
|
+
readonly items: {
|
|
1135
|
+
readonly type: "string";
|
|
1136
|
+
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"];
|
|
1137
|
+
};
|
|
1138
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1139
|
+
readonly default: readonly [];
|
|
693
1140
|
};
|
|
694
1141
|
};
|
|
695
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
696
1142
|
readonly additionalProperties: false;
|
|
1143
|
+
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.";
|
|
1144
|
+
readonly default: {
|
|
1145
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1146
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1147
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1148
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1149
|
+
};
|
|
1150
|
+
};
|
|
1151
|
+
readonly scalingProfile: {
|
|
1152
|
+
readonly type: "string";
|
|
1153
|
+
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`).";
|
|
1154
|
+
readonly default: "conservative";
|
|
1155
|
+
readonly example: "conservative";
|
|
1156
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
1157
|
+
};
|
|
1158
|
+
};
|
|
1159
|
+
readonly additionalProperties: false;
|
|
1160
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
1161
|
+
};
|
|
1162
|
+
export declare const InviteCreateInputSchema: {
|
|
1163
|
+
readonly type: "object";
|
|
1164
|
+
readonly properties: {
|
|
1165
|
+
readonly email: {
|
|
1166
|
+
readonly type: "string";
|
|
1167
|
+
readonly format: "email";
|
|
1168
|
+
readonly description: "Email address of the user to invite.";
|
|
1169
|
+
readonly example: "email@example.com";
|
|
1170
|
+
};
|
|
1171
|
+
readonly role: {
|
|
1172
|
+
readonly type: "string";
|
|
1173
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1174
|
+
readonly default: "User";
|
|
1175
|
+
readonly example: "User";
|
|
1176
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
697
1177
|
};
|
|
698
1178
|
};
|
|
1179
|
+
readonly required: readonly ["email"];
|
|
699
1180
|
readonly additionalProperties: false;
|
|
700
1181
|
};
|
|
701
1182
|
export declare const InviteSchema: {
|
|
@@ -729,6 +1210,13 @@ export declare const InviteSchema: {
|
|
|
729
1210
|
readonly description: "Generated unique invite code.";
|
|
730
1211
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
731
1212
|
};
|
|
1213
|
+
readonly role: {
|
|
1214
|
+
readonly type: "string";
|
|
1215
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1216
|
+
readonly default: "User";
|
|
1217
|
+
readonly example: "User";
|
|
1218
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1219
|
+
};
|
|
732
1220
|
};
|
|
733
1221
|
readonly required: readonly ["date_created"];
|
|
734
1222
|
readonly additionalProperties: false;
|
|
@@ -926,6 +1414,12 @@ export declare const MarketplaceListingSchema: {
|
|
|
926
1414
|
export declare const OrganizationCreateInputSchema: {
|
|
927
1415
|
readonly type: "object";
|
|
928
1416
|
readonly properties: {
|
|
1417
|
+
readonly type: {
|
|
1418
|
+
readonly type: "string";
|
|
1419
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1420
|
+
readonly example: "business";
|
|
1421
|
+
readonly enum: readonly ["business", "personal"];
|
|
1422
|
+
};
|
|
929
1423
|
readonly email: {
|
|
930
1424
|
readonly type: "string";
|
|
931
1425
|
readonly format: "email";
|
|
@@ -934,11 +1428,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
934
1428
|
};
|
|
935
1429
|
readonly first_name: {
|
|
936
1430
|
readonly type: "string";
|
|
1431
|
+
readonly minLength: 1;
|
|
937
1432
|
readonly description: "First name of the billing contact person.";
|
|
938
1433
|
readonly example: "John";
|
|
939
1434
|
};
|
|
940
1435
|
readonly last_name: {
|
|
941
1436
|
readonly type: "string";
|
|
1437
|
+
readonly minLength: 1;
|
|
942
1438
|
readonly description: "Last name of the billing contact person.";
|
|
943
1439
|
readonly example: "Doe";
|
|
944
1440
|
};
|
|
@@ -956,7 +1452,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
956
1452
|
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.";
|
|
957
1453
|
};
|
|
958
1454
|
};
|
|
959
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1455
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1456
|
+
readonly additionalProperties: false;
|
|
1457
|
+
};
|
|
1458
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1459
|
+
readonly type: "object";
|
|
1460
|
+
readonly properties: {
|
|
1461
|
+
readonly id: {
|
|
1462
|
+
readonly type: "string";
|
|
1463
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1464
|
+
readonly example: "organization-id";
|
|
1465
|
+
};
|
|
1466
|
+
};
|
|
1467
|
+
readonly required: readonly ["id"];
|
|
960
1468
|
readonly additionalProperties: false;
|
|
961
1469
|
};
|
|
962
1470
|
export declare const OrganizationSchema: {
|
|
@@ -975,6 +1483,12 @@ export declare const OrganizationSchema: {
|
|
|
975
1483
|
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
976
1484
|
readonly example: "ACME Corp.";
|
|
977
1485
|
};
|
|
1486
|
+
readonly type: {
|
|
1487
|
+
readonly type: "string";
|
|
1488
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1489
|
+
readonly example: "business";
|
|
1490
|
+
readonly enum: readonly ["business", "personal"];
|
|
1491
|
+
};
|
|
978
1492
|
readonly date_created: {
|
|
979
1493
|
readonly type: "string";
|
|
980
1494
|
readonly format: "date-time";
|
|
@@ -1006,6 +1520,17 @@ export declare const OrganizationSchema: {
|
|
|
1006
1520
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1007
1521
|
readonly example: 999;
|
|
1008
1522
|
};
|
|
1523
|
+
readonly enterprise_clusters_max: {
|
|
1524
|
+
readonly type: "integer";
|
|
1525
|
+
readonly minimum: 0;
|
|
1526
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1527
|
+
readonly example: 999;
|
|
1528
|
+
};
|
|
1529
|
+
readonly enterprise_clusters_available: {
|
|
1530
|
+
readonly type: "integer";
|
|
1531
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1532
|
+
readonly example: 999;
|
|
1533
|
+
};
|
|
1009
1534
|
readonly fleets_max: {
|
|
1010
1535
|
readonly type: "integer";
|
|
1011
1536
|
readonly minimum: 0;
|
|
@@ -1025,7 +1550,7 @@ export declare const OrganizationSchema: {
|
|
|
1025
1550
|
readonly type: "array";
|
|
1026
1551
|
readonly items: {
|
|
1027
1552
|
readonly type: "string";
|
|
1028
|
-
readonly example: "northamerica-central-
|
|
1553
|
+
readonly example: "northamerica-central-1a";
|
|
1029
1554
|
};
|
|
1030
1555
|
readonly minItems: 1;
|
|
1031
1556
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1052,18 +1577,6 @@ export declare const OrganizationSchema: {
|
|
|
1052
1577
|
readonly minItems: 1;
|
|
1053
1578
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1054
1579
|
};
|
|
1055
|
-
readonly copilot_user_hourly_tokens: {
|
|
1056
|
-
readonly type: "integer";
|
|
1057
|
-
readonly minimum: 0;
|
|
1058
|
-
readonly description: "User-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1059
|
-
readonly example: 42000;
|
|
1060
|
-
};
|
|
1061
|
-
readonly copilot_organization_hourly_tokens: {
|
|
1062
|
-
readonly type: "integer";
|
|
1063
|
-
readonly minimum: 0;
|
|
1064
|
-
readonly description: "Organization-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1065
|
-
readonly example: 242000;
|
|
1066
|
-
};
|
|
1067
1580
|
readonly cfcr_storage_gb: {
|
|
1068
1581
|
readonly type: "integer";
|
|
1069
1582
|
readonly minimum: -1;
|
|
@@ -1071,7 +1584,7 @@ export declare const OrganizationSchema: {
|
|
|
1071
1584
|
readonly example: 500;
|
|
1072
1585
|
};
|
|
1073
1586
|
};
|
|
1074
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "
|
|
1587
|
+
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"];
|
|
1075
1588
|
readonly additionalProperties: false;
|
|
1076
1589
|
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.";
|
|
1077
1590
|
};
|
|
@@ -1080,8 +1593,14 @@ export declare const OrganizationSchema: {
|
|
|
1080
1593
|
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1081
1594
|
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1082
1595
|
};
|
|
1596
|
+
readonly verification: {
|
|
1597
|
+
readonly type: "string";
|
|
1598
|
+
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.";
|
|
1599
|
+
readonly example: "verified";
|
|
1600
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1601
|
+
};
|
|
1083
1602
|
};
|
|
1084
|
-
readonly required: readonly ["id", "date_created", "quota", "status"];
|
|
1603
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1085
1604
|
readonly additionalProperties: false;
|
|
1086
1605
|
};
|
|
1087
1606
|
export declare const PaymentMethodSchema: {
|
|
@@ -1089,26 +1608,19 @@ export declare const PaymentMethodSchema: {
|
|
|
1089
1608
|
readonly properties: {
|
|
1090
1609
|
readonly id: {
|
|
1091
1610
|
readonly type: "string";
|
|
1092
|
-
readonly
|
|
1093
|
-
readonly
|
|
1094
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1095
|
-
};
|
|
1096
|
-
readonly setup: {
|
|
1097
|
-
readonly type: "boolean";
|
|
1098
|
-
readonly description: "Whether organization payment method was set up and ready to use for payments.";
|
|
1099
|
-
readonly example: true;
|
|
1611
|
+
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.";
|
|
1612
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1100
1613
|
};
|
|
1101
1614
|
readonly type: {
|
|
1102
1615
|
readonly type: "string";
|
|
1103
|
-
readonly
|
|
1104
|
-
readonly description: "Payment method type type. Only `card` payments supported at the moment.";
|
|
1616
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1105
1617
|
readonly example: "card";
|
|
1106
|
-
readonly enum: readonly ["card"];
|
|
1618
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1107
1619
|
};
|
|
1108
1620
|
readonly last4: {
|
|
1109
1621
|
readonly type: "string";
|
|
1110
1622
|
readonly nullable: true;
|
|
1111
|
-
readonly description: "Last 4 digits of the payment card number.";
|
|
1623
|
+
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.";
|
|
1112
1624
|
readonly example: "4242";
|
|
1113
1625
|
};
|
|
1114
1626
|
readonly exp_month: {
|
|
@@ -1116,25 +1628,46 @@ export declare const PaymentMethodSchema: {
|
|
|
1116
1628
|
readonly minimum: 1;
|
|
1117
1629
|
readonly maximum: 12;
|
|
1118
1630
|
readonly nullable: true;
|
|
1119
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1120
|
-
readonly example:
|
|
1631
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1632
|
+
readonly example: 12;
|
|
1121
1633
|
};
|
|
1122
1634
|
readonly exp_year: {
|
|
1123
1635
|
readonly type: "integer";
|
|
1124
|
-
readonly minimum: 2024;
|
|
1125
1636
|
readonly nullable: true;
|
|
1126
|
-
readonly description: "Four-digit number representing the card's expiration year.";
|
|
1127
|
-
readonly example:
|
|
1637
|
+
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.";
|
|
1638
|
+
readonly example: 2028;
|
|
1128
1639
|
};
|
|
1129
1640
|
readonly brand: {
|
|
1130
1641
|
readonly type: "string";
|
|
1131
1642
|
readonly nullable: true;
|
|
1132
|
-
readonly description: "Payment card brand
|
|
1643
|
+
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.";
|
|
1133
1644
|
readonly example: "visa";
|
|
1134
|
-
|
|
1645
|
+
};
|
|
1646
|
+
readonly iban: {
|
|
1647
|
+
readonly type: "string";
|
|
1648
|
+
readonly nullable: true;
|
|
1649
|
+
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.";
|
|
1650
|
+
readonly example: "DE11243015658023127510";
|
|
1651
|
+
};
|
|
1652
|
+
readonly bic: {
|
|
1653
|
+
readonly type: "string";
|
|
1654
|
+
readonly nullable: true;
|
|
1655
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1656
|
+
readonly example: "SOGEDEFFXXX";
|
|
1657
|
+
};
|
|
1658
|
+
readonly account_holder_name: {
|
|
1659
|
+
readonly type: "string";
|
|
1660
|
+
readonly nullable: true;
|
|
1661
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1662
|
+
readonly example: "Cloudfleet GmbH";
|
|
1663
|
+
};
|
|
1664
|
+
readonly is_default: {
|
|
1665
|
+
readonly type: "boolean";
|
|
1666
|
+
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).";
|
|
1667
|
+
readonly example: true;
|
|
1135
1668
|
};
|
|
1136
1669
|
};
|
|
1137
|
-
readonly required: readonly ["id", "
|
|
1670
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1138
1671
|
readonly additionalProperties: false;
|
|
1139
1672
|
};
|
|
1140
1673
|
export declare const PlatformQuotaSchema: {
|
|
@@ -1162,6 +1695,17 @@ export declare const PlatformQuotaSchema: {
|
|
|
1162
1695
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1163
1696
|
readonly example: 999;
|
|
1164
1697
|
};
|
|
1698
|
+
readonly enterprise_clusters_max: {
|
|
1699
|
+
readonly type: "integer";
|
|
1700
|
+
readonly minimum: 0;
|
|
1701
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1702
|
+
readonly example: 999;
|
|
1703
|
+
};
|
|
1704
|
+
readonly enterprise_clusters_available: {
|
|
1705
|
+
readonly type: "integer";
|
|
1706
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1707
|
+
readonly example: 999;
|
|
1708
|
+
};
|
|
1165
1709
|
readonly fleets_max: {
|
|
1166
1710
|
readonly type: "integer";
|
|
1167
1711
|
readonly minimum: 0;
|
|
@@ -1181,7 +1725,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1181
1725
|
readonly type: "array";
|
|
1182
1726
|
readonly items: {
|
|
1183
1727
|
readonly type: "string";
|
|
1184
|
-
readonly example: "northamerica-central-
|
|
1728
|
+
readonly example: "northamerica-central-1a";
|
|
1185
1729
|
};
|
|
1186
1730
|
readonly minItems: 1;
|
|
1187
1731
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1208,18 +1752,6 @@ export declare const PlatformQuotaSchema: {
|
|
|
1208
1752
|
readonly minItems: 1;
|
|
1209
1753
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1210
1754
|
};
|
|
1211
|
-
readonly copilot_user_hourly_tokens: {
|
|
1212
|
-
readonly type: "integer";
|
|
1213
|
-
readonly minimum: 0;
|
|
1214
|
-
readonly description: "User-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1215
|
-
readonly example: 42000;
|
|
1216
|
-
};
|
|
1217
|
-
readonly copilot_organization_hourly_tokens: {
|
|
1218
|
-
readonly type: "integer";
|
|
1219
|
-
readonly minimum: 0;
|
|
1220
|
-
readonly description: "Organization-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1221
|
-
readonly example: 242000;
|
|
1222
|
-
};
|
|
1223
1755
|
readonly cfcr_storage_gb: {
|
|
1224
1756
|
readonly type: "integer";
|
|
1225
1757
|
readonly minimum: -1;
|
|
@@ -1227,7 +1759,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1227
1759
|
readonly example: 500;
|
|
1228
1760
|
};
|
|
1229
1761
|
};
|
|
1230
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "
|
|
1762
|
+
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"];
|
|
1231
1763
|
readonly additionalProperties: false;
|
|
1232
1764
|
};
|
|
1233
1765
|
export declare const RegistryRepositorySchema: {
|
|
@@ -1461,6 +1993,274 @@ export declare const RegistryTagSchema: {
|
|
|
1461
1993
|
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
1462
1994
|
readonly additionalProperties: false;
|
|
1463
1995
|
};
|
|
1996
|
+
export declare const TicketAttachmentSchema: {
|
|
1997
|
+
readonly type: "object";
|
|
1998
|
+
readonly properties: {
|
|
1999
|
+
readonly id: {
|
|
2000
|
+
readonly type: "string";
|
|
2001
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2002
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2003
|
+
};
|
|
2004
|
+
readonly filename: {
|
|
2005
|
+
readonly type: "string";
|
|
2006
|
+
readonly description: "Original filename as uploaded.";
|
|
2007
|
+
readonly example: "debug.log";
|
|
2008
|
+
};
|
|
2009
|
+
readonly content_type: {
|
|
2010
|
+
readonly type: "string";
|
|
2011
|
+
readonly description: "MIME content type of the attachment.";
|
|
2012
|
+
readonly example: "text/plain";
|
|
2013
|
+
};
|
|
2014
|
+
readonly size: {
|
|
2015
|
+
readonly type: "integer";
|
|
2016
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2017
|
+
readonly example: 12345;
|
|
2018
|
+
};
|
|
2019
|
+
};
|
|
2020
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2021
|
+
readonly additionalProperties: false;
|
|
2022
|
+
};
|
|
2023
|
+
export declare const TicketCreateInputSchema: {
|
|
2024
|
+
readonly type: "object";
|
|
2025
|
+
readonly properties: {
|
|
2026
|
+
readonly category: {
|
|
2027
|
+
readonly type: "string";
|
|
2028
|
+
readonly description: "Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.";
|
|
2029
|
+
readonly example: "technical";
|
|
2030
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2031
|
+
};
|
|
2032
|
+
readonly body: {
|
|
2033
|
+
readonly type: "string";
|
|
2034
|
+
readonly maxLength: 50000;
|
|
2035
|
+
readonly minLength: 1;
|
|
2036
|
+
readonly pattern: "\\S";
|
|
2037
|
+
readonly description: "Initial message body in markdown. There is no separate subject — the first message body is the description.";
|
|
2038
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2039
|
+
};
|
|
2040
|
+
readonly properties: {
|
|
2041
|
+
readonly type: "object";
|
|
2042
|
+
readonly additionalProperties: true;
|
|
2043
|
+
readonly description: "Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).";
|
|
2044
|
+
readonly example: {
|
|
2045
|
+
readonly subcategory: "cluster-question";
|
|
2046
|
+
readonly cluster_id: "60c72b2f9f1b2c001f8e4d3a";
|
|
2047
|
+
};
|
|
2048
|
+
};
|
|
2049
|
+
};
|
|
2050
|
+
readonly required: readonly ["category", "body"];
|
|
2051
|
+
readonly additionalProperties: false;
|
|
2052
|
+
};
|
|
2053
|
+
export declare const TicketMessageInputSchema: {
|
|
2054
|
+
readonly type: "object";
|
|
2055
|
+
readonly properties: {
|
|
2056
|
+
readonly body: {
|
|
2057
|
+
readonly type: "string";
|
|
2058
|
+
readonly maxLength: 50000;
|
|
2059
|
+
readonly minLength: 1;
|
|
2060
|
+
readonly pattern: "\\S";
|
|
2061
|
+
readonly description: "Reply body in markdown.";
|
|
2062
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2063
|
+
};
|
|
2064
|
+
};
|
|
2065
|
+
readonly required: readonly ["body"];
|
|
2066
|
+
readonly additionalProperties: false;
|
|
2067
|
+
};
|
|
2068
|
+
export declare const TicketMessageSchema: {
|
|
2069
|
+
readonly type: "object";
|
|
2070
|
+
readonly properties: {
|
|
2071
|
+
readonly id: {
|
|
2072
|
+
readonly type: "string";
|
|
2073
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2074
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2075
|
+
};
|
|
2076
|
+
readonly type: {
|
|
2077
|
+
readonly type: "string";
|
|
2078
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2079
|
+
readonly example: "customer_reply";
|
|
2080
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2081
|
+
};
|
|
2082
|
+
readonly body: {
|
|
2083
|
+
readonly type: "string";
|
|
2084
|
+
readonly description: "Message body in markdown.";
|
|
2085
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2086
|
+
};
|
|
2087
|
+
readonly author_first_name: {
|
|
2088
|
+
readonly type: "string";
|
|
2089
|
+
readonly nullable: true;
|
|
2090
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2091
|
+
readonly example: "Jane";
|
|
2092
|
+
};
|
|
2093
|
+
readonly author_last_name: {
|
|
2094
|
+
readonly type: "string";
|
|
2095
|
+
readonly nullable: true;
|
|
2096
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2097
|
+
readonly example: "Doe";
|
|
2098
|
+
};
|
|
2099
|
+
readonly attachments: {
|
|
2100
|
+
readonly type: "array";
|
|
2101
|
+
readonly items: {
|
|
2102
|
+
readonly type: "object";
|
|
2103
|
+
readonly properties: {
|
|
2104
|
+
readonly id: {
|
|
2105
|
+
readonly type: "string";
|
|
2106
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2107
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2108
|
+
};
|
|
2109
|
+
readonly filename: {
|
|
2110
|
+
readonly type: "string";
|
|
2111
|
+
readonly description: "Original filename as uploaded.";
|
|
2112
|
+
readonly example: "debug.log";
|
|
2113
|
+
};
|
|
2114
|
+
readonly content_type: {
|
|
2115
|
+
readonly type: "string";
|
|
2116
|
+
readonly description: "MIME content type of the attachment.";
|
|
2117
|
+
readonly example: "text/plain";
|
|
2118
|
+
};
|
|
2119
|
+
readonly size: {
|
|
2120
|
+
readonly type: "integer";
|
|
2121
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2122
|
+
readonly example: 12345;
|
|
2123
|
+
};
|
|
2124
|
+
};
|
|
2125
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2126
|
+
readonly additionalProperties: false;
|
|
2127
|
+
};
|
|
2128
|
+
readonly description: "Attachments associated with this message.";
|
|
2129
|
+
readonly example: readonly [];
|
|
2130
|
+
};
|
|
2131
|
+
readonly date_created: {
|
|
2132
|
+
readonly type: "string";
|
|
2133
|
+
readonly format: "date-time";
|
|
2134
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2135
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2136
|
+
};
|
|
2137
|
+
};
|
|
2138
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2139
|
+
readonly additionalProperties: false;
|
|
2140
|
+
};
|
|
2141
|
+
export declare const TicketSchema: {
|
|
2142
|
+
readonly type: "object";
|
|
2143
|
+
readonly properties: {
|
|
2144
|
+
readonly id: {
|
|
2145
|
+
readonly type: "string";
|
|
2146
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
2147
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
2148
|
+
};
|
|
2149
|
+
readonly status: {
|
|
2150
|
+
readonly type: "string";
|
|
2151
|
+
readonly description: "Current state of the ticket.";
|
|
2152
|
+
readonly example: "waiting_on_us";
|
|
2153
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
2154
|
+
};
|
|
2155
|
+
readonly category: {
|
|
2156
|
+
readonly type: "string";
|
|
2157
|
+
readonly description: "Ticket category.";
|
|
2158
|
+
readonly example: "technical";
|
|
2159
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2160
|
+
};
|
|
2161
|
+
readonly summary: {
|
|
2162
|
+
readonly type: "string";
|
|
2163
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
2164
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2165
|
+
};
|
|
2166
|
+
readonly closed_at: {
|
|
2167
|
+
readonly type: "string";
|
|
2168
|
+
readonly format: "date-time";
|
|
2169
|
+
readonly nullable: true;
|
|
2170
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2171
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
2172
|
+
};
|
|
2173
|
+
readonly date_created: {
|
|
2174
|
+
readonly type: "string";
|
|
2175
|
+
readonly format: "date-time";
|
|
2176
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
2177
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2178
|
+
};
|
|
2179
|
+
readonly date_updated: {
|
|
2180
|
+
readonly type: "string";
|
|
2181
|
+
readonly format: "date-time";
|
|
2182
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2183
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2184
|
+
};
|
|
2185
|
+
readonly messages: {
|
|
2186
|
+
readonly type: "array";
|
|
2187
|
+
readonly items: {
|
|
2188
|
+
readonly type: "object";
|
|
2189
|
+
readonly properties: {
|
|
2190
|
+
readonly id: {
|
|
2191
|
+
readonly type: "string";
|
|
2192
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2193
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2194
|
+
};
|
|
2195
|
+
readonly type: {
|
|
2196
|
+
readonly type: "string";
|
|
2197
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2198
|
+
readonly example: "customer_reply";
|
|
2199
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2200
|
+
};
|
|
2201
|
+
readonly body: {
|
|
2202
|
+
readonly type: "string";
|
|
2203
|
+
readonly description: "Message body in markdown.";
|
|
2204
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2205
|
+
};
|
|
2206
|
+
readonly author_first_name: {
|
|
2207
|
+
readonly type: "string";
|
|
2208
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2209
|
+
readonly example: "Jane";
|
|
2210
|
+
};
|
|
2211
|
+
readonly author_last_name: {
|
|
2212
|
+
readonly type: "string";
|
|
2213
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2214
|
+
readonly example: "Doe";
|
|
2215
|
+
};
|
|
2216
|
+
readonly attachments: {
|
|
2217
|
+
readonly type: "array";
|
|
2218
|
+
readonly items: {
|
|
2219
|
+
readonly type: "object";
|
|
2220
|
+
readonly properties: {
|
|
2221
|
+
readonly id: {
|
|
2222
|
+
readonly type: "string";
|
|
2223
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2224
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2225
|
+
};
|
|
2226
|
+
readonly filename: {
|
|
2227
|
+
readonly type: "string";
|
|
2228
|
+
readonly description: "Original filename as uploaded.";
|
|
2229
|
+
readonly example: "debug.log";
|
|
2230
|
+
};
|
|
2231
|
+
readonly content_type: {
|
|
2232
|
+
readonly type: "string";
|
|
2233
|
+
readonly description: "MIME content type of the attachment.";
|
|
2234
|
+
readonly example: "text/plain";
|
|
2235
|
+
};
|
|
2236
|
+
readonly size: {
|
|
2237
|
+
readonly type: "integer";
|
|
2238
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2239
|
+
readonly example: 12345;
|
|
2240
|
+
};
|
|
2241
|
+
};
|
|
2242
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2243
|
+
readonly additionalProperties: false;
|
|
2244
|
+
};
|
|
2245
|
+
readonly description: "Attachments associated with this message.";
|
|
2246
|
+
readonly example: readonly [];
|
|
2247
|
+
};
|
|
2248
|
+
readonly date_created: {
|
|
2249
|
+
readonly type: "string";
|
|
2250
|
+
readonly format: "date-time";
|
|
2251
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2252
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2253
|
+
};
|
|
2254
|
+
};
|
|
2255
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2256
|
+
readonly additionalProperties: false;
|
|
2257
|
+
};
|
|
2258
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
2259
|
+
};
|
|
2260
|
+
};
|
|
2261
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
2262
|
+
readonly additionalProperties: false;
|
|
2263
|
+
};
|
|
1464
2264
|
export declare const TokenCreateInputSchema: {
|
|
1465
2265
|
readonly type: "object";
|
|
1466
2266
|
readonly properties: {
|
|
@@ -1554,9 +2354,10 @@ export declare const UsageFacetsSchema: {
|
|
|
1554
2354
|
readonly type: "array";
|
|
1555
2355
|
readonly items: {
|
|
1556
2356
|
readonly type: "string";
|
|
2357
|
+
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"];
|
|
1557
2358
|
};
|
|
1558
2359
|
readonly description: "List of unique products";
|
|
1559
|
-
readonly example: readonly ["
|
|
2360
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
1560
2361
|
};
|
|
1561
2362
|
};
|
|
1562
2363
|
readonly additionalProperties: false;
|
|
@@ -1582,7 +2383,8 @@ export declare const UsageResponseSchema: {
|
|
|
1582
2383
|
readonly product: {
|
|
1583
2384
|
readonly type: "string";
|
|
1584
2385
|
readonly description: "The product the usage is associated with";
|
|
1585
|
-
readonly example: "
|
|
2386
|
+
readonly example: "cfke_controlplane_pro";
|
|
2387
|
+
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"];
|
|
1586
2388
|
};
|
|
1587
2389
|
readonly value: {
|
|
1588
2390
|
readonly type: "number";
|
|
@@ -1622,9 +2424,10 @@ export declare const UsageResponseSchema: {
|
|
|
1622
2424
|
readonly type: "array";
|
|
1623
2425
|
readonly items: {
|
|
1624
2426
|
readonly type: "string";
|
|
2427
|
+
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"];
|
|
1625
2428
|
};
|
|
1626
2429
|
readonly description: "List of unique products";
|
|
1627
|
-
readonly example: readonly ["
|
|
2430
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
1628
2431
|
};
|
|
1629
2432
|
};
|
|
1630
2433
|
readonly additionalProperties: false;
|
|
@@ -1650,7 +2453,8 @@ export declare const UsageSchema: {
|
|
|
1650
2453
|
readonly product: {
|
|
1651
2454
|
readonly type: "string";
|
|
1652
2455
|
readonly description: "The product the usage is associated with";
|
|
1653
|
-
readonly example: "
|
|
2456
|
+
readonly example: "cfke_controlplane_pro";
|
|
2457
|
+
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"];
|
|
1654
2458
|
};
|
|
1655
2459
|
readonly value: {
|
|
1656
2460
|
readonly type: "number";
|
|
@@ -1707,18 +2511,6 @@ export declare const UserCreateInputSchema: {
|
|
|
1707
2511
|
readonly minLength: 8;
|
|
1708
2512
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
1709
2513
|
};
|
|
1710
|
-
readonly status: {
|
|
1711
|
-
readonly type: "string";
|
|
1712
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
1713
|
-
readonly example: "active";
|
|
1714
|
-
readonly enum: readonly ["active", "inactive"];
|
|
1715
|
-
};
|
|
1716
|
-
readonly role: {
|
|
1717
|
-
readonly type: "string";
|
|
1718
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
1719
|
-
readonly example: "User";
|
|
1720
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
1721
|
-
};
|
|
1722
2514
|
};
|
|
1723
2515
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
1724
2516
|
readonly additionalProperties: false;
|