API structure has changed
This documentation update aligns with the 8.17.3 release. Check out the release notes.
8 structure changes including:
8 Modifications
Modified
8
Breaking
GET /api/endpoint/action
- Query
-
query query parameter Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- page, pageSize, commands, agentIds, userIds, startDate, endDate, agentTypes, withOutputs, types query parameters Added
GET /api/endpoint/metadata
- Query
-
query query parameter Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- page, pageSize, kuery, hostStatuses, sortField, sortDirection query parameters Added
GET /api/osquery/live_queries
- Query
-
query query parameter Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- kuery, page, pageSize, sort, sortOrder query parameters Added
GET /api/osquery/live_queries/{id}
- Query
-
query query parameter Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
GET /api/osquery/live_queries/{id}/results/{actionId}
- Query
-
query query parameter Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- kuery, page, pageSize, sort, sortOrder query parameters Added
GET /api/osquery/packs
- Query
-
query query parameter Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- page, pageSize, sort, sortOrder query parameters Added
GET /api/osquery/saved_queries
- Query
-
query query parameter Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- page, pageSize, sort, sortOrder query parameters Added
PUT /api/osquery/packs/{id}
- Body
-
application/json; Elastic-Api-Version=2023-10-31 content type Modified
-
id property Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- name property Added
-
id property Removed