entities
Get a list of entities by type. A returned empty list indicates no entities matched the given parameters.
get/v1/entities
Query parameters
typestring
The entity type to search. If omitted or empty, the search includes all entity types.
namestring
The entity name to search for. Searches are case-insensitive and match any value containing the provided string.
searchstring
An optional contextual search query string. If used along with request parameter name, entities must match both filters.
pageSizeinteger
Number of items in a response page. Default varies by API.
skipTokenstring
Token for the requested page.
Response
The request has succeeded.
Example response
{
"entities": [
{
"id": "e-1234567890",
"type": "SyslogHost",
"name": "syslog-host-1",
"displayName": "SyslogTest",
"createdTime": "2024-11-25T16:38:24Z",
"updatedTime": "2024-12-01T16:38:24Z",
"lastSeenTime": "2024-11-25T16:38:24Z",
"tags": {
"gg.tk.token": "test",
"kfi.tk.token": "qa-test"
},
"attributes": {
"protocols": [
"HTTP"
],
"features": [
"rum"
],
"isAvailabilityCheckPaused": false,
"extensions": {
"has_extension": true
}
}
}
]
}