How to change the base "/api" path on Azure Functions (v2)?

Question

In azure functions we create the function route / name, but it Always preceded by /api

Note that you did not include the /api base path prefix in the route template, as this is handled by a global setting.

But, How to change this base "/api" path ?

truongx · Answer 1 · 2018-09-01T14:59:30.313

31

Accepted answer does not work for v2 anymore (source: Azure-Functions-Host Gitub repo). For v2 you need to wrap http settings inside extensions object. Working host.json example:

{
  "version": "2.0",
  "extensions": {
    "http": {
      "routePrefix": "customPrefix"
    }
  }
}

edited Sep 01 '18 at 14:59

answered Sep 01 '18 at 12:21

truongx

410
4
5

2

Note that the Azure Portal "test" functionality still seems to read the routePrefix from the original spot, so I ended up having to put it in both places... – goofballLogic Sep 18 '18 at 11:39
hi @goofballLogic, your comment saved my day! I kept testing it using portal test feature which throws error 404! How did you update it for Test? i coudn't find the place where i can update. – Preeti Joshi Nov 22 '18 at 10:29
@PreetiJoshi I just manually updated host.json file to have "http" both inside "extensions" and also at the top level – goofballLogic Nov 27 '18 at 14:27

Martin Brandl · Accepted Answer · 2018-09-18T10:59:44.260

4

You are looking for the routePrefix specified in the host.json:

{
  "http": {
    "routePrefix": "whatever"
  }
}

You can set this for example using kudu:

https://<YOURSITE>.scm.azurewebsites.net/DebugConsole/?shell=powershell

Navigate to site -> wwwroot and edit the host.json

Note: This does not work for v2. Please use the answer from truongx instead.

edited Sep 18 '18 at 10:59

answered Mar 19 '18 at 12:22

Martin Brandl

56,134
13
133
172

1

Does not work any more, see https://stackoverflow.com/a/52128045/275501 below from https://stackoverflow.com/users/2171887/truongx instead – goofballLogic Sep 18 '18 at 10:31
@goofballLogic You are right, I edited my answer. Thank you – Martin Brandl Sep 18 '18 at 10:59

How to change the base "/api" path on Azure Functions (v2)?

2 Answers2

Linked