OpenMetadata SearchIndex API
A `SearchIndex` is a index mapping for indexing documents in a `Search Service`.
OpenAPI Specification
openapi: 3.0.1
info:
title: OpenMetadata APIs Agent Executions SearchIndex API
description: Common types and API definition for OpenMetadata
contact:
name: OpenMetadata
url: https://open-metadata.org
email: openmetadata-dev@googlegroups.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: '1.13'
servers:
- url: /api
description: Current Host
- url: http://localhost:8585/api
description: Endpoint URL
security:
- BearerAuth: []
tags:
- name: SearchIndex
description: A `SearchIndex` is a index mapping for indexing documents in a `Search Service`.
paths:
/v1/searchIndexes/{id}/followers:
put:
tags:
- SearchIndex
summary: Add a follower
description: Add a user identified by `userId` as followed of this SearchIndex
operationId: addFollower_11
parameters:
- name: id
in: path
description: Id of the SearchIndex
required: true
schema:
type: string
format: uuid
requestBody:
description: Id of the user to be added as follower
content:
application/json:
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeEvent'
'404':
description: SearchIndex for instance {id} is not found
/v1/searchIndexes/{id}/sampleData:
get:
tags:
- SearchIndex
summary: Get sample data
description: Get sample data from the SearchIndex.
operationId: getSampleData_2
parameters:
- name: id
in: path
description: Id of the SearchIndex
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Successfully obtained the SampleData for SearchIndex
content:
application/json:
schema:
$ref: '#/components/schemas/SearchIndex'
put:
tags:
- SearchIndex
summary: Add sample data
description: Add sample data to the searchIndex.
operationId: addSampleData_2
parameters:
- name: id
in: path
description: Id of the SearchIndex
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SearchIndexSampleData'
responses:
'200':
description: The SearchIndex
content:
application/json:
schema:
$ref: '#/components/schemas/SearchIndex'
/v1/searchIndexes/bulk:
put:
tags:
- SearchIndex
summary: Bulk create or update search indexes
description: Create or update multiple search indexes in a single operation. Returns a BulkOperationResult with success/failure details for each search index.
operationId: bulkCreateOrUpdateSearchIndexes
parameters:
- name: async
in: query
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateSearchIndex'
responses:
'200':
description: Bulk operation results
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResult'
'202':
description: Bulk operation accepted for async processing
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResult'
'400':
description: Bad request
/v1/searchIndexes:
get:
tags:
- SearchIndex
summary: List searchIndexes
description: Get a list of SearchIndexes, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.
operationId: listSearchIndexes
parameters:
- name: fields
in: query
description: Fields requested in the returned resource
schema:
type: string
example: owners,followers,tags,extension,domains,dataProducts,sourceHash
- name: service
in: query
description: Filter SearchIndexes by service name
schema:
type: string
example: ElasticSearchWestCoast
- name: limit
in: query
description: Limit the number SearchIndexes returned. (1 to 1000000, default = 10)
schema:
maximum: 1000000
minimum: 0
type: integer
format: int32
default: 10
- name: before
in: query
description: Returns list of SearchIndexes before this cursor
schema:
type: string
- name: after
in: query
description: Returns list of SearchIndexes after this cursor
schema:
type: string
- name: include
in: query
description: Include all, deleted, or non-deleted entities.
schema:
type: string
default: non-deleted
enum:
- all
- deleted
- non-deleted
responses:
'200':
description: List of SearchIndexes
content:
application/json:
schema:
$ref: '#/components/schemas/SearchIndexList'
put:
tags:
- SearchIndex
summary: Update SearchIndex
description: Create a SearchIndex, it it does not exist or update an existing SearchIndex.
operationId: createOrUpdateSearchIndex
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSearchIndex'
responses:
'200':
description: 'The updated SearchIndex '
content:
application/json:
schema:
$ref: '#/components/schemas/SearchIndex'
post:
tags:
- SearchIndex
summary: Create a SearchIndex
description: Create a SearchIndex under an existing `service`.
operationId: createSearchIndex
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSearchIndex'
responses:
'200':
description: The SearchIndex
content:
application/json:
schema:
$ref: '#/components/schemas/SearchIndex'
'400':
description: Bad request
/v1/searchIndexes/name/{fqn}:
get:
tags:
- SearchIndex
summary: Get a SearchIndex by fully qualified name
description: Get a SearchIndex by fully qualified name.
operationId: getSearchIndexByFQN
parameters:
- name: fqn
in: path
description: Fully qualified name of the SearchIndex
required: true
schema:
type: string
- name: fields
in: query
description: Fields requested in the returned resource
schema:
type: string
example: owners,followers,tags,extension,domains,dataProducts,sourceHash
- name: include
in: query
description: Include all, deleted, or non-deleted entities.
schema:
type: string
default: non-deleted
enum:
- all
- deleted
- non-deleted
- name: includeRelations
in: query
description: 'Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity''s include value.'
schema:
type: string
example: owners:non-deleted,followers:all
responses:
'200':
description: The SearchIndex
content:
application/json:
schema:
$ref: '#/components/schemas/SearchIndex'
'404':
description: SearchIndex for instance {fqn} is not found
delete:
tags:
- SearchIndex
summary: Delete a SearchIndex by fully qualified name
description: Delete a SearchIndex by `fullyQualifiedName`.
operationId: deleteSearchIndexByFQN
parameters:
- name: hardDelete
in: query
description: Hard delete the entity. (Default = `false`)
schema:
type: boolean
default: false
- name: recursive
in: query
description: Recursively delete this entity and it's children. (Default `false`)
schema:
type: boolean
default: false
- name: fqn
in: path
description: Fully qualified name of the SearchIndex
required: true
schema:
type: string
responses:
'200':
description: OK
'404':
description: SearchIndex for instance {fqn} is not found
patch:
tags:
- SearchIndex
summary: Update a SearchIndex using name.
description: Update an existing SearchIndex using JsonPatch.
externalDocs:
description: JsonPatch RFC
url: https://tools.ietf.org/html/rfc6902
operationId: patchSearchIndex
parameters:
- name: fqn
in: path
description: Name of the SearchIndex
required: true
schema:
type: string
requestBody:
description: JsonPatch with array of operations
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/JsonPatch'
example: '[{op:remove, path:/a},{op:add, path: /b, value: val}]'
responses:
default:
description: default response
content:
application/json: {}
/v1/searchIndexes/{id}:
get:
tags:
- SearchIndex
summary: Get a SearchIndex by id
description: Get a SearchIndex by `id`.
operationId: get_6
parameters:
- name: id
in: path
description: Id of the SearchIndex
required: true
schema:
type: string
format: uuid
- name: fields
in: query
description: Fields requested in the returned resource
schema:
type: string
example: owners,followers,tags,extension,domains,dataProducts,sourceHash
- name: include
in: query
description: Include all, deleted, or non-deleted entities.
schema:
type: string
default: non-deleted
enum:
- all
- deleted
- non-deleted
- name: includeRelations
in: query
description: 'Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity''s include value.'
schema:
type: string
example: owners:non-deleted,followers:all
responses:
'200':
description: The SearchIndex
content:
application/json:
schema:
$ref: '#/components/schemas/SearchIndex'
'404':
description: SearchIndex for instance {id} is not found
delete:
tags:
- SearchIndex
summary: Delete a SearchIndex by id
description: Delete a SearchIndex by `id`.
operationId: deleteSearchIndex
parameters:
- name: hardDelete
in: query
description: Hard delete the entity. (Default = `false`)
schema:
type: boolean
default: false
- name: recursive
in: query
description: Recursively delete this entity and it's children. (Default `false`)
schema:
type: boolean
default: false
- name: id
in: path
description: Id of the SearchIndex
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
'404':
description: SearchIndex for instance {id} is not found
patch:
tags:
- SearchIndex
summary: Update a SearchIndex
description: Update an existing SearchIndex using JsonPatch.
externalDocs:
description: JsonPatch RFC
url: https://tools.ietf.org/html/rfc6902
operationId: patchSearchIndex_1
parameters:
- name: id
in: path
description: Id of the SearchIndex
required: true
schema:
type: string
format: uuid
requestBody:
description: JsonPatch with array of operations
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/JsonPatch'
example: '[{op:remove, path:/a},{op:add, path: /b, value: val}]'
responses:
default:
description: default response
content:
application/json: {}
/v1/searchIndexes/async/{id}:
delete:
tags:
- SearchIndex
summary: Asynchronously delete a SearchIndex by id
description: Asynchronously delete a SearchIndex by `id`.
operationId: deleteSearchIndexAsync
parameters:
- name: hardDelete
in: query
description: Hard delete the entity. (Default = `false`)
schema:
type: boolean
default: false
- name: recursive
in: query
description: Recursively delete this entity and it's children. (Default `false`)
schema:
type: boolean
default: false
- name: id
in: path
description: Id of the SearchIndex
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
'404':
description: SearchIndex for instance {id} is not found
/v1/searchIndexes/{id}/followers/{userId}:
delete:
tags:
- SearchIndex
summary: Remove a follower
description: Remove the user identified `userId` as a follower of the SearchIndex.
operationId: deleteFollower_14
parameters:
- name: id
in: path
description: Id of the SearchIndex
required: true
schema:
type: string
format: uuid
- name: userId
in: path
description: Id of the user being removed as follower
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeEvent'
/v1/searchIndexes/{id}/versions/{version}:
get:
tags:
- SearchIndex
summary: Get a version of the SearchIndex
description: Get a version of the SearchIndex by given `id`
operationId: getSpecificSearchIndexVersion
parameters:
- name: id
in: path
description: Id of the SearchIndex
required: true
schema:
type: string
format: uuid
- name: version
in: path
description: SearchIndex version number in the form `major`.`minor`
required: true
schema:
type: string
example: 0.1 or 1.1
responses:
'200':
description: SearchIndex
content:
application/json:
schema:
$ref: '#/components/schemas/SearchIndex'
'404':
description: SearchIndex for instance {id} and version {version} is not found
/v1/searchIndexes/history:
get:
tags:
- SearchIndex
summary: List all entity versions within a time range
description: 'Get a paginated list of all entity versions within a given time range specified by `startTs` and `endTs` in milliseconds since epoch. '
operationId: listAllEntityVersionsByTimestamp_39
parameters:
- name: startTs
in: query
description: Start timestamp in milliseconds since epoch
required: true
schema:
type: integer
format: int64
- name: endTs
in: query
description: End timestamp in milliseconds since epoch
required: true
schema:
type: integer
format: int64
- name: limit
in: query
description: Limit the number of entity returned (1 to 1000000, default = 10)
schema:
maximum: 500
minimum: 1
type: integer
format: int32
default: 10
- name: before
in: query
description: Returns list of entity versions before this cursor
schema:
type: string
- name: after
in: query
description: Returns list of entity versions after this cursor
schema:
type: string
responses:
'200':
description: List of all versions
content:
application/json:
schema:
$ref: '#/components/schemas/ResultList'
/v1/searchIndexes/{id}/versions:
get:
tags:
- SearchIndex
summary: List SearchIndex versions
description: Get a list of all the versions of a SearchIndex identified by `id`
operationId: listAllSearchIndexVersion
parameters:
- name: id
in: path
description: Id of the SearchIndex
required: true
schema:
type: string
format: uuid
responses:
'200':
description: List of SearchIndex versions
content:
application/json:
schema:
$ref: '#/components/schemas/EntityHistory'
/v1/searchIndexes/restore:
put:
tags:
- SearchIndex
summary: Restore a soft deleted SearchIndex
description: Restore a soft deleted SearchIndex.
operationId: restore_29
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RestoreEntity'
responses:
'200':
description: 'Successfully restored the SearchIndex. '
content:
application/json:
schema:
$ref: '#/components/schemas/SearchIndex'
/v1/searchIndexes/{id}/vote:
put:
tags:
- SearchIndex
summary: Update Vote for a Entity
description: Update vote for a Entity
operationId: updateVoteForEntity_15
parameters:
- name: id
in: path
description: Id of the Entity
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VoteRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeEvent'
'404':
description: model for instance {id} is not found
components:
schemas:
TagLabelRecognizerMetadata:
required:
- recognizerId
- recognizerName
- score
type: object
properties:
recognizerId:
type: string
format: uuid
recognizerName:
type: string
score:
type: number
format: double
target:
type: string
enum:
- content
- column_name
patterns:
type: array
items:
$ref: '#/components/schemas/PatternMatch'
SearchIndexField:
required:
- dataType
- name
type: object
properties:
name:
maxLength: 256
minLength: 1
pattern: ^((?!::).)*$
type: string
displayName:
type: string
dataType:
type: string
enum:
- NUMBER
- TEXT
- BINARY
- TIMESTAMP
- TIMESTAMPZ
- TIME
- DATE
- DATETIME
- KEYWORD
- ARRAY
- OBJECT
- FLATTENED
- NESTED
- JOIN
- RANGE
- IP
- VERSION
- MURMUR3
- AGGREGATE_METRIC_DOUBLE
- HISTOGRAM
- ANNOTATED-TEXT
- COMPLETION
- SEARCH_AS_YOU_TYPE
- DENSE_VECTOR
- RANK_FEATURE
- RANK_FEATURES
- GEO_POINT
- GEO_SHAPE
- POINT
- SHAPE
- PERCOLATOR
- BOOLEAN
- CONSTANT_KEYWORD
- WILDCARD
- LONG
- INTEGER
- SHORT
- BYTE
- DOUBLE
- FLOAT
- HALF_FLOAT
- SCALED_FLOAT
- UNSIGNED_LONG
- UNKNOWN
dataTypeDisplay:
type: string
description:
type: string
fullyQualifiedName:
maxLength: 3072
minLength: 1
type: string
tags:
type: array
items:
$ref: '#/components/schemas/TagLabel'
children:
type: array
items:
$ref: '#/components/schemas/SearchIndexField'
BulkOperationResult:
type: object
properties:
dryRun:
type: boolean
status:
type: string
enum:
- success
- failure
- aborted
- partialSuccess
- running
abortReason:
type: string
numberOfRowsProcessed:
minimum: 0
exclusiveMinimum: false
type: integer
format: int32
numberOfRowsPassed:
minimum: 0
exclusiveMinimum: false
type: integer
format: int32
numberOfRowsFailed:
minimum: 0
exclusiveMinimum: false
type: integer
format: int32
successRequest:
type: array
items:
$ref: '#/components/schemas/BulkResponse'
failedRequest:
type: array
items:
$ref: '#/components/schemas/BulkResponse'
SearchIndexSettings:
type: object
ChangeSummaryMap:
type: object
AccessDetails:
required:
- timestamp
type: object
properties:
timestamp:
type: integer
format: int64
accessedBy:
$ref: '#/components/schemas/EntityReference'
accessedByAProcess:
type: string
FieldChange:
type: object
properties:
name:
type: string
oldValue:
type: object
newValue:
type: object
CoverImage:
type: object
properties:
url:
type: string
position:
type: string
RestoreEntity:
required:
- id
type: object
properties:
id:
type: string
format: uuid
LifeCycle:
type: object
properties:
created:
$ref: '#/components/schemas/AccessDetails'
updated:
$ref: '#/components/schemas/AccessDetails'
accessed:
$ref: '#/components/schemas/AccessDetails'
EntityHistory:
required:
- entityType
- versions
type: object
properties:
entityType:
type: string
versions:
type: array
items:
type: object
AssetCertification:
required:
- appliedDate
- expiryDate
- tagLabel
type: object
properties:
tagLabel:
$ref: '#/components/schemas/TagLabel'
appliedDate:
type: integer
format: int64
expiryDate:
type: integer
format: int64
VoteRequest:
type: object
properties:
updatedVoteType:
type: string
enum:
- votedUp
- votedDown
- unVoted
ResultList:
required:
- data
type: object
properties:
data:
type: array
items:
type: object
paging:
$ref: '#/components/schemas/Paging'
errors:
type: array
items:
$ref: '#/components/schemas/EntityError'
warningsCount:
type: integer
format: int32
warnings:
type: array
items:
$ref: '#/components/schemas/EntityError'
BulkResponse:
type: object
properties:
request:
type: object
message:
type: string
status:
type: integer
format: int32
Paging:
required:
- total
type: object
properties:
before:
type: string
after:
type: string
offset:
type: integer
format: int32
limit:
type: integer
format: int32
total:
type: integer
format: int32
SearchIndexSampleData:
type: object
properties:
messages:
type: array
items:
type: string
SearchIndex:
required:
- fields
- id
- name
- service
type: object
properties:
id:
type: string
format: uuid
name:
maxLength: 256
minLength: 1
pattern: ^((?!::).)*$
type: string
fullyQualifiedName:
maxLength: 3072
minLength: 1
type: string
displayName:
type: string
description:
type: string
version:
type: number
format: double
updatedAt:
type: integer
format: int64
updatedBy:
type: string
impersonatedBy:
type: string
service:
$ref: '#/components/schemas/EntityReference'
serviceType:
type: string
enum:
- ElasticSearch
- OpenSearch
- CustomSearch
fields:
type: array
items:
$ref: '#/components/schemas/SearchIndexField'
searchIndexSettings:
$ref: '#/components/schemas/SearchIndexSettings'
indexType:
type: string
enum:
- Index
- IndexTemplate
sampleData:
$ref: '#/components/schemas/SearchIndexSampleData'
owners:
type: array
items:
$ref: '#/components/schemas/EntityReference'
followers:
type: array
items:
$ref: '#/components/schemas/EntityReference'
tags:
type: array
items:
$ref: '#/components/schemas/TagLabel'
href:
type: string
format: uri
changeDescription:
$ref: '#/components/schemas/ChangeDescription'
incrementalChangeDescription:
$ref: '#/components/schemas/ChangeDescription'
deleted:
type: boolean
extension:
type: object
domains:
type: array
items:
$ref: '#/components/schemas/EntityReference'
dataProducts:
type: array
items:
$ref: '#/components/schemas/EntityReference'
dataContract:
$ref: '#/components/schemas/EntityReference'
votes:
$ref: '#/components/schemas/Votes'
lifeCycle:
$ref: '#/components/schemas/LifeCycle'
certification:
$ref: '#/components/schemas/AssetCertification'
sourceHash:
maxLength: 32
minLength: 1
type: string
entityStatus:
type: string
enum:
- Draft
- In Review
- Approved
- Archived
- Deprecated
- Rejected
- Unprocessed
provider:
type: string
enum:
- system
- user
- automation
children:
type: array
items:
$ref: '#/components/schemas/EntityReference'
style:
$ref: '#/components/schemas/Style'
experts:
type: array
items:
$ref: '#/components/schemas/EntityReference'
reviewers:
type: array
items:
$ref: '#/components/schemas/EntityReference'
usageSummary:
$ref: '#/components/schemas/UsageDetails'
JsonPatch:
type: object
ChangeDescription:
type: object
properties:
fieldsAdded:
type: array
items:
$ref: '#/components/schemas/FieldChange'
fieldsUpdated:
type: array
items:
$ref: '#/components/schemas/FieldChange'
fieldsDeleted:
type: array
items:
$ref: '#/components/schemas/FieldChange'
previousVersion:
type: number
format: double
changeSummary:
$ref: '#/components/schemas/ChangeSummaryMap'
ChangeEvent:
required:
- entityId
- entityType
- eventType
- id
- timestamp
type: object
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- entityCreated
- entityUpdated
- entityFieldsChanged
- entityNoChange
- entitySoftDeleted
- entityDeleted
- entityRestored
- threadCreated
- threadUpdated
- postCreated
- postUpdated
- taskResolved
- taskClosed
- logicalTestCaseAdded
- suggestionCreated
- suggestionUpdated
- suggestionAccepted
- suggestionRejected
- suggestionDeleted
- userLogin
- userLogout
entityType:
type: string
entityId:
type: string
format: uuid
domains:
type: array
items:
type: string
format: uuid
entityFullyQualifiedName:
type: string
previousVersion:
type: number
format: double
currentVersion:
type: number
format: double
userName:
type: string
impersonatedBy:
type: string
timestamp:
type: integer
format: int64
changeDescription:
$ref: '#/components/schemas/ChangeDescription'
incrementalChangeDescription:
$ref: '#/components/schemas/ChangeDescription'
entity:
type: object
UsageStats:
required:
- count
type: object
properties:
count:
minimum: 0
exclusiveMinimum: false
type: integer
format: int32
percentileRank:
type: number
format: double
Style:
type: object
properties:
color:
type: string
iconURL:
type: string
coverImage:
$ref: '#/components/schemas/CoverImage'
Votes:
type: object
properties:
upVotes:
type: integer
format: int32
downVotes:
type: integer
format: int32
upVoters:
type: array
items:
$ref: '#/components/schemas/EntityReference'
downVoters:
type: array
items:
$ref: '#/components/schemas/EntityReference'
TagLabel:
required:
- labelType
- source
- state
- tagFQN
type: object
properties:
tagFQN:
type: string
name:
type: string
displayName:
type: string
description:
type: string
style:
$ref: '#/components/schemas/Style'
source:
type: string
enum:
- Classification
- Glossary
labelType:
type: string
enum:
- Manual
- Prop
# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openmetadata/refs/heads/main/openapi/openmetadata-searchindex-api-openapi.yml