files

A watch's events after a cursor, or follow them live.

JSON: events after cursor, notices, nextCursor to pass next time, lostBytes when this reader fell more than 1 MiB behind (rescan), ended. waitMs (up to 8000) holds the call until something happens. follow=true (or Accept: application/x-ndjson) streams events until the watch ends; a stream ends with paused when the sandbox pauses (read again after it wakes: nothing is lost) or continue after 110 s, each with the cursor to resume from. Reading never wakes a paused sandbox.

get/v1/sandboxes/{id}/files/watches/{watchId}/events

Request

  • Base URL: https://api.withruntime.com
  • URL: https://api.withruntime.com/v1/sandboxes/{id}/files/watches/{watchId}/events
  • Auth: HTTP bearer

Path parameters

idstring required

Resource identifier (UUID).

watchIdstring required

A watch's id.

Query parameters

cursorinteger
waitMsinteger
followboolean

Response

Success

noticesobject[] required

overflow {dropped, reason: kernel|rate}: events were lost, rescan. limit {watches}: some directories are not watched. end {reason}: the watch stopped.

nextCursorinteger required
lostBytesinteger required

Events the sandbox discarded because this reader fell over 1 MiB behind.

endedboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.