GET /search/indexes/{name}
Read a search index
Read an index: schema and document count. Use when checking which fields can be searched, filtered, sorted or faceted. Before: an index name from search_list_indexes. Returns the index and its fields. Scope: search:query.
API key (Bearer), on the public API endpoint.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
name | path | string · required | Index name. |
Responses
| Status | Description | Body |
|---|---|---|
2XX | Success: the JSON body the route returns (see the description for its fields). | object |
401 | Key missing or invalid | Error |
4XX | Refused: act on detail.code, then follow detail.next_action (404 not_found while the service is not open to the account). | Error |
Examples
curl
curl -X GET "$GALON_API_BASE/search/indexes/<name>" \
-H "Authorization: Bearer $GALON_API_KEY"DELETE /search/indexes/{name}
Delete a search index
Delete an index and all its documents. Use when the user asks to remove an index for good. Before: confirm with the user: this cannot be undone. Returns deleted true. Scope: search:write.
API key (Bearer), on the public API endpoint.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
name | path | string · required | Index name. |
Responses
| Status | Description | Body |
|---|---|---|
2XX | Success: the JSON body the route returns (see the description for its fields). | object |
401 | Key missing or invalid | Error |
4XX | Refused: act on detail.code, then follow detail.next_action (404 not_found while the service is not open to the account). | Error |
Examples
curl
curl -X DELETE "$GALON_API_BASE/search/indexes/<name>" \
-H "Authorization: Bearer $GALON_API_KEY"