Create Table

curl --request POST \
  --url https://api.example.com/api/database/tables \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tableName": "<string>",
  "columns": [
    {
      "columnName": "<string>",
      "isNullable": true,
      "isUnique": true,
      "defaultValue": "<string>"
    }
  ],
  "foreignKeys": [
    {
      "referenceTable": "<string>",
      "referenceColumns": [
        {
          "sourceColumn": "<string>",
          "referenceColumn": "<string>"
        }
      ],
      "constraintName": "<string>"
    }
  ],
  "rlsEnabled": true
}
'

import requests

url = "https://api.example.com/api/database/tables"

payload = {
    "tableName": "<string>",
    "columns": [
        {
            "columnName": "<string>",
            "isNullable": True,
            "isUnique": True,
            "defaultValue": "<string>"
        }
    ],
    "foreignKeys": [
        {
            "referenceTable": "<string>",
            "referenceColumns": [
                {
                    "sourceColumn": "<string>",
                    "referenceColumn": "<string>"
                }
            ],
            "constraintName": "<string>"
        }
    ],
    "rlsEnabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    tableName: '<string>',
    columns: [
      {
        columnName: '<string>',
        isNullable: true,
        isUnique: true,
        defaultValue: '<string>'
      }
    ],
    foreignKeys: [
      {
        referenceTable: '<string>',
        referenceColumns: [{sourceColumn: '<string>', referenceColumn: '<string>'}],
        constraintName: '<string>'
      }
    ],
    rlsEnabled: true
  })
};

fetch('https://api.example.com/api/database/tables', 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.example.com/api/database/tables",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'tableName' => '<string>',
    'columns' => [
        [
                'columnName' => '<string>',
                'isNullable' => true,
                'isUnique' => true,
                'defaultValue' => '<string>'
        ]
    ],
    'foreignKeys' => [
        [
                'referenceTable' => '<string>',
                'referenceColumns' => [
                                [
                                                                'sourceColumn' => '<string>',
                                                                'referenceColumn' => '<string>'
                                ]
                ],
                'constraintName' => '<string>'
        ]
    ],
    'rlsEnabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.example.com/api/database/tables"

	payload := strings.NewReader("{\n  \"tableName\": \"<string>\",\n  \"columns\": [\n    {\n      \"columnName\": \"<string>\",\n      \"isNullable\": true,\n      \"isUnique\": true,\n      \"defaultValue\": \"<string>\"\n    }\n  ],\n  \"foreignKeys\": [\n    {\n      \"referenceTable\": \"<string>\",\n      \"referenceColumns\": [\n        {\n          \"sourceColumn\": \"<string>\",\n          \"referenceColumn\": \"<string>\"\n        }\n      ],\n      \"constraintName\": \"<string>\"\n    }\n  ],\n  \"rlsEnabled\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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.post("https://api.example.com/api/database/tables")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tableName\": \"<string>\",\n  \"columns\": [\n    {\n      \"columnName\": \"<string>\",\n      \"isNullable\": true,\n      \"isUnique\": true,\n      \"defaultValue\": \"<string>\"\n    }\n  ],\n  \"foreignKeys\": [\n    {\n      \"referenceTable\": \"<string>\",\n      \"referenceColumns\": [\n        {\n          \"sourceColumn\": \"<string>\",\n          \"referenceColumn\": \"<string>\"\n        }\n      ],\n      \"constraintName\": \"<string>\"\n    }\n  ],\n  \"rlsEnabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/database/tables")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tableName\": \"<string>\",\n  \"columns\": [\n    {\n      \"columnName\": \"<string>\",\n      \"isNullable\": true,\n      \"isUnique\": true,\n      \"defaultValue\": \"<string>\"\n    }\n  ],\n  \"foreignKeys\": [\n    {\n      \"referenceTable\": \"<string>\",\n      \"referenceColumns\": [\n        {\n          \"sourceColumn\": \"<string>\",\n          \"referenceColumn\": \"<string>\"\n        }\n      ],\n      \"constraintName\": \"<string>\"\n    }\n  ],\n  \"rlsEnabled\": true\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Table created successfully",
  "tableName": "posts"
}

{
  "error": "VALIDATION_ERROR",
  "message": "Table name already exists",
  "statusCode": 400,
  "nextActions": "Choose a different table name"
}

{
  "error": "INVALID_FIELD_TYPE",
  "message": "Invalid field type: 'text'. Valid types are: string, date, datetime, integer, float, boolean, uuid, json",
  "statusCode": 422,
  "nextActions": "Use one of the valid field types"
}

POST

api

database

tables

Create Table

curl --request POST \
  --url https://api.example.com/api/database/tables \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tableName": "<string>",
  "columns": [
    {
      "columnName": "<string>",
      "isNullable": true,
      "isUnique": true,
      "defaultValue": "<string>"
    }
  ],
  "foreignKeys": [
    {
      "referenceTable": "<string>",
      "referenceColumns": [
        {
          "sourceColumn": "<string>",
          "referenceColumn": "<string>"
        }
      ],
      "constraintName": "<string>"
    }
  ],
  "rlsEnabled": true
}
'

