Skip to content

feat(clickpipes): document clickpipes_egress_ips in static-ips API - #6596

Draft
whites11 wants to merge 1 commit into
mainfrom
clp-1115-clickpipes-static-nat-ips-docs
Draft

feat(clickpipes): document clickpipes_egress_ips in static-ips API#6596
whites11 wants to merge 1 commit into
mainfrom
clp-1115-clickpipes-static-nat-ips-docs

Conversation

@whites11

Copy link
Copy Markdown
Member

What

Documents the new per-region clickpipes_egress_ips field exposed by https://api.clickhouse.cloud/static-ips.json, which lists the static NAT IPs ClickPipes uses to egress to customer data sources.

  • cloud/guides/data_sources/01_cloud-endpoints-api.md — notes the new clickpipes_egress_ips field in the schema description and adds it to the sample jq '.' output (using the real ap-south-1 ClickPipes NAT IPs).
  • integrations/data-ingestion/clickpipes/index.md (#list-of-static-ips) — adds a tip with jq snippets so customers can fetch the ClickPipes NAT IPs programmatically instead of copying the hand-maintained tables.

Resolves the docs side of CLP-1115 — the customer asked for a static-ips.json-style API for ClickPipes NAT IPs, mirroring the ClickHouse Cloud endpoints API.

⚠️ Do not merge until the field is live in production

The clickpipes_egress_ips field is added by data-plane-infrastructure PR #23468, which is currently dev-only. This docs PR must land only after the staging/prod rollout of that field, otherwise it documents a field that is not yet present in the production static-ips.json. Keeping this as a draft until then.

Notes

  • English source pages only. The ru/zh/jp copies are handled by the translation pipeline.

🤖 Generated with Claude Code

Adds the new per-region clickpipes_egress_ips field (from ClickHouse/data-plane-infrastructure) to the Cloud endpoints API reference, and a jq snippet on the ClickPipes 'List of Static IPs' page to fetch the NAT IPs programmatically.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 28, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clickhouse-docs Error Error Comment Jul 28, 2026 10:03am
4 Skipped Deployments
Project Deployment Actions Updated (UTC)
clickhouse-docs-jp Ignored Ignored Jul 28, 2026 10:03am
clickhouse-docs-ko Ignored Ignored Jul 28, 2026 10:03am
clickhouse-docs-ru Ignored Ignored Jul 28, 2026 10:03am
clickhouse-docs-zh Ignored Ignored Jul 28, 2026 10:03am

Request Review

@whites11 whites11 self-assigned this Jul 28, 2026
@github-actions

Copy link
Copy Markdown

Thanks for contributing to the ClickHouse documentation!

We’ve moved documentation development to the main ClickHouse/ClickHouse repository. For future documentation changes, please open your pull request there, with changes under the docs/ directory.

We’ll continue reviewing this pull request here during the transition, and it will be transferred as part of the migration. You don’t need to reopen it.

See the documentation README for more information.

@morsapaes morsapaes 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.

LGTM. I might revisit this with the re-architecture of the networking documentation later on. Thanks for implementing this, @whites11. ❤️

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants