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

GetDaemon

nokku.v1.DaemonService
POST
https://app.nokku.sh/nokku.v1.DaemonService/GetDaemon
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.GetDaemonRequest
id?
string <uuid>

Responses

200

Success

application/json

nokku.v1.GetDaemonResponse
daemon?
object
id?
string
name?
string
online?
boolean
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.

updatedAt?
string <date-time>

A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC.

createdAt?
string <date-time>

A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC.

lastSeenAt?
string <date-time>

A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC.

version?
string

version is nokkud's, as its last enroll or sync reported it.

behindSince?
string <date-time>

behind_since is when a connected daemon stopped keeping up with access changes. Unset while it keeps up.

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.DaemonService/GetDaemon' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}'

Example Responses

{
  "daemon": {
    "id": "string",
    "name": "string",
    "online": true,
    "status": "DAEMON_STATUS_UNSPECIFIED",
    "config": {
      "recordSessions": true,
      "allowForwarding": true,
      "allowAgentForwarding": true,
      "gatewayPorts": true,
      "ephemeral": true,
      "idleTimeout": "string"
    },
    "updatedAt": "2023-01-15T01:30:15.01Z",
    "createdAt": "2023-01-15T01:30:15.01Z",
    "lastSeenAt": "2023-01-15T01:30:15.01Z",
    "version": "string",
    "behindSince": "2023-01-15T01:30:15.01Z"
  }
}