Documentation menu

Live org progress stream (Server-Sent Events)

GEThttps://api.instacloud.com/orgs/{orgId}/events/stream

Token scope: account · org — read-only tokens allowed.

A long-lived text/event-stream for progress on org-scoped resources (purchased domains). Each live event (orgId, kind; no id) says something moved in the background: domain.order.progress — an order changed status, refetch the orders and the domain inventory; domain.progress — a domain's hostnames or status changed or its zone was published into, refetch the inventory, the orders and an open zone read. Nothing is replayed: after a reconnect, or on a reset event, refetch every view. The server ends each stream after a few minutes; reconnect.

Parameters

NameInTypeRequiredDescription
orgIdpathstringyes

Responses

200

Server-Sent Events: live and reset events

View as Markdown