Team / Domains /

Get subdomain

Gets details about the given subdomain

Required permission

Account > Networking > Subdomains > 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.

recordType
string required
The record type to use for the DNS record to verify the subdomain - always CNAME for subdomains.
name
string required
The subdomain.
fullName
string required
The full domain name with subdomain
content
string required
The content to set the DNS record to
verified
boolean required
Whether the subdomain has been verified successfully and can be used.
loadBalancer
string
Name of the load balancer linked to this subdomain, if any.
certificate
{object}

inProgress
boolean
Whether a certificate is in the process of being generated
expiryDate
string
Expiry date of the current certificate
refreshDare
string
Refresh date of the current certificate

options
{object}
Optional advanced configuration for the subdomain.

tlsMode
string
Desired TLS mode for the subdomain.
one of
default, passthrough
minTlsProtocolVersion
string
Minimum TLS protocol version for the subdomain. Only applicable for non-wildcard subdomains.
one of
TLSV1_1, TLSV1_2, TLSV1_3
autoVerify
boolean
The domain will be automatically verified on creation. Only configurable if the relevant feature flag is enabled for you account.
aliasDomains
[array]
Alias domains which should be routable. Only configurable if the relevant feature flag is enabled for you account.

string

routingMode
string
The routing mode for the subdomain.
one of
paths, geoRouting, loadBalancerSubdomain
geoRouting
{object}
Geo routing configuration. Only present when routingMode is geoRouting.

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} 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

cdn
{object}

northflank
{object}

enabled
boolean
status
string
options
{object}

service
{object}

forceTlsEnableHsts
boolean
hstsDuration
number
HSTS duration. Required when `forceTlsEnableHsts` is `true`.
min
300
staleIfError
boolean
staleIfErrorTtl
number
defaultTtl
number
passThrough
boolean
bypassCredentialedRequests
boolean

logging
{object}

enabled
boolean

http3
{object}

enabled
boolean

websockets
{object}

enabled
boolean

ddosProtection
{object}

enabled
boolean

compression
{object}

enabled
boolean
mode
string
Compression options. Required when `enabled` is `true`.
one of
gzip, brotli

vclSnippets
[array]

{object}

id
string
name
string required
min length
3
max length
39
pattern
^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$
type
string required
one of
init, recv, hash, hit, miss, pass, fetch, error, deliver, log, none
dynamic
string required
one of
0, 1
priority
(multiple options: oneOf)

number

min

max

100

content
string required

cacheSettings
[array]

{object}

id
string
name
string required
min length
3
max length
39
pattern
^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$
action
string
one of
pass, cache, restart
cacheCondition
string
max length
512
staleTtl
number required
ttl
number required

deployedAt
string

API

CLI

JS Client

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

GET /v1/teams/{teamId}/domains/{domain}/subdomains/{subdomain}

Example response

200 OK

Details about the subdomain.

JSON

{
  "data": {
    "recordType": "CNAME",
    "name": "site",
    "fullName": "site.example.com",
    "content": "site.example.com.user-1234.dns.northflank.app",
    "verified": true,
    "loadBalancer": "my-load-balancer",
    "geoRouting": {
      "rules": [
        {
          "backend": {
            "id": "my-project/my-service",
            "port": "http"
          }
        }
      ],
      "defaultBackend": {
        "id": "my-project/my-service",
        "port": "http"
      }
    }
  }
}