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

UploadRecording

nokku.v1.DaemonControlService
POST
https://app.nokku.sh/nokku.v1.DaemonControlService/UploadRecording
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
Media Type
nokku.v1.UploadRecordingRequest

At most one of `meta`, `chunk`, `final` may be set.

meta?
object
recordingId?
string <uuid>
username?
string
principal?
string
startedAt?
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.

chunk?
string <byte>
final?
object
sizeBytes?
string <int64>

int64.gte = 0

cutReason?
string
endedAt?
string <date-time>

ended_at is when the session ended, which a late upload can be long after.

Responses

200

Success

Media Type
nokku.v1.UploadRecordingResponse
recordingId?
string
sizeBytes?
string <int64>

size_bytes is what the core holds of the recording.

complete?
boolean

complete says the core takes no more of this recording. Only this answer lets a daemon delete its file, an error never does.

default

Error

Media Type
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.DaemonControlService/UploadRecording' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/connect+json' \
  -d '{
  "meta": {
    "recordingId": "bbd0b35c-32e1-4c5f-b1be-7f8fdbe015f2",
    "username": "string",
    "principal": "string",
    "startedAt": "2023-01-15T01:30:15.01Z"
  },
  "chunk": "string",
  "final": {
    "sizeBytes": "string",
    "cutReason": "string",
    "endedAt": "2023-01-15T01:30:15.01Z"
  }
}'

Example Responses

{
  "recordingId": "string",
  "sizeBytes": "string",
  "complete": true
}