import requests

url = "https://api.example.com/api/database/tables"

payload = {
    "tableName": "<string>",
    "columns": [
        {
            "columnName": "<string>",
            "isNullable": True,
            "isUnique": True,
            "defaultValue": "<string>"
        }
    ],
    "foreignKeys": [
        {
            "referenceTable": "<string>",
            "referenceColumns": [
                {
                    "sourceColumn": "<string>",
                    "referenceColumn": "<string>"
                }
            ],
            "constraintName": "<string>"
        }
    ],
    "rlsEnabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    tableName: '<string>',
    columns: [
      {
        columnName: '<string>',
        isNullable: true,
        isUnique: true,
        defaultValue: '<string>'
      }
    ],
    foreignKeys: [
      {
        referenceTable: '<string>',
        referenceColumns: [{sourceColumn: '<string>', referenceColumn: '<string>'}],
        constraintName: '<string>'
      }
    ],
    rlsEnabled: true
  })
};

fetch('https://api.example.com/api/database/tables', 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.example.com/api/database/tables",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'tableName' => '<string>',
    'columns' => [
        [
                'columnName' => '<string>',
                'isNullable' => true,
                'isUnique' => true,
                'defaultValue' => '<string>'
        ]
    ],
    'foreignKeys' => [
        [
                'referenceTable' => '<string>',
                'referenceColumns' => [
                                [
                                                                'sourceColumn' => '<string>',
                                                                'referenceColumn' => '<string>'
                                ]
                ],
                'constraintName' => '<string>'
        ]
    ],
    'rlsEnabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.example.com/api/database/tables"

	payload := strings.NewReader("{\n  \"tableName\": \"<string>\",\n  \"columns\": [\n    {\n      \"columnName\": \"<string>\",\n      \"isNullable\": true,\n      \"isUnique\": true,\n      \"defaultValue\": \"<string>\"\n    }\n  ],\n  \"foreignKeys\": [\n    {\n      \"referenceTable\": \"<string>\",\n      \"referenceColumns\": [\n        {\n          \"sourceColumn\": \"<string>\",\n          \"referenceColumn\": \"<string>\"\n        }\n      ],\n      \"constraintName\": \"<string>\"\n    }\n  ],\n  \"rlsEnabled\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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.post("https://api.example.com/api/database/tables")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tableName\": \"<string>\",\n  \"columns\": [\n    {\n      \"columnName\": \"<string>\",\n      \"isNullable\": true,\n      \"isUnique\": true,\n      \"defaultValue\": \"<string>\"\n    }\n  ],\n  \"foreignKeys\": [\n    {\n      \"referenceTable\": \"<string>\",\n      \"referenceColumns\": [\n        {\n          \"sourceColumn\": \"<string>\",\n          \"referenceColumn\": \"<string>\"\n        }\n      ],\n      \"constraintName\": \"<string>\"\n    }\n  ],\n  \"rlsEnabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/database/tables")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tableName\": \"<string>\",\n  \"columns\": [\n    {\n      \"columnName\": \"<string>\",\n      \"isNullable\": true,\n      \"isUnique\": true,\n      \"defaultValue\": \"<string>\"\n    }\n  ],\n  \"foreignKeys\": [\n    {\n      \"referenceTable\": \"<string>\",\n      \"referenceColumns\": [\n        {\n          \"sourceColumn\": \"<string>\",\n          \"referenceColumn\": \"<string>\"\n        }\n      ],\n      \"constraintName\": \"<string>\"\n    }\n  ],\n  \"rlsEnabled\": true\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Table created successfully",
  "tableName": "posts"
}

{
  "error": "VALIDATION_ERROR",
  "message": "Table name already exists",
  "statusCode": 400,
  "nextActions": "Choose a different table name"
}

{
  "error": "INVALID_FIELD_TYPE",
  "message": "Invalid field type: 'text'. Valid types are: string, date, datetime, integer, float, boolean, uuid, json",
  "statusCode": 422,
  "nextActions": "Use one of the valid field types"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

tableName

string

required

columns

object[]

required

Show child attributes

foreignKeys

object[]

Table-level foreign key constraints

Show child attributes

rlsEnabled

boolean

default:true

Enable Row Level Security on the table

Response

Table created

message

string

tableName

string

Tables

Schedules

Authentication

Records

Storage

Model Gateway

Functions

Realtime

Messaging

Payments

Secrets

Logs

Usage

Metadata

Health

Deployments

Dashboard

Create Table

Authorizations

Body

Response