Skip to content

Commit 06e8cc7

Browse files
Add APIRequest example for getting CH TLS settings
1 parent a414d38 commit 06e8cc7

File tree

1 file changed

+49
-4
lines changed
  • src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management

1 file changed

+49
-4
lines changed

src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/enforce-mtls.mdx

Lines changed: 49 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,17 +42,62 @@ Minimum TLS version exists both as a [zone-level setting](/ssl/edge-certificates
4242

4343
- For custom hostnames created via API, it is possible not to explicitly define a value for `min_tls_version`. When that is the case, whatever value is defined as your zone's minimum TLS version will be applied. To confirm whether a given custom hostname has a specific minimum TLS version set, use the following API call.
4444

45-
<Details header="API example: check custom hostname settings">
45+
<Details header="Check custom hostname settings TLS settings">
4646

47-
In the API documentation, refer to [Custom Hostname Details](/api/resources/custom_hostnames/methods/get/).
47+
<APIRequest
48+
path="/zones/{zone_id}/custom_hostnames/{custom_hostname_id}"
49+
method="GET"
50+
/>
4851

49-
TO-DO: Add APIRequest example
52+
```json title="Response example" collapse={5-16, 21-40} ""settings": {},"
53+
"success": true,
54+
"result": {
55+
"id": "<CUSTOM_HOSTNAME_ID>",
56+
"ssl": {
57+
"id": "<CERTIFICATE_ID>",
58+
"bundle_method": "ubiquitous",
59+
"certificate_authority": "<CERTIFICATE_AUTHORITY>",
60+
"custom_certificate": "",
61+
"custom_csr_id": "",
62+
"custom_key": "",
63+
"expires_on": "",
64+
"hosts": [
65+
"app.example.com",
66+
"*.app.example.com"
67+
],
68+
"issuer": "",
69+
"method": "http",
70+
"settings": {},
71+
"signature": "SHA256WithRSA",
72+
"type": "dv",
73+
"uploaded_on": "2020-02-06T18:11:23.531995Z",
74+
"validation_errors": [
75+
{
76+
"message": "SERVFAIL looking up CAA for app.example.com"
77+
}
78+
],
79+
"validation_records": [
80+
{
81+
"emails": [
82+
83+
84+
],
85+
"http_body": "ca3-574923932a82475cb8592200f1a2a23d",
86+
"http_url": "http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt",
87+
"txt_name": "_acme-challenge.app.example.com",
88+
"txt_value": "810b7d5f01154524b961ba0cd578acc2"
89+
}
90+
],
91+
"wildcard": false
92+
},
93+
}
94+
```
5095

5196
</Details>
5297

5398
- Whenever you make changes to a custom hostname via dashboard, the value that is set for Minimum TLS version will apply. If you have a scenario as explained in the bullet above, the dashboard change will override the zone-level configuration that was being applied.
5499

55-
- For custom hostnames with wildcards enabled, the direct custom hostname you create (`saas-customer.test`) will use the hostname-specific setting, while the others (`sub1.saas-customer.test`, `sub2.saas-customer.test`, etc) will default to the zone-level setting.
100+
- For custom hostnames with wildcards enabled, the direct custom hostname you create (for example, `saas-customer.test`) will use the hostname-specific setting, while the others (`sub1.saas-customer.test`, `sub2.saas-customer.test`, etc) will default to the zone-level setting.
56101

57102
### Setup
58103

0 commit comments

Comments
 (0)