Python SDK
from cognite.client.data_classes.data_modeling import ViewId
from cognite.client.data_classes.postgres_gateway import ViewTableWrite
table = ViewTableWrite(tablename="myCustom", options=ViewId(space="mySpace", external_id="myExternalId", version="v1"))
res = client.postgres_gateway.tables.create("myUserName",table)curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"type": "raw_rows",
"tablename": "<string>",
"options": {
"database": "<string>",
"table": "<string>",
"primaryKey": "<string>"
},
"columns": {}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
type: 'raw_rows',
tablename: '<string>',
options: {database: '<string>', table: '<string>', primaryKey: '<string>'},
columns: {}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username}', 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://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username}",
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([
'items' => [
[
'type' => 'raw_rows',
'tablename' => '<string>',
'options' => [
'database' => '<string>',
'table' => '<string>',
'primaryKey' => '<string>'
],
'columns' => [
]
]
]
]),
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://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username}"
payload := strings.NewReader("{\n \"items\": [\n {\n \"type\": \"raw_rows\",\n \"tablename\": \"<string>\",\n \"options\": {\n \"database\": \"<string>\",\n \"table\": \"<string>\",\n \"primaryKey\": \"<string>\"\n },\n \"columns\": {}\n }\n ]\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://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"type\": \"raw_rows\",\n \"tablename\": \"<string>\",\n \"options\": {\n \"database\": \"<string>\",\n \"table\": \"<string>\",\n \"primaryKey\": \"<string>\"\n },\n \"columns\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username}")
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 \"items\": [\n {\n \"type\": \"raw_rows\",\n \"tablename\": \"<string>\",\n \"options\": {\n \"database\": \"<string>\",\n \"table\": \"<string>\",\n \"primaryKey\": \"<string>\"\n },\n \"columns\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"columns": {},
"createdTime": 1730204346000,
"tablename": "<string>",
"options": {
"space": "<string>",
"externalId": "<string>",
"version": "<string>"
}
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}{
"error": {
"code": 422,
"message": "Extra inputs are not permitted: type"
}
}Required capabilities:
postgresGateway:WRITE
Create up to 10 tables.
POST
/
postgresgateway
/
tables
/
{username}
Python SDK
from cognite.client.data_classes.data_modeling import ViewId
from cognite.client.data_classes.postgres_gateway import ViewTableWrite
table = ViewTableWrite(tablename="myCustom", options=ViewId(space="mySpace", external_id="myExternalId", version="v1"))
res = client.postgres_gateway.tables.create("myUserName",table)curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"type": "raw_rows",
"tablename": "<string>",
"options": {
"database": "<string>",
"table": "<string>",
"primaryKey": "<string>"
},
"columns": {}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
type: 'raw_rows',
tablename: '<string>',
options: {database: '<string>', table: '<string>', primaryKey: '<string>'},
columns: {}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username}', 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://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username}",
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([
'items' => [
[
'type' => 'raw_rows',
'tablename' => '<string>',
'options' => [
'database' => '<string>',
'table' => '<string>',
'primaryKey' => '<string>'
],
'columns' => [
]
]
]
]),
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://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username}"
payload := strings.NewReader("{\n \"items\": [\n {\n \"type\": \"raw_rows\",\n \"tablename\": \"<string>\",\n \"options\": {\n \"database\": \"<string>\",\n \"table\": \"<string>\",\n \"primaryKey\": \"<string>\"\n },\n \"columns\": {}\n }\n ]\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://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"type\": \"raw_rows\",\n \"tablename\": \"<string>\",\n \"options\": {\n \"database\": \"<string>\",\n \"table\": \"<string>\",\n \"primaryKey\": \"<string>\"\n },\n \"columns\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username}")
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 \"items\": [\n {\n \"type\": \"raw_rows\",\n \"tablename\": \"<string>\",\n \"options\": {\n \"database\": \"<string>\",\n \"table\": \"<string>\",\n \"primaryKey\": \"<string>\"\n },\n \"columns\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"columns": {},
"createdTime": 1730204346000,
"tablename": "<string>",
"options": {
"space": "<string>",
"externalId": "<string>",
"version": "<string>"
}
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}{
"error": {
"code": 422,
"message": "Extra inputs are not permitted: type"
}
}Authorizations
oidc-tokenoauth2-client-credentialsoauth2-open-industrial-dataoauth2-auth-code
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Path Parameters
The name of the username (a.k.a. database) to be managed from the API Username to authenticate the user on the DB.
Body
application/json
List of tables to create
Required array length:
1 - 10 elements- Create Raw Table
- Create Fdm table
Show child attributes
Show child attributes
Response
List of created tables
Show child attributes
Show child attributes
Last modified on July 13, 2026
Was this page helpful?
⌘I