Api clients / JavaScript / V3 / Methods

Copy Settings | JavaScript API Client V3 (Deprecated)

This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.

Required API Key: any key with the settings ACL
Method signature
Not implemented yet.
See how to achieve that in the example section

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

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.

Did you find this page helpful?