OpenSearch API

These endpoints allow to list, delete and reindex OpenSearch indices as well as to receive index mappings.

Method Endpoint

Method	Endpoint
`GET`	`/cxf/bpc-core/opensearch/indices`
Description Get a list of all OpenSearch indices.
Returns The requested data as JSON HTTP Status Code `200` : OK Content-Type `application/json`
Required Access Rights The logged in user or API Key must have either the following role or right. Role : `OPENSEARCH_ADMIN` Right : `OPENSEARCH_LIST_INDICES`
`GET`	`/cxf/bpc-core/opensearch/indices/compact`
Description Get a compact list of OpenSearch indices. Can be used for example in a combo box.
Returns The requested data as JSON HTTP Status Code `200` : OK Content-Type `application/json`
Required Access Rights A logged in user or API Key is required.
`GET`	`/cxf/bpc-core/opensearch/indices/mapping/{indexName}`
Description Get the settings and mappings of an OpenSearch index.
Path Parameter `indexName` the name of the index
Returns The requested data as JSON HTTP Status Code `200` : OK Content-Type `application/json`
Required Access Rights The logged in user or API Key must have either the following role or right. Role : `OPENSEARCH_ADMIN` Right : `OPENSEARCH_GET_MAPPING`
`DELETE`	`/cxf/bpc-core/opensearch/indices/operations/{indexName}`
Description Delete an OpenSearch index.
Path Parameter `indexName` the name of the index to delete
Returns HTTP Status Code `200` : OK
Required Access Rights The logged in user or API Key must have either the following role or right. Role : `OPENSEARCH_ADMIN` Right : `OPENSEARCH_DELETE_INDEX`
`GET`	`/cxf/bpc-core/opensearch/indices/reindex/{indexName}`
Description Get the information what a reindex action would do with the index settings and mappings.
Path Parameter `indexName` the name of the index
Query Parameter `copyIndexMapping` `true` to copy the index mapping, otherwise `false`. Default is `true`. `copyMetaData` `true` to copy the meta data, otherwise `false`. Default is `true`.
Returns The old and new index settings and mappings as JSON HTTP Status Code `200` : OK Content-Type `application/json`
Required Access Rights The logged in user or API Key must have either the following role or right. Role : `OPENSEARCH_ADMIN` Right : `OPENSEARCH_REINDEX`
`POST`	`/cxf/bpc-core/opensearch/indices/reindex/{indexName}`
Description Perform a reindex action.
Path Parameter `indexName` the name of the index to reindex
Query Parameter `copyIndexMapping` `true` to copy the index mapping, otherwise `false`. Default is `true`. `copyMetaData` `true` to copy the meta data, otherwise `false`. Default is `true`. `deleteSourceIndexAfterwards` `true` to delete the source index afterwards, `false` to close it instead. Default is `false`.
Returns HTTP Status Code `200` : OK
Required Access Rights The logged in user or API Key must have either the following role or right. Role : `OPENSEARCH_ADMIN` Right : `OPENSEARCH_REINDEX`

GET

/cxf/bpc-core/opensearch/indices

Description

Get a list of all OpenSearch indices.

Returns

The requested data as JSON

HTTP Status Code

200 : OK

Content-Type

application/json

Required Access Rights

The logged in user or API Key must have either the following role or right.

Role : OPENSEARCH_ADMIN
Right : OPENSEARCH_LIST_INDICES

GET

/cxf/bpc-core/opensearch/indices/compact

Description

Get a compact list of OpenSearch indices. Can be used for example in a combo box.

Returns

The requested data as JSON

HTTP Status Code

200 : OK

Content-Type

application/json

Required Access Rights

A logged in user or API Key is required.

GET

/cxf/bpc-core/opensearch/indices/mapping/{indexName}

Description

Get the settings and mappings of an OpenSearch index.

Path Parameter

indexName: the name of the index

Returns

The requested data as JSON

HTTP Status Code

200 : OK

Content-Type

application/json

Required Access Rights

The logged in user or API Key must have either the following role or right.

Role : OPENSEARCH_ADMIN
Right : OPENSEARCH_GET_MAPPING

DELETE

/cxf/bpc-core/opensearch/indices/operations/{indexName}

Description

Delete an OpenSearch index.

Path Parameter

indexName: the name of the index to delete

Returns

HTTP Status Code

200 : OK

Required Access Rights

The logged in user or API Key must have either the following role or right.

Role : OPENSEARCH_ADMIN
Right : OPENSEARCH_DELETE_INDEX

GET

/cxf/bpc-core/opensearch/indices/reindex/{indexName}

Description

Get the information what a reindex action would do with the index settings and mappings.

Path Parameter

indexName: the name of the index

Query Parameter

copyIndexMapping: true to copy the index mapping, otherwise false. Default is true.
copyMetaData: true to copy the meta data, otherwise false. Default is true.

Returns

The old and new index settings and mappings as JSON

HTTP Status Code

200 : OK

Content-Type

application/json

Required Access Rights

The logged in user or API Key must have either the following role or right.

Role : OPENSEARCH_ADMIN
Right : OPENSEARCH_REINDEX

POST

/cxf/bpc-core/opensearch/indices/reindex/{indexName}

Description

Perform a reindex action.

Path Parameter

indexName: the name of the index to reindex

Query Parameter

copyIndexMapping: true to copy the index mapping, otherwise false. Default is true.
copyMetaData: true to copy the meta data, otherwise false. Default is true.
deleteSourceIndexAfterwards: true to delete the source index afterwards, false to close it instead. Default is false.

Returns

HTTP Status Code

200 : OK

Required Access Rights

The logged in user or API Key must have either the following role or right.

Role : OPENSEARCH_ADMIN
Right : OPENSEARCH_REINDEX