Set extra header

Required API Key: no ACL required

Method signature

$config = \Algolia\AlgoliaSearch\Config\SearchConfig::create('YourApplicationID', 'YourWriteAPIKey');
$config->setDefaultHeaders([
  headerName => string headerValue
]);
$client = \Algolia\AlgoliaSearch\SearchClient::createWithConfig($config);

config = Algolia::Search::Config.create('YourApplicationID', 'YourWriteAPIKey')
config.set_extra_header(String headerName, String headerValue)
client = Algolia::Search::Client.create_with_config(config)

algoliasearch('YourApplicationID', 'YourWriteAPIKey', {
  headers: {
    headerName: string headerValue
  }
})

config = SearchConfig('YourApplicationID', 'YourWriteAPIKey')
config.headers[headerName] = str headerValue
client = SearchClient.create_with_config(config)

let configuration = SearchConfiguration(applicationID: "YourApplicationID", apiKey: "YourWriteAPIKey")
  .set(\.defaultHeaders, to: [headerName: headerValue]: [HTTPHeaderKey: String]?)

data class ConfigurationSearch(
    val applicationID: ApplicationID,
    val apiKey: APIKey,
    val defaultHeaders: MutableMap<String, String> = mutableMapOf()
) : Configuration

var configuration = new SearchConfig(
  "YourApplicationID",
  "YourWriteAPIKey"
)
{
    DefaultHeaders = new Dictionary<string, string>
    {
      { String headerName, String headerValue }
    }
};
SearchClient client = new SearchClient(configuration);

SearchConfig configuration =
    new SearchConfig.Builder("YourApplicationID", "YourWriteAPIKey")
      .addExtraHeaders(String headerName,  String headerValue)
      .build();

search.NewClientWithConfig(search.Configuration{
  AppID: "YourApplicationID",
  APIKey: "YourWriteAPIKey",
  Headers: map[string]string{
    string headerName: string headerValue,
  },
})

new AlgoliaClient(
  "YourApplicationID",
  "YourWriteAPIKey",
  customHeader = Map(
    headerName -> String headerValue
  )
)

See code examples

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

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

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

About this method

Send an extra HTTP header to Algolia for use with later queries.

This method allows you to send the server a specific key-value pair (an extra HTTP header) with every query. By doing this, you are giving the API an additional header that it can be used in situations such as:

Setting X-Forwarded-For for analytics. If your server sends the end user’s IP along with every search, analytics can distinguish between users. Otherwise, analytics uses the server’s IP address, which doesn’t provide user details. Alternatively, see the followingX-Algolia-UserToken example.
Setting X-Algolia-UserToken for analytics. The Analytics API uses the provided value to distinguish between users. It takes priority over any value in X-Forwarded-For. Use this header if you need to forward the end user’s identity without relying on IP addresses.
Setting X-Algolia-UserToken for API key rate limiting.
Setting X-Forwarded-For to ensure that geo-search locations use the user’s IP address, not your backend server’s. For an example of this, see the aroundLatLngViaIP parameter.

The set extra header method will eventually be replaced by the requestOptions parameter, allowing you to set the header as part of your query parameters.

Examples

Read the Algolia CLI documentation for more information.

Copy

1
2
3
4
5
6
$config = \Algolia\AlgoliaSearch\Config\SearchConfig::create('YourApplicationID', 'YourWriteAPIKey');
$config->setDefaultHeaders([
  'headerName' => 'headerValue'
]);

$client = \Algolia\AlgoliaSearch\SearchClient::createWithConfig($config);

1
2
3
4
config = SearchConfig('YourApplicationID', 'YourWriteAPIKey')
config.headers['NAME-OF-HEADER'] = 'value-of-header'

client = SearchClient.create_with_config(config)

1
2
3
4
let configuration = SearchConfiguration(applicationID: "YourApplicationID", apiKey: "YourWriteAPIKey")
  .set(\.defaultHeaders, to: ["NAME-OF-HEADER": "value-of-header"])

let client = SearchClient(configuration: configuration)

1
2
3
4
5
6
val configuration = ConfigurationSearch(
    applicationID = ApplicationID("YourApplicationID"),
    apiKey = APIKey("YourWriteAPIKey"),
    defaultHeaders = mapOf("NAME-OF-HEADER" to "value-of-header")
)
ClientSearch(configuration)

1
2
3
4
var configuration = new SearchConfig("YourApplicationID", "YourWriteAPIKey");
configuration.DefaultHeaders.Add("NAME-OF-HEADER", "value-of-header");

SearchClient client = new SearchClient(configuration);

1
2
3
4
5
6
SearchConfig configuration =
new SearchConfig.Builder("YourApplicationID", "YourWriteAPIKey")
  .addExtraHeaders("NAME-OF-HEADER", "value-of-header")
  .build();

SearchClient client = DefaultSearchClient.create(configuration);

1
2
3
4
5
6
7
8
9
config := search.Configuration{
  AppID:  "YourApplicationID",
  APIKey: "YourWriteAPIKey",
  Headers: map[string]string{
    "NAME-OF-HEADER": "value-of-header",
  },
}

client := search.NewClientWithConfig(config)

Parameters

Parameter	Description
`headerName`	type: string Required Name of the header to add.
`headerValue`	type: string Required Value of the header to add.

Response

This method doesn't return a response.

Did you find this page helpful?

Set extra header

About this method

Examples

Parameters

Response

On this page