Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APICore grammarWatch

Watch routes: pause, replay, resume, rotate

The Watch Verbs pause, replay, resume, rotate as api.sb routes, with inputs, result, refusals and an example.

Reference for Watch, one group of Watch routes.

Watch.pause

Pause stops a Watch delivering while its Events keep queuing; the platform pauses a Watch whose deliveries fail for three days. Verb page.

Text
POST /{namespace}/watches/{watch}/pause

Path: watch. Body, as JSON: the other inputs. Emits Watch.paused.

Inputs

InputTypeRequiredDescription
watchWatchrequiredThe Watch to pause.
reasontextWhy deliveries stop.

Returns

OutputTypeRequiredDescription
watchWatchrequiredThe paused Watch.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/watches/watch_9o4vCuR17L/pause \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "watch": {
    "$id": "https://api.sb/leaseline.app/watches/watch_9o4vCuR17L",
    "$type": "Watch",
    "selector": "Example selector",
    "url": "https://leaseline.app"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Watch.pause",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Watch.replay

Replay redelivers a Watch’s Events from a chosen point, signed as they were the first time. Verb page.

Text
POST /{namespace}/watches/{watch}/replay

Path: watch. Body, as JSON: the other inputs. Emits Watch.replayed.

Inputs

InputTypeRequiredDescription
watchWatchrequiredThe Watch to replay.
fromdatetimerequiredWhere the replay starts.

Returns

OutputTypeRequiredDescription
watchWatchrequiredThe Watch, replaying.

Refuses when

CheckErrorFixThen call
The input does not match the schema of the operation.invalid-inputRead the schema of the operation, then send every required field with the right type.None.
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/watches/watch_9o4vCuR17L/replay \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"2026-10-22T12:00:00Z"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "watch": {
    "$id": "https://api.sb/leaseline.app/watches/watch_9o4vCuR17L",
    "$type": "Watch",
    "selector": "Example selector",
    "url": "https://leaseline.app"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Watch.replay",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Watch.resume

Resume restarts a paused Watch and delivers the Events it held, oldest first. Verb page.

Text
POST /{namespace}/watches/{watch}/resume

Path: watch. Emits Watch.resumed.

Inputs

InputTypeRequiredDescription
watchWatchrequiredThe paused Watch.

Returns

OutputTypeRequiredDescription
watchWatchrequiredThe Watch, delivering again.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/watches/watch_9o4vCuR17L/resume \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "watch": {
    "$id": "https://api.sb/leaseline.app/watches/watch_9o4vCuR17L",
    "$type": "Watch",
    "selector": "Example selector",
    "url": "https://leaseline.app"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Watch.resume",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Watch.rotate

Rotate issues a new signing secret for a Watch and signs with both secrets until the old one expires. Verb page.

Text
POST /{namespace}/watches/{watch}/rotate

Path: watch. Body, as JSON: the other inputs. Emits Watch.rotated.

Inputs

InputTypeRequiredDescription
watchWatchrequiredThe Watch whose secret changes.
overlapstringHow long the old secret keeps signing, as an ISO 8601 duration; defaults to PT24H.

Returns

OutputTypeRequiredDescription
watchWatchrequiredThe Watch, signing with both secrets.
secretstringrequiredThe new signing secret, shown once.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/watches/watch_9o4vCuR17L/rotate \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "watch": {
    "$id": "https://api.sb/leaseline.app/watches/watch_9o4vCuR17L",
    "$type": "Watch",
    "selector": "Example selector",
    "url": "https://leaseline.app"
  },
  "secret": "Example secret",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Watch.rotate",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update, delete

Previous

Workflow

Next