Skip to main content
POST
Call connections.probe_connector_address

Authorizations

Authorization
string
header
required

An API key minted at Settings › API & MCP. Send it as Authorization: Bearer <key>. A key carries its holder's own permissions, resolved on every call — revoking a membership closes the key's reach immediately. Keep it in an environment variable (GOOSY_API_KEY), never in a committed file.

Headers

x-request-id
string

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Maximum string length: 128

Body

application/json
kind
enum<string>
required

mcp for a remote MCP server, openapi for a REST API described by an OpenAPI document. Ask the operator which they have rather than guessing from the address.

Available options:
mcp,
openapi
address
string
required

The address to ask, exactly as the operator gave it: the MCP server's own https URL for mcp, or the https URL of the OpenAPI document for openapi. It is judged by the same SSRF floor the real dial takes, so a private or non-https address refuses here rather than being probed.

workspace
string

Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

Minimum string length: 1

Response

The call was admitted and dispatched. ok says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

The tool ran and answered.

ok
boolean
required
auth_mode
enum<string>
required

oauth — the address wants the operator to sign in with the provider; there is nothing to paste. bearer — it wants a token the operator holds. none — it answered without asking for anything. It is a DEFAULT for the Add custom connector sheet, never a boundary: the operator can override it under Advanced, and the registration re-validates whatever it is actually given.

Available options:
oauth,
bearer,
none
evidence
string
required

How the answer was reached, in the rail's own vocabulary (for example oauth_challenge, credential_challenge, document_key_scheme, reachable). Never an address and never a credential. Quote it only if the operator asks why.

oauth_endpoints_known
boolean | null
required

For an API only: whether the rail already knows where the provider's sign-in lives. false means the operator will be asked for the authorize and token URLs during setup — say so before they start. null for an MCP server, whose endpoints come from its own discovery.

workspace
string
required

The slug of the workspace this call ran in.

working_in
object
required

Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.