Probe an outbound SIP trunk pre-save
Pre-save connectivity probe for the trunk-creation wizard. This routes a real REGISTER through the probe carrier and returns the verdict (reachable / unreachable) plus an ordered steps breakdown naming the failing stage (DNS, gateway provisioning, registrar, credentials). A unreachable verdict is still 200 — the operator can override and save the trunk anyway. The wizard forwards this verdict as probe_status on the eventual POST /sip-trunks. Requires owner/admin.
Authorizations
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
1 - 255Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
true, false Body
Target SIP registrar hostname or IP.
1 - 253SIP port (default 5060).
1 <= x <= 65535SIP transport (default udp).
udp, tcp, tls Digest username the probe registrar expects.
1 - 128Digest password the probe registrar expects.
1 - 256Optional SIP realm override for digest auth.
1 - 253Response
Successful response.
The response is of type object.