Data Hub
Watchers

Record a watcher heartbeat

Requires scope `watchers:report`. PAT only; browser sessions are rejected.

POST
/watchers/{watcherId}/heartbeat

Requires scope watchers:report. PAT only; browser sessions are rejected.

Authorization

bearerAuth
AuthorizationBearer <token>

Personal access tokens begin with dhub_… and are restricted by their assigned scopes.

In: header

Path Parameters

watcherId*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/watchers/497f6eca-6276-4993-bfeb-53cbbbba6f08/heartbeat" \  -H "Content-Type: application/json" \  -d '{    "status": "registered"  }'
{  "ok": true,  "config_revision": 0}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}

Report a watcher event POST

Requires scope `watchers:report`. PAT only; browser sessions are rejected. Event types that only Data Hub writes, such as `upload_requests_cancelled`, are rejected with a 400 error. The event list still returns them.

List watcher heartbeats GET

Requires scope `watchers:read`.