Api reference
Update search index
Updates mutable index fields (displayName, enabled). At least one field must be provided.
Updates mutable index fields (displayName, enabled). At least one field must be provided.
Authorization
BearerAuth AuthorizationBearer <token>
Search API key (ss_search_*) from the dashboard or keys API. Scopes (search, ingest, admin) are stored on the key; each route requires the matching scope.
In: header
Path Parameters
indexId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://loading/api/v1/indexes/string" \ -H "Content-Type: application/json" \ -d '{}'{
"id": "string",
"organizationId": "string",
"slug": "string",
"displayName": "string",
"version": 0,
"enabled": true,
"schema": {},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}{
"error": "string",
"message": "string",
"details": null
}{
"error": "string",
"message": "string",
"details": null
}{
"error": "string",
"message": "string",
"details": null
}{
"error": "string",
"message": "string",
"details": null
}