How to remove the word ‘api’ from Azure functions url

Question

When you create an Http triggered API, Azure function hosts it on

https://[function-app-name].azurewebsites.net/api/[Route-configured-in-application]

Is there any way of getting rid of the term api from the URL and make it look like:

https://[function-app-name].azurewebsites.net/[Route-configured-in-application]

score 36 · Answer 1 · answered Nov 09 '18 at 18:55

36

The Azure Functions v2 solution is covered in this answer, the http bit needs to be wrapped in an extensions property.

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

answered Nov 09 '18 at 18:55

Denis Pitcher

3,080
1
27
19

Great, it's working for me. thank you very much! @Mayank please mark this as the answer, your answer is not working :( – Le Khiem Sep 09 '19 at 05:45

score 21 · Accepted Answer · edited Aug 29 '18 at 03:49

21

Edit the host.json file and set routePrefix to empty string:

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

edited Aug 29 '18 at 03:49

Nate

698
1
7
18

answered Nov 15 '17 at 16:36

Mayank

908
9
14

Yes, this is correct. Can you please mark this as answer? Thank you! – Fabio Cavalcante Nov 21 '17 at 02:30
It took a few minutes to update for me but this did indeed work. – Nate Aug 28 '18 at 22:56
Here is the host.json reference to read while you wait https://learn.microsoft.com/en-us/azure/azure-functions/functions-host-json#http – Nate Aug 28 '18 at 22:58
10

Answer is now outdated. – Tomislav Markovski Jan 26 '19 at 04:19
For functions v2 see the Answer from Denis to get this working as this answer will not work – lawrencegripper May 02 '19 at 07:29
@TomislavMarkovski -Stating the answer is outdated without providing a solution is also outdated. – BeanFlicker May 31 '23 at 15:44

score 13 · Answer 3 · answered Apr 08 '19 at 05:55

The accepted answer no longer works if you're using version 2 functions, instead you need to put the http settings in an extensions property:

"extensions": {
    "http": {
        "routePrefix": ""
    }
}

You can get caught out looking at the hosts.json reference because if you only look at the http section it shows just the http properties so make sure to check the start of the doc for the top level hosts.json format.

score 7 · Answer 4 · answered Nov 16 '17 at 08:54

You could also leverage the power of Azure Function Proxies for this, which might be better if you want to be explicit about which methods or routes you want to access.

Just create a proxy.json file and add the following piece of JSON to it.

{
  "$schema": "http://json.schemastore.org/proxies",
  "proxies": {
    "myazurefunctionproxy": {
      "matchCondition": {
        "methods": ["GET"],
        "route": "/{slug}"
      },
      "backendUri": "https://%WEBSITE_HOSTNAME%/api/{slug}"
    },
  }
}

This sample will redirect all GET-requests to a route with /api/ prefixed.

How to remove the word ‘api’ from Azure functions url

4 Answers4

Linked