Skip to content
Start here

Hostnames

HostnamesSettings

HostnamesSettingsTLS

List TLS setting for hostnames
client.Hostnames.Settings.TLS.Get(ctx, settingID, query) (*SinglePage[SettingTLSGetResponse], error)
GET/zones/{zone_id}/hostnames/settings/{setting_id}
Edit TLS setting for hostname
client.Hostnames.Settings.TLS.Update(ctx, settingID, hostname, params) (*Setting, error)
PUT/zones/{zone_id}/hostnames/settings/{setting_id}/{hostname}
Delete TLS setting for hostname
client.Hostnames.Settings.TLS.Delete(ctx, settingID, hostname, body) (*SettingTLSDeleteResponse, error)
DELETE/zones/{zone_id}/hostnames/settings/{setting_id}/{hostname}
ModelsExpand Collapse
type Setting struct{…}
CreatedAt Timeoptional

This is the time the tls setting was originally created for this hostname.

formatdate-time
Hostname stringoptional

The hostname for which the tls settings are set.

Status stringoptional

Deployment status for the given tls setting.

UpdatedAt Timeoptional

This is the time the tls setting was updated.

formatdate-time
Value SettingValueUnionoptional

The TLS setting value. The type depends on the setting_id used in the request path:

  • ciphers: an array of allowed cipher suite strings in BoringSSL format (e.g., ["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"])
  • min_tls_version: a string indicating the minimum TLS version — one of "1.0", "1.1", "1.2", or "1.3" (e.g., "1.2")
  • http2: a string indicating whether HTTP/2 is enabled — "on" or "off" (e.g., "on")
type SettingValueUnion interface{…}

The TLS setting value. The type depends on the setting_id used in the request path:

  • ciphers: an array of allowed cipher suite strings in BoringSSL format (e.g., ["ECDHE-RSA-AES128-GCM-SHA256", "AES128-GCM-SHA256"])
  • min_tls_version: a string indicating the minimum TLS version — one of "1.0", "1.1", "1.2", or "1.3" (e.g., "1.2")
  • http2: a string indicating whether HTTP/2 is enabled — "on" or "off" (e.g., "on")
One of the following:
type SettingValueString string
One of the following:
const SettingValueString1_0 SettingValueString = "1.0"
const SettingValueString1_1 SettingValueString = "1.1"
const SettingValueString1_2 SettingValueString = "1.2"
const SettingValueString1_3 SettingValueString = "1.3"
const SettingValueStringOn SettingValueString = "on"
const SettingValueStringOff SettingValueString = "off"
type SettingValueArray []string

Used when setting_id is ciphers. An array of allowed cipher suite strings.