Skip to content
Nokku LogoNokku
API Referencev1.0.0 · 174 endpoints

Connect

nokku.v1.DaemonControlService
POST
https://app.nokku.sh/nokku.v1.DaemonControlService/Connect
Try it
Authorization (BearerAuth)

Header Parameters

Connect-Protocol-Version?number

Define the version of the Connect protocol

Example 1
Connect-Timeout-Ms?number

Define the timeout, in ms

Example 1000

Authorization

  • BearerAuth (bearer)

    A service account token. Include it in the Authorization header: `Authorization: Bearer <token>`

  • CookieAuth (cookie: __Host-nokku_session)

    The session cookie the web app uses. Browsers send it after sign-in. Only on `localhost` it is named `nokku_session`.

Request Body

Required
Media Type
nokku.v1.ConnectRequest

At most one of `heartbeat`, `connectionReport` may be set.

heartbeat?
object
stateHash?
string <byte>

The state_hash of the last sync the daemon saved, empty before the first. bytes.max_len = 64

connectionReport?
object

ConnectionReport tells the core who logged in on the daemon's server and when they left. The daemon sends one report at a time and keeps its events until the ack. A report may so come twice, the core stores each event once.

events?
array<nokku.v1.ConnectionEvent>
dropped?
integer

Events the daemon threw away since its last report, because it could keep no more.

Responses

200

Success

Media Type
nokku.v1.ConnectResponse

At most one of `stateUpdate`, `relayOpen`, `connectionReportAck` may be set.

stateUpdate?
object

StateUpdate tells a daemon what it should hold. It syncs when its own hash differs, or when this one is empty.

stateHash?
string <byte>
relayOpen?
object
relayId?
string
clientAddr?
string

The user's address as the core saw it. The daemon's sshd reports it as the remote address of the relayed connection.

connectionReportAck?
object

The core stored the report it got last.

default

Error

Media Type
connect.error

Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation

code?
string

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

Enum:"canceled""unknown""invalid_argument""deadline_exceeded""not_found""already_exists""permission_denied""resource_exhausted""failed_precondition""aborted""out_of_range""unimplemented""internal""unavailable""data_loss""unauthenticated"
message?
string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

details?
array<connect.error_details.Any>

A list of messages that carry the error details. There is no limit on the number of messages.

Code Samples

curl -X POST 'https://app.nokku.sh/nokku.v1.DaemonControlService/Connect' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/connect+json' \
  -d '{
  "heartbeat": {
    "stateHash": "string"
  },
  "connectionReport": {
    "events": [
      {
        "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
        "closed": true,
        "time": "2023-01-15T01:30:15.01Z",
        "principal": "string",
        "keyId": "string",
        "remoteAddr": "string",
        "clientVersion": "string",
        "relayed": true
      }
    ],
    "dropped": 0
  }
}'

Example Responses

{
  "stateUpdate": {
    "stateHash": "string"
  },
  "relayOpen": {
    "relayId": "string",
    "clientAddr": "string"
  },
  "connectionReportAck": {}
}