Subscribe to resource change notifications

GET

/api/v1/events

curl --request GET \
  --url 'https://example.com/api/v1/events?env=example&topic=example' \
  --header 'Authorization: <Authorization>'

Best-effort SSE invalidation hints. No replay; refetch REST snapshots after stream.ready and retain polling. Requires the corresponding environment query/carve/admin permissions. Session-scoped console and file_explorer topics require console_session or file_explorer_session respectively. Alerts may use env=all. service_commands and fleet require super-admin permissions and env=all.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

env

required

string

Environment name or UUID; use all only with topic=alerts, topic=service_commands, or topic=fleet

topic

required

Array<string>

Topics: queries, carves, console, file_explorer, alerts, service_commands, fleet

console_session

integer

Console session id required when subscribing to topic=console

file_explorer_session

integer

File explorer session id required when subscribing to topic=file_explorer

Responses

200

SSE stream: stream.ready, resource.changed, auth.expired

Media typetext/event-stream json

string

Example^generated

example

400

Bad Request

Media typetext/event-stream json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

401

Unauthorized

Media typetext/event-stream json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

403

Forbidden

Media typetext/event-stream json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

404

Not Found

Media typetext/event-stream json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

429

Too Many Requests

Media typetext/event-stream json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

503

Service Unavailable

Media typetext/event-stream json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}