SearchIndex

Update SearchIndex

Create a SearchIndex, it it does not exist or update an existing SearchIndex.

put/v1/searchIndexes

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/searchIndexes
  • Auth: HTTP bearer

Request body

namestring required
displayNamestring
descriptionstring
servicestring required
searchIndexSettingsSearchIndexSettings
indexType'Index' | 'IndexTemplate'
extensionobject
domainsstring[]
dataProductsstring[]
sourceHashstring

Response

The updated SearchIndex

idstring uuid required
namestring required
fullyQualifiedNamestring
displayNamestring
descriptionstring
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
serviceType'ElasticSearch' | 'OpenSearch' | 'CustomSearch'
searchIndexSettingsSearchIndexSettings
indexType'Index' | 'IndexTemplate'
hrefstring uri
deletedboolean
extensionobject
sourceHashstring
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
provider'system' | 'user' | 'automation'

Changes

No recorded changes to this operation across all 1 revision of this API.