curl --request POST \
--url https://api.example.com/api/audit/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"source": "<string>",
"filters": [
{
"field": "<string>",
"operator": "is",
"value": "<unknown>"
}
],
"start": "<string>",
"end": "<string>",
"text": "<string>",
"limit": 50,
"offset": 0
}
'import requests
url = "https://api.example.com/api/audit/search"
payload = {
"source": "<string>",
"filters": [
{
"field": "<string>",
"operator": "is",
"value": "<unknown>"
}
],
"start": "<string>",
"end": "<string>",
"text": "<string>",
"limit": 50,
"offset": 0
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
source: '<string>',
filters: [{field: '<string>', operator: 'is', value: '<unknown>'}],
start: '<string>',
end: '<string>',
text: '<string>',
limit: 50,
offset: 0
})
};
fetch('https://api.example.com/api/audit/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/audit/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'source' => '<string>',
'filters' => [
[
'field' => '<string>',
'operator' => 'is',
'value' => '<unknown>'
]
],
'start' => '<string>',
'end' => '<string>',
'text' => '<string>',
'limit' => 50,
'offset' => 0
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/audit/search"
payload := strings.NewReader("{\n \"source\": \"<string>\",\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"is\",\n \"value\": \"<unknown>\"\n }\n ],\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"text\": \"<string>\",\n \"limit\": 50,\n \"offset\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/audit/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"source\": \"<string>\",\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"is\",\n \"value\": \"<unknown>\"\n }\n ],\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"text\": \"<string>\",\n \"limit\": 50,\n \"offset\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/audit/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"source\": \"<string>\",\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"is\",\n \"value\": \"<unknown>\"\n }\n ],\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"text\": \"<string>\",\n \"limit\": 50,\n \"offset\": 0\n}"
response = http.request(request)
puts response.read_body{
"source": "<string>",
"total": 123,
"events": [
{}
],
"time_field": "<string>"
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}Search one audit stream
Search a stream with field-aware filters.
Each filter is {field, operator, value}, validated against that
stream’s catalogue. An unknown field or an operator that cannot apply
to the field’s type is rejected with a 400 naming what would have
worked — filters are never silently dropped.
Time bounds apply to the stream’s own time field, which is not
@timestamp for Ranger. Free text matches only the stream’s text
fields, since keyword fields are unanalysed and a substring query
against them matches nothing.
Required roles: nx1_audit_viewer
curl --request POST \
--url https://api.example.com/api/audit/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"source": "<string>",
"filters": [
{
"field": "<string>",
"operator": "is",
"value": "<unknown>"
}
],
"start": "<string>",
"end": "<string>",
"text": "<string>",
"limit": 50,
"offset": 0
}
'import requests
url = "https://api.example.com/api/audit/search"
payload = {
"source": "<string>",
"filters": [
{
"field": "<string>",
"operator": "is",
"value": "<unknown>"
}
],
"start": "<string>",
"end": "<string>",
"text": "<string>",
"limit": 50,
"offset": 0
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
source: '<string>',
filters: [{field: '<string>', operator: 'is', value: '<unknown>'}],
start: '<string>',
end: '<string>',
text: '<string>',
limit: 50,
offset: 0
})
};
fetch('https://api.example.com/api/audit/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/audit/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'source' => '<string>',
'filters' => [
[
'field' => '<string>',
'operator' => 'is',
'value' => '<unknown>'
]
],
'start' => '<string>',
'end' => '<string>',
'text' => '<string>',
'limit' => 50,
'offset' => 0
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/audit/search"
payload := strings.NewReader("{\n \"source\": \"<string>\",\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"is\",\n \"value\": \"<unknown>\"\n }\n ],\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"text\": \"<string>\",\n \"limit\": 50,\n \"offset\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/audit/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"source\": \"<string>\",\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"is\",\n \"value\": \"<unknown>\"\n }\n ],\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"text\": \"<string>\",\n \"limit\": 50,\n \"offset\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/audit/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"source\": \"<string>\",\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"is\",\n \"value\": \"<unknown>\"\n }\n ],\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"text\": \"<string>\",\n \"limit\": 50,\n \"offset\": 0\n}"
response = http.request(request)
puts response.read_body{
"source": "<string>",
"total": 123,
"events": [
{}
],
"time_field": "<string>"
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
ranger, api or decisions.
Show child attributes
Show child attributes
ISO-8601 lower bound, inclusive.
ISO-8601 upper bound, inclusive.
Free text, matched across this stream's text fields only.
1 <= x <= 500x >= 0Was this page helpful?

