Skip to content
Cloudflare API
Start here
API Reference

Hostnames

HostnamesSettings

HostnamesSettingsTLS

List TLS setting for hostnames
client.hostnames.settings.tls.get("ciphers" | "min_tls_version" | "http2"settingID, TLSGetParams { zone_id } params, RequestOptionsoptions?): SinglePage<TLSGetResponse { created_at, hostname, status, 2 more } >
GET/zones/{zone_id}/hostnames/settings/{setting_id}
Edit TLS setting for hostname
client.hostnames.settings.tls.update(stringhostname, TLSUpdateParams { zone_id, setting_id, value } params, RequestOptionsoptions?): Setting { created_at, hostname, status, 2 more }
PUT/zones/{zone_id}/hostnames/settings/{setting_id}/{hostname}
Delete TLS setting for hostname
client.hostnames.settings.tls.delete(stringhostname, TLSDeleteParams { zone_id, setting_id } params, RequestOptionsoptions?): TLSDeleteResponse { created_at, hostname, status, 2 more }
DELETE/zones/{zone_id}/hostnames/settings/{setting_id}/{hostname}
ModelsExpand Collapse
Setting { created_at, hostname, status, 2 more }
created_at?: string

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

formatdate-time
hostname?: string

The hostname for which the tls settings are set.

status?: string

Deployment status for the given tls setting.

updated_at?: string

This is the time the tls setting was updated.

formatdate-time
value?: SettingValue

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").
SettingValue = "1.0" | "1.1" | "1.2" | 3 more | Array<string>

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:
"1.0" | "1.1" | "1.2" | 3 more
"1.0"
"1.1"
"1.2"
"1.3"
"on"
"off"
Array<string>
TLSGetResponse { created_at, hostname, status, 2 more }
created_at?: string

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

formatdate-time
hostname?: string

The hostname for which the tls settings are set.

status?: string

Deployment status for the given tls setting.

updated_at?: string

This is the time the tls setting was updated.

formatdate-time
value?: SettingValue

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").
TLSDeleteResponse { created_at, hostname, status, 2 more }
created_at?: string

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

formatdate-time
hostname?: string

The hostname for which the tls settings are set.

status?: string

Deployment status for the given tls setting.

updated_at?: string

This is the time the tls setting was updated.

formatdate-time
value?: SettingValue

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").