Skip to content
NebulaCtrldocs
HTTP APIEndpoints

Events

A live stream of hints about what changed in the active organization. Each operation lists its method and path, parameters, request body, responses and an example call.

Stream invalidation hints for the active organization: a `change` event names what changed, a `resync` event means hints were dropped and everything shown should be refetched.

GET/api/v1/events/stream

Authorization

AuthorizationBearer <token>

An API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.

In: header

Response Body

text/event-stream

application/problem+json

curl -X GET "https://example.com/api/v1/events/stream"
[  {    "data": {      "environmentId": "string",      "id": "string",      "kind": "deployment",      "projectId": "string",      "serviceId": "string"    },    "event": "change",    "id": 0,    "retry": 0  }]

Observability

Logs, metrics, traffic and runtime state of services and environments. Each operation lists its method and path, parameters, request body, responses and an example call.

Volume Backups

Backups and restores of volumes, and their schedules. Each operation lists its method and path, parameters, request body, responses and an example call.