Skip to content

[Fundamentals] Document scannable API credential formats#29561

Open
nkcmr wants to merge 1 commit intocloudflare:productionfrom
nkcmr:nick/ACCT-11368/scannable-token-formats
Open

[Fundamentals] Document scannable API credential formats#29561
nkcmr wants to merge 1 commit intocloudflare:productionfrom
nkcmr:nick/ACCT-11368/scannable-token-formats

Conversation

@nkcmr
Copy link
Copy Markdown
Contributor

@nkcmr nkcmr commented Apr 2, 2026

Cloudflare API credentials now use prefixed, scannable formats (cfk_, cfut_, cfat_) that enable credential scanning tools to detect leaked tokens. This PR documents the new formats and updates existing API credential pages to reference them.

  • New concept page at /fundamentals/api/get-started/token-formats/ covering the three credential formats, leaked token detection and auto-revocation, and the pre-2026 unprefixed formats
  • Added inline mentions linking to the new page on keys.mdx (cfk_), create-token.mdx (cfut_), and account-owned-tokens.mdx (cfat_)
  • Updated the api-roll-token partial to note that rolled tokens use the scannable format
  • Refreshed dashboard screenshots for the token creation flow

Related: RM-26064, ACCT-11368

 ## Context/Background

Cloudflare API credentials now use a prefixed, scannable format
(cfk_, cfut_, cfat_) that enables credential scanning tools like
GitHub Secret Scanning, TruffleHog, Gitleaks, and GitGuardian to
detect leaked tokens with high confidence. Leaked tokens are
automatically revoked and the token owner is notified via email.

 ## Changes in this commit

- New concept page (token-formats.mdx) covering the three scannable
  credential formats, leaked token detection partners, Cloudflare
  One DLP integration, and how to upgrade existing tokens
- Inline mentions with links on keys.mdx (cfk_),
  create-token.mdx (cfut_), and account-owned-tokens.mdx (cfat_)
- Updated api-roll-token partial to note that rolled tokens use
  the scannable format
- Refreshed dashboard screenshots for the token creation flow
@nkcmr nkcmr force-pushed the nick/ACCT-11368/scannable-token-formats branch from a6caf94 to 77497b8 Compare April 2, 2026 19:47
<DashButton url="/?to=/:account/home" />
<DashButton url="/?to=/:account/home" />

2. Go to **My Profile** > **API Tokens**.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We could deeplink directly to this page. Why not do so? We can also link to the account API tokens page.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good point. Will fix.

Copy link
Copy Markdown
Contributor

@jhutchings1 jhutchings1 left a comment

Choose a reason for hiding this comment

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

Made a minor suggestion, but overall, this is looking good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants