Events API
The /events API endpoint
/events (GET)
The /events API endpoint provides HTTP GET access to event data.
EXAMPLE
The following example demonstrates a request to the /events API, resulting in
a JSON Array containing event definitions.
curl -H "Authorization: Bearer TOKEN" \
http://127.0.0.1:8080/api/core/v2/namespaces/default/events
HTTP/1.1 200 OK
[
{
"timestamp": 1542667666,
"entity": {
"entity_class": "agent",
"system": {
"hostname": "webserver01",
"...": "...",
"arch": "amd64"
},
"subscriptions": [
"testing",
"entity:webserver01"
],
"metadata": {
"name": "check-nginx",
"namespace": "default",
"labels": null,
"annotations": null
}
},
"check": {
"check_hooks": null,
"duration": 2.033888684,
"command": "http_check.sh http://localhost:80",
"handlers": [
"slack"
],
"high_flap_threshold": 0,
"interval": 20,
"low_flap_threshold": 0,
"publish": true,
"runtime_assets": [],
"subscriptions": [
"testing"
],
"proxy_entity_name": "",
"check_hooks": null,
"stdin": false,
"ttl": 0,
"timeout": 0,
"duration": 0.010849143,
"output": "",
"state": "failing",
"status": 1,
"total_state_change": 0,
"last_ok": 0,
"occurrences": 1,
"occurrences_watermark": 1,
"output_metric_format": "",
"output_metric_handlers": [],
"env_vars": null,
"metadata": {
"name": "check-nginx",
"namespace": "default",
"labels": null,
"annotations": null
}
}
}
]API Specification
| /events (GET) | |
|---|---|
| description | Returns the list of events. |
| example url | http://hostname:8080/api/core/v2/namespaces/default/events |
| response type | Array |
| response codes |
|
| output | |
/events (POST)
| /events (POST) | |
|---|---|
| description | Create a Sensu event. |
| example URL | http://hostname:8080/api/core/v2/namespaces/default/events |
| payload | |
| response codes |
|
The /events/:entity API endpoint
/events/:entity (GET)
The /events/:entity API endpoint provides HTTP GET access to event data specific to an :entity, by entity name.
EXAMPLE
In the following example, querying the /events/:entity API returns a list of Sensu events for the sensu-go-sandbox entity and a successful HTTP 200 OK response.
curl -H "Authorization: Bearer TOKEN" \
http://127.0.0.1:8080/api/core/v2/namespaces/default/events/sensu-go-sandbox
HTTP/1.1 200 OK
[
{
"timestamp": 1543871497,
"entity": {
"entity_class": "agent",
"system": {
"hostname": "webserver01",
"...": "...",
"arch": "amd64"
},
"subscriptions": [
"linux",
"entity:sensu-go-sandbox"
],
"last_seen": 1543858763,
"metadata": {
"name": "sensu-go-sandbox",
"namespace": "default"
}
},
"check": {
"command": "check-cpu.sh -w 75 -c 90",
"duration": 1.054253257,
"executed": 1543871496,
"history": [
{
"status": 0,
"executed": 1543870296
}
],
"issued": 1543871496,
"output": "CPU OK - Usage:.50\n",
"state": "passing",
"status": 0,
"total_state_change": 0,
"last_ok": 1543871497,
"occurrences": 1,
"metadata": {
"name": "check-cpu",
"namespace": "default"
}
},
"metadata": {
"namespace": "default"
}
},
{
"timestamp": 1543871524,
"entity": {
"entity_class": "agent",
"system": {
"hostname": "webserver01",
"...": "...",
"arch": "amd64"
},
"subscriptions": [
"linux",
"entity:sensu-go-sandbox"
],
"last_seen": 1543871523,
"metadata": {
"name": "sensu-go-sandbox",
"namespace": "default"
}
},
"check": {
"handlers": [
"keepalive"
],
"executed": 1543871524,
"history": [
{
"status": 0,
"executed": 1543871124
}
],
"issued": 1543871524,
"output": "",
"state": "passing",
"status": 0,
"total_state_change": 0,
"last_ok": 1543871524,
"occurrences": 1,
"metadata": {
"name": "keepalive",
"namespace": "default"
}
},
"metadata": {}
}
]API Specification
| /events/:entity (GET) | |
|---|---|
| description | Returns a list of events for the specified entity. |
| example url | http://hostname:8080/api/core/v2/namespaces/default/events/sensu-go-sandbox |
| response type | Array |
| response codes |
|
| output | |
The /events/:entity/:check API endpoint
/events/:entity/:check (GET)
API Specification
| /events/:entity/:check (GET) | |
|---|---|
| description | Returns an event for a given entity and check. |
| example url | http://hostname:8080/api/core/v2/namespaces/default/events/sensu-go-sandbox/check-cpu |
| response type | Map |
| response codes |
|
| output | |
/events/:entity/:check (DELETE)
EXAMPLE
The following example shows a request to delete the event produced by the sensu-go-sandbox entity and check-cpu check, resulting in a successful HTTP 204 No Content response.
curl -X DELETE \
-H "TOKEN" \
http://127.0.0.1:8080/api/core/v2/namespaces/default/events/sensu-go-sandbox/check-cpu
HTTP/1.1 204 No ContentAPI Specification
| /events/:entity/:check (DELETE) | |
|---|---|
| description | Deletes the event created by the specified entity using the specified check |
| example url | http://hostname:8080/api/core/v2/namespaces/default/events/sensu-go-sandbox/check-cpu |
| response codes |
|