@cloudfleet/sdk 0.0.1-6a60d36 → 0.0.1-6b43f7e
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 +1159 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1175 -0
- package/dist/@tanstack/react-query.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts +3 -0
- package/dist/client/client.gen.d.ts.map +1 -0
- package/dist/client/client.gen.js +217 -0
- package/dist/client/client.gen.js.map +1 -0
- package/dist/client/index.d.ts +9 -0
- package/dist/client/index.d.ts.map +1 -0
- package/dist/client/index.js +7 -0
- package/dist/client/index.js.map +1 -0
- package/dist/client/types.gen.d.ts +121 -0
- package/dist/client/types.gen.d.ts.map +1 -0
- package/dist/client/types.gen.js +3 -0
- package/dist/client/types.gen.js.map +1 -0
- package/dist/client/utils.gen.d.ts +38 -0
- package/dist/client/utils.gen.d.ts.map +1 -0
- package/dist/client/utils.gen.js +229 -0
- package/dist/client/utils.gen.js.map +1 -0
- package/dist/client.gen.d.ts +4 -4
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/client.gen.js +2 -4
- package/dist/client.gen.js.map +1 -1
- package/dist/core/auth.gen.d.ts +19 -0
- package/dist/core/auth.gen.d.ts.map +1 -0
- package/dist/core/auth.gen.js +15 -0
- package/dist/core/auth.gen.js.map +1 -0
- package/dist/core/bodySerializer.gen.d.ts +26 -0
- package/dist/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/core/bodySerializer.gen.js +58 -0
- package/dist/core/bodySerializer.gen.js.map +1 -0
- package/dist/core/params.gen.d.ts +44 -0
- package/dist/core/params.gen.d.ts.map +1 -0
- package/dist/core/params.gen.js +101 -0
- package/dist/core/params.gen.js.map +1 -0
- package/dist/core/pathSerializer.gen.d.ts +34 -0
- package/dist/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/core/pathSerializer.gen.js +107 -0
- package/dist/core/pathSerializer.gen.js.map +1 -0
- package/dist/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/core/queryKeySerializer.gen.js +93 -0
- package/dist/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/core/serverSentEvents.gen.js +133 -0
- package/dist/core/serverSentEvents.gen.js.map +1 -0
- package/dist/core/types.gen.d.ts +79 -0
- package/dist/core/types.gen.d.ts.map +1 -0
- package/dist/core/types.gen.js +3 -0
- package/dist/core/types.gen.js.map +1 -0
- package/dist/core/utils.gen.d.ts +20 -0
- package/dist/core/utils.gen.d.ts.map +1 -0
- package/dist/core/utils.gen.js +88 -0
- package/dist/core/utils.gen.js.map +1 -0
- package/dist/schemas.gen.d.ts +1724 -680
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +3034 -709
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +300 -175
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +427 -348
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +20 -20
- package/dist/types.gen.d.ts +1825 -801
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3889 -2233
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1526 -824
- package/dist/zod.gen.js.map +1 -1
- package/package.json +28 -9
package/dist/schemas.gen.d.ts
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
export declare const BillingContactSchema: {
|
|
2
2
|
readonly type: "object";
|
|
3
3
|
readonly properties: {
|
|
4
|
+
readonly type: {
|
|
5
|
+
readonly type: "string";
|
|
6
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
7
|
+
readonly example: "business";
|
|
8
|
+
readonly enum: readonly ["business", "personal"];
|
|
9
|
+
};
|
|
4
10
|
readonly company: {
|
|
5
11
|
readonly type: "string";
|
|
6
12
|
readonly maxLength: 120;
|
|
@@ -57,15 +63,10 @@ export declare const BillingContactSchema: {
|
|
|
57
63
|
readonly description: "Email address used for billing as a string.";
|
|
58
64
|
readonly example: "email@example.com";
|
|
59
65
|
};
|
|
60
|
-
readonly
|
|
61
|
-
readonly type: "string";
|
|
62
|
-
readonly description: "First name of the billing contact person.";
|
|
63
|
-
readonly example: "John";
|
|
64
|
-
};
|
|
65
|
-
readonly last_name: {
|
|
66
|
+
readonly individual_name: {
|
|
66
67
|
readonly type: "string";
|
|
67
|
-
readonly description: "
|
|
68
|
-
readonly example: "Doe";
|
|
68
|
+
readonly description: "Name of the billing contact person.";
|
|
69
|
+
readonly example: "John Doe";
|
|
69
70
|
};
|
|
70
71
|
readonly tax_id: {
|
|
71
72
|
readonly type: "string";
|
|
@@ -81,7 +82,7 @@ export declare const BillingContactSchema: {
|
|
|
81
82
|
readonly enum: readonly ["ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "at_vat", "au_abn", "au_arn", "ba_tin", "bb_tin", "be_vat", "bg_uic", "bg_vat", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", "cy_vat", "cz_vat", "de_stn", "de_vat", "dk_vat", "do_rcn", "ec_ruc", "ee_vat", "eg_tin", "es_cif", "es_vat", "eu_oss_vat", "fi_vat", "fr_vat", "gb_vat", "ge_vat", "gn_nif", "gr_vat", "hk_br", "hr_oib", "hr_vat", "hu_tin", "hu_vat", "id_npwp", "ie_vat", "il_vat", "in_gst", "is_vat", "it_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "lt_vat", "lu_vat", "lv_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mt_vat", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "nl_vat", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "pl_vat", "pt_vat", "ro_tin", "ro_vat", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "se_vat", "sg_gst", "sg_uen", "si_tin", "si_vat", "sk_vat", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "xi_vat", "za_vat", "zm_tin", "zw_tin", ""];
|
|
82
83
|
};
|
|
83
84
|
};
|
|
84
|
-
readonly required: readonly ["
|
|
85
|
+
readonly required: readonly ["type", "email", "individual_name"];
|
|
85
86
|
readonly additionalProperties: false;
|
|
86
87
|
};
|
|
87
88
|
export declare const BillingCreditsSchema: {
|
|
@@ -92,10 +93,22 @@ export declare const BillingCreditsSchema: {
|
|
|
92
93
|
readonly description: "Generated unique identifier of the promotional code.";
|
|
93
94
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
94
95
|
};
|
|
95
|
-
readonly
|
|
96
|
+
readonly type: {
|
|
97
|
+
readonly type: "string";
|
|
98
|
+
readonly description: "Type of the promotional code.";
|
|
99
|
+
readonly example: "credit";
|
|
100
|
+
readonly enum: readonly ["credit", "discount"];
|
|
101
|
+
};
|
|
102
|
+
readonly date_start: {
|
|
103
|
+
readonly type: "string";
|
|
104
|
+
readonly format: "date-time";
|
|
105
|
+
readonly description: "Timestamp when the credit becomes active. ISO 8601 date string in the UTC timezone.";
|
|
106
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
107
|
+
};
|
|
108
|
+
readonly date_end: {
|
|
96
109
|
readonly type: "string";
|
|
97
110
|
readonly format: "date-time";
|
|
98
|
-
readonly description: "
|
|
111
|
+
readonly description: "Timestamp when the credit expires or becomes inactive. ISO 8601 date string in the UTC timezone.";
|
|
99
112
|
readonly example: "2023-12-20T13:53:32.000Z";
|
|
100
113
|
};
|
|
101
114
|
readonly code: {
|
|
@@ -108,40 +121,20 @@ export declare const BillingCreditsSchema: {
|
|
|
108
121
|
readonly description: "Description of the promotional code.";
|
|
109
122
|
readonly example: "10% off on all products";
|
|
110
123
|
};
|
|
111
|
-
readonly
|
|
112
|
-
readonly type: "array";
|
|
113
|
-
readonly items: {
|
|
114
|
-
readonly type: "string";
|
|
115
|
-
};
|
|
116
|
-
readonly description: "List of product SKUs that the promotional code can be used on.";
|
|
117
|
-
readonly example: readonly ["cfke_controlplane", "cfke_connected_nodes", "infra_compute", "infra_storage", "infra_loadbalancing", "infra_traffic", "cfcr_storage"];
|
|
118
|
-
};
|
|
119
|
-
readonly type: {
|
|
120
|
-
readonly type: "string";
|
|
121
|
-
readonly description: "Type of the promotional code.";
|
|
122
|
-
readonly example: "credit";
|
|
123
|
-
readonly enum: readonly ["credit", "discount"];
|
|
124
|
-
};
|
|
125
|
-
readonly value: {
|
|
124
|
+
readonly value_total: {
|
|
126
125
|
readonly type: "number";
|
|
127
126
|
readonly format: "float";
|
|
128
|
-
readonly description: "
|
|
127
|
+
readonly description: "Total value of the promotional code.";
|
|
129
128
|
readonly example: 10;
|
|
130
129
|
};
|
|
131
|
-
readonly billing_period: {
|
|
132
|
-
readonly type: "string";
|
|
133
|
-
readonly format: "date-time";
|
|
134
|
-
readonly description: "Date of the billing cycle. An ISO 8601 date string in the UTC timezone.";
|
|
135
|
-
readonly example: "2023-12-20T13:53:32.000Z";
|
|
136
|
-
};
|
|
137
130
|
readonly value_remaining: {
|
|
138
131
|
readonly type: "number";
|
|
139
132
|
readonly format: "float";
|
|
140
|
-
readonly description: "
|
|
141
|
-
readonly example:
|
|
133
|
+
readonly description: "Remaining value of the promotional code.";
|
|
134
|
+
readonly example: 8;
|
|
142
135
|
};
|
|
143
136
|
};
|
|
144
|
-
readonly required: readonly ["
|
|
137
|
+
readonly required: readonly ["type", "date_start", "code", "value_total"];
|
|
145
138
|
readonly additionalProperties: false;
|
|
146
139
|
};
|
|
147
140
|
export declare const ChartCreateInputSchema: {
|
|
@@ -224,9 +217,8 @@ export declare const ChartSchema: {
|
|
|
224
217
|
};
|
|
225
218
|
readonly status: {
|
|
226
219
|
readonly type: "string";
|
|
227
|
-
readonly description: "Status of the chart deployment.";
|
|
228
|
-
readonly example: "
|
|
229
|
-
readonly enum: readonly ["InstallSucceeded", "InstallFailed", "UpgradeSucceeded", "UpgradeFailed", "TestSucceeded", "TestFailed", "RollbackSucceeded", "RollbackFailed", "UninstallSucceeded", "UninstallFailed", "ArtifactFailed", "DependencyNotReady", "Progressing", "SourceNotReady"];
|
|
220
|
+
readonly description: "Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).";
|
|
221
|
+
readonly example: "InstallSucceeded";
|
|
230
222
|
};
|
|
231
223
|
readonly version_current: {
|
|
232
224
|
readonly type: "string";
|
|
@@ -280,29 +272,106 @@ export declare const ClusterCreateInputSchema: {
|
|
|
280
272
|
readonly description: "Name of the cluster.";
|
|
281
273
|
readonly example: "production-cluster";
|
|
282
274
|
};
|
|
283
|
-
readonly region: {
|
|
284
|
-
readonly type: "string";
|
|
285
|
-
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\". This field can not be updated after creation.";
|
|
286
|
-
readonly default: "staging";
|
|
287
|
-
readonly example: "northamerica-central-1";
|
|
288
|
-
readonly enum: readonly ["staging", "northamerica-central-1"];
|
|
289
|
-
};
|
|
290
275
|
readonly tier: {
|
|
291
276
|
readonly type: "string";
|
|
292
277
|
readonly description: "Tier of the cluster.";
|
|
278
|
+
readonly default: "basic";
|
|
293
279
|
readonly example: "pro";
|
|
294
|
-
readonly enum: readonly ["basic", "pro"];
|
|
280
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
295
281
|
};
|
|
296
282
|
readonly version_channel: {
|
|
297
283
|
readonly type: "string";
|
|
298
284
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
299
285
|
readonly description: "Version of the kubernetes cluster.";
|
|
300
286
|
readonly default: "1.x.x-cfke.x";
|
|
301
|
-
readonly example: "1.
|
|
287
|
+
readonly example: "1.x.x-cfke.x";
|
|
288
|
+
};
|
|
289
|
+
readonly release_channel: {
|
|
290
|
+
readonly type: "string";
|
|
291
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
292
|
+
readonly default: "rapid";
|
|
293
|
+
readonly example: "rapid";
|
|
294
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
295
|
+
};
|
|
296
|
+
readonly features: {
|
|
297
|
+
readonly type: "object";
|
|
298
|
+
readonly properties: {
|
|
299
|
+
readonly gpu_sharing_strategy: {
|
|
300
|
+
readonly type: "string";
|
|
301
|
+
readonly description: "GPU sharing strategy.";
|
|
302
|
+
readonly default: "none";
|
|
303
|
+
readonly example: "none";
|
|
304
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
305
|
+
};
|
|
306
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
307
|
+
readonly type: "integer";
|
|
308
|
+
readonly minimum: 2;
|
|
309
|
+
readonly maximum: 48;
|
|
310
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
311
|
+
readonly default: 4;
|
|
312
|
+
readonly example: 10;
|
|
313
|
+
};
|
|
314
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
315
|
+
readonly type: "boolean";
|
|
316
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
317
|
+
readonly example: false;
|
|
318
|
+
};
|
|
319
|
+
};
|
|
320
|
+
readonly additionalProperties: false;
|
|
321
|
+
readonly description: "Cluster feature toggles.";
|
|
322
|
+
readonly default: {
|
|
323
|
+
readonly gpu_sharing_strategy: "none";
|
|
324
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
325
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
326
|
+
};
|
|
327
|
+
};
|
|
328
|
+
readonly region: {
|
|
329
|
+
readonly type: "string";
|
|
330
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
331
|
+
readonly example: "europe-central-1a";
|
|
332
|
+
};
|
|
333
|
+
readonly networking: {
|
|
334
|
+
readonly type: "object";
|
|
335
|
+
readonly properties: {
|
|
336
|
+
readonly pod_cidr: {
|
|
337
|
+
readonly type: "string";
|
|
338
|
+
readonly description: "CIDR block for pod IPs.";
|
|
339
|
+
readonly default: "10.244.0.0/16";
|
|
340
|
+
};
|
|
341
|
+
readonly service_cidr: {
|
|
342
|
+
readonly type: "string";
|
|
343
|
+
readonly description: "CIDR block for service IPs.";
|
|
344
|
+
readonly default: "10.96.0.0/12";
|
|
345
|
+
};
|
|
346
|
+
readonly dual_stack: {
|
|
347
|
+
readonly type: "boolean";
|
|
348
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
349
|
+
};
|
|
350
|
+
readonly pod_cidr_v6: {
|
|
351
|
+
readonly type: "string";
|
|
352
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
353
|
+
readonly default: "2001:db8:1:2::/48";
|
|
354
|
+
};
|
|
355
|
+
readonly service_cidr_v6: {
|
|
356
|
+
readonly type: "string";
|
|
357
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
358
|
+
readonly default: "2001:db8:1:1::/112";
|
|
359
|
+
};
|
|
360
|
+
};
|
|
361
|
+
readonly additionalProperties: false;
|
|
362
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
363
|
+
readonly default: {
|
|
364
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
365
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
366
|
+
readonly dual_stack: false;
|
|
367
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
368
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
369
|
+
};
|
|
302
370
|
};
|
|
303
371
|
};
|
|
304
|
-
readonly required: readonly ["name", "
|
|
372
|
+
readonly required: readonly ["name", "region"];
|
|
305
373
|
readonly additionalProperties: false;
|
|
374
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
306
375
|
};
|
|
307
376
|
export declare const ClusterJoinInformationSchema: {
|
|
308
377
|
readonly type: "object";
|
|
@@ -318,6 +387,16 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
318
387
|
readonly description: "Internal URL of the Kubernetes cluster control plane. This is the endpoint that kubelet uses to connect to the cluster.";
|
|
319
388
|
readonly example: "https://10.31.64.7:6443";
|
|
320
389
|
};
|
|
390
|
+
readonly cluster_dns: {
|
|
391
|
+
readonly type: "string";
|
|
392
|
+
readonly description: "Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.";
|
|
393
|
+
readonly example: "10.96.0.10";
|
|
394
|
+
};
|
|
395
|
+
readonly pod_cidr: {
|
|
396
|
+
readonly type: "string";
|
|
397
|
+
readonly description: "Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.";
|
|
398
|
+
readonly example: "10.244.0.0/16";
|
|
399
|
+
};
|
|
321
400
|
readonly auth_key: {
|
|
322
401
|
readonly type: "string";
|
|
323
402
|
readonly description: "Authentication key for the cluster.";
|
|
@@ -334,7 +413,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
334
413
|
readonly kubernetes: {
|
|
335
414
|
readonly type: "string";
|
|
336
415
|
readonly description: "Kubernetes version of the cluster.";
|
|
337
|
-
readonly example: "1.
|
|
416
|
+
readonly example: "1.33.7";
|
|
338
417
|
};
|
|
339
418
|
readonly tailscale: {
|
|
340
419
|
readonly type: "string";
|
|
@@ -346,8 +425,13 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
346
425
|
readonly description: "Containerd version of the cluster.";
|
|
347
426
|
readonly example: "1.7.19";
|
|
348
427
|
};
|
|
428
|
+
readonly nvidia_driver: {
|
|
429
|
+
readonly type: "string";
|
|
430
|
+
readonly description: "NVIDIA driver version of the cluster.";
|
|
431
|
+
readonly example: "565.0.0";
|
|
432
|
+
};
|
|
349
433
|
};
|
|
350
|
-
readonly required: readonly ["kubernetes", "tailscale", "containerd"];
|
|
434
|
+
readonly required: readonly ["kubernetes", "tailscale", "containerd", "nvidia_driver"];
|
|
351
435
|
readonly additionalProperties: false;
|
|
352
436
|
readonly description: "Versions of the different components of the cluster.";
|
|
353
437
|
};
|
|
@@ -375,7 +459,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
375
459
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
376
460
|
};
|
|
377
461
|
};
|
|
378
|
-
readonly required: readonly ["certificate_authority", "endpoint", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
462
|
+
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "pod_cidr", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
379
463
|
readonly additionalProperties: false;
|
|
380
464
|
};
|
|
381
465
|
export declare const ClusterSchema: {
|
|
@@ -389,25 +473,103 @@ export declare const ClusterSchema: {
|
|
|
389
473
|
readonly description: "Name of the cluster.";
|
|
390
474
|
readonly example: "production-cluster";
|
|
391
475
|
};
|
|
392
|
-
readonly region: {
|
|
393
|
-
readonly type: "string";
|
|
394
|
-
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\". This field can not be updated after creation.";
|
|
395
|
-
readonly default: "staging";
|
|
396
|
-
readonly example: "northamerica-central-1";
|
|
397
|
-
readonly enum: readonly ["staging", "northamerica-central-1"];
|
|
398
|
-
};
|
|
399
476
|
readonly tier: {
|
|
400
477
|
readonly type: "string";
|
|
401
478
|
readonly description: "Tier of the cluster.";
|
|
479
|
+
readonly default: "basic";
|
|
402
480
|
readonly example: "pro";
|
|
403
|
-
readonly enum: readonly ["basic", "pro"];
|
|
481
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
404
482
|
};
|
|
405
483
|
readonly version_channel: {
|
|
406
484
|
readonly type: "string";
|
|
407
485
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
408
486
|
readonly description: "Version of the kubernetes cluster.";
|
|
409
487
|
readonly default: "1.x.x-cfke.x";
|
|
410
|
-
readonly example: "1.
|
|
488
|
+
readonly example: "1.x.x-cfke.x";
|
|
489
|
+
};
|
|
490
|
+
readonly release_channel: {
|
|
491
|
+
readonly type: "string";
|
|
492
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
493
|
+
readonly default: "rapid";
|
|
494
|
+
readonly example: "rapid";
|
|
495
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
496
|
+
};
|
|
497
|
+
readonly features: {
|
|
498
|
+
readonly type: "object";
|
|
499
|
+
readonly properties: {
|
|
500
|
+
readonly gpu_sharing_strategy: {
|
|
501
|
+
readonly type: "string";
|
|
502
|
+
readonly description: "GPU sharing strategy.";
|
|
503
|
+
readonly default: "none";
|
|
504
|
+
readonly example: "none";
|
|
505
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
506
|
+
};
|
|
507
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
508
|
+
readonly type: "integer";
|
|
509
|
+
readonly minimum: 2;
|
|
510
|
+
readonly maximum: 48;
|
|
511
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
512
|
+
readonly default: 4;
|
|
513
|
+
readonly example: 10;
|
|
514
|
+
};
|
|
515
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
516
|
+
readonly type: "boolean";
|
|
517
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
518
|
+
readonly example: false;
|
|
519
|
+
};
|
|
520
|
+
};
|
|
521
|
+
readonly required: readonly ["gpu_sharing_strategy", "gpu_max_shared_clients_per_gpu", "cilium_socket_lb_host_namespace_only"];
|
|
522
|
+
readonly additionalProperties: false;
|
|
523
|
+
readonly description: "Cluster feature toggles.";
|
|
524
|
+
readonly default: {
|
|
525
|
+
readonly gpu_sharing_strategy: "none";
|
|
526
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
527
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
528
|
+
};
|
|
529
|
+
};
|
|
530
|
+
readonly region: {
|
|
531
|
+
readonly type: "string";
|
|
532
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
533
|
+
readonly example: "europe-central-1a";
|
|
534
|
+
};
|
|
535
|
+
readonly networking: {
|
|
536
|
+
readonly type: "object";
|
|
537
|
+
readonly properties: {
|
|
538
|
+
readonly pod_cidr: {
|
|
539
|
+
readonly type: "string";
|
|
540
|
+
readonly description: "CIDR block for pod IPs.";
|
|
541
|
+
readonly default: "10.244.0.0/16";
|
|
542
|
+
};
|
|
543
|
+
readonly service_cidr: {
|
|
544
|
+
readonly type: "string";
|
|
545
|
+
readonly description: "CIDR block for service IPs.";
|
|
546
|
+
readonly default: "10.96.0.0/12";
|
|
547
|
+
};
|
|
548
|
+
readonly dual_stack: {
|
|
549
|
+
readonly type: "boolean";
|
|
550
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
551
|
+
};
|
|
552
|
+
readonly pod_cidr_v6: {
|
|
553
|
+
readonly type: "string";
|
|
554
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
555
|
+
readonly default: "2001:db8:1:2::/48";
|
|
556
|
+
};
|
|
557
|
+
readonly service_cidr_v6: {
|
|
558
|
+
readonly type: "string";
|
|
559
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
560
|
+
readonly default: "2001:db8:1:1::/112";
|
|
561
|
+
};
|
|
562
|
+
};
|
|
563
|
+
readonly required: readonly ["pod_cidr", "service_cidr", "dual_stack", "pod_cidr_v6", "service_cidr_v6"];
|
|
564
|
+
readonly additionalProperties: false;
|
|
565
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
566
|
+
readonly default: {
|
|
567
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
568
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
569
|
+
readonly dual_stack: false;
|
|
570
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
571
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
572
|
+
};
|
|
411
573
|
};
|
|
412
574
|
readonly id: {
|
|
413
575
|
readonly type: "string";
|
|
@@ -417,16 +579,27 @@ export declare const ClusterSchema: {
|
|
|
417
579
|
};
|
|
418
580
|
readonly status: {
|
|
419
581
|
readonly type: "string";
|
|
420
|
-
readonly description: "Status of the cluster.
|
|
421
|
-
readonly example: "
|
|
422
|
-
readonly enum: readonly ["
|
|
582
|
+
readonly description: "Status of the cluster.";
|
|
583
|
+
readonly example: "deployed";
|
|
584
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
423
585
|
};
|
|
424
586
|
readonly endpoint: {
|
|
425
587
|
readonly anyOf: readonly [{
|
|
426
588
|
readonly type: "string";
|
|
427
589
|
readonly format: "uri";
|
|
428
|
-
readonly description: "URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
429
|
-
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
590
|
+
readonly description: "URL signed by a public CA of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
591
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
592
|
+
}, {
|
|
593
|
+
readonly type: "string";
|
|
594
|
+
readonly enum: readonly [""];
|
|
595
|
+
}];
|
|
596
|
+
};
|
|
597
|
+
readonly endpoint_public: {
|
|
598
|
+
readonly anyOf: readonly [{
|
|
599
|
+
readonly type: "string";
|
|
600
|
+
readonly format: "uri";
|
|
601
|
+
readonly description: "Deprecated alias of `endpoint`; retained for backward compatibility.";
|
|
602
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
430
603
|
}, {
|
|
431
604
|
readonly type: "string";
|
|
432
605
|
readonly enum: readonly [""];
|
|
@@ -440,7 +613,7 @@ export declare const ClusterSchema: {
|
|
|
440
613
|
readonly version_current: {
|
|
441
614
|
readonly type: "string";
|
|
442
615
|
readonly description: "Current version of the cluster.";
|
|
443
|
-
readonly example: "1.
|
|
616
|
+
readonly example: "1.33.7-cfke.264";
|
|
444
617
|
};
|
|
445
618
|
readonly created_at: {
|
|
446
619
|
readonly type: "string";
|
|
@@ -458,8 +631,9 @@ export declare const ClusterSchema: {
|
|
|
458
631
|
readonly example: true;
|
|
459
632
|
};
|
|
460
633
|
};
|
|
461
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
634
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
462
635
|
readonly additionalProperties: false;
|
|
636
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
463
637
|
};
|
|
464
638
|
export declare const ClusterUpdateInputSchema: {
|
|
465
639
|
readonly type: "object";
|
|
@@ -472,14 +646,63 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
472
646
|
readonly description: "Name of the cluster.";
|
|
473
647
|
readonly example: "production-cluster";
|
|
474
648
|
};
|
|
649
|
+
readonly tier: {
|
|
650
|
+
readonly type: "string";
|
|
651
|
+
readonly description: "Tier of the cluster.";
|
|
652
|
+
readonly default: "basic";
|
|
653
|
+
readonly example: "pro";
|
|
654
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
655
|
+
};
|
|
475
656
|
readonly version_channel: {
|
|
476
657
|
readonly type: "string";
|
|
477
658
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
478
659
|
readonly description: "Version of the kubernetes cluster.";
|
|
479
|
-
readonly
|
|
660
|
+
readonly default: "1.x.x-cfke.x";
|
|
661
|
+
readonly example: "1.x.x-cfke.x";
|
|
662
|
+
};
|
|
663
|
+
readonly release_channel: {
|
|
664
|
+
readonly type: "string";
|
|
665
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
666
|
+
readonly default: "rapid";
|
|
667
|
+
readonly example: "rapid";
|
|
668
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
669
|
+
};
|
|
670
|
+
readonly features: {
|
|
671
|
+
readonly type: "object";
|
|
672
|
+
readonly properties: {
|
|
673
|
+
readonly gpu_sharing_strategy: {
|
|
674
|
+
readonly type: "string";
|
|
675
|
+
readonly description: "GPU sharing strategy.";
|
|
676
|
+
readonly default: "none";
|
|
677
|
+
readonly example: "none";
|
|
678
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
679
|
+
};
|
|
680
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
681
|
+
readonly type: "integer";
|
|
682
|
+
readonly minimum: 2;
|
|
683
|
+
readonly maximum: 48;
|
|
684
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
685
|
+
readonly default: 4;
|
|
686
|
+
readonly example: 10;
|
|
687
|
+
};
|
|
688
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
689
|
+
readonly type: "boolean";
|
|
690
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
691
|
+
readonly example: false;
|
|
692
|
+
};
|
|
693
|
+
};
|
|
694
|
+
readonly additionalProperties: false;
|
|
695
|
+
readonly description: "Cluster feature toggles.";
|
|
696
|
+
readonly default: {
|
|
697
|
+
readonly gpu_sharing_strategy: "none";
|
|
698
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
699
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
700
|
+
};
|
|
480
701
|
};
|
|
481
702
|
};
|
|
703
|
+
readonly required: readonly ["name"];
|
|
482
704
|
readonly additionalProperties: false;
|
|
705
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
483
706
|
};
|
|
484
707
|
export declare const FleetCreateInputSchema: {
|
|
485
708
|
readonly type: "object";
|
|
@@ -488,13 +711,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
488
711
|
readonly type: "object";
|
|
489
712
|
readonly properties: {
|
|
490
713
|
readonly cpu: {
|
|
491
|
-
readonly type: "
|
|
492
|
-
readonly format: "float";
|
|
714
|
+
readonly type: "integer";
|
|
493
715
|
readonly minimum: 0;
|
|
494
|
-
readonly
|
|
716
|
+
readonly maximum: 100000;
|
|
717
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
495
718
|
};
|
|
496
719
|
};
|
|
497
|
-
readonly required: readonly ["cpu"];
|
|
498
720
|
readonly additionalProperties: false;
|
|
499
721
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
500
722
|
};
|
|
@@ -503,14 +725,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
503
725
|
readonly properties: {
|
|
504
726
|
readonly enabled: {
|
|
505
727
|
readonly type: "boolean";
|
|
506
|
-
readonly default: true;
|
|
507
728
|
};
|
|
508
729
|
readonly project: {
|
|
509
730
|
readonly type: "string";
|
|
510
|
-
readonly
|
|
731
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
732
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
733
|
+
readonly example: "my-cloudfleet-project";
|
|
511
734
|
};
|
|
512
735
|
};
|
|
513
|
-
readonly required: readonly ["
|
|
736
|
+
readonly required: readonly ["enabled"];
|
|
514
737
|
readonly additionalProperties: false;
|
|
515
738
|
};
|
|
516
739
|
readonly hetzner: {
|
|
@@ -518,14 +741,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
518
741
|
readonly properties: {
|
|
519
742
|
readonly enabled: {
|
|
520
743
|
readonly type: "boolean";
|
|
521
|
-
readonly default: true;
|
|
522
744
|
};
|
|
523
745
|
readonly apiKey: {
|
|
524
746
|
readonly type: "string";
|
|
525
|
-
readonly
|
|
747
|
+
readonly maxLength: 64;
|
|
748
|
+
readonly minLength: 64;
|
|
749
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
750
|
+
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.";
|
|
526
751
|
};
|
|
527
752
|
};
|
|
528
|
-
readonly required: readonly ["
|
|
753
|
+
readonly required: readonly ["enabled"];
|
|
529
754
|
readonly additionalProperties: false;
|
|
530
755
|
};
|
|
531
756
|
readonly aws: {
|
|
@@ -533,15 +758,74 @@ export declare const FleetCreateInputSchema: {
|
|
|
533
758
|
readonly properties: {
|
|
534
759
|
readonly enabled: {
|
|
535
760
|
readonly type: "boolean";
|
|
536
|
-
readonly default: true;
|
|
537
761
|
};
|
|
538
762
|
readonly controllerRoleArn: {
|
|
539
763
|
readonly type: "string";
|
|
540
|
-
readonly
|
|
764
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
765
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
766
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
767
|
+
};
|
|
768
|
+
};
|
|
769
|
+
readonly required: readonly ["enabled"];
|
|
770
|
+
readonly additionalProperties: false;
|
|
771
|
+
};
|
|
772
|
+
readonly constraints: {
|
|
773
|
+
readonly type: "object";
|
|
774
|
+
readonly properties: {
|
|
775
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
776
|
+
readonly type: "array";
|
|
777
|
+
readonly items: {
|
|
778
|
+
readonly type: "string";
|
|
779
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
780
|
+
};
|
|
781
|
+
readonly minItems: 1;
|
|
782
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
783
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
784
|
+
};
|
|
785
|
+
readonly 'kubernetes.io/arch': {
|
|
786
|
+
readonly type: "array";
|
|
787
|
+
readonly items: {
|
|
788
|
+
readonly type: "string";
|
|
789
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
790
|
+
};
|
|
791
|
+
readonly minItems: 1;
|
|
792
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
793
|
+
readonly default: readonly ["amd64"];
|
|
794
|
+
};
|
|
795
|
+
readonly 'cfke.io/instance-family': {
|
|
796
|
+
readonly type: "array";
|
|
797
|
+
readonly items: {
|
|
798
|
+
readonly type: "string";
|
|
799
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
800
|
+
};
|
|
801
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
802
|
+
readonly default: readonly [];
|
|
803
|
+
};
|
|
804
|
+
readonly 'topology.kubernetes.io/region': {
|
|
805
|
+
readonly type: "array";
|
|
806
|
+
readonly items: {
|
|
807
|
+
readonly type: "string";
|
|
808
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
809
|
+
};
|
|
810
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
811
|
+
readonly default: readonly [];
|
|
541
812
|
};
|
|
542
813
|
};
|
|
543
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
544
814
|
readonly additionalProperties: false;
|
|
815
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
816
|
+
readonly default: {
|
|
817
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
818
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
819
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
820
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
821
|
+
};
|
|
822
|
+
};
|
|
823
|
+
readonly scalingProfile: {
|
|
824
|
+
readonly type: "string";
|
|
825
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
826
|
+
readonly default: "conservative";
|
|
827
|
+
readonly example: "conservative";
|
|
828
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
545
829
|
};
|
|
546
830
|
readonly id: {
|
|
547
831
|
readonly type: "string";
|
|
@@ -554,6 +838,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
554
838
|
};
|
|
555
839
|
readonly required: readonly ["id"];
|
|
556
840
|
readonly additionalProperties: false;
|
|
841
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
557
842
|
};
|
|
558
843
|
export declare const FleetSchema: {
|
|
559
844
|
readonly type: "object";
|
|
@@ -562,13 +847,12 @@ export declare const FleetSchema: {
|
|
|
562
847
|
readonly type: "object";
|
|
563
848
|
readonly properties: {
|
|
564
849
|
readonly cpu: {
|
|
565
|
-
readonly type: "
|
|
566
|
-
readonly format: "float";
|
|
850
|
+
readonly type: "integer";
|
|
567
851
|
readonly minimum: 0;
|
|
568
|
-
readonly
|
|
852
|
+
readonly maximum: 100000;
|
|
853
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
569
854
|
};
|
|
570
855
|
};
|
|
571
|
-
readonly required: readonly ["cpu"];
|
|
572
856
|
readonly additionalProperties: false;
|
|
573
857
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
574
858
|
};
|
|
@@ -577,14 +861,15 @@ export declare const FleetSchema: {
|
|
|
577
861
|
readonly properties: {
|
|
578
862
|
readonly enabled: {
|
|
579
863
|
readonly type: "boolean";
|
|
580
|
-
readonly default: true;
|
|
581
864
|
};
|
|
582
865
|
readonly project: {
|
|
583
866
|
readonly type: "string";
|
|
584
|
-
readonly
|
|
867
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
868
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
869
|
+
readonly example: "my-cloudfleet-project";
|
|
585
870
|
};
|
|
586
871
|
};
|
|
587
|
-
readonly required: readonly ["
|
|
872
|
+
readonly required: readonly ["enabled"];
|
|
588
873
|
readonly additionalProperties: false;
|
|
589
874
|
};
|
|
590
875
|
readonly hetzner: {
|
|
@@ -592,14 +877,14 @@ export declare const FleetSchema: {
|
|
|
592
877
|
readonly properties: {
|
|
593
878
|
readonly enabled: {
|
|
594
879
|
readonly type: "boolean";
|
|
595
|
-
readonly default: true;
|
|
596
880
|
};
|
|
597
881
|
readonly apiKey: {
|
|
598
882
|
readonly type: "string";
|
|
599
|
-
readonly
|
|
883
|
+
readonly pattern: "^\\*{64}$";
|
|
884
|
+
readonly description: "Redacted Hetzner API token. Returned as 64 asterisks when a token is configured; omitted otherwise. The real value is never echoed by the API.";
|
|
600
885
|
};
|
|
601
886
|
};
|
|
602
|
-
readonly required: readonly ["
|
|
887
|
+
readonly required: readonly ["enabled"];
|
|
603
888
|
readonly additionalProperties: false;
|
|
604
889
|
};
|
|
605
890
|
readonly aws: {
|
|
@@ -607,15 +892,75 @@ export declare const FleetSchema: {
|
|
|
607
892
|
readonly properties: {
|
|
608
893
|
readonly enabled: {
|
|
609
894
|
readonly type: "boolean";
|
|
610
|
-
readonly default: true;
|
|
611
895
|
};
|
|
612
896
|
readonly controllerRoleArn: {
|
|
613
897
|
readonly type: "string";
|
|
614
|
-
readonly
|
|
898
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
899
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
900
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
901
|
+
};
|
|
902
|
+
};
|
|
903
|
+
readonly required: readonly ["enabled"];
|
|
904
|
+
readonly additionalProperties: false;
|
|
905
|
+
};
|
|
906
|
+
readonly constraints: {
|
|
907
|
+
readonly type: "object";
|
|
908
|
+
readonly properties: {
|
|
909
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
910
|
+
readonly type: "array";
|
|
911
|
+
readonly items: {
|
|
912
|
+
readonly type: "string";
|
|
913
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
914
|
+
};
|
|
915
|
+
readonly minItems: 1;
|
|
916
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
917
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
918
|
+
};
|
|
919
|
+
readonly 'kubernetes.io/arch': {
|
|
920
|
+
readonly type: "array";
|
|
921
|
+
readonly items: {
|
|
922
|
+
readonly type: "string";
|
|
923
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
924
|
+
};
|
|
925
|
+
readonly minItems: 1;
|
|
926
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
927
|
+
readonly default: readonly ["amd64"];
|
|
928
|
+
};
|
|
929
|
+
readonly 'cfke.io/instance-family': {
|
|
930
|
+
readonly type: "array";
|
|
931
|
+
readonly items: {
|
|
932
|
+
readonly type: "string";
|
|
933
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
934
|
+
};
|
|
935
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
936
|
+
readonly default: readonly [];
|
|
937
|
+
};
|
|
938
|
+
readonly 'topology.kubernetes.io/region': {
|
|
939
|
+
readonly type: "array";
|
|
940
|
+
readonly items: {
|
|
941
|
+
readonly type: "string";
|
|
942
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
943
|
+
};
|
|
944
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
945
|
+
readonly default: readonly [];
|
|
615
946
|
};
|
|
616
947
|
};
|
|
617
|
-
readonly required: readonly ["
|
|
948
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
618
949
|
readonly additionalProperties: false;
|
|
950
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
951
|
+
readonly default: {
|
|
952
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
953
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
954
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
955
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
956
|
+
};
|
|
957
|
+
};
|
|
958
|
+
readonly scalingProfile: {
|
|
959
|
+
readonly type: "string";
|
|
960
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
961
|
+
readonly default: "conservative";
|
|
962
|
+
readonly example: "conservative";
|
|
963
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
619
964
|
};
|
|
620
965
|
readonly id: {
|
|
621
966
|
readonly type: "string";
|
|
@@ -625,9 +970,30 @@ export declare const FleetSchema: {
|
|
|
625
970
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
626
971
|
readonly example: "new-clouds-fleet";
|
|
627
972
|
};
|
|
973
|
+
readonly ready: {
|
|
974
|
+
readonly type: "boolean";
|
|
975
|
+
readonly description: "Indicates whether the fleet configuration is healthy.";
|
|
976
|
+
readonly example: true;
|
|
977
|
+
};
|
|
978
|
+
readonly status_message: {
|
|
979
|
+
readonly type: "string";
|
|
980
|
+
readonly description: "Human-readable reason the fleet is not ready. Present only when `ready` is false.";
|
|
981
|
+
readonly example: "Invalid provider permissions.";
|
|
982
|
+
};
|
|
983
|
+
readonly created_at: {
|
|
984
|
+
readonly type: "string";
|
|
985
|
+
readonly description: "Creation date and time of the fleet.";
|
|
986
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
987
|
+
};
|
|
988
|
+
readonly updated_at: {
|
|
989
|
+
readonly type: "string";
|
|
990
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
991
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
992
|
+
};
|
|
628
993
|
};
|
|
629
|
-
readonly required: readonly ["id"];
|
|
994
|
+
readonly required: readonly ["constraints", "scalingProfile", "id", "ready", "created_at", "updated_at"];
|
|
630
995
|
readonly additionalProperties: false;
|
|
996
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
631
997
|
};
|
|
632
998
|
export declare const FleetUpdateInputSchema: {
|
|
633
999
|
readonly type: "object";
|
|
@@ -636,13 +1002,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
636
1002
|
readonly type: "object";
|
|
637
1003
|
readonly properties: {
|
|
638
1004
|
readonly cpu: {
|
|
639
|
-
readonly type: "
|
|
640
|
-
readonly format: "float";
|
|
1005
|
+
readonly type: "integer";
|
|
641
1006
|
readonly minimum: 0;
|
|
642
|
-
readonly
|
|
1007
|
+
readonly maximum: 100000;
|
|
1008
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
643
1009
|
};
|
|
644
1010
|
};
|
|
645
|
-
readonly required: readonly ["cpu"];
|
|
646
1011
|
readonly additionalProperties: false;
|
|
647
1012
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
648
1013
|
};
|
|
@@ -651,14 +1016,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
651
1016
|
readonly properties: {
|
|
652
1017
|
readonly enabled: {
|
|
653
1018
|
readonly type: "boolean";
|
|
654
|
-
readonly default: true;
|
|
655
1019
|
};
|
|
656
1020
|
readonly project: {
|
|
657
1021
|
readonly type: "string";
|
|
658
|
-
readonly
|
|
1022
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
1023
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
1024
|
+
readonly example: "my-cloudfleet-project";
|
|
659
1025
|
};
|
|
660
1026
|
};
|
|
661
|
-
readonly required: readonly ["
|
|
1027
|
+
readonly required: readonly ["enabled"];
|
|
662
1028
|
readonly additionalProperties: false;
|
|
663
1029
|
};
|
|
664
1030
|
readonly hetzner: {
|
|
@@ -666,14 +1032,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
666
1032
|
readonly properties: {
|
|
667
1033
|
readonly enabled: {
|
|
668
1034
|
readonly type: "boolean";
|
|
669
|
-
readonly default: true;
|
|
670
1035
|
};
|
|
671
1036
|
readonly apiKey: {
|
|
672
1037
|
readonly type: "string";
|
|
673
|
-
readonly
|
|
1038
|
+
readonly maxLength: 64;
|
|
1039
|
+
readonly minLength: 64;
|
|
1040
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
1041
|
+
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.";
|
|
674
1042
|
};
|
|
675
1043
|
};
|
|
676
|
-
readonly required: readonly ["
|
|
1044
|
+
readonly required: readonly ["enabled"];
|
|
677
1045
|
readonly additionalProperties: false;
|
|
678
1046
|
};
|
|
679
1047
|
readonly aws: {
|
|
@@ -681,41 +1049,121 @@ export declare const FleetUpdateInputSchema: {
|
|
|
681
1049
|
readonly properties: {
|
|
682
1050
|
readonly enabled: {
|
|
683
1051
|
readonly type: "boolean";
|
|
684
|
-
readonly default: true;
|
|
685
1052
|
};
|
|
686
1053
|
readonly controllerRoleArn: {
|
|
687
1054
|
readonly type: "string";
|
|
688
|
-
readonly
|
|
1055
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
1056
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
1057
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
689
1058
|
};
|
|
690
1059
|
};
|
|
691
|
-
readonly required: readonly ["
|
|
1060
|
+
readonly required: readonly ["enabled"];
|
|
692
1061
|
readonly additionalProperties: false;
|
|
693
1062
|
};
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
1063
|
+
readonly constraints: {
|
|
1064
|
+
readonly type: "object";
|
|
1065
|
+
readonly properties: {
|
|
1066
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
1067
|
+
readonly type: "array";
|
|
1068
|
+
readonly items: {
|
|
1069
|
+
readonly type: "string";
|
|
1070
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
1071
|
+
};
|
|
1072
|
+
readonly minItems: 1;
|
|
1073
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1074
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
1075
|
+
};
|
|
1076
|
+
readonly 'kubernetes.io/arch': {
|
|
1077
|
+
readonly type: "array";
|
|
1078
|
+
readonly items: {
|
|
1079
|
+
readonly type: "string";
|
|
1080
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
1081
|
+
};
|
|
1082
|
+
readonly minItems: 1;
|
|
1083
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1084
|
+
readonly default: readonly ["amd64"];
|
|
1085
|
+
};
|
|
1086
|
+
readonly 'cfke.io/instance-family': {
|
|
1087
|
+
readonly type: "array";
|
|
1088
|
+
readonly items: {
|
|
1089
|
+
readonly type: "string";
|
|
1090
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
1091
|
+
};
|
|
1092
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1093
|
+
readonly default: readonly [];
|
|
1094
|
+
};
|
|
1095
|
+
readonly 'topology.kubernetes.io/region': {
|
|
1096
|
+
readonly type: "array";
|
|
1097
|
+
readonly items: {
|
|
1098
|
+
readonly type: "string";
|
|
1099
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
1100
|
+
};
|
|
1101
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1102
|
+
readonly default: readonly [];
|
|
1103
|
+
};
|
|
1104
|
+
};
|
|
1105
|
+
readonly additionalProperties: false;
|
|
1106
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
1107
|
+
readonly default: {
|
|
1108
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1109
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1110
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1111
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1112
|
+
};
|
|
1113
|
+
};
|
|
1114
|
+
readonly scalingProfile: {
|
|
1115
|
+
readonly type: "string";
|
|
1116
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
1117
|
+
readonly default: "conservative";
|
|
1118
|
+
readonly example: "conservative";
|
|
1119
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
1120
|
+
};
|
|
1121
|
+
};
|
|
1122
|
+
readonly additionalProperties: false;
|
|
1123
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
1124
|
+
};
|
|
1125
|
+
export declare const InviteCreateInputSchema: {
|
|
1126
|
+
readonly type: "object";
|
|
1127
|
+
readonly properties: {
|
|
1128
|
+
readonly email: {
|
|
1129
|
+
readonly type: "string";
|
|
1130
|
+
readonly format: "email";
|
|
1131
|
+
readonly description: "Email address of the user to invite.";
|
|
1132
|
+
readonly example: "email@example.com";
|
|
1133
|
+
};
|
|
1134
|
+
readonly role: {
|
|
1135
|
+
readonly type: "string";
|
|
1136
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1137
|
+
readonly default: "User";
|
|
1138
|
+
readonly example: "User";
|
|
1139
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1140
|
+
};
|
|
1141
|
+
};
|
|
1142
|
+
readonly required: readonly ["email"];
|
|
1143
|
+
readonly additionalProperties: false;
|
|
1144
|
+
};
|
|
1145
|
+
export declare const InviteSchema: {
|
|
1146
|
+
readonly type: "object";
|
|
1147
|
+
readonly properties: {
|
|
1148
|
+
readonly id: {
|
|
1149
|
+
readonly type: "string";
|
|
1150
|
+
readonly description: "Unique identifier of the invitation.";
|
|
1151
|
+
readonly example: "65831dd20d20165489cbb868";
|
|
1152
|
+
};
|
|
1153
|
+
readonly organization_id: {
|
|
1154
|
+
readonly type: "string";
|
|
1155
|
+
readonly format: "uuid";
|
|
1156
|
+
readonly description: "Unique identifier of the organization the project belongs to. UUID v4 string in canonical form";
|
|
1157
|
+
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1158
|
+
};
|
|
1159
|
+
readonly date_created: {
|
|
1160
|
+
readonly type: "string";
|
|
1161
|
+
readonly format: "date-time";
|
|
1162
|
+
readonly description: "Creation date of the project. ISO 8601 date string in UTC timezone";
|
|
1163
|
+
readonly example: "2023-11-02T16:08:14.338Z";
|
|
1164
|
+
};
|
|
1165
|
+
readonly email: {
|
|
1166
|
+
readonly type: "string";
|
|
719
1167
|
readonly format: "email";
|
|
720
1168
|
readonly description: "User email address.";
|
|
721
1169
|
readonly example: "email@example.com";
|
|
@@ -725,6 +1173,13 @@ export declare const InviteSchema: {
|
|
|
725
1173
|
readonly description: "Generated unique invite code.";
|
|
726
1174
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
727
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
|
+
};
|
|
728
1183
|
};
|
|
729
1184
|
readonly required: readonly ["date_created"];
|
|
730
1185
|
readonly additionalProperties: false;
|
|
@@ -734,621 +1189,1172 @@ export declare const InvoiceSchema: {
|
|
|
734
1189
|
readonly properties: {
|
|
735
1190
|
readonly id: {
|
|
736
1191
|
readonly type: "string";
|
|
737
|
-
readonly
|
|
738
|
-
readonly
|
|
739
|
-
|
|
1192
|
+
readonly description: "Unique identifier of the invoice.";
|
|
1193
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
1194
|
+
};
|
|
1195
|
+
readonly number: {
|
|
1196
|
+
readonly type: "string";
|
|
740
1197
|
};
|
|
741
|
-
readonly
|
|
1198
|
+
readonly status: {
|
|
1199
|
+
readonly type: "string";
|
|
1200
|
+
readonly description: "Status of the invoice";
|
|
1201
|
+
readonly example: "paid";
|
|
1202
|
+
};
|
|
1203
|
+
readonly total: {
|
|
1204
|
+
readonly type: "number";
|
|
1205
|
+
readonly format: "float";
|
|
1206
|
+
readonly description: "Total amount of the invoice";
|
|
1207
|
+
readonly example: 100;
|
|
1208
|
+
};
|
|
1209
|
+
readonly currency: {
|
|
1210
|
+
readonly type: "string";
|
|
1211
|
+
readonly description: "Currency of the invoice";
|
|
1212
|
+
readonly example: "usd";
|
|
1213
|
+
};
|
|
1214
|
+
readonly created: {
|
|
1215
|
+
readonly type: "string";
|
|
1216
|
+
readonly format: "date-time";
|
|
1217
|
+
readonly description: "Timestamp when the invoice was issued. ISO 8601 date string in the UTC timezone.";
|
|
1218
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
1219
|
+
};
|
|
1220
|
+
readonly period_start: {
|
|
1221
|
+
readonly type: "string";
|
|
1222
|
+
readonly format: "date-time";
|
|
1223
|
+
readonly description: "Billing period start timestamp. ISO 8601 date string in the UTC timezone.";
|
|
1224
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
1225
|
+
};
|
|
1226
|
+
readonly period_end: {
|
|
1227
|
+
readonly type: "string";
|
|
1228
|
+
readonly format: "date-time";
|
|
1229
|
+
readonly description: "Billing period end timestamp. ISO 8601 date string in the UTC timezone.";
|
|
1230
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
1231
|
+
};
|
|
1232
|
+
readonly invoice_pdf: {
|
|
1233
|
+
readonly type: "string";
|
|
1234
|
+
};
|
|
1235
|
+
};
|
|
1236
|
+
readonly required: readonly ["created", "period_start", "period_end"];
|
|
1237
|
+
readonly additionalProperties: false;
|
|
1238
|
+
};
|
|
1239
|
+
export declare const MarketplaceListingFilesSchema: {
|
|
1240
|
+
readonly type: "object";
|
|
1241
|
+
readonly properties: {
|
|
1242
|
+
readonly chartYaml: {
|
|
1243
|
+
readonly type: "string";
|
|
1244
|
+
readonly description: "Raw Chart.yaml content from the Helm chart";
|
|
1245
|
+
readonly example: "apiVersion: v2\nname: nginx-ingress\nversion: 1.18.2-cfke.45\nappVersion: 1.9.4";
|
|
1246
|
+
};
|
|
1247
|
+
readonly valuesYaml: {
|
|
1248
|
+
readonly type: "string";
|
|
1249
|
+
readonly description: "Raw values.yaml content from the Helm chart";
|
|
1250
|
+
readonly example: "replicaCount: 1\nimage:\n repository: nginx\n tag: latest";
|
|
1251
|
+
};
|
|
1252
|
+
readonly valuesSchemaJson: {
|
|
1253
|
+
readonly type: "string";
|
|
1254
|
+
readonly description: "JSON schema for values.yaml as a string";
|
|
1255
|
+
readonly example: "{\"type\":\"object\",\"properties\":{\"replicaCount\":{\"type\":\"number\"}}}";
|
|
1256
|
+
};
|
|
1257
|
+
};
|
|
1258
|
+
readonly additionalProperties: false;
|
|
1259
|
+
};
|
|
1260
|
+
export declare const MarketplaceListingSchema: {
|
|
1261
|
+
readonly type: "object";
|
|
1262
|
+
readonly properties: {
|
|
1263
|
+
readonly name: {
|
|
1264
|
+
readonly type: "string";
|
|
1265
|
+
readonly description: "Name of the chart";
|
|
1266
|
+
readonly example: "nginx-ingress";
|
|
1267
|
+
};
|
|
1268
|
+
readonly versions: {
|
|
1269
|
+
readonly type: "array";
|
|
1270
|
+
readonly items: {
|
|
1271
|
+
readonly type: "string";
|
|
1272
|
+
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-]+)*))?$";
|
|
1273
|
+
readonly description: "Specific version of the chart";
|
|
1274
|
+
readonly example: "1.18.2-cfke.45";
|
|
1275
|
+
};
|
|
1276
|
+
readonly description: "Available versions of the chart";
|
|
1277
|
+
};
|
|
1278
|
+
readonly version_channels: {
|
|
1279
|
+
readonly type: "array";
|
|
1280
|
+
readonly items: {
|
|
1281
|
+
readonly type: "string";
|
|
1282
|
+
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-]+)*))?$";
|
|
1283
|
+
readonly description: "Version channel pattern";
|
|
1284
|
+
readonly example: "1.18.x-cfke.x";
|
|
1285
|
+
};
|
|
1286
|
+
readonly description: "Version channels for the chart";
|
|
1287
|
+
};
|
|
1288
|
+
readonly latestVersion: {
|
|
1289
|
+
readonly type: "string";
|
|
1290
|
+
readonly description: "Latest version of the chart";
|
|
1291
|
+
readonly example: "1.18.2-cfke.45";
|
|
1292
|
+
};
|
|
1293
|
+
readonly metadata: {
|
|
1294
|
+
readonly type: "object";
|
|
1295
|
+
readonly properties: {
|
|
1296
|
+
readonly name: {
|
|
1297
|
+
readonly type: "string";
|
|
1298
|
+
readonly description: "Chart name from metadata";
|
|
1299
|
+
readonly example: "nginx-ingress";
|
|
1300
|
+
};
|
|
1301
|
+
readonly version: {
|
|
1302
|
+
readonly type: "string";
|
|
1303
|
+
readonly description: "Chart version from metadata";
|
|
1304
|
+
readonly example: "1.18.2-cfke.45";
|
|
1305
|
+
};
|
|
1306
|
+
readonly description: {
|
|
1307
|
+
readonly type: "string";
|
|
1308
|
+
readonly description: "Chart description";
|
|
1309
|
+
readonly example: "NGINX Ingress Controller for Kubernetes";
|
|
1310
|
+
};
|
|
1311
|
+
readonly appVersion: {
|
|
1312
|
+
readonly type: "string";
|
|
1313
|
+
readonly description: "Application version";
|
|
1314
|
+
readonly example: "1.9.4";
|
|
1315
|
+
};
|
|
1316
|
+
readonly apiVersion: {
|
|
1317
|
+
readonly type: "string";
|
|
1318
|
+
readonly description: "Helm API version";
|
|
1319
|
+
readonly example: "v2";
|
|
1320
|
+
};
|
|
1321
|
+
readonly keywords: {
|
|
1322
|
+
readonly type: "array";
|
|
1323
|
+
readonly items: {
|
|
1324
|
+
readonly type: "string";
|
|
1325
|
+
};
|
|
1326
|
+
readonly description: "Chart keywords";
|
|
1327
|
+
readonly example: readonly ["ingress", "nginx", "load-balancer"];
|
|
1328
|
+
};
|
|
1329
|
+
readonly home: {
|
|
1330
|
+
readonly type: "string";
|
|
1331
|
+
readonly description: "Chart home URL";
|
|
1332
|
+
readonly example: "https://kubernetes.github.io/ingress-nginx/";
|
|
1333
|
+
};
|
|
1334
|
+
readonly icon: {
|
|
1335
|
+
readonly type: "string";
|
|
1336
|
+
readonly description: "A URL to an SVG or PNG image to be used as an icon";
|
|
1337
|
+
readonly example: "https://cloudfleet.ai/images/marketplace/icons/ingress-nginx.png";
|
|
1338
|
+
};
|
|
1339
|
+
readonly sources: {
|
|
1340
|
+
readonly type: "array";
|
|
1341
|
+
readonly items: {
|
|
1342
|
+
readonly type: "string";
|
|
1343
|
+
};
|
|
1344
|
+
readonly description: "Chart source URLs";
|
|
1345
|
+
readonly example: readonly ["https://github.com/kubernetes/ingress-nginx"];
|
|
1346
|
+
};
|
|
1347
|
+
readonly maintainers: {
|
|
1348
|
+
readonly type: "array";
|
|
1349
|
+
readonly items: {
|
|
1350
|
+
readonly type: "object";
|
|
1351
|
+
readonly properties: {
|
|
1352
|
+
readonly name: {
|
|
1353
|
+
readonly type: "string";
|
|
1354
|
+
readonly description: "Maintainer name";
|
|
1355
|
+
readonly example: "NGINX Team";
|
|
1356
|
+
};
|
|
1357
|
+
readonly email: {
|
|
1358
|
+
readonly type: "string";
|
|
1359
|
+
readonly description: "Maintainer email";
|
|
1360
|
+
readonly example: "support@nginx.org";
|
|
1361
|
+
};
|
|
1362
|
+
};
|
|
1363
|
+
readonly required: readonly ["name"];
|
|
1364
|
+
readonly additionalProperties: false;
|
|
1365
|
+
};
|
|
1366
|
+
readonly description: "Chart maintainers";
|
|
1367
|
+
};
|
|
1368
|
+
};
|
|
1369
|
+
readonly required: readonly ["name", "version"];
|
|
1370
|
+
readonly additionalProperties: false;
|
|
1371
|
+
readonly description: "Chart metadata";
|
|
1372
|
+
};
|
|
1373
|
+
};
|
|
1374
|
+
readonly required: readonly ["name", "versions", "version_channels", "latestVersion"];
|
|
1375
|
+
readonly additionalProperties: false;
|
|
1376
|
+
};
|
|
1377
|
+
export declare const OrganizationCreateInputSchema: {
|
|
1378
|
+
readonly type: "object";
|
|
1379
|
+
readonly properties: {
|
|
1380
|
+
readonly type: {
|
|
1381
|
+
readonly type: "string";
|
|
1382
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1383
|
+
readonly example: "business";
|
|
1384
|
+
readonly enum: readonly ["business", "personal"];
|
|
1385
|
+
};
|
|
1386
|
+
readonly email: {
|
|
1387
|
+
readonly type: "string";
|
|
1388
|
+
readonly format: "email";
|
|
1389
|
+
readonly description: "Email address used for billing as a string.";
|
|
1390
|
+
readonly example: "email@example.com";
|
|
1391
|
+
};
|
|
1392
|
+
readonly first_name: {
|
|
1393
|
+
readonly type: "string";
|
|
1394
|
+
readonly minLength: 1;
|
|
1395
|
+
readonly description: "First name of the billing contact person.";
|
|
1396
|
+
readonly example: "John";
|
|
1397
|
+
};
|
|
1398
|
+
readonly last_name: {
|
|
1399
|
+
readonly type: "string";
|
|
1400
|
+
readonly minLength: 1;
|
|
1401
|
+
readonly description: "Last name of the billing contact person.";
|
|
1402
|
+
readonly example: "Doe";
|
|
1403
|
+
};
|
|
1404
|
+
readonly company_name: {
|
|
1405
|
+
readonly type: "string";
|
|
1406
|
+
readonly maxLength: 120;
|
|
1407
|
+
readonly minLength: 2;
|
|
1408
|
+
readonly pattern: "^(?!\\s)(?!.*\\s$)(?=.*[a-zA-ZÆÐƎƏƐƔIJŊŒẞÞǷȜæðǝəɛɣijŋœĸſßþƿȝĄƁÇĐƊĘĦĮƘŁØƠŞȘŢȚŦŲƯY̨Ƴąɓçđɗęħįƙłøơşșţțŧųưy̨ƴÁÀÂÄǍĂĀÃÅǺĄÆǼǢƁĆĊĈČÇĎḌĐƊÐÉÈĖÊËĚĔĒĘẸƎƏƐĠĜǦĞĢƔáàâäǎăāãåǻąæǽǣɓćċĉčçďḍđɗðéèėêëěĕēęẹǝəɛġĝǧğģɣĤḤĦIÍÌİÎÏǏĬĪĨĮỊIJĴĶƘĹĻŁĽĿʼNŃN̈ŇÑŅŊÓÒÔÖǑŎŌÕŐỌØǾƠŒĥḥħıíìiîïǐĭīĩįịijĵķƙĸĺļłľŀʼnńn̈ňñņŋóòôöǒŏōõőọøǿơœŔŘŖŚŜŠŞȘṢẞŤŢṬŦÞÚÙÛÜǓŬŪŨŰŮŲỤƯẂẀŴẄǷÝỲŶŸȲỸƳŹŻŽẒŕřŗſśŝšşșṣßťţṭŧþúùûüǔŭūũűůųụưẃẁŵẅƿýỳŷÿȳỹƴźżžẓ0-9])[a-zA-ZÆÐƎƏƐƔIJŊŒẞÞǷȜæðǝəɛɣijŋœĸſßþƿȝĄƁÇĐƊĘĦĮƘŁØƠŞȘŢȚŦŲƯY̨Ƴąɓçđɗęħįƙłøơşșţțŧųưy̨ƴÁÀÂÄǍĂĀÃÅǺĄÆǼǢƁĆĊĈČÇĎḌĐƊÐÉÈĖÊËĚĔĒĘẸƎƏƐĠĜǦĞĢƔáàâäǎăāãåǻąæǽǣɓćċĉčçďḍđɗðéèėêëěĕēęẹǝəɛġĝǧğģɣĤḤĦIÍÌİÎÏǏĬĪĨĮỊIJĴĶƘĹĻŁĽĿʼNŃN̈ŇÑŅŊÓÒÔÖǑŎŌÕŐỌØǾƠŒĥḥħıíìiîïǐĭīĩįịijĵķƙĸĺļłľŀʼnńn̈ňñņŋóòôöǒŏōõőọøǿơœŔŘŖŚŜŠŞȘṢẞŤŢṬŦÞÚÙÛÜǓŬŪŨŰŮŲỤƯẂẀŴẄǷÝỲŶŸȲỸƳŹŻŽẒŕřŗſśŝšşșṣßťţṭŧþúùûüǔŭūũűůųụưẃẁŵẅƿýỳŷÿȳỹƴźżžẓ0-9 -.]{2,}$";
|
|
1409
|
+
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1410
|
+
readonly example: "ACME Corp.";
|
|
1411
|
+
};
|
|
1412
|
+
readonly password: {
|
|
1413
|
+
readonly type: "string";
|
|
1414
|
+
readonly minLength: 8;
|
|
1415
|
+
readonly description: "Password for the root account. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.";
|
|
1416
|
+
};
|
|
1417
|
+
};
|
|
1418
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1419
|
+
readonly additionalProperties: false;
|
|
1420
|
+
};
|
|
1421
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1422
|
+
readonly type: "object";
|
|
1423
|
+
readonly properties: {
|
|
1424
|
+
readonly id: {
|
|
1425
|
+
readonly type: "string";
|
|
1426
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1427
|
+
readonly example: "organization-id";
|
|
1428
|
+
};
|
|
1429
|
+
};
|
|
1430
|
+
readonly required: readonly ["id"];
|
|
1431
|
+
readonly additionalProperties: false;
|
|
1432
|
+
};
|
|
1433
|
+
export declare const OrganizationSchema: {
|
|
1434
|
+
readonly type: "object";
|
|
1435
|
+
readonly properties: {
|
|
1436
|
+
readonly id: {
|
|
742
1437
|
readonly type: "string";
|
|
743
1438
|
readonly format: "uuid";
|
|
744
1439
|
readonly description: "Unique identifier of the organization. UUID v4 string in canonical form";
|
|
745
|
-
readonly example: "
|
|
1440
|
+
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1441
|
+
};
|
|
1442
|
+
readonly name: {
|
|
1443
|
+
readonly type: "string";
|
|
1444
|
+
readonly maxLength: 120;
|
|
1445
|
+
readonly minLength: 2;
|
|
1446
|
+
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1447
|
+
readonly example: "ACME Corp.";
|
|
1448
|
+
};
|
|
1449
|
+
readonly type: {
|
|
1450
|
+
readonly type: "string";
|
|
1451
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1452
|
+
readonly example: "business";
|
|
1453
|
+
readonly enum: readonly ["business", "personal"];
|
|
1454
|
+
};
|
|
1455
|
+
readonly date_created: {
|
|
1456
|
+
readonly type: "string";
|
|
1457
|
+
readonly format: "date-time";
|
|
1458
|
+
readonly description: "Creation date of the organization. ISO 8601 date string in UTC timezone";
|
|
1459
|
+
readonly example: "2023-11-02T16:08:14.338Z";
|
|
1460
|
+
};
|
|
1461
|
+
readonly quota: {
|
|
1462
|
+
readonly type: "object";
|
|
1463
|
+
readonly properties: {
|
|
1464
|
+
readonly basic_clusters_max: {
|
|
1465
|
+
readonly type: "integer";
|
|
1466
|
+
readonly minimum: 0;
|
|
1467
|
+
readonly description: "Maximum number of Basic clusters that can be created.";
|
|
1468
|
+
readonly example: 999;
|
|
1469
|
+
};
|
|
1470
|
+
readonly basic_clusters_available: {
|
|
1471
|
+
readonly type: "integer";
|
|
1472
|
+
readonly description: "Available number of Basic clusters that can be created.";
|
|
1473
|
+
readonly example: 999;
|
|
1474
|
+
};
|
|
1475
|
+
readonly pro_clusters_max: {
|
|
1476
|
+
readonly type: "integer";
|
|
1477
|
+
readonly minimum: 0;
|
|
1478
|
+
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1479
|
+
readonly example: 999;
|
|
1480
|
+
};
|
|
1481
|
+
readonly pro_clusters_available: {
|
|
1482
|
+
readonly type: "integer";
|
|
1483
|
+
readonly description: "Available number of Pro clusters that can be created.";
|
|
1484
|
+
readonly example: 999;
|
|
1485
|
+
};
|
|
1486
|
+
readonly enterprise_clusters_max: {
|
|
1487
|
+
readonly type: "integer";
|
|
1488
|
+
readonly minimum: 0;
|
|
1489
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1490
|
+
readonly example: 999;
|
|
1491
|
+
};
|
|
1492
|
+
readonly enterprise_clusters_available: {
|
|
1493
|
+
readonly type: "integer";
|
|
1494
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1495
|
+
readonly example: 999;
|
|
1496
|
+
};
|
|
1497
|
+
readonly fleets_max: {
|
|
1498
|
+
readonly type: "integer";
|
|
1499
|
+
readonly minimum: 0;
|
|
1500
|
+
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1501
|
+
readonly example: 999;
|
|
1502
|
+
};
|
|
1503
|
+
readonly cluster_tiers: {
|
|
1504
|
+
readonly type: "array";
|
|
1505
|
+
readonly items: {
|
|
1506
|
+
readonly type: "string";
|
|
1507
|
+
readonly example: "basic";
|
|
1508
|
+
};
|
|
1509
|
+
readonly minItems: 0;
|
|
1510
|
+
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1511
|
+
};
|
|
1512
|
+
readonly regions: {
|
|
1513
|
+
readonly type: "array";
|
|
1514
|
+
readonly items: {
|
|
1515
|
+
readonly type: "string";
|
|
1516
|
+
readonly example: "northamerica-central-1a";
|
|
1517
|
+
};
|
|
1518
|
+
readonly minItems: 1;
|
|
1519
|
+
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
1520
|
+
};
|
|
1521
|
+
readonly versions: {
|
|
1522
|
+
readonly type: "array";
|
|
1523
|
+
readonly items: {
|
|
1524
|
+
readonly type: "object";
|
|
1525
|
+
readonly properties: {
|
|
1526
|
+
readonly id: {
|
|
1527
|
+
readonly type: "string";
|
|
1528
|
+
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1529
|
+
readonly example: "1.33.x-cfke.x";
|
|
1530
|
+
};
|
|
1531
|
+
readonly label: {
|
|
1532
|
+
readonly type: "string";
|
|
1533
|
+
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1534
|
+
readonly example: "1.33.x (Always latest 1.33 patch version)";
|
|
1535
|
+
};
|
|
1536
|
+
};
|
|
1537
|
+
readonly required: readonly ["id", "label"];
|
|
1538
|
+
readonly additionalProperties: false;
|
|
1539
|
+
};
|
|
1540
|
+
readonly minItems: 1;
|
|
1541
|
+
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1542
|
+
};
|
|
1543
|
+
readonly cfcr_storage_gb: {
|
|
1544
|
+
readonly type: "integer";
|
|
1545
|
+
readonly minimum: -1;
|
|
1546
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1547
|
+
readonly example: 500;
|
|
1548
|
+
};
|
|
1549
|
+
};
|
|
1550
|
+
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"];
|
|
1551
|
+
readonly additionalProperties: false;
|
|
1552
|
+
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.";
|
|
746
1553
|
};
|
|
747
1554
|
readonly status: {
|
|
748
1555
|
readonly type: "string";
|
|
749
|
-
readonly description: "Status of the
|
|
750
|
-
readonly
|
|
751
|
-
|
|
1556
|
+
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1557
|
+
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1558
|
+
};
|
|
1559
|
+
readonly verification: {
|
|
1560
|
+
readonly type: "string";
|
|
1561
|
+
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.";
|
|
1562
|
+
readonly example: "verified";
|
|
1563
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1564
|
+
};
|
|
1565
|
+
};
|
|
1566
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1567
|
+
readonly additionalProperties: false;
|
|
1568
|
+
};
|
|
1569
|
+
export declare const PaymentMethodSchema: {
|
|
1570
|
+
readonly type: "object";
|
|
1571
|
+
readonly properties: {
|
|
1572
|
+
readonly id: {
|
|
1573
|
+
readonly type: "string";
|
|
1574
|
+
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.";
|
|
1575
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1576
|
+
};
|
|
1577
|
+
readonly type: {
|
|
1578
|
+
readonly type: "string";
|
|
1579
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1580
|
+
readonly example: "card";
|
|
1581
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1582
|
+
};
|
|
1583
|
+
readonly last4: {
|
|
1584
|
+
readonly type: "string";
|
|
1585
|
+
readonly nullable: true;
|
|
1586
|
+
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.";
|
|
1587
|
+
readonly example: "4242";
|
|
1588
|
+
};
|
|
1589
|
+
readonly exp_month: {
|
|
1590
|
+
readonly type: "integer";
|
|
1591
|
+
readonly minimum: 1;
|
|
1592
|
+
readonly maximum: 12;
|
|
1593
|
+
readonly nullable: true;
|
|
1594
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1595
|
+
readonly example: 12;
|
|
1596
|
+
};
|
|
1597
|
+
readonly exp_year: {
|
|
1598
|
+
readonly type: "integer";
|
|
1599
|
+
readonly nullable: true;
|
|
1600
|
+
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.";
|
|
1601
|
+
readonly example: 2028;
|
|
1602
|
+
};
|
|
1603
|
+
readonly brand: {
|
|
1604
|
+
readonly type: "string";
|
|
1605
|
+
readonly nullable: true;
|
|
1606
|
+
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.";
|
|
1607
|
+
readonly example: "visa";
|
|
1608
|
+
};
|
|
1609
|
+
readonly iban: {
|
|
1610
|
+
readonly type: "string";
|
|
1611
|
+
readonly nullable: true;
|
|
1612
|
+
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.";
|
|
1613
|
+
readonly example: "DE11243015658023127510";
|
|
1614
|
+
};
|
|
1615
|
+
readonly bic: {
|
|
1616
|
+
readonly type: "string";
|
|
1617
|
+
readonly nullable: true;
|
|
1618
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1619
|
+
readonly example: "SOGEDEFFXXX";
|
|
1620
|
+
};
|
|
1621
|
+
readonly account_holder_name: {
|
|
1622
|
+
readonly type: "string";
|
|
1623
|
+
readonly nullable: true;
|
|
1624
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1625
|
+
readonly example: "Cloudfleet GmbH";
|
|
1626
|
+
};
|
|
1627
|
+
readonly is_default: {
|
|
1628
|
+
readonly type: "boolean";
|
|
1629
|
+
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).";
|
|
1630
|
+
readonly example: true;
|
|
1631
|
+
};
|
|
1632
|
+
};
|
|
1633
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1634
|
+
readonly additionalProperties: false;
|
|
1635
|
+
};
|
|
1636
|
+
export declare const PlatformQuotaSchema: {
|
|
1637
|
+
readonly type: "object";
|
|
1638
|
+
readonly properties: {
|
|
1639
|
+
readonly basic_clusters_max: {
|
|
1640
|
+
readonly type: "integer";
|
|
1641
|
+
readonly minimum: 0;
|
|
1642
|
+
readonly description: "Maximum number of Basic clusters that can be created.";
|
|
1643
|
+
readonly example: 999;
|
|
1644
|
+
};
|
|
1645
|
+
readonly basic_clusters_available: {
|
|
1646
|
+
readonly type: "integer";
|
|
1647
|
+
readonly description: "Available number of Basic clusters that can be created.";
|
|
1648
|
+
readonly example: 999;
|
|
1649
|
+
};
|
|
1650
|
+
readonly pro_clusters_max: {
|
|
1651
|
+
readonly type: "integer";
|
|
1652
|
+
readonly minimum: 0;
|
|
1653
|
+
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1654
|
+
readonly example: 999;
|
|
1655
|
+
};
|
|
1656
|
+
readonly pro_clusters_available: {
|
|
1657
|
+
readonly type: "integer";
|
|
1658
|
+
readonly description: "Available number of Pro clusters that can be created.";
|
|
1659
|
+
readonly example: 999;
|
|
1660
|
+
};
|
|
1661
|
+
readonly enterprise_clusters_max: {
|
|
1662
|
+
readonly type: "integer";
|
|
1663
|
+
readonly minimum: 0;
|
|
1664
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1665
|
+
readonly example: 999;
|
|
1666
|
+
};
|
|
1667
|
+
readonly enterprise_clusters_available: {
|
|
1668
|
+
readonly type: "integer";
|
|
1669
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1670
|
+
readonly example: 999;
|
|
1671
|
+
};
|
|
1672
|
+
readonly fleets_max: {
|
|
1673
|
+
readonly type: "integer";
|
|
1674
|
+
readonly minimum: 0;
|
|
1675
|
+
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1676
|
+
readonly example: 999;
|
|
1677
|
+
};
|
|
1678
|
+
readonly cluster_tiers: {
|
|
1679
|
+
readonly type: "array";
|
|
1680
|
+
readonly items: {
|
|
1681
|
+
readonly type: "string";
|
|
1682
|
+
readonly example: "basic";
|
|
1683
|
+
};
|
|
1684
|
+
readonly minItems: 0;
|
|
1685
|
+
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1686
|
+
};
|
|
1687
|
+
readonly regions: {
|
|
1688
|
+
readonly type: "array";
|
|
1689
|
+
readonly items: {
|
|
1690
|
+
readonly type: "string";
|
|
1691
|
+
readonly example: "northamerica-central-1a";
|
|
1692
|
+
};
|
|
1693
|
+
readonly minItems: 1;
|
|
1694
|
+
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
1695
|
+
};
|
|
1696
|
+
readonly versions: {
|
|
1697
|
+
readonly type: "array";
|
|
1698
|
+
readonly items: {
|
|
1699
|
+
readonly type: "object";
|
|
1700
|
+
readonly properties: {
|
|
1701
|
+
readonly id: {
|
|
1702
|
+
readonly type: "string";
|
|
1703
|
+
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1704
|
+
readonly example: "1.33.x-cfke.x";
|
|
1705
|
+
};
|
|
1706
|
+
readonly label: {
|
|
1707
|
+
readonly type: "string";
|
|
1708
|
+
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1709
|
+
readonly example: "1.33.x (Always latest 1.33 patch version)";
|
|
1710
|
+
};
|
|
1711
|
+
};
|
|
1712
|
+
readonly required: readonly ["id", "label"];
|
|
1713
|
+
readonly additionalProperties: false;
|
|
1714
|
+
};
|
|
1715
|
+
readonly minItems: 1;
|
|
1716
|
+
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
752
1717
|
};
|
|
753
|
-
readonly
|
|
754
|
-
readonly type: "
|
|
755
|
-
readonly
|
|
756
|
-
readonly description: "
|
|
757
|
-
readonly example:
|
|
1718
|
+
readonly cfcr_storage_gb: {
|
|
1719
|
+
readonly type: "integer";
|
|
1720
|
+
readonly minimum: -1;
|
|
1721
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1722
|
+
readonly example: 500;
|
|
758
1723
|
};
|
|
759
|
-
|
|
1724
|
+
};
|
|
1725
|
+
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"];
|
|
1726
|
+
readonly additionalProperties: false;
|
|
1727
|
+
};
|
|
1728
|
+
export declare const RegistryRepositorySchema: {
|
|
1729
|
+
readonly type: "object";
|
|
1730
|
+
readonly properties: {
|
|
1731
|
+
readonly name: {
|
|
760
1732
|
readonly type: "string";
|
|
761
|
-
readonly description: "
|
|
762
|
-
readonly example: "
|
|
763
|
-
readonly enum: readonly ["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD", "BTC"];
|
|
764
|
-
};
|
|
765
|
-
readonly creditAdj: {
|
|
766
|
-
readonly type: "number";
|
|
767
|
-
readonly format: "float";
|
|
768
|
-
readonly description: "Total amount of credit adjustments";
|
|
769
|
-
readonly example: 0;
|
|
1733
|
+
readonly description: "Repository name.";
|
|
1734
|
+
readonly example: "my-app";
|
|
770
1735
|
};
|
|
771
|
-
readonly
|
|
772
|
-
readonly type: "number";
|
|
773
|
-
readonly format: "float";
|
|
774
|
-
readonly description: "Total amount of refund adjustments";
|
|
775
|
-
readonly example: 0;
|
|
776
|
-
};
|
|
777
|
-
readonly invoiceDate: {
|
|
1736
|
+
readonly region: {
|
|
778
1737
|
readonly type: "string";
|
|
779
|
-
readonly description: "
|
|
780
|
-
readonly example: "
|
|
1738
|
+
readonly description: "Registry region.";
|
|
1739
|
+
readonly example: "northamerica";
|
|
781
1740
|
};
|
|
782
|
-
readonly
|
|
1741
|
+
readonly uri: {
|
|
783
1742
|
readonly type: "string";
|
|
784
|
-
readonly description: "
|
|
785
|
-
readonly example: "
|
|
1743
|
+
readonly description: "Full URI of the repository.";
|
|
1744
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
786
1745
|
};
|
|
787
|
-
|
|
1746
|
+
};
|
|
1747
|
+
readonly required: readonly ["name", "region", "uri"];
|
|
1748
|
+
readonly additionalProperties: false;
|
|
1749
|
+
};
|
|
1750
|
+
export declare const RegistryRepositoryWithTagsSchema: {
|
|
1751
|
+
readonly type: "object";
|
|
1752
|
+
readonly properties: {
|
|
1753
|
+
readonly name: {
|
|
788
1754
|
readonly type: "string";
|
|
789
|
-
readonly description: "
|
|
790
|
-
readonly example: "
|
|
1755
|
+
readonly description: "Repository name.";
|
|
1756
|
+
readonly example: "my-app";
|
|
791
1757
|
};
|
|
792
|
-
readonly
|
|
793
|
-
readonly type: "
|
|
794
|
-
readonly
|
|
795
|
-
readonly
|
|
796
|
-
readonly example: 100;
|
|
1758
|
+
readonly region: {
|
|
1759
|
+
readonly type: "string";
|
|
1760
|
+
readonly description: "Registry region.";
|
|
1761
|
+
readonly example: "northamerica";
|
|
797
1762
|
};
|
|
798
|
-
readonly
|
|
1763
|
+
readonly uri: {
|
|
799
1764
|
readonly type: "string";
|
|
800
|
-
readonly description: "
|
|
801
|
-
readonly example: "
|
|
1765
|
+
readonly description: "Full URI of the repository.";
|
|
1766
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
802
1767
|
};
|
|
803
|
-
readonly
|
|
1768
|
+
readonly tags: {
|
|
804
1769
|
readonly type: "array";
|
|
805
1770
|
readonly items: {
|
|
806
1771
|
readonly type: "object";
|
|
807
1772
|
readonly properties: {
|
|
808
|
-
readonly
|
|
809
|
-
readonly type: "string";
|
|
810
|
-
readonly format: "uuid";
|
|
811
|
-
readonly description: "Unique identifier of the invoice item. UUID v4 string in canonical form";
|
|
812
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
813
|
-
};
|
|
814
|
-
readonly linkedInvoiceItemId: {
|
|
815
|
-
readonly type: "string";
|
|
816
|
-
readonly format: "uuid";
|
|
817
|
-
readonly description: "Unique identifier of the linked invoice item. UUID v4 string in canonical form";
|
|
818
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
819
|
-
};
|
|
820
|
-
readonly productName: {
|
|
821
|
-
readonly type: "string";
|
|
822
|
-
readonly description: "Name of the product";
|
|
823
|
-
readonly example: "Research team";
|
|
824
|
-
};
|
|
825
|
-
readonly planName: {
|
|
826
|
-
readonly type: "string";
|
|
827
|
-
readonly description: "Name of the plan";
|
|
828
|
-
readonly example: "Plan A";
|
|
829
|
-
};
|
|
830
|
-
readonly phaseName: {
|
|
831
|
-
readonly type: "string";
|
|
832
|
-
readonly description: "Name of the phase";
|
|
833
|
-
readonly example: "Phase A";
|
|
834
|
-
};
|
|
835
|
-
readonly usageName: {
|
|
836
|
-
readonly type: "string";
|
|
837
|
-
readonly description: "Name of the usage";
|
|
838
|
-
readonly example: "Usage A";
|
|
839
|
-
};
|
|
840
|
-
readonly prettyProductName: {
|
|
841
|
-
readonly type: "string";
|
|
842
|
-
readonly description: "Pretty name of the product";
|
|
843
|
-
readonly example: "Research team";
|
|
844
|
-
};
|
|
845
|
-
readonly prettyPlanName: {
|
|
846
|
-
readonly type: "string";
|
|
847
|
-
readonly description: "Pretty name of the plan";
|
|
848
|
-
readonly example: "Plan A";
|
|
849
|
-
};
|
|
850
|
-
readonly prettyPhaseName: {
|
|
851
|
-
readonly type: "string";
|
|
852
|
-
readonly description: "Pretty name of the phase";
|
|
853
|
-
readonly example: "Phase A";
|
|
854
|
-
};
|
|
855
|
-
readonly prettyUsageName: {
|
|
856
|
-
readonly type: "string";
|
|
857
|
-
readonly description: "Pretty name of the usage";
|
|
858
|
-
readonly example: "Usage A";
|
|
859
|
-
};
|
|
860
|
-
readonly itemType: {
|
|
861
|
-
readonly type: "string";
|
|
862
|
-
readonly description: "Type of the invoice item";
|
|
863
|
-
readonly example: "EXTERNAL_CHARGE";
|
|
864
|
-
readonly enum: readonly ["EXTERNAL_CHARGE", "FIXED", "RECURRING", "REPAIR_ADJ", "CBA_ADJ", "CREDIT_ADJ", "ITEM_ADJ", "USAGE", "TAX", "PARENT_SUMMARY"];
|
|
865
|
-
};
|
|
866
|
-
readonly description: {
|
|
867
|
-
readonly type: "string";
|
|
868
|
-
readonly description: "Description of the invoice item";
|
|
869
|
-
readonly example: "Description of the invoice item";
|
|
870
|
-
};
|
|
871
|
-
readonly startDate: {
|
|
872
|
-
readonly type: "string";
|
|
873
|
-
readonly description: "Start date of the invoice item";
|
|
874
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
875
|
-
};
|
|
876
|
-
readonly endDate: {
|
|
877
|
-
readonly type: "string";
|
|
878
|
-
readonly description: "End date of the invoice item";
|
|
879
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
880
|
-
};
|
|
881
|
-
readonly amount: {
|
|
882
|
-
readonly type: "number";
|
|
883
|
-
readonly format: "float";
|
|
884
|
-
readonly description: "Amount of the invoice item";
|
|
885
|
-
readonly example: 100;
|
|
886
|
-
};
|
|
887
|
-
readonly rate: {
|
|
888
|
-
readonly type: "number";
|
|
889
|
-
readonly format: "float";
|
|
890
|
-
readonly description: "Rate of the invoice item";
|
|
891
|
-
readonly example: 100;
|
|
892
|
-
};
|
|
893
|
-
readonly currency: {
|
|
1773
|
+
readonly name: {
|
|
894
1774
|
readonly type: "string";
|
|
895
|
-
readonly description: "
|
|
896
|
-
readonly example: "
|
|
897
|
-
readonly enum: readonly ["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD", "BTC"];
|
|
1775
|
+
readonly description: "Tag name.";
|
|
1776
|
+
readonly example: "latest";
|
|
898
1777
|
};
|
|
899
|
-
readonly
|
|
1778
|
+
readonly size: {
|
|
900
1779
|
readonly type: "number";
|
|
901
1780
|
readonly format: "float";
|
|
902
|
-
readonly description: "
|
|
903
|
-
readonly example:
|
|
904
|
-
};
|
|
905
|
-
readonly itemDetails: {
|
|
906
|
-
readonly type: "string";
|
|
907
|
-
readonly description: "Details of the invoice item";
|
|
908
|
-
readonly example: "Details of the invoice item";
|
|
1781
|
+
readonly description: "Size of the tag in bytes.";
|
|
1782
|
+
readonly example: 123456789;
|
|
909
1783
|
};
|
|
910
|
-
readonly
|
|
1784
|
+
readonly mediaType: {
|
|
911
1785
|
readonly type: "string";
|
|
912
|
-
readonly description: "
|
|
913
|
-
readonly example: "
|
|
1786
|
+
readonly description: "Media type of the manifest.";
|
|
1787
|
+
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
914
1788
|
};
|
|
915
|
-
readonly
|
|
1789
|
+
readonly platforms: {
|
|
916
1790
|
readonly type: "array";
|
|
917
1791
|
readonly items: {
|
|
918
|
-
readonly
|
|
919
|
-
readonly type: "array";
|
|
920
|
-
}, {
|
|
921
|
-
readonly type: "boolean";
|
|
922
|
-
}, {
|
|
923
|
-
readonly type: "number";
|
|
924
|
-
}, {
|
|
925
|
-
readonly type: "object";
|
|
926
|
-
readonly additionalProperties: true;
|
|
927
|
-
}, {
|
|
928
|
-
readonly type: "string";
|
|
929
|
-
}];
|
|
1792
|
+
readonly type: "string";
|
|
930
1793
|
};
|
|
931
|
-
readonly description: "
|
|
1794
|
+
readonly description: "Array of platform strings for multi-arch images (e.g., linux/amd64, linux/arm64).";
|
|
1795
|
+
readonly example: readonly ["linux/amd64", "linux/arm64"];
|
|
932
1796
|
};
|
|
933
1797
|
};
|
|
1798
|
+
readonly required: readonly ["name", "size"];
|
|
934
1799
|
readonly additionalProperties: false;
|
|
935
1800
|
};
|
|
936
|
-
readonly description: "
|
|
1801
|
+
readonly description: "Array of tags in the repository.";
|
|
937
1802
|
};
|
|
938
|
-
readonly
|
|
1803
|
+
readonly totalSize: {
|
|
1804
|
+
readonly type: "number";
|
|
1805
|
+
readonly format: "float";
|
|
1806
|
+
readonly description: "Total size of all tags in the repository in bytes.";
|
|
1807
|
+
readonly example: 987654321;
|
|
1808
|
+
};
|
|
1809
|
+
};
|
|
1810
|
+
readonly required: readonly ["name", "region", "uri", "tags", "totalSize"];
|
|
1811
|
+
readonly additionalProperties: false;
|
|
1812
|
+
};
|
|
1813
|
+
export declare const RegistryTagSchema: {
|
|
1814
|
+
readonly type: "object";
|
|
1815
|
+
readonly properties: {
|
|
1816
|
+
readonly name: {
|
|
1817
|
+
readonly type: "string";
|
|
1818
|
+
readonly description: "Tag name.";
|
|
1819
|
+
readonly example: "latest";
|
|
1820
|
+
};
|
|
1821
|
+
readonly digest: {
|
|
1822
|
+
readonly type: "string";
|
|
1823
|
+
readonly description: "Manifest digest for pulling by digest.";
|
|
1824
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1825
|
+
};
|
|
1826
|
+
readonly mediaType: {
|
|
1827
|
+
readonly type: "string";
|
|
1828
|
+
readonly description: "Media type of the manifest.";
|
|
1829
|
+
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
1830
|
+
};
|
|
1831
|
+
readonly config: {
|
|
1832
|
+
readonly type: "object";
|
|
1833
|
+
readonly properties: {
|
|
1834
|
+
readonly size: {
|
|
1835
|
+
readonly type: "number";
|
|
1836
|
+
readonly format: "float";
|
|
1837
|
+
readonly description: "Size of the config in bytes.";
|
|
1838
|
+
readonly example: 1234;
|
|
1839
|
+
};
|
|
1840
|
+
};
|
|
1841
|
+
readonly required: readonly ["size"];
|
|
1842
|
+
readonly additionalProperties: false;
|
|
1843
|
+
readonly description: "Manifest config metadata.";
|
|
1844
|
+
};
|
|
1845
|
+
readonly layers: {
|
|
939
1846
|
readonly type: "array";
|
|
940
1847
|
readonly items: {
|
|
941
1848
|
readonly type: "object";
|
|
942
1849
|
readonly properties: {
|
|
943
|
-
readonly
|
|
944
|
-
readonly type: "string";
|
|
945
|
-
readonly format: "uuid";
|
|
946
|
-
readonly description: "Unique identifier of the invoice item. UUID v4 string in canonical form";
|
|
947
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
948
|
-
};
|
|
949
|
-
readonly linkedInvoiceItemId: {
|
|
950
|
-
readonly type: "string";
|
|
951
|
-
readonly format: "uuid";
|
|
952
|
-
readonly description: "Unique identifier of the linked invoice item. UUID v4 string in canonical form";
|
|
953
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
954
|
-
};
|
|
955
|
-
readonly productName: {
|
|
956
|
-
readonly type: "string";
|
|
957
|
-
readonly description: "Name of the product";
|
|
958
|
-
readonly example: "Research team";
|
|
959
|
-
};
|
|
960
|
-
readonly planName: {
|
|
961
|
-
readonly type: "string";
|
|
962
|
-
readonly description: "Name of the plan";
|
|
963
|
-
readonly example: "Plan A";
|
|
964
|
-
};
|
|
965
|
-
readonly phaseName: {
|
|
966
|
-
readonly type: "string";
|
|
967
|
-
readonly description: "Name of the phase";
|
|
968
|
-
readonly example: "Phase A";
|
|
969
|
-
};
|
|
970
|
-
readonly usageName: {
|
|
971
|
-
readonly type: "string";
|
|
972
|
-
readonly description: "Name of the usage";
|
|
973
|
-
readonly example: "Usage A";
|
|
974
|
-
};
|
|
975
|
-
readonly prettyProductName: {
|
|
976
|
-
readonly type: "string";
|
|
977
|
-
readonly description: "Pretty name of the product";
|
|
978
|
-
readonly example: "Research team";
|
|
979
|
-
};
|
|
980
|
-
readonly prettyPlanName: {
|
|
981
|
-
readonly type: "string";
|
|
982
|
-
readonly description: "Pretty name of the plan";
|
|
983
|
-
readonly example: "Plan A";
|
|
984
|
-
};
|
|
985
|
-
readonly prettyPhaseName: {
|
|
986
|
-
readonly type: "string";
|
|
987
|
-
readonly description: "Pretty name of the phase";
|
|
988
|
-
readonly example: "Phase A";
|
|
989
|
-
};
|
|
990
|
-
readonly prettyUsageName: {
|
|
991
|
-
readonly type: "string";
|
|
992
|
-
readonly description: "Pretty name of the usage";
|
|
993
|
-
readonly example: "Usage A";
|
|
994
|
-
};
|
|
995
|
-
readonly itemType: {
|
|
996
|
-
readonly type: "string";
|
|
997
|
-
readonly description: "Type of the invoice item";
|
|
998
|
-
readonly example: "EXTERNAL_CHARGE";
|
|
999
|
-
readonly enum: readonly ["EXTERNAL_CHARGE", "FIXED", "RECURRING", "REPAIR_ADJ", "CBA_ADJ", "CREDIT_ADJ", "ITEM_ADJ", "USAGE", "TAX", "PARENT_SUMMARY"];
|
|
1000
|
-
};
|
|
1001
|
-
readonly description: {
|
|
1002
|
-
readonly type: "string";
|
|
1003
|
-
readonly description: "Description of the invoice item";
|
|
1004
|
-
readonly example: "Description of the invoice item";
|
|
1005
|
-
};
|
|
1006
|
-
readonly startDate: {
|
|
1007
|
-
readonly type: "string";
|
|
1008
|
-
readonly description: "Start date of the invoice item";
|
|
1009
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1010
|
-
};
|
|
1011
|
-
readonly endDate: {
|
|
1012
|
-
readonly type: "string";
|
|
1013
|
-
readonly description: "End date of the invoice item";
|
|
1014
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1015
|
-
};
|
|
1016
|
-
readonly amount: {
|
|
1017
|
-
readonly type: "number";
|
|
1018
|
-
readonly format: "float";
|
|
1019
|
-
readonly description: "Amount of the invoice item";
|
|
1020
|
-
readonly example: 100;
|
|
1021
|
-
};
|
|
1022
|
-
readonly rate: {
|
|
1023
|
-
readonly type: "number";
|
|
1024
|
-
readonly format: "float";
|
|
1025
|
-
readonly description: "Rate of the invoice item";
|
|
1026
|
-
readonly example: 100;
|
|
1027
|
-
};
|
|
1028
|
-
readonly currency: {
|
|
1850
|
+
readonly digest: {
|
|
1029
1851
|
readonly type: "string";
|
|
1030
|
-
readonly description: "
|
|
1031
|
-
readonly example: "
|
|
1032
|
-
readonly enum: readonly ["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD", "BTC"];
|
|
1852
|
+
readonly description: "Digest of the layer.";
|
|
1853
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1033
1854
|
};
|
|
1034
|
-
readonly
|
|
1855
|
+
readonly size: {
|
|
1035
1856
|
readonly type: "number";
|
|
1036
1857
|
readonly format: "float";
|
|
1037
|
-
readonly description: "
|
|
1038
|
-
readonly example:
|
|
1858
|
+
readonly description: "Size of the layer in bytes.";
|
|
1859
|
+
readonly example: 5678;
|
|
1039
1860
|
};
|
|
1040
|
-
|
|
1861
|
+
};
|
|
1862
|
+
readonly required: readonly ["size"];
|
|
1863
|
+
readonly additionalProperties: false;
|
|
1864
|
+
};
|
|
1865
|
+
readonly description: "Array of layer metadata.";
|
|
1866
|
+
};
|
|
1867
|
+
readonly manifests: {
|
|
1868
|
+
readonly type: "array";
|
|
1869
|
+
readonly items: {
|
|
1870
|
+
readonly type: "object";
|
|
1871
|
+
readonly properties: {
|
|
1872
|
+
readonly digest: {
|
|
1041
1873
|
readonly type: "string";
|
|
1042
|
-
readonly description: "
|
|
1043
|
-
readonly example: "
|
|
1874
|
+
readonly description: "Digest of the manifest.";
|
|
1875
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1044
1876
|
};
|
|
1045
|
-
readonly
|
|
1046
|
-
readonly type: "
|
|
1047
|
-
readonly
|
|
1048
|
-
|
|
1877
|
+
readonly platform: {
|
|
1878
|
+
readonly type: "object";
|
|
1879
|
+
readonly properties: {
|
|
1880
|
+
readonly architecture: {
|
|
1881
|
+
readonly type: "string";
|
|
1882
|
+
readonly description: "Architecture of the platform.";
|
|
1883
|
+
readonly example: "amd64";
|
|
1884
|
+
};
|
|
1885
|
+
readonly os: {
|
|
1886
|
+
readonly type: "string";
|
|
1887
|
+
readonly description: "Operating system of the platform.";
|
|
1888
|
+
readonly example: "linux";
|
|
1889
|
+
};
|
|
1890
|
+
readonly variant: {
|
|
1891
|
+
readonly type: "string";
|
|
1892
|
+
readonly description: "Variant of the platform (e.g., v7, v8 for ARM).";
|
|
1893
|
+
readonly example: "v8";
|
|
1894
|
+
};
|
|
1895
|
+
};
|
|
1896
|
+
readonly required: readonly ["architecture", "os"];
|
|
1897
|
+
readonly additionalProperties: false;
|
|
1898
|
+
readonly description: "Platform information for the manifest.";
|
|
1049
1899
|
};
|
|
1050
|
-
readonly
|
|
1900
|
+
readonly layers: {
|
|
1051
1901
|
readonly type: "array";
|
|
1052
1902
|
readonly items: {
|
|
1053
|
-
readonly
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
readonly
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1903
|
+
readonly type: "object";
|
|
1904
|
+
readonly properties: {
|
|
1905
|
+
readonly digest: {
|
|
1906
|
+
readonly type: "string";
|
|
1907
|
+
readonly description: "Digest of the layer.";
|
|
1908
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1909
|
+
};
|
|
1910
|
+
readonly size: {
|
|
1911
|
+
readonly type: "number";
|
|
1912
|
+
readonly format: "float";
|
|
1913
|
+
readonly description: "Size of the layer in bytes.";
|
|
1914
|
+
readonly example: 5678;
|
|
1915
|
+
};
|
|
1916
|
+
};
|
|
1917
|
+
readonly required: readonly ["size"];
|
|
1918
|
+
readonly additionalProperties: false;
|
|
1065
1919
|
};
|
|
1066
|
-
readonly description: "
|
|
1920
|
+
readonly description: "Layers for this platform.";
|
|
1921
|
+
};
|
|
1922
|
+
readonly size: {
|
|
1923
|
+
readonly type: "number";
|
|
1924
|
+
readonly format: "float";
|
|
1925
|
+
readonly description: "Total size of this platform manifest in bytes.";
|
|
1926
|
+
readonly example: 12345678;
|
|
1067
1927
|
};
|
|
1068
1928
|
};
|
|
1929
|
+
readonly required: readonly ["digest"];
|
|
1069
1930
|
readonly additionalProperties: false;
|
|
1070
1931
|
};
|
|
1071
|
-
readonly description: "
|
|
1932
|
+
readonly description: "Array of manifests for multi-arch images.";
|
|
1933
|
+
};
|
|
1934
|
+
readonly size: {
|
|
1935
|
+
readonly type: "number";
|
|
1936
|
+
readonly format: "float";
|
|
1937
|
+
readonly description: "Total size of the tag in bytes.";
|
|
1938
|
+
readonly example: 123456789;
|
|
1939
|
+
};
|
|
1940
|
+
readonly region: {
|
|
1941
|
+
readonly type: "string";
|
|
1942
|
+
readonly description: "Registry region.";
|
|
1943
|
+
readonly example: "northamerica";
|
|
1944
|
+
};
|
|
1945
|
+
readonly repository: {
|
|
1946
|
+
readonly type: "string";
|
|
1947
|
+
readonly description: "Repository name.";
|
|
1948
|
+
readonly example: "my-app";
|
|
1949
|
+
};
|
|
1950
|
+
readonly uri: {
|
|
1951
|
+
readonly type: "string";
|
|
1952
|
+
readonly description: "Full URI of the tag.";
|
|
1953
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app:latest";
|
|
1072
1954
|
};
|
|
1073
1955
|
};
|
|
1956
|
+
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
1074
1957
|
readonly additionalProperties: false;
|
|
1075
1958
|
};
|
|
1076
|
-
export declare const
|
|
1959
|
+
export declare const TicketAttachmentSchema: {
|
|
1077
1960
|
readonly type: "object";
|
|
1078
1961
|
readonly properties: {
|
|
1079
1962
|
readonly id: {
|
|
1080
1963
|
readonly type: "string";
|
|
1081
|
-
readonly
|
|
1082
|
-
readonly
|
|
1083
|
-
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
1084
|
-
readonly description: "Id of the chart listing";
|
|
1085
|
-
readonly example: "portworx-enterprise-disaster-recovery-baremetal";
|
|
1964
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
1965
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1086
1966
|
};
|
|
1087
|
-
readonly
|
|
1967
|
+
readonly filename: {
|
|
1088
1968
|
readonly type: "string";
|
|
1089
|
-
readonly description: "
|
|
1090
|
-
readonly example: "
|
|
1969
|
+
readonly description: "Original filename as uploaded.";
|
|
1970
|
+
readonly example: "debug.log";
|
|
1091
1971
|
};
|
|
1092
|
-
readonly
|
|
1972
|
+
readonly content_type: {
|
|
1093
1973
|
readonly type: "string";
|
|
1094
|
-
readonly description: "
|
|
1095
|
-
readonly example: "
|
|
1974
|
+
readonly description: "MIME content type of the attachment.";
|
|
1975
|
+
readonly example: "text/plain";
|
|
1096
1976
|
};
|
|
1097
|
-
readonly
|
|
1098
|
-
readonly type: "
|
|
1099
|
-
readonly description: "
|
|
1100
|
-
readonly example:
|
|
1977
|
+
readonly size: {
|
|
1978
|
+
readonly type: "integer";
|
|
1979
|
+
readonly description: "Size of the attachment in bytes.";
|
|
1980
|
+
readonly example: 12345;
|
|
1101
1981
|
};
|
|
1102
|
-
|
|
1982
|
+
};
|
|
1983
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1984
|
+
readonly additionalProperties: false;
|
|
1985
|
+
};
|
|
1986
|
+
export declare const TicketCreateInputSchema: {
|
|
1987
|
+
readonly type: "object";
|
|
1988
|
+
readonly properties: {
|
|
1989
|
+
readonly category: {
|
|
1103
1990
|
readonly type: "string";
|
|
1104
|
-
readonly description: "
|
|
1105
|
-
readonly example: "
|
|
1991
|
+
readonly description: "Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.";
|
|
1992
|
+
readonly example: "technical";
|
|
1993
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
1106
1994
|
};
|
|
1107
|
-
readonly
|
|
1995
|
+
readonly body: {
|
|
1108
1996
|
readonly type: "string";
|
|
1109
|
-
readonly
|
|
1110
|
-
readonly
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
readonly
|
|
1114
|
-
readonly items: {
|
|
1115
|
-
readonly type: "string";
|
|
1116
|
-
readonly example: "AI & Machine Learning";
|
|
1117
|
-
};
|
|
1118
|
-
readonly description: "Tags of the chart";
|
|
1997
|
+
readonly maxLength: 50000;
|
|
1998
|
+
readonly minLength: 1;
|
|
1999
|
+
readonly pattern: "\\S";
|
|
2000
|
+
readonly description: "Initial message body in markdown. There is no separate subject — the first message body is the description.";
|
|
2001
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1119
2002
|
};
|
|
1120
|
-
readonly
|
|
1121
|
-
readonly type: "
|
|
1122
|
-
readonly
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
readonly
|
|
1126
|
-
readonly
|
|
2003
|
+
readonly properties: {
|
|
2004
|
+
readonly type: "object";
|
|
2005
|
+
readonly additionalProperties: true;
|
|
2006
|
+
readonly description: "Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).";
|
|
2007
|
+
readonly example: {
|
|
2008
|
+
readonly subcategory: "cluster-question";
|
|
2009
|
+
readonly cluster_id: "60c72b2f9f1b2c001f8e4d3a";
|
|
1127
2010
|
};
|
|
1128
2011
|
};
|
|
1129
|
-
|
|
2012
|
+
};
|
|
2013
|
+
readonly required: readonly ["category", "body"];
|
|
2014
|
+
readonly additionalProperties: false;
|
|
2015
|
+
};
|
|
2016
|
+
export declare const TicketListResponseSchema: {
|
|
2017
|
+
readonly type: "object";
|
|
2018
|
+
readonly properties: {
|
|
2019
|
+
readonly items: {
|
|
1130
2020
|
readonly type: "array";
|
|
1131
2021
|
readonly items: {
|
|
1132
2022
|
readonly type: "object";
|
|
1133
2023
|
readonly properties: {
|
|
1134
|
-
readonly
|
|
2024
|
+
readonly id: {
|
|
2025
|
+
readonly type: "string";
|
|
2026
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
2027
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
2028
|
+
};
|
|
2029
|
+
readonly status: {
|
|
2030
|
+
readonly type: "string";
|
|
2031
|
+
readonly description: "Current state of the ticket.";
|
|
2032
|
+
readonly example: "waiting_on_us";
|
|
2033
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
2034
|
+
};
|
|
2035
|
+
readonly category: {
|
|
2036
|
+
readonly type: "string";
|
|
2037
|
+
readonly description: "Ticket category.";
|
|
2038
|
+
readonly example: "technical";
|
|
2039
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2040
|
+
};
|
|
2041
|
+
readonly summary: {
|
|
2042
|
+
readonly type: "string";
|
|
2043
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
2044
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2045
|
+
};
|
|
2046
|
+
readonly closed_at: {
|
|
1135
2047
|
readonly type: "string";
|
|
1136
|
-
readonly
|
|
1137
|
-
readonly
|
|
1138
|
-
readonly
|
|
2048
|
+
readonly format: "date-time";
|
|
2049
|
+
readonly nullable: true;
|
|
2050
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2051
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1139
2052
|
};
|
|
1140
|
-
readonly
|
|
2053
|
+
readonly date_created: {
|
|
1141
2054
|
readonly type: "string";
|
|
1142
|
-
readonly
|
|
2055
|
+
readonly format: "date-time";
|
|
2056
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
2057
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1143
2058
|
};
|
|
1144
|
-
readonly
|
|
2059
|
+
readonly date_updated: {
|
|
1145
2060
|
readonly type: "string";
|
|
1146
|
-
readonly
|
|
1147
|
-
readonly
|
|
2061
|
+
readonly format: "date-time";
|
|
2062
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2063
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2064
|
+
};
|
|
2065
|
+
readonly messages: {
|
|
2066
|
+
readonly type: "array";
|
|
2067
|
+
readonly items: {
|
|
2068
|
+
readonly type: "object";
|
|
2069
|
+
readonly properties: {
|
|
2070
|
+
readonly id: {
|
|
2071
|
+
readonly type: "string";
|
|
2072
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2073
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2074
|
+
};
|
|
2075
|
+
readonly type: {
|
|
2076
|
+
readonly type: "string";
|
|
2077
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2078
|
+
readonly example: "customer_reply";
|
|
2079
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2080
|
+
};
|
|
2081
|
+
readonly body: {
|
|
2082
|
+
readonly type: "string";
|
|
2083
|
+
readonly description: "Message body in markdown.";
|
|
2084
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2085
|
+
};
|
|
2086
|
+
readonly author_first_name: {
|
|
2087
|
+
readonly type: "string";
|
|
2088
|
+
readonly nullable: true;
|
|
2089
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2090
|
+
readonly example: "Jane";
|
|
2091
|
+
};
|
|
2092
|
+
readonly author_last_name: {
|
|
2093
|
+
readonly type: "string";
|
|
2094
|
+
readonly nullable: true;
|
|
2095
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2096
|
+
readonly example: "Doe";
|
|
2097
|
+
};
|
|
2098
|
+
readonly attachments: {
|
|
2099
|
+
readonly type: "array";
|
|
2100
|
+
readonly items: {
|
|
2101
|
+
readonly type: "object";
|
|
2102
|
+
readonly properties: {
|
|
2103
|
+
readonly id: {
|
|
2104
|
+
readonly type: "string";
|
|
2105
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2106
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2107
|
+
};
|
|
2108
|
+
readonly filename: {
|
|
2109
|
+
readonly type: "string";
|
|
2110
|
+
readonly description: "Original filename as uploaded.";
|
|
2111
|
+
readonly example: "debug.log";
|
|
2112
|
+
};
|
|
2113
|
+
readonly content_type: {
|
|
2114
|
+
readonly type: "string";
|
|
2115
|
+
readonly description: "MIME content type of the attachment.";
|
|
2116
|
+
readonly example: "text/plain";
|
|
2117
|
+
};
|
|
2118
|
+
readonly size: {
|
|
2119
|
+
readonly type: "integer";
|
|
2120
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2121
|
+
readonly example: 12345;
|
|
2122
|
+
};
|
|
2123
|
+
};
|
|
2124
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2125
|
+
readonly additionalProperties: false;
|
|
2126
|
+
};
|
|
2127
|
+
readonly description: "Attachments associated with this message.";
|
|
2128
|
+
readonly example: readonly [];
|
|
2129
|
+
};
|
|
2130
|
+
readonly date_created: {
|
|
2131
|
+
readonly type: "string";
|
|
2132
|
+
readonly format: "date-time";
|
|
2133
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2134
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2135
|
+
};
|
|
2136
|
+
};
|
|
2137
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2138
|
+
readonly additionalProperties: false;
|
|
2139
|
+
};
|
|
2140
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
1148
2141
|
};
|
|
1149
2142
|
};
|
|
1150
|
-
readonly required: readonly ["
|
|
2143
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1151
2144
|
readonly additionalProperties: false;
|
|
1152
2145
|
};
|
|
2146
|
+
readonly description: "Tickets for the organization, ordered newest first. Messages are omitted from list responses.";
|
|
1153
2147
|
};
|
|
1154
2148
|
};
|
|
1155
|
-
readonly required: readonly ["
|
|
2149
|
+
readonly required: readonly ["items"];
|
|
1156
2150
|
readonly additionalProperties: false;
|
|
1157
2151
|
};
|
|
1158
|
-
export declare const
|
|
2152
|
+
export declare const TicketMessageInputSchema: {
|
|
1159
2153
|
readonly type: "object";
|
|
1160
2154
|
readonly properties: {
|
|
1161
|
-
readonly
|
|
1162
|
-
readonly type: "string";
|
|
1163
|
-
readonly format: "email";
|
|
1164
|
-
readonly description: "Email address used for billing as a string.";
|
|
1165
|
-
readonly example: "email@example.com";
|
|
1166
|
-
};
|
|
1167
|
-
readonly first_name: {
|
|
1168
|
-
readonly type: "string";
|
|
1169
|
-
readonly description: "First name of the billing contact person.";
|
|
1170
|
-
readonly example: "John";
|
|
1171
|
-
};
|
|
1172
|
-
readonly last_name: {
|
|
1173
|
-
readonly type: "string";
|
|
1174
|
-
readonly description: "Last name of the billing contact person.";
|
|
1175
|
-
readonly example: "Doe";
|
|
1176
|
-
};
|
|
1177
|
-
readonly company_name: {
|
|
1178
|
-
readonly type: "string";
|
|
1179
|
-
readonly maxLength: 120;
|
|
1180
|
-
readonly minLength: 2;
|
|
1181
|
-
readonly pattern: "^(?!\\s)(?!.*\\s$)(?=.*[a-zA-ZÆÐƎƏƐƔIJŊŒẞÞǷȜæðǝəɛɣijŋœĸſßþƿȝĄƁÇĐƊĘĦĮƘŁØƠŞȘŢȚŦŲƯY̨Ƴąɓçđɗęħįƙłøơşșţțŧųưy̨ƴÁÀÂÄǍĂĀÃÅǺĄÆǼǢƁĆĊĈČÇĎḌĐƊÐÉÈĖÊËĚĔĒĘẸƎƏƐĠĜǦĞĢƔáàâäǎăāãåǻąæǽǣɓćċĉčçďḍđɗðéèėêëěĕēęẹǝəɛġĝǧğģɣĤḤĦIÍÌİÎÏǏĬĪĨĮỊIJĴĶƘĹĻŁĽĿʼNŃN̈ŇÑŅŊÓÒÔÖǑŎŌÕŐỌØǾƠŒĥḥħıíìiîïǐĭīĩįịijĵķƙĸĺļłľŀʼnńn̈ňñņŋóòôöǒŏōõőọøǿơœŔŘŖŚŜŠŞȘṢẞŤŢṬŦÞÚÙÛÜǓŬŪŨŰŮŲỤƯẂẀŴẄǷÝỲŶŸȲỸƳŹŻŽẒŕřŗſśŝšşșṣßťţṭŧþúùûüǔŭūũűůųụưẃẁŵẅƿýỳŷÿȳỹƴźżžẓ0-9])[a-zA-ZÆÐƎƏƐƔIJŊŒẞÞǷȜæðǝəɛɣijŋœĸſßþƿȝĄƁÇĐƊĘĦĮƘŁØƠŞȘŢȚŦŲƯY̨Ƴąɓçđɗęħįƙłøơşșţțŧųưy̨ƴÁÀÂÄǍĂĀÃÅǺĄÆǼǢƁĆĊĈČÇĎḌĐƊÐÉÈĖÊËĚĔĒĘẸƎƏƐĠĜǦĞĢƔáàâäǎăāãåǻąæǽǣɓćċĉčçďḍđɗðéèėêëěĕēęẹǝəɛġĝǧğģɣĤḤĦIÍÌİÎÏǏĬĪĨĮỊIJĴĶƘĹĻŁĽĿʼNŃN̈ŇÑŅŊÓÒÔÖǑŎŌÕŐỌØǾƠŒĥḥħıíìiîïǐĭīĩįịijĵķƙĸĺļłľŀʼnńn̈ňñņŋóòôöǒŏōõőọøǿơœŔŘŖŚŜŠŞȘṢẞŤŢṬŦÞÚÙÛÜǓŬŪŨŰŮŲỤƯẂẀŴẄǷÝỲŶŸȲỸƳŹŻŽẒŕřŗſśŝšşșṣßťţṭŧþúùûüǔŭūũűůųụưẃẁŵẅƿýỳŷÿȳỹƴźżžẓ0-9 -.]{2,}$";
|
|
1182
|
-
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1183
|
-
readonly example: "ACME Corp.";
|
|
1184
|
-
};
|
|
1185
|
-
readonly password: {
|
|
2155
|
+
readonly body: {
|
|
1186
2156
|
readonly type: "string";
|
|
1187
|
-
readonly
|
|
1188
|
-
readonly
|
|
2157
|
+
readonly maxLength: 50000;
|
|
2158
|
+
readonly minLength: 1;
|
|
2159
|
+
readonly pattern: "\\S";
|
|
2160
|
+
readonly description: "Reply body in markdown.";
|
|
2161
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
1189
2162
|
};
|
|
1190
2163
|
};
|
|
1191
|
-
readonly required: readonly ["
|
|
2164
|
+
readonly required: readonly ["body"];
|
|
1192
2165
|
readonly additionalProperties: false;
|
|
1193
2166
|
};
|
|
1194
|
-
export declare const
|
|
2167
|
+
export declare const TicketMessageSchema: {
|
|
1195
2168
|
readonly type: "object";
|
|
1196
2169
|
readonly properties: {
|
|
1197
2170
|
readonly id: {
|
|
1198
2171
|
readonly type: "string";
|
|
1199
|
-
readonly
|
|
1200
|
-
readonly
|
|
1201
|
-
|
|
2172
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2173
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2174
|
+
};
|
|
2175
|
+
readonly type: {
|
|
2176
|
+
readonly type: "string";
|
|
2177
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2178
|
+
readonly example: "customer_reply";
|
|
2179
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
1202
2180
|
};
|
|
1203
|
-
readonly
|
|
2181
|
+
readonly body: {
|
|
1204
2182
|
readonly type: "string";
|
|
1205
|
-
readonly
|
|
1206
|
-
readonly
|
|
1207
|
-
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1208
|
-
readonly example: "ACME Corp.";
|
|
2183
|
+
readonly description: "Message body in markdown.";
|
|
2184
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
1209
2185
|
};
|
|
1210
|
-
readonly
|
|
2186
|
+
readonly author_first_name: {
|
|
1211
2187
|
readonly type: "string";
|
|
1212
|
-
readonly
|
|
1213
|
-
readonly
|
|
1214
|
-
readonly example: "2023-11-02T16:08:14.338Z";
|
|
2188
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2189
|
+
readonly example: "Jane";
|
|
1215
2190
|
};
|
|
1216
|
-
readonly
|
|
1217
|
-
readonly type: "
|
|
1218
|
-
readonly
|
|
1219
|
-
|
|
1220
|
-
|
|
1221
|
-
|
|
1222
|
-
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
readonly
|
|
1226
|
-
readonly
|
|
1227
|
-
readonly description: "Available number of Basic clusters that can be created.";
|
|
1228
|
-
readonly example: 999;
|
|
1229
|
-
};
|
|
1230
|
-
readonly pro_clusters_max: {
|
|
1231
|
-
readonly type: "integer";
|
|
1232
|
-
readonly minimum: 0;
|
|
1233
|
-
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1234
|
-
readonly example: 999;
|
|
1235
|
-
};
|
|
1236
|
-
readonly pro_clusters_available: {
|
|
1237
|
-
readonly type: "integer";
|
|
1238
|
-
readonly description: "Available number of Pro clusters that can be created.";
|
|
1239
|
-
readonly example: 999;
|
|
1240
|
-
};
|
|
1241
|
-
readonly fleets_max: {
|
|
1242
|
-
readonly type: "integer";
|
|
1243
|
-
readonly minimum: 0;
|
|
1244
|
-
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1245
|
-
readonly example: 999;
|
|
1246
|
-
};
|
|
1247
|
-
readonly cluster_tiers: {
|
|
1248
|
-
readonly type: "array";
|
|
1249
|
-
readonly items: {
|
|
2191
|
+
readonly author_last_name: {
|
|
2192
|
+
readonly type: "string";
|
|
2193
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2194
|
+
readonly example: "Doe";
|
|
2195
|
+
};
|
|
2196
|
+
readonly attachments: {
|
|
2197
|
+
readonly type: "array";
|
|
2198
|
+
readonly items: {
|
|
2199
|
+
readonly type: "object";
|
|
2200
|
+
readonly properties: {
|
|
2201
|
+
readonly id: {
|
|
1250
2202
|
readonly type: "string";
|
|
1251
|
-
readonly
|
|
2203
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2204
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1252
2205
|
};
|
|
1253
|
-
readonly
|
|
1254
|
-
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1255
|
-
};
|
|
1256
|
-
readonly regions: {
|
|
1257
|
-
readonly type: "array";
|
|
1258
|
-
readonly items: {
|
|
2206
|
+
readonly filename: {
|
|
1259
2207
|
readonly type: "string";
|
|
1260
|
-
readonly
|
|
2208
|
+
readonly description: "Original filename as uploaded.";
|
|
2209
|
+
readonly example: "debug.log";
|
|
1261
2210
|
};
|
|
1262
|
-
readonly
|
|
1263
|
-
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
readonly
|
|
1268
|
-
readonly type: "
|
|
1269
|
-
readonly
|
|
1270
|
-
|
|
1271
|
-
readonly type: "string";
|
|
1272
|
-
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1273
|
-
readonly example: "1.29.x-cfke.x";
|
|
1274
|
-
};
|
|
1275
|
-
readonly label: {
|
|
1276
|
-
readonly type: "string";
|
|
1277
|
-
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1278
|
-
readonly example: "1.29.x (Always latest 1.29 patch version)";
|
|
1279
|
-
};
|
|
1280
|
-
};
|
|
1281
|
-
readonly required: readonly ["id", "label"];
|
|
1282
|
-
readonly additionalProperties: false;
|
|
2211
|
+
readonly content_type: {
|
|
2212
|
+
readonly type: "string";
|
|
2213
|
+
readonly description: "MIME content type of the attachment.";
|
|
2214
|
+
readonly example: "text/plain";
|
|
2215
|
+
};
|
|
2216
|
+
readonly size: {
|
|
2217
|
+
readonly type: "integer";
|
|
2218
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2219
|
+
readonly example: 12345;
|
|
1283
2220
|
};
|
|
1284
|
-
readonly minItems: 1;
|
|
1285
|
-
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1286
2221
|
};
|
|
2222
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2223
|
+
readonly additionalProperties: false;
|
|
1287
2224
|
};
|
|
1288
|
-
readonly
|
|
1289
|
-
readonly
|
|
1290
|
-
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.";
|
|
2225
|
+
readonly description: "Attachments associated with this message.";
|
|
2226
|
+
readonly example: readonly [];
|
|
1291
2227
|
};
|
|
1292
|
-
readonly
|
|
2228
|
+
readonly date_created: {
|
|
1293
2229
|
readonly type: "string";
|
|
1294
|
-
readonly
|
|
1295
|
-
readonly
|
|
2230
|
+
readonly format: "date-time";
|
|
2231
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2232
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1296
2233
|
};
|
|
1297
2234
|
};
|
|
1298
|
-
readonly required: readonly ["id", "
|
|
2235
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
1299
2236
|
readonly additionalProperties: false;
|
|
1300
2237
|
};
|
|
1301
|
-
export declare const
|
|
2238
|
+
export declare const TicketSchema: {
|
|
1302
2239
|
readonly type: "object";
|
|
1303
2240
|
readonly properties: {
|
|
1304
2241
|
readonly id: {
|
|
1305
2242
|
readonly type: "string";
|
|
1306
|
-
readonly
|
|
1307
|
-
readonly
|
|
1308
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
2243
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
2244
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
1309
2245
|
};
|
|
1310
|
-
readonly
|
|
1311
|
-
readonly type: "
|
|
1312
|
-
readonly description: "
|
|
1313
|
-
readonly example:
|
|
2246
|
+
readonly status: {
|
|
2247
|
+
readonly type: "string";
|
|
2248
|
+
readonly description: "Current state of the ticket.";
|
|
2249
|
+
readonly example: "waiting_on_us";
|
|
2250
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
1314
2251
|
};
|
|
1315
|
-
readonly
|
|
2252
|
+
readonly category: {
|
|
1316
2253
|
readonly type: "string";
|
|
1317
|
-
readonly
|
|
1318
|
-
readonly
|
|
1319
|
-
readonly
|
|
1320
|
-
readonly enum: readonly ["card"];
|
|
2254
|
+
readonly description: "Ticket category.";
|
|
2255
|
+
readonly example: "technical";
|
|
2256
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
1321
2257
|
};
|
|
1322
|
-
readonly
|
|
2258
|
+
readonly summary: {
|
|
1323
2259
|
readonly type: "string";
|
|
1324
|
-
readonly
|
|
1325
|
-
readonly
|
|
1326
|
-
readonly example: "4242";
|
|
2260
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
2261
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1327
2262
|
};
|
|
1328
|
-
readonly
|
|
1329
|
-
readonly type: "
|
|
1330
|
-
readonly
|
|
1331
|
-
readonly
|
|
1332
|
-
readonly
|
|
1333
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1334
|
-
readonly example: "12";
|
|
2263
|
+
readonly closed_at: {
|
|
2264
|
+
readonly type: "string";
|
|
2265
|
+
readonly format: "date-time";
|
|
2266
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2267
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1335
2268
|
};
|
|
1336
|
-
readonly
|
|
1337
|
-
readonly type: "
|
|
1338
|
-
readonly
|
|
1339
|
-
readonly
|
|
1340
|
-
readonly
|
|
1341
|
-
readonly example: "2028";
|
|
2269
|
+
readonly date_created: {
|
|
2270
|
+
readonly type: "string";
|
|
2271
|
+
readonly format: "date-time";
|
|
2272
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
2273
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1342
2274
|
};
|
|
1343
|
-
readonly
|
|
2275
|
+
readonly date_updated: {
|
|
1344
2276
|
readonly type: "string";
|
|
1345
|
-
readonly
|
|
1346
|
-
readonly description: "
|
|
1347
|
-
readonly example: "
|
|
1348
|
-
|
|
2277
|
+
readonly format: "date-time";
|
|
2278
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2279
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2280
|
+
};
|
|
2281
|
+
readonly messages: {
|
|
2282
|
+
readonly type: "array";
|
|
2283
|
+
readonly items: {
|
|
2284
|
+
readonly type: "object";
|
|
2285
|
+
readonly properties: {
|
|
2286
|
+
readonly id: {
|
|
2287
|
+
readonly type: "string";
|
|
2288
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2289
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2290
|
+
};
|
|
2291
|
+
readonly type: {
|
|
2292
|
+
readonly type: "string";
|
|
2293
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2294
|
+
readonly example: "customer_reply";
|
|
2295
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2296
|
+
};
|
|
2297
|
+
readonly body: {
|
|
2298
|
+
readonly type: "string";
|
|
2299
|
+
readonly description: "Message body in markdown.";
|
|
2300
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2301
|
+
};
|
|
2302
|
+
readonly author_first_name: {
|
|
2303
|
+
readonly type: "string";
|
|
2304
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2305
|
+
readonly example: "Jane";
|
|
2306
|
+
};
|
|
2307
|
+
readonly author_last_name: {
|
|
2308
|
+
readonly type: "string";
|
|
2309
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2310
|
+
readonly example: "Doe";
|
|
2311
|
+
};
|
|
2312
|
+
readonly attachments: {
|
|
2313
|
+
readonly type: "array";
|
|
2314
|
+
readonly items: {
|
|
2315
|
+
readonly type: "object";
|
|
2316
|
+
readonly properties: {
|
|
2317
|
+
readonly id: {
|
|
2318
|
+
readonly type: "string";
|
|
2319
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2320
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2321
|
+
};
|
|
2322
|
+
readonly filename: {
|
|
2323
|
+
readonly type: "string";
|
|
2324
|
+
readonly description: "Original filename as uploaded.";
|
|
2325
|
+
readonly example: "debug.log";
|
|
2326
|
+
};
|
|
2327
|
+
readonly content_type: {
|
|
2328
|
+
readonly type: "string";
|
|
2329
|
+
readonly description: "MIME content type of the attachment.";
|
|
2330
|
+
readonly example: "text/plain";
|
|
2331
|
+
};
|
|
2332
|
+
readonly size: {
|
|
2333
|
+
readonly type: "integer";
|
|
2334
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2335
|
+
readonly example: 12345;
|
|
2336
|
+
};
|
|
2337
|
+
};
|
|
2338
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2339
|
+
readonly additionalProperties: false;
|
|
2340
|
+
};
|
|
2341
|
+
readonly description: "Attachments associated with this message.";
|
|
2342
|
+
readonly example: readonly [];
|
|
2343
|
+
};
|
|
2344
|
+
readonly date_created: {
|
|
2345
|
+
readonly type: "string";
|
|
2346
|
+
readonly format: "date-time";
|
|
2347
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2348
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2349
|
+
};
|
|
2350
|
+
};
|
|
2351
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2352
|
+
readonly additionalProperties: false;
|
|
2353
|
+
};
|
|
2354
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
1349
2355
|
};
|
|
1350
2356
|
};
|
|
1351
|
-
readonly required: readonly ["id", "
|
|
2357
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1352
2358
|
readonly additionalProperties: false;
|
|
1353
2359
|
};
|
|
1354
2360
|
export declare const TokenCreateInputSchema: {
|
|
@@ -1429,6 +2435,101 @@ export declare const TokenUpdateInputSchema: {
|
|
|
1429
2435
|
};
|
|
1430
2436
|
readonly additionalProperties: false;
|
|
1431
2437
|
};
|
|
2438
|
+
export declare const UsageFacetsSchema: {
|
|
2439
|
+
readonly type: "object";
|
|
2440
|
+
readonly properties: {
|
|
2441
|
+
readonly cluster_id: {
|
|
2442
|
+
readonly type: "array";
|
|
2443
|
+
readonly items: {
|
|
2444
|
+
readonly type: "string";
|
|
2445
|
+
};
|
|
2446
|
+
readonly description: "List of unique cluster IDs";
|
|
2447
|
+
readonly example: readonly ["6b5439b1-923a-4f2b-a371-d554e5ea23fa"];
|
|
2448
|
+
};
|
|
2449
|
+
readonly product: {
|
|
2450
|
+
readonly type: "array";
|
|
2451
|
+
readonly items: {
|
|
2452
|
+
readonly type: "string";
|
|
2453
|
+
};
|
|
2454
|
+
readonly description: "List of unique products";
|
|
2455
|
+
readonly example: readonly ["cfke_controlplane", "cfke_connected_nodes"];
|
|
2456
|
+
};
|
|
2457
|
+
};
|
|
2458
|
+
readonly additionalProperties: false;
|
|
2459
|
+
};
|
|
2460
|
+
export declare const UsageResponseSchema: {
|
|
2461
|
+
readonly type: "object";
|
|
2462
|
+
readonly properties: {
|
|
2463
|
+
readonly data: {
|
|
2464
|
+
readonly type: "array";
|
|
2465
|
+
readonly items: {
|
|
2466
|
+
readonly type: "object";
|
|
2467
|
+
readonly properties: {
|
|
2468
|
+
readonly hour: {
|
|
2469
|
+
readonly type: "string";
|
|
2470
|
+
readonly description: "Hour of the usage";
|
|
2471
|
+
readonly example: "2019-01-01T00:00:00.000Z";
|
|
2472
|
+
};
|
|
2473
|
+
readonly cluster_id: {
|
|
2474
|
+
readonly type: "string";
|
|
2475
|
+
readonly description: "Unique identifier of the kubernetes cluster. UUID v4 string in canonical form";
|
|
2476
|
+
readonly example: "6b5439b1-923a-4f2b-a371-d554e5ea23fa";
|
|
2477
|
+
};
|
|
2478
|
+
readonly product: {
|
|
2479
|
+
readonly type: "string";
|
|
2480
|
+
readonly description: "The product the usage is associated with";
|
|
2481
|
+
readonly example: "cfke_controlplane";
|
|
2482
|
+
};
|
|
2483
|
+
readonly value: {
|
|
2484
|
+
readonly type: "number";
|
|
2485
|
+
readonly format: "float";
|
|
2486
|
+
readonly description: "Consumption";
|
|
2487
|
+
readonly example: 4;
|
|
2488
|
+
};
|
|
2489
|
+
readonly price: {
|
|
2490
|
+
readonly type: "number";
|
|
2491
|
+
readonly format: "float";
|
|
2492
|
+
readonly description: "Price per unit";
|
|
2493
|
+
readonly example: 0.01;
|
|
2494
|
+
};
|
|
2495
|
+
readonly total: {
|
|
2496
|
+
readonly type: "number";
|
|
2497
|
+
readonly format: "float";
|
|
2498
|
+
readonly description: "Total cost";
|
|
2499
|
+
};
|
|
2500
|
+
};
|
|
2501
|
+
readonly required: readonly ["hour", "cluster_id", "product", "value", "price", "total"];
|
|
2502
|
+
readonly additionalProperties: false;
|
|
2503
|
+
};
|
|
2504
|
+
readonly description: "Usage data";
|
|
2505
|
+
};
|
|
2506
|
+
readonly facets: {
|
|
2507
|
+
readonly type: "object";
|
|
2508
|
+
readonly properties: {
|
|
2509
|
+
readonly cluster_id: {
|
|
2510
|
+
readonly type: "array";
|
|
2511
|
+
readonly items: {
|
|
2512
|
+
readonly type: "string";
|
|
2513
|
+
};
|
|
2514
|
+
readonly description: "List of unique cluster IDs";
|
|
2515
|
+
readonly example: readonly ["6b5439b1-923a-4f2b-a371-d554e5ea23fa"];
|
|
2516
|
+
};
|
|
2517
|
+
readonly product: {
|
|
2518
|
+
readonly type: "array";
|
|
2519
|
+
readonly items: {
|
|
2520
|
+
readonly type: "string";
|
|
2521
|
+
};
|
|
2522
|
+
readonly description: "List of unique products";
|
|
2523
|
+
readonly example: readonly ["cfke_controlplane", "cfke_connected_nodes"];
|
|
2524
|
+
};
|
|
2525
|
+
};
|
|
2526
|
+
readonly additionalProperties: false;
|
|
2527
|
+
readonly description: "Facets for filtering";
|
|
2528
|
+
};
|
|
2529
|
+
};
|
|
2530
|
+
readonly required: readonly ["data", "facets"];
|
|
2531
|
+
readonly additionalProperties: false;
|
|
2532
|
+
};
|
|
1432
2533
|
export declare const UsageSchema: {
|
|
1433
2534
|
readonly type: "object";
|
|
1434
2535
|
readonly properties: {
|
|
@@ -1439,78 +2540,33 @@ export declare const UsageSchema: {
|
|
|
1439
2540
|
};
|
|
1440
2541
|
readonly cluster_id: {
|
|
1441
2542
|
readonly type: "string";
|
|
1442
|
-
readonly format: "uuid";
|
|
1443
2543
|
readonly description: "Unique identifier of the kubernetes cluster. UUID v4 string in canonical form";
|
|
1444
2544
|
readonly example: "6b5439b1-923a-4f2b-a371-d554e5ea23fa";
|
|
1445
2545
|
};
|
|
1446
|
-
readonly cluster_tier: {
|
|
1447
|
-
readonly type: "string";
|
|
1448
|
-
readonly description: "Tier of the cluster.";
|
|
1449
|
-
readonly example: "pro";
|
|
1450
|
-
readonly enum: readonly ["basic", "pro", ""];
|
|
1451
|
-
};
|
|
1452
2546
|
readonly product: {
|
|
1453
2547
|
readonly type: "string";
|
|
1454
2548
|
readonly description: "The product the usage is associated with";
|
|
1455
2549
|
readonly example: "cfke_controlplane";
|
|
1456
|
-
readonly enum: readonly ["cfke_controlplane", "cfke_connected_nodes", "infra_compute", "infra_storage", "infra_loadbalancing", "infra_traffic", "cfcr_storage"];
|
|
1457
|
-
};
|
|
1458
|
-
readonly node_name: {
|
|
1459
|
-
readonly type: "string";
|
|
1460
|
-
readonly description: "Name of the Kubernetes node";
|
|
1461
|
-
readonly example: "flexible-moth-956037384";
|
|
1462
|
-
};
|
|
1463
|
-
readonly sku: {
|
|
1464
|
-
readonly type: "string";
|
|
1465
|
-
readonly description: "SKU of the Kubernetes node";
|
|
1466
|
-
readonly example: "GCP-NORTHAMERICA-NORTHEAST1-A-G1-SMALL-SPOT";
|
|
1467
2550
|
};
|
|
1468
|
-
readonly
|
|
1469
|
-
readonly
|
|
1470
|
-
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
readonly example: 4;
|
|
1474
|
-
}, {
|
|
1475
|
-
readonly type: "string";
|
|
1476
|
-
readonly enum: readonly [""];
|
|
1477
|
-
}];
|
|
2551
|
+
readonly value: {
|
|
2552
|
+
readonly type: "number";
|
|
2553
|
+
readonly format: "float";
|
|
2554
|
+
readonly description: "Consumption";
|
|
2555
|
+
readonly example: 4;
|
|
1478
2556
|
};
|
|
1479
2557
|
readonly price: {
|
|
1480
|
-
readonly
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
-
|
|
1484
|
-
readonly example: 4;
|
|
1485
|
-
}, {
|
|
1486
|
-
readonly type: "string";
|
|
1487
|
-
readonly enum: readonly [""];
|
|
1488
|
-
}];
|
|
1489
|
-
};
|
|
1490
|
-
readonly value: {
|
|
1491
|
-
readonly anyOf: readonly [{
|
|
1492
|
-
readonly type: "number";
|
|
1493
|
-
readonly format: "float";
|
|
1494
|
-
readonly description: "Value";
|
|
1495
|
-
readonly example: 4;
|
|
1496
|
-
}, {
|
|
1497
|
-
readonly type: "string";
|
|
1498
|
-
readonly enum: readonly [""];
|
|
1499
|
-
}];
|
|
2558
|
+
readonly type: "number";
|
|
2559
|
+
readonly format: "float";
|
|
2560
|
+
readonly description: "Price per unit";
|
|
2561
|
+
readonly example: 0.01;
|
|
1500
2562
|
};
|
|
1501
2563
|
readonly total: {
|
|
1502
|
-
readonly
|
|
1503
|
-
|
|
1504
|
-
|
|
1505
|
-
readonly description: "Total";
|
|
1506
|
-
readonly example: 4;
|
|
1507
|
-
}, {
|
|
1508
|
-
readonly type: "string";
|
|
1509
|
-
readonly enum: readonly [""];
|
|
1510
|
-
}];
|
|
2564
|
+
readonly type: "number";
|
|
2565
|
+
readonly format: "float";
|
|
2566
|
+
readonly description: "Total cost";
|
|
1511
2567
|
};
|
|
1512
2568
|
};
|
|
1513
|
-
readonly required: readonly ["
|
|
2569
|
+
readonly required: readonly ["hour", "cluster_id", "product", "value", "price", "total"];
|
|
1514
2570
|
readonly additionalProperties: false;
|
|
1515
2571
|
};
|
|
1516
2572
|
export declare const UserCreateInputSchema: {
|
|
@@ -1547,18 +2603,6 @@ export declare const UserCreateInputSchema: {
|
|
|
1547
2603
|
readonly minLength: 8;
|
|
1548
2604
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
1549
2605
|
};
|
|
1550
|
-
readonly status: {
|
|
1551
|
-
readonly type: "string";
|
|
1552
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
1553
|
-
readonly example: "active";
|
|
1554
|
-
readonly enum: readonly ["active", "inactive"];
|
|
1555
|
-
};
|
|
1556
|
-
readonly role: {
|
|
1557
|
-
readonly type: "string";
|
|
1558
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
1559
|
-
readonly example: "User";
|
|
1560
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
1561
|
-
};
|
|
1562
2606
|
};
|
|
1563
2607
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
1564
2608
|
readonly additionalProperties: false;
|