Skip to main content
PUT
/
resources
/
{id}
Update resource
curl --request PUT \
  --url https://api.ledgerbeam.com/v1/resources/{id} \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "My Updated Database",
  "description": "Updated production database connection",
  "type": "postgresql",
  "meta": {}
}'
{
  "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"
}

​
Overview

Update a specific resource. This endpoint allows you to modify the configuration and metadata of an existing resource.

Authorizations

​
API-KEY
string
header
required

API key for authentication

Path Parameters

​
id
string
required

Resource ID

Body

application/json
​
name
string

Resource name

Example:

"My Updated Database"

​
description
string

Resource description

Example:

"Updated production database connection"

​
type
string

Resource type

Example:

"postgresql"

​
meta
object

Resource connection metadata

Response

Resource updated 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"