Data Hub
Watchers

Report whether a config revision was applied

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

POST
/watchers/{watcherId}/config-revisions/{revision}/result

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
revision*integer
Range0 < value

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/config-revisions/1/result" \  -H "Content-Type: application/json" \  -d '{    "status": "applied"  }'
{  "revision": 1,  "source": "web",  "status": "pending",  "status_reason": "string",  "settings": {    "watch_directory": "string",    "file_patterns": [      "string"    ],    "run_detection": {      "pattern": "string",      "recursive": true    },    "upload_mode": "auto",    "stability_period_seconds": 1,    "max_stability_wait_seconds": 1,    "upload_parallelism": 1  },  "created_at": "2019-08-24T14:15:22Z",  "resolved_at": "2019-08-24T14:15:22Z",  "created_by": {    "id": "string",    "name": "string",    "email": "string"  },  "created_by_token": {    "id": "string",    "name": "string"  }}
{  "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    }  }}

Get the config revision a watcher should apply GET

Requires scope `watchers:read`. PAT only; browser sessions are rejected. Returns the newest `pending` revision if there is one, otherwise the highest-numbered revision. A pending revision can sit below a higher `superseded` one when a change from Data Hub wins over an older offline edit on the PC. Returns 404 when the watcher has no revisions.

Update an archive job PATCH

Requires scope `archive-jobs:write`. PAT only; browser sessions are rejected.