diff --git a/apps/reference/_api/intro.md b/apps/reference/_api/intro.md
index 3727f570a6a..8f8abc600ab 100644
--- a/apps/reference/_api/intro.md
+++ b/apps/reference/_api/intro.md
@@ -29,3 +29,8 @@ All API requests must be authenticated and made over HTTPS.
The API is currently subject to our fair-use policy. In the future, are likely to introduce rate limits.
All resources created via the API are subject to the pricing detailed on our [Pricing](https://supabase.com/pricing) pages.
+
+## Additional links
+
+- [OpenAPI Docs](https://api.supabase.com/api/v1)
+- Reporting bugs and issues: [github.com/supabase/supabase](https://github.com/supabase/supabase)
\ No newline at end of file
diff --git a/apps/reference/_api/usage.mdx b/apps/reference/_api/usage.mdx
index 1c58e089b00..eb8f3e58b09 100644
--- a/apps/reference/_api/usage.mdx
+++ b/apps/reference/_api/usage.mdx
@@ -5,166 +5,24 @@ title: Usage
toc_max_heading_level: 3
---
-import Tabs from '@theme/Tabs'
-import TabItem from '@theme/TabItem'
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
-
+
+
-## Lists all organizations {#lists-all-organizations}
-```
-GET https://api.supabase.com/v1/organizations
-```
+
+
-### Parameters
-
-
-
-
-
-
-
-### Responses
-
-
-
-
-
-
-
-```json
-{
- "schema": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- }
- },
- "required": ["id", "name"]
- }
- }
-}
-```
-
-
-
-
-
-
-
-Unexpected error listing organizations
-
-
-
-
-
-
-
-
-
-
-
-
-
-## Creates an organization {#creates-an-organization}
-
-```
-POST https://api.supabase.com/v1/organizations
-```
-
-
-
-
-
-### Body
-
-```json
-{
- "schema": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- }
- },
- "required": ["name"]
- }
-}
-```
-
-
-
-### Responses
-
-
-
-
-
-
-
-```json
-{
- "schema": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- }
- },
- "required": ["id", "name"]
- }
-}
-```
-
-
-
-
-
-
-
-Unexpected error creating an organization
-
-
-
-
-
-
-
-
-
-
-
-
-
-## Gets all projects that belong to the authenticated user {#gets-all-projects-that-belong-to-the-authenticated-user}
+## List all projects {#list-all-projects}
```
GET https://api.supabase.com/v1/projects
@@ -172,8 +30,12 @@ GET https://api.supabase.com/v1/projects
+
+
+
+
### Responses
@@ -182,8 +44,11 @@ GET https://api.supabase.com/v1/projects
+
+
+
```json
{
"schema": {
@@ -207,12 +72,19 @@ GET https://api.supabase.com/v1/projects
"type": "string"
}
},
- "required": ["id", "organization_id", "name", "region", "created_at"]
+ "required": [
+ "id",
+ "organization_id",
+ "name",
+ "region",
+ "created_at"
+ ]
}
}
}
```
+
@@ -221,9 +93,10 @@ GET https://api.supabase.com/v1/projects
+
-## Creates a project {#creates-a-project}
+## Create a project {#create-a-project}
```
POST https://api.supabase.com/v1/projects
@@ -231,8 +104,11 @@ POST https://api.supabase.com/v1/projects
+
+
+
### Body
```json
@@ -251,7 +127,10 @@ POST https://api.supabase.com/v1/projects
},
"plan": {
"type": "string",
- "enum": ["free", "pro"]
+ "enum": [
+ "free",
+ "pro"
+ ]
},
"region": {
"type": "string",
@@ -271,21 +150,31 @@ POST https://api.supabase.com/v1/projects
]
}
},
- "required": ["db_pass", "name", "organization_id", "plan", "region"]
+ "required": [
+ "db_pass",
+ "name",
+ "organization_id",
+ "plan",
+ "region"
+ ]
}
}
```
+
### Responses
-
+
+
+
+
```json
{
"schema": {
@@ -307,11 +196,18 @@ POST https://api.supabase.com/v1/projects
"type": "string"
}
},
- "required": ["id", "organization_id", "name", "region", "created_at"]
+ "required": [
+ "id",
+ "organization_id",
+ "name",
+ "region",
+ "created_at"
+ ]
}
}
```
+
@@ -319,3 +215,1154 @@ POST https://api.supabase.com/v1/projects
+
+
+
+
+
+
+## List all organizations {#list-all-organizations}
+
+```
+GET https://api.supabase.com/v1/organizations
+```
+
+
+
+
+
+
+
+
+
+
+
+### Responses
+
+
+
+
+
+
+
+
+
+
+```json
+{
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ]
+ }
+ }
+}
+```
+
+
+
+
+
+
+
+
+Unexpected error listing organizations
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Create an organization {#create-an-organization}
+
+```
+POST https://api.supabase.com/v1/organizations
+```
+
+
+
+
+
+
+
+
+### Body
+
+```json
+{
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ]
+ }
+}
+```
+
+
+
+
+### Responses
+
+
+
+
+
+
+
+
+
+
+```json
+{
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ]
+ }
+}
+```
+
+
+
+
+
+
+
+
+Unexpected error creating an organization
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## List all functions {#list-all-functions}
+
+```
+GET https://api.supabase.com/v1/projects/{ref}/functions
+```
+
+
+
+
+### Parameters
+
+
+
+-
+
+
+ ref
+
+
+ required
+
+
+
+
+
+
+ Project ref
+
+
+
+
+
+
+
+
+
+
+
+
+### Responses
+
+
+
+
+
+
+
+
+
+
+```json
+{
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "ACTIVE",
+ "REMOVED",
+ "THROTTLED"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "type": "number"
+ },
+ "created_at": {
+ "type": "number"
+ },
+ "updated_at": {
+ "type": "number"
+ },
+ "verify_jwt": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "slug",
+ "name",
+ "status",
+ "version",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ }
+}
+```
+
+
+
+
+
+
+
+
+Failed to retrieve project's functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Create a function {#create-a-function}
+
+```
+POST https://api.supabase.com/v1/projects/{ref}/functions
+```
+
+
+
+
+### Parameters
+
+
+
+-
+
+
+ ref
+
+
+ required
+
+
+
+
+
+
+ Project ref
+
+
+
+
+
+
+
+
+
+### Body
+
+```json
+{
+ "schema": {
+ "type": "object",
+ "properties": {
+ "slug": {
+ "type": "string",
+ "pattern": {}
+ },
+ "name": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string"
+ },
+ "verify_jwt": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "slug",
+ "name",
+ "body"
+ ]
+ }
+}
+```
+
+
+
+
+### Responses
+
+
+
+
+
+
+
+
+
+
+```json
+{
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "ACTIVE",
+ "REMOVED",
+ "THROTTLED"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "type": "number"
+ },
+ "created_at": {
+ "type": "number"
+ },
+ "updated_at": {
+ "type": "number"
+ },
+ "verify_jwt": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "slug",
+ "name",
+ "status",
+ "version",
+ "created_at",
+ "updated_at"
+ ]
+ }
+}
+```
+
+
+
+
+
+
+
+
+Failed to create project's function
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Retrieve a function {#retrieve-a-function}
+
+```
+GET https://api.supabase.com/v1/projects/{ref}/functions/{function_slug}
+```
+
+
+
+
+### Parameters
+
+
+
+-
+
+
+ include_body
+
+
+ optional
+
+
+
+
+
+
+
+
+
+
+-
+
+
+ ref
+
+
+ required
+
+
+
+
+
+
+ Project ref
+
+
+
+-
+
+
+ function_slug
+
+
+ required
+
+
+
+
+
+
+ Function slug
+
+
+
+
+
+
+
+
+
+
+
+
+### Responses
+
+
+
+
+
+
+
+
+
+
+```json
+{
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "ACTIVE",
+ "REMOVED",
+ "THROTTLED"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "type": "number"
+ },
+ "created_at": {
+ "type": "number"
+ },
+ "updated_at": {
+ "type": "number"
+ },
+ "verify_jwt": {
+ "type": "boolean"
+ },
+ "body": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "slug",
+ "name",
+ "status",
+ "version",
+ "created_at",
+ "updated_at"
+ ]
+ }
+}
+```
+
+
+
+
+
+
+
+
+Failed to retrieve function with given slug
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Update a function {#update-a-function}
+
+```
+PATCH https://api.supabase.com/v1/projects/{ref}/functions/{function_slug}
+```
+
+
+
+
+### Parameters
+
+
+
+-
+
+
+ ref
+
+
+ required
+
+
+
+
+
+
+ Project ref
+
+
+
+-
+
+
+ function_slug
+
+
+ required
+
+
+
+
+
+
+ Function slug
+
+
+
+
+
+
+
+
+
+### Body
+
+```json
+{
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string"
+ },
+ "verify_jwt": {
+ "type": "boolean"
+ }
+ }
+ }
+}
+```
+
+
+
+
+### Responses
+
+
+
+
+
+
+
+
+
+
+```json
+{
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "ACTIVE",
+ "REMOVED",
+ "THROTTLED"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "type": "number"
+ },
+ "created_at": {
+ "type": "number"
+ },
+ "updated_at": {
+ "type": "number"
+ },
+ "verify_jwt": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "slug",
+ "name",
+ "status",
+ "version",
+ "created_at",
+ "updated_at"
+ ]
+ }
+}
+```
+
+
+
+
+
+
+
+
+Failed to update function with given slug
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Delete a function {#delete-a-function}
+
+```
+DELETE https://api.supabase.com/v1/projects/{ref}/functions/{function_slug}
+```
+
+
+
+
+### Parameters
+
+
+
+-
+
+
+ ref
+
+
+ required
+
+
+
+
+
+
+ Project ref
+
+
+
+-
+
+
+ function_slug
+
+
+ required
+
+
+
+
+
+
+ Function slug
+
+
+
+
+
+
+
+
+
+
+
+
+### Responses
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Failed to delete function with given slug
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## List all secrets {#list-all-secrets}
+
+```
+GET https://api.supabase.com/v1/projects/{ref}/secrets
+```
+
+
+
+
+### Parameters
+
+
+
+-
+
+
+ ref
+
+
+ required
+
+
+
+
+
+
+ Project ref
+
+
+
+
+
+
+
+
+
+
+
+
+### Responses
+
+
+
+
+
+
+
+
+
+
+```json
+{
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "value"
+ ]
+ }
+ }
+}
+```
+
+
+
+
+
+
+
+
+Failed to retrieve project's secrets
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Bulk create secrets {#bulk-create-secrets}
+
+```
+POST https://api.supabase.com/v1/projects/{ref}/secrets
+```
+
+
+
+
+### Parameters
+
+
+
+-
+
+
+ ref
+
+
+ required
+
+
+
+
+
+
+ Project ref
+
+
+
+
+
+
+
+
+
+### Body
+
+```json
+{
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "pattern": {}
+ }
+ },
+ "required": [
+ "name",
+ "value"
+ ]
+ }
+ }
+}
+```
+
+
+
+
+### Responses
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Failed to create project's secrets
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Bulk delete secrets {#bulk-delete-secrets}
+
+```
+DELETE https://api.supabase.com/v1/projects/{ref}/secrets
+```
+
+
+
+
+### Parameters
+
+
+
+-
+
+
+ ref
+
+
+ required
+
+
+
+
+
+
+ Project ref
+
+
+
+
+
+
+
+
+
+### Body
+
+```json
+{
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+}
+```
+
+
+
+
+### Responses
+
+
+
+
+
+
+
+
+
+
+```json
+{
+ "schema": {
+ "type": "object"
+ }
+}
+```
+
+
+
+
+
+
+
+
+Failed to delete secrets with given names
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/spec/api_v0_openapi.json b/spec/api_v0_openapi.json
index d6b8acea48a..62d7518cfb5 100644
--- a/spec/api_v0_openapi.json
+++ b/spec/api_v0_openapi.json
@@ -1,72 +1,11 @@
{
"openapi": "3.0.0",
"paths": {
- "/v1/organizations": {
- "get": {
- "operationId": "OrganizationsController_getOrganizations",
- "summary": "Lists all organizations",
- "parameters": [
- {
- "name": "owned_only",
- "required": true,
- "in": "query",
- "description": "Only list organizations you own",
- "schema": {}
- }
- ],
- "responses": {
- "200": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/OrganizationResponse"
- }
- }
- }
- }
- },
- "500": { "description": "Unexpected error listing organizations" }
- },
- "security": [{ "bearer": [] }]
- },
- "post": {
- "operationId": "OrganizationsController_createOrganization_",
- "summary": "Creates an organization",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CreateOrganizationBody"
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/OrganizationResponse"
- }
- }
- }
- },
- "500": { "description": "Unexpected error creating an organization" }
- },
- "security": [{ "bearer": [] }]
- }
- },
"/v1/projects": {
"get": {
- "operationId": "ProjectsController_getProjects",
- "summary": "Gets all projects that belong to the authenticated user",
- "description": "Only returns the minimal project info",
+ "operationId": "getProjects",
+ "summary": "List all projects",
+ "description": "Returns a list of all projects you've previously created.",
"parameters": [],
"responses": {
"200": {
@@ -84,1573 +23,345 @@
"security": [{ "bearer": [] }]
},
"post": {
- "operationId": "ProjectsController_createProject",
- "summary": "Creates a project",
+ "operationId": "createProject",
+ "summary": "Create a project",
+ "parameters": [],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectBody" } }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "",
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ProjectResponse" } }
+ }
+ }
+ },
+ "security": [{ "bearer": [] }]
+ }
+ },
+ "/v1/organizations": {
+ "get": {
+ "operationId": "getOrganizations",
+ "summary": "List all organizations",
+ "description": "Returns a list of organizations that you currently belong to.",
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/OrganizationResponse" }
+ }
+ }
+ }
+ },
+ "500": { "description": "Unexpected error listing organizations" }
+ },
+ "security": [{ "bearer": [] }]
+ },
+ "post": {
+ "operationId": "createOrganization_",
+ "summary": "Create an organization",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/CreateProjectBody" }
+ "schema": { "$ref": "#/components/schemas/CreateOrganizationBody" }
}
}
},
+ "responses": {
+ "201": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/OrganizationResponse" }
+ }
+ }
+ },
+ "500": { "description": "Unexpected error creating an organization" }
+ },
+ "security": [{ "bearer": [] }]
+ }
+ },
+ "/v1/projects/{ref}/functions": {
+ "get": {
+ "operationId": "getFunctions",
+ "summary": "List all functions",
+ "description": "Returns all functions you've previously added to the specified project.",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": { "minLength": 20, "maxLength": 20, "type": "string" }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/FunctionResponse" }
+ }
+ }
+ }
+ },
+ "500": { "description": "Failed to retrieve project's functions" }
+ },
+ "security": [{ "bearer": [] }]
+ },
+ "post": {
+ "operationId": "createFunction",
+ "summary": "Create a function",
+ "description": "Creates a function and adds it to the specified project.",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": { "minLength": 20, "maxLength": 20, "type": "string" }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/CreateFunctionBody" } }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "",
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/FunctionResponse" } }
+ }
+ },
+ "500": { "description": "Failed to create project's function" }
+ },
+ "security": [{ "bearer": [] }]
+ }
+ },
+ "/v1/projects/{ref}/functions/{function_slug}": {
+ "get": {
+ "operationId": "getFunction",
+ "summary": "Retrieve a function",
+ "description": "Retrieves a function with the specified slug and project.",
+ "parameters": [
+ {
+ "name": "include_body",
+ "required": false,
+ "in": "query",
+ "schema": { "type": "boolean" }
+ },
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": { "minLength": 20, "maxLength": 20, "type": "string" }
+ },
+ {
+ "name": "function_slug",
+ "required": true,
+ "in": "path",
+ "description": "Function slug",
+ "schema": { "pattern": {}, "type": "string" }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/FunctionSlugResponse" }
+ }
+ }
+ },
+ "500": { "description": "Failed to retrieve function with given slug" }
+ },
+ "security": [{ "bearer": [] }]
+ },
+ "patch": {
+ "operationId": "UpdateFunction",
+ "summary": "Update a function",
+ "description": "Updates a function with the specified slug and project.",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": { "minLength": 20, "maxLength": 20, "type": "string" }
+ },
+ {
+ "name": "function_slug",
+ "required": true,
+ "in": "path",
+ "description": "Function slug",
+ "schema": { "pattern": {}, "type": "string" }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFunctionBody" } }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/FunctionResponse" } }
+ }
+ },
+ "500": { "description": "Failed to update function with given slug" }
+ },
+ "security": [{ "bearer": [] }]
+ },
+ "delete": {
+ "operationId": "deleteFunction",
+ "summary": "Delete a function",
+ "description": "Deletes a function with the specified slug from the specified project.",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": { "minLength": 20, "maxLength": 20, "type": "string" }
+ },
+ {
+ "name": "function_slug",
+ "required": true,
+ "in": "path",
+ "description": "Function slug",
+ "schema": { "pattern": {}, "type": "string" }
+ }
+ ],
+ "responses": {
+ "200": { "description": "" },
+ "500": { "description": "Failed to delete function with given slug" }
+ },
+ "security": [{ "bearer": [] }]
+ }
+ },
+ "/v1/projects/{ref}/secrets": {
+ "get": {
+ "operationId": "getSecrets",
+ "summary": "List all secrets",
+ "description": "Returns all secrets you've previously added to the specified project.",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": { "minLength": 20, "maxLength": 20, "type": "string" }
+ }
+ ],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/ProjectResponse" }
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/SecretResponse" }
+ }
+ }
+ }
+ },
+ "500": { "description": "Failed to retrieve project's secrets" }
+ },
+ "security": [{ "bearer": [] }]
+ },
+ "post": {
+ "operationId": "createSecrets",
+ "summary": "Bulk create secrets",
+ "description": "Creates multiple secrets and adds them to the specified project.",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": { "minLength": 20, "maxLength": 20, "type": "string" }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/CreateSecretBody" }
}
}
}
},
+ "responses": {
+ "201": { "description": "" },
+ "500": { "description": "Failed to create project's secrets" }
+ },
+ "security": [{ "bearer": [] }]
+ },
+ "delete": {
+ "operationId": "deleteSecrets",
+ "summary": "Bulk delete secrets",
+ "description": "Deletes all secrets with the given names from the specified project",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": { "minLength": 20, "maxLength": 20, "type": "string" }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": { "application/json": { "schema": { "type": "object" } } }
+ },
+ "500": { "description": "Failed to delete secrets with given names" }
+ },
"security": [{ "bearer": [] }]
}
}
},
- "info": {
- "title": "Supabase API",
- "description": "",
- "version": "1.0.0",
- "contact": {}
- },
+ "info": { "title": "Supabase API (v1)", "description": "", "version": "1.0.0", "contact": {} },
"tags": [],
"servers": [],
"components": {
- "securitySchemes": {
- "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "type": "http" },
- "apiKeyHeader": { "in": "header", "name": "apikey", "type": "apiKey" },
- "apiKeyQuery": { "in": "query", "name": "apikey", "type": "apiKey" }
- },
+ "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "type": "http" } },
"schemas": {
- "Notification": {
+ "ProjectResponse": {
"type": "object",
"properties": {
"id": { "type": "string" },
- "inserted_at": { "type": "string" },
- "project_id": { "type": "number" },
- "notification_name": { "type": "string" },
- "notification_status": { "type": "string" },
- "data": { "type": "object" },
- "meta": { "type": "object" }
- },
- "required": [
- "id",
- "inserted_at",
- "project_id",
- "notification_name",
- "notification_status",
- "data",
- "meta"
- ]
- },
- "UpdateNotificationsBody": {
- "type": "object",
- "properties": {
- "ids": { "type": "array", "items": { "type": "string" } }
- },
- "required": ["ids"]
- },
- "SendFeedbackBody": {
- "type": "object",
- "properties": {
- "message": { "type": "string" },
- "category": { "type": "string" },
- "subject": { "type": "string" },
- "tags": { "type": "array", "items": { "type": "string" } },
- "additionalRedirectUrls": { "type": "string" },
- "pathname": { "type": "string" },
- "projectRef": { "type": "string" },
- "severity": { "type": "string" },
- "siteUrl": { "type": "string" },
- "urlToAirTable": { "type": "string" },
- "verified": { "type": "boolean" }
- },
- "required": ["message", "category", "tags"]
- },
- "SubjectRoleParams": {
- "type": "object",
- "properties": {
- "gotrue_id": { "type": "string" },
- "role_id": { "type": "string" }
- },
- "required": ["gotrue_id", "role_id"]
- },
- "GetGoTrueConfigResponse": {
- "type": "object",
- "properties": {
- "app_version": { "type": "string" },
- "isFreeTier": { "type": "boolean" },
- "id": { "type": "number" },
- "project_id": { "type": "number" },
- "updated_at": { "type": "string" },
- "SITE_URL": { "type": "string" },
- "OPERATOR_TOKEN": { "type": "string" },
- "DISABLE_SIGNUP": { "type": "boolean" },
- "RATE_LIMIT_HEADER": { "type": "string" },
- "JWT_EXP": { "type": "number" },
- "JWT_AUD": { "type": "string" },
- "JWT_DEFAULT_GROUP_NAME": { "type": "string" },
- "EXTERNAL_GITHUB_ENABLED": { "type": "boolean" },
- "EXTERNAL_GITHUB_CLIENT_ID": { "type": "string" },
- "EXTERNAL_GITHUB_SECRET": { "type": "string" },
- "EXTERNAL_BITBUCKET_ENABLED": { "type": "boolean" },
- "EXTERNAL_BITBUCKET_CLIENT_ID": { "type": "string" },
- "EXTERNAL_BITBUCKET_SECRET": { "type": "string" },
- "EXTERNAL_GOOGLE_ENABLED": { "type": "boolean" },
- "EXTERNAL_GOOGLE_CLIENT_ID": { "type": "string" },
- "EXTERNAL_GOOGLE_SECRET": { "type": "string" },
- "EXTERNAL_GITLAB_ENABLED": { "type": "boolean" },
- "EXTERNAL_GITLAB_CLIENT_ID": { "type": "string" },
- "EXTERNAL_GITLAB_SECRET": { "type": "string" },
- "EXTERNAL_GITLAB_REDIRECT_URI": { "type": "string" },
- "EXTERNAL_GITLAB_URL": { "type": "string" },
- "SMTP_ADMIN_EMAIL": { "type": "string" },
- "SMTP_HOST": { "type": "string" },
- "SMTP_PORT": { "type": "string" },
- "SMTP_USER": { "type": "string" },
- "SMTP_PASS": { "type": "string" },
- "SMTP_MAX_FREQUENCY": { "type": "number" },
- "MAILER_AUTOCONFIRM": { "type": "boolean" },
- "MAILER_URLPATHS_INVITE": { "type": "string" },
- "MAILER_URLPATHS_CONFIRMATION": { "type": "string" },
- "MAILER_URLPATHS_RECOVERY": { "type": "string" },
- "MAILER_URLPATHS_EMAIL_CHANGE": { "type": "string" },
- "MAILER_SUBJECTS_INVITE": { "type": "string" },
- "MAILER_SUBJECTS_CONFIRMATION": { "type": "string" },
- "MAILER_SUBJECTS_RECOVERY": { "type": "string" },
- "MAILER_SUBJECTS_EMAIL_CHANGE": { "type": "string" },
- "MAILER_TEMPLATES_INVITE": { "type": "string" },
- "MAILER_TEMPLATES_INVITE_CONTENT": { "type": "string" },
- "MAILER_TEMPLATES_CONFIRMATION": { "type": "string" },
- "MAILER_TEMPLATES_CONFIRMATION_CONTENT": { "type": "string" },
- "MAILER_TEMPLATES_RECOVERY": { "type": "string" },
- "MAILER_TEMPLATES_RECOVERY_CONTENT": { "type": "string" },
- "MAILER_TEMPLATES_EMAIL_CHANGE": { "type": "string" },
- "MAILER_TEMPLATES_EMAIL_CHANGE_CONTENT": { "type": "string" },
- "MAILER_SUBJECTS_MAGIC_LINK": { "type": "string" },
- "MAILER_TEMPLATES_MAGIC_LINK": { "type": "string" },
- "MAILER_TEMPLATES_MAGIC_LINK_CONTENT": { "type": "string" },
- "EXTERNAL_AZURE_ENABLED": { "type": "boolean" },
- "EXTERNAL_AZURE_CLIENT_ID": { "type": "string" },
- "EXTERNAL_AZURE_SECRET": { "type": "string" },
- "EXTERNAL_FACEBOOK_ENABLED": { "type": "boolean" },
- "EXTERNAL_FACEBOOK_CLIENT_ID": { "type": "string" },
- "EXTERNAL_FACEBOOK_SECRET": { "type": "string" },
- "URI_ALLOW_LIST": { "type": "string" },
- "EXTERNAL_TWITTER_ENABLED": { "type": "boolean" },
- "EXTERNAL_TWITTER_CLIENT_ID": { "type": "string" },
- "EXTERNAL_TWITTER_SECRET": { "type": "string" },
- "EXTERNAL_APPLE_ENABLED": { "type": "boolean" },
- "EXTERNAL_APPLE_CLIENT_ID": { "type": "string" },
- "EXTERNAL_APPLE_SECRET": { "type": "string" },
- "EXTERNAL_DISCORD_ENABLED": { "type": "boolean" },
- "EXTERNAL_DISCORD_CLIENT_ID": { "type": "string" },
- "EXTERNAL_DISCORD_SECRET": { "type": "string" },
- "EXTERNAL_TWITCH_ENABLED": { "type": "boolean" },
- "EXTERNAL_TWITCH_CLIENT_ID": { "type": "string" },
- "EXTERNAL_TWITCH_SECRET": { "type": "string" },
- "SMTP_SENDER_NAME": { "type": "string" },
- "EXTERNAL_EMAIL_ENABLED": { "type": "boolean" },
- "EXTERNAL_PHONE_ENABLED": { "type": "boolean" },
- "SMS_AUTOCONFIRM": { "type": "boolean" },
- "SMS_MAX_FREQUENCY": { "type": "number" },
- "SMS_OTP_EXP": { "type": "number" },
- "SMS_OTP_LENGTH": { "type": "number" },
- "SMS_PROVIDER": { "type": "string" },
- "SMS_TWILIO_ACCOUNT_SID": { "type": "string" },
- "SMS_TWILIO_AUTH_TOKEN": { "type": "string" },
- "SMS_TWILIO_MESSAGE_SERVICE_SID": { "type": "string" },
- "SMS_TEMPLATE": { "type": "string" },
- "SECURITY_CAPTCHA_ENABLED": { "type": "boolean" },
- "SECURITY_CAPTCHA_PROVIDER": { "type": "string" },
- "SECURITY_CAPTCHA_SECRET": { "type": "string" },
- "RATE_LIMIT_EMAIL_SENT": { "type": "number" },
- "MAILER_SECURE_EMAIL_CHANGE_ENABLED": { "type": "boolean" },
- "EXTERNAL_SPOTIFY_ENABLED": { "type": "boolean" },
- "EXTERNAL_SPOTIFY_CLIENT_ID": { "type": "string" },
- "EXTERNAL_SPOTIFY_SECRET": { "type": "string" },
- "EXTERNAL_SLACK_ENABLED": { "type": "boolean" },
- "EXTERNAL_SLACK_CLIENT_ID": { "type": "string" },
- "EXTERNAL_SLACK_SECRET": { "type": "string" },
- "SMS_MESSAGEBIRD_ACCESS_KEY": { "type": "string" },
- "SMS_MESSAGEBIRD_ORIGINATOR": { "type": "string" },
- "SMTP_PASS_ENCRYPTED": { "type": "string" },
- "REFRESH_TOKEN_ROTATION_ENABLED": { "type": "boolean" },
- "EXTERNAL_LINKEDIN_ENABLED": { "type": "boolean" },
- "EXTERNAL_LINKEDIN_CLIENT_ID": { "type": "string" },
- "EXTERNAL_LINKEDIN_SECRET": { "type": "string" },
- "EXTERNAL_NOTION_ENABLED": { "type": "boolean" },
- "EXTERNAL_NOTION_CLIENT_ID": { "type": "string" },
- "EXTERNAL_NOTION_SECRET": { "type": "string" },
- "SMS_VONAGE_API_KEY": { "type": "string" },
- "SMS_VONAGE_API_SECRET": { "type": "string" },
- "SMS_VONAGE_FROM": { "type": "string" },
- "SMS_TEXTLOCAL_API_KEY": { "type": "string" },
- "SMS_TEXTLOCAL_SENDER": { "type": "string" },
- "EXTERNAL_ZOOM_ENABLED": { "type": "boolean" },
- "EXTERNAL_ZOOM_CLIENT_ID": { "type": "string" },
- "EXTERNAL_ZOOM_SECRET": { "type": "string" },
- "EXTERNAL_AZURE_URL": { "type": "string" },
- "PASSWORD_MIN_LENGTH": { "type": "number" },
- "EXTERNAL_KEYCLOAK_ENABLED": { "type": "boolean" },
- "EXTERNAL_KEYCLOAK_CLIENT_ID": { "type": "string" },
- "EXTERNAL_KEYCLOAK_SECRET": { "type": "string" },
- "EXTERNAL_KEYCLOAK_URL": { "type": "string" },
- "EXTERNAL_WORKOS_ENABLED": { "type": "boolean" },
- "EXTERNAL_WORKOS_CLIENT_ID": { "type": "string" },
- "EXTERNAL_WORKOS_SECRET": { "type": "string" },
- "EXTERNAL_WORKOS_URL": { "type": "string" },
- "SECURITY_UPDATE_PASSWORD_REQUIRE_REAUTHENTICATION": {
- "type": "boolean"
- },
- "SECURITY_REFRESH_TOKEN_REUSE_INTERVAL": { "type": "number" },
- "MAILER_OTP_EXP": { "type": "number" },
- "RATE_LIMIT_VERIFY": { "type": "number" },
- "RATE_LIMIT_TOKEN_REFRESH": { "type": "number" }
- },
- "required": [
- "app_version",
- "isFreeTier",
- "id",
- "project_id",
- "updated_at",
- "SITE_URL",
- "OPERATOR_TOKEN",
- "DISABLE_SIGNUP",
- "RATE_LIMIT_HEADER",
- "JWT_EXP",
- "JWT_AUD",
- "JWT_DEFAULT_GROUP_NAME",
- "EXTERNAL_GITHUB_ENABLED",
- "EXTERNAL_GITHUB_CLIENT_ID",
- "EXTERNAL_GITHUB_SECRET",
- "EXTERNAL_BITBUCKET_ENABLED",
- "EXTERNAL_BITBUCKET_CLIENT_ID",
- "EXTERNAL_BITBUCKET_SECRET",
- "EXTERNAL_GOOGLE_ENABLED",
- "EXTERNAL_GOOGLE_CLIENT_ID",
- "EXTERNAL_GOOGLE_SECRET",
- "EXTERNAL_GITLAB_ENABLED",
- "EXTERNAL_GITLAB_CLIENT_ID",
- "EXTERNAL_GITLAB_SECRET",
- "EXTERNAL_GITLAB_REDIRECT_URI",
- "EXTERNAL_GITLAB_URL",
- "SMTP_ADMIN_EMAIL",
- "SMTP_HOST",
- "SMTP_PORT",
- "SMTP_USER",
- "SMTP_PASS",
- "SMTP_MAX_FREQUENCY",
- "MAILER_AUTOCONFIRM",
- "MAILER_URLPATHS_INVITE",
- "MAILER_URLPATHS_CONFIRMATION",
- "MAILER_URLPATHS_RECOVERY",
- "MAILER_URLPATHS_EMAIL_CHANGE",
- "MAILER_SUBJECTS_INVITE",
- "MAILER_SUBJECTS_CONFIRMATION",
- "MAILER_SUBJECTS_RECOVERY",
- "MAILER_SUBJECTS_EMAIL_CHANGE",
- "MAILER_TEMPLATES_INVITE",
- "MAILER_TEMPLATES_INVITE_CONTENT",
- "MAILER_TEMPLATES_CONFIRMATION",
- "MAILER_TEMPLATES_CONFIRMATION_CONTENT",
- "MAILER_TEMPLATES_RECOVERY",
- "MAILER_TEMPLATES_RECOVERY_CONTENT",
- "MAILER_TEMPLATES_EMAIL_CHANGE",
- "MAILER_TEMPLATES_EMAIL_CHANGE_CONTENT",
- "MAILER_SUBJECTS_MAGIC_LINK",
- "MAILER_TEMPLATES_MAGIC_LINK",
- "MAILER_TEMPLATES_MAGIC_LINK_CONTENT",
- "EXTERNAL_AZURE_ENABLED",
- "EXTERNAL_AZURE_CLIENT_ID",
- "EXTERNAL_AZURE_SECRET",
- "EXTERNAL_FACEBOOK_ENABLED",
- "EXTERNAL_FACEBOOK_CLIENT_ID",
- "EXTERNAL_FACEBOOK_SECRET",
- "URI_ALLOW_LIST",
- "EXTERNAL_TWITTER_ENABLED",
- "EXTERNAL_TWITTER_CLIENT_ID",
- "EXTERNAL_TWITTER_SECRET",
- "EXTERNAL_APPLE_ENABLED",
- "EXTERNAL_APPLE_CLIENT_ID",
- "EXTERNAL_APPLE_SECRET",
- "EXTERNAL_DISCORD_ENABLED",
- "EXTERNAL_DISCORD_CLIENT_ID",
- "EXTERNAL_DISCORD_SECRET",
- "EXTERNAL_TWITCH_ENABLED",
- "EXTERNAL_TWITCH_CLIENT_ID",
- "EXTERNAL_TWITCH_SECRET",
- "SMTP_SENDER_NAME",
- "EXTERNAL_EMAIL_ENABLED",
- "EXTERNAL_PHONE_ENABLED",
- "SMS_AUTOCONFIRM",
- "SMS_MAX_FREQUENCY",
- "SMS_OTP_EXP",
- "SMS_OTP_LENGTH",
- "SMS_PROVIDER",
- "SMS_TWILIO_ACCOUNT_SID",
- "SMS_TWILIO_AUTH_TOKEN",
- "SMS_TWILIO_MESSAGE_SERVICE_SID",
- "SMS_TEMPLATE",
- "SECURITY_CAPTCHA_ENABLED",
- "SECURITY_CAPTCHA_PROVIDER",
- "SECURITY_CAPTCHA_SECRET",
- "RATE_LIMIT_EMAIL_SENT",
- "MAILER_SECURE_EMAIL_CHANGE_ENABLED",
- "EXTERNAL_SPOTIFY_ENABLED",
- "EXTERNAL_SPOTIFY_CLIENT_ID",
- "EXTERNAL_SPOTIFY_SECRET",
- "EXTERNAL_SLACK_ENABLED",
- "EXTERNAL_SLACK_CLIENT_ID",
- "EXTERNAL_SLACK_SECRET",
- "SMS_MESSAGEBIRD_ACCESS_KEY",
- "SMS_MESSAGEBIRD_ORIGINATOR",
- "SMTP_PASS_ENCRYPTED",
- "REFRESH_TOKEN_ROTATION_ENABLED",
- "EXTERNAL_LINKEDIN_ENABLED",
- "EXTERNAL_LINKEDIN_CLIENT_ID",
- "EXTERNAL_LINKEDIN_SECRET",
- "EXTERNAL_NOTION_ENABLED",
- "EXTERNAL_NOTION_CLIENT_ID",
- "EXTERNAL_NOTION_SECRET",
- "SMS_VONAGE_API_KEY",
- "SMS_VONAGE_API_SECRET",
- "SMS_VONAGE_FROM",
- "SMS_TEXTLOCAL_API_KEY",
- "SMS_TEXTLOCAL_SENDER",
- "EXTERNAL_ZOOM_ENABLED",
- "EXTERNAL_ZOOM_CLIENT_ID",
- "EXTERNAL_ZOOM_SECRET",
- "EXTERNAL_AZURE_URL",
- "PASSWORD_MIN_LENGTH",
- "EXTERNAL_KEYCLOAK_ENABLED",
- "EXTERNAL_KEYCLOAK_CLIENT_ID",
- "EXTERNAL_KEYCLOAK_SECRET",
- "EXTERNAL_KEYCLOAK_URL",
- "EXTERNAL_WORKOS_ENABLED",
- "EXTERNAL_WORKOS_CLIENT_ID",
- "EXTERNAL_WORKOS_SECRET",
- "EXTERNAL_WORKOS_URL",
- "SECURITY_UPDATE_PASSWORD_REQUIRE_REAUTHENTICATION",
- "SECURITY_REFRESH_TOKEN_REUSE_INTERVAL",
- "MAILER_OTP_EXP",
- "RATE_LIMIT_VERIFY",
- "RATE_LIMIT_TOKEN_REFRESH"
- ]
- },
- "UpdateGoTrueConfigBody": {
- "type": "object",
- "properties": {
- "SITE_URL": { "type": "string" },
- "OPERATOR_TOKEN": { "type": "string" },
- "DISABLE_SIGNUP": { "type": "boolean" },
- "RATE_LIMIT_HEADER": { "type": "string" },
- "JWT_EXP": { "type": "number" },
- "JWT_AUD": { "type": "string" },
- "JWT_DEFAULT_GROUP_NAME": { "type": "string" },
- "EXTERNAL_GITHUB_ENABLED": { "type": "boolean" },
- "EXTERNAL_GITHUB_CLIENT_ID": { "type": "string" },
- "EXTERNAL_GITHUB_SECRET": { "type": "string" },
- "EXTERNAL_BITBUCKET_ENABLED": { "type": "boolean" },
- "EXTERNAL_BITBUCKET_CLIENT_ID": { "type": "string" },
- "EXTERNAL_BITBUCKET_SECRET": { "type": "string" },
- "EXTERNAL_GOOGLE_ENABLED": { "type": "boolean" },
- "EXTERNAL_GOOGLE_CLIENT_ID": { "type": "string" },
- "EXTERNAL_GOOGLE_SECRET": { "type": "string" },
- "EXTERNAL_GITLAB_ENABLED": { "type": "boolean" },
- "EXTERNAL_GITLAB_CLIENT_ID": { "type": "string" },
- "EXTERNAL_GITLAB_SECRET": { "type": "string" },
- "EXTERNAL_GITLAB_REDIRECT_URI": { "type": "string" },
- "EXTERNAL_GITLAB_URL": { "type": "string" },
- "SMTP_ADMIN_EMAIL": { "type": "string" },
- "SMTP_HOST": { "type": "string" },
- "SMTP_PORT": { "type": "string" },
- "SMTP_USER": { "type": "string" },
- "SMTP_PASS": { "type": "string" },
- "SMTP_MAX_FREQUENCY": { "type": "number" },
- "MAILER_AUTOCONFIRM": { "type": "boolean" },
- "MAILER_URLPATHS_INVITE": { "type": "string" },
- "MAILER_URLPATHS_CONFIRMATION": { "type": "string" },
- "MAILER_URLPATHS_RECOVERY": { "type": "string" },
- "MAILER_URLPATHS_EMAIL_CHANGE": { "type": "string" },
- "MAILER_SUBJECTS_INVITE": { "type": "string" },
- "MAILER_SUBJECTS_CONFIRMATION": { "type": "string" },
- "MAILER_SUBJECTS_RECOVERY": { "type": "string" },
- "MAILER_SUBJECTS_EMAIL_CHANGE": { "type": "string" },
- "MAILER_TEMPLATES_INVITE": { "type": "string" },
- "MAILER_TEMPLATES_INVITE_CONTENT": { "type": "string" },
- "MAILER_TEMPLATES_CONFIRMATION": { "type": "string" },
- "MAILER_TEMPLATES_CONFIRMATION_CONTENT": { "type": "string" },
- "MAILER_TEMPLATES_RECOVERY": { "type": "string" },
- "MAILER_TEMPLATES_RECOVERY_CONTENT": { "type": "string" },
- "MAILER_TEMPLATES_EMAIL_CHANGE": { "type": "string" },
- "MAILER_TEMPLATES_EMAIL_CHANGE_CONTENT": { "type": "string" },
- "MAILER_SUBJECTS_MAGIC_LINK": { "type": "string" },
- "MAILER_TEMPLATES_MAGIC_LINK": { "type": "string" },
- "MAILER_TEMPLATES_MAGIC_LINK_CONTENT": { "type": "string" },
- "EXTERNAL_AZURE_ENABLED": { "type": "boolean" },
- "EXTERNAL_AZURE_CLIENT_ID": { "type": "string" },
- "EXTERNAL_AZURE_SECRET": { "type": "string" },
- "EXTERNAL_FACEBOOK_ENABLED": { "type": "boolean" },
- "EXTERNAL_FACEBOOK_CLIENT_ID": { "type": "string" },
- "EXTERNAL_FACEBOOK_SECRET": { "type": "string" },
- "URI_ALLOW_LIST": { "type": "string" },
- "EXTERNAL_TWITTER_ENABLED": { "type": "boolean" },
- "EXTERNAL_TWITTER_CLIENT_ID": { "type": "string" },
- "EXTERNAL_TWITTER_SECRET": { "type": "string" },
- "EXTERNAL_APPLE_ENABLED": { "type": "boolean" },
- "EXTERNAL_APPLE_CLIENT_ID": { "type": "string" },
- "EXTERNAL_APPLE_SECRET": { "type": "string" },
- "EXTERNAL_DISCORD_ENABLED": { "type": "boolean" },
- "EXTERNAL_DISCORD_CLIENT_ID": { "type": "string" },
- "EXTERNAL_DISCORD_SECRET": { "type": "string" },
- "EXTERNAL_TWITCH_ENABLED": { "type": "boolean" },
- "EXTERNAL_TWITCH_CLIENT_ID": { "type": "string" },
- "EXTERNAL_TWITCH_SECRET": { "type": "string" },
- "SMTP_SENDER_NAME": { "type": "string" },
- "EXTERNAL_EMAIL_ENABLED": { "type": "boolean" },
- "EXTERNAL_PHONE_ENABLED": { "type": "boolean" },
- "SMS_AUTOCONFIRM": { "type": "boolean" },
- "SMS_MAX_FREQUENCY": { "type": "number" },
- "SMS_OTP_EXP": { "type": "number" },
- "SMS_OTP_LENGTH": { "type": "number" },
- "SMS_PROVIDER": { "type": "string" },
- "SMS_TWILIO_ACCOUNT_SID": { "type": "string" },
- "SMS_TWILIO_AUTH_TOKEN": { "type": "string" },
- "SMS_TWILIO_MESSAGE_SERVICE_SID": { "type": "string" },
- "SMS_TEMPLATE": { "type": "string" },
- "SECURITY_CAPTCHA_ENABLED": { "type": "boolean" },
- "SECURITY_CAPTCHA_PROVIDER": { "type": "string" },
- "SECURITY_CAPTCHA_SECRET": { "type": "string" },
- "RATE_LIMIT_EMAIL_SENT": { "type": "number" },
- "MAILER_SECURE_EMAIL_CHANGE_ENABLED": { "type": "boolean" },
- "EXTERNAL_SPOTIFY_ENABLED": { "type": "boolean" },
- "EXTERNAL_SPOTIFY_CLIENT_ID": { "type": "string" },
- "EXTERNAL_SPOTIFY_SECRET": { "type": "string" },
- "EXTERNAL_SLACK_ENABLED": { "type": "boolean" },
- "EXTERNAL_SLACK_CLIENT_ID": { "type": "string" },
- "EXTERNAL_SLACK_SECRET": { "type": "string" },
- "SMS_MESSAGEBIRD_ACCESS_KEY": { "type": "string" },
- "SMS_MESSAGEBIRD_ORIGINATOR": { "type": "string" },
- "SMTP_PASS_ENCRYPTED": { "type": "string" },
- "REFRESH_TOKEN_ROTATION_ENABLED": { "type": "boolean" },
- "EXTERNAL_LINKEDIN_ENABLED": { "type": "boolean" },
- "EXTERNAL_LINKEDIN_CLIENT_ID": { "type": "string" },
- "EXTERNAL_LINKEDIN_SECRET": { "type": "string" },
- "EXTERNAL_NOTION_ENABLED": { "type": "boolean" },
- "EXTERNAL_NOTION_CLIENT_ID": { "type": "string" },
- "EXTERNAL_NOTION_SECRET": { "type": "string" },
- "SMS_VONAGE_API_KEY": { "type": "string" },
- "SMS_VONAGE_API_SECRET": { "type": "string" },
- "SMS_VONAGE_FROM": { "type": "string" },
- "SMS_TEXTLOCAL_API_KEY": { "type": "string" },
- "SMS_TEXTLOCAL_SENDER": { "type": "string" },
- "EXTERNAL_ZOOM_ENABLED": { "type": "boolean" },
- "EXTERNAL_ZOOM_CLIENT_ID": { "type": "string" },
- "EXTERNAL_ZOOM_SECRET": { "type": "string" },
- "EXTERNAL_AZURE_URL": { "type": "string" },
- "PASSWORD_MIN_LENGTH": { "type": "number" },
- "EXTERNAL_KEYCLOAK_ENABLED": { "type": "boolean" },
- "EXTERNAL_KEYCLOAK_CLIENT_ID": { "type": "string" },
- "EXTERNAL_KEYCLOAK_SECRET": { "type": "string" },
- "EXTERNAL_KEYCLOAK_URL": { "type": "string" },
- "EXTERNAL_WORKOS_ENABLED": { "type": "boolean" },
- "EXTERNAL_WORKOS_CLIENT_ID": { "type": "string" },
- "EXTERNAL_WORKOS_SECRET": { "type": "string" },
- "EXTERNAL_WORKOS_URL": { "type": "string" },
- "SECURITY_UPDATE_PASSWORD_REQUIRE_REAUTHENTICATION": {
- "type": "boolean"
- },
- "SECURITY_REFRESH_TOKEN_REUSE_INTERVAL": { "type": "number" },
- "MAILER_OTP_EXP": { "type": "number" },
- "RATE_LIMIT_VERIFY": { "type": "number" },
- "RATE_LIMIT_TOKEN_REFRESH": { "type": "number" }
- },
- "required": [
- "SITE_URL",
- "OPERATOR_TOKEN",
- "DISABLE_SIGNUP",
- "RATE_LIMIT_HEADER",
- "JWT_EXP",
- "JWT_AUD",
- "JWT_DEFAULT_GROUP_NAME",
- "EXTERNAL_GITHUB_ENABLED",
- "EXTERNAL_GITHUB_CLIENT_ID",
- "EXTERNAL_GITHUB_SECRET",
- "EXTERNAL_BITBUCKET_ENABLED",
- "EXTERNAL_BITBUCKET_CLIENT_ID",
- "EXTERNAL_BITBUCKET_SECRET",
- "EXTERNAL_GOOGLE_ENABLED",
- "EXTERNAL_GOOGLE_CLIENT_ID",
- "EXTERNAL_GOOGLE_SECRET",
- "EXTERNAL_GITLAB_ENABLED",
- "EXTERNAL_GITLAB_CLIENT_ID",
- "EXTERNAL_GITLAB_SECRET",
- "EXTERNAL_GITLAB_REDIRECT_URI",
- "EXTERNAL_GITLAB_URL",
- "SMTP_ADMIN_EMAIL",
- "SMTP_HOST",
- "SMTP_PORT",
- "SMTP_USER",
- "SMTP_PASS",
- "SMTP_MAX_FREQUENCY",
- "MAILER_AUTOCONFIRM",
- "MAILER_URLPATHS_INVITE",
- "MAILER_URLPATHS_CONFIRMATION",
- "MAILER_URLPATHS_RECOVERY",
- "MAILER_URLPATHS_EMAIL_CHANGE",
- "MAILER_SUBJECTS_INVITE",
- "MAILER_SUBJECTS_CONFIRMATION",
- "MAILER_SUBJECTS_RECOVERY",
- "MAILER_SUBJECTS_EMAIL_CHANGE",
- "MAILER_TEMPLATES_INVITE",
- "MAILER_TEMPLATES_INVITE_CONTENT",
- "MAILER_TEMPLATES_CONFIRMATION",
- "MAILER_TEMPLATES_CONFIRMATION_CONTENT",
- "MAILER_TEMPLATES_RECOVERY",
- "MAILER_TEMPLATES_RECOVERY_CONTENT",
- "MAILER_TEMPLATES_EMAIL_CHANGE",
- "MAILER_TEMPLATES_EMAIL_CHANGE_CONTENT",
- "MAILER_SUBJECTS_MAGIC_LINK",
- "MAILER_TEMPLATES_MAGIC_LINK",
- "MAILER_TEMPLATES_MAGIC_LINK_CONTENT",
- "EXTERNAL_AZURE_ENABLED",
- "EXTERNAL_AZURE_CLIENT_ID",
- "EXTERNAL_AZURE_SECRET",
- "EXTERNAL_FACEBOOK_ENABLED",
- "EXTERNAL_FACEBOOK_CLIENT_ID",
- "EXTERNAL_FACEBOOK_SECRET",
- "URI_ALLOW_LIST",
- "EXTERNAL_TWITTER_ENABLED",
- "EXTERNAL_TWITTER_CLIENT_ID",
- "EXTERNAL_TWITTER_SECRET",
- "EXTERNAL_APPLE_ENABLED",
- "EXTERNAL_APPLE_CLIENT_ID",
- "EXTERNAL_APPLE_SECRET",
- "EXTERNAL_DISCORD_ENABLED",
- "EXTERNAL_DISCORD_CLIENT_ID",
- "EXTERNAL_DISCORD_SECRET",
- "EXTERNAL_TWITCH_ENABLED",
- "EXTERNAL_TWITCH_CLIENT_ID",
- "EXTERNAL_TWITCH_SECRET",
- "SMTP_SENDER_NAME",
- "EXTERNAL_EMAIL_ENABLED",
- "EXTERNAL_PHONE_ENABLED",
- "SMS_AUTOCONFIRM",
- "SMS_MAX_FREQUENCY",
- "SMS_OTP_EXP",
- "SMS_OTP_LENGTH",
- "SMS_PROVIDER",
- "SMS_TWILIO_ACCOUNT_SID",
- "SMS_TWILIO_AUTH_TOKEN",
- "SMS_TWILIO_MESSAGE_SERVICE_SID",
- "SMS_TEMPLATE",
- "SECURITY_CAPTCHA_ENABLED",
- "SECURITY_CAPTCHA_PROVIDER",
- "SECURITY_CAPTCHA_SECRET",
- "RATE_LIMIT_EMAIL_SENT",
- "MAILER_SECURE_EMAIL_CHANGE_ENABLED",
- "EXTERNAL_SPOTIFY_ENABLED",
- "EXTERNAL_SPOTIFY_CLIENT_ID",
- "EXTERNAL_SPOTIFY_SECRET",
- "EXTERNAL_SLACK_ENABLED",
- "EXTERNAL_SLACK_CLIENT_ID",
- "EXTERNAL_SLACK_SECRET",
- "SMS_MESSAGEBIRD_ACCESS_KEY",
- "SMS_MESSAGEBIRD_ORIGINATOR",
- "SMTP_PASS_ENCRYPTED",
- "REFRESH_TOKEN_ROTATION_ENABLED",
- "EXTERNAL_LINKEDIN_ENABLED",
- "EXTERNAL_LINKEDIN_CLIENT_ID",
- "EXTERNAL_LINKEDIN_SECRET",
- "EXTERNAL_NOTION_ENABLED",
- "EXTERNAL_NOTION_CLIENT_ID",
- "EXTERNAL_NOTION_SECRET",
- "SMS_VONAGE_API_KEY",
- "SMS_VONAGE_API_SECRET",
- "SMS_VONAGE_FROM",
- "SMS_TEXTLOCAL_API_KEY",
- "SMS_TEXTLOCAL_SENDER",
- "EXTERNAL_ZOOM_ENABLED",
- "EXTERNAL_ZOOM_CLIENT_ID",
- "EXTERNAL_ZOOM_SECRET",
- "EXTERNAL_AZURE_URL",
- "PASSWORD_MIN_LENGTH",
- "EXTERNAL_KEYCLOAK_ENABLED",
- "EXTERNAL_KEYCLOAK_CLIENT_ID",
- "EXTERNAL_KEYCLOAK_SECRET",
- "EXTERNAL_KEYCLOAK_URL",
- "EXTERNAL_WORKOS_ENABLED",
- "EXTERNAL_WORKOS_CLIENT_ID",
- "EXTERNAL_WORKOS_SECRET",
- "EXTERNAL_WORKOS_URL",
- "SECURITY_UPDATE_PASSWORD_REQUIRE_REAUTHENTICATION",
- "SECURITY_REFRESH_TOKEN_REUSE_INTERVAL",
- "MAILER_OTP_EXP",
- "RATE_LIMIT_VERIFY",
- "RATE_LIMIT_TOKEN_REFRESH"
- ]
- },
- "GoTrueConfig": {
- "type": "object",
- "properties": {
- "SITE_URL": { "type": "string" },
- "OPERATOR_TOKEN": { "type": "string" },
- "DISABLE_SIGNUP": { "type": "boolean" },
- "RATE_LIMIT_HEADER": { "type": "string" },
- "JWT_EXP": { "type": "number" },
- "JWT_AUD": { "type": "string" },
- "JWT_DEFAULT_GROUP_NAME": { "type": "string" },
- "EXTERNAL_GITHUB_ENABLED": { "type": "boolean" },
- "EXTERNAL_GITHUB_CLIENT_ID": { "type": "string" },
- "EXTERNAL_GITHUB_SECRET": { "type": "string" },
- "EXTERNAL_BITBUCKET_ENABLED": { "type": "boolean" },
- "EXTERNAL_BITBUCKET_CLIENT_ID": { "type": "string" },
- "EXTERNAL_BITBUCKET_SECRET": { "type": "string" },
- "EXTERNAL_GOOGLE_ENABLED": { "type": "boolean" },
- "EXTERNAL_GOOGLE_CLIENT_ID": { "type": "string" },
- "EXTERNAL_GOOGLE_SECRET": { "type": "string" },
- "EXTERNAL_GITLAB_ENABLED": { "type": "boolean" },
- "EXTERNAL_GITLAB_CLIENT_ID": { "type": "string" },
- "EXTERNAL_GITLAB_SECRET": { "type": "string" },
- "EXTERNAL_GITLAB_REDIRECT_URI": { "type": "string" },
- "EXTERNAL_GITLAB_URL": { "type": "string" },
- "SMTP_ADMIN_EMAIL": { "type": "string" },
- "SMTP_HOST": { "type": "string" },
- "SMTP_PORT": { "type": "string" },
- "SMTP_USER": { "type": "string" },
- "SMTP_PASS": { "type": "string" },
- "SMTP_MAX_FREQUENCY": { "type": "number" },
- "MAILER_AUTOCONFIRM": { "type": "boolean" },
- "MAILER_URLPATHS_INVITE": { "type": "string" },
- "MAILER_URLPATHS_CONFIRMATION": { "type": "string" },
- "MAILER_URLPATHS_RECOVERY": { "type": "string" },
- "MAILER_URLPATHS_EMAIL_CHANGE": { "type": "string" },
- "MAILER_SUBJECTS_INVITE": { "type": "string" },
- "MAILER_SUBJECTS_CONFIRMATION": { "type": "string" },
- "MAILER_SUBJECTS_RECOVERY": { "type": "string" },
- "MAILER_SUBJECTS_EMAIL_CHANGE": { "type": "string" },
- "MAILER_TEMPLATES_INVITE": { "type": "string" },
- "MAILER_TEMPLATES_INVITE_CONTENT": { "type": "string" },
- "MAILER_TEMPLATES_CONFIRMATION": { "type": "string" },
- "MAILER_TEMPLATES_CONFIRMATION_CONTENT": { "type": "string" },
- "MAILER_TEMPLATES_RECOVERY": { "type": "string" },
- "MAILER_TEMPLATES_RECOVERY_CONTENT": { "type": "string" },
- "MAILER_TEMPLATES_EMAIL_CHANGE": { "type": "string" },
- "MAILER_TEMPLATES_EMAIL_CHANGE_CONTENT": { "type": "string" },
- "MAILER_SUBJECTS_MAGIC_LINK": { "type": "string" },
- "MAILER_TEMPLATES_MAGIC_LINK": { "type": "string" },
- "MAILER_TEMPLATES_MAGIC_LINK_CONTENT": { "type": "string" },
- "EXTERNAL_AZURE_ENABLED": { "type": "boolean" },
- "EXTERNAL_AZURE_CLIENT_ID": { "type": "string" },
- "EXTERNAL_AZURE_SECRET": { "type": "string" },
- "EXTERNAL_FACEBOOK_ENABLED": { "type": "boolean" },
- "EXTERNAL_FACEBOOK_CLIENT_ID": { "type": "string" },
- "EXTERNAL_FACEBOOK_SECRET": { "type": "string" },
- "URI_ALLOW_LIST": { "type": "string" },
- "EXTERNAL_TWITTER_ENABLED": { "type": "boolean" },
- "EXTERNAL_TWITTER_CLIENT_ID": { "type": "string" },
- "EXTERNAL_TWITTER_SECRET": { "type": "string" },
- "EXTERNAL_APPLE_ENABLED": { "type": "boolean" },
- "EXTERNAL_APPLE_CLIENT_ID": { "type": "string" },
- "EXTERNAL_APPLE_SECRET": { "type": "string" },
- "EXTERNAL_DISCORD_ENABLED": { "type": "boolean" },
- "EXTERNAL_DISCORD_CLIENT_ID": { "type": "string" },
- "EXTERNAL_DISCORD_SECRET": { "type": "string" },
- "EXTERNAL_TWITCH_ENABLED": { "type": "boolean" },
- "EXTERNAL_TWITCH_CLIENT_ID": { "type": "string" },
- "EXTERNAL_TWITCH_SECRET": { "type": "string" },
- "SMTP_SENDER_NAME": { "type": "string" },
- "EXTERNAL_EMAIL_ENABLED": { "type": "boolean" },
- "EXTERNAL_PHONE_ENABLED": { "type": "boolean" },
- "SMS_AUTOCONFIRM": { "type": "boolean" },
- "SMS_MAX_FREQUENCY": { "type": "number" },
- "SMS_OTP_EXP": { "type": "number" },
- "SMS_OTP_LENGTH": { "type": "number" },
- "SMS_PROVIDER": { "type": "string" },
- "SMS_TWILIO_ACCOUNT_SID": { "type": "string" },
- "SMS_TWILIO_AUTH_TOKEN": { "type": "string" },
- "SMS_TWILIO_MESSAGE_SERVICE_SID": { "type": "string" },
- "SMS_TEMPLATE": { "type": "string" },
- "SECURITY_CAPTCHA_ENABLED": { "type": "boolean" },
- "SECURITY_CAPTCHA_PROVIDER": { "type": "string" },
- "SECURITY_CAPTCHA_SECRET": { "type": "string" },
- "RATE_LIMIT_EMAIL_SENT": { "type": "number" },
- "MAILER_SECURE_EMAIL_CHANGE_ENABLED": { "type": "boolean" },
- "EXTERNAL_SPOTIFY_ENABLED": { "type": "boolean" },
- "EXTERNAL_SPOTIFY_CLIENT_ID": { "type": "string" },
- "EXTERNAL_SPOTIFY_SECRET": { "type": "string" },
- "EXTERNAL_SLACK_ENABLED": { "type": "boolean" },
- "EXTERNAL_SLACK_CLIENT_ID": { "type": "string" },
- "EXTERNAL_SLACK_SECRET": { "type": "string" },
- "SMS_MESSAGEBIRD_ACCESS_KEY": { "type": "string" },
- "SMS_MESSAGEBIRD_ORIGINATOR": { "type": "string" },
- "SMTP_PASS_ENCRYPTED": { "type": "string" },
- "REFRESH_TOKEN_ROTATION_ENABLED": { "type": "boolean" },
- "EXTERNAL_LINKEDIN_ENABLED": { "type": "boolean" },
- "EXTERNAL_LINKEDIN_CLIENT_ID": { "type": "string" },
- "EXTERNAL_LINKEDIN_SECRET": { "type": "string" },
- "EXTERNAL_NOTION_ENABLED": { "type": "boolean" },
- "EXTERNAL_NOTION_CLIENT_ID": { "type": "string" },
- "EXTERNAL_NOTION_SECRET": { "type": "string" },
- "SMS_VONAGE_API_KEY": { "type": "string" },
- "SMS_VONAGE_API_SECRET": { "type": "string" },
- "SMS_VONAGE_FROM": { "type": "string" },
- "SMS_TEXTLOCAL_API_KEY": { "type": "string" },
- "SMS_TEXTLOCAL_SENDER": { "type": "string" },
- "EXTERNAL_ZOOM_ENABLED": { "type": "boolean" },
- "EXTERNAL_ZOOM_CLIENT_ID": { "type": "string" },
- "EXTERNAL_ZOOM_SECRET": { "type": "string" },
- "EXTERNAL_AZURE_URL": { "type": "string" },
- "PASSWORD_MIN_LENGTH": { "type": "number" },
- "EXTERNAL_KEYCLOAK_ENABLED": { "type": "boolean" },
- "EXTERNAL_KEYCLOAK_CLIENT_ID": { "type": "string" },
- "EXTERNAL_KEYCLOAK_SECRET": { "type": "string" },
- "EXTERNAL_KEYCLOAK_URL": { "type": "string" },
- "EXTERNAL_WORKOS_ENABLED": { "type": "boolean" },
- "EXTERNAL_WORKOS_CLIENT_ID": { "type": "string" },
- "EXTERNAL_WORKOS_SECRET": { "type": "string" },
- "EXTERNAL_WORKOS_URL": { "type": "string" },
- "SECURITY_UPDATE_PASSWORD_REQUIRE_REAUTHENTICATION": {
- "type": "boolean"
- },
- "SECURITY_REFRESH_TOKEN_REUSE_INTERVAL": { "type": "number" },
- "MAILER_OTP_EXP": { "type": "number" },
- "RATE_LIMIT_VERIFY": { "type": "number" },
- "RATE_LIMIT_TOKEN_REFRESH": { "type": "number" },
- "id": { "type": "number" },
- "project_id": { "type": "number" },
- "updated_at": { "type": "string" }
- },
- "required": [
- "SITE_URL",
- "OPERATOR_TOKEN",
- "DISABLE_SIGNUP",
- "RATE_LIMIT_HEADER",
- "JWT_EXP",
- "JWT_AUD",
- "JWT_DEFAULT_GROUP_NAME",
- "EXTERNAL_GITHUB_ENABLED",
- "EXTERNAL_GITHUB_CLIENT_ID",
- "EXTERNAL_GITHUB_SECRET",
- "EXTERNAL_BITBUCKET_ENABLED",
- "EXTERNAL_BITBUCKET_CLIENT_ID",
- "EXTERNAL_BITBUCKET_SECRET",
- "EXTERNAL_GOOGLE_ENABLED",
- "EXTERNAL_GOOGLE_CLIENT_ID",
- "EXTERNAL_GOOGLE_SECRET",
- "EXTERNAL_GITLAB_ENABLED",
- "EXTERNAL_GITLAB_CLIENT_ID",
- "EXTERNAL_GITLAB_SECRET",
- "EXTERNAL_GITLAB_REDIRECT_URI",
- "EXTERNAL_GITLAB_URL",
- "SMTP_ADMIN_EMAIL",
- "SMTP_HOST",
- "SMTP_PORT",
- "SMTP_USER",
- "SMTP_PASS",
- "SMTP_MAX_FREQUENCY",
- "MAILER_AUTOCONFIRM",
- "MAILER_URLPATHS_INVITE",
- "MAILER_URLPATHS_CONFIRMATION",
- "MAILER_URLPATHS_RECOVERY",
- "MAILER_URLPATHS_EMAIL_CHANGE",
- "MAILER_SUBJECTS_INVITE",
- "MAILER_SUBJECTS_CONFIRMATION",
- "MAILER_SUBJECTS_RECOVERY",
- "MAILER_SUBJECTS_EMAIL_CHANGE",
- "MAILER_TEMPLATES_INVITE",
- "MAILER_TEMPLATES_INVITE_CONTENT",
- "MAILER_TEMPLATES_CONFIRMATION",
- "MAILER_TEMPLATES_CONFIRMATION_CONTENT",
- "MAILER_TEMPLATES_RECOVERY",
- "MAILER_TEMPLATES_RECOVERY_CONTENT",
- "MAILER_TEMPLATES_EMAIL_CHANGE",
- "MAILER_TEMPLATES_EMAIL_CHANGE_CONTENT",
- "MAILER_SUBJECTS_MAGIC_LINK",
- "MAILER_TEMPLATES_MAGIC_LINK",
- "MAILER_TEMPLATES_MAGIC_LINK_CONTENT",
- "EXTERNAL_AZURE_ENABLED",
- "EXTERNAL_AZURE_CLIENT_ID",
- "EXTERNAL_AZURE_SECRET",
- "EXTERNAL_FACEBOOK_ENABLED",
- "EXTERNAL_FACEBOOK_CLIENT_ID",
- "EXTERNAL_FACEBOOK_SECRET",
- "URI_ALLOW_LIST",
- "EXTERNAL_TWITTER_ENABLED",
- "EXTERNAL_TWITTER_CLIENT_ID",
- "EXTERNAL_TWITTER_SECRET",
- "EXTERNAL_APPLE_ENABLED",
- "EXTERNAL_APPLE_CLIENT_ID",
- "EXTERNAL_APPLE_SECRET",
- "EXTERNAL_DISCORD_ENABLED",
- "EXTERNAL_DISCORD_CLIENT_ID",
- "EXTERNAL_DISCORD_SECRET",
- "EXTERNAL_TWITCH_ENABLED",
- "EXTERNAL_TWITCH_CLIENT_ID",
- "EXTERNAL_TWITCH_SECRET",
- "SMTP_SENDER_NAME",
- "EXTERNAL_EMAIL_ENABLED",
- "EXTERNAL_PHONE_ENABLED",
- "SMS_AUTOCONFIRM",
- "SMS_MAX_FREQUENCY",
- "SMS_OTP_EXP",
- "SMS_OTP_LENGTH",
- "SMS_PROVIDER",
- "SMS_TWILIO_ACCOUNT_SID",
- "SMS_TWILIO_AUTH_TOKEN",
- "SMS_TWILIO_MESSAGE_SERVICE_SID",
- "SMS_TEMPLATE",
- "SECURITY_CAPTCHA_ENABLED",
- "SECURITY_CAPTCHA_PROVIDER",
- "SECURITY_CAPTCHA_SECRET",
- "RATE_LIMIT_EMAIL_SENT",
- "MAILER_SECURE_EMAIL_CHANGE_ENABLED",
- "EXTERNAL_SPOTIFY_ENABLED",
- "EXTERNAL_SPOTIFY_CLIENT_ID",
- "EXTERNAL_SPOTIFY_SECRET",
- "EXTERNAL_SLACK_ENABLED",
- "EXTERNAL_SLACK_CLIENT_ID",
- "EXTERNAL_SLACK_SECRET",
- "SMS_MESSAGEBIRD_ACCESS_KEY",
- "SMS_MESSAGEBIRD_ORIGINATOR",
- "SMTP_PASS_ENCRYPTED",
- "REFRESH_TOKEN_ROTATION_ENABLED",
- "EXTERNAL_LINKEDIN_ENABLED",
- "EXTERNAL_LINKEDIN_CLIENT_ID",
- "EXTERNAL_LINKEDIN_SECRET",
- "EXTERNAL_NOTION_ENABLED",
- "EXTERNAL_NOTION_CLIENT_ID",
- "EXTERNAL_NOTION_SECRET",
- "SMS_VONAGE_API_KEY",
- "SMS_VONAGE_API_SECRET",
- "SMS_VONAGE_FROM",
- "SMS_TEXTLOCAL_API_KEY",
- "SMS_TEXTLOCAL_SENDER",
- "EXTERNAL_ZOOM_ENABLED",
- "EXTERNAL_ZOOM_CLIENT_ID",
- "EXTERNAL_ZOOM_SECRET",
- "EXTERNAL_AZURE_URL",
- "PASSWORD_MIN_LENGTH",
- "EXTERNAL_KEYCLOAK_ENABLED",
- "EXTERNAL_KEYCLOAK_CLIENT_ID",
- "EXTERNAL_KEYCLOAK_SECRET",
- "EXTERNAL_KEYCLOAK_URL",
- "EXTERNAL_WORKOS_ENABLED",
- "EXTERNAL_WORKOS_CLIENT_ID",
- "EXTERNAL_WORKOS_SECRET",
- "EXTERNAL_WORKOS_URL",
- "SECURITY_UPDATE_PASSWORD_REQUIRE_REAUTHENTICATION",
- "SECURITY_REFRESH_TOKEN_REUSE_INTERVAL",
- "MAILER_OTP_EXP",
- "RATE_LIMIT_VERIFY",
- "RATE_LIMIT_TOKEN_REFRESH",
- "id",
- "project_id",
- "updated_at"
- ]
- },
- "UserBody": {
- "type": "object",
- "properties": {
- "id": { "type": "string" },
- "aud": { "type": "string" },
- "banned_until": { "type": "string" },
- "confirmation_sent_at": { "type": "string" },
- "confirmation_token": { "type": "string" },
- "confirmed_at": { "type": "string" },
- "created_at": { "type": "string" },
- "email": { "type": "string" },
- "email_change": { "type": "string" },
- "email_change_confirm_status": { "type": "number" },
- "email_change_sent_at": { "type": "string" },
- "email_change_token_current": { "type": "string" },
- "email_change_token_new": { "type": "string" },
- "email_confirmed_at": { "type": "string" },
- "encrypted_password": { "type": "string" },
- "instance_id": { "type": "string" },
- "invited_at": { "type": "string" },
- "is_super_admin": { "type": "boolean" },
- "last_sign_in_at": { "type": "string" },
- "phone": { "type": "string" },
- "phone_change": { "type": "string" },
- "phone_change_sent_at": { "type": "string" },
- "phone_change_token": { "type": "string" },
- "phone_confirmed_at": { "type": "string" },
- "raw_app_meta_data": { "type": "object" },
- "raw_user_meta_data": { "type": "object" },
- "reauthentication_sent_at": { "type": "string" },
- "reauthentication_token": { "type": "string" },
- "recovery_sent_at": { "type": "string" },
- "recovery_token": { "type": "string" },
- "role": { "type": "string" },
- "updated_at": { "type": "string" }
- },
- "required": [
- "id",
- "aud",
- "banned_until",
- "confirmation_sent_at",
- "confirmation_token",
- "confirmed_at",
- "created_at",
- "email",
- "email_change",
- "email_change_confirm_status",
- "email_change_sent_at",
- "email_change_token_current",
- "email_change_token_new",
- "email_confirmed_at",
- "encrypted_password",
- "instance_id",
- "invited_at",
- "is_super_admin",
- "last_sign_in_at",
- "phone",
- "phone_change",
- "phone_change_sent_at",
- "phone_change_token",
- "phone_confirmed_at",
- "raw_app_meta_data",
- "raw_user_meta_data",
- "reauthentication_sent_at",
- "reauthentication_token",
- "recovery_sent_at",
- "recovery_token",
- "role",
- "updated_at"
- ]
- },
- "Backup": {
- "type": "object",
- "properties": {
- "id": { "type": "number" },
- "data": { "type": "object" },
- "project_id": { "type": "number" },
- "status": { "type": "object" },
- "s3_path": { "type": "string" },
- "s3_bucket": { "type": "string" },
- "inserted_at": { "type": "string" }
- },
- "required": ["id", "data", "project_id", "status", "s3_path", "s3_bucket", "inserted_at"]
- },
- "BackupsResponse": {
- "type": "object",
- "properties": {
- "tierId": { "type": "string" },
- "tierKey": { "type": "string" },
+ "organization_id": { "type": "string" },
+ "name": { "type": "string" },
"region": { "type": "string" },
- "walg_enabled": { "type": "boolean" },
- "backups": {
- "type": "array",
- "items": { "$ref": "#/components/schemas/Backup" }
- },
- "physicalBackupData": {
- "type": "object",
- "properties": {
- "earliestPhysicalBackupDateUnix": {
- "required": true,
- "type": "number"
- },
- "latestPhysicalBackupDateUnix": {
- "required": true,
- "type": "number"
- }
- }
- }
+ "created_at": { "type": "string" }
},
- "required": ["tierId", "tierKey", "region", "walg_enabled", "backups", "physicalBackupData"]
- },
- "DownloadBackupBody": {
- "type": "object",
- "properties": {
- "id": { "type": "number" },
- "data": { "type": "object" },
- "inserted_at": { "type": "string" },
- "project_id": { "type": "number" },
- "s3_bucket": { "type": "string" },
- "s3_path": { "type": "string" },
- "status": { "type": "string" }
- },
- "required": ["id", "data", "inserted_at", "project_id", "s3_bucket", "s3_path", "status"]
- },
- "DownloadBackupResponse": {
- "type": "object",
- "properties": { "fileUrl": { "type": "string" } },
- "required": ["fileUrl"]
- },
- "RestoreBackupBody": {
- "type": "object",
- "properties": {
- "id": { "type": "number" },
- "data": { "type": "object" },
- "inserted_at": { "type": "string" },
- "project_id": { "type": "number" },
- "s3_bucket": { "type": "string" },
- "s3_path": { "type": "string" },
- "status": { "type": "string" }
- },
- "required": ["id", "data", "inserted_at", "project_id", "s3_bucket", "s3_path", "status"]
- },
- "PointInTimeRestoreBody": {
- "type": "object",
- "properties": { "recovery_time_target_unix": { "type": "number" } },
- "required": ["recovery_time_target_unix"]
- },
- "Organization": {
- "type": "object",
- "properties": {
- "id": { "type": "number" },
- "slug": { "type": "string" },
- "name": { "type": "string" },
- "billing_email": { "type": "string" },
- "stripe_customer_id": { "type": "string" }
- },
- "required": ["id", "slug", "name", "billing_email", "stripe_customer_id"]
- },
- "CreateOrganizationBody": {
- "type": "object",
- "properties": { "name": { "type": "string" } },
- "required": ["name"]
- },
- "UpdateOrganizationBody": {
- "type": "object",
- "properties": {
- "name": { "type": "string" },
- "billing_email": { "type": "string" }
- },
- "required": ["name", "billing_email"]
- },
- "RemovedOrganization": {
- "type": "object",
- "properties": {
- "id": { "type": "number" },
- "slug": { "type": "string" },
- "name": { "type": "string" },
- "billing_email": { "type": "string" },
- "stripe_customer_id": { "type": "string" },
- "status": { "type": "string", "enum": ["ACTIVE", "REMOVED"] }
- },
- "required": ["id", "slug", "name", "billing_email", "stripe_customer_id", "status"]
- },
- "Member": {
- "type": "object",
- "properties": {
- "gotrue_id": { "type": "string" },
- "primary_email": { "type": "string" },
- "role_ids": { "type": "array", "items": { "type": "number" } },
- "username": { "type": "string" }
- },
- "required": ["gotrue_id", "primary_email", "role_ids", "username"]
- },
- "AddMemberBody": {
- "type": "object",
- "properties": {
- "gotrue_id": { "type": "string" },
- "org_id": { "type": "number" },
- "user_id": { "type": "number" }
- },
- "required": ["gotrue_id", "user_id"]
- },
- "RemoveMemberBody": {
- "type": "object",
- "properties": { "member_id": { "type": "number" } },
- "required": ["member_id"]
- },
- "CreateTaxIdBody": {
- "type": "object",
- "properties": {
- "type": { "type": "object" },
- "value": { "type": "string" }
- },
- "required": ["type", "value"]
- },
- "DeleteTaxIdBody": {
- "type": "object",
- "properties": { "id": { "type": "string" } },
- "required": ["id"]
- },
- "TransferOrganizationBody": {
- "type": "object",
- "properties": {
- "member_id": { "type": "number" },
- "org_id": { "type": "number" }
- },
- "required": ["member_id", "org_id"]
- },
- "InviteUserBody": {
- "type": "object",
- "properties": {
- "invited_email": { "type": "string" },
- "owner_id": { "type": "number" }
- },
- "required": ["invited_email", "owner_id"]
- },
- "DetachPaymentMethodBody": {
- "type": "object",
- "properties": { "card_id": { "type": "string" } },
- "required": ["card_id"]
- },
- "CreateColumnBody": {
- "type": "object",
- "properties": {
- "tableId": { "type": "number" },
- "name": { "type": "string" },
- "type": { "type": "string" },
- "check": { "type": "string" },
- "comment": { "type": "string" },
- "defaultValue": { "type": "object" },
- "defaultValueFormat": {
- "type": "string",
- "enum": ["expression", "literal"]
- },
- "identityGeneration": {
- "type": "string",
- "enum": ["BY DEFAULT", "ALWAYS"]
- },
- "isIdentity": { "type": "boolean" },
- "isNullable": { "type": "boolean" },
- "isPrimaryKey": { "type": "boolean" },
- "isUnique": { "type": "boolean" }
- },
- "required": ["tableId", "name", "type"]
- },
- "UpdateColumnBody": {
- "type": "object",
- "properties": {
- "dropDefault": { "type": "boolean" },
- "id": { "type": "number", "pattern": {} },
- "name": { "type": "string" },
- "comment": { "type": "string" },
- "type": { "type": "string" },
- "defaultValue": { "type": "object" },
- "defaultValueFormat": {
- "type": "string",
- "enum": ["expression", "literal"]
- },
- "identityGeneration": {
- "type": "string",
- "enum": ["BY DEFAULT", "ALWAYS"]
- },
- "isIdentity": { "type": "boolean" },
- "isNullable": { "type": "boolean" },
- "isUnique": { "type": "boolean" }
- }
- },
- "CreateExtensionBody": {
- "type": "object",
- "properties": {
- "cascade": { "type": "boolean" },
- "name": { "type": "string" },
- "schema": { "type": "string" },
- "version": { "type": "string" }
- },
- "required": ["cascade", "name", "schema", "version"]
- },
- "CreateFunctionBody": {
- "type": "object",
- "properties": {
- "args": { "type": "array", "items": { "type": "string" } },
- "behavior": {
- "type": "string",
- "enum": ["VOLATILE", "STABLE", "IMMUTABLE"]
- },
- "config_params": { "type": "object" },
- "definition": { "type": "string" },
- "language": { "type": "string" },
- "name": { "type": "string" },
- "return_type": { "type": "string" },
- "schema": { "type": "string" },
- "security_definer": { "type": "boolean" }
- },
- "required": [
- "args",
- "behavior",
- "definition",
- "language",
- "name",
- "return_type",
- "schema",
- "security_definer"
- ]
- },
- "UpdateFunctionBody": {
- "type": "object",
- "properties": {
- "id": { "type": "number" },
- "args": { "type": "array", "items": { "type": "string" } },
- "behavior": {
- "type": "string",
- "enum": ["VOLATILE", "STABLE", "IMMUTABLE"]
- },
- "config_params": { "type": "object" },
- "definition": { "type": "string" },
- "language": { "type": "string" },
- "name": { "type": "string" },
- "return_type": { "type": "string" },
- "schema": { "type": "string" },
- "security_definer": { "type": "boolean" }
- }
- },
- "CreatePolicyBody": {
- "type": "object",
- "properties": {
- "name": { "type": "string" },
- "table": { "type": "string" },
- "schema": { "type": "string" },
- "definition": { "type": "string" },
- "check": { "type": "string" },
- "action": { "type": "string", "enum": ["PERMISSIVE", "RESTRICTIVE"] },
- "command": {
- "type": "string",
- "enum": ["SELECT", "INSERT", "UPDATE", "DELETE", "ALL"]
- },
- "roles": { "type": "array", "items": { "type": "string" } }
- },
- "required": ["name", "table"]
- },
- "UpdatePolicyBody": {
- "type": "object",
- "properties": {
- "id": { "type": "number" },
- "name": { "type": "string" },
- "definition": { "type": "string" },
- "check": { "type": "string" },
- "roles": { "type": "array", "items": { "type": "string" } }
- }
- },
- "CreatePublicationBody": {
- "type": "object",
- "properties": {
- "name": { "type": "string" },
- "owner": { "type": "string" },
- "tables": { "type": "array", "items": { "type": "string" } },
- "publish_insert": { "type": "boolean" },
- "publish_update": { "type": "boolean" },
- "publish_delete": { "type": "boolean" },
- "publish_truncate": { "type": "boolean" }
- },
- "required": [
- "name",
- "owner",
- "tables",
- "publish_insert",
- "publish_update",
- "publish_delete",
- "publish_truncate"
- ]
- },
- "UpdatePublicationBody": {
- "type": "object",
- "properties": {
- "id": { "type": "number" },
- "name": { "type": "string" },
- "tables": { "type": "array", "items": { "type": "string" } },
- "publish_insert": { "type": "boolean" },
- "publish_update": { "type": "boolean" },
- "publish_delete": { "type": "boolean" },
- "publish_truncate": { "type": "boolean" }
- }
- },
- "RunQueryBody": {
- "type": "object",
- "properties": { "query": { "type": "string" } },
- "required": ["query"]
- },
- "FormatQueryBody": {
- "type": "object",
- "properties": { "query": { "type": "string" } },
- "required": ["query"]
- },
- "ValidateQueryBody": {
- "type": "object",
- "properties": { "query": { "type": "string" } },
- "required": ["query"]
- },
- "SearchTableBody": {
- "type": "object",
- "properties": {
- "name": { "type": "string" },
- "schema": { "type": "string" }
- },
- "required": ["name", "schema"]
- },
- "SearchColumnBody": {
- "type": "object",
- "properties": {
- "name": { "type": "string" },
- "schema": { "type": "string" }
- },
- "required": ["name", "schema"]
- },
- "CreateSchemaBody": {
- "type": "object",
- "properties": {
- "name": { "type": "string" },
- "owner": { "type": "string" }
- },
- "required": ["name", "owner"]
- },
- "UpdateSchemaBody": {
- "type": "object",
- "properties": {
- "name": { "type": "string" },
- "owner": { "type": "string" }
- }
- },
- "CreateTableBody": {
- "type": "object",
- "properties": {
- "name": { "type": "string" },
- "schema": { "type": "string" },
- "comment": { "type": "string" }
- },
- "required": ["name"]
- },
- "UpdateTableBody": {
- "type": "object",
- "properties": {
- "id": { "type": "number" },
- "rls_enabled": { "type": "boolean" },
- "rls_forced": { "type": "boolean" },
- "replica_identity": {
- "type": "string",
- "enum": ["DEFAULT", "INDEX", "FULL", "NOTHING"]
- },
- "replica_identity_index": { "type": "string" },
- "name": { "type": "string" },
- "schema": { "type": "string" },
- "comment": { "type": "string" }
- }
- },
- "CreateTriggerBody": {
- "type": "object",
- "properties": {
- "activation": { "type": "string", "enum": ["AFTER", "BEFORE"] },
- "enabled_mode": {
- "type": "string",
- "enum": ["ORIGIN", "REPLICA", "ALWAYS", "DISABLED"]
- },
- "events": {
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["INSERT", "UPDATE", "DELETE"]
- }
- },
- "function_args": { "type": "array", "items": { "type": "string" } },
- "function_name": { "type": "string" },
- "function_schema": { "type": "string" },
- "name": { "type": "string" },
- "orientation": { "type": "string", "enum": ["ROW", "STATEMENT"] },
- "schema": { "type": "string" },
- "table": { "type": "string" },
- "table_id": { "type": "number" }
- },
- "required": [
- "activation",
- "enabled_mode",
- "events",
- "function_args",
- "function_name",
- "function_schema",
- "name",
- "orientation",
- "schema",
- "table"
- ]
- },
- "UpdateTriggerBody": {
- "type": "object",
- "properties": {
- "id": { "type": "number" },
- "activation": { "type": "string", "enum": ["AFTER", "BEFORE"] },
- "enabled_mode": {
- "type": "string",
- "enum": ["ORIGIN", "REPLICA", "ALWAYS", "DISABLED"]
- },
- "events": {
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["INSERT", "UPDATE", "DELETE"]
- }
- },
- "function_args": { "type": "array", "items": { "type": "string" } },
- "function_name": { "type": "string" },
- "function_schema": { "type": "string" },
- "name": { "type": "string" },
- "orientation": { "type": "string", "enum": ["ROW", "STATEMENT"] },
- "schema": { "type": "string" },
- "table": { "type": "string" },
- "table_id": { "type": "number" }
- }
- },
- "AccessToken": {
- "type": "object",
- "properties": {
- "created_at": { "type": "string" },
- "id": { "type": "number" },
- "token_alias": { "type": "string" },
- "name": { "type": "string" }
- },
- "required": ["created_at", "id", "token_alias", "name"]
- },
- "CreateAccessTokenBody": {
- "type": "object",
- "properties": { "name": { "type": "string" } },
- "required": ["name"]
- },
- "CreateAccessTokenResponse": {
- "type": "object",
- "properties": {
- "created_at": { "type": "string" },
- "id": { "type": "number" },
- "token_alias": { "type": "string" },
- "name": { "type": "string" },
- "token": { "type": "string" }
- },
- "required": ["created_at", "id", "token_alias", "name", "token"]
- },
- "SearchProfileBody": {
- "type": "object",
- "properties": { "keywords": { "type": "string" } },
- "required": ["keywords"]
- },
- "Profile": {
- "type": "object",
- "properties": {
- "first_name": { "type": "string" },
- "gotrue_id": { "type": "string" },
- "id": { "type": "number" },
- "last_name": { "type": "string" },
- "username": { "type": "string" }
- },
- "required": ["first_name", "gotrue_id", "id", "last_name", "username"]
- },
- "SubscriptionStatisticsResponse": {
- "type": "object",
- "properties": {
- "total_paid_projects": { "type": "number" },
- "total_free_projects": { "type": "number" },
- "total_active_free_projects": { "type": "number" },
- "total_paused_free_projects": { "type": "number" },
- "total_pro_projects": { "type": "number" },
- "total_payg_projects": { "type": "number" },
- "total_enterprise_projects": { "type": "number" }
- },
- "required": [
- "total_paid_projects",
- "total_free_projects",
- "total_active_free_projects",
- "total_paused_free_projects",
- "total_pro_projects",
- "total_payg_projects",
- "total_enterprise_projects"
- ]
- },
- "PasswordCheckBody": {
- "type": "object",
- "properties": { "password": { "type": "string" } },
- "required": ["password"]
- },
- "PasswordCheckResponse": {
- "type": "object",
- "properties": {
- "result": {
- "type": "object",
- "properties": {
- "feedback": {
- "type": "object",
- "properties": {
- "warning": { "required": true, "type": "string" },
- "suggestions": {
- "required": true,
- "type": "array",
- "items": { "type": "string" }
- }
- }
- },
- "score": { "required": true, "type": "number" }
- }
- }
- },
- "required": ["result"]
- },
- "Permission": {
- "type": "object",
- "properties": {
- "actions": {
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "analytics:Read",
- "auth:Execute",
- "billing:Read",
- "billing:Write",
- "functions:Read",
- "functions:Write",
- "infra:Execute",
- "sql:Read:Select",
- "sql:Write:Delete",
- "sql:Write:Insert",
- "sql:Write:Update",
- "storage:Admin:Read",
- "storage:Admin:Write",
- "tenant:Sql:Admin:Read",
- "tenant:Sql:Admin:Write",
- "tenant:Sql:CreateTable",
- "tenant:Sql:Write:Delete",
- "tenant:Sql:Write:Insert",
- "tenant:Sql:Query",
- "tenant:Sql:Read:Select",
- "tenant:Sql:Write:Update"
- ]
- }
- },
- "condition": { "type": "object", "nullable": true },
- "organization_id": { "type": "number" },
- "resources": { "type": "array", "items": { "type": "string" } }
- },
- "required": ["actions", "condition", "organization_id", "resources"]
- },
- "ProfileResponse": {
- "type": "object",
- "properties": {
- "id": { "type": "number" },
- "auth0_id": { "type": "string" },
- "primary_email": { "type": "string" },
- "username": { "type": "string" },
- "first_name": { "type": "string" },
- "last_name": { "type": "string" },
- "mobile": { "type": "string" },
- "is_alpha_user": { "type": "boolean" },
- "gotrue_id": { "type": "string" },
- "free_project_limit": { "type": "number" }
- },
- "required": [
- "id",
- "auth0_id",
- "primary_email",
- "username",
- "first_name",
- "last_name",
- "mobile",
- "is_alpha_user",
- "gotrue_id",
- "free_project_limit"
- ]
- },
- "UpdateProfileBody": {
- "type": "object",
- "properties": {
- "first_name": { "type": "string" },
- "last_name": { "type": "string" }
- },
- "required": ["first_name", "last_name"]
+ "required": ["id", "organization_id", "name", "region", "created_at"]
},
"CreateProjectBody": {
"type": "object",
@@ -1679,459 +390,75 @@
},
"required": ["db_pass", "name", "organization_id", "plan", "region"]
},
- "UpdatePasswordBody": {
+ "OrganizationResponse": {
"type": "object",
- "properties": { "password": { "type": "string" } },
- "required": ["password"]
+ "properties": { "id": { "type": "string" }, "name": { "type": "string" } },
+ "required": ["id", "name"]
},
- "PoolingConfig": {
- "type": "object",
- "properties": {
- "db_dns_name": { "type": "string" },
- "db_host": { "type": "string" },
- "db_name": { "type": "string" },
- "db_port": { "type": "number" },
- "db_ssl": { "type": "boolean" },
- "db_user": { "type": "string" },
- "default_pool_size": { "type": "number" },
- "ignore_startup_parameters": { "type": "string" },
- "inserted_at": { "type": "string" },
- "pgbouncer_enabled": { "type": "boolean" },
- "pgbouncer_status": { "type": "string" },
- "pool_mode": { "type": "string" }
- },
- "required": [
- "db_dns_name",
- "db_host",
- "db_name",
- "db_port",
- "db_ssl",
- "db_user",
- "default_pool_size",
- "ignore_startup_parameters",
- "inserted_at",
- "pgbouncer_enabled",
- "pgbouncer_status",
- "pool_mode"
- ]
- },
- "UpdatePoolingConfigBody": {
- "type": "object",
- "properties": {
- "default_pool_size": { "type": "number" },
- "ignore_startup_parameters": { "type": "string" },
- "pgbouncer_enabled": { "type": "boolean" },
- "pool_mode": {
- "type": "string",
- "enum": ["transaction", "session", "statement"]
- }
- },
- "required": [
- "default_pool_size",
- "ignore_startup_parameters",
- "pgbouncer_enabled",
- "pool_mode"
- ]
- },
- "UpdatePoolingConfigResponse": {
- "type": "object",
- "properties": {
- "default_pool_size": { "type": "number" },
- "ignore_startup_parameters": { "type": "string" },
- "pgbouncer_enabled": { "type": "boolean" },
- "pool_mode": {
- "enum": ["transaction", "session", "statement"],
- "type": "string"
- }
- },
- "required": [
- "default_pool_size",
- "ignore_startup_parameters",
- "pgbouncer_enabled",
- "pool_mode"
- ]
- },
- "UpdateProjectBody": {
+ "CreateOrganizationBody": {
"type": "object",
"properties": { "name": { "type": "string" } },
"required": ["name"]
},
- "Project": { "type": "object", "properties": {} },
- "RestartRequest": {
- "type": "object",
- "properties": {
- "services": { "type": "array", "items": { "type": "string" } },
- "source_notification_id": { "type": "string" },
- "region": { "type": "string" }
- },
- "required": ["services", "region"]
- },
- "RestartServicesBody": {
- "type": "object",
- "properties": {
- "restartRequest": { "$ref": "#/components/schemas/RestartRequest" }
- },
- "required": ["restartRequest"]
- },
- "UsageStatusResponse": {
- "type": "object",
- "properties": {
- "database": {
- "type": "string",
- "enum": ["fine", "approaching", "over"]
- },
- "storage": {
- "type": "string",
- "enum": ["fine", "approaching", "over"]
- },
- "database_bandwidth": {
- "type": "string",
- "enum": ["fine", "approaching", "over"]
- },
- "storage_bandwidth": {
- "type": "string",
- "enum": ["fine", "approaching", "over"]
- },
- "active_users": {
- "type": "string",
- "enum": ["fine", "approaching", "over"]
- }
- },
- "required": [
- "database",
- "storage",
- "database_bandwidth",
- "storage_bandwidth",
- "active_users"
- ]
- },
- "SendEnterpriseRequestBody": {
- "type": "object",
- "properties": {
- "company": { "type": "string" },
- "email": { "type": "string" },
- "message": { "type": "string" },
- "name": { "type": "string" }
- },
- "required": ["company", "email", "message", "name"]
- },
- "PreviewSubscriptionBody": {
- "type": "object",
- "properties": {
- "addons": { "type": "array", "items": { "type": "string" } },
- "payment_method": { "type": "string" },
- "proration_date": { "type": "number" },
- "tier": { "type": "string" }
- },
- "required": ["addons", "payment_method", "proration_date", "tier"]
- },
- "UpdateSubscriptionBody": {
- "type": "object",
- "properties": {
- "addons": { "type": "array", "items": { "type": "string" } },
- "payment_method": { "type": "string" },
- "proration_date": { "type": "number" },
- "tier": { "type": "string" }
- },
- "required": ["addons", "payment_method", "proration_date", "tier"]
- },
- "UpdatePostgrestConfigBody": {
- "type": "object",
- "properties": {
- "db_extra_search_path": { "type": "string" },
- "db_schema": { "type": "string" },
- "max_rows": { "type": "number" }
- },
- "required": ["db_extra_search_path", "db_schema", "max_rows"]
- },
- "UpdateSecretsConfigBody": {
- "type": "object",
- "properties": {
- "jwt_secret": { "type": "string" },
- "change_tracking_id": { "type": "string" }
- },
- "required": ["jwt_secret", "change_tracking_id"]
- },
- "UpdateStorageConfigBody": {
- "type": "object",
- "properties": { "fileSizeLimit": { "type": "number" } },
- "required": ["fileSizeLimit"]
- },
- "OrganizationMembersResponse": {
- "type": "object",
- "properties": {
- "members": {
- "type": "array",
- "items": { "$ref": "#/components/schemas/Member" }
- }
- },
- "required": ["members"]
- },
- "PoolingRefConfig": {
- "type": "object",
- "properties": {
- "db_dns_name": { "type": "string" },
- "db_host": { "type": "string" },
- "db_name": { "type": "string" },
- "db_port": { "type": "number" },
- "db_ssl": { "type": "boolean" },
- "db_user": { "type": "string" },
- "default_pool_size": { "type": "number" },
- "ignore_startup_parameters": { "type": "string" },
- "inserted_at": { "type": "string" },
- "pgbouncer_enabled": { "type": "boolean" },
- "pgbouncer_status": { "type": "string" },
- "pool_mode": { "type": "string" }
- },
- "required": [
- "db_dns_name",
- "db_host",
- "db_name",
- "db_port",
- "db_ssl",
- "db_user",
- "default_pool_size",
- "ignore_startup_parameters",
- "inserted_at",
- "pgbouncer_enabled",
- "pgbouncer_status",
- "pool_mode"
- ]
- },
- "PoolingRefConfigResponse": {
- "type": "object",
- "properties": {
- "project": { "$ref": "#/components/schemas/PoolingRefConfig" }
- },
- "required": ["project"]
- },
- "UpdatePoolingRefConfigBody": {
- "type": "object",
- "properties": {
- "default_pool_size": { "type": "number" },
- "ignore_startup_parameters": { "type": "string" },
- "pgbouncer_enabled": { "type": "boolean" },
- "pool_mode": {
- "type": "string",
- "enum": ["transaction", "session", "statement"]
- }
- },
- "required": [
- "default_pool_size",
- "ignore_startup_parameters",
- "pgbouncer_enabled",
- "pool_mode"
- ]
- },
- "UpdatePoolingRefConfigResponse": {
- "type": "object",
- "properties": {
- "project": {
- "$ref": "#/components/schemas/UpdatePoolingRefConfigBody"
- }
- },
- "required": ["project"]
- },
- "ServiceApiKey": {
- "type": "object",
- "properties": {
- "api_key_encrypted": { "type": "string" },
- "tags": { "type": "string" },
- "name": { "type": "string" }
- },
- "required": ["api_key_encrypted", "tags", "name"]
- },
- "AutoApiService": {
- "type": "object",
- "properties": {
- "endpoint": { "type": "string" },
- "restUrl": { "type": "string" },
- "project": {
- "type": "object",
- "properties": { "ref": { "required": true, "type": "string" } }
- },
- "defaultApiKey": { "type": "string" },
- "serviceApiKey": { "type": "string" },
- "id": { "type": "number" },
- "name": { "type": "string" },
- "app_config": { "type": "object" },
- "app": {
- "type": "object",
- "properties": {
- "id": { "required": true, "type": "number" },
- "name": { "required": true, "type": "string" }
- }
- },
- "service_api_keys": {
- "type": "array",
- "items": { "$ref": "#/components/schemas/ServiceApiKey" }
- }
- },
- "required": [
- "endpoint",
- "restUrl",
- "project",
- "defaultApiKey",
- "serviceApiKey",
- "id",
- "name",
- "app_config",
- "app",
- "service_api_keys"
- ]
- },
- "ApiResponse": {
- "type": "object",
- "properties": {
- "project": { "$ref": "#/components/schemas/Project" },
- "autoApiService": { "$ref": "#/components/schemas/AutoApiService" }
- },
- "required": ["project", "autoApiService"]
- },
- "JwtSecretUpdateStatus": {
- "type": "object",
- "properties": {
- "jwtSecretUpdateStatus": {
- "type": "object",
- "properties": {
- "change_tracking_id": { "required": true, "type": "string" },
- "error": {
- "required": false,
- "enum": [
- "PostgreSQLRestartFailed",
- "APIServicesConfigurationUpdateFailed",
- "APIServicesRestartFailed",
- "DatabaseAdminAPIConfigurationUpdateFailed",
- "SupabaseAPIKeyUpdateFailed",
- "APIGatewayUpdateFailed"
- ],
- "type": "string"
- },
- "progress": {
- "required": false,
- "enum": [
- "Started",
- "RestartedPostgreSQL",
- "UpdatedAPIServicesConfiguration",
- "RestartedAPIServices",
- "UpdatedDatabaseAdminAPIConfiguration",
- "UpdatedAPIGatewayConfiguration"
- ],
- "type": "string"
- },
- "status": {
- "required": true,
- "enum": ["Updating", "Updated", "Failed"],
- "type": "string"
- }
- }
- }
- },
- "required": ["jwtSecretUpdateStatus"]
- },
- "ServiceApiKeyResponse": {
- "type": "object",
- "properties": {
- "api_key": { "type": "string" },
- "api_key_encrypted": { "type": "string" },
- "tags": { "type": "string" },
- "name": { "type": "string" }
- },
- "required": ["api_key", "api_key_encrypted", "tags", "name"]
- },
- "ServiceResponse": {
- "type": "object",
- "properties": {
- "service_api_keys": {
- "type": "array",
- "items": { "$ref": "#/components/schemas/ServiceApiKeyResponse" }
- },
- "id": { "type": "number" },
- "name": { "type": "string" },
- "app_config": { "type": "object" },
- "app": {
- "type": "object",
- "properties": {
- "id": { "required": true, "type": "number" },
- "name": { "required": true, "type": "string" }
- }
- }
- },
- "required": ["service_api_keys", "id", "name", "app_config", "app"]
- },
- "ProjectResponse": {
+ "FunctionResponse": {
"type": "object",
"properties": {
"id": { "type": "string" },
- "organization_id": { "type": "string" },
+ "slug": { "type": "string" },
"name": { "type": "string" },
- "region": { "type": "string" },
- "created_at": { "type": "string" }
+ "status": { "enum": ["ACTIVE", "REMOVED", "THROTTLED"], "type": "string" },
+ "version": { "type": "number" },
+ "created_at": { "type": "number" },
+ "updated_at": { "type": "number" },
+ "verify_jwt": { "type": "boolean" }
},
- "required": ["id", "organization_id", "name", "region", "created_at"]
+ "required": ["id", "slug", "name", "status", "version", "created_at", "updated_at"]
},
- "SettingsResponse": {
+ "CreateFunctionBody": {
"type": "object",
"properties": {
- "project": { "$ref": "#/components/schemas/ProjectResponse" },
- "services": {
- "type": "array",
- "items": { "$ref": "#/components/schemas/ServiceResponse" }
- }
+ "slug": { "type": "string", "pattern": {} },
+ "name": { "type": "string" },
+ "body": { "type": "string" },
+ "verify_jwt": { "type": "boolean" }
},
- "required": ["project", "services"]
+ "required": ["slug", "name", "body"]
},
- "GetCustomerBody": {
- "type": "object",
- "properties": { "stripe_customer_id": { "type": "string" } },
- "required": ["stripe_customer_id"]
- },
- "CreateCustomerPortalSessionBody": {
- "type": "object",
- "properties": {
- "projectRef": { "type": "string", "minLength": 20, "maxLength": 20 },
- "returnTo": { "type": "string" }
- },
- "required": ["projectRef", "returnTo"]
- },
- "TelemetryEventBody": {
- "type": "object",
- "properties": {
- "category": { "type": "string" },
- "action": { "type": "string" },
- "label": { "type": "object" },
- "value": { "type": "string" }
- },
- "required": ["category", "action"]
- },
- "CreateVercelEnvironmentVariableBody": {
- "type": "object",
- "properties": {
- "key": { "type": "string" },
- "target": { "type": "array", "items": { "type": "string" } },
- "type": { "type": "string" },
- "value": { "type": "string" }
- },
- "required": ["key", "target", "type", "value"]
- },
- "CreateSubscriptionBody": {
- "type": "object",
- "properties": { "projectId": { "type": "number" } },
- "required": ["projectId"]
- },
- "StripeSyncBody": {
- "type": "object",
- "properties": { "organizationId": { "type": "number" } },
- "required": ["organizationId"]
- },
- "Buffer": { "type": "object", "properties": {} },
- "OrganizationResponse": {
+ "FunctionSlugResponse": {
"type": "object",
"properties": {
"id": { "type": "string" },
- "name": { "type": "string" }
+ "slug": { "type": "string" },
+ "name": { "type": "string" },
+ "status": { "enum": ["ACTIVE", "REMOVED", "THROTTLED"], "type": "string" },
+ "version": { "type": "number" },
+ "created_at": { "type": "number" },
+ "updated_at": { "type": "number" },
+ "verify_jwt": { "type": "boolean" },
+ "body": { "type": "string" }
},
- "required": ["id", "name"]
+ "required": ["id", "slug", "name", "status", "version", "created_at", "updated_at"]
+ },
+ "UpdateFunctionBody": {
+ "type": "object",
+ "properties": {
+ "name": { "type": "string" },
+ "body": { "type": "string" },
+ "verify_jwt": { "type": "boolean" }
+ }
+ },
+ "SecretResponse": {
+ "type": "object",
+ "properties": { "name": { "type": "string" }, "value": { "type": "string" } },
+ "required": ["name", "value"]
+ },
+ "CreateSecretBody": {
+ "type": "object",
+ "properties": {
+ "name": { "type": "string" },
+ "value": { "type": "string", "pattern": {} }
+ },
+ "required": ["name", "value"]
}
}
}
diff --git a/spec/api_v0_openapi/deparsed.json b/spec/api_v0_openapi/deparsed.json
index b0f7d8bb97b..fc710024891 100644
--- a/spec/api_v0_openapi/deparsed.json
+++ b/spec/api_v0_openapi/deparsed.json
@@ -1,116 +1,11 @@
{
"openapi": "3.0.0",
"paths": {
- "/v1/organizations": {
- "get": {
- "operationId": "OrganizationsController_getOrganizations",
- "summary": "Lists all organizations",
- "parameters": [
- {
- "name": "owned_only",
- "required": true,
- "in": "query",
- "description": "Only list organizations you own",
- "schema": {}
- }
- ],
- "responses": {
- "200": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- }
- },
- "required": [
- "id",
- "name"
- ]
- }
- }
- }
- }
- },
- "500": {
- "description": "Unexpected error listing organizations"
- }
- },
- "security": [
- {
- "bearer": []
- }
- ]
- },
- "post": {
- "operationId": "OrganizationsController_createOrganization_",
- "summary": "Creates an organization",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- }
- },
- "required": [
- "name"
- ]
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- }
- },
- "required": [
- "id",
- "name"
- ]
- }
- }
- }
- },
- "500": {
- "description": "Unexpected error creating an organization"
- }
- },
- "security": [
- {
- "bearer": []
- }
- ]
- }
- },
"/v1/projects": {
"get": {
- "operationId": "ProjectsController_getProjects",
- "summary": "Gets all projects that belong to the authenticated user",
- "description": "Only returns the minimal project info",
+ "operationId": "getProjects",
+ "summary": "List all projects",
+ "description": "Returns a list of all projects you've previously created.",
"parameters": [],
"responses": {
"200": {
@@ -158,8 +53,8 @@
]
},
"post": {
- "operationId": "ProjectsController_createProject",
- "summary": "Creates a project",
+ "operationId": "createProject",
+ "summary": "Create a project",
"parameters": [],
"requestBody": {
"required": true,
@@ -214,7 +109,7 @@
}
},
"responses": {
- "200": {
+ "201": {
"description": "",
"content": {
"application/json": {
@@ -255,10 +150,713 @@
}
]
}
+ },
+ "/v1/organizations": {
+ "get": {
+ "operationId": "getOrganizations",
+ "summary": "List all organizations",
+ "description": "Returns a list of organizations that you currently belong to.",
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Unexpected error listing organizations"
+ }
+ },
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ },
+ "post": {
+ "operationId": "createOrganization_",
+ "summary": "Create an organization",
+ "parameters": [],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ]
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Unexpected error creating an organization"
+ }
+ },
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ }
+ },
+ "/v1/projects/{ref}/functions": {
+ "get": {
+ "operationId": "getFunctions",
+ "summary": "List all functions",
+ "description": "Returns all functions you've previously added to the specified project.",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": {
+ "minLength": 20,
+ "maxLength": 20,
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "ACTIVE",
+ "REMOVED",
+ "THROTTLED"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "type": "number"
+ },
+ "created_at": {
+ "type": "number"
+ },
+ "updated_at": {
+ "type": "number"
+ },
+ "verify_jwt": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "slug",
+ "name",
+ "status",
+ "version",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Failed to retrieve project's functions"
+ }
+ },
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ },
+ "post": {
+ "operationId": "createFunction",
+ "summary": "Create a function",
+ "description": "Creates a function and adds it to the specified project.",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": {
+ "minLength": 20,
+ "maxLength": 20,
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "slug": {
+ "type": "string",
+ "pattern": {}
+ },
+ "name": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string"
+ },
+ "verify_jwt": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "slug",
+ "name",
+ "body"
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "ACTIVE",
+ "REMOVED",
+ "THROTTLED"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "type": "number"
+ },
+ "created_at": {
+ "type": "number"
+ },
+ "updated_at": {
+ "type": "number"
+ },
+ "verify_jwt": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "slug",
+ "name",
+ "status",
+ "version",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Failed to create project's function"
+ }
+ },
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ }
+ },
+ "/v1/projects/{ref}/functions/{function_slug}": {
+ "get": {
+ "operationId": "getFunction",
+ "summary": "Retrieve a function",
+ "description": "Retrieves a function with the specified slug and project.",
+ "parameters": [
+ {
+ "name": "include_body",
+ "required": false,
+ "in": "query",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": {
+ "minLength": 20,
+ "maxLength": 20,
+ "type": "string"
+ }
+ },
+ {
+ "name": "function_slug",
+ "required": true,
+ "in": "path",
+ "description": "Function slug",
+ "schema": {
+ "pattern": {},
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "ACTIVE",
+ "REMOVED",
+ "THROTTLED"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "type": "number"
+ },
+ "created_at": {
+ "type": "number"
+ },
+ "updated_at": {
+ "type": "number"
+ },
+ "verify_jwt": {
+ "type": "boolean"
+ },
+ "body": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "slug",
+ "name",
+ "status",
+ "version",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Failed to retrieve function with given slug"
+ }
+ },
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ },
+ "patch": {
+ "operationId": "UpdateFunction",
+ "summary": "Update a function",
+ "description": "Updates a function with the specified slug and project.",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": {
+ "minLength": 20,
+ "maxLength": 20,
+ "type": "string"
+ }
+ },
+ {
+ "name": "function_slug",
+ "required": true,
+ "in": "path",
+ "description": "Function slug",
+ "schema": {
+ "pattern": {},
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string"
+ },
+ "verify_jwt": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "ACTIVE",
+ "REMOVED",
+ "THROTTLED"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "type": "number"
+ },
+ "created_at": {
+ "type": "number"
+ },
+ "updated_at": {
+ "type": "number"
+ },
+ "verify_jwt": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "slug",
+ "name",
+ "status",
+ "version",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Failed to update function with given slug"
+ }
+ },
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ },
+ "delete": {
+ "operationId": "deleteFunction",
+ "summary": "Delete a function",
+ "description": "Deletes a function with the specified slug from the specified project.",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": {
+ "minLength": 20,
+ "maxLength": 20,
+ "type": "string"
+ }
+ },
+ {
+ "name": "function_slug",
+ "required": true,
+ "in": "path",
+ "description": "Function slug",
+ "schema": {
+ "pattern": {},
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": ""
+ },
+ "500": {
+ "description": "Failed to delete function with given slug"
+ }
+ },
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ }
+ },
+ "/v1/projects/{ref}/secrets": {
+ "get": {
+ "operationId": "getSecrets",
+ "summary": "List all secrets",
+ "description": "Returns all secrets you've previously added to the specified project.",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": {
+ "minLength": 20,
+ "maxLength": 20,
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "value"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Failed to retrieve project's secrets"
+ }
+ },
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ },
+ "post": {
+ "operationId": "createSecrets",
+ "summary": "Bulk create secrets",
+ "description": "Creates multiple secrets and adds them to the specified project.",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": {
+ "minLength": 20,
+ "maxLength": 20,
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "pattern": {}
+ }
+ },
+ "required": [
+ "name",
+ "value"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": ""
+ },
+ "500": {
+ "description": "Failed to create project's secrets"
+ }
+ },
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ },
+ "delete": {
+ "operationId": "deleteSecrets",
+ "summary": "Bulk delete secrets",
+ "description": "Deletes all secrets with the given names from the specified project",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": {
+ "minLength": 20,
+ "maxLength": 20,
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Failed to delete secrets with given names"
+ }
+ },
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ }
}
},
"info": {
- "title": "Supabase API",
+ "title": "Supabase API (v1)",
"description": "",
"version": "1.0.0",
"contact": {}
@@ -271,3121 +869,34 @@
"scheme": "bearer",
"bearerFormat": "JWT",
"type": "http"
- },
- "apiKeyHeader": {
- "in": "header",
- "name": "apikey",
- "type": "apiKey"
- },
- "apiKeyQuery": {
- "in": "query",
- "name": "apikey",
- "type": "apiKey"
}
},
"schemas": {
- "Notification": {
+ "ProjectResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
- "inserted_at": {
+ "organization_id": {
"type": "string"
},
- "project_id": {
- "type": "number"
- },
- "notification_name": {
- "type": "string"
- },
- "notification_status": {
- "type": "string"
- },
- "data": {
- "type": "object"
- },
- "meta": {
- "type": "object"
- }
- },
- "required": [
- "id",
- "inserted_at",
- "project_id",
- "notification_name",
- "notification_status",
- "data",
- "meta"
- ]
- },
- "UpdateNotificationsBody": {
- "type": "object",
- "properties": {
- "ids": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": [
- "ids"
- ]
- },
- "SendFeedbackBody": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "category": {
- "type": "string"
- },
- "subject": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "additionalRedirectUrls": {
- "type": "string"
- },
- "pathname": {
- "type": "string"
- },
- "projectRef": {
- "type": "string"
- },
- "severity": {
- "type": "string"
- },
- "siteUrl": {
- "type": "string"
- },
- "urlToAirTable": {
- "type": "string"
- },
- "verified": {
- "type": "boolean"
- }
- },
- "required": [
- "message",
- "category",
- "tags"
- ]
- },
- "SubjectRoleParams": {
- "type": "object",
- "properties": {
- "gotrue_id": {
- "type": "string"
- },
- "role_id": {
- "type": "string"
- }
- },
- "required": [
- "gotrue_id",
- "role_id"
- ]
- },
- "GetGoTrueConfigResponse": {
- "type": "object",
- "properties": {
- "app_version": {
- "type": "string"
- },
- "isFreeTier": {
- "type": "boolean"
- },
- "id": {
- "type": "number"
- },
- "project_id": {
- "type": "number"
- },
- "updated_at": {
- "type": "string"
- },
- "SITE_URL": {
- "type": "string"
- },
- "OPERATOR_TOKEN": {
- "type": "string"
- },
- "DISABLE_SIGNUP": {
- "type": "boolean"
- },
- "RATE_LIMIT_HEADER": {
- "type": "string"
- },
- "JWT_EXP": {
- "type": "number"
- },
- "JWT_AUD": {
- "type": "string"
- },
- "JWT_DEFAULT_GROUP_NAME": {
- "type": "string"
- },
- "EXTERNAL_GITHUB_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_GITHUB_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_GITHUB_SECRET": {
- "type": "string"
- },
- "EXTERNAL_BITBUCKET_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_BITBUCKET_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_BITBUCKET_SECRET": {
- "type": "string"
- },
- "EXTERNAL_GOOGLE_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_GOOGLE_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_GOOGLE_SECRET": {
- "type": "string"
- },
- "EXTERNAL_GITLAB_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_GITLAB_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_GITLAB_SECRET": {
- "type": "string"
- },
- "EXTERNAL_GITLAB_REDIRECT_URI": {
- "type": "string"
- },
- "EXTERNAL_GITLAB_URL": {
- "type": "string"
- },
- "SMTP_ADMIN_EMAIL": {
- "type": "string"
- },
- "SMTP_HOST": {
- "type": "string"
- },
- "SMTP_PORT": {
- "type": "string"
- },
- "SMTP_USER": {
- "type": "string"
- },
- "SMTP_PASS": {
- "type": "string"
- },
- "SMTP_MAX_FREQUENCY": {
- "type": "number"
- },
- "MAILER_AUTOCONFIRM": {
- "type": "boolean"
- },
- "MAILER_URLPATHS_INVITE": {
- "type": "string"
- },
- "MAILER_URLPATHS_CONFIRMATION": {
- "type": "string"
- },
- "MAILER_URLPATHS_RECOVERY": {
- "type": "string"
- },
- "MAILER_URLPATHS_EMAIL_CHANGE": {
- "type": "string"
- },
- "MAILER_SUBJECTS_INVITE": {
- "type": "string"
- },
- "MAILER_SUBJECTS_CONFIRMATION": {
- "type": "string"
- },
- "MAILER_SUBJECTS_RECOVERY": {
- "type": "string"
- },
- "MAILER_SUBJECTS_EMAIL_CHANGE": {
- "type": "string"
- },
- "MAILER_TEMPLATES_INVITE": {
- "type": "string"
- },
- "MAILER_TEMPLATES_INVITE_CONTENT": {
- "type": "string"
- },
- "MAILER_TEMPLATES_CONFIRMATION": {
- "type": "string"
- },
- "MAILER_TEMPLATES_CONFIRMATION_CONTENT": {
- "type": "string"
- },
- "MAILER_TEMPLATES_RECOVERY": {
- "type": "string"
- },
- "MAILER_TEMPLATES_RECOVERY_CONTENT": {
- "type": "string"
- },
- "MAILER_TEMPLATES_EMAIL_CHANGE": {
- "type": "string"
- },
- "MAILER_TEMPLATES_EMAIL_CHANGE_CONTENT": {
- "type": "string"
- },
- "MAILER_SUBJECTS_MAGIC_LINK": {
- "type": "string"
- },
- "MAILER_TEMPLATES_MAGIC_LINK": {
- "type": "string"
- },
- "MAILER_TEMPLATES_MAGIC_LINK_CONTENT": {
- "type": "string"
- },
- "EXTERNAL_AZURE_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_AZURE_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_AZURE_SECRET": {
- "type": "string"
- },
- "EXTERNAL_FACEBOOK_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_FACEBOOK_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_FACEBOOK_SECRET": {
- "type": "string"
- },
- "URI_ALLOW_LIST": {
- "type": "string"
- },
- "EXTERNAL_TWITTER_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_TWITTER_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_TWITTER_SECRET": {
- "type": "string"
- },
- "EXTERNAL_APPLE_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_APPLE_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_APPLE_SECRET": {
- "type": "string"
- },
- "EXTERNAL_DISCORD_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_DISCORD_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_DISCORD_SECRET": {
- "type": "string"
- },
- "EXTERNAL_TWITCH_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_TWITCH_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_TWITCH_SECRET": {
- "type": "string"
- },
- "SMTP_SENDER_NAME": {
- "type": "string"
- },
- "EXTERNAL_EMAIL_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_PHONE_ENABLED": {
- "type": "boolean"
- },
- "SMS_AUTOCONFIRM": {
- "type": "boolean"
- },
- "SMS_MAX_FREQUENCY": {
- "type": "number"
- },
- "SMS_OTP_EXP": {
- "type": "number"
- },
- "SMS_OTP_LENGTH": {
- "type": "number"
- },
- "SMS_PROVIDER": {
- "type": "string"
- },
- "SMS_TWILIO_ACCOUNT_SID": {
- "type": "string"
- },
- "SMS_TWILIO_AUTH_TOKEN": {
- "type": "string"
- },
- "SMS_TWILIO_MESSAGE_SERVICE_SID": {
- "type": "string"
- },
- "SMS_TEMPLATE": {
- "type": "string"
- },
- "SECURITY_CAPTCHA_ENABLED": {
- "type": "boolean"
- },
- "SECURITY_CAPTCHA_PROVIDER": {
- "type": "string"
- },
- "SECURITY_CAPTCHA_SECRET": {
- "type": "string"
- },
- "RATE_LIMIT_EMAIL_SENT": {
- "type": "number"
- },
- "MAILER_SECURE_EMAIL_CHANGE_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_SPOTIFY_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_SPOTIFY_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_SPOTIFY_SECRET": {
- "type": "string"
- },
- "EXTERNAL_SLACK_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_SLACK_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_SLACK_SECRET": {
- "type": "string"
- },
- "SMS_MESSAGEBIRD_ACCESS_KEY": {
- "type": "string"
- },
- "SMS_MESSAGEBIRD_ORIGINATOR": {
- "type": "string"
- },
- "SMTP_PASS_ENCRYPTED": {
- "type": "string"
- },
- "REFRESH_TOKEN_ROTATION_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_LINKEDIN_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_LINKEDIN_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_LINKEDIN_SECRET": {
- "type": "string"
- },
- "EXTERNAL_NOTION_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_NOTION_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_NOTION_SECRET": {
- "type": "string"
- },
- "SMS_VONAGE_API_KEY": {
- "type": "string"
- },
- "SMS_VONAGE_API_SECRET": {
- "type": "string"
- },
- "SMS_VONAGE_FROM": {
- "type": "string"
- },
- "SMS_TEXTLOCAL_API_KEY": {
- "type": "string"
- },
- "SMS_TEXTLOCAL_SENDER": {
- "type": "string"
- },
- "EXTERNAL_ZOOM_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_ZOOM_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_ZOOM_SECRET": {
- "type": "string"
- },
- "EXTERNAL_AZURE_URL": {
- "type": "string"
- },
- "PASSWORD_MIN_LENGTH": {
- "type": "number"
- },
- "EXTERNAL_KEYCLOAK_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_KEYCLOAK_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_KEYCLOAK_SECRET": {
- "type": "string"
- },
- "EXTERNAL_KEYCLOAK_URL": {
- "type": "string"
- },
- "EXTERNAL_WORKOS_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_WORKOS_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_WORKOS_SECRET": {
- "type": "string"
- },
- "EXTERNAL_WORKOS_URL": {
- "type": "string"
- },
- "SECURITY_UPDATE_PASSWORD_REQUIRE_REAUTHENTICATION": {
- "type": "boolean"
- },
- "SECURITY_REFRESH_TOKEN_REUSE_INTERVAL": {
- "type": "number"
- },
- "MAILER_OTP_EXP": {
- "type": "number"
- },
- "RATE_LIMIT_VERIFY": {
- "type": "number"
- },
- "RATE_LIMIT_TOKEN_REFRESH": {
- "type": "number"
- }
- },
- "required": [
- "app_version",
- "isFreeTier",
- "id",
- "project_id",
- "updated_at",
- "SITE_URL",
- "OPERATOR_TOKEN",
- "DISABLE_SIGNUP",
- "RATE_LIMIT_HEADER",
- "JWT_EXP",
- "JWT_AUD",
- "JWT_DEFAULT_GROUP_NAME",
- "EXTERNAL_GITHUB_ENABLED",
- "EXTERNAL_GITHUB_CLIENT_ID",
- "EXTERNAL_GITHUB_SECRET",
- "EXTERNAL_BITBUCKET_ENABLED",
- "EXTERNAL_BITBUCKET_CLIENT_ID",
- "EXTERNAL_BITBUCKET_SECRET",
- "EXTERNAL_GOOGLE_ENABLED",
- "EXTERNAL_GOOGLE_CLIENT_ID",
- "EXTERNAL_GOOGLE_SECRET",
- "EXTERNAL_GITLAB_ENABLED",
- "EXTERNAL_GITLAB_CLIENT_ID",
- "EXTERNAL_GITLAB_SECRET",
- "EXTERNAL_GITLAB_REDIRECT_URI",
- "EXTERNAL_GITLAB_URL",
- "SMTP_ADMIN_EMAIL",
- "SMTP_HOST",
- "SMTP_PORT",
- "SMTP_USER",
- "SMTP_PASS",
- "SMTP_MAX_FREQUENCY",
- "MAILER_AUTOCONFIRM",
- "MAILER_URLPATHS_INVITE",
- "MAILER_URLPATHS_CONFIRMATION",
- "MAILER_URLPATHS_RECOVERY",
- "MAILER_URLPATHS_EMAIL_CHANGE",
- "MAILER_SUBJECTS_INVITE",
- "MAILER_SUBJECTS_CONFIRMATION",
- "MAILER_SUBJECTS_RECOVERY",
- "MAILER_SUBJECTS_EMAIL_CHANGE",
- "MAILER_TEMPLATES_INVITE",
- "MAILER_TEMPLATES_INVITE_CONTENT",
- "MAILER_TEMPLATES_CONFIRMATION",
- "MAILER_TEMPLATES_CONFIRMATION_CONTENT",
- "MAILER_TEMPLATES_RECOVERY",
- "MAILER_TEMPLATES_RECOVERY_CONTENT",
- "MAILER_TEMPLATES_EMAIL_CHANGE",
- "MAILER_TEMPLATES_EMAIL_CHANGE_CONTENT",
- "MAILER_SUBJECTS_MAGIC_LINK",
- "MAILER_TEMPLATES_MAGIC_LINK",
- "MAILER_TEMPLATES_MAGIC_LINK_CONTENT",
- "EXTERNAL_AZURE_ENABLED",
- "EXTERNAL_AZURE_CLIENT_ID",
- "EXTERNAL_AZURE_SECRET",
- "EXTERNAL_FACEBOOK_ENABLED",
- "EXTERNAL_FACEBOOK_CLIENT_ID",
- "EXTERNAL_FACEBOOK_SECRET",
- "URI_ALLOW_LIST",
- "EXTERNAL_TWITTER_ENABLED",
- "EXTERNAL_TWITTER_CLIENT_ID",
- "EXTERNAL_TWITTER_SECRET",
- "EXTERNAL_APPLE_ENABLED",
- "EXTERNAL_APPLE_CLIENT_ID",
- "EXTERNAL_APPLE_SECRET",
- "EXTERNAL_DISCORD_ENABLED",
- "EXTERNAL_DISCORD_CLIENT_ID",
- "EXTERNAL_DISCORD_SECRET",
- "EXTERNAL_TWITCH_ENABLED",
- "EXTERNAL_TWITCH_CLIENT_ID",
- "EXTERNAL_TWITCH_SECRET",
- "SMTP_SENDER_NAME",
- "EXTERNAL_EMAIL_ENABLED",
- "EXTERNAL_PHONE_ENABLED",
- "SMS_AUTOCONFIRM",
- "SMS_MAX_FREQUENCY",
- "SMS_OTP_EXP",
- "SMS_OTP_LENGTH",
- "SMS_PROVIDER",
- "SMS_TWILIO_ACCOUNT_SID",
- "SMS_TWILIO_AUTH_TOKEN",
- "SMS_TWILIO_MESSAGE_SERVICE_SID",
- "SMS_TEMPLATE",
- "SECURITY_CAPTCHA_ENABLED",
- "SECURITY_CAPTCHA_PROVIDER",
- "SECURITY_CAPTCHA_SECRET",
- "RATE_LIMIT_EMAIL_SENT",
- "MAILER_SECURE_EMAIL_CHANGE_ENABLED",
- "EXTERNAL_SPOTIFY_ENABLED",
- "EXTERNAL_SPOTIFY_CLIENT_ID",
- "EXTERNAL_SPOTIFY_SECRET",
- "EXTERNAL_SLACK_ENABLED",
- "EXTERNAL_SLACK_CLIENT_ID",
- "EXTERNAL_SLACK_SECRET",
- "SMS_MESSAGEBIRD_ACCESS_KEY",
- "SMS_MESSAGEBIRD_ORIGINATOR",
- "SMTP_PASS_ENCRYPTED",
- "REFRESH_TOKEN_ROTATION_ENABLED",
- "EXTERNAL_LINKEDIN_ENABLED",
- "EXTERNAL_LINKEDIN_CLIENT_ID",
- "EXTERNAL_LINKEDIN_SECRET",
- "EXTERNAL_NOTION_ENABLED",
- "EXTERNAL_NOTION_CLIENT_ID",
- "EXTERNAL_NOTION_SECRET",
- "SMS_VONAGE_API_KEY",
- "SMS_VONAGE_API_SECRET",
- "SMS_VONAGE_FROM",
- "SMS_TEXTLOCAL_API_KEY",
- "SMS_TEXTLOCAL_SENDER",
- "EXTERNAL_ZOOM_ENABLED",
- "EXTERNAL_ZOOM_CLIENT_ID",
- "EXTERNAL_ZOOM_SECRET",
- "EXTERNAL_AZURE_URL",
- "PASSWORD_MIN_LENGTH",
- "EXTERNAL_KEYCLOAK_ENABLED",
- "EXTERNAL_KEYCLOAK_CLIENT_ID",
- "EXTERNAL_KEYCLOAK_SECRET",
- "EXTERNAL_KEYCLOAK_URL",
- "EXTERNAL_WORKOS_ENABLED",
- "EXTERNAL_WORKOS_CLIENT_ID",
- "EXTERNAL_WORKOS_SECRET",
- "EXTERNAL_WORKOS_URL",
- "SECURITY_UPDATE_PASSWORD_REQUIRE_REAUTHENTICATION",
- "SECURITY_REFRESH_TOKEN_REUSE_INTERVAL",
- "MAILER_OTP_EXP",
- "RATE_LIMIT_VERIFY",
- "RATE_LIMIT_TOKEN_REFRESH"
- ]
- },
- "UpdateGoTrueConfigBody": {
- "type": "object",
- "properties": {
- "SITE_URL": {
- "type": "string"
- },
- "OPERATOR_TOKEN": {
- "type": "string"
- },
- "DISABLE_SIGNUP": {
- "type": "boolean"
- },
- "RATE_LIMIT_HEADER": {
- "type": "string"
- },
- "JWT_EXP": {
- "type": "number"
- },
- "JWT_AUD": {
- "type": "string"
- },
- "JWT_DEFAULT_GROUP_NAME": {
- "type": "string"
- },
- "EXTERNAL_GITHUB_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_GITHUB_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_GITHUB_SECRET": {
- "type": "string"
- },
- "EXTERNAL_BITBUCKET_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_BITBUCKET_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_BITBUCKET_SECRET": {
- "type": "string"
- },
- "EXTERNAL_GOOGLE_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_GOOGLE_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_GOOGLE_SECRET": {
- "type": "string"
- },
- "EXTERNAL_GITLAB_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_GITLAB_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_GITLAB_SECRET": {
- "type": "string"
- },
- "EXTERNAL_GITLAB_REDIRECT_URI": {
- "type": "string"
- },
- "EXTERNAL_GITLAB_URL": {
- "type": "string"
- },
- "SMTP_ADMIN_EMAIL": {
- "type": "string"
- },
- "SMTP_HOST": {
- "type": "string"
- },
- "SMTP_PORT": {
- "type": "string"
- },
- "SMTP_USER": {
- "type": "string"
- },
- "SMTP_PASS": {
- "type": "string"
- },
- "SMTP_MAX_FREQUENCY": {
- "type": "number"
- },
- "MAILER_AUTOCONFIRM": {
- "type": "boolean"
- },
- "MAILER_URLPATHS_INVITE": {
- "type": "string"
- },
- "MAILER_URLPATHS_CONFIRMATION": {
- "type": "string"
- },
- "MAILER_URLPATHS_RECOVERY": {
- "type": "string"
- },
- "MAILER_URLPATHS_EMAIL_CHANGE": {
- "type": "string"
- },
- "MAILER_SUBJECTS_INVITE": {
- "type": "string"
- },
- "MAILER_SUBJECTS_CONFIRMATION": {
- "type": "string"
- },
- "MAILER_SUBJECTS_RECOVERY": {
- "type": "string"
- },
- "MAILER_SUBJECTS_EMAIL_CHANGE": {
- "type": "string"
- },
- "MAILER_TEMPLATES_INVITE": {
- "type": "string"
- },
- "MAILER_TEMPLATES_INVITE_CONTENT": {
- "type": "string"
- },
- "MAILER_TEMPLATES_CONFIRMATION": {
- "type": "string"
- },
- "MAILER_TEMPLATES_CONFIRMATION_CONTENT": {
- "type": "string"
- },
- "MAILER_TEMPLATES_RECOVERY": {
- "type": "string"
- },
- "MAILER_TEMPLATES_RECOVERY_CONTENT": {
- "type": "string"
- },
- "MAILER_TEMPLATES_EMAIL_CHANGE": {
- "type": "string"
- },
- "MAILER_TEMPLATES_EMAIL_CHANGE_CONTENT": {
- "type": "string"
- },
- "MAILER_SUBJECTS_MAGIC_LINK": {
- "type": "string"
- },
- "MAILER_TEMPLATES_MAGIC_LINK": {
- "type": "string"
- },
- "MAILER_TEMPLATES_MAGIC_LINK_CONTENT": {
- "type": "string"
- },
- "EXTERNAL_AZURE_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_AZURE_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_AZURE_SECRET": {
- "type": "string"
- },
- "EXTERNAL_FACEBOOK_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_FACEBOOK_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_FACEBOOK_SECRET": {
- "type": "string"
- },
- "URI_ALLOW_LIST": {
- "type": "string"
- },
- "EXTERNAL_TWITTER_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_TWITTER_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_TWITTER_SECRET": {
- "type": "string"
- },
- "EXTERNAL_APPLE_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_APPLE_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_APPLE_SECRET": {
- "type": "string"
- },
- "EXTERNAL_DISCORD_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_DISCORD_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_DISCORD_SECRET": {
- "type": "string"
- },
- "EXTERNAL_TWITCH_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_TWITCH_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_TWITCH_SECRET": {
- "type": "string"
- },
- "SMTP_SENDER_NAME": {
- "type": "string"
- },
- "EXTERNAL_EMAIL_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_PHONE_ENABLED": {
- "type": "boolean"
- },
- "SMS_AUTOCONFIRM": {
- "type": "boolean"
- },
- "SMS_MAX_FREQUENCY": {
- "type": "number"
- },
- "SMS_OTP_EXP": {
- "type": "number"
- },
- "SMS_OTP_LENGTH": {
- "type": "number"
- },
- "SMS_PROVIDER": {
- "type": "string"
- },
- "SMS_TWILIO_ACCOUNT_SID": {
- "type": "string"
- },
- "SMS_TWILIO_AUTH_TOKEN": {
- "type": "string"
- },
- "SMS_TWILIO_MESSAGE_SERVICE_SID": {
- "type": "string"
- },
- "SMS_TEMPLATE": {
- "type": "string"
- },
- "SECURITY_CAPTCHA_ENABLED": {
- "type": "boolean"
- },
- "SECURITY_CAPTCHA_PROVIDER": {
- "type": "string"
- },
- "SECURITY_CAPTCHA_SECRET": {
- "type": "string"
- },
- "RATE_LIMIT_EMAIL_SENT": {
- "type": "number"
- },
- "MAILER_SECURE_EMAIL_CHANGE_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_SPOTIFY_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_SPOTIFY_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_SPOTIFY_SECRET": {
- "type": "string"
- },
- "EXTERNAL_SLACK_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_SLACK_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_SLACK_SECRET": {
- "type": "string"
- },
- "SMS_MESSAGEBIRD_ACCESS_KEY": {
- "type": "string"
- },
- "SMS_MESSAGEBIRD_ORIGINATOR": {
- "type": "string"
- },
- "SMTP_PASS_ENCRYPTED": {
- "type": "string"
- },
- "REFRESH_TOKEN_ROTATION_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_LINKEDIN_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_LINKEDIN_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_LINKEDIN_SECRET": {
- "type": "string"
- },
- "EXTERNAL_NOTION_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_NOTION_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_NOTION_SECRET": {
- "type": "string"
- },
- "SMS_VONAGE_API_KEY": {
- "type": "string"
- },
- "SMS_VONAGE_API_SECRET": {
- "type": "string"
- },
- "SMS_VONAGE_FROM": {
- "type": "string"
- },
- "SMS_TEXTLOCAL_API_KEY": {
- "type": "string"
- },
- "SMS_TEXTLOCAL_SENDER": {
- "type": "string"
- },
- "EXTERNAL_ZOOM_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_ZOOM_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_ZOOM_SECRET": {
- "type": "string"
- },
- "EXTERNAL_AZURE_URL": {
- "type": "string"
- },
- "PASSWORD_MIN_LENGTH": {
- "type": "number"
- },
- "EXTERNAL_KEYCLOAK_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_KEYCLOAK_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_KEYCLOAK_SECRET": {
- "type": "string"
- },
- "EXTERNAL_KEYCLOAK_URL": {
- "type": "string"
- },
- "EXTERNAL_WORKOS_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_WORKOS_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_WORKOS_SECRET": {
- "type": "string"
- },
- "EXTERNAL_WORKOS_URL": {
- "type": "string"
- },
- "SECURITY_UPDATE_PASSWORD_REQUIRE_REAUTHENTICATION": {
- "type": "boolean"
- },
- "SECURITY_REFRESH_TOKEN_REUSE_INTERVAL": {
- "type": "number"
- },
- "MAILER_OTP_EXP": {
- "type": "number"
- },
- "RATE_LIMIT_VERIFY": {
- "type": "number"
- },
- "RATE_LIMIT_TOKEN_REFRESH": {
- "type": "number"
- }
- },
- "required": [
- "SITE_URL",
- "OPERATOR_TOKEN",
- "DISABLE_SIGNUP",
- "RATE_LIMIT_HEADER",
- "JWT_EXP",
- "JWT_AUD",
- "JWT_DEFAULT_GROUP_NAME",
- "EXTERNAL_GITHUB_ENABLED",
- "EXTERNAL_GITHUB_CLIENT_ID",
- "EXTERNAL_GITHUB_SECRET",
- "EXTERNAL_BITBUCKET_ENABLED",
- "EXTERNAL_BITBUCKET_CLIENT_ID",
- "EXTERNAL_BITBUCKET_SECRET",
- "EXTERNAL_GOOGLE_ENABLED",
- "EXTERNAL_GOOGLE_CLIENT_ID",
- "EXTERNAL_GOOGLE_SECRET",
- "EXTERNAL_GITLAB_ENABLED",
- "EXTERNAL_GITLAB_CLIENT_ID",
- "EXTERNAL_GITLAB_SECRET",
- "EXTERNAL_GITLAB_REDIRECT_URI",
- "EXTERNAL_GITLAB_URL",
- "SMTP_ADMIN_EMAIL",
- "SMTP_HOST",
- "SMTP_PORT",
- "SMTP_USER",
- "SMTP_PASS",
- "SMTP_MAX_FREQUENCY",
- "MAILER_AUTOCONFIRM",
- "MAILER_URLPATHS_INVITE",
- "MAILER_URLPATHS_CONFIRMATION",
- "MAILER_URLPATHS_RECOVERY",
- "MAILER_URLPATHS_EMAIL_CHANGE",
- "MAILER_SUBJECTS_INVITE",
- "MAILER_SUBJECTS_CONFIRMATION",
- "MAILER_SUBJECTS_RECOVERY",
- "MAILER_SUBJECTS_EMAIL_CHANGE",
- "MAILER_TEMPLATES_INVITE",
- "MAILER_TEMPLATES_INVITE_CONTENT",
- "MAILER_TEMPLATES_CONFIRMATION",
- "MAILER_TEMPLATES_CONFIRMATION_CONTENT",
- "MAILER_TEMPLATES_RECOVERY",
- "MAILER_TEMPLATES_RECOVERY_CONTENT",
- "MAILER_TEMPLATES_EMAIL_CHANGE",
- "MAILER_TEMPLATES_EMAIL_CHANGE_CONTENT",
- "MAILER_SUBJECTS_MAGIC_LINK",
- "MAILER_TEMPLATES_MAGIC_LINK",
- "MAILER_TEMPLATES_MAGIC_LINK_CONTENT",
- "EXTERNAL_AZURE_ENABLED",
- "EXTERNAL_AZURE_CLIENT_ID",
- "EXTERNAL_AZURE_SECRET",
- "EXTERNAL_FACEBOOK_ENABLED",
- "EXTERNAL_FACEBOOK_CLIENT_ID",
- "EXTERNAL_FACEBOOK_SECRET",
- "URI_ALLOW_LIST",
- "EXTERNAL_TWITTER_ENABLED",
- "EXTERNAL_TWITTER_CLIENT_ID",
- "EXTERNAL_TWITTER_SECRET",
- "EXTERNAL_APPLE_ENABLED",
- "EXTERNAL_APPLE_CLIENT_ID",
- "EXTERNAL_APPLE_SECRET",
- "EXTERNAL_DISCORD_ENABLED",
- "EXTERNAL_DISCORD_CLIENT_ID",
- "EXTERNAL_DISCORD_SECRET",
- "EXTERNAL_TWITCH_ENABLED",
- "EXTERNAL_TWITCH_CLIENT_ID",
- "EXTERNAL_TWITCH_SECRET",
- "SMTP_SENDER_NAME",
- "EXTERNAL_EMAIL_ENABLED",
- "EXTERNAL_PHONE_ENABLED",
- "SMS_AUTOCONFIRM",
- "SMS_MAX_FREQUENCY",
- "SMS_OTP_EXP",
- "SMS_OTP_LENGTH",
- "SMS_PROVIDER",
- "SMS_TWILIO_ACCOUNT_SID",
- "SMS_TWILIO_AUTH_TOKEN",
- "SMS_TWILIO_MESSAGE_SERVICE_SID",
- "SMS_TEMPLATE",
- "SECURITY_CAPTCHA_ENABLED",
- "SECURITY_CAPTCHA_PROVIDER",
- "SECURITY_CAPTCHA_SECRET",
- "RATE_LIMIT_EMAIL_SENT",
- "MAILER_SECURE_EMAIL_CHANGE_ENABLED",
- "EXTERNAL_SPOTIFY_ENABLED",
- "EXTERNAL_SPOTIFY_CLIENT_ID",
- "EXTERNAL_SPOTIFY_SECRET",
- "EXTERNAL_SLACK_ENABLED",
- "EXTERNAL_SLACK_CLIENT_ID",
- "EXTERNAL_SLACK_SECRET",
- "SMS_MESSAGEBIRD_ACCESS_KEY",
- "SMS_MESSAGEBIRD_ORIGINATOR",
- "SMTP_PASS_ENCRYPTED",
- "REFRESH_TOKEN_ROTATION_ENABLED",
- "EXTERNAL_LINKEDIN_ENABLED",
- "EXTERNAL_LINKEDIN_CLIENT_ID",
- "EXTERNAL_LINKEDIN_SECRET",
- "EXTERNAL_NOTION_ENABLED",
- "EXTERNAL_NOTION_CLIENT_ID",
- "EXTERNAL_NOTION_SECRET",
- "SMS_VONAGE_API_KEY",
- "SMS_VONAGE_API_SECRET",
- "SMS_VONAGE_FROM",
- "SMS_TEXTLOCAL_API_KEY",
- "SMS_TEXTLOCAL_SENDER",
- "EXTERNAL_ZOOM_ENABLED",
- "EXTERNAL_ZOOM_CLIENT_ID",
- "EXTERNAL_ZOOM_SECRET",
- "EXTERNAL_AZURE_URL",
- "PASSWORD_MIN_LENGTH",
- "EXTERNAL_KEYCLOAK_ENABLED",
- "EXTERNAL_KEYCLOAK_CLIENT_ID",
- "EXTERNAL_KEYCLOAK_SECRET",
- "EXTERNAL_KEYCLOAK_URL",
- "EXTERNAL_WORKOS_ENABLED",
- "EXTERNAL_WORKOS_CLIENT_ID",
- "EXTERNAL_WORKOS_SECRET",
- "EXTERNAL_WORKOS_URL",
- "SECURITY_UPDATE_PASSWORD_REQUIRE_REAUTHENTICATION",
- "SECURITY_REFRESH_TOKEN_REUSE_INTERVAL",
- "MAILER_OTP_EXP",
- "RATE_LIMIT_VERIFY",
- "RATE_LIMIT_TOKEN_REFRESH"
- ]
- },
- "GoTrueConfig": {
- "type": "object",
- "properties": {
- "SITE_URL": {
- "type": "string"
- },
- "OPERATOR_TOKEN": {
- "type": "string"
- },
- "DISABLE_SIGNUP": {
- "type": "boolean"
- },
- "RATE_LIMIT_HEADER": {
- "type": "string"
- },
- "JWT_EXP": {
- "type": "number"
- },
- "JWT_AUD": {
- "type": "string"
- },
- "JWT_DEFAULT_GROUP_NAME": {
- "type": "string"
- },
- "EXTERNAL_GITHUB_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_GITHUB_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_GITHUB_SECRET": {
- "type": "string"
- },
- "EXTERNAL_BITBUCKET_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_BITBUCKET_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_BITBUCKET_SECRET": {
- "type": "string"
- },
- "EXTERNAL_GOOGLE_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_GOOGLE_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_GOOGLE_SECRET": {
- "type": "string"
- },
- "EXTERNAL_GITLAB_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_GITLAB_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_GITLAB_SECRET": {
- "type": "string"
- },
- "EXTERNAL_GITLAB_REDIRECT_URI": {
- "type": "string"
- },
- "EXTERNAL_GITLAB_URL": {
- "type": "string"
- },
- "SMTP_ADMIN_EMAIL": {
- "type": "string"
- },
- "SMTP_HOST": {
- "type": "string"
- },
- "SMTP_PORT": {
- "type": "string"
- },
- "SMTP_USER": {
- "type": "string"
- },
- "SMTP_PASS": {
- "type": "string"
- },
- "SMTP_MAX_FREQUENCY": {
- "type": "number"
- },
- "MAILER_AUTOCONFIRM": {
- "type": "boolean"
- },
- "MAILER_URLPATHS_INVITE": {
- "type": "string"
- },
- "MAILER_URLPATHS_CONFIRMATION": {
- "type": "string"
- },
- "MAILER_URLPATHS_RECOVERY": {
- "type": "string"
- },
- "MAILER_URLPATHS_EMAIL_CHANGE": {
- "type": "string"
- },
- "MAILER_SUBJECTS_INVITE": {
- "type": "string"
- },
- "MAILER_SUBJECTS_CONFIRMATION": {
- "type": "string"
- },
- "MAILER_SUBJECTS_RECOVERY": {
- "type": "string"
- },
- "MAILER_SUBJECTS_EMAIL_CHANGE": {
- "type": "string"
- },
- "MAILER_TEMPLATES_INVITE": {
- "type": "string"
- },
- "MAILER_TEMPLATES_INVITE_CONTENT": {
- "type": "string"
- },
- "MAILER_TEMPLATES_CONFIRMATION": {
- "type": "string"
- },
- "MAILER_TEMPLATES_CONFIRMATION_CONTENT": {
- "type": "string"
- },
- "MAILER_TEMPLATES_RECOVERY": {
- "type": "string"
- },
- "MAILER_TEMPLATES_RECOVERY_CONTENT": {
- "type": "string"
- },
- "MAILER_TEMPLATES_EMAIL_CHANGE": {
- "type": "string"
- },
- "MAILER_TEMPLATES_EMAIL_CHANGE_CONTENT": {
- "type": "string"
- },
- "MAILER_SUBJECTS_MAGIC_LINK": {
- "type": "string"
- },
- "MAILER_TEMPLATES_MAGIC_LINK": {
- "type": "string"
- },
- "MAILER_TEMPLATES_MAGIC_LINK_CONTENT": {
- "type": "string"
- },
- "EXTERNAL_AZURE_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_AZURE_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_AZURE_SECRET": {
- "type": "string"
- },
- "EXTERNAL_FACEBOOK_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_FACEBOOK_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_FACEBOOK_SECRET": {
- "type": "string"
- },
- "URI_ALLOW_LIST": {
- "type": "string"
- },
- "EXTERNAL_TWITTER_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_TWITTER_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_TWITTER_SECRET": {
- "type": "string"
- },
- "EXTERNAL_APPLE_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_APPLE_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_APPLE_SECRET": {
- "type": "string"
- },
- "EXTERNAL_DISCORD_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_DISCORD_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_DISCORD_SECRET": {
- "type": "string"
- },
- "EXTERNAL_TWITCH_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_TWITCH_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_TWITCH_SECRET": {
- "type": "string"
- },
- "SMTP_SENDER_NAME": {
- "type": "string"
- },
- "EXTERNAL_EMAIL_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_PHONE_ENABLED": {
- "type": "boolean"
- },
- "SMS_AUTOCONFIRM": {
- "type": "boolean"
- },
- "SMS_MAX_FREQUENCY": {
- "type": "number"
- },
- "SMS_OTP_EXP": {
- "type": "number"
- },
- "SMS_OTP_LENGTH": {
- "type": "number"
- },
- "SMS_PROVIDER": {
- "type": "string"
- },
- "SMS_TWILIO_ACCOUNT_SID": {
- "type": "string"
- },
- "SMS_TWILIO_AUTH_TOKEN": {
- "type": "string"
- },
- "SMS_TWILIO_MESSAGE_SERVICE_SID": {
- "type": "string"
- },
- "SMS_TEMPLATE": {
- "type": "string"
- },
- "SECURITY_CAPTCHA_ENABLED": {
- "type": "boolean"
- },
- "SECURITY_CAPTCHA_PROVIDER": {
- "type": "string"
- },
- "SECURITY_CAPTCHA_SECRET": {
- "type": "string"
- },
- "RATE_LIMIT_EMAIL_SENT": {
- "type": "number"
- },
- "MAILER_SECURE_EMAIL_CHANGE_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_SPOTIFY_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_SPOTIFY_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_SPOTIFY_SECRET": {
- "type": "string"
- },
- "EXTERNAL_SLACK_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_SLACK_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_SLACK_SECRET": {
- "type": "string"
- },
- "SMS_MESSAGEBIRD_ACCESS_KEY": {
- "type": "string"
- },
- "SMS_MESSAGEBIRD_ORIGINATOR": {
- "type": "string"
- },
- "SMTP_PASS_ENCRYPTED": {
- "type": "string"
- },
- "REFRESH_TOKEN_ROTATION_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_LINKEDIN_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_LINKEDIN_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_LINKEDIN_SECRET": {
- "type": "string"
- },
- "EXTERNAL_NOTION_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_NOTION_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_NOTION_SECRET": {
- "type": "string"
- },
- "SMS_VONAGE_API_KEY": {
- "type": "string"
- },
- "SMS_VONAGE_API_SECRET": {
- "type": "string"
- },
- "SMS_VONAGE_FROM": {
- "type": "string"
- },
- "SMS_TEXTLOCAL_API_KEY": {
- "type": "string"
- },
- "SMS_TEXTLOCAL_SENDER": {
- "type": "string"
- },
- "EXTERNAL_ZOOM_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_ZOOM_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_ZOOM_SECRET": {
- "type": "string"
- },
- "EXTERNAL_AZURE_URL": {
- "type": "string"
- },
- "PASSWORD_MIN_LENGTH": {
- "type": "number"
- },
- "EXTERNAL_KEYCLOAK_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_KEYCLOAK_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_KEYCLOAK_SECRET": {
- "type": "string"
- },
- "EXTERNAL_KEYCLOAK_URL": {
- "type": "string"
- },
- "EXTERNAL_WORKOS_ENABLED": {
- "type": "boolean"
- },
- "EXTERNAL_WORKOS_CLIENT_ID": {
- "type": "string"
- },
- "EXTERNAL_WORKOS_SECRET": {
- "type": "string"
- },
- "EXTERNAL_WORKOS_URL": {
- "type": "string"
- },
- "SECURITY_UPDATE_PASSWORD_REQUIRE_REAUTHENTICATION": {
- "type": "boolean"
- },
- "SECURITY_REFRESH_TOKEN_REUSE_INTERVAL": {
- "type": "number"
- },
- "MAILER_OTP_EXP": {
- "type": "number"
- },
- "RATE_LIMIT_VERIFY": {
- "type": "number"
- },
- "RATE_LIMIT_TOKEN_REFRESH": {
- "type": "number"
- },
- "id": {
- "type": "number"
- },
- "project_id": {
- "type": "number"
- },
- "updated_at": {
- "type": "string"
- }
- },
- "required": [
- "SITE_URL",
- "OPERATOR_TOKEN",
- "DISABLE_SIGNUP",
- "RATE_LIMIT_HEADER",
- "JWT_EXP",
- "JWT_AUD",
- "JWT_DEFAULT_GROUP_NAME",
- "EXTERNAL_GITHUB_ENABLED",
- "EXTERNAL_GITHUB_CLIENT_ID",
- "EXTERNAL_GITHUB_SECRET",
- "EXTERNAL_BITBUCKET_ENABLED",
- "EXTERNAL_BITBUCKET_CLIENT_ID",
- "EXTERNAL_BITBUCKET_SECRET",
- "EXTERNAL_GOOGLE_ENABLED",
- "EXTERNAL_GOOGLE_CLIENT_ID",
- "EXTERNAL_GOOGLE_SECRET",
- "EXTERNAL_GITLAB_ENABLED",
- "EXTERNAL_GITLAB_CLIENT_ID",
- "EXTERNAL_GITLAB_SECRET",
- "EXTERNAL_GITLAB_REDIRECT_URI",
- "EXTERNAL_GITLAB_URL",
- "SMTP_ADMIN_EMAIL",
- "SMTP_HOST",
- "SMTP_PORT",
- "SMTP_USER",
- "SMTP_PASS",
- "SMTP_MAX_FREQUENCY",
- "MAILER_AUTOCONFIRM",
- "MAILER_URLPATHS_INVITE",
- "MAILER_URLPATHS_CONFIRMATION",
- "MAILER_URLPATHS_RECOVERY",
- "MAILER_URLPATHS_EMAIL_CHANGE",
- "MAILER_SUBJECTS_INVITE",
- "MAILER_SUBJECTS_CONFIRMATION",
- "MAILER_SUBJECTS_RECOVERY",
- "MAILER_SUBJECTS_EMAIL_CHANGE",
- "MAILER_TEMPLATES_INVITE",
- "MAILER_TEMPLATES_INVITE_CONTENT",
- "MAILER_TEMPLATES_CONFIRMATION",
- "MAILER_TEMPLATES_CONFIRMATION_CONTENT",
- "MAILER_TEMPLATES_RECOVERY",
- "MAILER_TEMPLATES_RECOVERY_CONTENT",
- "MAILER_TEMPLATES_EMAIL_CHANGE",
- "MAILER_TEMPLATES_EMAIL_CHANGE_CONTENT",
- "MAILER_SUBJECTS_MAGIC_LINK",
- "MAILER_TEMPLATES_MAGIC_LINK",
- "MAILER_TEMPLATES_MAGIC_LINK_CONTENT",
- "EXTERNAL_AZURE_ENABLED",
- "EXTERNAL_AZURE_CLIENT_ID",
- "EXTERNAL_AZURE_SECRET",
- "EXTERNAL_FACEBOOK_ENABLED",
- "EXTERNAL_FACEBOOK_CLIENT_ID",
- "EXTERNAL_FACEBOOK_SECRET",
- "URI_ALLOW_LIST",
- "EXTERNAL_TWITTER_ENABLED",
- "EXTERNAL_TWITTER_CLIENT_ID",
- "EXTERNAL_TWITTER_SECRET",
- "EXTERNAL_APPLE_ENABLED",
- "EXTERNAL_APPLE_CLIENT_ID",
- "EXTERNAL_APPLE_SECRET",
- "EXTERNAL_DISCORD_ENABLED",
- "EXTERNAL_DISCORD_CLIENT_ID",
- "EXTERNAL_DISCORD_SECRET",
- "EXTERNAL_TWITCH_ENABLED",
- "EXTERNAL_TWITCH_CLIENT_ID",
- "EXTERNAL_TWITCH_SECRET",
- "SMTP_SENDER_NAME",
- "EXTERNAL_EMAIL_ENABLED",
- "EXTERNAL_PHONE_ENABLED",
- "SMS_AUTOCONFIRM",
- "SMS_MAX_FREQUENCY",
- "SMS_OTP_EXP",
- "SMS_OTP_LENGTH",
- "SMS_PROVIDER",
- "SMS_TWILIO_ACCOUNT_SID",
- "SMS_TWILIO_AUTH_TOKEN",
- "SMS_TWILIO_MESSAGE_SERVICE_SID",
- "SMS_TEMPLATE",
- "SECURITY_CAPTCHA_ENABLED",
- "SECURITY_CAPTCHA_PROVIDER",
- "SECURITY_CAPTCHA_SECRET",
- "RATE_LIMIT_EMAIL_SENT",
- "MAILER_SECURE_EMAIL_CHANGE_ENABLED",
- "EXTERNAL_SPOTIFY_ENABLED",
- "EXTERNAL_SPOTIFY_CLIENT_ID",
- "EXTERNAL_SPOTIFY_SECRET",
- "EXTERNAL_SLACK_ENABLED",
- "EXTERNAL_SLACK_CLIENT_ID",
- "EXTERNAL_SLACK_SECRET",
- "SMS_MESSAGEBIRD_ACCESS_KEY",
- "SMS_MESSAGEBIRD_ORIGINATOR",
- "SMTP_PASS_ENCRYPTED",
- "REFRESH_TOKEN_ROTATION_ENABLED",
- "EXTERNAL_LINKEDIN_ENABLED",
- "EXTERNAL_LINKEDIN_CLIENT_ID",
- "EXTERNAL_LINKEDIN_SECRET",
- "EXTERNAL_NOTION_ENABLED",
- "EXTERNAL_NOTION_CLIENT_ID",
- "EXTERNAL_NOTION_SECRET",
- "SMS_VONAGE_API_KEY",
- "SMS_VONAGE_API_SECRET",
- "SMS_VONAGE_FROM",
- "SMS_TEXTLOCAL_API_KEY",
- "SMS_TEXTLOCAL_SENDER",
- "EXTERNAL_ZOOM_ENABLED",
- "EXTERNAL_ZOOM_CLIENT_ID",
- "EXTERNAL_ZOOM_SECRET",
- "EXTERNAL_AZURE_URL",
- "PASSWORD_MIN_LENGTH",
- "EXTERNAL_KEYCLOAK_ENABLED",
- "EXTERNAL_KEYCLOAK_CLIENT_ID",
- "EXTERNAL_KEYCLOAK_SECRET",
- "EXTERNAL_KEYCLOAK_URL",
- "EXTERNAL_WORKOS_ENABLED",
- "EXTERNAL_WORKOS_CLIENT_ID",
- "EXTERNAL_WORKOS_SECRET",
- "EXTERNAL_WORKOS_URL",
- "SECURITY_UPDATE_PASSWORD_REQUIRE_REAUTHENTICATION",
- "SECURITY_REFRESH_TOKEN_REUSE_INTERVAL",
- "MAILER_OTP_EXP",
- "RATE_LIMIT_VERIFY",
- "RATE_LIMIT_TOKEN_REFRESH",
- "id",
- "project_id",
- "updated_at"
- ]
- },
- "UserBody": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "aud": {
- "type": "string"
- },
- "banned_until": {
- "type": "string"
- },
- "confirmation_sent_at": {
- "type": "string"
- },
- "confirmation_token": {
- "type": "string"
- },
- "confirmed_at": {
- "type": "string"
- },
- "created_at": {
- "type": "string"
- },
- "email": {
- "type": "string"
- },
- "email_change": {
- "type": "string"
- },
- "email_change_confirm_status": {
- "type": "number"
- },
- "email_change_sent_at": {
- "type": "string"
- },
- "email_change_token_current": {
- "type": "string"
- },
- "email_change_token_new": {
- "type": "string"
- },
- "email_confirmed_at": {
- "type": "string"
- },
- "encrypted_password": {
- "type": "string"
- },
- "instance_id": {
- "type": "string"
- },
- "invited_at": {
- "type": "string"
- },
- "is_super_admin": {
- "type": "boolean"
- },
- "last_sign_in_at": {
- "type": "string"
- },
- "phone": {
- "type": "string"
- },
- "phone_change": {
- "type": "string"
- },
- "phone_change_sent_at": {
- "type": "string"
- },
- "phone_change_token": {
- "type": "string"
- },
- "phone_confirmed_at": {
- "type": "string"
- },
- "raw_app_meta_data": {
- "type": "object"
- },
- "raw_user_meta_data": {
- "type": "object"
- },
- "reauthentication_sent_at": {
- "type": "string"
- },
- "reauthentication_token": {
- "type": "string"
- },
- "recovery_sent_at": {
- "type": "string"
- },
- "recovery_token": {
- "type": "string"
- },
- "role": {
- "type": "string"
- },
- "updated_at": {
- "type": "string"
- }
- },
- "required": [
- "id",
- "aud",
- "banned_until",
- "confirmation_sent_at",
- "confirmation_token",
- "confirmed_at",
- "created_at",
- "email",
- "email_change",
- "email_change_confirm_status",
- "email_change_sent_at",
- "email_change_token_current",
- "email_change_token_new",
- "email_confirmed_at",
- "encrypted_password",
- "instance_id",
- "invited_at",
- "is_super_admin",
- "last_sign_in_at",
- "phone",
- "phone_change",
- "phone_change_sent_at",
- "phone_change_token",
- "phone_confirmed_at",
- "raw_app_meta_data",
- "raw_user_meta_data",
- "reauthentication_sent_at",
- "reauthentication_token",
- "recovery_sent_at",
- "recovery_token",
- "role",
- "updated_at"
- ]
- },
- "Backup": {
- "type": "object",
- "properties": {
- "id": {
- "type": "number"
- },
- "data": {
- "type": "object"
- },
- "project_id": {
- "type": "number"
- },
- "status": {
- "type": "object"
- },
- "s3_path": {
- "type": "string"
- },
- "s3_bucket": {
- "type": "string"
- },
- "inserted_at": {
- "type": "string"
- }
- },
- "required": [
- "id",
- "data",
- "project_id",
- "status",
- "s3_path",
- "s3_bucket",
- "inserted_at"
- ]
- },
- "BackupsResponse": {
- "type": "object",
- "properties": {
- "tierId": {
- "type": "string"
- },
- "tierKey": {
+ "name": {
"type": "string"
},
"region": {
"type": "string"
},
- "walg_enabled": {
- "type": "boolean"
- },
- "backups": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "id": {
- "type": "number"
- },
- "data": {
- "type": "object"
- },
- "project_id": {
- "type": "number"
- },
- "status": {
- "type": "object"
- },
- "s3_path": {
- "type": "string"
- },
- "s3_bucket": {
- "type": "string"
- },
- "inserted_at": {
- "type": "string"
- }
- },
- "required": [
- "id",
- "data",
- "project_id",
- "status",
- "s3_path",
- "s3_bucket",
- "inserted_at"
- ]
- }
- },
- "physicalBackupData": {
- "type": "object",
- "properties": {
- "earliestPhysicalBackupDateUnix": {
- "required": true,
- "type": "number"
- },
- "latestPhysicalBackupDateUnix": {
- "required": true,
- "type": "number"
- }
- }
- }
- },
- "required": [
- "tierId",
- "tierKey",
- "region",
- "walg_enabled",
- "backups",
- "physicalBackupData"
- ]
- },
- "DownloadBackupBody": {
- "type": "object",
- "properties": {
- "id": {
- "type": "number"
- },
- "data": {
- "type": "object"
- },
- "inserted_at": {
- "type": "string"
- },
- "project_id": {
- "type": "number"
- },
- "s3_bucket": {
- "type": "string"
- },
- "s3_path": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- },
- "required": [
- "id",
- "data",
- "inserted_at",
- "project_id",
- "s3_bucket",
- "s3_path",
- "status"
- ]
- },
- "DownloadBackupResponse": {
- "type": "object",
- "properties": {
- "fileUrl": {
- "type": "string"
- }
- },
- "required": [
- "fileUrl"
- ]
- },
- "RestoreBackupBody": {
- "type": "object",
- "properties": {
- "id": {
- "type": "number"
- },
- "data": {
- "type": "object"
- },
- "inserted_at": {
- "type": "string"
- },
- "project_id": {
- "type": "number"
- },
- "s3_bucket": {
- "type": "string"
- },
- "s3_path": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- },
- "required": [
- "id",
- "data",
- "inserted_at",
- "project_id",
- "s3_bucket",
- "s3_path",
- "status"
- ]
- },
- "PointInTimeRestoreBody": {
- "type": "object",
- "properties": {
- "recovery_time_target_unix": {
- "type": "number"
- }
- },
- "required": [
- "recovery_time_target_unix"
- ]
- },
- "Organization": {
- "type": "object",
- "properties": {
- "id": {
- "type": "number"
- },
- "slug": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "billing_email": {
- "type": "string"
- },
- "stripe_customer_id": {
- "type": "string"
- }
- },
- "required": [
- "id",
- "slug",
- "name",
- "billing_email",
- "stripe_customer_id"
- ]
- },
- "CreateOrganizationBody": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- }
- },
- "required": [
- "name"
- ]
- },
- "UpdateOrganizationBody": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "billing_email": {
- "type": "string"
- }
- },
- "required": [
- "name",
- "billing_email"
- ]
- },
- "RemovedOrganization": {
- "type": "object",
- "properties": {
- "id": {
- "type": "number"
- },
- "slug": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "billing_email": {
- "type": "string"
- },
- "stripe_customer_id": {
- "type": "string"
- },
- "status": {
- "type": "string",
- "enum": [
- "ACTIVE",
- "REMOVED"
- ]
- }
- },
- "required": [
- "id",
- "slug",
- "name",
- "billing_email",
- "stripe_customer_id",
- "status"
- ]
- },
- "Member": {
- "type": "object",
- "properties": {
- "gotrue_id": {
- "type": "string"
- },
- "primary_email": {
- "type": "string"
- },
- "role_ids": {
- "type": "array",
- "items": {
- "type": "number"
- }
- },
- "username": {
- "type": "string"
- }
- },
- "required": [
- "gotrue_id",
- "primary_email",
- "role_ids",
- "username"
- ]
- },
- "AddMemberBody": {
- "type": "object",
- "properties": {
- "gotrue_id": {
- "type": "string"
- },
- "org_id": {
- "type": "number"
- },
- "user_id": {
- "type": "number"
- }
- },
- "required": [
- "gotrue_id",
- "user_id"
- ]
- },
- "RemoveMemberBody": {
- "type": "object",
- "properties": {
- "member_id": {
- "type": "number"
- }
- },
- "required": [
- "member_id"
- ]
- },
- "CreateTaxIdBody": {
- "type": "object",
- "properties": {
- "type": {
- "type": "object"
- },
- "value": {
- "type": "string"
- }
- },
- "required": [
- "type",
- "value"
- ]
- },
- "DeleteTaxIdBody": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- }
- },
- "required": [
- "id"
- ]
- },
- "TransferOrganizationBody": {
- "type": "object",
- "properties": {
- "member_id": {
- "type": "number"
- },
- "org_id": {
- "type": "number"
- }
- },
- "required": [
- "member_id",
- "org_id"
- ]
- },
- "InviteUserBody": {
- "type": "object",
- "properties": {
- "invited_email": {
- "type": "string"
- },
- "owner_id": {
- "type": "number"
- }
- },
- "required": [
- "invited_email",
- "owner_id"
- ]
- },
- "DetachPaymentMethodBody": {
- "type": "object",
- "properties": {
- "card_id": {
- "type": "string"
- }
- },
- "required": [
- "card_id"
- ]
- },
- "CreateColumnBody": {
- "type": "object",
- "properties": {
- "tableId": {
- "type": "number"
- },
- "name": {
- "type": "string"
- },
- "type": {
- "type": "string"
- },
- "check": {
- "type": "string"
- },
- "comment": {
- "type": "string"
- },
- "defaultValue": {
- "type": "object"
- },
- "defaultValueFormat": {
- "type": "string",
- "enum": [
- "expression",
- "literal"
- ]
- },
- "identityGeneration": {
- "type": "string",
- "enum": [
- "BY DEFAULT",
- "ALWAYS"
- ]
- },
- "isIdentity": {
- "type": "boolean"
- },
- "isNullable": {
- "type": "boolean"
- },
- "isPrimaryKey": {
- "type": "boolean"
- },
- "isUnique": {
- "type": "boolean"
- }
- },
- "required": [
- "tableId",
- "name",
- "type"
- ]
- },
- "UpdateColumnBody": {
- "type": "object",
- "properties": {
- "dropDefault": {
- "type": "boolean"
- },
- "id": {
- "type": "number",
- "pattern": {}
- },
- "name": {
- "type": "string"
- },
- "comment": {
- "type": "string"
- },
- "type": {
- "type": "string"
- },
- "defaultValue": {
- "type": "object"
- },
- "defaultValueFormat": {
- "type": "string",
- "enum": [
- "expression",
- "literal"
- ]
- },
- "identityGeneration": {
- "type": "string",
- "enum": [
- "BY DEFAULT",
- "ALWAYS"
- ]
- },
- "isIdentity": {
- "type": "boolean"
- },
- "isNullable": {
- "type": "boolean"
- },
- "isUnique": {
- "type": "boolean"
- }
- }
- },
- "CreateExtensionBody": {
- "type": "object",
- "properties": {
- "cascade": {
- "type": "boolean"
- },
- "name": {
- "type": "string"
- },
- "schema": {
- "type": "string"
- },
- "version": {
- "type": "string"
- }
- },
- "required": [
- "cascade",
- "name",
- "schema",
- "version"
- ]
- },
- "CreateFunctionBody": {
- "type": "object",
- "properties": {
- "args": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "behavior": {
- "type": "string",
- "enum": [
- "VOLATILE",
- "STABLE",
- "IMMUTABLE"
- ]
- },
- "config_params": {
- "type": "object"
- },
- "definition": {
- "type": "string"
- },
- "language": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "return_type": {
- "type": "string"
- },
- "schema": {
- "type": "string"
- },
- "security_definer": {
- "type": "boolean"
- }
- },
- "required": [
- "args",
- "behavior",
- "definition",
- "language",
- "name",
- "return_type",
- "schema",
- "security_definer"
- ]
- },
- "UpdateFunctionBody": {
- "type": "object",
- "properties": {
- "id": {
- "type": "number"
- },
- "args": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "behavior": {
- "type": "string",
- "enum": [
- "VOLATILE",
- "STABLE",
- "IMMUTABLE"
- ]
- },
- "config_params": {
- "type": "object"
- },
- "definition": {
- "type": "string"
- },
- "language": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "return_type": {
- "type": "string"
- },
- "schema": {
- "type": "string"
- },
- "security_definer": {
- "type": "boolean"
- }
- }
- },
- "CreatePolicyBody": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "table": {
- "type": "string"
- },
- "schema": {
- "type": "string"
- },
- "definition": {
- "type": "string"
- },
- "check": {
- "type": "string"
- },
- "action": {
- "type": "string",
- "enum": [
- "PERMISSIVE",
- "RESTRICTIVE"
- ]
- },
- "command": {
- "type": "string",
- "enum": [
- "SELECT",
- "INSERT",
- "UPDATE",
- "DELETE",
- "ALL"
- ]
- },
- "roles": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": [
- "name",
- "table"
- ]
- },
- "UpdatePolicyBody": {
- "type": "object",
- "properties": {
- "id": {
- "type": "number"
- },
- "name": {
- "type": "string"
- },
- "definition": {
- "type": "string"
- },
- "check": {
- "type": "string"
- },
- "roles": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "CreatePublicationBody": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "owner": {
- "type": "string"
- },
- "tables": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "publish_insert": {
- "type": "boolean"
- },
- "publish_update": {
- "type": "boolean"
- },
- "publish_delete": {
- "type": "boolean"
- },
- "publish_truncate": {
- "type": "boolean"
- }
- },
- "required": [
- "name",
- "owner",
- "tables",
- "publish_insert",
- "publish_update",
- "publish_delete",
- "publish_truncate"
- ]
- },
- "UpdatePublicationBody": {
- "type": "object",
- "properties": {
- "id": {
- "type": "number"
- },
- "name": {
- "type": "string"
- },
- "tables": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "publish_insert": {
- "type": "boolean"
- },
- "publish_update": {
- "type": "boolean"
- },
- "publish_delete": {
- "type": "boolean"
- },
- "publish_truncate": {
- "type": "boolean"
- }
- }
- },
- "RunQueryBody": {
- "type": "object",
- "properties": {
- "query": {
- "type": "string"
- }
- },
- "required": [
- "query"
- ]
- },
- "FormatQueryBody": {
- "type": "object",
- "properties": {
- "query": {
- "type": "string"
- }
- },
- "required": [
- "query"
- ]
- },
- "ValidateQueryBody": {
- "type": "object",
- "properties": {
- "query": {
- "type": "string"
- }
- },
- "required": [
- "query"
- ]
- },
- "SearchTableBody": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "schema": {
- "type": "string"
- }
- },
- "required": [
- "name",
- "schema"
- ]
- },
- "SearchColumnBody": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "schema": {
- "type": "string"
- }
- },
- "required": [
- "name",
- "schema"
- ]
- },
- "CreateSchemaBody": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "owner": {
- "type": "string"
- }
- },
- "required": [
- "name",
- "owner"
- ]
- },
- "UpdateSchemaBody": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "owner": {
- "type": "string"
- }
- }
- },
- "CreateTableBody": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "schema": {
- "type": "string"
- },
- "comment": {
- "type": "string"
- }
- },
- "required": [
- "name"
- ]
- },
- "UpdateTableBody": {
- "type": "object",
- "properties": {
- "id": {
- "type": "number"
- },
- "rls_enabled": {
- "type": "boolean"
- },
- "rls_forced": {
- "type": "boolean"
- },
- "replica_identity": {
- "type": "string",
- "enum": [
- "DEFAULT",
- "INDEX",
- "FULL",
- "NOTHING"
- ]
- },
- "replica_identity_index": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "schema": {
- "type": "string"
- },
- "comment": {
- "type": "string"
- }
- }
- },
- "CreateTriggerBody": {
- "type": "object",
- "properties": {
- "activation": {
- "type": "string",
- "enum": [
- "AFTER",
- "BEFORE"
- ]
- },
- "enabled_mode": {
- "type": "string",
- "enum": [
- "ORIGIN",
- "REPLICA",
- "ALWAYS",
- "DISABLED"
- ]
- },
- "events": {
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "INSERT",
- "UPDATE",
- "DELETE"
- ]
- }
- },
- "function_args": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "function_name": {
- "type": "string"
- },
- "function_schema": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "orientation": {
- "type": "string",
- "enum": [
- "ROW",
- "STATEMENT"
- ]
- },
- "schema": {
- "type": "string"
- },
- "table": {
- "type": "string"
- },
- "table_id": {
- "type": "number"
- }
- },
- "required": [
- "activation",
- "enabled_mode",
- "events",
- "function_args",
- "function_name",
- "function_schema",
- "name",
- "orientation",
- "schema",
- "table"
- ]
- },
- "UpdateTriggerBody": {
- "type": "object",
- "properties": {
- "id": {
- "type": "number"
- },
- "activation": {
- "type": "string",
- "enum": [
- "AFTER",
- "BEFORE"
- ]
- },
- "enabled_mode": {
- "type": "string",
- "enum": [
- "ORIGIN",
- "REPLICA",
- "ALWAYS",
- "DISABLED"
- ]
- },
- "events": {
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "INSERT",
- "UPDATE",
- "DELETE"
- ]
- }
- },
- "function_args": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "function_name": {
- "type": "string"
- },
- "function_schema": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "orientation": {
- "type": "string",
- "enum": [
- "ROW",
- "STATEMENT"
- ]
- },
- "schema": {
- "type": "string"
- },
- "table": {
- "type": "string"
- },
- "table_id": {
- "type": "number"
- }
- }
- },
- "AccessToken": {
- "type": "object",
- "properties": {
"created_at": {
"type": "string"
- },
- "id": {
- "type": "number"
- },
- "token_alias": {
- "type": "string"
- },
- "name": {
- "type": "string"
}
},
"required": [
- "created_at",
"id",
- "token_alias",
- "name"
- ]
- },
- "CreateAccessTokenBody": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- }
- },
- "required": [
- "name"
- ]
- },
- "CreateAccessTokenResponse": {
- "type": "object",
- "properties": {
- "created_at": {
- "type": "string"
- },
- "id": {
- "type": "number"
- },
- "token_alias": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "token": {
- "type": "string"
- }
- },
- "required": [
- "created_at",
- "id",
- "token_alias",
- "name",
- "token"
- ]
- },
- "SearchProfileBody": {
- "type": "object",
- "properties": {
- "keywords": {
- "type": "string"
- }
- },
- "required": [
- "keywords"
- ]
- },
- "Profile": {
- "type": "object",
- "properties": {
- "first_name": {
- "type": "string"
- },
- "gotrue_id": {
- "type": "string"
- },
- "id": {
- "type": "number"
- },
- "last_name": {
- "type": "string"
- },
- "username": {
- "type": "string"
- }
- },
- "required": [
- "first_name",
- "gotrue_id",
- "id",
- "last_name",
- "username"
- ]
- },
- "SubscriptionStatisticsResponse": {
- "type": "object",
- "properties": {
- "total_paid_projects": {
- "type": "number"
- },
- "total_free_projects": {
- "type": "number"
- },
- "total_active_free_projects": {
- "type": "number"
- },
- "total_paused_free_projects": {
- "type": "number"
- },
- "total_pro_projects": {
- "type": "number"
- },
- "total_payg_projects": {
- "type": "number"
- },
- "total_enterprise_projects": {
- "type": "number"
- }
- },
- "required": [
- "total_paid_projects",
- "total_free_projects",
- "total_active_free_projects",
- "total_paused_free_projects",
- "total_pro_projects",
- "total_payg_projects",
- "total_enterprise_projects"
- ]
- },
- "PasswordCheckBody": {
- "type": "object",
- "properties": {
- "password": {
- "type": "string"
- }
- },
- "required": [
- "password"
- ]
- },
- "PasswordCheckResponse": {
- "type": "object",
- "properties": {
- "result": {
- "type": "object",
- "properties": {
- "feedback": {
- "type": "object",
- "properties": {
- "warning": {
- "required": true,
- "type": "string"
- },
- "suggestions": {
- "required": true,
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "score": {
- "required": true,
- "type": "number"
- }
- }
- }
- },
- "required": [
- "result"
- ]
- },
- "Permission": {
- "type": "object",
- "properties": {
- "actions": {
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "analytics:Read",
- "auth:Execute",
- "billing:Read",
- "billing:Write",
- "functions:Read",
- "functions:Write",
- "infra:Execute",
- "sql:Read:Select",
- "sql:Write:Delete",
- "sql:Write:Insert",
- "sql:Write:Update",
- "storage:Admin:Read",
- "storage:Admin:Write",
- "tenant:Sql:Admin:Read",
- "tenant:Sql:Admin:Write",
- "tenant:Sql:CreateTable",
- "tenant:Sql:Write:Delete",
- "tenant:Sql:Write:Insert",
- "tenant:Sql:Query",
- "tenant:Sql:Read:Select",
- "tenant:Sql:Write:Update"
- ]
- }
- },
- "condition": {
- "type": "object",
- "nullable": true
- },
- "organization_id": {
- "type": "number"
- },
- "resources": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": [
- "actions",
- "condition",
"organization_id",
- "resources"
- ]
- },
- "ProfileResponse": {
- "type": "object",
- "properties": {
- "id": {
- "type": "number"
- },
- "auth0_id": {
- "type": "string"
- },
- "primary_email": {
- "type": "string"
- },
- "username": {
- "type": "string"
- },
- "first_name": {
- "type": "string"
- },
- "last_name": {
- "type": "string"
- },
- "mobile": {
- "type": "string"
- },
- "is_alpha_user": {
- "type": "boolean"
- },
- "gotrue_id": {
- "type": "string"
- },
- "free_project_limit": {
- "type": "number"
- }
- },
- "required": [
- "id",
- "auth0_id",
- "primary_email",
- "username",
- "first_name",
- "last_name",
- "mobile",
- "is_alpha_user",
- "gotrue_id",
- "free_project_limit"
- ]
- },
- "UpdateProfileBody": {
- "type": "object",
- "properties": {
- "first_name": {
- "type": "string"
- },
- "last_name": {
- "type": "string"
- }
- },
- "required": [
- "first_name",
- "last_name"
+ "name",
+ "region",
+ "created_at"
]
},
"CreateProjectBody": {
@@ -3433,1140 +944,6 @@
"region"
]
},
- "UpdatePasswordBody": {
- "type": "object",
- "properties": {
- "password": {
- "type": "string"
- }
- },
- "required": [
- "password"
- ]
- },
- "PoolingConfig": {
- "type": "object",
- "properties": {
- "db_dns_name": {
- "type": "string"
- },
- "db_host": {
- "type": "string"
- },
- "db_name": {
- "type": "string"
- },
- "db_port": {
- "type": "number"
- },
- "db_ssl": {
- "type": "boolean"
- },
- "db_user": {
- "type": "string"
- },
- "default_pool_size": {
- "type": "number"
- },
- "ignore_startup_parameters": {
- "type": "string"
- },
- "inserted_at": {
- "type": "string"
- },
- "pgbouncer_enabled": {
- "type": "boolean"
- },
- "pgbouncer_status": {
- "type": "string"
- },
- "pool_mode": {
- "type": "string"
- }
- },
- "required": [
- "db_dns_name",
- "db_host",
- "db_name",
- "db_port",
- "db_ssl",
- "db_user",
- "default_pool_size",
- "ignore_startup_parameters",
- "inserted_at",
- "pgbouncer_enabled",
- "pgbouncer_status",
- "pool_mode"
- ]
- },
- "UpdatePoolingConfigBody": {
- "type": "object",
- "properties": {
- "default_pool_size": {
- "type": "number"
- },
- "ignore_startup_parameters": {
- "type": "string"
- },
- "pgbouncer_enabled": {
- "type": "boolean"
- },
- "pool_mode": {
- "type": "string",
- "enum": [
- "transaction",
- "session",
- "statement"
- ]
- }
- },
- "required": [
- "default_pool_size",
- "ignore_startup_parameters",
- "pgbouncer_enabled",
- "pool_mode"
- ]
- },
- "UpdatePoolingConfigResponse": {
- "type": "object",
- "properties": {
- "default_pool_size": {
- "type": "number"
- },
- "ignore_startup_parameters": {
- "type": "string"
- },
- "pgbouncer_enabled": {
- "type": "boolean"
- },
- "pool_mode": {
- "enum": [
- "transaction",
- "session",
- "statement"
- ],
- "type": "string"
- }
- },
- "required": [
- "default_pool_size",
- "ignore_startup_parameters",
- "pgbouncer_enabled",
- "pool_mode"
- ]
- },
- "UpdateProjectBody": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- }
- },
- "required": [
- "name"
- ]
- },
- "Project": {
- "type": "object",
- "properties": {}
- },
- "RestartRequest": {
- "type": "object",
- "properties": {
- "services": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "source_notification_id": {
- "type": "string"
- },
- "region": {
- "type": "string"
- }
- },
- "required": [
- "services",
- "region"
- ]
- },
- "RestartServicesBody": {
- "type": "object",
- "properties": {
- "restartRequest": {
- "type": "object",
- "properties": {
- "services": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "source_notification_id": {
- "type": "string"
- },
- "region": {
- "type": "string"
- }
- },
- "required": [
- "services",
- "region"
- ]
- }
- },
- "required": [
- "restartRequest"
- ]
- },
- "UsageStatusResponse": {
- "type": "object",
- "properties": {
- "database": {
- "type": "string",
- "enum": [
- "fine",
- "approaching",
- "over"
- ]
- },
- "storage": {
- "type": "string",
- "enum": [
- "fine",
- "approaching",
- "over"
- ]
- },
- "database_bandwidth": {
- "type": "string",
- "enum": [
- "fine",
- "approaching",
- "over"
- ]
- },
- "storage_bandwidth": {
- "type": "string",
- "enum": [
- "fine",
- "approaching",
- "over"
- ]
- },
- "active_users": {
- "type": "string",
- "enum": [
- "fine",
- "approaching",
- "over"
- ]
- }
- },
- "required": [
- "database",
- "storage",
- "database_bandwidth",
- "storage_bandwidth",
- "active_users"
- ]
- },
- "SendEnterpriseRequestBody": {
- "type": "object",
- "properties": {
- "company": {
- "type": "string"
- },
- "email": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "name": {
- "type": "string"
- }
- },
- "required": [
- "company",
- "email",
- "message",
- "name"
- ]
- },
- "PreviewSubscriptionBody": {
- "type": "object",
- "properties": {
- "addons": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "payment_method": {
- "type": "string"
- },
- "proration_date": {
- "type": "number"
- },
- "tier": {
- "type": "string"
- }
- },
- "required": [
- "addons",
- "payment_method",
- "proration_date",
- "tier"
- ]
- },
- "UpdateSubscriptionBody": {
- "type": "object",
- "properties": {
- "addons": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "payment_method": {
- "type": "string"
- },
- "proration_date": {
- "type": "number"
- },
- "tier": {
- "type": "string"
- }
- },
- "required": [
- "addons",
- "payment_method",
- "proration_date",
- "tier"
- ]
- },
- "UpdatePostgrestConfigBody": {
- "type": "object",
- "properties": {
- "db_extra_search_path": {
- "type": "string"
- },
- "db_schema": {
- "type": "string"
- },
- "max_rows": {
- "type": "number"
- }
- },
- "required": [
- "db_extra_search_path",
- "db_schema",
- "max_rows"
- ]
- },
- "UpdateSecretsConfigBody": {
- "type": "object",
- "properties": {
- "jwt_secret": {
- "type": "string"
- },
- "change_tracking_id": {
- "type": "string"
- }
- },
- "required": [
- "jwt_secret",
- "change_tracking_id"
- ]
- },
- "UpdateStorageConfigBody": {
- "type": "object",
- "properties": {
- "fileSizeLimit": {
- "type": "number"
- }
- },
- "required": [
- "fileSizeLimit"
- ]
- },
- "OrganizationMembersResponse": {
- "type": "object",
- "properties": {
- "members": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "gotrue_id": {
- "type": "string"
- },
- "primary_email": {
- "type": "string"
- },
- "role_ids": {
- "type": "array",
- "items": {
- "type": "number"
- }
- },
- "username": {
- "type": "string"
- }
- },
- "required": [
- "gotrue_id",
- "primary_email",
- "role_ids",
- "username"
- ]
- }
- }
- },
- "required": [
- "members"
- ]
- },
- "PoolingRefConfig": {
- "type": "object",
- "properties": {
- "db_dns_name": {
- "type": "string"
- },
- "db_host": {
- "type": "string"
- },
- "db_name": {
- "type": "string"
- },
- "db_port": {
- "type": "number"
- },
- "db_ssl": {
- "type": "boolean"
- },
- "db_user": {
- "type": "string"
- },
- "default_pool_size": {
- "type": "number"
- },
- "ignore_startup_parameters": {
- "type": "string"
- },
- "inserted_at": {
- "type": "string"
- },
- "pgbouncer_enabled": {
- "type": "boolean"
- },
- "pgbouncer_status": {
- "type": "string"
- },
- "pool_mode": {
- "type": "string"
- }
- },
- "required": [
- "db_dns_name",
- "db_host",
- "db_name",
- "db_port",
- "db_ssl",
- "db_user",
- "default_pool_size",
- "ignore_startup_parameters",
- "inserted_at",
- "pgbouncer_enabled",
- "pgbouncer_status",
- "pool_mode"
- ]
- },
- "PoolingRefConfigResponse": {
- "type": "object",
- "properties": {
- "project": {
- "type": "object",
- "properties": {
- "db_dns_name": {
- "type": "string"
- },
- "db_host": {
- "type": "string"
- },
- "db_name": {
- "type": "string"
- },
- "db_port": {
- "type": "number"
- },
- "db_ssl": {
- "type": "boolean"
- },
- "db_user": {
- "type": "string"
- },
- "default_pool_size": {
- "type": "number"
- },
- "ignore_startup_parameters": {
- "type": "string"
- },
- "inserted_at": {
- "type": "string"
- },
- "pgbouncer_enabled": {
- "type": "boolean"
- },
- "pgbouncer_status": {
- "type": "string"
- },
- "pool_mode": {
- "type": "string"
- }
- },
- "required": [
- "db_dns_name",
- "db_host",
- "db_name",
- "db_port",
- "db_ssl",
- "db_user",
- "default_pool_size",
- "ignore_startup_parameters",
- "inserted_at",
- "pgbouncer_enabled",
- "pgbouncer_status",
- "pool_mode"
- ]
- }
- },
- "required": [
- "project"
- ]
- },
- "UpdatePoolingRefConfigBody": {
- "type": "object",
- "properties": {
- "default_pool_size": {
- "type": "number"
- },
- "ignore_startup_parameters": {
- "type": "string"
- },
- "pgbouncer_enabled": {
- "type": "boolean"
- },
- "pool_mode": {
- "type": "string",
- "enum": [
- "transaction",
- "session",
- "statement"
- ]
- }
- },
- "required": [
- "default_pool_size",
- "ignore_startup_parameters",
- "pgbouncer_enabled",
- "pool_mode"
- ]
- },
- "UpdatePoolingRefConfigResponse": {
- "type": "object",
- "properties": {
- "project": {
- "type": "object",
- "properties": {
- "default_pool_size": {
- "type": "number"
- },
- "ignore_startup_parameters": {
- "type": "string"
- },
- "pgbouncer_enabled": {
- "type": "boolean"
- },
- "pool_mode": {
- "type": "string",
- "enum": [
- "transaction",
- "session",
- "statement"
- ]
- }
- },
- "required": [
- "default_pool_size",
- "ignore_startup_parameters",
- "pgbouncer_enabled",
- "pool_mode"
- ]
- }
- },
- "required": [
- "project"
- ]
- },
- "ServiceApiKey": {
- "type": "object",
- "properties": {
- "api_key_encrypted": {
- "type": "string"
- },
- "tags": {
- "type": "string"
- },
- "name": {
- "type": "string"
- }
- },
- "required": [
- "api_key_encrypted",
- "tags",
- "name"
- ]
- },
- "AutoApiService": {
- "type": "object",
- "properties": {
- "endpoint": {
- "type": "string"
- },
- "restUrl": {
- "type": "string"
- },
- "project": {
- "type": "object",
- "properties": {
- "ref": {
- "required": true,
- "type": "string"
- }
- }
- },
- "defaultApiKey": {
- "type": "string"
- },
- "serviceApiKey": {
- "type": "string"
- },
- "id": {
- "type": "number"
- },
- "name": {
- "type": "string"
- },
- "app_config": {
- "type": "object"
- },
- "app": {
- "type": "object",
- "properties": {
- "id": {
- "required": true,
- "type": "number"
- },
- "name": {
- "required": true,
- "type": "string"
- }
- }
- },
- "service_api_keys": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "api_key_encrypted": {
- "type": "string"
- },
- "tags": {
- "type": "string"
- },
- "name": {
- "type": "string"
- }
- },
- "required": [
- "api_key_encrypted",
- "tags",
- "name"
- ]
- }
- }
- },
- "required": [
- "endpoint",
- "restUrl",
- "project",
- "defaultApiKey",
- "serviceApiKey",
- "id",
- "name",
- "app_config",
- "app",
- "service_api_keys"
- ]
- },
- "ApiResponse": {
- "type": "object",
- "properties": {
- "project": {
- "type": "object",
- "properties": {}
- },
- "autoApiService": {
- "type": "object",
- "properties": {
- "endpoint": {
- "type": "string"
- },
- "restUrl": {
- "type": "string"
- },
- "project": {
- "type": "object",
- "properties": {
- "ref": {
- "required": true,
- "type": "string"
- }
- }
- },
- "defaultApiKey": {
- "type": "string"
- },
- "serviceApiKey": {
- "type": "string"
- },
- "id": {
- "type": "number"
- },
- "name": {
- "type": "string"
- },
- "app_config": {
- "type": "object"
- },
- "app": {
- "type": "object",
- "properties": {
- "id": {
- "required": true,
- "type": "number"
- },
- "name": {
- "required": true,
- "type": "string"
- }
- }
- },
- "service_api_keys": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "api_key_encrypted": {
- "type": "string"
- },
- "tags": {
- "type": "string"
- },
- "name": {
- "type": "string"
- }
- },
- "required": [
- "api_key_encrypted",
- "tags",
- "name"
- ]
- }
- }
- },
- "required": [
- "endpoint",
- "restUrl",
- "project",
- "defaultApiKey",
- "serviceApiKey",
- "id",
- "name",
- "app_config",
- "app",
- "service_api_keys"
- ]
- }
- },
- "required": [
- "project",
- "autoApiService"
- ]
- },
- "JwtSecretUpdateStatus": {
- "type": "object",
- "properties": {
- "jwtSecretUpdateStatus": {
- "type": "object",
- "properties": {
- "change_tracking_id": {
- "required": true,
- "type": "string"
- },
- "error": {
- "required": false,
- "enum": [
- "PostgreSQLRestartFailed",
- "APIServicesConfigurationUpdateFailed",
- "APIServicesRestartFailed",
- "DatabaseAdminAPIConfigurationUpdateFailed",
- "SupabaseAPIKeyUpdateFailed",
- "APIGatewayUpdateFailed"
- ],
- "type": "string"
- },
- "progress": {
- "required": false,
- "enum": [
- "Started",
- "RestartedPostgreSQL",
- "UpdatedAPIServicesConfiguration",
- "RestartedAPIServices",
- "UpdatedDatabaseAdminAPIConfiguration",
- "UpdatedAPIGatewayConfiguration"
- ],
- "type": "string"
- },
- "status": {
- "required": true,
- "enum": [
- "Updating",
- "Updated",
- "Failed"
- ],
- "type": "string"
- }
- }
- }
- },
- "required": [
- "jwtSecretUpdateStatus"
- ]
- },
- "ServiceApiKeyResponse": {
- "type": "object",
- "properties": {
- "api_key": {
- "type": "string"
- },
- "api_key_encrypted": {
- "type": "string"
- },
- "tags": {
- "type": "string"
- },
- "name": {
- "type": "string"
- }
- },
- "required": [
- "api_key",
- "api_key_encrypted",
- "tags",
- "name"
- ]
- },
- "ServiceResponse": {
- "type": "object",
- "properties": {
- "service_api_keys": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "api_key": {
- "type": "string"
- },
- "api_key_encrypted": {
- "type": "string"
- },
- "tags": {
- "type": "string"
- },
- "name": {
- "type": "string"
- }
- },
- "required": [
- "api_key",
- "api_key_encrypted",
- "tags",
- "name"
- ]
- }
- },
- "id": {
- "type": "number"
- },
- "name": {
- "type": "string"
- },
- "app_config": {
- "type": "object"
- },
- "app": {
- "type": "object",
- "properties": {
- "id": {
- "required": true,
- "type": "number"
- },
- "name": {
- "required": true,
- "type": "string"
- }
- }
- }
- },
- "required": [
- "service_api_keys",
- "id",
- "name",
- "app_config",
- "app"
- ]
- },
- "ProjectResponse": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "organization_id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "region": {
- "type": "string"
- },
- "created_at": {
- "type": "string"
- }
- },
- "required": [
- "id",
- "organization_id",
- "name",
- "region",
- "created_at"
- ]
- },
- "SettingsResponse": {
- "type": "object",
- "properties": {
- "project": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "organization_id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "region": {
- "type": "string"
- },
- "created_at": {
- "type": "string"
- }
- },
- "required": [
- "id",
- "organization_id",
- "name",
- "region",
- "created_at"
- ]
- },
- "services": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "service_api_keys": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "api_key": {
- "type": "string"
- },
- "api_key_encrypted": {
- "type": "string"
- },
- "tags": {
- "type": "string"
- },
- "name": {
- "type": "string"
- }
- },
- "required": [
- "api_key",
- "api_key_encrypted",
- "tags",
- "name"
- ]
- }
- },
- "id": {
- "type": "number"
- },
- "name": {
- "type": "string"
- },
- "app_config": {
- "type": "object"
- },
- "app": {
- "type": "object",
- "properties": {
- "id": {
- "required": true,
- "type": "number"
- },
- "name": {
- "required": true,
- "type": "string"
- }
- }
- }
- },
- "required": [
- "service_api_keys",
- "id",
- "name",
- "app_config",
- "app"
- ]
- }
- }
- },
- "required": [
- "project",
- "services"
- ]
- },
- "GetCustomerBody": {
- "type": "object",
- "properties": {
- "stripe_customer_id": {
- "type": "string"
- }
- },
- "required": [
- "stripe_customer_id"
- ]
- },
- "CreateCustomerPortalSessionBody": {
- "type": "object",
- "properties": {
- "projectRef": {
- "type": "string",
- "minLength": 20,
- "maxLength": 20
- },
- "returnTo": {
- "type": "string"
- }
- },
- "required": [
- "projectRef",
- "returnTo"
- ]
- },
- "TelemetryEventBody": {
- "type": "object",
- "properties": {
- "category": {
- "type": "string"
- },
- "action": {
- "type": "string"
- },
- "label": {
- "type": "object"
- },
- "value": {
- "type": "string"
- }
- },
- "required": [
- "category",
- "action"
- ]
- },
- "CreateVercelEnvironmentVariableBody": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string"
- },
- "target": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string"
- },
- "value": {
- "type": "string"
- }
- },
- "required": [
- "key",
- "target",
- "type",
- "value"
- ]
- },
- "CreateSubscriptionBody": {
- "type": "object",
- "properties": {
- "projectId": {
- "type": "number"
- }
- },
- "required": [
- "projectId"
- ]
- },
- "StripeSyncBody": {
- "type": "object",
- "properties": {
- "organizationId": {
- "type": "number"
- }
- },
- "required": [
- "organizationId"
- ]
- },
- "Buffer": {
- "type": "object",
- "properties": {}
- },
"OrganizationResponse": {
"type": "object",
"properties": {
@@ -4581,6 +958,174 @@
"id",
"name"
]
+ },
+ "CreateOrganizationBody": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "FunctionResponse": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "ACTIVE",
+ "REMOVED",
+ "THROTTLED"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "type": "number"
+ },
+ "created_at": {
+ "type": "number"
+ },
+ "updated_at": {
+ "type": "number"
+ },
+ "verify_jwt": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "slug",
+ "name",
+ "status",
+ "version",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "CreateFunctionBody": {
+ "type": "object",
+ "properties": {
+ "slug": {
+ "type": "string",
+ "pattern": {}
+ },
+ "name": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string"
+ },
+ "verify_jwt": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "slug",
+ "name",
+ "body"
+ ]
+ },
+ "FunctionSlugResponse": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "ACTIVE",
+ "REMOVED",
+ "THROTTLED"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "type": "number"
+ },
+ "created_at": {
+ "type": "number"
+ },
+ "updated_at": {
+ "type": "number"
+ },
+ "verify_jwt": {
+ "type": "boolean"
+ },
+ "body": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "slug",
+ "name",
+ "status",
+ "version",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "UpdateFunctionBody": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string"
+ },
+ "verify_jwt": {
+ "type": "boolean"
+ }
+ }
+ },
+ "SecretResponse": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "value"
+ ]
+ },
+ "CreateSecretBody": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "pattern": {}
+ }
+ },
+ "required": [
+ "name",
+ "value"
+ ]
}
}
}