@cloudfleet/sdk 0.0.1-6d7ad01 → 0.0.1-6e4e1f8
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 +1026 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1194 -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 +1195 -145
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +2630 -215
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +258 -191
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +367 -370
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +8 -8
- package/dist/types.gen.d.ts +1583 -691
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3543 -1424
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1438 -631
- 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,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\", \"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"];
|
|
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";
|
|
@@ -306,11 +387,26 @@ 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.";
|
|
312
403
|
readonly example: "tskey-auth-kBV8wr1dk911CNTRL-...";
|
|
313
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
|
+
};
|
|
314
410
|
readonly bootstrap_token: {
|
|
315
411
|
readonly type: "string";
|
|
316
412
|
readonly description: "Bootstrap token for the cluster.";
|
|
@@ -368,7 +464,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
368
464
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
369
465
|
};
|
|
370
466
|
};
|
|
371
|
-
readonly required: readonly ["certificate_authority", "endpoint", "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"];
|
|
372
468
|
readonly additionalProperties: false;
|
|
373
469
|
};
|
|
374
470
|
export declare const ClusterSchema: {
|
|
@@ -385,15 +481,100 @@ export declare const ClusterSchema: {
|
|
|
385
481
|
readonly tier: {
|
|
386
482
|
readonly type: "string";
|
|
387
483
|
readonly description: "Tier of the cluster.";
|
|
484
|
+
readonly default: "basic";
|
|
388
485
|
readonly example: "pro";
|
|
389
|
-
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
|
+
};
|
|
390
534
|
};
|
|
391
535
|
readonly region: {
|
|
392
536
|
readonly type: "string";
|
|
393
|
-
readonly description: "Cloudfleet control plane region.
|
|
394
|
-
readonly
|
|
395
|
-
|
|
396
|
-
|
|
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
|
+
};
|
|
397
578
|
};
|
|
398
579
|
readonly id: {
|
|
399
580
|
readonly type: "string";
|
|
@@ -403,16 +584,27 @@ export declare const ClusterSchema: {
|
|
|
403
584
|
};
|
|
404
585
|
readonly status: {
|
|
405
586
|
readonly type: "string";
|
|
406
|
-
readonly description: "Status of the cluster.
|
|
407
|
-
readonly example: "
|
|
408
|
-
readonly enum: readonly ["
|
|
587
|
+
readonly description: "Status of the cluster.";
|
|
588
|
+
readonly example: "deployed";
|
|
589
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
409
590
|
};
|
|
410
591
|
readonly endpoint: {
|
|
411
592
|
readonly anyOf: readonly [{
|
|
412
593
|
readonly type: "string";
|
|
413
594
|
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.
|
|
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";
|
|
416
608
|
}, {
|
|
417
609
|
readonly type: "string";
|
|
418
610
|
readonly enum: readonly [""];
|
|
@@ -443,15 +635,10 @@ export declare const ClusterSchema: {
|
|
|
443
635
|
readonly description: "Indicates if the cluster is ready to be used.";
|
|
444
636
|
readonly example: true;
|
|
445
637
|
};
|
|
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
638
|
};
|
|
453
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
639
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
454
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.";
|
|
455
642
|
};
|
|
456
643
|
export declare const ClusterUpdateInputSchema: {
|
|
457
644
|
readonly type: "object";
|
|
@@ -467,18 +654,60 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
467
654
|
readonly tier: {
|
|
468
655
|
readonly type: "string";
|
|
469
656
|
readonly description: "Tier of the cluster.";
|
|
657
|
+
readonly default: "basic";
|
|
470
658
|
readonly example: "pro";
|
|
471
|
-
readonly enum: readonly ["basic", "pro"];
|
|
659
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
472
660
|
};
|
|
473
661
|
readonly version_channel: {
|
|
474
662
|
readonly type: "string";
|
|
475
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-]+)*))?$";
|
|
476
664
|
readonly description: "Version of the kubernetes cluster.";
|
|
665
|
+
readonly default: "1.x.x-cfke.x";
|
|
477
666
|
readonly example: "1.x.x-cfke.x";
|
|
478
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
|
+
};
|
|
479
707
|
};
|
|
480
|
-
readonly required: readonly ["
|
|
708
|
+
readonly required: readonly ["name"];
|
|
481
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.";
|
|
482
711
|
};
|
|
483
712
|
export declare const FleetCreateInputSchema: {
|
|
484
713
|
readonly type: "object";
|
|
@@ -487,13 +716,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
487
716
|
readonly type: "object";
|
|
488
717
|
readonly properties: {
|
|
489
718
|
readonly cpu: {
|
|
490
|
-
readonly type: "
|
|
491
|
-
readonly format: "float";
|
|
719
|
+
readonly type: "integer";
|
|
492
720
|
readonly minimum: 0;
|
|
493
|
-
readonly
|
|
721
|
+
readonly maximum: 100000;
|
|
722
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
494
723
|
};
|
|
495
724
|
};
|
|
496
|
-
readonly required: readonly ["cpu"];
|
|
497
725
|
readonly additionalProperties: false;
|
|
498
726
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
499
727
|
};
|
|
@@ -502,14 +730,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
502
730
|
readonly properties: {
|
|
503
731
|
readonly enabled: {
|
|
504
732
|
readonly type: "boolean";
|
|
505
|
-
readonly default: true;
|
|
506
733
|
};
|
|
507
734
|
readonly project: {
|
|
508
735
|
readonly type: "string";
|
|
509
|
-
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";
|
|
510
739
|
};
|
|
511
740
|
};
|
|
512
|
-
readonly required: readonly ["
|
|
741
|
+
readonly required: readonly ["enabled"];
|
|
513
742
|
readonly additionalProperties: false;
|
|
514
743
|
};
|
|
515
744
|
readonly hetzner: {
|
|
@@ -517,14 +746,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
517
746
|
readonly properties: {
|
|
518
747
|
readonly enabled: {
|
|
519
748
|
readonly type: "boolean";
|
|
520
|
-
readonly default: true;
|
|
521
749
|
};
|
|
522
750
|
readonly apiKey: {
|
|
523
751
|
readonly type: "string";
|
|
524
|
-
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.";
|
|
525
756
|
};
|
|
526
757
|
};
|
|
527
|
-
readonly required: readonly ["
|
|
758
|
+
readonly required: readonly ["enabled"];
|
|
528
759
|
readonly additionalProperties: false;
|
|
529
760
|
};
|
|
530
761
|
readonly aws: {
|
|
@@ -532,16 +763,106 @@ export declare const FleetCreateInputSchema: {
|
|
|
532
763
|
readonly properties: {
|
|
533
764
|
readonly enabled: {
|
|
534
765
|
readonly type: "boolean";
|
|
535
|
-
readonly default: true;
|
|
536
766
|
};
|
|
537
767
|
readonly controllerRoleArn: {
|
|
538
768
|
readonly type: "string";
|
|
539
|
-
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";
|
|
540
772
|
};
|
|
541
773
|
};
|
|
542
|
-
readonly required: readonly ["
|
|
774
|
+
readonly required: readonly ["enabled"];
|
|
543
775
|
readonly additionalProperties: false;
|
|
544
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 [];
|
|
817
|
+
};
|
|
818
|
+
};
|
|
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"];
|
|
834
|
+
};
|
|
835
|
+
readonly taints: {
|
|
836
|
+
readonly type: "array";
|
|
837
|
+
readonly items: {
|
|
838
|
+
readonly type: "object";
|
|
839
|
+
readonly properties: {
|
|
840
|
+
readonly key: {
|
|
841
|
+
readonly type: "string";
|
|
842
|
+
readonly description: "Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.";
|
|
843
|
+
readonly example: "dedicated";
|
|
844
|
+
};
|
|
845
|
+
readonly value: {
|
|
846
|
+
readonly type: "string";
|
|
847
|
+
readonly maxLength: 63;
|
|
848
|
+
readonly pattern: "^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$";
|
|
849
|
+
readonly description: "Taint value. Optional.";
|
|
850
|
+
readonly example: "ci";
|
|
851
|
+
};
|
|
852
|
+
readonly effect: {
|
|
853
|
+
readonly type: "string";
|
|
854
|
+
readonly description: "Taint effect.";
|
|
855
|
+
readonly example: "NoSchedule";
|
|
856
|
+
readonly enum: readonly ["NoSchedule", "PreferNoSchedule", "NoExecute"];
|
|
857
|
+
};
|
|
858
|
+
};
|
|
859
|
+
readonly required: readonly ["key", "effect"];
|
|
860
|
+
readonly additionalProperties: false;
|
|
861
|
+
};
|
|
862
|
+
readonly maxItems: 50;
|
|
863
|
+
readonly description: "Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.";
|
|
864
|
+
readonly default: readonly [];
|
|
865
|
+
};
|
|
545
866
|
readonly id: {
|
|
546
867
|
readonly type: "string";
|
|
547
868
|
readonly maxLength: 63;
|
|
@@ -553,6 +874,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
553
874
|
};
|
|
554
875
|
readonly required: readonly ["id"];
|
|
555
876
|
readonly additionalProperties: false;
|
|
877
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
556
878
|
};
|
|
557
879
|
export declare const FleetSchema: {
|
|
558
880
|
readonly type: "object";
|
|
@@ -561,13 +883,12 @@ export declare const FleetSchema: {
|
|
|
561
883
|
readonly type: "object";
|
|
562
884
|
readonly properties: {
|
|
563
885
|
readonly cpu: {
|
|
564
|
-
readonly type: "
|
|
565
|
-
readonly format: "float";
|
|
886
|
+
readonly type: "integer";
|
|
566
887
|
readonly minimum: 0;
|
|
567
|
-
readonly
|
|
888
|
+
readonly maximum: 100000;
|
|
889
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
568
890
|
};
|
|
569
891
|
};
|
|
570
|
-
readonly required: readonly ["cpu"];
|
|
571
892
|
readonly additionalProperties: false;
|
|
572
893
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
573
894
|
};
|
|
@@ -576,14 +897,15 @@ export declare const FleetSchema: {
|
|
|
576
897
|
readonly properties: {
|
|
577
898
|
readonly enabled: {
|
|
578
899
|
readonly type: "boolean";
|
|
579
|
-
readonly default: true;
|
|
580
900
|
};
|
|
581
901
|
readonly project: {
|
|
582
902
|
readonly type: "string";
|
|
583
|
-
readonly
|
|
903
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
904
|
+
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.";
|
|
905
|
+
readonly example: "my-cloudfleet-project";
|
|
584
906
|
};
|
|
585
907
|
};
|
|
586
|
-
readonly required: readonly ["
|
|
908
|
+
readonly required: readonly ["enabled"];
|
|
587
909
|
readonly additionalProperties: false;
|
|
588
910
|
};
|
|
589
911
|
readonly hetzner: {
|
|
@@ -591,14 +913,14 @@ export declare const FleetSchema: {
|
|
|
591
913
|
readonly properties: {
|
|
592
914
|
readonly enabled: {
|
|
593
915
|
readonly type: "boolean";
|
|
594
|
-
readonly default: true;
|
|
595
916
|
};
|
|
596
917
|
readonly apiKey: {
|
|
597
918
|
readonly type: "string";
|
|
598
|
-
readonly
|
|
919
|
+
readonly pattern: "^\\*{64}$";
|
|
920
|
+
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
921
|
};
|
|
600
922
|
};
|
|
601
|
-
readonly required: readonly ["
|
|
923
|
+
readonly required: readonly ["enabled"];
|
|
602
924
|
readonly additionalProperties: false;
|
|
603
925
|
};
|
|
604
926
|
readonly aws: {
|
|
@@ -606,16 +928,107 @@ export declare const FleetSchema: {
|
|
|
606
928
|
readonly properties: {
|
|
607
929
|
readonly enabled: {
|
|
608
930
|
readonly type: "boolean";
|
|
609
|
-
readonly default: true;
|
|
610
931
|
};
|
|
611
932
|
readonly controllerRoleArn: {
|
|
612
933
|
readonly type: "string";
|
|
613
|
-
readonly
|
|
934
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
935
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
936
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
614
937
|
};
|
|
615
938
|
};
|
|
616
|
-
readonly required: readonly ["
|
|
939
|
+
readonly required: readonly ["enabled"];
|
|
617
940
|
readonly additionalProperties: false;
|
|
618
941
|
};
|
|
942
|
+
readonly constraints: {
|
|
943
|
+
readonly type: "object";
|
|
944
|
+
readonly properties: {
|
|
945
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
946
|
+
readonly type: "array";
|
|
947
|
+
readonly items: {
|
|
948
|
+
readonly type: "string";
|
|
949
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
950
|
+
};
|
|
951
|
+
readonly minItems: 1;
|
|
952
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
953
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
954
|
+
};
|
|
955
|
+
readonly 'kubernetes.io/arch': {
|
|
956
|
+
readonly type: "array";
|
|
957
|
+
readonly items: {
|
|
958
|
+
readonly type: "string";
|
|
959
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
960
|
+
};
|
|
961
|
+
readonly minItems: 1;
|
|
962
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
963
|
+
readonly default: readonly ["amd64"];
|
|
964
|
+
};
|
|
965
|
+
readonly 'cfke.io/instance-family': {
|
|
966
|
+
readonly type: "array";
|
|
967
|
+
readonly items: {
|
|
968
|
+
readonly type: "string";
|
|
969
|
+
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"];
|
|
970
|
+
};
|
|
971
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
972
|
+
readonly default: readonly [];
|
|
973
|
+
};
|
|
974
|
+
readonly 'topology.kubernetes.io/region': {
|
|
975
|
+
readonly type: "array";
|
|
976
|
+
readonly items: {
|
|
977
|
+
readonly type: "string";
|
|
978
|
+
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"];
|
|
979
|
+
};
|
|
980
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
981
|
+
readonly default: readonly [];
|
|
982
|
+
};
|
|
983
|
+
};
|
|
984
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
985
|
+
readonly additionalProperties: false;
|
|
986
|
+
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.";
|
|
987
|
+
readonly default: {
|
|
988
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
989
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
990
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
991
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
992
|
+
};
|
|
993
|
+
};
|
|
994
|
+
readonly scalingProfile: {
|
|
995
|
+
readonly type: "string";
|
|
996
|
+
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`).";
|
|
997
|
+
readonly default: "conservative";
|
|
998
|
+
readonly example: "conservative";
|
|
999
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
1000
|
+
};
|
|
1001
|
+
readonly taints: {
|
|
1002
|
+
readonly type: "array";
|
|
1003
|
+
readonly items: {
|
|
1004
|
+
readonly type: "object";
|
|
1005
|
+
readonly properties: {
|
|
1006
|
+
readonly key: {
|
|
1007
|
+
readonly type: "string";
|
|
1008
|
+
readonly description: "Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.";
|
|
1009
|
+
readonly example: "dedicated";
|
|
1010
|
+
};
|
|
1011
|
+
readonly value: {
|
|
1012
|
+
readonly type: "string";
|
|
1013
|
+
readonly maxLength: 63;
|
|
1014
|
+
readonly pattern: "^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$";
|
|
1015
|
+
readonly description: "Taint value. Optional.";
|
|
1016
|
+
readonly example: "ci";
|
|
1017
|
+
};
|
|
1018
|
+
readonly effect: {
|
|
1019
|
+
readonly type: "string";
|
|
1020
|
+
readonly description: "Taint effect.";
|
|
1021
|
+
readonly example: "NoSchedule";
|
|
1022
|
+
readonly enum: readonly ["NoSchedule", "PreferNoSchedule", "NoExecute"];
|
|
1023
|
+
};
|
|
1024
|
+
};
|
|
1025
|
+
readonly required: readonly ["key", "effect"];
|
|
1026
|
+
readonly additionalProperties: false;
|
|
1027
|
+
};
|
|
1028
|
+
readonly maxItems: 50;
|
|
1029
|
+
readonly description: "Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.";
|
|
1030
|
+
readonly default: readonly [];
|
|
1031
|
+
};
|
|
619
1032
|
readonly id: {
|
|
620
1033
|
readonly type: "string";
|
|
621
1034
|
readonly maxLength: 63;
|
|
@@ -624,9 +1037,30 @@ export declare const FleetSchema: {
|
|
|
624
1037
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
625
1038
|
readonly example: "new-clouds-fleet";
|
|
626
1039
|
};
|
|
1040
|
+
readonly ready: {
|
|
1041
|
+
readonly type: "boolean";
|
|
1042
|
+
readonly description: "Indicates whether the fleet configuration is healthy.";
|
|
1043
|
+
readonly example: true;
|
|
1044
|
+
};
|
|
1045
|
+
readonly status_message: {
|
|
1046
|
+
readonly type: "string";
|
|
1047
|
+
readonly description: "Human-readable reason the fleet is not ready. Present only when `ready` is false.";
|
|
1048
|
+
readonly example: "Invalid provider permissions.";
|
|
1049
|
+
};
|
|
1050
|
+
readonly created_at: {
|
|
1051
|
+
readonly type: "string";
|
|
1052
|
+
readonly description: "Creation date and time of the fleet.";
|
|
1053
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1054
|
+
};
|
|
1055
|
+
readonly updated_at: {
|
|
1056
|
+
readonly type: "string";
|
|
1057
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
1058
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1059
|
+
};
|
|
627
1060
|
};
|
|
628
|
-
readonly required: readonly ["id"];
|
|
1061
|
+
readonly required: readonly ["constraints", "scalingProfile", "taints", "id", "ready", "created_at", "updated_at"];
|
|
629
1062
|
readonly additionalProperties: false;
|
|
1063
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
630
1064
|
};
|
|
631
1065
|
export declare const FleetUpdateInputSchema: {
|
|
632
1066
|
readonly type: "object";
|
|
@@ -635,13 +1069,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
635
1069
|
readonly type: "object";
|
|
636
1070
|
readonly properties: {
|
|
637
1071
|
readonly cpu: {
|
|
638
|
-
readonly type: "
|
|
639
|
-
readonly format: "float";
|
|
1072
|
+
readonly type: "integer";
|
|
640
1073
|
readonly minimum: 0;
|
|
641
|
-
readonly
|
|
1074
|
+
readonly maximum: 100000;
|
|
1075
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
642
1076
|
};
|
|
643
1077
|
};
|
|
644
|
-
readonly required: readonly ["cpu"];
|
|
645
1078
|
readonly additionalProperties: false;
|
|
646
1079
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
647
1080
|
};
|
|
@@ -650,14 +1083,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
650
1083
|
readonly properties: {
|
|
651
1084
|
readonly enabled: {
|
|
652
1085
|
readonly type: "boolean";
|
|
653
|
-
readonly default: true;
|
|
654
1086
|
};
|
|
655
1087
|
readonly project: {
|
|
656
1088
|
readonly type: "string";
|
|
657
|
-
readonly
|
|
1089
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
1090
|
+
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.";
|
|
1091
|
+
readonly example: "my-cloudfleet-project";
|
|
658
1092
|
};
|
|
659
1093
|
};
|
|
660
|
-
readonly required: readonly ["
|
|
1094
|
+
readonly required: readonly ["enabled"];
|
|
661
1095
|
readonly additionalProperties: false;
|
|
662
1096
|
};
|
|
663
1097
|
readonly hetzner: {
|
|
@@ -665,14 +1099,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
665
1099
|
readonly properties: {
|
|
666
1100
|
readonly enabled: {
|
|
667
1101
|
readonly type: "boolean";
|
|
668
|
-
readonly default: true;
|
|
669
1102
|
};
|
|
670
1103
|
readonly apiKey: {
|
|
671
1104
|
readonly type: "string";
|
|
672
|
-
readonly
|
|
1105
|
+
readonly maxLength: 64;
|
|
1106
|
+
readonly minLength: 64;
|
|
1107
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
1108
|
+
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.";
|
|
673
1109
|
};
|
|
674
1110
|
};
|
|
675
|
-
readonly required: readonly ["
|
|
1111
|
+
readonly required: readonly ["enabled"];
|
|
676
1112
|
readonly additionalProperties: false;
|
|
677
1113
|
};
|
|
678
1114
|
readonly aws: {
|
|
@@ -680,17 +1116,128 @@ export declare const FleetUpdateInputSchema: {
|
|
|
680
1116
|
readonly properties: {
|
|
681
1117
|
readonly enabled: {
|
|
682
1118
|
readonly type: "boolean";
|
|
683
|
-
readonly default: true;
|
|
684
1119
|
};
|
|
685
1120
|
readonly controllerRoleArn: {
|
|
686
1121
|
readonly type: "string";
|
|
687
|
-
readonly
|
|
1122
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
1123
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
1124
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
688
1125
|
};
|
|
689
1126
|
};
|
|
690
|
-
readonly required: readonly ["
|
|
1127
|
+
readonly required: readonly ["enabled"];
|
|
691
1128
|
readonly additionalProperties: false;
|
|
692
1129
|
};
|
|
1130
|
+
readonly constraints: {
|
|
1131
|
+
readonly type: "object";
|
|
1132
|
+
readonly properties: {
|
|
1133
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
1134
|
+
readonly type: "array";
|
|
1135
|
+
readonly items: {
|
|
1136
|
+
readonly type: "string";
|
|
1137
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
1138
|
+
};
|
|
1139
|
+
readonly minItems: 1;
|
|
1140
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1141
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
1142
|
+
};
|
|
1143
|
+
readonly 'kubernetes.io/arch': {
|
|
1144
|
+
readonly type: "array";
|
|
1145
|
+
readonly items: {
|
|
1146
|
+
readonly type: "string";
|
|
1147
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
1148
|
+
};
|
|
1149
|
+
readonly minItems: 1;
|
|
1150
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1151
|
+
readonly default: readonly ["amd64"];
|
|
1152
|
+
};
|
|
1153
|
+
readonly 'cfke.io/instance-family': {
|
|
1154
|
+
readonly type: "array";
|
|
1155
|
+
readonly items: {
|
|
1156
|
+
readonly type: "string";
|
|
1157
|
+
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"];
|
|
1158
|
+
};
|
|
1159
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1160
|
+
readonly default: readonly [];
|
|
1161
|
+
};
|
|
1162
|
+
readonly 'topology.kubernetes.io/region': {
|
|
1163
|
+
readonly type: "array";
|
|
1164
|
+
readonly items: {
|
|
1165
|
+
readonly type: "string";
|
|
1166
|
+
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"];
|
|
1167
|
+
};
|
|
1168
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1169
|
+
readonly default: readonly [];
|
|
1170
|
+
};
|
|
1171
|
+
};
|
|
1172
|
+
readonly additionalProperties: false;
|
|
1173
|
+
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.";
|
|
1174
|
+
readonly default: {
|
|
1175
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1176
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1177
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1178
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1179
|
+
};
|
|
1180
|
+
};
|
|
1181
|
+
readonly scalingProfile: {
|
|
1182
|
+
readonly type: "string";
|
|
1183
|
+
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`).";
|
|
1184
|
+
readonly default: "conservative";
|
|
1185
|
+
readonly example: "conservative";
|
|
1186
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
1187
|
+
};
|
|
1188
|
+
readonly taints: {
|
|
1189
|
+
readonly type: "array";
|
|
1190
|
+
readonly items: {
|
|
1191
|
+
readonly type: "object";
|
|
1192
|
+
readonly properties: {
|
|
1193
|
+
readonly key: {
|
|
1194
|
+
readonly type: "string";
|
|
1195
|
+
readonly description: "Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.";
|
|
1196
|
+
readonly example: "dedicated";
|
|
1197
|
+
};
|
|
1198
|
+
readonly value: {
|
|
1199
|
+
readonly type: "string";
|
|
1200
|
+
readonly maxLength: 63;
|
|
1201
|
+
readonly pattern: "^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$";
|
|
1202
|
+
readonly description: "Taint value. Optional.";
|
|
1203
|
+
readonly example: "ci";
|
|
1204
|
+
};
|
|
1205
|
+
readonly effect: {
|
|
1206
|
+
readonly type: "string";
|
|
1207
|
+
readonly description: "Taint effect.";
|
|
1208
|
+
readonly example: "NoSchedule";
|
|
1209
|
+
readonly enum: readonly ["NoSchedule", "PreferNoSchedule", "NoExecute"];
|
|
1210
|
+
};
|
|
1211
|
+
};
|
|
1212
|
+
readonly required: readonly ["key", "effect"];
|
|
1213
|
+
readonly additionalProperties: false;
|
|
1214
|
+
};
|
|
1215
|
+
readonly maxItems: 50;
|
|
1216
|
+
readonly description: "Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.";
|
|
1217
|
+
readonly default: readonly [];
|
|
1218
|
+
};
|
|
1219
|
+
};
|
|
1220
|
+
readonly additionalProperties: false;
|
|
1221
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
1222
|
+
};
|
|
1223
|
+
export declare const InviteCreateInputSchema: {
|
|
1224
|
+
readonly type: "object";
|
|
1225
|
+
readonly properties: {
|
|
1226
|
+
readonly email: {
|
|
1227
|
+
readonly type: "string";
|
|
1228
|
+
readonly format: "email";
|
|
1229
|
+
readonly description: "Email address of the user to invite.";
|
|
1230
|
+
readonly example: "email@example.com";
|
|
1231
|
+
};
|
|
1232
|
+
readonly role: {
|
|
1233
|
+
readonly type: "string";
|
|
1234
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1235
|
+
readonly default: "User";
|
|
1236
|
+
readonly example: "User";
|
|
1237
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1238
|
+
};
|
|
693
1239
|
};
|
|
1240
|
+
readonly required: readonly ["email"];
|
|
694
1241
|
readonly additionalProperties: false;
|
|
695
1242
|
};
|
|
696
1243
|
export declare const InviteSchema: {
|
|
@@ -715,17 +1262,148 @@ export declare const InviteSchema: {
|
|
|
715
1262
|
};
|
|
716
1263
|
readonly email: {
|
|
717
1264
|
readonly type: "string";
|
|
718
|
-
readonly format: "email";
|
|
719
|
-
readonly description: "User email address.";
|
|
720
|
-
readonly example: "email@example.com";
|
|
1265
|
+
readonly format: "email";
|
|
1266
|
+
readonly description: "User email address.";
|
|
1267
|
+
readonly example: "email@example.com";
|
|
1268
|
+
};
|
|
1269
|
+
readonly code: {
|
|
1270
|
+
readonly type: "string";
|
|
1271
|
+
readonly description: "Generated unique invite code.";
|
|
1272
|
+
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
1273
|
+
};
|
|
1274
|
+
readonly role: {
|
|
1275
|
+
readonly type: "string";
|
|
1276
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1277
|
+
readonly default: "User";
|
|
1278
|
+
readonly example: "User";
|
|
1279
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1280
|
+
};
|
|
1281
|
+
};
|
|
1282
|
+
readonly required: readonly ["date_created"];
|
|
1283
|
+
readonly additionalProperties: false;
|
|
1284
|
+
};
|
|
1285
|
+
export declare const InvoicePaymentAttemptSchema: {
|
|
1286
|
+
readonly type: "object";
|
|
1287
|
+
readonly properties: {
|
|
1288
|
+
readonly invoice_id: {
|
|
1289
|
+
readonly type: "string";
|
|
1290
|
+
readonly description: "Identifier of the invoice.";
|
|
1291
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
1292
|
+
};
|
|
1293
|
+
readonly number: {
|
|
1294
|
+
readonly type: "string";
|
|
1295
|
+
readonly nullable: true;
|
|
1296
|
+
readonly description: "Invoice number. Null if the invoice has no number.";
|
|
1297
|
+
readonly example: "CF-0042";
|
|
1298
|
+
};
|
|
1299
|
+
readonly amount: {
|
|
1300
|
+
readonly type: "number";
|
|
1301
|
+
readonly format: "float";
|
|
1302
|
+
readonly description: "Amount outstanding when the charge was attempted, in the smallest currency unit.";
|
|
1303
|
+
readonly example: 4200;
|
|
1304
|
+
};
|
|
1305
|
+
readonly currency: {
|
|
1306
|
+
readonly type: "string";
|
|
1307
|
+
readonly description: "Currency of the invoice.";
|
|
1308
|
+
readonly example: "eur";
|
|
1309
|
+
};
|
|
1310
|
+
readonly status: {
|
|
1311
|
+
readonly type: "string";
|
|
1312
|
+
readonly description: "Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).";
|
|
1313
|
+
readonly example: "paid";
|
|
1314
|
+
readonly enum: readonly ["paid", "processing", "requires_action", "failed"];
|
|
1315
|
+
};
|
|
1316
|
+
readonly client_secret: {
|
|
1317
|
+
readonly type: "string";
|
|
1318
|
+
readonly nullable: true;
|
|
1319
|
+
readonly description: "Client secret used to complete customer authentication. Set only when `status` is `requires_action`.";
|
|
1320
|
+
readonly example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH";
|
|
1321
|
+
};
|
|
1322
|
+
readonly failure_code: {
|
|
1323
|
+
readonly type: "string";
|
|
1324
|
+
readonly nullable: true;
|
|
1325
|
+
readonly description: "Decline code. Set only when `status` is `failed`.";
|
|
1326
|
+
readonly example: "insufficient_funds";
|
|
1327
|
+
};
|
|
1328
|
+
readonly failure_message: {
|
|
1329
|
+
readonly type: "string";
|
|
1330
|
+
readonly nullable: true;
|
|
1331
|
+
readonly description: "Explanation of the decline, suitable for display. Set only when `status` is `failed`.";
|
|
1332
|
+
readonly example: "Your card has insufficient funds.";
|
|
721
1333
|
};
|
|
1334
|
+
};
|
|
1335
|
+
readonly required: readonly ["invoice_id", "number", "amount", "currency", "status", "client_secret", "failure_code", "failure_message"];
|
|
1336
|
+
readonly additionalProperties: false;
|
|
1337
|
+
};
|
|
1338
|
+
export declare const InvoicePaymentResultSchema: {
|
|
1339
|
+
readonly type: "object";
|
|
1340
|
+
readonly properties: {
|
|
722
1341
|
readonly code: {
|
|
723
1342
|
readonly type: "string";
|
|
724
|
-
readonly description: "
|
|
725
|
-
readonly example: "
|
|
1343
|
+
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).";
|
|
1344
|
+
readonly example: "partially_paid";
|
|
1345
|
+
readonly enum: readonly ["paid", "processing", "action_required", "partially_paid", "failed", "nothing_due", "bank_transfer_due"];
|
|
1346
|
+
};
|
|
1347
|
+
readonly message: {
|
|
1348
|
+
readonly type: "string";
|
|
1349
|
+
readonly description: "Summary of the outcome, suitable for display.";
|
|
1350
|
+
readonly example: "1 of 2 open invoices was paid. Invoice CF-0043 was declined: Your card has insufficient funds.";
|
|
1351
|
+
};
|
|
1352
|
+
readonly results: {
|
|
1353
|
+
readonly type: "array";
|
|
1354
|
+
readonly items: {
|
|
1355
|
+
readonly type: "object";
|
|
1356
|
+
readonly properties: {
|
|
1357
|
+
readonly invoice_id: {
|
|
1358
|
+
readonly type: "string";
|
|
1359
|
+
readonly description: "Identifier of the invoice.";
|
|
1360
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
1361
|
+
};
|
|
1362
|
+
readonly number: {
|
|
1363
|
+
readonly type: "string";
|
|
1364
|
+
readonly description: "Invoice number. Null if the invoice has no number.";
|
|
1365
|
+
readonly example: "CF-0042";
|
|
1366
|
+
};
|
|
1367
|
+
readonly amount: {
|
|
1368
|
+
readonly type: "number";
|
|
1369
|
+
readonly format: "float";
|
|
1370
|
+
readonly description: "Amount outstanding when the charge was attempted, in the smallest currency unit.";
|
|
1371
|
+
readonly example: 4200;
|
|
1372
|
+
};
|
|
1373
|
+
readonly currency: {
|
|
1374
|
+
readonly type: "string";
|
|
1375
|
+
readonly description: "Currency of the invoice.";
|
|
1376
|
+
readonly example: "eur";
|
|
1377
|
+
};
|
|
1378
|
+
readonly status: {
|
|
1379
|
+
readonly type: "string";
|
|
1380
|
+
readonly description: "Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).";
|
|
1381
|
+
readonly example: "paid";
|
|
1382
|
+
readonly enum: readonly ["paid", "processing", "requires_action", "failed"];
|
|
1383
|
+
};
|
|
1384
|
+
readonly client_secret: {
|
|
1385
|
+
readonly type: "string";
|
|
1386
|
+
readonly description: "Client secret used to complete customer authentication. Set only when `status` is `requires_action`.";
|
|
1387
|
+
readonly example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH";
|
|
1388
|
+
};
|
|
1389
|
+
readonly failure_code: {
|
|
1390
|
+
readonly type: "string";
|
|
1391
|
+
readonly description: "Decline code. Set only when `status` is `failed`.";
|
|
1392
|
+
readonly example: "insufficient_funds";
|
|
1393
|
+
};
|
|
1394
|
+
readonly failure_message: {
|
|
1395
|
+
readonly type: "string";
|
|
1396
|
+
readonly description: "Explanation of the decline, suitable for display. Set only when `status` is `failed`.";
|
|
1397
|
+
readonly example: "Your card has insufficient funds.";
|
|
1398
|
+
};
|
|
1399
|
+
};
|
|
1400
|
+
readonly required: readonly ["invoice_id", "number", "amount", "currency", "status", "client_secret", "failure_code", "failure_message"];
|
|
1401
|
+
readonly additionalProperties: false;
|
|
1402
|
+
};
|
|
1403
|
+
readonly description: "One entry per invoice charged, oldest first.";
|
|
726
1404
|
};
|
|
727
1405
|
};
|
|
728
|
-
readonly required: readonly ["
|
|
1406
|
+
readonly required: readonly ["code", "message", "results"];
|
|
729
1407
|
readonly additionalProperties: false;
|
|
730
1408
|
};
|
|
731
1409
|
export declare const InvoiceSchema: {
|
|
@@ -875,6 +1553,11 @@ export declare const MarketplaceListingSchema: {
|
|
|
875
1553
|
readonly description: "Chart home URL";
|
|
876
1554
|
readonly example: "https://kubernetes.github.io/ingress-nginx/";
|
|
877
1555
|
};
|
|
1556
|
+
readonly icon: {
|
|
1557
|
+
readonly type: "string";
|
|
1558
|
+
readonly description: "A URL to an SVG or PNG image to be used as an icon";
|
|
1559
|
+
readonly example: "https://cloudfleet.ai/images/marketplace/icons/ingress-nginx.png";
|
|
1560
|
+
};
|
|
878
1561
|
readonly sources: {
|
|
879
1562
|
readonly type: "array";
|
|
880
1563
|
readonly items: {
|
|
@@ -916,6 +1599,12 @@ export declare const MarketplaceListingSchema: {
|
|
|
916
1599
|
export declare const OrganizationCreateInputSchema: {
|
|
917
1600
|
readonly type: "object";
|
|
918
1601
|
readonly properties: {
|
|
1602
|
+
readonly type: {
|
|
1603
|
+
readonly type: "string";
|
|
1604
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1605
|
+
readonly example: "business";
|
|
1606
|
+
readonly enum: readonly ["business", "personal"];
|
|
1607
|
+
};
|
|
919
1608
|
readonly email: {
|
|
920
1609
|
readonly type: "string";
|
|
921
1610
|
readonly format: "email";
|
|
@@ -924,11 +1613,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
924
1613
|
};
|
|
925
1614
|
readonly first_name: {
|
|
926
1615
|
readonly type: "string";
|
|
1616
|
+
readonly minLength: 1;
|
|
927
1617
|
readonly description: "First name of the billing contact person.";
|
|
928
1618
|
readonly example: "John";
|
|
929
1619
|
};
|
|
930
1620
|
readonly last_name: {
|
|
931
1621
|
readonly type: "string";
|
|
1622
|
+
readonly minLength: 1;
|
|
932
1623
|
readonly description: "Last name of the billing contact person.";
|
|
933
1624
|
readonly example: "Doe";
|
|
934
1625
|
};
|
|
@@ -946,7 +1637,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
946
1637
|
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
1638
|
};
|
|
948
1639
|
};
|
|
949
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1640
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1641
|
+
readonly additionalProperties: false;
|
|
1642
|
+
};
|
|
1643
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1644
|
+
readonly type: "object";
|
|
1645
|
+
readonly properties: {
|
|
1646
|
+
readonly id: {
|
|
1647
|
+
readonly type: "string";
|
|
1648
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1649
|
+
readonly example: "organization-id";
|
|
1650
|
+
};
|
|
1651
|
+
};
|
|
1652
|
+
readonly required: readonly ["id"];
|
|
950
1653
|
readonly additionalProperties: false;
|
|
951
1654
|
};
|
|
952
1655
|
export declare const OrganizationSchema: {
|
|
@@ -965,6 +1668,12 @@ export declare const OrganizationSchema: {
|
|
|
965
1668
|
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
966
1669
|
readonly example: "ACME Corp.";
|
|
967
1670
|
};
|
|
1671
|
+
readonly type: {
|
|
1672
|
+
readonly type: "string";
|
|
1673
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1674
|
+
readonly example: "business";
|
|
1675
|
+
readonly enum: readonly ["business", "personal"];
|
|
1676
|
+
};
|
|
968
1677
|
readonly date_created: {
|
|
969
1678
|
readonly type: "string";
|
|
970
1679
|
readonly format: "date-time";
|
|
@@ -996,6 +1705,17 @@ export declare const OrganizationSchema: {
|
|
|
996
1705
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
997
1706
|
readonly example: 999;
|
|
998
1707
|
};
|
|
1708
|
+
readonly enterprise_clusters_max: {
|
|
1709
|
+
readonly type: "integer";
|
|
1710
|
+
readonly minimum: 0;
|
|
1711
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1712
|
+
readonly example: 999;
|
|
1713
|
+
};
|
|
1714
|
+
readonly enterprise_clusters_available: {
|
|
1715
|
+
readonly type: "integer";
|
|
1716
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1717
|
+
readonly example: 999;
|
|
1718
|
+
};
|
|
999
1719
|
readonly fleets_max: {
|
|
1000
1720
|
readonly type: "integer";
|
|
1001
1721
|
readonly minimum: 0;
|
|
@@ -1015,7 +1735,7 @@ export declare const OrganizationSchema: {
|
|
|
1015
1735
|
readonly type: "array";
|
|
1016
1736
|
readonly items: {
|
|
1017
1737
|
readonly type: "string";
|
|
1018
|
-
readonly example: "northamerica-central-
|
|
1738
|
+
readonly example: "northamerica-central-1a";
|
|
1019
1739
|
};
|
|
1020
1740
|
readonly minItems: 1;
|
|
1021
1741
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1042,20 +1762,14 @@ export declare const OrganizationSchema: {
|
|
|
1042
1762
|
readonly minItems: 1;
|
|
1043
1763
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1044
1764
|
};
|
|
1045
|
-
readonly
|
|
1046
|
-
readonly type: "integer";
|
|
1047
|
-
readonly minimum: 0;
|
|
1048
|
-
readonly description: "User-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1049
|
-
readonly example: 42000;
|
|
1050
|
-
};
|
|
1051
|
-
readonly copilot_organization_hourly_tokens: {
|
|
1765
|
+
readonly cfcr_storage_gb: {
|
|
1052
1766
|
readonly type: "integer";
|
|
1053
|
-
readonly minimum:
|
|
1054
|
-
readonly description: "Organization-level maximum
|
|
1055
|
-
readonly example:
|
|
1767
|
+
readonly minimum: -1;
|
|
1768
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1769
|
+
readonly example: 500;
|
|
1056
1770
|
};
|
|
1057
1771
|
};
|
|
1058
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "
|
|
1772
|
+
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"];
|
|
1059
1773
|
readonly additionalProperties: false;
|
|
1060
1774
|
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
1775
|
};
|
|
@@ -1064,8 +1778,14 @@ export declare const OrganizationSchema: {
|
|
|
1064
1778
|
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1065
1779
|
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1066
1780
|
};
|
|
1781
|
+
readonly verification: {
|
|
1782
|
+
readonly type: "string";
|
|
1783
|
+
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.";
|
|
1784
|
+
readonly example: "verified";
|
|
1785
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1786
|
+
};
|
|
1067
1787
|
};
|
|
1068
|
-
readonly required: readonly ["id", "date_created", "quota", "status"];
|
|
1788
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1069
1789
|
readonly additionalProperties: false;
|
|
1070
1790
|
};
|
|
1071
1791
|
export declare const PaymentMethodSchema: {
|
|
@@ -1073,26 +1793,19 @@ export declare const PaymentMethodSchema: {
|
|
|
1073
1793
|
readonly properties: {
|
|
1074
1794
|
readonly id: {
|
|
1075
1795
|
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;
|
|
1796
|
+
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.";
|
|
1797
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1084
1798
|
};
|
|
1085
1799
|
readonly type: {
|
|
1086
1800
|
readonly type: "string";
|
|
1087
|
-
readonly
|
|
1088
|
-
readonly description: "Payment method type type. Only `card` payments supported at the moment.";
|
|
1801
|
+
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
1802
|
readonly example: "card";
|
|
1090
|
-
readonly enum: readonly ["card"];
|
|
1803
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1091
1804
|
};
|
|
1092
1805
|
readonly last4: {
|
|
1093
1806
|
readonly type: "string";
|
|
1094
1807
|
readonly nullable: true;
|
|
1095
|
-
readonly description: "Last 4 digits of the payment card number.";
|
|
1808
|
+
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
1809
|
readonly example: "4242";
|
|
1097
1810
|
};
|
|
1098
1811
|
readonly exp_month: {
|
|
@@ -1100,25 +1813,46 @@ export declare const PaymentMethodSchema: {
|
|
|
1100
1813
|
readonly minimum: 1;
|
|
1101
1814
|
readonly maximum: 12;
|
|
1102
1815
|
readonly nullable: true;
|
|
1103
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1104
|
-
readonly example:
|
|
1816
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1817
|
+
readonly example: 12;
|
|
1105
1818
|
};
|
|
1106
1819
|
readonly exp_year: {
|
|
1107
1820
|
readonly type: "integer";
|
|
1108
|
-
readonly minimum: 2024;
|
|
1109
1821
|
readonly nullable: true;
|
|
1110
|
-
readonly description: "Four-digit number representing the card's expiration year.";
|
|
1111
|
-
readonly example:
|
|
1822
|
+
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.";
|
|
1823
|
+
readonly example: 2028;
|
|
1112
1824
|
};
|
|
1113
1825
|
readonly brand: {
|
|
1114
1826
|
readonly type: "string";
|
|
1115
1827
|
readonly nullable: true;
|
|
1116
|
-
readonly description: "Payment card brand
|
|
1828
|
+
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
1829
|
readonly example: "visa";
|
|
1118
|
-
|
|
1830
|
+
};
|
|
1831
|
+
readonly iban: {
|
|
1832
|
+
readonly type: "string";
|
|
1833
|
+
readonly nullable: true;
|
|
1834
|
+
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.";
|
|
1835
|
+
readonly example: "DE11243015658023127510";
|
|
1836
|
+
};
|
|
1837
|
+
readonly bic: {
|
|
1838
|
+
readonly type: "string";
|
|
1839
|
+
readonly nullable: true;
|
|
1840
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1841
|
+
readonly example: "SOGEDEFFXXX";
|
|
1842
|
+
};
|
|
1843
|
+
readonly account_holder_name: {
|
|
1844
|
+
readonly type: "string";
|
|
1845
|
+
readonly nullable: true;
|
|
1846
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1847
|
+
readonly example: "Cloudfleet GmbH";
|
|
1848
|
+
};
|
|
1849
|
+
readonly is_default: {
|
|
1850
|
+
readonly type: "boolean";
|
|
1851
|
+
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).";
|
|
1852
|
+
readonly example: true;
|
|
1119
1853
|
};
|
|
1120
1854
|
};
|
|
1121
|
-
readonly required: readonly ["id", "
|
|
1855
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1122
1856
|
readonly additionalProperties: false;
|
|
1123
1857
|
};
|
|
1124
1858
|
export declare const PlatformQuotaSchema: {
|
|
@@ -1146,6 +1880,17 @@ export declare const PlatformQuotaSchema: {
|
|
|
1146
1880
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1147
1881
|
readonly example: 999;
|
|
1148
1882
|
};
|
|
1883
|
+
readonly enterprise_clusters_max: {
|
|
1884
|
+
readonly type: "integer";
|
|
1885
|
+
readonly minimum: 0;
|
|
1886
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1887
|
+
readonly example: 999;
|
|
1888
|
+
};
|
|
1889
|
+
readonly enterprise_clusters_available: {
|
|
1890
|
+
readonly type: "integer";
|
|
1891
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1892
|
+
readonly example: 999;
|
|
1893
|
+
};
|
|
1149
1894
|
readonly fleets_max: {
|
|
1150
1895
|
readonly type: "integer";
|
|
1151
1896
|
readonly minimum: 0;
|
|
@@ -1165,7 +1910,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1165
1910
|
readonly type: "array";
|
|
1166
1911
|
readonly items: {
|
|
1167
1912
|
readonly type: "string";
|
|
1168
|
-
readonly example: "northamerica-central-
|
|
1913
|
+
readonly example: "northamerica-central-1a";
|
|
1169
1914
|
};
|
|
1170
1915
|
readonly minItems: 1;
|
|
1171
1916
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1192,20 +1937,14 @@ export declare const PlatformQuotaSchema: {
|
|
|
1192
1937
|
readonly minItems: 1;
|
|
1193
1938
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1194
1939
|
};
|
|
1195
|
-
readonly
|
|
1940
|
+
readonly cfcr_storage_gb: {
|
|
1196
1941
|
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;
|
|
1942
|
+
readonly minimum: -1;
|
|
1943
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1944
|
+
readonly example: 500;
|
|
1206
1945
|
};
|
|
1207
1946
|
};
|
|
1208
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "
|
|
1947
|
+
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"];
|
|
1209
1948
|
readonly additionalProperties: false;
|
|
1210
1949
|
};
|
|
1211
1950
|
export declare const RegistryRepositorySchema: {
|
|
@@ -1224,7 +1963,7 @@ export declare const RegistryRepositorySchema: {
|
|
|
1224
1963
|
readonly uri: {
|
|
1225
1964
|
readonly type: "string";
|
|
1226
1965
|
readonly description: "Full URI of the repository.";
|
|
1227
|
-
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/
|
|
1966
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1228
1967
|
};
|
|
1229
1968
|
};
|
|
1230
1969
|
readonly required: readonly ["name", "region", "uri"];
|
|
@@ -1246,7 +1985,7 @@ export declare const RegistryRepositoryWithTagsSchema: {
|
|
|
1246
1985
|
readonly uri: {
|
|
1247
1986
|
readonly type: "string";
|
|
1248
1987
|
readonly description: "Full URI of the repository.";
|
|
1249
|
-
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/
|
|
1988
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1250
1989
|
};
|
|
1251
1990
|
readonly tags: {
|
|
1252
1991
|
readonly type: "array";
|
|
@@ -1269,6 +2008,14 @@ export declare const RegistryRepositoryWithTagsSchema: {
|
|
|
1269
2008
|
readonly description: "Media type of the manifest.";
|
|
1270
2009
|
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
1271
2010
|
};
|
|
2011
|
+
readonly platforms: {
|
|
2012
|
+
readonly type: "array";
|
|
2013
|
+
readonly items: {
|
|
2014
|
+
readonly type: "string";
|
|
2015
|
+
};
|
|
2016
|
+
readonly description: "Array of platform strings for multi-arch images (e.g., linux/amd64, linux/arm64).";
|
|
2017
|
+
readonly example: readonly ["linux/amd64", "linux/arm64"];
|
|
2018
|
+
};
|
|
1272
2019
|
};
|
|
1273
2020
|
readonly required: readonly ["name", "size"];
|
|
1274
2021
|
readonly additionalProperties: false;
|
|
@@ -1293,6 +2040,11 @@ export declare const RegistryTagSchema: {
|
|
|
1293
2040
|
readonly description: "Tag name.";
|
|
1294
2041
|
readonly example: "latest";
|
|
1295
2042
|
};
|
|
2043
|
+
readonly digest: {
|
|
2044
|
+
readonly type: "string";
|
|
2045
|
+
readonly description: "Manifest digest for pulling by digest.";
|
|
2046
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
2047
|
+
};
|
|
1296
2048
|
readonly mediaType: {
|
|
1297
2049
|
readonly type: "string";
|
|
1298
2050
|
readonly description: "Media type of the manifest.";
|
|
@@ -1317,6 +2069,11 @@ export declare const RegistryTagSchema: {
|
|
|
1317
2069
|
readonly items: {
|
|
1318
2070
|
readonly type: "object";
|
|
1319
2071
|
readonly properties: {
|
|
2072
|
+
readonly digest: {
|
|
2073
|
+
readonly type: "string";
|
|
2074
|
+
readonly description: "Digest of the layer.";
|
|
2075
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
2076
|
+
};
|
|
1320
2077
|
readonly size: {
|
|
1321
2078
|
readonly type: "number";
|
|
1322
2079
|
readonly format: "float";
|
|
@@ -1352,11 +2109,44 @@ export declare const RegistryTagSchema: {
|
|
|
1352
2109
|
readonly description: "Operating system of the platform.";
|
|
1353
2110
|
readonly example: "linux";
|
|
1354
2111
|
};
|
|
2112
|
+
readonly variant: {
|
|
2113
|
+
readonly type: "string";
|
|
2114
|
+
readonly description: "Variant of the platform (e.g., v7, v8 for ARM).";
|
|
2115
|
+
readonly example: "v8";
|
|
2116
|
+
};
|
|
1355
2117
|
};
|
|
1356
2118
|
readonly required: readonly ["architecture", "os"];
|
|
1357
2119
|
readonly additionalProperties: false;
|
|
1358
2120
|
readonly description: "Platform information for the manifest.";
|
|
1359
2121
|
};
|
|
2122
|
+
readonly layers: {
|
|
2123
|
+
readonly type: "array";
|
|
2124
|
+
readonly items: {
|
|
2125
|
+
readonly type: "object";
|
|
2126
|
+
readonly properties: {
|
|
2127
|
+
readonly digest: {
|
|
2128
|
+
readonly type: "string";
|
|
2129
|
+
readonly description: "Digest of the layer.";
|
|
2130
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
2131
|
+
};
|
|
2132
|
+
readonly size: {
|
|
2133
|
+
readonly type: "number";
|
|
2134
|
+
readonly format: "float";
|
|
2135
|
+
readonly description: "Size of the layer in bytes.";
|
|
2136
|
+
readonly example: 5678;
|
|
2137
|
+
};
|
|
2138
|
+
};
|
|
2139
|
+
readonly required: readonly ["size"];
|
|
2140
|
+
readonly additionalProperties: false;
|
|
2141
|
+
};
|
|
2142
|
+
readonly description: "Layers for this platform.";
|
|
2143
|
+
};
|
|
2144
|
+
readonly size: {
|
|
2145
|
+
readonly type: "number";
|
|
2146
|
+
readonly format: "float";
|
|
2147
|
+
readonly description: "Total size of this platform manifest in bytes.";
|
|
2148
|
+
readonly example: 12345678;
|
|
2149
|
+
};
|
|
1360
2150
|
};
|
|
1361
2151
|
readonly required: readonly ["digest"];
|
|
1362
2152
|
readonly additionalProperties: false;
|
|
@@ -1385,7 +2175,275 @@ export declare const RegistryTagSchema: {
|
|
|
1385
2175
|
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app:latest";
|
|
1386
2176
|
};
|
|
1387
2177
|
};
|
|
1388
|
-
readonly required: readonly ["name", "size", "region", "repository", "uri"];
|
|
2178
|
+
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
2179
|
+
readonly additionalProperties: false;
|
|
2180
|
+
};
|
|
2181
|
+
export declare const TicketAttachmentSchema: {
|
|
2182
|
+
readonly type: "object";
|
|
2183
|
+
readonly properties: {
|
|
2184
|
+
readonly id: {
|
|
2185
|
+
readonly type: "string";
|
|
2186
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2187
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2188
|
+
};
|
|
2189
|
+
readonly filename: {
|
|
2190
|
+
readonly type: "string";
|
|
2191
|
+
readonly description: "Original filename as uploaded.";
|
|
2192
|
+
readonly example: "debug.log";
|
|
2193
|
+
};
|
|
2194
|
+
readonly content_type: {
|
|
2195
|
+
readonly type: "string";
|
|
2196
|
+
readonly description: "MIME content type of the attachment.";
|
|
2197
|
+
readonly example: "text/plain";
|
|
2198
|
+
};
|
|
2199
|
+
readonly size: {
|
|
2200
|
+
readonly type: "integer";
|
|
2201
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2202
|
+
readonly example: 12345;
|
|
2203
|
+
};
|
|
2204
|
+
};
|
|
2205
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2206
|
+
readonly additionalProperties: false;
|
|
2207
|
+
};
|
|
2208
|
+
export declare const TicketCreateInputSchema: {
|
|
2209
|
+
readonly type: "object";
|
|
2210
|
+
readonly properties: {
|
|
2211
|
+
readonly category: {
|
|
2212
|
+
readonly type: "string";
|
|
2213
|
+
readonly description: "Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.";
|
|
2214
|
+
readonly example: "technical";
|
|
2215
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2216
|
+
};
|
|
2217
|
+
readonly body: {
|
|
2218
|
+
readonly type: "string";
|
|
2219
|
+
readonly maxLength: 50000;
|
|
2220
|
+
readonly minLength: 1;
|
|
2221
|
+
readonly pattern: "\\S";
|
|
2222
|
+
readonly description: "Initial message body in markdown. There is no separate subject — the first message body is the description.";
|
|
2223
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2224
|
+
};
|
|
2225
|
+
readonly properties: {
|
|
2226
|
+
readonly type: "object";
|
|
2227
|
+
readonly additionalProperties: true;
|
|
2228
|
+
readonly description: "Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).";
|
|
2229
|
+
readonly example: {
|
|
2230
|
+
readonly subcategory: "cluster-question";
|
|
2231
|
+
readonly cluster_id: "60c72b2f9f1b2c001f8e4d3a";
|
|
2232
|
+
};
|
|
2233
|
+
};
|
|
2234
|
+
};
|
|
2235
|
+
readonly required: readonly ["category", "body"];
|
|
2236
|
+
readonly additionalProperties: false;
|
|
2237
|
+
};
|
|
2238
|
+
export declare const TicketMessageInputSchema: {
|
|
2239
|
+
readonly type: "object";
|
|
2240
|
+
readonly properties: {
|
|
2241
|
+
readonly body: {
|
|
2242
|
+
readonly type: "string";
|
|
2243
|
+
readonly maxLength: 50000;
|
|
2244
|
+
readonly minLength: 1;
|
|
2245
|
+
readonly pattern: "\\S";
|
|
2246
|
+
readonly description: "Reply body in markdown.";
|
|
2247
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2248
|
+
};
|
|
2249
|
+
};
|
|
2250
|
+
readonly required: readonly ["body"];
|
|
2251
|
+
readonly additionalProperties: false;
|
|
2252
|
+
};
|
|
2253
|
+
export declare const TicketMessageSchema: {
|
|
2254
|
+
readonly type: "object";
|
|
2255
|
+
readonly properties: {
|
|
2256
|
+
readonly id: {
|
|
2257
|
+
readonly type: "string";
|
|
2258
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2259
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2260
|
+
};
|
|
2261
|
+
readonly type: {
|
|
2262
|
+
readonly type: "string";
|
|
2263
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2264
|
+
readonly example: "customer_reply";
|
|
2265
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2266
|
+
};
|
|
2267
|
+
readonly body: {
|
|
2268
|
+
readonly type: "string";
|
|
2269
|
+
readonly description: "Message body in markdown.";
|
|
2270
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2271
|
+
};
|
|
2272
|
+
readonly author_first_name: {
|
|
2273
|
+
readonly type: "string";
|
|
2274
|
+
readonly nullable: true;
|
|
2275
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2276
|
+
readonly example: "Jane";
|
|
2277
|
+
};
|
|
2278
|
+
readonly author_last_name: {
|
|
2279
|
+
readonly type: "string";
|
|
2280
|
+
readonly nullable: true;
|
|
2281
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2282
|
+
readonly example: "Doe";
|
|
2283
|
+
};
|
|
2284
|
+
readonly attachments: {
|
|
2285
|
+
readonly type: "array";
|
|
2286
|
+
readonly items: {
|
|
2287
|
+
readonly type: "object";
|
|
2288
|
+
readonly properties: {
|
|
2289
|
+
readonly id: {
|
|
2290
|
+
readonly type: "string";
|
|
2291
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2292
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2293
|
+
};
|
|
2294
|
+
readonly filename: {
|
|
2295
|
+
readonly type: "string";
|
|
2296
|
+
readonly description: "Original filename as uploaded.";
|
|
2297
|
+
readonly example: "debug.log";
|
|
2298
|
+
};
|
|
2299
|
+
readonly content_type: {
|
|
2300
|
+
readonly type: "string";
|
|
2301
|
+
readonly description: "MIME content type of the attachment.";
|
|
2302
|
+
readonly example: "text/plain";
|
|
2303
|
+
};
|
|
2304
|
+
readonly size: {
|
|
2305
|
+
readonly type: "integer";
|
|
2306
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2307
|
+
readonly example: 12345;
|
|
2308
|
+
};
|
|
2309
|
+
};
|
|
2310
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2311
|
+
readonly additionalProperties: false;
|
|
2312
|
+
};
|
|
2313
|
+
readonly description: "Attachments associated with this message.";
|
|
2314
|
+
readonly example: readonly [];
|
|
2315
|
+
};
|
|
2316
|
+
readonly date_created: {
|
|
2317
|
+
readonly type: "string";
|
|
2318
|
+
readonly format: "date-time";
|
|
2319
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2320
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2321
|
+
};
|
|
2322
|
+
};
|
|
2323
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2324
|
+
readonly additionalProperties: false;
|
|
2325
|
+
};
|
|
2326
|
+
export declare const TicketSchema: {
|
|
2327
|
+
readonly type: "object";
|
|
2328
|
+
readonly properties: {
|
|
2329
|
+
readonly id: {
|
|
2330
|
+
readonly type: "string";
|
|
2331
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
2332
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
2333
|
+
};
|
|
2334
|
+
readonly status: {
|
|
2335
|
+
readonly type: "string";
|
|
2336
|
+
readonly description: "Current state of the ticket.";
|
|
2337
|
+
readonly example: "waiting_on_us";
|
|
2338
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
2339
|
+
};
|
|
2340
|
+
readonly category: {
|
|
2341
|
+
readonly type: "string";
|
|
2342
|
+
readonly description: "Ticket category.";
|
|
2343
|
+
readonly example: "technical";
|
|
2344
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2345
|
+
};
|
|
2346
|
+
readonly summary: {
|
|
2347
|
+
readonly type: "string";
|
|
2348
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
2349
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2350
|
+
};
|
|
2351
|
+
readonly closed_at: {
|
|
2352
|
+
readonly type: "string";
|
|
2353
|
+
readonly format: "date-time";
|
|
2354
|
+
readonly nullable: true;
|
|
2355
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2356
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
2357
|
+
};
|
|
2358
|
+
readonly date_created: {
|
|
2359
|
+
readonly type: "string";
|
|
2360
|
+
readonly format: "date-time";
|
|
2361
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
2362
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2363
|
+
};
|
|
2364
|
+
readonly date_updated: {
|
|
2365
|
+
readonly type: "string";
|
|
2366
|
+
readonly format: "date-time";
|
|
2367
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2368
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2369
|
+
};
|
|
2370
|
+
readonly messages: {
|
|
2371
|
+
readonly type: "array";
|
|
2372
|
+
readonly items: {
|
|
2373
|
+
readonly type: "object";
|
|
2374
|
+
readonly properties: {
|
|
2375
|
+
readonly id: {
|
|
2376
|
+
readonly type: "string";
|
|
2377
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2378
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2379
|
+
};
|
|
2380
|
+
readonly type: {
|
|
2381
|
+
readonly type: "string";
|
|
2382
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2383
|
+
readonly example: "customer_reply";
|
|
2384
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2385
|
+
};
|
|
2386
|
+
readonly body: {
|
|
2387
|
+
readonly type: "string";
|
|
2388
|
+
readonly description: "Message body in markdown.";
|
|
2389
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2390
|
+
};
|
|
2391
|
+
readonly author_first_name: {
|
|
2392
|
+
readonly type: "string";
|
|
2393
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2394
|
+
readonly example: "Jane";
|
|
2395
|
+
};
|
|
2396
|
+
readonly author_last_name: {
|
|
2397
|
+
readonly type: "string";
|
|
2398
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2399
|
+
readonly example: "Doe";
|
|
2400
|
+
};
|
|
2401
|
+
readonly attachments: {
|
|
2402
|
+
readonly type: "array";
|
|
2403
|
+
readonly items: {
|
|
2404
|
+
readonly type: "object";
|
|
2405
|
+
readonly properties: {
|
|
2406
|
+
readonly id: {
|
|
2407
|
+
readonly type: "string";
|
|
2408
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2409
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2410
|
+
};
|
|
2411
|
+
readonly filename: {
|
|
2412
|
+
readonly type: "string";
|
|
2413
|
+
readonly description: "Original filename as uploaded.";
|
|
2414
|
+
readonly example: "debug.log";
|
|
2415
|
+
};
|
|
2416
|
+
readonly content_type: {
|
|
2417
|
+
readonly type: "string";
|
|
2418
|
+
readonly description: "MIME content type of the attachment.";
|
|
2419
|
+
readonly example: "text/plain";
|
|
2420
|
+
};
|
|
2421
|
+
readonly size: {
|
|
2422
|
+
readonly type: "integer";
|
|
2423
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2424
|
+
readonly example: 12345;
|
|
2425
|
+
};
|
|
2426
|
+
};
|
|
2427
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2428
|
+
readonly additionalProperties: false;
|
|
2429
|
+
};
|
|
2430
|
+
readonly description: "Attachments associated with this message.";
|
|
2431
|
+
readonly example: readonly [];
|
|
2432
|
+
};
|
|
2433
|
+
readonly date_created: {
|
|
2434
|
+
readonly type: "string";
|
|
2435
|
+
readonly format: "date-time";
|
|
2436
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2437
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2438
|
+
};
|
|
2439
|
+
};
|
|
2440
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2441
|
+
readonly additionalProperties: false;
|
|
2442
|
+
};
|
|
2443
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
2444
|
+
};
|
|
2445
|
+
};
|
|
2446
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1389
2447
|
readonly additionalProperties: false;
|
|
1390
2448
|
};
|
|
1391
2449
|
export declare const TokenCreateInputSchema: {
|
|
@@ -1481,9 +2539,10 @@ export declare const UsageFacetsSchema: {
|
|
|
1481
2539
|
readonly type: "array";
|
|
1482
2540
|
readonly items: {
|
|
1483
2541
|
readonly type: "string";
|
|
2542
|
+
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"];
|
|
1484
2543
|
};
|
|
1485
2544
|
readonly description: "List of unique products";
|
|
1486
|
-
readonly example: readonly ["
|
|
2545
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
1487
2546
|
};
|
|
1488
2547
|
};
|
|
1489
2548
|
readonly additionalProperties: false;
|
|
@@ -1509,7 +2568,8 @@ export declare const UsageResponseSchema: {
|
|
|
1509
2568
|
readonly product: {
|
|
1510
2569
|
readonly type: "string";
|
|
1511
2570
|
readonly description: "The product the usage is associated with";
|
|
1512
|
-
readonly example: "
|
|
2571
|
+
readonly example: "cfke_controlplane_pro";
|
|
2572
|
+
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"];
|
|
1513
2573
|
};
|
|
1514
2574
|
readonly value: {
|
|
1515
2575
|
readonly type: "number";
|
|
@@ -1549,9 +2609,10 @@ export declare const UsageResponseSchema: {
|
|
|
1549
2609
|
readonly type: "array";
|
|
1550
2610
|
readonly items: {
|
|
1551
2611
|
readonly type: "string";
|
|
2612
|
+
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"];
|
|
1552
2613
|
};
|
|
1553
2614
|
readonly description: "List of unique products";
|
|
1554
|
-
readonly example: readonly ["
|
|
2615
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
1555
2616
|
};
|
|
1556
2617
|
};
|
|
1557
2618
|
readonly additionalProperties: false;
|
|
@@ -1577,7 +2638,8 @@ export declare const UsageSchema: {
|
|
|
1577
2638
|
readonly product: {
|
|
1578
2639
|
readonly type: "string";
|
|
1579
2640
|
readonly description: "The product the usage is associated with";
|
|
1580
|
-
readonly example: "
|
|
2641
|
+
readonly example: "cfke_controlplane_pro";
|
|
2642
|
+
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"];
|
|
1581
2643
|
};
|
|
1582
2644
|
readonly value: {
|
|
1583
2645
|
readonly type: "number";
|
|
@@ -1634,18 +2696,6 @@ export declare const UserCreateInputSchema: {
|
|
|
1634
2696
|
readonly minLength: 8;
|
|
1635
2697
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
1636
2698
|
};
|
|
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
2699
|
};
|
|
1650
2700
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
1651
2701
|
readonly additionalProperties: false;
|