public.incidents.view
const url = 'https://rest.watchtower15.com/v1/incidents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://rest.watchtower15.com/v1/incidents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”IncidentsViewResource
object
object
One of open, acknowledged, resolved.
One of warning, critical.
The alarm’s own name, which tells apart two alarms on one metric.
The resource the incident is about, of any type that has alarms.
object
The server of a volume, port or unit; null for every other entity.
object
object
object
Whether the system resolved it (the condition cleared), not a person.
What changed when the incident fired, {<field>: {old, new}}, the stored normalised strings (an SSL instant as its text, the one exception to epoch milliseconds); {} with none. The WHOIS registrant fields are left out.
object
object
The alarm the incident belongs to; null once it is gone.
The scan that raised the incident.
The scan that cleared it.
Epoch milliseconds: when notifications for the trigger were sent.
object
The channel it went out on, such as email or slack: an open set.
How it went: sent, failed, skipped or queued, as the notifier records it; an open set.
Epoch milliseconds.
Example generated
{ "data": { "uuid": "example", "status": "example", "severity": "example", "message": "example", "rule_name": "example", "rule_slug": "example", "metric_name": "example", "scan_type": "example", "entity": { "type": "example", "uuid": "example", "name": "example" }, "parent_entity": { "type": "example", "uuid": "example" }, "triggered_at": 1, "acknowledged_at": 1, "acknowledged_by": { "name": "example" }, "resolved_at": 1, "resolved_by": { "name": "example" }, "resolved_by_system": true, "console_url": "example", "change_detail": { "additionalProperty": { "old": "example", "new": "example" } }, "alarm_uuid": "example", "trigger_scan_uuid": "example", "resolve_scan_uuid": "example", "notification_sent_at": 1, "notifications": [ { "channel": "example", "status": "example", "sent_at": 1 } ] }}The API key is missing, malformed, expired or revoked.
object
https://docs.watchtower15.com/api/errors/<code>/
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "code": "example", "detail": "example", "request_id": "example", "errors": { "additionalProperty": [ "example" ] }, "limit": 1, "used": 1}The key or its owner does not hold what the operation needs.
object
https://docs.watchtower15.com/api/errors/<code>/
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "code": "example", "detail": "example", "request_id": "example", "errors": { "additionalProperty": [ "example" ] }, "limit": 1, "used": 1}No such record in this organisation (an absent id and another organisation’s answer alike).
object
https://docs.watchtower15.com/api/errors/<code>/
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "code": "example", "detail": "example", "request_id": "example", "errors": { "additionalProperty": [ "example" ] }, "limit": 1, "used": 1}The request is invalid; errors names the parameters.
object
https://docs.watchtower15.com/api/errors/<code>/
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "code": "example", "detail": "example", "request_id": "example", "errors": { "additionalProperty": [ "example" ] }, "limit": 1, "used": 1}A rate limit or the organisation’s daily limit is reached; Retry-After says when to retry.
object
https://docs.watchtower15.com/api/errors/<code>/
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "code": "example", "detail": "example", "request_id": "example", "errors": { "additionalProperty": [ "example" ] }, "limit": 1, "used": 1}An unexpected error.
object
https://docs.watchtower15.com/api/errors/<code>/
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "code": "example", "detail": "example", "request_id": "example", "errors": { "additionalProperty": [ "example" ] }, "limit": 1, "used": 1}