Alert Interface

List configured alerts

GET/api/v6.1.0.26/hubs/{hub}/alerts

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `alert*`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: Hub not found
Required permissions	ReadOnly access level on hub

POST/api/v6.1.0.26/hubs/{hub}/alerts

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'alert' : 'props' : { prop *: value }`
Response headers	None
Response body	None
Status codes	✅ 201 Created ❌ 400 Bad Request: Alert already exists ❌ 404 Not Found: Hub not found
Required permissions	ReadWrite access level on hub
Events	Creates the following event: Alert_Create `'alert' : 'props' : { prop *: value }`

DELETE/api/v6.1.0.26/hubs/{hub}/alerts/{alert}

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Hub or Alert not found
Required permissions	ReadWrite access level on hub
Events	Creates the following event: Alert_Delete `'alert' :`

POST/api/v6.1.0.26/hubs/{hub}/alerts/{alert}/clear

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Hub or Alert not found
Required permissions	ReadWrite access level on hub
Events	Creates the following event: Alert_Clear `'alert' :`

POST/api/v6.1.0.26/hubs/{hub}/alerts/{alert}/disable

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Hub or Alert not found
Required permissions	ReadWrite access level on hub
Events	Creates the following event: Alert_Disable `'alert' :`

POST/api/v6.1.0.26/hubs/{hub}/alerts/{alert}/execute

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body (text)	None
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: Hub not found
Required permissions	ReadExec access level on hub
Events	Creates the following event: Alert_Notification `'alert' : 'latency_sla' ?: { 'over' : { job : { 'latency' : 'sla' : } } 'under' : } 'error_summary' \| 'warning_summary' ?: { err_id : { 'count' : 'first' : 'last' ?: } } 'scheduler_alive' : 'alert_errors' ?: ( + )`

GET/api/v6.1.0.26/hubs/{hub}/alerts/{alert}/props

Query parameters	Prototype: `'fetch' ?: ( prop+ )`
Request headers	Prototype: `X-Hvr-Classified-Access :`
Request body	None
Response headers	Prototype: `X-Hvr-Classified-Transport-Key : X-Hvr-Redacted-Storage :`
Response body (JSON)	Prototype: `prop *: value`
Status codes	✅ 200 OK ❌ 400 Bad Request: Specified property does not exist ❌ 404 Not Found: Hub or Alert not found
Required permissions	ReadOnly access level on hub

PATCH/api/v6.1.0.26/hubs/{hub}/alerts/{alert}/props

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `prop *: value \|`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Hub or Alert not found
Required permissions	ReadWrite access level on hub
Events	Creates the following event: Alert_Property_Change `'alert' : 'props_after' : { prop : value \| } 'props_before' ?: { prop : value }`

PUT/api/v6.1.0.26/hubs/{hub}/alerts/{alert}/props

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `prop *: value \|`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Hub or Alert not found
Required permissions	ReadWrite access level on hub
Events	Creates the following event: Alert_Property_Set `'alert' : 'props_after' : { prop : value } 'props_before' ?: { prop : value }`

POST/api/v6.1.0.26/hubs/{hub}/alerts/{alert}/props_delete

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'props' : ( prop+ )`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Hub or Alert not found
Required permissions	ReadWrite access level on hub
Events	Creates the following event: Alert_Property_Delete `'alert' : 'props' : ( prop+ )`

POST/api/v6.1.0.26/hubs/{hub}/alerts/{alert}/props_modify

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'alert_prop_args' : ( { 'key' : ( prop \| \| * ) 'value' : }+ )`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Hub or Alert not found
Required permissions	ReadWrite access level on hub
Events	Creates the following event: Alert_Property_Change `'alert' : 'props_after' : { prop : value \| } 'props_before' ?: { prop : value }`

POST/api/v6.1.0.26/hubs/{hub}/alerts/{alert}/test

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body (text)	None
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: Hub not found
Required permissions	ReadExec access level on hub
Events	Creates no events.