You can export the search interfaces All and TypeAhead in ZIP format or JSON format in order to view them, edit them, or back them up.

After you export these search interfaces, you can modify them to meet your requirements.

To export search interface configuration in ZIP format, use the following endpoint:

GET /gsadmin/v1/cloud/searchInterfaces/searchInterfaceName.zip

To export search interface configuration in JSON format, use the following endpoint:

GET /gsadmin/v1/cloud/searchInterfaces/searchInterfaceName.json

or

GET /gsadmin/v1/cloud/searchInterfaces/searchInterfaceName

Note: The search interface’s name is not included in the JSON that configures the search interface.

The following example illustrates the JSON representation of a search interface named All that can be exported by the endpoints above:

{
    "ecr:lastModifiedBy": "admin",
    "ecr:lastModified": "2016-03-27T13:39:15.486Z",
    "ecr:createDate": "2016-03-27T13:39:15.486Z",
    "ecr:type": "search-interface",
    "crossFieldMatch": "always",
    "fields": [
        {
            "attribute": "product.id"
        },
        {
            "attribute": "product.sku"
        },
        {
            "attribute": "product.code"
        },
        {
            "attribute": "product.brand.name"
        },
        {
            "attribute": "product.category"
        },
        {
            "attribute": "product.name"
        },
        {
            "attribute": "ecr:crossField"
        },
        {
            "attribute": "product.long_desc"
        }
    ]
}

Note: The endpoints GET /gsadmin/v1/cloud/searchInterfaces.zip and GET /gsadmin/v1/cloud/searchInterfaces.json return a list of search interfaces that does not include the full configurations of the individual search interfaces.