Team / Domains /

Update geo routing configuration

Updates the geo routing configuration for a geo-routed subdomain.

Required permission

Account > Networking > Subdomains > Update

Path parameters

domain
string required
Name of the domain
subdomain
string required
Name of the subdomain

Request body

{object}

geoRouting
{object} required
The geo routing configuration fields to update.

strategy
string
The geo routing strategy.
one of
continent, closest
rules
[array]

{object}

continents
[array]
Continent codes this rule covers (for continent strategy)

string
one of
NA, SA, EU, AF, AS, OC, AN

backend
{object} required

id
string required
Backend reference in format {projectInternalId}/{serviceInternalId}
pattern
^[a-zA-Z0-9-]+\/[a-zA-Z0-9-]+$
port
string required
Port name on the backend service

defaultBackend
{object}

id
string required
Backend reference in format {projectInternalId}/{serviceInternalId}
pattern
^[a-zA-Z0-9-]+\/[a-zA-Z0-9-]+$
port
string required
Port name on the backend service

Response body

{object}
Response object.

data
{object} required
Result data.

API

CLI

JS Client

PATCH /v1/domains/{domain}/subdomains/{subdomain}/geo-routing

PATCH /v1/teams/{teamId}/domains/{domain}/subdomains/{subdomain}/geo-routing

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request PATCH \
  --data '{"geoRouting":{"rules":[{"backend":{"id":"my-project/my-service","port":"http"}}],"defaultBackend":{"id":"my-project/my-service","port":"http"}}}' \
  https://api.northflank.com/v1/domains/{domain}/subdomains/{subdomain}/geo-routing

Example response

200 OK

The operation was performed successfully.

JSON

{
  "data": {}
}