Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API design: Deploy security agents to macOS, Windows, and Linux hosts #17865

Draft
wants to merge 44 commits into
base: main
Choose a base branch
from

Conversation

marko-lisica
Copy link
Member

API design for:
- #14921
"name": "Google Chrome.app",
"package_available_for_install": "GoogleChrome.pkg",
"source": "apps",
"bundle_identifier": "com.google.Chrome",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reminder to remove bundle_identifier from the response as discussed on slack.


#### Example

`GET /api/v1/fleet/software/install/results`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Example is missing the uuid path parameter:

Suggested change
`GET /api/v1/fleet/software/install/results`
`GET /api/v1/fleet/software/install/results/b15ce221-e22e-4c6a-afe7-5b3400a017da`


| Name | Type | In | Description |
| ---- | ------- | ---- | -------------------------------------------- |
| installation_uuid | string | path | **Required**. The installation UUID of the software.|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| installation_uuid | string | path | **Required**. The installation UUID of the software.|
| install_uuid | string | path | **Required**. The installation UUID of the software.|

Name of the param should be modified to match the corresponding API response field.


_Available in Fleet Premium_

`GET /api/v1/fleet/software/install/results`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing path param:

Suggested change
`GET /api/v1/fleet/software/install/results`
`GET /api/v1/fleet/software/install/results/:install_uuid`

@gillespi314
Copy link
Contributor

gillespi314 commented May 2, 2024

@marko-lisica, draft docs are missing the changes for the new software_status query param on the list hosts API

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants