Read retained changes or subscribe

GET/v1/disks/{disk}/notifications

GET

/v1/disks/{disk}/notifications

const url = 'https://api.wabe.sh/v1/disks/demo/notifications?sse=false&include_value=false&entity=file&limit=100';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url 'https://api.wabe.sh/v1/disks/demo/notifications?sse=false&include_value=false&entity=file&limit=100' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth
runtimeAccess

Parameters

Path Parameters

disk

required

string

/^[A-Za-z0-9_-]{1,128}$/

Example

demo

Project disk name, or the disk ID in the actor runtime disk URL.

Query Parameters

sequence

string

Exclusive opaque cursor; omitted or 0 starts at retained history.

sse

boolean

Replay retained history then stream live events with SSE.

include_value

boolean

Deliver previously captured content in value_chunk records.

entity

string

Allowed values: file kv

Restrict the resource kind.

file_prefix

string

Literal normalized file-path prefix; cannot combine with namespace.

namespace

string

Exact KV namespace; cannot combine with file_prefix.

limit

integer

default: 100 >= 1 <= 1000

Finite GET only; maximum examined events, including filtered events.

branch

string

Header Parameters

Last-Event-ID

string

Cursor fallback when sequence query is omitted.

Responses

200

A finite NDJSON page or a live SSE stream, selected by sse.

string

Example

{"type":"checkpoint","sequence":"62ad930b-c1e6-4d3c-ab84-8bf74a025d2f:42"}

When sse=true; Last-Event-ID can supply the resume cursor.

string

Example

event: checkpoint
id: 62ad930b-c1e6-4d3c-ab84-8bf74a025d2f:42
data: {"type":"checkpoint","sequence":"62ad930b-c1e6-4d3c-ab84-8bf74a025d2f:42"}

Headers

X-Notification-Sequence

string

Journal head at request start.

400

Invalid settings, cursor or filters.

object

code

required

string

message

required

string

401

Missing, invalid or revoked project API key, or an invalid runtime access token.

application/json

object

error

required

string

message

required

string

403

Actor runtime token does not authorize this disk or instance generation.

application/json

object

error

required

string

message

required

string

404

Sequence_expired: reload state and resume from sequence=0.

object

code

required

string

message

required

string

409

Conflict, nonempty destination or referenced object.

text/plain

string

500

Storage failure.

object

code

required

string

message

required

string

503

Notifications closed.

application/json

object

code

required

string

message

required

string