Create resource
curl --request POST \
--url https://api.ledgerbeam.com/v1/resources \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "My Database",
"type": "postgresql",
"meta": {
"connection": "postgresql",
"host": "localhost",
"port": "5432",
"name": "mydb",
"username": "user",
"password": "password",
"options": [],
"ssl": {
"ssl_mode": "require",
"certificate_type": "server",
"client_ca_certificate_file": "<string>",
"server_ca_certificate_file": "<string>",
"client_key_file": "<string>"
}
},
"description": "Production database connection"
}
'import requests
url = "https://api.ledgerbeam.com/v1/resources"
payload = {
"name": "My Database",
"type": "postgresql",
"meta": {
"connection": "postgresql",
"host": "localhost",
"port": "5432",
"name": "mydb",
"username": "user",
"password": "password",
"options": [],
"ssl": {
"ssl_mode": "require",
"certificate_type": "server",
"client_ca_certificate_file": "<string>",
"server_ca_certificate_file": "<string>",
"client_key_file": "<string>"
}
},
"description": "Production database connection"
}
headers = {
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'My Database',
type: 'postgresql',
meta: {
connection: 'postgresql',
host: 'localhost',
port: '5432',
name: 'mydb',
username: 'user',
password: 'password',
options: [],
ssl: {
ssl_mode: 'require',
certificate_type: 'server',
client_ca_certificate_file: '<string>',
server_ca_certificate_file: '<string>',
client_key_file: '<string>'
}
},
description: 'Production database connection'
})
};
fetch('https://api.ledgerbeam.com/v1/resources', 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.ledgerbeam.com/v1/resources",
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([
'name' => 'My Database',
'type' => 'postgresql',
'meta' => [
'connection' => 'postgresql',
'host' => 'localhost',
'port' => '5432',
'name' => 'mydb',
'username' => 'user',
'password' => 'password',
'options' => [
],
'ssl' => [
'ssl_mode' => 'require',
'certificate_type' => 'server',
'client_ca_certificate_file' => '<string>',
'server_ca_certificate_file' => '<string>',
'client_key_file' => '<string>'
]
],
'description' => 'Production database connection'
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"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.ledgerbeam.com/v1/resources"
payload := strings.NewReader("{\n \"name\": \"My Database\",\n \"type\": \"postgresql\",\n \"meta\": {\n \"connection\": \"postgresql\",\n \"host\": \"localhost\",\n \"port\": \"5432\",\n \"name\": \"mydb\",\n \"username\": \"user\",\n \"password\": \"password\",\n \"options\": [],\n \"ssl\": {\n \"ssl_mode\": \"require\",\n \"certificate_type\": \"server\",\n \"client_ca_certificate_file\": \"<string>\",\n \"server_ca_certificate_file\": \"<string>\",\n \"client_key_file\": \"<string>\"\n }\n },\n \"description\": \"Production database connection\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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.ledgerbeam.com/v1/resources")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My Database\",\n \"type\": \"postgresql\",\n \"meta\": {\n \"connection\": \"postgresql\",\n \"host\": \"localhost\",\n \"port\": \"5432\",\n \"name\": \"mydb\",\n \"username\": \"user\",\n \"password\": \"password\",\n \"options\": [],\n \"ssl\": {\n \"ssl_mode\": \"require\",\n \"certificate_type\": \"server\",\n \"client_ca_certificate_file\": \"<string>\",\n \"server_ca_certificate_file\": \"<string>\",\n \"client_key_file\": \"<string>\"\n }\n },\n \"description\": \"Production database connection\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ledgerbeam.com/v1/resources")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"My Database\",\n \"type\": \"postgresql\",\n \"meta\": {\n \"connection\": \"postgresql\",\n \"host\": \"localhost\",\n \"port\": \"5432\",\n \"name\": \"mydb\",\n \"username\": \"user\",\n \"password\": \"password\",\n \"options\": [],\n \"ssl\": {\n \"ssl_mode\": \"require\",\n \"certificate_type\": \"server\",\n \"client_ca_certificate_file\": \"<string>\",\n \"server_ca_certificate_file\": \"<string>\",\n \"client_key_file\": \"<string>\"\n }\n },\n \"description\": \"Production database connection\"\n}"
response = http.request(request)
puts response.read_body{
"id": "res_123456789",
"name": "My Database",
"description": "Production database connection",
"type": "postgresql",
"status": "active",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:35:00Z"
}{
"error": "Unauthorized access"
}Resources
Create Resource
Create a new resource
POST
/
resources
Create resource
curl --request POST \
--url https://api.ledgerbeam.com/v1/resources \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "My Database",
"type": "postgresql",
"meta": {
"connection": "postgresql",
"host": "localhost",
"port": "5432",
"name": "mydb",
"username": "user",
"password": "password",
"options": [],
"ssl": {
"ssl_mode": "require",
"certificate_type": "server",
"client_ca_certificate_file": "<string>",
"server_ca_certificate_file": "<string>",
"client_key_file": "<string>"
}
},
"description": "Production database connection"
}
'import requests
url = "https://api.ledgerbeam.com/v1/resources"
payload = {
"name": "My Database",
"type": "postgresql",
"meta": {
"connection": "postgresql",
"host": "localhost",
"port": "5432",
"name": "mydb",
"username": "user",
"password": "password",
"options": [],
"ssl": {
"ssl_mode": "require",
"certificate_type": "server",
"client_ca_certificate_file": "<string>",
"server_ca_certificate_file": "<string>",
"client_key_file": "<string>"
}
},
"description": "Production database connection"
}
headers = {
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'My Database',
type: 'postgresql',
meta: {
connection: 'postgresql',
host: 'localhost',
port: '5432',
name: 'mydb',
username: 'user',
password: 'password',
options: [],
ssl: {
ssl_mode: 'require',
certificate_type: 'server',
client_ca_certificate_file: '<string>',
server_ca_certificate_file: '<string>',
client_key_file: '<string>'
}
},
description: 'Production database connection'
})
};
fetch('https://api.ledgerbeam.com/v1/resources', 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.ledgerbeam.com/v1/resources",
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([
'name' => 'My Database',
'type' => 'postgresql',
'meta' => [
'connection' => 'postgresql',
'host' => 'localhost',
'port' => '5432',
'name' => 'mydb',
'username' => 'user',
'password' => 'password',
'options' => [
],
'ssl' => [
'ssl_mode' => 'require',
'certificate_type' => 'server',
'client_ca_certificate_file' => '<string>',
'server_ca_certificate_file' => '<string>',
'client_key_file' => '<string>'
]
],
'description' => 'Production database connection'
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"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.ledgerbeam.com/v1/resources"
payload := strings.NewReader("{\n \"name\": \"My Database\",\n \"type\": \"postgresql\",\n \"meta\": {\n \"connection\": \"postgresql\",\n \"host\": \"localhost\",\n \"port\": \"5432\",\n \"name\": \"mydb\",\n \"username\": \"user\",\n \"password\": \"password\",\n \"options\": [],\n \"ssl\": {\n \"ssl_mode\": \"require\",\n \"certificate_type\": \"server\",\n \"client_ca_certificate_file\": \"<string>\",\n \"server_ca_certificate_file\": \"<string>\",\n \"client_key_file\": \"<string>\"\n }\n },\n \"description\": \"Production database connection\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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.ledgerbeam.com/v1/resources")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My Database\",\n \"type\": \"postgresql\",\n \"meta\": {\n \"connection\": \"postgresql\",\n \"host\": \"localhost\",\n \"port\": \"5432\",\n \"name\": \"mydb\",\n \"username\": \"user\",\n \"password\": \"password\",\n \"options\": [],\n \"ssl\": {\n \"ssl_mode\": \"require\",\n \"certificate_type\": \"server\",\n \"client_ca_certificate_file\": \"<string>\",\n \"server_ca_certificate_file\": \"<string>\",\n \"client_key_file\": \"<string>\"\n }\n },\n \"description\": \"Production database connection\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ledgerbeam.com/v1/resources")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"My Database\",\n \"type\": \"postgresql\",\n \"meta\": {\n \"connection\": \"postgresql\",\n \"host\": \"localhost\",\n \"port\": \"5432\",\n \"name\": \"mydb\",\n \"username\": \"user\",\n \"password\": \"password\",\n \"options\": [],\n \"ssl\": {\n \"ssl_mode\": \"require\",\n \"certificate_type\": \"server\",\n \"client_ca_certificate_file\": \"<string>\",\n \"server_ca_certificate_file\": \"<string>\",\n \"client_key_file\": \"<string>\"\n }\n },\n \"description\": \"Production database connection\"\n}"
response = http.request(request)
puts response.read_body{
"id": "res_123456789",
"name": "My Database",
"description": "Production database connection",
"type": "postgresql",
"status": "active",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:35:00Z"
}{
"error": "Unauthorized access"
}Overview
Create a new resource. Resources represent data sources like databases, APIs, or files that can be connected to Ledgerbeam for data analysis and processing.Authorizations
API key for authentication
Body
application/json
Response
Resource created successfully
Resource ID
Example:
"res_123456789"
Resource name
Example:
"My Database"
Resource description
Example:
"Production database connection"
Resource type
Example:
"postgresql"
Resource status
Available options:
active, inactive, error Example:
"active"
Creation timestamp
Example:
"2024-01-15T10:30:00Z"
Last update timestamp
Example:
"2024-01-15T10:35:00Z"
⌘I

