> ## Documentation Index
> Fetch the complete documentation index at: https://ona.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Audit Log
> Gets one audit-log entry, including any typed details stored for it.
`Unary` ยท [`Events`](/docs/api-reference/generated/event/overview)
Gets one audit-log entry, including any typed details stored for it.
Use this method to:
* Inspect the details of a specific audit-log entry
* Retrieve the evidence associated with a Veto Exec audit event
### Examples
* Get an audit-log entry:
```yaml theme={null}
auditLogEntryId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
```
## Endpoint
```text theme={null}
POST /api/gitpod.v1.EventService/GetAuditLog
```
Send a Bearer token as described in [Authentication](/docs/api-reference#authenticate-requests). If your organization uses a custom management-plane domain, replace `https://app.ona.com` with that domain.
## Request example
```bash cURL theme={null}
export ONA_HOST=https://app.ona.com
export ONA_API_KEY=
curl --request POST \
--url "$ONA_HOST/api/gitpod.v1.EventService/GetAuditLog" \
--header "Authorization: Bearer $ONA_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"auditLogEntryId": ""
}'
```
```python Python theme={null}
import gitpod.v1.event_pb2 as event_pb2
from ona_sdk import create_client_from_env
ona = create_client_from_env()
request = event_pb2.GetAuditLogRequest(
audit_log_entry_id="",
)
response = ona.services.event.get_audit_log(request)
print(response)
```
```typescript TypeScript theme={null}
import { create } from "@bufbuild/protobuf";
import { createClientFromEnv } from "@gitpod/sdk";
import { GetAuditLogRequestSchema } from "@gitpod/sdk/gitpod/v1/event_pb";
async function main() {
const ona = createClientFromEnv();
const request = create(GetAuditLogRequestSchema, {
auditLogEntryId: "",
});
const response = await ona.services.event.getAuditLog(request);
console.log(response);
}
main().catch(console.error);
```
```go Go theme={null}
package main
import (
"context"
"fmt"
"log"
"connectrpc.com/connect"
"github.com/gitpod-io/gitpod-sdk-go/sdk"
gitpodpb "github.com/gitpod-io/gitpod-sdk-go/v1"
)
func main() {
ona, err := sdk.NewFromEnv()
if err != nil {
log.Fatal(err)
}
request := connect.NewRequest(&gitpodpb.GetAuditLogRequest{
AuditLogEntryId: "",
})
response, err := ona.Services.Event.GetAuditLog(context.Background(), request)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Msg)
}
```
```json Request body theme={null}
{
"auditLogEntryId": ""
}
```
## Request
`gitpod.v1.GetAuditLogRequest`
| Field | Type | Required | Description |
| ----------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------- |
| `auditLogEntryId` | string | Yes | audit\_log\_entry\_id is the ID of the audit-log entry to retrieve. Constraints: `required=true, string.uuid=true`. |
## Response
`gitpod.v1.GetAuditLogResponse`
| Field | Type | Required | Description |
| --------- | ------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------- |
| `entry` | [AuditLogEntry](#type-gitpod-v1-list-audit-logs-response-audit-log-entry) | Yes | entry contains the common audit-log fields also returned by ListAuditLogs. Constraints: `required=true`. |
| `details` | [AuditLogEntryDetails](#type-gitpod-v1-audit-log-entry-details) | No | details contains typed evidence captured with the audit entry. It is absent when the entry has no supported, valid details. |
## Related types
AuditLogEntryDetails contains the typed evidence stored with an audit-log entry.
`gitpod.v1.AuditLogEntryDetails`
| Field | Type | Required | Description |
| ---------- | ------------------------------------------------------------------- | ---------------- | -------------------------------------------------------------------- |
| `vetoExec` | [ReportExecEventRequest](#type-gitpod-v1-report-exec-event-request) | One of `payload` | veto\_exec contains Veto Exec event details without process.cmdline. |
`gitpod.v1.ListAuditLogsResponse.AuditLogEntry`
| Field | Type | Required | Description |
| ---------------- | --------------------------------------------------------- | -------- | ----------- |
| `id` | string | No | |
| `actorId` | string | No | |
| `actorPrincipal` | [Principal](#enum-gitpod-v1-principal) | No | |
| `subjectId` | string | No | |
| `subjectType` | [ResourceType](#enum-gitpod-v1-resource-type) | No | |
| `action` | string | No | |
| `createdAt` | RFC 3339 timestamp | No | |
| `kind` | [AuditLogEntryKind](#enum-gitpod-v1-audit-log-entry-kind) | No | |
ReportExecEventRequest contains a Veto Exec event reported by an environment.
`gitpod.v1.ReportExecEventRequest`
| Field | Type | Required | Description |
| --------------- | -------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `environmentId` | string | No | environment\_id is the environment where the event occurred. Constraints: `string.uuid=true`. |
| `executable` | string | No | executable is the digest of the binary content (e.g., "sha256:a1b2c3d4..."). 256 allows for longer hash algorithms or prefixed identifiers. May be empty when the event source cannot compute the hash. Constraints: `string.max_len=256`. |
| `filename` | string | No | filename is the kernel-resolved path of the binary. Kernel PATH\_MAX = 4096 (include/uapi/linux/limits.h). May be empty if the event source could not resolve it. Constraints: `string.max_len=4096`. |
| `action` | [KernelControlsAction](#enum-gitpod-v1-kernel-controls-action) | No | action is the enforcement action taken (block or audit). Constraints: `enum.defined_only=true, enum.not_in=0`. |
| `process` | Process | Yes | process contains metadata about the process that triggered the event. Constraints: `required=true`. |
| `timestamp` | RFC 3339 timestamp | Yes | timestamp is when the event occurred in the environment. Constraints: `required=true`. |
AuditLogEntryKind identifies the coarse query and rendering family of an audit-log entry.
| Value | Number | Description |
| -------------------------------------------------- | -----: | --------------- |
| `AUDIT_LOG_ENTRY_KIND_UNSPECIFIED` | 0 | |
| `AUDIT_LOG_ENTRY_KIND_AGENT_SECURITY_EXEC_BLOCKED` | 1 | **Deprecated.** |
| `AUDIT_LOG_ENTRY_KIND_AGENT_SECURITY_EXEC_AUDITED` | 2 | **Deprecated.** |
| `AUDIT_LOG_ENTRY_KIND_RESOURCE_CHANGE` | 3 | |
| `AUDIT_LOG_ENTRY_KIND_CREDENTIAL_ACCESS` | 4 | |
| `AUDIT_LOG_ENTRY_KIND_ENVIRONMENT_VETO` | 5 | |
KernelControlsAction defines how a kernel-level policy violation is handled.
| Value | Number | Description |
| ------------------------------------ | -----: | ----------------------------------------------------------------------- |
| `KERNEL_CONTROLS_ACTION_UNSPECIFIED` | 0 | KERNEL\_CONTROLS\_ACTION\_UNSPECIFIED defaults to BLOCK. |
| `KERNEL_CONTROLS_ACTION_BLOCK` | 1 | KERNEL\_CONTROLS\_ACTION\_BLOCK denies the operation. |
| `KERNEL_CONTROLS_ACTION_AUDIT` | 2 | KERNEL\_CONTROLS\_ACTION\_AUDIT logs the operation without blocking it. |
| Value | Number | Description |
| --------------------------- | -----: | ----------- |
| `PRINCIPAL_UNSPECIFIED` | 0 | |
| `PRINCIPAL_ACCOUNT` | 1 | |
| `PRINCIPAL_USER` | 2 | |
| `PRINCIPAL_RUNNER` | 3 | |
| `PRINCIPAL_ENVIRONMENT` | 4 | |
| `PRINCIPAL_SERVICE_ACCOUNT` | 5 | |
| `PRINCIPAL_RUNNER_MANAGER` | 6 | |
| Value | Number | Description |
| -------------------------------------------- | -----: | ----------- |
| `RESOURCE_TYPE_UNSPECIFIED` | 0 | |
| `RESOURCE_TYPE_ENVIRONMENT` | 1 | |
| `RESOURCE_TYPE_RUNNER` | 2 | |
| `RESOURCE_TYPE_PROJECT` | 3 | |
| `RESOURCE_TYPE_TASK` | 4 | |
| `RESOURCE_TYPE_TASK_EXECUTION` | 5 | |
| `RESOURCE_TYPE_SERVICE` | 6 | |
| `RESOURCE_TYPE_ORGANIZATION` | 7 | |
| `RESOURCE_TYPE_USER` | 8 | |
| `RESOURCE_TYPE_ENVIRONMENT_CLASS` | 9 | |
| `RESOURCE_TYPE_RUNNER_SCM_INTEGRATION` | 10 | |
| `RESOURCE_TYPE_HOST_AUTHENTICATION_TOKEN` | 11 | |
| `RESOURCE_TYPE_GROUP` | 12 | |
| `RESOURCE_TYPE_PERSONAL_ACCESS_TOKEN` | 13 | |
| `RESOURCE_TYPE_USER_PREFERENCE` | 14 | |
| `RESOURCE_TYPE_SERVICE_ACCOUNT` | 15 | |
| `RESOURCE_TYPE_SECRET` | 16 | |
| `RESOURCE_TYPE_SSO_CONFIG` | 17 | |
| `RESOURCE_TYPE_DOMAIN_VERIFICATION` | 18 | |
| `RESOURCE_TYPE_AGENT_EXECUTION` | 19 | |
| `RESOURCE_TYPE_RUNNER_LLM_INTEGRATION` | 20 | |
| `RESOURCE_TYPE_AGENT` | 21 | |
| `RESOURCE_TYPE_ENVIRONMENT_SESSION` | 22 | |
| `RESOURCE_TYPE_USER_SECRET` | 23 | |
| `RESOURCE_TYPE_ORGANIZATION_POLICY` | 24 | |
| `RESOURCE_TYPE_ORGANIZATION_SECRET` | 25 | |
| `RESOURCE_TYPE_PROJECT_ENVIRONMENT_CLASS` | 26 | |
| `RESOURCE_TYPE_BILLING` | 27 | |
| `RESOURCE_TYPE_PROMPT` | 28 | |
| `RESOURCE_TYPE_COUPON` | 29 | |
| `RESOURCE_TYPE_COUPON_REDEMPTION` | 30 | |
| `RESOURCE_TYPE_ACCOUNT` | 31 | |
| `RESOURCE_TYPE_INTEGRATION` | 32 | |
| `RESOURCE_TYPE_WORKFLOW` | 33 | |
| `RESOURCE_TYPE_WORKFLOW_EXECUTION` | 34 | |
| `RESOURCE_TYPE_WORKFLOW_EXECUTION_ACTION` | 35 | |
| `RESOURCE_TYPE_SNAPSHOT` | 36 | |
| `RESOURCE_TYPE_PREBUILD` | 37 | |
| `RESOURCE_TYPE_ORGANIZATION_LLM_INTEGRATION` | 38 | |
| `RESOURCE_TYPE_CUSTOM_DOMAIN` | 39 | |
| `RESOURCE_TYPE_ROLE_ASSIGNMENT_CHANGED` | 40 | |
| `RESOURCE_TYPE_GROUP_MEMBERSHIP_CHANGED` | 41 | |
| `RESOURCE_TYPE_WEBHOOK` | 42 | |
| `RESOURCE_TYPE_SCIM_CONFIGURATION` | 43 | |
| `RESOURCE_TYPE_SERVICE_ACCOUNT_SECRET` | 44 | |
| `RESOURCE_TYPE_ANNOUNCEMENT_BANNER` | 45 | |
| `RESOURCE_TYPE_SERVICE_ACCOUNT_TOKEN` | 46 | |
| `RESOURCE_TYPE_ROLE_ASSIGNMENT` | 47 | |
| `RESOURCE_TYPE_WARM_POOL` | 48 | |
| `RESOURCE_TYPE_NOTIFICATION` | 49 | |
| `RESOURCE_TYPE_SECURITY_POLICY` | 50 | |