API client / Methods / Settings
Required API Key: any key with the editSettings ACL
Method signature
$client->copySettings(
  string indexNameSrc,
  string indexNameDest
);

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

About this method # A

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

The copySettings method removes all current settings of the destination index, and replaces them with the settings from the source index.

If the destination index doesn’t exist, the copySettings method creates it. In that case, the new index has the settings of the source index, but not the records, Rules, or synonyms.

This method does not copy the enableReRanking and mode settings.

To copy more than settings, use the copyIndex method with the appropriate scope parameter.

Examples # A

Copy settings#

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

Parameters # A

Parameter Description
indexNameSrc #
type: string
Required

Name of the source index to copy.

indexNameDest #
type: string
Required

Name of the destination index.

Response # A

This method doesn't return a response.

Did you find this page helpful?
PHP v3