Get Search Query by ID
GET/search/history/:id
Returns a search query. You can access only queries that are either saved or recent searches.
Request
Path Parameters
Search ID
Responses
- 200
successful operation
- application/json; charset=UTF-8
- Schema
- Example (from schema)
Schema
- Array [
- ]
- RelativeTimeRangeConfigModel
- AbsoluteTimeRangeConfigModel
- ToNowTimeRangeConfigModel
- absolute
- relative
- to_now
Alert ID
true = Is Async
Async Result Url
Possible values: [aws
, azure
, gcp
, alibaba_cloud
, oci
]
Cloud Type
Cursor
Search Description
filters object[]
View Order
Name
Possible values: [=
]
Operator
Value
Group By
Search ID
Search Name
RQL Query
Read Only
Search Exists
Possible values: [network
, audit_event
, config
, asset
]
Search Type
Time Granularity
timeRange objectrequired
See the Time Range Model for details.
Possible values: [BACKWARD
, FORWARD
]
Direction in which to count time. Default = BACKWARD
value objectrequired
Model for RelativeTimeDuration
Number of time units
Possible values: [minute
, hour
, day
, week
, month
, year
]
Time unit
value objectrequired
Model for Time
End timestamp
Start timestamp
Possible values: [MINUTE
, HOUR
, DAY
, WEEK
, MONTH
, YEAR
, EPOCH
, LOGIN
]
Time range object
Possible values: [absolute
, relative
, to_now
]
Time type
value objectrequired
Model for Time
End timestamp
Start timestamp
Possible values: [BACKWARD
, FORWARD
]
Direction in which to count time. Default = BACKWARD
value objectrequired
Model for RelativeTimeDuration
Number of time units
Possible values: [minute
, hour
, day
, week
, month
, year
]
Time unit
Possible values: [MINUTE
, HOUR
, DAY
, WEEK
, MONTH
, YEAR
, EPOCH
, LOGIN
]
Time range object
{
"alertId": "string",
"async": true,
"asyncResultUrl": "/search/config/jobs/2df49d4f72e842b582b123bc2b7826b3/download",
"cloudType": "aws",
"cursor": 0,
"default": true,
"description": "string",
"filters": [
{
"name": "string",
"operator": "=",
"value": "string"
}
],
"groupBy": [
"string"
],
"id": "string",
"name": "string",
"query": "string",
"readOnly": true,
"saved": true,
"searchType": "network",
"timeGranularity": "string",
"timeRange": {
"relativeTimeType": "BACKWARD",
"type": "relative",
"value": {
"amount": 0,
"unit": "minute"
}
}
}