DOCS-2955: Add Usage API doc for Calico Cloud#2837
Open
ctauchen wants to merge 4 commits into
Open
Conversation
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new Calico Cloud operations doc that explains how to generate a read-only API key in the web console and use it to run generated commands against the Usage API, and wires the new page into the operations sidebar.
Changes:
- Added a new
operations/usage-apidocumentation page describing API key creation and Usage API invocation. - Updated the Calico Cloud sidebar to include the new page after
usage-metrics.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| sidebars-calico-cloud.js | Adds the new operations/usage-api doc to the Calico Cloud operations navigation. |
| calico-cloud/operations/usage-api.mdx | New how-to page for generating an API key and using the Calico Cloud Usage API. |
|
|
||
| ## Prerequisites | ||
|
|
||
| * You are signed in to the web console as a user with the **Admin** and **Usage Metrics** roles, or the **Owner role**. |
|
|
||
| ## Additional information | ||
|
|
||
| * [Usage metrics](usage-metrics.mdx) |
Documents creating a read-only API key in the web console and using it to call the Usage API for vCPU usage data. Adds the page to the operations sidebar after usage-metrics.
ctauchen
force-pushed
the
cc-usage-api-docs-2955
branch
from
fb2abc2 to
9d4e352
Compare
Collaborator
Author
|
@asincu PTAL |
asincu
approved these changes
Jul 7, 2026
|
|
||
| 1. In the web console, click the user icon <IconUser width="20"/> **> Settings**. | ||
| 1. Under the **API Keys** tab, click **Generate new key**. | ||
| 1. Enter a description, choose a validity period, and then click **Create**. |
Contributor
There was a problem hiding this comment.
We will be changing description to name
Glen-Tigera
reviewed
Jul 7, 2026
| * **Managed clusters** — per-cluster usage rows, with optional project filtering and CSV output. | ||
| * **Contracts** — your organization's contracts, including start and end dates, vCPU hours, package, and add-ons. | ||
| 1. Copy the generated command. | ||
| 1. In the command, replace `<your-secret>` with your API key, and set any query parameters, such as `startTime`, `endTime`, and `granularity`, for your query. |
Member
There was a problem hiding this comment.
@asincu Should we mention in docs that the daily granularity limit of 93 days? (~3 months) and for monthly granularity is 3 years (36 months)?
{
"key": "time_range.too_large",
"message": "daily granularity is limited to a maximum range of 93 days"
}
{
"key": "time_range.too_large",
"message": "monthly granularity is limited to a maximum range of 36 months"
}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a new operations page documenting how to create a read-only API key in the web console and use it to call the Calico Cloud Usage API for vCPU usage and managed cluster data. Adds the page to the operations sidebar after usage-metrics.