# Relay

`POST /nokku.v1.DaemonService/Relay`

Relay

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/connect+json, required)

Also accepts: application/connect+proto, application/grpc, application/grpc+proto, application/grpc+json, application/grpc-web, application/grpc-web+proto, application/grpc-web+json.

- `start` (object)
  - `daemonId` (string, required)
- `data` (string)

Example:

```json
{
  "start": {
    "daemonId": "a3e83d7b-ed22-4c45-95cd-ab2b550774b6"
  },
  "data": "string"
}
```

## Responses

### 200: Success

Returns `nokku.v1.RelayResponse`.

- `ready` (object)
  - `relayId` (string)
- `data` (string)
- `closed` (object)

```json
{
  "ready": {
    "relayId": "string"
  },
  "data": "string",
  "closed": {}
}
```

### 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.DaemonService/Relay' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/connect+json' \
  -d '{
  "start": {
    "daemonId": "a3e83d7b-ed22-4c45-95cd-ab2b550774b6"
  },
  "data": "string"
}'
```
