Cloudflare API | Hostnames › Settings › TLS › Edit TLS Setting For Hostname

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Delete TLS setting for hostname

List TLS setting for hostnames

Edit TLS setting for hostname

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Network Monitoring

Observability

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Content Scanning

Leaked Credential Checks

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Durable Objects

Workers For Platforms

Shared

Hostnames

hostnames

Settings

hostnames.settings

Hostnames Settings

TLS

hostnames.settings.tls

Methods

Delete TLS Setting For Hostname -> Envelope<{ created_at, hostname, status, 2 more... }>

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

Delete the tls setting value for the hostname.

List TLS Setting For Hostnames -> Envelope<Array<{ created_at, hostname, status, 2 more... }>>

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

List the requested TLS setting for the hostnames under this zone.

Edit TLS Setting For Hostname -> Envelope<

>

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

Update the tls setting value for the hostname.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example: X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example: X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

SSL and Certificates Write

Parameters

zone_id: string

Identifier

setting_id:

The TLS Setting name.

"ciphers"

"min_tls_version"

"http2"

hostname: string

The hostname for which the tls settings are set.

Response fields

errors: Array<

>

messages: Array<

>

success: true

Whether the API call was successful

result:

Optional

Request example

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/hostnames/settings/$SETTING_ID/$HOSTNAME \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
      "value": [
        "ECDHE-RSA-AES128-GCM-SHA256",
        "AES128-GCM-SHA256"
      ]
    }'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "success": true,
  "result": {
    "created_at": "2023-07-10T20:01:50.219171Z",
    "hostname": "app.example.com",
    "status": "pending_deployment",
    "updated_at": "2023-07-10T20:01:50.219171Z",
    "value": [
      "ECDHE-RSA-AES128-GCM-SHA256",
      "AES128-GCM-SHA256"
    ]
  }
}

Domain types

Setting = { created_at, hostname, status, 2 more... }

SettingValue = number | string | Array<string>