Revoke an event stream
/event-streams/{event_stream_id}Revokes the event stream and closes any open connection to it shortly afterward.
The stream is not removed: it remains available through the retrieve and list operations with the revoked status.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Public ID of the event stream, prefixed with str_.
Header Parameters
Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.
Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.
length <= 64Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/event-streams/string"Retrieve an event stream GET
Returns the event stream's status, filters, delivery cursor, and connection state. Revoked and expired event streams remain retrievable.
Connect to an event stream GET
Opens the Server-Sent Events connection for an event stream. Send `Accept: text/event-stream` and authenticate with the `Authorization` header; credentials in the query string are not accepted. Each message carries the event's public ID in `id`, its type in `event`, and in `data` the same JSON returned when retrieving the event. Without a `Last-Event-ID` header, delivery resumes from the stream's stored cursor; with it, delivery resumes after that event. Keep-alive comments are sent periodically. Only one connection per stream is allowed at a time. The server closes the connection after a maximum duration, or when the stream expires, is revoked, or the credential is revoked; reconnect with `Last-Event-ID` to continue. Each connection extends the stream's expiration. Delivery has a latency of a few seconds and is not real-time.