HomeDocumentationAPI Reference
Log In
API Reference

Delete artifacts

Deletes artifacts in bulk, each with all of its per-sandfly results. Artifacts are selected by a filter, by a time, or by an explicit list of IDs; exactly one of the three may be used.

This deletes whole artifacts: an artifact selected because one of the sandflies that matched it satisfies the filter is removed along with the rest of its per-sandfly results. Use DELETE /results when the intent is to remove one sandfly's finding and leave the artifact in place for the others.

A filter or time_since delete runs in the background and returns as soon as the filter is known to be valid, so a 200 means the deletion was scheduled, not that it has finished. Deleting by artifact_ids is synchronous and reports how many of the requested artifacts existed.

A filter with no items deletes every artifact. A filter whose conditions all have empty values narrows nothing, so it is rejected with a 400 rather than treated as a request to delete everything.

Body Params

Artifact delete parameters.

Selects the artifacts to delete. Exactly one of filter, time_since, or artifact_ids must be given.

filter
object

Delete every artifact matching this filter, in the same shape as the artifact search filter. See ArtifactSearchFilterItemField for the fields this endpoint exposes; sort is accepted but ignored, since a delete has no order.

date-time

Delete every artifact first stored at or after this time.

artifact_ids
array of int64s

List of artifact IDs to delete.

artifact_ids
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json