Commit graph

76 commits

Author SHA1 Message Date
eashaw
0cb2f21233
updated two links that linked to github (#1913) 2021-09-03 13:02:26 +09:00
gillespi314
edd4366abf
Update 3-REST-API.md
Update `/config` API documentation for `osquery_detail` response in nanoseconds instead of string
2021-08-26 22:15:38 -05:00
noahtalerman
a02bede9c7
Update "Policies" section in API docs (#1801)
- Add anchor link to "Policies" section. Move this section below "Packs"
- Add note on Fleet version in which the Policies feature will be released
2021-08-25 17:05:48 -04:00
RachelElysia
f10636f8d1
Host Details Page: Render disk space (#1770) 2021-08-25 13:05:54 -07:00
Tomas Touceda
a8642493ad
Add global policies (#1750)
* Add global policies

* Update documentation and add extra parameter to config

* Fix failing tests

* Store historic policy records

* Address review comments

And also remove other inmem references I saw by chance

* Add documentation for get by id request

* Add parameter doc

* Move schema generation to a cmd instead of a test

Otherwise it messes up running all tests sometimes depending on how parallel it does

* Remove brain dump for another task

* Make migration tests a separate beast

* Make schema generation idempotent and move dbutils cmd to tools

* Allow all filters and add counts to Policy

* Add test for Policy
2021-08-24 17:24:52 -03:00
Zach Wasserman
2d22020973
Update live query API documentation (#1745)
Attempt to add clarity to the process of using the API to run live queries.
2021-08-19 16:39:17 -07:00
Zach Wasserman
23fabff12a
Update host API doc (#1744)
Include software inventory and users in example response.
2021-08-19 16:22:17 -07:00
noahtalerman
4836864db6
Fix anchor links for "Get enroll secrets" and "Modify enroll secrets" sections in API docs (#1738) 2021-08-19 17:03:35 -04:00
Mike Thomas
7b3b24547d
Updated product name on website and docs (#1731)
Updated product name on website and docs
2021-08-19 12:50:21 -05:00
RachelElysia
7d23ff2b53
Align API docs and frontend interfaces with API GET responses (#1602) 2021-08-16 10:30:19 -04:00
noahtalerman
b2c7faf251
Update "Ask questions about your devices" walkthrough and update API docs (#1670)
- Remove "How to add Fleet's standard query library" section from the "Ask questions about your devices" walkthrough.
- Add `license`, `vulnerability_settings`, and `logging` properties to the example response for the `GET /api/v1/fleet/config` and `PATCH /api/v1/fleet/config` API routes
2021-08-13 15:01:53 -04:00
Zach Wasserman
544652e833
Clarify label responses and API docs (#1633)
- Include platform and description even when empty in API responses.
- Update docs to indicate immutability.
2021-08-11 14:57:05 -07:00
noahtalerman
63e598e595
API documentation for "filter hosts by team" (#1510) 2021-08-11 11:14:59 -04:00
Tomas Touceda
ccd52985ac
Add Team Schedule documentation (#1576)
* Add Team Schedule documentation

* Update docs/1-Using-Fleet/3-REST-API.md

Co-authored-by: noahtalerman <47070608+noahtalerman@users.noreply.github.com>

Co-authored-by: noahtalerman <47070608+noahtalerman@users.noreply.github.com>
2021-08-06 11:19:20 -03:00
noahtalerman
741cfb6a58
Add /activities API route to API documentation (#1529) 2021-08-02 13:49:51 -04:00
Mike McNeil
7a9d530938
fix copy/paste mistake in docs (#1487) 2021-07-27 11:17:04 -05:00
Tomas Touceda
484c6153e3
Issue 1359 fleetctl team transfer (#1413)
* wip

* Add delete user command and translator

* Add host transfer command

* Add changes file

* Undo bad refactor

* Fix copypaste error

* Implement with interfaces instead of assertions

* Ad documentation and simplify implementation further

* Update docs/1-Using-Fleet/3-REST-API.md

Co-authored-by: Zach Wasserman <zach@fleetdm.com>

Co-authored-by: Zach Wasserman <zach@fleetdm.com>
2021-07-21 14:03:10 -03:00
noahtalerman
285d1e66ca
Remove duplicate sections from REST API documentation (#1427)
- Remove duplicate "Transfer hosts to a team" and "Transfer hosts to a team by filter" sections
2021-07-20 09:57:14 -04:00
noahtalerman
7caedd9347
Add routes for Schedule feature to REST API documentation (#1401)
Add documentation (route, parameters, example) for the following routes:
- `GET /api/v1/fleet/global/schedule`
- `POST /api/v1/fleet/global/schedule`
- `PATCH /api/v1/fleet/global/schedule/{id}`
- `DELETE /api/v1/fleet/global/schedule/{id}`
2021-07-19 09:58:41 -04:00
noahtalerman
498209614c
Update examples in documentation to use FleetDM where possible (#1310)
- Remove "Connecting a host" from fleetctl documentation
- Remove queries from REST API examples
- Point to Launcher documentation
- Update community projects
2021-07-06 12:14:20 -04:00
Zach Wasserman
8384034e04
Update create user validation and documentation (#1285)
Closes #1272
2021-07-02 08:35:26 -07:00
noahtalerman
59e31911c9
Update REST API documentation in preparation for Fleet 4.0.0 (#1235)
- Add link and warning to REST API docs for Fleet v3
- Update various endpoints
2021-06-28 14:41:01 -04:00
noahtalerman
6c03415dae
Update documentation structure (#1230)
- Remove `2-Orbit-osquery` directory
- Rename `3-Deployment` directory to `2-Deploying`
- Rename `4-Contribution` directory to `3-Contributing`
2021-06-28 11:15:22 -04:00
Zach Wasserman
b00df0929e
Fix URLs in documentation (#1218)
Fix URLs not caught in previous PR CI run.
2021-06-25 19:23:45 -07:00
Zach Wasserman
5e26af701b Merge branch 'main' into teams 2021-06-25 18:48:20 -07:00
RachelElysia
aeb852e168
Remove username from UI (#1168)
* Remove username from UI code
* Remove username from tests
* Remove username from database
* Modify server endpoints for removing username
* Implement backend aspects of removing username
* Update API docs
* Add name to fleetctl
2021-06-24 13:42:29 -07:00
Zach Wasserman
1417d01407
Make naming of host columns consistent (#1183)
Adding consistency between API and DB helps to make it easier for users
and developers working with the API to correctly order things.

Closes #317
2021-06-23 17:32:19 -07:00
noahtalerman
e02b88d010
Update links to documentation so that they use main branch (#1151)
* Update to main branch

* Update link to releasing Fleet
2021-06-21 16:40:15 -05:00
noahtalerman
17a6c21224
Restructure documentation in preparation for docs living on fleetdm.com (#1143)
* Remove Orbit top level folder and rename folders to Deploying and Contributing

* Update link in doc README
2021-06-18 15:58:21 -05:00
Zach Wasserman
2ad557e3b3 Merge branch 'main' into teams 2021-06-18 09:42:20 -07:00
Zach Wasserman
6b59a40dbc
Add backend and fleetctl support for API-only user (#1119)
- Add api_only to users table.
- Pass api_only values through service.
- Allow setting api_only in `fleetctl user create`.

Backend part of #402
2021-06-16 18:11:28 -07:00
RachelElysia
dea20a96b2
Add team's enroll secret GET request to API docs 2021-06-16 18:09:49 -04:00
Mike McNeil
fccc58536b
Update 3-REST-API.md (#1052) 2021-06-10 12:54:12 -05:00
noahtalerman
9b6c8d36e4
Additions and changes to Fleet REST API for multiple teams (#383)
- Add API documentation for Teams and RBAC features support
2021-06-09 19:11:48 -04:00
Zach Wasserman
db459d3363
Continue to update names in backend code and docs (#976) 2021-06-06 16:58:23 -07:00
Zach Wasserman
08d57b40d1
Remove deprecated kolide names from API routes and configuration (#957)
Closes #260
2021-06-04 16:51:18 -07:00
Zach Wasserman
a5bd03e5d7 Merge branch 'master' into teams 2021-05-31 10:56:50 -07:00
Zach Wasserman
64f2cfc9cd
Refactor enroll secrets to support Teams (#903)
- Add `team_id` field to secrets.
- Remove secret `name` and `active` fields (migration deletes inactive secrets).
- Assign hosts to Team based on secret provided.
- Add API for retrieving secrets by Team.
2021-05-31 09:02:05 -07:00
Zach Wasserman
8ee47f8b23
Add support for Teams in targets and live queries (#880)
- Accept Teams as a searchable target type for the target selection API.
- Accept Teams for targets in running live queries.
- Refactoring to support these changes.
- Update API documentation.
2021-05-27 13:18:00 -07:00
Zach Wasserman
cebd4df0f5
Update live query and targets APIs for Teams (#876)
- Take query_id in live query and target APIs.
- Use query_id to determine observer targets.
- Update documentation.
2021-05-26 20:45:06 -07:00
Zach Wasserman
48c413a254
Split host additional into separate table (#875)
- Move host `additional` into a separate table.
- Join when that data is needed.
- API change: `/api/v1/fleet/hosts` now returns only the requested
  `additional` columns, unless `*` is provided as the sole argument.

Background:

A customer reported that MySQL binlogs grew huge and replication lag
went way up when data was stored in the `additional` column. In this
deployment MySQL was running with ROW replication. This would cause the
entire `additional` data to be copied on each update of the host checkin
time. While switching to STATEMENT or MIXED replication would likely
mitigate the issue, this was not an option in their environment.
2021-05-26 16:24:12 -07:00
Zach Wasserman
a2a7082bd3
Implement add hosts to team by filters API (#866)
- Add hosts to team using label, status, and query filters.
- Documentation (+ docs for regular add hosts to team).
2021-05-25 21:29:52 -07:00
Zach Wasserman
15b81824f5
Filter query page API responses based on team membership (#850)
- Include only hosts that the user has access to in search targets API.
- Add parameter to specify whether `observer` hosts should be included.
- Generate counts based on which hosts user can access.
- Update API doc.
2021-05-24 21:34:08 -07:00
Mike McNeil
6fa518a300
Update 3-REST-API.md (#825) 2021-05-21 05:31:21 -05:00
Noah Talerman
72882e8f9f Merge branch 'master' into teams 2021-05-19 13:16:54 -04:00
Zach Wasserman
daa8eeb9d0
Add refetch host API (#767)
This allows the host details to be refetched on the next check in,
rather than waiting for the normal interval to go by. Associated UI
changes are in-progress.

- Migration and service methods for requesting refetch.
- Expose refetch over API.
- Change detail query logic to respect this flag.
2021-05-13 13:09:22 -07:00
noahtalerman
9fb9da31f5
Bring Orbit docs into Fleet docs and add FAQ section (#717)
- Add new `2-Orbit-osquery/` directory to the top-level `docs/` directory.
- Rename `2-Deployment/` -> `3-Deployment/` to accommodate new Orbit directory.
- Rename `3-Contribution/` ->  `4-Contribution/` to accommodate new Orbit directory.
- Add FAQ section to Orbit documentation.
2021-05-04 15:50:18 -04:00
Zach Wasserman
a17556b2db Merge branch 'master' into teams 2021-04-30 09:40:10 -07:00
noahtalerman
b4e5097356
Draft API changes to api/v1/fleet/hosts/{id} endpoint for software inventory (#669)
Update documentation for the `api/v1/fleet/hosts/{id}` endpoint to align with the first iteration of Software inventory #399 in Fleet.
2021-04-29 11:25:54 -04:00
noahtalerman
dbfbde37b1
Add api/v1/status/ endpoints and api/v1/sso/callback endpoint to REST API docs (#671)
This PR concludes the Complete API documentation project #43

Add documentation for the following endpoints:
- api/v1/status/live_query
- api/v1/status/result_store
- api/v1/sso/callback
2021-04-29 10:45:43 -04:00