Copy Settings | Ruby API Client V1 (Deprecated)

Deprecated content

This documentation is for a deprecated version of Ruby API client . Some features and settings may be missing or their usage may have changed. Refer to the documentation for the latest version of Ruby API client for up-to-date information.

Required API Key: any key with the editSettings ACL

Method signature

client.copy_settings(
  string indexNameSrc,
  string indexNameDest
)

See code examples

About this method

Copy the settings of an index to another index on the same app.

When creating a new index (for example, a temporary testing index or a new replica), you may need to copy the settings from a source of truth.

Note that this removes all settings currently present in the destination index, and replaces them with the settings from the source.

Examples

Copy settings

Copy

1
$client->copySettings('indexNameSrc', 'indexNameDest');

Parameters

`indexNameSrc`	type: string Required Name of the source index to copy.
`indexNameDest`	type: string Required Name of the destination index.

Response

No response.