Skip to content

Add cross-references to API reference docs #22146

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 2 commits into from
May 5, 2025
Merged

Add cross-references to API reference docs #22146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c69dabe
Add cross-references to API reference docs in fundamentals section
jhutchings1 May 1, 2025
2e05645
Update page title to rate limits
jhutchings1 May 1, 2025
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 src/content/docs/fundamentals/api/reference/deprecations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: API deprecations
release_notes_file_name:
- api-deprecations
sidebar:
order: 5
order: 6
---

import { ProductReleaseNotes } from "~/components";
Expand Down
7 changes: 7 additions & 0 deletions src/content/docs/fundamentals/api/reference/graphql-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
pcx_content_type: navigation
title: GraphQL API
external_link: /analytics/graphql-api/
sidebar:
order: 2
---
7 changes: 3 additions & 4 deletions src/content/docs/fundamentals/api/reference/limits.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
pcx_content_type: reference
title: Limits
title: Rate limits
sidebar:
order: 2

order: 6
---

import { Render } from "~/components"
import { Render } from "~/components";

<Render file="api-rate-limits" product="fundamentals" />
2 changes: 1 addition & 1 deletion src/content/docs/fundamentals/api/reference/permissions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: API token permissions
pcx_content_type: reference
sidebar:
order: 3
order: 5
---

import { Render, TabItem, Tabs } from "~/components";
Expand Down
7 changes: 7 additions & 0 deletions src/content/docs/fundamentals/api/reference/rest-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
pcx_content_type: navigation
title: REST API
external_link: /api/
sidebar:
order: 1
---
2 changes: 1 addition & 1 deletion src/content/docs/fundamentals/api/reference/sdks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
pcx_content_type: reference
title: SDKs
sidebar:
order: 5
order: 7
---

Cloudflare offers language software development kits (SDKs) as well as `curl` examples to demonstrate how to use the Cloudflare API. The SDK libraries allow you to interact with the Cloudflare API in language-specific syntax and more easily integrate with your existing applications.
Expand Down
253 changes: 126 additions & 127 deletions src/content/docs/fundamentals/api/reference/template.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,136 +3,135 @@ title: API token templates
pcx_content_type: reference
description: Explore Cloudflare's API token templates to efficiently manage permissions. Start with a template and customize token permissions and resources as needed.
sidebar:
order: 4

order: 6
---

Below is a table of the currently available API token templates and the default [token permissions](/fundamentals/api/reference/permissions/) they grant. You can start creating a token with one of these templates and modify the permissions and resources from there.

