Skip to main content
POST
/
resources
/
check-connection
/
{id}
Check connection status
curl --request POST \
  --url https://api.ledgerbeam.com/v1/resources/check-connection/{id} \
  --header 'API-KEY: <api-key>'
{
  "status": "connected",
  "message": "Connection successful",
  "checked_at": "2024-01-15T10:30:00Z"
}

​
Overview

Check the connection status of a specific resource. This endpoint tests the connectivity to the resource and returns the current status.

Authorizations

​
API-KEY
string
header
required

API key for authentication

Path Parameters

​
id
string
required

Resource ID

Response

Connection status checked 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"