empayre/fleet
14
0
Fork 0
mirror of https://github.com/empayre/fleet.git synced 2024-11-06 08:55:24 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
d624e099fb
fleet/frontend/kolide
History
Zach Wasserman 7a68e3de65
Deprecate /api/v1/kolide routes (#297) 
- Support both /api/v1/fleet and /api/v1/kolide routes in server.
- Add logging for use of deprecated routes.
- Rename routes in frontend JS.
- Rename routes and add notes in documentation.
2021-02-10 12:13:11 -08:00
..
entities Deprecate /api/v1/kolide routes (#297) 2021-02-10 12:13:11 -08:00
base.js Add ability to prefix Fleet URLs (#2112) 2019-10-16 16:40:45 -07:00
endpoints.js Deprecate /api/v1/kolide routes (#297) 2021-02-10 12:13:11 -08:00
helpers.js Add Host details page (#238) 2021-01-28 12:44:48 -08:00
helpers.tests.js Migrate JS tests to Jest and update libraries (#74) 2020-12-01 10:15:12 -08:00
index.js Implement osquery options page (#11) 2020-11-04 18:00:51 -08:00
index.tests.js Migrate JS tests to Jest and update libraries (#74) 2020-12-01 10:15:12 -08:00
README.md Add Front-end Documentation (#1373) 2017-03-10 17:13:29 -05:00
request.js Refactor API client (#1335) 2017-03-02 17:07:01 -05:00
status.js Add ability to disable live queries (#2167) 2020-01-13 16:53:04 -08:00
websockets.js Deprecate /api/v1/kolide routes (#297) 2021-02-10 12:13:11 -08:00

README.md

Kolide API Client

The Kolide API Client is used for communicating with the Kolide API. Kolide has a number of entities (hosts, labels, packs, queries, users, etc), all of which have CRUD methods to perform on a specific entity or collection of entities.

Entities are assigned to the API Client in the constructor function. Each entity's methods can be found in the /frontend/kolide/entities directory.

The CRUD methods that are typically implemented in the API client are as follows:

create

  • The create method is used for creating a new entity. The input parameter is typically an object containing the attributes for the new entity.

destroy

  • The destroy method is used for deleting an entity. Then input parameter is typically the entity to be deleted.

load

  • The load method is used for loading a single entity. The input parameter is typically the id of the entity to load.

loadAll

  • The loadAll method is used for loading all of the entities.

update

  • The update method is used to update an entity. The input parameters are typically the entity being updated and an object with the updated attributes.