Skip to content

[CF1] partial front matter edit #22905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 4, 2025
Merged

[CF1] partial front matter edit #22905

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...e-one/connections/connect-devices/user-side-certificates/custom-certificate.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ openssl x509 -in <CUSTOM-ROOT-CERT>.pem -text

<TabItem label="API">

1. <Render file="upload-mtls-cert" params={{ one: " ", cert: "root CA" }} />
1. <Render file="upload-mtls-cert" params={{ key: " ", cert: "root CA" }} />
Copy link
Contributor

@windsurf-bot windsurf-bot bot Jun 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The parameter in the <Render> component was changed from one to key. Please confirm that key is the correct parameter expected by the upload-mtls-cert file, as this change could affect the rendered output or functionality.


2. Set the certificate as available for use in inspection with the [Activate a Zero Trust certificate endpoint](/api/resources/zero_trust/subresources/gateway/subresources/certificates/methods/activate/). This will deploy the certificate across the Cloudflare global network.

Expand Down
2 changes: 1 addition & 1 deletion .../docs/cloudflare-one/identity/devices/warp-client-checks/client-certificate.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ You can use the [Cloudflare PKI toolkit](/cloudflare-one/identity/devices/access
1. <Render
file="upload-mtls-cert"
params={{
one: "The private key is only required if you are using this custom certificate for Gateway HTTPS inspection.",
key: "The private key is only required if you are using this custom certificate for Gateway HTTPS inspection.",
Copy link
Contributor

@windsurf-bot windsurf-bot bot Jun 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The parameter name in the Render component was changed from 'one' to 'key'. Please confirm that the Render component expects 'key' and not 'one', as this could break the UI or documentation rendering if not updated everywhere.

cert: "signing certificate",
}}
/>
Expand Down
6 changes: 4 additions & 2 deletions src/content/partials/cloudflare-one/upload-mtls-cert.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---
inputParameters: param1
params:
- cert
- key?
Copy link
Contributor

@windsurf-bot windsurf-bot bot Jun 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The use of 'key?' in the params list is non-standard YAML. If you intend to indicate that 'key' is optional, consider documenting this in a comment or in the documentation body, rather than using a question mark in the key name.

---

import { Markdown } from "~/components";

Use the [Upload mTLS certificate endpoint](/api/resources/mtls_certificates/methods/create/) to upload the certificate and private key to Cloudflare. The certificate must be a {props.cert}, formatted as a single string with `\n` replacing the line breaks. {props.one}
Use the [Upload mTLS certificate endpoint](/api/resources/mtls_certificates/methods/create/) to upload the certificate and private key to Cloudflare. The certificate must be a {props.cert}, formatted as a single string with `\n` replacing the line breaks. {props.key}

```sh
curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/mtls_certificates" \
Expand Down