Skip to main content
GET
/
events
cURL
curl \
  --no-buffer \
  --unix-socket /run/miru/miru.sock \
  --request GET \
  --url http://localhost/v0.2/events
{
  "object": "event",
  "id": 42,
  "type": "deployment.deployed",
  "occurred_at": "2026-03-10T12:00:00Z",
  "data": {
    "deployment_id": "dpl_123",
    "release_id": "rls_123",
    "status": "deployed",
    "activity_status": "deployed",
    "error_status": "none",
    "target_status": "deployed",
    "deployed_at": "2026-03-10T12:00:00Z"
  }
}

Headers

​
Last-Event-ID
string

Standard SSE reconnection header. Used as the replay cursor if after query parameter is not provided.

Query Parameters

​
after
integer<int64>

Event ID cursor. Only events with id greater than this value are returned. Takes precedence over the Last-Event-ID header.

​
types
string[]

Event types to receive. If omitted, all event types are sent.

Response

200 - text/event-stream

SSE event stream. Each event is delivered as an SSE frame with id, event, and data fields.

​
object
enum<string>
required

The object type, which is always event.

Available options:
event
Example:

"event"

​
id
integer<int64>
required

Monotonically increasing event ID. Used as the SSE id field and for replay cursors.

Example:

42

​
type
string
required

Event type string in the format {resource}.{action}.

Example:

"deployment.deployed"

​
occurred_at
string<date-time>
required

Timestamp of when the event occurred.

Example:

"2026-03-10T12:00:00Z"

​
data
object
required

Event-specific payload. Shape varies by event type.

Last modified on April 7, 2026