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

ListRecordings

nokku.v1.RecordingService
POST
https://app.nokku.sh/nokku.v1.RecordingService/ListRecordings
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.ListRecordingsRequest
daemonId?
string <uuid>
limit?
integer <int32>
offset?
integer <int32>
username?
string
subjectId?
string <uuid>

Responses

200

Success

application/json

nokku.v1.ListRecordingsResponse
recordings?
array<nokku.v1.Recording>
total?
integer <int32>
totalBytes?
string <int64>
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.RecordingService/ListRecordings' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "daemonId": "a3e83d7b-ed22-4c45-95cd-ab2b550774b6",
  "limit": 1,
  "offset": 0,
  "username": "string",
  "subjectId": "68460e63-0717-47f9-8fd8-d28f152cb30b"
}'

Example Responses

{
  "recordings": [
    {
      "id": "string",
      "daemonId": "string",
      "username": "string",
      "sizeBytes": "string",
      "complete": true,
      "startedAt": "2023-01-15T01:30:15.01Z",
      "endedAt": "2023-01-15T01:30:15.01Z",
      "daemonName": "string",
      "subjectId": "string",
      "principal": "string",
      "subjectName": "string",
      "live": true
    }
  ],
  "total": 0,
  "totalBytes": "string"
}