In ZIP format, you can use the following POST endpoint to replace the current configuration of a search interface in its entirety. For example, the following endpoint replaces configuration of the search interface ALL:

POST /gsadmin/v1/cloud/searchInterfaces/All

In JSON format, you can use the following PUT endpoint to replace the current configuration of a search interface in its entirety. For example, the following endpoint replaces configuration of the search interface ALL:

PUT /gsadmin/v1/cloud/searchInterfaces/All

The PUT method can only replace a search interface in its entirety; it cannot replace parts of a search interface. To modify an existing search interface by importing new or modified attributes into it, use the PATCH method.

An error results if you attempt to PUT a search interface with a given name when no search interface with that name currently exists.

The following example illustrates one possible JSON configuration of the search interface ALL:

{
  "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"
    }
  ]
}