🎉 Try the public beta of the new docs site at algolia.com/doc-beta! 🎉
Tools / Crawler / APIs / Configuration
Type: Record<string, Record<string, string>>;
Parameter syntax
pathAliases: {
  'dev.example.com': {
    '/foo': '/bar'
  }
}

About this parameter

Defines mappings to replace a path in a hostname.

Sometimes URLs are found through multiple names or are accessible from a different entrypoint depending on the environment. The pathAliases setting transforms a path to a different path before crawling it.

For example, if you create a mapping for { "dev.example.com": { '/foo': '/bar' } } and the crawler encounters https://dev.example.com/foo/hello/, it is transformed to https://dev.example.com/bar/hello/.

See hostnameAliases to check conditions.

Examples

1
2
3
4
5
6
7
{
  pathAliases: {
    'dev.example.com': {
      '/foo': '/bar'
    }
  }
}
Did you find this page helpful?