Domains /
List subdomain paths
Required permission
Account > SubdomainPaths > General > Read
Path parameters
domain
string requiredName of the domain
subdomain
string requiredName of the subdomain
Response body
- {object}
Response object.
data
{object} requiredResult data.
paths
[array] requiredA list of paths created for the given subdomain.
- {object}
Details about a subdomain path.
subdomain
string requiredThe domain the path should be created for.
pattern^((www(\.[a-zA-Z0-9\-]{2,})+\.)?[a-zA-Z0-9\-]{2,})(\.([a-zA-Z0-9\-]{2,}))+$mode
string requiredMode of the path, determining how the URI will be interpreted.
one ofprefix, exact, regexuri
string requiredURI of the subdomain path. Interpreted according to the selected path mode
options
{object}priority
integerIn case of uri conflicts, the route with the higher priority will take precedence
min0max100ignoreUriCase
booleanAllows 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 requiredpattern^\/([a-zA-Z0-9-&?=.]*)((\/[a-zA-Z0-9-&?=.]+)*(\/)?)?$- {object}
Rewrite with regex
regex
{object}match
string requiredRegex match for the given path
rewrite
string requiredRegex rewrite for the given matched path
timeout
stringCustomised request timeout for the given path.
pattern^[1-9][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]- stringpattern^[a-zA-Z0-9_\-%$+]+$
response
{object}set
{object}add
{object}remove
[array]- stringpattern^[a-zA-Z0-9_\-%$+]+$
corsPolicy
{object}Settings allowing for customization of CORS policies.
enabled
boolean requiredallowOrigins
[array]- {object}
mode
string requiredMode of the path, determining how the URI will be interpreted.
one ofprefix, exact, regexorigin
stringOrigin definition.
allowMethods
[array]- stringone ofGET, POST, PUT, PATCH, DELETE, OPTIONS, TRACE, CONNECT, HEAD
allowCredentials
booleanallowHeaders
[array]- string
maxAge
stringpattern^[1-9][0-9]*(s|m|h)$retries
{object}Settings allowing for customization of retries.
enabled
boolean requiredattempts
integer requiredmin1max3perTryTimeout
stringpattern^[1-9][0-9]*(s|ms)$name
stringThe full URL including subdomain and path URI.
createdAt
stringtime of creation
pagination
{object} requiredData about the endpoint pagination.
hasNextPage
boolean requiredIs there another page of results available?
cursor
stringThe cursor to access the next page of results.
count
number requiredThe number of results returned by this request.
OR
GET /v1/domains/{domain}/subdomains/{subdomain}/paths
Example response
200 OK
JSON
{
"data": {
"paths": [
{
"subdomain": "site.example.com",
"mode": "prefix",
"uri": "/",
"options": {
"priority": 0,
"corsPolicy": {
"allowOrigins": [
{
"mode": "prefix",
"origin": "https://example.com"
}
]
}
}
}
]
},
"pagination": {
"hasNextPage": false,
"count": 1
}
}