@silas-sh/supabase-management-js 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +106 -0
- package/dist/index.d.mts +4431 -0
- package/dist/index.d.ts +4431 -0
- package/dist/index.js +1205 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +1201 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +50 -0
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,4431 @@
|
|
|
1
|
+
import * as openapi_fetch from 'openapi-fetch';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* This file was auto-generated by openapi-typescript.
|
|
5
|
+
* Do not make direct changes to the file.
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
/** OneOf type helpers */
|
|
10
|
+
type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };
|
|
11
|
+
type XOR<T, U> = (T | U) extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
|
|
12
|
+
type OneOf<T extends any[]> = T extends [infer Only] ? Only : T extends [infer A, infer B, ...infer Rest] ? OneOf<[XOR<A, B>, ...Rest]> : never;
|
|
13
|
+
|
|
14
|
+
interface paths {
|
|
15
|
+
"/v1/branches/{branch_id}": {
|
|
16
|
+
/**
|
|
17
|
+
* Get database branch config
|
|
18
|
+
* @description Fetches configurations of the specified database branch
|
|
19
|
+
*/
|
|
20
|
+
get: operations["v1-get-a-branch-config"];
|
|
21
|
+
/**
|
|
22
|
+
* Delete a database branch
|
|
23
|
+
* @description Deletes the specified database branch
|
|
24
|
+
*/
|
|
25
|
+
delete: operations["v1-delete-a-branch"];
|
|
26
|
+
/**
|
|
27
|
+
* Update database branch config
|
|
28
|
+
* @description Updates the configuration of the specified database branch
|
|
29
|
+
*/
|
|
30
|
+
patch: operations["v1-update-a-branch-config"];
|
|
31
|
+
};
|
|
32
|
+
"/v1/branches/{branch_id}/push": {
|
|
33
|
+
/**
|
|
34
|
+
* Pushes a database branch
|
|
35
|
+
* @description Pushes the specified database branch
|
|
36
|
+
*/
|
|
37
|
+
post: operations["v1-push-a-branch"];
|
|
38
|
+
};
|
|
39
|
+
"/v1/branches/{branch_id}/merge": {
|
|
40
|
+
/**
|
|
41
|
+
* Merges a database branch
|
|
42
|
+
* @description Merges the specified database branch
|
|
43
|
+
*/
|
|
44
|
+
post: operations["v1-merge-a-branch"];
|
|
45
|
+
};
|
|
46
|
+
"/v1/branches/{branch_id}/reset": {
|
|
47
|
+
/**
|
|
48
|
+
* Resets a database branch
|
|
49
|
+
* @description Resets the specified database branch
|
|
50
|
+
*/
|
|
51
|
+
post: operations["v1-reset-a-branch"];
|
|
52
|
+
};
|
|
53
|
+
"/v1/projects": {
|
|
54
|
+
/**
|
|
55
|
+
* List all projects
|
|
56
|
+
* @description Returns a list of all projects you've previously created.
|
|
57
|
+
*/
|
|
58
|
+
get: operations["v1-list-all-projects"];
|
|
59
|
+
/** Create a project */
|
|
60
|
+
post: operations["v1-create-a-project"];
|
|
61
|
+
};
|
|
62
|
+
"/v1/organizations": {
|
|
63
|
+
/**
|
|
64
|
+
* List all organizations
|
|
65
|
+
* @description Returns a list of organizations that you currently belong to.
|
|
66
|
+
*/
|
|
67
|
+
get: operations["v1-list-all-organizations"];
|
|
68
|
+
/** Create an organization */
|
|
69
|
+
post: operations["v1-create-an-organization"];
|
|
70
|
+
};
|
|
71
|
+
"/v1/oauth/authorize": {
|
|
72
|
+
/** [Beta] Authorize user through oauth */
|
|
73
|
+
get: operations["v1-authorize-user"];
|
|
74
|
+
};
|
|
75
|
+
"/v1/oauth/token": {
|
|
76
|
+
/** [Beta] Exchange auth code for user's access and refresh token */
|
|
77
|
+
post: operations["v1-exchange-oauth-token"];
|
|
78
|
+
};
|
|
79
|
+
"/v1/oauth/revoke": {
|
|
80
|
+
/** [Beta] Revoke oauth app authorization and it's corresponding tokens */
|
|
81
|
+
post: operations["v1-revoke-token"];
|
|
82
|
+
};
|
|
83
|
+
"/v1/snippets": {
|
|
84
|
+
/** Lists SQL snippets for the logged in user */
|
|
85
|
+
get: operations["v1-list-all-snippets"];
|
|
86
|
+
};
|
|
87
|
+
"/v1/snippets/{id}": {
|
|
88
|
+
/** Gets a specific SQL snippet */
|
|
89
|
+
get: operations["v1-get-a-snippet"];
|
|
90
|
+
};
|
|
91
|
+
"/v1/projects/{ref}/api-keys": {
|
|
92
|
+
/** Get project api keys */
|
|
93
|
+
get: operations["v1-get-project-api-keys"];
|
|
94
|
+
/** [Alpha] Creates a new API key for the project */
|
|
95
|
+
post: operations["createApiKey"];
|
|
96
|
+
};
|
|
97
|
+
"/v1/projects/{ref}/api-keys/{id}": {
|
|
98
|
+
/** [Alpha] Get API key */
|
|
99
|
+
get: operations["getApiKey"];
|
|
100
|
+
/** [Alpha] Deletes an API key for the project */
|
|
101
|
+
delete: operations["deleteApiKey"];
|
|
102
|
+
/** [Alpha] Updates an API key for the project */
|
|
103
|
+
patch: operations["updateApiKey"];
|
|
104
|
+
};
|
|
105
|
+
"/v1/projects/{ref}/branches": {
|
|
106
|
+
/**
|
|
107
|
+
* List all database branches
|
|
108
|
+
* @description Returns all database branches of the specified project.
|
|
109
|
+
*/
|
|
110
|
+
get: operations["v1-list-all-branches"];
|
|
111
|
+
/**
|
|
112
|
+
* Create a database branch
|
|
113
|
+
* @description Creates a database branch from the specified project.
|
|
114
|
+
*/
|
|
115
|
+
post: operations["v1-create-a-branch"];
|
|
116
|
+
/**
|
|
117
|
+
* Disables preview branching
|
|
118
|
+
* @description Disables preview branching for the specified project
|
|
119
|
+
*/
|
|
120
|
+
delete: operations["v1-disable-preview-branching"];
|
|
121
|
+
};
|
|
122
|
+
"/v1/projects/{ref}/custom-hostname": {
|
|
123
|
+
/** [Beta] Gets project's custom hostname config */
|
|
124
|
+
get: operations["v1-get-hostname-config"];
|
|
125
|
+
/** [Beta] Deletes a project's custom hostname configuration */
|
|
126
|
+
delete: operations["v1-Delete hostname config"];
|
|
127
|
+
};
|
|
128
|
+
"/v1/projects/{ref}/custom-hostname/initialize": {
|
|
129
|
+
/** [Beta] Updates project's custom hostname configuration */
|
|
130
|
+
post: operations["v1-update-hostname-config"];
|
|
131
|
+
};
|
|
132
|
+
"/v1/projects/{ref}/custom-hostname/reverify": {
|
|
133
|
+
/** [Beta] Attempts to verify the DNS configuration for project's custom hostname configuration */
|
|
134
|
+
post: operations["v1-verify-dns-config"];
|
|
135
|
+
};
|
|
136
|
+
"/v1/projects/{ref}/custom-hostname/activate": {
|
|
137
|
+
/** [Beta] Activates a custom hostname for a project. */
|
|
138
|
+
post: operations["v1-activate-custom-hostname"];
|
|
139
|
+
};
|
|
140
|
+
"/v1/projects/{ref}/network-bans/retrieve": {
|
|
141
|
+
/** [Beta] Gets project's network bans */
|
|
142
|
+
post: operations["v1-list-all-network-bans"];
|
|
143
|
+
};
|
|
144
|
+
"/v1/projects/{ref}/network-bans": {
|
|
145
|
+
/** [Beta] Remove network bans. */
|
|
146
|
+
delete: operations["v1-delete-network-bans"];
|
|
147
|
+
};
|
|
148
|
+
"/v1/projects/{ref}/network-restrictions": {
|
|
149
|
+
/** [Beta] Gets project's network restrictions */
|
|
150
|
+
get: operations["v1-get-network-restrictions"];
|
|
151
|
+
};
|
|
152
|
+
"/v1/projects/{ref}/network-restrictions/apply": {
|
|
153
|
+
/** [Beta] Updates project's network restrictions */
|
|
154
|
+
post: operations["v1-update-network-restrictions"];
|
|
155
|
+
};
|
|
156
|
+
"/v1/projects/{ref}/pgsodium": {
|
|
157
|
+
/** [Beta] Gets project's pgsodium config */
|
|
158
|
+
get: operations["v1-get-pgsodium-config"];
|
|
159
|
+
/** [Beta] Updates project's pgsodium config. Updating the root_key can cause all data encrypted with the older key to become inaccessible. */
|
|
160
|
+
put: operations["v1-update-pgsodium-config"];
|
|
161
|
+
};
|
|
162
|
+
"/v1/projects/{ref}/postgrest": {
|
|
163
|
+
/** Gets project's postgrest config */
|
|
164
|
+
get: operations["v1-get-postgrest-service-config"];
|
|
165
|
+
/** Updates project's postgrest config */
|
|
166
|
+
patch: operations["v1-update-postgrest-service-config"];
|
|
167
|
+
};
|
|
168
|
+
"/v1/projects/{ref}": {
|
|
169
|
+
/** Gets a specific project that belongs to the authenticated user */
|
|
170
|
+
get: operations["v1-get-project"];
|
|
171
|
+
/** Deletes the given project */
|
|
172
|
+
delete: operations["v1-delete-a-project"];
|
|
173
|
+
};
|
|
174
|
+
"/v1/projects/{ref}/secrets": {
|
|
175
|
+
/**
|
|
176
|
+
* List all secrets
|
|
177
|
+
* @description Returns all secrets you've previously added to the specified project.
|
|
178
|
+
*/
|
|
179
|
+
get: operations["v1-list-all-secrets"];
|
|
180
|
+
/**
|
|
181
|
+
* Bulk create secrets
|
|
182
|
+
* @description Creates multiple secrets and adds them to the specified project.
|
|
183
|
+
*/
|
|
184
|
+
post: operations["v1-bulk-create-secrets"];
|
|
185
|
+
/**
|
|
186
|
+
* Bulk delete secrets
|
|
187
|
+
* @description Deletes all secrets with the given names from the specified project
|
|
188
|
+
*/
|
|
189
|
+
delete: operations["v1-bulk-delete-secrets"];
|
|
190
|
+
};
|
|
191
|
+
"/v1/projects/{ref}/ssl-enforcement": {
|
|
192
|
+
/** [Beta] Get project's SSL enforcement configuration. */
|
|
193
|
+
get: operations["v1-get-ssl-enforcement-config"];
|
|
194
|
+
/** [Beta] Update project's SSL enforcement configuration. */
|
|
195
|
+
put: operations["v1-update-ssl-enforcement-config"];
|
|
196
|
+
};
|
|
197
|
+
"/v1/projects/{ref}/types/typescript": {
|
|
198
|
+
/**
|
|
199
|
+
* Generate TypeScript types
|
|
200
|
+
* @description Returns the TypeScript types of your schema for use with supabase-js.
|
|
201
|
+
*/
|
|
202
|
+
get: operations["v1-generate-typescript-types"];
|
|
203
|
+
};
|
|
204
|
+
"/v1/projects/{ref}/vanity-subdomain": {
|
|
205
|
+
/** [Beta] Gets current vanity subdomain config */
|
|
206
|
+
get: operations["v1-get-vanity-subdomain-config"];
|
|
207
|
+
/** [Beta] Deletes a project's vanity subdomain configuration */
|
|
208
|
+
delete: operations["v1-deactivate-vanity-subdomain-config"];
|
|
209
|
+
};
|
|
210
|
+
"/v1/projects/{ref}/vanity-subdomain/check-availability": {
|
|
211
|
+
/** [Beta] Checks vanity subdomain availability */
|
|
212
|
+
post: operations["v1-check-vanity-subdomain-availability"];
|
|
213
|
+
};
|
|
214
|
+
"/v1/projects/{ref}/vanity-subdomain/activate": {
|
|
215
|
+
/** [Beta] Activates a vanity subdomain for a project. */
|
|
216
|
+
post: operations["v1-activate-vanity-subdomain-config"];
|
|
217
|
+
};
|
|
218
|
+
"/v1/projects/{ref}/upgrade": {
|
|
219
|
+
/** [Beta] Upgrades the project's Postgres version */
|
|
220
|
+
post: operations["v1-upgrade-postgres-version"];
|
|
221
|
+
};
|
|
222
|
+
"/v1/projects/{ref}/upgrade/eligibility": {
|
|
223
|
+
/** [Beta] Returns the project's eligibility for upgrades */
|
|
224
|
+
get: operations["v1-get-postgres-upgrade-eligibility"];
|
|
225
|
+
};
|
|
226
|
+
"/v1/projects/{ref}/upgrade/status": {
|
|
227
|
+
/** [Beta] Gets the latest status of the project's upgrade */
|
|
228
|
+
get: operations["v1-get-postgres-upgrade-status"];
|
|
229
|
+
};
|
|
230
|
+
"/v1/projects/{ref}/readonly": {
|
|
231
|
+
/** Returns project's readonly mode status */
|
|
232
|
+
get: operations["v1-get-readonly-mode-status"];
|
|
233
|
+
};
|
|
234
|
+
"/v1/projects/{ref}/readonly/temporary-disable": {
|
|
235
|
+
/** Disables project's readonly mode for the next 15 minutes */
|
|
236
|
+
post: operations["v1-disable-readonly-mode-temporarily"];
|
|
237
|
+
};
|
|
238
|
+
"/v1/projects/{ref}/read-replicas/setup": {
|
|
239
|
+
/** [Beta] Set up a read replica */
|
|
240
|
+
post: operations["v1-setup-a-read-replica"];
|
|
241
|
+
};
|
|
242
|
+
"/v1/projects/{ref}/read-replicas/remove": {
|
|
243
|
+
/** [Beta] Remove a read replica */
|
|
244
|
+
post: operations["v1-remove-a-read-replica"];
|
|
245
|
+
};
|
|
246
|
+
"/v1/projects/{ref}/health": {
|
|
247
|
+
/** Gets project's service health status */
|
|
248
|
+
get: operations["v1-get-services-health"];
|
|
249
|
+
};
|
|
250
|
+
"/v1/projects/{ref}/config/auth/signing-keys": {
|
|
251
|
+
/** [Alpha] List all signing keys for the project */
|
|
252
|
+
get: operations["listSigningKeysForProject"];
|
|
253
|
+
/** [Alpha] Create a new signing key for the project in standby status */
|
|
254
|
+
post: operations["createSigningKeyForProject"];
|
|
255
|
+
};
|
|
256
|
+
"/v1/projects/{ref}/config/auth/signing-keys/{id}": {
|
|
257
|
+
/** [Alpha] Get information about a signing key */
|
|
258
|
+
get: operations["getSigningKeyForProject"];
|
|
259
|
+
/** [Alpha] Remove a signing key from a project, where the status is previously_used */
|
|
260
|
+
delete: operations["deleteSigningKey"];
|
|
261
|
+
/** [Alpha] Update a signing key, mainly its status */
|
|
262
|
+
patch: operations["patchSigningKey"];
|
|
263
|
+
};
|
|
264
|
+
"/v1/projects/{ref}/config/storage": {
|
|
265
|
+
/** Gets project's storage config */
|
|
266
|
+
get: operations["v1-get-storage-config"];
|
|
267
|
+
/** Updates project's storage config */
|
|
268
|
+
patch: operations["v1-update-storage-config"];
|
|
269
|
+
};
|
|
270
|
+
"/v1/projects/{ref}/config/database/postgres": {
|
|
271
|
+
/** Gets project's Postgres config */
|
|
272
|
+
get: operations["v1-get-postgres-config"];
|
|
273
|
+
/** Updates project's Postgres config */
|
|
274
|
+
put: operations["v1-update-postgres-config"];
|
|
275
|
+
};
|
|
276
|
+
"/v1/projects/{ref}/config/database/pgbouncer": {
|
|
277
|
+
/** Get project's pgbouncer config */
|
|
278
|
+
get: operations["v1-get-project-pgbouncer-config"];
|
|
279
|
+
};
|
|
280
|
+
"/v1/projects/{ref}/config/database/pooler": {
|
|
281
|
+
/** Gets project's supavisor config */
|
|
282
|
+
get: operations["getSupavisorConfig"];
|
|
283
|
+
/** Updates project's supavisor config */
|
|
284
|
+
patch: operations["updateSupavisorConfig"];
|
|
285
|
+
};
|
|
286
|
+
"/v1/projects/{ref}/config/auth": {
|
|
287
|
+
/** Gets project's auth config */
|
|
288
|
+
get: operations["v1-get-auth-service-config"];
|
|
289
|
+
/** Updates a project's auth config */
|
|
290
|
+
patch: operations["v1-update-auth-service-config"];
|
|
291
|
+
};
|
|
292
|
+
"/v1/projects/{ref}/config/auth/third-party-auth": {
|
|
293
|
+
/** Lists all third-party auth integrations */
|
|
294
|
+
get: operations["listTPAForProject"];
|
|
295
|
+
/** Creates a new third-party auth integration */
|
|
296
|
+
post: operations["createTPAForProject"];
|
|
297
|
+
};
|
|
298
|
+
"/v1/projects/{ref}/config/auth/third-party-auth/{tpa_id}": {
|
|
299
|
+
/** Get a third-party integration */
|
|
300
|
+
get: operations["getTPAForProject"];
|
|
301
|
+
/** Removes a third-party auth integration */
|
|
302
|
+
delete: operations["deleteTPAForProject"];
|
|
303
|
+
};
|
|
304
|
+
"/v1/projects/{ref}/pause": {
|
|
305
|
+
/** Pauses the given project */
|
|
306
|
+
post: operations["v1-pause-a-project"];
|
|
307
|
+
};
|
|
308
|
+
"/v1/projects/{ref}/restore": {
|
|
309
|
+
/** Lists available restore versions for the given project */
|
|
310
|
+
get: operations["v1-list-available-restore-versions"];
|
|
311
|
+
/** Restores the given project */
|
|
312
|
+
post: operations["v1-restore-a-project"];
|
|
313
|
+
};
|
|
314
|
+
"/v1/projects/{ref}/restore/cancel": {
|
|
315
|
+
/** Cancels the given project restoration */
|
|
316
|
+
post: operations["v1-cancel-a-project-restoration"];
|
|
317
|
+
};
|
|
318
|
+
"/v1/projects/{ref}/billing/addons": {
|
|
319
|
+
/** Lists project addons */
|
|
320
|
+
get: operations["v1-list-project-addons"];
|
|
321
|
+
/** Applies project addon */
|
|
322
|
+
patch: operations["v1-apply-project-addon"];
|
|
323
|
+
};
|
|
324
|
+
"/v1/projects/{ref}/billing/addons/{addon_variant}": {
|
|
325
|
+
/** Removes project addon */
|
|
326
|
+
delete: operations["v1-remove-project-addon"];
|
|
327
|
+
};
|
|
328
|
+
"/v1/projects/{ref}/advisors/performance": {
|
|
329
|
+
/**
|
|
330
|
+
* Gets project performance advisors.
|
|
331
|
+
* @deprecated
|
|
332
|
+
* @description This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
|
|
333
|
+
*/
|
|
334
|
+
get: operations["getPerformanceAdvisors"];
|
|
335
|
+
};
|
|
336
|
+
"/v1/projects/{ref}/advisors/security": {
|
|
337
|
+
/**
|
|
338
|
+
* Gets project security advisors.
|
|
339
|
+
* @deprecated
|
|
340
|
+
* @description This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
|
|
341
|
+
*/
|
|
342
|
+
get: operations["getSecurityAdvisors"];
|
|
343
|
+
};
|
|
344
|
+
"/v1/projects/{ref}/analytics/endpoints/logs.all": {
|
|
345
|
+
/**
|
|
346
|
+
* Gets project's logs
|
|
347
|
+
* @description Executes a SQL query on the project's logs.
|
|
348
|
+
*
|
|
349
|
+
* Either the 'iso_timestamp_start' and 'iso_timestamp_end' parameters must be provided.
|
|
350
|
+
* If both are not provided, only the last 1 minute of logs will be queried.
|
|
351
|
+
* The timestamp range must be no more than 24 hours and is rounded to the nearest minute. If the range is more than 24 hours, a validation error will be thrown.
|
|
352
|
+
*/
|
|
353
|
+
get: operations["getLogs"];
|
|
354
|
+
};
|
|
355
|
+
"/v1/projects/{ref}/database/migrations": {
|
|
356
|
+
/**
|
|
357
|
+
* [Beta] List applied migration versions
|
|
358
|
+
* @description Only available to selected partner OAuth apps
|
|
359
|
+
*/
|
|
360
|
+
get: operations["v1-list-migrations"];
|
|
361
|
+
/**
|
|
362
|
+
* [Beta] Apply a database migration
|
|
363
|
+
* @description Only available to selected partner OAuth apps
|
|
364
|
+
*/
|
|
365
|
+
post: operations["v1-apply-a-migration"];
|
|
366
|
+
};
|
|
367
|
+
"/v1/projects/{ref}/database/query": {
|
|
368
|
+
/** [Beta] Run sql query */
|
|
369
|
+
post: operations["v1-run-a-query"];
|
|
370
|
+
};
|
|
371
|
+
"/v1/projects/{ref}/database/webhooks/enable": {
|
|
372
|
+
/** [Beta] Enables Database Webhooks on the project */
|
|
373
|
+
post: operations["v1-enable-database-webhook"];
|
|
374
|
+
};
|
|
375
|
+
"/v1/projects/{ref}/database/context": {
|
|
376
|
+
/**
|
|
377
|
+
* Gets database metadata for the given project.
|
|
378
|
+
* @deprecated
|
|
379
|
+
* @description This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
|
|
380
|
+
*/
|
|
381
|
+
get: operations["getDatabaseMetadata"];
|
|
382
|
+
};
|
|
383
|
+
"/v1/projects/{ref}/functions": {
|
|
384
|
+
/**
|
|
385
|
+
* List all functions
|
|
386
|
+
* @description Returns all functions you've previously added to the specified project.
|
|
387
|
+
*/
|
|
388
|
+
get: operations["v1-list-all-functions"];
|
|
389
|
+
/**
|
|
390
|
+
* Bulk update functions
|
|
391
|
+
* @description Bulk update functions. It will create a new function or replace existing. The operation is idempotent. NOTE: You will need to manually bump the version.
|
|
392
|
+
*/
|
|
393
|
+
put: operations["v1-bulk-update-functions"];
|
|
394
|
+
/**
|
|
395
|
+
* Create a function
|
|
396
|
+
* @deprecated
|
|
397
|
+
* @description This endpoint is deprecated - use the deploy endpoint. Creates a function and adds it to the specified project.
|
|
398
|
+
*/
|
|
399
|
+
post: operations["v1-create-a-function"];
|
|
400
|
+
};
|
|
401
|
+
"/v1/projects/{ref}/functions/deploy": {
|
|
402
|
+
/**
|
|
403
|
+
* Deploy a function
|
|
404
|
+
* @description A new endpoint to deploy functions. It will create if function does not exist.
|
|
405
|
+
*/
|
|
406
|
+
post: operations["v1-deploy-a-function"];
|
|
407
|
+
};
|
|
408
|
+
"/v1/projects/{ref}/functions/{function_slug}": {
|
|
409
|
+
/**
|
|
410
|
+
* Retrieve a function
|
|
411
|
+
* @description Retrieves a function with the specified slug and project.
|
|
412
|
+
*/
|
|
413
|
+
get: operations["v1-get-a-function"];
|
|
414
|
+
/**
|
|
415
|
+
* Delete a function
|
|
416
|
+
* @description Deletes a function with the specified slug from the specified project.
|
|
417
|
+
*/
|
|
418
|
+
delete: operations["v1-delete-a-function"];
|
|
419
|
+
/**
|
|
420
|
+
* Update a function
|
|
421
|
+
* @description Updates a function with the specified slug and project.
|
|
422
|
+
*/
|
|
423
|
+
patch: operations["v1-update-a-function"];
|
|
424
|
+
};
|
|
425
|
+
"/v1/projects/{ref}/functions/{function_slug}/body": {
|
|
426
|
+
/**
|
|
427
|
+
* Retrieve a function body
|
|
428
|
+
* @description Retrieves a function body for the specified slug and project.
|
|
429
|
+
*/
|
|
430
|
+
get: operations["v1-get-a-function-body"];
|
|
431
|
+
};
|
|
432
|
+
"/v1/projects/{ref}/storage/buckets": {
|
|
433
|
+
/** Lists all buckets */
|
|
434
|
+
get: operations["v1-list-all-buckets"];
|
|
435
|
+
};
|
|
436
|
+
"/v1/projects/{ref}/config/auth/sso/providers": {
|
|
437
|
+
/** Lists all SSO providers */
|
|
438
|
+
get: operations["v1-list-all-sso-provider"];
|
|
439
|
+
/** Creates a new SSO provider */
|
|
440
|
+
post: operations["v1-create-a-sso-provider"];
|
|
441
|
+
};
|
|
442
|
+
"/v1/projects/{ref}/config/auth/sso/providers/{provider_id}": {
|
|
443
|
+
/** Gets a SSO provider by its UUID */
|
|
444
|
+
get: operations["v1-get-a-sso-provider"];
|
|
445
|
+
/** Updates a SSO provider by its UUID */
|
|
446
|
+
put: operations["v1-update-a-sso-provider"];
|
|
447
|
+
/** Removes a SSO provider by its UUID */
|
|
448
|
+
delete: operations["v1-delete-a-sso-provider"];
|
|
449
|
+
};
|
|
450
|
+
"/v1/projects/{ref}/database/backups": {
|
|
451
|
+
/** Lists all backups */
|
|
452
|
+
get: operations["v1-list-all-backups"];
|
|
453
|
+
};
|
|
454
|
+
"/v1/projects/{ref}/database/backups/restore-pitr": {
|
|
455
|
+
/** Restores a PITR backup for a database */
|
|
456
|
+
post: operations["v1-restore-pitr-backup"];
|
|
457
|
+
};
|
|
458
|
+
"/v1/organizations/{slug}/members": {
|
|
459
|
+
/** List members of an organization */
|
|
460
|
+
get: operations["v1-list-organization-members"];
|
|
461
|
+
};
|
|
462
|
+
"/v1/organizations/{slug}": {
|
|
463
|
+
/** Gets information about the organization */
|
|
464
|
+
get: operations["v1-get-an-organization"];
|
|
465
|
+
};
|
|
466
|
+
}
|
|
467
|
+
|
|
468
|
+
interface components {
|
|
469
|
+
schemas: {
|
|
470
|
+
BranchDetailResponse: {
|
|
471
|
+
ref: string;
|
|
472
|
+
postgres_version: string;
|
|
473
|
+
postgres_engine: string;
|
|
474
|
+
release_channel: string;
|
|
475
|
+
/** @enum {string} */
|
|
476
|
+
status: "INACTIVE" | "ACTIVE_HEALTHY" | "ACTIVE_UNHEALTHY" | "COMING_UP" | "UNKNOWN" | "GOING_DOWN" | "INIT_FAILED" | "REMOVED" | "RESTORING" | "UPGRADING" | "PAUSING" | "RESTORE_FAILED" | "RESTARTING" | "PAUSE_FAILED" | "RESIZING";
|
|
477
|
+
db_host: string;
|
|
478
|
+
db_port: number;
|
|
479
|
+
db_user?: string;
|
|
480
|
+
db_pass?: string;
|
|
481
|
+
jwt_secret?: string;
|
|
482
|
+
};
|
|
483
|
+
UpdateBranchBody: {
|
|
484
|
+
branch_name?: string;
|
|
485
|
+
git_branch?: string;
|
|
486
|
+
/**
|
|
487
|
+
* @deprecated
|
|
488
|
+
* @description This field is deprecated and will be ignored. Use v1-reset-a-branch endpoint directly instead.
|
|
489
|
+
*/
|
|
490
|
+
reset_on_push?: boolean;
|
|
491
|
+
persistent?: boolean;
|
|
492
|
+
/** @enum {string} */
|
|
493
|
+
status?: "CREATING_PROJECT" | "RUNNING_MIGRATIONS" | "MIGRATIONS_PASSED" | "MIGRATIONS_FAILED" | "FUNCTIONS_DEPLOYED" | "FUNCTIONS_FAILED";
|
|
494
|
+
};
|
|
495
|
+
BranchResponse: {
|
|
496
|
+
id: string;
|
|
497
|
+
name: string;
|
|
498
|
+
project_ref: string;
|
|
499
|
+
parent_project_ref: string;
|
|
500
|
+
is_default: boolean;
|
|
501
|
+
git_branch?: string;
|
|
502
|
+
/** Format: int32 */
|
|
503
|
+
pr_number?: number;
|
|
504
|
+
/**
|
|
505
|
+
* @deprecated
|
|
506
|
+
* @description This field is deprecated and will not be populated.
|
|
507
|
+
*/
|
|
508
|
+
latest_check_run_id?: number;
|
|
509
|
+
persistent: boolean;
|
|
510
|
+
/** @enum {string} */
|
|
511
|
+
status: "CREATING_PROJECT" | "RUNNING_MIGRATIONS" | "MIGRATIONS_PASSED" | "MIGRATIONS_FAILED" | "FUNCTIONS_DEPLOYED" | "FUNCTIONS_FAILED";
|
|
512
|
+
created_at: string;
|
|
513
|
+
updated_at: string;
|
|
514
|
+
};
|
|
515
|
+
BranchDeleteResponse: {
|
|
516
|
+
/** @enum {string} */
|
|
517
|
+
message: "ok";
|
|
518
|
+
};
|
|
519
|
+
BranchActionBody: {
|
|
520
|
+
migration_version?: string;
|
|
521
|
+
};
|
|
522
|
+
BranchUpdateResponse: {
|
|
523
|
+
workflow_run_id: string;
|
|
524
|
+
/** @enum {string} */
|
|
525
|
+
message: "ok";
|
|
526
|
+
};
|
|
527
|
+
V1DatabaseResponse: {
|
|
528
|
+
/** @description Database host */
|
|
529
|
+
host: string;
|
|
530
|
+
/** @description Database version */
|
|
531
|
+
version: string;
|
|
532
|
+
/** @description Database engine */
|
|
533
|
+
postgres_engine: string;
|
|
534
|
+
/** @description Release channel */
|
|
535
|
+
release_channel: string;
|
|
536
|
+
};
|
|
537
|
+
V1ProjectWithDatabaseResponse: {
|
|
538
|
+
/** @description Id of your project */
|
|
539
|
+
id: string;
|
|
540
|
+
/** @description Slug of your organization */
|
|
541
|
+
organization_id: string;
|
|
542
|
+
/** @description Name of your project */
|
|
543
|
+
name: string;
|
|
544
|
+
/**
|
|
545
|
+
* @description Region of your project
|
|
546
|
+
* @example us-east-1
|
|
547
|
+
*/
|
|
548
|
+
region: string;
|
|
549
|
+
/**
|
|
550
|
+
* @description Creation timestamp
|
|
551
|
+
* @example 2023-03-29T16:32:59Z
|
|
552
|
+
*/
|
|
553
|
+
created_at: string;
|
|
554
|
+
/** @enum {string} */
|
|
555
|
+
status: "INACTIVE" | "ACTIVE_HEALTHY" | "ACTIVE_UNHEALTHY" | "COMING_UP" | "UNKNOWN" | "GOING_DOWN" | "INIT_FAILED" | "REMOVED" | "RESTORING" | "UPGRADING" | "PAUSING" | "RESTORE_FAILED" | "RESTARTING" | "PAUSE_FAILED" | "RESIZING";
|
|
556
|
+
database: components["schemas"]["V1DatabaseResponse"];
|
|
557
|
+
};
|
|
558
|
+
V1CreateProjectBodyDto: {
|
|
559
|
+
/** @description Database password */
|
|
560
|
+
db_pass: string;
|
|
561
|
+
/** @description Name of your project */
|
|
562
|
+
name: string;
|
|
563
|
+
/** @description Slug of your organization */
|
|
564
|
+
organization_id: string;
|
|
565
|
+
/**
|
|
566
|
+
* @deprecated
|
|
567
|
+
* @description Subscription Plan is now set on organization level and is ignored in this request
|
|
568
|
+
* @enum {string}
|
|
569
|
+
*/
|
|
570
|
+
plan?: "free" | "pro";
|
|
571
|
+
/**
|
|
572
|
+
* @description Region you want your server to reside in
|
|
573
|
+
* @enum {string}
|
|
574
|
+
*/
|
|
575
|
+
region: "us-east-1" | "us-east-2" | "us-west-1" | "us-west-2" | "ap-east-1" | "ap-southeast-1" | "ap-northeast-1" | "ap-northeast-2" | "ap-southeast-2" | "eu-west-1" | "eu-west-2" | "eu-west-3" | "eu-north-1" | "eu-central-1" | "eu-central-2" | "ca-central-1" | "ap-south-1" | "sa-east-1";
|
|
576
|
+
/**
|
|
577
|
+
* @deprecated
|
|
578
|
+
* @description This field is deprecated and is ignored in this request
|
|
579
|
+
*/
|
|
580
|
+
kps_enabled?: boolean;
|
|
581
|
+
/** @enum {string} */
|
|
582
|
+
desired_instance_size?: "micro" | "small" | "medium" | "large" | "xlarge" | "2xlarge" | "4xlarge" | "8xlarge" | "12xlarge" | "16xlarge";
|
|
583
|
+
/**
|
|
584
|
+
* Format: uri
|
|
585
|
+
* @description Template URL used to create the project from the CLI.
|
|
586
|
+
* @example https://github.com/supabase/supabase/tree/master/examples/slack-clone/nextjs-slack-clone
|
|
587
|
+
*/
|
|
588
|
+
template_url?: string;
|
|
589
|
+
};
|
|
590
|
+
V1ProjectResponse: {
|
|
591
|
+
/** @description Id of your project */
|
|
592
|
+
id: string;
|
|
593
|
+
/** @description Slug of your organization */
|
|
594
|
+
organization_id: string;
|
|
595
|
+
/** @description Name of your project */
|
|
596
|
+
name: string;
|
|
597
|
+
/**
|
|
598
|
+
* @description Region of your project
|
|
599
|
+
* @example us-east-1
|
|
600
|
+
*/
|
|
601
|
+
region: string;
|
|
602
|
+
/**
|
|
603
|
+
* @description Creation timestamp
|
|
604
|
+
* @example 2023-03-29T16:32:59Z
|
|
605
|
+
*/
|
|
606
|
+
created_at: string;
|
|
607
|
+
/** @enum {string} */
|
|
608
|
+
status: "INACTIVE" | "ACTIVE_HEALTHY" | "ACTIVE_UNHEALTHY" | "COMING_UP" | "UNKNOWN" | "GOING_DOWN" | "INIT_FAILED" | "REMOVED" | "RESTORING" | "UPGRADING" | "PAUSING" | "RESTORE_FAILED" | "RESTARTING" | "PAUSE_FAILED" | "RESIZING";
|
|
609
|
+
};
|
|
610
|
+
OrganizationResponseV1: {
|
|
611
|
+
id: string;
|
|
612
|
+
name: string;
|
|
613
|
+
};
|
|
614
|
+
CreateOrganizationV1Dto: {
|
|
615
|
+
name: string;
|
|
616
|
+
};
|
|
617
|
+
OAuthTokenBody: {
|
|
618
|
+
/** @enum {string} */
|
|
619
|
+
grant_type?: "authorization_code" | "refresh_token";
|
|
620
|
+
/** Format: uuid */
|
|
621
|
+
client_id?: string;
|
|
622
|
+
client_secret?: string;
|
|
623
|
+
code?: string;
|
|
624
|
+
code_verifier?: string;
|
|
625
|
+
redirect_uri?: string;
|
|
626
|
+
refresh_token?: string;
|
|
627
|
+
};
|
|
628
|
+
OAuthTokenResponse: {
|
|
629
|
+
access_token: string;
|
|
630
|
+
refresh_token: string;
|
|
631
|
+
expires_in: number;
|
|
632
|
+
/** @enum {string} */
|
|
633
|
+
token_type: "Bearer";
|
|
634
|
+
};
|
|
635
|
+
OAuthRevokeTokenBodyDto: {
|
|
636
|
+
/** Format: uuid */
|
|
637
|
+
client_id: string;
|
|
638
|
+
client_secret: string;
|
|
639
|
+
refresh_token: string;
|
|
640
|
+
};
|
|
641
|
+
SnippetProject: {
|
|
642
|
+
/** Format: int64 */
|
|
643
|
+
id: number;
|
|
644
|
+
name: string;
|
|
645
|
+
};
|
|
646
|
+
SnippetUser: {
|
|
647
|
+
/** Format: int64 */
|
|
648
|
+
id: number;
|
|
649
|
+
username: string;
|
|
650
|
+
};
|
|
651
|
+
SnippetMeta: {
|
|
652
|
+
id: string;
|
|
653
|
+
inserted_at: string;
|
|
654
|
+
updated_at: string;
|
|
655
|
+
/** @enum {string} */
|
|
656
|
+
type: "sql";
|
|
657
|
+
/** @enum {string} */
|
|
658
|
+
visibility: "user" | "project" | "org" | "public";
|
|
659
|
+
name: string;
|
|
660
|
+
description: string | null;
|
|
661
|
+
project: components["schemas"]["SnippetProject"];
|
|
662
|
+
owner: components["schemas"]["SnippetUser"];
|
|
663
|
+
updated_by: components["schemas"]["SnippetUser"];
|
|
664
|
+
};
|
|
665
|
+
SnippetList: {
|
|
666
|
+
data: (components["schemas"]["SnippetMeta"])[];
|
|
667
|
+
cursor?: string;
|
|
668
|
+
};
|
|
669
|
+
SnippetContent: {
|
|
670
|
+
favorite: boolean;
|
|
671
|
+
schema_version: string;
|
|
672
|
+
sql: string;
|
|
673
|
+
};
|
|
674
|
+
SnippetResponse: {
|
|
675
|
+
id: string;
|
|
676
|
+
inserted_at: string;
|
|
677
|
+
updated_at: string;
|
|
678
|
+
/** @enum {string} */
|
|
679
|
+
type: "sql";
|
|
680
|
+
/** @enum {string} */
|
|
681
|
+
visibility: "user" | "project" | "org" | "public";
|
|
682
|
+
name: string;
|
|
683
|
+
description: string | null;
|
|
684
|
+
project: components["schemas"]["SnippetProject"];
|
|
685
|
+
owner: components["schemas"]["SnippetUser"];
|
|
686
|
+
updated_by: components["schemas"]["SnippetUser"];
|
|
687
|
+
content: components["schemas"]["SnippetContent"];
|
|
688
|
+
};
|
|
689
|
+
ApiKeyResponse: {
|
|
690
|
+
name: string;
|
|
691
|
+
api_key: string;
|
|
692
|
+
id?: string | null;
|
|
693
|
+
/** @enum {string|null} */
|
|
694
|
+
type?: "publishable" | "secret" | "legacy" | null;
|
|
695
|
+
prefix?: string | null;
|
|
696
|
+
description?: string | null;
|
|
697
|
+
hash?: string | null;
|
|
698
|
+
secret_jwt_template?: {
|
|
699
|
+
role: string;
|
|
700
|
+
} | null;
|
|
701
|
+
/** Format: date-time */
|
|
702
|
+
inserted_at?: string | null;
|
|
703
|
+
/** Format: date-time */
|
|
704
|
+
updated_at?: string | null;
|
|
705
|
+
};
|
|
706
|
+
CreateApiKeyBody: {
|
|
707
|
+
/** @enum {string} */
|
|
708
|
+
type: "publishable" | "secret";
|
|
709
|
+
description?: string | null;
|
|
710
|
+
secret_jwt_template?: {
|
|
711
|
+
role: string;
|
|
712
|
+
} | null;
|
|
713
|
+
};
|
|
714
|
+
UpdateApiKeyBody: {
|
|
715
|
+
description?: string | null;
|
|
716
|
+
secret_jwt_template?: {
|
|
717
|
+
role: string;
|
|
718
|
+
} | null;
|
|
719
|
+
};
|
|
720
|
+
CreateBranchBody: {
|
|
721
|
+
branch_name: string;
|
|
722
|
+
git_branch?: string;
|
|
723
|
+
persistent?: boolean;
|
|
724
|
+
region?: string;
|
|
725
|
+
/** @enum {string} */
|
|
726
|
+
desired_instance_size?: "pico" | "nano" | "micro" | "small" | "medium" | "large" | "xlarge" | "2xlarge" | "4xlarge" | "8xlarge" | "12xlarge" | "16xlarge";
|
|
727
|
+
/**
|
|
728
|
+
* @description Release channel. If not provided, GA will be used.
|
|
729
|
+
* @enum {string}
|
|
730
|
+
*/
|
|
731
|
+
release_channel?: "internal" | "alpha" | "beta" | "ga" | "withdrawn" | "preview";
|
|
732
|
+
/**
|
|
733
|
+
* @description Postgres engine version. If not provided, the latest version will be used.
|
|
734
|
+
* @enum {string}
|
|
735
|
+
*/
|
|
736
|
+
postgres_engine?: "15" | "17-oriole";
|
|
737
|
+
secrets?: {
|
|
738
|
+
[key: string]: string | undefined;
|
|
739
|
+
};
|
|
740
|
+
};
|
|
741
|
+
UpdateCustomHostnameResponse: {
|
|
742
|
+
/** @enum {string} */
|
|
743
|
+
status: "1_not_started" | "2_initiated" | "3_challenge_verified" | "4_origin_setup_completed" | "5_services_reconfigured";
|
|
744
|
+
custom_hostname: string;
|
|
745
|
+
data: {
|
|
746
|
+
success: boolean;
|
|
747
|
+
errors: (unknown)[];
|
|
748
|
+
messages: (unknown)[];
|
|
749
|
+
result: {
|
|
750
|
+
id: string;
|
|
751
|
+
hostname: string;
|
|
752
|
+
ssl: {
|
|
753
|
+
status: string;
|
|
754
|
+
validation_records: ({
|
|
755
|
+
txt_name: string;
|
|
756
|
+
txt_value: string;
|
|
757
|
+
})[];
|
|
758
|
+
validation_errors?: ({
|
|
759
|
+
message: string;
|
|
760
|
+
})[];
|
|
761
|
+
};
|
|
762
|
+
ownership_verification: {
|
|
763
|
+
type: string;
|
|
764
|
+
name: string;
|
|
765
|
+
value: string;
|
|
766
|
+
};
|
|
767
|
+
custom_origin_server: string;
|
|
768
|
+
verification_errors?: (string)[];
|
|
769
|
+
status: string;
|
|
770
|
+
};
|
|
771
|
+
};
|
|
772
|
+
};
|
|
773
|
+
UpdateCustomHostnameBody: {
|
|
774
|
+
custom_hostname: string;
|
|
775
|
+
};
|
|
776
|
+
NetworkBanResponse: {
|
|
777
|
+
banned_ipv4_addresses: (string)[];
|
|
778
|
+
};
|
|
779
|
+
RemoveNetworkBanRequest: {
|
|
780
|
+
ipv4_addresses: (string)[];
|
|
781
|
+
};
|
|
782
|
+
NetworkRestrictionsResponse: {
|
|
783
|
+
/** @enum {string} */
|
|
784
|
+
entitlement: "disallowed" | "allowed";
|
|
785
|
+
/** @description At any given point in time, this is the config that the user has requested be applied to their project. The `status` field indicates if it has been applied to the project, or is pending. When an updated config is received, the applied config is moved to `old_config`. */
|
|
786
|
+
config: {
|
|
787
|
+
dbAllowedCidrs?: (string)[];
|
|
788
|
+
dbAllowedCidrsV6?: (string)[];
|
|
789
|
+
};
|
|
790
|
+
/** @description Populated when a new config has been received, but not registered as successfully applied to a project. */
|
|
791
|
+
old_config?: {
|
|
792
|
+
dbAllowedCidrs?: (string)[];
|
|
793
|
+
dbAllowedCidrsV6?: (string)[];
|
|
794
|
+
};
|
|
795
|
+
/** @enum {string} */
|
|
796
|
+
status: "stored" | "applied";
|
|
797
|
+
};
|
|
798
|
+
NetworkRestrictionsRequest: {
|
|
799
|
+
dbAllowedCidrs?: (string)[];
|
|
800
|
+
dbAllowedCidrsV6?: (string)[];
|
|
801
|
+
};
|
|
802
|
+
PgsodiumConfigResponse: {
|
|
803
|
+
root_key: string;
|
|
804
|
+
};
|
|
805
|
+
UpdatePgsodiumConfigBody: {
|
|
806
|
+
root_key: string;
|
|
807
|
+
};
|
|
808
|
+
PostgrestConfigWithJWTSecretResponse: {
|
|
809
|
+
db_schema: string;
|
|
810
|
+
max_rows: number;
|
|
811
|
+
db_extra_search_path: string;
|
|
812
|
+
/** @description If `null`, the value is automatically configured based on compute size. */
|
|
813
|
+
db_pool: number | null;
|
|
814
|
+
jwt_secret?: string;
|
|
815
|
+
};
|
|
816
|
+
V1UpdatePostgrestConfigBody: {
|
|
817
|
+
db_extra_search_path?: string;
|
|
818
|
+
db_schema?: string;
|
|
819
|
+
max_rows?: number;
|
|
820
|
+
db_pool?: number;
|
|
821
|
+
};
|
|
822
|
+
V1PostgrestConfigResponse: {
|
|
823
|
+
db_schema: string;
|
|
824
|
+
max_rows: number;
|
|
825
|
+
db_extra_search_path: string;
|
|
826
|
+
/** @description If `null`, the value is automatically configured based on compute size. */
|
|
827
|
+
db_pool: number | null;
|
|
828
|
+
};
|
|
829
|
+
V1ProjectRefResponse: {
|
|
830
|
+
/** Format: int64 */
|
|
831
|
+
id: number;
|
|
832
|
+
ref: string;
|
|
833
|
+
name: string;
|
|
834
|
+
};
|
|
835
|
+
SecretResponse: {
|
|
836
|
+
name: string;
|
|
837
|
+
value: string;
|
|
838
|
+
updated_at?: string;
|
|
839
|
+
};
|
|
840
|
+
CreateSecretBody: ({
|
|
841
|
+
/**
|
|
842
|
+
* @description Secret name must not start with the SUPABASE_ prefix.
|
|
843
|
+
* @example string
|
|
844
|
+
*/
|
|
845
|
+
name: string;
|
|
846
|
+
value: string;
|
|
847
|
+
})[];
|
|
848
|
+
SslEnforcementResponse: {
|
|
849
|
+
currentConfig: {
|
|
850
|
+
database: boolean;
|
|
851
|
+
};
|
|
852
|
+
appliedSuccessfully: boolean;
|
|
853
|
+
};
|
|
854
|
+
SslEnforcementRequest: {
|
|
855
|
+
requestedConfig: {
|
|
856
|
+
database: boolean;
|
|
857
|
+
};
|
|
858
|
+
};
|
|
859
|
+
TypescriptResponse: {
|
|
860
|
+
types: string;
|
|
861
|
+
};
|
|
862
|
+
VanitySubdomainConfigResponse: {
|
|
863
|
+
/** @enum {string} */
|
|
864
|
+
status: "not-used" | "custom-domain-used" | "active";
|
|
865
|
+
custom_domain?: string;
|
|
866
|
+
};
|
|
867
|
+
VanitySubdomainBody: {
|
|
868
|
+
vanity_subdomain: string;
|
|
869
|
+
};
|
|
870
|
+
SubdomainAvailabilityResponse: {
|
|
871
|
+
available: boolean;
|
|
872
|
+
};
|
|
873
|
+
ActivateVanitySubdomainResponse: {
|
|
874
|
+
custom_domain: string;
|
|
875
|
+
};
|
|
876
|
+
UpgradeDatabaseBody: {
|
|
877
|
+
target_version: string;
|
|
878
|
+
/** @enum {string} */
|
|
879
|
+
release_channel?: "internal" | "alpha" | "beta" | "ga" | "withdrawn" | "preview";
|
|
880
|
+
};
|
|
881
|
+
ProjectUpgradeInitiateResponse: {
|
|
882
|
+
tracking_id: string;
|
|
883
|
+
};
|
|
884
|
+
ProjectUpgradeEligibilityResponse: {
|
|
885
|
+
eligible: boolean;
|
|
886
|
+
current_app_version: string;
|
|
887
|
+
/** @enum {string} */
|
|
888
|
+
current_app_version_release_channel: "internal" | "alpha" | "beta" | "ga" | "withdrawn" | "preview";
|
|
889
|
+
latest_app_version: string;
|
|
890
|
+
target_upgrade_versions: ({
|
|
891
|
+
/** @enum {string} */
|
|
892
|
+
postgres_version: "15" | "17-oriole";
|
|
893
|
+
/** @enum {string} */
|
|
894
|
+
release_channel: "internal" | "alpha" | "beta" | "ga" | "withdrawn" | "preview";
|
|
895
|
+
app_version: string;
|
|
896
|
+
})[];
|
|
897
|
+
potential_breaking_changes: (string)[];
|
|
898
|
+
duration_estimate_hours: number;
|
|
899
|
+
legacy_auth_custom_roles: (string)[];
|
|
900
|
+
extension_dependent_objects: (string)[];
|
|
901
|
+
};
|
|
902
|
+
DatabaseUpgradeStatusResponse: {
|
|
903
|
+
databaseUpgradeStatus: ({
|
|
904
|
+
initiated_at: string;
|
|
905
|
+
latest_status_at: string;
|
|
906
|
+
target_version: number;
|
|
907
|
+
/** @enum {string} */
|
|
908
|
+
error?: "1_upgraded_instance_launch_failed" | "2_volume_detachchment_from_upgraded_instance_failed" | "3_volume_attachment_to_original_instance_failed" | "4_data_upgrade_initiation_failed" | "5_data_upgrade_completion_failed" | "6_volume_detachchment_from_original_instance_failed" | "7_volume_attachment_to_upgraded_instance_failed" | "8_upgrade_completion_failed" | "9_post_physical_backup_failed";
|
|
909
|
+
/** @enum {string} */
|
|
910
|
+
progress?: "0_requested" | "1_started" | "2_launched_upgraded_instance" | "3_detached_volume_from_upgraded_instance" | "4_attached_volume_to_original_instance" | "5_initiated_data_upgrade" | "6_completed_data_upgrade" | "7_detached_volume_from_original_instance" | "8_attached_volume_to_upgraded_instance" | "9_completed_upgrade" | "10_completed_post_physical_backup";
|
|
911
|
+
status: number;
|
|
912
|
+
}) | null;
|
|
913
|
+
};
|
|
914
|
+
ReadOnlyStatusResponse: {
|
|
915
|
+
enabled: boolean;
|
|
916
|
+
override_enabled: boolean;
|
|
917
|
+
override_active_until: string;
|
|
918
|
+
};
|
|
919
|
+
SetUpReadReplicaBody: {
|
|
920
|
+
/**
|
|
921
|
+
* @description Region you want your read replica to reside in
|
|
922
|
+
* @example us-east-1
|
|
923
|
+
* @enum {string}
|
|
924
|
+
*/
|
|
925
|
+
read_replica_region: "us-east-1" | "us-east-2" | "us-west-1" | "us-west-2" | "ap-east-1" | "ap-southeast-1" | "ap-northeast-1" | "ap-northeast-2" | "ap-southeast-2" | "eu-west-1" | "eu-west-2" | "eu-west-3" | "eu-north-1" | "eu-central-1" | "eu-central-2" | "ca-central-1" | "ap-south-1" | "sa-east-1";
|
|
926
|
+
};
|
|
927
|
+
RemoveReadReplicaBody: {
|
|
928
|
+
database_identifier: string;
|
|
929
|
+
};
|
|
930
|
+
V1ServiceHealthResponse: {
|
|
931
|
+
/** @enum {string} */
|
|
932
|
+
name: "auth" | "db" | "pooler" | "realtime" | "rest" | "storage";
|
|
933
|
+
healthy: boolean;
|
|
934
|
+
/** @enum {string} */
|
|
935
|
+
status: "COMING_UP" | "ACTIVE_HEALTHY" | "UNHEALTHY";
|
|
936
|
+
info?: OneOf<[{
|
|
937
|
+
/** @enum {string} */
|
|
938
|
+
name: "GoTrue";
|
|
939
|
+
version: string;
|
|
940
|
+
description: string;
|
|
941
|
+
}, {
|
|
942
|
+
healthy: boolean;
|
|
943
|
+
db_connected: boolean;
|
|
944
|
+
connected_cluster: number;
|
|
945
|
+
}]>;
|
|
946
|
+
error?: string;
|
|
947
|
+
};
|
|
948
|
+
CreateSigningKeyBody: {
|
|
949
|
+
/** @enum {string} */
|
|
950
|
+
algorithm: "EdDSA" | "ES256" | "RS256" | "HS256";
|
|
951
|
+
/** @enum {string} */
|
|
952
|
+
status?: "in_use" | "standby";
|
|
953
|
+
};
|
|
954
|
+
SigningKeysResponse: {
|
|
955
|
+
keys: ({
|
|
956
|
+
/** Format: uuid */
|
|
957
|
+
id: string;
|
|
958
|
+
/** @enum {string} */
|
|
959
|
+
algorithm: "EdDSA" | "ES256" | "RS256" | "HS256";
|
|
960
|
+
/** @enum {string} */
|
|
961
|
+
status: "in_use" | "previously_used" | "revoked" | "standby";
|
|
962
|
+
public_jwk?: Record<string, unknown> | null;
|
|
963
|
+
/** Format: date-time */
|
|
964
|
+
created_at: string;
|
|
965
|
+
/** Format: date-time */
|
|
966
|
+
updated_at: string;
|
|
967
|
+
})[];
|
|
968
|
+
};
|
|
969
|
+
SigningKeyResponse: {
|
|
970
|
+
/** Format: uuid */
|
|
971
|
+
id: string;
|
|
972
|
+
/** @enum {string} */
|
|
973
|
+
algorithm: "EdDSA" | "ES256" | "RS256" | "HS256";
|
|
974
|
+
/** @enum {string} */
|
|
975
|
+
status: "in_use" | "previously_used" | "revoked" | "standby";
|
|
976
|
+
public_jwk?: Record<string, unknown> | null;
|
|
977
|
+
/** Format: date-time */
|
|
978
|
+
created_at: string;
|
|
979
|
+
/** Format: date-time */
|
|
980
|
+
updated_at: string;
|
|
981
|
+
};
|
|
982
|
+
UpdateSigningKeyBody: {
|
|
983
|
+
/** @enum {string} */
|
|
984
|
+
status: "in_use" | "previously_used" | "revoked" | "standby";
|
|
985
|
+
};
|
|
986
|
+
StorageConfigResponse: {
|
|
987
|
+
fileSizeLimit: number;
|
|
988
|
+
features: {
|
|
989
|
+
imageTransformation: {
|
|
990
|
+
enabled: boolean;
|
|
991
|
+
};
|
|
992
|
+
s3Protocol: {
|
|
993
|
+
enabled: boolean;
|
|
994
|
+
};
|
|
995
|
+
};
|
|
996
|
+
};
|
|
997
|
+
UpdateStorageConfigBody: {
|
|
998
|
+
fileSizeLimit?: number;
|
|
999
|
+
features?: {
|
|
1000
|
+
imageTransformation: {
|
|
1001
|
+
enabled: boolean;
|
|
1002
|
+
};
|
|
1003
|
+
s3Protocol: {
|
|
1004
|
+
enabled: boolean;
|
|
1005
|
+
};
|
|
1006
|
+
};
|
|
1007
|
+
};
|
|
1008
|
+
PostgresConfigResponse: {
|
|
1009
|
+
effective_cache_size?: string;
|
|
1010
|
+
logical_decoding_work_mem?: string;
|
|
1011
|
+
maintenance_work_mem?: string;
|
|
1012
|
+
track_activity_query_size?: string;
|
|
1013
|
+
max_connections?: number;
|
|
1014
|
+
max_locks_per_transaction?: number;
|
|
1015
|
+
max_parallel_maintenance_workers?: number;
|
|
1016
|
+
max_parallel_workers?: number;
|
|
1017
|
+
max_parallel_workers_per_gather?: number;
|
|
1018
|
+
max_replication_slots?: number;
|
|
1019
|
+
max_slot_wal_keep_size?: string;
|
|
1020
|
+
max_standby_archive_delay?: string;
|
|
1021
|
+
max_standby_streaming_delay?: string;
|
|
1022
|
+
max_wal_size?: string;
|
|
1023
|
+
max_wal_senders?: number;
|
|
1024
|
+
max_worker_processes?: number;
|
|
1025
|
+
/** @enum {string} */
|
|
1026
|
+
session_replication_role?: "origin" | "replica" | "local";
|
|
1027
|
+
shared_buffers?: string;
|
|
1028
|
+
statement_timeout?: string;
|
|
1029
|
+
track_commit_timestamp?: boolean;
|
|
1030
|
+
wal_keep_size?: string;
|
|
1031
|
+
wal_sender_timeout?: string;
|
|
1032
|
+
work_mem?: string;
|
|
1033
|
+
};
|
|
1034
|
+
UpdatePostgresConfigBody: {
|
|
1035
|
+
effective_cache_size?: string;
|
|
1036
|
+
logical_decoding_work_mem?: string;
|
|
1037
|
+
maintenance_work_mem?: string;
|
|
1038
|
+
track_activity_query_size?: string;
|
|
1039
|
+
max_connections?: number;
|
|
1040
|
+
max_locks_per_transaction?: number;
|
|
1041
|
+
max_parallel_maintenance_workers?: number;
|
|
1042
|
+
max_parallel_workers?: number;
|
|
1043
|
+
max_parallel_workers_per_gather?: number;
|
|
1044
|
+
max_replication_slots?: number;
|
|
1045
|
+
max_slot_wal_keep_size?: string;
|
|
1046
|
+
max_standby_archive_delay?: string;
|
|
1047
|
+
max_standby_streaming_delay?: string;
|
|
1048
|
+
max_wal_size?: string;
|
|
1049
|
+
max_wal_senders?: number;
|
|
1050
|
+
max_worker_processes?: number;
|
|
1051
|
+
/** @enum {string} */
|
|
1052
|
+
session_replication_role?: "origin" | "replica" | "local";
|
|
1053
|
+
shared_buffers?: string;
|
|
1054
|
+
statement_timeout?: string;
|
|
1055
|
+
track_commit_timestamp?: boolean;
|
|
1056
|
+
wal_keep_size?: string;
|
|
1057
|
+
wal_sender_timeout?: string;
|
|
1058
|
+
work_mem?: string;
|
|
1059
|
+
restart_database?: boolean;
|
|
1060
|
+
};
|
|
1061
|
+
V1PgbouncerConfigResponse: {
|
|
1062
|
+
/** @enum {string} */
|
|
1063
|
+
pool_mode?: "transaction" | "session" | "statement";
|
|
1064
|
+
default_pool_size?: number;
|
|
1065
|
+
ignore_startup_parameters?: string;
|
|
1066
|
+
max_client_conn?: number;
|
|
1067
|
+
connection_string?: string;
|
|
1068
|
+
};
|
|
1069
|
+
SupavisorConfigResponse: {
|
|
1070
|
+
identifier: string;
|
|
1071
|
+
/** @enum {string} */
|
|
1072
|
+
database_type: "PRIMARY" | "READ_REPLICA";
|
|
1073
|
+
is_using_scram_auth: boolean;
|
|
1074
|
+
db_user: string;
|
|
1075
|
+
db_host: string;
|
|
1076
|
+
db_port: number;
|
|
1077
|
+
db_name: string;
|
|
1078
|
+
connection_string: string;
|
|
1079
|
+
/** @description Use connection_string instead */
|
|
1080
|
+
connectionString: string;
|
|
1081
|
+
default_pool_size: number | null;
|
|
1082
|
+
max_client_conn: number | null;
|
|
1083
|
+
/** @enum {string} */
|
|
1084
|
+
pool_mode: "transaction" | "session";
|
|
1085
|
+
};
|
|
1086
|
+
UpdateSupavisorConfigBody: {
|
|
1087
|
+
default_pool_size?: number | null;
|
|
1088
|
+
/**
|
|
1089
|
+
* @description Dedicated pooler mode for the project
|
|
1090
|
+
* @enum {string}
|
|
1091
|
+
*/
|
|
1092
|
+
pool_mode?: "transaction" | "session";
|
|
1093
|
+
};
|
|
1094
|
+
UpdateSupavisorConfigResponse: {
|
|
1095
|
+
default_pool_size: number | null;
|
|
1096
|
+
pool_mode: string;
|
|
1097
|
+
};
|
|
1098
|
+
AuthConfigResponse: {
|
|
1099
|
+
api_max_request_duration: number | null;
|
|
1100
|
+
db_max_pool_size: number | null;
|
|
1101
|
+
disable_signup: boolean | null;
|
|
1102
|
+
external_anonymous_users_enabled: boolean | null;
|
|
1103
|
+
external_apple_additional_client_ids: string | null;
|
|
1104
|
+
external_apple_client_id: string | null;
|
|
1105
|
+
external_apple_enabled: boolean | null;
|
|
1106
|
+
external_apple_secret: string | null;
|
|
1107
|
+
external_azure_client_id: string | null;
|
|
1108
|
+
external_azure_enabled: boolean | null;
|
|
1109
|
+
external_azure_secret: string | null;
|
|
1110
|
+
external_azure_url: string | null;
|
|
1111
|
+
external_bitbucket_client_id: string | null;
|
|
1112
|
+
external_bitbucket_enabled: boolean | null;
|
|
1113
|
+
external_bitbucket_secret: string | null;
|
|
1114
|
+
external_discord_client_id: string | null;
|
|
1115
|
+
external_discord_enabled: boolean | null;
|
|
1116
|
+
external_discord_secret: string | null;
|
|
1117
|
+
external_email_enabled: boolean | null;
|
|
1118
|
+
external_facebook_client_id: string | null;
|
|
1119
|
+
external_facebook_enabled: boolean | null;
|
|
1120
|
+
external_facebook_secret: string | null;
|
|
1121
|
+
external_figma_client_id: string | null;
|
|
1122
|
+
external_figma_enabled: boolean | null;
|
|
1123
|
+
external_figma_secret: string | null;
|
|
1124
|
+
external_github_client_id: string | null;
|
|
1125
|
+
external_github_enabled: boolean | null;
|
|
1126
|
+
external_github_secret: string | null;
|
|
1127
|
+
external_gitlab_client_id: string | null;
|
|
1128
|
+
external_gitlab_enabled: boolean | null;
|
|
1129
|
+
external_gitlab_secret: string | null;
|
|
1130
|
+
external_gitlab_url: string | null;
|
|
1131
|
+
external_google_additional_client_ids: string | null;
|
|
1132
|
+
external_google_client_id: string | null;
|
|
1133
|
+
external_google_enabled: boolean | null;
|
|
1134
|
+
external_google_secret: string | null;
|
|
1135
|
+
external_google_skip_nonce_check: boolean | null;
|
|
1136
|
+
external_kakao_client_id: string | null;
|
|
1137
|
+
external_kakao_enabled: boolean | null;
|
|
1138
|
+
external_kakao_secret: string | null;
|
|
1139
|
+
external_keycloak_client_id: string | null;
|
|
1140
|
+
external_keycloak_enabled: boolean | null;
|
|
1141
|
+
external_keycloak_secret: string | null;
|
|
1142
|
+
external_keycloak_url: string | null;
|
|
1143
|
+
external_linkedin_oidc_client_id: string | null;
|
|
1144
|
+
external_linkedin_oidc_enabled: boolean | null;
|
|
1145
|
+
external_linkedin_oidc_secret: string | null;
|
|
1146
|
+
external_slack_oidc_client_id: string | null;
|
|
1147
|
+
external_slack_oidc_enabled: boolean | null;
|
|
1148
|
+
external_slack_oidc_secret: string | null;
|
|
1149
|
+
external_notion_client_id: string | null;
|
|
1150
|
+
external_notion_enabled: boolean | null;
|
|
1151
|
+
external_notion_secret: string | null;
|
|
1152
|
+
external_phone_enabled: boolean | null;
|
|
1153
|
+
external_slack_client_id: string | null;
|
|
1154
|
+
external_slack_enabled: boolean | null;
|
|
1155
|
+
external_slack_secret: string | null;
|
|
1156
|
+
external_spotify_client_id: string | null;
|
|
1157
|
+
external_spotify_enabled: boolean | null;
|
|
1158
|
+
external_spotify_secret: string | null;
|
|
1159
|
+
external_twitch_client_id: string | null;
|
|
1160
|
+
external_twitch_enabled: boolean | null;
|
|
1161
|
+
external_twitch_secret: string | null;
|
|
1162
|
+
external_twitter_client_id: string | null;
|
|
1163
|
+
external_twitter_enabled: boolean | null;
|
|
1164
|
+
external_twitter_secret: string | null;
|
|
1165
|
+
external_workos_client_id: string | null;
|
|
1166
|
+
external_workos_enabled: boolean | null;
|
|
1167
|
+
external_workos_secret: string | null;
|
|
1168
|
+
external_workos_url: string | null;
|
|
1169
|
+
external_web3_solana_enabled: boolean | null;
|
|
1170
|
+
external_zoom_client_id: string | null;
|
|
1171
|
+
external_zoom_enabled: boolean | null;
|
|
1172
|
+
external_zoom_secret: string | null;
|
|
1173
|
+
hook_custom_access_token_enabled: boolean | null;
|
|
1174
|
+
hook_custom_access_token_uri: string | null;
|
|
1175
|
+
hook_custom_access_token_secrets: string | null;
|
|
1176
|
+
hook_mfa_verification_attempt_enabled: boolean | null;
|
|
1177
|
+
hook_mfa_verification_attempt_uri: string | null;
|
|
1178
|
+
hook_mfa_verification_attempt_secrets: string | null;
|
|
1179
|
+
hook_password_verification_attempt_enabled: boolean | null;
|
|
1180
|
+
hook_password_verification_attempt_uri: string | null;
|
|
1181
|
+
hook_password_verification_attempt_secrets: string | null;
|
|
1182
|
+
hook_send_sms_enabled: boolean | null;
|
|
1183
|
+
hook_send_sms_uri: string | null;
|
|
1184
|
+
hook_send_sms_secrets: string | null;
|
|
1185
|
+
hook_send_email_enabled: boolean | null;
|
|
1186
|
+
hook_send_email_uri: string | null;
|
|
1187
|
+
hook_send_email_secrets: string | null;
|
|
1188
|
+
jwt_exp: number | null;
|
|
1189
|
+
mailer_allow_unverified_email_sign_ins: boolean | null;
|
|
1190
|
+
mailer_autoconfirm: boolean | null;
|
|
1191
|
+
mailer_otp_exp: number;
|
|
1192
|
+
mailer_otp_length: number | null;
|
|
1193
|
+
mailer_secure_email_change_enabled: boolean | null;
|
|
1194
|
+
mailer_subjects_confirmation: string | null;
|
|
1195
|
+
mailer_subjects_email_change: string | null;
|
|
1196
|
+
mailer_subjects_invite: string | null;
|
|
1197
|
+
mailer_subjects_magic_link: string | null;
|
|
1198
|
+
mailer_subjects_reauthentication: string | null;
|
|
1199
|
+
mailer_subjects_recovery: string | null;
|
|
1200
|
+
mailer_templates_confirmation_content: string | null;
|
|
1201
|
+
mailer_templates_email_change_content: string | null;
|
|
1202
|
+
mailer_templates_invite_content: string | null;
|
|
1203
|
+
mailer_templates_magic_link_content: string | null;
|
|
1204
|
+
mailer_templates_reauthentication_content: string | null;
|
|
1205
|
+
mailer_templates_recovery_content: string | null;
|
|
1206
|
+
mfa_max_enrolled_factors: number | null;
|
|
1207
|
+
mfa_totp_enroll_enabled: boolean | null;
|
|
1208
|
+
mfa_totp_verify_enabled: boolean | null;
|
|
1209
|
+
mfa_phone_enroll_enabled: boolean | null;
|
|
1210
|
+
mfa_phone_verify_enabled: boolean | null;
|
|
1211
|
+
mfa_web_authn_enroll_enabled: boolean | null;
|
|
1212
|
+
mfa_web_authn_verify_enabled: boolean | null;
|
|
1213
|
+
mfa_phone_otp_length: number;
|
|
1214
|
+
mfa_phone_template: string | null;
|
|
1215
|
+
mfa_phone_max_frequency: number | null;
|
|
1216
|
+
password_hibp_enabled: boolean | null;
|
|
1217
|
+
password_min_length: number | null;
|
|
1218
|
+
password_required_characters: string | null;
|
|
1219
|
+
rate_limit_anonymous_users: number | null;
|
|
1220
|
+
rate_limit_email_sent: number | null;
|
|
1221
|
+
rate_limit_sms_sent: number | null;
|
|
1222
|
+
rate_limit_token_refresh: number | null;
|
|
1223
|
+
rate_limit_verify: number | null;
|
|
1224
|
+
rate_limit_otp: number | null;
|
|
1225
|
+
rate_limit_web3: number | null;
|
|
1226
|
+
refresh_token_rotation_enabled: boolean | null;
|
|
1227
|
+
saml_enabled: boolean | null;
|
|
1228
|
+
saml_external_url: string | null;
|
|
1229
|
+
saml_allow_encrypted_assertions: boolean | null;
|
|
1230
|
+
security_captcha_enabled: boolean | null;
|
|
1231
|
+
security_captcha_provider: string | null;
|
|
1232
|
+
security_captcha_secret: string | null;
|
|
1233
|
+
security_manual_linking_enabled: boolean | null;
|
|
1234
|
+
security_refresh_token_reuse_interval: number | null;
|
|
1235
|
+
security_update_password_require_reauthentication: boolean | null;
|
|
1236
|
+
sessions_inactivity_timeout: number | null;
|
|
1237
|
+
sessions_single_per_user: boolean | null;
|
|
1238
|
+
sessions_tags: string | null;
|
|
1239
|
+
sessions_timebox: number | null;
|
|
1240
|
+
site_url: string | null;
|
|
1241
|
+
sms_autoconfirm: boolean | null;
|
|
1242
|
+
sms_max_frequency: number | null;
|
|
1243
|
+
sms_messagebird_access_key: string | null;
|
|
1244
|
+
sms_messagebird_originator: string | null;
|
|
1245
|
+
sms_otp_exp: number | null;
|
|
1246
|
+
sms_otp_length: number;
|
|
1247
|
+
sms_provider: string | null;
|
|
1248
|
+
sms_template: string | null;
|
|
1249
|
+
sms_test_otp: string | null;
|
|
1250
|
+
sms_test_otp_valid_until: string | null;
|
|
1251
|
+
sms_textlocal_api_key: string | null;
|
|
1252
|
+
sms_textlocal_sender: string | null;
|
|
1253
|
+
sms_twilio_account_sid: string | null;
|
|
1254
|
+
sms_twilio_auth_token: string | null;
|
|
1255
|
+
sms_twilio_content_sid: string | null;
|
|
1256
|
+
sms_twilio_message_service_sid: string | null;
|
|
1257
|
+
sms_twilio_verify_account_sid: string | null;
|
|
1258
|
+
sms_twilio_verify_auth_token: string | null;
|
|
1259
|
+
sms_twilio_verify_message_service_sid: string | null;
|
|
1260
|
+
sms_vonage_api_key: string | null;
|
|
1261
|
+
sms_vonage_api_secret: string | null;
|
|
1262
|
+
sms_vonage_from: string | null;
|
|
1263
|
+
smtp_admin_email: string | null;
|
|
1264
|
+
smtp_host: string | null;
|
|
1265
|
+
smtp_max_frequency: number | null;
|
|
1266
|
+
smtp_pass: string | null;
|
|
1267
|
+
smtp_port: string | null;
|
|
1268
|
+
smtp_sender_name: string | null;
|
|
1269
|
+
smtp_user: string | null;
|
|
1270
|
+
uri_allow_list: string | null;
|
|
1271
|
+
};
|
|
1272
|
+
UpdateAuthConfigBody: {
|
|
1273
|
+
site_url?: string | null;
|
|
1274
|
+
disable_signup?: boolean | null;
|
|
1275
|
+
jwt_exp?: number | null;
|
|
1276
|
+
smtp_admin_email?: string | null;
|
|
1277
|
+
smtp_host?: string | null;
|
|
1278
|
+
smtp_port?: string | null;
|
|
1279
|
+
smtp_user?: string | null;
|
|
1280
|
+
smtp_pass?: string | null;
|
|
1281
|
+
smtp_max_frequency?: number | null;
|
|
1282
|
+
smtp_sender_name?: string | null;
|
|
1283
|
+
mailer_allow_unverified_email_sign_ins?: boolean | null;
|
|
1284
|
+
mailer_autoconfirm?: boolean | null;
|
|
1285
|
+
mailer_subjects_invite?: string | null;
|
|
1286
|
+
mailer_subjects_confirmation?: string | null;
|
|
1287
|
+
mailer_subjects_recovery?: string | null;
|
|
1288
|
+
mailer_subjects_email_change?: string | null;
|
|
1289
|
+
mailer_subjects_magic_link?: string | null;
|
|
1290
|
+
mailer_subjects_reauthentication?: string | null;
|
|
1291
|
+
mailer_templates_invite_content?: string | null;
|
|
1292
|
+
mailer_templates_confirmation_content?: string | null;
|
|
1293
|
+
mailer_templates_recovery_content?: string | null;
|
|
1294
|
+
mailer_templates_email_change_content?: string | null;
|
|
1295
|
+
mailer_templates_magic_link_content?: string | null;
|
|
1296
|
+
mailer_templates_reauthentication_content?: string | null;
|
|
1297
|
+
mfa_max_enrolled_factors?: number | null;
|
|
1298
|
+
uri_allow_list?: string | null;
|
|
1299
|
+
external_anonymous_users_enabled?: boolean | null;
|
|
1300
|
+
external_email_enabled?: boolean | null;
|
|
1301
|
+
external_phone_enabled?: boolean | null;
|
|
1302
|
+
saml_enabled?: boolean | null;
|
|
1303
|
+
saml_external_url?: string | null;
|
|
1304
|
+
security_captcha_enabled?: boolean | null;
|
|
1305
|
+
/** @enum {string|null} */
|
|
1306
|
+
security_captcha_provider?: "turnstile" | "hcaptcha" | null;
|
|
1307
|
+
security_captcha_secret?: string | null;
|
|
1308
|
+
sessions_timebox?: number | null;
|
|
1309
|
+
sessions_inactivity_timeout?: number | null;
|
|
1310
|
+
sessions_single_per_user?: boolean | null;
|
|
1311
|
+
sessions_tags?: string | null;
|
|
1312
|
+
rate_limit_anonymous_users?: number | null;
|
|
1313
|
+
rate_limit_email_sent?: number | null;
|
|
1314
|
+
rate_limit_sms_sent?: number | null;
|
|
1315
|
+
rate_limit_verify?: number | null;
|
|
1316
|
+
rate_limit_token_refresh?: number | null;
|
|
1317
|
+
rate_limit_otp?: number | null;
|
|
1318
|
+
rate_limit_web3?: number | null;
|
|
1319
|
+
mailer_secure_email_change_enabled?: boolean | null;
|
|
1320
|
+
refresh_token_rotation_enabled?: boolean | null;
|
|
1321
|
+
password_hibp_enabled?: boolean | null;
|
|
1322
|
+
password_min_length?: number | null;
|
|
1323
|
+
/** @enum {string|null} */
|
|
1324
|
+
password_required_characters?: "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789" | "abcdefghijklmnopqrstuvwxyz:ABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789" | ("abcdefghijklmnopqrstuvwxyz:ABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789:!@#$%^&*()_+-=[]{};'\\:\"|<>?,./`~") | "" | null;
|
|
1325
|
+
security_manual_linking_enabled?: boolean | null;
|
|
1326
|
+
security_update_password_require_reauthentication?: boolean | null;
|
|
1327
|
+
security_refresh_token_reuse_interval?: number | null;
|
|
1328
|
+
mailer_otp_exp?: number;
|
|
1329
|
+
mailer_otp_length?: number | null;
|
|
1330
|
+
sms_autoconfirm?: boolean | null;
|
|
1331
|
+
sms_max_frequency?: number | null;
|
|
1332
|
+
sms_otp_exp?: number | null;
|
|
1333
|
+
sms_otp_length?: number;
|
|
1334
|
+
/** @enum {string|null} */
|
|
1335
|
+
sms_provider?: "messagebird" | "textlocal" | "twilio" | "twilio_verify" | "vonage" | null;
|
|
1336
|
+
sms_messagebird_access_key?: string | null;
|
|
1337
|
+
sms_messagebird_originator?: string | null;
|
|
1338
|
+
sms_test_otp?: string | null;
|
|
1339
|
+
/** Format: date-time */
|
|
1340
|
+
sms_test_otp_valid_until?: string | null;
|
|
1341
|
+
sms_textlocal_api_key?: string | null;
|
|
1342
|
+
sms_textlocal_sender?: string | null;
|
|
1343
|
+
sms_twilio_account_sid?: string | null;
|
|
1344
|
+
sms_twilio_auth_token?: string | null;
|
|
1345
|
+
sms_twilio_content_sid?: string | null;
|
|
1346
|
+
sms_twilio_message_service_sid?: string | null;
|
|
1347
|
+
sms_twilio_verify_account_sid?: string | null;
|
|
1348
|
+
sms_twilio_verify_auth_token?: string | null;
|
|
1349
|
+
sms_twilio_verify_message_service_sid?: string | null;
|
|
1350
|
+
sms_vonage_api_key?: string | null;
|
|
1351
|
+
sms_vonage_api_secret?: string | null;
|
|
1352
|
+
sms_vonage_from?: string | null;
|
|
1353
|
+
sms_template?: string | null;
|
|
1354
|
+
hook_mfa_verification_attempt_enabled?: boolean | null;
|
|
1355
|
+
hook_mfa_verification_attempt_uri?: string | null;
|
|
1356
|
+
hook_mfa_verification_attempt_secrets?: string | null;
|
|
1357
|
+
hook_password_verification_attempt_enabled?: boolean | null;
|
|
1358
|
+
hook_password_verification_attempt_uri?: string | null;
|
|
1359
|
+
hook_password_verification_attempt_secrets?: string | null;
|
|
1360
|
+
hook_custom_access_token_enabled?: boolean | null;
|
|
1361
|
+
hook_custom_access_token_uri?: string | null;
|
|
1362
|
+
hook_custom_access_token_secrets?: string | null;
|
|
1363
|
+
hook_send_sms_enabled?: boolean | null;
|
|
1364
|
+
hook_send_sms_uri?: string | null;
|
|
1365
|
+
hook_send_sms_secrets?: string | null;
|
|
1366
|
+
hook_send_email_enabled?: boolean | null;
|
|
1367
|
+
hook_send_email_uri?: string | null;
|
|
1368
|
+
hook_send_email_secrets?: string | null;
|
|
1369
|
+
external_apple_enabled?: boolean | null;
|
|
1370
|
+
external_apple_client_id?: string | null;
|
|
1371
|
+
external_apple_secret?: string | null;
|
|
1372
|
+
external_apple_additional_client_ids?: string | null;
|
|
1373
|
+
external_azure_enabled?: boolean | null;
|
|
1374
|
+
external_azure_client_id?: string | null;
|
|
1375
|
+
external_azure_secret?: string | null;
|
|
1376
|
+
external_azure_url?: string | null;
|
|
1377
|
+
external_bitbucket_enabled?: boolean | null;
|
|
1378
|
+
external_bitbucket_client_id?: string | null;
|
|
1379
|
+
external_bitbucket_secret?: string | null;
|
|
1380
|
+
external_discord_enabled?: boolean | null;
|
|
1381
|
+
external_discord_client_id?: string | null;
|
|
1382
|
+
external_discord_secret?: string | null;
|
|
1383
|
+
external_facebook_enabled?: boolean | null;
|
|
1384
|
+
external_facebook_client_id?: string | null;
|
|
1385
|
+
external_facebook_secret?: string | null;
|
|
1386
|
+
external_figma_enabled?: boolean | null;
|
|
1387
|
+
external_figma_client_id?: string | null;
|
|
1388
|
+
external_figma_secret?: string | null;
|
|
1389
|
+
external_github_enabled?: boolean | null;
|
|
1390
|
+
external_github_client_id?: string | null;
|
|
1391
|
+
external_github_secret?: string | null;
|
|
1392
|
+
external_gitlab_enabled?: boolean | null;
|
|
1393
|
+
external_gitlab_client_id?: string | null;
|
|
1394
|
+
external_gitlab_secret?: string | null;
|
|
1395
|
+
external_gitlab_url?: string | null;
|
|
1396
|
+
external_google_enabled?: boolean | null;
|
|
1397
|
+
external_google_client_id?: string | null;
|
|
1398
|
+
external_google_secret?: string | null;
|
|
1399
|
+
external_google_additional_client_ids?: string | null;
|
|
1400
|
+
external_google_skip_nonce_check?: boolean | null;
|
|
1401
|
+
external_kakao_enabled?: boolean | null;
|
|
1402
|
+
external_kakao_client_id?: string | null;
|
|
1403
|
+
external_kakao_secret?: string | null;
|
|
1404
|
+
external_keycloak_enabled?: boolean | null;
|
|
1405
|
+
external_keycloak_client_id?: string | null;
|
|
1406
|
+
external_keycloak_secret?: string | null;
|
|
1407
|
+
external_keycloak_url?: string | null;
|
|
1408
|
+
external_linkedin_oidc_enabled?: boolean | null;
|
|
1409
|
+
external_linkedin_oidc_client_id?: string | null;
|
|
1410
|
+
external_linkedin_oidc_secret?: string | null;
|
|
1411
|
+
external_slack_oidc_enabled?: boolean | null;
|
|
1412
|
+
external_slack_oidc_client_id?: string | null;
|
|
1413
|
+
external_slack_oidc_secret?: string | null;
|
|
1414
|
+
external_notion_enabled?: boolean | null;
|
|
1415
|
+
external_notion_client_id?: string | null;
|
|
1416
|
+
external_notion_secret?: string | null;
|
|
1417
|
+
external_slack_enabled?: boolean | null;
|
|
1418
|
+
external_slack_client_id?: string | null;
|
|
1419
|
+
external_slack_secret?: string | null;
|
|
1420
|
+
external_spotify_enabled?: boolean | null;
|
|
1421
|
+
external_spotify_client_id?: string | null;
|
|
1422
|
+
external_spotify_secret?: string | null;
|
|
1423
|
+
external_twitch_enabled?: boolean | null;
|
|
1424
|
+
external_twitch_client_id?: string | null;
|
|
1425
|
+
external_twitch_secret?: string | null;
|
|
1426
|
+
external_twitter_enabled?: boolean | null;
|
|
1427
|
+
external_twitter_client_id?: string | null;
|
|
1428
|
+
external_twitter_secret?: string | null;
|
|
1429
|
+
external_workos_enabled?: boolean | null;
|
|
1430
|
+
external_workos_client_id?: string | null;
|
|
1431
|
+
external_workos_secret?: string | null;
|
|
1432
|
+
external_workos_url?: string | null;
|
|
1433
|
+
external_web3_solana_enabled?: boolean | null;
|
|
1434
|
+
external_zoom_enabled?: boolean | null;
|
|
1435
|
+
external_zoom_client_id?: string | null;
|
|
1436
|
+
external_zoom_secret?: string | null;
|
|
1437
|
+
db_max_pool_size?: number | null;
|
|
1438
|
+
api_max_request_duration?: number | null;
|
|
1439
|
+
mfa_totp_enroll_enabled?: boolean | null;
|
|
1440
|
+
mfa_totp_verify_enabled?: boolean | null;
|
|
1441
|
+
mfa_web_authn_enroll_enabled?: boolean | null;
|
|
1442
|
+
mfa_web_authn_verify_enabled?: boolean | null;
|
|
1443
|
+
mfa_phone_enroll_enabled?: boolean | null;
|
|
1444
|
+
mfa_phone_verify_enabled?: boolean | null;
|
|
1445
|
+
mfa_phone_max_frequency?: number | null;
|
|
1446
|
+
mfa_phone_otp_length?: number | null;
|
|
1447
|
+
mfa_phone_template?: string | null;
|
|
1448
|
+
};
|
|
1449
|
+
CreateThirdPartyAuthBody: {
|
|
1450
|
+
oidc_issuer_url?: string;
|
|
1451
|
+
jwks_url?: string;
|
|
1452
|
+
custom_jwks?: unknown;
|
|
1453
|
+
};
|
|
1454
|
+
ThirdPartyAuth: {
|
|
1455
|
+
/** Format: uuid */
|
|
1456
|
+
id: string;
|
|
1457
|
+
type: string;
|
|
1458
|
+
oidc_issuer_url?: string | null;
|
|
1459
|
+
jwks_url?: string | null;
|
|
1460
|
+
custom_jwks?: Record<string, unknown> | null;
|
|
1461
|
+
resolved_jwks?: Record<string, unknown> | null;
|
|
1462
|
+
inserted_at: string;
|
|
1463
|
+
updated_at: string;
|
|
1464
|
+
resolved_at?: string | null;
|
|
1465
|
+
};
|
|
1466
|
+
ProjectAvailableRestoreVersion: {
|
|
1467
|
+
version: string;
|
|
1468
|
+
/** @enum {string} */
|
|
1469
|
+
release_channel: "internal" | "alpha" | "beta" | "ga" | "withdrawn" | "preview";
|
|
1470
|
+
/** @enum {string} */
|
|
1471
|
+
postgres_engine: "13" | "14" | "15" | "17" | "17-oriole";
|
|
1472
|
+
};
|
|
1473
|
+
GetProjectAvailableRestoreVersionsResponse: {
|
|
1474
|
+
available_versions: (components["schemas"]["ProjectAvailableRestoreVersion"])[];
|
|
1475
|
+
};
|
|
1476
|
+
ListProjectAddonsResponseDto: {
|
|
1477
|
+
selected_addons: ({
|
|
1478
|
+
/** @enum {string} */
|
|
1479
|
+
type: "custom_domain" | "compute_instance" | "pitr" | "ipv4" | "auth_mfa_phone" | "auth_mfa_web_authn" | "log_drain";
|
|
1480
|
+
variant: {
|
|
1481
|
+
id: ("ci_micro" | "ci_small" | "ci_medium" | "ci_large" | "ci_xlarge" | "ci_2xlarge" | "ci_4xlarge" | "ci_8xlarge" | "ci_12xlarge" | "ci_16xlarge") | "cd_default" | ("pitr_7" | "pitr_14" | "pitr_28") | "ipv4_default" | "auth_mfa_phone_default" | "auth_mfa_web_authn_default" | "log_drain_default";
|
|
1482
|
+
name: string;
|
|
1483
|
+
price: {
|
|
1484
|
+
description: string;
|
|
1485
|
+
/** @enum {string} */
|
|
1486
|
+
type: "fixed" | "usage";
|
|
1487
|
+
/** @enum {string} */
|
|
1488
|
+
interval: "monthly" | "hourly";
|
|
1489
|
+
amount: number;
|
|
1490
|
+
};
|
|
1491
|
+
/** @description Any JSON-serializable value */
|
|
1492
|
+
meta?: unknown;
|
|
1493
|
+
};
|
|
1494
|
+
})[];
|
|
1495
|
+
available_addons: ({
|
|
1496
|
+
/** @enum {string} */
|
|
1497
|
+
type: "custom_domain" | "compute_instance" | "pitr" | "ipv4" | "auth_mfa_phone" | "auth_mfa_web_authn" | "log_drain";
|
|
1498
|
+
name: string;
|
|
1499
|
+
variants: ({
|
|
1500
|
+
id: ("ci_micro" | "ci_small" | "ci_medium" | "ci_large" | "ci_xlarge" | "ci_2xlarge" | "ci_4xlarge" | "ci_8xlarge" | "ci_12xlarge" | "ci_16xlarge") | "cd_default" | ("pitr_7" | "pitr_14" | "pitr_28") | "ipv4_default" | "auth_mfa_phone_default" | "auth_mfa_web_authn_default" | "log_drain_default";
|
|
1501
|
+
name: string;
|
|
1502
|
+
price: {
|
|
1503
|
+
description: string;
|
|
1504
|
+
/** @enum {string} */
|
|
1505
|
+
type: "fixed" | "usage";
|
|
1506
|
+
/** @enum {string} */
|
|
1507
|
+
interval: "monthly" | "hourly";
|
|
1508
|
+
amount: number;
|
|
1509
|
+
};
|
|
1510
|
+
/** @description Any JSON-serializable value */
|
|
1511
|
+
meta?: unknown;
|
|
1512
|
+
})[];
|
|
1513
|
+
})[];
|
|
1514
|
+
};
|
|
1515
|
+
ApplyProjectAddonBodyDto: {
|
|
1516
|
+
addon_variant: ("ci_micro" | "ci_small" | "ci_medium" | "ci_large" | "ci_xlarge" | "ci_2xlarge" | "ci_4xlarge" | "ci_8xlarge" | "ci_12xlarge" | "ci_16xlarge") | "cd_default" | ("pitr_7" | "pitr_14" | "pitr_28") | "ipv4_default";
|
|
1517
|
+
/** @enum {string} */
|
|
1518
|
+
addon_type: "custom_domain" | "compute_instance" | "pitr" | "ipv4" | "auth_mfa_phone" | "auth_mfa_web_authn" | "log_drain";
|
|
1519
|
+
};
|
|
1520
|
+
V1ProjectAdvisorsResponseDto: {
|
|
1521
|
+
lints: ({
|
|
1522
|
+
/** @enum {string} */
|
|
1523
|
+
name: "unindexed_foreign_keys" | "auth_users_exposed" | "auth_rls_initplan" | "no_primary_key" | "unused_index" | "multiple_permissive_policies" | "policy_exists_rls_disabled" | "rls_enabled_no_policy" | "duplicate_index" | "security_definer_view" | "function_search_path_mutable" | "rls_disabled_in_public" | "extension_in_public" | "rls_references_user_metadata" | "materialized_view_in_api" | "foreign_table_in_api" | "unsupported_reg_types" | "auth_otp_long_expiry" | "auth_otp_short_length" | "ssl_not_enforced" | "network_restrictions_not_set" | "password_requirements_min_length" | "pitr_not_enabled" | "auth_leaked_password_protection" | "auth_insufficient_mfa_options" | "auth_password_policy_missing" | "leaked_service_key" | "no_backup_admin";
|
|
1524
|
+
title: string;
|
|
1525
|
+
/** @enum {string} */
|
|
1526
|
+
level: "ERROR" | "WARN" | "INFO";
|
|
1527
|
+
/** @enum {string} */
|
|
1528
|
+
facing: "EXTERNAL";
|
|
1529
|
+
categories: ("PERFORMANCE" | "SECURITY")[];
|
|
1530
|
+
description: string;
|
|
1531
|
+
detail: string;
|
|
1532
|
+
remediation: string;
|
|
1533
|
+
metadata?: {
|
|
1534
|
+
schema?: string;
|
|
1535
|
+
name?: string;
|
|
1536
|
+
entity?: string;
|
|
1537
|
+
/** @enum {string} */
|
|
1538
|
+
type?: "table" | "view" | "auth" | "function" | "extension" | "compliance";
|
|
1539
|
+
fkey_name?: string;
|
|
1540
|
+
fkey_columns?: (number)[];
|
|
1541
|
+
};
|
|
1542
|
+
cache_key: string;
|
|
1543
|
+
})[];
|
|
1544
|
+
};
|
|
1545
|
+
V1AnalyticsResponse: {
|
|
1546
|
+
result?: (unknown)[];
|
|
1547
|
+
error?: OneOf<[string, {
|
|
1548
|
+
code: number;
|
|
1549
|
+
errors: ({
|
|
1550
|
+
domain: string;
|
|
1551
|
+
location: string;
|
|
1552
|
+
locationType: string;
|
|
1553
|
+
message: string;
|
|
1554
|
+
reason: string;
|
|
1555
|
+
})[];
|
|
1556
|
+
message: string;
|
|
1557
|
+
status: string;
|
|
1558
|
+
}]>;
|
|
1559
|
+
};
|
|
1560
|
+
V1ListMigrationsResponse: ({
|
|
1561
|
+
version: string;
|
|
1562
|
+
name?: string;
|
|
1563
|
+
})[];
|
|
1564
|
+
V1CreateMigrationBody: {
|
|
1565
|
+
query: string;
|
|
1566
|
+
name?: string;
|
|
1567
|
+
};
|
|
1568
|
+
V1RunQueryBody: {
|
|
1569
|
+
query: string;
|
|
1570
|
+
read_only?: boolean;
|
|
1571
|
+
};
|
|
1572
|
+
GetProjectDbMetadataResponseDto: {
|
|
1573
|
+
databases: ({
|
|
1574
|
+
name: string;
|
|
1575
|
+
schemas: ({
|
|
1576
|
+
name: string;
|
|
1577
|
+
[key: string]: unknown;
|
|
1578
|
+
})[];
|
|
1579
|
+
[key: string]: unknown;
|
|
1580
|
+
})[];
|
|
1581
|
+
};
|
|
1582
|
+
FunctionResponse: {
|
|
1583
|
+
id: string;
|
|
1584
|
+
slug: string;
|
|
1585
|
+
name: string;
|
|
1586
|
+
/** @enum {string} */
|
|
1587
|
+
status: "ACTIVE" | "REMOVED" | "THROTTLED";
|
|
1588
|
+
version: number;
|
|
1589
|
+
created_at: number;
|
|
1590
|
+
updated_at: number;
|
|
1591
|
+
verify_jwt?: boolean;
|
|
1592
|
+
import_map?: boolean;
|
|
1593
|
+
entrypoint_path?: string;
|
|
1594
|
+
import_map_path?: string;
|
|
1595
|
+
};
|
|
1596
|
+
BulkUpdateFunctionBody: ({
|
|
1597
|
+
id: string;
|
|
1598
|
+
slug: string;
|
|
1599
|
+
name: string;
|
|
1600
|
+
/** @enum {string} */
|
|
1601
|
+
status: "ACTIVE" | "REMOVED" | "THROTTLED";
|
|
1602
|
+
version: number;
|
|
1603
|
+
created_at?: number;
|
|
1604
|
+
verify_jwt?: boolean;
|
|
1605
|
+
import_map?: boolean;
|
|
1606
|
+
entrypoint_path?: string;
|
|
1607
|
+
import_map_path?: string;
|
|
1608
|
+
})[];
|
|
1609
|
+
BulkUpdateFunctionResponse: {
|
|
1610
|
+
functions: ({
|
|
1611
|
+
id: string;
|
|
1612
|
+
slug: string;
|
|
1613
|
+
name: string;
|
|
1614
|
+
/** @enum {string} */
|
|
1615
|
+
status: "ACTIVE" | "REMOVED" | "THROTTLED";
|
|
1616
|
+
version: number;
|
|
1617
|
+
created_at: number;
|
|
1618
|
+
updated_at: number;
|
|
1619
|
+
verify_jwt?: boolean;
|
|
1620
|
+
import_map?: boolean;
|
|
1621
|
+
entrypoint_path?: string;
|
|
1622
|
+
import_map_path?: string;
|
|
1623
|
+
})[];
|
|
1624
|
+
};
|
|
1625
|
+
DeployFunctionResponse: {
|
|
1626
|
+
id: string;
|
|
1627
|
+
slug: string;
|
|
1628
|
+
name: string;
|
|
1629
|
+
/** @enum {string} */
|
|
1630
|
+
status: "ACTIVE" | "REMOVED" | "THROTTLED";
|
|
1631
|
+
version: number;
|
|
1632
|
+
created_at?: number;
|
|
1633
|
+
updated_at?: number;
|
|
1634
|
+
verify_jwt?: boolean;
|
|
1635
|
+
import_map?: boolean;
|
|
1636
|
+
entrypoint_path?: string;
|
|
1637
|
+
import_map_path?: string;
|
|
1638
|
+
};
|
|
1639
|
+
FunctionSlugResponse: {
|
|
1640
|
+
id: string;
|
|
1641
|
+
slug: string;
|
|
1642
|
+
name: string;
|
|
1643
|
+
/** @enum {string} */
|
|
1644
|
+
status: "ACTIVE" | "REMOVED" | "THROTTLED";
|
|
1645
|
+
version: number;
|
|
1646
|
+
created_at: number;
|
|
1647
|
+
updated_at: number;
|
|
1648
|
+
verify_jwt?: boolean;
|
|
1649
|
+
import_map?: boolean;
|
|
1650
|
+
entrypoint_path?: string;
|
|
1651
|
+
import_map_path?: string;
|
|
1652
|
+
};
|
|
1653
|
+
V1StorageBucketResponse: {
|
|
1654
|
+
id: string;
|
|
1655
|
+
name: string;
|
|
1656
|
+
owner: string;
|
|
1657
|
+
created_at: string;
|
|
1658
|
+
updated_at: string;
|
|
1659
|
+
public: boolean;
|
|
1660
|
+
};
|
|
1661
|
+
CreateProviderBody: {
|
|
1662
|
+
/**
|
|
1663
|
+
* @description What type of provider will be created
|
|
1664
|
+
* @enum {string}
|
|
1665
|
+
*/
|
|
1666
|
+
type: "saml";
|
|
1667
|
+
metadata_xml?: string;
|
|
1668
|
+
metadata_url?: string;
|
|
1669
|
+
domains?: (string)[];
|
|
1670
|
+
attribute_mapping?: {
|
|
1671
|
+
keys: {
|
|
1672
|
+
[key: string]: ({
|
|
1673
|
+
name?: string;
|
|
1674
|
+
names?: (string)[];
|
|
1675
|
+
default?: Record<string, never> | number | string | boolean;
|
|
1676
|
+
array?: boolean;
|
|
1677
|
+
}) | undefined;
|
|
1678
|
+
};
|
|
1679
|
+
};
|
|
1680
|
+
};
|
|
1681
|
+
CreateProviderResponse: {
|
|
1682
|
+
id: string;
|
|
1683
|
+
saml?: {
|
|
1684
|
+
id: string;
|
|
1685
|
+
entity_id: string;
|
|
1686
|
+
metadata_url?: string;
|
|
1687
|
+
metadata_xml?: string;
|
|
1688
|
+
attribute_mapping?: {
|
|
1689
|
+
keys: {
|
|
1690
|
+
[key: string]: ({
|
|
1691
|
+
name?: string;
|
|
1692
|
+
names?: (string)[];
|
|
1693
|
+
default?: Record<string, never> | number | string | boolean;
|
|
1694
|
+
array?: boolean;
|
|
1695
|
+
}) | undefined;
|
|
1696
|
+
};
|
|
1697
|
+
};
|
|
1698
|
+
};
|
|
1699
|
+
domains?: ({
|
|
1700
|
+
id: string;
|
|
1701
|
+
domain?: string;
|
|
1702
|
+
created_at?: string;
|
|
1703
|
+
updated_at?: string;
|
|
1704
|
+
})[];
|
|
1705
|
+
created_at?: string;
|
|
1706
|
+
updated_at?: string;
|
|
1707
|
+
};
|
|
1708
|
+
ListProvidersResponse: {
|
|
1709
|
+
items: ({
|
|
1710
|
+
id: string;
|
|
1711
|
+
saml?: {
|
|
1712
|
+
id: string;
|
|
1713
|
+
entity_id: string;
|
|
1714
|
+
metadata_url?: string;
|
|
1715
|
+
metadata_xml?: string;
|
|
1716
|
+
attribute_mapping?: {
|
|
1717
|
+
keys: {
|
|
1718
|
+
[key: string]: ({
|
|
1719
|
+
name?: string;
|
|
1720
|
+
names?: (string)[];
|
|
1721
|
+
default?: Record<string, never> | number | string | boolean;
|
|
1722
|
+
array?: boolean;
|
|
1723
|
+
}) | undefined;
|
|
1724
|
+
};
|
|
1725
|
+
};
|
|
1726
|
+
};
|
|
1727
|
+
domains?: ({
|
|
1728
|
+
id: string;
|
|
1729
|
+
domain?: string;
|
|
1730
|
+
created_at?: string;
|
|
1731
|
+
updated_at?: string;
|
|
1732
|
+
})[];
|
|
1733
|
+
created_at?: string;
|
|
1734
|
+
updated_at?: string;
|
|
1735
|
+
})[];
|
|
1736
|
+
};
|
|
1737
|
+
GetProviderResponse: {
|
|
1738
|
+
id: string;
|
|
1739
|
+
saml?: {
|
|
1740
|
+
id: string;
|
|
1741
|
+
entity_id: string;
|
|
1742
|
+
metadata_url?: string;
|
|
1743
|
+
metadata_xml?: string;
|
|
1744
|
+
attribute_mapping?: {
|
|
1745
|
+
keys: {
|
|
1746
|
+
[key: string]: ({
|
|
1747
|
+
name?: string;
|
|
1748
|
+
names?: (string)[];
|
|
1749
|
+
default?: Record<string, never> | number | string | boolean;
|
|
1750
|
+
array?: boolean;
|
|
1751
|
+
}) | undefined;
|
|
1752
|
+
};
|
|
1753
|
+
};
|
|
1754
|
+
};
|
|
1755
|
+
domains?: ({
|
|
1756
|
+
id: string;
|
|
1757
|
+
domain?: string;
|
|
1758
|
+
created_at?: string;
|
|
1759
|
+
updated_at?: string;
|
|
1760
|
+
})[];
|
|
1761
|
+
created_at?: string;
|
|
1762
|
+
updated_at?: string;
|
|
1763
|
+
};
|
|
1764
|
+
UpdateProviderBody: {
|
|
1765
|
+
metadata_xml?: string;
|
|
1766
|
+
metadata_url?: string;
|
|
1767
|
+
domains?: (string)[];
|
|
1768
|
+
attribute_mapping?: {
|
|
1769
|
+
keys: {
|
|
1770
|
+
[key: string]: ({
|
|
1771
|
+
name?: string;
|
|
1772
|
+
names?: (string)[];
|
|
1773
|
+
default?: Record<string, never> | number | string | boolean;
|
|
1774
|
+
array?: boolean;
|
|
1775
|
+
}) | undefined;
|
|
1776
|
+
};
|
|
1777
|
+
};
|
|
1778
|
+
};
|
|
1779
|
+
UpdateProviderResponse: {
|
|
1780
|
+
id: string;
|
|
1781
|
+
saml?: {
|
|
1782
|
+
id: string;
|
|
1783
|
+
entity_id: string;
|
|
1784
|
+
metadata_url?: string;
|
|
1785
|
+
metadata_xml?: string;
|
|
1786
|
+
attribute_mapping?: {
|
|
1787
|
+
keys: {
|
|
1788
|
+
[key: string]: ({
|
|
1789
|
+
name?: string;
|
|
1790
|
+
names?: (string)[];
|
|
1791
|
+
default?: Record<string, never> | number | string | boolean;
|
|
1792
|
+
array?: boolean;
|
|
1793
|
+
}) | undefined;
|
|
1794
|
+
};
|
|
1795
|
+
};
|
|
1796
|
+
};
|
|
1797
|
+
domains?: ({
|
|
1798
|
+
id: string;
|
|
1799
|
+
domain?: string;
|
|
1800
|
+
created_at?: string;
|
|
1801
|
+
updated_at?: string;
|
|
1802
|
+
})[];
|
|
1803
|
+
created_at?: string;
|
|
1804
|
+
updated_at?: string;
|
|
1805
|
+
};
|
|
1806
|
+
DeleteProviderResponse: {
|
|
1807
|
+
id: string;
|
|
1808
|
+
saml?: {
|
|
1809
|
+
id: string;
|
|
1810
|
+
entity_id: string;
|
|
1811
|
+
metadata_url?: string;
|
|
1812
|
+
metadata_xml?: string;
|
|
1813
|
+
attribute_mapping?: {
|
|
1814
|
+
keys: {
|
|
1815
|
+
[key: string]: ({
|
|
1816
|
+
name?: string;
|
|
1817
|
+
names?: (string)[];
|
|
1818
|
+
default?: Record<string, never> | number | string | boolean;
|
|
1819
|
+
array?: boolean;
|
|
1820
|
+
}) | undefined;
|
|
1821
|
+
};
|
|
1822
|
+
};
|
|
1823
|
+
};
|
|
1824
|
+
domains?: ({
|
|
1825
|
+
id: string;
|
|
1826
|
+
domain?: string;
|
|
1827
|
+
created_at?: string;
|
|
1828
|
+
updated_at?: string;
|
|
1829
|
+
})[];
|
|
1830
|
+
created_at?: string;
|
|
1831
|
+
updated_at?: string;
|
|
1832
|
+
};
|
|
1833
|
+
V1Backup: {
|
|
1834
|
+
/** @enum {string} */
|
|
1835
|
+
status: "COMPLETED" | "FAILED" | "PENDING" | "REMOVED" | "ARCHIVED" | "CANCELLED";
|
|
1836
|
+
is_physical_backup: boolean;
|
|
1837
|
+
inserted_at: string;
|
|
1838
|
+
};
|
|
1839
|
+
V1PhysicalBackup: {
|
|
1840
|
+
/** Format: int64 */
|
|
1841
|
+
earliest_physical_backup_date_unix?: number;
|
|
1842
|
+
/** Format: int64 */
|
|
1843
|
+
latest_physical_backup_date_unix?: number;
|
|
1844
|
+
};
|
|
1845
|
+
V1BackupsResponse: {
|
|
1846
|
+
region: string;
|
|
1847
|
+
walg_enabled: boolean;
|
|
1848
|
+
pitr_enabled: boolean;
|
|
1849
|
+
backups: (components["schemas"]["V1Backup"])[];
|
|
1850
|
+
physical_backup_data: components["schemas"]["V1PhysicalBackup"];
|
|
1851
|
+
};
|
|
1852
|
+
V1RestorePitrBody: {
|
|
1853
|
+
/** Format: int64 */
|
|
1854
|
+
recovery_time_target_unix: number;
|
|
1855
|
+
};
|
|
1856
|
+
V1OrganizationMemberResponse: {
|
|
1857
|
+
user_id: string;
|
|
1858
|
+
user_name: string;
|
|
1859
|
+
email?: string;
|
|
1860
|
+
role_name: string;
|
|
1861
|
+
mfa_enabled: boolean;
|
|
1862
|
+
};
|
|
1863
|
+
/** @enum {string} */
|
|
1864
|
+
BillingPlanId: "free" | "pro" | "team" | "enterprise";
|
|
1865
|
+
/** @enum {string} */
|
|
1866
|
+
ReleaseChannel: "internal" | "alpha" | "beta" | "ga" | "withdrawn" | "preview";
|
|
1867
|
+
V1OrganizationSlugResponse: {
|
|
1868
|
+
plan?: components["schemas"]["BillingPlanId"];
|
|
1869
|
+
opt_in_tags: ("AI_SQL_GENERATOR_OPT_IN")[];
|
|
1870
|
+
allowed_release_channels: (components["schemas"]["ReleaseChannel"])[];
|
|
1871
|
+
id: string;
|
|
1872
|
+
name: string;
|
|
1873
|
+
};
|
|
1874
|
+
};
|
|
1875
|
+
responses: never;
|
|
1876
|
+
parameters: never;
|
|
1877
|
+
requestBodies: never;
|
|
1878
|
+
headers: never;
|
|
1879
|
+
pathItems: never;
|
|
1880
|
+
}
|
|
1881
|
+
|
|
1882
|
+
interface operations {
|
|
1883
|
+
|
|
1884
|
+
/**
|
|
1885
|
+
* Get database branch config
|
|
1886
|
+
* @description Fetches configurations of the specified database branch
|
|
1887
|
+
*/
|
|
1888
|
+
"v1-get-a-branch-config": {
|
|
1889
|
+
parameters: {
|
|
1890
|
+
path: {
|
|
1891
|
+
/** @description Branch ID */
|
|
1892
|
+
branch_id: string;
|
|
1893
|
+
};
|
|
1894
|
+
};
|
|
1895
|
+
responses: {
|
|
1896
|
+
200: {
|
|
1897
|
+
content: {
|
|
1898
|
+
"application/json": components["schemas"]["BranchDetailResponse"];
|
|
1899
|
+
};
|
|
1900
|
+
};
|
|
1901
|
+
/** @description Failed to retrieve database branch */
|
|
1902
|
+
500: never;
|
|
1903
|
+
};
|
|
1904
|
+
};
|
|
1905
|
+
/**
|
|
1906
|
+
* Delete a database branch
|
|
1907
|
+
* @description Deletes the specified database branch
|
|
1908
|
+
*/
|
|
1909
|
+
"v1-delete-a-branch": {
|
|
1910
|
+
parameters: {
|
|
1911
|
+
path: {
|
|
1912
|
+
/** @description Branch ID */
|
|
1913
|
+
branch_id: string;
|
|
1914
|
+
};
|
|
1915
|
+
};
|
|
1916
|
+
responses: {
|
|
1917
|
+
200: {
|
|
1918
|
+
content: {
|
|
1919
|
+
"application/json": components["schemas"]["BranchDeleteResponse"];
|
|
1920
|
+
};
|
|
1921
|
+
};
|
|
1922
|
+
/** @description Failed to delete database branch */
|
|
1923
|
+
500: never;
|
|
1924
|
+
};
|
|
1925
|
+
};
|
|
1926
|
+
/**
|
|
1927
|
+
* Update database branch config
|
|
1928
|
+
* @description Updates the configuration of the specified database branch
|
|
1929
|
+
*/
|
|
1930
|
+
"v1-update-a-branch-config": {
|
|
1931
|
+
parameters: {
|
|
1932
|
+
path: {
|
|
1933
|
+
/** @description Branch ID */
|
|
1934
|
+
branch_id: string;
|
|
1935
|
+
};
|
|
1936
|
+
};
|
|
1937
|
+
requestBody: {
|
|
1938
|
+
content: {
|
|
1939
|
+
"application/json": components["schemas"]["UpdateBranchBody"];
|
|
1940
|
+
};
|
|
1941
|
+
};
|
|
1942
|
+
responses: {
|
|
1943
|
+
200: {
|
|
1944
|
+
content: {
|
|
1945
|
+
"application/json": components["schemas"]["BranchResponse"];
|
|
1946
|
+
};
|
|
1947
|
+
};
|
|
1948
|
+
/** @description Failed to update database branch */
|
|
1949
|
+
500: never;
|
|
1950
|
+
};
|
|
1951
|
+
};
|
|
1952
|
+
/**
|
|
1953
|
+
* Pushes a database branch
|
|
1954
|
+
* @description Pushes the specified database branch
|
|
1955
|
+
*/
|
|
1956
|
+
"v1-push-a-branch": {
|
|
1957
|
+
parameters: {
|
|
1958
|
+
path: {
|
|
1959
|
+
/** @description Branch ID */
|
|
1960
|
+
branch_id: string;
|
|
1961
|
+
};
|
|
1962
|
+
};
|
|
1963
|
+
requestBody: {
|
|
1964
|
+
content: {
|
|
1965
|
+
"application/json": components["schemas"]["BranchActionBody"];
|
|
1966
|
+
};
|
|
1967
|
+
};
|
|
1968
|
+
responses: {
|
|
1969
|
+
201: {
|
|
1970
|
+
content: {
|
|
1971
|
+
"application/json": components["schemas"]["BranchUpdateResponse"];
|
|
1972
|
+
};
|
|
1973
|
+
};
|
|
1974
|
+
/** @description Failed to push database branch */
|
|
1975
|
+
500: never;
|
|
1976
|
+
};
|
|
1977
|
+
};
|
|
1978
|
+
/**
|
|
1979
|
+
* Merges a database branch
|
|
1980
|
+
* @description Merges the specified database branch
|
|
1981
|
+
*/
|
|
1982
|
+
"v1-merge-a-branch": {
|
|
1983
|
+
parameters: {
|
|
1984
|
+
path: {
|
|
1985
|
+
/** @description Branch ID */
|
|
1986
|
+
branch_id: string;
|
|
1987
|
+
};
|
|
1988
|
+
};
|
|
1989
|
+
requestBody: {
|
|
1990
|
+
content: {
|
|
1991
|
+
"application/json": components["schemas"]["BranchActionBody"];
|
|
1992
|
+
};
|
|
1993
|
+
};
|
|
1994
|
+
responses: {
|
|
1995
|
+
201: {
|
|
1996
|
+
content: {
|
|
1997
|
+
"application/json": components["schemas"]["BranchUpdateResponse"];
|
|
1998
|
+
};
|
|
1999
|
+
};
|
|
2000
|
+
/** @description Failed to merge database branch */
|
|
2001
|
+
500: never;
|
|
2002
|
+
};
|
|
2003
|
+
};
|
|
2004
|
+
/**
|
|
2005
|
+
* Resets a database branch
|
|
2006
|
+
* @description Resets the specified database branch
|
|
2007
|
+
*/
|
|
2008
|
+
"v1-reset-a-branch": {
|
|
2009
|
+
parameters: {
|
|
2010
|
+
path: {
|
|
2011
|
+
/** @description Branch ID */
|
|
2012
|
+
branch_id: string;
|
|
2013
|
+
};
|
|
2014
|
+
};
|
|
2015
|
+
requestBody: {
|
|
2016
|
+
content: {
|
|
2017
|
+
"application/json": components["schemas"]["BranchActionBody"];
|
|
2018
|
+
};
|
|
2019
|
+
};
|
|
2020
|
+
responses: {
|
|
2021
|
+
201: {
|
|
2022
|
+
content: {
|
|
2023
|
+
"application/json": components["schemas"]["BranchUpdateResponse"];
|
|
2024
|
+
};
|
|
2025
|
+
};
|
|
2026
|
+
/** @description Failed to reset database branch */
|
|
2027
|
+
500: never;
|
|
2028
|
+
};
|
|
2029
|
+
};
|
|
2030
|
+
/**
|
|
2031
|
+
* List all projects
|
|
2032
|
+
* @description Returns a list of all projects you've previously created.
|
|
2033
|
+
*/
|
|
2034
|
+
"v1-list-all-projects": {
|
|
2035
|
+
responses: {
|
|
2036
|
+
200: {
|
|
2037
|
+
content: {
|
|
2038
|
+
"application/json": (components["schemas"]["V1ProjectWithDatabaseResponse"])[];
|
|
2039
|
+
};
|
|
2040
|
+
};
|
|
2041
|
+
};
|
|
2042
|
+
};
|
|
2043
|
+
/** Create a project */
|
|
2044
|
+
"v1-create-a-project": {
|
|
2045
|
+
requestBody: {
|
|
2046
|
+
content: {
|
|
2047
|
+
"application/json": components["schemas"]["V1CreateProjectBodyDto"];
|
|
2048
|
+
};
|
|
2049
|
+
};
|
|
2050
|
+
responses: {
|
|
2051
|
+
201: {
|
|
2052
|
+
content: {
|
|
2053
|
+
"application/json": components["schemas"]["V1ProjectResponse"];
|
|
2054
|
+
};
|
|
2055
|
+
};
|
|
2056
|
+
};
|
|
2057
|
+
};
|
|
2058
|
+
/**
|
|
2059
|
+
* List all organizations
|
|
2060
|
+
* @description Returns a list of organizations that you currently belong to.
|
|
2061
|
+
*/
|
|
2062
|
+
"v1-list-all-organizations": {
|
|
2063
|
+
responses: {
|
|
2064
|
+
200: {
|
|
2065
|
+
content: {
|
|
2066
|
+
"application/json": (components["schemas"]["OrganizationResponseV1"])[];
|
|
2067
|
+
};
|
|
2068
|
+
};
|
|
2069
|
+
/** @description Unexpected error listing organizations */
|
|
2070
|
+
500: never;
|
|
2071
|
+
};
|
|
2072
|
+
};
|
|
2073
|
+
/** Create an organization */
|
|
2074
|
+
"v1-create-an-organization": {
|
|
2075
|
+
requestBody: {
|
|
2076
|
+
content: {
|
|
2077
|
+
"application/json": components["schemas"]["CreateOrganizationV1Dto"];
|
|
2078
|
+
};
|
|
2079
|
+
};
|
|
2080
|
+
responses: {
|
|
2081
|
+
201: {
|
|
2082
|
+
content: {
|
|
2083
|
+
"application/json": components["schemas"]["OrganizationResponseV1"];
|
|
2084
|
+
};
|
|
2085
|
+
};
|
|
2086
|
+
/** @description Unexpected error creating an organization */
|
|
2087
|
+
500: never;
|
|
2088
|
+
};
|
|
2089
|
+
};
|
|
2090
|
+
/** [Beta] Authorize user through oauth */
|
|
2091
|
+
"v1-authorize-user": {
|
|
2092
|
+
parameters: {
|
|
2093
|
+
query: {
|
|
2094
|
+
client_id: string;
|
|
2095
|
+
response_type: "code" | "token" | "id_token token";
|
|
2096
|
+
redirect_uri: string;
|
|
2097
|
+
scope?: string;
|
|
2098
|
+
state?: string;
|
|
2099
|
+
response_mode?: string;
|
|
2100
|
+
code_challenge?: string;
|
|
2101
|
+
code_challenge_method?: "plain" | "sha256" | "S256";
|
|
2102
|
+
};
|
|
2103
|
+
};
|
|
2104
|
+
responses: {
|
|
2105
|
+
303: never;
|
|
2106
|
+
};
|
|
2107
|
+
};
|
|
2108
|
+
/** [Beta] Exchange auth code for user's access and refresh token */
|
|
2109
|
+
"v1-exchange-oauth-token": {
|
|
2110
|
+
requestBody: {
|
|
2111
|
+
content: {
|
|
2112
|
+
"application/x-www-form-urlencoded": components["schemas"]["OAuthTokenBody"];
|
|
2113
|
+
};
|
|
2114
|
+
};
|
|
2115
|
+
responses: {
|
|
2116
|
+
201: {
|
|
2117
|
+
content: {
|
|
2118
|
+
"application/json": components["schemas"]["OAuthTokenResponse"];
|
|
2119
|
+
};
|
|
2120
|
+
};
|
|
2121
|
+
};
|
|
2122
|
+
};
|
|
2123
|
+
/** [Beta] Revoke oauth app authorization and it's corresponding tokens */
|
|
2124
|
+
"v1-revoke-token": {
|
|
2125
|
+
requestBody: {
|
|
2126
|
+
content: {
|
|
2127
|
+
"application/json": components["schemas"]["OAuthRevokeTokenBodyDto"];
|
|
2128
|
+
};
|
|
2129
|
+
};
|
|
2130
|
+
responses: {
|
|
2131
|
+
204: never;
|
|
2132
|
+
};
|
|
2133
|
+
};
|
|
2134
|
+
/** Lists SQL snippets for the logged in user */
|
|
2135
|
+
"v1-list-all-snippets": {
|
|
2136
|
+
parameters: {
|
|
2137
|
+
query?: {
|
|
2138
|
+
/** @description Project ref */
|
|
2139
|
+
project_ref?: string;
|
|
2140
|
+
cursor?: string;
|
|
2141
|
+
limit?: string;
|
|
2142
|
+
sort_by?: "name" | "inserted_at";
|
|
2143
|
+
sort_order?: "asc" | "desc";
|
|
2144
|
+
};
|
|
2145
|
+
};
|
|
2146
|
+
responses: {
|
|
2147
|
+
200: {
|
|
2148
|
+
content: {
|
|
2149
|
+
"application/json": components["schemas"]["SnippetList"];
|
|
2150
|
+
};
|
|
2151
|
+
};
|
|
2152
|
+
/** @description Failed to list user's SQL snippets */
|
|
2153
|
+
500: never;
|
|
2154
|
+
};
|
|
2155
|
+
};
|
|
2156
|
+
/** Gets a specific SQL snippet */
|
|
2157
|
+
"v1-get-a-snippet": {
|
|
2158
|
+
parameters: {
|
|
2159
|
+
path: {
|
|
2160
|
+
id: string;
|
|
2161
|
+
};
|
|
2162
|
+
};
|
|
2163
|
+
responses: {
|
|
2164
|
+
200: {
|
|
2165
|
+
content: {
|
|
2166
|
+
"application/json": components["schemas"]["SnippetResponse"];
|
|
2167
|
+
};
|
|
2168
|
+
};
|
|
2169
|
+
/** @description Failed to retrieve SQL snippet */
|
|
2170
|
+
500: never;
|
|
2171
|
+
};
|
|
2172
|
+
};
|
|
2173
|
+
/** Get project api keys */
|
|
2174
|
+
"v1-get-project-api-keys": {
|
|
2175
|
+
parameters: {
|
|
2176
|
+
query?: {
|
|
2177
|
+
reveal?: string;
|
|
2178
|
+
};
|
|
2179
|
+
path: {
|
|
2180
|
+
/** @description Project ref */
|
|
2181
|
+
ref: string;
|
|
2182
|
+
};
|
|
2183
|
+
};
|
|
2184
|
+
responses: {
|
|
2185
|
+
200: {
|
|
2186
|
+
content: {
|
|
2187
|
+
"application/json": (components["schemas"]["ApiKeyResponse"])[];
|
|
2188
|
+
};
|
|
2189
|
+
};
|
|
2190
|
+
403: never;
|
|
2191
|
+
};
|
|
2192
|
+
};
|
|
2193
|
+
/** [Alpha] Creates a new API key for the project */
|
|
2194
|
+
createApiKey: {
|
|
2195
|
+
parameters: {
|
|
2196
|
+
query?: {
|
|
2197
|
+
reveal?: string;
|
|
2198
|
+
};
|
|
2199
|
+
path: {
|
|
2200
|
+
/** @description Project ref */
|
|
2201
|
+
ref: string;
|
|
2202
|
+
};
|
|
2203
|
+
};
|
|
2204
|
+
requestBody: {
|
|
2205
|
+
content: {
|
|
2206
|
+
"application/json": components["schemas"]["CreateApiKeyBody"];
|
|
2207
|
+
};
|
|
2208
|
+
};
|
|
2209
|
+
responses: {
|
|
2210
|
+
201: {
|
|
2211
|
+
content: {
|
|
2212
|
+
"application/json": components["schemas"]["ApiKeyResponse"];
|
|
2213
|
+
};
|
|
2214
|
+
};
|
|
2215
|
+
403: never;
|
|
2216
|
+
};
|
|
2217
|
+
};
|
|
2218
|
+
/** [Alpha] Get API key */
|
|
2219
|
+
getApiKey: {
|
|
2220
|
+
parameters: {
|
|
2221
|
+
query?: {
|
|
2222
|
+
reveal?: string;
|
|
2223
|
+
};
|
|
2224
|
+
path: {
|
|
2225
|
+
/** @description Project ref */
|
|
2226
|
+
ref: string;
|
|
2227
|
+
id: string;
|
|
2228
|
+
};
|
|
2229
|
+
};
|
|
2230
|
+
responses: {
|
|
2231
|
+
200: {
|
|
2232
|
+
content: {
|
|
2233
|
+
"application/json": components["schemas"]["ApiKeyResponse"];
|
|
2234
|
+
};
|
|
2235
|
+
};
|
|
2236
|
+
403: never;
|
|
2237
|
+
};
|
|
2238
|
+
};
|
|
2239
|
+
/** [Alpha] Deletes an API key for the project */
|
|
2240
|
+
deleteApiKey: {
|
|
2241
|
+
parameters: {
|
|
2242
|
+
query?: {
|
|
2243
|
+
reveal?: string;
|
|
2244
|
+
};
|
|
2245
|
+
path: {
|
|
2246
|
+
/** @description Project ref */
|
|
2247
|
+
ref: string;
|
|
2248
|
+
id: string;
|
|
2249
|
+
};
|
|
2250
|
+
};
|
|
2251
|
+
responses: {
|
|
2252
|
+
200: {
|
|
2253
|
+
content: {
|
|
2254
|
+
"application/json": components["schemas"]["ApiKeyResponse"];
|
|
2255
|
+
};
|
|
2256
|
+
};
|
|
2257
|
+
403: never;
|
|
2258
|
+
};
|
|
2259
|
+
};
|
|
2260
|
+
/** [Alpha] Updates an API key for the project */
|
|
2261
|
+
updateApiKey: {
|
|
2262
|
+
parameters: {
|
|
2263
|
+
query?: {
|
|
2264
|
+
reveal?: string;
|
|
2265
|
+
};
|
|
2266
|
+
path: {
|
|
2267
|
+
/** @description Project ref */
|
|
2268
|
+
ref: string;
|
|
2269
|
+
id: string;
|
|
2270
|
+
};
|
|
2271
|
+
};
|
|
2272
|
+
requestBody: {
|
|
2273
|
+
content: {
|
|
2274
|
+
"application/json": components["schemas"]["UpdateApiKeyBody"];
|
|
2275
|
+
};
|
|
2276
|
+
};
|
|
2277
|
+
responses: {
|
|
2278
|
+
200: {
|
|
2279
|
+
content: {
|
|
2280
|
+
"application/json": components["schemas"]["ApiKeyResponse"];
|
|
2281
|
+
};
|
|
2282
|
+
};
|
|
2283
|
+
403: never;
|
|
2284
|
+
};
|
|
2285
|
+
};
|
|
2286
|
+
/**
|
|
2287
|
+
* List all database branches
|
|
2288
|
+
* @description Returns all database branches of the specified project.
|
|
2289
|
+
*/
|
|
2290
|
+
"v1-list-all-branches": {
|
|
2291
|
+
parameters: {
|
|
2292
|
+
path: {
|
|
2293
|
+
/** @description Project ref */
|
|
2294
|
+
ref: string;
|
|
2295
|
+
};
|
|
2296
|
+
};
|
|
2297
|
+
responses: {
|
|
2298
|
+
200: {
|
|
2299
|
+
content: {
|
|
2300
|
+
"application/json": (components["schemas"]["BranchResponse"])[];
|
|
2301
|
+
};
|
|
2302
|
+
};
|
|
2303
|
+
403: never;
|
|
2304
|
+
/** @description Failed to retrieve database branches */
|
|
2305
|
+
500: never;
|
|
2306
|
+
};
|
|
2307
|
+
};
|
|
2308
|
+
/**
|
|
2309
|
+
* Create a database branch
|
|
2310
|
+
* @description Creates a database branch from the specified project.
|
|
2311
|
+
*/
|
|
2312
|
+
"v1-create-a-branch": {
|
|
2313
|
+
parameters: {
|
|
2314
|
+
path: {
|
|
2315
|
+
/** @description Project ref */
|
|
2316
|
+
ref: string;
|
|
2317
|
+
};
|
|
2318
|
+
};
|
|
2319
|
+
requestBody: {
|
|
2320
|
+
content: {
|
|
2321
|
+
"application/json": components["schemas"]["CreateBranchBody"];
|
|
2322
|
+
};
|
|
2323
|
+
};
|
|
2324
|
+
responses: {
|
|
2325
|
+
201: {
|
|
2326
|
+
content: {
|
|
2327
|
+
"application/json": components["schemas"]["BranchResponse"];
|
|
2328
|
+
};
|
|
2329
|
+
};
|
|
2330
|
+
403: never;
|
|
2331
|
+
/** @description Failed to create database branch */
|
|
2332
|
+
500: never;
|
|
2333
|
+
};
|
|
2334
|
+
};
|
|
2335
|
+
/**
|
|
2336
|
+
* Disables preview branching
|
|
2337
|
+
* @description Disables preview branching for the specified project
|
|
2338
|
+
*/
|
|
2339
|
+
"v1-disable-preview-branching": {
|
|
2340
|
+
parameters: {
|
|
2341
|
+
path: {
|
|
2342
|
+
/** @description Project ref */
|
|
2343
|
+
ref: string;
|
|
2344
|
+
};
|
|
2345
|
+
};
|
|
2346
|
+
responses: {
|
|
2347
|
+
200: never;
|
|
2348
|
+
403: never;
|
|
2349
|
+
/** @description Failed to disable preview branching */
|
|
2350
|
+
500: never;
|
|
2351
|
+
};
|
|
2352
|
+
};
|
|
2353
|
+
/** [Beta] Gets project's custom hostname config */
|
|
2354
|
+
"v1-get-hostname-config": {
|
|
2355
|
+
parameters: {
|
|
2356
|
+
path: {
|
|
2357
|
+
/** @description Project ref */
|
|
2358
|
+
ref: string;
|
|
2359
|
+
};
|
|
2360
|
+
};
|
|
2361
|
+
responses: {
|
|
2362
|
+
200: {
|
|
2363
|
+
content: {
|
|
2364
|
+
"application/json": components["schemas"]["UpdateCustomHostnameResponse"];
|
|
2365
|
+
};
|
|
2366
|
+
};
|
|
2367
|
+
403: never;
|
|
2368
|
+
/** @description Failed to retrieve project's custom hostname config */
|
|
2369
|
+
500: never;
|
|
2370
|
+
};
|
|
2371
|
+
};
|
|
2372
|
+
/** [Beta] Deletes a project's custom hostname configuration */
|
|
2373
|
+
"v1-Delete hostname config": {
|
|
2374
|
+
parameters: {
|
|
2375
|
+
path: {
|
|
2376
|
+
/** @description Project ref */
|
|
2377
|
+
ref: string;
|
|
2378
|
+
};
|
|
2379
|
+
};
|
|
2380
|
+
responses: {
|
|
2381
|
+
200: never;
|
|
2382
|
+
403: never;
|
|
2383
|
+
/** @description Failed to delete project custom hostname configuration */
|
|
2384
|
+
500: never;
|
|
2385
|
+
};
|
|
2386
|
+
};
|
|
2387
|
+
/** [Beta] Updates project's custom hostname configuration */
|
|
2388
|
+
"v1-update-hostname-config": {
|
|
2389
|
+
parameters: {
|
|
2390
|
+
path: {
|
|
2391
|
+
/** @description Project ref */
|
|
2392
|
+
ref: string;
|
|
2393
|
+
};
|
|
2394
|
+
};
|
|
2395
|
+
requestBody: {
|
|
2396
|
+
content: {
|
|
2397
|
+
"application/json": components["schemas"]["UpdateCustomHostnameBody"];
|
|
2398
|
+
};
|
|
2399
|
+
};
|
|
2400
|
+
responses: {
|
|
2401
|
+
201: {
|
|
2402
|
+
content: {
|
|
2403
|
+
"application/json": components["schemas"]["UpdateCustomHostnameResponse"];
|
|
2404
|
+
};
|
|
2405
|
+
};
|
|
2406
|
+
403: never;
|
|
2407
|
+
/** @description Failed to update project custom hostname configuration */
|
|
2408
|
+
500: never;
|
|
2409
|
+
};
|
|
2410
|
+
};
|
|
2411
|
+
/** [Beta] Attempts to verify the DNS configuration for project's custom hostname configuration */
|
|
2412
|
+
"v1-verify-dns-config": {
|
|
2413
|
+
parameters: {
|
|
2414
|
+
path: {
|
|
2415
|
+
/** @description Project ref */
|
|
2416
|
+
ref: string;
|
|
2417
|
+
};
|
|
2418
|
+
};
|
|
2419
|
+
responses: {
|
|
2420
|
+
201: {
|
|
2421
|
+
content: {
|
|
2422
|
+
"application/json": components["schemas"]["UpdateCustomHostnameResponse"];
|
|
2423
|
+
};
|
|
2424
|
+
};
|
|
2425
|
+
403: never;
|
|
2426
|
+
/** @description Failed to verify project custom hostname configuration */
|
|
2427
|
+
500: never;
|
|
2428
|
+
};
|
|
2429
|
+
};
|
|
2430
|
+
/** [Beta] Activates a custom hostname for a project. */
|
|
2431
|
+
"v1-activate-custom-hostname": {
|
|
2432
|
+
parameters: {
|
|
2433
|
+
path: {
|
|
2434
|
+
/** @description Project ref */
|
|
2435
|
+
ref: string;
|
|
2436
|
+
};
|
|
2437
|
+
};
|
|
2438
|
+
responses: {
|
|
2439
|
+
201: {
|
|
2440
|
+
content: {
|
|
2441
|
+
"application/json": components["schemas"]["UpdateCustomHostnameResponse"];
|
|
2442
|
+
};
|
|
2443
|
+
};
|
|
2444
|
+
403: never;
|
|
2445
|
+
/** @description Failed to activate project custom hostname configuration */
|
|
2446
|
+
500: never;
|
|
2447
|
+
};
|
|
2448
|
+
};
|
|
2449
|
+
/** [Beta] Gets project's network bans */
|
|
2450
|
+
"v1-list-all-network-bans": {
|
|
2451
|
+
parameters: {
|
|
2452
|
+
path: {
|
|
2453
|
+
/** @description Project ref */
|
|
2454
|
+
ref: string;
|
|
2455
|
+
};
|
|
2456
|
+
};
|
|
2457
|
+
responses: {
|
|
2458
|
+
201: {
|
|
2459
|
+
content: {
|
|
2460
|
+
"application/json": components["schemas"]["NetworkBanResponse"];
|
|
2461
|
+
};
|
|
2462
|
+
};
|
|
2463
|
+
403: never;
|
|
2464
|
+
/** @description Failed to retrieve project's network bans */
|
|
2465
|
+
500: never;
|
|
2466
|
+
};
|
|
2467
|
+
};
|
|
2468
|
+
/** [Beta] Remove network bans. */
|
|
2469
|
+
"v1-delete-network-bans": {
|
|
2470
|
+
parameters: {
|
|
2471
|
+
path: {
|
|
2472
|
+
/** @description Project ref */
|
|
2473
|
+
ref: string;
|
|
2474
|
+
};
|
|
2475
|
+
};
|
|
2476
|
+
requestBody: {
|
|
2477
|
+
content: {
|
|
2478
|
+
"application/json": components["schemas"]["RemoveNetworkBanRequest"];
|
|
2479
|
+
};
|
|
2480
|
+
};
|
|
2481
|
+
responses: {
|
|
2482
|
+
200: never;
|
|
2483
|
+
403: never;
|
|
2484
|
+
/** @description Failed to remove network bans. */
|
|
2485
|
+
500: never;
|
|
2486
|
+
};
|
|
2487
|
+
};
|
|
2488
|
+
/** [Beta] Gets project's network restrictions */
|
|
2489
|
+
"v1-get-network-restrictions": {
|
|
2490
|
+
parameters: {
|
|
2491
|
+
path: {
|
|
2492
|
+
/** @description Project ref */
|
|
2493
|
+
ref: string;
|
|
2494
|
+
};
|
|
2495
|
+
};
|
|
2496
|
+
responses: {
|
|
2497
|
+
200: {
|
|
2498
|
+
content: {
|
|
2499
|
+
"application/json": components["schemas"]["NetworkRestrictionsResponse"];
|
|
2500
|
+
};
|
|
2501
|
+
};
|
|
2502
|
+
403: never;
|
|
2503
|
+
/** @description Failed to retrieve project's network restrictions */
|
|
2504
|
+
500: never;
|
|
2505
|
+
};
|
|
2506
|
+
};
|
|
2507
|
+
/** [Beta] Updates project's network restrictions */
|
|
2508
|
+
"v1-update-network-restrictions": {
|
|
2509
|
+
parameters: {
|
|
2510
|
+
path: {
|
|
2511
|
+
/** @description Project ref */
|
|
2512
|
+
ref: string;
|
|
2513
|
+
};
|
|
2514
|
+
};
|
|
2515
|
+
requestBody: {
|
|
2516
|
+
content: {
|
|
2517
|
+
"application/json": components["schemas"]["NetworkRestrictionsRequest"];
|
|
2518
|
+
};
|
|
2519
|
+
};
|
|
2520
|
+
responses: {
|
|
2521
|
+
201: {
|
|
2522
|
+
content: {
|
|
2523
|
+
"application/json": components["schemas"]["NetworkRestrictionsResponse"];
|
|
2524
|
+
};
|
|
2525
|
+
};
|
|
2526
|
+
403: never;
|
|
2527
|
+
/** @description Failed to update project network restrictions */
|
|
2528
|
+
500: never;
|
|
2529
|
+
};
|
|
2530
|
+
};
|
|
2531
|
+
/** [Beta] Gets project's pgsodium config */
|
|
2532
|
+
"v1-get-pgsodium-config": {
|
|
2533
|
+
parameters: {
|
|
2534
|
+
path: {
|
|
2535
|
+
/** @description Project ref */
|
|
2536
|
+
ref: string;
|
|
2537
|
+
};
|
|
2538
|
+
};
|
|
2539
|
+
responses: {
|
|
2540
|
+
200: {
|
|
2541
|
+
content: {
|
|
2542
|
+
"application/json": components["schemas"]["PgsodiumConfigResponse"];
|
|
2543
|
+
};
|
|
2544
|
+
};
|
|
2545
|
+
403: never;
|
|
2546
|
+
/** @description Failed to retrieve project's pgsodium config */
|
|
2547
|
+
500: never;
|
|
2548
|
+
};
|
|
2549
|
+
};
|
|
2550
|
+
/** [Beta] Updates project's pgsodium config. Updating the root_key can cause all data encrypted with the older key to become inaccessible. */
|
|
2551
|
+
"v1-update-pgsodium-config": {
|
|
2552
|
+
parameters: {
|
|
2553
|
+
path: {
|
|
2554
|
+
/** @description Project ref */
|
|
2555
|
+
ref: string;
|
|
2556
|
+
};
|
|
2557
|
+
};
|
|
2558
|
+
requestBody: {
|
|
2559
|
+
content: {
|
|
2560
|
+
"application/json": components["schemas"]["UpdatePgsodiumConfigBody"];
|
|
2561
|
+
};
|
|
2562
|
+
};
|
|
2563
|
+
responses: {
|
|
2564
|
+
200: {
|
|
2565
|
+
content: {
|
|
2566
|
+
"application/json": components["schemas"]["PgsodiumConfigResponse"];
|
|
2567
|
+
};
|
|
2568
|
+
};
|
|
2569
|
+
403: never;
|
|
2570
|
+
/** @description Failed to update project's pgsodium config */
|
|
2571
|
+
500: never;
|
|
2572
|
+
};
|
|
2573
|
+
};
|
|
2574
|
+
/** Gets project's postgrest config */
|
|
2575
|
+
"v1-get-postgrest-service-config": {
|
|
2576
|
+
parameters: {
|
|
2577
|
+
path: {
|
|
2578
|
+
/** @description Project ref */
|
|
2579
|
+
ref: string;
|
|
2580
|
+
};
|
|
2581
|
+
};
|
|
2582
|
+
responses: {
|
|
2583
|
+
200: {
|
|
2584
|
+
content: {
|
|
2585
|
+
"application/json": components["schemas"]["PostgrestConfigWithJWTSecretResponse"];
|
|
2586
|
+
};
|
|
2587
|
+
};
|
|
2588
|
+
403: never;
|
|
2589
|
+
/** @description Failed to retrieve project's postgrest config */
|
|
2590
|
+
500: never;
|
|
2591
|
+
};
|
|
2592
|
+
};
|
|
2593
|
+
/** Updates project's postgrest config */
|
|
2594
|
+
"v1-update-postgrest-service-config": {
|
|
2595
|
+
parameters: {
|
|
2596
|
+
path: {
|
|
2597
|
+
/** @description Project ref */
|
|
2598
|
+
ref: string;
|
|
2599
|
+
};
|
|
2600
|
+
};
|
|
2601
|
+
requestBody: {
|
|
2602
|
+
content: {
|
|
2603
|
+
"application/json": components["schemas"]["V1UpdatePostgrestConfigBody"];
|
|
2604
|
+
};
|
|
2605
|
+
};
|
|
2606
|
+
responses: {
|
|
2607
|
+
200: {
|
|
2608
|
+
content: {
|
|
2609
|
+
"application/json": components["schemas"]["V1PostgrestConfigResponse"];
|
|
2610
|
+
};
|
|
2611
|
+
};
|
|
2612
|
+
403: never;
|
|
2613
|
+
/** @description Failed to update project's postgrest config */
|
|
2614
|
+
500: never;
|
|
2615
|
+
};
|
|
2616
|
+
};
|
|
2617
|
+
/** Gets a specific project that belongs to the authenticated user */
|
|
2618
|
+
"v1-get-project": {
|
|
2619
|
+
parameters: {
|
|
2620
|
+
path: {
|
|
2621
|
+
/** @description Project ref */
|
|
2622
|
+
ref: string;
|
|
2623
|
+
};
|
|
2624
|
+
};
|
|
2625
|
+
responses: {
|
|
2626
|
+
200: {
|
|
2627
|
+
content: {
|
|
2628
|
+
"application/json": components["schemas"]["V1ProjectWithDatabaseResponse"];
|
|
2629
|
+
};
|
|
2630
|
+
};
|
|
2631
|
+
403: never;
|
|
2632
|
+
/** @description Failed to retrieve project */
|
|
2633
|
+
500: never;
|
|
2634
|
+
};
|
|
2635
|
+
};
|
|
2636
|
+
/** Deletes the given project */
|
|
2637
|
+
"v1-delete-a-project": {
|
|
2638
|
+
parameters: {
|
|
2639
|
+
path: {
|
|
2640
|
+
/** @description Project ref */
|
|
2641
|
+
ref: string;
|
|
2642
|
+
};
|
|
2643
|
+
};
|
|
2644
|
+
responses: {
|
|
2645
|
+
200: {
|
|
2646
|
+
content: {
|
|
2647
|
+
"application/json": components["schemas"]["V1ProjectRefResponse"];
|
|
2648
|
+
};
|
|
2649
|
+
};
|
|
2650
|
+
403: never;
|
|
2651
|
+
};
|
|
2652
|
+
};
|
|
2653
|
+
/**
|
|
2654
|
+
* List all secrets
|
|
2655
|
+
* @description Returns all secrets you've previously added to the specified project.
|
|
2656
|
+
*/
|
|
2657
|
+
"v1-list-all-secrets": {
|
|
2658
|
+
parameters: {
|
|
2659
|
+
path: {
|
|
2660
|
+
/** @description Project ref */
|
|
2661
|
+
ref: string;
|
|
2662
|
+
};
|
|
2663
|
+
};
|
|
2664
|
+
responses: {
|
|
2665
|
+
200: {
|
|
2666
|
+
content: {
|
|
2667
|
+
"application/json": (components["schemas"]["SecretResponse"])[];
|
|
2668
|
+
};
|
|
2669
|
+
};
|
|
2670
|
+
403: never;
|
|
2671
|
+
/** @description Failed to retrieve project's secrets */
|
|
2672
|
+
500: never;
|
|
2673
|
+
};
|
|
2674
|
+
};
|
|
2675
|
+
/**
|
|
2676
|
+
* Bulk create secrets
|
|
2677
|
+
* @description Creates multiple secrets and adds them to the specified project.
|
|
2678
|
+
*/
|
|
2679
|
+
"v1-bulk-create-secrets": {
|
|
2680
|
+
parameters: {
|
|
2681
|
+
path: {
|
|
2682
|
+
/** @description Project ref */
|
|
2683
|
+
ref: string;
|
|
2684
|
+
};
|
|
2685
|
+
};
|
|
2686
|
+
requestBody: {
|
|
2687
|
+
content: {
|
|
2688
|
+
"application/json": components["schemas"]["CreateSecretBody"];
|
|
2689
|
+
};
|
|
2690
|
+
};
|
|
2691
|
+
responses: {
|
|
2692
|
+
201: never;
|
|
2693
|
+
403: never;
|
|
2694
|
+
/** @description Failed to create project's secrets */
|
|
2695
|
+
500: never;
|
|
2696
|
+
};
|
|
2697
|
+
};
|
|
2698
|
+
/**
|
|
2699
|
+
* Bulk delete secrets
|
|
2700
|
+
* @description Deletes all secrets with the given names from the specified project
|
|
2701
|
+
*/
|
|
2702
|
+
"v1-bulk-delete-secrets": {
|
|
2703
|
+
parameters: {
|
|
2704
|
+
path: {
|
|
2705
|
+
/** @description Project ref */
|
|
2706
|
+
ref: string;
|
|
2707
|
+
};
|
|
2708
|
+
};
|
|
2709
|
+
requestBody: {
|
|
2710
|
+
content: {
|
|
2711
|
+
"application/json": (string)[];
|
|
2712
|
+
};
|
|
2713
|
+
};
|
|
2714
|
+
responses: {
|
|
2715
|
+
200: {
|
|
2716
|
+
content: {
|
|
2717
|
+
"application/json": Record<string, never>;
|
|
2718
|
+
};
|
|
2719
|
+
};
|
|
2720
|
+
403: never;
|
|
2721
|
+
/** @description Failed to delete secrets with given names */
|
|
2722
|
+
500: never;
|
|
2723
|
+
};
|
|
2724
|
+
};
|
|
2725
|
+
/** [Beta] Get project's SSL enforcement configuration. */
|
|
2726
|
+
"v1-get-ssl-enforcement-config": {
|
|
2727
|
+
parameters: {
|
|
2728
|
+
path: {
|
|
2729
|
+
/** @description Project ref */
|
|
2730
|
+
ref: string;
|
|
2731
|
+
};
|
|
2732
|
+
};
|
|
2733
|
+
responses: {
|
|
2734
|
+
200: {
|
|
2735
|
+
content: {
|
|
2736
|
+
"application/json": components["schemas"]["SslEnforcementResponse"];
|
|
2737
|
+
};
|
|
2738
|
+
};
|
|
2739
|
+
403: never;
|
|
2740
|
+
/** @description Failed to retrieve project's SSL enforcement config */
|
|
2741
|
+
500: never;
|
|
2742
|
+
};
|
|
2743
|
+
};
|
|
2744
|
+
/** [Beta] Update project's SSL enforcement configuration. */
|
|
2745
|
+
"v1-update-ssl-enforcement-config": {
|
|
2746
|
+
parameters: {
|
|
2747
|
+
path: {
|
|
2748
|
+
/** @description Project ref */
|
|
2749
|
+
ref: string;
|
|
2750
|
+
};
|
|
2751
|
+
};
|
|
2752
|
+
requestBody: {
|
|
2753
|
+
content: {
|
|
2754
|
+
"application/json": components["schemas"]["SslEnforcementRequest"];
|
|
2755
|
+
};
|
|
2756
|
+
};
|
|
2757
|
+
responses: {
|
|
2758
|
+
200: {
|
|
2759
|
+
content: {
|
|
2760
|
+
"application/json": components["schemas"]["SslEnforcementResponse"];
|
|
2761
|
+
};
|
|
2762
|
+
};
|
|
2763
|
+
403: never;
|
|
2764
|
+
/** @description Failed to update project's SSL enforcement configuration. */
|
|
2765
|
+
500: never;
|
|
2766
|
+
};
|
|
2767
|
+
};
|
|
2768
|
+
/**
|
|
2769
|
+
* Generate TypeScript types
|
|
2770
|
+
* @description Returns the TypeScript types of your schema for use with supabase-js.
|
|
2771
|
+
*/
|
|
2772
|
+
"v1-generate-typescript-types": {
|
|
2773
|
+
parameters: {
|
|
2774
|
+
query?: {
|
|
2775
|
+
included_schemas?: string;
|
|
2776
|
+
};
|
|
2777
|
+
path: {
|
|
2778
|
+
/** @description Project ref */
|
|
2779
|
+
ref: string;
|
|
2780
|
+
};
|
|
2781
|
+
};
|
|
2782
|
+
responses: {
|
|
2783
|
+
200: {
|
|
2784
|
+
content: {
|
|
2785
|
+
"application/json": components["schemas"]["TypescriptResponse"];
|
|
2786
|
+
};
|
|
2787
|
+
};
|
|
2788
|
+
403: never;
|
|
2789
|
+
/** @description Failed to generate TypeScript types */
|
|
2790
|
+
500: never;
|
|
2791
|
+
};
|
|
2792
|
+
};
|
|
2793
|
+
/** [Beta] Gets current vanity subdomain config */
|
|
2794
|
+
"v1-get-vanity-subdomain-config": {
|
|
2795
|
+
parameters: {
|
|
2796
|
+
path: {
|
|
2797
|
+
/** @description Project ref */
|
|
2798
|
+
ref: string;
|
|
2799
|
+
};
|
|
2800
|
+
};
|
|
2801
|
+
responses: {
|
|
2802
|
+
200: {
|
|
2803
|
+
content: {
|
|
2804
|
+
"application/json": components["schemas"]["VanitySubdomainConfigResponse"];
|
|
2805
|
+
};
|
|
2806
|
+
};
|
|
2807
|
+
403: never;
|
|
2808
|
+
/** @description Failed to get project vanity subdomain configuration */
|
|
2809
|
+
500: never;
|
|
2810
|
+
};
|
|
2811
|
+
};
|
|
2812
|
+
/** [Beta] Deletes a project's vanity subdomain configuration */
|
|
2813
|
+
"v1-deactivate-vanity-subdomain-config": {
|
|
2814
|
+
parameters: {
|
|
2815
|
+
path: {
|
|
2816
|
+
/** @description Project ref */
|
|
2817
|
+
ref: string;
|
|
2818
|
+
};
|
|
2819
|
+
};
|
|
2820
|
+
responses: {
|
|
2821
|
+
200: never;
|
|
2822
|
+
403: never;
|
|
2823
|
+
/** @description Failed to delete project vanity subdomain configuration */
|
|
2824
|
+
500: never;
|
|
2825
|
+
};
|
|
2826
|
+
};
|
|
2827
|
+
/** [Beta] Checks vanity subdomain availability */
|
|
2828
|
+
"v1-check-vanity-subdomain-availability": {
|
|
2829
|
+
parameters: {
|
|
2830
|
+
path: {
|
|
2831
|
+
/** @description Project ref */
|
|
2832
|
+
ref: string;
|
|
2833
|
+
};
|
|
2834
|
+
};
|
|
2835
|
+
requestBody: {
|
|
2836
|
+
content: {
|
|
2837
|
+
"application/json": components["schemas"]["VanitySubdomainBody"];
|
|
2838
|
+
};
|
|
2839
|
+
};
|
|
2840
|
+
responses: {
|
|
2841
|
+
201: {
|
|
2842
|
+
content: {
|
|
2843
|
+
"application/json": components["schemas"]["SubdomainAvailabilityResponse"];
|
|
2844
|
+
};
|
|
2845
|
+
};
|
|
2846
|
+
403: never;
|
|
2847
|
+
/** @description Failed to check project vanity subdomain configuration */
|
|
2848
|
+
500: never;
|
|
2849
|
+
};
|
|
2850
|
+
};
|
|
2851
|
+
/** [Beta] Activates a vanity subdomain for a project. */
|
|
2852
|
+
"v1-activate-vanity-subdomain-config": {
|
|
2853
|
+
parameters: {
|
|
2854
|
+
path: {
|
|
2855
|
+
/** @description Project ref */
|
|
2856
|
+
ref: string;
|
|
2857
|
+
};
|
|
2858
|
+
};
|
|
2859
|
+
requestBody: {
|
|
2860
|
+
content: {
|
|
2861
|
+
"application/json": components["schemas"]["VanitySubdomainBody"];
|
|
2862
|
+
};
|
|
2863
|
+
};
|
|
2864
|
+
responses: {
|
|
2865
|
+
201: {
|
|
2866
|
+
content: {
|
|
2867
|
+
"application/json": components["schemas"]["ActivateVanitySubdomainResponse"];
|
|
2868
|
+
};
|
|
2869
|
+
};
|
|
2870
|
+
403: never;
|
|
2871
|
+
/** @description Failed to activate project vanity subdomain configuration */
|
|
2872
|
+
500: never;
|
|
2873
|
+
};
|
|
2874
|
+
};
|
|
2875
|
+
/** [Beta] Upgrades the project's Postgres version */
|
|
2876
|
+
"v1-upgrade-postgres-version": {
|
|
2877
|
+
parameters: {
|
|
2878
|
+
path: {
|
|
2879
|
+
/** @description Project ref */
|
|
2880
|
+
ref: string;
|
|
2881
|
+
};
|
|
2882
|
+
};
|
|
2883
|
+
requestBody: {
|
|
2884
|
+
content: {
|
|
2885
|
+
"application/json": components["schemas"]["UpgradeDatabaseBody"];
|
|
2886
|
+
};
|
|
2887
|
+
};
|
|
2888
|
+
responses: {
|
|
2889
|
+
201: {
|
|
2890
|
+
content: {
|
|
2891
|
+
"application/json": components["schemas"]["ProjectUpgradeInitiateResponse"];
|
|
2892
|
+
};
|
|
2893
|
+
};
|
|
2894
|
+
403: never;
|
|
2895
|
+
/** @description Failed to initiate project upgrade */
|
|
2896
|
+
500: never;
|
|
2897
|
+
};
|
|
2898
|
+
};
|
|
2899
|
+
/** [Beta] Returns the project's eligibility for upgrades */
|
|
2900
|
+
"v1-get-postgres-upgrade-eligibility": {
|
|
2901
|
+
parameters: {
|
|
2902
|
+
path: {
|
|
2903
|
+
/** @description Project ref */
|
|
2904
|
+
ref: string;
|
|
2905
|
+
};
|
|
2906
|
+
};
|
|
2907
|
+
responses: {
|
|
2908
|
+
200: {
|
|
2909
|
+
content: {
|
|
2910
|
+
"application/json": components["schemas"]["ProjectUpgradeEligibilityResponse"];
|
|
2911
|
+
};
|
|
2912
|
+
};
|
|
2913
|
+
403: never;
|
|
2914
|
+
/** @description Failed to determine project upgrade eligibility */
|
|
2915
|
+
500: never;
|
|
2916
|
+
};
|
|
2917
|
+
};
|
|
2918
|
+
/** [Beta] Gets the latest status of the project's upgrade */
|
|
2919
|
+
"v1-get-postgres-upgrade-status": {
|
|
2920
|
+
parameters: {
|
|
2921
|
+
query?: {
|
|
2922
|
+
tracking_id?: string;
|
|
2923
|
+
};
|
|
2924
|
+
path: {
|
|
2925
|
+
/** @description Project ref */
|
|
2926
|
+
ref: string;
|
|
2927
|
+
};
|
|
2928
|
+
};
|
|
2929
|
+
responses: {
|
|
2930
|
+
200: {
|
|
2931
|
+
content: {
|
|
2932
|
+
"application/json": components["schemas"]["DatabaseUpgradeStatusResponse"];
|
|
2933
|
+
};
|
|
2934
|
+
};
|
|
2935
|
+
403: never;
|
|
2936
|
+
/** @description Failed to retrieve project upgrade status */
|
|
2937
|
+
500: never;
|
|
2938
|
+
};
|
|
2939
|
+
};
|
|
2940
|
+
/** Returns project's readonly mode status */
|
|
2941
|
+
"v1-get-readonly-mode-status": {
|
|
2942
|
+
parameters: {
|
|
2943
|
+
path: {
|
|
2944
|
+
/** @description Project ref */
|
|
2945
|
+
ref: string;
|
|
2946
|
+
};
|
|
2947
|
+
};
|
|
2948
|
+
responses: {
|
|
2949
|
+
200: {
|
|
2950
|
+
content: {
|
|
2951
|
+
"application/json": components["schemas"]["ReadOnlyStatusResponse"];
|
|
2952
|
+
};
|
|
2953
|
+
};
|
|
2954
|
+
403: never;
|
|
2955
|
+
/** @description Failed to get project readonly mode status */
|
|
2956
|
+
500: never;
|
|
2957
|
+
};
|
|
2958
|
+
};
|
|
2959
|
+
/** Disables project's readonly mode for the next 15 minutes */
|
|
2960
|
+
"v1-disable-readonly-mode-temporarily": {
|
|
2961
|
+
parameters: {
|
|
2962
|
+
path: {
|
|
2963
|
+
/** @description Project ref */
|
|
2964
|
+
ref: string;
|
|
2965
|
+
};
|
|
2966
|
+
};
|
|
2967
|
+
responses: {
|
|
2968
|
+
201: never;
|
|
2969
|
+
403: never;
|
|
2970
|
+
/** @description Failed to disable project's readonly mode */
|
|
2971
|
+
500: never;
|
|
2972
|
+
};
|
|
2973
|
+
};
|
|
2974
|
+
/** [Beta] Set up a read replica */
|
|
2975
|
+
"v1-setup-a-read-replica": {
|
|
2976
|
+
parameters: {
|
|
2977
|
+
path: {
|
|
2978
|
+
/** @description Project ref */
|
|
2979
|
+
ref: string;
|
|
2980
|
+
};
|
|
2981
|
+
};
|
|
2982
|
+
requestBody: {
|
|
2983
|
+
content: {
|
|
2984
|
+
"application/json": components["schemas"]["SetUpReadReplicaBody"];
|
|
2985
|
+
};
|
|
2986
|
+
};
|
|
2987
|
+
responses: {
|
|
2988
|
+
201: never;
|
|
2989
|
+
403: never;
|
|
2990
|
+
/** @description Failed to set up read replica */
|
|
2991
|
+
500: never;
|
|
2992
|
+
};
|
|
2993
|
+
};
|
|
2994
|
+
/** [Beta] Remove a read replica */
|
|
2995
|
+
"v1-remove-a-read-replica": {
|
|
2996
|
+
parameters: {
|
|
2997
|
+
path: {
|
|
2998
|
+
/** @description Project ref */
|
|
2999
|
+
ref: string;
|
|
3000
|
+
};
|
|
3001
|
+
};
|
|
3002
|
+
requestBody: {
|
|
3003
|
+
content: {
|
|
3004
|
+
"application/json": components["schemas"]["RemoveReadReplicaBody"];
|
|
3005
|
+
};
|
|
3006
|
+
};
|
|
3007
|
+
responses: {
|
|
3008
|
+
201: never;
|
|
3009
|
+
403: never;
|
|
3010
|
+
/** @description Failed to remove read replica */
|
|
3011
|
+
500: never;
|
|
3012
|
+
};
|
|
3013
|
+
};
|
|
3014
|
+
/** Gets project's service health status */
|
|
3015
|
+
"v1-get-services-health": {
|
|
3016
|
+
parameters: {
|
|
3017
|
+
query: {
|
|
3018
|
+
services: string;
|
|
3019
|
+
timeout_ms?: number;
|
|
3020
|
+
};
|
|
3021
|
+
path: {
|
|
3022
|
+
/** @description Project ref */
|
|
3023
|
+
ref: string;
|
|
3024
|
+
};
|
|
3025
|
+
};
|
|
3026
|
+
responses: {
|
|
3027
|
+
200: {
|
|
3028
|
+
content: {
|
|
3029
|
+
"application/json": (components["schemas"]["V1ServiceHealthResponse"])[];
|
|
3030
|
+
};
|
|
3031
|
+
};
|
|
3032
|
+
403: never;
|
|
3033
|
+
/** @description Failed to retrieve project's service health status */
|
|
3034
|
+
500: never;
|
|
3035
|
+
};
|
|
3036
|
+
};
|
|
3037
|
+
/** [Alpha] List all signing keys for the project */
|
|
3038
|
+
listSigningKeysForProject: {
|
|
3039
|
+
parameters: {
|
|
3040
|
+
path: {
|
|
3041
|
+
/** @description Project ref */
|
|
3042
|
+
ref: string;
|
|
3043
|
+
};
|
|
3044
|
+
};
|
|
3045
|
+
responses: {
|
|
3046
|
+
200: {
|
|
3047
|
+
content: {
|
|
3048
|
+
"application/json": components["schemas"]["SigningKeysResponse"];
|
|
3049
|
+
};
|
|
3050
|
+
};
|
|
3051
|
+
403: never;
|
|
3052
|
+
};
|
|
3053
|
+
};
|
|
3054
|
+
/** [Alpha] Create a new signing key for the project in standby status */
|
|
3055
|
+
createSigningKeyForProject: {
|
|
3056
|
+
parameters: {
|
|
3057
|
+
path: {
|
|
3058
|
+
/** @description Project ref */
|
|
3059
|
+
ref: string;
|
|
3060
|
+
};
|
|
3061
|
+
};
|
|
3062
|
+
requestBody: {
|
|
3063
|
+
content: {
|
|
3064
|
+
"application/json": components["schemas"]["CreateSigningKeyBody"];
|
|
3065
|
+
};
|
|
3066
|
+
};
|
|
3067
|
+
responses: {
|
|
3068
|
+
/** @description [Alpha] Create a new signing key for the project in standby status */
|
|
3069
|
+
201: {
|
|
3070
|
+
content: {
|
|
3071
|
+
"application/json": components["schemas"]["CreateSigningKeyBody"];
|
|
3072
|
+
};
|
|
3073
|
+
};
|
|
3074
|
+
403: never;
|
|
3075
|
+
};
|
|
3076
|
+
};
|
|
3077
|
+
/** [Alpha] Get information about a signing key */
|
|
3078
|
+
getSigningKeyForProject: {
|
|
3079
|
+
parameters: {
|
|
3080
|
+
path: {
|
|
3081
|
+
id: string;
|
|
3082
|
+
/** @description Project ref */
|
|
3083
|
+
ref: string;
|
|
3084
|
+
};
|
|
3085
|
+
};
|
|
3086
|
+
responses: {
|
|
3087
|
+
200: {
|
|
3088
|
+
content: {
|
|
3089
|
+
"application/json": components["schemas"]["SigningKeyResponse"];
|
|
3090
|
+
};
|
|
3091
|
+
};
|
|
3092
|
+
403: never;
|
|
3093
|
+
};
|
|
3094
|
+
};
|
|
3095
|
+
/** [Alpha] Remove a signing key from a project, where the status is previously_used */
|
|
3096
|
+
deleteSigningKey: {
|
|
3097
|
+
parameters: {
|
|
3098
|
+
path: {
|
|
3099
|
+
id: string;
|
|
3100
|
+
/** @description Project ref */
|
|
3101
|
+
ref: string;
|
|
3102
|
+
};
|
|
3103
|
+
};
|
|
3104
|
+
responses: {
|
|
3105
|
+
200: {
|
|
3106
|
+
content: {
|
|
3107
|
+
"application/json": components["schemas"]["SigningKeyResponse"];
|
|
3108
|
+
};
|
|
3109
|
+
};
|
|
3110
|
+
403: never;
|
|
3111
|
+
};
|
|
3112
|
+
};
|
|
3113
|
+
/** [Alpha] Update a signing key, mainly its status */
|
|
3114
|
+
patchSigningKey: {
|
|
3115
|
+
parameters: {
|
|
3116
|
+
path: {
|
|
3117
|
+
id: string;
|
|
3118
|
+
/** @description Project ref */
|
|
3119
|
+
ref: string;
|
|
3120
|
+
};
|
|
3121
|
+
};
|
|
3122
|
+
requestBody: {
|
|
3123
|
+
content: {
|
|
3124
|
+
"application/json": components["schemas"]["UpdateSigningKeyBody"];
|
|
3125
|
+
};
|
|
3126
|
+
};
|
|
3127
|
+
responses: {
|
|
3128
|
+
200: {
|
|
3129
|
+
content: {
|
|
3130
|
+
"application/json": components["schemas"]["SigningKeyResponse"];
|
|
3131
|
+
};
|
|
3132
|
+
};
|
|
3133
|
+
403: never;
|
|
3134
|
+
};
|
|
3135
|
+
};
|
|
3136
|
+
/** Gets project's storage config */
|
|
3137
|
+
"v1-get-storage-config": {
|
|
3138
|
+
parameters: {
|
|
3139
|
+
path: {
|
|
3140
|
+
/** @description Project ref */
|
|
3141
|
+
ref: string;
|
|
3142
|
+
};
|
|
3143
|
+
};
|
|
3144
|
+
responses: {
|
|
3145
|
+
200: {
|
|
3146
|
+
content: {
|
|
3147
|
+
"application/json": components["schemas"]["StorageConfigResponse"];
|
|
3148
|
+
};
|
|
3149
|
+
};
|
|
3150
|
+
403: never;
|
|
3151
|
+
/** @description Failed to retrieve project's storage config */
|
|
3152
|
+
500: never;
|
|
3153
|
+
};
|
|
3154
|
+
};
|
|
3155
|
+
/** Updates project's storage config */
|
|
3156
|
+
"v1-update-storage-config": {
|
|
3157
|
+
parameters: {
|
|
3158
|
+
path: {
|
|
3159
|
+
/** @description Project ref */
|
|
3160
|
+
ref: string;
|
|
3161
|
+
};
|
|
3162
|
+
};
|
|
3163
|
+
requestBody: {
|
|
3164
|
+
content: {
|
|
3165
|
+
"application/json": components["schemas"]["UpdateStorageConfigBody"];
|
|
3166
|
+
};
|
|
3167
|
+
};
|
|
3168
|
+
responses: {
|
|
3169
|
+
200: never;
|
|
3170
|
+
403: never;
|
|
3171
|
+
/** @description Failed to update project's storage config */
|
|
3172
|
+
500: never;
|
|
3173
|
+
};
|
|
3174
|
+
};
|
|
3175
|
+
/** Gets project's Postgres config */
|
|
3176
|
+
"v1-get-postgres-config": {
|
|
3177
|
+
parameters: {
|
|
3178
|
+
path: {
|
|
3179
|
+
/** @description Project ref */
|
|
3180
|
+
ref: string;
|
|
3181
|
+
};
|
|
3182
|
+
};
|
|
3183
|
+
responses: {
|
|
3184
|
+
200: {
|
|
3185
|
+
content: {
|
|
3186
|
+
"application/json": components["schemas"]["PostgresConfigResponse"];
|
|
3187
|
+
};
|
|
3188
|
+
};
|
|
3189
|
+
403: never;
|
|
3190
|
+
/** @description Failed to retrieve project's Postgres config */
|
|
3191
|
+
500: never;
|
|
3192
|
+
};
|
|
3193
|
+
};
|
|
3194
|
+
/** Updates project's Postgres config */
|
|
3195
|
+
"v1-update-postgres-config": {
|
|
3196
|
+
parameters: {
|
|
3197
|
+
path: {
|
|
3198
|
+
/** @description Project ref */
|
|
3199
|
+
ref: string;
|
|
3200
|
+
};
|
|
3201
|
+
};
|
|
3202
|
+
requestBody: {
|
|
3203
|
+
content: {
|
|
3204
|
+
"application/json": components["schemas"]["UpdatePostgresConfigBody"];
|
|
3205
|
+
};
|
|
3206
|
+
};
|
|
3207
|
+
responses: {
|
|
3208
|
+
200: {
|
|
3209
|
+
content: {
|
|
3210
|
+
"application/json": components["schemas"]["PostgresConfigResponse"];
|
|
3211
|
+
};
|
|
3212
|
+
};
|
|
3213
|
+
403: never;
|
|
3214
|
+
/** @description Failed to update project's Postgres config */
|
|
3215
|
+
500: never;
|
|
3216
|
+
};
|
|
3217
|
+
};
|
|
3218
|
+
/** Get project's pgbouncer config */
|
|
3219
|
+
"v1-get-project-pgbouncer-config": {
|
|
3220
|
+
parameters: {
|
|
3221
|
+
path: {
|
|
3222
|
+
/** @description Project ref */
|
|
3223
|
+
ref: string;
|
|
3224
|
+
};
|
|
3225
|
+
};
|
|
3226
|
+
responses: {
|
|
3227
|
+
200: {
|
|
3228
|
+
content: {
|
|
3229
|
+
"application/json": components["schemas"]["V1PgbouncerConfigResponse"];
|
|
3230
|
+
};
|
|
3231
|
+
};
|
|
3232
|
+
403: never;
|
|
3233
|
+
/** @description Failed to retrieve project's pgbouncer config */
|
|
3234
|
+
500: never;
|
|
3235
|
+
};
|
|
3236
|
+
};
|
|
3237
|
+
/** Gets project's supavisor config */
|
|
3238
|
+
getSupavisorConfig: {
|
|
3239
|
+
parameters: {
|
|
3240
|
+
path: {
|
|
3241
|
+
/** @description Project ref */
|
|
3242
|
+
ref: string;
|
|
3243
|
+
};
|
|
3244
|
+
};
|
|
3245
|
+
responses: {
|
|
3246
|
+
200: {
|
|
3247
|
+
content: {
|
|
3248
|
+
"application/json": (components["schemas"]["SupavisorConfigResponse"])[];
|
|
3249
|
+
};
|
|
3250
|
+
};
|
|
3251
|
+
/** @description Failed to retrieve project's supavisor config */
|
|
3252
|
+
500: never;
|
|
3253
|
+
};
|
|
3254
|
+
};
|
|
3255
|
+
/** Updates project's supavisor config */
|
|
3256
|
+
updateSupavisorConfig: {
|
|
3257
|
+
parameters: {
|
|
3258
|
+
path: {
|
|
3259
|
+
/** @description Project ref */
|
|
3260
|
+
ref: string;
|
|
3261
|
+
};
|
|
3262
|
+
};
|
|
3263
|
+
requestBody: {
|
|
3264
|
+
content: {
|
|
3265
|
+
"application/json": components["schemas"]["UpdateSupavisorConfigBody"];
|
|
3266
|
+
};
|
|
3267
|
+
};
|
|
3268
|
+
responses: {
|
|
3269
|
+
200: {
|
|
3270
|
+
content: {
|
|
3271
|
+
"application/json": components["schemas"]["UpdateSupavisorConfigResponse"];
|
|
3272
|
+
};
|
|
3273
|
+
};
|
|
3274
|
+
403: never;
|
|
3275
|
+
/** @description Failed to update project's supavisor config */
|
|
3276
|
+
500: never;
|
|
3277
|
+
};
|
|
3278
|
+
};
|
|
3279
|
+
/** Gets project's auth config */
|
|
3280
|
+
"v1-get-auth-service-config": {
|
|
3281
|
+
parameters: {
|
|
3282
|
+
path: {
|
|
3283
|
+
/** @description Project ref */
|
|
3284
|
+
ref: string;
|
|
3285
|
+
};
|
|
3286
|
+
};
|
|
3287
|
+
responses: {
|
|
3288
|
+
200: {
|
|
3289
|
+
content: {
|
|
3290
|
+
"application/json": components["schemas"]["AuthConfigResponse"];
|
|
3291
|
+
};
|
|
3292
|
+
};
|
|
3293
|
+
403: never;
|
|
3294
|
+
/** @description Failed to retrieve project's auth config */
|
|
3295
|
+
500: never;
|
|
3296
|
+
};
|
|
3297
|
+
};
|
|
3298
|
+
/** Updates a project's auth config */
|
|
3299
|
+
"v1-update-auth-service-config": {
|
|
3300
|
+
parameters: {
|
|
3301
|
+
path: {
|
|
3302
|
+
/** @description Project ref */
|
|
3303
|
+
ref: string;
|
|
3304
|
+
};
|
|
3305
|
+
};
|
|
3306
|
+
requestBody: {
|
|
3307
|
+
content: {
|
|
3308
|
+
"application/json": components["schemas"]["UpdateAuthConfigBody"];
|
|
3309
|
+
};
|
|
3310
|
+
};
|
|
3311
|
+
responses: {
|
|
3312
|
+
200: {
|
|
3313
|
+
content: {
|
|
3314
|
+
"application/json": components["schemas"]["AuthConfigResponse"];
|
|
3315
|
+
};
|
|
3316
|
+
};
|
|
3317
|
+
403: never;
|
|
3318
|
+
/** @description Failed to update project's auth config */
|
|
3319
|
+
500: never;
|
|
3320
|
+
};
|
|
3321
|
+
};
|
|
3322
|
+
/** Lists all third-party auth integrations */
|
|
3323
|
+
listTPAForProject: {
|
|
3324
|
+
parameters: {
|
|
3325
|
+
path: {
|
|
3326
|
+
/** @description Project ref */
|
|
3327
|
+
ref: string;
|
|
3328
|
+
};
|
|
3329
|
+
};
|
|
3330
|
+
responses: {
|
|
3331
|
+
200: {
|
|
3332
|
+
content: {
|
|
3333
|
+
"application/json": (components["schemas"]["ThirdPartyAuth"])[];
|
|
3334
|
+
};
|
|
3335
|
+
};
|
|
3336
|
+
403: never;
|
|
3337
|
+
};
|
|
3338
|
+
};
|
|
3339
|
+
/** Creates a new third-party auth integration */
|
|
3340
|
+
createTPAForProject: {
|
|
3341
|
+
parameters: {
|
|
3342
|
+
path: {
|
|
3343
|
+
/** @description Project ref */
|
|
3344
|
+
ref: string;
|
|
3345
|
+
};
|
|
3346
|
+
};
|
|
3347
|
+
requestBody: {
|
|
3348
|
+
content: {
|
|
3349
|
+
"application/json": components["schemas"]["CreateThirdPartyAuthBody"];
|
|
3350
|
+
};
|
|
3351
|
+
};
|
|
3352
|
+
responses: {
|
|
3353
|
+
201: {
|
|
3354
|
+
content: {
|
|
3355
|
+
"application/json": components["schemas"]["ThirdPartyAuth"];
|
|
3356
|
+
};
|
|
3357
|
+
};
|
|
3358
|
+
403: never;
|
|
3359
|
+
};
|
|
3360
|
+
};
|
|
3361
|
+
/** Get a third-party integration */
|
|
3362
|
+
getTPAForProject: {
|
|
3363
|
+
parameters: {
|
|
3364
|
+
path: {
|
|
3365
|
+
/** @description Project ref */
|
|
3366
|
+
ref: string;
|
|
3367
|
+
tpa_id: string;
|
|
3368
|
+
};
|
|
3369
|
+
};
|
|
3370
|
+
responses: {
|
|
3371
|
+
200: {
|
|
3372
|
+
content: {
|
|
3373
|
+
"application/json": components["schemas"]["ThirdPartyAuth"];
|
|
3374
|
+
};
|
|
3375
|
+
};
|
|
3376
|
+
403: never;
|
|
3377
|
+
};
|
|
3378
|
+
};
|
|
3379
|
+
/** Removes a third-party auth integration */
|
|
3380
|
+
deleteTPAForProject: {
|
|
3381
|
+
parameters: {
|
|
3382
|
+
path: {
|
|
3383
|
+
/** @description Project ref */
|
|
3384
|
+
ref: string;
|
|
3385
|
+
tpa_id: string;
|
|
3386
|
+
};
|
|
3387
|
+
};
|
|
3388
|
+
responses: {
|
|
3389
|
+
200: {
|
|
3390
|
+
content: {
|
|
3391
|
+
"application/json": components["schemas"]["ThirdPartyAuth"];
|
|
3392
|
+
};
|
|
3393
|
+
};
|
|
3394
|
+
403: never;
|
|
3395
|
+
};
|
|
3396
|
+
};
|
|
3397
|
+
/** Pauses the given project */
|
|
3398
|
+
"v1-pause-a-project": {
|
|
3399
|
+
parameters: {
|
|
3400
|
+
path: {
|
|
3401
|
+
/** @description Project ref */
|
|
3402
|
+
ref: string;
|
|
3403
|
+
};
|
|
3404
|
+
};
|
|
3405
|
+
responses: {
|
|
3406
|
+
200: never;
|
|
3407
|
+
403: never;
|
|
3408
|
+
};
|
|
3409
|
+
};
|
|
3410
|
+
/** Lists available restore versions for the given project */
|
|
3411
|
+
"v1-list-available-restore-versions": {
|
|
3412
|
+
parameters: {
|
|
3413
|
+
path: {
|
|
3414
|
+
/** @description Project ref */
|
|
3415
|
+
ref: string;
|
|
3416
|
+
};
|
|
3417
|
+
};
|
|
3418
|
+
responses: {
|
|
3419
|
+
200: {
|
|
3420
|
+
content: {
|
|
3421
|
+
"application/json": components["schemas"]["GetProjectAvailableRestoreVersionsResponse"];
|
|
3422
|
+
};
|
|
3423
|
+
};
|
|
3424
|
+
403: never;
|
|
3425
|
+
};
|
|
3426
|
+
};
|
|
3427
|
+
/** Restores the given project */
|
|
3428
|
+
"v1-restore-a-project": {
|
|
3429
|
+
parameters: {
|
|
3430
|
+
path: {
|
|
3431
|
+
/** @description Project ref */
|
|
3432
|
+
ref: string;
|
|
3433
|
+
};
|
|
3434
|
+
};
|
|
3435
|
+
responses: {
|
|
3436
|
+
200: never;
|
|
3437
|
+
403: never;
|
|
3438
|
+
};
|
|
3439
|
+
};
|
|
3440
|
+
/** Cancels the given project restoration */
|
|
3441
|
+
"v1-cancel-a-project-restoration": {
|
|
3442
|
+
parameters: {
|
|
3443
|
+
path: {
|
|
3444
|
+
/** @description Project ref */
|
|
3445
|
+
ref: string;
|
|
3446
|
+
};
|
|
3447
|
+
};
|
|
3448
|
+
responses: {
|
|
3449
|
+
200: never;
|
|
3450
|
+
403: never;
|
|
3451
|
+
};
|
|
3452
|
+
};
|
|
3453
|
+
/** Lists project addons */
|
|
3454
|
+
"v1-list-project-addons": {
|
|
3455
|
+
parameters: {
|
|
3456
|
+
path: {
|
|
3457
|
+
/** @description Project ref */
|
|
3458
|
+
ref: string;
|
|
3459
|
+
};
|
|
3460
|
+
};
|
|
3461
|
+
responses: {
|
|
3462
|
+
200: {
|
|
3463
|
+
content: {
|
|
3464
|
+
"application/json": components["schemas"]["ListProjectAddonsResponseDto"];
|
|
3465
|
+
};
|
|
3466
|
+
};
|
|
3467
|
+
403: never;
|
|
3468
|
+
/** @description Failed to list project addons */
|
|
3469
|
+
500: never;
|
|
3470
|
+
};
|
|
3471
|
+
};
|
|
3472
|
+
/** Applies project addon */
|
|
3473
|
+
"v1-apply-project-addon": {
|
|
3474
|
+
parameters: {
|
|
3475
|
+
path: {
|
|
3476
|
+
/** @description Project ref */
|
|
3477
|
+
ref: string;
|
|
3478
|
+
};
|
|
3479
|
+
};
|
|
3480
|
+
requestBody: {
|
|
3481
|
+
content: {
|
|
3482
|
+
"application/json": components["schemas"]["ApplyProjectAddonBodyDto"];
|
|
3483
|
+
};
|
|
3484
|
+
};
|
|
3485
|
+
responses: {
|
|
3486
|
+
200: never;
|
|
3487
|
+
403: never;
|
|
3488
|
+
/** @description Failed to apply project addon */
|
|
3489
|
+
500: never;
|
|
3490
|
+
};
|
|
3491
|
+
};
|
|
3492
|
+
/** Removes project addon */
|
|
3493
|
+
"v1-remove-project-addon": {
|
|
3494
|
+
parameters: {
|
|
3495
|
+
path: {
|
|
3496
|
+
/** @description Project ref */
|
|
3497
|
+
ref: string;
|
|
3498
|
+
addon_variant: unknown;
|
|
3499
|
+
};
|
|
3500
|
+
};
|
|
3501
|
+
responses: {
|
|
3502
|
+
200: never;
|
|
3503
|
+
403: never;
|
|
3504
|
+
/** @description Failed to remove project addon */
|
|
3505
|
+
500: never;
|
|
3506
|
+
};
|
|
3507
|
+
};
|
|
3508
|
+
/**
|
|
3509
|
+
* Gets project performance advisors.
|
|
3510
|
+
* @deprecated
|
|
3511
|
+
* @description This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
|
|
3512
|
+
*/
|
|
3513
|
+
getPerformanceAdvisors: {
|
|
3514
|
+
parameters: {
|
|
3515
|
+
path: {
|
|
3516
|
+
/** @description Project ref */
|
|
3517
|
+
ref: string;
|
|
3518
|
+
};
|
|
3519
|
+
};
|
|
3520
|
+
responses: {
|
|
3521
|
+
200: {
|
|
3522
|
+
content: {
|
|
3523
|
+
"application/json": components["schemas"]["V1ProjectAdvisorsResponseDto"];
|
|
3524
|
+
};
|
|
3525
|
+
};
|
|
3526
|
+
403: never;
|
|
3527
|
+
};
|
|
3528
|
+
};
|
|
3529
|
+
/**
|
|
3530
|
+
* Gets project security advisors.
|
|
3531
|
+
* @deprecated
|
|
3532
|
+
* @description This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
|
|
3533
|
+
*/
|
|
3534
|
+
getSecurityAdvisors: {
|
|
3535
|
+
parameters: {
|
|
3536
|
+
path: {
|
|
3537
|
+
/** @description Project ref */
|
|
3538
|
+
ref: string;
|
|
3539
|
+
};
|
|
3540
|
+
};
|
|
3541
|
+
responses: {
|
|
3542
|
+
200: {
|
|
3543
|
+
content: {
|
|
3544
|
+
"application/json": components["schemas"]["V1ProjectAdvisorsResponseDto"];
|
|
3545
|
+
};
|
|
3546
|
+
};
|
|
3547
|
+
403: never;
|
|
3548
|
+
};
|
|
3549
|
+
};
|
|
3550
|
+
/**
|
|
3551
|
+
* Gets project's logs
|
|
3552
|
+
* @description Executes a SQL query on the project's logs.
|
|
3553
|
+
*
|
|
3554
|
+
* Either the 'iso_timestamp_start' and 'iso_timestamp_end' parameters must be provided.
|
|
3555
|
+
* If both are not provided, only the last 1 minute of logs will be queried.
|
|
3556
|
+
* The timestamp range must be no more than 24 hours and is rounded to the nearest minute. If the range is more than 24 hours, a validation error will be thrown.
|
|
3557
|
+
*/
|
|
3558
|
+
getLogs: {
|
|
3559
|
+
parameters: {
|
|
3560
|
+
query?: {
|
|
3561
|
+
sql?: string;
|
|
3562
|
+
iso_timestamp_start?: string;
|
|
3563
|
+
iso_timestamp_end?: string;
|
|
3564
|
+
};
|
|
3565
|
+
path: {
|
|
3566
|
+
/** @description Project ref */
|
|
3567
|
+
ref: string;
|
|
3568
|
+
};
|
|
3569
|
+
};
|
|
3570
|
+
responses: {
|
|
3571
|
+
200: {
|
|
3572
|
+
content: {
|
|
3573
|
+
"application/json": components["schemas"]["V1AnalyticsResponse"];
|
|
3574
|
+
};
|
|
3575
|
+
};
|
|
3576
|
+
403: never;
|
|
3577
|
+
};
|
|
3578
|
+
};
|
|
3579
|
+
/**
|
|
3580
|
+
* [Beta] List applied migration versions
|
|
3581
|
+
* @description Only available to selected partner OAuth apps
|
|
3582
|
+
*/
|
|
3583
|
+
"v1-list-migrations": {
|
|
3584
|
+
parameters: {
|
|
3585
|
+
path: {
|
|
3586
|
+
/** @description Project ref */
|
|
3587
|
+
ref: string;
|
|
3588
|
+
};
|
|
3589
|
+
};
|
|
3590
|
+
responses: {
|
|
3591
|
+
200: {
|
|
3592
|
+
content: {
|
|
3593
|
+
"application/json": components["schemas"]["V1ListMigrationsResponse"];
|
|
3594
|
+
};
|
|
3595
|
+
};
|
|
3596
|
+
403: never;
|
|
3597
|
+
/** @description Failed to list database migrations */
|
|
3598
|
+
500: never;
|
|
3599
|
+
};
|
|
3600
|
+
};
|
|
3601
|
+
/**
|
|
3602
|
+
* [Beta] Apply a database migration
|
|
3603
|
+
* @description Only available to selected partner OAuth apps
|
|
3604
|
+
*/
|
|
3605
|
+
"v1-apply-a-migration": {
|
|
3606
|
+
parameters: {
|
|
3607
|
+
path: {
|
|
3608
|
+
/** @description Project ref */
|
|
3609
|
+
ref: string;
|
|
3610
|
+
};
|
|
3611
|
+
};
|
|
3612
|
+
requestBody: {
|
|
3613
|
+
content: {
|
|
3614
|
+
"application/json": components["schemas"]["V1CreateMigrationBody"];
|
|
3615
|
+
};
|
|
3616
|
+
};
|
|
3617
|
+
responses: {
|
|
3618
|
+
200: {
|
|
3619
|
+
content: {
|
|
3620
|
+
"application/json": Record<string, never>;
|
|
3621
|
+
};
|
|
3622
|
+
};
|
|
3623
|
+
403: never;
|
|
3624
|
+
/** @description Failed to apply database migration */
|
|
3625
|
+
500: never;
|
|
3626
|
+
};
|
|
3627
|
+
};
|
|
3628
|
+
/** [Beta] Run sql query */
|
|
3629
|
+
"v1-run-a-query": {
|
|
3630
|
+
parameters: {
|
|
3631
|
+
path: {
|
|
3632
|
+
/** @description Project ref */
|
|
3633
|
+
ref: string;
|
|
3634
|
+
};
|
|
3635
|
+
};
|
|
3636
|
+
requestBody: {
|
|
3637
|
+
content: {
|
|
3638
|
+
"application/json": components["schemas"]["V1RunQueryBody"];
|
|
3639
|
+
};
|
|
3640
|
+
};
|
|
3641
|
+
responses: {
|
|
3642
|
+
201: {
|
|
3643
|
+
content: {
|
|
3644
|
+
"application/json": Record<string, never>;
|
|
3645
|
+
};
|
|
3646
|
+
};
|
|
3647
|
+
403: never;
|
|
3648
|
+
/** @description Failed to run sql query */
|
|
3649
|
+
500: never;
|
|
3650
|
+
};
|
|
3651
|
+
};
|
|
3652
|
+
/** [Beta] Enables Database Webhooks on the project */
|
|
3653
|
+
"v1-enable-database-webhook": {
|
|
3654
|
+
parameters: {
|
|
3655
|
+
path: {
|
|
3656
|
+
/** @description Project ref */
|
|
3657
|
+
ref: string;
|
|
3658
|
+
};
|
|
3659
|
+
};
|
|
3660
|
+
responses: {
|
|
3661
|
+
201: never;
|
|
3662
|
+
403: never;
|
|
3663
|
+
/** @description Failed to enable Database Webhooks on the project */
|
|
3664
|
+
500: never;
|
|
3665
|
+
};
|
|
3666
|
+
};
|
|
3667
|
+
/**
|
|
3668
|
+
* Gets database metadata for the given project.
|
|
3669
|
+
* @deprecated
|
|
3670
|
+
* @description This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
|
|
3671
|
+
*/
|
|
3672
|
+
getDatabaseMetadata: {
|
|
3673
|
+
parameters: {
|
|
3674
|
+
path: {
|
|
3675
|
+
/** @description Project ref */
|
|
3676
|
+
ref: string;
|
|
3677
|
+
};
|
|
3678
|
+
};
|
|
3679
|
+
responses: {
|
|
3680
|
+
200: {
|
|
3681
|
+
content: {
|
|
3682
|
+
"application/json": components["schemas"]["GetProjectDbMetadataResponseDto"];
|
|
3683
|
+
};
|
|
3684
|
+
};
|
|
3685
|
+
403: never;
|
|
3686
|
+
};
|
|
3687
|
+
};
|
|
3688
|
+
/**
|
|
3689
|
+
* List all functions
|
|
3690
|
+
* @description Returns all functions you've previously added to the specified project.
|
|
3691
|
+
*/
|
|
3692
|
+
"v1-list-all-functions": {
|
|
3693
|
+
parameters: {
|
|
3694
|
+
path: {
|
|
3695
|
+
/** @description Project ref */
|
|
3696
|
+
ref: string;
|
|
3697
|
+
};
|
|
3698
|
+
};
|
|
3699
|
+
responses: {
|
|
3700
|
+
200: {
|
|
3701
|
+
content: {
|
|
3702
|
+
"application/json": (components["schemas"]["FunctionResponse"])[];
|
|
3703
|
+
};
|
|
3704
|
+
};
|
|
3705
|
+
403: never;
|
|
3706
|
+
/** @description Failed to retrieve project's functions */
|
|
3707
|
+
500: never;
|
|
3708
|
+
};
|
|
3709
|
+
};
|
|
3710
|
+
/**
|
|
3711
|
+
* Bulk update functions
|
|
3712
|
+
* @description Bulk update functions. It will create a new function or replace existing. The operation is idempotent. NOTE: You will need to manually bump the version.
|
|
3713
|
+
*/
|
|
3714
|
+
"v1-bulk-update-functions": {
|
|
3715
|
+
parameters: {
|
|
3716
|
+
path: {
|
|
3717
|
+
/** @description Project ref */
|
|
3718
|
+
ref: string;
|
|
3719
|
+
};
|
|
3720
|
+
};
|
|
3721
|
+
requestBody: {
|
|
3722
|
+
content: {
|
|
3723
|
+
"application/json": components["schemas"]["BulkUpdateFunctionBody"];
|
|
3724
|
+
};
|
|
3725
|
+
};
|
|
3726
|
+
responses: {
|
|
3727
|
+
200: {
|
|
3728
|
+
content: {
|
|
3729
|
+
"application/json": components["schemas"]["BulkUpdateFunctionResponse"];
|
|
3730
|
+
};
|
|
3731
|
+
};
|
|
3732
|
+
403: never;
|
|
3733
|
+
/** @description Failed to update functions */
|
|
3734
|
+
500: never;
|
|
3735
|
+
};
|
|
3736
|
+
};
|
|
3737
|
+
/**
|
|
3738
|
+
* Create a function
|
|
3739
|
+
* @deprecated
|
|
3740
|
+
* @description This endpoint is deprecated - use the deploy endpoint. Creates a function and adds it to the specified project.
|
|
3741
|
+
*/
|
|
3742
|
+
"v1-create-a-function": {
|
|
3743
|
+
parameters: {
|
|
3744
|
+
query?: {
|
|
3745
|
+
slug?: string;
|
|
3746
|
+
name?: string;
|
|
3747
|
+
verify_jwt?: string;
|
|
3748
|
+
import_map?: string;
|
|
3749
|
+
entrypoint_path?: string;
|
|
3750
|
+
import_map_path?: string;
|
|
3751
|
+
};
|
|
3752
|
+
path: {
|
|
3753
|
+
/** @description Project ref */
|
|
3754
|
+
ref: string;
|
|
3755
|
+
};
|
|
3756
|
+
};
|
|
3757
|
+
responses: {
|
|
3758
|
+
201: {
|
|
3759
|
+
content: {
|
|
3760
|
+
"application/json": components["schemas"]["FunctionResponse"];
|
|
3761
|
+
};
|
|
3762
|
+
};
|
|
3763
|
+
403: never;
|
|
3764
|
+
/** @description Failed to create project's function */
|
|
3765
|
+
500: never;
|
|
3766
|
+
};
|
|
3767
|
+
};
|
|
3768
|
+
/**
|
|
3769
|
+
* Deploy a function
|
|
3770
|
+
* @description A new endpoint to deploy functions. It will create if function does not exist.
|
|
3771
|
+
*/
|
|
3772
|
+
"v1-deploy-a-function": {
|
|
3773
|
+
parameters: {
|
|
3774
|
+
query?: {
|
|
3775
|
+
slug?: string;
|
|
3776
|
+
bundleOnly?: string;
|
|
3777
|
+
};
|
|
3778
|
+
path: {
|
|
3779
|
+
/** @description Project ref */
|
|
3780
|
+
ref: string;
|
|
3781
|
+
};
|
|
3782
|
+
};
|
|
3783
|
+
responses: {
|
|
3784
|
+
201: {
|
|
3785
|
+
content: {
|
|
3786
|
+
"application/json": components["schemas"]["DeployFunctionResponse"];
|
|
3787
|
+
};
|
|
3788
|
+
};
|
|
3789
|
+
403: never;
|
|
3790
|
+
/** @description Failed to deploy function */
|
|
3791
|
+
500: never;
|
|
3792
|
+
};
|
|
3793
|
+
};
|
|
3794
|
+
/**
|
|
3795
|
+
* Retrieve a function
|
|
3796
|
+
* @description Retrieves a function with the specified slug and project.
|
|
3797
|
+
*/
|
|
3798
|
+
"v1-get-a-function": {
|
|
3799
|
+
parameters: {
|
|
3800
|
+
path: {
|
|
3801
|
+
/** @description Project ref */
|
|
3802
|
+
ref: string;
|
|
3803
|
+
/** @description Function slug */
|
|
3804
|
+
function_slug: string;
|
|
3805
|
+
};
|
|
3806
|
+
};
|
|
3807
|
+
responses: {
|
|
3808
|
+
200: {
|
|
3809
|
+
content: {
|
|
3810
|
+
"application/json": components["schemas"]["FunctionSlugResponse"];
|
|
3811
|
+
};
|
|
3812
|
+
};
|
|
3813
|
+
403: never;
|
|
3814
|
+
/** @description Failed to retrieve function with given slug */
|
|
3815
|
+
500: never;
|
|
3816
|
+
};
|
|
3817
|
+
};
|
|
3818
|
+
/**
|
|
3819
|
+
* Delete a function
|
|
3820
|
+
* @description Deletes a function with the specified slug from the specified project.
|
|
3821
|
+
*/
|
|
3822
|
+
"v1-delete-a-function": {
|
|
3823
|
+
parameters: {
|
|
3824
|
+
path: {
|
|
3825
|
+
/** @description Project ref */
|
|
3826
|
+
ref: string;
|
|
3827
|
+
/** @description Function slug */
|
|
3828
|
+
function_slug: string;
|
|
3829
|
+
};
|
|
3830
|
+
};
|
|
3831
|
+
responses: {
|
|
3832
|
+
200: never;
|
|
3833
|
+
403: never;
|
|
3834
|
+
/** @description Failed to delete function with given slug */
|
|
3835
|
+
500: never;
|
|
3836
|
+
};
|
|
3837
|
+
};
|
|
3838
|
+
/**
|
|
3839
|
+
* Update a function
|
|
3840
|
+
* @description Updates a function with the specified slug and project.
|
|
3841
|
+
*/
|
|
3842
|
+
"v1-update-a-function": {
|
|
3843
|
+
parameters: {
|
|
3844
|
+
query?: {
|
|
3845
|
+
slug?: string;
|
|
3846
|
+
name?: string;
|
|
3847
|
+
verify_jwt?: string;
|
|
3848
|
+
import_map?: string;
|
|
3849
|
+
entrypoint_path?: string;
|
|
3850
|
+
import_map_path?: string;
|
|
3851
|
+
};
|
|
3852
|
+
path: {
|
|
3853
|
+
/** @description Project ref */
|
|
3854
|
+
ref: string;
|
|
3855
|
+
/** @description Function slug */
|
|
3856
|
+
function_slug: string;
|
|
3857
|
+
};
|
|
3858
|
+
};
|
|
3859
|
+
responses: {
|
|
3860
|
+
200: {
|
|
3861
|
+
content: {
|
|
3862
|
+
"application/json": components["schemas"]["FunctionResponse"];
|
|
3863
|
+
};
|
|
3864
|
+
};
|
|
3865
|
+
403: never;
|
|
3866
|
+
/** @description Failed to update function with given slug */
|
|
3867
|
+
500: never;
|
|
3868
|
+
};
|
|
3869
|
+
};
|
|
3870
|
+
/**
|
|
3871
|
+
* Retrieve a function body
|
|
3872
|
+
* @description Retrieves a function body for the specified slug and project.
|
|
3873
|
+
*/
|
|
3874
|
+
"v1-get-a-function-body": {
|
|
3875
|
+
parameters: {
|
|
3876
|
+
path: {
|
|
3877
|
+
/** @description Project ref */
|
|
3878
|
+
ref: string;
|
|
3879
|
+
/** @description Function slug */
|
|
3880
|
+
function_slug: string;
|
|
3881
|
+
};
|
|
3882
|
+
};
|
|
3883
|
+
responses: {
|
|
3884
|
+
200: never;
|
|
3885
|
+
403: never;
|
|
3886
|
+
/** @description Failed to retrieve function body with given slug */
|
|
3887
|
+
500: never;
|
|
3888
|
+
};
|
|
3889
|
+
};
|
|
3890
|
+
/** Lists all buckets */
|
|
3891
|
+
"v1-list-all-buckets": {
|
|
3892
|
+
parameters: {
|
|
3893
|
+
path: {
|
|
3894
|
+
/** @description Project ref */
|
|
3895
|
+
ref: string;
|
|
3896
|
+
};
|
|
3897
|
+
};
|
|
3898
|
+
responses: {
|
|
3899
|
+
200: {
|
|
3900
|
+
content: {
|
|
3901
|
+
"application/json": (components["schemas"]["V1StorageBucketResponse"])[];
|
|
3902
|
+
};
|
|
3903
|
+
};
|
|
3904
|
+
403: never;
|
|
3905
|
+
/** @description Failed to get list of buckets */
|
|
3906
|
+
500: never;
|
|
3907
|
+
};
|
|
3908
|
+
};
|
|
3909
|
+
/** Lists all SSO providers */
|
|
3910
|
+
"v1-list-all-sso-provider": {
|
|
3911
|
+
parameters: {
|
|
3912
|
+
path: {
|
|
3913
|
+
/** @description Project ref */
|
|
3914
|
+
ref: string;
|
|
3915
|
+
};
|
|
3916
|
+
};
|
|
3917
|
+
responses: {
|
|
3918
|
+
200: {
|
|
3919
|
+
content: {
|
|
3920
|
+
"application/json": components["schemas"]["ListProvidersResponse"];
|
|
3921
|
+
};
|
|
3922
|
+
};
|
|
3923
|
+
403: never;
|
|
3924
|
+
/** @description SAML 2.0 support is not enabled for this project */
|
|
3925
|
+
404: never;
|
|
3926
|
+
};
|
|
3927
|
+
};
|
|
3928
|
+
/** Creates a new SSO provider */
|
|
3929
|
+
"v1-create-a-sso-provider": {
|
|
3930
|
+
parameters: {
|
|
3931
|
+
path: {
|
|
3932
|
+
/** @description Project ref */
|
|
3933
|
+
ref: string;
|
|
3934
|
+
};
|
|
3935
|
+
};
|
|
3936
|
+
requestBody: {
|
|
3937
|
+
content: {
|
|
3938
|
+
"application/json": components["schemas"]["CreateProviderBody"];
|
|
3939
|
+
};
|
|
3940
|
+
};
|
|
3941
|
+
responses: {
|
|
3942
|
+
201: {
|
|
3943
|
+
content: {
|
|
3944
|
+
"application/json": components["schemas"]["CreateProviderResponse"];
|
|
3945
|
+
};
|
|
3946
|
+
};
|
|
3947
|
+
403: never;
|
|
3948
|
+
/** @description SAML 2.0 support is not enabled for this project */
|
|
3949
|
+
404: never;
|
|
3950
|
+
};
|
|
3951
|
+
};
|
|
3952
|
+
/** Gets a SSO provider by its UUID */
|
|
3953
|
+
"v1-get-a-sso-provider": {
|
|
3954
|
+
parameters: {
|
|
3955
|
+
path: {
|
|
3956
|
+
/** @description Project ref */
|
|
3957
|
+
ref: string;
|
|
3958
|
+
provider_id: string;
|
|
3959
|
+
};
|
|
3960
|
+
};
|
|
3961
|
+
responses: {
|
|
3962
|
+
200: {
|
|
3963
|
+
content: {
|
|
3964
|
+
"application/json": components["schemas"]["GetProviderResponse"];
|
|
3965
|
+
};
|
|
3966
|
+
};
|
|
3967
|
+
403: never;
|
|
3968
|
+
/** @description Either SAML 2.0 was not enabled for this project, or the provider does not exist */
|
|
3969
|
+
404: never;
|
|
3970
|
+
};
|
|
3971
|
+
};
|
|
3972
|
+
/** Updates a SSO provider by its UUID */
|
|
3973
|
+
"v1-update-a-sso-provider": {
|
|
3974
|
+
parameters: {
|
|
3975
|
+
path: {
|
|
3976
|
+
/** @description Project ref */
|
|
3977
|
+
ref: string;
|
|
3978
|
+
provider_id: string;
|
|
3979
|
+
};
|
|
3980
|
+
};
|
|
3981
|
+
requestBody: {
|
|
3982
|
+
content: {
|
|
3983
|
+
"application/json": components["schemas"]["UpdateProviderBody"];
|
|
3984
|
+
};
|
|
3985
|
+
};
|
|
3986
|
+
responses: {
|
|
3987
|
+
200: {
|
|
3988
|
+
content: {
|
|
3989
|
+
"application/json": components["schemas"]["UpdateProviderResponse"];
|
|
3990
|
+
};
|
|
3991
|
+
};
|
|
3992
|
+
403: never;
|
|
3993
|
+
/** @description Either SAML 2.0 was not enabled for this project, or the provider does not exist */
|
|
3994
|
+
404: never;
|
|
3995
|
+
};
|
|
3996
|
+
};
|
|
3997
|
+
/** Removes a SSO provider by its UUID */
|
|
3998
|
+
"v1-delete-a-sso-provider": {
|
|
3999
|
+
parameters: {
|
|
4000
|
+
path: {
|
|
4001
|
+
/** @description Project ref */
|
|
4002
|
+
ref: string;
|
|
4003
|
+
provider_id: string;
|
|
4004
|
+
};
|
|
4005
|
+
};
|
|
4006
|
+
responses: {
|
|
4007
|
+
200: {
|
|
4008
|
+
content: {
|
|
4009
|
+
"application/json": components["schemas"]["DeleteProviderResponse"];
|
|
4010
|
+
};
|
|
4011
|
+
};
|
|
4012
|
+
403: never;
|
|
4013
|
+
/** @description Either SAML 2.0 was not enabled for this project, or the provider does not exist */
|
|
4014
|
+
404: never;
|
|
4015
|
+
};
|
|
4016
|
+
};
|
|
4017
|
+
/** Lists all backups */
|
|
4018
|
+
"v1-list-all-backups": {
|
|
4019
|
+
parameters: {
|
|
4020
|
+
path: {
|
|
4021
|
+
/** @description Project ref */
|
|
4022
|
+
ref: string;
|
|
4023
|
+
};
|
|
4024
|
+
};
|
|
4025
|
+
responses: {
|
|
4026
|
+
200: {
|
|
4027
|
+
content: {
|
|
4028
|
+
"application/json": components["schemas"]["V1BackupsResponse"];
|
|
4029
|
+
};
|
|
4030
|
+
};
|
|
4031
|
+
403: never;
|
|
4032
|
+
/** @description Failed to get backups */
|
|
4033
|
+
500: never;
|
|
4034
|
+
};
|
|
4035
|
+
};
|
|
4036
|
+
/** Restores a PITR backup for a database */
|
|
4037
|
+
"v1-restore-pitr-backup": {
|
|
4038
|
+
parameters: {
|
|
4039
|
+
path: {
|
|
4040
|
+
/** @description Project ref */
|
|
4041
|
+
ref: string;
|
|
4042
|
+
};
|
|
4043
|
+
};
|
|
4044
|
+
requestBody: {
|
|
4045
|
+
content: {
|
|
4046
|
+
"application/json": components["schemas"]["V1RestorePitrBody"];
|
|
4047
|
+
};
|
|
4048
|
+
};
|
|
4049
|
+
responses: {
|
|
4050
|
+
201: never;
|
|
4051
|
+
403: never;
|
|
4052
|
+
};
|
|
4053
|
+
};
|
|
4054
|
+
/** List members of an organization */
|
|
4055
|
+
"v1-list-organization-members": {
|
|
4056
|
+
parameters: {
|
|
4057
|
+
path: {
|
|
4058
|
+
/** @description Organization slug */
|
|
4059
|
+
slug: string;
|
|
4060
|
+
};
|
|
4061
|
+
};
|
|
4062
|
+
responses: {
|
|
4063
|
+
200: {
|
|
4064
|
+
content: {
|
|
4065
|
+
"application/json": (components["schemas"]["V1OrganizationMemberResponse"])[];
|
|
4066
|
+
};
|
|
4067
|
+
};
|
|
4068
|
+
403: never;
|
|
4069
|
+
};
|
|
4070
|
+
};
|
|
4071
|
+
/** Gets information about the organization */
|
|
4072
|
+
"v1-get-an-organization": {
|
|
4073
|
+
parameters: {
|
|
4074
|
+
path: {
|
|
4075
|
+
/** @description Organization slug */
|
|
4076
|
+
slug: string;
|
|
4077
|
+
};
|
|
4078
|
+
};
|
|
4079
|
+
responses: {
|
|
4080
|
+
200: {
|
|
4081
|
+
content: {
|
|
4082
|
+
"application/json": components["schemas"]["V1OrganizationSlugResponse"];
|
|
4083
|
+
};
|
|
4084
|
+
};
|
|
4085
|
+
403: never;
|
|
4086
|
+
};
|
|
4087
|
+
};
|
|
4088
|
+
}
|
|
4089
|
+
|
|
4090
|
+
type Prettify<T> = {
|
|
4091
|
+
[K in keyof T]: T[K];
|
|
4092
|
+
} & {};
|
|
4093
|
+
type ExtractResponseContent<TOperation, TMethod extends "get" | "post" | "put" | "patch" | "delete", TStatus extends number, TMime extends string = "application/json"> = TOperation extends {
|
|
4094
|
+
[method in TMethod]: {
|
|
4095
|
+
responses: {
|
|
4096
|
+
[status in TStatus]: {
|
|
4097
|
+
content: {
|
|
4098
|
+
[mime in TMime]: infer TData;
|
|
4099
|
+
};
|
|
4100
|
+
};
|
|
4101
|
+
};
|
|
4102
|
+
};
|
|
4103
|
+
} ? Prettify<TData> | undefined : never;
|
|
4104
|
+
type ExtractRequestBody<TOperation, TMethod extends "put" | "post" | "patch" | "delete", TMime extends string = "application/json"> = TOperation extends {
|
|
4105
|
+
[method in TMethod]: {
|
|
4106
|
+
requestBody: {
|
|
4107
|
+
content: {
|
|
4108
|
+
[mime in TMime]: infer TData;
|
|
4109
|
+
};
|
|
4110
|
+
};
|
|
4111
|
+
};
|
|
4112
|
+
} ? Prettify<TData> : never;
|
|
4113
|
+
type ExtractRequestQuery<TOperation, TMethod extends "put" | "post" | "patch" | "delete" | "get"> = TOperation extends {
|
|
4114
|
+
[method in TMethod]: {
|
|
4115
|
+
parameters: {
|
|
4116
|
+
query: infer TQuery;
|
|
4117
|
+
};
|
|
4118
|
+
};
|
|
4119
|
+
} ? Prettify<TQuery> : never;
|
|
4120
|
+
|
|
4121
|
+
type GetOrganizationsResponseData = ExtractResponseContent<paths["/v1/organizations"], "get", 200>;
|
|
4122
|
+
type CreateOrganizationRequestBody = ExtractRequestBody<paths["/v1/organizations"], "post">;
|
|
4123
|
+
type CreateOrganizationResponseData = ExtractResponseContent<paths["/v1/organizations"], "post", 201>;
|
|
4124
|
+
type GetBranchDetailsResponseData = ExtractResponseContent<paths["/v1/branches/{branch_id}"], "get", 200>;
|
|
4125
|
+
type UpdateBranchRequestBody = ExtractRequestBody<paths["/v1/branches/{branch_id}"], "patch">;
|
|
4126
|
+
type UpdateBranchResponseData = ExtractResponseContent<paths["/v1/branches/{branch_id}"], "patch", 200>;
|
|
4127
|
+
type GetProjectsResponseData = ExtractResponseContent<paths["/v1/projects"], "get", 200>;
|
|
4128
|
+
type CreateProjectResponseData = ExtractResponseContent<paths["/v1/projects"], "post", 201>;
|
|
4129
|
+
type CreateProjectRequestBody = ExtractRequestBody<paths["/v1/projects"], "post">;
|
|
4130
|
+
type DeleteProjectResponseBody = ExtractResponseContent<paths["/v1/projects/{ref}"], "delete", 200>;
|
|
4131
|
+
type ListFunctionsResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/functions"], "get", 200>;
|
|
4132
|
+
type DeployFunctionRequestBody = ExtractRequestBody<paths["/v1/projects/{ref}/functions/deploy"], "post">;
|
|
4133
|
+
type DeployFunctionResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/functions/deploy"], "post", 201>;
|
|
4134
|
+
type CreateFunctionRequestBody = ExtractRequestBody<paths["/v1/projects/{ref}/functions"], "post">;
|
|
4135
|
+
type CreateFunctionResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/functions"], "post", 201>;
|
|
4136
|
+
type GetFunctionResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/functions/{function_slug}"], "get", 200>;
|
|
4137
|
+
type UpdateFunctionRequestBody = ExtractRequestBody<paths["/v1/projects/{ref}/functions/{function_slug}"], "patch">;
|
|
4138
|
+
type UpdateFunctionResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/functions/{function_slug}"], "patch", 200>;
|
|
4139
|
+
type GetFunctionBodyResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/functions/{function_slug}/body"], "get", 200>;
|
|
4140
|
+
type GetProjectApiKeysResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/api-keys"], "get", 200>;
|
|
4141
|
+
type GetCustomHostnameResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/custom-hostname"], "get", 200>;
|
|
4142
|
+
type CreateCustomHostnameRequestBody = ExtractRequestBody<paths["/v1/projects/{ref}/custom-hostname/initialize"], "post">;
|
|
4143
|
+
type CreateCustomHostnameResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/custom-hostname/initialize"], "post", 201>;
|
|
4144
|
+
type ReverifyCustomHostnameResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/custom-hostname/reverify"], "post", 201>;
|
|
4145
|
+
type ActivateCustomHostnameResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/custom-hostname/activate"], "post", 201>;
|
|
4146
|
+
type GetNetworkBansResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/network-bans/retrieve"], "post", 201>;
|
|
4147
|
+
type RemoveNetworkBanRequestBody = ExtractRequestBody<paths["/v1/projects/{ref}/network-bans"], "delete">;
|
|
4148
|
+
type GetNetworkRestrictionsResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/network-restrictions"], "get", 200>;
|
|
4149
|
+
type ApplyNetworkRestrictionsRequestBody = ExtractRequestBody<paths["/v1/projects/{ref}/network-restrictions/apply"], "post">;
|
|
4150
|
+
type ApplyNetworkRestrictionsResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/network-restrictions/apply"], "post", 201>;
|
|
4151
|
+
type GetPgsodiumConfigResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/pgsodium"], "get", 200>;
|
|
4152
|
+
type UpdatePgSodiumConfigRequestBody = ExtractRequestBody<paths["/v1/projects/{ref}/pgsodium"], "put">;
|
|
4153
|
+
type UpdatePgSodiumConfigResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/pgsodium"], "put", 200>;
|
|
4154
|
+
type GetPostgRESTConfigResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/postgrest"], "get", 200>;
|
|
4155
|
+
type UpdatePostgRESTConfigRequestBody = ExtractRequestBody<paths["/v1/projects/{ref}/postgrest"], "patch">;
|
|
4156
|
+
type UpdatePostgRESTConfigResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/postgrest"], "patch", 200>;
|
|
4157
|
+
type RunQueryResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/database/query"], "post", 201>;
|
|
4158
|
+
type GetSecretsResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/secrets"], "get", 200>;
|
|
4159
|
+
type CreateSecretsRequestBody = ExtractRequestBody<paths["/v1/projects/{ref}/secrets"], "post">;
|
|
4160
|
+
type DeleteSecretsRequestBody = ExtractRequestBody<paths["/v1/projects/{ref}/secrets"], "delete">;
|
|
4161
|
+
type DeleteSecretsResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/secrets"], "delete", 200>;
|
|
4162
|
+
type GetSSLEnforcementConfigResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/ssl-enforcement"], "get", 200>;
|
|
4163
|
+
type UpdateSSLEnforcementConfigRequestBody = ExtractRequestBody<paths["/v1/projects/{ref}/ssl-enforcement"], "put">;
|
|
4164
|
+
type UpdateSSLEnforcementConfigResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/ssl-enforcement"], "put", 200>;
|
|
4165
|
+
type GetTypescriptTypesResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/types/typescript"], "get", 200>;
|
|
4166
|
+
type GetVanitySubdomainResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/vanity-subdomain"], "get", 200>;
|
|
4167
|
+
type GetUpgradeEligibilityResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/upgrade/eligibility"], "get", 200>;
|
|
4168
|
+
type GetUpgradeStatusResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/upgrade/status"], "get", 200>;
|
|
4169
|
+
type GetReadonlyModeStatusResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/readonly"], "get", 200>;
|
|
4170
|
+
type GetProjectPGConfigResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/config/database/postgres"], "get", 200>;
|
|
4171
|
+
type UpdateProjectPGConfigRequestBody = ExtractRequestBody<paths["/v1/projects/{ref}/config/database/postgres"], "put">;
|
|
4172
|
+
type UpdateProjectPGConfigResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/config/database/postgres"], "put", 200>;
|
|
4173
|
+
type GetProjectPgBouncerConfigResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/config/database/pgbouncer"], "get", 200>;
|
|
4174
|
+
type GetSSOProvidersResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/config/auth/sso/providers"], "get", 200>;
|
|
4175
|
+
type GetProjectAuthConfigResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/config/auth"], "get", 200>;
|
|
4176
|
+
type UpdateProjectAuthConfigRequestBody = ExtractRequestBody<paths["/v1/projects/{ref}/config/auth"], "patch">;
|
|
4177
|
+
type UpdateProjectAuthConfigResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/config/auth"], "patch", 200>;
|
|
4178
|
+
type CreateSSOProviderRequestBody = ExtractRequestBody<paths["/v1/projects/{ref}/config/auth/sso/providers"], "post">;
|
|
4179
|
+
type CreateSSOProviderResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/config/auth/sso/providers"], "post", 201>;
|
|
4180
|
+
type GetSSOProviderResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/config/auth/sso/providers/{provider_id}"], "get", 200>;
|
|
4181
|
+
type UpdateSSOProviderRequestBody = ExtractRequestBody<paths["/v1/projects/{ref}/config/auth/sso/providers/{provider_id}"], "put">;
|
|
4182
|
+
type UpdateSSOProviderResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/config/auth/sso/providers/{provider_id}"], "put", 200>;
|
|
4183
|
+
type ListSnippetsResponseData = ExtractResponseContent<paths["/v1/snippets"], "get", 200>;
|
|
4184
|
+
type GetSnippetResponseData = ExtractResponseContent<paths["/v1/snippets/{id}"], "get", 200>;
|
|
4185
|
+
type CheckServiceQuery = ExtractRequestQuery<paths["/v1/projects/{ref}/health"], "get">;
|
|
4186
|
+
type CheckServiceHealthResponseData = ExtractResponseContent<paths["/v1/projects/{ref}/health"], "get", 200>;
|
|
4187
|
+
|
|
4188
|
+
type SupabaseManagementAPIOptions = {
|
|
4189
|
+
accessToken: string;
|
|
4190
|
+
baseUrl?: string;
|
|
4191
|
+
};
|
|
4192
|
+
declare class SupabaseManagementAPIError extends Error {
|
|
4193
|
+
readonly response: Response;
|
|
4194
|
+
constructor(message: string, response: Response);
|
|
4195
|
+
}
|
|
4196
|
+
declare function isSupabaseError(error: unknown): error is SupabaseManagementAPIError;
|
|
4197
|
+
declare class SupabaseManagementAPI {
|
|
4198
|
+
#private;
|
|
4199
|
+
private readonly options;
|
|
4200
|
+
constructor(options: SupabaseManagementAPIOptions);
|
|
4201
|
+
/**
|
|
4202
|
+
* List all organizations
|
|
4203
|
+
* @description Returns a list of organizations that you currently belong to.
|
|
4204
|
+
*/
|
|
4205
|
+
getOrganizations(): Promise<GetOrganizationsResponseData>;
|
|
4206
|
+
/** Create an organization */
|
|
4207
|
+
createOrganization(body: CreateOrganizationRequestBody): Promise<CreateOrganizationResponseData>;
|
|
4208
|
+
/**
|
|
4209
|
+
* Get database branch config
|
|
4210
|
+
* @description Fetches configurations of the specified database branch
|
|
4211
|
+
*/
|
|
4212
|
+
getBranchDetails(branchId: string): Promise<GetBranchDetailsResponseData>;
|
|
4213
|
+
deleteBranch(branchId: string): Promise<void>;
|
|
4214
|
+
updateBranch(branchId: string, body: UpdateBranchRequestBody): Promise<UpdateBranchResponseData>;
|
|
4215
|
+
/**
|
|
4216
|
+
* List all projects
|
|
4217
|
+
* @description Returns a list of all projects you've previously created.
|
|
4218
|
+
*/
|
|
4219
|
+
getProjects(): Promise<GetProjectsResponseData>;
|
|
4220
|
+
/** Create a project */
|
|
4221
|
+
createProject(body: CreateProjectRequestBody): Promise<CreateProjectResponseData>;
|
|
4222
|
+
/** Delete a project */
|
|
4223
|
+
deleteProject(ref: string): Promise<DeleteProjectResponseBody>;
|
|
4224
|
+
/**
|
|
4225
|
+
* Check service health
|
|
4226
|
+
* @description Checks the health of the specified service.
|
|
4227
|
+
*/
|
|
4228
|
+
checkServiceHealth(ref: string, query: CheckServiceQuery): Promise<CheckServiceHealthResponseData>;
|
|
4229
|
+
/**
|
|
4230
|
+
* List all functions
|
|
4231
|
+
* @description Returns all functions you've previously added to the specified project.
|
|
4232
|
+
*/
|
|
4233
|
+
listFunctions(ref: string): Promise<{
|
|
4234
|
+
id: string;
|
|
4235
|
+
slug: string;
|
|
4236
|
+
name: string;
|
|
4237
|
+
status: "REMOVED" | "ACTIVE" | "THROTTLED";
|
|
4238
|
+
version: number;
|
|
4239
|
+
created_at: number;
|
|
4240
|
+
updated_at: number;
|
|
4241
|
+
verify_jwt?: boolean | undefined;
|
|
4242
|
+
import_map?: boolean | undefined;
|
|
4243
|
+
entrypoint_path?: string | undefined;
|
|
4244
|
+
import_map_path?: string | undefined;
|
|
4245
|
+
}[] | undefined>;
|
|
4246
|
+
/**
|
|
4247
|
+
* Create a function
|
|
4248
|
+
* @description Creates a function and adds it to the specified project.
|
|
4249
|
+
*/
|
|
4250
|
+
createFunction(ref: string, body: CreateFunctionRequestBody): Promise<CreateFunctionResponseData>;
|
|
4251
|
+
/**
|
|
4252
|
+
* Deploy function
|
|
4253
|
+
* @description Deploys a function and adds it to the specified project.
|
|
4254
|
+
*/
|
|
4255
|
+
deployFunction(ref: string, body: DeployFunctionRequestBody): Promise<DeployFunctionResponseData>;
|
|
4256
|
+
/**
|
|
4257
|
+
* Retrieve a function
|
|
4258
|
+
* @description Retrieves a function with the specified slug and project.
|
|
4259
|
+
*/
|
|
4260
|
+
getFunction(ref: string, slug: string): Promise<GetFunctionResponseData>;
|
|
4261
|
+
/**
|
|
4262
|
+
* Update a function
|
|
4263
|
+
* @description Updates a function with the specified slug and project.
|
|
4264
|
+
*/
|
|
4265
|
+
updateFunction(ref: string, slug: string, body: UpdateFunctionRequestBody): Promise<UpdateFunctionResponseData>;
|
|
4266
|
+
/**
|
|
4267
|
+
* Delete a function
|
|
4268
|
+
* @description Deletes a function with the specified slug from the specified project.
|
|
4269
|
+
*/
|
|
4270
|
+
deleteFunction(ref: string, slug: string): Promise<void>;
|
|
4271
|
+
/**
|
|
4272
|
+
* Retrieve a function body
|
|
4273
|
+
* @description Retrieves a function body for the specified slug and project.
|
|
4274
|
+
*/
|
|
4275
|
+
getFunctionBody(ref: string, slug: string): Promise<GetFunctionBodyResponseData>;
|
|
4276
|
+
getProjectApiKeys(ref: string): Promise<GetProjectApiKeysResponseData>;
|
|
4277
|
+
/** Gets project's custom hostname config */
|
|
4278
|
+
getCustomHostnameConfig(ref: string): Promise<GetCustomHostnameResponseData>;
|
|
4279
|
+
/** Deletes a project's custom hostname configuration */
|
|
4280
|
+
removeCustomHostnameConfig(ref: string): Promise<void>;
|
|
4281
|
+
/** Updates project's custom hostname configuration */
|
|
4282
|
+
createCustomHostnameConfig(ref: string, body: CreateCustomHostnameRequestBody): Promise<CreateCustomHostnameResponseData>;
|
|
4283
|
+
/** Attempts to verify the DNS configuration for project's custom hostname configuration */
|
|
4284
|
+
reverifyCustomHostnameConfig(ref: string): Promise<ReverifyCustomHostnameResponseData>;
|
|
4285
|
+
/** Activates a custom hostname for a project. */
|
|
4286
|
+
activateCustomHostnameConfig(ref: string): Promise<ActivateCustomHostnameResponseData>;
|
|
4287
|
+
/** Gets project's network bans */
|
|
4288
|
+
getNetworkBans(ref: string): Promise<GetNetworkBansResponseData>;
|
|
4289
|
+
/** Remove network bans. */
|
|
4290
|
+
removeNetworkBan(ref: string, body: RemoveNetworkBanRequestBody): Promise<void>;
|
|
4291
|
+
/** Gets project's network restrictions */
|
|
4292
|
+
getNetworkRestrictions(ref: string): Promise<GetNetworkRestrictionsResponseData>;
|
|
4293
|
+
/** Updates project's network restrictions */
|
|
4294
|
+
applyNetworkRestrictions(ref: string, body: ApplyNetworkRestrictionsRequestBody): Promise<ApplyNetworkRestrictionsResponseData>;
|
|
4295
|
+
/** Gets project's pgsodium config */
|
|
4296
|
+
getPgsodiumConfig(ref: string): Promise<GetPgsodiumConfigResponseData>;
|
|
4297
|
+
/** Updates project's pgsodium config. Updating the root_key can cause all data encrypted with the older key to become inaccessible. */
|
|
4298
|
+
updatePgSodiumConfig(ref: string, body: UpdatePgSodiumConfigRequestBody): Promise<UpdatePgSodiumConfigResponseData>;
|
|
4299
|
+
/** Gets project's postgrest config */
|
|
4300
|
+
getPostgRESTConfig(ref: string): Promise<GetPostgRESTConfigResponseData>;
|
|
4301
|
+
/** Updates project's postgrest config */
|
|
4302
|
+
updatePostgRESTConfig(ref: string, body: UpdatePostgRESTConfigRequestBody): Promise<UpdatePostgRESTConfigResponseData>;
|
|
4303
|
+
/** Run sql query */
|
|
4304
|
+
runQuery(ref: string, query: string): Promise<RunQueryResponseData>;
|
|
4305
|
+
enableWebhooks(ref: string): Promise<void>;
|
|
4306
|
+
/**
|
|
4307
|
+
* List all secrets
|
|
4308
|
+
* @description Returns all secrets you've previously added to the specified project.
|
|
4309
|
+
*/
|
|
4310
|
+
getSecrets(ref: string): Promise<GetSecretsResponseData>;
|
|
4311
|
+
/**
|
|
4312
|
+
* Bulk create secrets
|
|
4313
|
+
* @description Creates multiple secrets and adds them to the specified project.
|
|
4314
|
+
*/
|
|
4315
|
+
createSecrets(ref: string, body: CreateSecretsRequestBody): Promise<void>;
|
|
4316
|
+
/**
|
|
4317
|
+
* Bulk delete secrets
|
|
4318
|
+
* @description Deletes all secrets with the given names from the specified project
|
|
4319
|
+
*/
|
|
4320
|
+
deleteSecrets(ref: string, body: DeleteSecretsRequestBody): Promise<DeleteSecretsResponseData>;
|
|
4321
|
+
/** Get project's SSL enforcement configuration. */
|
|
4322
|
+
getSSLEnforcementConfig(ref: string): Promise<GetSSLEnforcementConfigResponseData>;
|
|
4323
|
+
/** Update project's SSL enforcement configuration. */
|
|
4324
|
+
updateSSLEnforcementConfig(ref: string, body: UpdateSSLEnforcementConfigRequestBody): Promise<UpdateSSLEnforcementConfigResponseData>;
|
|
4325
|
+
/**
|
|
4326
|
+
* Generate TypeScript types
|
|
4327
|
+
* @description Returns the TypeScript types of your schema for use with supabase-js.
|
|
4328
|
+
*/
|
|
4329
|
+
getTypescriptTypes(ref: string): Promise<GetTypescriptTypesResponseData>;
|
|
4330
|
+
/** Gets current vanity subdomain config */
|
|
4331
|
+
getVanitySubdomainConfig(ref: string): Promise<GetVanitySubdomainResponseData>;
|
|
4332
|
+
/** Deletes a project's vanity subdomain configuration */
|
|
4333
|
+
removeVanitySubdomainConfig(ref: string): Promise<void>;
|
|
4334
|
+
/** Checks vanity subdomain availability */
|
|
4335
|
+
checkVanitySubdomainAvailability(ref: string, subdomain: string): Promise<boolean>;
|
|
4336
|
+
/** Activates a vanity subdomain for a project. */
|
|
4337
|
+
activateVanitySubdomainPlease(ref: string, subdomain: string): Promise<string | undefined>;
|
|
4338
|
+
/** Upgrades the project's Postgres version */
|
|
4339
|
+
upgradeProject(ref: string, targetVersion: string): Promise<void>;
|
|
4340
|
+
/** Returns the project's eligibility for upgrades */
|
|
4341
|
+
getUpgradeEligibility(ref: string): Promise<GetUpgradeEligibilityResponseData>;
|
|
4342
|
+
/** Gets the latest status of the project's upgrade */
|
|
4343
|
+
getUpgradeStatus(ref: string): Promise<GetUpgradeStatusResponseData>;
|
|
4344
|
+
/** Returns project's readonly mode status */
|
|
4345
|
+
getReadOnlyModeStatus(ref: string): Promise<GetReadonlyModeStatusResponseData>;
|
|
4346
|
+
/** Disables project's readonly mode for the next 15 minutes */
|
|
4347
|
+
temporarilyDisableReadonlyMode(ref: string): Promise<void>;
|
|
4348
|
+
/** Gets project's Postgres config */
|
|
4349
|
+
getPGConfig(ref: string): Promise<GetProjectPGConfigResponseData>;
|
|
4350
|
+
/** Updates project's Postgres config */
|
|
4351
|
+
updatePGConfig(ref: string, body: UpdateProjectPGConfigRequestBody): Promise<UpdateProjectPGConfigResponseData>;
|
|
4352
|
+
/** Gets project's pgbouncer config */
|
|
4353
|
+
getPgBouncerConfig(ref: string): Promise<GetProjectPgBouncerConfigResponseData>;
|
|
4354
|
+
/** Gets project's auth config */
|
|
4355
|
+
getProjectAuthConfig(ref: string): Promise<GetProjectAuthConfigResponseData>;
|
|
4356
|
+
/** Updates a project's auth config */
|
|
4357
|
+
updateProjectAuthConfig(ref: string, body: UpdateProjectAuthConfigRequestBody): Promise<UpdateProjectAuthConfigResponseData>;
|
|
4358
|
+
/** Lists all SSO providers */
|
|
4359
|
+
getSSOProviders(ref: string): Promise<GetSSOProvidersResponseData>;
|
|
4360
|
+
/** Creates a new SSO provider */
|
|
4361
|
+
createSSOProvider(ref: string, body: CreateSSOProviderRequestBody): Promise<CreateSSOProviderResponseData>;
|
|
4362
|
+
/** Gets a SSO provider by its UUID */
|
|
4363
|
+
getSSOProvider(ref: string, uuid: string): Promise<GetSSOProviderResponseData>;
|
|
4364
|
+
/** Updates a SSO provider by its UUID */
|
|
4365
|
+
updateSSOProvider(ref: string, uuid: string, body: UpdateSSOProviderRequestBody): Promise<UpdateSSOProviderResponseData>;
|
|
4366
|
+
/** Removes a SSO provider by its UUID */
|
|
4367
|
+
deleteSSOProvider(ref: string, uuid: string): Promise<void>;
|
|
4368
|
+
/** List snippets */
|
|
4369
|
+
listSnippets(projectRef?: string): Promise<{
|
|
4370
|
+
data: {
|
|
4371
|
+
id: string;
|
|
4372
|
+
inserted_at: string; /** Activates a vanity subdomain for a project. */
|
|
4373
|
+
updated_at: string;
|
|
4374
|
+
type: "sql";
|
|
4375
|
+
visibility: "user" | "project" | "org" | "public";
|
|
4376
|
+
name: string;
|
|
4377
|
+
description: string | null;
|
|
4378
|
+
project: {
|
|
4379
|
+
id: number;
|
|
4380
|
+
name: string;
|
|
4381
|
+
};
|
|
4382
|
+
owner: {
|
|
4383
|
+
id: number;
|
|
4384
|
+
username: string;
|
|
4385
|
+
};
|
|
4386
|
+
updated_by: {
|
|
4387
|
+
id: number;
|
|
4388
|
+
username: string;
|
|
4389
|
+
};
|
|
4390
|
+
}[];
|
|
4391
|
+
cursor?: string | undefined;
|
|
4392
|
+
} | undefined>;
|
|
4393
|
+
getSnippet(id: string): Promise<{
|
|
4394
|
+
id: string; /** Upgrades the project's Postgres version */
|
|
4395
|
+
inserted_at: string;
|
|
4396
|
+
updated_at: string;
|
|
4397
|
+
type: "sql";
|
|
4398
|
+
visibility: "user" | "project" | "org" | "public";
|
|
4399
|
+
name: string;
|
|
4400
|
+
description: string | null;
|
|
4401
|
+
project: {
|
|
4402
|
+
id: number;
|
|
4403
|
+
name: string;
|
|
4404
|
+
};
|
|
4405
|
+
owner: {
|
|
4406
|
+
id: number;
|
|
4407
|
+
username: string;
|
|
4408
|
+
};
|
|
4409
|
+
updated_by: {
|
|
4410
|
+
id: number;
|
|
4411
|
+
username: string;
|
|
4412
|
+
};
|
|
4413
|
+
content: {
|
|
4414
|
+
favorite: boolean;
|
|
4415
|
+
schema_version: string;
|
|
4416
|
+
sql: string;
|
|
4417
|
+
};
|
|
4418
|
+
} | undefined>;
|
|
4419
|
+
get client(): {
|
|
4420
|
+
get<P extends openapi_fetch.PathsWith<paths, "get">>(url: P, init: openapi_fetch.FetchOptions<openapi_fetch.FilterKeys<paths[P], "get">>): Promise<openapi_fetch.FetchResponse<"get" extends keyof paths[P] ? paths[P][keyof paths[P] & "get"] : unknown>>;
|
|
4421
|
+
put<P_1 extends openapi_fetch.PathsWith<paths, "put">>(url: P_1, init: openapi_fetch.FetchOptions<openapi_fetch.FilterKeys<paths[P_1], "put">>): Promise<openapi_fetch.FetchResponse<"put" extends keyof paths[P_1] ? paths[P_1][keyof paths[P_1] & "put"] : unknown>>;
|
|
4422
|
+
post<P_2 extends openapi_fetch.PathsWith<paths, "post">>(url: P_2, init: openapi_fetch.FetchOptions<openapi_fetch.FilterKeys<paths[P_2], "post">>): Promise<openapi_fetch.FetchResponse<"post" extends keyof paths[P_2] ? paths[P_2][keyof paths[P_2] & "post"] : unknown>>;
|
|
4423
|
+
del<P_3 extends openapi_fetch.PathsWith<paths, "delete">>(url: P_3, init: openapi_fetch.FetchOptions<openapi_fetch.FilterKeys<paths[P_3], "delete">>): Promise<openapi_fetch.FetchResponse<"delete" extends keyof paths[P_3] ? paths[P_3][keyof paths[P_3] & "delete"] : unknown>>;
|
|
4424
|
+
options<P_4 extends never>(url: P_4, init: openapi_fetch.FetchOptions<openapi_fetch.FilterKeys<paths[P_4], "options">>): Promise<openapi_fetch.FetchResponse<"options" extends keyof paths[P_4] ? paths[P_4][keyof paths[P_4] & "options"] : unknown>>;
|
|
4425
|
+
head<P_5 extends never>(url: P_5, init: openapi_fetch.FetchOptions<openapi_fetch.FilterKeys<paths[P_5], "head">>): Promise<openapi_fetch.FetchResponse<"head" extends keyof paths[P_5] ? paths[P_5][keyof paths[P_5] & "head"] : unknown>>;
|
|
4426
|
+
patch<P_6 extends openapi_fetch.PathsWith<paths, "patch">>(url: P_6, init: openapi_fetch.FetchOptions<openapi_fetch.FilterKeys<paths[P_6], "patch">>): Promise<openapi_fetch.FetchResponse<"patch" extends keyof paths[P_6] ? paths[P_6][keyof paths[P_6] & "patch"] : unknown>>;
|
|
4427
|
+
trace<P_7 extends never>(url: P_7, init: openapi_fetch.FetchOptions<openapi_fetch.FilterKeys<paths[P_7], "trace">>): Promise<openapi_fetch.FetchResponse<"trace" extends keyof paths[P_7] ? paths[P_7][keyof paths[P_7] & "trace"] : unknown>>;
|
|
4428
|
+
};
|
|
4429
|
+
}
|
|
4430
|
+
|
|
4431
|
+
export { type ActivateCustomHostnameResponseData, type ApplyNetworkRestrictionsRequestBody, type ApplyNetworkRestrictionsResponseData, type CheckServiceHealthResponseData, type CheckServiceQuery, type CreateCustomHostnameRequestBody, type CreateCustomHostnameResponseData, type CreateFunctionRequestBody, type CreateFunctionResponseData, type CreateOrganizationRequestBody, type CreateOrganizationResponseData, type CreateProjectRequestBody, type CreateProjectResponseData, type CreateSSOProviderRequestBody, type CreateSSOProviderResponseData, type CreateSecretsRequestBody, type DeleteProjectResponseBody, type DeleteSecretsRequestBody, type DeleteSecretsResponseData, type DeployFunctionRequestBody, type DeployFunctionResponseData, type GetBranchDetailsResponseData, type GetCustomHostnameResponseData, type GetFunctionBodyResponseData, type GetFunctionResponseData, type GetNetworkBansResponseData, type GetNetworkRestrictionsResponseData, type GetOrganizationsResponseData, type GetPgsodiumConfigResponseData, type GetPostgRESTConfigResponseData, type GetProjectApiKeysResponseData, type GetProjectAuthConfigResponseData, type GetProjectPGConfigResponseData, type GetProjectPgBouncerConfigResponseData, type GetProjectsResponseData, type GetReadonlyModeStatusResponseData, type GetSSLEnforcementConfigResponseData, type GetSSOProviderResponseData, type GetSSOProvidersResponseData, type GetSecretsResponseData, type GetSnippetResponseData, type GetTypescriptTypesResponseData, type GetUpgradeEligibilityResponseData, type GetUpgradeStatusResponseData, type GetVanitySubdomainResponseData, type ListFunctionsResponseData, type ListSnippetsResponseData, type RemoveNetworkBanRequestBody, type ReverifyCustomHostnameResponseData, type RunQueryResponseData, SupabaseManagementAPI, SupabaseManagementAPIError, type SupabaseManagementAPIOptions, type UpdateBranchRequestBody, type UpdateBranchResponseData, type UpdateFunctionRequestBody, type UpdateFunctionResponseData, type UpdatePgSodiumConfigRequestBody, type UpdatePgSodiumConfigResponseData, type UpdatePostgRESTConfigRequestBody, type UpdatePostgRESTConfigResponseData, type UpdateProjectAuthConfigRequestBody, type UpdateProjectAuthConfigResponseData, type UpdateProjectPGConfigRequestBody, type UpdateProjectPGConfigResponseData, type UpdateSSLEnforcementConfigRequestBody, type UpdateSSLEnforcementConfigResponseData, type UpdateSSOProviderRequestBody, type UpdateSSOProviderResponseData, isSupabaseError };
|