POST /_system/storages/search
Search storage configurations using request body with complex queries
Search storage configurations using request body with complex queries
Key | Type | Example | |
---|---|---|---|
authorization required | string |
"Bearer your-jwt-token"
|
Key | Type | Example | Description |
---|---|---|---|
term optional | object |
{
"status.keyword": {
"value": "active"
}
}
|
Term queries for exact matches
|
terms optional | object |
{
"category.keyword": [
"user",
"admin"
]
}
|
Terms queries for multiple exact matches
|
match optional | object |
{
"title": "blueprint automation"
}
|
Full-text match queries
|
range optional | object |
{
"created": {
"gte": "2024-01-01",
"lte": "2024-12-31"
}
}
|
Range queries for dates, numbers
|
bool optional | object |
{}
|
Boolean queries for complex logic
|
wildcard optional | object |
{
"name.keyword": {
"value": "user*",
"case_insensitive": true
}
}
|
Wildcard pattern matching
|
exists optional | object |
{
"field": "description"
}
|
Check if field exists
|
from optional | integer |
0
|
Starting position for pagination
|
size optional | integer |
10
|
Number of results to return
|
sort optional | array |
[{"created":{"order":"desc"}}, ...]
|
Sort criteria
|
_source optional | string |
"example-value"
|
Fields to include/exclude in results
|
highlight optional | object |
{}
|
Highlight matching text
|
aggs optional | object |
{}
|
Aggregations for analytics
|
count optional | boolean |
false
|
Return only count instead of documents
|
include_hits optional | boolean |
false
|
Include hit details in paginated results
|
{
"success": true
}
{
"success": false,
"error": "HTTP_401",
"message": "Error response"
}
Error Code | Description |
---|---|
HTTP_401 | HTTP 401 error |
permission | description |
---|---|
BearerAuth |
JWT access token obtained from login endpoint required |
Back to System Storages Return to the System Storages category to view other endpoints All API Categories Browse all available API categories