@cloudfleet/sdk 0.0.1-a0f38b2 → 0.0.1-a3b700e
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 +1149 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1165 -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 +114 -102
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/index.d.ts +1 -1
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js.map +1 -1
- package/dist/client/types.gen.d.ts +9 -13
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +8 -4
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.js +13 -15
- package/dist/client/utils.gen.js.map +1 -1
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/client.gen.js +1 -3
- package/dist/client.gen.js.map +1 -1
- package/dist/core/auth.gen.d.ts.map +1 -1
- package/dist/core/auth.gen.js.map +1 -1
- package/dist/core/bodySerializer.gen.d.ts +16 -8
- package/dist/core/bodySerializer.gen.d.ts.map +1 -1
- package/dist/core/bodySerializer.gen.js +1 -1
- package/dist/core/bodySerializer.gen.js.map +1 -1
- package/dist/core/params.gen.d.ts +10 -0
- package/dist/core/params.gen.d.ts.map +1 -1
- package/dist/core/params.gen.js +22 -10
- package/dist/core/params.gen.js.map +1 -1
- package/dist/core/pathSerializer.gen.d.ts.map +1 -1
- package/dist/core/pathSerializer.gen.js +3 -11
- package/dist/core/pathSerializer.gen.js.map +1 -1
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -1
- package/dist/core/queryKeySerializer.gen.js +4 -11
- package/dist/core/queryKeySerializer.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 +6 -9
- package/dist/core/serverSentEvents.gen.js.map +1 -1
- package/dist/core/types.gen.d.ts +1 -1
- package/dist/core/types.gen.d.ts.map +1 -1
- package/dist/core/utils.gen.d.ts.map +1 -1
- package/dist/core/utils.gen.js +1 -1
- package/dist/core/utils.gen.js.map +1 -1
- package/dist/schemas.gen.d.ts +1067 -132
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +2439 -211
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +242 -192
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +348 -370
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +8 -8
- package/dist/types.gen.d.ts +1542 -748
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3387 -1429
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1353 -635
- package/dist/zod.gen.js.map +1 -1
- package/package.json +28 -8
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,27 +275,103 @@ 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
280
|
readonly enum: readonly ["basic", "pro"];
|
|
275
281
|
};
|
|
276
|
-
readonly region: {
|
|
277
|
-
readonly type: "string";
|
|
278
|
-
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\", \"europe-central-1a\", \"northamerica-central-1a\". This field can not be updated after creation.";
|
|
279
|
-
readonly default: "staging";
|
|
280
|
-
readonly example: "northamerica-central-1a";
|
|
281
|
-
readonly enum: readonly ["staging", "northamerica-central-1", "europe-central-1a", "northamerica-central-1a"];
|
|
282
|
-
};
|
|
283
282
|
readonly version_channel: {
|
|
284
283
|
readonly type: "string";
|
|
285
284
|
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-]+)*))?$";
|
|
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";
|
|
@@ -306,6 +387,16 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
306
387
|
readonly description: "Internal URL of the Kubernetes cluster control plane. This is the endpoint that kubelet uses to connect to the cluster.";
|
|
307
388
|
readonly example: "https://10.31.64.7:6443";
|
|
308
389
|
};
|
|
390
|
+
readonly cluster_dns: {
|
|
391
|
+
readonly type: "string";
|
|
392
|
+
readonly description: "Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.";
|
|
393
|
+
readonly example: "10.96.0.10";
|
|
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
|
+
};
|
|
309
400
|
readonly auth_key: {
|
|
310
401
|
readonly type: "string";
|
|
311
402
|
readonly description: "Authentication key for the cluster.";
|
|
@@ -368,7 +459,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
368
459
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
369
460
|
};
|
|
370
461
|
};
|
|
371
|
-
readonly required: readonly ["certificate_authority", "endpoint", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
462
|
+
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "pod_cidr", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
372
463
|
readonly additionalProperties: false;
|
|
373
464
|
};
|
|
374
465
|
export declare const ClusterSchema: {
|
|
@@ -385,15 +476,100 @@ export declare const ClusterSchema: {
|
|
|
385
476
|
readonly tier: {
|
|
386
477
|
readonly type: "string";
|
|
387
478
|
readonly description: "Tier of the cluster.";
|
|
479
|
+
readonly default: "basic";
|
|
388
480
|
readonly example: "pro";
|
|
389
481
|
readonly enum: readonly ["basic", "pro"];
|
|
390
482
|
};
|
|
483
|
+
readonly version_channel: {
|
|
484
|
+
readonly type: "string";
|
|
485
|
+
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
486
|
+
readonly description: "Version of the kubernetes cluster.";
|
|
487
|
+
readonly default: "1.x.x-cfke.x";
|
|
488
|
+
readonly example: "1.x.x-cfke.x";
|
|
489
|
+
};
|
|
490
|
+
readonly release_channel: {
|
|
491
|
+
readonly type: "string";
|
|
492
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
493
|
+
readonly default: "rapid";
|
|
494
|
+
readonly example: "rapid";
|
|
495
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
496
|
+
};
|
|
497
|
+
readonly features: {
|
|
498
|
+
readonly type: "object";
|
|
499
|
+
readonly properties: {
|
|
500
|
+
readonly gpu_sharing_strategy: {
|
|
501
|
+
readonly type: "string";
|
|
502
|
+
readonly description: "GPU sharing strategy.";
|
|
503
|
+
readonly default: "none";
|
|
504
|
+
readonly example: "none";
|
|
505
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
506
|
+
};
|
|
507
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
508
|
+
readonly type: "integer";
|
|
509
|
+
readonly minimum: 2;
|
|
510
|
+
readonly maximum: 48;
|
|
511
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
512
|
+
readonly default: 4;
|
|
513
|
+
readonly example: 10;
|
|
514
|
+
};
|
|
515
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
516
|
+
readonly type: "boolean";
|
|
517
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
518
|
+
readonly example: false;
|
|
519
|
+
};
|
|
520
|
+
};
|
|
521
|
+
readonly required: readonly ["gpu_sharing_strategy", "gpu_max_shared_clients_per_gpu", "cilium_socket_lb_host_namespace_only"];
|
|
522
|
+
readonly additionalProperties: false;
|
|
523
|
+
readonly description: "Cluster feature toggles.";
|
|
524
|
+
readonly default: {
|
|
525
|
+
readonly gpu_sharing_strategy: "none";
|
|
526
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
527
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
528
|
+
};
|
|
529
|
+
};
|
|
391
530
|
readonly region: {
|
|
392
531
|
readonly type: "string";
|
|
393
|
-
readonly description: "Cloudfleet control plane region.
|
|
394
|
-
readonly
|
|
395
|
-
|
|
396
|
-
|
|
532
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
533
|
+
readonly example: "europe-central-1a";
|
|
534
|
+
};
|
|
535
|
+
readonly networking: {
|
|
536
|
+
readonly type: "object";
|
|
537
|
+
readonly properties: {
|
|
538
|
+
readonly pod_cidr: {
|
|
539
|
+
readonly type: "string";
|
|
540
|
+
readonly description: "CIDR block for pod IPs.";
|
|
541
|
+
readonly default: "10.244.0.0/16";
|
|
542
|
+
};
|
|
543
|
+
readonly service_cidr: {
|
|
544
|
+
readonly type: "string";
|
|
545
|
+
readonly description: "CIDR block for service IPs.";
|
|
546
|
+
readonly default: "10.96.0.0/12";
|
|
547
|
+
};
|
|
548
|
+
readonly dual_stack: {
|
|
549
|
+
readonly type: "boolean";
|
|
550
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
551
|
+
};
|
|
552
|
+
readonly pod_cidr_v6: {
|
|
553
|
+
readonly type: "string";
|
|
554
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
555
|
+
readonly default: "2001:db8:1:2::/48";
|
|
556
|
+
};
|
|
557
|
+
readonly service_cidr_v6: {
|
|
558
|
+
readonly type: "string";
|
|
559
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
560
|
+
readonly default: "2001:db8:1:1::/112";
|
|
561
|
+
};
|
|
562
|
+
};
|
|
563
|
+
readonly required: readonly ["pod_cidr", "service_cidr", "dual_stack", "pod_cidr_v6", "service_cidr_v6"];
|
|
564
|
+
readonly additionalProperties: false;
|
|
565
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
566
|
+
readonly default: {
|
|
567
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
568
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
569
|
+
readonly dual_stack: false;
|
|
570
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
571
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
572
|
+
};
|
|
397
573
|
};
|
|
398
574
|
readonly id: {
|
|
399
575
|
readonly type: "string";
|
|
@@ -403,16 +579,27 @@ export declare const ClusterSchema: {
|
|
|
403
579
|
};
|
|
404
580
|
readonly status: {
|
|
405
581
|
readonly type: "string";
|
|
406
|
-
readonly description: "Status of the cluster.
|
|
407
|
-
readonly example: "
|
|
408
|
-
readonly enum: readonly ["
|
|
582
|
+
readonly description: "Status of the cluster.";
|
|
583
|
+
readonly example: "deployed";
|
|
584
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
409
585
|
};
|
|
410
586
|
readonly endpoint: {
|
|
411
587
|
readonly anyOf: readonly [{
|
|
412
588
|
readonly type: "string";
|
|
413
589
|
readonly format: "uri";
|
|
414
|
-
readonly description: "URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
415
|
-
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
590
|
+
readonly description: "URL signed by a public CA of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
591
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
592
|
+
}, {
|
|
593
|
+
readonly type: "string";
|
|
594
|
+
readonly enum: readonly [""];
|
|
595
|
+
}];
|
|
596
|
+
};
|
|
597
|
+
readonly endpoint_public: {
|
|
598
|
+
readonly anyOf: readonly [{
|
|
599
|
+
readonly type: "string";
|
|
600
|
+
readonly format: "uri";
|
|
601
|
+
readonly description: "Deprecated alias of `endpoint`; retained for backward compatibility.";
|
|
602
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
416
603
|
}, {
|
|
417
604
|
readonly type: "string";
|
|
418
605
|
readonly enum: readonly [""];
|
|
@@ -443,15 +630,10 @@ export declare const ClusterSchema: {
|
|
|
443
630
|
readonly description: "Indicates if the cluster is ready to be used.";
|
|
444
631
|
readonly example: true;
|
|
445
632
|
};
|
|
446
|
-
readonly version_channel: {
|
|
447
|
-
readonly type: "string";
|
|
448
|
-
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-]+)*))?$";
|
|
449
|
-
readonly description: "Version of the kubernetes cluster.";
|
|
450
|
-
readonly example: "1.x.x-cfke.x";
|
|
451
|
-
};
|
|
452
633
|
};
|
|
453
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
634
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
454
635
|
readonly additionalProperties: false;
|
|
636
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
455
637
|
};
|
|
456
638
|
export declare const ClusterUpdateInputSchema: {
|
|
457
639
|
readonly type: "object";
|
|
@@ -467,6 +649,7 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
467
649
|
readonly tier: {
|
|
468
650
|
readonly type: "string";
|
|
469
651
|
readonly description: "Tier of the cluster.";
|
|
652
|
+
readonly default: "basic";
|
|
470
653
|
readonly example: "pro";
|
|
471
654
|
readonly enum: readonly ["basic", "pro"];
|
|
472
655
|
};
|
|
@@ -474,11 +657,52 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
474
657
|
readonly type: "string";
|
|
475
658
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
476
659
|
readonly description: "Version of the kubernetes cluster.";
|
|
660
|
+
readonly default: "1.x.x-cfke.x";
|
|
477
661
|
readonly example: "1.x.x-cfke.x";
|
|
478
662
|
};
|
|
663
|
+
readonly release_channel: {
|
|
664
|
+
readonly type: "string";
|
|
665
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
666
|
+
readonly default: "rapid";
|
|
667
|
+
readonly example: "rapid";
|
|
668
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
669
|
+
};
|
|
670
|
+
readonly features: {
|
|
671
|
+
readonly type: "object";
|
|
672
|
+
readonly properties: {
|
|
673
|
+
readonly gpu_sharing_strategy: {
|
|
674
|
+
readonly type: "string";
|
|
675
|
+
readonly description: "GPU sharing strategy.";
|
|
676
|
+
readonly default: "none";
|
|
677
|
+
readonly example: "none";
|
|
678
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
679
|
+
};
|
|
680
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
681
|
+
readonly type: "integer";
|
|
682
|
+
readonly minimum: 2;
|
|
683
|
+
readonly maximum: 48;
|
|
684
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
685
|
+
readonly default: 4;
|
|
686
|
+
readonly example: 10;
|
|
687
|
+
};
|
|
688
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
689
|
+
readonly type: "boolean";
|
|
690
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
691
|
+
readonly example: false;
|
|
692
|
+
};
|
|
693
|
+
};
|
|
694
|
+
readonly additionalProperties: false;
|
|
695
|
+
readonly description: "Cluster feature toggles.";
|
|
696
|
+
readonly default: {
|
|
697
|
+
readonly gpu_sharing_strategy: "none";
|
|
698
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
699
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
700
|
+
};
|
|
701
|
+
};
|
|
479
702
|
};
|
|
480
|
-
readonly required: readonly ["
|
|
703
|
+
readonly required: readonly ["name"];
|
|
481
704
|
readonly additionalProperties: false;
|
|
705
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
482
706
|
};
|
|
483
707
|
export declare const FleetCreateInputSchema: {
|
|
484
708
|
readonly type: "object";
|
|
@@ -487,13 +711,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
487
711
|
readonly type: "object";
|
|
488
712
|
readonly properties: {
|
|
489
713
|
readonly cpu: {
|
|
490
|
-
readonly type: "
|
|
491
|
-
readonly format: "float";
|
|
714
|
+
readonly type: "integer";
|
|
492
715
|
readonly minimum: 0;
|
|
493
|
-
readonly
|
|
716
|
+
readonly maximum: 100000;
|
|
717
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
494
718
|
};
|
|
495
719
|
};
|
|
496
|
-
readonly required: readonly ["cpu"];
|
|
497
720
|
readonly additionalProperties: false;
|
|
498
721
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
499
722
|
};
|
|
@@ -502,14 +725,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
502
725
|
readonly properties: {
|
|
503
726
|
readonly enabled: {
|
|
504
727
|
readonly type: "boolean";
|
|
505
|
-
readonly default: true;
|
|
506
728
|
};
|
|
507
729
|
readonly project: {
|
|
508
730
|
readonly type: "string";
|
|
509
|
-
readonly
|
|
731
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
732
|
+
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.";
|
|
733
|
+
readonly example: "my-cloudfleet-project";
|
|
510
734
|
};
|
|
511
735
|
};
|
|
512
|
-
readonly required: readonly ["
|
|
736
|
+
readonly required: readonly ["enabled"];
|
|
513
737
|
readonly additionalProperties: false;
|
|
514
738
|
};
|
|
515
739
|
readonly hetzner: {
|
|
@@ -517,14 +741,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
517
741
|
readonly properties: {
|
|
518
742
|
readonly enabled: {
|
|
519
743
|
readonly type: "boolean";
|
|
520
|
-
readonly default: true;
|
|
521
744
|
};
|
|
522
745
|
readonly apiKey: {
|
|
523
746
|
readonly type: "string";
|
|
524
|
-
readonly
|
|
747
|
+
readonly maxLength: 64;
|
|
748
|
+
readonly minLength: 64;
|
|
749
|
+
readonly pattern: "^[A-Za-z0-9]+$";
|
|
750
|
+
readonly description: "Hetzner Cloud API token with read / write access (64 alphanumeric characters). Omit this field to keep the existing value.";
|
|
525
751
|
};
|
|
526
752
|
};
|
|
527
|
-
readonly required: readonly ["
|
|
753
|
+
readonly required: readonly ["enabled"];
|
|
528
754
|
readonly additionalProperties: false;
|
|
529
755
|
};
|
|
530
756
|
readonly aws: {
|
|
@@ -532,15 +758,74 @@ export declare const FleetCreateInputSchema: {
|
|
|
532
758
|
readonly properties: {
|
|
533
759
|
readonly enabled: {
|
|
534
760
|
readonly type: "boolean";
|
|
535
|
-
readonly default: true;
|
|
536
761
|
};
|
|
537
762
|
readonly controllerRoleArn: {
|
|
538
763
|
readonly type: "string";
|
|
539
|
-
readonly
|
|
764
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
765
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
766
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
767
|
+
};
|
|
768
|
+
};
|
|
769
|
+
readonly required: readonly ["enabled"];
|
|
770
|
+
readonly additionalProperties: false;
|
|
771
|
+
};
|
|
772
|
+
readonly constraints: {
|
|
773
|
+
readonly type: "object";
|
|
774
|
+
readonly properties: {
|
|
775
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
776
|
+
readonly type: "array";
|
|
777
|
+
readonly items: {
|
|
778
|
+
readonly type: "string";
|
|
779
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
780
|
+
};
|
|
781
|
+
readonly minItems: 1;
|
|
782
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
783
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
784
|
+
};
|
|
785
|
+
readonly 'kubernetes.io/arch': {
|
|
786
|
+
readonly type: "array";
|
|
787
|
+
readonly items: {
|
|
788
|
+
readonly type: "string";
|
|
789
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
790
|
+
};
|
|
791
|
+
readonly minItems: 1;
|
|
792
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
793
|
+
readonly default: readonly ["amd64"];
|
|
794
|
+
};
|
|
795
|
+
readonly 'cfke.io/instance-family': {
|
|
796
|
+
readonly type: "array";
|
|
797
|
+
readonly items: {
|
|
798
|
+
readonly type: "string";
|
|
799
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
800
|
+
};
|
|
801
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
802
|
+
readonly default: readonly [];
|
|
803
|
+
};
|
|
804
|
+
readonly 'topology.kubernetes.io/region': {
|
|
805
|
+
readonly type: "array";
|
|
806
|
+
readonly items: {
|
|
807
|
+
readonly type: "string";
|
|
808
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
809
|
+
};
|
|
810
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
811
|
+
readonly default: readonly [];
|
|
540
812
|
};
|
|
541
813
|
};
|
|
542
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
543
814
|
readonly additionalProperties: false;
|
|
815
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
816
|
+
readonly default: {
|
|
817
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
818
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
819
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
820
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
821
|
+
};
|
|
822
|
+
};
|
|
823
|
+
readonly scalingProfile: {
|
|
824
|
+
readonly type: "string";
|
|
825
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
826
|
+
readonly default: "conservative";
|
|
827
|
+
readonly example: "conservative";
|
|
828
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
544
829
|
};
|
|
545
830
|
readonly id: {
|
|
546
831
|
readonly type: "string";
|
|
@@ -553,6 +838,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
553
838
|
};
|
|
554
839
|
readonly required: readonly ["id"];
|
|
555
840
|
readonly additionalProperties: false;
|
|
841
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
556
842
|
};
|
|
557
843
|
export declare const FleetSchema: {
|
|
558
844
|
readonly type: "object";
|
|
@@ -561,13 +847,12 @@ export declare const FleetSchema: {
|
|
|
561
847
|
readonly type: "object";
|
|
562
848
|
readonly properties: {
|
|
563
849
|
readonly cpu: {
|
|
564
|
-
readonly type: "
|
|
565
|
-
readonly format: "float";
|
|
850
|
+
readonly type: "integer";
|
|
566
851
|
readonly minimum: 0;
|
|
567
|
-
readonly
|
|
852
|
+
readonly maximum: 100000;
|
|
853
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
568
854
|
};
|
|
569
855
|
};
|
|
570
|
-
readonly required: readonly ["cpu"];
|
|
571
856
|
readonly additionalProperties: false;
|
|
572
857
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
573
858
|
};
|
|
@@ -576,14 +861,15 @@ export declare const FleetSchema: {
|
|
|
576
861
|
readonly properties: {
|
|
577
862
|
readonly enabled: {
|
|
578
863
|
readonly type: "boolean";
|
|
579
|
-
readonly default: true;
|
|
580
864
|
};
|
|
581
865
|
readonly project: {
|
|
582
866
|
readonly type: "string";
|
|
583
|
-
readonly
|
|
867
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
868
|
+
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.";
|
|
869
|
+
readonly example: "my-cloudfleet-project";
|
|
584
870
|
};
|
|
585
871
|
};
|
|
586
|
-
readonly required: readonly ["
|
|
872
|
+
readonly required: readonly ["enabled"];
|
|
587
873
|
readonly additionalProperties: false;
|
|
588
874
|
};
|
|
589
875
|
readonly hetzner: {
|
|
@@ -591,14 +877,14 @@ export declare const FleetSchema: {
|
|
|
591
877
|
readonly properties: {
|
|
592
878
|
readonly enabled: {
|
|
593
879
|
readonly type: "boolean";
|
|
594
|
-
readonly default: true;
|
|
595
880
|
};
|
|
596
881
|
readonly apiKey: {
|
|
597
882
|
readonly type: "string";
|
|
598
|
-
readonly
|
|
883
|
+
readonly pattern: "^\\*{64}$";
|
|
884
|
+
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.";
|
|
599
885
|
};
|
|
600
886
|
};
|
|
601
|
-
readonly required: readonly ["
|
|
887
|
+
readonly required: readonly ["enabled"];
|
|
602
888
|
readonly additionalProperties: false;
|
|
603
889
|
};
|
|
604
890
|
readonly aws: {
|
|
@@ -606,15 +892,75 @@ export declare const FleetSchema: {
|
|
|
606
892
|
readonly properties: {
|
|
607
893
|
readonly enabled: {
|
|
608
894
|
readonly type: "boolean";
|
|
609
|
-
readonly default: true;
|
|
610
895
|
};
|
|
611
896
|
readonly controllerRoleArn: {
|
|
612
897
|
readonly type: "string";
|
|
613
|
-
readonly
|
|
898
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
899
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
900
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
901
|
+
};
|
|
902
|
+
};
|
|
903
|
+
readonly required: readonly ["enabled"];
|
|
904
|
+
readonly additionalProperties: false;
|
|
905
|
+
};
|
|
906
|
+
readonly constraints: {
|
|
907
|
+
readonly type: "object";
|
|
908
|
+
readonly properties: {
|
|
909
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
910
|
+
readonly type: "array";
|
|
911
|
+
readonly items: {
|
|
912
|
+
readonly type: "string";
|
|
913
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
914
|
+
};
|
|
915
|
+
readonly minItems: 1;
|
|
916
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
917
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
918
|
+
};
|
|
919
|
+
readonly 'kubernetes.io/arch': {
|
|
920
|
+
readonly type: "array";
|
|
921
|
+
readonly items: {
|
|
922
|
+
readonly type: "string";
|
|
923
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
924
|
+
};
|
|
925
|
+
readonly minItems: 1;
|
|
926
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
927
|
+
readonly default: readonly ["amd64"];
|
|
928
|
+
};
|
|
929
|
+
readonly 'cfke.io/instance-family': {
|
|
930
|
+
readonly type: "array";
|
|
931
|
+
readonly items: {
|
|
932
|
+
readonly type: "string";
|
|
933
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
934
|
+
};
|
|
935
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
936
|
+
readonly default: readonly [];
|
|
937
|
+
};
|
|
938
|
+
readonly 'topology.kubernetes.io/region': {
|
|
939
|
+
readonly type: "array";
|
|
940
|
+
readonly items: {
|
|
941
|
+
readonly type: "string";
|
|
942
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
943
|
+
};
|
|
944
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
945
|
+
readonly default: readonly [];
|
|
614
946
|
};
|
|
615
947
|
};
|
|
616
|
-
readonly required: readonly ["
|
|
948
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
617
949
|
readonly additionalProperties: false;
|
|
950
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
951
|
+
readonly default: {
|
|
952
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
953
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
954
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
955
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
956
|
+
};
|
|
957
|
+
};
|
|
958
|
+
readonly scalingProfile: {
|
|
959
|
+
readonly type: "string";
|
|
960
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
961
|
+
readonly default: "conservative";
|
|
962
|
+
readonly example: "conservative";
|
|
963
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
618
964
|
};
|
|
619
965
|
readonly id: {
|
|
620
966
|
readonly type: "string";
|
|
@@ -624,9 +970,30 @@ export declare const FleetSchema: {
|
|
|
624
970
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
625
971
|
readonly example: "new-clouds-fleet";
|
|
626
972
|
};
|
|
973
|
+
readonly ready: {
|
|
974
|
+
readonly type: "boolean";
|
|
975
|
+
readonly description: "Indicates whether the fleet configuration is healthy.";
|
|
976
|
+
readonly example: true;
|
|
977
|
+
};
|
|
978
|
+
readonly status_message: {
|
|
979
|
+
readonly type: "string";
|
|
980
|
+
readonly description: "Human-readable reason the fleet is not ready. Present only when `ready` is false.";
|
|
981
|
+
readonly example: "Invalid provider permissions.";
|
|
982
|
+
};
|
|
983
|
+
readonly created_at: {
|
|
984
|
+
readonly type: "string";
|
|
985
|
+
readonly description: "Creation date and time of the fleet.";
|
|
986
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
987
|
+
};
|
|
988
|
+
readonly updated_at: {
|
|
989
|
+
readonly type: "string";
|
|
990
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
991
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
992
|
+
};
|
|
627
993
|
};
|
|
628
|
-
readonly required: readonly ["id"];
|
|
994
|
+
readonly required: readonly ["constraints", "scalingProfile", "id", "ready", "created_at", "updated_at"];
|
|
629
995
|
readonly additionalProperties: false;
|
|
996
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
630
997
|
};
|
|
631
998
|
export declare const FleetUpdateInputSchema: {
|
|
632
999
|
readonly type: "object";
|
|
@@ -635,13 +1002,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
635
1002
|
readonly type: "object";
|
|
636
1003
|
readonly properties: {
|
|
637
1004
|
readonly cpu: {
|
|
638
|
-
readonly type: "
|
|
639
|
-
readonly format: "float";
|
|
1005
|
+
readonly type: "integer";
|
|
640
1006
|
readonly minimum: 0;
|
|
641
|
-
readonly
|
|
1007
|
+
readonly maximum: 100000;
|
|
1008
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
642
1009
|
};
|
|
643
1010
|
};
|
|
644
|
-
readonly required: readonly ["cpu"];
|
|
645
1011
|
readonly additionalProperties: false;
|
|
646
1012
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
647
1013
|
};
|
|
@@ -650,14 +1016,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
650
1016
|
readonly properties: {
|
|
651
1017
|
readonly enabled: {
|
|
652
1018
|
readonly type: "boolean";
|
|
653
|
-
readonly default: true;
|
|
654
1019
|
};
|
|
655
1020
|
readonly project: {
|
|
656
1021
|
readonly type: "string";
|
|
657
|
-
readonly
|
|
1022
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
1023
|
+
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.";
|
|
1024
|
+
readonly example: "my-cloudfleet-project";
|
|
658
1025
|
};
|
|
659
1026
|
};
|
|
660
|
-
readonly required: readonly ["
|
|
1027
|
+
readonly required: readonly ["enabled"];
|
|
661
1028
|
readonly additionalProperties: false;
|
|
662
1029
|
};
|
|
663
1030
|
readonly hetzner: {
|
|
@@ -665,14 +1032,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
665
1032
|
readonly properties: {
|
|
666
1033
|
readonly enabled: {
|
|
667
1034
|
readonly type: "boolean";
|
|
668
|
-
readonly default: true;
|
|
669
1035
|
};
|
|
670
1036
|
readonly apiKey: {
|
|
671
1037
|
readonly type: "string";
|
|
672
|
-
readonly
|
|
1038
|
+
readonly maxLength: 64;
|
|
1039
|
+
readonly minLength: 64;
|
|
1040
|
+
readonly pattern: "^[A-Za-z0-9]+$";
|
|
1041
|
+
readonly description: "Hetzner Cloud API token with read / write access (64 alphanumeric characters). Omit this field to keep the existing value.";
|
|
673
1042
|
};
|
|
674
1043
|
};
|
|
675
|
-
readonly required: readonly ["
|
|
1044
|
+
readonly required: readonly ["enabled"];
|
|
676
1045
|
readonly additionalProperties: false;
|
|
677
1046
|
};
|
|
678
1047
|
readonly aws: {
|
|
@@ -680,17 +1049,97 @@ export declare const FleetUpdateInputSchema: {
|
|
|
680
1049
|
readonly properties: {
|
|
681
1050
|
readonly enabled: {
|
|
682
1051
|
readonly type: "boolean";
|
|
683
|
-
readonly default: true;
|
|
684
1052
|
};
|
|
685
1053
|
readonly controllerRoleArn: {
|
|
686
1054
|
readonly type: "string";
|
|
687
|
-
readonly
|
|
1055
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
1056
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
1057
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
688
1058
|
};
|
|
689
1059
|
};
|
|
690
|
-
readonly required: readonly ["
|
|
1060
|
+
readonly required: readonly ["enabled"];
|
|
691
1061
|
readonly additionalProperties: false;
|
|
692
1062
|
};
|
|
1063
|
+
readonly constraints: {
|
|
1064
|
+
readonly type: "object";
|
|
1065
|
+
readonly properties: {
|
|
1066
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
1067
|
+
readonly type: "array";
|
|
1068
|
+
readonly items: {
|
|
1069
|
+
readonly type: "string";
|
|
1070
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
1071
|
+
};
|
|
1072
|
+
readonly minItems: 1;
|
|
1073
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1074
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
1075
|
+
};
|
|
1076
|
+
readonly 'kubernetes.io/arch': {
|
|
1077
|
+
readonly type: "array";
|
|
1078
|
+
readonly items: {
|
|
1079
|
+
readonly type: "string";
|
|
1080
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
1081
|
+
};
|
|
1082
|
+
readonly minItems: 1;
|
|
1083
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1084
|
+
readonly default: readonly ["amd64"];
|
|
1085
|
+
};
|
|
1086
|
+
readonly 'cfke.io/instance-family': {
|
|
1087
|
+
readonly type: "array";
|
|
1088
|
+
readonly items: {
|
|
1089
|
+
readonly type: "string";
|
|
1090
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
1091
|
+
};
|
|
1092
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1093
|
+
readonly default: readonly [];
|
|
1094
|
+
};
|
|
1095
|
+
readonly 'topology.kubernetes.io/region': {
|
|
1096
|
+
readonly type: "array";
|
|
1097
|
+
readonly items: {
|
|
1098
|
+
readonly type: "string";
|
|
1099
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
1100
|
+
};
|
|
1101
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1102
|
+
readonly default: readonly [];
|
|
1103
|
+
};
|
|
1104
|
+
};
|
|
1105
|
+
readonly additionalProperties: false;
|
|
1106
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
1107
|
+
readonly default: {
|
|
1108
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1109
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1110
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1111
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1112
|
+
};
|
|
1113
|
+
};
|
|
1114
|
+
readonly scalingProfile: {
|
|
1115
|
+
readonly type: "string";
|
|
1116
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
1117
|
+
readonly default: "conservative";
|
|
1118
|
+
readonly example: "conservative";
|
|
1119
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
1120
|
+
};
|
|
1121
|
+
};
|
|
1122
|
+
readonly additionalProperties: false;
|
|
1123
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
1124
|
+
};
|
|
1125
|
+
export declare const InviteCreateInputSchema: {
|
|
1126
|
+
readonly type: "object";
|
|
1127
|
+
readonly properties: {
|
|
1128
|
+
readonly email: {
|
|
1129
|
+
readonly type: "string";
|
|
1130
|
+
readonly format: "email";
|
|
1131
|
+
readonly description: "Email address of the user to invite.";
|
|
1132
|
+
readonly example: "email@example.com";
|
|
1133
|
+
};
|
|
1134
|
+
readonly role: {
|
|
1135
|
+
readonly type: "string";
|
|
1136
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1137
|
+
readonly default: "User";
|
|
1138
|
+
readonly example: "User";
|
|
1139
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1140
|
+
};
|
|
693
1141
|
};
|
|
1142
|
+
readonly required: readonly ["email"];
|
|
694
1143
|
readonly additionalProperties: false;
|
|
695
1144
|
};
|
|
696
1145
|
export declare const InviteSchema: {
|
|
@@ -724,6 +1173,13 @@ export declare const InviteSchema: {
|
|
|
724
1173
|
readonly description: "Generated unique invite code.";
|
|
725
1174
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
726
1175
|
};
|
|
1176
|
+
readonly role: {
|
|
1177
|
+
readonly type: "string";
|
|
1178
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1179
|
+
readonly default: "User";
|
|
1180
|
+
readonly example: "User";
|
|
1181
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1182
|
+
};
|
|
727
1183
|
};
|
|
728
1184
|
readonly required: readonly ["date_created"];
|
|
729
1185
|
readonly additionalProperties: false;
|
|
@@ -875,6 +1331,11 @@ export declare const MarketplaceListingSchema: {
|
|
|
875
1331
|
readonly description: "Chart home URL";
|
|
876
1332
|
readonly example: "https://kubernetes.github.io/ingress-nginx/";
|
|
877
1333
|
};
|
|
1334
|
+
readonly icon: {
|
|
1335
|
+
readonly type: "string";
|
|
1336
|
+
readonly description: "A URL to an SVG or PNG image to be used as an icon";
|
|
1337
|
+
readonly example: "https://cloudfleet.ai/images/marketplace/icons/ingress-nginx.png";
|
|
1338
|
+
};
|
|
878
1339
|
readonly sources: {
|
|
879
1340
|
readonly type: "array";
|
|
880
1341
|
readonly items: {
|
|
@@ -916,6 +1377,12 @@ export declare const MarketplaceListingSchema: {
|
|
|
916
1377
|
export declare const OrganizationCreateInputSchema: {
|
|
917
1378
|
readonly type: "object";
|
|
918
1379
|
readonly properties: {
|
|
1380
|
+
readonly type: {
|
|
1381
|
+
readonly type: "string";
|
|
1382
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1383
|
+
readonly example: "business";
|
|
1384
|
+
readonly enum: readonly ["business", "personal"];
|
|
1385
|
+
};
|
|
919
1386
|
readonly email: {
|
|
920
1387
|
readonly type: "string";
|
|
921
1388
|
readonly format: "email";
|
|
@@ -924,11 +1391,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
924
1391
|
};
|
|
925
1392
|
readonly first_name: {
|
|
926
1393
|
readonly type: "string";
|
|
1394
|
+
readonly minLength: 1;
|
|
927
1395
|
readonly description: "First name of the billing contact person.";
|
|
928
1396
|
readonly example: "John";
|
|
929
1397
|
};
|
|
930
1398
|
readonly last_name: {
|
|
931
1399
|
readonly type: "string";
|
|
1400
|
+
readonly minLength: 1;
|
|
932
1401
|
readonly description: "Last name of the billing contact person.";
|
|
933
1402
|
readonly example: "Doe";
|
|
934
1403
|
};
|
|
@@ -946,7 +1415,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
946
1415
|
readonly description: "Password for the root account. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.";
|
|
947
1416
|
};
|
|
948
1417
|
};
|
|
949
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1418
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1419
|
+
readonly additionalProperties: false;
|
|
1420
|
+
};
|
|
1421
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1422
|
+
readonly type: "object";
|
|
1423
|
+
readonly properties: {
|
|
1424
|
+
readonly id: {
|
|
1425
|
+
readonly type: "string";
|
|
1426
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1427
|
+
readonly example: "organization-id";
|
|
1428
|
+
};
|
|
1429
|
+
};
|
|
1430
|
+
readonly required: readonly ["id"];
|
|
950
1431
|
readonly additionalProperties: false;
|
|
951
1432
|
};
|
|
952
1433
|
export declare const OrganizationSchema: {
|
|
@@ -965,6 +1446,12 @@ export declare const OrganizationSchema: {
|
|
|
965
1446
|
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
966
1447
|
readonly example: "ACME Corp.";
|
|
967
1448
|
};
|
|
1449
|
+
readonly type: {
|
|
1450
|
+
readonly type: "string";
|
|
1451
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1452
|
+
readonly example: "business";
|
|
1453
|
+
readonly enum: readonly ["business", "personal"];
|
|
1454
|
+
};
|
|
968
1455
|
readonly date_created: {
|
|
969
1456
|
readonly type: "string";
|
|
970
1457
|
readonly format: "date-time";
|
|
@@ -1015,7 +1502,7 @@ export declare const OrganizationSchema: {
|
|
|
1015
1502
|
readonly type: "array";
|
|
1016
1503
|
readonly items: {
|
|
1017
1504
|
readonly type: "string";
|
|
1018
|
-
readonly example: "northamerica-central-
|
|
1505
|
+
readonly example: "northamerica-central-1a";
|
|
1019
1506
|
};
|
|
1020
1507
|
readonly minItems: 1;
|
|
1021
1508
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1042,20 +1529,14 @@ export declare const OrganizationSchema: {
|
|
|
1042
1529
|
readonly minItems: 1;
|
|
1043
1530
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1044
1531
|
};
|
|
1045
|
-
readonly
|
|
1532
|
+
readonly cfcr_storage_gb: {
|
|
1046
1533
|
readonly type: "integer";
|
|
1047
|
-
readonly minimum:
|
|
1048
|
-
readonly description: "
|
|
1049
|
-
readonly example:
|
|
1050
|
-
};
|
|
1051
|
-
readonly copilot_organization_hourly_tokens: {
|
|
1052
|
-
readonly type: "integer";
|
|
1053
|
-
readonly minimum: 0;
|
|
1054
|
-
readonly description: "Organization-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1055
|
-
readonly example: 242000;
|
|
1534
|
+
readonly minimum: -1;
|
|
1535
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1536
|
+
readonly example: 500;
|
|
1056
1537
|
};
|
|
1057
1538
|
};
|
|
1058
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "
|
|
1539
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1059
1540
|
readonly additionalProperties: false;
|
|
1060
1541
|
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.";
|
|
1061
1542
|
};
|
|
@@ -1064,8 +1545,14 @@ export declare const OrganizationSchema: {
|
|
|
1064
1545
|
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1065
1546
|
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1066
1547
|
};
|
|
1548
|
+
readonly verification: {
|
|
1549
|
+
readonly type: "string";
|
|
1550
|
+
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.";
|
|
1551
|
+
readonly example: "verified";
|
|
1552
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1553
|
+
};
|
|
1067
1554
|
};
|
|
1068
|
-
readonly required: readonly ["id", "date_created", "quota", "status"];
|
|
1555
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1069
1556
|
readonly additionalProperties: false;
|
|
1070
1557
|
};
|
|
1071
1558
|
export declare const PaymentMethodSchema: {
|
|
@@ -1073,26 +1560,19 @@ export declare const PaymentMethodSchema: {
|
|
|
1073
1560
|
readonly properties: {
|
|
1074
1561
|
readonly id: {
|
|
1075
1562
|
readonly type: "string";
|
|
1076
|
-
readonly
|
|
1077
|
-
readonly
|
|
1078
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1079
|
-
};
|
|
1080
|
-
readonly setup: {
|
|
1081
|
-
readonly type: "boolean";
|
|
1082
|
-
readonly description: "Whether organization payment method was set up and ready to use for payments.";
|
|
1083
|
-
readonly example: true;
|
|
1563
|
+
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.";
|
|
1564
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1084
1565
|
};
|
|
1085
1566
|
readonly type: {
|
|
1086
1567
|
readonly type: "string";
|
|
1087
|
-
readonly
|
|
1088
|
-
readonly description: "Payment method type type. Only `card` payments supported at the moment.";
|
|
1568
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1089
1569
|
readonly example: "card";
|
|
1090
|
-
readonly enum: readonly ["card"];
|
|
1570
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1091
1571
|
};
|
|
1092
1572
|
readonly last4: {
|
|
1093
1573
|
readonly type: "string";
|
|
1094
1574
|
readonly nullable: true;
|
|
1095
|
-
readonly description: "Last 4 digits of the payment card number.";
|
|
1575
|
+
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.";
|
|
1096
1576
|
readonly example: "4242";
|
|
1097
1577
|
};
|
|
1098
1578
|
readonly exp_month: {
|
|
@@ -1100,25 +1580,46 @@ export declare const PaymentMethodSchema: {
|
|
|
1100
1580
|
readonly minimum: 1;
|
|
1101
1581
|
readonly maximum: 12;
|
|
1102
1582
|
readonly nullable: true;
|
|
1103
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1104
|
-
readonly example:
|
|
1583
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1584
|
+
readonly example: 12;
|
|
1105
1585
|
};
|
|
1106
1586
|
readonly exp_year: {
|
|
1107
1587
|
readonly type: "integer";
|
|
1108
|
-
readonly minimum: 2024;
|
|
1109
1588
|
readonly nullable: true;
|
|
1110
|
-
readonly description: "Four-digit number representing the card's expiration year.";
|
|
1111
|
-
readonly example:
|
|
1589
|
+
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.";
|
|
1590
|
+
readonly example: 2028;
|
|
1112
1591
|
};
|
|
1113
1592
|
readonly brand: {
|
|
1114
1593
|
readonly type: "string";
|
|
1115
1594
|
readonly nullable: true;
|
|
1116
|
-
readonly description: "Payment card brand
|
|
1595
|
+
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.";
|
|
1117
1596
|
readonly example: "visa";
|
|
1118
|
-
|
|
1597
|
+
};
|
|
1598
|
+
readonly iban: {
|
|
1599
|
+
readonly type: "string";
|
|
1600
|
+
readonly nullable: true;
|
|
1601
|
+
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.";
|
|
1602
|
+
readonly example: "DE11243015658023127510";
|
|
1603
|
+
};
|
|
1604
|
+
readonly bic: {
|
|
1605
|
+
readonly type: "string";
|
|
1606
|
+
readonly nullable: true;
|
|
1607
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1608
|
+
readonly example: "SOGEDEFFXXX";
|
|
1609
|
+
};
|
|
1610
|
+
readonly account_holder_name: {
|
|
1611
|
+
readonly type: "string";
|
|
1612
|
+
readonly nullable: true;
|
|
1613
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1614
|
+
readonly example: "Cloudfleet GmbH";
|
|
1615
|
+
};
|
|
1616
|
+
readonly is_default: {
|
|
1617
|
+
readonly type: "boolean";
|
|
1618
|
+
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).";
|
|
1619
|
+
readonly example: true;
|
|
1119
1620
|
};
|
|
1120
1621
|
};
|
|
1121
|
-
readonly required: readonly ["id", "
|
|
1622
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1122
1623
|
readonly additionalProperties: false;
|
|
1123
1624
|
};
|
|
1124
1625
|
export declare const PlatformQuotaSchema: {
|
|
@@ -1165,7 +1666,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1165
1666
|
readonly type: "array";
|
|
1166
1667
|
readonly items: {
|
|
1167
1668
|
readonly type: "string";
|
|
1168
|
-
readonly example: "northamerica-central-
|
|
1669
|
+
readonly example: "northamerica-central-1a";
|
|
1169
1670
|
};
|
|
1170
1671
|
readonly minItems: 1;
|
|
1171
1672
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1192,20 +1693,14 @@ export declare const PlatformQuotaSchema: {
|
|
|
1192
1693
|
readonly minItems: 1;
|
|
1193
1694
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1194
1695
|
};
|
|
1195
|
-
readonly
|
|
1696
|
+
readonly cfcr_storage_gb: {
|
|
1196
1697
|
readonly type: "integer";
|
|
1197
|
-
readonly minimum:
|
|
1198
|
-
readonly description: "
|
|
1199
|
-
readonly example:
|
|
1200
|
-
};
|
|
1201
|
-
readonly copilot_organization_hourly_tokens: {
|
|
1202
|
-
readonly type: "integer";
|
|
1203
|
-
readonly minimum: 0;
|
|
1204
|
-
readonly description: "Organization-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1205
|
-
readonly example: 242000;
|
|
1698
|
+
readonly minimum: -1;
|
|
1699
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1700
|
+
readonly example: 500;
|
|
1206
1701
|
};
|
|
1207
1702
|
};
|
|
1208
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "
|
|
1703
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1209
1704
|
readonly additionalProperties: false;
|
|
1210
1705
|
};
|
|
1211
1706
|
export declare const RegistryRepositorySchema: {
|
|
@@ -1224,7 +1719,7 @@ export declare const RegistryRepositorySchema: {
|
|
|
1224
1719
|
readonly uri: {
|
|
1225
1720
|
readonly type: "string";
|
|
1226
1721
|
readonly description: "Full URI of the repository.";
|
|
1227
|
-
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/
|
|
1722
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1228
1723
|
};
|
|
1229
1724
|
};
|
|
1230
1725
|
readonly required: readonly ["name", "region", "uri"];
|
|
@@ -1246,7 +1741,7 @@ export declare const RegistryRepositoryWithTagsSchema: {
|
|
|
1246
1741
|
readonly uri: {
|
|
1247
1742
|
readonly type: "string";
|
|
1248
1743
|
readonly description: "Full URI of the repository.";
|
|
1249
|
-
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/
|
|
1744
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1250
1745
|
};
|
|
1251
1746
|
readonly tags: {
|
|
1252
1747
|
readonly type: "array";
|
|
@@ -1269,6 +1764,14 @@ export declare const RegistryRepositoryWithTagsSchema: {
|
|
|
1269
1764
|
readonly description: "Media type of the manifest.";
|
|
1270
1765
|
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
1271
1766
|
};
|
|
1767
|
+
readonly platforms: {
|
|
1768
|
+
readonly type: "array";
|
|
1769
|
+
readonly items: {
|
|
1770
|
+
readonly type: "string";
|
|
1771
|
+
};
|
|
1772
|
+
readonly description: "Array of platform strings for multi-arch images (e.g., linux/amd64, linux/arm64).";
|
|
1773
|
+
readonly example: readonly ["linux/amd64", "linux/arm64"];
|
|
1774
|
+
};
|
|
1272
1775
|
};
|
|
1273
1776
|
readonly required: readonly ["name", "size"];
|
|
1274
1777
|
readonly additionalProperties: false;
|
|
@@ -1293,6 +1796,11 @@ export declare const RegistryTagSchema: {
|
|
|
1293
1796
|
readonly description: "Tag name.";
|
|
1294
1797
|
readonly example: "latest";
|
|
1295
1798
|
};
|
|
1799
|
+
readonly digest: {
|
|
1800
|
+
readonly type: "string";
|
|
1801
|
+
readonly description: "Manifest digest for pulling by digest.";
|
|
1802
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1803
|
+
};
|
|
1296
1804
|
readonly mediaType: {
|
|
1297
1805
|
readonly type: "string";
|
|
1298
1806
|
readonly description: "Media type of the manifest.";
|
|
@@ -1317,6 +1825,11 @@ export declare const RegistryTagSchema: {
|
|
|
1317
1825
|
readonly items: {
|
|
1318
1826
|
readonly type: "object";
|
|
1319
1827
|
readonly properties: {
|
|
1828
|
+
readonly digest: {
|
|
1829
|
+
readonly type: "string";
|
|
1830
|
+
readonly description: "Digest of the layer.";
|
|
1831
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1832
|
+
};
|
|
1320
1833
|
readonly size: {
|
|
1321
1834
|
readonly type: "number";
|
|
1322
1835
|
readonly format: "float";
|
|
@@ -1352,11 +1865,44 @@ export declare const RegistryTagSchema: {
|
|
|
1352
1865
|
readonly description: "Operating system of the platform.";
|
|
1353
1866
|
readonly example: "linux";
|
|
1354
1867
|
};
|
|
1868
|
+
readonly variant: {
|
|
1869
|
+
readonly type: "string";
|
|
1870
|
+
readonly description: "Variant of the platform (e.g., v7, v8 for ARM).";
|
|
1871
|
+
readonly example: "v8";
|
|
1872
|
+
};
|
|
1355
1873
|
};
|
|
1356
1874
|
readonly required: readonly ["architecture", "os"];
|
|
1357
1875
|
readonly additionalProperties: false;
|
|
1358
1876
|
readonly description: "Platform information for the manifest.";
|
|
1359
1877
|
};
|
|
1878
|
+
readonly layers: {
|
|
1879
|
+
readonly type: "array";
|
|
1880
|
+
readonly items: {
|
|
1881
|
+
readonly type: "object";
|
|
1882
|
+
readonly properties: {
|
|
1883
|
+
readonly digest: {
|
|
1884
|
+
readonly type: "string";
|
|
1885
|
+
readonly description: "Digest of the layer.";
|
|
1886
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1887
|
+
};
|
|
1888
|
+
readonly size: {
|
|
1889
|
+
readonly type: "number";
|
|
1890
|
+
readonly format: "float";
|
|
1891
|
+
readonly description: "Size of the layer in bytes.";
|
|
1892
|
+
readonly example: 5678;
|
|
1893
|
+
};
|
|
1894
|
+
};
|
|
1895
|
+
readonly required: readonly ["size"];
|
|
1896
|
+
readonly additionalProperties: false;
|
|
1897
|
+
};
|
|
1898
|
+
readonly description: "Layers for this platform.";
|
|
1899
|
+
};
|
|
1900
|
+
readonly size: {
|
|
1901
|
+
readonly type: "number";
|
|
1902
|
+
readonly format: "float";
|
|
1903
|
+
readonly description: "Total size of this platform manifest in bytes.";
|
|
1904
|
+
readonly example: 12345678;
|
|
1905
|
+
};
|
|
1360
1906
|
};
|
|
1361
1907
|
readonly required: readonly ["digest"];
|
|
1362
1908
|
readonly additionalProperties: false;
|
|
@@ -1385,7 +1931,408 @@ export declare const RegistryTagSchema: {
|
|
|
1385
1931
|
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app:latest";
|
|
1386
1932
|
};
|
|
1387
1933
|
};
|
|
1388
|
-
readonly required: readonly ["name", "size", "region", "repository", "uri"];
|
|
1934
|
+
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
1935
|
+
readonly additionalProperties: false;
|
|
1936
|
+
};
|
|
1937
|
+
export declare const TicketAttachmentSchema: {
|
|
1938
|
+
readonly type: "object";
|
|
1939
|
+
readonly properties: {
|
|
1940
|
+
readonly id: {
|
|
1941
|
+
readonly type: "string";
|
|
1942
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
1943
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1944
|
+
};
|
|
1945
|
+
readonly filename: {
|
|
1946
|
+
readonly type: "string";
|
|
1947
|
+
readonly description: "Original filename as uploaded.";
|
|
1948
|
+
readonly example: "debug.log";
|
|
1949
|
+
};
|
|
1950
|
+
readonly content_type: {
|
|
1951
|
+
readonly type: "string";
|
|
1952
|
+
readonly description: "MIME content type of the attachment.";
|
|
1953
|
+
readonly example: "text/plain";
|
|
1954
|
+
};
|
|
1955
|
+
readonly size: {
|
|
1956
|
+
readonly type: "integer";
|
|
1957
|
+
readonly description: "Size of the attachment in bytes.";
|
|
1958
|
+
readonly example: 12345;
|
|
1959
|
+
};
|
|
1960
|
+
};
|
|
1961
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1962
|
+
readonly additionalProperties: false;
|
|
1963
|
+
};
|
|
1964
|
+
export declare const TicketCreateInputSchema: {
|
|
1965
|
+
readonly type: "object";
|
|
1966
|
+
readonly properties: {
|
|
1967
|
+
readonly category: {
|
|
1968
|
+
readonly type: "string";
|
|
1969
|
+
readonly description: "Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.";
|
|
1970
|
+
readonly example: "technical";
|
|
1971
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
1972
|
+
};
|
|
1973
|
+
readonly body: {
|
|
1974
|
+
readonly type: "string";
|
|
1975
|
+
readonly maxLength: 50000;
|
|
1976
|
+
readonly minLength: 1;
|
|
1977
|
+
readonly pattern: "\\S";
|
|
1978
|
+
readonly description: "Initial message body in markdown. There is no separate subject — the first message body is the description.";
|
|
1979
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1980
|
+
};
|
|
1981
|
+
readonly properties: {
|
|
1982
|
+
readonly type: "object";
|
|
1983
|
+
readonly additionalProperties: true;
|
|
1984
|
+
readonly description: "Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).";
|
|
1985
|
+
readonly example: {
|
|
1986
|
+
readonly subcategory: "cluster-question";
|
|
1987
|
+
readonly cluster_id: "60c72b2f9f1b2c001f8e4d3a";
|
|
1988
|
+
};
|
|
1989
|
+
};
|
|
1990
|
+
};
|
|
1991
|
+
readonly required: readonly ["category", "body"];
|
|
1992
|
+
readonly additionalProperties: false;
|
|
1993
|
+
};
|
|
1994
|
+
export declare const TicketListResponseSchema: {
|
|
1995
|
+
readonly type: "object";
|
|
1996
|
+
readonly properties: {
|
|
1997
|
+
readonly items: {
|
|
1998
|
+
readonly type: "array";
|
|
1999
|
+
readonly items: {
|
|
2000
|
+
readonly type: "object";
|
|
2001
|
+
readonly properties: {
|
|
2002
|
+
readonly id: {
|
|
2003
|
+
readonly type: "string";
|
|
2004
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
2005
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
2006
|
+
};
|
|
2007
|
+
readonly status: {
|
|
2008
|
+
readonly type: "string";
|
|
2009
|
+
readonly description: "Current state of the ticket.";
|
|
2010
|
+
readonly example: "waiting_on_us";
|
|
2011
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
2012
|
+
};
|
|
2013
|
+
readonly category: {
|
|
2014
|
+
readonly type: "string";
|
|
2015
|
+
readonly description: "Ticket category.";
|
|
2016
|
+
readonly example: "technical";
|
|
2017
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2018
|
+
};
|
|
2019
|
+
readonly summary: {
|
|
2020
|
+
readonly type: "string";
|
|
2021
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
2022
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2023
|
+
};
|
|
2024
|
+
readonly closed_at: {
|
|
2025
|
+
readonly type: "string";
|
|
2026
|
+
readonly format: "date-time";
|
|
2027
|
+
readonly nullable: true;
|
|
2028
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2029
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
2030
|
+
};
|
|
2031
|
+
readonly date_created: {
|
|
2032
|
+
readonly type: "string";
|
|
2033
|
+
readonly format: "date-time";
|
|
2034
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
2035
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2036
|
+
};
|
|
2037
|
+
readonly date_updated: {
|
|
2038
|
+
readonly type: "string";
|
|
2039
|
+
readonly format: "date-time";
|
|
2040
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2041
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2042
|
+
};
|
|
2043
|
+
readonly messages: {
|
|
2044
|
+
readonly type: "array";
|
|
2045
|
+
readonly items: {
|
|
2046
|
+
readonly type: "object";
|
|
2047
|
+
readonly properties: {
|
|
2048
|
+
readonly id: {
|
|
2049
|
+
readonly type: "string";
|
|
2050
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2051
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2052
|
+
};
|
|
2053
|
+
readonly type: {
|
|
2054
|
+
readonly type: "string";
|
|
2055
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2056
|
+
readonly example: "customer_reply";
|
|
2057
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2058
|
+
};
|
|
2059
|
+
readonly body: {
|
|
2060
|
+
readonly type: "string";
|
|
2061
|
+
readonly description: "Message body in markdown.";
|
|
2062
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2063
|
+
};
|
|
2064
|
+
readonly author_first_name: {
|
|
2065
|
+
readonly type: "string";
|
|
2066
|
+
readonly nullable: true;
|
|
2067
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2068
|
+
readonly example: "Jane";
|
|
2069
|
+
};
|
|
2070
|
+
readonly author_last_name: {
|
|
2071
|
+
readonly type: "string";
|
|
2072
|
+
readonly nullable: true;
|
|
2073
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2074
|
+
readonly example: "Doe";
|
|
2075
|
+
};
|
|
2076
|
+
readonly attachments: {
|
|
2077
|
+
readonly type: "array";
|
|
2078
|
+
readonly items: {
|
|
2079
|
+
readonly type: "object";
|
|
2080
|
+
readonly properties: {
|
|
2081
|
+
readonly id: {
|
|
2082
|
+
readonly type: "string";
|
|
2083
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2084
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2085
|
+
};
|
|
2086
|
+
readonly filename: {
|
|
2087
|
+
readonly type: "string";
|
|
2088
|
+
readonly description: "Original filename as uploaded.";
|
|
2089
|
+
readonly example: "debug.log";
|
|
2090
|
+
};
|
|
2091
|
+
readonly content_type: {
|
|
2092
|
+
readonly type: "string";
|
|
2093
|
+
readonly description: "MIME content type of the attachment.";
|
|
2094
|
+
readonly example: "text/plain";
|
|
2095
|
+
};
|
|
2096
|
+
readonly size: {
|
|
2097
|
+
readonly type: "integer";
|
|
2098
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2099
|
+
readonly example: 12345;
|
|
2100
|
+
};
|
|
2101
|
+
};
|
|
2102
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2103
|
+
readonly additionalProperties: false;
|
|
2104
|
+
};
|
|
2105
|
+
readonly description: "Attachments associated with this message.";
|
|
2106
|
+
readonly example: readonly [];
|
|
2107
|
+
};
|
|
2108
|
+
readonly date_created: {
|
|
2109
|
+
readonly type: "string";
|
|
2110
|
+
readonly format: "date-time";
|
|
2111
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2112
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2113
|
+
};
|
|
2114
|
+
};
|
|
2115
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2116
|
+
readonly additionalProperties: false;
|
|
2117
|
+
};
|
|
2118
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
2119
|
+
};
|
|
2120
|
+
};
|
|
2121
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
2122
|
+
readonly additionalProperties: false;
|
|
2123
|
+
};
|
|
2124
|
+
readonly description: "Tickets for the organization, ordered newest first. Messages are omitted from list responses.";
|
|
2125
|
+
};
|
|
2126
|
+
};
|
|
2127
|
+
readonly required: readonly ["items"];
|
|
2128
|
+
readonly additionalProperties: false;
|
|
2129
|
+
};
|
|
2130
|
+
export declare const TicketMessageInputSchema: {
|
|
2131
|
+
readonly type: "object";
|
|
2132
|
+
readonly properties: {
|
|
2133
|
+
readonly body: {
|
|
2134
|
+
readonly type: "string";
|
|
2135
|
+
readonly maxLength: 50000;
|
|
2136
|
+
readonly minLength: 1;
|
|
2137
|
+
readonly pattern: "\\S";
|
|
2138
|
+
readonly description: "Reply body in markdown.";
|
|
2139
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2140
|
+
};
|
|
2141
|
+
};
|
|
2142
|
+
readonly required: readonly ["body"];
|
|
2143
|
+
readonly additionalProperties: false;
|
|
2144
|
+
};
|
|
2145
|
+
export declare const TicketMessageSchema: {
|
|
2146
|
+
readonly type: "object";
|
|
2147
|
+
readonly properties: {
|
|
2148
|
+
readonly id: {
|
|
2149
|
+
readonly type: "string";
|
|
2150
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2151
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2152
|
+
};
|
|
2153
|
+
readonly type: {
|
|
2154
|
+
readonly type: "string";
|
|
2155
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2156
|
+
readonly example: "customer_reply";
|
|
2157
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2158
|
+
};
|
|
2159
|
+
readonly body: {
|
|
2160
|
+
readonly type: "string";
|
|
2161
|
+
readonly description: "Message body in markdown.";
|
|
2162
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2163
|
+
};
|
|
2164
|
+
readonly author_first_name: {
|
|
2165
|
+
readonly type: "string";
|
|
2166
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2167
|
+
readonly example: "Jane";
|
|
2168
|
+
};
|
|
2169
|
+
readonly author_last_name: {
|
|
2170
|
+
readonly type: "string";
|
|
2171
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2172
|
+
readonly example: "Doe";
|
|
2173
|
+
};
|
|
2174
|
+
readonly attachments: {
|
|
2175
|
+
readonly type: "array";
|
|
2176
|
+
readonly items: {
|
|
2177
|
+
readonly type: "object";
|
|
2178
|
+
readonly properties: {
|
|
2179
|
+
readonly id: {
|
|
2180
|
+
readonly type: "string";
|
|
2181
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2182
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2183
|
+
};
|
|
2184
|
+
readonly filename: {
|
|
2185
|
+
readonly type: "string";
|
|
2186
|
+
readonly description: "Original filename as uploaded.";
|
|
2187
|
+
readonly example: "debug.log";
|
|
2188
|
+
};
|
|
2189
|
+
readonly content_type: {
|
|
2190
|
+
readonly type: "string";
|
|
2191
|
+
readonly description: "MIME content type of the attachment.";
|
|
2192
|
+
readonly example: "text/plain";
|
|
2193
|
+
};
|
|
2194
|
+
readonly size: {
|
|
2195
|
+
readonly type: "integer";
|
|
2196
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2197
|
+
readonly example: 12345;
|
|
2198
|
+
};
|
|
2199
|
+
};
|
|
2200
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2201
|
+
readonly additionalProperties: false;
|
|
2202
|
+
};
|
|
2203
|
+
readonly description: "Attachments associated with this message.";
|
|
2204
|
+
readonly example: readonly [];
|
|
2205
|
+
};
|
|
2206
|
+
readonly date_created: {
|
|
2207
|
+
readonly type: "string";
|
|
2208
|
+
readonly format: "date-time";
|
|
2209
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2210
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2211
|
+
};
|
|
2212
|
+
};
|
|
2213
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2214
|
+
readonly additionalProperties: false;
|
|
2215
|
+
};
|
|
2216
|
+
export declare const TicketSchema: {
|
|
2217
|
+
readonly type: "object";
|
|
2218
|
+
readonly properties: {
|
|
2219
|
+
readonly id: {
|
|
2220
|
+
readonly type: "string";
|
|
2221
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
2222
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
2223
|
+
};
|
|
2224
|
+
readonly status: {
|
|
2225
|
+
readonly type: "string";
|
|
2226
|
+
readonly description: "Current state of the ticket.";
|
|
2227
|
+
readonly example: "waiting_on_us";
|
|
2228
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
2229
|
+
};
|
|
2230
|
+
readonly category: {
|
|
2231
|
+
readonly type: "string";
|
|
2232
|
+
readonly description: "Ticket category.";
|
|
2233
|
+
readonly example: "technical";
|
|
2234
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2235
|
+
};
|
|
2236
|
+
readonly summary: {
|
|
2237
|
+
readonly type: "string";
|
|
2238
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
2239
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2240
|
+
};
|
|
2241
|
+
readonly closed_at: {
|
|
2242
|
+
readonly type: "string";
|
|
2243
|
+
readonly format: "date-time";
|
|
2244
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2245
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
2246
|
+
};
|
|
2247
|
+
readonly date_created: {
|
|
2248
|
+
readonly type: "string";
|
|
2249
|
+
readonly format: "date-time";
|
|
2250
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
2251
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2252
|
+
};
|
|
2253
|
+
readonly date_updated: {
|
|
2254
|
+
readonly type: "string";
|
|
2255
|
+
readonly format: "date-time";
|
|
2256
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2257
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2258
|
+
};
|
|
2259
|
+
readonly messages: {
|
|
2260
|
+
readonly type: "array";
|
|
2261
|
+
readonly items: {
|
|
2262
|
+
readonly type: "object";
|
|
2263
|
+
readonly properties: {
|
|
2264
|
+
readonly id: {
|
|
2265
|
+
readonly type: "string";
|
|
2266
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2267
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2268
|
+
};
|
|
2269
|
+
readonly type: {
|
|
2270
|
+
readonly type: "string";
|
|
2271
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2272
|
+
readonly example: "customer_reply";
|
|
2273
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2274
|
+
};
|
|
2275
|
+
readonly body: {
|
|
2276
|
+
readonly type: "string";
|
|
2277
|
+
readonly description: "Message body in markdown.";
|
|
2278
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2279
|
+
};
|
|
2280
|
+
readonly author_first_name: {
|
|
2281
|
+
readonly type: "string";
|
|
2282
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2283
|
+
readonly example: "Jane";
|
|
2284
|
+
};
|
|
2285
|
+
readonly author_last_name: {
|
|
2286
|
+
readonly type: "string";
|
|
2287
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2288
|
+
readonly example: "Doe";
|
|
2289
|
+
};
|
|
2290
|
+
readonly attachments: {
|
|
2291
|
+
readonly type: "array";
|
|
2292
|
+
readonly items: {
|
|
2293
|
+
readonly type: "object";
|
|
2294
|
+
readonly properties: {
|
|
2295
|
+
readonly id: {
|
|
2296
|
+
readonly type: "string";
|
|
2297
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2298
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2299
|
+
};
|
|
2300
|
+
readonly filename: {
|
|
2301
|
+
readonly type: "string";
|
|
2302
|
+
readonly description: "Original filename as uploaded.";
|
|
2303
|
+
readonly example: "debug.log";
|
|
2304
|
+
};
|
|
2305
|
+
readonly content_type: {
|
|
2306
|
+
readonly type: "string";
|
|
2307
|
+
readonly description: "MIME content type of the attachment.";
|
|
2308
|
+
readonly example: "text/plain";
|
|
2309
|
+
};
|
|
2310
|
+
readonly size: {
|
|
2311
|
+
readonly type: "integer";
|
|
2312
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2313
|
+
readonly example: 12345;
|
|
2314
|
+
};
|
|
2315
|
+
};
|
|
2316
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2317
|
+
readonly additionalProperties: false;
|
|
2318
|
+
};
|
|
2319
|
+
readonly description: "Attachments associated with this message.";
|
|
2320
|
+
readonly example: readonly [];
|
|
2321
|
+
};
|
|
2322
|
+
readonly date_created: {
|
|
2323
|
+
readonly type: "string";
|
|
2324
|
+
readonly format: "date-time";
|
|
2325
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2326
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2327
|
+
};
|
|
2328
|
+
};
|
|
2329
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2330
|
+
readonly additionalProperties: false;
|
|
2331
|
+
};
|
|
2332
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
2333
|
+
};
|
|
2334
|
+
};
|
|
2335
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1389
2336
|
readonly additionalProperties: false;
|
|
1390
2337
|
};
|
|
1391
2338
|
export declare const TokenCreateInputSchema: {
|
|
@@ -1634,18 +2581,6 @@ export declare const UserCreateInputSchema: {
|
|
|
1634
2581
|
readonly minLength: 8;
|
|
1635
2582
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
1636
2583
|
};
|
|
1637
|
-
readonly status: {
|
|
1638
|
-
readonly type: "string";
|
|
1639
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
1640
|
-
readonly example: "active";
|
|
1641
|
-
readonly enum: readonly ["active", "inactive"];
|
|
1642
|
-
};
|
|
1643
|
-
readonly role: {
|
|
1644
|
-
readonly type: "string";
|
|
1645
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
1646
|
-
readonly example: "User";
|
|
1647
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
1648
|
-
};
|
|
1649
2584
|
};
|
|
1650
2585
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
1651
2586
|
readonly additionalProperties: false;
|