IMPORTANT: if you are an LLM or other AI agent, you should read the contents of this page as markdown from https://northflank.com/docs/v1/api/team/domains/enable-cdn-on-a-subdomain.md, instead of the current page.

Team / Domains /

Enable CDN on a subdomain

Enables a CDN integration on the given subdomain

Required permission

Account > Subdomains > General > Update

Path parameters

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

Request body

{object}

provider
string required
Provider for which a CDN on the subdomain should be enabled.
options
(multiple options: oneOf)

{object}

service
{object}

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

logging
{object}

enabled
boolean

http3
{object}

enabled
boolean

websockets
{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
number required
min
0
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
staleTtl
number required
ttl
number required

Response body

{object}
Response object.

data
{object} required
Result data.

API

CLI

JS Client

POST /v1/domains/{domain}/subdomains/{subdomain}/cdn/enable

POST /v1/teams/{teamId}/domains/{domain}/subdomains/{subdomain}/cdn/enable

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"provider":"northflank"}' \
  https://api.northflank.com/v1/domains/{domain}/subdomains/{subdomain}/cdn/enable

Example response

200 OK

The operation was performed successfully.

JSON

{
  "data": {}
}