curl --request PATCH \
--url https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"schemaVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {},
"seed": "<string>",
"generatorConfig": {},
"basePath": "<string>",
"rateLimitRpm": 2,
"corsOrigins": [
"<string>"
],
"requireAuth": true
}
'import requests
url = "https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}"
payload = {
"name": "<string>",
"description": "<string>",
"schemaVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {},
"seed": "<string>",
"generatorConfig": {},
"basePath": "<string>",
"rateLimitRpm": 2,
"corsOrigins": ["<string>"],
"requireAuth": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
schemaVersionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
config: {},
seed: '<string>',
generatorConfig: {},
basePath: '<string>',
rateLimitRpm: 2,
corsOrigins: ['<string>'],
requireAuth: true
})
};
fetch('https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'schemaVersionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'config' => [
],
'seed' => '<string>',
'generatorConfig' => [
],
'basePath' => '<string>',
'rateLimitRpm' => 2,
'corsOrigins' => [
'<string>'
],
'requireAuth' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"schemaVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {},\n \"seed\": \"<string>\",\n \"generatorConfig\": {},\n \"basePath\": \"<string>\",\n \"rateLimitRpm\": 2,\n \"corsOrigins\": [\n \"<string>\"\n ],\n \"requireAuth\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"schemaVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {},\n \"seed\": \"<string>\",\n \"generatorConfig\": {},\n \"basePath\": \"<string>\",\n \"rateLimitRpm\": 2,\n \"corsOrigins\": [\n \"<string>\"\n ],\n \"requireAuth\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"schemaVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {},\n \"seed\": \"<string>\",\n \"generatorConfig\": {},\n \"basePath\": \"<string>\",\n \"rateLimitRpm\": 2,\n \"corsOrigins\": [\n \"<string>\"\n ],\n \"requireAuth\": true\n}"
response = http.request(request)
puts response.read_bodyUpdate Source
curl --request PATCH \
--url https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"schemaVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {},
"seed": "<string>",
"generatorConfig": {},
"basePath": "<string>",
"rateLimitRpm": 2,
"corsOrigins": [
"<string>"
],
"requireAuth": true
}
'import requests
url = "https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}"
payload = {
"name": "<string>",
"description": "<string>",
"schemaVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {},
"seed": "<string>",
"generatorConfig": {},
"basePath": "<string>",
"rateLimitRpm": 2,
"corsOrigins": ["<string>"],
"requireAuth": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
schemaVersionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
config: {},
seed: '<string>',
generatorConfig: {},
basePath: '<string>',
rateLimitRpm: 2,
corsOrigins: ['<string>'],
requireAuth: true
})
};
fetch('https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'schemaVersionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'config' => [
],
'seed' => '<string>',
'generatorConfig' => [
],
'basePath' => '<string>',
'rateLimitRpm' => 2,
'corsOrigins' => [
'<string>'
],
'requireAuth' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"schemaVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {},\n \"seed\": \"<string>\",\n \"generatorConfig\": {},\n \"basePath\": \"<string>\",\n \"rateLimitRpm\": 2,\n \"corsOrigins\": [\n \"<string>\"\n ],\n \"requireAuth\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"schemaVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {},\n \"seed\": \"<string>\",\n \"generatorConfig\": {},\n \"basePath\": \"<string>\",\n \"rateLimitRpm\": 2,\n \"corsOrigins\": [\n \"<string>\"\n ],\n \"requireAuth\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"schemaVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {},\n \"seed\": \"<string>\",\n \"generatorConfig\": {},\n \"basePath\": \"<string>\",\n \"rateLimitRpm\": 2,\n \"corsOrigins\": [\n \"<string>\"\n ],\n \"requireAuth\": true\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Team API key created under /api/api-keys. Prefix: sb_api_.
Path Parameters
Project UUID in the team associated with the API key.
Source UUID. For runtime endpoints this identifies the source backing the table; for public v1 it identifies the source resource inside the project.
Body
Patch mutable source settings. Omitted fields are unchanged.
Switches the source to a different schema version.
Source config patch. Runtime target values should already be normalized for storage.
postgres, mysql Set deterministic seed or null to clear.
Generator override patch.
Runtime API per-source rate limit (requests per minute).
x >= 1Allowed CORS origins for runtime API requests.
Whether runtime endpoints require x-api-key authentication.
Response
Updated source
Source configuration. For Supabase runtime targets, responses include runtimeTarget.connectionSecretId and never return plaintext runtimeTarget.connectionString.
postgres, mysql