API Reference / API Methods / Settings / Copy settings

Copy Settings

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

About this method

You are currently reading the documentation of the JavaScript API Client v4. Read our migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

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?