DBaaS Opensearch

Opensearch, the popular open-source search and analytics database.

update-dbaas-opensearch-acl-config

Create a DBaaS OpenSearch ACL configuration

PUT /dbaas-opensearch/{name}/acl-config

null

Path parameters

name in path (required)

Request body

application/json
- acls (array[object]): List of OpenSearch ACLs - schema details
- acl-enabled (boolean): Enable OpenSearch ACLs. When disabled authenticated service users have unrestricted access.
- extended-acl-enabled (boolean): Enable to enforce index rules in a limited fashion for requests that use the _mget, _msearch, and _bulk APIs

Responses

200: 200
- application/json
  - id (string): Operation ID
  - reason (string): Operation failure reason
  - reference (object): Related resource reference - schema details
  - message (string): Operation message
  - state (string): Operation status

SDK reference for update-dbaas-opensearch-acl-config: golang | Python | Java

CLI: exo api update-dbaas-opensearch-acl-config

get-dbaas-opensearch-acl-config

Get DBaaS OpenSearch ACL configuration

GET /dbaas-opensearch/{name}/acl-config

null

Path parameters

name in path (required)

Responses

200: 200
- application/json
  - acls (array[object]): List of OpenSearch ACLs - schema details
  - acl-enabled (boolean): Enable OpenSearch ACLs. When disabled authenticated service users have unrestricted access.
  - extended-acl-enabled (boolean): Enable to enforce index rules in a limited fashion for requests that use the _mget, _msearch, and _bulk APIs

SDK reference for get-dbaas-opensearch-acl-config: golang | Python | Java

CLI: exo api get-dbaas-opensearch-acl-config

create-dbaas-opensearch-user

Create a DBaaS OpenSearch user

POST /dbaas-opensearch/{service-name}/user

null

Path parameters

service-name in path (required)

Request body

application/json
- username (required) (string)

Responses

200: 200
- application/json
  - id (string): Operation ID
  - reason (string): Operation failure reason
  - reference (object): Related resource reference - schema details
  - message (string): Operation message
  - state (string): Operation status

SDK reference for create-dbaas-opensearch-user: golang | Python | Java

CLI: exo api create-dbaas-opensearch-user

delete-dbaas-opensearch-user

Delete a DBaaS OpenSearch user

DELETE /dbaas-opensearch/{service-name}/user/{username}

null

Path parameters

service-name in path (required)
username in path (required)

Responses

200: 200
- application/json
  - id (string): Operation ID
  - reason (string): Operation failure reason
  - reference (object): Related resource reference - schema details
  - message (string): Operation message
  - state (string): Operation status

SDK reference for delete-dbaas-opensearch-user: golang | Python | Java

CLI: exo api delete-dbaas-opensearch-user

reveal-dbaas-opensearch-user-password

Reveal the secrets of a DBaaS OpenSearch user

GET /dbaas-opensearch/{service-name}/user/{username}/password/reveal

null

Path parameters

service-name in path (required)
username in path (required)

Responses

200: 200
- application/json
  - username (string): Opensearch username
  - password (string): Opensearch password

SDK reference for reveal-dbaas-opensearch-user-password: golang | Python | Java

CLI: exo api reveal-dbaas-opensearch-user-password

reset-dbaas-opensearch-user-password

Reset the credentials of a DBaaS OpenSearch user

PUT /dbaas-opensearch/{service-name}/user/{username}/password/reset

If no password is provided one will be generated automatically.

Path parameters

service-name in path (required)
username in path (required)

Request body

application/json
- password (string)

Responses

200: 200
- application/json
  - id (string): Operation ID
  - reason (string): Operation failure reason
  - reference (object): Related resource reference - schema details
  - message (string): Operation message
  - state (string): Operation status

SDK reference for reset-dbaas-opensearch-user-password: golang | Python | Java

CLI: exo api reset-dbaas-opensearch-user-password

create-dbaas-service-opensearch

Create a DBaaS OpenSearch service

POST /dbaas-opensearch/{name}

Create a DBaaS OpenSearch service

Path parameters

name in path (required)

Request body

application/json
- max-index-count (integer): Maximum number of indexes to keep before deleting the oldest one
- keep-index-refresh-interval (boolean): Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn’t fit your case, you can disable this by setting up this flag to true.
- ip-filter (array[string]): Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
- termination-protection (boolean): Service is protected against termination and powering off
- fork-from-service (string)
- index-patterns (array[object]): Allows you to create glob style patterns and set a max number of indexes matching this pattern you want to keep. Creating indexes exceeding this value will cause the oldest one to get deleted. You could for example create a pattern looking like ’logs.?’ and then create index logs.1, logs.2 etc, it will delete logs.1 once you create logs.6. Do note ’logs.?’ does not apply to logs.10. Note: Setting max_index_count to 0 will do nothing and the pattern gets ignored. - schema details
- maintenance (object): Automatic maintenance settings - schema details
- index-template (object): Template settings for all new indexes - schema details
- opensearch-settings (object) - schema details
- version (string): OpenSearch major version
- recovery-backup-name (string): Name of a backup to recover from for services that support backup names
- plan (required) (string): Subscription plan
- opensearch-dashboards (object): OpenSearch Dashboards settings - schema details

Responses

200: 200
- application/json
  - id (string): Operation ID
  - reason (string): Operation failure reason
  - reference (object): Related resource reference - schema details
  - message (string): Operation message
  - state (string): Operation status

SDK reference for create-dbaas-service-opensearch: golang | Python | Java

