empayre/fleet
14
0
Fork 0
mirror of https://github.com/empayre/fleet.git synced 2024-11-06 17:05:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
ea744709e0
fleet/frontend/kolide
History
Zachary Wasserman ea744709e0
Fix handling of missing scheduled query parameters in UI (#1870) 
The UI previously expected these parameters to be set, but instead we can
massage the data appropriately (because they are not required to be set by
fleetctl).

Fixes #1869
2018-07-17 10:03:31 -07:00
..
entities Fix deletion of labels in UI (#1848) 2018-06-25 13:56:59 -07:00
base.js SSO Login and Configuration Support (#1506) 2017-05-17 10:58:40 -05:00
endpoints.js Remove decorators and osquery config from the UI (#1769) 2018-05-08 11:03:32 -06:00
helpers.js Fix handling of missing scheduled query parameters in UI (#1870) 2018-07-17 10:03:31 -07:00
helpers.tests.js removing license code (#1551) 2017-09-01 10:42:46 -06:00
index.js Remove decorators and osquery config from the UI (#1769) 2018-05-08 11:03:32 -06:00
index.tests.js Refactor API client (#1335) 2017-03-02 17:07:01 -05: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
websockets.js Refactor API client (#1335) 2017-03-02 17:07:01 -05: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.