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

nokku.v1.Target

object
nokku.v1.Target
id?
string
daemonId?
string
name?
string
description?
string
hostPublicKey?
string

pinned SSH host public key (manual mode)

tags?
array<string>
endpoints?
array<string>
usernames?
array<string>
accounts?
array<nokku.v1.TargetAccount>
metadata?
object

Map value

[key: string]?
string
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.

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.

lastSyncAt?
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.

usernameExpiresAt?
object

username_expires_at holds the usernames the subject asked about may only use until then. The others are for good.

Map value

[key: string]?
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.

blocked?
string

blocked says why the subject's grants here let nobody in today. Unset when they work.

Enum:"ACCESS_BLOCK_UNSPECIFIED""ACCESS_BLOCK_USER_INACTIVE""ACCESS_BLOCK_DAEMON_NOT_APPROVED"
daemon?
object

daemon is the server's daemon with its live state, from ListTargets and GetTarget. Unset for nk sync servers.

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.

Example

{
  "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"
  }
}