# ExportAuditLogs

`POST /nokku.v1.UtilService/ExportAuditLogs`

ExportAuditLogs

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)

- `format` (string): One of: `FORMAT_UNSPECIFIED`, `FORMAT_CSV`, `FORMAT_JSON`.
- `filter` (object)
  - `search` (string)
  - `actorIds` (array<string>)
  - `actorKinds` (array<string>)
  - `actions` (array<string>)
  - `target` (string)
  - `outcome` (string): One of: `AUDIT_OUTCOME_UNSPECIFIED`, `AUDIT_OUTCOME_SUCCEEDED`, `AUDIT_OUTCOME_FAILED`, `AUDIT_OUTCOME_DENIED`.
  - `startDate` (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.
  - `endDate` (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.
  - `excludedActions` (array<string>): excluded_actions leaves these out, like every sign-in for a view of changes.

Example:

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

## Responses

### 200: Success

Returns `nokku.v1.ExportAuditLogsResponse`.

- `data` (string)
- `filename` (string)
- `contentType` (string)

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

### 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.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"
    ]
  }
}'
```
