@cloudfleet/sdk 0.0.1-91321da → 0.0.1-933646b
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 +446 -372
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +478 -392
- package/dist/@tanstack/react-query.gen.js.map +1 -1
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +1 -4
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/types.gen.d.ts +1 -1
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +2 -2
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.js +3 -3
- package/dist/client/utils.gen.js.map +1 -1
- package/dist/core/params.gen.js +4 -4
- package/dist/core/params.gen.js.map +1 -1
- package/dist/schemas.gen.d.ts +662 -253
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +1544 -358
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +249 -211
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +357 -304
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +1216 -817
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3353 -1450
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1201 -354
- package/dist/zod.gen.js.map +1 -1
- package/package.json +9 -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,16 @@ 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 signed by
|
|
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";
|
|
421
634
|
}, {
|
|
422
635
|
readonly type: "string";
|
|
423
636
|
readonly enum: readonly [""];
|
|
@@ -427,7 +640,7 @@ export declare const ClusterSchema: {
|
|
|
427
640
|
readonly anyOf: readonly [{
|
|
428
641
|
readonly type: "string";
|
|
429
642
|
readonly format: "uri";
|
|
430
|
-
readonly description: "
|
|
643
|
+
readonly description: "Deprecated alias of `endpoint`; retained for backward compatibility.";
|
|
431
644
|
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
432
645
|
}, {
|
|
433
646
|
readonly type: "string";
|
|
@@ -459,15 +672,10 @@ export declare const ClusterSchema: {
|
|
|
459
672
|
readonly description: "Indicates if the cluster is ready to be used.";
|
|
460
673
|
readonly example: true;
|
|
461
674
|
};
|
|
462
|
-
readonly version_channel: {
|
|
463
|
-
readonly type: "string";
|
|
464
|
-
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-]+)*))?$";
|
|
465
|
-
readonly description: "Version of the kubernetes cluster.";
|
|
466
|
-
readonly example: "1.x.x-cfke.x";
|
|
467
|
-
};
|
|
468
675
|
};
|
|
469
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
676
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
470
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.";
|
|
471
679
|
};
|
|
472
680
|
export declare const ClusterUpdateInputSchema: {
|
|
473
681
|
readonly type: "object";
|
|
@@ -483,18 +691,60 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
483
691
|
readonly tier: {
|
|
484
692
|
readonly type: "string";
|
|
485
693
|
readonly description: "Tier of the cluster.";
|
|
694
|
+
readonly default: "basic";
|
|
486
695
|
readonly example: "pro";
|
|
487
|
-
readonly enum: readonly ["basic", "pro"];
|
|
696
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
488
697
|
};
|
|
489
698
|
readonly version_channel: {
|
|
490
699
|
readonly type: "string";
|
|
491
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-]+)*))?$";
|
|
492
701
|
readonly description: "Version of the kubernetes cluster.";
|
|
702
|
+
readonly default: "1.x.x-cfke.x";
|
|
493
703
|
readonly example: "1.x.x-cfke.x";
|
|
494
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
|
+
};
|
|
495
744
|
};
|
|
496
|
-
readonly required: readonly ["
|
|
745
|
+
readonly required: readonly ["name"];
|
|
497
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.";
|
|
498
748
|
};
|
|
499
749
|
export declare const FleetCreateInputSchema: {
|
|
500
750
|
readonly type: "object";
|
|
@@ -503,13 +753,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
503
753
|
readonly type: "object";
|
|
504
754
|
readonly properties: {
|
|
505
755
|
readonly cpu: {
|
|
506
|
-
readonly type: "
|
|
507
|
-
readonly format: "float";
|
|
756
|
+
readonly type: "integer";
|
|
508
757
|
readonly minimum: 0;
|
|
509
|
-
readonly
|
|
758
|
+
readonly maximum: 100000;
|
|
759
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
510
760
|
};
|
|
511
761
|
};
|
|
512
|
-
readonly required: readonly ["cpu"];
|
|
513
762
|
readonly additionalProperties: false;
|
|
514
763
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
515
764
|
};
|
|
@@ -518,14 +767,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
518
767
|
readonly properties: {
|
|
519
768
|
readonly enabled: {
|
|
520
769
|
readonly type: "boolean";
|
|
521
|
-
readonly default: true;
|
|
522
770
|
};
|
|
523
771
|
readonly project: {
|
|
524
772
|
readonly type: "string";
|
|
525
|
-
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";
|
|
526
776
|
};
|
|
527
777
|
};
|
|
528
|
-
readonly required: readonly ["
|
|
778
|
+
readonly required: readonly ["enabled"];
|
|
529
779
|
readonly additionalProperties: false;
|
|
530
780
|
};
|
|
531
781
|
readonly hetzner: {
|
|
@@ -533,14 +783,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
533
783
|
readonly properties: {
|
|
534
784
|
readonly enabled: {
|
|
535
785
|
readonly type: "boolean";
|
|
536
|
-
readonly default: true;
|
|
537
786
|
};
|
|
538
787
|
readonly apiKey: {
|
|
539
788
|
readonly type: "string";
|
|
540
|
-
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.";
|
|
541
793
|
};
|
|
542
794
|
};
|
|
543
|
-
readonly required: readonly ["
|
|
795
|
+
readonly required: readonly ["enabled"];
|
|
544
796
|
readonly additionalProperties: false;
|
|
545
797
|
};
|
|
546
798
|
readonly aws: {
|
|
@@ -548,16 +800,75 @@ export declare const FleetCreateInputSchema: {
|
|
|
548
800
|
readonly properties: {
|
|
549
801
|
readonly enabled: {
|
|
550
802
|
readonly type: "boolean";
|
|
551
|
-
readonly default: true;
|
|
552
803
|
};
|
|
553
804
|
readonly controllerRoleArn: {
|
|
554
805
|
readonly type: "string";
|
|
555
|
-
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";
|
|
556
809
|
};
|
|
557
810
|
};
|
|
558
|
-
readonly required: readonly ["
|
|
811
|
+
readonly required: readonly ["enabled"];
|
|
559
812
|
readonly additionalProperties: false;
|
|
560
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 [];
|
|
854
|
+
};
|
|
855
|
+
};
|
|
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"];
|
|
871
|
+
};
|
|
561
872
|
readonly id: {
|
|
562
873
|
readonly type: "string";
|
|
563
874
|
readonly maxLength: 63;
|
|
@@ -569,6 +880,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
569
880
|
};
|
|
570
881
|
readonly required: readonly ["id"];
|
|
571
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.";
|
|
572
884
|
};
|
|
573
885
|
export declare const FleetSchema: {
|
|
574
886
|
readonly type: "object";
|
|
@@ -577,13 +889,12 @@ export declare const FleetSchema: {
|
|
|
577
889
|
readonly type: "object";
|
|
578
890
|
readonly properties: {
|
|
579
891
|
readonly cpu: {
|
|
580
|
-
readonly type: "
|
|
581
|
-
readonly format: "float";
|
|
892
|
+
readonly type: "integer";
|
|
582
893
|
readonly minimum: 0;
|
|
583
|
-
readonly
|
|
894
|
+
readonly maximum: 100000;
|
|
895
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
584
896
|
};
|
|
585
897
|
};
|
|
586
|
-
readonly required: readonly ["cpu"];
|
|
587
898
|
readonly additionalProperties: false;
|
|
588
899
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
589
900
|
};
|
|
@@ -592,14 +903,15 @@ export declare const FleetSchema: {
|
|
|
592
903
|
readonly properties: {
|
|
593
904
|
readonly enabled: {
|
|
594
905
|
readonly type: "boolean";
|
|
595
|
-
readonly default: true;
|
|
596
906
|
};
|
|
597
907
|
readonly project: {
|
|
598
908
|
readonly type: "string";
|
|
599
|
-
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";
|
|
600
912
|
};
|
|
601
913
|
};
|
|
602
|
-
readonly required: readonly ["
|
|
914
|
+
readonly required: readonly ["enabled"];
|
|
603
915
|
readonly additionalProperties: false;
|
|
604
916
|
};
|
|
605
917
|
readonly hetzner: {
|
|
@@ -607,14 +919,14 @@ export declare const FleetSchema: {
|
|
|
607
919
|
readonly properties: {
|
|
608
920
|
readonly enabled: {
|
|
609
921
|
readonly type: "boolean";
|
|
610
|
-
readonly default: true;
|
|
611
922
|
};
|
|
612
923
|
readonly apiKey: {
|
|
613
924
|
readonly type: "string";
|
|
614
|
-
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.";
|
|
615
927
|
};
|
|
616
928
|
};
|
|
617
|
-
readonly required: readonly ["
|
|
929
|
+
readonly required: readonly ["enabled"];
|
|
618
930
|
readonly additionalProperties: false;
|
|
619
931
|
};
|
|
620
932
|
readonly aws: {
|
|
@@ -622,16 +934,76 @@ export declare const FleetSchema: {
|
|
|
622
934
|
readonly properties: {
|
|
623
935
|
readonly enabled: {
|
|
624
936
|
readonly type: "boolean";
|
|
625
|
-
readonly default: true;
|
|
626
937
|
};
|
|
627
938
|
readonly controllerRoleArn: {
|
|
628
939
|
readonly type: "string";
|
|
629
|
-
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";
|
|
630
943
|
};
|
|
631
944
|
};
|
|
632
|
-
readonly required: readonly ["
|
|
945
|
+
readonly required: readonly ["enabled"];
|
|
633
946
|
readonly additionalProperties: false;
|
|
634
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 [];
|
|
988
|
+
};
|
|
989
|
+
};
|
|
990
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
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"];
|
|
1006
|
+
};
|
|
635
1007
|
readonly id: {
|
|
636
1008
|
readonly type: "string";
|
|
637
1009
|
readonly maxLength: 63;
|
|
@@ -640,9 +1012,30 @@ export declare const FleetSchema: {
|
|
|
640
1012
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
641
1013
|
readonly example: "new-clouds-fleet";
|
|
642
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
|
+
};
|
|
643
1035
|
};
|
|
644
|
-
readonly required: readonly ["id"];
|
|
1036
|
+
readonly required: readonly ["constraints", "scalingProfile", "id", "ready", "created_at", "updated_at"];
|
|
645
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.";
|
|
646
1039
|
};
|
|
647
1040
|
export declare const FleetUpdateInputSchema: {
|
|
648
1041
|
readonly type: "object";
|
|
@@ -651,13 +1044,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
651
1044
|
readonly type: "object";
|
|
652
1045
|
readonly properties: {
|
|
653
1046
|
readonly cpu: {
|
|
654
|
-
readonly type: "
|
|
655
|
-
readonly format: "float";
|
|
1047
|
+
readonly type: "integer";
|
|
656
1048
|
readonly minimum: 0;
|
|
657
|
-
readonly
|
|
1049
|
+
readonly maximum: 100000;
|
|
1050
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
658
1051
|
};
|
|
659
1052
|
};
|
|
660
|
-
readonly required: readonly ["cpu"];
|
|
661
1053
|
readonly additionalProperties: false;
|
|
662
1054
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
663
1055
|
};
|
|
@@ -666,14 +1058,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
666
1058
|
readonly properties: {
|
|
667
1059
|
readonly enabled: {
|
|
668
1060
|
readonly type: "boolean";
|
|
669
|
-
readonly default: true;
|
|
670
1061
|
};
|
|
671
1062
|
readonly project: {
|
|
672
1063
|
readonly type: "string";
|
|
673
|
-
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";
|
|
674
1067
|
};
|
|
675
1068
|
};
|
|
676
|
-
readonly required: readonly ["
|
|
1069
|
+
readonly required: readonly ["enabled"];
|
|
677
1070
|
readonly additionalProperties: false;
|
|
678
1071
|
};
|
|
679
1072
|
readonly hetzner: {
|
|
@@ -681,14 +1074,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
681
1074
|
readonly properties: {
|
|
682
1075
|
readonly enabled: {
|
|
683
1076
|
readonly type: "boolean";
|
|
684
|
-
readonly default: true;
|
|
685
1077
|
};
|
|
686
1078
|
readonly apiKey: {
|
|
687
1079
|
readonly type: "string";
|
|
688
|
-
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.";
|
|
689
1084
|
};
|
|
690
1085
|
};
|
|
691
|
-
readonly required: readonly ["
|
|
1086
|
+
readonly required: readonly ["enabled"];
|
|
692
1087
|
readonly additionalProperties: false;
|
|
693
1088
|
};
|
|
694
1089
|
readonly aws: {
|
|
@@ -696,17 +1091,97 @@ export declare const FleetUpdateInputSchema: {
|
|
|
696
1091
|
readonly properties: {
|
|
697
1092
|
readonly enabled: {
|
|
698
1093
|
readonly type: "boolean";
|
|
699
|
-
readonly default: true;
|
|
700
1094
|
};
|
|
701
1095
|
readonly controllerRoleArn: {
|
|
702
1096
|
readonly type: "string";
|
|
703
|
-
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 [];
|
|
704
1145
|
};
|
|
705
1146
|
};
|
|
706
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
707
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"];
|
|
708
1182
|
};
|
|
709
1183
|
};
|
|
1184
|
+
readonly required: readonly ["email"];
|
|
710
1185
|
readonly additionalProperties: false;
|
|
711
1186
|
};
|
|
712
1187
|
export declare const InviteSchema: {
|
|
@@ -740,6 +1215,13 @@ export declare const InviteSchema: {
|
|
|
740
1215
|
readonly description: "Generated unique invite code.";
|
|
741
1216
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
742
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
|
+
};
|
|
743
1225
|
};
|
|
744
1226
|
readonly required: readonly ["date_created"];
|
|
745
1227
|
readonly additionalProperties: false;
|
|
@@ -937,6 +1419,12 @@ export declare const MarketplaceListingSchema: {
|
|
|
937
1419
|
export declare const OrganizationCreateInputSchema: {
|
|
938
1420
|
readonly type: "object";
|
|
939
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
|
+
};
|
|
940
1428
|
readonly email: {
|
|
941
1429
|
readonly type: "string";
|
|
942
1430
|
readonly format: "email";
|
|
@@ -945,11 +1433,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
945
1433
|
};
|
|
946
1434
|
readonly first_name: {
|
|
947
1435
|
readonly type: "string";
|
|
1436
|
+
readonly minLength: 1;
|
|
948
1437
|
readonly description: "First name of the billing contact person.";
|
|
949
1438
|
readonly example: "John";
|
|
950
1439
|
};
|
|
951
1440
|
readonly last_name: {
|
|
952
1441
|
readonly type: "string";
|
|
1442
|
+
readonly minLength: 1;
|
|
953
1443
|
readonly description: "Last name of the billing contact person.";
|
|
954
1444
|
readonly example: "Doe";
|
|
955
1445
|
};
|
|
@@ -967,7 +1457,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
967
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.";
|
|
968
1458
|
};
|
|
969
1459
|
};
|
|
970
|
-
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"];
|
|
971
1473
|
readonly additionalProperties: false;
|
|
972
1474
|
};
|
|
973
1475
|
export declare const OrganizationSchema: {
|
|
@@ -986,6 +1488,12 @@ export declare const OrganizationSchema: {
|
|
|
986
1488
|
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
987
1489
|
readonly example: "ACME Corp.";
|
|
988
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
|
+
};
|
|
989
1497
|
readonly date_created: {
|
|
990
1498
|
readonly type: "string";
|
|
991
1499
|
readonly format: "date-time";
|
|
@@ -1017,6 +1525,17 @@ export declare const OrganizationSchema: {
|
|
|
1017
1525
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1018
1526
|
readonly example: 999;
|
|
1019
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
|
+
};
|
|
1020
1539
|
readonly fleets_max: {
|
|
1021
1540
|
readonly type: "integer";
|
|
1022
1541
|
readonly minimum: 0;
|
|
@@ -1036,7 +1555,7 @@ export declare const OrganizationSchema: {
|
|
|
1036
1555
|
readonly type: "array";
|
|
1037
1556
|
readonly items: {
|
|
1038
1557
|
readonly type: "string";
|
|
1039
|
-
readonly example: "northamerica-central-
|
|
1558
|
+
readonly example: "northamerica-central-1a";
|
|
1040
1559
|
};
|
|
1041
1560
|
readonly minItems: 1;
|
|
1042
1561
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1070,7 +1589,7 @@ export declare const OrganizationSchema: {
|
|
|
1070
1589
|
readonly example: 500;
|
|
1071
1590
|
};
|
|
1072
1591
|
};
|
|
1073
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
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"];
|
|
1074
1593
|
readonly additionalProperties: false;
|
|
1075
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.";
|
|
1076
1595
|
};
|
|
@@ -1079,8 +1598,14 @@ export declare const OrganizationSchema: {
|
|
|
1079
1598
|
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1080
1599
|
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1081
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
|
+
};
|
|
1082
1607
|
};
|
|
1083
|
-
readonly required: readonly ["id", "date_created", "quota", "status"];
|
|
1608
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1084
1609
|
readonly additionalProperties: false;
|
|
1085
1610
|
};
|
|
1086
1611
|
export declare const PaymentMethodSchema: {
|
|
@@ -1088,26 +1613,19 @@ export declare const PaymentMethodSchema: {
|
|
|
1088
1613
|
readonly properties: {
|
|
1089
1614
|
readonly id: {
|
|
1090
1615
|
readonly type: "string";
|
|
1091
|
-
readonly
|
|
1092
|
-
readonly
|
|
1093
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1094
|
-
};
|
|
1095
|
-
readonly setup: {
|
|
1096
|
-
readonly type: "boolean";
|
|
1097
|
-
readonly description: "Whether organization payment method was set up and ready to use for payments.";
|
|
1098
|
-
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";
|
|
1099
1618
|
};
|
|
1100
1619
|
readonly type: {
|
|
1101
1620
|
readonly type: "string";
|
|
1102
|
-
readonly
|
|
1103
|
-
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.";
|
|
1104
1622
|
readonly example: "card";
|
|
1105
|
-
readonly enum: readonly ["card"];
|
|
1623
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1106
1624
|
};
|
|
1107
1625
|
readonly last4: {
|
|
1108
1626
|
readonly type: "string";
|
|
1109
1627
|
readonly nullable: true;
|
|
1110
|
-
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.";
|
|
1111
1629
|
readonly example: "4242";
|
|
1112
1630
|
};
|
|
1113
1631
|
readonly exp_month: {
|
|
@@ -1115,25 +1633,46 @@ export declare const PaymentMethodSchema: {
|
|
|
1115
1633
|
readonly minimum: 1;
|
|
1116
1634
|
readonly maximum: 12;
|
|
1117
1635
|
readonly nullable: true;
|
|
1118
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1119
|
-
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;
|
|
1120
1638
|
};
|
|
1121
1639
|
readonly exp_year: {
|
|
1122
1640
|
readonly type: "integer";
|
|
1123
|
-
readonly minimum: 2024;
|
|
1124
1641
|
readonly nullable: true;
|
|
1125
|
-
readonly description: "Four-digit number representing the card's expiration year.";
|
|
1126
|
-
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;
|
|
1127
1644
|
};
|
|
1128
1645
|
readonly brand: {
|
|
1129
1646
|
readonly type: "string";
|
|
1130
1647
|
readonly nullable: true;
|
|
1131
|
-
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.";
|
|
1132
1649
|
readonly example: "visa";
|
|
1133
|
-
|
|
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;
|
|
1134
1673
|
};
|
|
1135
1674
|
};
|
|
1136
|
-
readonly required: readonly ["id", "
|
|
1675
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1137
1676
|
readonly additionalProperties: false;
|
|
1138
1677
|
};
|
|
1139
1678
|
export declare const PlatformQuotaSchema: {
|
|
@@ -1161,6 +1700,17 @@ export declare const PlatformQuotaSchema: {
|
|
|
1161
1700
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1162
1701
|
readonly example: 999;
|
|
1163
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
|
+
};
|
|
1164
1714
|
readonly fleets_max: {
|
|
1165
1715
|
readonly type: "integer";
|
|
1166
1716
|
readonly minimum: 0;
|
|
@@ -1180,7 +1730,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1180
1730
|
readonly type: "array";
|
|
1181
1731
|
readonly items: {
|
|
1182
1732
|
readonly type: "string";
|
|
1183
|
-
readonly example: "northamerica-central-
|
|
1733
|
+
readonly example: "northamerica-central-1a";
|
|
1184
1734
|
};
|
|
1185
1735
|
readonly minItems: 1;
|
|
1186
1736
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1214,7 +1764,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1214
1764
|
readonly example: 500;
|
|
1215
1765
|
};
|
|
1216
1766
|
};
|
|
1217
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
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"];
|
|
1218
1768
|
readonly additionalProperties: false;
|
|
1219
1769
|
};
|
|
1220
1770
|
export declare const RegistryRepositorySchema: {
|
|
@@ -1505,142 +2055,6 @@ export declare const TicketCreateInputSchema: {
|
|
|
1505
2055
|
readonly required: readonly ["category", "body"];
|
|
1506
2056
|
readonly additionalProperties: false;
|
|
1507
2057
|
};
|
|
1508
|
-
export declare const TicketListResponseSchema: {
|
|
1509
|
-
readonly type: "object";
|
|
1510
|
-
readonly properties: {
|
|
1511
|
-
readonly items: {
|
|
1512
|
-
readonly type: "array";
|
|
1513
|
-
readonly items: {
|
|
1514
|
-
readonly type: "object";
|
|
1515
|
-
readonly properties: {
|
|
1516
|
-
readonly id: {
|
|
1517
|
-
readonly type: "string";
|
|
1518
|
-
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
1519
|
-
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
1520
|
-
};
|
|
1521
|
-
readonly status: {
|
|
1522
|
-
readonly type: "string";
|
|
1523
|
-
readonly description: "Current state of the ticket.";
|
|
1524
|
-
readonly example: "waiting_on_us";
|
|
1525
|
-
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
1526
|
-
};
|
|
1527
|
-
readonly category: {
|
|
1528
|
-
readonly type: "string";
|
|
1529
|
-
readonly description: "Ticket category.";
|
|
1530
|
-
readonly example: "technical";
|
|
1531
|
-
readonly enum: readonly ["billing", "technical", "general"];
|
|
1532
|
-
};
|
|
1533
|
-
readonly summary: {
|
|
1534
|
-
readonly type: "string";
|
|
1535
|
-
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
1536
|
-
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1537
|
-
};
|
|
1538
|
-
readonly closed_at: {
|
|
1539
|
-
readonly type: "string";
|
|
1540
|
-
readonly format: "date-time";
|
|
1541
|
-
readonly nullable: true;
|
|
1542
|
-
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
1543
|
-
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1544
|
-
};
|
|
1545
|
-
readonly date_created: {
|
|
1546
|
-
readonly type: "string";
|
|
1547
|
-
readonly format: "date-time";
|
|
1548
|
-
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
1549
|
-
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1550
|
-
};
|
|
1551
|
-
readonly date_updated: {
|
|
1552
|
-
readonly type: "string";
|
|
1553
|
-
readonly format: "date-time";
|
|
1554
|
-
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
1555
|
-
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1556
|
-
};
|
|
1557
|
-
readonly messages: {
|
|
1558
|
-
readonly type: "array";
|
|
1559
|
-
readonly items: {
|
|
1560
|
-
readonly type: "object";
|
|
1561
|
-
readonly properties: {
|
|
1562
|
-
readonly id: {
|
|
1563
|
-
readonly type: "string";
|
|
1564
|
-
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
1565
|
-
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
1566
|
-
};
|
|
1567
|
-
readonly type: {
|
|
1568
|
-
readonly type: "string";
|
|
1569
|
-
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
1570
|
-
readonly example: "customer_reply";
|
|
1571
|
-
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
1572
|
-
};
|
|
1573
|
-
readonly body: {
|
|
1574
|
-
readonly type: "string";
|
|
1575
|
-
readonly description: "Message body in markdown.";
|
|
1576
|
-
readonly example: "Thanks — that resolved it on my side.";
|
|
1577
|
-
};
|
|
1578
|
-
readonly author_first_name: {
|
|
1579
|
-
readonly type: "string";
|
|
1580
|
-
readonly nullable: true;
|
|
1581
|
-
readonly description: "First name of the author. Null when not provided.";
|
|
1582
|
-
readonly example: "Jane";
|
|
1583
|
-
};
|
|
1584
|
-
readonly author_last_name: {
|
|
1585
|
-
readonly type: "string";
|
|
1586
|
-
readonly nullable: true;
|
|
1587
|
-
readonly description: "Last name of the author. Null when not provided.";
|
|
1588
|
-
readonly example: "Doe";
|
|
1589
|
-
};
|
|
1590
|
-
readonly attachments: {
|
|
1591
|
-
readonly type: "array";
|
|
1592
|
-
readonly items: {
|
|
1593
|
-
readonly type: "object";
|
|
1594
|
-
readonly properties: {
|
|
1595
|
-
readonly id: {
|
|
1596
|
-
readonly type: "string";
|
|
1597
|
-
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
1598
|
-
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1599
|
-
};
|
|
1600
|
-
readonly filename: {
|
|
1601
|
-
readonly type: "string";
|
|
1602
|
-
readonly description: "Original filename as uploaded.";
|
|
1603
|
-
readonly example: "debug.log";
|
|
1604
|
-
};
|
|
1605
|
-
readonly content_type: {
|
|
1606
|
-
readonly type: "string";
|
|
1607
|
-
readonly description: "MIME content type of the attachment.";
|
|
1608
|
-
readonly example: "text/plain";
|
|
1609
|
-
};
|
|
1610
|
-
readonly size: {
|
|
1611
|
-
readonly type: "integer";
|
|
1612
|
-
readonly description: "Size of the attachment in bytes.";
|
|
1613
|
-
readonly example: 12345;
|
|
1614
|
-
};
|
|
1615
|
-
};
|
|
1616
|
-
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1617
|
-
readonly additionalProperties: false;
|
|
1618
|
-
};
|
|
1619
|
-
readonly description: "Attachments associated with this message.";
|
|
1620
|
-
readonly example: readonly [];
|
|
1621
|
-
};
|
|
1622
|
-
readonly date_created: {
|
|
1623
|
-
readonly type: "string";
|
|
1624
|
-
readonly format: "date-time";
|
|
1625
|
-
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
1626
|
-
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1627
|
-
};
|
|
1628
|
-
};
|
|
1629
|
-
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
1630
|
-
readonly additionalProperties: false;
|
|
1631
|
-
};
|
|
1632
|
-
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
1633
|
-
};
|
|
1634
|
-
};
|
|
1635
|
-
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1636
|
-
readonly additionalProperties: false;
|
|
1637
|
-
};
|
|
1638
|
-
readonly description: "Tickets for the organization, ordered newest first. Messages are omitted from list responses.";
|
|
1639
|
-
};
|
|
1640
|
-
};
|
|
1641
|
-
readonly required: readonly ["items"];
|
|
1642
|
-
readonly additionalProperties: false;
|
|
1643
|
-
};
|
|
1644
2058
|
export declare const TicketMessageInputSchema: {
|
|
1645
2059
|
readonly type: "object";
|
|
1646
2060
|
readonly properties: {
|
|
@@ -1677,11 +2091,13 @@ export declare const TicketMessageSchema: {
|
|
|
1677
2091
|
};
|
|
1678
2092
|
readonly author_first_name: {
|
|
1679
2093
|
readonly type: "string";
|
|
2094
|
+
readonly nullable: true;
|
|
1680
2095
|
readonly description: "First name of the author. Null when not provided.";
|
|
1681
2096
|
readonly example: "Jane";
|
|
1682
2097
|
};
|
|
1683
2098
|
readonly author_last_name: {
|
|
1684
2099
|
readonly type: "string";
|
|
2100
|
+
readonly nullable: true;
|
|
1685
2101
|
readonly description: "Last name of the author. Null when not provided.";
|
|
1686
2102
|
readonly example: "Doe";
|
|
1687
2103
|
};
|
|
@@ -1755,6 +2171,7 @@ export declare const TicketSchema: {
|
|
|
1755
2171
|
readonly closed_at: {
|
|
1756
2172
|
readonly type: "string";
|
|
1757
2173
|
readonly format: "date-time";
|
|
2174
|
+
readonly nullable: true;
|
|
1758
2175
|
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
1759
2176
|
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1760
2177
|
};
|
|
@@ -1942,9 +2359,10 @@ export declare const UsageFacetsSchema: {
|
|
|
1942
2359
|
readonly type: "array";
|
|
1943
2360
|
readonly items: {
|
|
1944
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"];
|
|
1945
2363
|
};
|
|
1946
2364
|
readonly description: "List of unique products";
|
|
1947
|
-
readonly example: readonly ["
|
|
2365
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
1948
2366
|
};
|
|
1949
2367
|
};
|
|
1950
2368
|
readonly additionalProperties: false;
|
|
@@ -1970,7 +2388,8 @@ export declare const UsageResponseSchema: {
|
|
|
1970
2388
|
readonly product: {
|
|
1971
2389
|
readonly type: "string";
|
|
1972
2390
|
readonly description: "The product the usage is associated with";
|
|
1973
|
-
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"];
|
|
1974
2393
|
};
|
|
1975
2394
|
readonly value: {
|
|
1976
2395
|
readonly type: "number";
|
|
@@ -2010,9 +2429,10 @@ export declare const UsageResponseSchema: {
|
|
|
2010
2429
|
readonly type: "array";
|
|
2011
2430
|
readonly items: {
|
|
2012
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"];
|
|
2013
2433
|
};
|
|
2014
2434
|
readonly description: "List of unique products";
|
|
2015
|
-
readonly example: readonly ["
|
|
2435
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
2016
2436
|
};
|
|
2017
2437
|
};
|
|
2018
2438
|
readonly additionalProperties: false;
|
|
@@ -2038,7 +2458,8 @@ export declare const UsageSchema: {
|
|
|
2038
2458
|
readonly product: {
|
|
2039
2459
|
readonly type: "string";
|
|
2040
2460
|
readonly description: "The product the usage is associated with";
|
|
2041
|
-
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"];
|
|
2042
2463
|
};
|
|
2043
2464
|
readonly value: {
|
|
2044
2465
|
readonly type: "number";
|
|
@@ -2095,18 +2516,6 @@ export declare const UserCreateInputSchema: {
|
|
|
2095
2516
|
readonly minLength: 8;
|
|
2096
2517
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
2097
2518
|
};
|
|
2098
|
-
readonly status: {
|
|
2099
|
-
readonly type: "string";
|
|
2100
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
2101
|
-
readonly example: "active";
|
|
2102
|
-
readonly enum: readonly ["active", "inactive"];
|
|
2103
|
-
};
|
|
2104
|
-
readonly role: {
|
|
2105
|
-
readonly type: "string";
|
|
2106
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
2107
|
-
readonly example: "User";
|
|
2108
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
2109
|
-
};
|
|
2110
2519
|
};
|
|
2111
2520
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
2112
2521
|
readonly additionalProperties: false;
|