Skip to main content
POST
Add a host

Authorizations

Authorization
string
header
required

An organization-scoped API key, minted in control under Settings → API keys. Every failure to authenticate answers one identical 401: "Provide a valid organization-scoped API key or an active session." Each operation names the one scope it is filed under, <resource>:<read|write>, where the resource is the first path segment after /api/v1/; a key minted today carries all 22 of them. Scopes are RECORDED — on the key and on every audit row — and are not yet enforced: no request is refused for want of one.

Headers

Idempotency-Key
string

Any unique string.

Path Parameters

id
string
required

The connection to inject on that host. A malformed id answers 404, exactly as another organization's well-formed id does.

Body

application/json
host
string
required

A bare hostname. No scheme, path, port, userinfo or wildcard; it is lowercased and any trailing dot removed. A host maps to exactly one connection per organization.

Response

Success.

data
object
required