Skip to content

Commit bcf5b72

Browse files
authoredFeb 3, 2025··
Split cloud API reference (#929)

File tree

13 files changed

+4972
-4660
lines changed

13 files changed

+4972
-4660
lines changed
 

‎modules/ROOT/attachments/cloud-api.yaml ‎modules/ROOT/attachments/cloud-controlplane-api.yaml

+217-4,617
Large diffs are not rendered by default.

‎modules/ROOT/attachments/cloud-dataplane-api.yaml

+4,678
Large diffs are not rendered by default.

‎modules/ROOT/nav.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,6 @@
33
*** xref:api:ROOT:pandaproxy-rest.adoc[]
44
*** xref:api:ROOT:pandaproxy-schema-registry.adoc[]
55
*** xref:api:ROOT:admin-api.adoc[]
6-
*** xref:api:ROOT:cloud-api.adoc[]
6+
*** xref:api:ROOT:cloud-api.adoc[]
7+
**** xref:api:ROOT:cloud-controlplane-api.adoc[]
8+
**** xref:api:ROOT:cloud-dataplane-api.adoc[]

‎modules/ROOT/pages/cloud-api.adoc

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,2 @@
11
= Cloud API
2-
:page-api-spec-url: api:ROOT:attachment$cloud-api.yaml
3-
:page-layout: swagger
4-
:page-try-it: true
2+
:page-layout: index
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
= Control Plane API
2+
:page-api-spec-url: api:ROOT:attachment$cloud-controlplane-api.yaml
3+
:page-layout: swagger
4+
:page-try-it: true
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
:page-layout: api-partial
22

3-
. To <<try-the-cloud-api,issue requests to the Cloud API from this page>>, click *Get Token*.
3+
. To issue requests to the Control Plane API from this page, click *Get Token*.
44
. If successful, the text “1 API key applied” displays under the *Authentication* header. The token is valid for one hour.
5-
. Make sure to choose the correct <<servers,API server>> before making requests.
65

76
See xref:redpanda-cloud:manage:api/cloud-api-authentication.adoc[Cloud API Authentication] for more information.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
:page-layout: api-partial
2+
3+
The Redpanda Cloud Control Plane API enables you to programmatically manage your clusters, networks, and resource groups.
4+
5+
To familiarize yourself with Redpanda Cloud API basics, see the xref:redpanda-cloud:manage:api/cloud-api-overview.adoc[Redpanda Cloud API Overview]. To get started using the API, try the xref:redpanda-cloud:manage:api/cloud-api-quickstart.adoc[Quickstart].
6+
7+
NOTE: To see the available endpoints for managing resources within your clusters, such as topics, users, access control lists (ACLs), and connectors, see the link:https://docs.redpanda.com/api/cloud-dataplane-api.html[Data Plane API Reference].
8+
9+
== Requirements
10+
11+
To use the Control Plane API:
12+
13+
* You must be a customer with an existing organization in Redpanda Cloud.
14+
* You can only use one organization for authentication. See xref:redpanda-cloud:manage:api/cloud-api-authentication.adoc[Cloud API Authentication] for steps to authenticate API requests.
15+
16+
== Control Plane API URL
17+
18+
The xref:redpanda-cloud:manage:api/cloud-api-overview.adoc#control-plane-api-url[*base URL*] of the Control Plane API for all organizations is:
19+
20+
```
21+
https://api.redpanda.com
22+
```
23+
24+
== See also
25+
26+
* xref:redpanda-cloud:manage:api/cloud-api-quickstart.adoc[Cloud API Quickstart]
27+
* xref:redpanda-cloud:manage:api/cloud-api-errors.adoc[Cloud API Error and Status Codes]
28+
* link:https://docs.redpanda.com/api/cloud-dataplane-api.html[Data Plane API Reference]
29+
30+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
= Data Plane APIs
2+
:page-api-spec-url: api:ROOT:attachment$cloud-dataplane-api.yaml
3+
:page-layout: swagger
4+
:page-try-it: true
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
= OAuth Receiver
2+
:page-layout: oauth
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
:page-layout: api-partial
2+
3+
. To issue requests to the Data Plane APIs from this page, click *Get Token*.
4+
. If successful, the text “1 API key applied” displays under the *Authentication* header. The token is valid for one hour.
5+
. Make sure you have set the correct <<servers,API server>> value based on your <<data-plane-api-url,Data Plane API URL>>.
6+
7+
See xref:redpanda-cloud:manage:api/cloud-api-authentication.adoc[Cloud API Authentication] for more information.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
:page-layout: api-partial
2+
3+
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.
4+
5+
To familiarize yourself with Redpanda Cloud API basics, see the xref:redpanda-cloud:manage:api/cloud-api-overview.adoc[Redpanda Cloud API Overview]. For a quick guide to the Data Plane APIs, see xref:redpanda-cloud:manage:api/cloud-dataplane-api.adoc[Quickstart].
6+
7+
NOTE: Redpanda Cloud uses a control plane and data plane architecture. To see the available endpoints for managing your clusters, networks, and resource groups, see the link:https://docs.redpanda.com/api/cloud-controlplane-api.html[Control Plane API Reference].
8+
9+
== Requirements
10+
11+
To use the Data Plane APIs:
12+
13+
* You must be a customer with an existing organization in Redpanda Cloud.
14+
* You can only use one organization for authentication. See xref:redpanda-cloud:manage:api/cloud-api-authentication.adoc[Cloud API Authentication] for steps to authenticate API requests.
15+
16+
== Data Plane API URL
17+
18+
The xref:redpanda-cloud:manage:api/cloud-api-overview.adoc#data-plane-apis-url[*base URL*] of the Data Plane APIs is unique to every cluster. You can retrieve this value by making a link:https://docs.redpanda.com/api/cloud-controlplane-api.html#get-/v1beta2/clusters/-id-[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.
19+
20+
== See also
21+
22+
* xref:redpanda-cloud:manage:api/cloud-api-quickstart.adoc[Cloud API Quickstart]
23+
* xref:redpanda-cloud:manage:api/cloud-api-errors.adoc[Cloud API Error and Status Codes]
24+
* link:https://docs.redpanda.com/api/cloud-controlplane-api.html[Control Plane API Reference]
25+

‎modules/ROOT/pages/cloud/overview/overview.adoc

-37
This file was deleted.

0 commit comments

Comments
 (0)
Please sign in to comment.