Skip to main content
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=
{
  "contextFields": [
    "<string>"
  ],
  "defaultSearchFields": [
    "<string>"
  ],
  "displayName": "<string>",
  "fields": [
    {
      "fast": true,
      "name": "<string>",
      "type": "<string>"
    }
  ],
  "indexId": "<string>",
  "indexUri": "<string>",
  "levelField": "<string>",
  "messageField": "<string>",
  "mode": "<string>",
  "sources": [
    {
      "enabled": true,
      "sourceId": "<string>",
      "sourceType": "<string>"
    }
  ],
  "storeSource": true,
  "tagFields": [
    "<string>"
  ],
  "timestampField": "<string>",
  "tracebackField": "<string>"
}

Authorizations

​
better-auth.session_token
string
cookie
required

Path Parameters

​
indexId
string
required
Minimum string length: 1

Response

Successful response

​
contextFields
string[] | null
required
​
defaultSearchFields
string[] | null
required
​
displayName
string | null
required
​
fields
object[]
required
​
indexId
string
required
​
indexUri
string | null
required
​
levelField
string
required
​
messageField
string
required
​
mode
string | null
required
​
sources
object[]
required
​
storeSource
boolean | null
required
​
tagFields
string[] | null
required
​
timestampField
string | null
required
​
tracebackField
string | null
required
​
visibility
enum<string>
required
Available options:
hidden,
admin,
all