# GetTarget

`POST /nokku.v1.TargetService/GetTarget`

GetTarget

Base URL: https://app.nokku.sh

## Authorization

- BearerAuth: HTTP bearer
- CookieAuth: API key in cookie `__Host-nokku_session`

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Connect-Protocol-Version` | header | number | no | Define the version of the Connect protocol |
| `Connect-Timeout-Ms` | header | number | no | Define the timeout, in ms |

## Request body (application/json, required)

- `id` (string)

Example:

```json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
```

## Responses

### 200: Success

Returns `nokku.v1.GetTargetResponse`.

- `target` (object)
  - `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)
  - `createdAt` (string): 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): 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): 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.
  - `blocked` (string): blocked says why the subject's grants here let nobody in today. Unset when they work. One of: `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): One of: `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): 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): 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): 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): behind_since is when a connected daemon stopped keeping up with access changes. Unset while it keeps up.

```json
{
  "target": {
    "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"
    }
  }
}
```

### default: Error

Returns `connect.error`.

- `code` (string): The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. One of: `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.

```json
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}
```

## Example request

```bash
curl -X POST 'https://app.nokku.sh/nokku.v1.TargetService/GetTarget' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}'
```
