@cloudfleet/sdk 0.0.1-8a4d7bb → 0.0.1-8aa6e49
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -2
- package/dist/@tanstack/react-query.gen.d.ts +1199 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1215 -0
- package/dist/@tanstack/react-query.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +104 -123
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/types.gen.d.ts +6 -3
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +7 -3
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.js +3 -3
- package/dist/client/utils.gen.js.map +1 -1
- package/dist/core/params.gen.js +4 -4
- package/dist/core/params.gen.js.map +1 -1
- package/dist/core/serverSentEvents.gen.d.ts +1 -1
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -1
- package/dist/core/serverSentEvents.gen.js +3 -4
- package/dist/core/serverSentEvents.gen.js.map +1 -1
- package/dist/schemas.gen.d.ts +937 -140
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +1873 -213
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +262 -186
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +377 -257
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +8 -8
- package/dist/types.gen.d.ts +1499 -758
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3417 -1208
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1281 -293
- package/dist/zod.gen.js.map +1 -1
- package/package.json +28 -12
package/dist/schemas.gen.d.ts
CHANGED
|
@@ -1,6 +1,49 @@
|
|
|
1
|
+
export declare const BasicPriceConsentInputSchema: {
|
|
2
|
+
readonly type: "object";
|
|
3
|
+
readonly properties: {
|
|
4
|
+
readonly decision: {
|
|
5
|
+
readonly type: "string";
|
|
6
|
+
readonly description: "The administrator's decision on the new Basic price. `accepted` continues to paid billing when the signup credit runs out; `rejected` opts out (clusters are suspended, never charged). A `rejected` org can later be flipped back to `accepted`.";
|
|
7
|
+
readonly example: "accepted";
|
|
8
|
+
readonly enum: readonly ["accepted", "rejected"];
|
|
9
|
+
};
|
|
10
|
+
};
|
|
11
|
+
readonly required: readonly ["decision"];
|
|
12
|
+
readonly additionalProperties: false;
|
|
13
|
+
};
|
|
14
|
+
export declare const BasicPriceConsentSchema: {
|
|
15
|
+
readonly type: "object";
|
|
16
|
+
readonly properties: {
|
|
17
|
+
readonly status: {
|
|
18
|
+
readonly type: "string";
|
|
19
|
+
readonly description: "Consent status for the new Basic price. `not_applicable` when the organization is not in scope for the migration. `pending` when the organization must opt in but no admin has decided yet. `accepted` / `rejected` reflect the recorded decision.";
|
|
20
|
+
readonly example: "pending";
|
|
21
|
+
readonly enum: readonly ["not_applicable", "pending", "accepted", "rejected"];
|
|
22
|
+
};
|
|
23
|
+
readonly decided_at: {
|
|
24
|
+
readonly type: "string";
|
|
25
|
+
readonly format: "date-time";
|
|
26
|
+
readonly description: "When the current decision was recorded. Absent while `not_applicable` or `pending`.";
|
|
27
|
+
readonly example: "2026-09-05T10:12:00.000Z";
|
|
28
|
+
};
|
|
29
|
+
readonly decided_by: {
|
|
30
|
+
readonly type: "string";
|
|
31
|
+
readonly description: "User id of the administrator who recorded the current decision. Absent while `not_applicable` or `pending`.";
|
|
32
|
+
readonly example: "2b7a5c9e-1f4d-4a1b-9c3e-8d2f6a0b1c2d";
|
|
33
|
+
};
|
|
34
|
+
};
|
|
35
|
+
readonly required: readonly ["status"];
|
|
36
|
+
readonly additionalProperties: false;
|
|
37
|
+
};
|
|
1
38
|
export declare const BillingContactSchema: {
|
|
2
39
|
readonly type: "object";
|
|
3
40
|
readonly properties: {
|
|
41
|
+
readonly type: {
|
|
42
|
+
readonly type: "string";
|
|
43
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
44
|
+
readonly example: "business";
|
|
45
|
+
readonly enum: readonly ["business", "personal"];
|
|
46
|
+
};
|
|
4
47
|
readonly company: {
|
|
5
48
|
readonly type: "string";
|
|
6
49
|
readonly maxLength: 120;
|
|
@@ -76,7 +119,7 @@ export declare const BillingContactSchema: {
|
|
|
76
119
|
readonly enum: readonly ["ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "at_vat", "au_abn", "au_arn", "ba_tin", "bb_tin", "be_vat", "bg_uic", "bg_vat", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", "cy_vat", "cz_vat", "de_stn", "de_vat", "dk_vat", "do_rcn", "ec_ruc", "ee_vat", "eg_tin", "es_cif", "es_vat", "eu_oss_vat", "fi_vat", "fr_vat", "gb_vat", "ge_vat", "gn_nif", "gr_vat", "hk_br", "hr_oib", "hr_vat", "hu_tin", "hu_vat", "id_npwp", "ie_vat", "il_vat", "in_gst", "is_vat", "it_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "lt_vat", "lu_vat", "lv_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mt_vat", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "nl_vat", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "pl_vat", "pt_vat", "ro_tin", "ro_vat", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "se_vat", "sg_gst", "sg_uen", "si_tin", "si_vat", "sk_vat", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "xi_vat", "za_vat", "zm_tin", "zw_tin", ""];
|
|
77
120
|
};
|
|
78
121
|
};
|
|
79
|
-
readonly required: readonly ["email", "individual_name"];
|
|
122
|
+
readonly required: readonly ["type", "email", "individual_name"];
|
|
80
123
|
readonly additionalProperties: false;
|
|
81
124
|
};
|
|
82
125
|
export declare const BillingCreditsSchema: {
|
|
@@ -211,9 +254,8 @@ export declare const ChartSchema: {
|
|
|
211
254
|
};
|
|
212
255
|
readonly status: {
|
|
213
256
|
readonly type: "string";
|
|
214
|
-
readonly description: "Status of the chart deployment.";
|
|
215
|
-
readonly example: "
|
|
216
|
-
readonly enum: readonly ["InstallSucceeded", "InstallFailed", "UpgradeSucceeded", "UpgradeFailed", "TestSucceeded", "TestFailed", "RollbackSucceeded", "RollbackFailed", "UninstallSucceeded", "UninstallFailed", "ArtifactFailed", "DependencyNotReady", "Progressing", "SourceNotReady"];
|
|
257
|
+
readonly description: "Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).";
|
|
258
|
+
readonly example: "InstallSucceeded";
|
|
217
259
|
};
|
|
218
260
|
readonly version_current: {
|
|
219
261
|
readonly type: "string";
|
|
@@ -270,15 +312,9 @@ export declare const ClusterCreateInputSchema: {
|
|
|
270
312
|
readonly tier: {
|
|
271
313
|
readonly type: "string";
|
|
272
314
|
readonly description: "Tier of the cluster.";
|
|
315
|
+
readonly default: "basic";
|
|
273
316
|
readonly example: "pro";
|
|
274
|
-
readonly enum: readonly ["basic", "pro"];
|
|
275
|
-
};
|
|
276
|
-
readonly region: {
|
|
277
|
-
readonly type: "string";
|
|
278
|
-
readonly description: "Cloudfleet control plane region. One of \"staging-1a\", \"northamerica-central-1\", \"europe-central-1a\", \"northamerica-central-1a\". This field can not be updated after creation.";
|
|
279
|
-
readonly default: "staging-1a";
|
|
280
|
-
readonly example: "northamerica-central-1a";
|
|
281
|
-
readonly enum: readonly ["staging-1a", "northamerica-central-1", "europe-central-1a", "northamerica-central-1a"];
|
|
317
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
282
318
|
};
|
|
283
319
|
readonly version_channel: {
|
|
284
320
|
readonly type: "string";
|
|
@@ -286,11 +322,93 @@ export declare const ClusterCreateInputSchema: {
|
|
|
286
322
|
readonly description: "Version of the kubernetes cluster.";
|
|
287
323
|
readonly default: "1.x.x-cfke.x";
|
|
288
324
|
readonly example: "1.x.x-cfke.x";
|
|
289
|
-
|
|
325
|
+
};
|
|
326
|
+
readonly release_channel: {
|
|
327
|
+
readonly type: "string";
|
|
328
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
329
|
+
readonly default: "rapid";
|
|
330
|
+
readonly example: "rapid";
|
|
331
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
332
|
+
};
|
|
333
|
+
readonly features: {
|
|
334
|
+
readonly type: "object";
|
|
335
|
+
readonly properties: {
|
|
336
|
+
readonly gpu_sharing_strategy: {
|
|
337
|
+
readonly type: "string";
|
|
338
|
+
readonly description: "GPU sharing strategy.";
|
|
339
|
+
readonly default: "none";
|
|
340
|
+
readonly example: "none";
|
|
341
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
342
|
+
};
|
|
343
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
344
|
+
readonly type: "integer";
|
|
345
|
+
readonly minimum: 2;
|
|
346
|
+
readonly maximum: 48;
|
|
347
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
348
|
+
readonly default: 4;
|
|
349
|
+
readonly example: 10;
|
|
350
|
+
};
|
|
351
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
352
|
+
readonly type: "boolean";
|
|
353
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
354
|
+
readonly example: false;
|
|
355
|
+
};
|
|
356
|
+
};
|
|
357
|
+
readonly additionalProperties: false;
|
|
358
|
+
readonly description: "Cluster feature toggles.";
|
|
359
|
+
readonly default: {
|
|
360
|
+
readonly gpu_sharing_strategy: "none";
|
|
361
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
362
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
363
|
+
};
|
|
364
|
+
};
|
|
365
|
+
readonly region: {
|
|
366
|
+
readonly type: "string";
|
|
367
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
368
|
+
readonly example: "europe-central-1a";
|
|
369
|
+
};
|
|
370
|
+
readonly networking: {
|
|
371
|
+
readonly type: "object";
|
|
372
|
+
readonly properties: {
|
|
373
|
+
readonly pod_cidr: {
|
|
374
|
+
readonly type: "string";
|
|
375
|
+
readonly description: "CIDR block for pod IPs.";
|
|
376
|
+
readonly default: "10.244.0.0/16";
|
|
377
|
+
};
|
|
378
|
+
readonly service_cidr: {
|
|
379
|
+
readonly type: "string";
|
|
380
|
+
readonly description: "CIDR block for service IPs.";
|
|
381
|
+
readonly default: "10.96.0.0/12";
|
|
382
|
+
};
|
|
383
|
+
readonly dual_stack: {
|
|
384
|
+
readonly type: "boolean";
|
|
385
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
386
|
+
};
|
|
387
|
+
readonly pod_cidr_v6: {
|
|
388
|
+
readonly type: "string";
|
|
389
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
390
|
+
readonly default: "2001:db8:1:2::/48";
|
|
391
|
+
};
|
|
392
|
+
readonly service_cidr_v6: {
|
|
393
|
+
readonly type: "string";
|
|
394
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
395
|
+
readonly default: "2001:db8:1:1::/112";
|
|
396
|
+
};
|
|
397
|
+
};
|
|
398
|
+
readonly additionalProperties: false;
|
|
399
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
400
|
+
readonly default: {
|
|
401
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
402
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
403
|
+
readonly dual_stack: false;
|
|
404
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
405
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
406
|
+
};
|
|
290
407
|
};
|
|
291
408
|
};
|
|
292
|
-
readonly required: readonly ["name", "
|
|
409
|
+
readonly required: readonly ["name", "region"];
|
|
293
410
|
readonly additionalProperties: false;
|
|
411
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
294
412
|
};
|
|
295
413
|
export declare const ClusterJoinInformationSchema: {
|
|
296
414
|
readonly type: "object";
|
|
@@ -311,11 +429,21 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
311
429
|
readonly description: "Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.";
|
|
312
430
|
readonly example: "10.96.0.10";
|
|
313
431
|
};
|
|
432
|
+
readonly pod_cidr: {
|
|
433
|
+
readonly type: "string";
|
|
434
|
+
readonly description: "Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.";
|
|
435
|
+
readonly example: "10.244.0.0/16";
|
|
436
|
+
};
|
|
314
437
|
readonly auth_key: {
|
|
315
438
|
readonly type: "string";
|
|
316
439
|
readonly description: "Authentication key for the cluster.";
|
|
317
440
|
readonly example: "tskey-auth-kBV8wr1dk911CNTRL-...";
|
|
318
441
|
};
|
|
442
|
+
readonly login_server: {
|
|
443
|
+
readonly type: "string";
|
|
444
|
+
readonly description: "Coordination server the node registers against. Empty on data plane v1 clusters, where the node advertises its own tag instead. A non-empty value requires a client that declares the dataplane-v2 capability.";
|
|
445
|
+
readonly example: "https://415026b6-f00f-44f8-968d-fc6ef4d0fc6d.fabric.europe-central-1a.cfke.io";
|
|
446
|
+
};
|
|
319
447
|
readonly bootstrap_token: {
|
|
320
448
|
readonly type: "string";
|
|
321
449
|
readonly description: "Bootstrap token for the cluster.";
|
|
@@ -373,7 +501,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
373
501
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
374
502
|
};
|
|
375
503
|
};
|
|
376
|
-
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
504
|
+
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "pod_cidr", "auth_key", "login_server", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
377
505
|
readonly additionalProperties: false;
|
|
378
506
|
};
|
|
379
507
|
export declare const ClusterSchema: {
|
|
@@ -390,15 +518,100 @@ export declare const ClusterSchema: {
|
|
|
390
518
|
readonly tier: {
|
|
391
519
|
readonly type: "string";
|
|
392
520
|
readonly description: "Tier of the cluster.";
|
|
521
|
+
readonly default: "basic";
|
|
393
522
|
readonly example: "pro";
|
|
394
|
-
readonly enum: readonly ["basic", "pro"];
|
|
523
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
524
|
+
};
|
|
525
|
+
readonly version_channel: {
|
|
526
|
+
readonly type: "string";
|
|
527
|
+
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
528
|
+
readonly description: "Version of the kubernetes cluster.";
|
|
529
|
+
readonly default: "1.x.x-cfke.x";
|
|
530
|
+
readonly example: "1.x.x-cfke.x";
|
|
531
|
+
};
|
|
532
|
+
readonly release_channel: {
|
|
533
|
+
readonly type: "string";
|
|
534
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
535
|
+
readonly default: "rapid";
|
|
536
|
+
readonly example: "rapid";
|
|
537
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
538
|
+
};
|
|
539
|
+
readonly features: {
|
|
540
|
+
readonly type: "object";
|
|
541
|
+
readonly properties: {
|
|
542
|
+
readonly gpu_sharing_strategy: {
|
|
543
|
+
readonly type: "string";
|
|
544
|
+
readonly description: "GPU sharing strategy.";
|
|
545
|
+
readonly default: "none";
|
|
546
|
+
readonly example: "none";
|
|
547
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
548
|
+
};
|
|
549
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
550
|
+
readonly type: "integer";
|
|
551
|
+
readonly minimum: 2;
|
|
552
|
+
readonly maximum: 48;
|
|
553
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
554
|
+
readonly default: 4;
|
|
555
|
+
readonly example: 10;
|
|
556
|
+
};
|
|
557
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
558
|
+
readonly type: "boolean";
|
|
559
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
560
|
+
readonly example: false;
|
|
561
|
+
};
|
|
562
|
+
};
|
|
563
|
+
readonly required: readonly ["gpu_sharing_strategy", "gpu_max_shared_clients_per_gpu", "cilium_socket_lb_host_namespace_only"];
|
|
564
|
+
readonly additionalProperties: false;
|
|
565
|
+
readonly description: "Cluster feature toggles.";
|
|
566
|
+
readonly default: {
|
|
567
|
+
readonly gpu_sharing_strategy: "none";
|
|
568
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
569
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
570
|
+
};
|
|
395
571
|
};
|
|
396
572
|
readonly region: {
|
|
397
573
|
readonly type: "string";
|
|
398
|
-
readonly description: "Cloudfleet control plane region.
|
|
399
|
-
readonly
|
|
400
|
-
|
|
401
|
-
|
|
574
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
575
|
+
readonly example: "europe-central-1a";
|
|
576
|
+
};
|
|
577
|
+
readonly networking: {
|
|
578
|
+
readonly type: "object";
|
|
579
|
+
readonly properties: {
|
|
580
|
+
readonly pod_cidr: {
|
|
581
|
+
readonly type: "string";
|
|
582
|
+
readonly description: "CIDR block for pod IPs.";
|
|
583
|
+
readonly default: "10.244.0.0/16";
|
|
584
|
+
};
|
|
585
|
+
readonly service_cidr: {
|
|
586
|
+
readonly type: "string";
|
|
587
|
+
readonly description: "CIDR block for service IPs.";
|
|
588
|
+
readonly default: "10.96.0.0/12";
|
|
589
|
+
};
|
|
590
|
+
readonly dual_stack: {
|
|
591
|
+
readonly type: "boolean";
|
|
592
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
593
|
+
};
|
|
594
|
+
readonly pod_cidr_v6: {
|
|
595
|
+
readonly type: "string";
|
|
596
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
597
|
+
readonly default: "2001:db8:1:2::/48";
|
|
598
|
+
};
|
|
599
|
+
readonly service_cidr_v6: {
|
|
600
|
+
readonly type: "string";
|
|
601
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
602
|
+
readonly default: "2001:db8:1:1::/112";
|
|
603
|
+
};
|
|
604
|
+
};
|
|
605
|
+
readonly required: readonly ["pod_cidr", "service_cidr", "dual_stack", "pod_cidr_v6", "service_cidr_v6"];
|
|
606
|
+
readonly additionalProperties: false;
|
|
607
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
608
|
+
readonly default: {
|
|
609
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
610
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
611
|
+
readonly dual_stack: false;
|
|
612
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
613
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
614
|
+
};
|
|
402
615
|
};
|
|
403
616
|
readonly id: {
|
|
404
617
|
readonly type: "string";
|
|
@@ -408,16 +621,27 @@ export declare const ClusterSchema: {
|
|
|
408
621
|
};
|
|
409
622
|
readonly status: {
|
|
410
623
|
readonly type: "string";
|
|
411
|
-
readonly description: "Status of the cluster.
|
|
412
|
-
readonly example: "
|
|
413
|
-
readonly enum: readonly ["
|
|
624
|
+
readonly description: "Status of the cluster.";
|
|
625
|
+
readonly example: "deployed";
|
|
626
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
414
627
|
};
|
|
415
628
|
readonly endpoint: {
|
|
416
629
|
readonly anyOf: readonly [{
|
|
417
630
|
readonly type: "string";
|
|
418
631
|
readonly format: "uri";
|
|
419
|
-
readonly description: "URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
420
|
-
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
632
|
+
readonly description: "URL signed by a public CA of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
633
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
634
|
+
}, {
|
|
635
|
+
readonly type: "string";
|
|
636
|
+
readonly enum: readonly [""];
|
|
637
|
+
}];
|
|
638
|
+
};
|
|
639
|
+
readonly endpoint_public: {
|
|
640
|
+
readonly anyOf: readonly [{
|
|
641
|
+
readonly type: "string";
|
|
642
|
+
readonly format: "uri";
|
|
643
|
+
readonly description: "Deprecated alias of `endpoint`; retained for backward compatibility.";
|
|
644
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
421
645
|
}, {
|
|
422
646
|
readonly type: "string";
|
|
423
647
|
readonly enum: readonly [""];
|
|
@@ -448,15 +672,10 @@ export declare const ClusterSchema: {
|
|
|
448
672
|
readonly description: "Indicates if the cluster is ready to be used.";
|
|
449
673
|
readonly example: true;
|
|
450
674
|
};
|
|
451
|
-
readonly version_channel: {
|
|
452
|
-
readonly type: "string";
|
|
453
|
-
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
454
|
-
readonly description: "Version of the kubernetes cluster.";
|
|
455
|
-
readonly example: "1.x.x-cfke.x";
|
|
456
|
-
};
|
|
457
675
|
};
|
|
458
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
676
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
459
677
|
readonly additionalProperties: false;
|
|
678
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
460
679
|
};
|
|
461
680
|
export declare const ClusterUpdateInputSchema: {
|
|
462
681
|
readonly type: "object";
|
|
@@ -472,18 +691,60 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
472
691
|
readonly tier: {
|
|
473
692
|
readonly type: "string";
|
|
474
693
|
readonly description: "Tier of the cluster.";
|
|
694
|
+
readonly default: "basic";
|
|
475
695
|
readonly example: "pro";
|
|
476
|
-
readonly enum: readonly ["basic", "pro"];
|
|
696
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
477
697
|
};
|
|
478
698
|
readonly version_channel: {
|
|
479
699
|
readonly type: "string";
|
|
480
700
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
481
701
|
readonly description: "Version of the kubernetes cluster.";
|
|
702
|
+
readonly default: "1.x.x-cfke.x";
|
|
482
703
|
readonly example: "1.x.x-cfke.x";
|
|
483
704
|
};
|
|
705
|
+
readonly release_channel: {
|
|
706
|
+
readonly type: "string";
|
|
707
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
708
|
+
readonly default: "rapid";
|
|
709
|
+
readonly example: "rapid";
|
|
710
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
711
|
+
};
|
|
712
|
+
readonly features: {
|
|
713
|
+
readonly type: "object";
|
|
714
|
+
readonly properties: {
|
|
715
|
+
readonly gpu_sharing_strategy: {
|
|
716
|
+
readonly type: "string";
|
|
717
|
+
readonly description: "GPU sharing strategy.";
|
|
718
|
+
readonly default: "none";
|
|
719
|
+
readonly example: "none";
|
|
720
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
721
|
+
};
|
|
722
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
723
|
+
readonly type: "integer";
|
|
724
|
+
readonly minimum: 2;
|
|
725
|
+
readonly maximum: 48;
|
|
726
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
727
|
+
readonly default: 4;
|
|
728
|
+
readonly example: 10;
|
|
729
|
+
};
|
|
730
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
731
|
+
readonly type: "boolean";
|
|
732
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
733
|
+
readonly example: false;
|
|
734
|
+
};
|
|
735
|
+
};
|
|
736
|
+
readonly additionalProperties: false;
|
|
737
|
+
readonly description: "Cluster feature toggles.";
|
|
738
|
+
readonly default: {
|
|
739
|
+
readonly gpu_sharing_strategy: "none";
|
|
740
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
741
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
742
|
+
};
|
|
743
|
+
};
|
|
484
744
|
};
|
|
485
|
-
readonly required: readonly ["
|
|
745
|
+
readonly required: readonly ["name"];
|
|
486
746
|
readonly additionalProperties: false;
|
|
747
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
487
748
|
};
|
|
488
749
|
export declare const FleetCreateInputSchema: {
|
|
489
750
|
readonly type: "object";
|
|
@@ -492,13 +753,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
492
753
|
readonly type: "object";
|
|
493
754
|
readonly properties: {
|
|
494
755
|
readonly cpu: {
|
|
495
|
-
readonly type: "
|
|
496
|
-
readonly format: "float";
|
|
756
|
+
readonly type: "integer";
|
|
497
757
|
readonly minimum: 0;
|
|
498
|
-
readonly
|
|
758
|
+
readonly maximum: 100000;
|
|
759
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
499
760
|
};
|
|
500
761
|
};
|
|
501
|
-
readonly required: readonly ["cpu"];
|
|
502
762
|
readonly additionalProperties: false;
|
|
503
763
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
504
764
|
};
|
|
@@ -507,14 +767,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
507
767
|
readonly properties: {
|
|
508
768
|
readonly enabled: {
|
|
509
769
|
readonly type: "boolean";
|
|
510
|
-
readonly default: true;
|
|
511
770
|
};
|
|
512
771
|
readonly project: {
|
|
513
772
|
readonly type: "string";
|
|
514
|
-
readonly
|
|
773
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
774
|
+
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.";
|
|
775
|
+
readonly example: "my-cloudfleet-project";
|
|
515
776
|
};
|
|
516
777
|
};
|
|
517
|
-
readonly required: readonly ["
|
|
778
|
+
readonly required: readonly ["enabled"];
|
|
518
779
|
readonly additionalProperties: false;
|
|
519
780
|
};
|
|
520
781
|
readonly hetzner: {
|
|
@@ -522,14 +783,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
522
783
|
readonly properties: {
|
|
523
784
|
readonly enabled: {
|
|
524
785
|
readonly type: "boolean";
|
|
525
|
-
readonly default: true;
|
|
526
786
|
};
|
|
527
787
|
readonly apiKey: {
|
|
528
788
|
readonly type: "string";
|
|
529
|
-
readonly
|
|
789
|
+
readonly maxLength: 64;
|
|
790
|
+
readonly minLength: 64;
|
|
791
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
792
|
+
readonly description: "Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.";
|
|
530
793
|
};
|
|
531
794
|
};
|
|
532
|
-
readonly required: readonly ["
|
|
795
|
+
readonly required: readonly ["enabled"];
|
|
533
796
|
readonly additionalProperties: false;
|
|
534
797
|
};
|
|
535
798
|
readonly aws: {
|
|
@@ -537,15 +800,74 @@ export declare const FleetCreateInputSchema: {
|
|
|
537
800
|
readonly properties: {
|
|
538
801
|
readonly enabled: {
|
|
539
802
|
readonly type: "boolean";
|
|
540
|
-
readonly default: true;
|
|
541
803
|
};
|
|
542
804
|
readonly controllerRoleArn: {
|
|
543
805
|
readonly type: "string";
|
|
544
|
-
readonly
|
|
806
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
807
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
808
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
809
|
+
};
|
|
810
|
+
};
|
|
811
|
+
readonly required: readonly ["enabled"];
|
|
812
|
+
readonly additionalProperties: false;
|
|
813
|
+
};
|
|
814
|
+
readonly constraints: {
|
|
815
|
+
readonly type: "object";
|
|
816
|
+
readonly properties: {
|
|
817
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
818
|
+
readonly type: "array";
|
|
819
|
+
readonly items: {
|
|
820
|
+
readonly type: "string";
|
|
821
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
822
|
+
};
|
|
823
|
+
readonly minItems: 1;
|
|
824
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
825
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
826
|
+
};
|
|
827
|
+
readonly 'kubernetes.io/arch': {
|
|
828
|
+
readonly type: "array";
|
|
829
|
+
readonly items: {
|
|
830
|
+
readonly type: "string";
|
|
831
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
832
|
+
};
|
|
833
|
+
readonly minItems: 1;
|
|
834
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
835
|
+
readonly default: readonly ["amd64"];
|
|
836
|
+
};
|
|
837
|
+
readonly 'cfke.io/instance-family': {
|
|
838
|
+
readonly type: "array";
|
|
839
|
+
readonly items: {
|
|
840
|
+
readonly type: "string";
|
|
841
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
842
|
+
};
|
|
843
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
844
|
+
readonly default: readonly [];
|
|
845
|
+
};
|
|
846
|
+
readonly 'topology.kubernetes.io/region': {
|
|
847
|
+
readonly type: "array";
|
|
848
|
+
readonly items: {
|
|
849
|
+
readonly type: "string";
|
|
850
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
851
|
+
};
|
|
852
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
853
|
+
readonly default: readonly [];
|
|
545
854
|
};
|
|
546
855
|
};
|
|
547
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
548
856
|
readonly additionalProperties: false;
|
|
857
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
858
|
+
readonly default: {
|
|
859
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
860
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
861
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
862
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
863
|
+
};
|
|
864
|
+
};
|
|
865
|
+
readonly scalingProfile: {
|
|
866
|
+
readonly type: "string";
|
|
867
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
868
|
+
readonly default: "conservative";
|
|
869
|
+
readonly example: "conservative";
|
|
870
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
549
871
|
};
|
|
550
872
|
readonly id: {
|
|
551
873
|
readonly type: "string";
|
|
@@ -558,6 +880,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
558
880
|
};
|
|
559
881
|
readonly required: readonly ["id"];
|
|
560
882
|
readonly additionalProperties: false;
|
|
883
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
561
884
|
};
|
|
562
885
|
export declare const FleetSchema: {
|
|
563
886
|
readonly type: "object";
|
|
@@ -566,13 +889,12 @@ export declare const FleetSchema: {
|
|
|
566
889
|
readonly type: "object";
|
|
567
890
|
readonly properties: {
|
|
568
891
|
readonly cpu: {
|
|
569
|
-
readonly type: "
|
|
570
|
-
readonly format: "float";
|
|
892
|
+
readonly type: "integer";
|
|
571
893
|
readonly minimum: 0;
|
|
572
|
-
readonly
|
|
894
|
+
readonly maximum: 100000;
|
|
895
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
573
896
|
};
|
|
574
897
|
};
|
|
575
|
-
readonly required: readonly ["cpu"];
|
|
576
898
|
readonly additionalProperties: false;
|
|
577
899
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
578
900
|
};
|
|
@@ -581,14 +903,15 @@ export declare const FleetSchema: {
|
|
|
581
903
|
readonly properties: {
|
|
582
904
|
readonly enabled: {
|
|
583
905
|
readonly type: "boolean";
|
|
584
|
-
readonly default: true;
|
|
585
906
|
};
|
|
586
907
|
readonly project: {
|
|
587
908
|
readonly type: "string";
|
|
588
|
-
readonly
|
|
909
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
910
|
+
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.";
|
|
911
|
+
readonly example: "my-cloudfleet-project";
|
|
589
912
|
};
|
|
590
913
|
};
|
|
591
|
-
readonly required: readonly ["
|
|
914
|
+
readonly required: readonly ["enabled"];
|
|
592
915
|
readonly additionalProperties: false;
|
|
593
916
|
};
|
|
594
917
|
readonly hetzner: {
|
|
@@ -596,14 +919,14 @@ export declare const FleetSchema: {
|
|
|
596
919
|
readonly properties: {
|
|
597
920
|
readonly enabled: {
|
|
598
921
|
readonly type: "boolean";
|
|
599
|
-
readonly default: true;
|
|
600
922
|
};
|
|
601
923
|
readonly apiKey: {
|
|
602
924
|
readonly type: "string";
|
|
603
|
-
readonly
|
|
925
|
+
readonly pattern: "^\\*{64}$";
|
|
926
|
+
readonly description: "Redacted Hetzner API token. Returned as 64 asterisks when a token is configured; omitted otherwise. The real value is never echoed by the API.";
|
|
604
927
|
};
|
|
605
928
|
};
|
|
606
|
-
readonly required: readonly ["
|
|
929
|
+
readonly required: readonly ["enabled"];
|
|
607
930
|
readonly additionalProperties: false;
|
|
608
931
|
};
|
|
609
932
|
readonly aws: {
|
|
@@ -611,15 +934,75 @@ export declare const FleetSchema: {
|
|
|
611
934
|
readonly properties: {
|
|
612
935
|
readonly enabled: {
|
|
613
936
|
readonly type: "boolean";
|
|
614
|
-
readonly default: true;
|
|
615
937
|
};
|
|
616
938
|
readonly controllerRoleArn: {
|
|
617
939
|
readonly type: "string";
|
|
618
|
-
readonly
|
|
940
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
941
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
942
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
943
|
+
};
|
|
944
|
+
};
|
|
945
|
+
readonly required: readonly ["enabled"];
|
|
946
|
+
readonly additionalProperties: false;
|
|
947
|
+
};
|
|
948
|
+
readonly constraints: {
|
|
949
|
+
readonly type: "object";
|
|
950
|
+
readonly properties: {
|
|
951
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
952
|
+
readonly type: "array";
|
|
953
|
+
readonly items: {
|
|
954
|
+
readonly type: "string";
|
|
955
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
956
|
+
};
|
|
957
|
+
readonly minItems: 1;
|
|
958
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
959
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
960
|
+
};
|
|
961
|
+
readonly 'kubernetes.io/arch': {
|
|
962
|
+
readonly type: "array";
|
|
963
|
+
readonly items: {
|
|
964
|
+
readonly type: "string";
|
|
965
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
966
|
+
};
|
|
967
|
+
readonly minItems: 1;
|
|
968
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
969
|
+
readonly default: readonly ["amd64"];
|
|
970
|
+
};
|
|
971
|
+
readonly 'cfke.io/instance-family': {
|
|
972
|
+
readonly type: "array";
|
|
973
|
+
readonly items: {
|
|
974
|
+
readonly type: "string";
|
|
975
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
976
|
+
};
|
|
977
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
978
|
+
readonly default: readonly [];
|
|
979
|
+
};
|
|
980
|
+
readonly 'topology.kubernetes.io/region': {
|
|
981
|
+
readonly type: "array";
|
|
982
|
+
readonly items: {
|
|
983
|
+
readonly type: "string";
|
|
984
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
985
|
+
};
|
|
986
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
987
|
+
readonly default: readonly [];
|
|
619
988
|
};
|
|
620
989
|
};
|
|
621
|
-
readonly required: readonly ["
|
|
990
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
622
991
|
readonly additionalProperties: false;
|
|
992
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
993
|
+
readonly default: {
|
|
994
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
995
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
996
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
997
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
998
|
+
};
|
|
999
|
+
};
|
|
1000
|
+
readonly scalingProfile: {
|
|
1001
|
+
readonly type: "string";
|
|
1002
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
1003
|
+
readonly default: "conservative";
|
|
1004
|
+
readonly example: "conservative";
|
|
1005
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
623
1006
|
};
|
|
624
1007
|
readonly id: {
|
|
625
1008
|
readonly type: "string";
|
|
@@ -629,9 +1012,30 @@ export declare const FleetSchema: {
|
|
|
629
1012
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
630
1013
|
readonly example: "new-clouds-fleet";
|
|
631
1014
|
};
|
|
1015
|
+
readonly ready: {
|
|
1016
|
+
readonly type: "boolean";
|
|
1017
|
+
readonly description: "Indicates whether the fleet configuration is healthy.";
|
|
1018
|
+
readonly example: true;
|
|
1019
|
+
};
|
|
1020
|
+
readonly status_message: {
|
|
1021
|
+
readonly type: "string";
|
|
1022
|
+
readonly description: "Human-readable reason the fleet is not ready. Present only when `ready` is false.";
|
|
1023
|
+
readonly example: "Invalid provider permissions.";
|
|
1024
|
+
};
|
|
1025
|
+
readonly created_at: {
|
|
1026
|
+
readonly type: "string";
|
|
1027
|
+
readonly description: "Creation date and time of the fleet.";
|
|
1028
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1029
|
+
};
|
|
1030
|
+
readonly updated_at: {
|
|
1031
|
+
readonly type: "string";
|
|
1032
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
1033
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1034
|
+
};
|
|
632
1035
|
};
|
|
633
|
-
readonly required: readonly ["id"];
|
|
1036
|
+
readonly required: readonly ["constraints", "scalingProfile", "id", "ready", "created_at", "updated_at"];
|
|
634
1037
|
readonly additionalProperties: false;
|
|
1038
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
635
1039
|
};
|
|
636
1040
|
export declare const FleetUpdateInputSchema: {
|
|
637
1041
|
readonly type: "object";
|
|
@@ -640,13 +1044,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
640
1044
|
readonly type: "object";
|
|
641
1045
|
readonly properties: {
|
|
642
1046
|
readonly cpu: {
|
|
643
|
-
readonly type: "
|
|
644
|
-
readonly format: "float";
|
|
1047
|
+
readonly type: "integer";
|
|
645
1048
|
readonly minimum: 0;
|
|
646
|
-
readonly
|
|
1049
|
+
readonly maximum: 100000;
|
|
1050
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
647
1051
|
};
|
|
648
1052
|
};
|
|
649
|
-
readonly required: readonly ["cpu"];
|
|
650
1053
|
readonly additionalProperties: false;
|
|
651
1054
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
652
1055
|
};
|
|
@@ -655,14 +1058,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
655
1058
|
readonly properties: {
|
|
656
1059
|
readonly enabled: {
|
|
657
1060
|
readonly type: "boolean";
|
|
658
|
-
readonly default: true;
|
|
659
1061
|
};
|
|
660
1062
|
readonly project: {
|
|
661
1063
|
readonly type: "string";
|
|
662
|
-
readonly
|
|
1064
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
1065
|
+
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.";
|
|
1066
|
+
readonly example: "my-cloudfleet-project";
|
|
663
1067
|
};
|
|
664
1068
|
};
|
|
665
|
-
readonly required: readonly ["
|
|
1069
|
+
readonly required: readonly ["enabled"];
|
|
666
1070
|
readonly additionalProperties: false;
|
|
667
1071
|
};
|
|
668
1072
|
readonly hetzner: {
|
|
@@ -670,14 +1074,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
670
1074
|
readonly properties: {
|
|
671
1075
|
readonly enabled: {
|
|
672
1076
|
readonly type: "boolean";
|
|
673
|
-
readonly default: true;
|
|
674
1077
|
};
|
|
675
1078
|
readonly apiKey: {
|
|
676
1079
|
readonly type: "string";
|
|
677
|
-
readonly
|
|
1080
|
+
readonly maxLength: 64;
|
|
1081
|
+
readonly minLength: 64;
|
|
1082
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
1083
|
+
readonly description: "Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.";
|
|
678
1084
|
};
|
|
679
1085
|
};
|
|
680
|
-
readonly required: readonly ["
|
|
1086
|
+
readonly required: readonly ["enabled"];
|
|
681
1087
|
readonly additionalProperties: false;
|
|
682
1088
|
};
|
|
683
1089
|
readonly aws: {
|
|
@@ -685,17 +1091,97 @@ export declare const FleetUpdateInputSchema: {
|
|
|
685
1091
|
readonly properties: {
|
|
686
1092
|
readonly enabled: {
|
|
687
1093
|
readonly type: "boolean";
|
|
688
|
-
readonly default: true;
|
|
689
1094
|
};
|
|
690
1095
|
readonly controllerRoleArn: {
|
|
691
1096
|
readonly type: "string";
|
|
692
|
-
readonly
|
|
1097
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
1098
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
1099
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
1100
|
+
};
|
|
1101
|
+
};
|
|
1102
|
+
readonly required: readonly ["enabled"];
|
|
1103
|
+
readonly additionalProperties: false;
|
|
1104
|
+
};
|
|
1105
|
+
readonly constraints: {
|
|
1106
|
+
readonly type: "object";
|
|
1107
|
+
readonly properties: {
|
|
1108
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
1109
|
+
readonly type: "array";
|
|
1110
|
+
readonly items: {
|
|
1111
|
+
readonly type: "string";
|
|
1112
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
1113
|
+
};
|
|
1114
|
+
readonly minItems: 1;
|
|
1115
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1116
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
1117
|
+
};
|
|
1118
|
+
readonly 'kubernetes.io/arch': {
|
|
1119
|
+
readonly type: "array";
|
|
1120
|
+
readonly items: {
|
|
1121
|
+
readonly type: "string";
|
|
1122
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
1123
|
+
};
|
|
1124
|
+
readonly minItems: 1;
|
|
1125
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1126
|
+
readonly default: readonly ["amd64"];
|
|
1127
|
+
};
|
|
1128
|
+
readonly 'cfke.io/instance-family': {
|
|
1129
|
+
readonly type: "array";
|
|
1130
|
+
readonly items: {
|
|
1131
|
+
readonly type: "string";
|
|
1132
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
1133
|
+
};
|
|
1134
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1135
|
+
readonly default: readonly [];
|
|
1136
|
+
};
|
|
1137
|
+
readonly 'topology.kubernetes.io/region': {
|
|
1138
|
+
readonly type: "array";
|
|
1139
|
+
readonly items: {
|
|
1140
|
+
readonly type: "string";
|
|
1141
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
1142
|
+
};
|
|
1143
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1144
|
+
readonly default: readonly [];
|
|
693
1145
|
};
|
|
694
1146
|
};
|
|
695
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
696
1147
|
readonly additionalProperties: false;
|
|
1148
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
1149
|
+
readonly default: {
|
|
1150
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1151
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1152
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1153
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1154
|
+
};
|
|
1155
|
+
};
|
|
1156
|
+
readonly scalingProfile: {
|
|
1157
|
+
readonly type: "string";
|
|
1158
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
1159
|
+
readonly default: "conservative";
|
|
1160
|
+
readonly example: "conservative";
|
|
1161
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
1162
|
+
};
|
|
1163
|
+
};
|
|
1164
|
+
readonly additionalProperties: false;
|
|
1165
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
1166
|
+
};
|
|
1167
|
+
export declare const InviteCreateInputSchema: {
|
|
1168
|
+
readonly type: "object";
|
|
1169
|
+
readonly properties: {
|
|
1170
|
+
readonly email: {
|
|
1171
|
+
readonly type: "string";
|
|
1172
|
+
readonly format: "email";
|
|
1173
|
+
readonly description: "Email address of the user to invite.";
|
|
1174
|
+
readonly example: "email@example.com";
|
|
1175
|
+
};
|
|
1176
|
+
readonly role: {
|
|
1177
|
+
readonly type: "string";
|
|
1178
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1179
|
+
readonly default: "User";
|
|
1180
|
+
readonly example: "User";
|
|
1181
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
697
1182
|
};
|
|
698
1183
|
};
|
|
1184
|
+
readonly required: readonly ["email"];
|
|
699
1185
|
readonly additionalProperties: false;
|
|
700
1186
|
};
|
|
701
1187
|
export declare const InviteSchema: {
|
|
@@ -729,6 +1215,13 @@ export declare const InviteSchema: {
|
|
|
729
1215
|
readonly description: "Generated unique invite code.";
|
|
730
1216
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
731
1217
|
};
|
|
1218
|
+
readonly role: {
|
|
1219
|
+
readonly type: "string";
|
|
1220
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1221
|
+
readonly default: "User";
|
|
1222
|
+
readonly example: "User";
|
|
1223
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1224
|
+
};
|
|
732
1225
|
};
|
|
733
1226
|
readonly required: readonly ["date_created"];
|
|
734
1227
|
readonly additionalProperties: false;
|
|
@@ -926,6 +1419,12 @@ export declare const MarketplaceListingSchema: {
|
|
|
926
1419
|
export declare const OrganizationCreateInputSchema: {
|
|
927
1420
|
readonly type: "object";
|
|
928
1421
|
readonly properties: {
|
|
1422
|
+
readonly type: {
|
|
1423
|
+
readonly type: "string";
|
|
1424
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1425
|
+
readonly example: "business";
|
|
1426
|
+
readonly enum: readonly ["business", "personal"];
|
|
1427
|
+
};
|
|
929
1428
|
readonly email: {
|
|
930
1429
|
readonly type: "string";
|
|
931
1430
|
readonly format: "email";
|
|
@@ -934,11 +1433,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
934
1433
|
};
|
|
935
1434
|
readonly first_name: {
|
|
936
1435
|
readonly type: "string";
|
|
1436
|
+
readonly minLength: 1;
|
|
937
1437
|
readonly description: "First name of the billing contact person.";
|
|
938
1438
|
readonly example: "John";
|
|
939
1439
|
};
|
|
940
1440
|
readonly last_name: {
|
|
941
1441
|
readonly type: "string";
|
|
1442
|
+
readonly minLength: 1;
|
|
942
1443
|
readonly description: "Last name of the billing contact person.";
|
|
943
1444
|
readonly example: "Doe";
|
|
944
1445
|
};
|
|
@@ -956,7 +1457,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
956
1457
|
readonly description: "Password for the root account. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.";
|
|
957
1458
|
};
|
|
958
1459
|
};
|
|
959
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1460
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1461
|
+
readonly additionalProperties: false;
|
|
1462
|
+
};
|
|
1463
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1464
|
+
readonly type: "object";
|
|
1465
|
+
readonly properties: {
|
|
1466
|
+
readonly id: {
|
|
1467
|
+
readonly type: "string";
|
|
1468
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1469
|
+
readonly example: "organization-id";
|
|
1470
|
+
};
|
|
1471
|
+
};
|
|
1472
|
+
readonly required: readonly ["id"];
|
|
960
1473
|
readonly additionalProperties: false;
|
|
961
1474
|
};
|
|
962
1475
|
export declare const OrganizationSchema: {
|
|
@@ -975,6 +1488,12 @@ export declare const OrganizationSchema: {
|
|
|
975
1488
|
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
976
1489
|
readonly example: "ACME Corp.";
|
|
977
1490
|
};
|
|
1491
|
+
readonly type: {
|
|
1492
|
+
readonly type: "string";
|
|
1493
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1494
|
+
readonly example: "business";
|
|
1495
|
+
readonly enum: readonly ["business", "personal"];
|
|
1496
|
+
};
|
|
978
1497
|
readonly date_created: {
|
|
979
1498
|
readonly type: "string";
|
|
980
1499
|
readonly format: "date-time";
|
|
@@ -1006,6 +1525,17 @@ export declare const OrganizationSchema: {
|
|
|
1006
1525
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1007
1526
|
readonly example: 999;
|
|
1008
1527
|
};
|
|
1528
|
+
readonly enterprise_clusters_max: {
|
|
1529
|
+
readonly type: "integer";
|
|
1530
|
+
readonly minimum: 0;
|
|
1531
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1532
|
+
readonly example: 999;
|
|
1533
|
+
};
|
|
1534
|
+
readonly enterprise_clusters_available: {
|
|
1535
|
+
readonly type: "integer";
|
|
1536
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1537
|
+
readonly example: 999;
|
|
1538
|
+
};
|
|
1009
1539
|
readonly fleets_max: {
|
|
1010
1540
|
readonly type: "integer";
|
|
1011
1541
|
readonly minimum: 0;
|
|
@@ -1025,7 +1555,7 @@ export declare const OrganizationSchema: {
|
|
|
1025
1555
|
readonly type: "array";
|
|
1026
1556
|
readonly items: {
|
|
1027
1557
|
readonly type: "string";
|
|
1028
|
-
readonly example: "northamerica-central-
|
|
1558
|
+
readonly example: "northamerica-central-1a";
|
|
1029
1559
|
};
|
|
1030
1560
|
readonly minItems: 1;
|
|
1031
1561
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1052,18 +1582,6 @@ export declare const OrganizationSchema: {
|
|
|
1052
1582
|
readonly minItems: 1;
|
|
1053
1583
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1054
1584
|
};
|
|
1055
|
-
readonly copilot_user_hourly_tokens: {
|
|
1056
|
-
readonly type: "integer";
|
|
1057
|
-
readonly minimum: 0;
|
|
1058
|
-
readonly description: "User-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1059
|
-
readonly example: 42000;
|
|
1060
|
-
};
|
|
1061
|
-
readonly copilot_organization_hourly_tokens: {
|
|
1062
|
-
readonly type: "integer";
|
|
1063
|
-
readonly minimum: 0;
|
|
1064
|
-
readonly description: "Organization-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1065
|
-
readonly example: 242000;
|
|
1066
|
-
};
|
|
1067
1585
|
readonly cfcr_storage_gb: {
|
|
1068
1586
|
readonly type: "integer";
|
|
1069
1587
|
readonly minimum: -1;
|
|
@@ -1071,7 +1589,7 @@ export declare const OrganizationSchema: {
|
|
|
1071
1589
|
readonly example: 500;
|
|
1072
1590
|
};
|
|
1073
1591
|
};
|
|
1074
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "
|
|
1592
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "enterprise_clusters_max", "enterprise_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1075
1593
|
readonly additionalProperties: false;
|
|
1076
1594
|
readonly description: "For security reasons, platform quota is controlled by Cloudfleet and can be updated only by Cloudfleet administrators. Please open a support ticket if you need to change the platform quota.";
|
|
1077
1595
|
};
|
|
@@ -1080,8 +1598,14 @@ export declare const OrganizationSchema: {
|
|
|
1080
1598
|
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1081
1599
|
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1082
1600
|
};
|
|
1601
|
+
readonly verification: {
|
|
1602
|
+
readonly type: "string";
|
|
1603
|
+
readonly description: "Verification status of the organization, which determines the assigned quota. `none` when billing information is incomplete, `submitted` when billing information is complete but the organization is not yet verified, `verified` when the organization is verified.";
|
|
1604
|
+
readonly example: "verified";
|
|
1605
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1606
|
+
};
|
|
1083
1607
|
};
|
|
1084
|
-
readonly required: readonly ["id", "date_created", "quota", "status"];
|
|
1608
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1085
1609
|
readonly additionalProperties: false;
|
|
1086
1610
|
};
|
|
1087
1611
|
export declare const PaymentMethodSchema: {
|
|
@@ -1089,26 +1613,19 @@ export declare const PaymentMethodSchema: {
|
|
|
1089
1613
|
readonly properties: {
|
|
1090
1614
|
readonly id: {
|
|
1091
1615
|
readonly type: "string";
|
|
1092
|
-
readonly
|
|
1093
|
-
readonly
|
|
1094
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1095
|
-
};
|
|
1096
|
-
readonly setup: {
|
|
1097
|
-
readonly type: "boolean";
|
|
1098
|
-
readonly description: "Whether organization payment method was set up and ready to use for payments.";
|
|
1099
|
-
readonly example: true;
|
|
1616
|
+
readonly description: "Payment method identifier. Stripe payment method id for cards/SEPA; the constant `bank_transfer` for the invoice/bank-transfer method. Used to set as default or delete the payment method.";
|
|
1617
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1100
1618
|
};
|
|
1101
1619
|
readonly type: {
|
|
1102
1620
|
readonly type: "string";
|
|
1103
|
-
readonly
|
|
1104
|
-
readonly description: "Payment method type type. Only `card` payments supported at the moment.";
|
|
1621
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1105
1622
|
readonly example: "card";
|
|
1106
|
-
readonly enum: readonly ["card"];
|
|
1623
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1107
1624
|
};
|
|
1108
1625
|
readonly last4: {
|
|
1109
1626
|
readonly type: "string";
|
|
1110
1627
|
readonly nullable: true;
|
|
1111
|
-
readonly description: "Last 4 digits of the payment card number.";
|
|
1628
|
+
readonly description: "Last 4 digits of the payment card number, of the bank account (IBAN) for SEPA Direct Debit, or of the destination IBAN for bank transfer.";
|
|
1112
1629
|
readonly example: "4242";
|
|
1113
1630
|
};
|
|
1114
1631
|
readonly exp_month: {
|
|
@@ -1116,25 +1633,46 @@ export declare const PaymentMethodSchema: {
|
|
|
1116
1633
|
readonly minimum: 1;
|
|
1117
1634
|
readonly maximum: 12;
|
|
1118
1635
|
readonly nullable: true;
|
|
1119
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1120
|
-
readonly example:
|
|
1636
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1637
|
+
readonly example: 12;
|
|
1121
1638
|
};
|
|
1122
1639
|
readonly exp_year: {
|
|
1123
1640
|
readonly type: "integer";
|
|
1124
|
-
readonly minimum: 2024;
|
|
1125
1641
|
readonly nullable: true;
|
|
1126
|
-
readonly description: "Four-digit number representing the card's expiration year.";
|
|
1127
|
-
readonly example:
|
|
1642
|
+
readonly description: "Four-digit number representing the card's expiration year. May be in the past for an expired card still on file. Null for SEPA Direct Debit and bank transfer.";
|
|
1643
|
+
readonly example: 2028;
|
|
1128
1644
|
};
|
|
1129
1645
|
readonly brand: {
|
|
1130
1646
|
readonly type: "string";
|
|
1131
1647
|
readonly nullable: true;
|
|
1132
|
-
readonly description: "Payment card brand
|
|
1648
|
+
readonly description: "Payment card brand as reported by Stripe, e.g. `visa`, `mastercard`, `amex`, `cartes_bancaires`, or `unknown`. Null for SEPA Direct Debit and bank transfer.";
|
|
1133
1649
|
readonly example: "visa";
|
|
1134
|
-
|
|
1650
|
+
};
|
|
1651
|
+
readonly iban: {
|
|
1652
|
+
readonly type: "string";
|
|
1653
|
+
readonly nullable: true;
|
|
1654
|
+
readonly description: "Full destination IBAN to send bank transfers to. Set only for `bank_transfer`; null otherwise. This is Cloudfleet's virtual receiving account, shown in full so the customer can pay into it.";
|
|
1655
|
+
readonly example: "DE11243015658023127510";
|
|
1656
|
+
};
|
|
1657
|
+
readonly bic: {
|
|
1658
|
+
readonly type: "string";
|
|
1659
|
+
readonly nullable: true;
|
|
1660
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1661
|
+
readonly example: "SOGEDEFFXXX";
|
|
1662
|
+
};
|
|
1663
|
+
readonly account_holder_name: {
|
|
1664
|
+
readonly type: "string";
|
|
1665
|
+
readonly nullable: true;
|
|
1666
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1667
|
+
readonly example: "Cloudfleet GmbH";
|
|
1668
|
+
};
|
|
1669
|
+
readonly is_default: {
|
|
1670
|
+
readonly type: "boolean";
|
|
1671
|
+
readonly description: "Whether this payment method is the default used for invoices and active subscriptions. Always false for `bank_transfer` (it cannot be a Stripe default payment method).";
|
|
1672
|
+
readonly example: true;
|
|
1135
1673
|
};
|
|
1136
1674
|
};
|
|
1137
|
-
readonly required: readonly ["id", "
|
|
1675
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1138
1676
|
readonly additionalProperties: false;
|
|
1139
1677
|
};
|
|
1140
1678
|
export declare const PlatformQuotaSchema: {
|
|
@@ -1162,6 +1700,17 @@ export declare const PlatformQuotaSchema: {
|
|
|
1162
1700
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1163
1701
|
readonly example: 999;
|
|
1164
1702
|
};
|
|
1703
|
+
readonly enterprise_clusters_max: {
|
|
1704
|
+
readonly type: "integer";
|
|
1705
|
+
readonly minimum: 0;
|
|
1706
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1707
|
+
readonly example: 999;
|
|
1708
|
+
};
|
|
1709
|
+
readonly enterprise_clusters_available: {
|
|
1710
|
+
readonly type: "integer";
|
|
1711
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1712
|
+
readonly example: 999;
|
|
1713
|
+
};
|
|
1165
1714
|
readonly fleets_max: {
|
|
1166
1715
|
readonly type: "integer";
|
|
1167
1716
|
readonly minimum: 0;
|
|
@@ -1181,7 +1730,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1181
1730
|
readonly type: "array";
|
|
1182
1731
|
readonly items: {
|
|
1183
1732
|
readonly type: "string";
|
|
1184
|
-
readonly example: "northamerica-central-
|
|
1733
|
+
readonly example: "northamerica-central-1a";
|
|
1185
1734
|
};
|
|
1186
1735
|
readonly minItems: 1;
|
|
1187
1736
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1208,18 +1757,6 @@ export declare const PlatformQuotaSchema: {
|
|
|
1208
1757
|
readonly minItems: 1;
|
|
1209
1758
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1210
1759
|
};
|
|
1211
|
-
readonly copilot_user_hourly_tokens: {
|
|
1212
|
-
readonly type: "integer";
|
|
1213
|
-
readonly minimum: 0;
|
|
1214
|
-
readonly description: "User-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1215
|
-
readonly example: 42000;
|
|
1216
|
-
};
|
|
1217
|
-
readonly copilot_organization_hourly_tokens: {
|
|
1218
|
-
readonly type: "integer";
|
|
1219
|
-
readonly minimum: 0;
|
|
1220
|
-
readonly description: "Organization-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1221
|
-
readonly example: 242000;
|
|
1222
|
-
};
|
|
1223
1760
|
readonly cfcr_storage_gb: {
|
|
1224
1761
|
readonly type: "integer";
|
|
1225
1762
|
readonly minimum: -1;
|
|
@@ -1227,7 +1764,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1227
1764
|
readonly example: 500;
|
|
1228
1765
|
};
|
|
1229
1766
|
};
|
|
1230
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "
|
|
1767
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "enterprise_clusters_max", "enterprise_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1231
1768
|
readonly additionalProperties: false;
|
|
1232
1769
|
};
|
|
1233
1770
|
export declare const RegistryRepositorySchema: {
|
|
@@ -1461,6 +1998,274 @@ export declare const RegistryTagSchema: {
|
|
|
1461
1998
|
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
1462
1999
|
readonly additionalProperties: false;
|
|
1463
2000
|
};
|
|
2001
|
+
export declare const TicketAttachmentSchema: {
|
|
2002
|
+
readonly type: "object";
|
|
2003
|
+
readonly properties: {
|
|
2004
|
+
readonly id: {
|
|
2005
|
+
readonly type: "string";
|
|
2006
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2007
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2008
|
+
};
|
|
2009
|
+
readonly filename: {
|
|
2010
|
+
readonly type: "string";
|
|
2011
|
+
readonly description: "Original filename as uploaded.";
|
|
2012
|
+
readonly example: "debug.log";
|
|
2013
|
+
};
|
|
2014
|
+
readonly content_type: {
|
|
2015
|
+
readonly type: "string";
|
|
2016
|
+
readonly description: "MIME content type of the attachment.";
|
|
2017
|
+
readonly example: "text/plain";
|
|
2018
|
+
};
|
|
2019
|
+
readonly size: {
|
|
2020
|
+
readonly type: "integer";
|
|
2021
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2022
|
+
readonly example: 12345;
|
|
2023
|
+
};
|
|
2024
|
+
};
|
|
2025
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2026
|
+
readonly additionalProperties: false;
|
|
2027
|
+
};
|
|
2028
|
+
export declare const TicketCreateInputSchema: {
|
|
2029
|
+
readonly type: "object";
|
|
2030
|
+
readonly properties: {
|
|
2031
|
+
readonly category: {
|
|
2032
|
+
readonly type: "string";
|
|
2033
|
+
readonly description: "Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.";
|
|
2034
|
+
readonly example: "technical";
|
|
2035
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2036
|
+
};
|
|
2037
|
+
readonly body: {
|
|
2038
|
+
readonly type: "string";
|
|
2039
|
+
readonly maxLength: 50000;
|
|
2040
|
+
readonly minLength: 1;
|
|
2041
|
+
readonly pattern: "\\S";
|
|
2042
|
+
readonly description: "Initial message body in markdown. There is no separate subject — the first message body is the description.";
|
|
2043
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2044
|
+
};
|
|
2045
|
+
readonly properties: {
|
|
2046
|
+
readonly type: "object";
|
|
2047
|
+
readonly additionalProperties: true;
|
|
2048
|
+
readonly description: "Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).";
|
|
2049
|
+
readonly example: {
|
|
2050
|
+
readonly subcategory: "cluster-question";
|
|
2051
|
+
readonly cluster_id: "60c72b2f9f1b2c001f8e4d3a";
|
|
2052
|
+
};
|
|
2053
|
+
};
|
|
2054
|
+
};
|
|
2055
|
+
readonly required: readonly ["category", "body"];
|
|
2056
|
+
readonly additionalProperties: false;
|
|
2057
|
+
};
|
|
2058
|
+
export declare const TicketMessageInputSchema: {
|
|
2059
|
+
readonly type: "object";
|
|
2060
|
+
readonly properties: {
|
|
2061
|
+
readonly body: {
|
|
2062
|
+
readonly type: "string";
|
|
2063
|
+
readonly maxLength: 50000;
|
|
2064
|
+
readonly minLength: 1;
|
|
2065
|
+
readonly pattern: "\\S";
|
|
2066
|
+
readonly description: "Reply body in markdown.";
|
|
2067
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2068
|
+
};
|
|
2069
|
+
};
|
|
2070
|
+
readonly required: readonly ["body"];
|
|
2071
|
+
readonly additionalProperties: false;
|
|
2072
|
+
};
|
|
2073
|
+
export declare const TicketMessageSchema: {
|
|
2074
|
+
readonly type: "object";
|
|
2075
|
+
readonly properties: {
|
|
2076
|
+
readonly id: {
|
|
2077
|
+
readonly type: "string";
|
|
2078
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2079
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2080
|
+
};
|
|
2081
|
+
readonly type: {
|
|
2082
|
+
readonly type: "string";
|
|
2083
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2084
|
+
readonly example: "customer_reply";
|
|
2085
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2086
|
+
};
|
|
2087
|
+
readonly body: {
|
|
2088
|
+
readonly type: "string";
|
|
2089
|
+
readonly description: "Message body in markdown.";
|
|
2090
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2091
|
+
};
|
|
2092
|
+
readonly author_first_name: {
|
|
2093
|
+
readonly type: "string";
|
|
2094
|
+
readonly nullable: true;
|
|
2095
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2096
|
+
readonly example: "Jane";
|
|
2097
|
+
};
|
|
2098
|
+
readonly author_last_name: {
|
|
2099
|
+
readonly type: "string";
|
|
2100
|
+
readonly nullable: true;
|
|
2101
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2102
|
+
readonly example: "Doe";
|
|
2103
|
+
};
|
|
2104
|
+
readonly attachments: {
|
|
2105
|
+
readonly type: "array";
|
|
2106
|
+
readonly items: {
|
|
2107
|
+
readonly type: "object";
|
|
2108
|
+
readonly properties: {
|
|
2109
|
+
readonly id: {
|
|
2110
|
+
readonly type: "string";
|
|
2111
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2112
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2113
|
+
};
|
|
2114
|
+
readonly filename: {
|
|
2115
|
+
readonly type: "string";
|
|
2116
|
+
readonly description: "Original filename as uploaded.";
|
|
2117
|
+
readonly example: "debug.log";
|
|
2118
|
+
};
|
|
2119
|
+
readonly content_type: {
|
|
2120
|
+
readonly type: "string";
|
|
2121
|
+
readonly description: "MIME content type of the attachment.";
|
|
2122
|
+
readonly example: "text/plain";
|
|
2123
|
+
};
|
|
2124
|
+
readonly size: {
|
|
2125
|
+
readonly type: "integer";
|
|
2126
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2127
|
+
readonly example: 12345;
|
|
2128
|
+
};
|
|
2129
|
+
};
|
|
2130
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2131
|
+
readonly additionalProperties: false;
|
|
2132
|
+
};
|
|
2133
|
+
readonly description: "Attachments associated with this message.";
|
|
2134
|
+
readonly example: readonly [];
|
|
2135
|
+
};
|
|
2136
|
+
readonly date_created: {
|
|
2137
|
+
readonly type: "string";
|
|
2138
|
+
readonly format: "date-time";
|
|
2139
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2140
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2141
|
+
};
|
|
2142
|
+
};
|
|
2143
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2144
|
+
readonly additionalProperties: false;
|
|
2145
|
+
};
|
|
2146
|
+
export declare const TicketSchema: {
|
|
2147
|
+
readonly type: "object";
|
|
2148
|
+
readonly properties: {
|
|
2149
|
+
readonly id: {
|
|
2150
|
+
readonly type: "string";
|
|
2151
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
2152
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
2153
|
+
};
|
|
2154
|
+
readonly status: {
|
|
2155
|
+
readonly type: "string";
|
|
2156
|
+
readonly description: "Current state of the ticket.";
|
|
2157
|
+
readonly example: "waiting_on_us";
|
|
2158
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
2159
|
+
};
|
|
2160
|
+
readonly category: {
|
|
2161
|
+
readonly type: "string";
|
|
2162
|
+
readonly description: "Ticket category.";
|
|
2163
|
+
readonly example: "technical";
|
|
2164
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2165
|
+
};
|
|
2166
|
+
readonly summary: {
|
|
2167
|
+
readonly type: "string";
|
|
2168
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
2169
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2170
|
+
};
|
|
2171
|
+
readonly closed_at: {
|
|
2172
|
+
readonly type: "string";
|
|
2173
|
+
readonly format: "date-time";
|
|
2174
|
+
readonly nullable: true;
|
|
2175
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2176
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
2177
|
+
};
|
|
2178
|
+
readonly date_created: {
|
|
2179
|
+
readonly type: "string";
|
|
2180
|
+
readonly format: "date-time";
|
|
2181
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
2182
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2183
|
+
};
|
|
2184
|
+
readonly date_updated: {
|
|
2185
|
+
readonly type: "string";
|
|
2186
|
+
readonly format: "date-time";
|
|
2187
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2188
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2189
|
+
};
|
|
2190
|
+
readonly messages: {
|
|
2191
|
+
readonly type: "array";
|
|
2192
|
+
readonly items: {
|
|
2193
|
+
readonly type: "object";
|
|
2194
|
+
readonly properties: {
|
|
2195
|
+
readonly id: {
|
|
2196
|
+
readonly type: "string";
|
|
2197
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2198
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2199
|
+
};
|
|
2200
|
+
readonly type: {
|
|
2201
|
+
readonly type: "string";
|
|
2202
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2203
|
+
readonly example: "customer_reply";
|
|
2204
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2205
|
+
};
|
|
2206
|
+
readonly body: {
|
|
2207
|
+
readonly type: "string";
|
|
2208
|
+
readonly description: "Message body in markdown.";
|
|
2209
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2210
|
+
};
|
|
2211
|
+
readonly author_first_name: {
|
|
2212
|
+
readonly type: "string";
|
|
2213
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2214
|
+
readonly example: "Jane";
|
|
2215
|
+
};
|
|
2216
|
+
readonly author_last_name: {
|
|
2217
|
+
readonly type: "string";
|
|
2218
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2219
|
+
readonly example: "Doe";
|
|
2220
|
+
};
|
|
2221
|
+
readonly attachments: {
|
|
2222
|
+
readonly type: "array";
|
|
2223
|
+
readonly items: {
|
|
2224
|
+
readonly type: "object";
|
|
2225
|
+
readonly properties: {
|
|
2226
|
+
readonly id: {
|
|
2227
|
+
readonly type: "string";
|
|
2228
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2229
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2230
|
+
};
|
|
2231
|
+
readonly filename: {
|
|
2232
|
+
readonly type: "string";
|
|
2233
|
+
readonly description: "Original filename as uploaded.";
|
|
2234
|
+
readonly example: "debug.log";
|
|
2235
|
+
};
|
|
2236
|
+
readonly content_type: {
|
|
2237
|
+
readonly type: "string";
|
|
2238
|
+
readonly description: "MIME content type of the attachment.";
|
|
2239
|
+
readonly example: "text/plain";
|
|
2240
|
+
};
|
|
2241
|
+
readonly size: {
|
|
2242
|
+
readonly type: "integer";
|
|
2243
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2244
|
+
readonly example: 12345;
|
|
2245
|
+
};
|
|
2246
|
+
};
|
|
2247
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2248
|
+
readonly additionalProperties: false;
|
|
2249
|
+
};
|
|
2250
|
+
readonly description: "Attachments associated with this message.";
|
|
2251
|
+
readonly example: readonly [];
|
|
2252
|
+
};
|
|
2253
|
+
readonly date_created: {
|
|
2254
|
+
readonly type: "string";
|
|
2255
|
+
readonly format: "date-time";
|
|
2256
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2257
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2258
|
+
};
|
|
2259
|
+
};
|
|
2260
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2261
|
+
readonly additionalProperties: false;
|
|
2262
|
+
};
|
|
2263
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
2264
|
+
};
|
|
2265
|
+
};
|
|
2266
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
2267
|
+
readonly additionalProperties: false;
|
|
2268
|
+
};
|
|
1464
2269
|
export declare const TokenCreateInputSchema: {
|
|
1465
2270
|
readonly type: "object";
|
|
1466
2271
|
readonly properties: {
|
|
@@ -1554,9 +2359,10 @@ export declare const UsageFacetsSchema: {
|
|
|
1554
2359
|
readonly type: "array";
|
|
1555
2360
|
readonly items: {
|
|
1556
2361
|
readonly type: "string";
|
|
2362
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
1557
2363
|
};
|
|
1558
2364
|
readonly description: "List of unique products";
|
|
1559
|
-
readonly example: readonly ["
|
|
2365
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
1560
2366
|
};
|
|
1561
2367
|
};
|
|
1562
2368
|
readonly additionalProperties: false;
|
|
@@ -1582,7 +2388,8 @@ export declare const UsageResponseSchema: {
|
|
|
1582
2388
|
readonly product: {
|
|
1583
2389
|
readonly type: "string";
|
|
1584
2390
|
readonly description: "The product the usage is associated with";
|
|
1585
|
-
readonly example: "
|
|
2391
|
+
readonly example: "cfke_controlplane_pro";
|
|
2392
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
1586
2393
|
};
|
|
1587
2394
|
readonly value: {
|
|
1588
2395
|
readonly type: "number";
|
|
@@ -1622,9 +2429,10 @@ export declare const UsageResponseSchema: {
|
|
|
1622
2429
|
readonly type: "array";
|
|
1623
2430
|
readonly items: {
|
|
1624
2431
|
readonly type: "string";
|
|
2432
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
1625
2433
|
};
|
|
1626
2434
|
readonly description: "List of unique products";
|
|
1627
|
-
readonly example: readonly ["
|
|
2435
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
1628
2436
|
};
|
|
1629
2437
|
};
|
|
1630
2438
|
readonly additionalProperties: false;
|
|
@@ -1650,7 +2458,8 @@ export declare const UsageSchema: {
|
|
|
1650
2458
|
readonly product: {
|
|
1651
2459
|
readonly type: "string";
|
|
1652
2460
|
readonly description: "The product the usage is associated with";
|
|
1653
|
-
readonly example: "
|
|
2461
|
+
readonly example: "cfke_controlplane_pro";
|
|
2462
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
1654
2463
|
};
|
|
1655
2464
|
readonly value: {
|
|
1656
2465
|
readonly type: "number";
|
|
@@ -1707,18 +2516,6 @@ export declare const UserCreateInputSchema: {
|
|
|
1707
2516
|
readonly minLength: 8;
|
|
1708
2517
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
1709
2518
|
};
|
|
1710
|
-
readonly status: {
|
|
1711
|
-
readonly type: "string";
|
|
1712
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
1713
|
-
readonly example: "active";
|
|
1714
|
-
readonly enum: readonly ["active", "inactive"];
|
|
1715
|
-
};
|
|
1716
|
-
readonly role: {
|
|
1717
|
-
readonly type: "string";
|
|
1718
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
1719
|
-
readonly example: "User";
|
|
1720
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
1721
|
-
};
|
|
1722
2519
|
};
|
|
1723
2520
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
1724
2521
|
readonly additionalProperties: false;
|