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

ListTargets

nokku.v1.TargetService
POST
https://app.nokku.sh/nokku.v1.TargetService/ListTargets
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.ListTargetsRequest
limit?
integer <int32>
offset?
integer <int32>
query?
string
daemonId?
string
accounts?
array<string>
tags?
array<string>
status?
string

TargetStatus is what a server's daemon is up to, or that it has none.

Enum:"TARGET_STATUS_UNSPECIFIED""TARGET_STATUS_PENDING""TARGET_STATUS_ONLINE""TARGET_STATUS_OFFLINE""TARGET_STATUS_MANUAL"
ids?
array<string>

ids keeps only these servers, like the ones a person picked.

Responses

200

Success

application/json

nokku.v1.ListTargetsResponse
targets?
array<nokku.v1.Target>
total?
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 POST 'https://app.nokku.sh/nokku.v1.TargetService/ListTargets' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "limit": 1,
  "offset": 0,
  "query": "string",
  "daemonId": "string",
  "accounts": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "status": "TARGET_STATUS_UNSPECIFIED",
  "ids": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}'

Example Responses

{
  "targets": [
    {
      "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"
      }
    }
  ],
  "total": 0
}