Domains /

Add subdomain path

Adds a new path to the subdomain.

Required permission

Account > SubdomainPaths > General > Create

Path parameters

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

Request body

{object}

mode
string required
Mode of the path, determining how the URI will be interpreted.
one of
prefix, exact, regex
uri
string required
URI of the subdomain path. Interpreted according to the selected path mode
options
{object}

priority
integer
In case of uri conflicts, the route with the higher priority will take precedence
min
0
max
100
ignoreUriCase
boolean
Allows case insensitive matching for 'prefix' and 'exact' modes
rewrite
(multiple options: oneOf)
Settings determining if a path should be rewritten. Either a uri or regex have to be specified.

{object}

Rewrite with URI

uri
string required
pattern
^\/([a-zA-Z0-9-&?=.]+)*(([a-zA-Z0-9-&?=])+(\/)?)?$

{object}

Rewrite with regex

regex
{object}

match
string required
Regex match for the given path
rewrite
string required
Regex rewrite for the given matched path

timeout
string
Customised request timeout for the given path.
pattern
^[0-9]+(s|ms)$
headers
{object}
Settings allowing addition, re-write and removal of request as well as response headers.

request
{object}

set
{object}

add
{object}

remove
[array]

string
pattern
^[a-zA-Z0-9_\-%$+]+$

response
{object}

set
{object}

add
{object}

remove
[array]

string
pattern
^[a-zA-Z0-9_\-%$+]+$

corsPolicy
{object}
Settings allowing for customization of CORS policies.

enabled
boolean required
allowOrigins
[array]

{object}

mode
string
Mode of the path, determining how the URI will be interpreted.
one of
prefix, exact, regex
path
string
pattern
^\/([a-zA-Z0-9-&?=.]+)*(([a-zA-Z0-9-&?=])+(\/)?)?$

allowMethods
[array]

string
one of
GET, POST, PUT, PATCH, DELETE

allowCredentials
boolean
allowHeaders
[array]

string

maxAge
string
pattern
^[0-9]+(s|ms)$

retries
{object}
Settings allowing for customization of retries.

enabled
boolean required
attempts
integer required
min
1
max
3
perTryTimeout
string
pattern
^[0-9]+(s|ms)$

Response body

{object}
Response object.

data
{object} required
Result data.

mode
string required
Mode of the path, determining how the URI will be interpreted.
one of
prefix, exact, regex
uri
string required
URI of the subdomain path. Interpreted according to the selected path mode
options
{object}

priority
integer
In case of uri conflicts, the route with the higher priority will take precedence
min
0
max
100
ignoreUriCase
boolean
Allows case insensitive matching for 'prefix' and 'exact' modes
rewrite
(multiple options: oneOf)
Settings determining if a path should be rewritten. Either a uri or regex have to be specified.

{object}

Rewrite with URI

uri
string required
pattern
^\/([a-zA-Z0-9-&?=.]+)*(([a-zA-Z0-9-&?=])+(\/)?)?$

{object}

Rewrite with regex

regex
{object}

match
string required
Regex match for the given path
rewrite
string required
Regex rewrite for the given matched path

timeout
string
Customised request timeout for the given path.
pattern
^[0-9]+(s|ms)$
headers
{object}
Settings allowing addition, re-write and removal of request as well as response headers.

request
{object}

set
{object}

add
{object}

remove
[array]

string
pattern
^[a-zA-Z0-9_\-%$+]+$

response
{object}

set
{object}

add
{object}

remove
[array]

string
pattern
^[a-zA-Z0-9_\-%$+]+$

corsPolicy
{object}
Settings allowing for customization of CORS policies.

enabled
boolean required
allowOrigins
[array]

{object}

mode
string
Mode of the path, determining how the URI will be interpreted.
one of
prefix, exact, regex
path
string
pattern
^\/([a-zA-Z0-9-&?=.]+)*(([a-zA-Z0-9-&?=])+(\/)?)?$

allowMethods
[array]

string
one of
GET, POST, PUT, PATCH, DELETE

allowCredentials
boolean
allowHeaders
[array]

string

maxAge
string
pattern
^[0-9]+(s|ms)$

retries
{object}
Settings allowing for customization of retries.

enabled
boolean required
attempts
integer required
min
1
max
3
perTryTimeout
string
pattern
^[0-9]+(s|ms)$

name
string
The full URL including subdomain and path URI.
createdAt
string
time of creation

API

CLI

JS Client

POST /v1/domains/{domain}/subdomains/{subdomain}/paths

Example request

Request body

curl

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"mode":"prefix","uri":"/","options":{"priority":0}}' \
  https://api.northflank.com/v1/domains/{domain}/subdomains/{subdomain}/paths

Example response

200 OK

Details about the newly added path.

JSON

{
  "data": {
    "mode": "prefix",
    "uri": "/",
    "options": {
      "priority": 0
    }
  }
}

Example response

409 Conflict

The path has already been added to this subdomain.