@cloudfleet/sdk 0.0.1-bbb5ebb → 0.0.1-bbca6e3
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/dist/@tanstack/react-query.gen.d.ts +1151 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1167 -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 +220 -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 +1636 -639
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +2875 -672
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +259 -72
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +357 -159
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +20 -20
- package/dist/types.gen.d.ts +1501 -352
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3667 -1927
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1542 -785
- package/dist/zod.gen.js.map +1 -1
- package/package.json +29 -7
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,18 +63,202 @@ 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
|
|
66
|
+
readonly individual_name: {
|
|
61
67
|
readonly type: "string";
|
|
62
|
-
readonly description: "
|
|
63
|
-
readonly example: "John";
|
|
68
|
+
readonly description: "Name of the billing contact person.";
|
|
69
|
+
readonly example: "John Doe";
|
|
64
70
|
};
|
|
65
|
-
readonly
|
|
71
|
+
readonly tax_id: {
|
|
66
72
|
readonly type: "string";
|
|
67
|
-
readonly
|
|
68
|
-
readonly
|
|
73
|
+
readonly nullable: true;
|
|
74
|
+
readonly description: "Tax ID of the organization.";
|
|
75
|
+
readonly example: "DE123456789";
|
|
76
|
+
};
|
|
77
|
+
readonly tax_id_type: {
|
|
78
|
+
readonly type: "string";
|
|
79
|
+
readonly nullable: true;
|
|
80
|
+
readonly description: "Type of the tax ID.";
|
|
81
|
+
readonly example: "de_vat";
|
|
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", ""];
|
|
83
|
+
};
|
|
84
|
+
};
|
|
85
|
+
readonly required: readonly ["type", "email", "individual_name"];
|
|
86
|
+
readonly additionalProperties: false;
|
|
87
|
+
};
|
|
88
|
+
export declare const BillingCreditsSchema: {
|
|
89
|
+
readonly type: "object";
|
|
90
|
+
readonly properties: {
|
|
91
|
+
readonly id: {
|
|
92
|
+
readonly type: "string";
|
|
93
|
+
readonly description: "Generated unique identifier of the promotional code.";
|
|
94
|
+
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
95
|
+
};
|
|
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: {
|
|
109
|
+
readonly type: "string";
|
|
110
|
+
readonly format: "date-time";
|
|
111
|
+
readonly description: "Timestamp when the credit expires or becomes inactive. ISO 8601 date string in the UTC timezone.";
|
|
112
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
113
|
+
};
|
|
114
|
+
readonly code: {
|
|
115
|
+
readonly type: "string";
|
|
116
|
+
readonly description: "Promotional code used by the customer.";
|
|
117
|
+
readonly example: "VQ4SCMB";
|
|
118
|
+
};
|
|
119
|
+
readonly description: {
|
|
120
|
+
readonly type: "string";
|
|
121
|
+
readonly description: "Description of the promotional code.";
|
|
122
|
+
readonly example: "10% off on all products";
|
|
123
|
+
};
|
|
124
|
+
readonly value_total: {
|
|
125
|
+
readonly type: "number";
|
|
126
|
+
readonly format: "float";
|
|
127
|
+
readonly description: "Total value of the promotional code.";
|
|
128
|
+
readonly example: 10;
|
|
129
|
+
};
|
|
130
|
+
readonly value_remaining: {
|
|
131
|
+
readonly type: "number";
|
|
132
|
+
readonly format: "float";
|
|
133
|
+
readonly description: "Remaining value of the promotional code.";
|
|
134
|
+
readonly example: 8;
|
|
135
|
+
};
|
|
136
|
+
};
|
|
137
|
+
readonly required: readonly ["type", "date_start", "code", "value_total"];
|
|
138
|
+
readonly additionalProperties: false;
|
|
139
|
+
};
|
|
140
|
+
export declare const ChartCreateInputSchema: {
|
|
141
|
+
readonly type: "object";
|
|
142
|
+
readonly properties: {
|
|
143
|
+
readonly values: {
|
|
144
|
+
readonly type: "string";
|
|
145
|
+
readonly description: "Values to be used in the chart encoded as a JSON string.";
|
|
146
|
+
};
|
|
147
|
+
readonly version_channel: {
|
|
148
|
+
readonly type: "string";
|
|
149
|
+
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-]+)*))?$";
|
|
150
|
+
readonly description: "Desired version range or channel for the chart.";
|
|
151
|
+
readonly example: "2.x.x-cfke.x";
|
|
152
|
+
};
|
|
153
|
+
readonly name: {
|
|
154
|
+
readonly type: "string";
|
|
155
|
+
readonly maxLength: 63;
|
|
156
|
+
readonly minLength: 1;
|
|
157
|
+
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
158
|
+
readonly description: "Unique identifier of the chart deployment aka name of the helm release.";
|
|
159
|
+
readonly example: "postgresql-0";
|
|
160
|
+
};
|
|
161
|
+
readonly namespace: {
|
|
162
|
+
readonly type: "string";
|
|
163
|
+
readonly maxLength: 63;
|
|
164
|
+
readonly minLength: 1;
|
|
165
|
+
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
166
|
+
readonly description: "Namespace of the chart deployment";
|
|
167
|
+
readonly example: "default";
|
|
168
|
+
};
|
|
169
|
+
readonly chart: {
|
|
170
|
+
readonly type: "string";
|
|
171
|
+
readonly maxLength: 63;
|
|
172
|
+
readonly minLength: 1;
|
|
173
|
+
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
174
|
+
readonly description: "Name of the chart listing";
|
|
175
|
+
readonly example: "postgresql";
|
|
176
|
+
};
|
|
177
|
+
};
|
|
178
|
+
readonly required: readonly ["values", "version_channel", "name", "namespace", "chart"];
|
|
179
|
+
readonly additionalProperties: false;
|
|
180
|
+
};
|
|
181
|
+
export declare const ChartSchema: {
|
|
182
|
+
readonly type: "object";
|
|
183
|
+
readonly properties: {
|
|
184
|
+
readonly values: {
|
|
185
|
+
readonly type: "string";
|
|
186
|
+
readonly description: "Values to be used in the chart encoded as a JSON string.";
|
|
187
|
+
};
|
|
188
|
+
readonly version_channel: {
|
|
189
|
+
readonly type: "string";
|
|
190
|
+
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-]+)*))?$";
|
|
191
|
+
readonly description: "Desired version range or channel for the chart.";
|
|
192
|
+
readonly example: "2.x.x-cfke.x";
|
|
193
|
+
};
|
|
194
|
+
readonly name: {
|
|
195
|
+
readonly type: "string";
|
|
196
|
+
readonly maxLength: 63;
|
|
197
|
+
readonly minLength: 1;
|
|
198
|
+
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
199
|
+
readonly description: "Unique identifier of the chart deployment aka name of the helm release.";
|
|
200
|
+
readonly example: "postgresql-0";
|
|
201
|
+
};
|
|
202
|
+
readonly namespace: {
|
|
203
|
+
readonly type: "string";
|
|
204
|
+
readonly maxLength: 63;
|
|
205
|
+
readonly minLength: 1;
|
|
206
|
+
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
207
|
+
readonly description: "Namespace of the chart deployment";
|
|
208
|
+
readonly example: "default";
|
|
209
|
+
};
|
|
210
|
+
readonly chart: {
|
|
211
|
+
readonly type: "string";
|
|
212
|
+
readonly maxLength: 63;
|
|
213
|
+
readonly minLength: 1;
|
|
214
|
+
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
215
|
+
readonly description: "Name of the chart listing";
|
|
216
|
+
readonly example: "postgresql";
|
|
217
|
+
};
|
|
218
|
+
readonly status: {
|
|
219
|
+
readonly type: "string";
|
|
220
|
+
readonly description: "Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).";
|
|
221
|
+
readonly example: "InstallSucceeded";
|
|
222
|
+
};
|
|
223
|
+
readonly version_current: {
|
|
224
|
+
readonly type: "string";
|
|
225
|
+
readonly description: "Current version of the chart deployment.";
|
|
226
|
+
readonly example: "2.1.33-cfke.11";
|
|
227
|
+
};
|
|
228
|
+
readonly created_at: {
|
|
229
|
+
readonly type: "string";
|
|
230
|
+
readonly description: "Creation date and time of the chart deployment.";
|
|
231
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
232
|
+
};
|
|
233
|
+
readonly updated_at: {
|
|
234
|
+
readonly type: "string";
|
|
235
|
+
readonly description: "Last update date and time of the chart deployment.";
|
|
236
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
237
|
+
};
|
|
238
|
+
readonly ready: {
|
|
239
|
+
readonly type: "boolean";
|
|
240
|
+
readonly description: "Indicates if the chart deployment is ready to be used.";
|
|
241
|
+
readonly example: true;
|
|
242
|
+
};
|
|
243
|
+
};
|
|
244
|
+
readonly required: readonly ["values", "version_channel", "name", "namespace", "chart", "status", "version_current", "created_at", "updated_at", "ready"];
|
|
245
|
+
readonly additionalProperties: false;
|
|
246
|
+
};
|
|
247
|
+
export declare const ChartUpdateInputSchema: {
|
|
248
|
+
readonly type: "object";
|
|
249
|
+
readonly properties: {
|
|
250
|
+
readonly values: {
|
|
251
|
+
readonly type: "string";
|
|
252
|
+
readonly description: "Values to be used in the chart encoded as a JSON string.";
|
|
253
|
+
};
|
|
254
|
+
readonly version_channel: {
|
|
255
|
+
readonly type: "string";
|
|
256
|
+
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-]+)*))?$";
|
|
257
|
+
readonly description: "Desired version range or channel for the chart.";
|
|
258
|
+
readonly example: "2.x.x-cfke.x";
|
|
69
259
|
};
|
|
70
260
|
};
|
|
71
|
-
readonly required: readonly ["
|
|
261
|
+
readonly required: readonly ["values", "version_channel"];
|
|
72
262
|
readonly additionalProperties: false;
|
|
73
263
|
};
|
|
74
264
|
export declare const ClusterCreateInputSchema: {
|
|
@@ -82,28 +272,26 @@ export declare const ClusterCreateInputSchema: {
|
|
|
82
272
|
readonly description: "Name of the cluster.";
|
|
83
273
|
readonly example: "production-cluster";
|
|
84
274
|
};
|
|
85
|
-
readonly region: {
|
|
86
|
-
readonly type: "string";
|
|
87
|
-
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\". This field can not be updated after creation.";
|
|
88
|
-
readonly default: "staging";
|
|
89
|
-
readonly example: "northamerica-central-1";
|
|
90
|
-
readonly enum: readonly ["staging", "northamerica-central-1"];
|
|
91
|
-
};
|
|
92
275
|
readonly tier: {
|
|
93
276
|
readonly type: "string";
|
|
94
277
|
readonly description: "Tier of the cluster.";
|
|
95
278
|
readonly example: "pro";
|
|
96
279
|
readonly enum: readonly ["basic", "pro"];
|
|
97
280
|
};
|
|
281
|
+
readonly region: {
|
|
282
|
+
readonly type: "string";
|
|
283
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
284
|
+
readonly example: "europe-central-1a";
|
|
285
|
+
};
|
|
98
286
|
readonly version_channel: {
|
|
99
287
|
readonly type: "string";
|
|
100
288
|
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-]+)*))?$";
|
|
101
289
|
readonly description: "Version of the kubernetes cluster.";
|
|
102
290
|
readonly default: "1.x.x-cfke.x";
|
|
103
|
-
readonly example: "1.
|
|
291
|
+
readonly example: "1.x.x-cfke.x";
|
|
104
292
|
};
|
|
105
293
|
};
|
|
106
|
-
readonly required: readonly ["name", "tier"];
|
|
294
|
+
readonly required: readonly ["name", "tier", "region"];
|
|
107
295
|
readonly additionalProperties: false;
|
|
108
296
|
};
|
|
109
297
|
export declare const ClusterJoinInformationSchema: {
|
|
@@ -120,6 +308,16 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
120
308
|
readonly description: "Internal URL of the Kubernetes cluster control plane. This is the endpoint that kubelet uses to connect to the cluster.";
|
|
121
309
|
readonly example: "https://10.31.64.7:6443";
|
|
122
310
|
};
|
|
311
|
+
readonly cluster_dns: {
|
|
312
|
+
readonly type: "string";
|
|
313
|
+
readonly description: "Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.";
|
|
314
|
+
readonly example: "10.96.0.10";
|
|
315
|
+
};
|
|
316
|
+
readonly pod_cidr: {
|
|
317
|
+
readonly type: "string";
|
|
318
|
+
readonly description: "Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.";
|
|
319
|
+
readonly example: "10.244.0.0/16";
|
|
320
|
+
};
|
|
123
321
|
readonly auth_key: {
|
|
124
322
|
readonly type: "string";
|
|
125
323
|
readonly description: "Authentication key for the cluster.";
|
|
@@ -136,7 +334,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
136
334
|
readonly kubernetes: {
|
|
137
335
|
readonly type: "string";
|
|
138
336
|
readonly description: "Kubernetes version of the cluster.";
|
|
139
|
-
readonly example: "1.
|
|
337
|
+
readonly example: "1.33.7";
|
|
140
338
|
};
|
|
141
339
|
readonly tailscale: {
|
|
142
340
|
readonly type: "string";
|
|
@@ -148,8 +346,13 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
148
346
|
readonly description: "Containerd version of the cluster.";
|
|
149
347
|
readonly example: "1.7.19";
|
|
150
348
|
};
|
|
349
|
+
readonly nvidia_driver: {
|
|
350
|
+
readonly type: "string";
|
|
351
|
+
readonly description: "NVIDIA driver version of the cluster.";
|
|
352
|
+
readonly example: "565.0.0";
|
|
353
|
+
};
|
|
151
354
|
};
|
|
152
|
-
readonly required: readonly ["kubernetes", "tailscale", "containerd"];
|
|
355
|
+
readonly required: readonly ["kubernetes", "tailscale", "containerd", "nvidia_driver"];
|
|
153
356
|
readonly additionalProperties: false;
|
|
154
357
|
readonly description: "Versions of the different components of the cluster.";
|
|
155
358
|
};
|
|
@@ -177,7 +380,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
177
380
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
178
381
|
};
|
|
179
382
|
};
|
|
180
|
-
readonly required: readonly ["certificate_authority", "endpoint", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
383
|
+
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "pod_cidr", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
181
384
|
readonly additionalProperties: false;
|
|
182
385
|
};
|
|
183
386
|
export declare const ClusterSchema: {
|
|
@@ -191,25 +394,16 @@ export declare const ClusterSchema: {
|
|
|
191
394
|
readonly description: "Name of the cluster.";
|
|
192
395
|
readonly example: "production-cluster";
|
|
193
396
|
};
|
|
194
|
-
readonly region: {
|
|
195
|
-
readonly type: "string";
|
|
196
|
-
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\". This field can not be updated after creation.";
|
|
197
|
-
readonly default: "staging";
|
|
198
|
-
readonly example: "northamerica-central-1";
|
|
199
|
-
readonly enum: readonly ["staging", "northamerica-central-1"];
|
|
200
|
-
};
|
|
201
397
|
readonly tier: {
|
|
202
398
|
readonly type: "string";
|
|
203
399
|
readonly description: "Tier of the cluster.";
|
|
204
400
|
readonly example: "pro";
|
|
205
401
|
readonly enum: readonly ["basic", "pro"];
|
|
206
402
|
};
|
|
207
|
-
readonly
|
|
403
|
+
readonly region: {
|
|
208
404
|
readonly type: "string";
|
|
209
|
-
readonly
|
|
210
|
-
readonly
|
|
211
|
-
readonly default: "1.x.x-cfke.x";
|
|
212
|
-
readonly example: "1.29.x-cfke.x";
|
|
405
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
406
|
+
readonly example: "europe-central-1a";
|
|
213
407
|
};
|
|
214
408
|
readonly id: {
|
|
215
409
|
readonly type: "string";
|
|
@@ -221,19 +415,30 @@ export declare const ClusterSchema: {
|
|
|
221
415
|
readonly type: "string";
|
|
222
416
|
readonly description: "Status of the cluster. When creating a new cluster, set to `active`. When deleting a clusters, set to `deleted`.";
|
|
223
417
|
readonly example: "active";
|
|
224
|
-
readonly enum: readonly ["active", "deleted", "creating", "deployed", "failed", "updating"];
|
|
418
|
+
readonly enum: readonly ["active", "disabled", "deleted", "creating", "deployed", "failed", "updating"];
|
|
225
419
|
};
|
|
226
420
|
readonly endpoint: {
|
|
227
421
|
readonly anyOf: readonly [{
|
|
228
422
|
readonly type: "string";
|
|
229
423
|
readonly format: "uri";
|
|
230
|
-
readonly description: "URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
424
|
+
readonly description: "URL signed by the private CA of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster. (Deprecated, use endpoint_public instead)";
|
|
231
425
|
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.cloudfleet.dev:6443";
|
|
232
426
|
}, {
|
|
233
427
|
readonly type: "string";
|
|
234
428
|
readonly enum: readonly [""];
|
|
235
429
|
}];
|
|
236
430
|
};
|
|
431
|
+
readonly endpoint_public: {
|
|
432
|
+
readonly anyOf: readonly [{
|
|
433
|
+
readonly type: "string";
|
|
434
|
+
readonly format: "uri";
|
|
435
|
+
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.";
|
|
436
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
437
|
+
}, {
|
|
438
|
+
readonly type: "string";
|
|
439
|
+
readonly enum: readonly [""];
|
|
440
|
+
}];
|
|
441
|
+
};
|
|
237
442
|
readonly certificate_ca: {
|
|
238
443
|
readonly type: "string";
|
|
239
444
|
readonly description: "Certificate authority data for the kubernetes cluster. This is the root certificate authority for the cluster.";
|
|
@@ -242,7 +447,7 @@ export declare const ClusterSchema: {
|
|
|
242
447
|
readonly version_current: {
|
|
243
448
|
readonly type: "string";
|
|
244
449
|
readonly description: "Current version of the cluster.";
|
|
245
|
-
readonly example: "1.
|
|
450
|
+
readonly example: "1.33.7-cfke.264";
|
|
246
451
|
};
|
|
247
452
|
readonly created_at: {
|
|
248
453
|
readonly type: "string";
|
|
@@ -259,8 +464,14 @@ export declare const ClusterSchema: {
|
|
|
259
464
|
readonly description: "Indicates if the cluster is ready to be used.";
|
|
260
465
|
readonly example: true;
|
|
261
466
|
};
|
|
467
|
+
readonly version_channel: {
|
|
468
|
+
readonly type: "string";
|
|
469
|
+
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-]+)*))?$";
|
|
470
|
+
readonly description: "Version of the kubernetes cluster.";
|
|
471
|
+
readonly example: "1.x.x-cfke.x";
|
|
472
|
+
};
|
|
262
473
|
};
|
|
263
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
474
|
+
readonly required: readonly ["name", "tier", "region", "id", "status"];
|
|
264
475
|
readonly additionalProperties: false;
|
|
265
476
|
};
|
|
266
477
|
export declare const ClusterUpdateInputSchema: {
|
|
@@ -274,13 +485,20 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
274
485
|
readonly description: "Name of the cluster.";
|
|
275
486
|
readonly example: "production-cluster";
|
|
276
487
|
};
|
|
488
|
+
readonly tier: {
|
|
489
|
+
readonly type: "string";
|
|
490
|
+
readonly description: "Tier of the cluster.";
|
|
491
|
+
readonly example: "pro";
|
|
492
|
+
readonly enum: readonly ["basic", "pro"];
|
|
493
|
+
};
|
|
277
494
|
readonly version_channel: {
|
|
278
495
|
readonly type: "string";
|
|
279
496
|
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-]+)*))?$";
|
|
280
497
|
readonly description: "Version of the kubernetes cluster.";
|
|
281
|
-
readonly example: "1.
|
|
498
|
+
readonly example: "1.x.x-cfke.x";
|
|
282
499
|
};
|
|
283
500
|
};
|
|
501
|
+
readonly required: readonly ["tier"];
|
|
284
502
|
readonly additionalProperties: false;
|
|
285
503
|
};
|
|
286
504
|
export declare const FleetCreateInputSchema: {
|
|
@@ -290,13 +508,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
290
508
|
readonly type: "object";
|
|
291
509
|
readonly properties: {
|
|
292
510
|
readonly cpu: {
|
|
293
|
-
readonly type: "
|
|
294
|
-
readonly format: "float";
|
|
511
|
+
readonly type: "integer";
|
|
295
512
|
readonly minimum: 0;
|
|
296
|
-
readonly
|
|
513
|
+
readonly maximum: 100000;
|
|
514
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
297
515
|
};
|
|
298
516
|
};
|
|
299
|
-
readonly required: readonly ["cpu"];
|
|
300
517
|
readonly additionalProperties: false;
|
|
301
518
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
302
519
|
};
|
|
@@ -305,57 +522,99 @@ export declare const FleetCreateInputSchema: {
|
|
|
305
522
|
readonly properties: {
|
|
306
523
|
readonly enabled: {
|
|
307
524
|
readonly type: "boolean";
|
|
308
|
-
readonly default: true;
|
|
309
525
|
};
|
|
310
526
|
readonly project: {
|
|
311
527
|
readonly type: "string";
|
|
312
|
-
readonly
|
|
528
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
529
|
+
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.";
|
|
530
|
+
readonly example: "my-cloudfleet-project";
|
|
313
531
|
};
|
|
314
532
|
};
|
|
315
|
-
readonly required: readonly ["
|
|
533
|
+
readonly required: readonly ["enabled"];
|
|
316
534
|
readonly additionalProperties: false;
|
|
317
535
|
};
|
|
318
536
|
readonly hetzner: {
|
|
319
|
-
readonly
|
|
320
|
-
|
|
321
|
-
readonly
|
|
322
|
-
readonly
|
|
323
|
-
readonly type: "boolean";
|
|
324
|
-
readonly default: true;
|
|
325
|
-
};
|
|
326
|
-
readonly apiKey: {
|
|
327
|
-
readonly type: "string";
|
|
328
|
-
};
|
|
537
|
+
readonly type: "object";
|
|
538
|
+
readonly properties: {
|
|
539
|
+
readonly enabled: {
|
|
540
|
+
readonly type: "boolean";
|
|
329
541
|
};
|
|
330
|
-
readonly
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
readonly
|
|
335
|
-
|
|
336
|
-
};
|
|
337
|
-
readonly enabled: {
|
|
338
|
-
readonly type: "boolean";
|
|
339
|
-
readonly default: true;
|
|
340
|
-
};
|
|
542
|
+
readonly apiKey: {
|
|
543
|
+
readonly type: "string";
|
|
544
|
+
readonly maxLength: 64;
|
|
545
|
+
readonly minLength: 64;
|
|
546
|
+
readonly pattern: "^[A-Za-z0-9]+$";
|
|
547
|
+
readonly description: "Hetzner Cloud API token with read / write access (64 alphanumeric characters). Omit this field to keep the existing value.";
|
|
341
548
|
};
|
|
342
|
-
|
|
343
|
-
|
|
549
|
+
};
|
|
550
|
+
readonly required: readonly ["enabled"];
|
|
551
|
+
readonly additionalProperties: false;
|
|
344
552
|
};
|
|
345
553
|
readonly aws: {
|
|
346
554
|
readonly type: "object";
|
|
347
555
|
readonly properties: {
|
|
348
556
|
readonly enabled: {
|
|
349
557
|
readonly type: "boolean";
|
|
350
|
-
readonly default: true;
|
|
351
558
|
};
|
|
352
559
|
readonly controllerRoleArn: {
|
|
353
560
|
readonly type: "string";
|
|
354
|
-
readonly
|
|
561
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
562
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
563
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
564
|
+
};
|
|
565
|
+
};
|
|
566
|
+
readonly required: readonly ["enabled"];
|
|
567
|
+
readonly additionalProperties: false;
|
|
568
|
+
};
|
|
569
|
+
readonly constraints: {
|
|
570
|
+
readonly type: "object";
|
|
571
|
+
readonly properties: {
|
|
572
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
573
|
+
readonly type: "array";
|
|
574
|
+
readonly items: {
|
|
575
|
+
readonly type: "string";
|
|
576
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
577
|
+
};
|
|
578
|
+
readonly minItems: 1;
|
|
579
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
580
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
581
|
+
};
|
|
582
|
+
readonly 'kubernetes.io/arch': {
|
|
583
|
+
readonly type: "array";
|
|
584
|
+
readonly items: {
|
|
585
|
+
readonly type: "string";
|
|
586
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
587
|
+
};
|
|
588
|
+
readonly minItems: 1;
|
|
589
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
590
|
+
readonly default: readonly ["amd64"];
|
|
591
|
+
};
|
|
592
|
+
readonly 'cfke.io/instance-family': {
|
|
593
|
+
readonly type: "array";
|
|
594
|
+
readonly items: {
|
|
595
|
+
readonly type: "string";
|
|
596
|
+
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"];
|
|
597
|
+
};
|
|
598
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
599
|
+
};
|
|
600
|
+
readonly 'topology.kubernetes.io/region': {
|
|
601
|
+
readonly type: "array";
|
|
602
|
+
readonly items: {
|
|
603
|
+
readonly type: "string";
|
|
604
|
+
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"];
|
|
605
|
+
};
|
|
606
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
355
607
|
};
|
|
356
608
|
};
|
|
357
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
358
609
|
readonly additionalProperties: false;
|
|
610
|
+
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. Omit a field to place no restriction on that key.";
|
|
611
|
+
};
|
|
612
|
+
readonly scalingProfile: {
|
|
613
|
+
readonly type: "string";
|
|
614
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
615
|
+
readonly default: "conservative";
|
|
616
|
+
readonly example: "conservative";
|
|
617
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
359
618
|
};
|
|
360
619
|
readonly id: {
|
|
361
620
|
readonly type: "string";
|
|
@@ -365,13 +624,8 @@ export declare const FleetCreateInputSchema: {
|
|
|
365
624
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
366
625
|
readonly example: "new-clouds-fleet";
|
|
367
626
|
};
|
|
368
|
-
readonly type: {
|
|
369
|
-
readonly type: "string";
|
|
370
|
-
readonly description: "Specifies the fleet type: infrastructure managed by Cloudfleet or Connected Fleets.";
|
|
371
|
-
readonly enum: readonly ["managed", "connected"];
|
|
372
|
-
};
|
|
373
627
|
};
|
|
374
|
-
readonly required: readonly ["id"
|
|
628
|
+
readonly required: readonly ["id"];
|
|
375
629
|
readonly additionalProperties: false;
|
|
376
630
|
};
|
|
377
631
|
export declare const FleetSchema: {
|
|
@@ -381,13 +635,12 @@ export declare const FleetSchema: {
|
|
|
381
635
|
readonly type: "object";
|
|
382
636
|
readonly properties: {
|
|
383
637
|
readonly cpu: {
|
|
384
|
-
readonly type: "
|
|
385
|
-
readonly format: "float";
|
|
638
|
+
readonly type: "integer";
|
|
386
639
|
readonly minimum: 0;
|
|
387
|
-
readonly
|
|
640
|
+
readonly maximum: 100000;
|
|
641
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
388
642
|
};
|
|
389
643
|
};
|
|
390
|
-
readonly required: readonly ["cpu"];
|
|
391
644
|
readonly additionalProperties: false;
|
|
392
645
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
393
646
|
};
|
|
@@ -396,73 +649,108 @@ export declare const FleetSchema: {
|
|
|
396
649
|
readonly properties: {
|
|
397
650
|
readonly enabled: {
|
|
398
651
|
readonly type: "boolean";
|
|
399
|
-
readonly default: true;
|
|
400
652
|
};
|
|
401
653
|
readonly project: {
|
|
402
654
|
readonly type: "string";
|
|
403
|
-
readonly
|
|
655
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
656
|
+
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.";
|
|
657
|
+
readonly example: "my-cloudfleet-project";
|
|
404
658
|
};
|
|
405
659
|
};
|
|
406
|
-
readonly required: readonly ["
|
|
660
|
+
readonly required: readonly ["enabled"];
|
|
407
661
|
readonly additionalProperties: false;
|
|
408
662
|
};
|
|
409
663
|
readonly hetzner: {
|
|
410
|
-
readonly
|
|
411
|
-
|
|
412
|
-
readonly
|
|
413
|
-
readonly
|
|
414
|
-
readonly type: "boolean";
|
|
415
|
-
readonly default: true;
|
|
416
|
-
};
|
|
417
|
-
readonly apiKey: {
|
|
418
|
-
readonly type: "string";
|
|
419
|
-
};
|
|
664
|
+
readonly type: "object";
|
|
665
|
+
readonly properties: {
|
|
666
|
+
readonly enabled: {
|
|
667
|
+
readonly type: "boolean";
|
|
420
668
|
};
|
|
421
|
-
readonly
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
readonly apiKey: {
|
|
426
|
-
readonly type: "string";
|
|
427
|
-
};
|
|
428
|
-
readonly enabled: {
|
|
429
|
-
readonly type: "boolean";
|
|
430
|
-
readonly default: true;
|
|
431
|
-
};
|
|
669
|
+
readonly apiKey: {
|
|
670
|
+
readonly type: "string";
|
|
671
|
+
readonly pattern: "^\\*{64}$";
|
|
672
|
+
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.";
|
|
432
673
|
};
|
|
433
|
-
|
|
434
|
-
|
|
674
|
+
};
|
|
675
|
+
readonly required: readonly ["enabled"];
|
|
676
|
+
readonly additionalProperties: false;
|
|
435
677
|
};
|
|
436
678
|
readonly aws: {
|
|
437
679
|
readonly type: "object";
|
|
438
680
|
readonly properties: {
|
|
439
681
|
readonly enabled: {
|
|
440
682
|
readonly type: "boolean";
|
|
441
|
-
readonly default: true;
|
|
442
683
|
};
|
|
443
684
|
readonly controllerRoleArn: {
|
|
444
685
|
readonly type: "string";
|
|
445
|
-
readonly
|
|
686
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
687
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
688
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
446
689
|
};
|
|
447
690
|
};
|
|
448
|
-
readonly required: readonly ["
|
|
691
|
+
readonly required: readonly ["enabled"];
|
|
449
692
|
readonly additionalProperties: false;
|
|
450
693
|
};
|
|
451
|
-
readonly
|
|
452
|
-
readonly type: "
|
|
453
|
-
readonly
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
694
|
+
readonly constraints: {
|
|
695
|
+
readonly type: "object";
|
|
696
|
+
readonly properties: {
|
|
697
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
698
|
+
readonly type: "array";
|
|
699
|
+
readonly items: {
|
|
700
|
+
readonly type: "string";
|
|
701
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
702
|
+
};
|
|
703
|
+
readonly minItems: 1;
|
|
704
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
705
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
706
|
+
};
|
|
707
|
+
readonly 'kubernetes.io/arch': {
|
|
708
|
+
readonly type: "array";
|
|
709
|
+
readonly items: {
|
|
710
|
+
readonly type: "string";
|
|
711
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
712
|
+
};
|
|
713
|
+
readonly minItems: 1;
|
|
714
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
715
|
+
readonly default: readonly ["amd64"];
|
|
716
|
+
};
|
|
717
|
+
readonly 'cfke.io/instance-family': {
|
|
718
|
+
readonly type: "array";
|
|
719
|
+
readonly items: {
|
|
720
|
+
readonly type: "string";
|
|
721
|
+
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"];
|
|
722
|
+
};
|
|
723
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
724
|
+
};
|
|
725
|
+
readonly 'topology.kubernetes.io/region': {
|
|
726
|
+
readonly type: "array";
|
|
727
|
+
readonly items: {
|
|
728
|
+
readonly type: "string";
|
|
729
|
+
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"];
|
|
730
|
+
};
|
|
731
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
732
|
+
};
|
|
733
|
+
};
|
|
734
|
+
readonly additionalProperties: false;
|
|
735
|
+
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. Omit a field to place no restriction on that key.";
|
|
736
|
+
};
|
|
737
|
+
readonly scalingProfile: {
|
|
738
|
+
readonly type: "string";
|
|
739
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
740
|
+
readonly default: "conservative";
|
|
741
|
+
readonly example: "conservative";
|
|
742
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
743
|
+
};
|
|
744
|
+
readonly id: {
|
|
745
|
+
readonly type: "string";
|
|
746
|
+
readonly maxLength: 63;
|
|
747
|
+
readonly minLength: 1;
|
|
748
|
+
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
749
|
+
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
750
|
+
readonly example: "new-clouds-fleet";
|
|
463
751
|
};
|
|
464
752
|
};
|
|
465
|
-
readonly required: readonly ["
|
|
753
|
+
readonly required: readonly ["scalingProfile", "id"];
|
|
466
754
|
readonly additionalProperties: false;
|
|
467
755
|
};
|
|
468
756
|
export declare const FleetUpdateInputSchema: {
|
|
@@ -472,13 +760,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
472
760
|
readonly type: "object";
|
|
473
761
|
readonly properties: {
|
|
474
762
|
readonly cpu: {
|
|
475
|
-
readonly type: "
|
|
476
|
-
readonly format: "float";
|
|
763
|
+
readonly type: "integer";
|
|
477
764
|
readonly minimum: 0;
|
|
478
|
-
readonly
|
|
765
|
+
readonly maximum: 100000;
|
|
766
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
479
767
|
};
|
|
480
768
|
};
|
|
481
|
-
readonly required: readonly ["cpu"];
|
|
482
769
|
readonly additionalProperties: false;
|
|
483
770
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
484
771
|
};
|
|
@@ -487,59 +774,119 @@ export declare const FleetUpdateInputSchema: {
|
|
|
487
774
|
readonly properties: {
|
|
488
775
|
readonly enabled: {
|
|
489
776
|
readonly type: "boolean";
|
|
490
|
-
readonly default: true;
|
|
491
777
|
};
|
|
492
778
|
readonly project: {
|
|
493
779
|
readonly type: "string";
|
|
494
|
-
readonly
|
|
780
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
781
|
+
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.";
|
|
782
|
+
readonly example: "my-cloudfleet-project";
|
|
495
783
|
};
|
|
496
784
|
};
|
|
497
|
-
readonly required: readonly ["
|
|
785
|
+
readonly required: readonly ["enabled"];
|
|
498
786
|
readonly additionalProperties: false;
|
|
499
787
|
};
|
|
500
788
|
readonly hetzner: {
|
|
501
|
-
readonly
|
|
502
|
-
|
|
503
|
-
readonly
|
|
504
|
-
readonly
|
|
505
|
-
readonly type: "boolean";
|
|
506
|
-
readonly default: true;
|
|
507
|
-
};
|
|
508
|
-
readonly apiKey: {
|
|
509
|
-
readonly type: "string";
|
|
510
|
-
};
|
|
789
|
+
readonly type: "object";
|
|
790
|
+
readonly properties: {
|
|
791
|
+
readonly enabled: {
|
|
792
|
+
readonly type: "boolean";
|
|
511
793
|
};
|
|
512
|
-
readonly
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
readonly
|
|
517
|
-
|
|
518
|
-
};
|
|
519
|
-
readonly enabled: {
|
|
520
|
-
readonly type: "boolean";
|
|
521
|
-
readonly default: true;
|
|
522
|
-
};
|
|
794
|
+
readonly apiKey: {
|
|
795
|
+
readonly type: "string";
|
|
796
|
+
readonly maxLength: 64;
|
|
797
|
+
readonly minLength: 64;
|
|
798
|
+
readonly pattern: "^[A-Za-z0-9]+$";
|
|
799
|
+
readonly description: "Hetzner Cloud API token with read / write access (64 alphanumeric characters). Omit this field to keep the existing value.";
|
|
523
800
|
};
|
|
524
|
-
|
|
525
|
-
|
|
801
|
+
};
|
|
802
|
+
readonly required: readonly ["enabled"];
|
|
803
|
+
readonly additionalProperties: false;
|
|
526
804
|
};
|
|
527
805
|
readonly aws: {
|
|
528
806
|
readonly type: "object";
|
|
529
807
|
readonly properties: {
|
|
530
808
|
readonly enabled: {
|
|
531
809
|
readonly type: "boolean";
|
|
532
|
-
readonly default: true;
|
|
533
810
|
};
|
|
534
811
|
readonly controllerRoleArn: {
|
|
535
812
|
readonly type: "string";
|
|
536
|
-
readonly
|
|
813
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
814
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
815
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
816
|
+
};
|
|
817
|
+
};
|
|
818
|
+
readonly required: readonly ["enabled"];
|
|
819
|
+
readonly additionalProperties: false;
|
|
820
|
+
};
|
|
821
|
+
readonly constraints: {
|
|
822
|
+
readonly type: "object";
|
|
823
|
+
readonly properties: {
|
|
824
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
825
|
+
readonly type: "array";
|
|
826
|
+
readonly items: {
|
|
827
|
+
readonly type: "string";
|
|
828
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
829
|
+
};
|
|
830
|
+
readonly minItems: 1;
|
|
831
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
832
|
+
};
|
|
833
|
+
readonly 'kubernetes.io/arch': {
|
|
834
|
+
readonly type: "array";
|
|
835
|
+
readonly items: {
|
|
836
|
+
readonly type: "string";
|
|
837
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
838
|
+
};
|
|
839
|
+
readonly minItems: 1;
|
|
840
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
841
|
+
};
|
|
842
|
+
readonly 'cfke.io/instance-family': {
|
|
843
|
+
readonly type: "array";
|
|
844
|
+
readonly items: {
|
|
845
|
+
readonly type: "string";
|
|
846
|
+
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"];
|
|
847
|
+
};
|
|
848
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
849
|
+
};
|
|
850
|
+
readonly 'topology.kubernetes.io/region': {
|
|
851
|
+
readonly type: "array";
|
|
852
|
+
readonly items: {
|
|
853
|
+
readonly type: "string";
|
|
854
|
+
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"];
|
|
855
|
+
};
|
|
856
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
537
857
|
};
|
|
538
858
|
};
|
|
539
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
540
859
|
readonly additionalProperties: false;
|
|
860
|
+
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. Omit a field to place no restriction on that key.";
|
|
861
|
+
};
|
|
862
|
+
readonly scalingProfile: {
|
|
863
|
+
readonly type: "string";
|
|
864
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
865
|
+
readonly example: "conservative";
|
|
866
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
867
|
+
};
|
|
868
|
+
};
|
|
869
|
+
readonly required: readonly ["scalingProfile"];
|
|
870
|
+
readonly additionalProperties: false;
|
|
871
|
+
};
|
|
872
|
+
export declare const InviteCreateInputSchema: {
|
|
873
|
+
readonly type: "object";
|
|
874
|
+
readonly properties: {
|
|
875
|
+
readonly email: {
|
|
876
|
+
readonly type: "string";
|
|
877
|
+
readonly format: "email";
|
|
878
|
+
readonly description: "Email address of the user to invite.";
|
|
879
|
+
readonly example: "email@example.com";
|
|
880
|
+
};
|
|
881
|
+
readonly role: {
|
|
882
|
+
readonly type: "string";
|
|
883
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
884
|
+
readonly default: "User";
|
|
885
|
+
readonly example: "User";
|
|
886
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
541
887
|
};
|
|
542
888
|
};
|
|
889
|
+
readonly required: readonly ["email"];
|
|
543
890
|
readonly additionalProperties: false;
|
|
544
891
|
};
|
|
545
892
|
export declare const InviteSchema: {
|
|
@@ -573,6 +920,13 @@ export declare const InviteSchema: {
|
|
|
573
920
|
readonly description: "Generated unique invite code.";
|
|
574
921
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
575
922
|
};
|
|
923
|
+
readonly role: {
|
|
924
|
+
readonly type: "string";
|
|
925
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
926
|
+
readonly default: "User";
|
|
927
|
+
readonly example: "User";
|
|
928
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
929
|
+
};
|
|
576
930
|
};
|
|
577
931
|
readonly required: readonly ["date_created"];
|
|
578
932
|
readonly additionalProperties: false;
|
|
@@ -582,23 +936,18 @@ export declare const InvoiceSchema: {
|
|
|
582
936
|
readonly properties: {
|
|
583
937
|
readonly id: {
|
|
584
938
|
readonly type: "string";
|
|
585
|
-
readonly
|
|
586
|
-
readonly
|
|
587
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
939
|
+
readonly description: "Unique identifier of the invoice.";
|
|
940
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
588
941
|
};
|
|
589
|
-
readonly
|
|
942
|
+
readonly number: {
|
|
590
943
|
readonly type: "string";
|
|
591
|
-
readonly format: "uuid";
|
|
592
|
-
readonly description: "Unique identifier of the organization. UUID v4 string in canonical form";
|
|
593
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
594
944
|
};
|
|
595
945
|
readonly status: {
|
|
596
946
|
readonly type: "string";
|
|
597
947
|
readonly description: "Status of the invoice";
|
|
598
|
-
readonly example: "
|
|
599
|
-
readonly enum: readonly ["DRAFT", "COMMITTED", "VOID"];
|
|
948
|
+
readonly example: "paid";
|
|
600
949
|
};
|
|
601
|
-
readonly
|
|
950
|
+
readonly total: {
|
|
602
951
|
readonly type: "number";
|
|
603
952
|
readonly format: "float";
|
|
604
953
|
readonly description: "Total amount of the invoice";
|
|
@@ -607,520 +956,1130 @@ export declare const InvoiceSchema: {
|
|
|
607
956
|
readonly currency: {
|
|
608
957
|
readonly type: "string";
|
|
609
958
|
readonly description: "Currency of the invoice";
|
|
610
|
-
readonly example: "
|
|
611
|
-
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"];
|
|
959
|
+
readonly example: "usd";
|
|
612
960
|
};
|
|
613
|
-
readonly
|
|
614
|
-
readonly type: "
|
|
615
|
-
readonly format: "
|
|
616
|
-
readonly description: "
|
|
617
|
-
readonly example:
|
|
961
|
+
readonly created: {
|
|
962
|
+
readonly type: "string";
|
|
963
|
+
readonly format: "date-time";
|
|
964
|
+
readonly description: "Timestamp when the invoice was issued. ISO 8601 date string in the UTC timezone.";
|
|
965
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
618
966
|
};
|
|
619
|
-
readonly
|
|
620
|
-
readonly type: "
|
|
621
|
-
readonly format: "
|
|
622
|
-
readonly description: "
|
|
623
|
-
readonly example:
|
|
967
|
+
readonly period_start: {
|
|
968
|
+
readonly type: "string";
|
|
969
|
+
readonly format: "date-time";
|
|
970
|
+
readonly description: "Billing period start timestamp. ISO 8601 date string in the UTC timezone.";
|
|
971
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
624
972
|
};
|
|
625
|
-
readonly
|
|
973
|
+
readonly period_end: {
|
|
626
974
|
readonly type: "string";
|
|
627
|
-
readonly
|
|
628
|
-
readonly
|
|
975
|
+
readonly format: "date-time";
|
|
976
|
+
readonly description: "Billing period end timestamp. ISO 8601 date string in the UTC timezone.";
|
|
977
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
629
978
|
};
|
|
630
|
-
readonly
|
|
979
|
+
readonly invoice_pdf: {
|
|
631
980
|
readonly type: "string";
|
|
632
|
-
readonly description: "Target date of the invoice";
|
|
633
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
634
981
|
};
|
|
635
|
-
|
|
982
|
+
};
|
|
983
|
+
readonly required: readonly ["created", "period_start", "period_end"];
|
|
984
|
+
readonly additionalProperties: false;
|
|
985
|
+
};
|
|
986
|
+
export declare const MarketplaceListingFilesSchema: {
|
|
987
|
+
readonly type: "object";
|
|
988
|
+
readonly properties: {
|
|
989
|
+
readonly chartYaml: {
|
|
990
|
+
readonly type: "string";
|
|
991
|
+
readonly description: "Raw Chart.yaml content from the Helm chart";
|
|
992
|
+
readonly example: "apiVersion: v2\nname: nginx-ingress\nversion: 1.18.2-cfke.45\nappVersion: 1.9.4";
|
|
993
|
+
};
|
|
994
|
+
readonly valuesYaml: {
|
|
636
995
|
readonly type: "string";
|
|
637
|
-
readonly description: "
|
|
638
|
-
readonly example: "
|
|
996
|
+
readonly description: "Raw values.yaml content from the Helm chart";
|
|
997
|
+
readonly example: "replicaCount: 1\nimage:\n repository: nginx\n tag: latest";
|
|
639
998
|
};
|
|
640
|
-
readonly
|
|
641
|
-
readonly type: "
|
|
642
|
-
readonly
|
|
643
|
-
readonly
|
|
644
|
-
readonly example: 100;
|
|
999
|
+
readonly valuesSchemaJson: {
|
|
1000
|
+
readonly type: "string";
|
|
1001
|
+
readonly description: "JSON schema for values.yaml as a string";
|
|
1002
|
+
readonly example: "{\"type\":\"object\",\"properties\":{\"replicaCount\":{\"type\":\"number\"}}}";
|
|
645
1003
|
};
|
|
646
|
-
|
|
1004
|
+
};
|
|
1005
|
+
readonly additionalProperties: false;
|
|
1006
|
+
};
|
|
1007
|
+
export declare const MarketplaceListingSchema: {
|
|
1008
|
+
readonly type: "object";
|
|
1009
|
+
readonly properties: {
|
|
1010
|
+
readonly name: {
|
|
647
1011
|
readonly type: "string";
|
|
648
|
-
readonly description: "
|
|
649
|
-
readonly example: "
|
|
1012
|
+
readonly description: "Name of the chart";
|
|
1013
|
+
readonly example: "nginx-ingress";
|
|
650
1014
|
};
|
|
651
|
-
readonly
|
|
1015
|
+
readonly versions: {
|
|
652
1016
|
readonly type: "array";
|
|
653
1017
|
readonly items: {
|
|
654
|
-
readonly type: "
|
|
655
|
-
readonly
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
};
|
|
708
|
-
readonly itemType: {
|
|
709
|
-
readonly type: "string";
|
|
710
|
-
readonly description: "Type of the invoice item";
|
|
711
|
-
readonly example: "EXTERNAL_CHARGE";
|
|
712
|
-
readonly enum: readonly ["EXTERNAL_CHARGE", "FIXED", "RECURRING", "REPAIR_ADJ", "CBA_ADJ", "CREDIT_ADJ", "ITEM_ADJ", "USAGE", "TAX", "PARENT_SUMMARY"];
|
|
713
|
-
};
|
|
714
|
-
readonly description: {
|
|
715
|
-
readonly type: "string";
|
|
716
|
-
readonly description: "Description of the invoice item";
|
|
717
|
-
readonly example: "Description of the invoice item";
|
|
718
|
-
};
|
|
719
|
-
readonly startDate: {
|
|
720
|
-
readonly type: "string";
|
|
721
|
-
readonly description: "Start date of the invoice item";
|
|
722
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
723
|
-
};
|
|
724
|
-
readonly endDate: {
|
|
725
|
-
readonly type: "string";
|
|
726
|
-
readonly description: "End date of the invoice item";
|
|
727
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
728
|
-
};
|
|
729
|
-
readonly amount: {
|
|
730
|
-
readonly type: "number";
|
|
731
|
-
readonly format: "float";
|
|
732
|
-
readonly description: "Amount of the invoice item";
|
|
733
|
-
readonly example: 100;
|
|
734
|
-
};
|
|
735
|
-
readonly rate: {
|
|
736
|
-
readonly type: "number";
|
|
737
|
-
readonly format: "float";
|
|
738
|
-
readonly description: "Rate of the invoice item";
|
|
739
|
-
readonly example: 100;
|
|
740
|
-
};
|
|
741
|
-
readonly currency: {
|
|
742
|
-
readonly type: "string";
|
|
743
|
-
readonly description: "Currency of the invoice item";
|
|
744
|
-
readonly example: "USD";
|
|
745
|
-
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"];
|
|
746
|
-
};
|
|
747
|
-
readonly quantity: {
|
|
748
|
-
readonly type: "number";
|
|
749
|
-
readonly format: "float";
|
|
750
|
-
readonly description: "Quantity of the invoice item";
|
|
751
|
-
readonly example: 1;
|
|
752
|
-
};
|
|
753
|
-
readonly itemDetails: {
|
|
1018
|
+
readonly type: "string";
|
|
1019
|
+
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-]+)*))?$";
|
|
1020
|
+
readonly description: "Specific version of the chart";
|
|
1021
|
+
readonly example: "1.18.2-cfke.45";
|
|
1022
|
+
};
|
|
1023
|
+
readonly description: "Available versions of the chart";
|
|
1024
|
+
};
|
|
1025
|
+
readonly version_channels: {
|
|
1026
|
+
readonly type: "array";
|
|
1027
|
+
readonly items: {
|
|
1028
|
+
readonly type: "string";
|
|
1029
|
+
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-]+)*))?$";
|
|
1030
|
+
readonly description: "Version channel pattern";
|
|
1031
|
+
readonly example: "1.18.x-cfke.x";
|
|
1032
|
+
};
|
|
1033
|
+
readonly description: "Version channels for the chart";
|
|
1034
|
+
};
|
|
1035
|
+
readonly latestVersion: {
|
|
1036
|
+
readonly type: "string";
|
|
1037
|
+
readonly description: "Latest version of the chart";
|
|
1038
|
+
readonly example: "1.18.2-cfke.45";
|
|
1039
|
+
};
|
|
1040
|
+
readonly metadata: {
|
|
1041
|
+
readonly type: "object";
|
|
1042
|
+
readonly properties: {
|
|
1043
|
+
readonly name: {
|
|
1044
|
+
readonly type: "string";
|
|
1045
|
+
readonly description: "Chart name from metadata";
|
|
1046
|
+
readonly example: "nginx-ingress";
|
|
1047
|
+
};
|
|
1048
|
+
readonly version: {
|
|
1049
|
+
readonly type: "string";
|
|
1050
|
+
readonly description: "Chart version from metadata";
|
|
1051
|
+
readonly example: "1.18.2-cfke.45";
|
|
1052
|
+
};
|
|
1053
|
+
readonly description: {
|
|
1054
|
+
readonly type: "string";
|
|
1055
|
+
readonly description: "Chart description";
|
|
1056
|
+
readonly example: "NGINX Ingress Controller for Kubernetes";
|
|
1057
|
+
};
|
|
1058
|
+
readonly appVersion: {
|
|
1059
|
+
readonly type: "string";
|
|
1060
|
+
readonly description: "Application version";
|
|
1061
|
+
readonly example: "1.9.4";
|
|
1062
|
+
};
|
|
1063
|
+
readonly apiVersion: {
|
|
1064
|
+
readonly type: "string";
|
|
1065
|
+
readonly description: "Helm API version";
|
|
1066
|
+
readonly example: "v2";
|
|
1067
|
+
};
|
|
1068
|
+
readonly keywords: {
|
|
1069
|
+
readonly type: "array";
|
|
1070
|
+
readonly items: {
|
|
754
1071
|
readonly type: "string";
|
|
755
|
-
readonly description: "Details of the invoice item";
|
|
756
|
-
readonly example: "Details of the invoice item";
|
|
757
1072
|
};
|
|
758
|
-
readonly
|
|
1073
|
+
readonly description: "Chart keywords";
|
|
1074
|
+
readonly example: readonly ["ingress", "nginx", "load-balancer"];
|
|
1075
|
+
};
|
|
1076
|
+
readonly home: {
|
|
1077
|
+
readonly type: "string";
|
|
1078
|
+
readonly description: "Chart home URL";
|
|
1079
|
+
readonly example: "https://kubernetes.github.io/ingress-nginx/";
|
|
1080
|
+
};
|
|
1081
|
+
readonly icon: {
|
|
1082
|
+
readonly type: "string";
|
|
1083
|
+
readonly description: "A URL to an SVG or PNG image to be used as an icon";
|
|
1084
|
+
readonly example: "https://cloudfleet.ai/images/marketplace/icons/ingress-nginx.png";
|
|
1085
|
+
};
|
|
1086
|
+
readonly sources: {
|
|
1087
|
+
readonly type: "array";
|
|
1088
|
+
readonly items: {
|
|
759
1089
|
readonly type: "string";
|
|
760
|
-
readonly description: "Effective date of the catalog";
|
|
761
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
762
1090
|
};
|
|
763
|
-
readonly
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
}, {
|
|
773
|
-
readonly type: "object";
|
|
774
|
-
readonly additionalProperties: true;
|
|
775
|
-
}, {
|
|
1091
|
+
readonly description: "Chart source URLs";
|
|
1092
|
+
readonly example: readonly ["https://github.com/kubernetes/ingress-nginx"];
|
|
1093
|
+
};
|
|
1094
|
+
readonly maintainers: {
|
|
1095
|
+
readonly type: "array";
|
|
1096
|
+
readonly items: {
|
|
1097
|
+
readonly type: "object";
|
|
1098
|
+
readonly properties: {
|
|
1099
|
+
readonly name: {
|
|
776
1100
|
readonly type: "string";
|
|
777
|
-
|
|
1101
|
+
readonly description: "Maintainer name";
|
|
1102
|
+
readonly example: "NGINX Team";
|
|
1103
|
+
};
|
|
1104
|
+
readonly email: {
|
|
1105
|
+
readonly type: "string";
|
|
1106
|
+
readonly description: "Maintainer email";
|
|
1107
|
+
readonly example: "support@nginx.org";
|
|
1108
|
+
};
|
|
778
1109
|
};
|
|
779
|
-
readonly
|
|
1110
|
+
readonly required: readonly ["name"];
|
|
1111
|
+
readonly additionalProperties: false;
|
|
780
1112
|
};
|
|
1113
|
+
readonly description: "Chart maintainers";
|
|
781
1114
|
};
|
|
782
|
-
readonly additionalProperties: false;
|
|
783
1115
|
};
|
|
784
|
-
readonly
|
|
1116
|
+
readonly required: readonly ["name", "version"];
|
|
1117
|
+
readonly additionalProperties: false;
|
|
1118
|
+
readonly description: "Chart metadata";
|
|
785
1119
|
};
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
1120
|
+
};
|
|
1121
|
+
readonly required: readonly ["name", "versions", "version_channels", "latestVersion"];
|
|
1122
|
+
readonly additionalProperties: false;
|
|
1123
|
+
};
|
|
1124
|
+
export declare const OrganizationCreateInputSchema: {
|
|
1125
|
+
readonly type: "object";
|
|
1126
|
+
readonly properties: {
|
|
1127
|
+
readonly type: {
|
|
1128
|
+
readonly type: "string";
|
|
1129
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1130
|
+
readonly example: "business";
|
|
1131
|
+
readonly enum: readonly ["business", "personal"];
|
|
1132
|
+
};
|
|
1133
|
+
readonly email: {
|
|
1134
|
+
readonly type: "string";
|
|
1135
|
+
readonly format: "email";
|
|
1136
|
+
readonly description: "Email address used for billing as a string.";
|
|
1137
|
+
readonly example: "email@example.com";
|
|
1138
|
+
};
|
|
1139
|
+
readonly first_name: {
|
|
1140
|
+
readonly type: "string";
|
|
1141
|
+
readonly minLength: 1;
|
|
1142
|
+
readonly description: "First name of the billing contact person.";
|
|
1143
|
+
readonly example: "John";
|
|
1144
|
+
};
|
|
1145
|
+
readonly last_name: {
|
|
1146
|
+
readonly type: "string";
|
|
1147
|
+
readonly minLength: 1;
|
|
1148
|
+
readonly description: "Last name of the billing contact person.";
|
|
1149
|
+
readonly example: "Doe";
|
|
1150
|
+
};
|
|
1151
|
+
readonly company_name: {
|
|
1152
|
+
readonly type: "string";
|
|
1153
|
+
readonly maxLength: 120;
|
|
1154
|
+
readonly minLength: 2;
|
|
1155
|
+
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,}$";
|
|
1156
|
+
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1157
|
+
readonly example: "ACME Corp.";
|
|
1158
|
+
};
|
|
1159
|
+
readonly password: {
|
|
1160
|
+
readonly type: "string";
|
|
1161
|
+
readonly minLength: 8;
|
|
1162
|
+
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.";
|
|
1163
|
+
};
|
|
1164
|
+
};
|
|
1165
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1166
|
+
readonly additionalProperties: false;
|
|
1167
|
+
};
|
|
1168
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1169
|
+
readonly type: "object";
|
|
1170
|
+
readonly properties: {
|
|
1171
|
+
readonly id: {
|
|
1172
|
+
readonly type: "string";
|
|
1173
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1174
|
+
readonly example: "organization-id";
|
|
1175
|
+
};
|
|
1176
|
+
};
|
|
1177
|
+
readonly required: readonly ["id"];
|
|
1178
|
+
readonly additionalProperties: false;
|
|
1179
|
+
};
|
|
1180
|
+
export declare const OrganizationSchema: {
|
|
1181
|
+
readonly type: "object";
|
|
1182
|
+
readonly properties: {
|
|
1183
|
+
readonly id: {
|
|
1184
|
+
readonly type: "string";
|
|
1185
|
+
readonly format: "uuid";
|
|
1186
|
+
readonly description: "Unique identifier of the organization. UUID v4 string in canonical form";
|
|
1187
|
+
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1188
|
+
};
|
|
1189
|
+
readonly name: {
|
|
1190
|
+
readonly type: "string";
|
|
1191
|
+
readonly maxLength: 120;
|
|
1192
|
+
readonly minLength: 2;
|
|
1193
|
+
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1194
|
+
readonly example: "ACME Corp.";
|
|
1195
|
+
};
|
|
1196
|
+
readonly type: {
|
|
1197
|
+
readonly type: "string";
|
|
1198
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1199
|
+
readonly example: "business";
|
|
1200
|
+
readonly enum: readonly ["business", "personal"];
|
|
1201
|
+
};
|
|
1202
|
+
readonly date_created: {
|
|
1203
|
+
readonly type: "string";
|
|
1204
|
+
readonly format: "date-time";
|
|
1205
|
+
readonly description: "Creation date of the organization. ISO 8601 date string in UTC timezone";
|
|
1206
|
+
readonly example: "2023-11-02T16:08:14.338Z";
|
|
1207
|
+
};
|
|
1208
|
+
readonly quota: {
|
|
1209
|
+
readonly type: "object";
|
|
1210
|
+
readonly properties: {
|
|
1211
|
+
readonly basic_clusters_max: {
|
|
1212
|
+
readonly type: "integer";
|
|
1213
|
+
readonly minimum: 0;
|
|
1214
|
+
readonly description: "Maximum number of Basic clusters that can be created.";
|
|
1215
|
+
readonly example: 999;
|
|
1216
|
+
};
|
|
1217
|
+
readonly basic_clusters_available: {
|
|
1218
|
+
readonly type: "integer";
|
|
1219
|
+
readonly description: "Available number of Basic clusters that can be created.";
|
|
1220
|
+
readonly example: 999;
|
|
1221
|
+
};
|
|
1222
|
+
readonly pro_clusters_max: {
|
|
1223
|
+
readonly type: "integer";
|
|
1224
|
+
readonly minimum: 0;
|
|
1225
|
+
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1226
|
+
readonly example: 999;
|
|
1227
|
+
};
|
|
1228
|
+
readonly pro_clusters_available: {
|
|
1229
|
+
readonly type: "integer";
|
|
1230
|
+
readonly description: "Available number of Pro clusters that can be created.";
|
|
1231
|
+
readonly example: 999;
|
|
1232
|
+
};
|
|
1233
|
+
readonly fleets_max: {
|
|
1234
|
+
readonly type: "integer";
|
|
1235
|
+
readonly minimum: 0;
|
|
1236
|
+
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1237
|
+
readonly example: 999;
|
|
1238
|
+
};
|
|
1239
|
+
readonly cluster_tiers: {
|
|
1240
|
+
readonly type: "array";
|
|
1241
|
+
readonly items: {
|
|
834
1242
|
readonly type: "string";
|
|
835
|
-
readonly
|
|
836
|
-
readonly example: "Phase A";
|
|
1243
|
+
readonly example: "basic";
|
|
837
1244
|
};
|
|
838
|
-
readonly
|
|
1245
|
+
readonly minItems: 0;
|
|
1246
|
+
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1247
|
+
};
|
|
1248
|
+
readonly regions: {
|
|
1249
|
+
readonly type: "array";
|
|
1250
|
+
readonly items: {
|
|
839
1251
|
readonly type: "string";
|
|
840
|
-
readonly
|
|
841
|
-
readonly example: "Usage A";
|
|
1252
|
+
readonly example: "northamerica-central-1a";
|
|
842
1253
|
};
|
|
843
|
-
readonly
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
1254
|
+
readonly minItems: 1;
|
|
1255
|
+
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
1256
|
+
};
|
|
1257
|
+
readonly versions: {
|
|
1258
|
+
readonly type: "array";
|
|
1259
|
+
readonly items: {
|
|
1260
|
+
readonly type: "object";
|
|
1261
|
+
readonly properties: {
|
|
1262
|
+
readonly id: {
|
|
1263
|
+
readonly type: "string";
|
|
1264
|
+
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1265
|
+
readonly example: "1.33.x-cfke.x";
|
|
1266
|
+
};
|
|
1267
|
+
readonly label: {
|
|
1268
|
+
readonly type: "string";
|
|
1269
|
+
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1270
|
+
readonly example: "1.33.x (Always latest 1.33 patch version)";
|
|
1271
|
+
};
|
|
1272
|
+
};
|
|
1273
|
+
readonly required: readonly ["id", "label"];
|
|
1274
|
+
readonly additionalProperties: false;
|
|
848
1275
|
};
|
|
849
|
-
readonly
|
|
1276
|
+
readonly minItems: 1;
|
|
1277
|
+
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1278
|
+
};
|
|
1279
|
+
readonly cfcr_storage_gb: {
|
|
1280
|
+
readonly type: "integer";
|
|
1281
|
+
readonly minimum: -1;
|
|
1282
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1283
|
+
readonly example: 500;
|
|
1284
|
+
};
|
|
1285
|
+
};
|
|
1286
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1287
|
+
readonly additionalProperties: false;
|
|
1288
|
+
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.";
|
|
1289
|
+
};
|
|
1290
|
+
readonly status: {
|
|
1291
|
+
readonly type: "string";
|
|
1292
|
+
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1293
|
+
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1294
|
+
};
|
|
1295
|
+
readonly verification: {
|
|
1296
|
+
readonly type: "string";
|
|
1297
|
+
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.";
|
|
1298
|
+
readonly example: "verified";
|
|
1299
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1300
|
+
};
|
|
1301
|
+
};
|
|
1302
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1303
|
+
readonly additionalProperties: false;
|
|
1304
|
+
};
|
|
1305
|
+
export declare const PaymentMethodSchema: {
|
|
1306
|
+
readonly type: "object";
|
|
1307
|
+
readonly properties: {
|
|
1308
|
+
readonly id: {
|
|
1309
|
+
readonly type: "string";
|
|
1310
|
+
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.";
|
|
1311
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1312
|
+
};
|
|
1313
|
+
readonly type: {
|
|
1314
|
+
readonly type: "string";
|
|
1315
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1316
|
+
readonly example: "card";
|
|
1317
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1318
|
+
};
|
|
1319
|
+
readonly last4: {
|
|
1320
|
+
readonly type: "string";
|
|
1321
|
+
readonly nullable: true;
|
|
1322
|
+
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.";
|
|
1323
|
+
readonly example: "4242";
|
|
1324
|
+
};
|
|
1325
|
+
readonly exp_month: {
|
|
1326
|
+
readonly type: "integer";
|
|
1327
|
+
readonly minimum: 1;
|
|
1328
|
+
readonly maximum: 12;
|
|
1329
|
+
readonly nullable: true;
|
|
1330
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1331
|
+
readonly example: 12;
|
|
1332
|
+
};
|
|
1333
|
+
readonly exp_year: {
|
|
1334
|
+
readonly type: "integer";
|
|
1335
|
+
readonly nullable: true;
|
|
1336
|
+
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.";
|
|
1337
|
+
readonly example: 2028;
|
|
1338
|
+
};
|
|
1339
|
+
readonly brand: {
|
|
1340
|
+
readonly type: "string";
|
|
1341
|
+
readonly nullable: true;
|
|
1342
|
+
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.";
|
|
1343
|
+
readonly example: "visa";
|
|
1344
|
+
};
|
|
1345
|
+
readonly iban: {
|
|
1346
|
+
readonly type: "string";
|
|
1347
|
+
readonly nullable: true;
|
|
1348
|
+
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.";
|
|
1349
|
+
readonly example: "DE11243015658023127510";
|
|
1350
|
+
};
|
|
1351
|
+
readonly bic: {
|
|
1352
|
+
readonly type: "string";
|
|
1353
|
+
readonly nullable: true;
|
|
1354
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1355
|
+
readonly example: "SOGEDEFFXXX";
|
|
1356
|
+
};
|
|
1357
|
+
readonly account_holder_name: {
|
|
1358
|
+
readonly type: "string";
|
|
1359
|
+
readonly nullable: true;
|
|
1360
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1361
|
+
readonly example: "Cloudfleet GmbH";
|
|
1362
|
+
};
|
|
1363
|
+
readonly is_default: {
|
|
1364
|
+
readonly type: "boolean";
|
|
1365
|
+
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).";
|
|
1366
|
+
readonly example: true;
|
|
1367
|
+
};
|
|
1368
|
+
};
|
|
1369
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1370
|
+
readonly additionalProperties: false;
|
|
1371
|
+
};
|
|
1372
|
+
export declare const PlatformQuotaSchema: {
|
|
1373
|
+
readonly type: "object";
|
|
1374
|
+
readonly properties: {
|
|
1375
|
+
readonly basic_clusters_max: {
|
|
1376
|
+
readonly type: "integer";
|
|
1377
|
+
readonly minimum: 0;
|
|
1378
|
+
readonly description: "Maximum number of Basic clusters that can be created.";
|
|
1379
|
+
readonly example: 999;
|
|
1380
|
+
};
|
|
1381
|
+
readonly basic_clusters_available: {
|
|
1382
|
+
readonly type: "integer";
|
|
1383
|
+
readonly description: "Available number of Basic clusters that can be created.";
|
|
1384
|
+
readonly example: 999;
|
|
1385
|
+
};
|
|
1386
|
+
readonly pro_clusters_max: {
|
|
1387
|
+
readonly type: "integer";
|
|
1388
|
+
readonly minimum: 0;
|
|
1389
|
+
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1390
|
+
readonly example: 999;
|
|
1391
|
+
};
|
|
1392
|
+
readonly pro_clusters_available: {
|
|
1393
|
+
readonly type: "integer";
|
|
1394
|
+
readonly description: "Available number of Pro clusters that can be created.";
|
|
1395
|
+
readonly example: 999;
|
|
1396
|
+
};
|
|
1397
|
+
readonly fleets_max: {
|
|
1398
|
+
readonly type: "integer";
|
|
1399
|
+
readonly minimum: 0;
|
|
1400
|
+
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1401
|
+
readonly example: 999;
|
|
1402
|
+
};
|
|
1403
|
+
readonly cluster_tiers: {
|
|
1404
|
+
readonly type: "array";
|
|
1405
|
+
readonly items: {
|
|
1406
|
+
readonly type: "string";
|
|
1407
|
+
readonly example: "basic";
|
|
1408
|
+
};
|
|
1409
|
+
readonly minItems: 0;
|
|
1410
|
+
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1411
|
+
};
|
|
1412
|
+
readonly regions: {
|
|
1413
|
+
readonly type: "array";
|
|
1414
|
+
readonly items: {
|
|
1415
|
+
readonly type: "string";
|
|
1416
|
+
readonly example: "northamerica-central-1a";
|
|
1417
|
+
};
|
|
1418
|
+
readonly minItems: 1;
|
|
1419
|
+
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
1420
|
+
};
|
|
1421
|
+
readonly versions: {
|
|
1422
|
+
readonly type: "array";
|
|
1423
|
+
readonly items: {
|
|
1424
|
+
readonly type: "object";
|
|
1425
|
+
readonly properties: {
|
|
1426
|
+
readonly id: {
|
|
850
1427
|
readonly type: "string";
|
|
851
|
-
readonly description: "
|
|
852
|
-
readonly example: "
|
|
1428
|
+
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1429
|
+
readonly example: "1.33.x-cfke.x";
|
|
853
1430
|
};
|
|
854
|
-
readonly
|
|
1431
|
+
readonly label: {
|
|
855
1432
|
readonly type: "string";
|
|
856
|
-
readonly description: "
|
|
857
|
-
readonly example: "
|
|
1433
|
+
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1434
|
+
readonly example: "1.33.x (Always latest 1.33 patch version)";
|
|
858
1435
|
};
|
|
859
|
-
|
|
1436
|
+
};
|
|
1437
|
+
readonly required: readonly ["id", "label"];
|
|
1438
|
+
readonly additionalProperties: false;
|
|
1439
|
+
};
|
|
1440
|
+
readonly minItems: 1;
|
|
1441
|
+
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1442
|
+
};
|
|
1443
|
+
readonly cfcr_storage_gb: {
|
|
1444
|
+
readonly type: "integer";
|
|
1445
|
+
readonly minimum: -1;
|
|
1446
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1447
|
+
readonly example: 500;
|
|
1448
|
+
};
|
|
1449
|
+
};
|
|
1450
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1451
|
+
readonly additionalProperties: false;
|
|
1452
|
+
};
|
|
1453
|
+
export declare const RegistryRepositorySchema: {
|
|
1454
|
+
readonly type: "object";
|
|
1455
|
+
readonly properties: {
|
|
1456
|
+
readonly name: {
|
|
1457
|
+
readonly type: "string";
|
|
1458
|
+
readonly description: "Repository name.";
|
|
1459
|
+
readonly example: "my-app";
|
|
1460
|
+
};
|
|
1461
|
+
readonly region: {
|
|
1462
|
+
readonly type: "string";
|
|
1463
|
+
readonly description: "Registry region.";
|
|
1464
|
+
readonly example: "northamerica";
|
|
1465
|
+
};
|
|
1466
|
+
readonly uri: {
|
|
1467
|
+
readonly type: "string";
|
|
1468
|
+
readonly description: "Full URI of the repository.";
|
|
1469
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1470
|
+
};
|
|
1471
|
+
};
|
|
1472
|
+
readonly required: readonly ["name", "region", "uri"];
|
|
1473
|
+
readonly additionalProperties: false;
|
|
1474
|
+
};
|
|
1475
|
+
export declare const RegistryRepositoryWithTagsSchema: {
|
|
1476
|
+
readonly type: "object";
|
|
1477
|
+
readonly properties: {
|
|
1478
|
+
readonly name: {
|
|
1479
|
+
readonly type: "string";
|
|
1480
|
+
readonly description: "Repository name.";
|
|
1481
|
+
readonly example: "my-app";
|
|
1482
|
+
};
|
|
1483
|
+
readonly region: {
|
|
1484
|
+
readonly type: "string";
|
|
1485
|
+
readonly description: "Registry region.";
|
|
1486
|
+
readonly example: "northamerica";
|
|
1487
|
+
};
|
|
1488
|
+
readonly uri: {
|
|
1489
|
+
readonly type: "string";
|
|
1490
|
+
readonly description: "Full URI of the repository.";
|
|
1491
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1492
|
+
};
|
|
1493
|
+
readonly tags: {
|
|
1494
|
+
readonly type: "array";
|
|
1495
|
+
readonly items: {
|
|
1496
|
+
readonly type: "object";
|
|
1497
|
+
readonly properties: {
|
|
1498
|
+
readonly name: {
|
|
860
1499
|
readonly type: "string";
|
|
861
|
-
readonly description: "
|
|
862
|
-
readonly example: "
|
|
1500
|
+
readonly description: "Tag name.";
|
|
1501
|
+
readonly example: "latest";
|
|
863
1502
|
};
|
|
864
|
-
readonly
|
|
1503
|
+
readonly size: {
|
|
865
1504
|
readonly type: "number";
|
|
866
1505
|
readonly format: "float";
|
|
867
|
-
readonly description: "
|
|
868
|
-
readonly example:
|
|
1506
|
+
readonly description: "Size of the tag in bytes.";
|
|
1507
|
+
readonly example: 123456789;
|
|
869
1508
|
};
|
|
870
|
-
readonly
|
|
871
|
-
readonly type: "
|
|
872
|
-
readonly
|
|
873
|
-
readonly
|
|
874
|
-
|
|
1509
|
+
readonly mediaType: {
|
|
1510
|
+
readonly type: "string";
|
|
1511
|
+
readonly description: "Media type of the manifest.";
|
|
1512
|
+
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
1513
|
+
};
|
|
1514
|
+
readonly platforms: {
|
|
1515
|
+
readonly type: "array";
|
|
1516
|
+
readonly items: {
|
|
1517
|
+
readonly type: "string";
|
|
1518
|
+
};
|
|
1519
|
+
readonly description: "Array of platform strings for multi-arch images (e.g., linux/amd64, linux/arm64).";
|
|
1520
|
+
readonly example: readonly ["linux/amd64", "linux/arm64"];
|
|
875
1521
|
};
|
|
876
|
-
|
|
1522
|
+
};
|
|
1523
|
+
readonly required: readonly ["name", "size"];
|
|
1524
|
+
readonly additionalProperties: false;
|
|
1525
|
+
};
|
|
1526
|
+
readonly description: "Array of tags in the repository.";
|
|
1527
|
+
};
|
|
1528
|
+
readonly totalSize: {
|
|
1529
|
+
readonly type: "number";
|
|
1530
|
+
readonly format: "float";
|
|
1531
|
+
readonly description: "Total size of all tags in the repository in bytes.";
|
|
1532
|
+
readonly example: 987654321;
|
|
1533
|
+
};
|
|
1534
|
+
};
|
|
1535
|
+
readonly required: readonly ["name", "region", "uri", "tags", "totalSize"];
|
|
1536
|
+
readonly additionalProperties: false;
|
|
1537
|
+
};
|
|
1538
|
+
export declare const RegistryTagSchema: {
|
|
1539
|
+
readonly type: "object";
|
|
1540
|
+
readonly properties: {
|
|
1541
|
+
readonly name: {
|
|
1542
|
+
readonly type: "string";
|
|
1543
|
+
readonly description: "Tag name.";
|
|
1544
|
+
readonly example: "latest";
|
|
1545
|
+
};
|
|
1546
|
+
readonly digest: {
|
|
1547
|
+
readonly type: "string";
|
|
1548
|
+
readonly description: "Manifest digest for pulling by digest.";
|
|
1549
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1550
|
+
};
|
|
1551
|
+
readonly mediaType: {
|
|
1552
|
+
readonly type: "string";
|
|
1553
|
+
readonly description: "Media type of the manifest.";
|
|
1554
|
+
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
1555
|
+
};
|
|
1556
|
+
readonly config: {
|
|
1557
|
+
readonly type: "object";
|
|
1558
|
+
readonly properties: {
|
|
1559
|
+
readonly size: {
|
|
1560
|
+
readonly type: "number";
|
|
1561
|
+
readonly format: "float";
|
|
1562
|
+
readonly description: "Size of the config in bytes.";
|
|
1563
|
+
readonly example: 1234;
|
|
1564
|
+
};
|
|
1565
|
+
};
|
|
1566
|
+
readonly required: readonly ["size"];
|
|
1567
|
+
readonly additionalProperties: false;
|
|
1568
|
+
readonly description: "Manifest config metadata.";
|
|
1569
|
+
};
|
|
1570
|
+
readonly layers: {
|
|
1571
|
+
readonly type: "array";
|
|
1572
|
+
readonly items: {
|
|
1573
|
+
readonly type: "object";
|
|
1574
|
+
readonly properties: {
|
|
1575
|
+
readonly digest: {
|
|
877
1576
|
readonly type: "string";
|
|
878
|
-
readonly description: "
|
|
879
|
-
readonly example: "
|
|
880
|
-
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"];
|
|
1577
|
+
readonly description: "Digest of the layer.";
|
|
1578
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
881
1579
|
};
|
|
882
|
-
readonly
|
|
1580
|
+
readonly size: {
|
|
883
1581
|
readonly type: "number";
|
|
884
1582
|
readonly format: "float";
|
|
885
|
-
readonly description: "
|
|
886
|
-
readonly example:
|
|
1583
|
+
readonly description: "Size of the layer in bytes.";
|
|
1584
|
+
readonly example: 5678;
|
|
887
1585
|
};
|
|
888
|
-
|
|
1586
|
+
};
|
|
1587
|
+
readonly required: readonly ["size"];
|
|
1588
|
+
readonly additionalProperties: false;
|
|
1589
|
+
};
|
|
1590
|
+
readonly description: "Array of layer metadata.";
|
|
1591
|
+
};
|
|
1592
|
+
readonly manifests: {
|
|
1593
|
+
readonly type: "array";
|
|
1594
|
+
readonly items: {
|
|
1595
|
+
readonly type: "object";
|
|
1596
|
+
readonly properties: {
|
|
1597
|
+
readonly digest: {
|
|
889
1598
|
readonly type: "string";
|
|
890
|
-
readonly description: "
|
|
891
|
-
readonly example: "
|
|
1599
|
+
readonly description: "Digest of the manifest.";
|
|
1600
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
892
1601
|
};
|
|
893
|
-
readonly
|
|
894
|
-
readonly type: "
|
|
895
|
-
readonly
|
|
896
|
-
|
|
1602
|
+
readonly platform: {
|
|
1603
|
+
readonly type: "object";
|
|
1604
|
+
readonly properties: {
|
|
1605
|
+
readonly architecture: {
|
|
1606
|
+
readonly type: "string";
|
|
1607
|
+
readonly description: "Architecture of the platform.";
|
|
1608
|
+
readonly example: "amd64";
|
|
1609
|
+
};
|
|
1610
|
+
readonly os: {
|
|
1611
|
+
readonly type: "string";
|
|
1612
|
+
readonly description: "Operating system of the platform.";
|
|
1613
|
+
readonly example: "linux";
|
|
1614
|
+
};
|
|
1615
|
+
readonly variant: {
|
|
1616
|
+
readonly type: "string";
|
|
1617
|
+
readonly description: "Variant of the platform (e.g., v7, v8 for ARM).";
|
|
1618
|
+
readonly example: "v8";
|
|
1619
|
+
};
|
|
1620
|
+
};
|
|
1621
|
+
readonly required: readonly ["architecture", "os"];
|
|
1622
|
+
readonly additionalProperties: false;
|
|
1623
|
+
readonly description: "Platform information for the manifest.";
|
|
897
1624
|
};
|
|
898
|
-
readonly
|
|
1625
|
+
readonly layers: {
|
|
899
1626
|
readonly type: "array";
|
|
900
1627
|
readonly items: {
|
|
901
|
-
readonly
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
|
|
907
|
-
|
|
908
|
-
readonly
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
1628
|
+
readonly type: "object";
|
|
1629
|
+
readonly properties: {
|
|
1630
|
+
readonly digest: {
|
|
1631
|
+
readonly type: "string";
|
|
1632
|
+
readonly description: "Digest of the layer.";
|
|
1633
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1634
|
+
};
|
|
1635
|
+
readonly size: {
|
|
1636
|
+
readonly type: "number";
|
|
1637
|
+
readonly format: "float";
|
|
1638
|
+
readonly description: "Size of the layer in bytes.";
|
|
1639
|
+
readonly example: 5678;
|
|
1640
|
+
};
|
|
1641
|
+
};
|
|
1642
|
+
readonly required: readonly ["size"];
|
|
1643
|
+
readonly additionalProperties: false;
|
|
913
1644
|
};
|
|
914
|
-
readonly description: "
|
|
1645
|
+
readonly description: "Layers for this platform.";
|
|
1646
|
+
};
|
|
1647
|
+
readonly size: {
|
|
1648
|
+
readonly type: "number";
|
|
1649
|
+
readonly format: "float";
|
|
1650
|
+
readonly description: "Total size of this platform manifest in bytes.";
|
|
1651
|
+
readonly example: 12345678;
|
|
915
1652
|
};
|
|
916
1653
|
};
|
|
1654
|
+
readonly required: readonly ["digest"];
|
|
917
1655
|
readonly additionalProperties: false;
|
|
918
1656
|
};
|
|
919
|
-
readonly description: "
|
|
1657
|
+
readonly description: "Array of manifests for multi-arch images.";
|
|
1658
|
+
};
|
|
1659
|
+
readonly size: {
|
|
1660
|
+
readonly type: "number";
|
|
1661
|
+
readonly format: "float";
|
|
1662
|
+
readonly description: "Total size of the tag in bytes.";
|
|
1663
|
+
readonly example: 123456789;
|
|
1664
|
+
};
|
|
1665
|
+
readonly region: {
|
|
1666
|
+
readonly type: "string";
|
|
1667
|
+
readonly description: "Registry region.";
|
|
1668
|
+
readonly example: "northamerica";
|
|
1669
|
+
};
|
|
1670
|
+
readonly repository: {
|
|
1671
|
+
readonly type: "string";
|
|
1672
|
+
readonly description: "Repository name.";
|
|
1673
|
+
readonly example: "my-app";
|
|
1674
|
+
};
|
|
1675
|
+
readonly uri: {
|
|
1676
|
+
readonly type: "string";
|
|
1677
|
+
readonly description: "Full URI of the tag.";
|
|
1678
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app:latest";
|
|
920
1679
|
};
|
|
921
1680
|
};
|
|
1681
|
+
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
922
1682
|
readonly additionalProperties: false;
|
|
923
1683
|
};
|
|
924
|
-
export declare const
|
|
1684
|
+
export declare const TicketAttachmentSchema: {
|
|
925
1685
|
readonly type: "object";
|
|
926
1686
|
readonly properties: {
|
|
927
|
-
readonly
|
|
1687
|
+
readonly id: {
|
|
928
1688
|
readonly type: "string";
|
|
929
|
-
readonly
|
|
930
|
-
readonly
|
|
931
|
-
readonly example: "email@example.com";
|
|
1689
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
1690
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
932
1691
|
};
|
|
933
|
-
readonly
|
|
1692
|
+
readonly filename: {
|
|
934
1693
|
readonly type: "string";
|
|
935
|
-
readonly description: "
|
|
936
|
-
readonly example: "
|
|
1694
|
+
readonly description: "Original filename as uploaded.";
|
|
1695
|
+
readonly example: "debug.log";
|
|
937
1696
|
};
|
|
938
|
-
readonly
|
|
1697
|
+
readonly content_type: {
|
|
939
1698
|
readonly type: "string";
|
|
940
|
-
readonly description: "
|
|
941
|
-
readonly example: "
|
|
1699
|
+
readonly description: "MIME content type of the attachment.";
|
|
1700
|
+
readonly example: "text/plain";
|
|
942
1701
|
};
|
|
943
|
-
readonly
|
|
1702
|
+
readonly size: {
|
|
1703
|
+
readonly type: "integer";
|
|
1704
|
+
readonly description: "Size of the attachment in bytes.";
|
|
1705
|
+
readonly example: 12345;
|
|
1706
|
+
};
|
|
1707
|
+
};
|
|
1708
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1709
|
+
readonly additionalProperties: false;
|
|
1710
|
+
};
|
|
1711
|
+
export declare const TicketCreateInputSchema: {
|
|
1712
|
+
readonly type: "object";
|
|
1713
|
+
readonly properties: {
|
|
1714
|
+
readonly category: {
|
|
944
1715
|
readonly type: "string";
|
|
945
|
-
readonly
|
|
946
|
-
readonly
|
|
947
|
-
readonly
|
|
948
|
-
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
949
|
-
readonly example: "ACME Corp.";
|
|
1716
|
+
readonly description: "Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.";
|
|
1717
|
+
readonly example: "technical";
|
|
1718
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
950
1719
|
};
|
|
951
|
-
readonly
|
|
1720
|
+
readonly body: {
|
|
952
1721
|
readonly type: "string";
|
|
953
|
-
readonly
|
|
954
|
-
readonly
|
|
1722
|
+
readonly maxLength: 50000;
|
|
1723
|
+
readonly minLength: 1;
|
|
1724
|
+
readonly pattern: "\\S";
|
|
1725
|
+
readonly description: "Initial message body in markdown. There is no separate subject — the first message body is the description.";
|
|
1726
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1727
|
+
};
|
|
1728
|
+
readonly properties: {
|
|
1729
|
+
readonly type: "object";
|
|
1730
|
+
readonly additionalProperties: true;
|
|
1731
|
+
readonly description: "Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).";
|
|
1732
|
+
readonly example: {
|
|
1733
|
+
readonly subcategory: "cluster-question";
|
|
1734
|
+
readonly cluster_id: "60c72b2f9f1b2c001f8e4d3a";
|
|
1735
|
+
};
|
|
955
1736
|
};
|
|
956
1737
|
};
|
|
957
|
-
readonly required: readonly ["
|
|
1738
|
+
readonly required: readonly ["category", "body"];
|
|
958
1739
|
readonly additionalProperties: false;
|
|
959
1740
|
};
|
|
960
|
-
export declare const
|
|
1741
|
+
export declare const TicketListResponseSchema: {
|
|
1742
|
+
readonly type: "object";
|
|
1743
|
+
readonly properties: {
|
|
1744
|
+
readonly items: {
|
|
1745
|
+
readonly type: "array";
|
|
1746
|
+
readonly items: {
|
|
1747
|
+
readonly type: "object";
|
|
1748
|
+
readonly properties: {
|
|
1749
|
+
readonly id: {
|
|
1750
|
+
readonly type: "string";
|
|
1751
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
1752
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
1753
|
+
};
|
|
1754
|
+
readonly status: {
|
|
1755
|
+
readonly type: "string";
|
|
1756
|
+
readonly description: "Current state of the ticket.";
|
|
1757
|
+
readonly example: "waiting_on_us";
|
|
1758
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
1759
|
+
};
|
|
1760
|
+
readonly category: {
|
|
1761
|
+
readonly type: "string";
|
|
1762
|
+
readonly description: "Ticket category.";
|
|
1763
|
+
readonly example: "technical";
|
|
1764
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
1765
|
+
};
|
|
1766
|
+
readonly summary: {
|
|
1767
|
+
readonly type: "string";
|
|
1768
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
1769
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1770
|
+
};
|
|
1771
|
+
readonly closed_at: {
|
|
1772
|
+
readonly type: "string";
|
|
1773
|
+
readonly format: "date-time";
|
|
1774
|
+
readonly nullable: true;
|
|
1775
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
1776
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1777
|
+
};
|
|
1778
|
+
readonly date_created: {
|
|
1779
|
+
readonly type: "string";
|
|
1780
|
+
readonly format: "date-time";
|
|
1781
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
1782
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1783
|
+
};
|
|
1784
|
+
readonly date_updated: {
|
|
1785
|
+
readonly type: "string";
|
|
1786
|
+
readonly format: "date-time";
|
|
1787
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
1788
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1789
|
+
};
|
|
1790
|
+
readonly messages: {
|
|
1791
|
+
readonly type: "array";
|
|
1792
|
+
readonly items: {
|
|
1793
|
+
readonly type: "object";
|
|
1794
|
+
readonly properties: {
|
|
1795
|
+
readonly id: {
|
|
1796
|
+
readonly type: "string";
|
|
1797
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
1798
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
1799
|
+
};
|
|
1800
|
+
readonly type: {
|
|
1801
|
+
readonly type: "string";
|
|
1802
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
1803
|
+
readonly example: "customer_reply";
|
|
1804
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
1805
|
+
};
|
|
1806
|
+
readonly body: {
|
|
1807
|
+
readonly type: "string";
|
|
1808
|
+
readonly description: "Message body in markdown.";
|
|
1809
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
1810
|
+
};
|
|
1811
|
+
readonly author_first_name: {
|
|
1812
|
+
readonly type: "string";
|
|
1813
|
+
readonly nullable: true;
|
|
1814
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
1815
|
+
readonly example: "Jane";
|
|
1816
|
+
};
|
|
1817
|
+
readonly author_last_name: {
|
|
1818
|
+
readonly type: "string";
|
|
1819
|
+
readonly nullable: true;
|
|
1820
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
1821
|
+
readonly example: "Doe";
|
|
1822
|
+
};
|
|
1823
|
+
readonly attachments: {
|
|
1824
|
+
readonly type: "array";
|
|
1825
|
+
readonly items: {
|
|
1826
|
+
readonly type: "object";
|
|
1827
|
+
readonly properties: {
|
|
1828
|
+
readonly id: {
|
|
1829
|
+
readonly type: "string";
|
|
1830
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
1831
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1832
|
+
};
|
|
1833
|
+
readonly filename: {
|
|
1834
|
+
readonly type: "string";
|
|
1835
|
+
readonly description: "Original filename as uploaded.";
|
|
1836
|
+
readonly example: "debug.log";
|
|
1837
|
+
};
|
|
1838
|
+
readonly content_type: {
|
|
1839
|
+
readonly type: "string";
|
|
1840
|
+
readonly description: "MIME content type of the attachment.";
|
|
1841
|
+
readonly example: "text/plain";
|
|
1842
|
+
};
|
|
1843
|
+
readonly size: {
|
|
1844
|
+
readonly type: "integer";
|
|
1845
|
+
readonly description: "Size of the attachment in bytes.";
|
|
1846
|
+
readonly example: 12345;
|
|
1847
|
+
};
|
|
1848
|
+
};
|
|
1849
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1850
|
+
readonly additionalProperties: false;
|
|
1851
|
+
};
|
|
1852
|
+
readonly description: "Attachments associated with this message.";
|
|
1853
|
+
readonly example: readonly [];
|
|
1854
|
+
};
|
|
1855
|
+
readonly date_created: {
|
|
1856
|
+
readonly type: "string";
|
|
1857
|
+
readonly format: "date-time";
|
|
1858
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
1859
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1860
|
+
};
|
|
1861
|
+
};
|
|
1862
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
1863
|
+
readonly additionalProperties: false;
|
|
1864
|
+
};
|
|
1865
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
1866
|
+
};
|
|
1867
|
+
};
|
|
1868
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1869
|
+
readonly additionalProperties: false;
|
|
1870
|
+
};
|
|
1871
|
+
readonly description: "Tickets for the organization, ordered newest first. Messages are omitted from list responses.";
|
|
1872
|
+
};
|
|
1873
|
+
};
|
|
1874
|
+
readonly required: readonly ["items"];
|
|
1875
|
+
readonly additionalProperties: false;
|
|
1876
|
+
};
|
|
1877
|
+
export declare const TicketMessageInputSchema: {
|
|
1878
|
+
readonly type: "object";
|
|
1879
|
+
readonly properties: {
|
|
1880
|
+
readonly body: {
|
|
1881
|
+
readonly type: "string";
|
|
1882
|
+
readonly maxLength: 50000;
|
|
1883
|
+
readonly minLength: 1;
|
|
1884
|
+
readonly pattern: "\\S";
|
|
1885
|
+
readonly description: "Reply body in markdown.";
|
|
1886
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
1887
|
+
};
|
|
1888
|
+
};
|
|
1889
|
+
readonly required: readonly ["body"];
|
|
1890
|
+
readonly additionalProperties: false;
|
|
1891
|
+
};
|
|
1892
|
+
export declare const TicketMessageSchema: {
|
|
961
1893
|
readonly type: "object";
|
|
962
1894
|
readonly properties: {
|
|
963
1895
|
readonly id: {
|
|
964
1896
|
readonly type: "string";
|
|
965
|
-
readonly
|
|
966
|
-
readonly
|
|
967
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1897
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
1898
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
968
1899
|
};
|
|
969
|
-
readonly
|
|
1900
|
+
readonly type: {
|
|
970
1901
|
readonly type: "string";
|
|
971
|
-
readonly
|
|
972
|
-
readonly
|
|
973
|
-
readonly
|
|
974
|
-
|
|
1902
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
1903
|
+
readonly example: "customer_reply";
|
|
1904
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
1905
|
+
};
|
|
1906
|
+
readonly body: {
|
|
1907
|
+
readonly type: "string";
|
|
1908
|
+
readonly description: "Message body in markdown.";
|
|
1909
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
975
1910
|
};
|
|
976
|
-
readonly
|
|
1911
|
+
readonly author_first_name: {
|
|
977
1912
|
readonly type: "string";
|
|
978
|
-
readonly
|
|
979
|
-
readonly
|
|
980
|
-
readonly example: "2023-11-02T16:08:14.338Z";
|
|
1913
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
1914
|
+
readonly example: "Jane";
|
|
981
1915
|
};
|
|
982
|
-
readonly
|
|
983
|
-
readonly type: "
|
|
984
|
-
readonly
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
readonly
|
|
992
|
-
readonly
|
|
993
|
-
readonly description: "Available number of Basic clusters that can be created.";
|
|
994
|
-
readonly example: 999;
|
|
995
|
-
};
|
|
996
|
-
readonly pro_clusters_max: {
|
|
997
|
-
readonly type: "integer";
|
|
998
|
-
readonly minimum: 0;
|
|
999
|
-
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1000
|
-
readonly example: 999;
|
|
1001
|
-
};
|
|
1002
|
-
readonly pro_clusters_available: {
|
|
1003
|
-
readonly type: "integer";
|
|
1004
|
-
readonly description: "Available number of Pro clusters that can be created.";
|
|
1005
|
-
readonly example: 999;
|
|
1006
|
-
};
|
|
1007
|
-
readonly fleets_max: {
|
|
1008
|
-
readonly type: "integer";
|
|
1009
|
-
readonly minimum: 0;
|
|
1010
|
-
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1011
|
-
readonly example: 999;
|
|
1012
|
-
};
|
|
1013
|
-
readonly managed_fleets_cpu_max: {
|
|
1014
|
-
readonly type: "integer";
|
|
1015
|
-
readonly minimum: 0;
|
|
1016
|
-
readonly description: "Maximum number of CPU cores per managed fleet.";
|
|
1017
|
-
readonly example: 999;
|
|
1018
|
-
};
|
|
1019
|
-
readonly cluster_tiers: {
|
|
1020
|
-
readonly type: "array";
|
|
1021
|
-
readonly items: {
|
|
1916
|
+
readonly author_last_name: {
|
|
1917
|
+
readonly type: "string";
|
|
1918
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
1919
|
+
readonly example: "Doe";
|
|
1920
|
+
};
|
|
1921
|
+
readonly attachments: {
|
|
1922
|
+
readonly type: "array";
|
|
1923
|
+
readonly items: {
|
|
1924
|
+
readonly type: "object";
|
|
1925
|
+
readonly properties: {
|
|
1926
|
+
readonly id: {
|
|
1022
1927
|
readonly type: "string";
|
|
1023
|
-
readonly
|
|
1928
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
1929
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1024
1930
|
};
|
|
1025
|
-
readonly
|
|
1026
|
-
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1027
|
-
};
|
|
1028
|
-
readonly regions: {
|
|
1029
|
-
readonly type: "array";
|
|
1030
|
-
readonly items: {
|
|
1931
|
+
readonly filename: {
|
|
1031
1932
|
readonly type: "string";
|
|
1032
|
-
readonly
|
|
1933
|
+
readonly description: "Original filename as uploaded.";
|
|
1934
|
+
readonly example: "debug.log";
|
|
1033
1935
|
};
|
|
1034
|
-
readonly
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
readonly
|
|
1040
|
-
readonly type: "
|
|
1041
|
-
readonly
|
|
1042
|
-
|
|
1043
|
-
readonly type: "string";
|
|
1044
|
-
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1045
|
-
readonly example: "1.29.x-cfke.x";
|
|
1046
|
-
};
|
|
1047
|
-
readonly label: {
|
|
1048
|
-
readonly type: "string";
|
|
1049
|
-
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1050
|
-
readonly example: "1.29.x (Always latest 1.29 patch version)";
|
|
1051
|
-
};
|
|
1052
|
-
};
|
|
1053
|
-
readonly required: readonly ["id", "label"];
|
|
1054
|
-
readonly additionalProperties: false;
|
|
1936
|
+
readonly content_type: {
|
|
1937
|
+
readonly type: "string";
|
|
1938
|
+
readonly description: "MIME content type of the attachment.";
|
|
1939
|
+
readonly example: "text/plain";
|
|
1940
|
+
};
|
|
1941
|
+
readonly size: {
|
|
1942
|
+
readonly type: "integer";
|
|
1943
|
+
readonly description: "Size of the attachment in bytes.";
|
|
1944
|
+
readonly example: 12345;
|
|
1055
1945
|
};
|
|
1056
|
-
readonly minItems: 1;
|
|
1057
|
-
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1058
1946
|
};
|
|
1947
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1948
|
+
readonly additionalProperties: false;
|
|
1059
1949
|
};
|
|
1060
|
-
readonly
|
|
1061
|
-
readonly
|
|
1062
|
-
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.";
|
|
1950
|
+
readonly description: "Attachments associated with this message.";
|
|
1951
|
+
readonly example: readonly [];
|
|
1063
1952
|
};
|
|
1064
|
-
readonly
|
|
1953
|
+
readonly date_created: {
|
|
1065
1954
|
readonly type: "string";
|
|
1066
|
-
readonly
|
|
1067
|
-
readonly
|
|
1955
|
+
readonly format: "date-time";
|
|
1956
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
1957
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1068
1958
|
};
|
|
1069
1959
|
};
|
|
1070
|
-
readonly required: readonly ["id", "
|
|
1960
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
1071
1961
|
readonly additionalProperties: false;
|
|
1072
1962
|
};
|
|
1073
|
-
export declare const
|
|
1963
|
+
export declare const TicketSchema: {
|
|
1074
1964
|
readonly type: "object";
|
|
1075
1965
|
readonly properties: {
|
|
1076
1966
|
readonly id: {
|
|
1077
1967
|
readonly type: "string";
|
|
1078
|
-
readonly
|
|
1079
|
-
readonly
|
|
1080
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1968
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
1969
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
1081
1970
|
};
|
|
1082
|
-
readonly
|
|
1083
|
-
readonly type: "
|
|
1084
|
-
readonly description: "
|
|
1085
|
-
readonly example:
|
|
1971
|
+
readonly status: {
|
|
1972
|
+
readonly type: "string";
|
|
1973
|
+
readonly description: "Current state of the ticket.";
|
|
1974
|
+
readonly example: "waiting_on_us";
|
|
1975
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
1086
1976
|
};
|
|
1087
|
-
readonly
|
|
1977
|
+
readonly category: {
|
|
1088
1978
|
readonly type: "string";
|
|
1089
|
-
readonly
|
|
1090
|
-
readonly
|
|
1091
|
-
readonly
|
|
1092
|
-
readonly enum: readonly ["card"];
|
|
1979
|
+
readonly description: "Ticket category.";
|
|
1980
|
+
readonly example: "technical";
|
|
1981
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
1093
1982
|
};
|
|
1094
|
-
readonly
|
|
1983
|
+
readonly summary: {
|
|
1095
1984
|
readonly type: "string";
|
|
1096
|
-
readonly
|
|
1097
|
-
readonly
|
|
1098
|
-
readonly example: "4242";
|
|
1985
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
1986
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1099
1987
|
};
|
|
1100
|
-
readonly
|
|
1101
|
-
readonly type: "
|
|
1102
|
-
readonly
|
|
1103
|
-
readonly
|
|
1104
|
-
readonly
|
|
1105
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1106
|
-
readonly example: "12";
|
|
1988
|
+
readonly closed_at: {
|
|
1989
|
+
readonly type: "string";
|
|
1990
|
+
readonly format: "date-time";
|
|
1991
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
1992
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1107
1993
|
};
|
|
1108
|
-
readonly
|
|
1109
|
-
readonly type: "
|
|
1110
|
-
readonly
|
|
1111
|
-
readonly
|
|
1112
|
-
readonly
|
|
1113
|
-
readonly example: "2028";
|
|
1994
|
+
readonly date_created: {
|
|
1995
|
+
readonly type: "string";
|
|
1996
|
+
readonly format: "date-time";
|
|
1997
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
1998
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1114
1999
|
};
|
|
1115
|
-
readonly
|
|
2000
|
+
readonly date_updated: {
|
|
1116
2001
|
readonly type: "string";
|
|
1117
|
-
readonly
|
|
1118
|
-
readonly description: "
|
|
1119
|
-
readonly example: "
|
|
1120
|
-
|
|
2002
|
+
readonly format: "date-time";
|
|
2003
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2004
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2005
|
+
};
|
|
2006
|
+
readonly messages: {
|
|
2007
|
+
readonly type: "array";
|
|
2008
|
+
readonly items: {
|
|
2009
|
+
readonly type: "object";
|
|
2010
|
+
readonly properties: {
|
|
2011
|
+
readonly id: {
|
|
2012
|
+
readonly type: "string";
|
|
2013
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2014
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2015
|
+
};
|
|
2016
|
+
readonly type: {
|
|
2017
|
+
readonly type: "string";
|
|
2018
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2019
|
+
readonly example: "customer_reply";
|
|
2020
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2021
|
+
};
|
|
2022
|
+
readonly body: {
|
|
2023
|
+
readonly type: "string";
|
|
2024
|
+
readonly description: "Message body in markdown.";
|
|
2025
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2026
|
+
};
|
|
2027
|
+
readonly author_first_name: {
|
|
2028
|
+
readonly type: "string";
|
|
2029
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2030
|
+
readonly example: "Jane";
|
|
2031
|
+
};
|
|
2032
|
+
readonly author_last_name: {
|
|
2033
|
+
readonly type: "string";
|
|
2034
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2035
|
+
readonly example: "Doe";
|
|
2036
|
+
};
|
|
2037
|
+
readonly attachments: {
|
|
2038
|
+
readonly type: "array";
|
|
2039
|
+
readonly items: {
|
|
2040
|
+
readonly type: "object";
|
|
2041
|
+
readonly properties: {
|
|
2042
|
+
readonly id: {
|
|
2043
|
+
readonly type: "string";
|
|
2044
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2045
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2046
|
+
};
|
|
2047
|
+
readonly filename: {
|
|
2048
|
+
readonly type: "string";
|
|
2049
|
+
readonly description: "Original filename as uploaded.";
|
|
2050
|
+
readonly example: "debug.log";
|
|
2051
|
+
};
|
|
2052
|
+
readonly content_type: {
|
|
2053
|
+
readonly type: "string";
|
|
2054
|
+
readonly description: "MIME content type of the attachment.";
|
|
2055
|
+
readonly example: "text/plain";
|
|
2056
|
+
};
|
|
2057
|
+
readonly size: {
|
|
2058
|
+
readonly type: "integer";
|
|
2059
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2060
|
+
readonly example: 12345;
|
|
2061
|
+
};
|
|
2062
|
+
};
|
|
2063
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2064
|
+
readonly additionalProperties: false;
|
|
2065
|
+
};
|
|
2066
|
+
readonly description: "Attachments associated with this message.";
|
|
2067
|
+
readonly example: readonly [];
|
|
2068
|
+
};
|
|
2069
|
+
readonly date_created: {
|
|
2070
|
+
readonly type: "string";
|
|
2071
|
+
readonly format: "date-time";
|
|
2072
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2073
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2074
|
+
};
|
|
2075
|
+
};
|
|
2076
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2077
|
+
readonly additionalProperties: false;
|
|
2078
|
+
};
|
|
2079
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
1121
2080
|
};
|
|
1122
2081
|
};
|
|
1123
|
-
readonly required: readonly ["id", "
|
|
2082
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1124
2083
|
readonly additionalProperties: false;
|
|
1125
2084
|
};
|
|
1126
2085
|
export declare const TokenCreateInputSchema: {
|
|
@@ -1201,6 +2160,101 @@ export declare const TokenUpdateInputSchema: {
|
|
|
1201
2160
|
};
|
|
1202
2161
|
readonly additionalProperties: false;
|
|
1203
2162
|
};
|
|
2163
|
+
export declare const UsageFacetsSchema: {
|
|
2164
|
+
readonly type: "object";
|
|
2165
|
+
readonly properties: {
|
|
2166
|
+
readonly cluster_id: {
|
|
2167
|
+
readonly type: "array";
|
|
2168
|
+
readonly items: {
|
|
2169
|
+
readonly type: "string";
|
|
2170
|
+
};
|
|
2171
|
+
readonly description: "List of unique cluster IDs";
|
|
2172
|
+
readonly example: readonly ["6b5439b1-923a-4f2b-a371-d554e5ea23fa"];
|
|
2173
|
+
};
|
|
2174
|
+
readonly product: {
|
|
2175
|
+
readonly type: "array";
|
|
2176
|
+
readonly items: {
|
|
2177
|
+
readonly type: "string";
|
|
2178
|
+
};
|
|
2179
|
+
readonly description: "List of unique products";
|
|
2180
|
+
readonly example: readonly ["cfke_controlplane", "cfke_connected_nodes"];
|
|
2181
|
+
};
|
|
2182
|
+
};
|
|
2183
|
+
readonly additionalProperties: false;
|
|
2184
|
+
};
|
|
2185
|
+
export declare const UsageResponseSchema: {
|
|
2186
|
+
readonly type: "object";
|
|
2187
|
+
readonly properties: {
|
|
2188
|
+
readonly data: {
|
|
2189
|
+
readonly type: "array";
|
|
2190
|
+
readonly items: {
|
|
2191
|
+
readonly type: "object";
|
|
2192
|
+
readonly properties: {
|
|
2193
|
+
readonly hour: {
|
|
2194
|
+
readonly type: "string";
|
|
2195
|
+
readonly description: "Hour of the usage";
|
|
2196
|
+
readonly example: "2019-01-01T00:00:00.000Z";
|
|
2197
|
+
};
|
|
2198
|
+
readonly cluster_id: {
|
|
2199
|
+
readonly type: "string";
|
|
2200
|
+
readonly description: "Unique identifier of the kubernetes cluster. UUID v4 string in canonical form";
|
|
2201
|
+
readonly example: "6b5439b1-923a-4f2b-a371-d554e5ea23fa";
|
|
2202
|
+
};
|
|
2203
|
+
readonly product: {
|
|
2204
|
+
readonly type: "string";
|
|
2205
|
+
readonly description: "The product the usage is associated with";
|
|
2206
|
+
readonly example: "cfke_controlplane";
|
|
2207
|
+
};
|
|
2208
|
+
readonly value: {
|
|
2209
|
+
readonly type: "number";
|
|
2210
|
+
readonly format: "float";
|
|
2211
|
+
readonly description: "Consumption";
|
|
2212
|
+
readonly example: 4;
|
|
2213
|
+
};
|
|
2214
|
+
readonly price: {
|
|
2215
|
+
readonly type: "number";
|
|
2216
|
+
readonly format: "float";
|
|
2217
|
+
readonly description: "Price per unit";
|
|
2218
|
+
readonly example: 0.01;
|
|
2219
|
+
};
|
|
2220
|
+
readonly total: {
|
|
2221
|
+
readonly type: "number";
|
|
2222
|
+
readonly format: "float";
|
|
2223
|
+
readonly description: "Total cost";
|
|
2224
|
+
};
|
|
2225
|
+
};
|
|
2226
|
+
readonly required: readonly ["hour", "cluster_id", "product", "value", "price", "total"];
|
|
2227
|
+
readonly additionalProperties: false;
|
|
2228
|
+
};
|
|
2229
|
+
readonly description: "Usage data";
|
|
2230
|
+
};
|
|
2231
|
+
readonly facets: {
|
|
2232
|
+
readonly type: "object";
|
|
2233
|
+
readonly properties: {
|
|
2234
|
+
readonly cluster_id: {
|
|
2235
|
+
readonly type: "array";
|
|
2236
|
+
readonly items: {
|
|
2237
|
+
readonly type: "string";
|
|
2238
|
+
};
|
|
2239
|
+
readonly description: "List of unique cluster IDs";
|
|
2240
|
+
readonly example: readonly ["6b5439b1-923a-4f2b-a371-d554e5ea23fa"];
|
|
2241
|
+
};
|
|
2242
|
+
readonly product: {
|
|
2243
|
+
readonly type: "array";
|
|
2244
|
+
readonly items: {
|
|
2245
|
+
readonly type: "string";
|
|
2246
|
+
};
|
|
2247
|
+
readonly description: "List of unique products";
|
|
2248
|
+
readonly example: readonly ["cfke_controlplane", "cfke_connected_nodes"];
|
|
2249
|
+
};
|
|
2250
|
+
};
|
|
2251
|
+
readonly additionalProperties: false;
|
|
2252
|
+
readonly description: "Facets for filtering";
|
|
2253
|
+
};
|
|
2254
|
+
};
|
|
2255
|
+
readonly required: readonly ["data", "facets"];
|
|
2256
|
+
readonly additionalProperties: false;
|
|
2257
|
+
};
|
|
1204
2258
|
export declare const UsageSchema: {
|
|
1205
2259
|
readonly type: "object";
|
|
1206
2260
|
readonly properties: {
|
|
@@ -1211,78 +2265,33 @@ export declare const UsageSchema: {
|
|
|
1211
2265
|
};
|
|
1212
2266
|
readonly cluster_id: {
|
|
1213
2267
|
readonly type: "string";
|
|
1214
|
-
readonly format: "uuid";
|
|
1215
2268
|
readonly description: "Unique identifier of the kubernetes cluster. UUID v4 string in canonical form";
|
|
1216
2269
|
readonly example: "6b5439b1-923a-4f2b-a371-d554e5ea23fa";
|
|
1217
2270
|
};
|
|
1218
|
-
readonly cluster_tier: {
|
|
1219
|
-
readonly type: "string";
|
|
1220
|
-
readonly description: "Tier of the cluster.";
|
|
1221
|
-
readonly example: "pro";
|
|
1222
|
-
readonly enum: readonly [""];
|
|
1223
|
-
};
|
|
1224
2271
|
readonly product: {
|
|
1225
2272
|
readonly type: "string";
|
|
1226
2273
|
readonly description: "The product the usage is associated with";
|
|
1227
|
-
readonly example: "
|
|
1228
|
-
readonly enum: readonly ["cfke_infra_compute", "cfke_nodes", "cfke_controlplane"];
|
|
1229
|
-
};
|
|
1230
|
-
readonly node_name: {
|
|
1231
|
-
readonly type: "string";
|
|
1232
|
-
readonly description: "Name of the Kubernetes node";
|
|
1233
|
-
readonly example: "flexible-moth-956037384";
|
|
1234
|
-
};
|
|
1235
|
-
readonly sku: {
|
|
1236
|
-
readonly type: "string";
|
|
1237
|
-
readonly description: "SKU of the Kubernetes node";
|
|
1238
|
-
readonly example: "GCP-NORTHAMERICA-NORTHEAST1-A-G1-SMALL-SPOT";
|
|
2274
|
+
readonly example: "cfke_controlplane";
|
|
1239
2275
|
};
|
|
1240
|
-
readonly
|
|
1241
|
-
readonly
|
|
1242
|
-
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
readonly example: 4;
|
|
1246
|
-
}, {
|
|
1247
|
-
readonly type: "string";
|
|
1248
|
-
readonly enum: readonly [""];
|
|
1249
|
-
}];
|
|
2276
|
+
readonly value: {
|
|
2277
|
+
readonly type: "number";
|
|
2278
|
+
readonly format: "float";
|
|
2279
|
+
readonly description: "Consumption";
|
|
2280
|
+
readonly example: 4;
|
|
1250
2281
|
};
|
|
1251
2282
|
readonly price: {
|
|
1252
|
-
readonly
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
|
|
1256
|
-
readonly example: 4;
|
|
1257
|
-
}, {
|
|
1258
|
-
readonly type: "string";
|
|
1259
|
-
readonly enum: readonly [""];
|
|
1260
|
-
}];
|
|
1261
|
-
};
|
|
1262
|
-
readonly value: {
|
|
1263
|
-
readonly anyOf: readonly [{
|
|
1264
|
-
readonly type: "number";
|
|
1265
|
-
readonly format: "float";
|
|
1266
|
-
readonly description: "Value";
|
|
1267
|
-
readonly example: 4;
|
|
1268
|
-
}, {
|
|
1269
|
-
readonly type: "string";
|
|
1270
|
-
readonly enum: readonly [""];
|
|
1271
|
-
}];
|
|
2283
|
+
readonly type: "number";
|
|
2284
|
+
readonly format: "float";
|
|
2285
|
+
readonly description: "Price per unit";
|
|
2286
|
+
readonly example: 0.01;
|
|
1272
2287
|
};
|
|
1273
2288
|
readonly total: {
|
|
1274
|
-
readonly
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
readonly description: "Total";
|
|
1278
|
-
readonly example: 4;
|
|
1279
|
-
}, {
|
|
1280
|
-
readonly type: "string";
|
|
1281
|
-
readonly enum: readonly [""];
|
|
1282
|
-
}];
|
|
2289
|
+
readonly type: "number";
|
|
2290
|
+
readonly format: "float";
|
|
2291
|
+
readonly description: "Total cost";
|
|
1283
2292
|
};
|
|
1284
2293
|
};
|
|
1285
|
-
readonly required: readonly ["
|
|
2294
|
+
readonly required: readonly ["hour", "cluster_id", "product", "value", "price", "total"];
|
|
1286
2295
|
readonly additionalProperties: false;
|
|
1287
2296
|
};
|
|
1288
2297
|
export declare const UserCreateInputSchema: {
|
|
@@ -1319,18 +2328,6 @@ export declare const UserCreateInputSchema: {
|
|
|
1319
2328
|
readonly minLength: 8;
|
|
1320
2329
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
1321
2330
|
};
|
|
1322
|
-
readonly status: {
|
|
1323
|
-
readonly type: "string";
|
|
1324
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
1325
|
-
readonly example: "active";
|
|
1326
|
-
readonly enum: readonly ["active", "inactive"];
|
|
1327
|
-
};
|
|
1328
|
-
readonly role: {
|
|
1329
|
-
readonly type: "string";
|
|
1330
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
1331
|
-
readonly example: "User";
|
|
1332
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
1333
|
-
};
|
|
1334
2331
|
};
|
|
1335
2332
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
1336
2333
|
readonly additionalProperties: false;
|