Skip to content

docs(reference): correct artifact_get/log_get reply event and tasking syntax #348

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.

Sign up for GitHub

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

Draft
lc-cbot wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

docs(reference): correct artifact_get/log_get reply event and tasking syntax #348

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/2-sensors-deployment/endpoint-agent/service-upgrades.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Instead of running an installer on the host, you can task a sensor to upgrade it
The native upgrade procedure is currently in beta, so the `--beta` flag is required; the command is rejected without it.

```bash
limacharlie sensor task <SID> upgrade_core --beta
limacharlie task send --sid <SID> --task 'upgrade_core --beta'
```

Optional flags:
Expand Down
26 changes: 24 additions & 2 deletions docs/8-reference/edr-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ These are the events emitted by the endpoint agent for each supported operating
| [HTTP\_REQUEST\_HEADERS](#http_request_headers) | | | | ☑️ | |
| [HTTP\_RESPONSE\_HEADERS](#http_response_headers) | | | | ☑️ | |
| INGEST | ☑️ | ☑️ | ☑️ | | |
| [LOG\_GET\_REP](#log_get_rep) | | | | | |
| [LOG\_GET\_REP](#log_get_rep) | ☑️ | ☑️ | ☑️ | | |
| [LOG\_LIST\_REP](#log_list_rep) | | | | | |
| [MEM\_FIND\_HANDLES\_REP](#mem_find_handles_rep) | | ☑️ | | | |
| [MEM\_FIND\_STRING\_REP](#mem_find_string_rep) | ☑️ | ☑️ | ☑️ | | |
Expand Down Expand Up @@ -800,7 +800,29 @@ Provides HTTP Response headers.

### LOG\_GET\_REP

Response from a `log_get` request.
Response event for the [`log_get`](endpoint-commands.md#log_get) sensor command, and
for its alias [`artifact_get`](endpoint-commands.md#artifact_get).

This event is a **receipt, not the collected data**. `log_get` uploads the file
out-of-band to Artifact Collection, so the reply reports the outcome of that upload
and the ID of the resulting artifact. To obtain the data itself, use the
`PAYLOAD_ID` with `limacharlie artifact download --id <PAYLOAD_ID>`.

**Platforms:** macOS | Windows | Linux

- `ERROR`: Status of the artifact upload. `200` indicates success.
- `ERROR_MESSAGE`: Present only on failure, describing the reason.
- `PAYLOAD_ID`: ID of the stored artifact — either the value passed to
`--payload-id`, or the UUID generated for the request.

**Sample Event:**

```json
{
"ERROR": 200,
"PAYLOAD_ID": "746f5893-4402-4d3b-ba4a-4c643ad17802"
}
```

### LOG\_LIST\_REP

Expand Down
Loading
Loading