Path parameters

• name string Required

  Minimum length is 0, maximum length is 63.

Responses

• 200 application/json

  200

  Hide response attributes Show response attributes object

  • description string

    DbaaS service description

  • max-index-count integer(int64)

    Maximum number of indexes to keep before deleting the oldest one

    Minimum value is 0.

  • updated-at string(date-time)

    Service last update timestamp (ISO 8601)

  • node-count integer(int64)

    Number of service nodes in the active plan

    Minimum value is 0.

  • connection-info object

    Opensearch connection information properties

    Hide connection-info attributes Show connection-info attributes object

    • uri array[string]
    • username string
    • password string
    • dashboard-uri string
  • node-cpu-count integer(int64)

    Number of CPUs for each node

    Minimum value is 0.

  • prometheus-uri object Required

    Prometheus integration URI

    Hide prometheus-uri attributes Show prometheus-uri attributes object

    • host string
    • port integer(int64)

      Minimum value is 0, maximum value is 65535.

  • integrations array[object]

    Service integrations

    Hide integrations attributes Show integrations attributes object

    • description string

      Description of the integration

    • settings object

      Integration settings

    • type string

      Integration type

    • is-enabled boolean

      Whether the integration is enabled or not

    • source string

      Source service name

    • is-active boolean

      Whether the integration is active or not

    • status string

      Integration status

    • id string(uuid)

      Integration id

    • dest string

      Destination service name

  • zone string

    The zone where the service is running

  • node-states array[object]

    State of individual service nodes

    Automatic maintenance settings

    Hide node-states attributes Show node-states attributes object

    • name string Required

      Name of the service node

    • progress-updates array[object]

      Extra information regarding the progress for current state

      Extra information regarding the progress for current state

      Hide progress-updates attributes Show progress-updates attributes object

      • completed boolean Required

        Indicates whether this phase has been completed or not

      • current integer(int64)

        Current progress for this phase. May be missing or null.

        Minimum value is 0.

      • max integer(int64)

        Maximum progress value for this phase. May be missing or null. May change.

        Minimum value is 0.

      • min integer(int64)

        Minimum progress value for this phase. May be missing or null.

        Minimum value is 0.

      • phase string Required

        Key identifying this phase

        Values are stream, basebackup, prepare, or finalize.

      • unit string

        Unit for current/min/max values. New units may be added. If null should be treated as generic unit

    • role string

      Role of this node. Only returned for a subset of service types

      Values are standby, master, or read-replica.

    • state string Required

      Current state of the service node

      Values are leaving, running, syncing_data, setting_up_vm, or unknown.

  • name string Required

    Minimum length is 0, maximum length is 63.

  • 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 Required

    Minimum length is 0, maximum length is 64.

  • state string

    Values are running, rebuilding, rebalancing, or poweroff.

  • ip-filter array[string]

    Allowed CIDR address blocks for incoming connections

  • backups array[object]

    List of backups for the service

    List of backups for the service

    Hide backups attributes Show backups attributes object

    • backup-name string Required

      Internal name of this backup

    • backup-time string(date-time) Required

      Backup timestamp (ISO 8601)

    • data-size integer(int64) Required

      Backup's original size before compression

      Minimum value is 0.

  • termination-protection boolean

    Service is protected against termination and powering off

  • notifications array[object]

    Service notifications

    Service notifications

    Hide notifications attributes Show notifications attributes object

    • level string Required

      Notification level

      Values are warning or notice.

    • message string Required

      Human notification message

      Minimum length is 1, maximum length is 1024.

    • type string Required

      Notification type

      Values are service_powered_off_removal or service_end_of_life.

    • metadata object Required

      Notification type

  • components array[object]

    Service component information objects

    Hide components attributes Show components attributes object

    • component string Required

      Service component name

    • host string Required

      DNS name for connecting to the service component

    • port integer(int64) Required

      Port number for connecting to the service component

      Minimum value is 0, maximum value is 65535.

    • route string Required

      Values are dynamic, private, public, or privatelink.

    • usage string Required

      Values are primary or replica.

  • 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.

    Hide index-patterns attributes Show index-patterns attributes object

    • max-index-count integer(int64)

      Maximum number of indexes to keep

      Minimum value is 0.

    • sorting-algorithm string

      Deletion sorting algorithm

      Values are alphabetical or creation_date.

    • pattern string

      fnmatch pattern

      Maximum length is 1024.

  • maintenance object

    Automatic maintenance settings

    Hide maintenance attributes Show maintenance attributes object

    • dow string Required

      Day of week for installing updates

      Values are saturday, tuesday, never, wednesday, sunday, friday, monday, or thursday.

    • time string Required

      Time for installing updates, UTC

      Minimum length is 8, maximum length is 8.

    • updates array[object] Required

      List of updates waiting to be installed

      Update waiting to be installed

      Hide updates attributes Show updates attributes object

      • description string

        Description of the update

      • deadline string(date-time)

        Deadline for installing the update

      • start-after string(date-time)

        The earliest time the update will be automatically applied

      • start-at string(date-time)

        The time when the update will be automatically applied

  • index-template object

    Template settings for all new indexes

    Hide index-template attributes Show index-template attributes object

    • mapping-nested-objects-limit integer(int64)

      The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000.

      Minimum value is 0, maximum value is 100000.

    • number-of-replicas integer(int64)

      The number of replicas each primary shard has.

      Minimum value is 0, maximum value is 29.

    • number-of-shards integer(int64)

      The number of primary shards that an index should have.

      Minimum value is 1, maximum value is 1024.

  • disk-size integer(int64)

    TODO UNIT disk space for data storage

    Minimum value is 0.

  • node-memory integer(int64)

    TODO UNIT of memory for each node

    Minimum value is 0.

  • uri string

    URI for connecting to the service (may be absent)

  • opensearch-settings object

    Additional properties are NOT allowed.

    Hide opensearch-settings attributes Show opensearch-settings attributes object

    • thread_pool_search_throttled_size integer

      Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

      Minimum value is 1, maximum value is 128.

    • thread_pool_analyze_size integer

      Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

      Minimum value is 1, maximum value is 128.

    • thread_pool_get_size integer

      Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

      Minimum value is 1, maximum value is 128.

    • thread_pool_get_queue_size integer

      Size for the thread pool queue. See documentation for exact details.

      Minimum value is 10, maximum value is 2000.

    • indices_memory_max_index_buffer_size integer

      Absolute value. Default is unbound. Doesn't work without indices.memory.index_buffer_size. Maximum amount of heap used for query cache, an absolute indices.memory.index_buffer_size maximum hard limit.

      Minimum value is 3, maximum value is 2048.

    • indices_recovery_max_concurrent_file_chunks integer

      Number of file chunks sent in parallel for each recovery. Defaults to 2.

      Minimum value is 2, maximum value is 5.

    • indices_queries_cache_size integer

      Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality.

      Minimum value is 3, maximum value is 40.

    • search_backpressure object

      Additional properties are NOT allowed.

      Hide search_backpressure attributes Show search_backpressure attributes object

      • mode string

        The search backpressure mode. Valid values are monitor_only, enforced, or disabled. Default is monitor_only

        Values are monitor_only, enforced, or disabled.

      • node_duress object

        Additional properties are NOT allowed.

        Hide node_duress attributes Show node_duress attributes object

        • cpu_threshold number

          The CPU usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.9

          Minimum value is 0.0, maximum value is 1.0.

        • heap_threshold number

          The heap usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.7

          Minimum value is 0.0, maximum value is 1.0.

        • num_successive_breaches integer

          The number of successive limit breaches after which the node is considered to be under duress. Default is 3

          Minimum value is 1.

      • search_shard_task object

        Additional properties are NOT allowed.

        Hide search_shard_task attributes Show search_shard_task attributes object

        • total_heap_percent_threshold number

          The heap usage threshold (as a percentage) required for the sum of heap usages of all search shard tasks before cancellation is applied. Default is 0.5

          Minimum value is 0.0, maximum value is 1.0.

        • elapsed_time_millis_threshold integer

          The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 30000

          Minimum value is 0.

        • cancellation_rate number

          The maximum number of tasks to cancel per millisecond of elapsed time. Default is 0.003

          Minimum value is 0.0.

        • heap_variance number

          The minimum variance required for a single search shard task’s heap usage compared to the rolling average of previously completed tasks before it is considered for cancellation. Default is 2.0

          Minimum value is 0.0.

        • heap_moving_average_window_size integer

          The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage. Default is 100

          Minimum value is 0.

        • cancellation_ratio number

          The maximum number of tasks to cancel, as a percentage of successful task completions. Default is 0.1

          Minimum value is 0.0, maximum value is 1.0.

        • heap_percent_threshold number

          The heap usage threshold (as a percentage) required for a single search shard task before it is considered for cancellation. Default is 0.5

          Minimum value is 0.0, maximum value is 1.0.

        • cpu_time_millis_threshold integer

          The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 15000

          Minimum value is 0.

        • cancellation_burst number

          The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 10.0

          Minimum value is 1.0.

      • search_task object

        Additional properties are NOT allowed.

        Hide search_task attributes Show search_task attributes object

        • total_heap_percent_threshold number

          The heap usage threshold (as a percentage) required for the sum of heap usages of all search tasks before cancellation is applied. Default is 0.5

          Minimum value is 0.0, maximum value is 1.0.

        • elapsed_time_millis_threshold integer

          The elapsed time threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 45000

          Minimum value is 0.

        • cancellation_rate number

          The maximum number of search tasks to cancel per millisecond of elapsed time. Default is 0.003

          Minimum value is 0.0.

        • heap_variance number

          The heap usage variance required for an individual parent task before it is considered for cancellation. A task is considered for cancellation when taskHeapUsage is greater than or equal to heapUsageMovingAverage * variance. Default is 2.0

          Minimum value is 0.0.

        • heap_moving_average_window_size integer

          The window size used to calculate the rolling average of the heap usage for the completed parent tasks. Default is 10

          Minimum value is 0.

        • cancellation_ratio number

          The maximum number of search tasks to cancel, as a percentage of successful search task completions. Default is 0.1

          Minimum value is 0.0, maximum value is 1.0.

        • heap_percent_threshold number

          The heap usage threshold (as a percentage) required for an individual parent task before it is considered for cancellation. Default is 0.2

          Minimum value is 0.0, maximum value is 1.0.

        • cpu_time_millis_threshold integer

          The CPU usage threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 30000

          Minimum value is 0.

        • cancellation_burst number

          The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 5.0

          Minimum value is 1.0.

    • shard_indexing_pressure object

      Additional properties are NOT allowed.

      Hide shard_indexing_pressure attributes Show shard_indexing_pressure attributes object

      • primary_parameter object

        Additional properties are NOT allowed.

        Hide primary_parameter attributes Show primary_parameter attributes object

        • shard object

          Additional properties are NOT allowed.

          Hide shard attribute Show shard attribute object

          • min_limit number

            Specify the minimum assigned quota for a new shard in any role (coordinator, primary, or replica). Shard indexing backpressure increases or decreases this allocated quota based on the inflow of traffic for the shard. Default is 0.001

            Minimum value is 0.0.

        • node object

          Additional properties are NOT allowed.

          Hide node attribute Show node attribute object

          • soft_limit number

            Define the percentage of the node-level memory threshold that acts as a soft indicator for strain on a node. Default is 0.7

            Minimum value is 0.0.

      • operating_factor object

        Additional properties are NOT allowed.

        Hide operating_factor attributes Show operating_factor attributes object

        • upper number

          Specify the upper occupancy limit of the allocated quota of memory for the shard. If the total memory usage of a shard is above this limit, shard indexing backpressure increases the current allocated memory for that shard. Default is 0.95

          Minimum value is 0.0.

        • optimal number

          Specify the optimal occupancy of the allocated quota of memory for the shard. If the total memory usage of a shard is at this level, shard indexing backpressure doesn’t change the current allocated memory for that shard. Default is 0.85

          Minimum value is 0.0.

        • lower number

          Specify the lower occupancy limit of the allocated quota of memory for the shard. If the total memory usage of a shard is below this limit, shard indexing backpressure decreases the current allocated memory for that shard. Default is 0.75

          Minimum value is 0.0.

      • enforced boolean

        Run shard indexing backpressure in shadow mode or enforced mode. In shadow mode (value set as false), shard indexing backpressure tracks all granular-level metrics, but it doesn’t actually reject any indexing requests. In enforced mode (value set as true), shard indexing backpressure rejects any requests to the cluster that might cause a dip in its performance. Default is false

      • enabled boolean

        Enable or disable shard indexing backpressure. Default is false

    • knn_memory_circuit_breaker_enabled boolean

      Enable or disable KNN memory circuit breaker. Defaults to true.

    • thread_pool_search_size integer

      Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

      Minimum value is 1, maximum value is 128.

    • indices_memory_min_index_buffer_size integer

      Absolute value. Default is 48mb. Doesn't work without indices.memory.index_buffer_size. Minimum amount of heap used for query cache, an absolute indices.memory.index_buffer_size minimal hard limit.

      Minimum value is 3, maximum value is 2048.

    • indices_recovery_max_bytes_per_sec integer

      Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb

      Minimum value is 40, maximum value is 400.

    • http_max_initial_line_length integer

      The max length of an HTTP URL, in bytes

      Minimum value is 1024, maximum value is 65536.

    • enable_security_audit boolean

      Default value is false.

    • thread_pool_write_queue_size integer

      Size for the thread pool queue. See documentation for exact details.

      Minimum value is 10, maximum value is 2000.

    • script_max_compilations_rate string

      Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context

      Maximum length is 1024.

    • search_max_buckets integer | null

      Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined.

      Minimum value is 1, maximum value is 1000000.

    • reindex_remote_whitelist array[string | null] | null

      Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.

      Not more than 32 elements. Maximum length of each is 261.

    • override_main_response_version boolean

      Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false

    • http_max_header_size integer

      The max size of allowed headers, in bytes

      Minimum value is 1024, maximum value is 262144.

    • email-sender object
      Hide email-sender attributes Show email-sender attributes object

      • email_sender_name string Required

        This should be identical to the Sender name defined in Opensearch dashboards

        Maximum length is 40. Format should match the following pattern: ^[a-zA-Z0-9-_]+$.

      • email_sender_password string Required

        Sender password for Opensearch alerts to authenticate with SMTP server

        Maximum length is 1024. Format should match the following pattern: ^[^\x00-\x1F]+$.

      • email_sender_username string Required

        Maximum length is 320. Format should match the following pattern: ^[^\x00-\x1F]+$.

    • indices_fielddata_cache_size integer | null

      Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.

      Minimum value is 3, maximum value is 100.

    • action_destructive_requires_name boolean | null
    • plugins_alerting_filter_by_backend_roles boolean

      Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false

    • indices_memory_index_buffer_size integer

      Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.

      Minimum value is 3, maximum value is 40.

    • thread_pool_force_merge_size integer

      Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

      Minimum value is 1, maximum value is 128.

    • auth_failure_listeners object

      Additional properties are NOT allowed.

      Hide auth_failure_listeners attributes Show auth_failure_listeners attributes object

      • internal_authentication_backend_limiting object

        Additional properties are NOT allowed.

        Hide internal_authentication_backend_limiting attributes Show internal_authentication_backend_limiting attributes object

        • allowed_tries integer

          The number of login attempts allowed before login is blocked

          Minimum value is 0, maximum value is 2147483647.

        • authentication_backend string

          The internal backend. Enter internal

          Maximum length is 1024. Value is internal.

        • block_expiry_seconds integer

          The duration of time that login remains blocked after a failed login

          Minimum value is 0, maximum value is 2147483647.

        • max_blocked_clients integer

          The maximum number of blocked IP addresses

          Minimum value is 0, maximum value is 2147483647.

        • max_tracked_clients integer

          The maximum number of tracked IP addresses that have failed login

          Minimum value is 0, maximum value is 2147483647.

        • time_window_seconds integer

          The window of time in which the value for allowed_tries is enforced

          Minimum value is 0, maximum value is 2147483647.

        • type string

          The type of rate limiting

          Maximum length is 1024. Value is username.

      • ip_rate_limiting object

        Additional properties are NOT allowed.

        Hide ip_rate_limiting attributes Show ip_rate_limiting attributes object

        • allowed_tries integer

          The number of login attempts allowed before login is blocked

          Minimum value is 1, maximum value is 2147483647.

        • block_expiry_seconds integer

          The duration of time that login remains blocked after a failed login

          Minimum value is 1, maximum value is 36000.

        • max_blocked_clients integer

          The maximum number of blocked IP addresses

          Minimum value is 0, maximum value is 2147483647.

        • max_tracked_clients integer

          The maximum number of tracked IP addresses that have failed login

          Minimum value is 0, maximum value is 2147483647.

        • time_window_seconds integer

          The window of time in which the value for allowed_tries is enforced

          Minimum value is 1, maximum value is 36000.

        • type string

          The type of rate limiting

          Maximum length is 1024. Value is ip.

    • ism-history object
      Hide ism-history attributes Show ism-history attributes object

      • ism_enabled boolean Required

        Default value is true.

      • ism_history_enabled boolean

        Default value is true.

      • ism_history_max_age integer

        Minimum value is 1, maximum value is 2147483647. Default value is 24.

      • ism_history_max_docs integer

        Minimum value is 1, maximum value is 9223372036854775807. Default value is 2500000.

      • ism_history_rollover_check_period integer

        Minimum value is 1, maximum value is 2147483647. Default value is 8.

      • ism_history_rollover_retention_period integer

        Minimum value is 1, maximum value is 2147483647. Default value is 30.

    • cluster_routing_allocation_node_concurrent_recoveries integer

      How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to 2.

      Minimum value is 2, maximum value is 16.

    • thread_pool_analyze_queue_size integer

      Size for the thread pool queue. See documentation for exact details.

      Minimum value is 10, maximum value is 2000.

    • action_auto_create_index_enabled boolean

      Explicitly allow or block automatic creation of indices. Defaults to true

    • http_max_content_length integer

      Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.

      Minimum value is 1, maximum value is 2147483647.

    • thread_pool_write_size integer

      Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

      Minimum value is 1, maximum value is 128.

    • thread_pool_search_queue_size integer

      Size for the thread pool queue. See documentation for exact details.

      Minimum value is 10, maximum value is 2000.

    • knn_memory_circuit_breaker_limit integer

      Maximum amount of memory that can be used for KNN index. Defaults to 50% of the JVM heap size.

      Minimum value is 3, maximum value is 100.

    • indices_query_bool_max_clause_count integer

      Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.

      Minimum value is 64, maximum value is 4096.

    • thread_pool_search_throttled_queue_size integer

      Size for the thread pool queue. See documentation for exact details.

      Minimum value is 10, maximum value is 2000.

    • cluster_max_shards_per_node integer

      Controls the number of shards allowed in the cluster per data node

      Minimum value is 100, maximum value is 10000.

  • uri-params object

    service_uri parameterized into key-value pairs

  • version string

    OpenSearch version

  • created-at string(date-time)

    Service creation timestamp (ISO 8601)

  • plan string Required

    Subscription plan

  • opensearch-dashboards object

    OpenSearch Dashboards settings

    Hide opensearch-dashboards attributes Show opensearch-dashboards attributes object

    • opensearch-request-timeout integer(int64)

      Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch (default: 30000)

      Minimum value is 5000, maximum value is 120000.

    • enabled boolean

      Enable or disable OpenSearch Dashboards (default: true)

    • max-old-space-size integer(int64)

      Limits the maximum amount of memory (in MiB) the OpenSearch Dashboards process can use. This sets the max_old_space_size option of the nodejs running the OpenSearch Dashboards. Note: the memory reserved by OpenSearch Dashboards is not available for OpenSearch. (default: 128)

      Minimum value is 64, maximum value is 1024.

  • users array[object]

    List of service users

    Hide users attributes Show users attributes object

    • type string
    • username string
    • password string