Skip to main content
POST
/
postgresgateway
/
list
Python SDK
user_list = client.postgres_gateway.users.list(limit=5)

for user in client.postgres_gateway.users:
    user # do something with the user

for user_list in client.postgres_gateway.users(chunk_size=25):
    user_list # do something with the users
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"limit": 5,
"cursor": "<string>"
}
'
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({limit: 5, cursor: '<string>'})
};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/list', 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/list",
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([
'limit' => 5,
'cursor' => '<string>'
]),
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/list"

payload := strings.NewReader("{\n \"limit\": 5,\n \"cursor\": \"<string>\"\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/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"limit\": 5,\n \"cursor\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/postgresgateway/list")

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 \"limit\": 5,\n \"cursor\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "username": "<string>",
      "createdTime": 1730204346000,
      "lastUpdatedTime": 1730204346000,
      "sessionId": 4503599627370496
    }
  ],
  "nextCursor": "<string>"
}
{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}
{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}

Authorizations

Authorization
string
header
required

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.

Body

application/json
limit
integer<int32>
Required range: 1 <= x <= 10
cursor
string

Cursor for pagination

Response

List of users paginated

items
Items · object[]
required
Maximum array length: 100
nextCursor
string

Cursor for pagination

Last modified on July 10, 2026