Skip to main content
GET
/
api
/
bash
/
bash_events
/
search
Search Bash Events
curl --request GET \
  --url https://api.example.com/api/bash/bash_events/search
import requests

url = "https://api.example.com/api/bash/bash_events/search"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/api/bash/bash_events/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/bash/bash_events/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/bash/bash_events/search"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/api/bash/bash_events/search")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/bash/bash_events/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "command": "<string>",
      "kind": "<string>",
      "cwd": "<string>",
      "timeout": 300,
      "id": "<string>",
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ],
  "next_page_id": "<string>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Query Parameters

​
kind__eq
enum<string> | null
Available options:
BashCommand,
BashOutput
​
command_id__eq
string<uuid> | null
​
timestamp__gte
string<date-time> | null
​
timestamp__lt
string<date-time> | null
​
order__gt
integer | null

Only returns BashOutput events with order > this value. Useful for polling to fetch only new events since the last poll.

​
sort_order
enum<string>
default:TIMESTAMP
Available options:
TIMESTAMP,
TIMESTAMP_DESC
​
page_id
string | null
​
limit
integer
default:100

Response

Successful Response

​
items
(BashCommand · object | BashOutput · object)[]
required
​
next_page_id
string | null