Sign in
tool-settings

Test Service

Changed on

Structurally validate a URL and probe it for reachability.

Tests the URL in the request body (typically unsaved), so an operator can verify before saving. The probe is a plain HTTP GET with a short timeout: any HTTP response means the host is reachable; a connection/timeout/DNS error means it is not. The operator is trusted (master key), so no SSRF deny-list applies; only the structural check (http/https + host) runs first.

post/api/v1/tool-settings/{service}/test

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Path parameters

servicestring required

Request body

urlstring required

Response

Successful Response

okboolean required
reasonstring required

Changes