API Reference

Audit Logs

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Audit Logs

client.AuditLogs.List(ctx, query) (*Cursor[AuditLog], error)

GET/v1/audit_logs

List Audit Log entries for an organization

ParametersExpand Collapse

query AuditLogListParams

Cursor param.Field[string]Optional

Pagination cursor returned by a previous request

Limit param.Field[int64]Optional

Maximum number of items to return

maximum100

minimum10

ReturnsExpand Collapse

type AuditLog struct{…}

Audit log entry.

ID string

Unique identifier for the audit log entry.

Action string

The action that was performed.

Actor AuditLogActor

The entity that performed the action.

ID string

Unique identifier for the actor.

Name string

Display name of the actor.

Type AuditLogType

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.

List Audit Logs

Go

HTTP

TypeScript

Go

Terraform

CLI Tool

package main

import (
  "context"
  "fmt"

  "github.com/nirvana-labs/nirvana-go"
  "github.com/nirvana-labs/nirvana-go/audit_logs"
  "github.com/nirvana-labs/nirvana-go/option"
)

func main() {
  client := nirvana.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.AuditLogs.List(context.TODO(), audit_logs.AuditLogListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

200 example

{
  "items": [
    {
      "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"
      }
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}

Returns Examples

200 example

{
  "items": [
    {
      "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"
      }
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}