To issue requests to the Data Plane APIs from this page, click Get Token.
If successful, the text “1 API key applied” displays under the Authentication header. The token is valid for one hour.
Make sure you have set the correct API server value based on your Data Plane API URL.
See Cloud API Authentication for more information.
The Redpanda Cloud Data Plane APIs enable you to programmatically manage the resources within your clusters, including topics, users, access control lists (ACLs), and connectors.
To familiarize yourself with Redpanda Cloud API basics, see the Redpanda Cloud API Overview. For a quick guide to the Data Plane APIs, see Quickstart.
The Data Plane API versions v1alpha1 and v1alpha2 are deprecated. v1alpha1 and v1alpha2 are still available, but they will be removed in a future release and are not recommended for use.
The deprecation timeline is:
Announcement date: May 27, 2025
End-of-support date: November 28, 2025
Retirement date: May 28, 2026
See Redpanda Cloud API Deprecation Policy for more information.
To use the Data Plane APIs:
You must be a customer with an existing organization in Redpanda Cloud.
You can only use one organization for authentication. See Cloud API Authentication for steps to authenticate API requests.
The base URL of the Data Plane APIs is unique to every cluster. You can retrieve this value by making a Get Cluster request to your target cluster. Use the dataplane_api.url from the response body as the base URL when calling the Data Plane API endpoints.
dataplane_api.url
Cloud API Quickstart
Cloud API Error and Status Codes
Control Plane API Reference
Beep-Boop. Bot-field