Skip to main content
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"
}
'
{
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.ledgerbeam.com/llms.txt

Use this file to discover all available pages before exploring further.

​
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
string
header
required

API key for authentication

Body

application/json
​
name
string
required

Resource name

Example:

"My Database"

​
type
string
required

Resource type

Example:

"postgresql"

​
meta
object
required

Resource connection metadata

​
description
string

Resource description

Example:

"Production database connection"

Response

Resource created successfully

​
id
string

Resource ID

Example:

"res_123456789"

​
name
string

Resource name

Example:

"My Database"

​
description
string

Resource description

Example:

"Production database connection"

​
type
string

Resource type

Example:

"postgresql"

​
status
enum<string>

Resource status

Available options:
active,
inactive,
error
Example:

"active"

​
created_at
string<date-time>

Creation timestamp

Example:

"2024-01-15T10:30:00Z"

​
updated_at
string<date-time>

Last update timestamp

Example:

"2024-01-15T10:35:00Z"