Update table name and description.
curl --request PATCH \
--url http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"expectedSchemaVersion": 1,
"name": "example"
}
'import requests
url = "http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}"
payload = {
"expectedSchemaVersion": 1,
"name": "example"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({expectedSchemaVersion: 1, name: 'example'})
};
fetch('http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "4310",
CURLOPT_URL => "http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}",
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([
'expectedSchemaVersion' => 1,
'name' => 'example'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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 := "http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}"
payload := strings.NewReader("{\n \"expectedSchemaVersion\": 1,\n \"name\": \"example\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expectedSchemaVersion\": 1,\n \"name\": \"example\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expectedSchemaVersion\": 1,\n \"name\": \"example\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"databaseId": "<string>",
"orgId": "<string>",
"name": "<string>",
"schemaVersion": 1073741824,
"rowCount": 2500000,
"state": "active",
"createdAt": "2024-01-01T12:30:00.000Z",
"updatedAt": "2024-01-01T12:30:00.000Z",
"description": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}Update table
Update table name and description.
PATCH
/
v1
/
orgs
/
{orgId}
/
databases
/
{databaseId}
/
tables
/
{tableId}
Update table name and description.
curl --request PATCH \
--url http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"expectedSchemaVersion": 1,
"name": "example"
}
'import requests
url = "http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}"
payload = {
"expectedSchemaVersion": 1,
"name": "example"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({expectedSchemaVersion: 1, name: 'example'})
};
fetch('http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "4310",
CURLOPT_URL => "http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}",
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([
'expectedSchemaVersion' => 1,
'name' => 'example'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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 := "http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}"
payload := strings.NewReader("{\n \"expectedSchemaVersion\": 1,\n \"name\": \"example\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expectedSchemaVersion\": 1,\n \"name\": \"example\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:4310/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expectedSchemaVersion\": 1,\n \"name\": \"example\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"databaseId": "<string>",
"orgId": "<string>",
"name": "<string>",
"schemaVersion": 1073741824,
"rowCount": 2500000,
"state": "active",
"createdAt": "2024-01-01T12:30:00.000Z",
"updatedAt": "2024-01-01T12:30:00.000Z",
"description": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}Authorizations
apiKeyoauth
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Bound to actor, operation, target, schema version and canonical payload; changed input returns 409.
Required string length:
8 - 255Path Parameters
Pattern:
^[0-7][0-9A-HJKMNP-TV-Z]{25}$Pattern:
^[0-7][0-9A-HJKMNP-TV-Z]{25}$Pattern:
^[0-7][0-9A-HJKMNP-TV-Z]{25}$Body
application/json
Response
Authorised operation result.
Pattern:
^[0-7][0-9A-HJKMNP-TV-Z]{25}$Pattern:
^[0-7][0-9A-HJKMNP-TV-Z]{25}$Pattern:
^[0-7][0-9A-HJKMNP-TV-Z]{25}$Required string length:
1 - 255Required range:
1 <= x <= 2147483647Required range:
0 <= x <= 5000000Available options:
active, creating, maintenance, deleting, deleted, failed UTC instant with mandatory Z and at most three fractional digits.
Pattern:
^(?!0000)\d{4}-\d{2}-\d{2}T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d{1,3})?Z$Example:
"2024-01-01T12:30:00.000Z"
UTC instant with mandatory Z and at most three fractional digits.
Pattern:
^(?!0000)\d{4}-\d{2}-\d{2}T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d{1,3})?Z$Example:
"2024-01-01T12:30:00.000Z"
Maximum string length:
4096Was this page helpful?
