Entities API
The /entities
API endpoint
/entities
(GET)
The /entities
API endpoint provides HTTP GET access to entity data.
EXAMPLE
The following example demonstrates a request to the /entities
API, resulting in
a JSON Array containing entity definitions.
curl http://127.0.0.1:8080/api/core/v2/namespaces/default/entities -H "Authorization: Bearer $SENSU_TOKEN"
[
{
"entity_class": "agent",
"system": {
"hostname": "sensu-centos",
"os": "linux",
"platform": "centos",
"platform_family": "rhel",
"platform_version": "7.4.1708",
"network": {
"interfaces": [
{
"name": "lo",
"addresses": [
"127.0.0.1/8",
"::1/128"
]
},
{
"name": "enp0s3",
"mac": "08:00:27:11:ad:d2",
"addresses": [
"10.0.2.15/24",
"fe80::f50c:b029:30a5:3e26/64"
]
},
{
"name": "enp0s8",
"mac": "08:00:27:9f:5d:f3",
"addresses": [
"172.28.128.3/24",
"fe80::a00:27ff:fe9f:5df3/64"
]
}
]
},
"arch": "amd64"
},
"subscriptions": [
"entity:sensu-centos"
],
"last_seen": 1543349936,
"deregister": false,
"deregistration": {},
"user": "agent",
"redact": [
"password",
"passwd",
"pass",
"api_key",
"api_token",
"access_key",
"secret_key",
"private_key",
"secret"
],
"metadata": {
"name": "sensu-centos",
"namespace": "default",
"labels": null,
"annotations": null
}
}
]
API Specification
/entities (GET) | |
---|---|
description | Returns the list of entities. |
example url | http://hostname:8080/api/core/v2/namespaces/default/entities |
pagination | This endpoint supports pagination using the limit and continue query parameters. See the API overview for details. |
response type | Array |
response codes |
|
output |
|
/entities
(POST)
/entities (POST) | |
---|---|
description | Create a Sensu entity. |
example URL | http://hostname:8080/api/core/v2/namespaces/default/entities |
payload |
|
response codes |
|
The /entities/:entity
API endpoint
/entities/:entity
(GET)
The /entities/:entity
API endpoint provides HTTP GET access to entity data for specific :entity
definitions, by entity name
.
EXAMPLE
In the following example, querying the /entities/:entity
API returns a JSON Map
containing the requested :entity
definition (in this example: for the :entity
named
sensu-centos
).
curl http://127.0.0.1:8080/api/core/v2/namespaces/default/entities/sensu-centos -H "Authorization: Bearer $SENSU_TOKEN"
{
"entity_class": "agent",
"system": {
"hostname": "sensu-centos",
"os": "linux",
"platform": "centos",
"platform_family": "rhel",
"platform_version": "7.4.1708",
"network": {
"interfaces": [
{
"name": "lo",
"addresses": [
"127.0.0.1/8",
"::1/128"
]
},
{
"name": "enp0s3",
"mac": "08:00:27:11:ad:d2",
"addresses": [
"10.0.2.15/24",
"fe80::f50c:b029:30a5:3e26/64"
]
},
{
"name": "enp0s8",
"mac": "08:00:27:9f:5d:f3",
"addresses": [
"172.28.128.3/24",
"fe80::a00:27ff:fe9f:5df3/64"
]
}
]
},
"arch": "amd64"
},
"subscriptions": [
"entity:sensu-centos"
],
"last_seen": 1543349936,
"deregister": false,
"deregistration": {},
"user": "agent",
"redact": [
"password",
"passwd",
"pass",
"api_key",
"api_token",
"access_key",
"secret_key",
"private_key",
"secret"
],
"metadata": {
"name": "sensu-centos",
"namespace": "default",
"labels": null,
"annotations": null
}
}
API Specification
/entities/:entity (GET) | |
---|---|
description | Returns a entity. |
example url | http://hostname:8080/api/core/v2/namespaces/default/entities/sensu-centos |
response type | Map |
response codes |
|
output |
|
/entities/:entity
(PUT)
API Specification
/entities/:entity (PUT) | |
---|---|
description | Create or update a Sensu entity. |
example URL | http://hostname:8080/api/core/v2/namespaces/default/entities/sensu-centos |
payload |
|
response codes |
|
/entities/:entity
(DELETE)
The /entities/:entity
API endpoint provides HTTP DELETE access to delete an entity from Sensu given the entity name.
EXAMPLE
The following example shows a request to delete the entity server1
, resulting in a successful HTTP 204 No Content response.
curl -X DELETE \
-H "Authorization: Bearer $SENSU_TOKEN" \
http://127.0.0.1:8080/api/core/v2/namespaces/default/entities/server1
HTTP/1.1 204 No Content
API Specification
/entities/:entity (DELETE) | |
---|---|
description | Removes a entity from Sensu given the entity name. |
example url | http://hostname:8080/api/core/v2/namespaces/default/entities/sensu-centos |
response codes |
|