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

GetDashboard

nokku.v1.DashboardService
GET
https://app.nokku.sh/nokku.v1.DashboardService/GetDashboard
Try it
Authorization (BearerAuth)

Query Parameters

message?

The URL-encoded message query parameter contains the JSON or binary serialized request message

encodingRequired

Define which encoding or 'Message-Codec' to use

Example json
base64?boolean

Specifies if the message query param is base64 encoded, which may be required for binary data

Example false
compression?

Which compression algorithm to use for this request

Example gzip
connectRequired

Define the version of the Connect protocol

Example v1

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`.

Responses

200

Success

application/json

nokku.v1.GetDashboardResponse
targets?
integer <int32>
targetsOnline?
integer <int32>
targetsManual?
integer <int32>
daemons?
integer <int32>
daemonsOnline?
integer <int32>
pendingDaemons?
array<nokku.v1.Daemon>
offlineServers?
array<nokku.v1.Target>

with their daemons, approved but not connected

users?
integer <int32>
recordingBytes?
string <int64>
recordingQuotaBytes?
string <int64>
liveSessions?
array<nokku.v1.LiveSession>
activity?
array<integer>
failures?
array<integer>
recentChanges?
array<nokku.v1.EventLog>
daemonsBehind?
integer <int32>
endingGrants?
array<nokku.v1.EndingGrant>

the next five to end within a day

endingGrantsTotal?
integer <int32>
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 GET 'https://app.nokku.sh/nokku.v1.DashboardService/GetDashboard?encoding=<encoding>&connect=<connect>' \
  -H 'Authorization: Bearer <token>'

Example Responses

{
  "targets": 0,
  "targetsOnline": 0,
  "targetsManual": 0,
  "daemons": 0,
  "daemonsOnline": 0,
  "pendingDaemons": [
    {
      "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"
    }
  ],
  "offlineServers": [
    {
      "id": "string",
      "daemonId": "string",
      "name": "string",
      "description": "string",
      "hostPublicKey": "string",
      "tags": [
        "string"
      ],
      "endpoints": [
        "string"
      ],
      "usernames": [
        "string"
      ],
      "accounts": [
        {
          "id": "string",
          "targetId": "string",
          "username": "string",
          "userIds": [
            "string"
          ],
          "teamIds": [
            "string"
          ],
          "serviceAccountIds": [
            "string"
          ],
          "createdAt": "2023-01-15T01:30:15.01Z",
          "seenAt": "2023-01-15T01:30:15.01Z",
          "expiresAt": {
            "property1": "2023-01-15T01:30:15.01Z",
            "property2": "2023-01-15T01:30:15.01Z"
          }
        }
      ],
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "createdAt": "2023-01-15T01:30:15.01Z",
      "updatedAt": "2023-01-15T01:30:15.01Z",
      "lastSyncAt": "2023-01-15T01:30:15.01Z",
      "usernameExpiresAt": {
        "property1": "2023-01-15T01:30:15.01Z",
        "property2": "2023-01-15T01:30:15.01Z"
      },
      "blocked": "ACCESS_BLOCK_UNSPECIFIED",
      "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"
      }
    }
  ],
  "users": 0,
  "recordingBytes": "string",
  "recordingQuotaBytes": "string",
  "liveSessions": [
    {
      "id": "string",
      "daemonId": "string",
      "daemonName": "string",
      "username": "string",
      "userId": "string",
      "recording": true,
      "web": true,
      "startedAt": "2023-01-15T01:30:15.01Z"
    }
  ],
  "activity": [
    0
  ],
  "failures": [
    0
  ],
  "recentChanges": [
    {
      "id": "string",
      "actorId": "string",
      "actorKind": "string",
      "actorName": "string",
      "action": "string",
      "target": "string",
      "ok": true,
      "ip": "string",
      "userAgent": "string",
      "details": {
        "property1": {},
        "property2": {}
      },
      "timestamp": "2023-01-15T01:30:15.01Z"
    }
  ],
  "daemonsBehind": 0,
  "endingGrants": [
    {
      "subjectKind": "SUBJECT_KIND_UNSPECIFIED",
      "subjectId": "string",
      "subjectName": "string",
      "username": "string",
      "expiresAt": "2023-01-15T01:30:15.01Z",
      "targets": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "targetCount": 0
    }
  ],
  "endingGrantsTotal": 0
}