List Audit Logs

$ nirvana audit-logs list

GET/v1/audit_logs

List Audit Log entries for an organization

ParametersExpand Collapse

--action: optional string

Filter by recorded action

--actor-id: optional string

Filter by the acting user or API key

--actor-type: optional "user" or "api_key"

Filter by the kind of actor that acted

--client-ip: optional string

Filter by client IP address, matched exactly

--created-at-max: optional string

Only entries at or before this RFC 3339 instant

--created-at-min: optional string

Only entries at or after this RFC 3339 instant

--cursor: optional string

Pagination cursor returned by a previous request. Only valid for the same filters and sort order.

--limit: optional number

Maximum number of items to return

--method: optional string

Filter by HTTP method

--path: optional string

Filter by a case-insensitive substring of the request path

--sort: optional string

Comma-separated sort terms in precedence order, each field:asc or field:desc. Fields: created_at, status_code

--status-code-max: optional number

Only entries with a status code at or below this

--status-code-min: optional number

Only entries with a status code at or above this, e.g. 400 for failures only

--target-id: optional string

Filter by the resource acted on

--target-type: optional string

Filter by the kind of resource acted on

ReturnsExpand Collapse

audit_log_list: object { items, pagination }

items: array of AuditLog { id, action, actor, 7 more }

id: string

Unique identifier for the audit log entry.

action: string

The action that was performed.

actor: object { id, name, type }

The entity that performed the action.

id: string

Unique identifier for the actor.

name: string

Display name of the actor.

type: "user" or "api_key"

Type of actor.

"user"

"api_key"

client_ip: string

Client IP address.

created_at: string

When the action occurred.

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: optional object { id, type }

The target resource of the action.

id: string

Unique identifier for the target resource.

type: string

Type of the target resource.

pagination: object { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

List Audit Logs

nirvana audit-logs list \
  --api-key 'My API Key'

{
  "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

{
  "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
  }
}