/sse/v1/status

An HTTP POST request used to update an event stream's status. Spec

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request parameters

string
enum
required

REQUIRED. The status of the stream. Values can be one of:

enabled: The Transmitter MUST transmit events over the stream, according to the stream’s configured delivery method.

paused: The Transmitter MUST NOT transmit events over the stream. The transmitter will hold any events it would have transmitted while paused, and SHOULD transmit them when the stream’s status becomes enabled. If a Transmitter holds successive events that affect the same Subject Principal, then the Transmitter MUST make sure that those events are transmitted in the order of time that they were generated OR the Transmitter MUST send only the last events that do not require the previous events affecting the same Subject Principal to be processed by the Receiver, because the previous events are either cancelled by the later events or the previous events are outdated.

disabled: The Transmitter MUST NOT transmit events over the stream, and will not hold any events for later transmission.

Allowed:
string
Responses

202

The update request has been accepted, but not processed. Receiver MAY try the same request later in order to get processing result.

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json