ListSecurityMonitoringSignals
Retrieve and filter security signals using specific search queries, time ranges, and sorting criteria to monitor and analyze potential threats or anomalies.
Instructions
The list endpoint returns security signals that match a search query. Both this endpoint and the POST endpoint can be used interchangeably when listing security signals.
Query Parameters:
- filter[query]: The search query for security signals.
- filter[from]: The minimum timestamp for requested security signals.
- filter[to]: The maximum timestamp for requested security signals.
- sort: The order of the security signals in results.
- page[cursor]: A list of results using the cursor provided in the previous query.
- page[limit]: The maximum number of security signals in the response.
Responses:
- 200 (Success): OK
- Content-Type:
application/json - Response Properties:
- data: An array of security signals matching the request.
- Example:
- Content-Type:
- 400: Bad Request
- Content-Type:
application/json - Response Properties:
- errors: A list of errors.
- Example:
- Content-Type:
- 403: Not Authorized
- Content-Type:
application/json - Response Properties:
- errors: A list of errors.
- Example:
- Content-Type:
- 429: Too many requests
- Content-Type:
application/json - Response Properties:
- errors: A list of errors.
- Example:
- Content-Type:
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filter[from] | No | The minimum timestamp for requested security signals. | |
| filter[query] | No | The search query for security signals. | |
| filter[to] | No | The maximum timestamp for requested security signals. | |
| page[cursor] | No | A list of results using the cursor provided in the previous query. | |
| page[limit] | No | The maximum number of security signals in the response. | |
| sort | No | The sort parameters used for querying security signals. |