Search Files
curl --request POST \
--url http://localhost:4242/{computer_name}/api/filesystem/search \
--header 'Content-Type: application/json' \
--data '
{
"include_hidden": false,
"max_results": 100,
"pattern": "*.txt",
"root_path": "/home/user"
}
'import requests
url = "http://localhost:4242/{computer_name}/api/filesystem/search"
payload = {
"include_hidden": False,
"max_results": 100,
"pattern": "*.txt",
"root_path": "/home/user"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
include_hidden: false,
max_results: 100,
pattern: '*.txt',
root_path: '/home/user'
})
};
fetch('http://localhost:4242/{computer_name}/api/filesystem/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_PORT => "4242",
CURLOPT_URL => "http://localhost:4242/{computer_name}/api/filesystem/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([
'include_hidden' => false,
'max_results' => 100,
'pattern' => '*.txt',
'root_path' => '/home/user'
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:4242/{computer_name}/api/filesystem/search"
payload := strings.NewReader("{\n \"include_hidden\": false,\n \"max_results\": 100,\n \"pattern\": \"*.txt\",\n \"root_path\": \"/home/user\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:4242/{computer_name}/api/filesystem/search")
.header("Content-Type", "application/json")
.body("{\n \"include_hidden\": false,\n \"max_results\": 100,\n \"pattern\": \"*.txt\",\n \"root_path\": \"/home/user\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:4242/{computer_name}/api/filesystem/search")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"include_hidden\": false,\n \"max_results\": 100,\n \"pattern\": \"*.txt\",\n \"root_path\": \"/home/user\"\n}"
response = http.request(request)
puts response.read_body[
{
"name": "document.txt",
"path": "/home/user/documents/document.txt",
"type": "file",
"size": 1024,
"modified_time": "2024-03-10T12:34:56",
"is_hidden": false,
"extension": "txt"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}filesystem
Search Files
Searches for files matching a pattern in a directory tree.
POST
/
api
/
filesystem
/
search
Search Files
curl --request POST \
--url http://localhost:4242/{computer_name}/api/filesystem/search \
--header 'Content-Type: application/json' \
--data '
{
"include_hidden": false,
"max_results": 100,
"pattern": "*.txt",
"root_path": "/home/user"
}
'import requests
url = "http://localhost:4242/{computer_name}/api/filesystem/search"
payload = {
"include_hidden": False,
"max_results": 100,
"pattern": "*.txt",
"root_path": "/home/user"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
include_hidden: false,
max_results: 100,
pattern: '*.txt',
root_path: '/home/user'
})
};
fetch('http://localhost:4242/{computer_name}/api/filesystem/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_PORT => "4242",
CURLOPT_URL => "http://localhost:4242/{computer_name}/api/filesystem/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([
'include_hidden' => false,
'max_results' => 100,
'pattern' => '*.txt',
'root_path' => '/home/user'
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:4242/{computer_name}/api/filesystem/search"
payload := strings.NewReader("{\n \"include_hidden\": false,\n \"max_results\": 100,\n \"pattern\": \"*.txt\",\n \"root_path\": \"/home/user\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:4242/{computer_name}/api/filesystem/search")
.header("Content-Type", "application/json")
.body("{\n \"include_hidden\": false,\n \"max_results\": 100,\n \"pattern\": \"*.txt\",\n \"root_path\": \"/home/user\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:4242/{computer_name}/api/filesystem/search")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"include_hidden\": false,\n \"max_results\": 100,\n \"pattern\": \"*.txt\",\n \"root_path\": \"/home/user\"\n}"
response = http.request(request)
puts response.read_body[
{
"name": "document.txt",
"path": "/home/user/documents/document.txt",
"type": "file",
"size": 1024,
"modified_time": "2024-03-10T12:34:56",
"is_hidden": false,
"extension": "txt"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Body
application/json
Root directory to start search from
Example:
"/home/user"
Glob pattern to search for
Example:
"*.txt"
Maximum number of results to return
Example:
100
Whether to include hidden files/directories
Example:
false
Response
Successfully searched for files
File or directory name
Example:
"document.txt"
Full path to the file or directory
Example:
"/home/user/documents/document.txt"
Type of entry: 'file' or 'directory'
Example:
"file"
Size in bytes
Example:
1024
Last modification time
Example:
"2024-03-10T12:34:56"
Whether the file/directory is hidden
Example:
false
File extension if applicable
Example:
"txt"
⌘I