CLI: exo api create-dbaas-service-opensearch

get-dbaas-service-opensearch

Get a DBaaS OpenSearch service

GET /dbaas-opensearch/{name}

Get a DBaaS OpenSearch service

Path parameters

name in path (required)

Responses

200: 200
- application/json
  - description (string): DbaaS service description
  - max-index-count (integer): Maximum number of indexes to keep before deleting the oldest one
  - updated-at (string): Service last update timestamp (ISO 8601)
  - node-count (integer): Number of service nodes in the active plan
  - connection-info (object): Opensearch connection information properties - schema details
  - node-cpu-count (integer): Number of CPUs for each node
  - prometheus-uri (object): Prometheus integration URI - schema details
  - integrations (array[object]): Service integrations - schema details
  - zone (string): The zone where the service is running
  - node-states (array[object]): State of individual service nodes - schema details
  - name (string)
  - keep-index-refresh-interval (boolean): Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn’t fit your case, you can disable this by setting up this flag to true.
  - type (string)
  - state (string)
  - ip-filter (array[string]): Allowed CIDR address blocks for incoming connections
  - backups (array[object]): List of backups for the service - schema details
  - termination-protection (boolean): Service is protected against termination and powering off
  - notifications (array[object]): Service notifications - schema details
  - components (array[object]): Service component information objects - schema details
  - index-patterns (array[object]): Allows you to create glob style patterns and set a max number of indexes matching this pattern you want to keep. Creating indexes exceeding this value will cause the oldest one to get deleted. You could for example create a pattern looking like ’logs.?’ and then create index logs.1, logs.2 etc, it will delete logs.1 once you create logs.6. Do note ’logs.?’ does not apply to logs.10. Note: Setting max_index_count to 0 will do nothing and the pattern gets ignored. - schema details
  - maintenance (object): Automatic maintenance settings - schema details
  - index-template (object): Template settings for all new indexes - schema details
  - disk-size (integer): TODO UNIT disk space for data storage
  - node-memory (integer): TODO UNIT of memory for each node
  - uri (string): URI for connecting to the service (may be absent)
  - opensearch-settings (object) - schema details
  - uri-params (object): service_uri parameterized into key-value pairs
  - version (string): OpenSearch version
  - created-at (string): Service creation timestamp (ISO 8601)
  - plan (string): Subscription plan
  - opensearch-dashboards (object): OpenSearch Dashboards settings - schema details
  - users (array[object]): List of service users - schema details

SDK reference for get-dbaas-service-opensearch: golang | Python | Java

CLI: exo api get-dbaas-service-opensearch

update-dbaas-service-opensearch

Update a DBaaS OpenSearch service

PUT /dbaas-opensearch/{name}

Update a DBaaS OpenSearch service

Path parameters

name in path (required)

Request body

application/json
- max-index-count (integer): Maximum number of indexes to keep before deleting the oldest one
- keep-index-refresh-interval (boolean): Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn’t fit your case, you can disable this by setting up this flag to true.
- ip-filter (array[string]): Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
- termination-protection (boolean): Service is protected against termination and powering off
- index-patterns (array[object]): Allows you to create glob style patterns and set a max number of indexes matching this pattern you want to keep. Creating indexes exceeding this value will cause the oldest one to get deleted. You could for example create a pattern looking like ’logs.?’ and then create index logs.1, logs.2 etc, it will delete logs.1 once you create logs.6. Do note ’logs.?’ does not apply to logs.10. Note: Setting max_index_count to 0 will do nothing and the pattern gets ignored. - schema details
- maintenance (object): Automatic maintenance settings - schema details
- index-template (object): Template settings for all new indexes - schema details
- opensearch-settings (object) - schema details
- version (string): Version
- plan (string): Subscription plan
- opensearch-dashboards (object): OpenSearch Dashboards settings - schema details

Responses

200: 200
- application/json
  - id (string): Operation ID
  - reason (string): Operation failure reason
  - reference (object): Related resource reference - schema details
  - message (string): Operation message
  - state (string): Operation status

SDK reference for update-dbaas-service-opensearch: golang | Python | Java

CLI: exo api update-dbaas-service-opensearch

delete-dbaas-service-opensearch

Delete a OpenSearch service

DELETE /dbaas-opensearch/{name}

null

Path parameters

name in path (required)

Responses

200: 200
- application/json
  - id (string): Operation ID
  - reason (string): Operation failure reason
  - reference (object): Related resource reference - schema details
  - message (string): Operation message
  - state (string): Operation status

SDK reference for delete-dbaas-service-opensearch: golang | Python | Java

CLI: exo api delete-dbaas-service-opensearch

Other Operations

start-dbaas-opensearch-maintenance

Initiate OpenSearch maintenance update

PUT /dbaas-opensearch/{name}/maintenance/start

null

Path parameters

name in path (required)

Responses

200: 200
- application/json
  - id (string): Operation ID
  - reason (string): Operation failure reason
  - reference (object): Related resource reference - schema details
  - message (string): Operation message
  - state (string): Operation status

SDK reference for start-dbaas-opensearch-maintenance: golang | Python | Java

CLI: exo api start-dbaas-opensearch-maintenance

get-dbaas-settings-opensearch

Get DBaaS OpenSearch settings

GET /dbaas-settings-opensearch

Get DBaaS OpenSearch settings

Responses

200: 200
- application/json
  - settings (object) - schema details

SDK reference for get-dbaas-settings-opensearch: golang | Python | Java

CLI: exo api get-dbaas-settings-opensearch

Last updated on January 9, 2026