TLS

List TLS setting for hostnames

hostnames.settings.tls.get(, ) -> SyncSinglePage[TLSGetResponse]

GET/zones/{zone_id}/hostnames/settings/{setting_id}

Edit TLS setting for hostname

hostnames.settings.tls.update(, ) -> Setting

PUT/zones/{zone_id}/hostnames/settings/{setting_id}/{hostname}

Delete TLS setting for hostname

hostnames.settings.tls.delete(, ) -> TLSDeleteResponse

DELETE/zones/{zone_id}/hostnames/settings/{setting_id}/{hostname}

ModelsExpand Collapse

class Setting: …

created_at: Optional[datetime]

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

formatdate-time

hostname: Optional[str]

The hostname for which the tls settings are set.

status: Optional[str]

Deployment status for the given tls setting.

updated_at: Optional[datetime]

This is the time the tls setting was updated.

formatdate-time

value: Optional[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")

Union[Literal["1.0", "1.1", "1.2", 3 more], List[str]]

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:

Literal["1.0", "1.1", "1.2", 3 more]

One of the following:

"1.0"

"1.1"

"1.2"

"1.3"

"on"

"off"

List[str]

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

class TLSGetResponse: …

created_at: Optional[datetime]

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

formatdate-time

hostname: Optional[str]

The hostname for which the tls settings are set.

status: Optional[str]

Deployment status for the given tls setting.

updated_at: Optional[datetime]

This is the time the tls setting was updated.

formatdate-time

value: Optional[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")

class TLSDeleteResponse: …

created_at: Optional[datetime]

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

formatdate-time

hostname: Optional[str]

The hostname for which the tls settings are set.

status: Optional[str]

Deployment status for the given tls setting.

updated_at: Optional[datetime]

This is the time the tls setting was updated.

formatdate-time

value: Optional[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")