You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: cloud-controlplane/cloud-controlplane.yaml
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5690,7 +5690,7 @@ tags:
5690
5690
name: Resource Groups
5691
5691
- description: Manage [Redpanda Serverless](https://docs.redpanda.com/redpanda-cloud/get-started/cloud-overview/#redpanda-cloud-cluster-types) clusters. For detailed steps, see [Use the Control Plane API with Serverless](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-serverless-controlplane-api/).
Copy file name to clipboardExpand all lines: cloud-controlplane/x-topics/quickstart.md
+49-44Lines changed: 49 additions & 44 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,15 +37,16 @@ If you successfully retrieve an access token, it is valid for one hour.
37
37
1. Under **Body**, click **Add** and provide a name for your resource group. A resource group is a container to organize your Redpanda Cloud resources, such as clusters and networks.
38
38
39
39
1. In the request panel, click **Send request**. If successful, the response returns a resource group ID. Copy the ID and use it later when you make a Create network request.
40
-
```
41
-
{
42
-
"resource_group": {
43
-
"id": "d61b4c7f-95da-4d62-a237-9fd9f20a0c19",
44
-
"name": "test-resource-group",
45
-
...
46
-
}
47
-
}
48
-
```
40
+
41
+
```
42
+
{
43
+
"resource_group": {
44
+
"id": "d61b4c7f-95da-4d62-a237-9fd9f20a0c19",
45
+
"name": "test-resource-group",
46
+
...
47
+
}
48
+
}
49
+
```
49
50
50
51
1. In the operation dropdown, select **Create network**.
51
52
@@ -54,41 +55,44 @@ If you successfully retrieve an access token, it is valid for one hour.
54
55
1. Include the ID of the resource group you created in the previous step.
55
56
56
57
1. Click **Send request**. Note that this endpoint returns a long-running operation. The response returns a network ID in `metadata.network_id`. Copy the ID and pass it later when you call the Create cluster endpoint. To check the operation state, make a [**Get operation**](/api/doc/cloud-controlplane/explorer/operation/operation-operationservice_getoperation) request with the `operation.id`.
1. When the Create network operation is complete, make a [Create cluster](/api/doc/cloud-controlplane/explorer/operation/operation-clusterservice_createcluster) request. Use the resource group and network IDs you just created. Note that this endpoint also returns a long-running operation.
72
75
73
76
1. For BYOC, run `rpk cloud byoc <cloud-provider> apply` in the shell, passing the `metadata.cluster_id` from the Create cluster response as a flag:
1. In the subheader of this page, open [**API Explorer**](/api/doc/cloud-controlplane/explorer)
95
+
1. In the subheader of this page, open [**API Explorer**](/api/doc/cloud-controlplane/explorer).
92
96
93
97
1. In the **Choose an operation** dropdown, select **Create resource group**.
94
98
@@ -99,15 +103,16 @@ If you successfully retrieve an access token, it is valid for one hour.
99
103
1. Under **Body**, click **Add** and provide a name for your resource group. A resource group is a container to organize your Redpanda Cloud resources, such as clusters and networks.
100
104
101
105
1. In the request panel, click **Send request**. If successful, the response returns a resource group ID. Copy the ID and use it later when you make a Create Serverless cluster request.
102
-
```
103
-
{
104
-
"resource_group": {
105
-
"id": "d61b4c7f-95da-4d62-a237-9fd9f20a0c19",
106
-
"name": "test-resource-group",
107
-
...
108
-
}
109
-
}
110
-
```
106
+
107
+
```
108
+
{
109
+
"resource_group": {
110
+
"id": "d61b4c7f-95da-4d62-a237-9fd9f20a0c19",
111
+
"name": "test-resource-group",
112
+
...
113
+
}
114
+
}
115
+
```
111
116
112
117
1. In the operation dropdown, scroll to **Serverless Clusters** and select [**Create Serverless cluster**](/api/doc/cloud-controlplane/explorer/operation/operation-serverlessclusterservice_createserverlesscluster).
Copy file name to clipboardExpand all lines: cloud-dataplane/x-topics/quickstart.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
The following steps describe how to authenticate with the Data Plane APIs and create a new topic. For more information on the Data Plane APIs, see the [Cloud API Overview](#topic-cloud-api-overview).
1
+
The following steps describe how to authenticate with the Data Plane APIs and create a new topic.
2
2
3
-
> **Note:** Redpanda Cloud uses a control plane and data plane architecture. To view the available endpoints for managing your clusters, networks, and resource groups, see the [Control Plane API Reference](/api/doc/cloud-controlplane).
3
+
> **Note:** Redpanda Cloud uses a control plane and data plane architecture. To view the available endpoints for managing your clusters, networks, and resource groups, see the [Control Plane API Reference](/api/doc/cloud-controlplane). For more information on the Data Plane APIs, see the [Cloud API Overview](#topic-cloud-api-overview).
4
4
5
5
## Requirements
6
6
@@ -25,7 +25,8 @@ If you successfully retrieve an access token, it is valid for one hour. You can
25
25
1. In the subheader of this page, open [**API Explorer**](/api/doc/cloud-dataplane/explorer).
26
26
27
27
1. If you don't already have the data plane API URL for your target cluster, make a [Get Cluster](/api/doc/cloud-controlplane/explorer/operation/operation-clusterservice_getcluster) (BYOC, Dedicated) or [Get Serverless Cluster](/api/doc/cloud-controlplane/explorer/operation/operation-serverlessclusterservice_getserverlesscluster) (Serverless) request with the Control Plane API. The response contains the data plane API URL.
28
-
From the `dataplane_api.url` value in the response, extract only the subdomain (the part between `https://` and `.cloud.redpanda.com`). Enter this value in the Data Plane API URL field.
28
+
29
+
From the `dataplane_api.url` value in the response, extract only the subdomain (the part between `https://` and `.cloud.redpanda.com`). Enter this value in the Data Plane API URL field.
29
30
30
31
1. In the **Choose an operation** dropdown, select **Create topic**.
0 commit comments