Restore Text Index

Restores a text index at a previous state.

The Restore Text Index API creates a new text index, using a previous state from an internal backup of one of your text indexes.

Quick Start

Haven OnDemand automatically takes regular backups of the content in your text indexes. It also stores details of the changes that you make made between backups (additions, changes, and deletions). This process means that you can restore your text indexes to any time and date since their creation.

Set the index parameter to the name of the index that you want to restore, and date to the date and time that you want to restore to. Set new_index to the name of a new text index to create with the restored data.

For example, the following request restores an index called myindex, as it was at midnight on June 30th, 2016, to a new index called myrestoredindex.


Note: The preferred date format is ISO 8601:


You must include the time.

Here is a sample response:
  "restored": "myrestoredindex"

Note: The Restore Index API creates a new text index of the same size and flavor as the original index at the backup date and time you specified. Make sure that you have a sufficient quantity of static API Resource Units to accommodate this new index. The size of an index component is determined by the flavor of the text index. For more information about the different flavors, see Index Flavors. For more information about text index quotas, see Rate Limiting, Quotas, Data Expiry, and Maximums.


This API requires an authentication token to be supplied in the following parameter:

Parameter Description
apikey The API key to use to authenticate the API request.

This API accepts the following parameters:

Name Type Description
resource The name of the text index to restore.
new_resource The name of the index to create with the restored data.
string The date and time to restore to, in ISO 8601 format YYYY-MM-DDThh:mm:ss.

This API returns a JSON response that is described by the model below. This single model is presented both as an easy to read abstract definition and as the formal JSON schema.

Asynchronous Use

Additional requests are required to get the result if this API is invoked asynchronously.

You can use /1/job/status/<job-id> to get the status of the job, including results if the job is finished.

You can also use /1/job/result/<job-id>, which waits until the job has finished and then returns the result.

This is an abstract definition of the response that describes each of the properties that might be returned.
Restore Text Index Response {
restored ( string , optional) The name of the index created.
Model Schema
This is a JSON schema that describes the syntax of the response. See for a complete reference.
    "properties": {
        "restored": {
            "type": "string"
    "type": "object"

If you would like to provide us with more information then please use the box below:

We will use your submission to help improve our product.