Get Audit Log

client.auditLogs.get(, ?): AuditLog { id, action, actor, 7 more }

GET/v1/audit_logs/{audit_log_id}

Get an Audit Log entry

ParametersExpand Collapse

auditLogID: string

ReturnsExpand Collapse

AuditLog { id, action, actor, 7 more }

Audit log entry.

id: string

Unique identifier for the audit log entry.

action: string

The action that was performed.

actor: AuditLogActor { id, name, type }

The entity that performed the action.

id: string

Unique identifier for the actor.

name: string | null

Display name of the actor.

type: AuditLogType

Type of actor.

One of the following:

"user"

"api_key"

client_ip: string

Client IP address.

created_at: string

When the action occurred.

formatdate-time

method: string

HTTP method of the request.

path: string

Request path.

status_code: number

HTTP status code of the response.

user_agent: string

User agent string.

target?: AuditLogTarget { id, type } | null

The target resource of the action.

id: string

Unique identifier for the target resource.

type: string

Type of the target resource.

Get Audit Log

import NirvanaLabs from '@nirvana-labs/nirvana';

const client = new NirvanaLabs({
  apiKey: process.env['NIRVANA_LABS_API_KEY'], // This is the default and can be omitted
});

const auditLog = await client.auditLogs.get('audit_log_id');

console.log(auditLog.id);

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "action": "vm.created",
  "actor": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Alice Smith",
    "type": "user"
  },
  "client_ip": "203.0.113.1",
  "created_at": "2025-01-01T00:00:00Z",
  "method": "GET",
  "path": "/v1/compute/vms",
  "status_code": 200,
  "user_agent": "Mozilla/5.0",
  "target": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "vm"
  }
}

Returns Examples

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "action": "vm.created",
  "actor": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Alice Smith",
    "type": "user"
  },
  "client_ip": "203.0.113.1",
  "created_at": "2025-01-01T00:00:00Z",
  "method": "GET",
  "path": "/v1/compute/vms",
  "status_code": 200,
  "user_agent": "Mozilla/5.0",
  "target": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "vm"
  }
}