Stream Events - Miru

GET

/

events

curl (Linux)

curl \
  --no-buffer \
  --unix-socket /run/miru/miru.sock \
  --request GET \
  --url http://localhost/v0.2/events

$api = Get-Content -Raw "$env:ProgramData\Miru\device-api\device-api.json" | ConvertFrom-Json; `
curl.exe --no-buffer `
  --request GET `
  --url "http://127.0.0.1:$($api.port)/v0.2/events" `
  --header "Authorization: Bearer $($api.token)"

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost/v0.2/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://localhost/v0.2/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost/v0.2/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost/v0.2/events")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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

Authorizations

Authorization

string

header

required

The token from the agent's discovery file (%ProgramData%\Miru\device-api\device-api.json on Windows). Required over loopback TCP (127.0.0.1:6478 by default on Windows) and accepted by every route; not used over the Unix socket.

Headers

Last-Event-ID

string

Standard SSE reconnection header. Used as the replay cursor if after query parameter is not provided. If the cursor is older than the earliest retained event, the server returns 410 Gone.

Query Parameters

after

integer<int64>

Event ID cursor to resume from. Retained events with id greater than this value are replayed, then live events follow. If the cursor is older than the earliest retained event, the server returns 410 Gone. 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. Events are delivered at-least-once, so deduplicate by event id. A ": heartbeat" comment is sent immediately when the connection opens, and again every 30 seconds while the stream is idle. Comments carry no data and should be ignored by clients.

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.

⌘I

curl (Linux)

curl \
  --no-buffer \
  --unix-socket /run/miru/miru.sock \
  --request GET \
  --url http://localhost/v0.2/events

$api = Get-Content -Raw "$env:ProgramData\Miru\device-api\device-api.json" | ConvertFrom-Json; `
curl.exe --no-buffer `
  --request GET `
  --url "http://127.0.0.1:$($api.port)/v0.2/events" `
  --header "Authorization: Bearer $($api.token)"

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost/v0.2/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://localhost/v0.2/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost/v0.2/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost/v0.2/events")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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