Skip to main content
POST
/
resources
/
validate-connection
Validate connection
curl --request POST \
  --url https://api.ledgerbeam.com/v1/resources/validate-connection \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "resource_type": "postgresql",
  "meta": {}
}'
{
  "status": "connected",
  "message": "Connection successful",
  "checked_at": "2024-01-15T10:30:00Z"
}

​
Overview

Validate a resource connection before creating it. This endpoint tests the connection parameters without actually creating the resource, allowing you to verify connectivity and configuration.

Authorizations

​
API-KEY
string
header
required

API key for authentication

Body

application/json
​
resource_type
string
required

Resource type to validate

Example:

"postgresql"

​
meta
object
required

Connection metadata to validate

Response

Connection validated successfully

​
status
enum<string>

Connection status

Available options:
connected,
disconnected,
error
Example:

"connected"

​
message
string

Status message

Example:

"Connection successful"

​
checked_at
string<date-time>

Check timestamp

Example:

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