Admin API guide #1390
Open
Admin API guide #1390
+145
−2
Conversation
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
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
Feediver1
reviewed
Oct 16, 2025
Feediver1
reviewed
Oct 16, 2025
Feediver1
reviewed
Oct 16, 2025
Feediver1
reviewed
Oct 16, 2025
|
|
||
| Most Admin API operations are also available using xref:get-started:intro-to-rpk.adoc[`rpk`], a CLI tool which interacts with the Admin API under the hood. | ||
|
|
||
| Redpanda version 25.3 introduces a version 2 of the Admin API, powered by https://connectrpc.com/docs/introduction[ConnectRPC]. New Redpanda features and operations introduced starting in version 25.3 are available with Admin API v2 only, and are not backported to Admin API v1. Supported Admin API v1 operations remain available and you can continue to use them per usual (including with rpk v25.3 and later). |
There was a problem hiding this comment.
I keep seeing v25.3 in other contexts. No big deal, but we should all be on the same page wrt how we do this.
Feediver1
reviewed
Oct 16, 2025
|
|
||
| Most Admin API operations are also available using xref:get-started:intro-to-rpk.adoc[`rpk`], a CLI tool which interacts with the Admin API under the hood. | ||
|
|
||
| Redpanda version 25.3 introduces a version 2 of the Admin API, powered by https://connectrpc.com/docs/introduction[ConnectRPC]. New Redpanda features and operations introduced starting in version 25.3 are available with Admin API v2 only, and are not backported to Admin API v1. Supported Admin API v1 operations remain available and you can continue to use them per usual (including with rpk v25.3 and later). |
There was a problem hiding this comment.
Suggested change
| Redpanda version 25.3 introduces a version 2 of the Admin API, powered by https://connectrpc.com/docs/introduction[ConnectRPC]. New Redpanda features and operations introduced starting in version 25.3 are available with Admin API v2 only, and are not backported to Admin API v1. Supported Admin API v1 operations remain available and you can continue to use them per usual (including with rpk v25.3 and later). | |
| Redpanda v25.3 introduces a version 2 of the Admin API, powered by https://connectrpc.com/docs/introduction[ConnectRPC]. New Redpanda features and operations introduced in version 25.3 are available with Admin API v2 only, and are not backported to Admin API v1. Supported Admin API v1 operations remain available and you can continue to use them as usual (including with rpk v25.3 and later). |
Feediver1
reviewed
Oct 16, 2025
| ** For Admin API v1, any supported version of Redpanda. For Admin API v2, Redpanda version 25.3 or later. | ||
| * Superuser privileges, if xref:manage:security/authentication.adoc#enable-authentication[authentication] is enabled on your cluster for the Admin API. For more information, see xref:manage:security/authentication.adoc#create-superusers[Configure Authentication]. (Some endpoints are read-only and do not require superuser access.) | ||
| * A tool to make HTTP requests, such as `curl`, or client libraries for your programming language of choice. | ||
| ** For Admin API v2, you can also make requests using a Connect client. You can install the Connect plugin for your preferred language and use the Protobuf compiler to generate an SDK. Admin API v2 is also available as a Buf module and can be accessed through the https://buf.build/redpandadata/core/docs/dev:redpanda.core.admin.v2[Buf Schema Registry]. The https://buf.build/docs/cli/[Buf CLI] provides an easy way to generate client SDKs. |
There was a problem hiding this comment.
Is this a Kafka Connect? If you are referring generally to connectors, wouldn't this be "connect"?
Or is this Redpanda Connect?
Feediver1
reviewed
Oct 16, 2025
| ** For Admin API v1, any supported version of Redpanda. For Admin API v2, Redpanda version 25.3 or later. | ||
| * Superuser privileges, if xref:manage:security/authentication.adoc#enable-authentication[authentication] is enabled on your cluster for the Admin API. For more information, see xref:manage:security/authentication.adoc#create-superusers[Configure Authentication]. (Some endpoints are read-only and do not require superuser access.) | ||
| * A tool to make HTTP requests, such as `curl`, or client libraries for your programming language of choice. | ||
| ** For Admin API v2, you can also make requests using a Connect client. You can install the Connect plugin for your preferred language and use the Protobuf compiler to generate an SDK. Admin API v2 is also available as a Buf module and can be accessed through the https://buf.build/redpandadata/core/docs/dev:redpanda.core.admin.v2[Buf Schema Registry]. The https://buf.build/docs/cli/[Buf CLI] provides an easy way to generate client SDKs. |
There was a problem hiding this comment.
Suggested change
| ** For Admin API v2, you can also make requests using a Connect client. You can install the Connect plugin for your preferred language and use the Protobuf compiler to generate an SDK. Admin API v2 is also available as a Buf module and can be accessed through the https://buf.build/redpandadata/core/docs/dev:redpanda.core.admin.v2[Buf Schema Registry]. The https://buf.build/docs/cli/[Buf CLI] provides an easy way to generate client SDKs. | |
| ** For Admin API v2, you can also make requests using a Connect client. You can install the Connect plugin for your preferred language and use the Protobuf compiler to generate an SDK. Admin API v2 is also available as a Buf module, which you can access using the https://buf.build/redpandadata/core/docs/dev:redpanda.core.admin.v2[Buf Schema Registry]. The https://buf.build/docs/cli/[Buf CLI] provides an easy way to generate client SDKs. |
Feediver1
reviewed
Oct 16, 2025
|
|
||
| == Choose an Admin API version | ||
|
|
||
| In Redpanda version 25.3, Admin API v2 endpoints are entirely exclusive to v2, and there is virtually no overlap in functionality between v2 and v1. You can use both versions of the Admin API on the same cluster, so choosing which version depends on whether you use the following v2-only features: |
There was a problem hiding this comment.
I would not mix v and version, especially in the same paragraph
Feediver1
reviewed
Oct 16, 2025
|
|
||
| == Choose an Admin API version | ||
|
|
||
| In Redpanda version 25.3, Admin API v2 endpoints are entirely exclusive to v2, and there is virtually no overlap in functionality between v2 and v1. You can use both versions of the Admin API on the same cluster, so choosing which version depends on whether you use the following v2-only features: |
There was a problem hiding this comment.
Suggested change
| In Redpanda version 25.3, Admin API v2 endpoints are entirely exclusive to v2, and there is virtually no overlap in functionality between v2 and v1. You can use both versions of the Admin API on the same cluster, so choosing which version depends on whether you use the following v2-only features: | |
| In Redpanda v25.3, Admin API v2 endpoints are entirely exclusive to v2, and there is virtually no overlap in functionality between v2 and v1. You can use both versions of the Admin API on the same cluster, so choosing which version depends on whether you use the following v2-only features: |
Feediver1
reviewed
Oct 16, 2025
|
|
||
| === Use Admin API v2 | ||
|
|
||
| The Admin API v2 is built on ConnectRPC, so you can send `curl` requests with a JSON payload, or use a generated Connect client to call the same methods directly from your application code. The v2 paths are the fully qualified names of the services. All v2 endpoints accept POST requests only. |
There was a problem hiding this comment.
Connect client<--- Redpanda Connect? Kafka Connect? connect client?
Feediver1
reviewed
Oct 16, 2025
|
@mattschumpert Do we want to announce Admin v2 in What's New? |
rockwotj
approved these changes
Oct 22, 2025
Co-authored-by: Joyce Fee <[email protected]>
kbatuigas
force-pushed
the
DOC-1706-create-user-guide-for-admin-api
branch
from
8b20de2 to
2d1adde
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
This pull request introduces documentation for the new ConnectRPC-powered Admin API endpoints in Redpanda v25.3 and updates navigation and references throughout the docs to surface these changes. The most important changes are the addition of a dedicated Admin API usage guide, updates to the release notes to announce the new endpoints, and improved navigation and reference structure to distinguish between legacy and new Admin API endpoints.
Admin API documentation and navigation improvements:
use-admin-api.adoc, providing a comprehensive guide on managing Redpanda clusters using both legacy and new ConnectRPC Admin API endpoints, including usage examples and authentication details.nav.adocto add direct links to the new Admin API usage guide and the ConnectRPC Admin API reference, making it easier for users to find relevant documentation. [1] [2]v1) and new ConnectRPC (v2) Admin API endpoints, including versioning details and links to the new usage guide.Release notes updates:
These changes collectively improve discoverability, clarity, and usability of the Admin API documentation for both new and existing Redpanda users.
Resolves https://redpandadata.atlassian.net/browse/
Review deadline: 16 Oct
Page previews
Manage > Manage Redpanda Using the Admin API
Reference > API Reference
What's New
Checks