[VAULT-38465] Cumulative API docs #1050

blueberry-pi · 2025-10-03T16:12:44Z

Add documentation for the new Cumulative namespace API introduced in https://github.com/hashicorp/vault-enterprise/pull/9186.

RFC: https://go.hashi.co/rfc/vlt-361

github-actions · 2025-10-03T16:13:36Z

Vercel Previews Deployed

Name	Status	Preview	Updated (UTC)
Dev Portal	✅ Ready (Inspect)	Visit Preview	Tue Oct 7 20:41:11 UTC 2025
Unified Docs API	✅ Ready (Inspect)	Visit Preview	Tue Oct 7 20:32:19 UTC 2025

content/vault/v1.21.x (rc)/content/api-docs/system/internal-counters.mdx

Co-authored-by: Sarah Chavis <[email protected]>

content/vault/v1.21.x (rc)/content/api-docs/system/internal-counters.mdx

divyaac · 2025-10-06T18:20:13Z

content/vault/v1.21.x (rc)/content/api-docs/system/internal-counters.mdx

+
+```json
+{
+  "request_id": "b222b518-63a5-d1e7-39ee-216c0247833d",


We should be add an example with root as well that contains the cumulative sum

Do you mean where the root namespace also has its own clients? I can replace this example with that if that's what you're looking for

I think we can have a common example scenario and two responses depending on which namespace the api is called from.

I see, I modified the scenario so the root namespace also has 50 clients, and now there's two sample requests/responses: one called from root, and one called from ns1

content/vault/v1.21.x (rc)/content/api-docs/system/internal-counters.mdx

…unters.mdx Co-authored-by: Sarah Chavis <[email protected]>

gsantos-hc

Minor suggestions, LGTM

content/vault/v1.21.x (rc)/content/api-docs/system/internal-counters.mdx

gsantos-hc · 2025-10-07T00:53:37Z

content/vault/v1.21.x (rc)/content/api-docs/system/internal-counters.mdx

+If the number of namespaces in the response approaches or exceeds the
+[default maximum](/vault/docs/internals/limits#namespace-limits), the request
+may take several seconds to complete. To prevent impacting the performance of
+your Vault cluster, avoid making multiple requests to the cumulative count
+endpoint at once.


Should we recommend that customers set a rate limit quota on this endpoint?

Added a mention of rate limit quotas

content/vault/v1.21.x (rc)/content/api-docs/system/internal-counters.mdx

…nd response

Co-authored-by: Guilherme Santos <[email protected]>

github-actions · 2025-10-07T02:55:50Z

Broken Link Checker

No broken links found! 🎉

divyaac · 2025-10-07T16:26:46Z

content/vault/v1.21.x (rc)/content/api-docs/system/internal-counters.mdx

+- `start_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time
+  specifying the start of the client count query period. Leave `start_time`
+  unset to use the billing start date as the start time.
+- `end_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time


One thing to mention here is that end_time is always the end of the billing period

Changed the wording to specify end of the billing period

divyaac · 2025-10-07T16:27:27Z

content/vault/v1.21.x (rc)/content/api-docs/system/internal-counters.mdx

+
+### Parameters
+
+- `start_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time


Similarily, start_time will always be aligned to the start of a billing period

Changed the wording to specify start of the billing period

content/vault/v1.21.x (rc)/content/api-docs/system/internal-counters.mdx

cumulative api docs

0443cd7

blueberry-pi requested a review from divyaac October 3, 2025 16:12

blueberry-pi requested a review from a team as a code owner October 3, 2025 16:12

blueberry-pi added the Vault Content update for Vault product docs label Oct 3, 2025

blueberry-pi requested a review from akshya96 October 3, 2025 16:16

Merge branch 'vault/1.21.x' into vault-38465-cumulative-api-docs

019cc1e

blueberry-pi requested a review from gsantos-hc October 3, 2025 19:54

schavis requested changes Oct 3, 2025

View reviewed changes

schavis and others added 3 commits October 3, 2025 14:19

Merge branch 'vault/1.21.x' into vault-38465-cumulative-api-docs

3d0d5bd

Apply suggestions from code review

3337370

Co-authored-by: Sarah Chavis <[email protected]>

Tweak wording, add back warning

09af78d

blueberry-pi commented Oct 6, 2025

View reviewed changes

content/vault/v1.21.x (rc)/content/api-docs/system/internal-counters.mdx Outdated Show resolved Hide resolved

blueberry-pi commented Oct 6, 2025

View reviewed changes

content/vault/v1.21.x (rc)/content/api-docs/system/internal-counters.mdx Show resolved Hide resolved

blueberry-pi requested a review from schavis October 6, 2025 17:50

divyaac reviewed Oct 6, 2025

View reviewed changes

schavis requested changes Oct 6, 2025

View reviewed changes

content/vault/v1.21.x (rc)/content/api-docs/system/internal-counters.mdx Show resolved Hide resolved

content/vault/v1.21.x (rc)/content/api-docs/system/internal-counters.mdx Outdated Show resolved Hide resolved

Update content/vault/v1.21.x (rc)/content/api-docs/system/internal-co…

5f23213

…unters.mdx Co-authored-by: Sarah Chavis <[email protected]>

gsantos-hc approved these changes Oct 7, 2025

View reviewed changes

blueberry-pi and others added 2 commits October 6, 2025 18:55

create a partial alert for tech preview, add another sample request a…

efce7ba

…nd response

Apply suggestions from code review

04c8826

Co-authored-by: Guilherme Santos <[email protected]>

blueberry-pi requested review from divyaac and schavis October 7, 2025 02:01

schavis approved these changes Oct 7, 2025

View reviewed changes

divyaac requested changes Oct 7, 2025

View reviewed changes

divyaac reviewed Oct 7, 2025

View reviewed changes

content/vault/v1.21.x (rc)/content/api-docs/system/internal-counters.mdx Outdated Show resolved Hide resolved

address comments

3ddc634

blueberry-pi requested a review from divyaac October 7, 2025 17:01

Merge branch 'vault/1.21.x' into vault-38465-cumulative-api-docs

fef1a3e

divyaac approved these changes Oct 8, 2025

View reviewed changes

divyaac merged commit 9058679 into vault/1.21.x Oct 8, 2025
15 checks passed

divyaac deleted the vault-38465-cumulative-api-docs branch October 8, 2025 00:14


		### Parameters

		- `start_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time

[VAULT-38465] Cumulative API docs #1050

[VAULT-38465] Cumulative API docs #1050

Conversation

blueberry-pi commented Oct 3, 2025

Uh oh!

github-actions bot commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Vercel Previews Deployed

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

gsantos-hc left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Broken Link Checker

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Oct 3, 2025 •

edited

Loading

github-actions bot commented Oct 7, 2025 •

edited

Loading