Skip to main content
POST
Create resource

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"