Domains /
Get subdomain path
Required permission
Account > SubdomainPaths > General > Read
Path parameters
domain
string requiredName of the domain
subdomain
string requiredName of the subdomain
subdomainPath
string requiredName of the path
Response body
- {object}
Response object.
data
{object} requiredResult data.
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^[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
stringMode of the path, determining how the URI will be interpreted.
one ofprefix, exact, regexpath
stringpattern^\/([a-zA-Z0-9-&?=.]+)*(([a-zA-Z0-9-&?=])+(\/)?)?$allowMethods
[array]- stringone ofGET, POST, PUT, PATCH, DELETE
allowCredentials
booleanallowHeaders
[array]- string
maxAge
stringpattern^[0-9]+(s|ms)$retries
{object}Settings allowing for customization of retries.
enabled
boolean requiredattempts
integer requiredmin1max3perTryTimeout
stringpattern^[0-9]+(s|ms)$name
stringThe full URL including subdomain and path URI.
createdAt
stringtime of creation
assignment
{object}Data about the subdomain path assignment.
project
string requiredThe ID of the service to assign the subdomain path to.
min length3max length39pattern^[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$service
string requiredThe ID of the project the service belongs to.
min length3max length39pattern^[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$port
string requiredThe name of the port that will be assigned to the subdomain path.
OR
GET /v1/domains/{domain}/subdomains/{subdomain}/paths/{subdomainPath}
Example response
200 OK
JSON
{
"data": {
"mode": "prefix",
"uri": "/",
"options": {
"priority": 0
},
"assignment": {
"project": "default-project",
"service": "example-service",
"port": "p01"
}
}
}
Example response
404 Not Found