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