v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB

Organization Connections

Test Storage Connection

Perform a credential test against the external provider.

Validates that connection credentials are still valid and the provider is accessible. Result is logged in audit trail.

Use Cases:

Validate credentials before using in sync operations
Diagnose connection issues
Refresh credentials after expiration

Example:

curl -X POST "http://localhost:8000/v1/organizations/connections/conn_abc123/test" \
  -H "Authorization: Bearer YOUR_API_KEY"

post/v1/organizations/connections/{connection_identifier}/test

Path parameters

connection_identifierstring required

Connection identifier - either connection ID (conn_...) or name. The system will automatically resolve names to IDs.

Example:conn_abc123def456ghi

Connection identifier - either connection ID (conn_...) or name. The system will automatically resolve names to IDs.

Response

Successful Response

successboolean required

Whether the connection test succeeded. True: Credentials are valid and connection is accessible. False: Authentication failed, network error, or permissions denied.

messagestring required

Human-readable message describing the test result. Success: 'Connection test succeeded' or similar. Failure: Error message explaining what went wrong.

detailsobject nullable

OPTIONAL. Additional diagnostic information about the test result. May include error details, provider-specific information, or success metadata. Format varies by provider.

Example response

{
  "description": "Successful test",
  "details": {
    "result": "success"
  },
  "message": "Connection test succeeded",
  "success": true
}