Skip to content
Docs

    Get Audit Log

    client.AuditLogs.Get(ctx, auditLogID) (*AuditLog, error)
    GET/v1/audit_logs/{audit_log_id}

    Get an Audit Log entry

    ParametersExpand Collapse
    auditLogID string
    ReturnsExpand Collapse
    type AuditLog struct{…}

    Audit log entry.

    ID string

    Unique identifier for the audit log entry.

    Action string

    The action that was performed.

    The entity that performed the action.

    ID string

    Unique identifier for the actor.

    Name string

    Display name of the actor.

    Type of actor.

    One of the following:
    const AuditLogTypeUser AuditLogType = "user"
    const AuditLogTypeAPIKey AuditLogType = "api_key"
    ClientIP string

    Client IP address.

    CreatedAt Time

    When the action occurred.

    formatdate-time
    Method string

    HTTP method of the request.

    Path string

    Request path.

    StatusCode int64

    HTTP status code of the response.

    UserAgent string

    User agent string.

    Target AuditLogTargetOptional

    The target resource of the action.

    ID string

    Unique identifier for the target resource.

    Type string

    Type of the target resource.

    Get Audit Log

    package main
    
    import (
      "context"
      "fmt"
    
      "github.com/nirvana-labs/nirvana-go"
      "github.com/nirvana-labs/nirvana-go/option"
    )
    
    func main() {
      client := nirvana.NewClient(
        option.WithAPIKey("My API Key"),
      )
      auditLog, err := client.AuditLogs.Get(context.TODO(), "audit_log_id")
      if err != nil {
        panic(err.Error())
      }
      fmt.Printf("%+v\n", 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"
      }
    }