curl --request POST \
--url https://api.watchdog.no/v1/agreements/{id}/teach \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"note": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({note: '<string>'})
};
fetch('https://api.watchdog.no/v1/agreements/{id}/teach', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/agreements/{id}/teach"
payload = { "note": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alert_count": 123,
"changed_count": 1
}{
"error": {
"code": "validation_error",
"message": "The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB.",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "The bearer token is missing or invalid.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The agreement or an alert in alert_ids was not found.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "An alert in alert_ids belongs to another agreement, the filter matches no alert of this agreement, or it matches too many. Nothing changed.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Wait for the Retry-After delay before retrying.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Temporarily unavailable. Retry after the Retry-After delay, when provided.",
"request_id": "req_example"
}
}Teach the agreement a rule from alerts (don't flag this again)
Records a rule about alerts of this agreement, such as a tolerance you accept, and starts a run that suggests an edit to the agreement’s instructions so later checks stop flagging such deviations. Nothing else changes: the alerts keep their verdict (unless to_review sets one for those still to review), claim and credit, and the instructions change only when someone accepts a suggestion (GET /v1/agreements//context-suggestions). The alerts show the rule’s scope, whatever their verdict. To mark alerts as false alarms without stating a rule, use POST /v1/alerts/update. Every selected alert must belong to this agreement; a filter leaves other agreements’ alerts out. Select alerts with alert_ids or filter, at most 5000 per request. Each call records a new rule and starts its own run, so check the agreement’s runs before sending it again. The agreement’s activity records who taught the rule, its note and what it decided (agreements.alert_rule_taught), and every verdict change it made names the rule (data.reason rule, data.rule_dismissal_id).
curl --request POST \
--url https://api.watchdog.no/v1/agreements/{id}/teach \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"note": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({note: '<string>'})
};
fetch('https://api.watchdog.no/v1/agreements/{id}/teach', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/agreements/{id}/teach"
payload = { "note": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alert_count": 123,
"changed_count": 1
}{
"error": {
"code": "validation_error",
"message": "The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB.",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "The bearer token is missing or invalid.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The agreement or an alert in alert_ids was not found.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "An alert in alert_ids belongs to another agreement, the filter matches no alert of this agreement, or it matches too many. Nothing changed.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Wait for the Retry-After delay before retrying.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Temporarily unavailable. Retry after the Retry-After delay, when provided.",
"request_id": "req_example"
}
}Authorizations
Headers
Body
Response
The rule is recorded and its suggestions are on the way. Follow the run with getWorkflowRun.