settings

POST /settings/relay-probe

Changed on

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

  • The document declares no server URL.
  • Auth
    • API key in query parameter auth
    • or API key in header Authorization

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

  • 4c664cabd0c5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 225bdf35611eRevision changes
    • breaking

      added the new required request property

    • breaking

      removed the required property // from the response with the status

    • info

      added the non-success response with the status

    • info

      added the required property // to the response with the status