Browse schemas, tables, and keys
curl --request POST \
--url https://api.rafftechnologies.com/api/v1/databases/{database_id}/browse \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"path": [
"public",
"users"
],
"cursor": "<string>",
"match": "user:*",
"limit": 123
}
'import requests
url = "https://api.rafftechnologies.com/api/v1/databases/{database_id}/browse"
payload = {
"path": ["public", "users"],
"cursor": "<string>",
"match": "user:*",
"limit": 123
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({path: ['public', 'users'], cursor: '<string>', match: 'user:*', limit: 123})
};
fetch('https://api.rafftechnologies.com/api/v1/databases/{database_id}/browse', 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.rafftechnologies.com/api/v1/databases/{database_id}/browse",
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([
'path' => [
'public',
'users'
],
'cursor' => '<string>',
'match' => 'user:*',
'limit' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-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 := "https://api.rafftechnologies.com/api/v1/databases/{database_id}/browse"
payload := strings.NewReader("{\n \"path\": [\n \"public\",\n \"users\"\n ],\n \"cursor\": \"<string>\",\n \"match\": \"user:*\",\n \"limit\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.rafftechnologies.com/api/v1/databases/{database_id}/browse")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"path\": [\n \"public\",\n \"users\"\n ],\n \"cursor\": \"<string>\",\n \"match\": \"user:*\",\n \"limit\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rafftechnologies.com/api/v1/databases/{database_id}/browse")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"path\": [\n \"public\",\n \"users\"\n ],\n \"cursor\": \"<string>\",\n \"match\": \"user:*\",\n \"limit\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"kind": "nodes",
"nodes": [
{
"name": "<string>",
"kind": "<string>",
"detail": "<string>"
}
],
"columns": [
"<string>"
],
"rows": [
{
"cells": [
"<string>"
],
"nulls": [
true
]
}
],
"next_cursor": "<string>",
"meta": {}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Query & data
Browse schemas, tables, and keys
Walk the database one level at a time with path.
- PostgreSQL, MySQL, ClickHouse:
[]lists schemas,[schema]lists its tables,[schema, table]returns a page of rows. Page withlimitandnext_cursor. - Valkey:
[]lists keys (filter withmatch, for exampleuser:*),[key]returns the key’s value with its type and TTL inmeta.
A response has kind: nodes (a list in nodes) or kind: rows (columns and rows).
POST
/
api
/
v1
/
databases
/
{database_id}
/
browse
Browse schemas, tables, and keys
curl --request POST \
--url https://api.rafftechnologies.com/api/v1/databases/{database_id}/browse \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"path": [
"public",
"users"
],
"cursor": "<string>",
"match": "user:*",
"limit": 123
}
'import requests
url = "https://api.rafftechnologies.com/api/v1/databases/{database_id}/browse"
payload = {
"path": ["public", "users"],
"cursor": "<string>",
"match": "user:*",
"limit": 123
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({path: ['public', 'users'], cursor: '<string>', match: 'user:*', limit: 123})
};
fetch('https://api.rafftechnologies.com/api/v1/databases/{database_id}/browse', 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.rafftechnologies.com/api/v1/databases/{database_id}/browse",
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([
'path' => [
'public',
'users'
],
'cursor' => '<string>',
'match' => 'user:*',
'limit' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-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 := "https://api.rafftechnologies.com/api/v1/databases/{database_id}/browse"
payload := strings.NewReader("{\n \"path\": [\n \"public\",\n \"users\"\n ],\n \"cursor\": \"<string>\",\n \"match\": \"user:*\",\n \"limit\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.rafftechnologies.com/api/v1/databases/{database_id}/browse")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"path\": [\n \"public\",\n \"users\"\n ],\n \"cursor\": \"<string>\",\n \"match\": \"user:*\",\n \"limit\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rafftechnologies.com/api/v1/databases/{database_id}/browse")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"path\": [\n \"public\",\n \"users\"\n ],\n \"cursor\": \"<string>\",\n \"match\": \"user:*\",\n \"limit\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"kind": "nodes",
"nodes": [
{
"name": "<string>",
"kind": "<string>",
"detail": "<string>"
}
],
"columns": [
"<string>"
],
"rows": [
{
"cells": [
"<string>"
],
"nulls": [
true
]
}
],
"next_cursor": "<string>",
"meta": {}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
API key for authentication. Each key is bound to a specific account.
Path Parameters
Database ID (UUID) or short id (the database_id field, e.g. a1b2c3d4)
Body
application/json
Response
One level of the database
Last modified on October 5, 2026