Skip to main content
POST
Test connectivity for a PRO credential set
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

POST /pro-credentials//test Description: Ephemeral connectivity probe. Decrypts the stored credentials, opens the transport, lists/stats the configured upload folder, and disconnects — never writes a CWR file and never persists the result. Currently only supported for submissionMethod: SFTP. Shares the per-(tenant, society) submission rate limiter with real CWR submissions, so repeated health checks can be throttled with 429. The HTTP status is 200 for both a successful and a failed connection attempt — check data.ok, not the status code. Authorization:
  • Required role: admin or higher
  • Requires an active publisher addon
Method: POST

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

id
string<uuid>
required

Response

Connection test attempted (see data.ok for pass/fail)

status
string
Example:

"success"

data
object