Skip to main content
POST
/
connections
/
test
Test ad-hoc credentials
curl --request POST \
  --url https://api.getdialed.ai/flows/connections/test \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "auth_method": "basic_auth",
  "credentials": {
    "password": "REPLACE_ME",
    "username": "api_user@example"
  },
  "platform_id": "five9",
  "service_id": "five9__configuration"
}
'
import requests

url = "https://api.getdialed.ai/flows/connections/test"

payload = {
    "auth_method": "basic_auth",
    "credentials": {
        "password": "REPLACE_ME",
        "username": "api_user@example"
    },
    "platform_id": "five9",
    "service_id": "five9__configuration"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    auth_method: 'basic_auth',
    credentials: {password: 'REPLACE_ME', username: 'api_user@example'},
    platform_id: 'five9',
    service_id: 'five9__configuration'
  })
};

fetch('https://api.getdialed.ai/flows/connections/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.getdialed.ai/flows/connections/test",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'auth_method' => 'basic_auth',
    'credentials' => [
        'password' => 'REPLACE_ME',
        'username' => 'api_user@example'
    ],
    'platform_id' => 'five9',
    'service_id' => 'five9__configuration'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

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

curl_close($curl);

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

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

func main() {

	url := "https://api.getdialed.ai/flows/connections/test"

	payload := strings.NewReader("{\n  \"auth_method\": \"basic_auth\",\n  \"credentials\": {\n    \"password\": \"REPLACE_ME\",\n    \"username\": \"api_user@example\"\n  },\n  \"platform_id\": \"five9\",\n  \"service_id\": \"five9__configuration\"\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	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.getdialed.ai/flows/connections/test")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"auth_method\": \"basic_auth\",\n  \"credentials\": {\n    \"password\": \"REPLACE_ME\",\n    \"username\": \"api_user@example\"\n  },\n  \"platform_id\": \"five9\",\n  \"service_id\": \"five9__configuration\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.getdialed.ai/flows/connections/test")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"auth_method\": \"basic_auth\",\n  \"credentials\": {\n    \"password\": \"REPLACE_ME\",\n    \"username\": \"api_user@example\"\n  },\n  \"platform_id\": \"five9\",\n  \"service_id\": \"five9__configuration\"\n}"

response = http.request(request)
puts response.read_body
{
  "details": "Authenticated successfully; 3 lists visible",
  "latency_ms": 412,
  "success": true,
  "tested_at": "2026-07-09T18:00:00Z"
}
{
  "detail": "Authentication required"
}
{
  "detail": "Admin role required"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}
{
  "detail": "Rate limit exceeded: 100 per 1 minute"
}

Authorizations

X-API-Key
string
header
required

Body

application/json

Ad-hoc credentials test request body (D-06).

Used by POST /connections/test (no saved connection required). The UI's "test before save" flow posts this body to verify credentials before calling POST /connections to persist them.

Differs from ConnectionCreate: no name, no credentials_ref, no status. credentials is REQUIRED (not optional) — the whole point is to test a specific credentials dict.

platform_id
string
required
service_id
string
required
auth_method
enum<string>
required
Available options:
basic_auth,
oauth2,
client_credentials,
jwt,
api_key,
soap_wss
credentials
Credentials · object
required

Response

Successful Response

Result of a connection test (D-08, 5 fields locked).

Returned by both POST /connections/{conn_id}/test and POST /connections/test with HTTP 200 for ALL handler outcomes including timeouts (D-03). The UI always parses this exact shape regardless of failure mode.

error is one of 7 codes (D-09) when success=False, or None when success=True:

  • AUTH_FAILED, NETWORK, TIMEOUT, RATE_LIMITED, PERMISSION_DENIED, INVALID_CREDENTIALS_SHAPE, UNKNOWN

error is typed as str | None (not Literal[...]) per PATTERNS.md anti-pattern note: keeps schema evolution decoupled from handler logic.

latency_ms is HANDLER-measured (start of network round-trip to end of response parsing); excludes API/serialization overhead.

tested_at is set by the HANDLER at the start of the attempt, not by the router. (A4 binding in 38-RESEARCH.md.)

success
boolean
required
error
string | null
required
details
string
required
latency_ms
integer
required
tested_at
string<date-time>
required