Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Get a search index
Gets a search index.
Gets a search index.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/search_indexes/search-index - Scope
data:read - Effect
read— nothing is written. - Collection search_indexes
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the search index to get. Required. |
#Response
| 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— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/search_indexes/search-index" \
-H "Authorization: Bearer $SYLPHX_API_KEY"