Skip to main content
GET
https://your-rootprint-host
/
api
/
indexes
/
{indexId}
Get index detail
curl --request GET \
  --url https://your-rootprint-host/api/indexes/{indexId} \
  --cookie better-auth.session_token=
{
  "indexId": "<string>",
  "displayName": "<string>",
  "levelField": "<string>",
  "messageField": "<string>",
  "tracebackField": "<string>",
  "contextFields": [
    "<string>"
  ],
  "fields": [
    {
      "name": "<string>",
      "type": "<string>",
      "fast": true
    }
  ],
  "sources": [
    {
      "sourceId": "<string>",
      "sourceType": "<string>",
      "enabled": true
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.rootprint.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

better-auth.session_token
string
cookie
required

Better Auth session cookie used by the Rootprint web UI.

Path Parameters

indexId
string
required

Quickwit index ID.

Minimum string length: 1

Response

Index detail.

indexId
string
displayName
string | null
visibility
enum<string>
Available options:
hidden,
admin,
all
levelField
string
messageField
string
tracebackField
string | null
contextFields
string[] | null
fields
object[]
sources
object[]