Python SDK
res = client.postgres_gateway.tables.retrieve("myUserName", 'myCustom')
res = client.postgres_gateway.tables.retrieve("myUserName", ["myCustom", "myCustom2"])curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username}/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"tablename": "<string>"
}
],
"ignoreUnknownIds": true
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({items: [{tablename: '<string>'}], ignoreUnknownIds: true})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username}/byids', 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}/byids",
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' => [
[
'tablename' => '<string>'
]
],
'ignoreUnknownIds' => 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://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username}/byids"
payload := strings.NewReader("{\n \"items\": [\n {\n \"tablename\": \"<string>\"\n }\n ],\n \"ignoreUnknownIds\": 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://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username}/byids")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"tablename\": \"<string>\"\n }\n ],\n \"ignoreUnknownIds\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username}/byids")
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 \"tablename\": \"<string>\"\n }\n ],\n \"ignoreUnknownIds\": true\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"columns": {},
"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:READ
Retrieve a list of postgres tables for a user by their table names, optionally ignoring unknown table names
POST
/
postgresgateway
/
tables
/
{username}
/
byids
Python SDK
res = client.postgres_gateway.tables.retrieve("myUserName", 'myCustom')
res = client.postgres_gateway.tables.retrieve("myUserName", ["myCustom", "myCustom2"])curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username}/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"tablename": "<string>"
}
],
"ignoreUnknownIds": true
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({items: [{tablename: '<string>'}], ignoreUnknownIds: true})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username}/byids', 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}/byids",
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' => [
[
'tablename' => '<string>'
]
],
'ignoreUnknownIds' => 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://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username}/byids"
payload := strings.NewReader("{\n \"items\": [\n {\n \"tablename\": \"<string>\"\n }\n ],\n \"ignoreUnknownIds\": 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://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username}/byids")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"tablename\": \"<string>\"\n }\n ],\n \"ignoreUnknownIds\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/tables/{username}/byids")
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 \"tablename\": \"<string>\"\n }\n ],\n \"ignoreUnknownIds\": true\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"columns": {},
"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
Response
List postgres tables by table names
Show child attributes
Show child attributes
Last modified on July 13, 2026
Was this page helpful?
⌘I