Skip to content

Commit fa43b90

Browse files
Adjust related content for custom ciphers via API
1 parent cc3f316 commit fa43b90

File tree

2 files changed

+18
-34
lines changed

2 files changed

+18
-34
lines changed

src/content/docs/ssl/edge-certificates/additional-options/cipher-suites/customize-cipher-suites/api.mdx

Lines changed: 13 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ Note that:
2525
* If setting up a per-hostname cipher suite customization, make sure that the hostname is specified on the certificate (instead of being covered by a wildcard).
2626
* If you use Windows you might need to adjust the `curl` syntax, refer to [Making API calls on Windows](/fundamentals/api/how-to/make-api-calls/#making-api-calls-on-windows) for further guidance.
2727

28+
:::note
29+
Updating the cipher suites will result in certificates being redeployed.
30+
:::
31+
2832
## Steps and API examples
2933

3034
1. Decide which cipher suites you want to specify and which ones you want to disable (meaning they will not be included in your selection).
@@ -35,19 +39,9 @@ Note that:
3539
3. Get the Zone ID from the [Overview page](https://dash.cloudflare.com/?to=/:account/:zone/) of the domain you want to specify cipher suites for.
3640
4. Make an API call to either the [Edit zone setting](/api/resources/zones/subresources/settings/methods/edit/) endpoint or the [Edit TLS setting for hostname](/api/resources/hostnames/subresources/settings/subresources/tls/methods/update/) endpoint, specifying `ciphers` in the URL. List your array of chosen cipher suites in the `value` field.
3741

38-
:::note
39-
Updating the cipher suites will result in certificates being redeployed.
40-
:::
41-
4242
<Tabs> <TabItem label="modern">
4343

44-
<Render file="ciphers-api-general-notes" />
45-
4644
```bash
47-
# To configure cipher suites per hostname, replace the first two lines by the following
48-
# curl --request PUT \
49-
# "https://api.cloudflare.com/client/v4/zones/{zone_id}/hostnames/settings/ciphers/{hostname}" \
50-
5145
curl --request PATCH \
5246
"https://api.cloudflare.com/client/v4/zones/{zone_id}/settings/ciphers" \
5347
--header "X-Auth-Email: <EMAIL>" \
@@ -67,16 +61,11 @@ curl --request PATCH \
6761
}}
6862
/>
6963

64+
<Render file="ciphers-api-general-notes" />
7065

7166
</TabItem> <TabItem label="compatible">
7267

73-
<Render file="ciphers-api-general-notes" />
74-
7568
```bash
76-
# To configure cipher suites per hostname, replace the first two lines by the following
77-
# curl --request PUT \
78-
# "https://api.cloudflare.com/client/v4/zones/{zone_id}/hostnames/settings/ciphers/{hostname}" \
79-
8069
curl --request PATCH \
8170
"https://api.cloudflare.com/client/v4/zones/{zone_id}/settings/ciphers" \
8271
--header "X-Auth-Email: <EMAIL>" \
@@ -96,15 +85,16 @@ curl --request PATCH \
9685
}}
9786
/>
9887

99-
</TabItem> <TabItem label="pci dss">
10088

10189
<Render file="ciphers-api-general-notes" />
10290

103-
```bash
104-
# To configure cipher suites per hostname, replace the first two lines by the following
105-
# curl --request PUT \
106-
# "https://api.cloudflare.com/client/v4/zones/{zone_id}/hostnames/settings/ciphers/{hostname}" \
91+
</TabItem> <TabItem label="pci dss">
92+
93+
:::note
94+
For compliance with PCI DSS, also [enable TLS 1.3](/ssl/edge-certificates/additional-options/tls-13/#enable-tls-13) on your zone and make sure to up your [Minimum TLS version](/ssl/edge-certificates/additional-options/minimum-tls/) to `1.2`.
95+
:::
10796

97+
```bash
10898
curl --request PATCH \
10999
"https://api.cloudflare.com/client/v4/zones/{zone_id}/settings/ciphers" \
110100
--header "X-Auth-Email: <EMAIL>" \
@@ -124,20 +114,11 @@ curl --request PATCH \
124114
}}
125115
/>
126116

127-
:::caution
128-
129-
For compliance with PCI DSS, also [enable TLS 1.3](/ssl/edge-certificates/additional-options/tls-13/#enable-tls-13) on your zone and make sure to up your [Minimum TLS version](/ssl/edge-certificates/additional-options/minimum-tls/) to `1.2`.
130-
:::
117+
<Render file="ciphers-api-general-notes" />
131118

132119
</TabItem> <TabItem label="fips-140-2">
133120

134-
<Render file="ciphers-api-general-notes" />
135-
136121
```bash
137-
# To configure cipher suites per hostname, replace the first two lines by the following
138-
# curl --request PUT \
139-
# "https://api.cloudflare.com/client/v4/zones/{zone_id}/hostnames/settings/ciphers/{hostname}" \
140-
141122
curl --request PATCH \
142123
"https://api.cloudflare.com/client/v4/zones/{zone_id}/settings/ciphers" \
143124
--header "X-Auth-Email: <EMAIL>" \
@@ -157,6 +138,7 @@ curl --request PATCH \
157138
}}
158139
/>
159140

141+
<Render file="ciphers-api-general-notes" />
160142

161143
</TabItem> </Tabs>
162144

src/content/partials/ssl/ciphers-api-general-notes.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
{}
33

44
---
5+
To configure cipher suites per hostname, replace the first two lines by the following:
56

6-
Make the following API call with the appropriate `{zone_id}`, `<EMAIL>`, and `<API_KEY>`.
7-
8-
If you [choose to use a token](/fundamentals/api/get-started/), you will not need an email nor an API key. You will instead replace the `X-Auth-Email` and `X-Auth-Key` headers by `--header "Authorization: Bearer <API_TOKEN>" \`.
7+
```bash
8+
curl --request PUT \
9+
"https://api.cloudflare.com/client/v4/zones/{zone_id}/hostnames/settings/ciphers/{hostname}" \
10+
```

0 commit comments

Comments
 (0)