From c69dabee9ae8d44166b07ef38770dd1322ce18e7 Mon Sep 17 00:00:00 2001 From: Justin Hutchings Date: Thu, 1 May 2025 14:06:13 -0700 Subject: [PATCH 1/2] Add cross-references to API reference docs in fundamentals section --- .../api/reference/deprecations.mdx | 2 +- .../api/reference/graphql-api.mdx | 7 + .../fundamentals/api/reference/limits.mdx | 5 +- .../api/reference/permissions.mdx | 2 +- .../fundamentals/api/reference/rest-api.mdx | 7 + .../docs/fundamentals/api/reference/sdks.mdx | 2 +- .../fundamentals/api/reference/template.mdx | 253 +++++++++--------- .../api/reference/wrangler-api.mdx | 7 + 8 files changed, 152 insertions(+), 133 deletions(-) create mode 100644 src/content/docs/fundamentals/api/reference/graphql-api.mdx create mode 100644 src/content/docs/fundamentals/api/reference/rest-api.mdx create mode 100644 src/content/docs/fundamentals/api/reference/wrangler-api.mdx diff --git a/src/content/docs/fundamentals/api/reference/deprecations.mdx b/src/content/docs/fundamentals/api/reference/deprecations.mdx index 3a2e038ba2bc71..175d8e56c9be34 100644 --- a/src/content/docs/fundamentals/api/reference/deprecations.mdx +++ b/src/content/docs/fundamentals/api/reference/deprecations.mdx @@ -4,7 +4,7 @@ title: API deprecations release_notes_file_name: - api-deprecations sidebar: - order: 5 + order: 6 --- import { ProductReleaseNotes } from "~/components"; diff --git a/src/content/docs/fundamentals/api/reference/graphql-api.mdx b/src/content/docs/fundamentals/api/reference/graphql-api.mdx new file mode 100644 index 00000000000000..1bb3bfd47d5790 --- /dev/null +++ b/src/content/docs/fundamentals/api/reference/graphql-api.mdx @@ -0,0 +1,7 @@ +--- +pcx_content_type: navigation +title: GraphQL API +external_link: /analytics/graphql-api/ +sidebar: + order: 2 +--- diff --git a/src/content/docs/fundamentals/api/reference/limits.mdx b/src/content/docs/fundamentals/api/reference/limits.mdx index 1904b79e6d134b..b34c61e2fcfb7b 100644 --- a/src/content/docs/fundamentals/api/reference/limits.mdx +++ b/src/content/docs/fundamentals/api/reference/limits.mdx @@ -2,10 +2,9 @@ pcx_content_type: reference title: Limits sidebar: - order: 2 - + order: 6 --- -import { Render } from "~/components" +import { Render } from "~/components"; diff --git a/src/content/docs/fundamentals/api/reference/permissions.mdx b/src/content/docs/fundamentals/api/reference/permissions.mdx index cbd21f41507e78..da4781b3f03c45 100644 --- a/src/content/docs/fundamentals/api/reference/permissions.mdx +++ b/src/content/docs/fundamentals/api/reference/permissions.mdx @@ -2,7 +2,7 @@ title: API token permissions pcx_content_type: reference sidebar: - order: 3 + order: 5 --- import { Render, TabItem, Tabs } from "~/components"; diff --git a/src/content/docs/fundamentals/api/reference/rest-api.mdx b/src/content/docs/fundamentals/api/reference/rest-api.mdx new file mode 100644 index 00000000000000..019e297cc5f254 --- /dev/null +++ b/src/content/docs/fundamentals/api/reference/rest-api.mdx @@ -0,0 +1,7 @@ +--- +pcx_content_type: navigation +title: REST API +external_link: /api/ +sidebar: + order: 1 +--- diff --git a/src/content/docs/fundamentals/api/reference/sdks.mdx b/src/content/docs/fundamentals/api/reference/sdks.mdx index acb8ebfda6a950..19e6aa498a546b 100644 --- a/src/content/docs/fundamentals/api/reference/sdks.mdx +++ b/src/content/docs/fundamentals/api/reference/sdks.mdx @@ -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. diff --git a/src/content/docs/fundamentals/api/reference/template.mdx b/src/content/docs/fundamentals/api/reference/template.mdx index ad690a3826220d..f5f829ef3b8e98 100644 --- a/src/content/docs/fundamentals/api/reference/template.mdx +++ b/src/content/docs/fundamentals/api/reference/template.mdx @@ -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Template NamePermissionResource
Edit Zone DNSDNS WriteZone
Read billing infoBilling ReadAccount
Account resources: Include all accounts
Read analytics and logsAnalytics ReadZone
Logs ReadZone
Edit Cloudflare WorkersWorkers Routes WriteZone
Workers Scripts WriteAccount
Workers KV Storage WriteAccount
Workers Tail ReadAccount
Workers R2 Storage WriteAccount
Account Settings ReadAccount
User Details ReadUser
User Memberships ReadUser
Edit load balancing configurationLoad Balancing: Monitors and Pools WriteAccount
Load Balancers WriteZone
WordPressAnalytics ReadZone
Zone ReadZone
Zone Settings WriteZone
Account Settings ReadAccount
DNS ReadZone
Cache PurgeZone
Account resources: Include all accounts
Zone resources: Include all zones
Create Additional TokensAPI Tokens WriteUser
Read All Resources - (All read permissions) - Account, Zone, User
Account resources: Include all accounts
Zone resources: Include all zones
Template NamePermissionResource
Edit Zone DNSDNS WriteZone
Read billing infoBilling ReadAccount
Account resources: Include all accounts
Read analytics and logsAnalytics ReadZone
Logs ReadZone
Edit Cloudflare WorkersWorkers Routes WriteZone
Workers Scripts WriteAccount
Workers KV Storage WriteAccount
Workers Tail ReadAccount
Workers R2 Storage WriteAccount
Account Settings ReadAccount
User Details ReadUser
User Memberships ReadUser
Edit load balancing configurationLoad Balancing: Monitors and Pools WriteAccount
Load Balancers WriteZone
WordPressAnalytics ReadZone
Zone ReadZone
Zone Settings WriteZone
Account Settings ReadAccount
DNS ReadZone
Cache PurgeZone
Account resources: Include all accounts
Zone resources: Include all zones
Create Additional TokensAPI Tokens WriteUser
Read All Resources + (All read permissions) + Account, Zone, User
Account resources: Include all accounts
Zone resources: Include all zones
diff --git a/src/content/docs/fundamentals/api/reference/wrangler-api.mdx b/src/content/docs/fundamentals/api/reference/wrangler-api.mdx new file mode 100644 index 00000000000000..09649345721c23 --- /dev/null +++ b/src/content/docs/fundamentals/api/reference/wrangler-api.mdx @@ -0,0 +1,7 @@ +--- +pcx_content_type: navigation +title: Wrangler API +external_link: /workers/wrangler/api/ +sidebar: + order: 3 +--- From 2e05645d84803b923b97b0981d6ff3bf80061cab Mon Sep 17 00:00:00 2001 From: Justin Hutchings Date: Thu, 1 May 2025 14:06:56 -0700 Subject: [PATCH 2/2] Update page title to rate limits --- src/content/docs/fundamentals/api/reference/limits.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/fundamentals/api/reference/limits.mdx b/src/content/docs/fundamentals/api/reference/limits.mdx index b34c61e2fcfb7b..5b76bbe43f2892 100644 --- a/src/content/docs/fundamentals/api/reference/limits.mdx +++ b/src/content/docs/fundamentals/api/reference/limits.mdx @@ -1,6 +1,6 @@ --- pcx_content_type: reference -title: Limits +title: Rate limits sidebar: order: 6 ---