# Audit Logs

## Get Audit Log

**get** `/v1/audit_logs/{audit_log_id}`

Get an Audit Log entry

### Path Parameters

- `audit_log_id: string`

### Returns

- `AuditLog object { 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`

    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.

      - `"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 AuditLogTarget`

    The target resource of the action.

    - `id: string`

      Unique identifier for the target resource.

    - `type: string`

      Type of the target resource.

### Example

```http
curl https://api.nirvanalabs.io/v1/audit_logs/$AUDIT_LOG_ID \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY"
```

#### Response

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

## List Audit Logs

**get** `/v1/audit_logs`

List Audit Log entries for an organization

### Query Parameters

- `cursor: optional string`

  Pagination cursor returned by a previous request

- `limit: optional number`

  Maximum number of items to return

### Returns

- `AuditLogList object { items, pagination }`

  - `items: array of AuditLog`

    - `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.

        - `"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 AuditLogTarget`

      The target resource of the action.

      - `id: string`

        Unique identifier for the target resource.

      - `type: string`

        Type of the target resource.

  - `pagination: Pagination`

    Pagination response details.

    - `next_cursor: string`

    - `previous_cursor: string`

    - `total_count: number`

### Example

```http
curl https://api.nirvanalabs.io/v1/audit_logs \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY"
```

#### Response

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

## Domain Types

### Audit Log

- `AuditLog object { 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`

    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.

      - `"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 AuditLogTarget`

    The target resource of the action.

    - `id: string`

      Unique identifier for the target resource.

    - `type: string`

      Type of the target resource.

### Audit Log Actor

- `AuditLogActor 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: AuditLogType`

    Type of actor.

    - `"user"`

    - `"api_key"`

### Audit Log List

- `AuditLogList object { items, pagination }`

  - `items: array of AuditLog`

    - `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.

        - `"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 AuditLogTarget`

      The target resource of the action.

      - `id: string`

        Unique identifier for the target resource.

      - `type: string`

        Type of the target resource.

  - `pagination: Pagination`

    Pagination response details.

    - `next_cursor: string`

    - `previous_cursor: string`

    - `total_count: number`

### Audit Log Target

- `AuditLogTarget object { id, type }`

  The target resource of the action.

  - `id: string`

    Unique identifier for the target resource.

  - `type: string`

    Type of the target resource.

### Audit Log Type

- `AuditLogType = "user" or "api_key"`

  Type of actor.

  - `"user"`

  - `"api_key"`