Skip to content

docs(controller): add Telegraf Controller API reference page#7314

Open
sanderson wants to merge 1 commit into
telegraf-controller-gafrom
docs/controller-api
Open

docs(controller): add Telegraf Controller API reference page#7314
sanderson wants to merge 1 commit into
telegraf-controller-gafrom
docs/controller-api

Conversation

@sanderson

Copy link
Copy Markdown
Collaborator

Summary

  • Adds a reference page that introduces the Telegraf Controller HTTP API, covering the API base path, token authentication, and an example request.
  • Points users to the interactive /api/docs reference served by their own instance instead of rendering the full API reference in the docs.
  • Adds cross-links from the token usage and authentication/authorization pages.

Checklist

  • Rebased/mergeable
  • Local build passes (npx hugo --quiet)

Add a reference page that introduces the Telegraf Controller HTTP API,
covering the API base path, token authentication, and an example request.
Point users to the interactive /api/docs reference served by their own
instance instead of rendering the full API reference in the docs. Add
cross-links from the token usage and authentication/authorization pages.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@sanderson sanderson requested a review from a team as a code owner June 10, 2026 21:09
@sanderson sanderson requested review from jstirnaman and removed request for a team June 10, 2026 21:09
@github-actions

Copy link
Copy Markdown
Contributor

Vale Style Check Results

Metric Count
Errors 0
Warnings 0
Suggestions 0

Check passed

@github-actions github-actions Bot added the product:telegraf Telegraf documentation label Jun 10, 2026
@github-actions

Copy link
Copy Markdown
Contributor
PR Preview Action v1.4.8
🚀 Deployed preview to https://influxdata.github.io/docs-v2/pr-preview/pr-7314/
on branch gh-pages at 2026-06-10 21:11 UTC

@github-actions

Copy link
Copy Markdown
Contributor

📦 PR Preview — Preview Bot

Status Details
Result ✅ DEPLOYED
Preview View preview
Pages 3 page(s) deployed
Build time 69s
Last updated 2026-06-10 21:12:04 UTC
Pages included in this preview
  • /telegraf/controller/reference/api/
  • /telegraf/controller/reference/authentication-authorization/
  • /telegraf/controller/tokens/use/

Preview auto-deploys on push. Will be cleaned up when PR closes.

@jstirnaman

Copy link
Copy Markdown
Contributor

instead of rendering the full API reference in the docs

  1. Is there a machine-readable spec served by the instance?
  2. We'll be adding it to the site as well?

@jstirnaman jstirnaman left a comment

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.

See PR #7324

@sanderson

Copy link
Copy Markdown
Collaborator Author

@jstirnaman

Is there a machine-readable spec served by the instance?
I'll double-check, but I believe there is. The application does include the spec, but I don't know how accessible it is.

We'll be adding it to the site as well?
In the short-term, no, just because I think it's going to be growing a lot between the next couple of releases.

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

Labels

product:telegraf Telegraf documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants