Skip to main content
POST
Shell Docs Grep

Authorizations

Authorization
string
header
required

API key must be provided in the Authorization header

Path Parameters

namespace
string
required

Body

application/json
pattern
string
required

Regex pattern

path
string
default:""

Path prefix filter

case_sensitive
boolean
default:false
whole_word
boolean
default:false
fixed_string
boolean
default:false
max_total_matches
integer
default:100
Required range: 1 <= x <= 10000
max_matches_per_file
integer
default:10
Required range: 1 <= x <= 100
context_lines
integer
default:3
Required range: 0 <= x <= 10
lines_before
integer | null
lines_after
integer | null
output_mode
string
default:content

content|files_with_matches|count

multiline_content
boolean
default:false

Response

Successful Response