List indexes

GET/v1alpha1/admin/indexesindexes.read

Lists the indexes the deployment holds, with their generations and the live generation each answers for.

Index listings omit indexes on which the key has no permissions rather than refusing the listing.

prefix keeps the indexes whose name starts with it. limit caps the answer, and a listing cut short names the last index in next; pass it as after to read on. See Listings.

Request

HTTP

GET /v1alpha1/admin/indexes
Authorization: Bearer <key>

curl

curl -X GET "http://localhost:8080/v1alpha1/admin/indexes" \
  -H "Authorization: Bearer $EXOFIND_API_KEY"

JavaScript

const apiKey = process.env.EXOFIND_API_KEY;

const response = await fetch("http://localhost:8080/v1alpha1/admin/indexes", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${apiKey}`
  }
});

const result = await response.json();

Java

String apiKey = System.getenv("EXOFIND_API_KEY");

HttpRequest request = HttpRequest.newBuilder()
  .uri(URI.create("http://localhost:8080/v1alpha1/admin/indexes"))
  .header("Authorization", "Bearer " + apiKey)
  .GET()
  .build();

HttpResponse<String> response = HttpClient.newHttpClient()
  .send(request, HttpResponse.BodyHandlers.ofString());

Go

apiKey := os.Getenv("EXOFIND_API_KEY")

request, err := http.NewRequest("GET", "http://localhost:8080/v1alpha1/admin/indexes", nil)
if err != nil {
  log.Fatal(err)
}

request.Header.Set("Authorization", "Bearer "+apiKey)

response, err := http.DefaultClient.Do(request)

Response200

{
  "indexes": [
    {
      "name": "products",
      "liveGeneration": "2",
      "generations": [
        {
          "name": "1",
          "live": false,
          "createdAt": "2026-08-16T11:02:07Z"
        },
        {
          "name": "2",
          "live": true,
          "createdAt": "2026-08-28T10:15:30Z"
        }
      ]
    }
  ]
}

Query parameters

afterstring

The name to continue after, as the next field of the previous response gave it. The named index is not included.

limitinteger

Most indexs to answer. Without it the whole listing is answered. When more remain, the response carries the last name in next.

Range

1 to 1000

prefixstring

Keeps only the indexs whose name starts with this text.

Responses

200

The indexes the key can see, ordered by name.

IndexListResponse

The indexes held across the deployment. Definitions and status are omitted; request a specific index to retrieve them.

indexesIndexSummary[]

The indexes visible to the key, ordered by name.

Example

{
  "name": "products",
  "liveGeneration": "2",
  "generations": [
    {
      "name": "1",
      "live": false
    },
    {
      "name": "2",
      "live": true
    }
  ]
}

3 properties

namestring

The name of the index.

Example

"products"

liveGenerationstring

The generation the index answers from. Omitted when no generation is live.

Example

"2"

generationsGenerationSummary[]

Every generation of the index, ordered by name.

Example

{
  "name": "2",
  "live": true,
  "createdAt": "2026-08-16T11:02:07Z"
}

3 properties

namestring

Name of the generation within its index, which is what follows the @ when addressing it as products@2.

Example

"2"

liveboolean

Whether the index answers from this generation. Exactly one generation of an index does, unless the index has just been created.

createdAtstring

When the generation was created, as an ISO 8601 timestamp. Omitted for a generation registered before this was recorded.

Example

"2026-08-16T11:02:07Z"

nextstring

The name to pass as the after parameter to list the indexes after these. Present only when a limit cut the listing short.

Example

"products"

400

The limit parameter is out of range.

ErrorResponse

The body of every failed request. Error codes use colon-separated namespaces such as index:field:name_invalid, are stable across API versions, and are never renamed or reused, so clients match on code rather than on message. See Errors.

codestring

Identifies the failure type. For validation failures, this is validation and the individual problems are listed in errors. For all other failures, this matches the code of the single entry in errors.

Example

"validation"

messagestring

Human-readable message for log output. Match on code rather than on message. When a validation failure contains one problem, this is that problem's message. When it contains several, it reads Request contains N errors.

Example

"Request contains 2 errors"

errorsErrorDetail[]

All problems found in the request. A validation failure reports every field with a problem, so a caller can fix them in one pass rather than one request at a time.

Example

{
  "code": "index:field:primary_key:multiple_unsupported",
  "message": "Field `id` is marked as a primary key and multiple, primary keys can not have multiple values",
  "path": "id"
}

4 properties

codestring

The error code identifying this specific problem.

Example

"index:field:primary_key:multiple_unsupported"

messagestring

Human-readable description of this problem.

Example

"Field `id` is marked as a primary key and multiple, primary keys can not have multiple values"

pathstring

Location of the offending value in the request, such as fields.title or documents[1].nonexistent. Names join with ., one element of a list reads [n] counted from zero, and a key of a free-form map such as metadata goes in brackets and double quotes when it holds a dot or a bracket, as metadata["build.sha"]. A field inside an object field carries its own dotted path, so a path here reaches a field the same way a query does. Omitted when the problem applies to the request as a whole. See API conventions.

Example

"id"

argumentsmap of string

The values the message was rendered with, so a client can render a message of its own from the code.

1 property

<key>string

Error codes

request:limit_out_of_range

The `limit` parameter is not a whole number from 1 to 1000.

401

The request carries no credential this node accepts. Absent, malformed, unknown and lapsed keys are all answered alike, so a refusal cannot be used to find out which keys exist. The response carries WWW-Authenticate: Bearer.

ErrorResponse

The body of every failed request. Error codes use colon-separated namespaces such as index:field:name_invalid, are stable across API versions, and are never renamed or reused, so clients match on code rather than on message. See Errors.

codestring

Identifies the failure type. For validation failures, this is validation and the individual problems are listed in errors. For all other failures, this matches the code of the single entry in errors.

Example

"validation"

messagestring

Human-readable message for log output. Match on code rather than on message. When a validation failure contains one problem, this is that problem's message. When it contains several, it reads Request contains N errors.

Example

"Request contains 2 errors"

errorsErrorDetail[]

All problems found in the request. A validation failure reports every field with a problem, so a caller can fix them in one pass rather than one request at a time.

Example

{
  "code": "index:field:primary_key:multiple_unsupported",
  "message": "Field `id` is marked as a primary key and multiple, primary keys can not have multiple values",
  "path": "id"
}

4 properties

codestring

The error code identifying this specific problem.

Example

"index:field:primary_key:multiple_unsupported"

messagestring

Human-readable description of this problem.

Example

"Field `id` is marked as a primary key and multiple, primary keys can not have multiple values"

pathstring

Location of the offending value in the request, such as fields.title or documents[1].nonexistent. Names join with ., one element of a list reads [n] counted from zero, and a key of a free-form map such as metadata goes in brackets and double quotes when it holds a dot or a bracket, as metadata["build.sha"]. A field inside an object field carries its own dotted path, so a path here reaches a field the same way a query does. Omitted when the problem applies to the request as a whole. See API conventions.

Example

"id"

argumentsmap of string

The values the message was rendered with, so a client can render a message of its own from the code.

1 property

<key>string

Error codes

auth:unauthenticated

The request carries no credential this node accepts.

403

The API key does not have the indexes.read permission.

ErrorResponse

The body of every failed request. Error codes use colon-separated namespaces such as index:field:name_invalid, are stable across API versions, and are never renamed or reused, so clients match on code rather than on message. See Errors.

codestring

Identifies the failure type. For validation failures, this is validation and the individual problems are listed in errors. For all other failures, this matches the code of the single entry in errors.

Example

"validation"

messagestring

Human-readable message for log output. Match on code rather than on message. When a validation failure contains one problem, this is that problem's message. When it contains several, it reads Request contains N errors.

Example

"Request contains 2 errors"

errorsErrorDetail[]

All problems found in the request. A validation failure reports every field with a problem, so a caller can fix them in one pass rather than one request at a time.

Example

{
  "code": "index:field:primary_key:multiple_unsupported",
  "message": "Field `id` is marked as a primary key and multiple, primary keys can not have multiple values",
  "path": "id"
}

4 properties

codestring

The error code identifying this specific problem.

Example

"index:field:primary_key:multiple_unsupported"

messagestring

Human-readable description of this problem.

Example

"Field `id` is marked as a primary key and multiple, primary keys can not have multiple values"

pathstring

Location of the offending value in the request, such as fields.title or documents[1].nonexistent. Names join with ., one element of a list reads [n] counted from zero, and a key of a free-form map such as metadata goes in brackets and double quotes when it holds a dot or a bracket, as metadata["build.sha"]. A field inside an object field carries its own dotted path, so a path here reaches a field the same way a query does. Omitted when the problem applies to the request as a whole. See API conventions.

Example

"id"

argumentsmap of string

The values the message was rendered with, so a client can render a message of its own from the code.

1 property

<key>string

Error codes

auth:forbidden

The key is accepted but does not hold the `indexes.read` permission.

Authorization

Permission

indexes.read

Checked on

At least one index

Roles

reader, writer, admin

An API key sent as a bearer token, such as Authorization: Bearer exok_4ff6b760264c1918_ePQcdT1O9HSATZoXfDbT8hhHGsP9VpZH. A key carries grants that pair permissions with index patterns; the permission each endpoint needs is named beside it. Nodes running with EXOFIND_AUTH_MODE=none accept requests without a credential, and a node with EXOFIND_AUTH_ANONYMOUS_KEY set serves requests that carry none with the permissions of that key.