Audit

Server

Audit events attribute state changes to the operation that caused them. Events are emitted to the controller's configured log sinks and are not stored or queryable here; this API subscribes to them live.

GET

https://api.sfo.unikraft.cloud

/v1/audit

Subscribe to audit events as they are raised.

events

Audit.AuditEventType[]

Deliver only these event types.

Enum values:

vm.state_change

vm.start_failed

gap

uuid

string[]

Deliver only events about these object UUIDs.

tags

string[]

Deliver only events about objects carrying all of these tags.

The audit event stream.

The default response rather than 200 because that is what marks an operation as streaming: a status-coded response describes one body, this describes every message on an open connection.

One audit event.

Audit.AuditEvent

type

string · enum · required

The type of event.

Enum values:

vm.state_change

vm.start_failed

gap

timestamp

string · date-time · required

When the event was raised.

object

The object the event is about. Absent on gap, which names no object.

object

The operation the event belongs to.

object

The event payload. Its fields depend on type.

dropped

integer · uint64

How many events were lost. Only on gap.

GET/v1/audit

curl https://api.sfo.unikraft.cloud/v1/audit \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "type": "vm.state_change",
  "timestamp": "2024-08-25T15:00:00Z",
  "object": {
    "type": "i",
    "uuid": "00000000-0000-0000-0000-000000000000",
    "owner": "00000000-0000-0000-0000-000000000000",
    "tags": [
      "string"
    ]
  },
  "attribution": {
    "operation": "00000000-0000-0000-0000-000000000000",
    "kind": "start",
    "trigger": "requested",
    "origin": "unknown",
    "user": "00000000-0000-0000-0000-000000000000"
  },
  "data": {
    "prev": "prev",
    "new": "new",
    "state": "state",
    "error": "error",
    "stop": {
      "reason": [
        "string"
      ],
      "code": 0,
      "cause": "cause"
    }
  },
  "dropped": 0
}

text

text/event-stream

Node

Audit

Subscribe to Audit Events

Subscribe to Audit Events › query Parameters

Subscribe to Audit Events › Responses