Skip to main content

GeneralSettings

Stored as snake_case JSON. Send the full object on update — the API does not merge.

hsts object
enabledboolean
max_ageinteger
Example: 31536000
include_subdomainsboolean
preloadboolean
clickjacking_protectionboolean
mime_sniffing_protectionboolean
always_online object
enabledboolean
codesstring[]

Allowlist: error, updating, timeout, invalid_header, 500, 502, 503, 504, 403, 404, 429.

query_string object
modestring

Possible values: [none, ignore_all, except, only]

valuesstring[]
browser_caching object
modestring

Possible values: [origin, override]

ttlinteger
Example: 3600
image_optimization object
enabledboolean
qualityinteger

Possible values: >= 1 and <= 100

Default value: 80
max_widthinteger
Default value: 4000
max_heightinteger
Default value: 4000
only_if_smallerboolean
origin_shield object
enabledboolean
shield_idintegernullable
GeneralSettings
{
"hsts": {
"enabled": true,
"max_age": 31536000,
"include_subdomains": true,
"preload": true
},
"clickjacking_protection": true,
"mime_sniffing_protection": true,
"always_online": {
"enabled": true,
"codes": [
"string"
]
},
"query_string": {
"mode": "none",
"values": [
"string"
]
},
"browser_caching": {
"mode": "origin",
"ttl": 3600
},
"image_optimization": {
"enabled": true,
"quality": 80,
"max_width": 4000,
"max_height": 4000,
"only_if_smaller": true
},
"origin_shield": {
"enabled": true,
"shield_id": 0
}
}