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

SyncDaemon

nokku.v1.DaemonControlService
POST
https://app.nokku.sh/nokku.v1.DaemonControlService/SyncDaemon
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

application/json

nokku.v1.SyncDaemonRequest
users?
array<string>
privateIps?
array<string>

Where the daemon's sshd listens, as ip:port.

metadata?
object

Map value

[key: string]?
string

Responses

200

Success

application/json

nokku.v1.SyncDaemonResponse
status?
string
Enum:"DAEMON_STATUS_UNSPECIFIED""DAEMON_STATUS_PENDING""DAEMON_STATUS_ACCEPTED""DAEMON_STATUS_REJECTED"
config?
object
recordSessions?
boolean
allowForwarding?
boolean
allowAgentForwarding?
boolean
gatewayPorts?
boolean
ephemeral?
boolean
idleTimeout?
string

idle_timeout closes an interactive session nobody typed into for that long. It is the workspace's session_idle_timeout, filled in by the core on sync and ignored when sent.

principals?
array<nokku.v1.AccountPrincipals>
userCaPublicKey?
string

The user CA key logins are checked against.

hostCaPublicKey?
string

The host CA key the daemon's host certificate has to come from.

stateHash?
string <byte>

A hash of this answer, the daemon sends it back with every heartbeat. A daemon never works it out itself.

default

Error

application/json

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/SyncDaemon' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "users": [
    "string"
  ],
  "privateIps": [
    "string"
  ],
  "metadata": {
    "property1": "string",
    "property2": "string"
  }
}'

Example Responses

{
  "status": "DAEMON_STATUS_UNSPECIFIED",
  "config": {
    "recordSessions": true,
    "allowForwarding": true,
    "allowAgentForwarding": true,
    "gatewayPorts": true,
    "ephemeral": true,
    "idleTimeout": "string"
  },
  "principals": [
    {
      "username": "string",
      "certPrincipals": [
        "string"
      ]
    }
  ],
  "userCaPublicKey": "string",
  "hostCaPublicKey": "string",
  "stateHash": "string"
}