Sign in
settings

POST /settings/relay-probe

Probes a candidate relay URL for reachability. An optional one-time access token is used only for this probe and is never persisted. A probe that fails to reach the relay is a NORMAL categorized outcome returned 200 (mirrors the Tauri command contract) — only a missing relay-diagnostic adapter (server misconfiguration) becomes a 500 ApiError.

post/settings/relay-probe

Request body

urlstring required

Candidate relay URL to probe. Not persisted; the probe is repeatable.

Response

Relay probe outcome (reachable or a categorized failure)

tsinteger required

Server time when the response was built (unix epoch milliseconds).

Changes

Changed in 3 of the 44 revisions of this API.33

  • 225bdf35611e22See the full diff
    • ▲

      added the new required request property credential

      new-required-request-property

    • ▲

      removed the required property data/oneOf[subschema #1]/latency_ms from the response with the 200 status

      response-required-property-removed

    • ○

      added the non-success response with the status 503

      response-non-success-status-added

    • ○

      added the required property data/oneOf[subschema #1]/latencyMs to the response with the 200 status

      response-required-property-added

  • 0ac29b503d271See the full diff
    • ○

      endpoint added

      endpoint-added

  • e7038123d2681See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 74 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog