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

Update recieve-from-github.js and add fixes to API docs (#3310)

Browse Source
This commit is contained in:
Noah Talerman 2021-12-10 15:40:29 -05:00 committed by GitHub
parent be670c5701
commit 1f8f5b0d27
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/01-Using-Fleet/03-REST-API.md
View File

@ -479,7 +479,7 @@ This is the callback endpoint that the identity provider will use to send securi
| status | string | query | Indicates the status of the hosts to return. Can either be `new`, `online`, `offline`, or `mia`. |
| query | string | query | Search query keywords. Searchable fields include `hostname`, `machine_serial`, `uuid`, and `ipv4`. |
| additional_info_filters | string | query | A comma-delimited list of fields to include in each host's additional information object. See [Fleet Configuration Options](../01-Using-Fleet/02-fleetctl-CLI.md#fleet-configuration-options) for an example configuration with hosts' additional information. Use `*` to get all stored fields. |
| team_id | integer | query | _Available in Fleet Premium_ Filters the users to only include users in the specified team. |
| team_id | integer | query | _Available in Fleet Premium_ Filters the hosts to only include hosts in the specified team. |
| policy_id | integer | query | The ID of the policy to filter hosts by. `policy_response` must also be specified with `policy_id`. |
| policy_response | string | query | Valid options are `passing` or `failing`. `policy_id` must also be specified with `policy_response`. |
| software_id | integer | query | The ID of the software to filter hosts by. |
@ -569,7 +569,7 @@ If `additional_info_filters` is not specified, no `additional` information will
| status | string | query | Indicates the status of the hosts to return. Can either be `new`, `online`, `offline`, or `mia`. |
| query | string | query | Search query keywords. Searchable fields include `hostname`, `machine_serial`, `uuid`, and `ipv4`. |
| additional_info_filters | string | query | A comma-delimited list of fields to include in each host's additional information object. See [Fleet Configuration Options](../01-Using-Fleet/02-fleetctl-CLI.md#fleet-configuration-options) for an example configuration with hosts' additional information. Use `*` to get all stored fields. |
| team_id | integer | query | _Available in Fleet Premium_ Filters the users to only include users in the specified team. |
| team_id | integer | query | _Available in Fleet Premium_ Filters the hosts to only include hosts in the specified team. |
| policy_id | integer | query | The ID of the policy to filter hosts by. `policy_response` must also be specified with `policy_id`. |
| policy_response | string | query | Valid options are `passing` or `failing`. `policy_id` must also be specified with `policy_response`. |
| label_id | integer | query | A valid label ID. It cannot be used alongside policy filters. |
@ -1325,7 +1325,7 @@ Returns a list of the hosts that belong to the specified label.
| order_direction | string | query | **Requires `order_key`**. The direction of the order given the order key. Options include `asc` and `desc`. Default is `asc`. |
| status | string | query | Indicates the status of the hosts to return. Can either be `new`, `online`, `offline`, or `mia`. |
| query | string | query | Search query keywords. Searchable fields include `hostname`, `machine_serial`, `uuid`, and `ipv4`. |
| team_id | integer | query | _Available in Fleet Premium_ Filters the users to only include users in the specified team. |
| team_id | integer | query | _Available in Fleet Premium_ Filters the hosts to only include hosts in the specified team. |
#### Example
@ -5768,7 +5768,7 @@ _Available in Fleet Premium_
| order_key | string | query | What to order results by. Can be ordered by the following fields: `name`. |
| order_direction | string | query | **Requires `order_key`**. The direction of the order given the order key. Options include `asc` and `desc`. Default is `asc`. |
| query | string | query | Search query keywords. Searchable fields include `name`. |
| team_id | integer | query | _Available in Fleet Premium_ Filters the users to only include users in the specified team. |
| team_id | integer | query | _Available in Fleet Premium_ Filters the software to only include the software installed on the hosts that are assigned to the specified team. |
| vulnerable | bool | query | If true or 1, only list software that has detected vulnerabilities |
#### Example
@ -5832,7 +5832,7 @@ _Available in Fleet Premium_
| order_key | string | query | Allowed for compatibility with GET /api/v1/fleet/software but ignored |
| order_direction | string | query | Allowed for compatibility with GET /api/v1/fleet/software but ignored |
| query | string | query | Search query keywords. Searchable fields include `name`. |
| team_id | integer | query | _Available in Fleet Premium_ Filters the users to only include hosts in the specified team. |
| team_id | integer | query | _Available in Fleet Premium_ Filters the software to only include the software installed on the hosts that are assigned to the specified team. |
| vulnerable | bool | query | If true or 1, only list software that has detected vulnerabilities |
#### Example

3
website/api/controllers/webhooks/receive-from-github.js vendored
View File

@ -33,7 +33,6 @@ module.exports = {
'mikermcneil',
'lukeheath',
'zwass',
'rlynnj11',
'martavis',
'rachelelysia',
'gillespi314',
@ -48,7 +47,7 @@ module.exports = {
'tgauda',
'ksatter'
];
let GITHUB_USERNAME_OF_DRI_FOR_LABELS = 'rlynnj11';// « Used below
let GITHUB_USERNAME_OF_DRI_FOR_LABELS = 'noahtalerman';// « Used below
if (!sails.config.custom.slackWebhookUrlForGithubBot) {
throw new Error('No Slack webhook URL configured for the GitHub bot to notify with alerts! (Please set `sails.config.custom.slackWebhookUrlForGithubBot`.)');