Get index detail
GET
https://example.com
/
api
/
indexes
/
{indexId}
Get index detail
curl --request GET \
--url https://example.com/api/indexes/{indexId} \
--cookie better-auth.session_token=const options = {method: 'GET', headers: {cookie: 'better-auth.session_token='}};
fetch('https://example.com/api/indexes/{indexId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://example.com/api/indexes/{indexId}"
headers = {"cookie": "better-auth.session_token="}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://example.com/api/indexes/{indexId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("cookie", "better-auth.session_token=")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"commitTimeoutSecs": 123,
"contextFields": [
"<string>"
],
"defaultSearchFields": [
"<string>"
],
"displayName": "<string>",
"dynamicMapping": {
"expandDots": true,
"fast": true,
"indexed": true,
"record": "<string>",
"stored": true,
"tokenizer": "<string>"
},
"fields": [
{
"description": "<string>",
"fast": true,
"name": "<string>",
"type": "<string>"
}
],
"indexFieldPresence": true,
"indexId": "<string>",
"indexUri": "<string>",
"isTraceIndex": true,
"levelField": "<string>",
"maxNumPartitions": 123,
"messageField": "<string>",
"mode": "<string>",
"partitionKey": "<string>",
"retention": {
"period": "<string>",
"schedule": "<string>"
},
"sources": [
{
"enabled": true,
"sourceId": "<string>",
"sourceType": "<string>"
}
],
"storeSource": true,
"tagFields": [
"<string>"
],
"timestampField": "<string>",
"traceIdField": "<string>",
"tracebackField": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"statusCode": 123,
"details": [
{
"message": "<string>",
"path": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"statusCode": 123,
"details": [
{
"message": "<string>",
"path": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"statusCode": 123,
"details": [
{
"message": "<string>",
"path": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"statusCode": 123,
"details": [
{
"message": "<string>",
"path": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"statusCode": 123,
"details": [
{
"message": "<string>",
"path": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"statusCode": 123,
"details": [
{
"message": "<string>",
"path": "<string>"
}
]
}
}Authorizations
Path Parameters
Minimum string length:
1Response
Successful response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
Get index detail
curl --request GET \
--url https://example.com/api/indexes/{indexId} \
--cookie better-auth.session_token=const options = {method: 'GET', headers: {cookie: 'better-auth.session_token='}};
fetch('https://example.com/api/indexes/{indexId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://example.com/api/indexes/{indexId}"
headers = {"cookie": "better-auth.session_token="}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://example.com/api/indexes/{indexId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("cookie", "better-auth.session_token=")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"commitTimeoutSecs": 123,
"contextFields": [
"<string>"
],
"defaultSearchFields": [
"<string>"
],
"displayName": "<string>",
"dynamicMapping": {
"expandDots": true,
"fast": true,
"indexed": true,
"record": "<string>",
"stored": true,
"tokenizer": "<string>"
},
"fields": [
{
"description": "<string>",
"fast": true,
"name": "<string>",
"type": "<string>"
}
],
"indexFieldPresence": true,
"indexId": "<string>",
"indexUri": "<string>",
"isTraceIndex": true,
"levelField": "<string>",
"maxNumPartitions": 123,
"messageField": "<string>",
"mode": "<string>",
"partitionKey": "<string>",
"retention": {
"period": "<string>",
"schedule": "<string>"
},
"sources": [
{
"enabled": true,
"sourceId": "<string>",
"sourceType": "<string>"
}
],
"storeSource": true,
"tagFields": [
"<string>"
],
"timestampField": "<string>",
"traceIdField": "<string>",
"tracebackField": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"statusCode": 123,
"details": [
{
"message": "<string>",
"path": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"statusCode": 123,
"details": [
{
"message": "<string>",
"path": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"statusCode": 123,
"details": [
{
"message": "<string>",
"path": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"statusCode": 123,
"details": [
{
"message": "<string>",
"path": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"statusCode": 123,
"details": [
{
"message": "<string>",
"path": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"statusCode": 123,
"details": [
{
"message": "<string>",
"path": "<string>"
}
]
}
}