<table>
<tbody>
<tr>
<th>Template Name</th>
<th>Permission</th>
<th>Resource</th>
</tr>
<tr>
<td>Edit Zone DNS</td>
<td>DNS Write</td>
<td>Zone</td>
</tr>
<tr>
<td rowspan="2">Read billing info</td>
<td>Billing Read</td>
<td>Account</td>
</tr>
<tr>
<td>Account resources: Include all accounts</td>
<td></td>
</tr>
<tr>
<td rowspan="2">Read analytics and logs</td>
<td>Analytics Read</td>
<td>Zone</td>
</tr>
<tr>
<td>Logs Read</td>
<td>Zone</td>
</tr>
<tr>
<td rowspan="8">Edit Cloudflare Workers</td>
<td>Workers Routes Write</td>
<td>Zone</td>
</tr>
<tr>
<td>Workers Scripts Write</td>
<td>Account</td>
</tr>
<tr>
<td>Workers KV Storage Write</td>
<td>Account</td>
</tr>
<tr>
<td>Workers Tail Read</td>
<td>Account</td>
</tr>
<tr>
<td>Workers R2 Storage Write</td>
<td>Account</td>
</tr>
<tr>
<td>Account Settings Read</td>
<td>Account</td>
</tr>
<tr>
<td>User Details Read</td>
<td>User</td>
</tr>
<tr>
<td>User Memberships Read</td>
<td>User</td>
</tr>
<tr>
<td rowspan="2">Edit load balancing configuration</td>
<td>Load Balancing: Monitors and Pools Write</td>
<td>Account</td>
</tr>
<tr>
<td>Load Balancers Write</td>
<td>Zone</td>
</tr>
<tr>
<td rowspan="8">WordPress</td>
<td>Analytics Read</td>
<td>Zone</td>
</tr>
<tr>
<td>Zone Read</td>
<td>Zone</td>
</tr>
<tr>
<td>Zone Settings Write</td>
<td>Zone</td>
</tr>
<tr>
<td>Account Settings Read</td>
<td>Account</td>
</tr>
<tr>
<td>DNS Read</td>
<td>Zone</td>
</tr>
<tr>
<td>Cache Purge</td>
<td>Zone</td>
</tr>
<tr>
<td>Account resources: Include all accounts</td>
<td></td>
</tr>
<tr>
<td>Zone resources: Include all zones</td>
<td></td>
</tr>
<tr>
<td>Create Additional Tokens</td>
<td>API Tokens Write</td>
<td>User</td>
</tr>
<tr>
<td rowspan="3">Read All Resources</td>
<td>
<em>(All read permissions)</em>
</td>
<td>Account, Zone, User</td>
</tr>
<tr>
<td>Account resources: Include all accounts</td>
<td></td>
</tr>
<tr>
<td>Zone resources: Include all zones</td>
<td></td>
</tr>
</tbody>
<tbody>
<tr>
<th>Template Name</th>
<th>Permission</th>
<th>Resource</th>
</tr>
<tr>
<td>Edit Zone DNS</td>
<td>DNS Write</td>
<td>Zone</td>
</tr>
<tr>
<td rowspan="2">Read billing info</td>
<td>Billing Read</td>
<td>Account</td>
</tr>
<tr>
<td>Account resources: Include all accounts</td>
<td></td>
</tr>
<tr>
<td rowspan="2">Read analytics and logs</td>
<td>Analytics Read</td>
<td>Zone</td>
</tr>
<tr>
<td>Logs Read</td>
<td>Zone</td>
</tr>
<tr>
<td rowspan="8">Edit Cloudflare Workers</td>
<td>Workers Routes Write</td>
<td>Zone</td>
</tr>
<tr>
<td>Workers Scripts Write</td>
<td>Account</td>
</tr>
<tr>
<td>Workers KV Storage Write</td>
<td>Account</td>
</tr>
<tr>
<td>Workers Tail Read</td>
<td>Account</td>
</tr>
<tr>
<td>Workers R2 Storage Write</td>
<td>Account</td>
</tr>
<tr>
<td>Account Settings Read</td>
<td>Account</td>
</tr>
<tr>
<td>User Details Read</td>
<td>User</td>
</tr>
<tr>
<td>User Memberships Read</td>
<td>User</td>
</tr>
<tr>
<td rowspan="2">Edit load balancing configuration</td>
<td>Load Balancing: Monitors and Pools Write</td>
<td>Account</td>
</tr>
<tr>
<td>Load Balancers Write</td>
<td>Zone</td>
</tr>
<tr>
<td rowspan="8">WordPress</td>
<td>Analytics Read</td>
<td>Zone</td>
</tr>
<tr>
<td>Zone Read</td>
<td>Zone</td>
</tr>
<tr>
<td>Zone Settings Write</td>
<td>Zone</td>
</tr>
<tr>
<td>Account Settings Read</td>
<td>Account</td>
</tr>
<tr>
<td>DNS Read</td>
<td>Zone</td>
</tr>
<tr>
<td>Cache Purge</td>
<td>Zone</td>
</tr>
<tr>
<td>Account resources: Include all accounts</td>
<td></td>
</tr>
<tr>
<td>Zone resources: Include all zones</td>
<td></td>
</tr>
<tr>
<td>Create Additional Tokens</td>
<td>API Tokens Write</td>
<td>User</td>
</tr>
<tr>
<td rowspan="3">Read All Resources</td>
<td>
<em>(All read permissions)</em>
</td>
<td>Account, Zone, User</td>
</tr>
<tr>
<td>Account resources: Include all accounts</td>
<td></td>
</tr>
<tr>
<td>Zone resources: Include all zones</td>
<td></td>
</tr>
</tbody>
</table>
7 changes: 7 additions & 0 deletions src/content/docs/fundamentals/api/reference/wrangler-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
pcx_content_type: navigation
title: Wrangler API
external_link: /workers/wrangler/api/
sidebar:
order: 3
---