API Reference / API Methods / Manage indices / Index exists

Index Exists

Required API Key: any key with the settings ACL
Method signature
$index->exists()

About this method

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

You are currently reading the Ruby API client v2 documentation. Check our migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

Returns whether an index exists or not.

Algolia lets you instantiate indices with any name, even if they haven’t been previously created. An initialized index is created when you call save objects or set settings on it. This can result in the accidental creation of new indices, or modification of existing ones.

The exists method returns a boolean that indicates whether an initialized index has been created.

You should be careful when using this method to execute code conditionally. Due to the asynchronous nature of saving objects, the existence of an index may change between the time a condition is met, and when the conditional code executes. Be mindful of the surrounding code, and of any process that may be altering your indices.

Examples

Check if an index exists

1
$index->exists();

Parameters

No parameters for this method.

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

This method returns true if the index exists, and false otherwise.

Did you find this page helpful?