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	Description
`name`	`path`

Request body

Content-Type: application/json

Property	Type	Required	Description
`acl-enabled`	boolean	no	Enable OpenSearch ACLs. When disabled authenticated service users have unrestricted access.
`acls`	array[object]	no	List of OpenSearch ACLs schema details
`extended-acl-enabled`	boolean	no	Enable to enforce index rules in a limited fashion for requests that use the _mget, _msearch, and _bulk APIs

Example

{
  "acl-enabled": true,
  "acls": [
    {
      "rules": [
        {
          "index": "string",
          "permission": "admin"
        }
      ],
      "username": "string"
    }
  ],
  "extended-acl-enabled": true
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	object	Related resource reference schema details
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

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	Description
`name`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

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

Example output

{
  "acl-enabled": true,
  "acls": [
    {
      "rules": [
        {
          "index": "string",
          "permission": "admin"
        }
      ],
      "username": "string"
    }
  ],
  "extended-acl-enabled": true
}

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

Name	In	Description
`service-name`	`path`

Request body

Content-Type: application/json

Property	Type	Required	Description
`username`	string	yes	Username

Example

{
  "username": "string"
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	object	Related resource reference schema details
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

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

Name	In	Description
`service-name`	`path`
`username`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	object	Related resource reference schema details
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

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

Name	In	Description
`service-name`	`path`
`username`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`password`	string	Opensearch password
`username`	string	Opensearch username

Example output

{
  "password": "string",
  "username": "string"
}

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

Name	In	Description
`service-name`	`path`
`username`	`path`

Request body

Content-Type: application/json

Property	Type	Required	Description
`password`	string	no	New password

Example

{
  "password": "string"
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	object	Related resource reference schema details
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

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	Description
`name`	`path`

Request body

Content-Type: application/json

Property	Type	Required	Description
`plan`	string	yes	Subscription plan
`fork-from-service`	string	no	Service to fork from
`index-patterns`	array[object]	no	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
`index-template`	object	no	Template settings for all new indexes schema details
`ip-filter`	array[string]	no	Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
`keep-index-refresh-interval`	boolean	no	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.
`maintenance`	object	no	Automatic maintenance settings schema details
`max-index-count`	integer	no	Maximum number of indexes to keep before deleting the oldest one
`opensearch-dashboards`	object	no	OpenSearch Dashboards settings schema details
`opensearch-settings`	object	no	OpenSearch-specific settings schema details
`recovery-backup-name`	string	no	Name of a backup to recover from for services that support backup names
`termination-protection`	boolean	no	Service is protected against termination and powering off
`version`	string	no	OpenSearch major version

Example

{
  "fork-from-service": "string",
  "index-patterns": [
    {
      "max-index-count": 0,
      "pattern": "string",
      "sorting-algorithm": "alphabetical"
    }
  ],
  "index-template": {
    "mapping-nested-objects-limit": 0,
    "number-of-replicas": 0,
    "number-of-shards": 0
  },
  "ip-filter": [
    "string"
  ],
  "keep-index-refresh-interval": true,
  "maintenance": {
    "dow": "saturday",
    "time": "string"
  },
  "max-index-count": 0,
  "opensearch-dashboards": {
    "enabled": true,
    "max-old-space-size": 0,
    "opensearch-request-timeout": 0
  },
  "opensearch-settings": {
    "action_auto_create_index_enabled": true,
    "action_destructive_requires_name": true,
    "auth_failure_listeners": {
      "internal_authentication_backend_limiting": {
        "allowed_tries": 0,
        "authentication_backend": "internal",
        "block_expiry_seconds": 0,
        "max_blocked_clients": 0,
        "max_tracked_clients": 0,
        "time_window_seconds": 0,
        "type": "username"
      },
      "ip_rate_limiting": {
        "allowed_tries": 0,
        "block_expiry_seconds": 0,
        "max_blocked_clients": 0,
        "max_tracked_clients": 0,
        "time_window_seconds": 0,
        "type": "ip"
      }
    },
    "cluster_max_shards_per_node": 0,
    "cluster_routing_allocation_node_concurrent_recoveries": 0,
    "email-sender": {
      "email_sender_name": "alert-sender",
      "email_sender_password": "very-secure-mail-password",
      "email_sender_username": "jane@example.com"
    },
    "enable_security_audit": true,
    "http_max_content_length": 0,
    "http_max_header_size": 0,
    "http_max_initial_line_length": 0,
    "indices_fielddata_cache_size": 0,
    "indices_memory_index_buffer_size": 0,
    "indices_memory_max_index_buffer_size": 0,
    "indices_memory_min_index_buffer_size": 0,
    "indices_queries_cache_size": 0,
    "indices_query_bool_max_clause_count": 0,
    "indices_recovery_max_bytes_per_sec": 0,
    "indices_recovery_max_concurrent_file_chunks": 0,
    "ism-history": {
      "ism_enabled": true,
      "ism_history_enabled": true,
      "ism_history_max_age": 0,
      "ism_history_max_docs": 0,
      "ism_history_rollover_check_period": 0,
      "ism_history_rollover_retention_period": 0
    },
    "knn_memory_circuit_breaker_enabled": true,
    "knn_memory_circuit_breaker_limit": 0,
    "override_main_response_version": true,
    "plugins_alerting_filter_by_backend_roles": true,
    "reindex_remote_whitelist": [
      "anotherservice.aivencloud.com:12398"
    ],
    "script_max_compilations_rate": "75/5m",
    "search_backpressure": {
      "mode": "monitor_only",
      "node_duress": {
        "cpu_threshold": 0,
        "heap_threshold": 0,
        "num_successive_breaches": 0
      },
      "search_shard_task": {
        "cancellation_burst": 0,
        "cancellation_rate": 0,
        "cancellation_ratio": 0,
        "cpu_time_millis_threshold": 0,
        "elapsed_time_millis_threshold": 0,
        "heap_moving_average_window_size": 0,
        "heap_percent_threshold": 0,
        "heap_variance": 0,
        "total_heap_percent_threshold": 0
      },
      "search_task": {
        "cancellation_burst": 0,
        "cancellation_rate": 0,
        "cancellation_ratio": 0,
        "cpu_time_millis_threshold": 0,
        "elapsed_time_millis_threshold": 0,
        "heap_moving_average_window_size": 0,
        "heap_percent_threshold": 0,
        "heap_variance": 0,
        "total_heap_percent_threshold": 0
      }
    },
    "search_max_buckets": 0,
    "shard_indexing_pressure": {
      "enabled": true,
      "enforced": true,
      "operating_factor": {
        "lower": 0,
        "optimal": 0,
        "upper": 0
      },
      "primary_parameter": {
        "node": {
          "soft_limit": 0
        },
        "shard": {
          "min_limit": 0
        }
      }
    },
    "thread_pool_analyze_queue_size": 0,
    "thread_pool_analyze_size": 0,
    "thread_pool_force_merge_size": 0,
    "thread_pool_get_queue_size": 0,
    "thread_pool_get_size": 0,
    "thread_pool_search_queue_size": 0,
    "thread_pool_search_size": 0,
    "thread_pool_search_throttled_queue_size": 0,
    "thread_pool_search_throttled_size": 0,
    "thread_pool_write_queue_size": 0,
    "thread_pool_write_size": 0
  },
  "plan": "string",
  "recovery-backup-name": "string",
  "termination-protection": true,
  "version": "string"
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	object	Related resource reference schema details
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

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	Description
`name`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`backups`	array[object]	List of backups for the service schema details
`components`	array[object]	Service component information objects schema details
`connection-info`	object	Opensearch connection information properties schema details
`created-at`	string	Service creation timestamp (ISO 8601)
`description`	string	DbaaS service description
`disk-size`	integer	TODO UNIT disk space for data storage
`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
`index-template`	object	Template settings for all new indexes schema details
`integrations`	array[object]	Service integrations schema details
`ip-filter`	array[string]	Allowed CIDR address blocks for incoming connections
`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.
`maintenance`	object	Automatic maintenance settings schema details
`max-index-count`	integer	Maximum number of indexes to keep before deleting the oldest one
`name`	string	Service name
`node-count`	integer	Number of service nodes in the active plan
`node-cpu-count`	integer	Number of CPUs for each node
`node-memory`	integer	TODO UNIT of memory for each node
`node-states`	array[object]	State of individual service nodes schema details
`notifications`	array[object]	Service notifications schema details
`opensearch-dashboards`	object	OpenSearch Dashboards settings schema details
`opensearch-settings`	object	OpenSearch-specific settings schema details
`plan`	string	Subscription plan
`prometheus-uri`	object	Prometheus integration URI schema details
`state`	string	State of the service Allowed values: `running`, `rebuilding`, `rebalancing`, `poweroff`.
`termination-protection`	boolean	Service is protected against termination and powering off
`type`	string	Service type code
`updated-at`	string	Service last update timestamp (ISO 8601)
`uri`	string	URI for connecting to the service (may be absent)
`uri-params`	object	service_uri parameterized into key-value pairs
`users`	array[object]	List of service users schema details
`version`	string	OpenSearch version
`zone`	string	The zone where the service is running

Example output

{
  "backups": [
    {
      "backup-name": "string",
      "backup-time": "2024-01-01T12:00:00Z",
      "data-size": 0
    }
  ],
  "components": [
    {
      "component": "string",
      "host": "string",
      "port": 0,
      "route": "dynamic",
      "usage": "primary"
    }
  ],
  "connection-info": {
    "dashboard-uri": "string",
    "password": "string",
    "uri": [
      "string"
    ],
    "username": "string"
  },
  "created-at": "2024-01-01T12:00:00Z",
  "description": "string",
  "disk-size": 0,
  "index-patterns": [
    {
      "max-index-count": 0,
      "pattern": "string",
      "sorting-algorithm": "alphabetical"
    }
  ],
  "index-template": {
    "mapping-nested-objects-limit": 0,
    "number-of-replicas": 0,
    "number-of-shards": 0
  },
  "integrations": [
    {
      "description": "string",
      "dest": "string",
      "id": "string",
      "is-active": true,
      "is-enabled": true,
      "settings": {},
      "source": "string",
      "status": "string",
      "type": "string"
    }
  ],
  "ip-filter": [
    "string"
  ],
  "keep-index-refresh-interval": true,
  "maintenance": {
    "dow": "saturday",
    "time": "string",
    "updates": [
      {
        "deadline": "2024-01-01T12:00:00Z",
        "description": "string",
        "start-after": "2024-01-01T12:00:00Z",
        "start-at": "2024-01-01T12:00:00Z"
      }
    ]
  },
  "max-index-count": 0,
  "name": "string",
  "node-count": 0,
  "node-cpu-count": 0,
  "node-memory": 0,
  "node-states": [
    {
      "name": "string",
      "progress-updates": [
        {
          "completed": true,
          "current": 0,
          "max": 0,
          "min": 0,
          "phase": "stream",
          "unit": "string"
        }
      ],
      "role": "standby",
      "state": "leaving"
    }
  ],
  "notifications": [
    {
      "level": "warning",
      "message": "string",
      "metadata": {},
      "type": "service_powered_off_removal"
    }
  ],
  "opensearch-dashboards": {
    "enabled": true,
    "max-old-space-size": 0,
    "opensearch-request-timeout": 0
  },
  "opensearch-settings": {
    "action_auto_create_index_enabled": true,
    "action_destructive_requires_name": true,
    "auth_failure_listeners": {
      "internal_authentication_backend_limiting": {
        "allowed_tries": 0,
        "authentication_backend": "internal",
        "block_expiry_seconds": 0,
        "max_blocked_clients": 0,
        "max_tracked_clients": 0,
        "time_window_seconds": 0,
        "type": "username"
      },
      "ip_rate_limiting": {
        "allowed_tries": 0,
        "block_expiry_seconds": 0,
        "max_blocked_clients": 0,
        "max_tracked_clients": 0,
        "time_window_seconds": 0,
        "type": "ip"
      }
    },
    "cluster_max_shards_per_node": 0,
    "cluster_routing_allocation_node_concurrent_recoveries": 0,
    "email-sender": {
      "email_sender_name": "alert-sender",
      "email_sender_password": "very-secure-mail-password",
      "email_sender_username": "jane@example.com"
    },
    "enable_security_audit": true,
    "http_max_content_length": 0,
    "http_max_header_size": 0,
    "http_max_initial_line_length": 0,
    "indices_fielddata_cache_size": 0,
    "indices_memory_index_buffer_size": 0,
    "indices_memory_max_index_buffer_size": 0,
    "indices_memory_min_index_buffer_size": 0,
    "indices_queries_cache_size": 0,
    "indices_query_bool_max_clause_count": 0,
    "indices_recovery_max_bytes_per_sec": 0,
    "indices_recovery_max_concurrent_file_chunks": 0,
    "ism-history": {
      "ism_enabled": true,
      "ism_history_enabled": true,
      "ism_history_max_age": 0,
      "ism_history_max_docs": 0,
      "ism_history_rollover_check_period": 0,
      "ism_history_rollover_retention_period": 0
    },
    "knn_memory_circuit_breaker_enabled": true,
    "knn_memory_circuit_breaker_limit": 0,
    "override_main_response_version": true,
    "plugins_alerting_filter_by_backend_roles": true,
    "reindex_remote_whitelist": [
      "anotherservice.aivencloud.com:12398"
    ],
    "script_max_compilations_rate": "75/5m",
    "search_backpressure": {
      "mode": "monitor_only",
      "node_duress": {
        "cpu_threshold": 0,
        "heap_threshold": 0,
        "num_successive_breaches": 0
      },
      "search_shard_task": {
        "cancellation_burst": 0,
        "cancellation_rate": 0,
        "cancellation_ratio": 0,
        "cpu_time_millis_threshold": 0,
        "elapsed_time_millis_threshold": 0,
        "heap_moving_average_window_size": 0,
        "heap_percent_threshold": 0,
        "heap_variance": 0,
        "total_heap_percent_threshold": 0
      },
      "search_task": {
        "cancellation_burst": 0,
        "cancellation_rate": 0,
        "cancellation_ratio": 0,
        "cpu_time_millis_threshold": 0,
        "elapsed_time_millis_threshold": 0,
        "heap_moving_average_window_size": 0,
        "heap_percent_threshold": 0,
        "heap_variance": 0,
        "total_heap_percent_threshold": 0
      }
    },
    "search_max_buckets": 0,
    "shard_indexing_pressure": {
      "enabled": true,
      "enforced": true,
      "operating_factor": {
        "lower": 0,
        "optimal": 0,
        "upper": 0
      },
      "primary_parameter": {
        "node": {
          "soft_limit": 0
        },
        "shard": {
          "min_limit": 0
        }
      }
    },
    "thread_pool_analyze_queue_size": 0,
    "thread_pool_analyze_size": 0,
    "thread_pool_force_merge_size": 0,
    "thread_pool_get_queue_size": 0,
    "thread_pool_get_size": 0,
    "thread_pool_search_queue_size": 0,
    "thread_pool_search_size": 0,
    "thread_pool_search_throttled_queue_size": 0,
    "thread_pool_search_throttled_size": 0,
    "thread_pool_write_queue_size": 0,
    "thread_pool_write_size": 0
  },
  "plan": "string",
  "prometheus-uri": {
    "host": "string",
    "port": 0
  },
  "state": "running",
  "termination-protection": true,
  "type": "string",
  "updated-at": "2024-01-01T12:00:00Z",
  "uri": "string",
  "uri-params": {},
  "users": [
    {
      "password": "string",
      "type": "string",
      "username": "string"
    }
  ],
  "version": "string",
  "zone": "string"
}

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	Description
`name`	`path`

Request body

Content-Type: application/json

Property	Type	Required	Description
`index-patterns`	array[object]	no	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
`index-template`	object	no	Template settings for all new indexes schema details
`ip-filter`	array[string]	no	Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
`keep-index-refresh-interval`	boolean	no	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.
`maintenance`	object	no	Automatic maintenance settings schema details
`max-index-count`	integer	no	Maximum number of indexes to keep before deleting the oldest one
`opensearch-dashboards`	object	no	OpenSearch Dashboards settings schema details
`opensearch-settings`	object	no	OpenSearch-specific settings schema details
`plan`	string	no	Subscription plan
`termination-protection`	boolean	no	Service is protected against termination and powering off
`version`	string	no	Version

Example

{
  "index-patterns": [
    {
      "max-index-count": 0,
      "pattern": "string",
      "sorting-algorithm": "alphabetical"
    }
  ],
  "index-template": {
    "mapping-nested-objects-limit": 0,
    "number-of-replicas": 0,
    "number-of-shards": 0
  },
  "ip-filter": [
    "string"
  ],
  "keep-index-refresh-interval": true,
  "maintenance": {
    "dow": "saturday",
    "time": "string"
  },
  "max-index-count": 0,
  "opensearch-dashboards": {
    "enabled": true,
    "max-old-space-size": 0,
    "opensearch-request-timeout": 0
  },
  "opensearch-settings": {
    "action_auto_create_index_enabled": true,
    "action_destructive_requires_name": true,
    "auth_failure_listeners": {
      "internal_authentication_backend_limiting": {
        "allowed_tries": 0,
        "authentication_backend": "internal",
        "block_expiry_seconds": 0,
        "max_blocked_clients": 0,
        "max_tracked_clients": 0,
        "time_window_seconds": 0,
        "type": "username"
      },
      "ip_rate_limiting": {
        "allowed_tries": 0,
        "block_expiry_seconds": 0,
        "max_blocked_clients": 0,
        "max_tracked_clients": 0,
        "time_window_seconds": 0,
        "type": "ip"
      }
    },
    "cluster_max_shards_per_node": 0,
    "cluster_routing_allocation_node_concurrent_recoveries": 0,
    "email-sender": {
      "email_sender_name": "alert-sender",
      "email_sender_password": "very-secure-mail-password",
      "email_sender_username": "jane@example.com"
    },
    "enable_security_audit": true,
    "http_max_content_length": 0,
    "http_max_header_size": 0,
    "http_max_initial_line_length": 0,
    "indices_fielddata_cache_size": 0,
    "indices_memory_index_buffer_size": 0,
    "indices_memory_max_index_buffer_size": 0,
    "indices_memory_min_index_buffer_size": 0,
    "indices_queries_cache_size": 0,
    "indices_query_bool_max_clause_count": 0,
    "indices_recovery_max_bytes_per_sec": 0,
    "indices_recovery_max_concurrent_file_chunks": 0,
    "ism-history": {
      "ism_enabled": true,
      "ism_history_enabled": true,
      "ism_history_max_age": 0,
      "ism_history_max_docs": 0,
      "ism_history_rollover_check_period": 0,
      "ism_history_rollover_retention_period": 0
    },
    "knn_memory_circuit_breaker_enabled": true,
    "knn_memory_circuit_breaker_limit": 0,
    "override_main_response_version": true,
    "plugins_alerting_filter_by_backend_roles": true,
    "reindex_remote_whitelist": [
      "anotherservice.aivencloud.com:12398"
    ],
    "script_max_compilations_rate": "75/5m",
    "search_backpressure": {
      "mode": "monitor_only",
      "node_duress": {
        "cpu_threshold": 0,
        "heap_threshold": 0,
        "num_successive_breaches": 0
      },
      "search_shard_task": {
        "cancellation_burst": 0,
        "cancellation_rate": 0,
        "cancellation_ratio": 0,
        "cpu_time_millis_threshold": 0,
        "elapsed_time_millis_threshold": 0,
        "heap_moving_average_window_size": 0,
        "heap_percent_threshold": 0,
        "heap_variance": 0,
        "total_heap_percent_threshold": 0
      },
      "search_task": {
        "cancellation_burst": 0,
        "cancellation_rate": 0,
        "cancellation_ratio": 0,
        "cpu_time_millis_threshold": 0,
        "elapsed_time_millis_threshold": 0,
        "heap_moving_average_window_size": 0,
        "heap_percent_threshold": 0,
        "heap_variance": 0,
        "total_heap_percent_threshold": 0
      }
    },
    "search_max_buckets": 0,
    "shard_indexing_pressure": {
      "enabled": true,
      "enforced": true,
      "operating_factor": {
        "lower": 0,
        "optimal": 0,
        "upper": 0
      },
      "primary_parameter": {
        "node": {
          "soft_limit": 0
        },
        "shard": {
          "min_limit": 0
        }
      }
    },
    "thread_pool_analyze_queue_size": 0,
    "thread_pool_analyze_size": 0,
    "thread_pool_force_merge_size": 0,
    "thread_pool_get_queue_size": 0,
    "thread_pool_get_size": 0,
    "thread_pool_search_queue_size": 0,
    "thread_pool_search_size": 0,
    "thread_pool_search_throttled_queue_size": 0,
    "thread_pool_search_throttled_size": 0,
    "thread_pool_write_queue_size": 0,
    "thread_pool_write_size": 0
  },
  "plan": "string",
  "termination-protection": true,
  "version": "string"
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	object	Related resource reference schema details
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

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	Description
`name`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	object	Related resource reference schema details
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

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	Description
`name`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	object	Related resource reference schema details
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

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

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`settings`	object	schema details

Example output

{
  "settings": {
    "opensearch": {
      "additionalProperties": true,
      "properties": {},
      "title": "string",
      "type": "string"
    }
  }
}

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

CLI: exo api get-dbaas-settings-opensearch

Last updated on January 28, 2026