Skip to main content
POST
/
pro-credentials
/
{id}
/
test
Test connectivity for a PRO credential set
curl --request POST \
  --url https://api.royalti.io/pro-credentials/{id}/test \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.royalti.io/pro-credentials/{id}/test"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/pro-credentials/{id}/test', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.royalti.io/pro-credentials/{id}/test",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.royalti.io/pro-credentials/{id}/test"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.royalti.io/pro-credentials/{id}/test")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/pro-credentials/{id}/test")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "data": {
    "ok": true,
    "latencyMs": 123,
    "message": "<string>"
  }
}
{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}
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

const response = await fetch('https://api.royalti.io/pro-credentials/example-id/test', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
});

const data = await response.json();
console.log(data);

import requests

response = requests.post(
  'https://api.royalti.io/pro-credentials/example-id/test',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={}
)

data = response.json()
print(data)

curl -X POST https://api.royalti.io/pro-credentials/example-id/test \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

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