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
+65-21Lines changed: 65 additions & 21 deletions
Original file line number
Diff line number
Diff line change
@@ -315,12 +315,6 @@ components:
315
315
id:
316
316
description: ID of the cluster. ID is an output from the Create Cluster endpoint and cannot be set by the caller.
317
317
type: string
318
-
internet_gateways:
319
-
description: InternetGateway information of the cluster.
320
-
items:
321
-
type: string
322
-
readOnly: true
323
-
type: array
324
318
kafka_api:
325
319
$ref: '#/components/schemas/Cluster.KafkaAPI'
326
320
kafka_connect:
@@ -331,6 +325,12 @@ components:
331
325
description: Unique name of the cluster.
332
326
example: development-cluster
333
327
type: string
328
+
nat_gateways:
329
+
description: NAT gateway information for the cluster.
330
+
items:
331
+
type: string
332
+
readOnly: true
333
+
type: array
334
334
network_id:
335
335
description: Network ID where cluster is placed.
336
336
example: cjcuq79c4vs94fcufc2g
@@ -2096,13 +2096,20 @@ components:
2096
2096
id:
2097
2097
title: internal id of the organization
2098
2098
type: string
2099
+
mfa_enforced:
2100
+
type: boolean
2099
2101
name:
2100
2102
title: display name of the organization
2101
2103
type: string
2102
2104
welcome_cluster_id:
2103
2105
nullable: true
2104
2106
type: string
2105
2107
type: object
2108
+
OrganizationUpdate:
2109
+
properties:
2110
+
mfa_enforced:
2111
+
type: boolean
2112
+
type: object
2106
2113
Placement:
2107
2114
description: Information about creation of new serverless clusters on the serverless region.
2108
2115
properties:
@@ -2791,6 +2798,11 @@ components:
2791
2798
enum:
2792
2799
- UPDATE_CLUSTER_TYPE_CUSTOMER_CONFIG
2793
2800
type: string
2801
+
UpdateOrganizationResponse:
2802
+
properties:
2803
+
organization:
2804
+
$ref: '#/components/schemas/Organization'
2805
+
type: object
2794
2806
UpdateResourceGroupBody:
2795
2807
properties:
2796
2808
resource_group:
@@ -3232,7 +3244,7 @@ components:
3232
3244
x-client-id: dQjapNIAHhF7EQqQToRla3yEII9sUSap
3233
3245
type: oauth2
3234
3246
info:
3235
-
description: 'Use the Control Plane API to manage resources in your Redpanda Cloud organization such as clustersand networks.'
3247
+
description: The Redpanda Cloud Control Plane API allows programmatic management of Redpanda Cloud resources including clusters, networks, and resource groups.
description: Create a Redpanda cluster. Returns a long-running operation. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information. Call `GET /v1/operations/{id}` to check operation state. Refer to [Regions](https://docs.redpanda.com/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers) for the list of available regions, zones, and tiers combinations for each cloud provider. For BYOC clusters, follow additional steps to [create a BYOC cluster](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-byoc-controlplane-api/#additional-steps-to-create-a-byoc-cluster).
3375
+
description: Create a Redpanda cluster. Returns a long-running operation. For more information, see [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/). To check operation state, call `GET /v1/operations/{id}`. Refer to [Regions](https://docs.redpanda.com/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers) for the list of available regions, zones, and tiers combinations for each cloud provider. For BYOC clusters, follow additional steps to [create a BYOC cluster](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-byoc-controlplane-api/#additional-steps-to-create-a-byoc-cluster).
3364
3376
operationId: ClusterService_CreateCluster
3365
3377
requestBody:
3366
3378
content:
@@ -3568,7 +3580,7 @@ paths:
3568
3580
- Clusters
3569
3581
/v1/clusters/{id}:
3570
3582
delete:
3571
-
description: Delete a Redpanda Cluster. Returns a long-running operation. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information. Call `GET /v1/operations/{id}` to check operation state.
3583
+
description: Delete a Redpanda Cluster. Returns a long-running operation. For more information, see [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/). To check operation state, call `GET /v1/operations/{id}`.
description: Create a Redpanda network. Returns a long-running operation. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information. Call `GET /v1/operations/{id}` to check operation state.
3788
+
description: Create a Redpanda network. Returns a long-running operation. For more information, see [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/). To check operation state, call `GET /v1/operations/{id}`.
description: Create a Redpanda Serverless cluster. Returns a long-running operation. For more information, see [Use the Control Plane API with Serverless](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-serverless-controlplane-api/). To check operation state, call `GET /v1/operations/{id}`.
4885
+
description: Create a Redpanda Serverless cluster. Returns a long-running operation. For more information, see [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-serverless-controlplane-api/). To check operation state, call `GET /v1/operations/{id}`.
description: Delete Redpanda Serverless cluster. Returns a long-running operation. For more information, see [Use the Control Plane API with Serverless](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-serverless-controlplane-api/). To check operation state, call `GET /v1/operations/{id}`.
4931
+
description: Delete Redpanda Serverless cluster. Returns a long-running operation. For more information, see [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-serverless-controlplane-api/). To check operation state, call `GET /v1/operations/{id}`.
- description: Check the state of long-running operations. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information.
5664
+
- description: Check the state of long-running operations.
5621
5665
name: Operations
5622
5666
- description: Manage Redpanda Cloud clusters. For detailed steps and information, see [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/).
0 commit comments