Probe the live event stream

HEAD

/events

const url = 'https://example.com/api/v1/events';
const options = {method: 'HEAD'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request HEAD \
  --url https://example.com/api/v1/events

Runs the same authentication, scope and capacity checks as GET without opening a stream. Clients use it to classify an EventSource error (auth failure vs capacity vs network).

Parameters

Header Parameters

X-Api-Key

string

Praxrr API token (prx_…) with the read scope.

Query Parameters

apikey

string

Praxrr API token with the read scope, for EventSource clients that cannot set headers. Warning: the token leaks into proxy and access logs and browser history; prefer X-Api-Key.

Responses

204

A stream would be accepted.

401

Unauthenticated.

403

The API token lacks the read scope.

429

Too many concurrent streams for this principal.

Headers

Retry-After

integer

Seconds to wait before retrying.

503

The server-wide stream limit is reached.

Headers

Retry-After

integer

Seconds to wait before retrying.