Domains /

List subdomain paths

List paths for a given subdomain.

Required permission

Account > SubdomainPaths > General > Read

Path parameters

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

Response body

{object}
Response object.

data
{object} required
Result data.

paths
[array] required
A list of paths created for the given subdomain.

{object}
Details about a subdomain path.

subdomain
(multiple options: oneOf) required
The domain the path should be created for.

string

The domain the path should be created for.

pattern

^((www(\.[a-zA-Z0-9\-]{2,})+\.)?[a-zA-Z0-9\-]{2,})(\.([a-zA-Z0-9\-]{2,}))+$

string

A string containing one or more references that resolve to the domain the path should be created for.

pattern

.*\${.*}.*

mode
(multiple options: oneOf) required
Mode of the path, determining how the URI will be interpreted.

string

Mode of the path, determining how the URI will be interpreted.

one of

prefix, exact, regex

string

A string containing one or more references that resolve to mode of the path, determining how the URI will be interpreted.

pattern

.*\${.*}.*

uri
(multiple options: oneOf) required
URI of the subdomain path. Interpreted according to the selected path mode

string

URI of the subdomain path. Interpreted according to the selected path mode

string

A string containing one or more references that resolve to uRI of the subdomain path. Interpreted according to the selected path mode

pattern

.*\${.*}.*

options
{object}

priority
(multiple options: oneOf)
In case of uri conflicts, the route with the higher priority will take precedence

integer

In case of uri conflicts, the route with the higher priority will take precedence

min

max

100

string

A string containing one or more references that resolve to in case of uri conflicts, the route with the higher priority will take precedence

pattern

.*\${.*}.*

ignoreUriCase
(multiple options: oneOf)
Allows case insensitive matching for 'prefix' and 'exact' modes

boolean

Allows case insensitive matching for 'prefix' and 'exact' modes

string

A string containing one or more references that resolve to allows case insensitive matching for 'prefix' and 'exact' modes

pattern

.*\${.*}.*

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
(multiple options: oneOf) required

string

pattern

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

string

pattern

.*\${.*}.*

{object}

Rewrite with regex

regex
{object}

match
(multiple options: oneOf) required
Regex match for the given path

string

Regex match for the given path

string

A string containing one or more references that resolve to regex match for the given path

pattern

.*\${.*}.*

rewrite
(multiple options: oneOf) required
Regex rewrite for the given matched path

string

Regex rewrite for the given matched path

string

A string containing one or more references that resolve to regex rewrite for the given matched path

pattern

.*\${.*}.*

timeout
(multiple options: oneOf)
Customised request timeout for the given path.

string

Customised request timeout for the given path.

pattern

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

string

A string containing one or more references that resolve to customised request timeout for the given path.

pattern

.*\${.*}.*

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

pagination
{object} required
Data about the endpoint pagination.

hasNextPage
boolean required
Is there another page of results available?
cursor
string
The cursor to access the next page of results.
count
number required
The number of results returned by this request.

API

CLI

JS Client

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

Example response

200 OK

A list of paths for the given subdomain.

JSON

{
  "data": {
    "paths": [
      {
        "subdomain": "site.example.com",
        "mode": "prefix",
        "uri": "/",
        "options": {
          "priority": 0
        }
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}