@cloudfleet/sdk 0.0.1-cb875c6 → 0.0.1-cc82d04
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 +1061 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1234 -0
- package/dist/@tanstack/react-query.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +114 -102
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/index.d.ts +1 -1
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js.map +1 -1
- package/dist/client/types.gen.d.ts +9 -13
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +8 -4
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.js +13 -15
- package/dist/client/utils.gen.js.map +1 -1
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/client.gen.js +1 -3
- package/dist/client.gen.js.map +1 -1
- package/dist/core/auth.gen.d.ts.map +1 -1
- package/dist/core/auth.gen.js.map +1 -1
- package/dist/core/bodySerializer.gen.d.ts +16 -8
- package/dist/core/bodySerializer.gen.d.ts.map +1 -1
- package/dist/core/bodySerializer.gen.js +1 -1
- package/dist/core/bodySerializer.gen.js.map +1 -1
- package/dist/core/params.gen.d.ts +10 -0
- package/dist/core/params.gen.d.ts.map +1 -1
- package/dist/core/params.gen.js +22 -10
- package/dist/core/params.gen.js.map +1 -1
- package/dist/core/pathSerializer.gen.d.ts.map +1 -1
- package/dist/core/pathSerializer.gen.js +3 -11
- package/dist/core/pathSerializer.gen.js.map +1 -1
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -1
- package/dist/core/queryKeySerializer.gen.js +4 -11
- package/dist/core/queryKeySerializer.gen.js.map +1 -1
- package/dist/core/serverSentEvents.gen.d.ts +1 -1
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -1
- package/dist/core/serverSentEvents.gen.js +6 -9
- package/dist/core/serverSentEvents.gen.js.map +1 -1
- package/dist/core/types.gen.d.ts +1 -1
- package/dist/core/types.gen.d.ts.map +1 -1
- package/dist/core/utils.gen.d.ts.map +1 -1
- package/dist/core/utils.gen.js +1 -1
- package/dist/core/utils.gen.js.map +1 -1
- package/dist/schemas.gen.d.ts +1238 -170
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +2667 -239
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +271 -186
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +385 -359
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +8 -8
- package/dist/types.gen.d.ts +1661 -700
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3545 -1419
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1442 -620
- package/dist/zod.gen.js.map +1 -1
- package/package.json +28 -8
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,26 +312,103 @@ 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\", \"northamerica-central-1\", \"europe-central-1a\", \"northamerica-central-1a\". This field can not be updated after creation.";
|
|
279
|
-
readonly default: "staging";
|
|
280
|
-
readonly example: "northamerica-central-1a";
|
|
281
|
-
readonly enum: readonly ["staging", "northamerica-central-1", "europe-central-1a", "northamerica-central-1a"];
|
|
317
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
282
318
|
};
|
|
283
319
|
readonly version_channel: {
|
|
284
320
|
readonly type: "string";
|
|
285
321
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
286
322
|
readonly description: "Version of the kubernetes cluster.";
|
|
287
323
|
readonly default: "1.x.x-cfke.x";
|
|
288
|
-
readonly example: "1.
|
|
324
|
+
readonly example: "1.x.x-cfke.x";
|
|
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
|
+
};
|
|
289
407
|
};
|
|
290
408
|
};
|
|
291
|
-
readonly required: readonly ["name", "
|
|
409
|
+
readonly required: readonly ["name", "region"];
|
|
292
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.";
|
|
293
412
|
};
|
|
294
413
|
export declare const ClusterJoinInformationSchema: {
|
|
295
414
|
readonly type: "object";
|
|
@@ -305,11 +424,26 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
305
424
|
readonly description: "Internal URL of the Kubernetes cluster control plane. This is the endpoint that kubelet uses to connect to the cluster.";
|
|
306
425
|
readonly example: "https://10.31.64.7:6443";
|
|
307
426
|
};
|
|
427
|
+
readonly cluster_dns: {
|
|
428
|
+
readonly type: "string";
|
|
429
|
+
readonly description: "Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.";
|
|
430
|
+
readonly example: "10.96.0.10";
|
|
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
|
+
};
|
|
308
437
|
readonly auth_key: {
|
|
309
438
|
readonly type: "string";
|
|
310
439
|
readonly description: "Authentication key for the cluster.";
|
|
311
440
|
readonly example: "tskey-auth-kBV8wr1dk911CNTRL-...";
|
|
312
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
|
+
};
|
|
313
447
|
readonly bootstrap_token: {
|
|
314
448
|
readonly type: "string";
|
|
315
449
|
readonly description: "Bootstrap token for the cluster.";
|
|
@@ -367,7 +501,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
367
501
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
368
502
|
};
|
|
369
503
|
};
|
|
370
|
-
readonly required: readonly ["certificate_authority", "endpoint", "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"];
|
|
371
505
|
readonly additionalProperties: false;
|
|
372
506
|
};
|
|
373
507
|
export declare const ClusterSchema: {
|
|
@@ -384,22 +518,100 @@ export declare const ClusterSchema: {
|
|
|
384
518
|
readonly tier: {
|
|
385
519
|
readonly type: "string";
|
|
386
520
|
readonly description: "Tier of the cluster.";
|
|
521
|
+
readonly default: "basic";
|
|
387
522
|
readonly example: "pro";
|
|
388
|
-
readonly enum: readonly ["basic", "pro"];
|
|
389
|
-
};
|
|
390
|
-
readonly region: {
|
|
391
|
-
readonly type: "string";
|
|
392
|
-
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\", \"europe-central-1a\", \"northamerica-central-1a\". This field can not be updated after creation.";
|
|
393
|
-
readonly default: "staging";
|
|
394
|
-
readonly example: "northamerica-central-1a";
|
|
395
|
-
readonly enum: readonly ["staging", "northamerica-central-1", "europe-central-1a", "northamerica-central-1a"];
|
|
523
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
396
524
|
};
|
|
397
525
|
readonly version_channel: {
|
|
398
526
|
readonly type: "string";
|
|
399
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-]+)*))?$";
|
|
400
528
|
readonly description: "Version of the kubernetes cluster.";
|
|
401
529
|
readonly default: "1.x.x-cfke.x";
|
|
402
|
-
readonly example: "1.
|
|
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
|
+
};
|
|
571
|
+
};
|
|
572
|
+
readonly region: {
|
|
573
|
+
readonly type: "string";
|
|
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
|
+
};
|
|
403
615
|
};
|
|
404
616
|
readonly id: {
|
|
405
617
|
readonly type: "string";
|
|
@@ -409,16 +621,27 @@ export declare const ClusterSchema: {
|
|
|
409
621
|
};
|
|
410
622
|
readonly status: {
|
|
411
623
|
readonly type: "string";
|
|
412
|
-
readonly description: "Status of the cluster.
|
|
413
|
-
readonly example: "
|
|
414
|
-
readonly enum: readonly ["
|
|
624
|
+
readonly description: "Status of the cluster.";
|
|
625
|
+
readonly example: "deployed";
|
|
626
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
415
627
|
};
|
|
416
628
|
readonly endpoint: {
|
|
417
629
|
readonly anyOf: readonly [{
|
|
418
630
|
readonly type: "string";
|
|
419
631
|
readonly format: "uri";
|
|
420
|
-
readonly description: "URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
421
|
-
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";
|
|
422
645
|
}, {
|
|
423
646
|
readonly type: "string";
|
|
424
647
|
readonly enum: readonly [""];
|
|
@@ -450,8 +673,9 @@ export declare const ClusterSchema: {
|
|
|
450
673
|
readonly example: true;
|
|
451
674
|
};
|
|
452
675
|
};
|
|
453
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
676
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
454
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.";
|
|
455
679
|
};
|
|
456
680
|
export declare const ClusterUpdateInputSchema: {
|
|
457
681
|
readonly type: "object";
|
|
@@ -467,18 +691,60 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
467
691
|
readonly tier: {
|
|
468
692
|
readonly type: "string";
|
|
469
693
|
readonly description: "Tier of the cluster.";
|
|
694
|
+
readonly default: "basic";
|
|
470
695
|
readonly example: "pro";
|
|
471
|
-
readonly enum: readonly ["basic", "pro"];
|
|
696
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
472
697
|
};
|
|
473
698
|
readonly version_channel: {
|
|
474
699
|
readonly type: "string";
|
|
475
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-]+)*))?$";
|
|
476
701
|
readonly description: "Version of the kubernetes cluster.";
|
|
477
|
-
readonly
|
|
702
|
+
readonly default: "1.x.x-cfke.x";
|
|
703
|
+
readonly example: "1.x.x-cfke.x";
|
|
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
|
+
};
|
|
478
743
|
};
|
|
479
744
|
};
|
|
480
|
-
readonly required: readonly ["
|
|
745
|
+
readonly required: readonly ["name"];
|
|
481
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.";
|
|
482
748
|
};
|
|
483
749
|
export declare const FleetCreateInputSchema: {
|
|
484
750
|
readonly type: "object";
|
|
@@ -487,13 +753,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
487
753
|
readonly type: "object";
|
|
488
754
|
readonly properties: {
|
|
489
755
|
readonly cpu: {
|
|
490
|
-
readonly type: "
|
|
491
|
-
readonly format: "float";
|
|
756
|
+
readonly type: "integer";
|
|
492
757
|
readonly minimum: 0;
|
|
493
|
-
readonly
|
|
758
|
+
readonly maximum: 100000;
|
|
759
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
494
760
|
};
|
|
495
761
|
};
|
|
496
|
-
readonly required: readonly ["cpu"];
|
|
497
762
|
readonly additionalProperties: false;
|
|
498
763
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
499
764
|
};
|
|
@@ -502,14 +767,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
502
767
|
readonly properties: {
|
|
503
768
|
readonly enabled: {
|
|
504
769
|
readonly type: "boolean";
|
|
505
|
-
readonly default: true;
|
|
506
770
|
};
|
|
507
771
|
readonly project: {
|
|
508
772
|
readonly type: "string";
|
|
509
|
-
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";
|
|
510
776
|
};
|
|
511
777
|
};
|
|
512
|
-
readonly required: readonly ["
|
|
778
|
+
readonly required: readonly ["enabled"];
|
|
513
779
|
readonly additionalProperties: false;
|
|
514
780
|
};
|
|
515
781
|
readonly hetzner: {
|
|
@@ -517,14 +783,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
517
783
|
readonly properties: {
|
|
518
784
|
readonly enabled: {
|
|
519
785
|
readonly type: "boolean";
|
|
520
|
-
readonly default: true;
|
|
521
786
|
};
|
|
522
787
|
readonly apiKey: {
|
|
523
788
|
readonly type: "string";
|
|
524
|
-
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.";
|
|
525
793
|
};
|
|
526
794
|
};
|
|
527
|
-
readonly required: readonly ["
|
|
795
|
+
readonly required: readonly ["enabled"];
|
|
528
796
|
readonly additionalProperties: false;
|
|
529
797
|
};
|
|
530
798
|
readonly aws: {
|
|
@@ -532,16 +800,75 @@ export declare const FleetCreateInputSchema: {
|
|
|
532
800
|
readonly properties: {
|
|
533
801
|
readonly enabled: {
|
|
534
802
|
readonly type: "boolean";
|
|
535
|
-
readonly default: true;
|
|
536
803
|
};
|
|
537
804
|
readonly controllerRoleArn: {
|
|
538
805
|
readonly type: "string";
|
|
539
|
-
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";
|
|
540
809
|
};
|
|
541
810
|
};
|
|
542
|
-
readonly required: readonly ["
|
|
811
|
+
readonly required: readonly ["enabled"];
|
|
543
812
|
readonly additionalProperties: false;
|
|
544
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
|
+
};
|
|
545
872
|
readonly id: {
|
|
546
873
|
readonly type: "string";
|
|
547
874
|
readonly maxLength: 63;
|
|
@@ -553,6 +880,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
553
880
|
};
|
|
554
881
|
readonly required: readonly ["id"];
|
|
555
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.";
|
|
556
884
|
};
|
|
557
885
|
export declare const FleetSchema: {
|
|
558
886
|
readonly type: "object";
|
|
@@ -561,13 +889,12 @@ export declare const FleetSchema: {
|
|
|
561
889
|
readonly type: "object";
|
|
562
890
|
readonly properties: {
|
|
563
891
|
readonly cpu: {
|
|
564
|
-
readonly type: "
|
|
565
|
-
readonly format: "float";
|
|
892
|
+
readonly type: "integer";
|
|
566
893
|
readonly minimum: 0;
|
|
567
|
-
readonly
|
|
894
|
+
readonly maximum: 100000;
|
|
895
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
568
896
|
};
|
|
569
897
|
};
|
|
570
|
-
readonly required: readonly ["cpu"];
|
|
571
898
|
readonly additionalProperties: false;
|
|
572
899
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
573
900
|
};
|
|
@@ -576,14 +903,15 @@ export declare const FleetSchema: {
|
|
|
576
903
|
readonly properties: {
|
|
577
904
|
readonly enabled: {
|
|
578
905
|
readonly type: "boolean";
|
|
579
|
-
readonly default: true;
|
|
580
906
|
};
|
|
581
907
|
readonly project: {
|
|
582
908
|
readonly type: "string";
|
|
583
|
-
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";
|
|
584
912
|
};
|
|
585
913
|
};
|
|
586
|
-
readonly required: readonly ["
|
|
914
|
+
readonly required: readonly ["enabled"];
|
|
587
915
|
readonly additionalProperties: false;
|
|
588
916
|
};
|
|
589
917
|
readonly hetzner: {
|
|
@@ -591,14 +919,14 @@ export declare const FleetSchema: {
|
|
|
591
919
|
readonly properties: {
|
|
592
920
|
readonly enabled: {
|
|
593
921
|
readonly type: "boolean";
|
|
594
|
-
readonly default: true;
|
|
595
922
|
};
|
|
596
923
|
readonly apiKey: {
|
|
597
924
|
readonly type: "string";
|
|
598
|
-
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.";
|
|
599
927
|
};
|
|
600
928
|
};
|
|
601
|
-
readonly required: readonly ["
|
|
929
|
+
readonly required: readonly ["enabled"];
|
|
602
930
|
readonly additionalProperties: false;
|
|
603
931
|
};
|
|
604
932
|
readonly aws: {
|
|
@@ -606,15 +934,75 @@ export declare const FleetSchema: {
|
|
|
606
934
|
readonly properties: {
|
|
607
935
|
readonly enabled: {
|
|
608
936
|
readonly type: "boolean";
|
|
609
|
-
readonly default: true;
|
|
610
937
|
};
|
|
611
938
|
readonly controllerRoleArn: {
|
|
612
939
|
readonly type: "string";
|
|
613
|
-
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 [];
|
|
614
988
|
};
|
|
615
989
|
};
|
|
616
|
-
readonly required: readonly ["
|
|
990
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
617
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"];
|
|
618
1006
|
};
|
|
619
1007
|
readonly id: {
|
|
620
1008
|
readonly type: "string";
|
|
@@ -624,9 +1012,30 @@ export declare const FleetSchema: {
|
|
|
624
1012
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
625
1013
|
readonly example: "new-clouds-fleet";
|
|
626
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
|
+
};
|
|
627
1035
|
};
|
|
628
|
-
readonly required: readonly ["id"];
|
|
1036
|
+
readonly required: readonly ["constraints", "scalingProfile", "id", "ready", "created_at", "updated_at"];
|
|
629
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.";
|
|
630
1039
|
};
|
|
631
1040
|
export declare const FleetUpdateInputSchema: {
|
|
632
1041
|
readonly type: "object";
|
|
@@ -635,13 +1044,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
635
1044
|
readonly type: "object";
|
|
636
1045
|
readonly properties: {
|
|
637
1046
|
readonly cpu: {
|
|
638
|
-
readonly type: "
|
|
639
|
-
readonly format: "float";
|
|
1047
|
+
readonly type: "integer";
|
|
640
1048
|
readonly minimum: 0;
|
|
641
|
-
readonly
|
|
1049
|
+
readonly maximum: 100000;
|
|
1050
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
642
1051
|
};
|
|
643
1052
|
};
|
|
644
|
-
readonly required: readonly ["cpu"];
|
|
645
1053
|
readonly additionalProperties: false;
|
|
646
1054
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
647
1055
|
};
|
|
@@ -650,14 +1058,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
650
1058
|
readonly properties: {
|
|
651
1059
|
readonly enabled: {
|
|
652
1060
|
readonly type: "boolean";
|
|
653
|
-
readonly default: true;
|
|
654
1061
|
};
|
|
655
1062
|
readonly project: {
|
|
656
1063
|
readonly type: "string";
|
|
657
|
-
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";
|
|
658
1067
|
};
|
|
659
1068
|
};
|
|
660
|
-
readonly required: readonly ["
|
|
1069
|
+
readonly required: readonly ["enabled"];
|
|
661
1070
|
readonly additionalProperties: false;
|
|
662
1071
|
};
|
|
663
1072
|
readonly hetzner: {
|
|
@@ -665,14 +1074,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
665
1074
|
readonly properties: {
|
|
666
1075
|
readonly enabled: {
|
|
667
1076
|
readonly type: "boolean";
|
|
668
|
-
readonly default: true;
|
|
669
1077
|
};
|
|
670
1078
|
readonly apiKey: {
|
|
671
1079
|
readonly type: "string";
|
|
672
|
-
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.";
|
|
673
1084
|
};
|
|
674
1085
|
};
|
|
675
|
-
readonly required: readonly ["
|
|
1086
|
+
readonly required: readonly ["enabled"];
|
|
676
1087
|
readonly additionalProperties: false;
|
|
677
1088
|
};
|
|
678
1089
|
readonly aws: {
|
|
@@ -680,18 +1091,98 @@ export declare const FleetUpdateInputSchema: {
|
|
|
680
1091
|
readonly properties: {
|
|
681
1092
|
readonly enabled: {
|
|
682
1093
|
readonly type: "boolean";
|
|
683
|
-
readonly default: true;
|
|
684
1094
|
};
|
|
685
1095
|
readonly controllerRoleArn: {
|
|
686
1096
|
readonly type: "string";
|
|
687
|
-
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 [];
|
|
688
1145
|
};
|
|
689
1146
|
};
|
|
690
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
691
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"];
|
|
692
1162
|
};
|
|
693
1163
|
};
|
|
694
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"];
|
|
1182
|
+
};
|
|
1183
|
+
};
|
|
1184
|
+
readonly required: readonly ["email"];
|
|
1185
|
+
readonly additionalProperties: false;
|
|
695
1186
|
};
|
|
696
1187
|
export declare const InviteSchema: {
|
|
697
1188
|
readonly type: "object";
|
|
@@ -724,18 +1215,148 @@ export declare const InviteSchema: {
|
|
|
724
1215
|
readonly description: "Generated unique invite code.";
|
|
725
1216
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
726
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
|
+
};
|
|
727
1225
|
};
|
|
728
1226
|
readonly required: readonly ["date_created"];
|
|
729
1227
|
readonly additionalProperties: false;
|
|
730
1228
|
};
|
|
1229
|
+
export declare const InvoicePaymentAttemptSchema: {
|
|
1230
|
+
readonly type: "object";
|
|
1231
|
+
readonly properties: {
|
|
1232
|
+
readonly invoice_id: {
|
|
1233
|
+
readonly type: "string";
|
|
1234
|
+
readonly description: "Identifier of the invoice.";
|
|
1235
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
1236
|
+
};
|
|
1237
|
+
readonly number: {
|
|
1238
|
+
readonly type: "string";
|
|
1239
|
+
readonly nullable: true;
|
|
1240
|
+
readonly description: "Invoice number. Null if the invoice has no number.";
|
|
1241
|
+
readonly example: "CF-0042";
|
|
1242
|
+
};
|
|
1243
|
+
readonly amount: {
|
|
1244
|
+
readonly type: "number";
|
|
1245
|
+
readonly format: "float";
|
|
1246
|
+
readonly description: "Amount outstanding when the charge was attempted, in the smallest currency unit.";
|
|
1247
|
+
readonly example: 4200;
|
|
1248
|
+
};
|
|
1249
|
+
readonly currency: {
|
|
1250
|
+
readonly type: "string";
|
|
1251
|
+
readonly description: "Currency of the invoice.";
|
|
1252
|
+
readonly example: "eur";
|
|
1253
|
+
};
|
|
1254
|
+
readonly status: {
|
|
1255
|
+
readonly type: "string";
|
|
1256
|
+
readonly description: "Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).";
|
|
1257
|
+
readonly example: "paid";
|
|
1258
|
+
readonly enum: readonly ["paid", "processing", "requires_action", "failed"];
|
|
1259
|
+
};
|
|
1260
|
+
readonly client_secret: {
|
|
1261
|
+
readonly type: "string";
|
|
1262
|
+
readonly nullable: true;
|
|
1263
|
+
readonly description: "Client secret used to complete customer authentication. Set only when `status` is `requires_action`.";
|
|
1264
|
+
readonly example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH";
|
|
1265
|
+
};
|
|
1266
|
+
readonly failure_code: {
|
|
1267
|
+
readonly type: "string";
|
|
1268
|
+
readonly nullable: true;
|
|
1269
|
+
readonly description: "Decline code. Set only when `status` is `failed`.";
|
|
1270
|
+
readonly example: "insufficient_funds";
|
|
1271
|
+
};
|
|
1272
|
+
readonly failure_message: {
|
|
1273
|
+
readonly type: "string";
|
|
1274
|
+
readonly nullable: true;
|
|
1275
|
+
readonly description: "Explanation of the decline, suitable for display. Set only when `status` is `failed`.";
|
|
1276
|
+
readonly example: "Your card has insufficient funds.";
|
|
1277
|
+
};
|
|
1278
|
+
};
|
|
1279
|
+
readonly required: readonly ["invoice_id", "number", "amount", "currency", "status", "client_secret", "failure_code", "failure_message"];
|
|
1280
|
+
readonly additionalProperties: false;
|
|
1281
|
+
};
|
|
1282
|
+
export declare const InvoicePaymentResultSchema: {
|
|
1283
|
+
readonly type: "object";
|
|
1284
|
+
readonly properties: {
|
|
1285
|
+
readonly code: {
|
|
1286
|
+
readonly type: "string";
|
|
1287
|
+
readonly description: "Overall outcome: `paid` (nothing outstanding), `processing` (all accepted, not yet settled), `action_required` (one or more await customer authentication), `partially_paid`, `failed`, `nothing_due`, or `bank_transfer_due` (the organization pays by bank transfer; nothing was charged).";
|
|
1288
|
+
readonly example: "partially_paid";
|
|
1289
|
+
readonly enum: readonly ["paid", "processing", "action_required", "partially_paid", "failed", "nothing_due", "bank_transfer_due"];
|
|
1290
|
+
};
|
|
1291
|
+
readonly message: {
|
|
1292
|
+
readonly type: "string";
|
|
1293
|
+
readonly description: "Summary of the outcome, suitable for display.";
|
|
1294
|
+
readonly example: "1 of 2 open invoices was paid. Invoice CF-0043 was declined: Your card has insufficient funds.";
|
|
1295
|
+
};
|
|
1296
|
+
readonly results: {
|
|
1297
|
+
readonly type: "array";
|
|
1298
|
+
readonly items: {
|
|
1299
|
+
readonly type: "object";
|
|
1300
|
+
readonly properties: {
|
|
1301
|
+
readonly invoice_id: {
|
|
1302
|
+
readonly type: "string";
|
|
1303
|
+
readonly description: "Identifier of the invoice.";
|
|
1304
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
1305
|
+
};
|
|
1306
|
+
readonly number: {
|
|
1307
|
+
readonly type: "string";
|
|
1308
|
+
readonly description: "Invoice number. Null if the invoice has no number.";
|
|
1309
|
+
readonly example: "CF-0042";
|
|
1310
|
+
};
|
|
1311
|
+
readonly amount: {
|
|
1312
|
+
readonly type: "number";
|
|
1313
|
+
readonly format: "float";
|
|
1314
|
+
readonly description: "Amount outstanding when the charge was attempted, in the smallest currency unit.";
|
|
1315
|
+
readonly example: 4200;
|
|
1316
|
+
};
|
|
1317
|
+
readonly currency: {
|
|
1318
|
+
readonly type: "string";
|
|
1319
|
+
readonly description: "Currency of the invoice.";
|
|
1320
|
+
readonly example: "eur";
|
|
1321
|
+
};
|
|
1322
|
+
readonly status: {
|
|
1323
|
+
readonly type: "string";
|
|
1324
|
+
readonly description: "Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).";
|
|
1325
|
+
readonly example: "paid";
|
|
1326
|
+
readonly enum: readonly ["paid", "processing", "requires_action", "failed"];
|
|
1327
|
+
};
|
|
1328
|
+
readonly client_secret: {
|
|
1329
|
+
readonly type: "string";
|
|
1330
|
+
readonly description: "Client secret used to complete customer authentication. Set only when `status` is `requires_action`.";
|
|
1331
|
+
readonly example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH";
|
|
1332
|
+
};
|
|
1333
|
+
readonly failure_code: {
|
|
1334
|
+
readonly type: "string";
|
|
1335
|
+
readonly description: "Decline code. Set only when `status` is `failed`.";
|
|
1336
|
+
readonly example: "insufficient_funds";
|
|
1337
|
+
};
|
|
1338
|
+
readonly failure_message: {
|
|
1339
|
+
readonly type: "string";
|
|
1340
|
+
readonly description: "Explanation of the decline, suitable for display. Set only when `status` is `failed`.";
|
|
1341
|
+
readonly example: "Your card has insufficient funds.";
|
|
1342
|
+
};
|
|
1343
|
+
};
|
|
1344
|
+
readonly required: readonly ["invoice_id", "number", "amount", "currency", "status", "client_secret", "failure_code", "failure_message"];
|
|
1345
|
+
readonly additionalProperties: false;
|
|
1346
|
+
};
|
|
1347
|
+
readonly description: "One entry per invoice charged, oldest first.";
|
|
1348
|
+
};
|
|
1349
|
+
};
|
|
1350
|
+
readonly required: readonly ["code", "message", "results"];
|
|
1351
|
+
readonly additionalProperties: false;
|
|
1352
|
+
};
|
|
731
1353
|
export declare const InvoiceSchema: {
|
|
732
1354
|
readonly type: "object";
|
|
733
1355
|
readonly properties: {
|
|
734
1356
|
readonly id: {
|
|
735
1357
|
readonly type: "string";
|
|
736
|
-
readonly
|
|
737
|
-
readonly
|
|
738
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
1358
|
+
readonly description: "Unique identifier of the invoice.";
|
|
1359
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
739
1360
|
};
|
|
740
1361
|
readonly number: {
|
|
741
1362
|
readonly type: "string";
|
|
@@ -781,91 +1402,153 @@ export declare const InvoiceSchema: {
|
|
|
781
1402
|
readonly required: readonly ["created", "period_start", "period_end"];
|
|
782
1403
|
readonly additionalProperties: false;
|
|
783
1404
|
};
|
|
784
|
-
export declare const
|
|
1405
|
+
export declare const MarketplaceListingFilesSchema: {
|
|
785
1406
|
readonly type: "object";
|
|
786
1407
|
readonly properties: {
|
|
787
|
-
readonly
|
|
1408
|
+
readonly chartYaml: {
|
|
788
1409
|
readonly type: "string";
|
|
789
|
-
readonly
|
|
790
|
-
readonly
|
|
791
|
-
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
792
|
-
readonly description: "Id of the chart listing";
|
|
793
|
-
readonly example: "portworx-enterprise-disaster-recovery-baremetal";
|
|
1410
|
+
readonly description: "Raw Chart.yaml content from the Helm chart";
|
|
1411
|
+
readonly example: "apiVersion: v2\nname: nginx-ingress\nversion: 1.18.2-cfke.45\nappVersion: 1.9.4";
|
|
794
1412
|
};
|
|
795
|
-
readonly
|
|
1413
|
+
readonly valuesYaml: {
|
|
796
1414
|
readonly type: "string";
|
|
797
|
-
readonly description: "
|
|
798
|
-
readonly example: "
|
|
799
|
-
};
|
|
800
|
-
readonly developer: {
|
|
801
|
-
readonly type: "string";
|
|
802
|
-
readonly description: "Author of the chart listing";
|
|
803
|
-
readonly example: "Portworx";
|
|
804
|
-
};
|
|
805
|
-
readonly description: {
|
|
806
|
-
readonly type: "string";
|
|
807
|
-
readonly description: "Short description of the chart listing";
|
|
808
|
-
readonly example: "Run Kubernetes with unmatched scalability, availability, and self-service access to any storage";
|
|
1415
|
+
readonly description: "Raw values.yaml content from the Helm chart";
|
|
1416
|
+
readonly example: "replicaCount: 1\nimage:\n repository: nginx\n tag: latest";
|
|
809
1417
|
};
|
|
810
|
-
readonly
|
|
1418
|
+
readonly valuesSchemaJson: {
|
|
811
1419
|
readonly type: "string";
|
|
812
|
-
readonly description: "
|
|
813
|
-
readonly example: "
|
|
1420
|
+
readonly description: "JSON schema for values.yaml as a string";
|
|
1421
|
+
readonly example: "{\"type\":\"object\",\"properties\":{\"replicaCount\":{\"type\":\"number\"}}}";
|
|
814
1422
|
};
|
|
815
|
-
|
|
1423
|
+
};
|
|
1424
|
+
readonly additionalProperties: false;
|
|
1425
|
+
};
|
|
1426
|
+
export declare const MarketplaceListingSchema: {
|
|
1427
|
+
readonly type: "object";
|
|
1428
|
+
readonly properties: {
|
|
1429
|
+
readonly name: {
|
|
816
1430
|
readonly type: "string";
|
|
817
|
-
readonly description: "
|
|
818
|
-
readonly example: "
|
|
1431
|
+
readonly description: "Name of the chart";
|
|
1432
|
+
readonly example: "nginx-ingress";
|
|
819
1433
|
};
|
|
820
|
-
readonly
|
|
1434
|
+
readonly versions: {
|
|
821
1435
|
readonly type: "array";
|
|
822
1436
|
readonly items: {
|
|
823
1437
|
readonly type: "string";
|
|
824
|
-
readonly
|
|
1438
|
+
readonly pattern: "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(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-]+)*))?$";
|
|
1439
|
+
readonly description: "Specific version of the chart";
|
|
1440
|
+
readonly example: "1.18.2-cfke.45";
|
|
825
1441
|
};
|
|
826
|
-
readonly description: "
|
|
1442
|
+
readonly description: "Available versions of the chart";
|
|
827
1443
|
};
|
|
828
1444
|
readonly version_channels: {
|
|
829
1445
|
readonly type: "array";
|
|
830
1446
|
readonly items: {
|
|
831
1447
|
readonly type: "string";
|
|
832
1448
|
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-]+)*))?$";
|
|
833
|
-
readonly description: "Version
|
|
834
|
-
readonly example: "
|
|
1449
|
+
readonly description: "Version channel pattern";
|
|
1450
|
+
readonly example: "1.18.x-cfke.x";
|
|
835
1451
|
};
|
|
1452
|
+
readonly description: "Version channels for the chart";
|
|
836
1453
|
};
|
|
837
|
-
readonly
|
|
838
|
-
readonly type: "
|
|
839
|
-
readonly
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
1454
|
+
readonly latestVersion: {
|
|
1455
|
+
readonly type: "string";
|
|
1456
|
+
readonly description: "Latest version of the chart";
|
|
1457
|
+
readonly example: "1.18.2-cfke.45";
|
|
1458
|
+
};
|
|
1459
|
+
readonly metadata: {
|
|
1460
|
+
readonly type: "object";
|
|
1461
|
+
readonly properties: {
|
|
1462
|
+
readonly name: {
|
|
1463
|
+
readonly type: "string";
|
|
1464
|
+
readonly description: "Chart name from metadata";
|
|
1465
|
+
readonly example: "nginx-ingress";
|
|
1466
|
+
};
|
|
1467
|
+
readonly version: {
|
|
1468
|
+
readonly type: "string";
|
|
1469
|
+
readonly description: "Chart version from metadata";
|
|
1470
|
+
readonly example: "1.18.2-cfke.45";
|
|
1471
|
+
};
|
|
1472
|
+
readonly description: {
|
|
1473
|
+
readonly type: "string";
|
|
1474
|
+
readonly description: "Chart description";
|
|
1475
|
+
readonly example: "NGINX Ingress Controller for Kubernetes";
|
|
1476
|
+
};
|
|
1477
|
+
readonly appVersion: {
|
|
1478
|
+
readonly type: "string";
|
|
1479
|
+
readonly description: "Application version";
|
|
1480
|
+
readonly example: "1.9.4";
|
|
1481
|
+
};
|
|
1482
|
+
readonly apiVersion: {
|
|
1483
|
+
readonly type: "string";
|
|
1484
|
+
readonly description: "Helm API version";
|
|
1485
|
+
readonly example: "v2";
|
|
1486
|
+
};
|
|
1487
|
+
readonly keywords: {
|
|
1488
|
+
readonly type: "array";
|
|
1489
|
+
readonly items: {
|
|
843
1490
|
readonly type: "string";
|
|
844
|
-
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-]+)*))?$";
|
|
845
|
-
readonly description: "Version of the chart.";
|
|
846
|
-
readonly example: "2.1.1-cfke.123";
|
|
847
1491
|
};
|
|
848
|
-
readonly
|
|
1492
|
+
readonly description: "Chart keywords";
|
|
1493
|
+
readonly example: readonly ["ingress", "nginx", "load-balancer"];
|
|
1494
|
+
};
|
|
1495
|
+
readonly home: {
|
|
1496
|
+
readonly type: "string";
|
|
1497
|
+
readonly description: "Chart home URL";
|
|
1498
|
+
readonly example: "https://kubernetes.github.io/ingress-nginx/";
|
|
1499
|
+
};
|
|
1500
|
+
readonly icon: {
|
|
1501
|
+
readonly type: "string";
|
|
1502
|
+
readonly description: "A URL to an SVG or PNG image to be used as an icon";
|
|
1503
|
+
readonly example: "https://cloudfleet.ai/images/marketplace/icons/ingress-nginx.png";
|
|
1504
|
+
};
|
|
1505
|
+
readonly sources: {
|
|
1506
|
+
readonly type: "array";
|
|
1507
|
+
readonly items: {
|
|
849
1508
|
readonly type: "string";
|
|
850
|
-
readonly description: "Schema of the chart values. JSON Schema as string";
|
|
851
1509
|
};
|
|
852
|
-
readonly
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
1510
|
+
readonly description: "Chart source URLs";
|
|
1511
|
+
readonly example: readonly ["https://github.com/kubernetes/ingress-nginx"];
|
|
1512
|
+
};
|
|
1513
|
+
readonly maintainers: {
|
|
1514
|
+
readonly type: "array";
|
|
1515
|
+
readonly items: {
|
|
1516
|
+
readonly type: "object";
|
|
1517
|
+
readonly properties: {
|
|
1518
|
+
readonly name: {
|
|
1519
|
+
readonly type: "string";
|
|
1520
|
+
readonly description: "Maintainer name";
|
|
1521
|
+
readonly example: "NGINX Team";
|
|
1522
|
+
};
|
|
1523
|
+
readonly email: {
|
|
1524
|
+
readonly type: "string";
|
|
1525
|
+
readonly description: "Maintainer email";
|
|
1526
|
+
readonly example: "support@nginx.org";
|
|
1527
|
+
};
|
|
1528
|
+
};
|
|
1529
|
+
readonly required: readonly ["name"];
|
|
1530
|
+
readonly additionalProperties: false;
|
|
856
1531
|
};
|
|
1532
|
+
readonly description: "Chart maintainers";
|
|
857
1533
|
};
|
|
858
|
-
readonly required: readonly ["version", "schema", "placeholder"];
|
|
859
|
-
readonly additionalProperties: false;
|
|
860
1534
|
};
|
|
1535
|
+
readonly required: readonly ["name", "version"];
|
|
1536
|
+
readonly additionalProperties: false;
|
|
1537
|
+
readonly description: "Chart metadata";
|
|
861
1538
|
};
|
|
862
1539
|
};
|
|
863
|
-
readonly required: readonly ["
|
|
1540
|
+
readonly required: readonly ["name", "versions", "version_channels", "latestVersion"];
|
|
864
1541
|
readonly additionalProperties: false;
|
|
865
1542
|
};
|
|
866
1543
|
export declare const OrganizationCreateInputSchema: {
|
|
867
1544
|
readonly type: "object";
|
|
868
1545
|
readonly properties: {
|
|
1546
|
+
readonly type: {
|
|
1547
|
+
readonly type: "string";
|
|
1548
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1549
|
+
readonly example: "business";
|
|
1550
|
+
readonly enum: readonly ["business", "personal"];
|
|
1551
|
+
};
|
|
869
1552
|
readonly email: {
|
|
870
1553
|
readonly type: "string";
|
|
871
1554
|
readonly format: "email";
|
|
@@ -874,11 +1557,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
874
1557
|
};
|
|
875
1558
|
readonly first_name: {
|
|
876
1559
|
readonly type: "string";
|
|
1560
|
+
readonly minLength: 1;
|
|
877
1561
|
readonly description: "First name of the billing contact person.";
|
|
878
1562
|
readonly example: "John";
|
|
879
1563
|
};
|
|
880
1564
|
readonly last_name: {
|
|
881
1565
|
readonly type: "string";
|
|
1566
|
+
readonly minLength: 1;
|
|
882
1567
|
readonly description: "Last name of the billing contact person.";
|
|
883
1568
|
readonly example: "Doe";
|
|
884
1569
|
};
|
|
@@ -896,7 +1581,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
896
1581
|
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.";
|
|
897
1582
|
};
|
|
898
1583
|
};
|
|
899
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1584
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1585
|
+
readonly additionalProperties: false;
|
|
1586
|
+
};
|
|
1587
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1588
|
+
readonly type: "object";
|
|
1589
|
+
readonly properties: {
|
|
1590
|
+
readonly id: {
|
|
1591
|
+
readonly type: "string";
|
|
1592
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1593
|
+
readonly example: "organization-id";
|
|
1594
|
+
};
|
|
1595
|
+
};
|
|
1596
|
+
readonly required: readonly ["id"];
|
|
900
1597
|
readonly additionalProperties: false;
|
|
901
1598
|
};
|
|
902
1599
|
export declare const OrganizationSchema: {
|
|
@@ -915,6 +1612,12 @@ export declare const OrganizationSchema: {
|
|
|
915
1612
|
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
916
1613
|
readonly example: "ACME Corp.";
|
|
917
1614
|
};
|
|
1615
|
+
readonly type: {
|
|
1616
|
+
readonly type: "string";
|
|
1617
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1618
|
+
readonly example: "business";
|
|
1619
|
+
readonly enum: readonly ["business", "personal"];
|
|
1620
|
+
};
|
|
918
1621
|
readonly date_created: {
|
|
919
1622
|
readonly type: "string";
|
|
920
1623
|
readonly format: "date-time";
|
|
@@ -946,6 +1649,17 @@ export declare const OrganizationSchema: {
|
|
|
946
1649
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
947
1650
|
readonly example: 999;
|
|
948
1651
|
};
|
|
1652
|
+
readonly enterprise_clusters_max: {
|
|
1653
|
+
readonly type: "integer";
|
|
1654
|
+
readonly minimum: 0;
|
|
1655
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1656
|
+
readonly example: 999;
|
|
1657
|
+
};
|
|
1658
|
+
readonly enterprise_clusters_available: {
|
|
1659
|
+
readonly type: "integer";
|
|
1660
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1661
|
+
readonly example: 999;
|
|
1662
|
+
};
|
|
949
1663
|
readonly fleets_max: {
|
|
950
1664
|
readonly type: "integer";
|
|
951
1665
|
readonly minimum: 0;
|
|
@@ -965,7 +1679,7 @@ export declare const OrganizationSchema: {
|
|
|
965
1679
|
readonly type: "array";
|
|
966
1680
|
readonly items: {
|
|
967
1681
|
readonly type: "string";
|
|
968
|
-
readonly example: "northamerica-central-
|
|
1682
|
+
readonly example: "northamerica-central-1a";
|
|
969
1683
|
};
|
|
970
1684
|
readonly minItems: 1;
|
|
971
1685
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -992,8 +1706,14 @@ export declare const OrganizationSchema: {
|
|
|
992
1706
|
readonly minItems: 1;
|
|
993
1707
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
994
1708
|
};
|
|
1709
|
+
readonly cfcr_storage_gb: {
|
|
1710
|
+
readonly type: "integer";
|
|
1711
|
+
readonly minimum: -1;
|
|
1712
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1713
|
+
readonly example: 500;
|
|
1714
|
+
};
|
|
995
1715
|
};
|
|
996
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions"];
|
|
1716
|
+
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"];
|
|
997
1717
|
readonly additionalProperties: false;
|
|
998
1718
|
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.";
|
|
999
1719
|
};
|
|
@@ -1002,8 +1722,14 @@ export declare const OrganizationSchema: {
|
|
|
1002
1722
|
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1003
1723
|
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1004
1724
|
};
|
|
1725
|
+
readonly verification: {
|
|
1726
|
+
readonly type: "string";
|
|
1727
|
+
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.";
|
|
1728
|
+
readonly example: "verified";
|
|
1729
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1730
|
+
};
|
|
1005
1731
|
};
|
|
1006
|
-
readonly required: readonly ["id", "date_created", "quota", "status"];
|
|
1732
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1007
1733
|
readonly additionalProperties: false;
|
|
1008
1734
|
};
|
|
1009
1735
|
export declare const PaymentMethodSchema: {
|
|
@@ -1011,26 +1737,19 @@ export declare const PaymentMethodSchema: {
|
|
|
1011
1737
|
readonly properties: {
|
|
1012
1738
|
readonly id: {
|
|
1013
1739
|
readonly type: "string";
|
|
1014
|
-
readonly
|
|
1015
|
-
readonly
|
|
1016
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1017
|
-
};
|
|
1018
|
-
readonly setup: {
|
|
1019
|
-
readonly type: "boolean";
|
|
1020
|
-
readonly description: "Whether organization payment method was set up and ready to use for payments.";
|
|
1021
|
-
readonly example: true;
|
|
1740
|
+
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.";
|
|
1741
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1022
1742
|
};
|
|
1023
1743
|
readonly type: {
|
|
1024
1744
|
readonly type: "string";
|
|
1025
|
-
readonly
|
|
1026
|
-
readonly description: "Payment method type type. Only `card` payments supported at the moment.";
|
|
1745
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1027
1746
|
readonly example: "card";
|
|
1028
|
-
readonly enum: readonly ["card"];
|
|
1747
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1029
1748
|
};
|
|
1030
1749
|
readonly last4: {
|
|
1031
1750
|
readonly type: "string";
|
|
1032
1751
|
readonly nullable: true;
|
|
1033
|
-
readonly description: "Last 4 digits of the payment card number.";
|
|
1752
|
+
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.";
|
|
1034
1753
|
readonly example: "4242";
|
|
1035
1754
|
};
|
|
1036
1755
|
readonly exp_month: {
|
|
@@ -1038,25 +1757,46 @@ export declare const PaymentMethodSchema: {
|
|
|
1038
1757
|
readonly minimum: 1;
|
|
1039
1758
|
readonly maximum: 12;
|
|
1040
1759
|
readonly nullable: true;
|
|
1041
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1042
|
-
readonly example:
|
|
1760
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1761
|
+
readonly example: 12;
|
|
1043
1762
|
};
|
|
1044
1763
|
readonly exp_year: {
|
|
1045
1764
|
readonly type: "integer";
|
|
1046
|
-
readonly minimum: 2024;
|
|
1047
1765
|
readonly nullable: true;
|
|
1048
|
-
readonly description: "Four-digit number representing the card's expiration year.";
|
|
1049
|
-
readonly example:
|
|
1766
|
+
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.";
|
|
1767
|
+
readonly example: 2028;
|
|
1050
1768
|
};
|
|
1051
1769
|
readonly brand: {
|
|
1052
1770
|
readonly type: "string";
|
|
1053
1771
|
readonly nullable: true;
|
|
1054
|
-
readonly description: "Payment card brand
|
|
1772
|
+
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.";
|
|
1055
1773
|
readonly example: "visa";
|
|
1056
|
-
|
|
1774
|
+
};
|
|
1775
|
+
readonly iban: {
|
|
1776
|
+
readonly type: "string";
|
|
1777
|
+
readonly nullable: true;
|
|
1778
|
+
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.";
|
|
1779
|
+
readonly example: "DE11243015658023127510";
|
|
1780
|
+
};
|
|
1781
|
+
readonly bic: {
|
|
1782
|
+
readonly type: "string";
|
|
1783
|
+
readonly nullable: true;
|
|
1784
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1785
|
+
readonly example: "SOGEDEFFXXX";
|
|
1786
|
+
};
|
|
1787
|
+
readonly account_holder_name: {
|
|
1788
|
+
readonly type: "string";
|
|
1789
|
+
readonly nullable: true;
|
|
1790
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1791
|
+
readonly example: "Cloudfleet GmbH";
|
|
1792
|
+
};
|
|
1793
|
+
readonly is_default: {
|
|
1794
|
+
readonly type: "boolean";
|
|
1795
|
+
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).";
|
|
1796
|
+
readonly example: true;
|
|
1057
1797
|
};
|
|
1058
1798
|
};
|
|
1059
|
-
readonly required: readonly ["id", "
|
|
1799
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1060
1800
|
readonly additionalProperties: false;
|
|
1061
1801
|
};
|
|
1062
1802
|
export declare const PlatformQuotaSchema: {
|
|
@@ -1084,6 +1824,17 @@ export declare const PlatformQuotaSchema: {
|
|
|
1084
1824
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1085
1825
|
readonly example: 999;
|
|
1086
1826
|
};
|
|
1827
|
+
readonly enterprise_clusters_max: {
|
|
1828
|
+
readonly type: "integer";
|
|
1829
|
+
readonly minimum: 0;
|
|
1830
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1831
|
+
readonly example: 999;
|
|
1832
|
+
};
|
|
1833
|
+
readonly enterprise_clusters_available: {
|
|
1834
|
+
readonly type: "integer";
|
|
1835
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1836
|
+
readonly example: 999;
|
|
1837
|
+
};
|
|
1087
1838
|
readonly fleets_max: {
|
|
1088
1839
|
readonly type: "integer";
|
|
1089
1840
|
readonly minimum: 0;
|
|
@@ -1103,7 +1854,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1103
1854
|
readonly type: "array";
|
|
1104
1855
|
readonly items: {
|
|
1105
1856
|
readonly type: "string";
|
|
1106
|
-
readonly example: "northamerica-central-
|
|
1857
|
+
readonly example: "northamerica-central-1a";
|
|
1107
1858
|
};
|
|
1108
1859
|
readonly minItems: 1;
|
|
1109
1860
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1130,8 +1881,14 @@ export declare const PlatformQuotaSchema: {
|
|
|
1130
1881
|
readonly minItems: 1;
|
|
1131
1882
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1132
1883
|
};
|
|
1884
|
+
readonly cfcr_storage_gb: {
|
|
1885
|
+
readonly type: "integer";
|
|
1886
|
+
readonly minimum: -1;
|
|
1887
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1888
|
+
readonly example: 500;
|
|
1889
|
+
};
|
|
1133
1890
|
};
|
|
1134
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions"];
|
|
1891
|
+
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"];
|
|
1135
1892
|
readonly additionalProperties: false;
|
|
1136
1893
|
};
|
|
1137
1894
|
export declare const RegistryRepositorySchema: {
|
|
@@ -1150,7 +1907,7 @@ export declare const RegistryRepositorySchema: {
|
|
|
1150
1907
|
readonly uri: {
|
|
1151
1908
|
readonly type: "string";
|
|
1152
1909
|
readonly description: "Full URI of the repository.";
|
|
1153
|
-
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/
|
|
1910
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1154
1911
|
};
|
|
1155
1912
|
};
|
|
1156
1913
|
readonly required: readonly ["name", "region", "uri"];
|
|
@@ -1172,7 +1929,7 @@ export declare const RegistryRepositoryWithTagsSchema: {
|
|
|
1172
1929
|
readonly uri: {
|
|
1173
1930
|
readonly type: "string";
|
|
1174
1931
|
readonly description: "Full URI of the repository.";
|
|
1175
|
-
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/
|
|
1932
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1176
1933
|
};
|
|
1177
1934
|
readonly tags: {
|
|
1178
1935
|
readonly type: "array";
|
|
@@ -1195,6 +1952,14 @@ export declare const RegistryRepositoryWithTagsSchema: {
|
|
|
1195
1952
|
readonly description: "Media type of the manifest.";
|
|
1196
1953
|
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
1197
1954
|
};
|
|
1955
|
+
readonly platforms: {
|
|
1956
|
+
readonly type: "array";
|
|
1957
|
+
readonly items: {
|
|
1958
|
+
readonly type: "string";
|
|
1959
|
+
};
|
|
1960
|
+
readonly description: "Array of platform strings for multi-arch images (e.g., linux/amd64, linux/arm64).";
|
|
1961
|
+
readonly example: readonly ["linux/amd64", "linux/arm64"];
|
|
1962
|
+
};
|
|
1198
1963
|
};
|
|
1199
1964
|
readonly required: readonly ["name", "size"];
|
|
1200
1965
|
readonly additionalProperties: false;
|
|
@@ -1219,6 +1984,11 @@ export declare const RegistryTagSchema: {
|
|
|
1219
1984
|
readonly description: "Tag name.";
|
|
1220
1985
|
readonly example: "latest";
|
|
1221
1986
|
};
|
|
1987
|
+
readonly digest: {
|
|
1988
|
+
readonly type: "string";
|
|
1989
|
+
readonly description: "Manifest digest for pulling by digest.";
|
|
1990
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1991
|
+
};
|
|
1222
1992
|
readonly mediaType: {
|
|
1223
1993
|
readonly type: "string";
|
|
1224
1994
|
readonly description: "Media type of the manifest.";
|
|
@@ -1243,6 +2013,11 @@ export declare const RegistryTagSchema: {
|
|
|
1243
2013
|
readonly items: {
|
|
1244
2014
|
readonly type: "object";
|
|
1245
2015
|
readonly properties: {
|
|
2016
|
+
readonly digest: {
|
|
2017
|
+
readonly type: "string";
|
|
2018
|
+
readonly description: "Digest of the layer.";
|
|
2019
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
2020
|
+
};
|
|
1246
2021
|
readonly size: {
|
|
1247
2022
|
readonly type: "number";
|
|
1248
2023
|
readonly format: "float";
|
|
@@ -1278,11 +2053,44 @@ export declare const RegistryTagSchema: {
|
|
|
1278
2053
|
readonly description: "Operating system of the platform.";
|
|
1279
2054
|
readonly example: "linux";
|
|
1280
2055
|
};
|
|
2056
|
+
readonly variant: {
|
|
2057
|
+
readonly type: "string";
|
|
2058
|
+
readonly description: "Variant of the platform (e.g., v7, v8 for ARM).";
|
|
2059
|
+
readonly example: "v8";
|
|
2060
|
+
};
|
|
1281
2061
|
};
|
|
1282
2062
|
readonly required: readonly ["architecture", "os"];
|
|
1283
2063
|
readonly additionalProperties: false;
|
|
1284
2064
|
readonly description: "Platform information for the manifest.";
|
|
1285
2065
|
};
|
|
2066
|
+
readonly layers: {
|
|
2067
|
+
readonly type: "array";
|
|
2068
|
+
readonly items: {
|
|
2069
|
+
readonly type: "object";
|
|
2070
|
+
readonly properties: {
|
|
2071
|
+
readonly digest: {
|
|
2072
|
+
readonly type: "string";
|
|
2073
|
+
readonly description: "Digest of the layer.";
|
|
2074
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
2075
|
+
};
|
|
2076
|
+
readonly size: {
|
|
2077
|
+
readonly type: "number";
|
|
2078
|
+
readonly format: "float";
|
|
2079
|
+
readonly description: "Size of the layer in bytes.";
|
|
2080
|
+
readonly example: 5678;
|
|
2081
|
+
};
|
|
2082
|
+
};
|
|
2083
|
+
readonly required: readonly ["size"];
|
|
2084
|
+
readonly additionalProperties: false;
|
|
2085
|
+
};
|
|
2086
|
+
readonly description: "Layers for this platform.";
|
|
2087
|
+
};
|
|
2088
|
+
readonly size: {
|
|
2089
|
+
readonly type: "number";
|
|
2090
|
+
readonly format: "float";
|
|
2091
|
+
readonly description: "Total size of this platform manifest in bytes.";
|
|
2092
|
+
readonly example: 12345678;
|
|
2093
|
+
};
|
|
1286
2094
|
};
|
|
1287
2095
|
readonly required: readonly ["digest"];
|
|
1288
2096
|
readonly additionalProperties: false;
|
|
@@ -1311,7 +2119,275 @@ export declare const RegistryTagSchema: {
|
|
|
1311
2119
|
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app:latest";
|
|
1312
2120
|
};
|
|
1313
2121
|
};
|
|
1314
|
-
readonly required: readonly ["name", "size", "region", "repository", "uri"];
|
|
2122
|
+
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
2123
|
+
readonly additionalProperties: false;
|
|
2124
|
+
};
|
|
2125
|
+
export declare const TicketAttachmentSchema: {
|
|
2126
|
+
readonly type: "object";
|
|
2127
|
+
readonly properties: {
|
|
2128
|
+
readonly id: {
|
|
2129
|
+
readonly type: "string";
|
|
2130
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2131
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2132
|
+
};
|
|
2133
|
+
readonly filename: {
|
|
2134
|
+
readonly type: "string";
|
|
2135
|
+
readonly description: "Original filename as uploaded.";
|
|
2136
|
+
readonly example: "debug.log";
|
|
2137
|
+
};
|
|
2138
|
+
readonly content_type: {
|
|
2139
|
+
readonly type: "string";
|
|
2140
|
+
readonly description: "MIME content type of the attachment.";
|
|
2141
|
+
readonly example: "text/plain";
|
|
2142
|
+
};
|
|
2143
|
+
readonly size: {
|
|
2144
|
+
readonly type: "integer";
|
|
2145
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2146
|
+
readonly example: 12345;
|
|
2147
|
+
};
|
|
2148
|
+
};
|
|
2149
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2150
|
+
readonly additionalProperties: false;
|
|
2151
|
+
};
|
|
2152
|
+
export declare const TicketCreateInputSchema: {
|
|
2153
|
+
readonly type: "object";
|
|
2154
|
+
readonly properties: {
|
|
2155
|
+
readonly category: {
|
|
2156
|
+
readonly type: "string";
|
|
2157
|
+
readonly description: "Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.";
|
|
2158
|
+
readonly example: "technical";
|
|
2159
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2160
|
+
};
|
|
2161
|
+
readonly body: {
|
|
2162
|
+
readonly type: "string";
|
|
2163
|
+
readonly maxLength: 50000;
|
|
2164
|
+
readonly minLength: 1;
|
|
2165
|
+
readonly pattern: "\\S";
|
|
2166
|
+
readonly description: "Initial message body in markdown. There is no separate subject — the first message body is the description.";
|
|
2167
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2168
|
+
};
|
|
2169
|
+
readonly properties: {
|
|
2170
|
+
readonly type: "object";
|
|
2171
|
+
readonly additionalProperties: true;
|
|
2172
|
+
readonly description: "Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).";
|
|
2173
|
+
readonly example: {
|
|
2174
|
+
readonly subcategory: "cluster-question";
|
|
2175
|
+
readonly cluster_id: "60c72b2f9f1b2c001f8e4d3a";
|
|
2176
|
+
};
|
|
2177
|
+
};
|
|
2178
|
+
};
|
|
2179
|
+
readonly required: readonly ["category", "body"];
|
|
2180
|
+
readonly additionalProperties: false;
|
|
2181
|
+
};
|
|
2182
|
+
export declare const TicketMessageInputSchema: {
|
|
2183
|
+
readonly type: "object";
|
|
2184
|
+
readonly properties: {
|
|
2185
|
+
readonly body: {
|
|
2186
|
+
readonly type: "string";
|
|
2187
|
+
readonly maxLength: 50000;
|
|
2188
|
+
readonly minLength: 1;
|
|
2189
|
+
readonly pattern: "\\S";
|
|
2190
|
+
readonly description: "Reply body in markdown.";
|
|
2191
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2192
|
+
};
|
|
2193
|
+
};
|
|
2194
|
+
readonly required: readonly ["body"];
|
|
2195
|
+
readonly additionalProperties: false;
|
|
2196
|
+
};
|
|
2197
|
+
export declare const TicketMessageSchema: {
|
|
2198
|
+
readonly type: "object";
|
|
2199
|
+
readonly properties: {
|
|
2200
|
+
readonly id: {
|
|
2201
|
+
readonly type: "string";
|
|
2202
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2203
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2204
|
+
};
|
|
2205
|
+
readonly type: {
|
|
2206
|
+
readonly type: "string";
|
|
2207
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2208
|
+
readonly example: "customer_reply";
|
|
2209
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2210
|
+
};
|
|
2211
|
+
readonly body: {
|
|
2212
|
+
readonly type: "string";
|
|
2213
|
+
readonly description: "Message body in markdown.";
|
|
2214
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2215
|
+
};
|
|
2216
|
+
readonly author_first_name: {
|
|
2217
|
+
readonly type: "string";
|
|
2218
|
+
readonly nullable: true;
|
|
2219
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2220
|
+
readonly example: "Jane";
|
|
2221
|
+
};
|
|
2222
|
+
readonly author_last_name: {
|
|
2223
|
+
readonly type: "string";
|
|
2224
|
+
readonly nullable: true;
|
|
2225
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2226
|
+
readonly example: "Doe";
|
|
2227
|
+
};
|
|
2228
|
+
readonly attachments: {
|
|
2229
|
+
readonly type: "array";
|
|
2230
|
+
readonly items: {
|
|
2231
|
+
readonly type: "object";
|
|
2232
|
+
readonly properties: {
|
|
2233
|
+
readonly id: {
|
|
2234
|
+
readonly type: "string";
|
|
2235
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2236
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2237
|
+
};
|
|
2238
|
+
readonly filename: {
|
|
2239
|
+
readonly type: "string";
|
|
2240
|
+
readonly description: "Original filename as uploaded.";
|
|
2241
|
+
readonly example: "debug.log";
|
|
2242
|
+
};
|
|
2243
|
+
readonly content_type: {
|
|
2244
|
+
readonly type: "string";
|
|
2245
|
+
readonly description: "MIME content type of the attachment.";
|
|
2246
|
+
readonly example: "text/plain";
|
|
2247
|
+
};
|
|
2248
|
+
readonly size: {
|
|
2249
|
+
readonly type: "integer";
|
|
2250
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2251
|
+
readonly example: 12345;
|
|
2252
|
+
};
|
|
2253
|
+
};
|
|
2254
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2255
|
+
readonly additionalProperties: false;
|
|
2256
|
+
};
|
|
2257
|
+
readonly description: "Attachments associated with this message.";
|
|
2258
|
+
readonly example: readonly [];
|
|
2259
|
+
};
|
|
2260
|
+
readonly date_created: {
|
|
2261
|
+
readonly type: "string";
|
|
2262
|
+
readonly format: "date-time";
|
|
2263
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2264
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2265
|
+
};
|
|
2266
|
+
};
|
|
2267
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2268
|
+
readonly additionalProperties: false;
|
|
2269
|
+
};
|
|
2270
|
+
export declare const TicketSchema: {
|
|
2271
|
+
readonly type: "object";
|
|
2272
|
+
readonly properties: {
|
|
2273
|
+
readonly id: {
|
|
2274
|
+
readonly type: "string";
|
|
2275
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
2276
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
2277
|
+
};
|
|
2278
|
+
readonly status: {
|
|
2279
|
+
readonly type: "string";
|
|
2280
|
+
readonly description: "Current state of the ticket.";
|
|
2281
|
+
readonly example: "waiting_on_us";
|
|
2282
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
2283
|
+
};
|
|
2284
|
+
readonly category: {
|
|
2285
|
+
readonly type: "string";
|
|
2286
|
+
readonly description: "Ticket category.";
|
|
2287
|
+
readonly example: "technical";
|
|
2288
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2289
|
+
};
|
|
2290
|
+
readonly summary: {
|
|
2291
|
+
readonly type: "string";
|
|
2292
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
2293
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2294
|
+
};
|
|
2295
|
+
readonly closed_at: {
|
|
2296
|
+
readonly type: "string";
|
|
2297
|
+
readonly format: "date-time";
|
|
2298
|
+
readonly nullable: true;
|
|
2299
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2300
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
2301
|
+
};
|
|
2302
|
+
readonly date_created: {
|
|
2303
|
+
readonly type: "string";
|
|
2304
|
+
readonly format: "date-time";
|
|
2305
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
2306
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2307
|
+
};
|
|
2308
|
+
readonly date_updated: {
|
|
2309
|
+
readonly type: "string";
|
|
2310
|
+
readonly format: "date-time";
|
|
2311
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2312
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2313
|
+
};
|
|
2314
|
+
readonly messages: {
|
|
2315
|
+
readonly type: "array";
|
|
2316
|
+
readonly items: {
|
|
2317
|
+
readonly type: "object";
|
|
2318
|
+
readonly properties: {
|
|
2319
|
+
readonly id: {
|
|
2320
|
+
readonly type: "string";
|
|
2321
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2322
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2323
|
+
};
|
|
2324
|
+
readonly type: {
|
|
2325
|
+
readonly type: "string";
|
|
2326
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2327
|
+
readonly example: "customer_reply";
|
|
2328
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2329
|
+
};
|
|
2330
|
+
readonly body: {
|
|
2331
|
+
readonly type: "string";
|
|
2332
|
+
readonly description: "Message body in markdown.";
|
|
2333
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2334
|
+
};
|
|
2335
|
+
readonly author_first_name: {
|
|
2336
|
+
readonly type: "string";
|
|
2337
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2338
|
+
readonly example: "Jane";
|
|
2339
|
+
};
|
|
2340
|
+
readonly author_last_name: {
|
|
2341
|
+
readonly type: "string";
|
|
2342
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2343
|
+
readonly example: "Doe";
|
|
2344
|
+
};
|
|
2345
|
+
readonly attachments: {
|
|
2346
|
+
readonly type: "array";
|
|
2347
|
+
readonly items: {
|
|
2348
|
+
readonly type: "object";
|
|
2349
|
+
readonly properties: {
|
|
2350
|
+
readonly id: {
|
|
2351
|
+
readonly type: "string";
|
|
2352
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2353
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2354
|
+
};
|
|
2355
|
+
readonly filename: {
|
|
2356
|
+
readonly type: "string";
|
|
2357
|
+
readonly description: "Original filename as uploaded.";
|
|
2358
|
+
readonly example: "debug.log";
|
|
2359
|
+
};
|
|
2360
|
+
readonly content_type: {
|
|
2361
|
+
readonly type: "string";
|
|
2362
|
+
readonly description: "MIME content type of the attachment.";
|
|
2363
|
+
readonly example: "text/plain";
|
|
2364
|
+
};
|
|
2365
|
+
readonly size: {
|
|
2366
|
+
readonly type: "integer";
|
|
2367
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2368
|
+
readonly example: 12345;
|
|
2369
|
+
};
|
|
2370
|
+
};
|
|
2371
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2372
|
+
readonly additionalProperties: false;
|
|
2373
|
+
};
|
|
2374
|
+
readonly description: "Attachments associated with this message.";
|
|
2375
|
+
readonly example: readonly [];
|
|
2376
|
+
};
|
|
2377
|
+
readonly date_created: {
|
|
2378
|
+
readonly type: "string";
|
|
2379
|
+
readonly format: "date-time";
|
|
2380
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2381
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2382
|
+
};
|
|
2383
|
+
};
|
|
2384
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2385
|
+
readonly additionalProperties: false;
|
|
2386
|
+
};
|
|
2387
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
2388
|
+
};
|
|
2389
|
+
};
|
|
2390
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1315
2391
|
readonly additionalProperties: false;
|
|
1316
2392
|
};
|
|
1317
2393
|
export declare const TokenCreateInputSchema: {
|
|
@@ -1407,9 +2483,10 @@ export declare const UsageFacetsSchema: {
|
|
|
1407
2483
|
readonly type: "array";
|
|
1408
2484
|
readonly items: {
|
|
1409
2485
|
readonly type: "string";
|
|
2486
|
+
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"];
|
|
1410
2487
|
};
|
|
1411
2488
|
readonly description: "List of unique products";
|
|
1412
|
-
readonly example: readonly ["
|
|
2489
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
1413
2490
|
};
|
|
1414
2491
|
};
|
|
1415
2492
|
readonly additionalProperties: false;
|
|
@@ -1435,7 +2512,8 @@ export declare const UsageResponseSchema: {
|
|
|
1435
2512
|
readonly product: {
|
|
1436
2513
|
readonly type: "string";
|
|
1437
2514
|
readonly description: "The product the usage is associated with";
|
|
1438
|
-
readonly example: "
|
|
2515
|
+
readonly example: "cfke_controlplane_pro";
|
|
2516
|
+
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"];
|
|
1439
2517
|
};
|
|
1440
2518
|
readonly value: {
|
|
1441
2519
|
readonly type: "number";
|
|
@@ -1475,9 +2553,10 @@ export declare const UsageResponseSchema: {
|
|
|
1475
2553
|
readonly type: "array";
|
|
1476
2554
|
readonly items: {
|
|
1477
2555
|
readonly type: "string";
|
|
2556
|
+
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"];
|
|
1478
2557
|
};
|
|
1479
2558
|
readonly description: "List of unique products";
|
|
1480
|
-
readonly example: readonly ["
|
|
2559
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
1481
2560
|
};
|
|
1482
2561
|
};
|
|
1483
2562
|
readonly additionalProperties: false;
|
|
@@ -1503,7 +2582,8 @@ export declare const UsageSchema: {
|
|
|
1503
2582
|
readonly product: {
|
|
1504
2583
|
readonly type: "string";
|
|
1505
2584
|
readonly description: "The product the usage is associated with";
|
|
1506
|
-
readonly example: "
|
|
2585
|
+
readonly example: "cfke_controlplane_pro";
|
|
2586
|
+
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"];
|
|
1507
2587
|
};
|
|
1508
2588
|
readonly value: {
|
|
1509
2589
|
readonly type: "number";
|
|
@@ -1560,18 +2640,6 @@ export declare const UserCreateInputSchema: {
|
|
|
1560
2640
|
readonly minLength: 8;
|
|
1561
2641
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
1562
2642
|
};
|
|
1563
|
-
readonly status: {
|
|
1564
|
-
readonly type: "string";
|
|
1565
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
1566
|
-
readonly example: "active";
|
|
1567
|
-
readonly enum: readonly ["active", "inactive"];
|
|
1568
|
-
};
|
|
1569
|
-
readonly role: {
|
|
1570
|
-
readonly type: "string";
|
|
1571
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
1572
|
-
readonly example: "User";
|
|
1573
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
1574
|
-
};
|
|
1575
2643
|
};
|
|
1576
2644
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
1577
2645
|
readonly additionalProperties: false;
|