@cloudfleet/sdk 0.0.1-a104fac → 0.0.1-a10877b
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 +512 -534
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +486 -332
- 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 +1041 -133
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +1995 -192
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +256 -196
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +367 -274
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +1515 -731
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3373 -1141
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1303 -294
- package/dist/zod.gen.js.map +1 -1
- package/package.json +10 -13
package/dist/schemas.gen.d.ts
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
export declare const BillingContactSchema: {
|
|
2
2
|
readonly type: "object";
|
|
3
3
|
readonly properties: {
|
|
4
|
+
readonly type: {
|
|
5
|
+
readonly type: "string";
|
|
6
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
7
|
+
readonly example: "business";
|
|
8
|
+
readonly enum: readonly ["business", "personal"];
|
|
9
|
+
};
|
|
4
10
|
readonly company: {
|
|
5
11
|
readonly type: "string";
|
|
6
12
|
readonly maxLength: 120;
|
|
@@ -76,7 +82,7 @@ export declare const BillingContactSchema: {
|
|
|
76
82
|
readonly enum: readonly ["ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "at_vat", "au_abn", "au_arn", "ba_tin", "bb_tin", "be_vat", "bg_uic", "bg_vat", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", "cy_vat", "cz_vat", "de_stn", "de_vat", "dk_vat", "do_rcn", "ec_ruc", "ee_vat", "eg_tin", "es_cif", "es_vat", "eu_oss_vat", "fi_vat", "fr_vat", "gb_vat", "ge_vat", "gn_nif", "gr_vat", "hk_br", "hr_oib", "hr_vat", "hu_tin", "hu_vat", "id_npwp", "ie_vat", "il_vat", "in_gst", "is_vat", "it_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "lt_vat", "lu_vat", "lv_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mt_vat", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "nl_vat", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "pl_vat", "pt_vat", "ro_tin", "ro_vat", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "se_vat", "sg_gst", "sg_uen", "si_tin", "si_vat", "sk_vat", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "xi_vat", "za_vat", "zm_tin", "zw_tin", ""];
|
|
77
83
|
};
|
|
78
84
|
};
|
|
79
|
-
readonly required: readonly ["email", "individual_name"];
|
|
85
|
+
readonly required: readonly ["type", "email", "individual_name"];
|
|
80
86
|
readonly additionalProperties: false;
|
|
81
87
|
};
|
|
82
88
|
export declare const BillingCreditsSchema: {
|
|
@@ -211,9 +217,8 @@ export declare const ChartSchema: {
|
|
|
211
217
|
};
|
|
212
218
|
readonly status: {
|
|
213
219
|
readonly type: "string";
|
|
214
|
-
readonly description: "Status of the chart deployment.";
|
|
215
|
-
readonly example: "
|
|
216
|
-
readonly enum: readonly ["InstallSucceeded", "InstallFailed", "UpgradeSucceeded", "UpgradeFailed", "TestSucceeded", "TestFailed", "RollbackSucceeded", "RollbackFailed", "UninstallSucceeded", "UninstallFailed", "ArtifactFailed", "DependencyNotReady", "Progressing", "SourceNotReady"];
|
|
220
|
+
readonly description: "Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).";
|
|
221
|
+
readonly example: "InstallSucceeded";
|
|
217
222
|
};
|
|
218
223
|
readonly version_current: {
|
|
219
224
|
readonly type: "string";
|
|
@@ -270,15 +275,9 @@ export declare const ClusterCreateInputSchema: {
|
|
|
270
275
|
readonly tier: {
|
|
271
276
|
readonly type: "string";
|
|
272
277
|
readonly description: "Tier of the cluster.";
|
|
278
|
+
readonly default: "basic";
|
|
273
279
|
readonly example: "pro";
|
|
274
|
-
readonly enum: readonly ["basic", "pro"];
|
|
275
|
-
};
|
|
276
|
-
readonly region: {
|
|
277
|
-
readonly type: "string";
|
|
278
|
-
readonly description: "Cloudfleet control plane region. One of \"staging-1a\", \"northamerica-central-1\", \"europe-central-1a\", \"northamerica-central-1a\". This field can not be updated after creation.";
|
|
279
|
-
readonly default: "staging-1a";
|
|
280
|
-
readonly example: "northamerica-central-1a";
|
|
281
|
-
readonly enum: readonly ["staging-1a", "northamerica-central-1", "europe-central-1a", "northamerica-central-1a"];
|
|
280
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
282
281
|
};
|
|
283
282
|
readonly version_channel: {
|
|
284
283
|
readonly type: "string";
|
|
@@ -286,11 +285,93 @@ export declare const ClusterCreateInputSchema: {
|
|
|
286
285
|
readonly description: "Version of the kubernetes cluster.";
|
|
287
286
|
readonly default: "1.x.x-cfke.x";
|
|
288
287
|
readonly example: "1.x.x-cfke.x";
|
|
289
|
-
|
|
288
|
+
};
|
|
289
|
+
readonly release_channel: {
|
|
290
|
+
readonly type: "string";
|
|
291
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
292
|
+
readonly default: "rapid";
|
|
293
|
+
readonly example: "rapid";
|
|
294
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
295
|
+
};
|
|
296
|
+
readonly features: {
|
|
297
|
+
readonly type: "object";
|
|
298
|
+
readonly properties: {
|
|
299
|
+
readonly gpu_sharing_strategy: {
|
|
300
|
+
readonly type: "string";
|
|
301
|
+
readonly description: "GPU sharing strategy.";
|
|
302
|
+
readonly default: "none";
|
|
303
|
+
readonly example: "none";
|
|
304
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
305
|
+
};
|
|
306
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
307
|
+
readonly type: "integer";
|
|
308
|
+
readonly minimum: 2;
|
|
309
|
+
readonly maximum: 48;
|
|
310
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
311
|
+
readonly default: 4;
|
|
312
|
+
readonly example: 10;
|
|
313
|
+
};
|
|
314
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
315
|
+
readonly type: "boolean";
|
|
316
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
317
|
+
readonly example: false;
|
|
318
|
+
};
|
|
319
|
+
};
|
|
320
|
+
readonly additionalProperties: false;
|
|
321
|
+
readonly description: "Cluster feature toggles.";
|
|
322
|
+
readonly default: {
|
|
323
|
+
readonly gpu_sharing_strategy: "none";
|
|
324
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
325
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
326
|
+
};
|
|
327
|
+
};
|
|
328
|
+
readonly region: {
|
|
329
|
+
readonly type: "string";
|
|
330
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
331
|
+
readonly example: "europe-central-1a";
|
|
332
|
+
};
|
|
333
|
+
readonly networking: {
|
|
334
|
+
readonly type: "object";
|
|
335
|
+
readonly properties: {
|
|
336
|
+
readonly pod_cidr: {
|
|
337
|
+
readonly type: "string";
|
|
338
|
+
readonly description: "CIDR block for pod IPs.";
|
|
339
|
+
readonly default: "10.244.0.0/16";
|
|
340
|
+
};
|
|
341
|
+
readonly service_cidr: {
|
|
342
|
+
readonly type: "string";
|
|
343
|
+
readonly description: "CIDR block for service IPs.";
|
|
344
|
+
readonly default: "10.96.0.0/12";
|
|
345
|
+
};
|
|
346
|
+
readonly dual_stack: {
|
|
347
|
+
readonly type: "boolean";
|
|
348
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
349
|
+
};
|
|
350
|
+
readonly pod_cidr_v6: {
|
|
351
|
+
readonly type: "string";
|
|
352
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
353
|
+
readonly default: "2001:db8:1:2::/48";
|
|
354
|
+
};
|
|
355
|
+
readonly service_cidr_v6: {
|
|
356
|
+
readonly type: "string";
|
|
357
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
358
|
+
readonly default: "2001:db8:1:1::/112";
|
|
359
|
+
};
|
|
360
|
+
};
|
|
361
|
+
readonly additionalProperties: false;
|
|
362
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
363
|
+
readonly default: {
|
|
364
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
365
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
366
|
+
readonly dual_stack: false;
|
|
367
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
368
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
369
|
+
};
|
|
290
370
|
};
|
|
291
371
|
};
|
|
292
|
-
readonly required: readonly ["name", "
|
|
372
|
+
readonly required: readonly ["name", "region"];
|
|
293
373
|
readonly additionalProperties: false;
|
|
374
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
294
375
|
};
|
|
295
376
|
export declare const ClusterJoinInformationSchema: {
|
|
296
377
|
readonly type: "object";
|
|
@@ -311,11 +392,21 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
311
392
|
readonly description: "Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.";
|
|
312
393
|
readonly example: "10.96.0.10";
|
|
313
394
|
};
|
|
395
|
+
readonly pod_cidr: {
|
|
396
|
+
readonly type: "string";
|
|
397
|
+
readonly description: "Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.";
|
|
398
|
+
readonly example: "10.244.0.0/16";
|
|
399
|
+
};
|
|
314
400
|
readonly auth_key: {
|
|
315
401
|
readonly type: "string";
|
|
316
402
|
readonly description: "Authentication key for the cluster.";
|
|
317
403
|
readonly example: "tskey-auth-kBV8wr1dk911CNTRL-...";
|
|
318
404
|
};
|
|
405
|
+
readonly login_server: {
|
|
406
|
+
readonly type: "string";
|
|
407
|
+
readonly description: "Coordination server the node registers against. Empty on data plane v1 clusters, where the node advertises its own tag instead. A non-empty value requires a client that declares the dataplane-v2 capability.";
|
|
408
|
+
readonly example: "https://415026b6-f00f-44f8-968d-fc6ef4d0fc6d.fabric.europe-central-1a.cfke.io";
|
|
409
|
+
};
|
|
319
410
|
readonly bootstrap_token: {
|
|
320
411
|
readonly type: "string";
|
|
321
412
|
readonly description: "Bootstrap token for the cluster.";
|
|
@@ -373,7 +464,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
373
464
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
374
465
|
};
|
|
375
466
|
};
|
|
376
|
-
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
467
|
+
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "pod_cidr", "auth_key", "login_server", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
377
468
|
readonly additionalProperties: false;
|
|
378
469
|
};
|
|
379
470
|
export declare const ClusterSchema: {
|
|
@@ -390,15 +481,100 @@ export declare const ClusterSchema: {
|
|
|
390
481
|
readonly tier: {
|
|
391
482
|
readonly type: "string";
|
|
392
483
|
readonly description: "Tier of the cluster.";
|
|
484
|
+
readonly default: "basic";
|
|
393
485
|
readonly example: "pro";
|
|
394
|
-
readonly enum: readonly ["basic", "pro"];
|
|
486
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
487
|
+
};
|
|
488
|
+
readonly version_channel: {
|
|
489
|
+
readonly type: "string";
|
|
490
|
+
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
491
|
+
readonly description: "Version of the kubernetes cluster.";
|
|
492
|
+
readonly default: "1.x.x-cfke.x";
|
|
493
|
+
readonly example: "1.x.x-cfke.x";
|
|
494
|
+
};
|
|
495
|
+
readonly release_channel: {
|
|
496
|
+
readonly type: "string";
|
|
497
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
498
|
+
readonly default: "rapid";
|
|
499
|
+
readonly example: "rapid";
|
|
500
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
501
|
+
};
|
|
502
|
+
readonly features: {
|
|
503
|
+
readonly type: "object";
|
|
504
|
+
readonly properties: {
|
|
505
|
+
readonly gpu_sharing_strategy: {
|
|
506
|
+
readonly type: "string";
|
|
507
|
+
readonly description: "GPU sharing strategy.";
|
|
508
|
+
readonly default: "none";
|
|
509
|
+
readonly example: "none";
|
|
510
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
511
|
+
};
|
|
512
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
513
|
+
readonly type: "integer";
|
|
514
|
+
readonly minimum: 2;
|
|
515
|
+
readonly maximum: 48;
|
|
516
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
517
|
+
readonly default: 4;
|
|
518
|
+
readonly example: 10;
|
|
519
|
+
};
|
|
520
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
521
|
+
readonly type: "boolean";
|
|
522
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
523
|
+
readonly example: false;
|
|
524
|
+
};
|
|
525
|
+
};
|
|
526
|
+
readonly required: readonly ["gpu_sharing_strategy", "gpu_max_shared_clients_per_gpu", "cilium_socket_lb_host_namespace_only"];
|
|
527
|
+
readonly additionalProperties: false;
|
|
528
|
+
readonly description: "Cluster feature toggles.";
|
|
529
|
+
readonly default: {
|
|
530
|
+
readonly gpu_sharing_strategy: "none";
|
|
531
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
532
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
533
|
+
};
|
|
395
534
|
};
|
|
396
535
|
readonly region: {
|
|
397
536
|
readonly type: "string";
|
|
398
|
-
readonly description: "Cloudfleet control plane region.
|
|
399
|
-
readonly
|
|
400
|
-
|
|
401
|
-
|
|
537
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
538
|
+
readonly example: "europe-central-1a";
|
|
539
|
+
};
|
|
540
|
+
readonly networking: {
|
|
541
|
+
readonly type: "object";
|
|
542
|
+
readonly properties: {
|
|
543
|
+
readonly pod_cidr: {
|
|
544
|
+
readonly type: "string";
|
|
545
|
+
readonly description: "CIDR block for pod IPs.";
|
|
546
|
+
readonly default: "10.244.0.0/16";
|
|
547
|
+
};
|
|
548
|
+
readonly service_cidr: {
|
|
549
|
+
readonly type: "string";
|
|
550
|
+
readonly description: "CIDR block for service IPs.";
|
|
551
|
+
readonly default: "10.96.0.0/12";
|
|
552
|
+
};
|
|
553
|
+
readonly dual_stack: {
|
|
554
|
+
readonly type: "boolean";
|
|
555
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
556
|
+
};
|
|
557
|
+
readonly pod_cidr_v6: {
|
|
558
|
+
readonly type: "string";
|
|
559
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
560
|
+
readonly default: "2001:db8:1:2::/48";
|
|
561
|
+
};
|
|
562
|
+
readonly service_cidr_v6: {
|
|
563
|
+
readonly type: "string";
|
|
564
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
565
|
+
readonly default: "2001:db8:1:1::/112";
|
|
566
|
+
};
|
|
567
|
+
};
|
|
568
|
+
readonly required: readonly ["pod_cidr", "service_cidr", "dual_stack", "pod_cidr_v6", "service_cidr_v6"];
|
|
569
|
+
readonly additionalProperties: false;
|
|
570
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
571
|
+
readonly default: {
|
|
572
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
573
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
574
|
+
readonly dual_stack: false;
|
|
575
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
576
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
577
|
+
};
|
|
402
578
|
};
|
|
403
579
|
readonly id: {
|
|
404
580
|
readonly type: "string";
|
|
@@ -408,16 +584,27 @@ export declare const ClusterSchema: {
|
|
|
408
584
|
};
|
|
409
585
|
readonly status: {
|
|
410
586
|
readonly type: "string";
|
|
411
|
-
readonly description: "Status of the cluster.
|
|
412
|
-
readonly example: "
|
|
413
|
-
readonly enum: readonly ["
|
|
587
|
+
readonly description: "Status of the cluster.";
|
|
588
|
+
readonly example: "deployed";
|
|
589
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
414
590
|
};
|
|
415
591
|
readonly endpoint: {
|
|
416
592
|
readonly anyOf: readonly [{
|
|
417
593
|
readonly type: "string";
|
|
418
594
|
readonly format: "uri";
|
|
419
|
-
readonly description: "URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
420
|
-
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
595
|
+
readonly description: "URL signed by a public CA of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
596
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
597
|
+
}, {
|
|
598
|
+
readonly type: "string";
|
|
599
|
+
readonly enum: readonly [""];
|
|
600
|
+
}];
|
|
601
|
+
};
|
|
602
|
+
readonly endpoint_public: {
|
|
603
|
+
readonly anyOf: readonly [{
|
|
604
|
+
readonly type: "string";
|
|
605
|
+
readonly format: "uri";
|
|
606
|
+
readonly description: "Deprecated alias of `endpoint`; retained for backward compatibility.";
|
|
607
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
421
608
|
}, {
|
|
422
609
|
readonly type: "string";
|
|
423
610
|
readonly enum: readonly [""];
|
|
@@ -448,15 +635,10 @@ export declare const ClusterSchema: {
|
|
|
448
635
|
readonly description: "Indicates if the cluster is ready to be used.";
|
|
449
636
|
readonly example: true;
|
|
450
637
|
};
|
|
451
|
-
readonly version_channel: {
|
|
452
|
-
readonly type: "string";
|
|
453
|
-
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
454
|
-
readonly description: "Version of the kubernetes cluster.";
|
|
455
|
-
readonly example: "1.x.x-cfke.x";
|
|
456
|
-
};
|
|
457
638
|
};
|
|
458
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
639
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
459
640
|
readonly additionalProperties: false;
|
|
641
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
460
642
|
};
|
|
461
643
|
export declare const ClusterUpdateInputSchema: {
|
|
462
644
|
readonly type: "object";
|
|
@@ -472,18 +654,60 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
472
654
|
readonly tier: {
|
|
473
655
|
readonly type: "string";
|
|
474
656
|
readonly description: "Tier of the cluster.";
|
|
657
|
+
readonly default: "basic";
|
|
475
658
|
readonly example: "pro";
|
|
476
|
-
readonly enum: readonly ["basic", "pro"];
|
|
659
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
477
660
|
};
|
|
478
661
|
readonly version_channel: {
|
|
479
662
|
readonly type: "string";
|
|
480
663
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
481
664
|
readonly description: "Version of the kubernetes cluster.";
|
|
665
|
+
readonly default: "1.x.x-cfke.x";
|
|
482
666
|
readonly example: "1.x.x-cfke.x";
|
|
483
667
|
};
|
|
668
|
+
readonly release_channel: {
|
|
669
|
+
readonly type: "string";
|
|
670
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
671
|
+
readonly default: "rapid";
|
|
672
|
+
readonly example: "rapid";
|
|
673
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
674
|
+
};
|
|
675
|
+
readonly features: {
|
|
676
|
+
readonly type: "object";
|
|
677
|
+
readonly properties: {
|
|
678
|
+
readonly gpu_sharing_strategy: {
|
|
679
|
+
readonly type: "string";
|
|
680
|
+
readonly description: "GPU sharing strategy.";
|
|
681
|
+
readonly default: "none";
|
|
682
|
+
readonly example: "none";
|
|
683
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
684
|
+
};
|
|
685
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
686
|
+
readonly type: "integer";
|
|
687
|
+
readonly minimum: 2;
|
|
688
|
+
readonly maximum: 48;
|
|
689
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
690
|
+
readonly default: 4;
|
|
691
|
+
readonly example: 10;
|
|
692
|
+
};
|
|
693
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
694
|
+
readonly type: "boolean";
|
|
695
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
696
|
+
readonly example: false;
|
|
697
|
+
};
|
|
698
|
+
};
|
|
699
|
+
readonly additionalProperties: false;
|
|
700
|
+
readonly description: "Cluster feature toggles.";
|
|
701
|
+
readonly default: {
|
|
702
|
+
readonly gpu_sharing_strategy: "none";
|
|
703
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
704
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
705
|
+
};
|
|
706
|
+
};
|
|
484
707
|
};
|
|
485
|
-
readonly required: readonly ["
|
|
708
|
+
readonly required: readonly ["name"];
|
|
486
709
|
readonly additionalProperties: false;
|
|
710
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
487
711
|
};
|
|
488
712
|
export declare const FleetCreateInputSchema: {
|
|
489
713
|
readonly type: "object";
|
|
@@ -492,13 +716,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
492
716
|
readonly type: "object";
|
|
493
717
|
readonly properties: {
|
|
494
718
|
readonly cpu: {
|
|
495
|
-
readonly type: "
|
|
496
|
-
readonly format: "float";
|
|
719
|
+
readonly type: "integer";
|
|
497
720
|
readonly minimum: 0;
|
|
498
|
-
readonly
|
|
721
|
+
readonly maximum: 100000;
|
|
722
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
499
723
|
};
|
|
500
724
|
};
|
|
501
|
-
readonly required: readonly ["cpu"];
|
|
502
725
|
readonly additionalProperties: false;
|
|
503
726
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
504
727
|
};
|
|
@@ -507,14 +730,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
507
730
|
readonly properties: {
|
|
508
731
|
readonly enabled: {
|
|
509
732
|
readonly type: "boolean";
|
|
510
|
-
readonly default: true;
|
|
511
733
|
};
|
|
512
734
|
readonly project: {
|
|
513
735
|
readonly type: "string";
|
|
514
|
-
readonly
|
|
736
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
737
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
738
|
+
readonly example: "my-cloudfleet-project";
|
|
515
739
|
};
|
|
516
740
|
};
|
|
517
|
-
readonly required: readonly ["
|
|
741
|
+
readonly required: readonly ["enabled"];
|
|
518
742
|
readonly additionalProperties: false;
|
|
519
743
|
};
|
|
520
744
|
readonly hetzner: {
|
|
@@ -522,14 +746,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
522
746
|
readonly properties: {
|
|
523
747
|
readonly enabled: {
|
|
524
748
|
readonly type: "boolean";
|
|
525
|
-
readonly default: true;
|
|
526
749
|
};
|
|
527
750
|
readonly apiKey: {
|
|
528
751
|
readonly type: "string";
|
|
529
|
-
readonly
|
|
752
|
+
readonly maxLength: 64;
|
|
753
|
+
readonly minLength: 64;
|
|
754
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
755
|
+
readonly description: "Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.";
|
|
530
756
|
};
|
|
531
757
|
};
|
|
532
|
-
readonly required: readonly ["
|
|
758
|
+
readonly required: readonly ["enabled"];
|
|
533
759
|
readonly additionalProperties: false;
|
|
534
760
|
};
|
|
535
761
|
readonly aws: {
|
|
@@ -537,15 +763,74 @@ export declare const FleetCreateInputSchema: {
|
|
|
537
763
|
readonly properties: {
|
|
538
764
|
readonly enabled: {
|
|
539
765
|
readonly type: "boolean";
|
|
540
|
-
readonly default: true;
|
|
541
766
|
};
|
|
542
767
|
readonly controllerRoleArn: {
|
|
543
768
|
readonly type: "string";
|
|
544
|
-
readonly
|
|
769
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
770
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
771
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
772
|
+
};
|
|
773
|
+
};
|
|
774
|
+
readonly required: readonly ["enabled"];
|
|
775
|
+
readonly additionalProperties: false;
|
|
776
|
+
};
|
|
777
|
+
readonly constraints: {
|
|
778
|
+
readonly type: "object";
|
|
779
|
+
readonly properties: {
|
|
780
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
781
|
+
readonly type: "array";
|
|
782
|
+
readonly items: {
|
|
783
|
+
readonly type: "string";
|
|
784
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
785
|
+
};
|
|
786
|
+
readonly minItems: 1;
|
|
787
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
788
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
789
|
+
};
|
|
790
|
+
readonly 'kubernetes.io/arch': {
|
|
791
|
+
readonly type: "array";
|
|
792
|
+
readonly items: {
|
|
793
|
+
readonly type: "string";
|
|
794
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
795
|
+
};
|
|
796
|
+
readonly minItems: 1;
|
|
797
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
798
|
+
readonly default: readonly ["amd64"];
|
|
799
|
+
};
|
|
800
|
+
readonly 'cfke.io/instance-family': {
|
|
801
|
+
readonly type: "array";
|
|
802
|
+
readonly items: {
|
|
803
|
+
readonly type: "string";
|
|
804
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
805
|
+
};
|
|
806
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
807
|
+
readonly default: readonly [];
|
|
808
|
+
};
|
|
809
|
+
readonly 'topology.kubernetes.io/region': {
|
|
810
|
+
readonly type: "array";
|
|
811
|
+
readonly items: {
|
|
812
|
+
readonly type: "string";
|
|
813
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
814
|
+
};
|
|
815
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
816
|
+
readonly default: readonly [];
|
|
545
817
|
};
|
|
546
818
|
};
|
|
547
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
548
819
|
readonly additionalProperties: false;
|
|
820
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
821
|
+
readonly default: {
|
|
822
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
823
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
824
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
825
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
826
|
+
};
|
|
827
|
+
};
|
|
828
|
+
readonly scalingProfile: {
|
|
829
|
+
readonly type: "string";
|
|
830
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
831
|
+
readonly default: "conservative";
|
|
832
|
+
readonly example: "conservative";
|
|
833
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
549
834
|
};
|
|
550
835
|
readonly id: {
|
|
551
836
|
readonly type: "string";
|
|
@@ -558,6 +843,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
558
843
|
};
|
|
559
844
|
readonly required: readonly ["id"];
|
|
560
845
|
readonly additionalProperties: false;
|
|
846
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
561
847
|
};
|
|
562
848
|
export declare const FleetSchema: {
|
|
563
849
|
readonly type: "object";
|
|
@@ -566,13 +852,12 @@ export declare const FleetSchema: {
|
|
|
566
852
|
readonly type: "object";
|
|
567
853
|
readonly properties: {
|
|
568
854
|
readonly cpu: {
|
|
569
|
-
readonly type: "
|
|
570
|
-
readonly format: "float";
|
|
855
|
+
readonly type: "integer";
|
|
571
856
|
readonly minimum: 0;
|
|
572
|
-
readonly
|
|
857
|
+
readonly maximum: 100000;
|
|
858
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
573
859
|
};
|
|
574
860
|
};
|
|
575
|
-
readonly required: readonly ["cpu"];
|
|
576
861
|
readonly additionalProperties: false;
|
|
577
862
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
578
863
|
};
|
|
@@ -581,14 +866,15 @@ export declare const FleetSchema: {
|
|
|
581
866
|
readonly properties: {
|
|
582
867
|
readonly enabled: {
|
|
583
868
|
readonly type: "boolean";
|
|
584
|
-
readonly default: true;
|
|
585
869
|
};
|
|
586
870
|
readonly project: {
|
|
587
871
|
readonly type: "string";
|
|
588
|
-
readonly
|
|
872
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
873
|
+
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.";
|
|
874
|
+
readonly example: "my-cloudfleet-project";
|
|
589
875
|
};
|
|
590
876
|
};
|
|
591
|
-
readonly required: readonly ["
|
|
877
|
+
readonly required: readonly ["enabled"];
|
|
592
878
|
readonly additionalProperties: false;
|
|
593
879
|
};
|
|
594
880
|
readonly hetzner: {
|
|
@@ -596,14 +882,14 @@ export declare const FleetSchema: {
|
|
|
596
882
|
readonly properties: {
|
|
597
883
|
readonly enabled: {
|
|
598
884
|
readonly type: "boolean";
|
|
599
|
-
readonly default: true;
|
|
600
885
|
};
|
|
601
886
|
readonly apiKey: {
|
|
602
887
|
readonly type: "string";
|
|
603
|
-
readonly
|
|
888
|
+
readonly pattern: "^\\*{64}$";
|
|
889
|
+
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
890
|
};
|
|
605
891
|
};
|
|
606
|
-
readonly required: readonly ["
|
|
892
|
+
readonly required: readonly ["enabled"];
|
|
607
893
|
readonly additionalProperties: false;
|
|
608
894
|
};
|
|
609
895
|
readonly aws: {
|
|
@@ -611,16 +897,76 @@ export declare const FleetSchema: {
|
|
|
611
897
|
readonly properties: {
|
|
612
898
|
readonly enabled: {
|
|
613
899
|
readonly type: "boolean";
|
|
614
|
-
readonly default: true;
|
|
615
900
|
};
|
|
616
901
|
readonly controllerRoleArn: {
|
|
617
902
|
readonly type: "string";
|
|
618
|
-
readonly
|
|
903
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
904
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
905
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
619
906
|
};
|
|
620
907
|
};
|
|
621
|
-
readonly required: readonly ["
|
|
908
|
+
readonly required: readonly ["enabled"];
|
|
622
909
|
readonly additionalProperties: false;
|
|
623
910
|
};
|
|
911
|
+
readonly constraints: {
|
|
912
|
+
readonly type: "object";
|
|
913
|
+
readonly properties: {
|
|
914
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
915
|
+
readonly type: "array";
|
|
916
|
+
readonly items: {
|
|
917
|
+
readonly type: "string";
|
|
918
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
919
|
+
};
|
|
920
|
+
readonly minItems: 1;
|
|
921
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
922
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
923
|
+
};
|
|
924
|
+
readonly 'kubernetes.io/arch': {
|
|
925
|
+
readonly type: "array";
|
|
926
|
+
readonly items: {
|
|
927
|
+
readonly type: "string";
|
|
928
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
929
|
+
};
|
|
930
|
+
readonly minItems: 1;
|
|
931
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
932
|
+
readonly default: readonly ["amd64"];
|
|
933
|
+
};
|
|
934
|
+
readonly 'cfke.io/instance-family': {
|
|
935
|
+
readonly type: "array";
|
|
936
|
+
readonly items: {
|
|
937
|
+
readonly type: "string";
|
|
938
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
939
|
+
};
|
|
940
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
941
|
+
readonly default: readonly [];
|
|
942
|
+
};
|
|
943
|
+
readonly 'topology.kubernetes.io/region': {
|
|
944
|
+
readonly type: "array";
|
|
945
|
+
readonly items: {
|
|
946
|
+
readonly type: "string";
|
|
947
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
948
|
+
};
|
|
949
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
950
|
+
readonly default: readonly [];
|
|
951
|
+
};
|
|
952
|
+
};
|
|
953
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
954
|
+
readonly additionalProperties: false;
|
|
955
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
956
|
+
readonly default: {
|
|
957
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
958
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
959
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
960
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
961
|
+
};
|
|
962
|
+
};
|
|
963
|
+
readonly scalingProfile: {
|
|
964
|
+
readonly type: "string";
|
|
965
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
966
|
+
readonly default: "conservative";
|
|
967
|
+
readonly example: "conservative";
|
|
968
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
969
|
+
};
|
|
624
970
|
readonly id: {
|
|
625
971
|
readonly type: "string";
|
|
626
972
|
readonly maxLength: 63;
|
|
@@ -629,9 +975,30 @@ export declare const FleetSchema: {
|
|
|
629
975
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
630
976
|
readonly example: "new-clouds-fleet";
|
|
631
977
|
};
|
|
978
|
+
readonly ready: {
|
|
979
|
+
readonly type: "boolean";
|
|
980
|
+
readonly description: "Indicates whether the fleet configuration is healthy.";
|
|
981
|
+
readonly example: true;
|
|
982
|
+
};
|
|
983
|
+
readonly status_message: {
|
|
984
|
+
readonly type: "string";
|
|
985
|
+
readonly description: "Human-readable reason the fleet is not ready. Present only when `ready` is false.";
|
|
986
|
+
readonly example: "Invalid provider permissions.";
|
|
987
|
+
};
|
|
988
|
+
readonly created_at: {
|
|
989
|
+
readonly type: "string";
|
|
990
|
+
readonly description: "Creation date and time of the fleet.";
|
|
991
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
992
|
+
};
|
|
993
|
+
readonly updated_at: {
|
|
994
|
+
readonly type: "string";
|
|
995
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
996
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
997
|
+
};
|
|
632
998
|
};
|
|
633
|
-
readonly required: readonly ["id"];
|
|
999
|
+
readonly required: readonly ["constraints", "scalingProfile", "id", "ready", "created_at", "updated_at"];
|
|
634
1000
|
readonly additionalProperties: false;
|
|
1001
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
635
1002
|
};
|
|
636
1003
|
export declare const FleetUpdateInputSchema: {
|
|
637
1004
|
readonly type: "object";
|
|
@@ -640,13 +1007,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
640
1007
|
readonly type: "object";
|
|
641
1008
|
readonly properties: {
|
|
642
1009
|
readonly cpu: {
|
|
643
|
-
readonly type: "
|
|
644
|
-
readonly format: "float";
|
|
1010
|
+
readonly type: "integer";
|
|
645
1011
|
readonly minimum: 0;
|
|
646
|
-
readonly
|
|
1012
|
+
readonly maximum: 100000;
|
|
1013
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
647
1014
|
};
|
|
648
1015
|
};
|
|
649
|
-
readonly required: readonly ["cpu"];
|
|
650
1016
|
readonly additionalProperties: false;
|
|
651
1017
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
652
1018
|
};
|
|
@@ -655,14 +1021,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
655
1021
|
readonly properties: {
|
|
656
1022
|
readonly enabled: {
|
|
657
1023
|
readonly type: "boolean";
|
|
658
|
-
readonly default: true;
|
|
659
1024
|
};
|
|
660
1025
|
readonly project: {
|
|
661
1026
|
readonly type: "string";
|
|
662
|
-
readonly
|
|
1027
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
1028
|
+
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.";
|
|
1029
|
+
readonly example: "my-cloudfleet-project";
|
|
663
1030
|
};
|
|
664
1031
|
};
|
|
665
|
-
readonly required: readonly ["
|
|
1032
|
+
readonly required: readonly ["enabled"];
|
|
666
1033
|
readonly additionalProperties: false;
|
|
667
1034
|
};
|
|
668
1035
|
readonly hetzner: {
|
|
@@ -670,14 +1037,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
670
1037
|
readonly properties: {
|
|
671
1038
|
readonly enabled: {
|
|
672
1039
|
readonly type: "boolean";
|
|
673
|
-
readonly default: true;
|
|
674
1040
|
};
|
|
675
1041
|
readonly apiKey: {
|
|
676
1042
|
readonly type: "string";
|
|
677
|
-
readonly
|
|
1043
|
+
readonly maxLength: 64;
|
|
1044
|
+
readonly minLength: 64;
|
|
1045
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
1046
|
+
readonly description: "Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.";
|
|
678
1047
|
};
|
|
679
1048
|
};
|
|
680
|
-
readonly required: readonly ["
|
|
1049
|
+
readonly required: readonly ["enabled"];
|
|
681
1050
|
readonly additionalProperties: false;
|
|
682
1051
|
};
|
|
683
1052
|
readonly aws: {
|
|
@@ -685,52 +1054,263 @@ export declare const FleetUpdateInputSchema: {
|
|
|
685
1054
|
readonly properties: {
|
|
686
1055
|
readonly enabled: {
|
|
687
1056
|
readonly type: "boolean";
|
|
688
|
-
readonly default: true;
|
|
689
1057
|
};
|
|
690
1058
|
readonly controllerRoleArn: {
|
|
691
1059
|
readonly type: "string";
|
|
692
|
-
readonly
|
|
1060
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
1061
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
1062
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
1063
|
+
};
|
|
1064
|
+
};
|
|
1065
|
+
readonly required: readonly ["enabled"];
|
|
1066
|
+
readonly additionalProperties: false;
|
|
1067
|
+
};
|
|
1068
|
+
readonly constraints: {
|
|
1069
|
+
readonly type: "object";
|
|
1070
|
+
readonly properties: {
|
|
1071
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
1072
|
+
readonly type: "array";
|
|
1073
|
+
readonly items: {
|
|
1074
|
+
readonly type: "string";
|
|
1075
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
1076
|
+
};
|
|
1077
|
+
readonly minItems: 1;
|
|
1078
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1079
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
1080
|
+
};
|
|
1081
|
+
readonly 'kubernetes.io/arch': {
|
|
1082
|
+
readonly type: "array";
|
|
1083
|
+
readonly items: {
|
|
1084
|
+
readonly type: "string";
|
|
1085
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
1086
|
+
};
|
|
1087
|
+
readonly minItems: 1;
|
|
1088
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1089
|
+
readonly default: readonly ["amd64"];
|
|
1090
|
+
};
|
|
1091
|
+
readonly 'cfke.io/instance-family': {
|
|
1092
|
+
readonly type: "array";
|
|
1093
|
+
readonly items: {
|
|
1094
|
+
readonly type: "string";
|
|
1095
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
1096
|
+
};
|
|
1097
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1098
|
+
readonly default: readonly [];
|
|
1099
|
+
};
|
|
1100
|
+
readonly 'topology.kubernetes.io/region': {
|
|
1101
|
+
readonly type: "array";
|
|
1102
|
+
readonly items: {
|
|
1103
|
+
readonly type: "string";
|
|
1104
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
1105
|
+
};
|
|
1106
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1107
|
+
readonly default: readonly [];
|
|
693
1108
|
};
|
|
694
1109
|
};
|
|
695
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
696
1110
|
readonly additionalProperties: false;
|
|
1111
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
1112
|
+
readonly default: {
|
|
1113
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1114
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1115
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1116
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1117
|
+
};
|
|
1118
|
+
};
|
|
1119
|
+
readonly scalingProfile: {
|
|
1120
|
+
readonly type: "string";
|
|
1121
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
1122
|
+
readonly default: "conservative";
|
|
1123
|
+
readonly example: "conservative";
|
|
1124
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
697
1125
|
};
|
|
698
1126
|
};
|
|
699
1127
|
readonly additionalProperties: false;
|
|
1128
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
1129
|
+
};
|
|
1130
|
+
export declare const InviteCreateInputSchema: {
|
|
1131
|
+
readonly type: "object";
|
|
1132
|
+
readonly properties: {
|
|
1133
|
+
readonly email: {
|
|
1134
|
+
readonly type: "string";
|
|
1135
|
+
readonly format: "email";
|
|
1136
|
+
readonly description: "Email address of the user to invite.";
|
|
1137
|
+
readonly example: "email@example.com";
|
|
1138
|
+
};
|
|
1139
|
+
readonly role: {
|
|
1140
|
+
readonly type: "string";
|
|
1141
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1142
|
+
readonly default: "User";
|
|
1143
|
+
readonly example: "User";
|
|
1144
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1145
|
+
};
|
|
1146
|
+
};
|
|
1147
|
+
readonly required: readonly ["email"];
|
|
1148
|
+
readonly additionalProperties: false;
|
|
700
1149
|
};
|
|
701
1150
|
export declare const InviteSchema: {
|
|
702
1151
|
readonly type: "object";
|
|
703
1152
|
readonly properties: {
|
|
704
1153
|
readonly id: {
|
|
705
1154
|
readonly type: "string";
|
|
706
|
-
readonly description: "Unique identifier of the invitation.";
|
|
707
|
-
readonly example: "65831dd20d20165489cbb868";
|
|
1155
|
+
readonly description: "Unique identifier of the invitation.";
|
|
1156
|
+
readonly example: "65831dd20d20165489cbb868";
|
|
1157
|
+
};
|
|
1158
|
+
readonly organization_id: {
|
|
1159
|
+
readonly type: "string";
|
|
1160
|
+
readonly format: "uuid";
|
|
1161
|
+
readonly description: "Unique identifier of the organization the project belongs to. UUID v4 string in canonical form";
|
|
1162
|
+
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1163
|
+
};
|
|
1164
|
+
readonly date_created: {
|
|
1165
|
+
readonly type: "string";
|
|
1166
|
+
readonly format: "date-time";
|
|
1167
|
+
readonly description: "Creation date of the project. ISO 8601 date string in UTC timezone";
|
|
1168
|
+
readonly example: "2023-11-02T16:08:14.338Z";
|
|
1169
|
+
};
|
|
1170
|
+
readonly email: {
|
|
1171
|
+
readonly type: "string";
|
|
1172
|
+
readonly format: "email";
|
|
1173
|
+
readonly description: "User email address.";
|
|
1174
|
+
readonly example: "email@example.com";
|
|
1175
|
+
};
|
|
1176
|
+
readonly code: {
|
|
1177
|
+
readonly type: "string";
|
|
1178
|
+
readonly description: "Generated unique invite code.";
|
|
1179
|
+
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
1180
|
+
};
|
|
1181
|
+
readonly role: {
|
|
1182
|
+
readonly type: "string";
|
|
1183
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1184
|
+
readonly default: "User";
|
|
1185
|
+
readonly example: "User";
|
|
1186
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1187
|
+
};
|
|
1188
|
+
};
|
|
1189
|
+
readonly required: readonly ["date_created"];
|
|
1190
|
+
readonly additionalProperties: false;
|
|
1191
|
+
};
|
|
1192
|
+
export declare const InvoicePaymentAttemptSchema: {
|
|
1193
|
+
readonly type: "object";
|
|
1194
|
+
readonly properties: {
|
|
1195
|
+
readonly invoice_id: {
|
|
1196
|
+
readonly type: "string";
|
|
1197
|
+
readonly description: "Identifier of the invoice.";
|
|
1198
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
1199
|
+
};
|
|
1200
|
+
readonly number: {
|
|
1201
|
+
readonly type: "string";
|
|
1202
|
+
readonly nullable: true;
|
|
1203
|
+
readonly description: "Invoice number. Null if the invoice has no number.";
|
|
1204
|
+
readonly example: "CF-0042";
|
|
1205
|
+
};
|
|
1206
|
+
readonly amount: {
|
|
1207
|
+
readonly type: "number";
|
|
1208
|
+
readonly format: "float";
|
|
1209
|
+
readonly description: "Amount outstanding when the charge was attempted, in the smallest currency unit.";
|
|
1210
|
+
readonly example: 4200;
|
|
1211
|
+
};
|
|
1212
|
+
readonly currency: {
|
|
1213
|
+
readonly type: "string";
|
|
1214
|
+
readonly description: "Currency of the invoice.";
|
|
1215
|
+
readonly example: "eur";
|
|
1216
|
+
};
|
|
1217
|
+
readonly status: {
|
|
1218
|
+
readonly type: "string";
|
|
1219
|
+
readonly description: "Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).";
|
|
1220
|
+
readonly example: "paid";
|
|
1221
|
+
readonly enum: readonly ["paid", "processing", "requires_action", "failed"];
|
|
708
1222
|
};
|
|
709
|
-
readonly
|
|
1223
|
+
readonly client_secret: {
|
|
710
1224
|
readonly type: "string";
|
|
711
|
-
readonly
|
|
712
|
-
readonly description: "
|
|
713
|
-
readonly example: "
|
|
1225
|
+
readonly nullable: true;
|
|
1226
|
+
readonly description: "Client secret used to complete customer authentication. Set only when `status` is `requires_action`.";
|
|
1227
|
+
readonly example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH";
|
|
714
1228
|
};
|
|
715
|
-
readonly
|
|
1229
|
+
readonly failure_code: {
|
|
716
1230
|
readonly type: "string";
|
|
717
|
-
readonly
|
|
718
|
-
readonly description: "
|
|
719
|
-
readonly example: "
|
|
1231
|
+
readonly nullable: true;
|
|
1232
|
+
readonly description: "Decline code. Set only when `status` is `failed`.";
|
|
1233
|
+
readonly example: "insufficient_funds";
|
|
720
1234
|
};
|
|
721
|
-
readonly
|
|
1235
|
+
readonly failure_message: {
|
|
722
1236
|
readonly type: "string";
|
|
723
|
-
readonly
|
|
724
|
-
readonly description: "
|
|
725
|
-
readonly example: "
|
|
1237
|
+
readonly nullable: true;
|
|
1238
|
+
readonly description: "Explanation of the decline, suitable for display. Set only when `status` is `failed`.";
|
|
1239
|
+
readonly example: "Your card has insufficient funds.";
|
|
726
1240
|
};
|
|
1241
|
+
};
|
|
1242
|
+
readonly required: readonly ["invoice_id", "number", "amount", "currency", "status", "client_secret", "failure_code", "failure_message"];
|
|
1243
|
+
readonly additionalProperties: false;
|
|
1244
|
+
};
|
|
1245
|
+
export declare const InvoicePaymentResultSchema: {
|
|
1246
|
+
readonly type: "object";
|
|
1247
|
+
readonly properties: {
|
|
727
1248
|
readonly code: {
|
|
728
1249
|
readonly type: "string";
|
|
729
|
-
readonly description: "
|
|
730
|
-
readonly example: "
|
|
1250
|
+
readonly description: "Overall outcome: `paid` (nothing outstanding), `processing` (all accepted, not yet settled), `action_required` (one or more await customer authentication), `partially_paid`, `failed`, `nothing_due`, or `bank_transfer_due` (the organization pays by bank transfer; nothing was charged).";
|
|
1251
|
+
readonly example: "partially_paid";
|
|
1252
|
+
readonly enum: readonly ["paid", "processing", "action_required", "partially_paid", "failed", "nothing_due", "bank_transfer_due"];
|
|
1253
|
+
};
|
|
1254
|
+
readonly message: {
|
|
1255
|
+
readonly type: "string";
|
|
1256
|
+
readonly description: "Summary of the outcome, suitable for display.";
|
|
1257
|
+
readonly example: "1 of 2 open invoices was paid. Invoice CF-0043 was declined: Your card has insufficient funds.";
|
|
1258
|
+
};
|
|
1259
|
+
readonly results: {
|
|
1260
|
+
readonly type: "array";
|
|
1261
|
+
readonly items: {
|
|
1262
|
+
readonly type: "object";
|
|
1263
|
+
readonly properties: {
|
|
1264
|
+
readonly invoice_id: {
|
|
1265
|
+
readonly type: "string";
|
|
1266
|
+
readonly description: "Identifier of the invoice.";
|
|
1267
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
1268
|
+
};
|
|
1269
|
+
readonly number: {
|
|
1270
|
+
readonly type: "string";
|
|
1271
|
+
readonly description: "Invoice number. Null if the invoice has no number.";
|
|
1272
|
+
readonly example: "CF-0042";
|
|
1273
|
+
};
|
|
1274
|
+
readonly amount: {
|
|
1275
|
+
readonly type: "number";
|
|
1276
|
+
readonly format: "float";
|
|
1277
|
+
readonly description: "Amount outstanding when the charge was attempted, in the smallest currency unit.";
|
|
1278
|
+
readonly example: 4200;
|
|
1279
|
+
};
|
|
1280
|
+
readonly currency: {
|
|
1281
|
+
readonly type: "string";
|
|
1282
|
+
readonly description: "Currency of the invoice.";
|
|
1283
|
+
readonly example: "eur";
|
|
1284
|
+
};
|
|
1285
|
+
readonly status: {
|
|
1286
|
+
readonly type: "string";
|
|
1287
|
+
readonly description: "Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).";
|
|
1288
|
+
readonly example: "paid";
|
|
1289
|
+
readonly enum: readonly ["paid", "processing", "requires_action", "failed"];
|
|
1290
|
+
};
|
|
1291
|
+
readonly client_secret: {
|
|
1292
|
+
readonly type: "string";
|
|
1293
|
+
readonly description: "Client secret used to complete customer authentication. Set only when `status` is `requires_action`.";
|
|
1294
|
+
readonly example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH";
|
|
1295
|
+
};
|
|
1296
|
+
readonly failure_code: {
|
|
1297
|
+
readonly type: "string";
|
|
1298
|
+
readonly description: "Decline code. Set only when `status` is `failed`.";
|
|
1299
|
+
readonly example: "insufficient_funds";
|
|
1300
|
+
};
|
|
1301
|
+
readonly failure_message: {
|
|
1302
|
+
readonly type: "string";
|
|
1303
|
+
readonly description: "Explanation of the decline, suitable for display. Set only when `status` is `failed`.";
|
|
1304
|
+
readonly example: "Your card has insufficient funds.";
|
|
1305
|
+
};
|
|
1306
|
+
};
|
|
1307
|
+
readonly required: readonly ["invoice_id", "number", "amount", "currency", "status", "client_secret", "failure_code", "failure_message"];
|
|
1308
|
+
readonly additionalProperties: false;
|
|
1309
|
+
};
|
|
1310
|
+
readonly description: "One entry per invoice charged, oldest first.";
|
|
731
1311
|
};
|
|
732
1312
|
};
|
|
733
|
-
readonly required: readonly ["
|
|
1313
|
+
readonly required: readonly ["code", "message", "results"];
|
|
734
1314
|
readonly additionalProperties: false;
|
|
735
1315
|
};
|
|
736
1316
|
export declare const InvoiceSchema: {
|
|
@@ -926,6 +1506,12 @@ export declare const MarketplaceListingSchema: {
|
|
|
926
1506
|
export declare const OrganizationCreateInputSchema: {
|
|
927
1507
|
readonly type: "object";
|
|
928
1508
|
readonly properties: {
|
|
1509
|
+
readonly type: {
|
|
1510
|
+
readonly type: "string";
|
|
1511
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1512
|
+
readonly example: "business";
|
|
1513
|
+
readonly enum: readonly ["business", "personal"];
|
|
1514
|
+
};
|
|
929
1515
|
readonly email: {
|
|
930
1516
|
readonly type: "string";
|
|
931
1517
|
readonly format: "email";
|
|
@@ -934,11 +1520,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
934
1520
|
};
|
|
935
1521
|
readonly first_name: {
|
|
936
1522
|
readonly type: "string";
|
|
1523
|
+
readonly minLength: 1;
|
|
937
1524
|
readonly description: "First name of the billing contact person.";
|
|
938
1525
|
readonly example: "John";
|
|
939
1526
|
};
|
|
940
1527
|
readonly last_name: {
|
|
941
1528
|
readonly type: "string";
|
|
1529
|
+
readonly minLength: 1;
|
|
942
1530
|
readonly description: "Last name of the billing contact person.";
|
|
943
1531
|
readonly example: "Doe";
|
|
944
1532
|
};
|
|
@@ -956,7 +1544,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
956
1544
|
readonly description: "Password for the root account. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.";
|
|
957
1545
|
};
|
|
958
1546
|
};
|
|
959
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1547
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1548
|
+
readonly additionalProperties: false;
|
|
1549
|
+
};
|
|
1550
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1551
|
+
readonly type: "object";
|
|
1552
|
+
readonly properties: {
|
|
1553
|
+
readonly id: {
|
|
1554
|
+
readonly type: "string";
|
|
1555
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1556
|
+
readonly example: "organization-id";
|
|
1557
|
+
};
|
|
1558
|
+
};
|
|
1559
|
+
readonly required: readonly ["id"];
|
|
960
1560
|
readonly additionalProperties: false;
|
|
961
1561
|
};
|
|
962
1562
|
export declare const OrganizationSchema: {
|
|
@@ -975,6 +1575,12 @@ export declare const OrganizationSchema: {
|
|
|
975
1575
|
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
976
1576
|
readonly example: "ACME Corp.";
|
|
977
1577
|
};
|
|
1578
|
+
readonly type: {
|
|
1579
|
+
readonly type: "string";
|
|
1580
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1581
|
+
readonly example: "business";
|
|
1582
|
+
readonly enum: readonly ["business", "personal"];
|
|
1583
|
+
};
|
|
978
1584
|
readonly date_created: {
|
|
979
1585
|
readonly type: "string";
|
|
980
1586
|
readonly format: "date-time";
|
|
@@ -1006,6 +1612,17 @@ export declare const OrganizationSchema: {
|
|
|
1006
1612
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1007
1613
|
readonly example: 999;
|
|
1008
1614
|
};
|
|
1615
|
+
readonly enterprise_clusters_max: {
|
|
1616
|
+
readonly type: "integer";
|
|
1617
|
+
readonly minimum: 0;
|
|
1618
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1619
|
+
readonly example: 999;
|
|
1620
|
+
};
|
|
1621
|
+
readonly enterprise_clusters_available: {
|
|
1622
|
+
readonly type: "integer";
|
|
1623
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1624
|
+
readonly example: 999;
|
|
1625
|
+
};
|
|
1009
1626
|
readonly fleets_max: {
|
|
1010
1627
|
readonly type: "integer";
|
|
1011
1628
|
readonly minimum: 0;
|
|
@@ -1025,7 +1642,7 @@ export declare const OrganizationSchema: {
|
|
|
1025
1642
|
readonly type: "array";
|
|
1026
1643
|
readonly items: {
|
|
1027
1644
|
readonly type: "string";
|
|
1028
|
-
readonly example: "northamerica-central-
|
|
1645
|
+
readonly example: "northamerica-central-1a";
|
|
1029
1646
|
};
|
|
1030
1647
|
readonly minItems: 1;
|
|
1031
1648
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1059,7 +1676,7 @@ export declare const OrganizationSchema: {
|
|
|
1059
1676
|
readonly example: 500;
|
|
1060
1677
|
};
|
|
1061
1678
|
};
|
|
1062
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1679
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "enterprise_clusters_max", "enterprise_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1063
1680
|
readonly additionalProperties: false;
|
|
1064
1681
|
readonly description: "For security reasons, platform quota is controlled by Cloudfleet and can be updated only by Cloudfleet administrators. Please open a support ticket if you need to change the platform quota.";
|
|
1065
1682
|
};
|
|
@@ -1068,8 +1685,14 @@ export declare const OrganizationSchema: {
|
|
|
1068
1685
|
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1069
1686
|
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1070
1687
|
};
|
|
1688
|
+
readonly verification: {
|
|
1689
|
+
readonly type: "string";
|
|
1690
|
+
readonly description: "Verification status of the organization, which determines the assigned quota. `none` when billing information is incomplete, `submitted` when billing information is complete but the organization is not yet verified, `verified` when the organization is verified.";
|
|
1691
|
+
readonly example: "verified";
|
|
1692
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1693
|
+
};
|
|
1071
1694
|
};
|
|
1072
|
-
readonly required: readonly ["id", "date_created", "quota", "status"];
|
|
1695
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1073
1696
|
readonly additionalProperties: false;
|
|
1074
1697
|
};
|
|
1075
1698
|
export declare const PaymentMethodSchema: {
|
|
@@ -1077,26 +1700,19 @@ export declare const PaymentMethodSchema: {
|
|
|
1077
1700
|
readonly properties: {
|
|
1078
1701
|
readonly id: {
|
|
1079
1702
|
readonly type: "string";
|
|
1080
|
-
readonly
|
|
1081
|
-
readonly
|
|
1082
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1083
|
-
};
|
|
1084
|
-
readonly setup: {
|
|
1085
|
-
readonly type: "boolean";
|
|
1086
|
-
readonly description: "Whether organization payment method was set up and ready to use for payments.";
|
|
1087
|
-
readonly example: true;
|
|
1703
|
+
readonly description: "Payment method identifier. Stripe payment method id for cards/SEPA; the constant `bank_transfer` for the invoice/bank-transfer method. Used to set as default or delete the payment method.";
|
|
1704
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1088
1705
|
};
|
|
1089
1706
|
readonly type: {
|
|
1090
1707
|
readonly type: "string";
|
|
1091
|
-
readonly
|
|
1092
|
-
readonly description: "Payment method type type. Only `card` payments supported at the moment.";
|
|
1708
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1093
1709
|
readonly example: "card";
|
|
1094
|
-
readonly enum: readonly ["card"];
|
|
1710
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1095
1711
|
};
|
|
1096
1712
|
readonly last4: {
|
|
1097
1713
|
readonly type: "string";
|
|
1098
1714
|
readonly nullable: true;
|
|
1099
|
-
readonly description: "Last 4 digits of the payment card number.";
|
|
1715
|
+
readonly description: "Last 4 digits of the payment card number, of the bank account (IBAN) for SEPA Direct Debit, or of the destination IBAN for bank transfer.";
|
|
1100
1716
|
readonly example: "4242";
|
|
1101
1717
|
};
|
|
1102
1718
|
readonly exp_month: {
|
|
@@ -1104,25 +1720,46 @@ export declare const PaymentMethodSchema: {
|
|
|
1104
1720
|
readonly minimum: 1;
|
|
1105
1721
|
readonly maximum: 12;
|
|
1106
1722
|
readonly nullable: true;
|
|
1107
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1108
|
-
readonly example:
|
|
1723
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1724
|
+
readonly example: 12;
|
|
1109
1725
|
};
|
|
1110
1726
|
readonly exp_year: {
|
|
1111
1727
|
readonly type: "integer";
|
|
1112
|
-
readonly minimum: 2024;
|
|
1113
1728
|
readonly nullable: true;
|
|
1114
|
-
readonly description: "Four-digit number representing the card's expiration year.";
|
|
1115
|
-
readonly example:
|
|
1729
|
+
readonly description: "Four-digit number representing the card's expiration year. May be in the past for an expired card still on file. Null for SEPA Direct Debit and bank transfer.";
|
|
1730
|
+
readonly example: 2028;
|
|
1116
1731
|
};
|
|
1117
1732
|
readonly brand: {
|
|
1118
1733
|
readonly type: "string";
|
|
1119
1734
|
readonly nullable: true;
|
|
1120
|
-
readonly description: "Payment card brand
|
|
1735
|
+
readonly description: "Payment card brand as reported by Stripe, e.g. `visa`, `mastercard`, `amex`, `cartes_bancaires`, or `unknown`. Null for SEPA Direct Debit and bank transfer.";
|
|
1121
1736
|
readonly example: "visa";
|
|
1122
|
-
|
|
1737
|
+
};
|
|
1738
|
+
readonly iban: {
|
|
1739
|
+
readonly type: "string";
|
|
1740
|
+
readonly nullable: true;
|
|
1741
|
+
readonly description: "Full destination IBAN to send bank transfers to. Set only for `bank_transfer`; null otherwise. This is Cloudfleet's virtual receiving account, shown in full so the customer can pay into it.";
|
|
1742
|
+
readonly example: "DE11243015658023127510";
|
|
1743
|
+
};
|
|
1744
|
+
readonly bic: {
|
|
1745
|
+
readonly type: "string";
|
|
1746
|
+
readonly nullable: true;
|
|
1747
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1748
|
+
readonly example: "SOGEDEFFXXX";
|
|
1749
|
+
};
|
|
1750
|
+
readonly account_holder_name: {
|
|
1751
|
+
readonly type: "string";
|
|
1752
|
+
readonly nullable: true;
|
|
1753
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1754
|
+
readonly example: "Cloudfleet GmbH";
|
|
1755
|
+
};
|
|
1756
|
+
readonly is_default: {
|
|
1757
|
+
readonly type: "boolean";
|
|
1758
|
+
readonly description: "Whether this payment method is the default used for invoices and active subscriptions. Always false for `bank_transfer` (it cannot be a Stripe default payment method).";
|
|
1759
|
+
readonly example: true;
|
|
1123
1760
|
};
|
|
1124
1761
|
};
|
|
1125
|
-
readonly required: readonly ["id", "
|
|
1762
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1126
1763
|
readonly additionalProperties: false;
|
|
1127
1764
|
};
|
|
1128
1765
|
export declare const PlatformQuotaSchema: {
|
|
@@ -1150,6 +1787,17 @@ export declare const PlatformQuotaSchema: {
|
|
|
1150
1787
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1151
1788
|
readonly example: 999;
|
|
1152
1789
|
};
|
|
1790
|
+
readonly enterprise_clusters_max: {
|
|
1791
|
+
readonly type: "integer";
|
|
1792
|
+
readonly minimum: 0;
|
|
1793
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1794
|
+
readonly example: 999;
|
|
1795
|
+
};
|
|
1796
|
+
readonly enterprise_clusters_available: {
|
|
1797
|
+
readonly type: "integer";
|
|
1798
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1799
|
+
readonly example: 999;
|
|
1800
|
+
};
|
|
1153
1801
|
readonly fleets_max: {
|
|
1154
1802
|
readonly type: "integer";
|
|
1155
1803
|
readonly minimum: 0;
|
|
@@ -1169,7 +1817,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1169
1817
|
readonly type: "array";
|
|
1170
1818
|
readonly items: {
|
|
1171
1819
|
readonly type: "string";
|
|
1172
|
-
readonly example: "northamerica-central-
|
|
1820
|
+
readonly example: "northamerica-central-1a";
|
|
1173
1821
|
};
|
|
1174
1822
|
readonly minItems: 1;
|
|
1175
1823
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1203,7 +1851,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1203
1851
|
readonly example: 500;
|
|
1204
1852
|
};
|
|
1205
1853
|
};
|
|
1206
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1854
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "enterprise_clusters_max", "enterprise_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1207
1855
|
readonly additionalProperties: false;
|
|
1208
1856
|
};
|
|
1209
1857
|
export declare const RegistryRepositorySchema: {
|
|
@@ -1437,6 +2085,274 @@ export declare const RegistryTagSchema: {
|
|
|
1437
2085
|
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
1438
2086
|
readonly additionalProperties: false;
|
|
1439
2087
|
};
|
|
2088
|
+
export declare const TicketAttachmentSchema: {
|
|
2089
|
+
readonly type: "object";
|
|
2090
|
+
readonly properties: {
|
|
2091
|
+
readonly id: {
|
|
2092
|
+
readonly type: "string";
|
|
2093
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2094
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2095
|
+
};
|
|
2096
|
+
readonly filename: {
|
|
2097
|
+
readonly type: "string";
|
|
2098
|
+
readonly description: "Original filename as uploaded.";
|
|
2099
|
+
readonly example: "debug.log";
|
|
2100
|
+
};
|
|
2101
|
+
readonly content_type: {
|
|
2102
|
+
readonly type: "string";
|
|
2103
|
+
readonly description: "MIME content type of the attachment.";
|
|
2104
|
+
readonly example: "text/plain";
|
|
2105
|
+
};
|
|
2106
|
+
readonly size: {
|
|
2107
|
+
readonly type: "integer";
|
|
2108
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2109
|
+
readonly example: 12345;
|
|
2110
|
+
};
|
|
2111
|
+
};
|
|
2112
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2113
|
+
readonly additionalProperties: false;
|
|
2114
|
+
};
|
|
2115
|
+
export declare const TicketCreateInputSchema: {
|
|
2116
|
+
readonly type: "object";
|
|
2117
|
+
readonly properties: {
|
|
2118
|
+
readonly category: {
|
|
2119
|
+
readonly type: "string";
|
|
2120
|
+
readonly description: "Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.";
|
|
2121
|
+
readonly example: "technical";
|
|
2122
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2123
|
+
};
|
|
2124
|
+
readonly body: {
|
|
2125
|
+
readonly type: "string";
|
|
2126
|
+
readonly maxLength: 50000;
|
|
2127
|
+
readonly minLength: 1;
|
|
2128
|
+
readonly pattern: "\\S";
|
|
2129
|
+
readonly description: "Initial message body in markdown. There is no separate subject — the first message body is the description.";
|
|
2130
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2131
|
+
};
|
|
2132
|
+
readonly properties: {
|
|
2133
|
+
readonly type: "object";
|
|
2134
|
+
readonly additionalProperties: true;
|
|
2135
|
+
readonly description: "Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).";
|
|
2136
|
+
readonly example: {
|
|
2137
|
+
readonly subcategory: "cluster-question";
|
|
2138
|
+
readonly cluster_id: "60c72b2f9f1b2c001f8e4d3a";
|
|
2139
|
+
};
|
|
2140
|
+
};
|
|
2141
|
+
};
|
|
2142
|
+
readonly required: readonly ["category", "body"];
|
|
2143
|
+
readonly additionalProperties: false;
|
|
2144
|
+
};
|
|
2145
|
+
export declare const TicketMessageInputSchema: {
|
|
2146
|
+
readonly type: "object";
|
|
2147
|
+
readonly properties: {
|
|
2148
|
+
readonly body: {
|
|
2149
|
+
readonly type: "string";
|
|
2150
|
+
readonly maxLength: 50000;
|
|
2151
|
+
readonly minLength: 1;
|
|
2152
|
+
readonly pattern: "\\S";
|
|
2153
|
+
readonly description: "Reply body in markdown.";
|
|
2154
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2155
|
+
};
|
|
2156
|
+
};
|
|
2157
|
+
readonly required: readonly ["body"];
|
|
2158
|
+
readonly additionalProperties: false;
|
|
2159
|
+
};
|
|
2160
|
+
export declare const TicketMessageSchema: {
|
|
2161
|
+
readonly type: "object";
|
|
2162
|
+
readonly properties: {
|
|
2163
|
+
readonly id: {
|
|
2164
|
+
readonly type: "string";
|
|
2165
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2166
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2167
|
+
};
|
|
2168
|
+
readonly type: {
|
|
2169
|
+
readonly type: "string";
|
|
2170
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2171
|
+
readonly example: "customer_reply";
|
|
2172
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2173
|
+
};
|
|
2174
|
+
readonly body: {
|
|
2175
|
+
readonly type: "string";
|
|
2176
|
+
readonly description: "Message body in markdown.";
|
|
2177
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2178
|
+
};
|
|
2179
|
+
readonly author_first_name: {
|
|
2180
|
+
readonly type: "string";
|
|
2181
|
+
readonly nullable: true;
|
|
2182
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2183
|
+
readonly example: "Jane";
|
|
2184
|
+
};
|
|
2185
|
+
readonly author_last_name: {
|
|
2186
|
+
readonly type: "string";
|
|
2187
|
+
readonly nullable: true;
|
|
2188
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2189
|
+
readonly example: "Doe";
|
|
2190
|
+
};
|
|
2191
|
+
readonly attachments: {
|
|
2192
|
+
readonly type: "array";
|
|
2193
|
+
readonly items: {
|
|
2194
|
+
readonly type: "object";
|
|
2195
|
+
readonly properties: {
|
|
2196
|
+
readonly id: {
|
|
2197
|
+
readonly type: "string";
|
|
2198
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2199
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2200
|
+
};
|
|
2201
|
+
readonly filename: {
|
|
2202
|
+
readonly type: "string";
|
|
2203
|
+
readonly description: "Original filename as uploaded.";
|
|
2204
|
+
readonly example: "debug.log";
|
|
2205
|
+
};
|
|
2206
|
+
readonly content_type: {
|
|
2207
|
+
readonly type: "string";
|
|
2208
|
+
readonly description: "MIME content type of the attachment.";
|
|
2209
|
+
readonly example: "text/plain";
|
|
2210
|
+
};
|
|
2211
|
+
readonly size: {
|
|
2212
|
+
readonly type: "integer";
|
|
2213
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2214
|
+
readonly example: 12345;
|
|
2215
|
+
};
|
|
2216
|
+
};
|
|
2217
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2218
|
+
readonly additionalProperties: false;
|
|
2219
|
+
};
|
|
2220
|
+
readonly description: "Attachments associated with this message.";
|
|
2221
|
+
readonly example: readonly [];
|
|
2222
|
+
};
|
|
2223
|
+
readonly date_created: {
|
|
2224
|
+
readonly type: "string";
|
|
2225
|
+
readonly format: "date-time";
|
|
2226
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2227
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2228
|
+
};
|
|
2229
|
+
};
|
|
2230
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2231
|
+
readonly additionalProperties: false;
|
|
2232
|
+
};
|
|
2233
|
+
export declare const TicketSchema: {
|
|
2234
|
+
readonly type: "object";
|
|
2235
|
+
readonly properties: {
|
|
2236
|
+
readonly id: {
|
|
2237
|
+
readonly type: "string";
|
|
2238
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
2239
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
2240
|
+
};
|
|
2241
|
+
readonly status: {
|
|
2242
|
+
readonly type: "string";
|
|
2243
|
+
readonly description: "Current state of the ticket.";
|
|
2244
|
+
readonly example: "waiting_on_us";
|
|
2245
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
2246
|
+
};
|
|
2247
|
+
readonly category: {
|
|
2248
|
+
readonly type: "string";
|
|
2249
|
+
readonly description: "Ticket category.";
|
|
2250
|
+
readonly example: "technical";
|
|
2251
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2252
|
+
};
|
|
2253
|
+
readonly summary: {
|
|
2254
|
+
readonly type: "string";
|
|
2255
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
2256
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2257
|
+
};
|
|
2258
|
+
readonly closed_at: {
|
|
2259
|
+
readonly type: "string";
|
|
2260
|
+
readonly format: "date-time";
|
|
2261
|
+
readonly nullable: true;
|
|
2262
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2263
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
2264
|
+
};
|
|
2265
|
+
readonly date_created: {
|
|
2266
|
+
readonly type: "string";
|
|
2267
|
+
readonly format: "date-time";
|
|
2268
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
2269
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2270
|
+
};
|
|
2271
|
+
readonly date_updated: {
|
|
2272
|
+
readonly type: "string";
|
|
2273
|
+
readonly format: "date-time";
|
|
2274
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2275
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2276
|
+
};
|
|
2277
|
+
readonly messages: {
|
|
2278
|
+
readonly type: "array";
|
|
2279
|
+
readonly items: {
|
|
2280
|
+
readonly type: "object";
|
|
2281
|
+
readonly properties: {
|
|
2282
|
+
readonly id: {
|
|
2283
|
+
readonly type: "string";
|
|
2284
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2285
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2286
|
+
};
|
|
2287
|
+
readonly type: {
|
|
2288
|
+
readonly type: "string";
|
|
2289
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2290
|
+
readonly example: "customer_reply";
|
|
2291
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2292
|
+
};
|
|
2293
|
+
readonly body: {
|
|
2294
|
+
readonly type: "string";
|
|
2295
|
+
readonly description: "Message body in markdown.";
|
|
2296
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2297
|
+
};
|
|
2298
|
+
readonly author_first_name: {
|
|
2299
|
+
readonly type: "string";
|
|
2300
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2301
|
+
readonly example: "Jane";
|
|
2302
|
+
};
|
|
2303
|
+
readonly author_last_name: {
|
|
2304
|
+
readonly type: "string";
|
|
2305
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2306
|
+
readonly example: "Doe";
|
|
2307
|
+
};
|
|
2308
|
+
readonly attachments: {
|
|
2309
|
+
readonly type: "array";
|
|
2310
|
+
readonly items: {
|
|
2311
|
+
readonly type: "object";
|
|
2312
|
+
readonly properties: {
|
|
2313
|
+
readonly id: {
|
|
2314
|
+
readonly type: "string";
|
|
2315
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2316
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2317
|
+
};
|
|
2318
|
+
readonly filename: {
|
|
2319
|
+
readonly type: "string";
|
|
2320
|
+
readonly description: "Original filename as uploaded.";
|
|
2321
|
+
readonly example: "debug.log";
|
|
2322
|
+
};
|
|
2323
|
+
readonly content_type: {
|
|
2324
|
+
readonly type: "string";
|
|
2325
|
+
readonly description: "MIME content type of the attachment.";
|
|
2326
|
+
readonly example: "text/plain";
|
|
2327
|
+
};
|
|
2328
|
+
readonly size: {
|
|
2329
|
+
readonly type: "integer";
|
|
2330
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2331
|
+
readonly example: 12345;
|
|
2332
|
+
};
|
|
2333
|
+
};
|
|
2334
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2335
|
+
readonly additionalProperties: false;
|
|
2336
|
+
};
|
|
2337
|
+
readonly description: "Attachments associated with this message.";
|
|
2338
|
+
readonly example: readonly [];
|
|
2339
|
+
};
|
|
2340
|
+
readonly date_created: {
|
|
2341
|
+
readonly type: "string";
|
|
2342
|
+
readonly format: "date-time";
|
|
2343
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2344
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2345
|
+
};
|
|
2346
|
+
};
|
|
2347
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2348
|
+
readonly additionalProperties: false;
|
|
2349
|
+
};
|
|
2350
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
2351
|
+
};
|
|
2352
|
+
};
|
|
2353
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
2354
|
+
readonly additionalProperties: false;
|
|
2355
|
+
};
|
|
1440
2356
|
export declare const TokenCreateInputSchema: {
|
|
1441
2357
|
readonly type: "object";
|
|
1442
2358
|
readonly properties: {
|
|
@@ -1530,9 +2446,10 @@ export declare const UsageFacetsSchema: {
|
|
|
1530
2446
|
readonly type: "array";
|
|
1531
2447
|
readonly items: {
|
|
1532
2448
|
readonly type: "string";
|
|
2449
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
1533
2450
|
};
|
|
1534
2451
|
readonly description: "List of unique products";
|
|
1535
|
-
readonly example: readonly ["
|
|
2452
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
1536
2453
|
};
|
|
1537
2454
|
};
|
|
1538
2455
|
readonly additionalProperties: false;
|
|
@@ -1558,7 +2475,8 @@ export declare const UsageResponseSchema: {
|
|
|
1558
2475
|
readonly product: {
|
|
1559
2476
|
readonly type: "string";
|
|
1560
2477
|
readonly description: "The product the usage is associated with";
|
|
1561
|
-
readonly example: "
|
|
2478
|
+
readonly example: "cfke_controlplane_pro";
|
|
2479
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
1562
2480
|
};
|
|
1563
2481
|
readonly value: {
|
|
1564
2482
|
readonly type: "number";
|
|
@@ -1598,9 +2516,10 @@ export declare const UsageResponseSchema: {
|
|
|
1598
2516
|
readonly type: "array";
|
|
1599
2517
|
readonly items: {
|
|
1600
2518
|
readonly type: "string";
|
|
2519
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
1601
2520
|
};
|
|
1602
2521
|
readonly description: "List of unique products";
|
|
1603
|
-
readonly example: readonly ["
|
|
2522
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
1604
2523
|
};
|
|
1605
2524
|
};
|
|
1606
2525
|
readonly additionalProperties: false;
|
|
@@ -1626,7 +2545,8 @@ export declare const UsageSchema: {
|
|
|
1626
2545
|
readonly product: {
|
|
1627
2546
|
readonly type: "string";
|
|
1628
2547
|
readonly description: "The product the usage is associated with";
|
|
1629
|
-
readonly example: "
|
|
2548
|
+
readonly example: "cfke_controlplane_pro";
|
|
2549
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
1630
2550
|
};
|
|
1631
2551
|
readonly value: {
|
|
1632
2552
|
readonly type: "number";
|
|
@@ -1683,18 +2603,6 @@ export declare const UserCreateInputSchema: {
|
|
|
1683
2603
|
readonly minLength: 8;
|
|
1684
2604
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
1685
2605
|
};
|
|
1686
|
-
readonly status: {
|
|
1687
|
-
readonly type: "string";
|
|
1688
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
1689
|
-
readonly example: "active";
|
|
1690
|
-
readonly enum: readonly ["active", "inactive"];
|
|
1691
|
-
};
|
|
1692
|
-
readonly role: {
|
|
1693
|
-
readonly type: "string";
|
|
1694
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
1695
|
-
readonly example: "User";
|
|
1696
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
1697
|
-
};
|
|
1698
2606
|
};
|
|
1699
2607
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
1700
2608
|
readonly additionalProperties: false;
|