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

ExportAuditLogs

nokku.v1.UtilService
POST
https://app.nokku.sh/nokku.v1.UtilService/ExportAuditLogs
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.ExportAuditLogsRequest
format?
string
Enum:"FORMAT_UNSPECIFIED""FORMAT_CSV""FORMAT_JSON"
filter?
object
search?
string
actorIds?
array<string>
actorKinds?
array<string>
actions?
array<string>
target?
string
outcome?
string
Enum:"AUDIT_OUTCOME_UNSPECIFIED""AUDIT_OUTCOME_SUCCEEDED""AUDIT_OUTCOME_FAILED""AUDIT_OUTCOME_DENIED"
startDate?
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.

endDate?
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.

excludedActions?
array<string>

excluded_actions leaves these out, like every sign-in for a view of changes.

Responses

200

Success

application/json

nokku.v1.ExportAuditLogsResponse
data?
string <byte>
filename?
string
contentType?
string
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.UtilService/ExportAuditLogs' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "format": "FORMAT_UNSPECIFIED",
  "filter": {
    "search": "string",
    "actorIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "actorKinds": [
      "string"
    ],
    "actions": [
      "string"
    ],
    "target": "string",
    "outcome": "AUDIT_OUTCOME_UNSPECIFIED",
    "startDate": "2023-01-15T01:30:15.01Z",
    "endDate": "2023-01-15T01:30:15.01Z",
    "excludedActions": [
      "string"
    ]
  }
}'

Example Responses

{
  "data": "string",
  "filename": "string",
  "contentType": "string"
}