Edge Functions

Regional Invocations

How to execute an Edge Function in a particular region.

Edge Functions are executed in the region closest to the user making the request. This helps to reduce network latency and provide faster responses to the user.

However, if your Function performs lots of database or storage operations, invoking the Function in the same region as your database may provide better performance. Some situations where this might be helpful include:

  • Bulk adding and editing records in your database
  • Uploading files

There are couple of ways specify the region when invoking the Function.

Use supabase-js client

If you're invoking an Edge Function via supabase-js client, set the region header.

JavaScript
1
2
3
4
5
6
7
8
9
10
11
// https://supabase.com/docs/reference/javascript/installingimport { createClient } from '@supabase/supabase-js@2'// Create a single supabase client for interacting with your databaseconst supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key')// https://supabase.com/docs/reference/javascript/functions-invokeconst { data, error } = await supabase.functions.invoke('hello-world', {  body: { name: 'Functions' },  region: 'eu-west-3',})

Set the x-region header

Use the x-region HTTP header when calling an Edge Function to determine where the Function should be executed:

1
2
3
4
5
6
# https://supabase.com/docs/guides/functions/deploy#invoking-remote-functionscurl --request POST 'https://<project_ref>.supabase.co/functions/v1/hello-world' \  --header 'Authorization: Bearer ANON_KEY' \  --header 'Content-Type: application/json' \  --header 'x-region: eu-west-3' \  --data '{ "name":"Functions" }'

Set the forceFunctionRegion query parameter

In case you cannot add the x-region header to the request (e.g.: CORS requests, Webhooks), you can use forceFunctionRegion query parameter.

1
2
3
4
5
# https://supabase.com/docs/guides/functions/deploy#invoking-remote-functionscurl --request POST 'https://<project_ref>.supabase.co/functions/v1/hello-world?forceFunctionRegion=eu-west-3' \  --header 'Authorization: Bearer ANON_KEY' \  --header 'Content-Type: application/json' \  --data '{ "name":"Functions" }'

You can verify the execution region by looking at the x-sb-edge-region HTTP header in the response. You can also find it as metadata in Edge Function Logs.

Available regions

These are the currently supported region values you can provide for x-region header.

  • ap-northeast-1
  • ap-northeast-2
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • ca-central-1
  • eu-central-1
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • sa-east-1
  • us-east-1
  • us-west-1
  • us-west-2

Using the client library

You can also specify the region when invoking a Function using the Supabase client library:

1
2
3
4
5
6
7
8
9
import { ,  } from '@supabase/supabase-js'const  = ('SUPABASE_URL', 'SUPABASE_ANON_KEY')const { : ,  } = await ..('my-function-name', {  : { 'Content-Type': 'application/json' },  : 'GET',  : {},  : .,})

Handling regional outages

If you explicitly specify the region via x-region header, requests will NOT be automatically re-routed to another region and you should consider temporarily changing regions during the outage.