---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "List search indexes"
description: "`data.search_indexes.list` (GET /v1/{parent}/search_indexes): Lists search indexs in a environment."
type: reference
product: search
summary: "Lists search indexs in a environment."
updated: 2026-09-28
nav: false
---

Lists search indexs in a environment.

- **Path** `GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/search_indexes`
- **Scope** `data:read`
- **Effect** `read` — nothing is written.
- **Collection** [search_indexes](/docs/api/search_indexes)
- **Query** `page_size`, `page_token`, `filter`, `order_by`
- **Pagination** the answer carries `search_indexes` and, when there is more, `next_page_token`

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `parent` | `string` | The parent to list in. Required. |
| `page_size` | `int32` | At most this many; default 50, clamped to 1000. |
| `page_token` | `string` | `next_page_token` of the previous page. |
| `filter` | `string` | AIP-160 filter over labels, filterable fields, and Ready. |
| `order_by` | `string` | AIP-132 ordering over filterable fields. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `search_indexes` | `SearchIndex[]` | The page. |
| `next_page_token` | `string` | The token of the next page; empty on the last page. |

### SearchIndex

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/search_indexes/{search_index}`. |
| `uid` | `string` | `idx_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `SearchIndexSpec` | Desired state. Required. |
| `status` | `SearchIndexStatus` | Observed state. Output only. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

### SearchIndexSpec

| Field | Type | What it is |
| --- | --- | --- |
| `vector_dimensions` | `int32` | The vector dimension; 0 for lexical only. |
| `region` | `string` | The region; default the project's home region. Changing it moves the data by signed export and import. |
| `deletion_protection` | `bool` | While set, Delete fails with DELETION_PROTECTED. |

### SearchIndexStatus

| Field | Type | What it is |
| --- | --- | --- |
| `observed_generation` | `int64` | The generation this status was computed from. Output only. |
| `conditions` | `Condition[]` | Ready, Reconciling, Stalled. Output only. |
| `state` | `DatastoreState` | Serving state. Output only. One of `provisioning`, `active`, `idle`, `moving`, `deleting`. |
| `ref` | `string` | The routing ref: the first DNS label of the datastore's endpoint. Output only. |
| `host` | `string` | The endpoint host, `{ref}.sylphx.net`, port 8108. Output only. |
| `cell` | `string` | The cell the datastore is placed on. Output only. |
| `storage_bytes` | `int64` | Bytes stored, at the last usage sample. Output only. |
| `document_count` | `int64` | Indexed documents, at the last usage sample. Output only. |

### Condition

| Field | Type | What it is |
| --- | --- | --- |
| `type` | `string` | The condition type, for example `Ready`. |
| `status` | `ConditionStatus` | Whether the condition holds. One of `true`, `false`, `unknown`. |
| `observed_generation` | `int64` | The generation this observation was made against. |
| `reason` | `string` | A machine-readable UpperCamelCase reason. |
| `message` | `string` | A customer-safe human-readable message. |
| `severity` | `Severity` | How severe a FALSE condition is. One of `info`, `warning`, `error`. |
| `transition_time` | `timestamp` | When `status` last changed. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`PAGE_TOKEN_MISMATCH`](/docs/api/errors/PAGE_TOKEN_MISMATCH) — A page token was reused with different parameters.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/search_indexes" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.data.searchIndexes.list({ parent: 'orgs/acme/projects/shop/envs/production' })
```

**Rust**

```rust
let mut req = sylphx::data::ListSearchIndexesRequest::default();
req.parent = "orgs/acme/projects/shop/envs/production".to_string();
let response = sx.data().search_indexes().list(req).await?;
```

**CLI**

```bash
sylphx data search-indexes list orgs/acme/projects/shop/envs/production
```

**MCP**

```json
{ "method_id": "data.search_indexes.list", "args": {"parent":"orgs/acme/projects/shop/envs/production"} }
```