Docs
Sign in

Change a connection.

Changing the harness, model, auth or base URL marks it untested again.

PATCH/api/v1/connections/{id}

Scopeconfig

No query parameters.

Path parameters.

idstringrequired

The connection's id.

Body.

namestring

A name for the connection, shown in the dashboard. At least 1 character.

harnessenum

The coding agent program that runs the model. A machine runs it only when that harness is installed there. One of claude-code, pi, codex.

providerenum

Who serves the model. One of anthropic, morph, openai, custom.

modelstring

The model agents use when a launch names none. At least 1 character.

authenum

How the harness signs in. local_login uses the sign-in already on one paired machine, so it never runs on a cloud VM. One of local_login, oauth_token, api_key, boat_profile.

baseUrlstring

The provider's address, for a custom provider or a proxy. A URL.

scopeenum

Where it may run: local on paired machines, cloud on cloud workers, both.

meteringenum

How you pay the provider for it: subscription or metered. Shown in forecasts; Koidog bills nothing.

maxConcurrent1–100

The most agents that use it at once; the rest wait.

defaultOptionsobject

Options agents use when a launch names none.

ShowHide 1 field

effortenum

How much reasoning the model spends, where its harness lets you choose. Left out, the harness's default. One of low, medium, high, xhigh, max.

Response.

200 OK: a Connection. The example has placeholder values.

422 validation_failed
The body does not match its schema; each problem is in details.