---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Search indexes"
description: "The `search_indexes` collection of Sylphx Data: A SearchIndex is one customer lexical and vector index of JSON documents."
type: reference
product: search
summary: "A SearchIndex is one customer lexical and vector index of JSON documents."
updated: 2026-09-28
order: 900
---

A SearchIndex is one customer lexical and vector index of JSON documents. Dimension 0 is lexical only; a positive dimension adds cosine queries. Data never invents embeddings. Silo: each has its own engine, credentials, backup, region, and deletion.

**Service** Sylphx Data · **Resource type** `data.sylphx.com/SearchIndex` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/search_indexes/{search_index}` · **Shape** `spec_status`

## Fields

| 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. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/search_indexes#get) | Gets a search index. |
| `GET` | [`list`](/docs/api/search_indexes#list) | Lists search indexs in a environment. |
| `POST` | [`create`](/docs/api/search_indexes#create) | Creates a search index. The Operation is done when the controller settles it. |
| `PATCH` | [`update`](/docs/api/search_indexes#update) | Updates a search index. |
| `DELETE` | [`delete`](/docs/api/search_indexes#delete) | Deletes a search index. Fails while `spec.deletion_protection` is set. |
| `POST` | [`connect`](/docs/api/search_indexes#connect) | Returns how to connect to the search index: its endpoint and its own engine credentials. The credentials are not API keys and are returned only here. |
| `POST` | [`rotate_credentials`](/docs/api/search_indexes#rotate-credentials) | Replaces the search index's engine credentials; the old ones stop working once the new ones are served. |

## get

Gets a search index.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/search_indexes/search-index` · scope `data:read` · effect `read` · [Request, response and examples](/docs/api/search_indexes/get)

## list

Lists search indexs in a environment.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/search_indexes` · scope `data:read` · effect `read` · paginated · [Request, response and examples](/docs/api/search_indexes/list)

## create

Creates a search index. The Operation is done when the controller settles it.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/search_indexes` · scope `data:write` · effect `write` · long-running · [Request, response and examples](/docs/api/search_indexes/create)

## update

Updates a search index.

`PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/search_indexes/search-index` · scope `data:write` · effect `write` · long-running · [Request, response and examples](/docs/api/search_indexes/update)

## delete

Deletes a search index. Fails while `spec.deletion_protection` is set.

`DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/search_indexes/search-index` · scope `data:write` · effect `destructive` · long-running · [Request, response and examples](/docs/api/search_indexes/delete)

## connect

Returns how to connect to the search index: its endpoint and its own engine credentials. The credentials are not API keys and are returned only here.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/search_indexes/search-index:connect` · scope `data:write` · effect `read` · [Request, response and examples](/docs/api/search_indexes/connect)

## rotate_credentials

Replaces the search index's engine credentials; the old ones stop working once the new ones are served.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/search_indexes/search-index:rotateCredentials` · scope `data:write` · effect `write` · validate_only · long-running · [Request, response and examples](/docs/api/search_indexes/rotate_credentials)