cloud-controlplane-openapi-source.json

{"components":{"schemas":{"AWS.Role":{"description":"Role identifies AWS role.","properties":{"arn":{"description":"AWS role ARN.","type":"string"}},"required":["arn"],"title":"Role","type":"object"},"AWSInstanceProfile":{"description":"AWS instance profile.","properties":{"arn":{"description":"AWS instance profile ARN.","type":"string"}},"required":["arn"],"title":"Instance Profile","type":"object"},"AWSPrivateLink":{"properties":{"allowed_principals":{"description":"The ARN of the principals that can access the Redpanda AWS PrivateLink Endpoint Service. To grant permissions to all principals, use an asterisk (*).","example":["arn:aws:iam::account-number-without-hyphens:user/username or arn:aws:iam::account-number-without-hyphens:root"],"items":{"type":"string"},"type":"array"},"connect_console":{"description":"Whether Console is connected in Redpanda AWS Private Link Service.","type":"boolean"},"enabled":{"description":"Whether Redpanda AWS Private Link Endpoint Service is enabled.","type":"boolean"},"http_proxy_auth_mode":{"$ref":"#/components/schemas/PrivateLinkAuthMode"},"kafka_api_auth_mode":{"$ref":"#/components/schemas/PrivateLinkAuthMode"},"schema_registry_auth_mode":{"$ref":"#/components/schemas/PrivateLinkAuthMode"},"status":{"$ref":"#/components/schemas/AWSPrivateLink.Status"}},"type":"object"},"AWSPrivateLink.Status":{"properties":{"console_port":{"description":"The port of Redpanda Console.","format":"int32","type":"integer"},"created_at":{"description":"Redpanda AWS PrivateLink Endpoint Service creation timestamp.","format":"date-time","type":"string"},"deleted_at":{"description":"Redpanda AWS PrivateLink Service deletion timestamp.","format":"date-time","type":"string"},"kafka_api_node_base_port":{"description":"Kafka API node service base port. The port for node `i` (0 .. node_count-1) is kafka_api_node_base_port + `i`.","format":"int32","type":"integer"},"kafka_api_seed_port":{"description":"Kafka API seed service port.","format":"int32","type":"integer"},"redpanda_proxy_node_base_port":{"description":"HTTP Proxy node service base port. The port for node `i` (0 .. node_count-1) is redpanda_proxy_node_base_port + i.","format":"int32","type":"integer"},"redpanda_proxy_seed_port":{"description":"HTTP Proxy seed service port.","format":"int32","type":"integer"},"schema_registry_seed_port":{"description":"Schema Registry seed service port.","format":"int32","type":"integer"},"service_id":{"description":"ID of Redpanda AWS PrivateLink Endpoint Service.","example":"vpce-svc-05fff2117d648da35","type":"string"},"service_name":{"description":"Name of Redpanda AWS PrivateLink Endpoint Service.","example":"com.amazonaws.vpce.us-west-2.vpce-svc-05fff2117d648da35","type":"string"},"service_state":{"description":"State of Redpanda AWS PrivateLink Endpoint Service.","example":"Pending | Available | Deleting | Deleted | Failed","type":"string"},"vpc_endpoint_connections":{"description":"List of VPC endpoints with established connections to Redpanda AWS PrivateLink Endpoint Service.","items":{"$ref":"#/components/schemas/VPCEndpointConnection"},"type":"array"}},"type":"object"},"AWSPrivateLinkSpec":{"description":"AWS PrivateLink specification.","properties":{"allowed_principals":{"description":"The ARN of the principals that can access Redpanda AWS PrivateLink Endpoint Service. To grant permissions to all principals, use an asterisk (*).","example":["arn:aws:iam::account-number-without-hyphens:user/username or arn:aws:iam::account-number-without-hyphens:root"],"items":{"type":"string"},"type":"array"},"connect_console":{"description":"Whether Console is connected in Redpanda AWS Private Link Service. The default is true if not set.","nullable":true,"type":"boolean"},"enabled":{"description":"Whether Redpanda AWS Private Link Endpoint Service is enabled.","type":"boolean"},"http_proxy_auth_mode":{"$ref":"#/components/schemas/PrivateLinkAuthMode"},"kafka_api_auth_mode":{"$ref":"#/components/schemas/PrivateLinkAuthMode"},"schema_registry_auth_mode":{"$ref":"#/components/schemas/PrivateLinkAuthMode"}},"type":"object"},"AWSSecurityGroup":{"description":"Security Group identifies AWS security group.","properties":{"arn":{"description":"AWS security group ARN.","type":"string"}},"required":["arn"],"title":"Security Group","type":"object"},"Anytime":{"type":"object"},"AzurePrivateLink":{"properties":{"allowed_subscriptions":{"description":"The subscriptions that can access the Redpanda Azure PrivateLink Endpoint Service. To grant permissions to all principals, use an asterisk (*).","example":["4a73b02e-90c1-4d76-af36-5c935dd41e7c"],"items":{"type":"string"},"type":"array"},"connect_console":{"description":"Whether Console is connected in Redpanda Azure Private Link Service.","type":"boolean"},"enabled":{"description":"Whether Redpanda AWS Private Link Endpoint Service is enabled.","type":"boolean"},"http_proxy_auth_mode":{"$ref":"#/components/schemas/PrivateLinkAuthMode"},"kafka_api_auth_mode":{"$ref":"#/components/schemas/PrivateLinkAuthMode"},"schema_registry_auth_mode":{"$ref":"#/components/schemas/PrivateLinkAuthMode"},"status":{"$ref":"#/components/schemas/AzurePrivateLink.Status"}},"type":"object"},"AzurePrivateLink.Status":{"properties":{"approved_subscriptions":{"items":{"type":"string"},"title":"These are the approved subscriptions on the private link","type":"array"},"console_port":{"description":"The port of Redpanda Console.","format":"int32","type":"integer"},"created_at":{"description":"Redpanda Azure PrivateLink Endpoint Service creation timestamp.","format":"date-time","type":"string"},"deleted_at":{"description":"Redpanda Azure PrivateLink Service deletion timestamp.","format":"date-time","type":"string"},"dns_a_record":{"title":"dns_a_dns_a_recordrecord is the DNS A record the customer will create pointing at the their PE","type":"string"},"kafka_api_node_base_port":{"description":"Kafka API node service base port. The port for node `i` (0 .. node_count-1) is kafka_api_node_base_port + `i`.","format":"int32","type":"integer"},"kafka_api_seed_port":{"description":"Kafka API seed service port.","format":"int32","type":"integer"},"private_endpoint_connections":{"description":"List of private endpoint connections to Redpanda Azure Private Link Service.","items":{"$ref":"#/components/schemas/PrivateEndpointConnection"},"type":"array"},"redpanda_proxy_node_base_port":{"description":"HTTP Proxy node service base port. The port for node `i` (0 .. node_count-1) is redpanda_proxy_node_base_port + i.","format":"int32","type":"integer"},"redpanda_proxy_seed_port":{"description":"HTTP Proxy seed service port.","format":"int32","type":"integer"},"schema_registry_seed_port":{"description":"Schema Registry seed service port.","format":"int32","type":"integer"},"service_id":{"description":"ID of Redpanda Azure PrivateLink Endpoint Service.","example":"/subscriptions/\u003csub-id\u003e/resourceGroups/\u003crg-id\u003e/providers/Microsoft.Network/privateLinkServices/\u003cname\u003e","type":"string"},"service_name":{"description":"Name of Redpanda Azure PrivateLink Endpoint Service.","example":"pls-name","type":"string"}},"type":"object"},"AzurePrivateLinkSpec":{"properties":{"allowed_subscriptions":{"description":"The subscriptions that can access the Redpanda Azure PrivateLink Endpoint Service.","example":["4a73b02e-90c1-4d76-af36-5c935dd41e7c"],"items":{"type":"string"},"type":"array"},"connect_console":{"description":"Whether Console is connected in Redpanda Azure Private Link Service. The default is true if not set.","nullable":true,"type":"boolean"},"enabled":{"description":"Enabled controls if Azure Private Link Endpoint Service is enabled.","type":"boolean"},"http_proxy_auth_mode":{"$ref":"#/components/schemas/PrivateLinkAuthMode"},"kafka_api_auth_mode":{"$ref":"#/components/schemas/PrivateLinkAuthMode"},"schema_registry_auth_mode":{"$ref":"#/components/schemas/PrivateLinkAuthMode"}},"type":"object"},"BadRequest":{"description":"Describes violations in a client request. This error type focuses on the\nsyntactic aspects of the request.","properties":{"field_violations":{"description":"Describes all violations in a client request.","items":{"$ref":"#/components/schemas/FieldViolation"},"type":"array"}},"title":"BadRequest","type":"object"},"CIDR":{"description":"Additional CIDRs allocated to Redpanda cluster.","properties":{"aks_service_cidr":{"description":"CIDR used by AKS Kubernetes services.","type":"string"}},"required":["aks_service_cidr"],"title":"CIDR","type":"object"},"CloudProvider":{"description":"Cloud provider where resources are created.","enum":["CLOUD_PROVIDER_AWS","CLOUD_PROVIDER_GCP","CLOUD_PROVIDER_AZURE"],"type":"string"},"Cluster":{"description":"Resource describing a Cluster.","properties":{"api_gateway_access":{"$ref":"#/components/schemas/NetworkAccessMode"},"aws_private_link":{"$ref":"#/components/schemas/AWSPrivateLink"},"azure_private_link":{"$ref":"#/components/schemas/AzurePrivateLink"},"cloud_provider":{"$ref":"#/components/schemas/CloudProvider"},"cloud_provider_tags":{"additionalProperties":{"type":"string"},"description":"Tags placed on cloud resources.\nIf the cloud provider is GCP and the name of a tag has the prefix \"gcp.network-tag.\", the tag\nis a network tag that will be added to the Redpanda cluster GKE nodes. Otherwise, the tag\nis a normal tag.\nFor example, if the name of a tag is \"gcp.network-tag.network-tag-foo\", the network tag named\n\"network-tag-foo\" will be added to the Redpanda cluster GKE nodes.\nNote: The value of a network tag will be ignored.\nSee the official [GCP VPC](https://cloud.google.com/vpc/docs/add-remove-network-tags) for more details on network tags.","type":"object"},"cloud_storage":{"$ref":"#/components/schemas/Cluster.CloudStorage"},"cluster_configuration":{"$ref":"#/components/schemas/Cluster.ClusterConfiguration"},"connection_type":{"$ref":"#/components/schemas/ConnectionType"},"created_at":{"description":"Cluster creation timestamp.","format":"date-time","type":"string"},"current_redpanda_version":{"description":"Current Redpanda version of the cluster.","type":"string"},"customer_managed_resources":{"$ref":"#/components/schemas/v1.CustomerManagedResources"},"dataplane_api":{"$ref":"#/components/schemas/Cluster.DataplaneAPI"},"desired_redpanda_version":{"description":"Desired Redpanda version of the cluster.","type":"string"},"gcp_global_access_enabled":{"nullable":true,"title":"gcp_enable_global_access control if global access is enabled on the seed load balancer, applicable only for GCP. Default is false","type":"boolean"},"gcp_private_service_connect":{"$ref":"#/components/schemas/GCPPrivateServiceConnect"},"http_proxy":{"$ref":"#/components/schemas/HTTPProxyStatus"},"id":{"description":"ID of the cluster. ID is an output from the Create Cluster endpoint and cannot be set by the caller.","type":"string"},"kafka_api":{"$ref":"#/components/schemas/Cluster.KafkaAPI"},"kafka_connect":{"$ref":"#/components/schemas/KafkaConnect"},"maintenance_window_config":{"$ref":"#/components/schemas/MaintenanceWindowConfig"},"name":{"description":"Unique name of the cluster.","example":"development-cluster","type":"string"},"nat_gateways":{"description":"NAT gateway information for the cluster.","items":{"type":"string"},"readOnly":true,"type":"array"},"network_id":{"description":"Network ID where cluster is placed.","example":"cjcuq79c4vs94fcufc2g","type":"string"},"prometheus":{"$ref":"#/components/schemas/Prometheus"},"read_replica_cluster_ids":{"description":"IDs of clusters which may create read-only topics from this cluster.","items":{"type":"string"},"type":"array"},"redpanda_console":{"$ref":"#/components/schemas/RedpandaConsole"},"redpanda_node_count":{"format":"int32","title":"Number of Redpanda broker nodes","type":"integer"},"region":{"description":"Region represents the name of the region where the cluster will be provisioned.","example":"us-central1","title":"Cloud provider region.","type":"string"},"resource_group_id":{"description":"Resource group ID of the cluster.","example":"a0b40af9-0250-48ca-9417-783ed127ce42","type":"string"},"schema_registry":{"$ref":"#/components/schemas/Cluster.SchemaRegistryStatus"},"state":{"$ref":"#/components/schemas/Cluster.State"},"state_description":{"$ref":"#/components/schemas/rpc.Status"},"throughput_tier":{"description":"Throughput tier of the cluster.","type":"string"},"type":{"$ref":"#/components/schemas/Cluster.Type"},"updated_at":{"description":"Cluster update timestamp.","format":"date-time","type":"string"},"zones":{"description":"Zones of the cluster. Must be valid zones within the selected region.\nIf multiple zones are used, the cluster is a multi-AZ cluster.","items":{"type":"string"},"type":"array"}},"title":"Cluster","type":"object"},"Cluster.CloudStorage":{"properties":{"aws":{"$ref":"#/components/schemas/Cluster.CloudStorage.AWS"},"azure":{"$ref":"#/components/schemas/Cluster.CloudStorage.Azure"},"gcp":{"$ref":"#/components/schemas/Cluster.CloudStorage.GCP"},"skip_destroy":{"type":"boolean"}},"type":"object"},"Cluster.CloudStorage.AWS":{"properties":{"arn":{"type":"string"}},"type":"object"},"Cluster.CloudStorage.Azure":{"properties":{"allowed_ips":{"description":"List of public IP or IP ranges in CIDR Format.\n\n- Only IPv4 addresses are allowed.\n- Private IP address ranges as defined in RFC 1918 are not allowed.\n- Private IP address ranges as defined in RFC 6598 are not allowed.\n- Small address ranges using \"/31\" or \"/32\" prefix sizes are not\nsupported. These ranges should be configured using individual IP\naddress rules without prefix specified.\n- allowed_ips have no effect on requests originating from the same\nAzure region as the storage account. Use allowed_subnet_ids to allow\nsame-region requests. Services deployed in the same region as the\nstorage account use private Azure IP addresses for communication. Thus,\nyou cannot allow access to specific Azure services based on their\npublic outbound IP address range.","items":{"type":"string"},"type":"array"},"allowed_subnet_ids":{"description":"A list of virtual network subnet IDs that are allowed to access the\nstorage account.","items":{"type":"string"},"type":"array"},"container_name":{"type":"string"},"resource_group_name":{"type":"string"},"storage_account_name":{"type":"string"},"subscription_id":{"type":"string"}},"type":"object"},"Cluster.CloudStorage.GCP":{"properties":{"name":{"type":"string"}},"type":"object"},"Cluster.ClusterConfiguration":{"properties":{"computed_properties":{"type":"object"},"custom_properties":{"type":"object"}},"type":"object"},"Cluster.DataplaneAPI":{"description":"Cluster's Data Plane API properties.","properties":{"url":{"description":"Data Plane API URL.","example":"https://api-ab1234l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com","readOnly":true,"type":"string"}},"type":"object"},"Cluster.KafkaAPI":{"description":"Cluster's Kafka API properties.","properties":{"all_seed_brokers":{"$ref":"#/components/schemas/SeedBrokers"},"mtls":{"$ref":"#/components/schemas/MTLSSpec"},"sasl":{"$ref":"#/components/schemas/SASLSpec"},"seed_brokers":{"description":"Kafka API Seed Brokers (also known as Bootstrap servers).","items":{"type":"string"},"type":"array"}},"type":"object"},"Cluster.SchemaRegistryStatus":{"description":"Cluster's Schema Registry properties.","properties":{"all_urls":{"$ref":"#/components/schemas/Endpoints"},"mtls":{"$ref":"#/components/schemas/MTLSSpec"},"sasl":{"$ref":"#/components/schemas/SASLSpec"},"url":{"description":"Schema Registry URL.","type":"string"}},"type":"object"},"Cluster.State":{"description":"State describes the state of the cluster.","enum":["STATE_CREATING_AGENT","STATE_CREATING","STATE_READY","STATE_DELETING","STATE_DELETING_AGENT","STATE_UPGRADING","STATE_FAILED","STATE_SUSPENDED"],"type":"string"},"Cluster.Type":{"description":"Cluster type. Type is immutable and can only be set on cluster creation.","enum":["TYPE_DEDICATED","TYPE_BYOC"],"type":"string"},"ClusterCreate":{"description":"Resource describing a Create Cluster.","properties":{"api_gateway_access":{"$ref":"#/components/schemas/NetworkAccessMode"},"aws_private_link":{"$ref":"#/components/schemas/AWSPrivateLinkSpec"},"azure_private_link":{"$ref":"#/components/schemas/AzurePrivateLinkSpec"},"cloud_provider":{"$ref":"#/components/schemas/CloudProvider"},"cloud_provider_tags":{"additionalProperties":{"type":"string"},"description":"Tags placed on cloud resources.\nA tag is a key value pair.\nIf the cloud provider is GCP and the key of a tag has the prefix \"gcp.network-tag.\",\nthe tag is a network tag that will be added to the Redpanda cluster GKE nodes.\nOtherwise, the tag is a normal provider tag or label.\nFor example, if the key of a tag is \"gcp.network-tag.network-tag-foo\",\nthe GCP network tag named \"network-tag-foo\" will be added to the Redpanda cluster GKE nodes.\nNote: If a tag is GCP network tag, its value will be ignored.\nSee the official [GCP VPC](https://cloud.google.com/vpc/docs/add-remove-network-tags) for more details on network tags.","type":"object"},"cloud_storage":{"$ref":"#/components/schemas/ClusterCreate.CloudStorage"},"cluster_configuration":{"$ref":"#/components/schemas/ClusterCreate.ClusterConfiguration"},"connection_type":{"$ref":"#/components/schemas/ConnectionType"},"customer_managed_resources":{"$ref":"#/components/schemas/v1.CustomerManagedResources"},"gcp_enable_global_access":{"title":"gcp_enable_global_access control if global access is enabled on the seed load balancer, applicable only for GCP. Default is false","type":"boolean"},"gcp_private_service_connect":{"$ref":"#/components/schemas/GCPPrivateServiceConnectSpec"},"http_proxy":{"$ref":"#/components/schemas/HTTPProxySpec"},"kafka_api":{"$ref":"#/components/schemas/KafkaAPISpec"},"kafka_connect":{"$ref":"#/components/schemas/KafkaConnect"},"maintenance_window_config":{"$ref":"#/components/schemas/MaintenanceWindowConfig"},"name":{"description":"Unique name of the cluster.","example":"development-cluster","type":"string"},"network_id":{"description":"Id of the network where the cluster will be placed.","example":"cjcuq79c4vs94fcufc2g","type":"string"},"read_replica_cluster_ids":{"description":"IDs of clusters that can create read-only topics from this cluster.","items":{"type":"string"},"type":"array"},"redpanda_version":{"description":"Cluster's Redpanda version. Only `major.minor` semver is supported, e.g. `24.1`.","nullable":true,"type":"string"},"region":{"description":"Cloud provider region where the cluster will be provisioned.","type":"string"},"resource_group_id":{"description":"Resource group ID of the cluster","example":"a0b40af9-0250-48ca-9417-783ed127ce42","type":"string"},"schema_registry":{"$ref":"#/components/schemas/SchemaRegistrySpec"},"throughput_tier":{"description":"[Throughput tier](https://docs.redpanda.com/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers) of the cluster. See also: Redpanda Cloud [Dedicated tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/dedicated-tiers/#dedicated-usage-tiers) and [BYOC tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/byoc-tiers/).","type":"string"},"type":{"$ref":"#/components/schemas/Cluster.Type"},"zones":{"description":"Cloud provider zones. Must be valid zones within the selected region.\nIf multiple zones are used, the cluster is a multi-AZ cluster.","items":{"type":"string"},"type":"array"}},"required":["name","resource_group_id","throughput_tier","type","network_id","cloud_provider","region","zones"],"title":"ClusterCreate","type":"object"},"ClusterCreate.CloudStorage":{"properties":{"aws":{"$ref":"#/components/schemas/ClusterCreate.CloudStorage.AWS"},"azure":{"$ref":"#/components/schemas/ClusterCreate.CloudStorage.Azure"},"gcp":{"$ref":"#/components/schemas/ClusterCreate.CloudStorage.GCP"},"skip_destroy":{"type":"boolean"}},"type":"object"},"ClusterCreate.CloudStorage.AWS":{"type":"object"},"ClusterCreate.CloudStorage.Azure":{"properties":{"allowed_ips":{"description":"List of public IP or IP ranges in CIDR Format.\n\n- Only IPv4 addresses are allowed.\n- Private IP address ranges as defined in RFC 1918 are not allowed.\n- Private IP address ranges as defined in RFC 6598 are not allowed.\n- Small address ranges using \"/31\" or \"/32\" prefix sizes are not\nsupported. These ranges should be configured using individual IP\naddress rules without prefix specified.\n- allowed_ips have no effect on requests originating from the same\nAzure region as the storage account. Use allowed_subnet_ids to allow\nsame-region requests. Services deployed in the same region as the\nstorage account use private Azure IP addresses for communication. Thus,\nyou cannot allow access to specific Azure services based on their\npublic outbound IP address range.","items":{"type":"string"},"type":"array"},"allowed_subnet_ids":{"description":"A list of virtual network subnet ids that are allowed to access the\nstorage account.","items":{"type":"string"},"type":"array"}},"type":"object"},"ClusterCreate.CloudStorage.GCP":{"type":"object"},"ClusterCreate.ClusterConfiguration":{"properties":{"custom_properties":{"type":"object"}},"type":"object"},"ClusterUpdate":{"description":"Resource describing an Update Cluster.","properties":{"api_gateway_access":{"$ref":"#/components/schemas/NetworkAccessMode"},"aws_private_link":{"$ref":"#/components/schemas/AWSPrivateLinkSpec"},"azure_private_link":{"$ref":"#/components/schemas/AzurePrivateLinkSpec"},"cloud_provider_tags":{"additionalProperties":{"type":"string"},"description":"Tags that are placed on Cloud resources.\nIf the cloud provider is GCP and the name of a tag has the prefix \"gcp.network-tag.\", the tag\nis a network tag that will be added to the Redpanda cluster GKE nodes. Otherwise, the tag\nis a normal tag.\nFor example, if the name of a tag is \"gcp.network-tag.network-tag-foo\", the network tag named\n\"network-tag-foo\" will be added to the Redpanda cluster GKE nodes.\nNote: The value of a network tag will be ignored.\nSee the official [GCP VPC](https://cloud.google.com/vpc/docs/add-remove-network-tags) for more details on network tags.","type":"object"},"cloud_storage":{"$ref":"#/components/schemas/ClusterUpdate.CloudStorage"},"cluster_configuration":{"$ref":"#/components/schemas/ClusterUpdate.ClusterConfiguration"},"customer_managed_resources":{"$ref":"#/components/schemas/CustomerManagedResourcesUpdate"},"gcp_private_service_connect":{"$ref":"#/components/schemas/GCPPrivateServiceConnectSpec"},"http_proxy":{"$ref":"#/components/schemas/HTTPProxySpec"},"id":{"description":"ID of the cluster.","type":"string"},"kafka_api":{"$ref":"#/components/schemas/KafkaAPISpec"},"kafka_connect":{"$ref":"#/components/schemas/KafkaConnect"},"maintenance_window_config":{"$ref":"#/components/schemas/MaintenanceWindowConfig"},"name":{"description":"Unique name of the cluster.","example":"development-cluster","type":"string"},"read_replica_cluster_ids":{"description":"IDs of clusters which may create read-only topics from this cluster.","items":{"type":"string"},"type":"array"},"redpanda_node_count":{"format":"int32","type":"integer"},"schema_registry":{"$ref":"#/components/schemas/SchemaRegistrySpec"},"throughput_tier":{"type":"string"}},"required":["id"],"title":"ClusterUpdate","type":"object"},"ClusterUpdate.CloudStorage":{"properties":{"aws":{"$ref":"#/components/schemas/ClusterUpdate.CloudStorage.AWS"},"azure":{"$ref":"#/components/schemas/ClusterUpdate.CloudStorage.Azure"},"gcp":{"$ref":"#/components/schemas/ClusterUpdate.CloudStorage.GCP"},"skip_destroy":{"type":"boolean"}},"type":"object"},"ClusterUpdate.CloudStorage.AWS":{"type":"object"},"ClusterUpdate.CloudStorage.Azure":{"properties":{"allowed_ips":{"description":"List of public IP or IP ranges in CIDR Format.\n\n- Only IPv4 addresses are allowed.\n- Private IP address ranges as defined in RFC 1918 are not allowed.\n- Private IP address ranges as defined in RFC 6598 are not allowed.\n- Small address ranges using \"/31\" or \"/32\" prefix sizes are not\nsupported. These ranges should be configured using individual IP\naddress rules without prefix specified.\n- allowed_ips have no effect on requests originating from the same\nAzure region as the storage account. Use allowed_subnet_ids to allow\nsame-region requests. Services deployed in the same region as the\nstorage account use private Azure IP addresses for communication. Thus,\nyou cannot allow access to specific Azure services based on their\npublic outbound IP address range.","items":{"type":"string"},"type":"array"},"allowed_subnet_ids":{"description":"A list of virtual network subnet ids that are allowed to access the\nstorage account.","items":{"type":"string"},"type":"array"}},"type":"object"},"ClusterUpdate.CloudStorage.GCP":{"type":"object"},"ClusterUpdate.ClusterConfiguration":{"properties":{"custom_properties":{"type":"object"}},"type":"object"},"ConnectedEndpoint":{"description":"ConnectedEndpoint defines endpoint connection connected to Redpanda GCP PSC (Private Service Connect) service.","properties":{"connection_id":{"description":"Connection ID of the endpoint.","type":"string"},"consumer_network":{"description":"Network of the consumer connecting to Redpanda GCP Private Service Connect service.\nSee the official [GCP documentation](https://www.googleapis.com/compute/v1/projects/my-project/global/networks/vpc-consumer-psc) for Private Service Connect.","type":"string"},"endpoint":{"description":"Connection endpoint.\nSee the official [GCP API reference](https://www.googleapis.com/compute/v1/projects/my-project/regions/us-west2/forwardingRules/vpc-consumer-psc) for Private Service Connect.","type":"string"},"status":{"description":"Endpoint status (ACCEPTED | REJECTED).\n\nThe ServiceAttachment API resource (https://cloud.google.com/compute/docs/reference/rest/v1/serviceAttachments)\n does have more fields, such as connection ID \u0026 consumer network, but the Terraform provider\n (https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_service_attachment#nested_connected_endpoints)\n doesn't return them as outputs.","type":"string"}},"type":"object"},"ConnectionType":{"description":"Cluster connection type.\nPrivate clusters are not exposed to the internet.\nFor BYOC clusters, **Private** is best-practice.","enum":["CONNECTION_TYPE_PUBLIC","CONNECTION_TYPE_PRIVATE"],"type":"string"},"CreateClusterMetadata":{"description":"Resource describing an in-progress CreateCluster Operation.","properties":{"cluster_id":{"description":"ID of the Cluster created by this operation.","type":"string"}},"title":"CreateClusterMetadata","type":"object"},"CreateClusterOperation":{"description":"CreateClusterOperation is the response of the create cluster rpc.","properties":{"operation":{"$ref":"#/components/schemas/v1.Operation"}},"type":"object"},"CreateClusterRequest":{"description":"CreateClusterRequest is the request of CreateCluster.","properties":{"cluster":{"$ref":"#/components/schemas/ClusterCreate"}},"type":"object"},"CreateClusterResponse":{"description":"CreateClusterResponse is the request of CreateCluster.","properties":{"cluster":{"$ref":"#/components/schemas/Cluster"}},"type":"object"},"CreateNetworkMetadata":{"description":"Resource describing an in-progress CreateNetwork Operation.","properties":{"network_id":{"description":"ID of the network created by this Operation.","type":"string"}},"title":"CreateNetworkMetadata","type":"object"},"CreateNetworkOperation":{"description":"CreateNetworkOperation is the response of the create network rpc.","properties":{"operation":{"$ref":"#/components/schemas/v1.Operation"}},"type":"object"},"CreateNetworkRequest":{"description":"CreateNetworkRequest is the request of CreateNetwork.","properties":{"network":{"$ref":"#/components/schemas/NetworkCreate"}},"required":["network"],"type":"object"},"CreateNetworkResponse":{"description":"CreateNetworkResponse is the request of CreateNetwork.","properties":{"network":{"$ref":"#/components/schemas/Network"}},"type":"object"},"CreateResourceGroupRequest":{"description":"CreateResourceGroupRequest is the request of CreateResourceGroup.","properties":{"resource_group":{"$ref":"#/components/schemas/ResourceGroupCreate"}},"type":"object"},"CreateResourceGroupResponse":{"description":"CreateResourceGroupResponse is the response of CreateResourceGroup.","properties":{"resource_group":{"$ref":"#/components/schemas/ResourceGroup"}},"type":"object"},"CreateRoleBindingRequest":{"description":"CreateRoleBindingRequest is the request of CreateRoleBinding.","properties":{"role_binding":{"$ref":"#/components/schemas/RoleBindingCreate"}},"type":"object"},"CreateRoleBindingResponse":{"properties":{"role_binding":{"$ref":"#/components/schemas/v1.RoleBinding"}},"type":"object"},"CreateServerlessClusterOperation":{"description":"CreateServerlessClusterOperation is the response of the create serverless_cluster rpc.","properties":{"operation":{"$ref":"#/components/schemas/v1.Operation"}},"type":"object"},"CreateServerlessClusterRequest":{"description":"CreateServerlessClusterRequest is the request of CreateServerlessCluster.","properties":{"serverless_cluster":{"$ref":"#/components/schemas/ServerlessClusterCreate"}},"type":"object"},"CreateServiceAccountRequest":{"description":"CreateServiceAccountRequest is the request of CreateServiceAccount.","properties":{"service_account":{"$ref":"#/components/schemas/ServiceAccountCreate"}},"type":"object"},"CreateServiceAccountResponse":{"properties":{"service_account":{"$ref":"#/components/schemas/ServiceAccount"}},"type":"object"},"CreateUserInviteRequest":{"properties":{"user_invite":{"$ref":"#/components/schemas/UserInviteCreate"}},"type":"object"},"CreateUserInviteResponse":{"properties":{"user_invite":{"$ref":"#/components/schemas/UserInvite"}},"type":"object"},"CustomerManagedAWSCloudStorageBucket":{"description":"AWS storage bucket properties by ARN.","properties":{"arn":{"description":"AWS storage bucket identifier.","type":"string"}},"required":["arn"],"title":"AWS Storage Bucket","type":"object"},"CustomerManagedAWSSubnets":{"description":"AWS Subnets Specification","properties":{"arns":{"description":"AWS subnet identifiers.","items":{"type":"string"},"type":"array"}},"required":["arns"],"title":"AWS Subnets","type":"object"},"CustomerManagedAWSVPC":{"description":"AWS VPC Specification","properties":{"arn":{"description":"AWS VPC identifier.","type":"string"}},"required":["arn"],"title":"AWS VPC","type":"object"},"CustomerManagedAzureBucketSpec":{"description":"Azure Bucket Specification","properties":{"resource_group":{"$ref":"#/components/schemas/CustomerManagedAzureResourceGroupSpec"},"storage_account_name":{"title":"Naming convention: Between 3 and 24 characters and use numbers and lower-case letters only.\nhttps://learn.microsoft.com/en-us/rest/api/storagerp/storage-accounts/create?view=rest-storagerp-2023-05-01\u0026tabs=HTTP","type":"string"},"storage_container_name":{"title":"Naming convention: Between 3 and 63 characters and use numbers, lower-case letters and dash (-) only.\n                   Every dash (-) character must be immediately preceded and followed by a letter or number.\nhttps://learn.microsoft.com/en-us/rest/api/storagerp/blob-containers/create?view=rest-storagerp-2023-05-01\u0026tabs=HTTP","type":"string"}},"required":["storage_account_name","storage_container_name"],"title":"Azure Bucket","type":"object"},"CustomerManagedAzureResourceGroupSpec":{"description":"Azure Resource Group Specification","properties":{"name":{"title":"Naming convention: Between 1 and 90 characters long. Alphanumerics, underscores, parentheses, hyphens, periods. Can't end with period.\nhttps://azure.github.io/PSRule.Rules.Azure/en/rules/Azure.ResourceGroup.Name/","type":"string"}},"required":["name"],"title":"Azure Resource Group","type":"object"},"CustomerManagedDynamoDBTable":{"description":"AWS DynamoDB table specification.","properties":{"arn":{"description":"AWS DynamoDB table identifier.","type":"string"}},"required":["arn"],"title":"AWS DynamoDB Table","type":"object"},"CustomerManagedGoogleCloudStorageBucket":{"description":"GCP storage bucket properties.","properties":{"name":{"description":"Name of GCP storage bucket. See the official [GCP documentation](https://cloud.google.com/storage/docs/buckets#naming) for naming restrictions.","type":"string"}},"required":["name"],"title":"GCP Storage Bucket","type":"object"},"CustomerManagedResourcesUpdate":{"properties":{"aws":{"$ref":"#/components/schemas/CustomerManagedResourcesUpdate.AWS"},"gcp":{"$ref":"#/components/schemas/CustomerManagedResourcesUpdate.GCP"}},"title":"The cloud resources created by user that can be updated","type":"object"},"CustomerManagedResourcesUpdate.AWS":{"description":"AWS resources managed by user.","properties":{"redpanda_connect_node_group_instance_profile":{"$ref":"#/components/schemas/AWSInstanceProfile"},"redpanda_connect_security_group":{"$ref":"#/components/schemas/AWSSecurityGroup"}},"title":"AWS Customer-Managed Resoures","type":"object"},"CustomerManagedResourcesUpdate.GCP":{"description":"GCP resources managed by user.","properties":{"psc_nat_subnet_name":{"description":"NAT subnet name if GCP Private Service Connect (a.k.a. Private Link) is enabled.\nIf it is used for PSC v1, use psc_v2_nat_subnet_name to set NAT subnet name for PSC v2.","type":"string"},"psc_v2_nat_subnet_name":{"description":"NAT subnet name for PSC v2 if GCP Private Service Connect (a.k.a. Private Link) is enabled and\npsc_nat_subnet_name is used for PSC v1.","type":"string"},"redpanda_connect_api_service_account":{"$ref":"#/components/schemas/GCPServiceAccount"},"redpanda_connect_service_account":{"$ref":"#/components/schemas/GCPServiceAccount"},"redpanda_operator_service_account":{"$ref":"#/components/schemas/GCPServiceAccount"}},"title":"GCP Customer-Managed Resoures","type":"object"},"DNSEntry":{"properties":{"dns_name":{"description":"DNS entry of VPC endpoint connected to Redpanda AWS PrivateLink Endpoint Service.","example":"vpce-0751b7ad8a51777f2-1hpievf5.vpce-svc-0d489fa89f24e3802.us-east-2.vpce.amazonaws.com","type":"string"},"hosted_zone_id":{"description":"The ID of Route53 DNS zone.","type":"string"}},"type":"object"},"DayHour":{"properties":{"day_of_week":{"$ref":"#/components/schemas/DayOfWeek"},"hour_of_day":{"format":"int32","title":"always UTC","type":"integer"}},"type":"object"},"DayOfWeek":{"description":"Represents a day of the week.\n\n - MONDAY: Monday\n - TUESDAY: Tuesday\n - WEDNESDAY: Wednesday\n - THURSDAY: Thursday\n - FRIDAY: Friday\n - SATURDAY: Saturday\n - SUNDAY: Sunday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"DeleteClusterMetadata":{"description":"Resource describing an in-progress DeleteCluster Operation.","properties":{"required_action":{"type":"string"}},"title":"DeleteClusterMetadata","type":"object"},"DeleteClusterOperation":{"description":"DeleteClusterOperation is the response of the delete cluster rpc.","properties":{"operation":{"$ref":"#/components/schemas/v1.Operation"}},"type":"object"},"DeleteClusterResponse":{"description":"DeleteClusterResponse is the request of DeleteCluster.","type":"object"},"DeleteNetworkMetadata":{"description":"Resource describing an in-progress DeleteNetwork Operation.","title":"DeleteNetworkMetadata","type":"object"},"DeleteNetworkOperation":{"description":"DeleteNetworkOperation is the response of the delete network rpc.","properties":{"operation":{"$ref":"#/components/schemas/v1.Operation"}},"type":"object"},"DeleteNetworkResponse":{"description":"DeleteNetworkResponse is the response of DeleteNetwork.","type":"object"},"DeleteResourceGroupResponse":{"description":"DeleteResourceGroupResponse is the response of DeleteResourceGroup.","type":"object"},"DeleteRoleBindingResponse":{"description":"DeleteRoleBindingResponse is the response of DeleteRoleBinding.","type":"object"},"DeleteServerlessClusterOperation":{"description":"DeleteServerlessClusterOperation is the response of the delete serverless_cluster rpc.","properties":{"operation":{"$ref":"#/components/schemas/v1.Operation"}},"type":"object"},"DeleteServiceAccountResponse":{"type":"object"},"DeleteUserInviteResponse":{"type":"object"},"DeleteUserResponse":{"type":"object"},"Endpoints":{"description":"The endpoints of Redpanda HTTP Proxy or Schema Registry.","properties":{"mtls":{"description":"URL of the seed broker for mTLS. If mTLS is not enabled, the field is empty.","type":"string"},"private_link_mtls":{"description":"URL of the seed broker for private link with mTLS. If private link with mTLS is not enabled, the field is empty.","type":"string"},"private_link_sasl":{"description":"URL of the seed broker for private link with SASL. If private link with SASL is not enabled, the field is empty.","type":"string"},"sasl":{"description":"URL of the seed broker for SASL. If SASL is not enabled, the field is empty.","type":"string"}},"type":"object"},"ErrorInfo":{"description":"Describes the cause of the error with structured details.\n\nExample of an error when contacting the \"pubsub.googleapis.com\" API when it\nis not enabled:\n\n    { \"reason\": \"API_DISABLED\"\n      \"domain\": \"googleapis.com\"\n      \"metadata\": {\n        \"resource\": \"projects/123\",\n        \"service\": \"pubsub.googleapis.com\"\n      }\n    }\n\nThis response indicates that the pubsub.googleapis.com API is not enabled.\n\nExample of an error that is returned when attempting to create a Spanner\ninstance in a region that is out of stock:\n\n    { \"reason\": \"STOCKOUT\"\n      \"domain\": \"spanner.googleapis.com\",\n      \"metadata\": {\n        \"availableRegions\": \"us-central1,us-east2\"\n      }\n    }","properties":{"domain":{"description":"The logical grouping to which the \"reason\" belongs. The error domain\nis typically the registered service name of the tool or product that\ngenerates the error. Example: \"pubsub.googleapis.com\". If the error is\ngenerated by some common infrastructure, the error domain must be a\nglobally unique value that identifies the infrastructure. For Google API\ninfrastructure, the error domain is \"googleapis.com\".","type":"string"},"metadata":{"additionalProperties":{"type":"string"},"description":"Additional structured details about this error.\n\nKeys must match a regular expression of `[a-z][a-zA-Z0-9-_]+` but should\nideally be lowerCamelCase. Also, they must be limited to 64 characters in\nlength. When identifying the current value of an exceeded limit, the units\nshould be contained in the key, not the value.  For example, rather than\n`{\"instanceLimit\": \"100/request\"}`, should be returned as,\n`{\"instanceLimitPerRequest\": \"100\"}`, if the client exceeds the number of\ninstances that can be created in a single (batch) request.","type":"object"},"reason":{"description":"The reason of the error. This is a constant value that identifies the\nproximate cause of the error. Error reasons are unique within a particular\ndomain of errors. This should be at most 63 characters and match a\nregular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents\nUPPER_SNAKE_CASE.","type":"string"}},"title":"ErrorInfo","type":"object"},"FieldViolation":{"description":"A message type used to describe a single bad request field.","properties":{"description":{"description":"A description of why the request element is bad.","type":"string"},"field":{"description":"A path that leads to a field in the request body. The value will be a\nsequence of dot-separated identifiers that identify a protocol buffer\nfield.\n\nConsider the following:\n\n    message CreateContactRequest {\n      message EmailAddress {\n        enum Type {\n          TYPE_UNSPECIFIED = 0;\n          HOME = 1;\n          WORK = 2;\n        }\n\n        optional string email = 1;\n        repeated EmailType type = 2;\n      }\n\n      string full_name = 1;\n      repeated EmailAddress email_addresses = 2;\n    }\n\nIn this example, in proto `field` could take one of the following values:\n\n* `full_name` for a violation in the `full_name` value\n* `email_addresses[1].email` for a violation in the `email` field of the\n  first `email_addresses` message\n* `email_addresses[3].type[2]` for a violation in the second `type`\n  value in the third `email_addresses` message.\n\nIn JSON, the same values are represented as:\n\n* `fullName` for a violation in the `fullName` value\n* `emailAddresses[1].email` for a violation in the `email` field of the\n  first `emailAddresses` message\n* `emailAddresses[3].type[2]` for a violation in the second `type`\n  value in the third `emailAddresses` message.","type":"string"},"localized_message":{"$ref":"#/components/schemas/LocalizedMessage"},"reason":{"description":"The reason of the field-level error. This is a constant value that\nidentifies the proximate cause of the field-level error. It should\nuniquely identify the type of the FieldViolation within the scope of the\ngoogle.rpc.ErrorInfo.domain. This should be at most 63\ncharacters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`,\nwhich represents UPPER_SNAKE_CASE.","type":"string"}},"type":"object"},"GCP.Subnet":{"description":"GCP subnet properties. See the official [GCP API reference](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks).","properties":{"k8s_master_ipv4_range":{"description":"Kubernetes Master IPv4 range, e.g. 10.0.0.0/24.","type":"string"},"name":{"description":"Subnet name.","type":"string"},"secondary_ipv4_range_pods":{"$ref":"#/components/schemas/SecondaryIPv4Range"},"secondary_ipv4_range_services":{"$ref":"#/components/schemas/SecondaryIPv4Range"}},"required":["name","secondary_ipv4_range_pods","secondary_ipv4_range_services","k8s_master_ipv4_range"],"title":"Subnet","type":"object"},"GCPPrivateServiceConnect":{"properties":{"consumer_accept_list":{"description":"List of consumers that are allowed to connect to Redpanda GCP PSC (Private Service Connect) service attachment.","items":{"$ref":"#/components/schemas/GCPPrivateServiceConnectConsumer"},"type":"array"},"enabled":{"description":"Whether Redpanda GCP Private Service Connect is enabled.","type":"boolean"},"global_access_enabled":{"description":"Whether global access is enabled.","type":"boolean"},"http_proxy_auth_mode":{"$ref":"#/components/schemas/PrivateLinkAuthMode"},"kafka_api_auth_mode":{"$ref":"#/components/schemas/PrivateLinkAuthMode"},"schema_registry_auth_mode":{"$ref":"#/components/schemas/PrivateLinkAuthMode"},"status":{"$ref":"#/components/schemas/GCPPrivateServiceConnect.Status"}},"type":"object"},"GCPPrivateServiceConnect.Status":{"properties":{"connected_endpoints":{"description":"List of VPC endpoints with established connections to GCP Private Service Connect.","items":{"$ref":"#/components/schemas/ConnectedEndpoint"},"type":"array"},"created_at":{"description":"Redpanda GCP Private Service Connect service creation timestamp.","format":"date-time","type":"string"},"deleted_at":{"description":"Redpanda GCP Private Service Connect service deletion timestamp.","format":"date-time","type":"string"},"dns_a_records":{"description":"Customer-created DNS A records that point at the PSC endpoint on the consumer side.","items":{"type":"string"},"type":"array"},"kafka_api_node_base_port":{"description":"Kafka API node service base port. The port for node `i` (0 .. node_count-1) is kafka_api_node_base_port + `i`.","format":"int32","type":"integer"},"kafka_api_seed_port":{"description":"Kafka API seed service port.","format":"int32","type":"integer"},"redpanda_proxy_node_base_port":{"description":"HTTP Proxy node service base port. The port for node `i` (0 .. node_count-1) is redpanda_proxy_node_base_port + `i`.","format":"int32","type":"integer"},"redpanda_proxy_seed_port":{"description":"HTTP Proxy seed service port.","format":"int32","type":"integer"},"schema_registry_seed_port":{"description":"Schema Registry seed service port.","format":"int32","type":"integer"},"seed_hostname":{"description":"Hostname for clients to initiate connections to the APIs exposed through Private Service Connect.","type":"string"},"service_attachment":{"description":"Service attachment used by consumers to create endpoint connections to Redpanda GCP Private Service Connect service.","type":"string"}},"type":"object"},"GCPPrivateServiceConnectConsumer":{"description":"GCP Private Service Connect consumer specifications.","properties":{"source":{"description":"Either the GCP project number or its alphanumeric ID.","example":"gcp-project-1","type":"string"}},"type":"object"},"GCPPrivateServiceConnectSpec":{"properties":{"consumer_accept_list":{"description":"List of consumers that are allowed to connect to Redpanda GCP PSC (Private Service Connect) service attachment.","items":{"$ref":"#/components/schemas/GCPPrivateServiceConnectConsumer"},"type":"array"},"enabled":{"description":"Whether Redpanda GCP Private Service Connect is enabled.","type":"boolean"},"global_access_enabled":{"description":"Whether global access is enabled.","type":"boolean"},"http_proxy_auth_mode":{"$ref":"#/components/schemas/PrivateLinkAuthMode"},"kafka_api_auth_mode":{"$ref":"#/components/schemas/PrivateLinkAuthMode"},"schema_registry_auth_mode":{"$ref":"#/components/schemas/PrivateLinkAuthMode"}},"type":"object"},"GCPServiceAccount":{"description":"GCP service account.","properties":{"email":{"description":"GCP service account email.","type":"string"}},"required":["email"],"title":"Service Account","type":"object"},"GetClusterResponse":{"description":"GetClusterResponse is the request of GetCluster.","properties":{"cluster":{"$ref":"#/components/schemas/Cluster"}},"type":"object"},"GetCurrentOrganizationResponse":{"properties":{"organization":{"$ref":"#/components/schemas/Organization"}},"title":"GetCurrentOrganizationResponse the response of the the\nGetCurrentOrganization rpc","type":"object"},"GetNetworkResponse":{"description":"GetNetworkRequest is the request of GetNetwork.","properties":{"network":{"$ref":"#/components/schemas/Network"}},"type":"object"},"GetOperationResponse":{"properties":{"operation":{"$ref":"#/components/schemas/v1.Operation"}},"title":"GetOperationResponse is the request of GetOperation","type":"object"},"GetRegionResponse":{"properties":{"region":{"$ref":"#/components/schemas/Region"}},"type":"object"},"GetResourceGroupResponse":{"description":"GetResourceGroupResponse is the response of GetResourceGroup.","properties":{"resource_group":{"$ref":"#/components/schemas/ResourceGroup"}},"type":"object"},"GetRoleBindingResponse":{"properties":{"role_binding":{"$ref":"#/components/schemas/v1.RoleBinding"}},"type":"object"},"GetServerlessClusterResponse":{"description":"GetServerlessClusterResponse is the request of GetServerlessCluster.","properties":{"serverless_cluster":{"$ref":"#/components/schemas/ServerlessCluster"}},"type":"object"},"GetServerlessRegionResponse":{"description":"GetServerlessRegionResponse is the response of GetServerlessRegions.","properties":{"serverless_region":{"$ref":"#/components/schemas/ServerlessRegion"}},"type":"object"},"GetServiceAccountCredentialsResponse":{"properties":{"credentials":{"$ref":"#/components/schemas/ServiceAccountCredentials"}},"type":"object"},"GetServiceAccountResponse":{"properties":{"service_account":{"$ref":"#/components/schemas/ServiceAccount"}},"type":"object"},"GetUserInviteResponse":{"properties":{"user_invite":{"$ref":"#/components/schemas/UserInvite"}},"type":"object"},"GetUserResponse":{"properties":{"user":{"$ref":"#/components/schemas/User"}},"type":"object"},"HTTPProxySpec":{"description":"Cluster's HTTP Proxy properties. See [Use Redpanda with the HTTP Proxy API](https://docs.redpanda.com/redpanda-cloud/develop/http-proxy/) and the [HTTP Proxy API reference](https://docs.redpanda.com/api/doc/http-proxy) for more information.","properties":{"mtls":{"$ref":"#/components/schemas/MTLSSpec"},"sasl":{"$ref":"#/components/schemas/SASLSpec"}},"type":"object"},"HTTPProxyStatus":{"description":"HTTP Proxy properties.","properties":{"all_urls":{"$ref":"#/components/schemas/Endpoints"},"mtls":{"$ref":"#/components/schemas/MTLSSpec"},"sasl":{"$ref":"#/components/schemas/SASLSpec"},"url":{"description":"HTTP Proxy URL of cluster.","example":"https://pandaproxy-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com:9092","readOnly":true,"type":"string"}},"type":"object"},"Help":{"description":"Provides links to documentation or for performing an out of band action.\n\nFor example, if a quota check failed with an error indicating the calling\nproject hasn't enabled the accessed service, this can contain a URL pointing\ndirectly to the right place in the developer console to flip the bit.","properties":{"links":{"description":"URL(s) pointing to additional information on handling the current error.","items":{"$ref":"#/components/schemas/Link"},"type":"array"}},"title":"Help","type":"object"},"KafkaAPISpec":{"description":"Cluster's Kafka API properties.","properties":{"mtls":{"$ref":"#/components/schemas/MTLSSpec"},"sasl":{"$ref":"#/components/schemas/SASLSpec"}},"type":"object"},"KafkaConnect":{"properties":{"enabled":{"type":"boolean"}},"type":"object"},"KeyVault":{"description":"Azure Key Vault.","properties":{"name":{"title":"Naming convention: Between 3 and 24 characters and begin with a letter, end with a letter or digit, and not contain consecutive hyphens.\nhttps://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules","type":"string"}},"required":["name"],"type":"object"},"KeyVaults":{"description":"Azure key vaults used by Redpanda Cluster. All key vaults shall be in redpanda_resource_group.","properties":{"console_vault":{"$ref":"#/components/schemas/KeyVault"},"management_vault":{"$ref":"#/components/schemas/KeyVault"}},"required":["management_vault","console_vault"],"title":"Azure Key Vaults","type":"object"},"Link":{"description":"Describes a URL link.","properties":{"description":{"description":"Describes what the link offers.","type":"string"},"url":{"description":"The URL of the link.","type":"string"}},"type":"object"},"ListAvailableOrganizationsResponse":{"properties":{"next_page_token":{"type":"string"},"organizations":{"items":{"$ref":"#/components/schemas/Organization"},"type":"array"}},"title":"GetAvalableOrganizationsResponse the response of the\nGetAvalableOrganizations rpc","type":"object"},"ListClustersRequest.Filter":{"properties":{"cloud_provider":{"$ref":"#/components/schemas/CloudProvider"},"name_contains":{"description":"Name of cluster.","type":"string"},"network_id":{"description":"Network ID.","type":"string"},"region":{"description":"Cloud provider region.","type":"string"},"resource_group_id":{"description":"Resource group ID.","type":"string"}},"type":"object"},"ListClustersResponse":{"description":"ListClustersResponse is the response of ListClusters.","properties":{"clusters":{"description":"Clusters matching the request.","items":{"$ref":"#/components/schemas/Cluster"},"maxItems":100,"type":"array"},"next_page_token":{"description":"Page token to fetch the next page. The value can be used as `next_page_token` in the next call to this endpoint.","type":"string"}},"type":"object"},"ListNetworksRequest.Filter":{"properties":{"cloud_provider":{"$ref":"#/components/schemas/CloudProvider"},"name_contains":{"description":"Name of network.","type":"string"},"region":{"description":"Name of cloud provider region.","type":"string"},"resource_group_id":{"description":"Resource group ID.","type":"string"}},"type":"object"},"ListNetworksResponse":{"description":"ListNetworksResponse is the response of ListNetworks.","properties":{"networks":{"description":"Networks matching the request","items":{"$ref":"#/components/schemas/Network"},"maxItems":100,"type":"array"},"next_page_token":{"type":"string"}},"type":"object"},"ListOperationsRequest.Filter":{"properties":{"resource_id":{"type":"string"},"state":{"$ref":"#/components/schemas/Operation.State"},"type_in":{"items":{"$ref":"#/components/schemas/Operation.Type"},"type":"array"}},"type":"object"},"ListOperationsResponse":{"properties":{"next_page_token":{"description":"Page Token to fetch the next page. The value can be used as\nnext_page_token in the next call to this endpoint. since the pagination is\ncursor based the last page will be encountered when the next page token is\nnot set and the operations list is empty.","type":"string"},"operations":{"description":"Operations matching the request","items":{"$ref":"#/components/schemas/v1.Operation"},"maxItems":100,"type":"array"}},"title":"ListOperationsResponse is the response of ListOperations","type":"object"},"ListRegionsRequest.Filter":{"properties":{"cluster_type":{"$ref":"#/components/schemas/Cluster.Type"}},"type":"object"},"ListRegionsResponse":{"properties":{"next_page_token":{"description":"Page token to fetch the next page. The value can be used as `next_page_token` in the next call to this endpoint.","type":"string"},"regions":{"items":{"$ref":"#/components/schemas/Region"},"type":"array"}},"type":"object"},"ListResourceGroupsRequest.Filter":{"properties":{"name_contains":{"description":"Name of resource group. Partial match.","type":"string"}},"type":"object"},"ListResourceGroupsResponse":{"description":"ListResourceGroupsResponse is the response of ListResourceGroups.","properties":{"next_page_token":{"type":"string"},"resource_groups":{"description":"Matching resource groups.","items":{"$ref":"#/components/schemas/ResourceGroup"},"maxItems":100,"type":"array"}},"type":"object"},"ListRoleBindingsRequest.Filter":{"properties":{"account":{"nullable":true,"type":"string"},"account_ids":{"items":{"type":"string"},"type":"array"},"role_name":{"nullable":true,"type":"string"},"scope":{"$ref":"#/components/schemas/Scope"}},"type":"object"},"ListRoleBindingsResponse":{"description":"ListRoleBindingsResponse is the response of ListRoleBindings.","properties":{"next_page_token":{"type":"string"},"role_bindings":{"description":"RoleBindings matching the request","items":{"$ref":"#/components/schemas/v1.RoleBinding"},"maxItems":100,"type":"array"}},"type":"object"},"ListServerlessClustersRequest.Filter":{"properties":{"name_contains":{"description":"Name of cluster. Partial match.","type":"string"},"resource_group_id":{"description":"Resource group ID of Serverless cluster.","type":"string"},"serverless_region":{"title":"Region in which Serverless cluster is hosted","type":"string"},"state_in":{"description":"States of Serverless cluster.","items":{"$ref":"#/components/schemas/ServerlessCluster.State"},"type":"array"}},"type":"object"},"ListServerlessClustersResponse":{"description":"ListServerlessClustersResponse is the response of ListServerlessClusters.","properties":{"next_page_token":{"description":"Page Token to fetch the next page. The value can be used as next_page_token in the next call to this endpoint.","type":"string"},"serverless_clusters":{"description":"Serverless clusters matching the request","items":{"$ref":"#/components/schemas/ServerlessCluster"},"maxItems":100,"type":"array"}},"type":"object"},"ListServerlessRegionsRequest.Filter":{"properties":{"placement_enabled_only":{"description":"Only select regions with placement enabled.","type":"boolean"}},"type":"object"},"ListServerlessRegionsResponse":{"description":"ListServerlessRegionsResponse is the response of ListServerlessRegions.","properties":{"next_page_token":{"description":"Page token to fetch the next page. The value can be used as `next_page_token` in the next call to this endpoint.","type":"string"},"serverless_regions":{"description":"Serverless regions matching the request.","items":{"$ref":"#/components/schemas/ServerlessRegion"},"type":"array"}},"type":"object"},"ListServiceAccountsRequest.Filter":{"properties":{"name":{"type":"string"}},"type":"object"},"ListServiceAccountsResponse":{"description":"ListServiceAccountsResponse is the response of ListServiceAccounts.","properties":{"next_page_token":{"type":"string"},"service_accounts":{"description":"ServiceAccounts matching the request","items":{"$ref":"#/components/schemas/ServiceAccount"},"maxItems":100,"type":"array"}},"type":"object"},"ListUserInvitesRequest.Filter":{"type":"object"},"ListUserInvitesResponse":{"description":"ListUserInvitesResponse is the response of ListUserInvites.","properties":{"next_page_token":{"type":"string"},"user_invites":{"description":"User invites matching the request","items":{"$ref":"#/components/schemas/UserInvite"},"maxItems":100,"type":"array"}},"type":"object"},"ListUsersRequest.Filter":{"type":"object"},"ListUsersResponse":{"description":"ListUsersResponse is the response of ListUsers.","properties":{"next_page_token":{"type":"string"},"users":{"description":"Users matching the request","items":{"$ref":"#/components/schemas/User"},"maxItems":100,"type":"array"}},"type":"object"},"LocalizedMessage":{"description":"Provides a localized error message that is safe to return to the user\nwhich can be attached to an RPC error.","properties":{"locale":{"title":"The locale used following the specification defined at\nhttps://www.rfc-editor.org/rfc/bcp/bcp47.txt.\nExamples are: \"en-US\", \"fr-CH\", \"es-MX\"","type":"string"},"message":{"description":"The localized error message in the above locale.","type":"string"}},"type":"object"},"MTLSSpec":{"description":"mTLS configuration.","properties":{"ca_certificates_pem":{"description":"CA certificate in PEM format.","example":["-----BEGIN CERTIFICATE-----\nMII........\n-----END CERTIFICATE-----"],"items":{"type":"string"},"type":"array"},"enabled":{"description":"Whether mTLS is enabled.","type":"boolean"},"principal_mapping_rules":{"description":"Principal mapping rules for mTLS authentication. Only valid for Kafka API. See the Redpanda documentation on [configuring authentication](https://docs.redpanda.com/redpanda-cloud/security/cloud-authentication/#mtls).","example":["RULE:.*CN=([^,]+).*/$1/"],"items":{"type":"string"},"type":"array"}},"type":"object"},"MaintenanceWindowConfig":{"description":"Resource describing the maintenance window configuration of a cluster.","properties":{"anytime":{"$ref":"#/components/schemas/Anytime"},"day_hour":{"$ref":"#/components/schemas/DayHour"},"unspecified":{"$ref":"#/components/schemas/Unspecified"}},"title":"MaintenanceWindowConfig","type":"object"},"Network":{"description":"Resource describing a Network.","properties":{"cidr_block":{"description":"Network CIDR from where public and private subnets are derived. At least a 21 bits CIDR is required.","type":"string"},"cloud_provider":{"$ref":"#/components/schemas/CloudProvider"},"cluster_type":{"$ref":"#/components/schemas/Cluster.Type"},"created_at":{"description":"Network creation timestamp.","format":"date-time","readOnly":true,"type":"string"},"customer_managed_resources":{"$ref":"#/components/schemas/Network.CustomerManagedResources"},"id":{"description":"Network ID. The ID is an output of the Create Network request and cannot be set by the caller.","readOnly":true,"type":"string"},"name":{"description":"The unique name of the network.","example":"development-network","type":"string"},"region":{"description":"Region where network is placed.","type":"string"},"resource_group_id":{"description":"Resource group ID of the network","example":"a0b40af9-0250-48ca-9417-783ed127ce42","type":"string"},"state":{"$ref":"#/components/schemas/Network.State"},"updated_at":{"description":"Network update timestamp.","format":"date-time","readOnly":true,"type":"string"},"zones":{"description":"Network availability zones.","items":{"type":"string"},"type":"array"}},"required":["name","resource_group_id","cloud_provider","region","type"],"title":"Network","type":"object"},"Network.CustomerManagedResources":{"description":"Cloud resources created by user.","properties":{"aws":{"$ref":"#/components/schemas/Network.CustomerManagedResources.AWS"},"azure":{"$ref":"#/components/schemas/Network.CustomerManagedResources.Azure"},"gcp":{"$ref":"#/components/schemas/Network.CustomerManagedResources.GCP"}},"type":"object"},"Network.CustomerManagedResources.AWS":{"description":"The AWS resources managed by user.","properties":{"dynamodb_table":{"$ref":"#/components/schemas/CustomerManagedDynamoDBTable"},"management_bucket":{"$ref":"#/components/schemas/CustomerManagedAWSCloudStorageBucket"},"private_subnets":{"$ref":"#/components/schemas/CustomerManagedAWSSubnets"},"vpc":{"$ref":"#/components/schemas/CustomerManagedAWSVPC"}},"required":["management_bucket","dynamodb_table","vpc","private_subnets"],"title":"AWS Customer Managed Resources","type":"object"},"Network.CustomerManagedResources.Azure":{"description":"The Azure resources managed by user.","properties":{"management_bucket":{"$ref":"#/components/schemas/CustomerManagedAzureBucketSpec"},"subnets":{"$ref":"#/components/schemas/Subnets"},"vnet":{"$ref":"#/components/schemas/Vnet"}},"required":["management_bucket","vnet","subnets"],"title":"Azure Customer Managed Resources","type":"object"},"Network.CustomerManagedResources.GCP":{"description":"GCP resources created and managed by user, and required to deploy the Redpanda cluster. See [Create a BYOVPC Cluster on GCP](https://docs.redpanda.com/redpanda-cloud/get-started/cluster-types/byoc/gcp/vpc-byo-gcp/) for details.","properties":{"management_bucket":{"$ref":"#/components/schemas/CustomerManagedGoogleCloudStorageBucket"},"network_name":{"description":"Name of user-created network where the Redpanda cluster is deployed to.\nSee the official [GCP API reference](https://cloud.google.com/compute/docs/reference/rest/v1/networks).","type":"string"},"network_project_id":{"description":"GCP project ID where the network is created.","type":"string"}},"required":["network_name","network_project_id","management_bucket"],"title":"GCP Customer Managed Resources","type":"object"},"Network.State":{"enum":["STATE_CREATING","STATE_READY","STATE_DELETING","STATE_FAILED"],"type":"string"},"NetworkAccessMode":{"description":"Network access mode for an endpoint.","enum":["NETWORK_ACCESS_MODE_PRIVATE","NETWORK_ACCESS_MODE_PUBLIC"],"type":"string"},"NetworkCreate":{"description":"Redpanda Cloud network properties.","properties":{"cidr_block":{"description":"Network CIDR from where public and private subnets are derived. At least a 21 bits CIDR is required. For more information, see [Choose CIDR Ranges](https://docs.redpanda.com/redpanda-cloud/networking/cidr-ranges/).","type":"string"},"cloud_provider":{"$ref":"#/components/schemas/CloudProvider"},"cluster_type":{"$ref":"#/components/schemas/Cluster.Type"},"customer_managed_resources":{"$ref":"#/components/schemas/Network.CustomerManagedResources"},"name":{"description":"The unique name of the network.","example":"development-network","type":"string"},"region":{"description":"Cloud provider region. See [available cloud providers and regions](https://docs.redpanda.com/redpanda-cloud/reference/tiers/).","type":"string"},"resource_group_id":{"description":"Resource group ID of the network","example":"a0b40af9-0250-48ca-9417-783ed127ce42","type":"string"}},"required":["resource_group_id","cloud_provider","region","cluster_type"],"title":"Network details","type":"object"},"NullValue":{"description":"`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\nThe JSON representation for `NullValue` is JSON `null`.","type":"string"},"Operation.State":{"description":"describes if the operation has finished, or is still in progress. Only if done is true, either error or result become available.","enum":["STATE_IN_PROGRESS","STATE_COMPLETED","STATE_FAILED"],"type":"string"},"Operation.Type":{"enum":["TYPE_CREATE_CLUSTER","TYPE_UPDATE_CLUSTER","TYPE_DELETE_CLUSTER","TYPE_CREATE_NETWORK","TYPE_DELETE_NETWORK","TYPE_CREATE_SERVERLESS_CLUSTER","TYPE_DELETE_SERVERLESS_CLUSTER","TYPE_CREATE_CLUSTER_WITH_DEPENDENCIES","TYPE_DELETE_CLUSTER_WITH_DEPENDENCIES","TYPE_CREATE_SERVERLESS_PRIVATE_LINK","TYPE_UPDATE_SERVERLESS_PRIVATE_LINK","TYPE_DELETE_SERVERLESS_PRIVATE_LINK"],"type":"string"},"OperationMetadata":{"description":"Metadata of the long-running Operation. Contains in-progress information.","oneOf":[{"allOf":[{"properties":{"@type":{"description":"Fully qualified protobuf type name of the underlying response, prefixed with `type.googleapis.com/`.","enum":["type.googleapis.com/redpanda.api.controlplane.v1.CreateNetworkMetadata"],"type":"string"}}},{"$ref":"#/components/schemas/CreateNetworkMetadata"}]},{"allOf":[{"properties":{"@type":{"description":"Fully qualified protobuf type name of the underlying response, prefixed with `type.googleapis.com/`.","enum":["type.googleapis.com/redpanda.api.controlplane.v1.DeleteNetworkMetadata"],"type":"string"}}},{"$ref":"#/components/schemas/DeleteNetworkMetadata"}]},{"allOf":[{"properties":{"@type":{"description":"Fully qualified protobuf type name of the underlying response, prefixed with `type.googleapis.com/`.","enum":["type.googleapis.com/redpanda.api.controlplane.v1.CreateClusterMetadata"],"type":"string"}}},{"$ref":"#/components/schemas/CreateClusterMetadata"}]},{"allOf":[{"properties":{"@type":{"description":"Fully qualified protobuf type name of the underlying response, prefixed with `type.googleapis.com/`.","enum":["type.googleapis.com/redpanda.api.controlplane.v1.UpdateClusterMetadata"],"type":"string"}}},{"$ref":"#/components/schemas/UpdateClusterMetadata"}]},{"allOf":[{"properties":{"@type":{"description":"Fully qualified protobuf type name of the underlying response, prefixed with `type.googleapis.com/`.","enum":["type.googleapis.com/redpanda.api.controlplane.v1.DeleteClusterMetadata"],"type":"string"}}},{"$ref":"#/components/schemas/DeleteClusterMetadata"}]}]},"OperationResponse":{"description":"Response of the long-running Operation.","oneOf":[{"allOf":[{"properties":{"@type":{"description":"Fully qualified protobuf type name of the underlying response, prefixed with `type.googleapis.com/`.","enum":["type.googleapis.com/redpanda.api.controlplane.v1.CreateClusterResponse"],"type":"string"}}},{"$ref":"#/components/schemas/CreateClusterResponse"}]},{"allOf":[{"properties":{"@type":{"description":"Fully qualified protobuf type name of the underlying response, prefixed with `type.googleapis.com/`.","enum":["type.googleapis.com/redpanda.api.controlplane.v1.UpdateClusterResponse"],"type":"string"}}},{"$ref":"#/components/schemas/UpdateClusterResponse"}]},{"allOf":[{"properties":{"@type":{"description":"Fully qualified protobuf type name of the underlying response, prefixed with `type.googleapis.com/`.","enum":["type.googleapis.com/redpanda.api.controlplane.v1.DeleteClusterResponse"],"type":"string"}}},{"$ref":"#/components/schemas/DeleteClusterResponse"}]},{"allOf":[{"properties":{"@type":{"description":"Fully qualified protobuf type name of the underlying response, prefixed with `type.googleapis.com/`.","enum":["type.googleapis.com/redpanda.api.controlplane.v1.CreateNetworkResponse"],"type":"string"}}},{"$ref":"#/components/schemas/CreateNetworkResponse"}]},{"allOf":[{"properties":{"@type":{"description":"Fully qualified protobuf type name of the underlying response, prefixed with `type.googleapis.com/`.","enum":["type.googleapis.com/redpanda.api.controlplane.v1.DeleteNetworkResponse"],"type":"string"}}},{"$ref":"#/components/schemas/DeleteNetworkResponse"}]}]},"Organization":{"properties":{"auth0_id":{"type":"string"},"default_resource_group_id":{"nullable":true,"type":"string"},"id":{"title":"internal id of the organization","type":"string"},"mfa_enforced":{"type":"boolean"},"name":{"title":"display name of the organization","type":"string"},"welcome_cluster_id":{"nullable":true,"type":"string"}},"type":"object"},"OrganizationUpdate":{"properties":{"mfa_enforced":{"type":"boolean"}},"type":"object"},"Placement":{"description":"Information about creation of new serverless clusters on the serverless region.","properties":{"enabled":{"description":"Tells if new serverless clusters can be currently placed in the serverless region.","readOnly":true,"type":"boolean"}},"readOnly":true,"type":"object"},"PlannedDeletion":{"description":"Date after which this cluster can and should be deleted.","properties":{"delete_after":{"format":"date-time","type":"string"},"reason":{"type":"string"}},"type":"object"},"Policy":{"description":"Policy identifies an AWS policy.","properties":{"arn":{"description":"AWS policy ARN.","type":"string"}},"required":["arn"],"title":"Policy","type":"object"},"PrivateEndpointConnection":{"properties":{"connection_id":{"title":"ConnectionID is the id of the connection between the private endpoint and the private link service","type":"string"},"connection_name":{"title":"ConnectionName is the name of the connection between the private endpoint and the private link service","type":"string"},"created_at":{"description":"PrivateEndpointConnection creation timestamp.","format":"date-time","type":"string"},"private_endpoint_id":{"description":"Resource ID of Private Endpoint to Redpanda Azure PrivateLink Endpoint Service.","example":"/subscriptions/\u003csub-id\u003e/resourceGroups/\u003crg-id\u003e/providers/Microsoft.Network/privateEndpoints/\u003cname\u003e","title":"resource_id is the ID of an endpoint connection, e.g. /subscriptions/\u003csub-id\u003e/resourceGroups/\u003crg-id\u003e/providers/Microsoft.Network/privateEndpoints/\u003cname\u003e","type":"string"},"private_endpoint_name":{"description":"The name of the PrivateEndpointConnection.","type":"string"},"status":{"description":"The status of private endpoint connected to Redpanda Azure PrivateLink Endpoint Service.","example":"Approved | Rejected","title":"status is the status of the Azure PE","type":"string"}},"type":"object"},"PrivateLink.State":{"description":" - STATE_DISABLED: Private link is being created.\n - STATE_LINKING: Private link is being created.\n - STATE_READY: Private link is ready to use.\n - STATE_UNLINKING: Private link is being deleted.\n - STATE_FAILED: Private link is in an error state.","enum":["STATE_DISABLED","STATE_LINKING","STATE_READY","STATE_UNLINKING","STATE_FAILED"],"type":"string"},"PrivateLinkAuthMode":{"description":"Private link authentication mode.\n\n - PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint,\ni.e. Kafka, HTTP Proxy, or Schema Registry.\n - PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.\n - PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.\n - PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.\n - PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.","enum":["PRIVATE_LINK_AUTH_MODE_MATCH","PRIVATE_LINK_AUTH_MODE_SASL","PRIVATE_LINK_AUTH_MODE_MTLS","PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL","PRIVATE_LINK_AUTH_MODE_NONE"],"type":"string"},"Prometheus":{"description":"Prometheus metrics endpoint properties.","properties":{"url":{"description":"Prometheus API URL.","example":"https://console-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"QuotaFailure":{"description":"Describes how a quota check failed.\n\nFor example if a daily limit was exceeded for the calling project,\na service could respond with a QuotaFailure detail containing the project\nid and the description of the quota limit that was exceeded.  If the\ncalling project hasn't enabled the service in the developer console, then\na service could respond with the project id and set `service_disabled`\nto true.\n\nAlso see RetryInfo and Help types for other details about handling a\nquota failure.","properties":{"violations":{"description":"Describes all quota violations.","items":{"$ref":"#/components/schemas/QuotaFailure.Violation"},"type":"array"}},"title":"QuotaFailure","type":"object"},"QuotaFailure.Violation":{"description":"A message type used to describe a single quota violation.  For example, a\ndaily quota or a custom quota that was exceeded.","properties":{"api_service":{"description":"The API Service from which the `QuotaFailure.Violation` orginates. In\nsome cases, Quota issues originate from an API Service other than the one\nthat was called. In other words, a dependency of the called API Service\ncould be the cause of the `QuotaFailure`, and this field would have the\ndependency API service name.\n\nFor example, if the called API is Kubernetes Engine API\n(container.googleapis.com), and a quota violation occurs in the\nKubernetes Engine API itself, this field would be\n\"container.googleapis.com\". On the other hand, if the quota violation\noccurs when the Kubernetes Engine API creates VMs in the Compute Engine\nAPI (compute.googleapis.com), this field would be\n\"compute.googleapis.com\".","type":"string"},"description":{"description":"A description of how the quota check failed. Clients can use this\ndescription to find more about the quota configuration in the service's\npublic documentation, or find the relevant quota limit to adjust through\ndeveloper console.\n\nFor example: \"Service disabled\" or \"Daily Limit for read operations\nexceeded\".","type":"string"},"future_quota_value":{"description":"The new quota value being rolled out at the time of the violation. At the\ncompletion of the rollout, this value will be enforced in place of\nquota_value. If no rollout is in progress at the time of the violation,\nthis field is not set.\n\nFor example, if at the time of the violation a rollout is in progress\nchanging the number of CPUs quota from 10 to 20, 20 would be the value of\nthis field.","format":"int64","nullable":true,"type":"string"},"quota_dimensions":{"additionalProperties":{"type":"string"},"description":"The dimensions of the violated quota. Every non-global quota is enforced\non a set of dimensions. While quota metric defines what to count, the\ndimensions specify for what aspects the counter should be increased.\n\nFor example, the quota \"CPUs per region per VM family\" enforces a limit\non the metric \"compute.googleapis.com/cpus_per_vm_family\" on dimensions\n\"region\" and \"vm_family\". And if the violation occurred in region\n\"us-central1\" and for VM family \"n1\", the quota_dimensions would be,\n\n{\n  \"region\": \"us-central1\",\n  \"vm_family\": \"n1\",\n}\n\nWhen a quota is enforced globally, the quota_dimensions would always be\nempty.","type":"object"},"quota_id":{"description":"The id of the violated quota. Also know as \"limit name\", this is the\nunique identifier of a quota in the context of an API service.\n\nFor example, \"CPUS-PER-VM-FAMILY-per-project-region\".","type":"string"},"quota_metric":{"description":"The metric of the violated quota. A quota metric is a named counter to\nmeasure usage, such as API requests or CPUs. When an activity occurs in a\nservice, such as Virtual Machine allocation, one or more quota metrics\nmay be affected.\n\nFor example, \"compute.googleapis.com/cpus_per_vm_family\",\n\"storage.googleapis.com/internet_egress_bandwidth\".","type":"string"},"quota_value":{"description":"The enforced quota value at the time of the `QuotaFailure`.\n\nFor example, if the enforced quota value at the time of the\n`QuotaFailure` on the number of CPUs is \"10\", then the value of this\nfield would reflect this quantity.","format":"int64","type":"string"},"subject":{"description":"The subject on which the quota check failed.\nFor example, \"clientip:\u003cip address of client\u003e\" or \"project:\u003cGoogle\ndeveloper project id\u003e\".","type":"string"}},"type":"object"},"RedpandaConsole":{"description":"Cluster's Redpanda Console properties.","properties":{"url":{"description":"Redpanda Console API URL.","example":"https://console-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com/api","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"Region":{"description":"Region describes a region of one specific CloudProvider. There can be only\none region with the same name per CloudProvider.","properties":{"cloud_provider":{"$ref":"#/components/schemas/CloudProvider"},"default_timezone":{"$ref":"#/components/schemas/TimeZone"},"name":{"title":"name is the name of the region, as given by the cloud provider. e.g. europe-west3","type":"string"},"zones":{"description":"zones is the list of zones that existing in this region.","items":{"type":"string"},"type":"array"}},"type":"object"},"ResourceGroup":{"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"string"},"id":{"readOnly":true,"title":"ID of the resource group. ID is an output of the Create Resource Group request and cannot be set by the caller","type":"string"},"name":{"description":"The unique name of the resource group.","example":"development","type":"string"},"updated_at":{"format":"date-time","readOnly":true,"type":"string"}},"title":"Redpanda resource group","type":"object"},"ResourceGroupCreate":{"properties":{"name":{"description":"The unique name of the resource group.","example":"development","type":"string"}},"required":["name"],"title":"ResourceGroupCreate represents a Redpanda resource group creation input","type":"object"},"ResourceGroupUpdate":{"properties":{"id":{"description":"ID of the resource group. The ID should be valid and the resource group\nshould exist within the organization.","type":"string"},"name":{"description":"The unique name of the resource group.","example":"development","type":"string"}},"required":["id","name"],"title":"ResourceGroupUpdate represents a Redpanda resource group update input","type":"object"},"ResourceGroups":{"description":"Azure resource groups holding the Redpanda cluster resources.","properties":{"iam_resource_group":{"$ref":"#/components/schemas/CustomerManagedAzureResourceGroupSpec"},"redpanda_resource_group":{"$ref":"#/components/schemas/CustomerManagedAzureResourceGroupSpec"},"storage_resource_group":{"$ref":"#/components/schemas/CustomerManagedAzureResourceGroupSpec"}},"required":["redpanda_resource_group","storage_resource_group","iam_resource_group"],"title":"Azure Resoure Groups","type":"object"},"RoleBindingCreate":{"properties":{"account_id":{"type":"string"},"role_name":{"type":"string"},"scope":{"$ref":"#/components/schemas/Scope"}},"type":"object"},"RotateServiceAccountSecretResponse":{"properties":{"service_account":{"$ref":"#/components/schemas/ServiceAccount"}},"type":"object"},"SASLSpec":{"properties":{"enabled":{"description":"Whether SASL is enabled.","type":"boolean"}},"title":"SASL configuration","type":"object"},"SchemaRegistrySpec":{"description":"Cluster's Schema Registry properties. See the [Schema Registry overview](https://docs.redpanda.com/redpanda-cloud/manage/schema-reg/schema-reg-overview/) and the [Schema Registry API reference](https://docs.redpanda.com/api/doc/schema-registry) for more information.","properties":{"mtls":{"$ref":"#/components/schemas/MTLSSpec"},"sasl":{"$ref":"#/components/schemas/SASLSpec"}},"type":"object"},"Scope":{"properties":{"resource_id":{"type":"string"},"resource_type":{"$ref":"#/components/schemas/ScopeResourceType"}},"type":"object"},"ScopeResourceType":{"enum":["SCOPE_RESOURCE_TYPE_RESOURCE_GROUP","SCOPE_RESOURCE_TYPE_NETWORK","SCOPE_RESOURCE_TYPE_CLUSTER","SCOPE_RESOURCE_TYPE_SERVERLESS_CLUSTER","SCOPE_RESOURCE_TYPE_NETWORK_PEERING","SCOPE_RESOURCE_TYPE_ORGANIZATION"],"type":"string"},"SecondaryIPv4Range":{"description":"Secondary IPv4 range.","properties":{"name":{"type":"string"}},"type":"object"},"SecurityGroup":{"description":"Azure security group.","properties":{"name":{"title":"Naming convention: Between 1 and 80 characters. Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. End alphanumeric or underscore.\nhttps://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules","type":"string"}},"required":["name"],"type":"object"},"SecurityGroups":{"description":"Azure security groups for Redpanda Cluster. All security groups shall be in the network resource group.","properties":{"redpanda_security_group":{"$ref":"#/components/schemas/SecurityGroup"}},"required":["redpanda_security_group"],"title":"Azure Security Groups","type":"object"},"SeedBrokers":{"description":"Seed brokers of Redpanda Kafka API.","properties":{"mtls":{"description":"URL of the seed broker for mTLS. If mTLS is not enabled, the field is empty.","type":"string"},"private_link_mtls":{"description":"URL of the seed broker for private link with mTLS. If private link with mTLS is not enabled, the field is empty.","type":"string"},"private_link_sasl":{"description":"URL of the seed broker for private link with SASL. If private link with SASL is not enabled, the field is empty.","type":"string"},"sasl":{"description":"URL of the seed broker for SASL. If SASL is not enabled, the field is empty.","type":"string"}},"type":"object"},"ServerlessCluster":{"description":"Resource describing a ServerlessCluster.","properties":{"console":{"$ref":"#/components/schemas/ServerlessCluster.Console"},"console_url":{"readOnly":true,"type":"string"},"created_at":{"description":"Timestamp when the Serverless cluster was created.","format":"date-time","type":"string"},"dataplane_api":{"$ref":"#/components/schemas/ServerlessCluster.DataplaneAPI"},"id":{"description":"ID of the Serverless cluster. ID is an output from the Create Serverless Cluster operation and cannot be set by the caller.","type":"string"},"kafka_api":{"$ref":"#/components/schemas/ServerlessCluster.KafkaAPI"},"name":{"description":"Unique name of the Serverless cluster.","example":"development-ServerlessCluster","type":"string"},"planned_deletion":{"$ref":"#/components/schemas/PlannedDeletion"},"private_link":{"$ref":"#/components/schemas/ServerlessCluster.PrivateLink"},"resource_group_id":{"description":"Resource group ID of the cluster.","example":"a0b40af9-0250-48ca-9417-783ed127ce42","type":"string"},"schema_registry":{"$ref":"#/components/schemas/ServerlessCluster.SchemaRegistryStatus"},"serverless_region":{"description":"Serverless region in which the cluster is placed, backed by a cloud provider region.","example":"us-east-1","type":"string"},"state":{"$ref":"#/components/schemas/ServerlessCluster.State"},"updated_at":{"description":"Timestamp when the Serverless cluster was updated.","format":"date-time","type":"string"}},"title":"ServerlessCluster","type":"object"},"ServerlessCluster.Console":{"type":"object"},"ServerlessCluster.DataplaneAPI":{"description":"Cluster's Data Plane API properties.","properties":{"url":{"readOnly":true,"type":"string"}},"type":"object"},"ServerlessCluster.KafkaAPI":{"description":"Cluster's Kafka API properties.","properties":{"seed_brokers":{"description":"Kafka API seed brokers (also known as bootstrap servers).","items":{"type":"string"},"readOnly":true,"type":"array"}},"type":"object"},"ServerlessCluster.PrivateLink":{"properties":{"id":{"type":"string"},"state":{"$ref":"#/components/schemas/PrivateLink.State"}},"type":"object"},"ServerlessCluster.SchemaRegistryStatus":{"description":"Cluster's Schema Registry properties.","properties":{"url":{"readOnly":true,"type":"string"}},"type":"object"},"ServerlessCluster.State":{"description":"State describes the state of the ServerlessCluster.\n\n - STATE_PLACING: Serverless cluster is in the process of being placed on a cell with sufficient resources in the data plane.\n - STATE_CREATING: Serverless cluster is in the process of having its control plane state created.\n - STATE_READY: Serverless cluster is in execution and accepting external requests.\n - STATE_DELETING: Serverless cluster is in the process of having its control plane state removed. Resources dedicated to the cluster in the data plane will be released.\n - STATE_FAILED: Serverless cluster was unable to enter the ready state from either the creating or placing states.\n - STATE_SUSPENDED: Serverless cluster is in execution but blocks all external requests.","enum":["STATE_PLACING","STATE_CREATING","STATE_READY","STATE_DELETING","STATE_FAILED","STATE_SUSPENDED"],"type":"string"},"ServerlessClusterCreate":{"description":"Resource describing a Create ServerlessCluster.","properties":{"name":{"description":"Unique name of the Serverless cluster within the org.","example":"development-ServerlessCluster","type":"string"},"resource_group_id":{"description":"Resource group ID of the cluster.","example":"a0b40af9-0250-48ca-9417-783ed127ce42","title":"Resource group ID (formerly namespace)","type":"string"},"serverless_region":{"description":"Name of the region where the Serverless cluster will be provisioned.","type":"string"}},"required":["name","resource_group_id","serverless_region"],"title":"ServerlessClusterCreate","type":"object"},"ServerlessRegion":{"description":"Resource describing a ServerlessRegion.","properties":{"cloud_provider":{"$ref":"#/components/schemas/CloudProvider"},"default_timezone":{"$ref":"#/components/schemas/TimeZone"},"name":{"description":"Unique name of the Serverless region.","example":"int-eu-west-1","type":"string"},"placement":{"$ref":"#/components/schemas/Placement"}},"title":"ServerlessRegion","type":"object"},"ServiceAccount":{"properties":{"auth0_client_credentials":{"$ref":"#/components/schemas/ServiceAccountCredentials"},"created_at":{"format":"date-time","type":"string"},"description":{"description":"The description of the service_account.","example":"CI bot account is used for CI workloads.","type":"string"},"id":{"type":"string"},"name":{"description":"The unique name of the service account.","example":"ci_bot","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"type":"object"},"ServiceAccountCreate":{"properties":{"description":{"description":"The description of the service_account.","example":"CI bot account is used for CI workloads.","type":"string"},"name":{"description":"The unique name of the service_account.","example":"billing_admin","type":"string"},"role_bindings":{"items":{"$ref":"#/components/schemas/ServiceAccountCreate.RoleBinding"},"type":"array"}},"type":"object"},"ServiceAccountCreate.RoleBinding":{"properties":{"role_name":{"type":"string"},"scope":{"$ref":"#/components/schemas/Scope"}},"type":"object"},"ServiceAccountCredentials":{"properties":{"client_id":{"description":"The client ID of the credentials","example":"CDFX4567298","type":"string"},"client_secret":{"description":"The client secret","example":"dYz_FZqNM6E3_O1lKUwONKNQ4TKf7i","nullable":true,"type":"string"}},"type":"object"},"ServiceAccountUpdate":{"properties":{"description":{"description":"The description of the service account.","example":"CI bot account is used for CI workloads.","type":"string"},"name":{"description":"The unique name of the service account.","example":"ci_bot","type":"string"}},"type":"object"},"Subnets":{"description":"Azure subnets used by Redpand cluster deployment.","properties":{"kafka_connect_pods":{"$ref":"#/components/schemas/Subnets.Subnet"},"kafka_connect_vnet":{"$ref":"#/components/schemas/Subnets.Subnet"},"rp_0_pods":{"$ref":"#/components/schemas/Subnets.Subnet"},"rp_0_vnet":{"$ref":"#/components/schemas/Subnets.Subnet"},"rp_1_pods":{"$ref":"#/components/schemas/Subnets.Subnet"},"rp_1_vnet":{"$ref":"#/components/schemas/Subnets.Subnet"},"rp_2_pods":{"$ref":"#/components/schemas/Subnets.Subnet"},"rp_2_vnet":{"$ref":"#/components/schemas/Subnets.Subnet"},"rp_agent":{"$ref":"#/components/schemas/Subnets.Subnet"},"rp_connect_pods":{"$ref":"#/components/schemas/Subnets.Subnet"},"rp_connect_vnet":{"$ref":"#/components/schemas/Subnets.Subnet"},"rp_egress_vnet":{"$ref":"#/components/schemas/Subnets.Subnet"},"sys_pods":{"$ref":"#/components/schemas/Subnets.Subnet"},"sys_vnet":{"$ref":"#/components/schemas/Subnets.Subnet"}},"required":["rp_agent","rp_0_pods","rp_0_vnet","rp_1_pods","rp_1_vnet","rp_2_pods","rp_2_vnet","rp_connect_pods","rp_connect_vnet","sys_pods","sys_vnet","rp_egress_vnet","kafka_connect_pods","kafka_connect_vnet"],"type":"object"},"Subnets.Subnet":{"description":"Azure subnet.","properties":{"name":{"title":"Naming convention: Between 1 and 80 characters. Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. End alphanumeric or underscore.\nhttps://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules","type":"string"}},"required":["name"],"type":"object"},"TimeZone":{"description":"Represents a time zone from the\n[IANA Time Zone Database](https://www.iana.org/time-zones).","properties":{"id":{"description":"IANA Time Zone Database time zone, e.g. \"America/New_York\".","type":"string"},"version":{"description":"Optional. IANA Time Zone Database version number, e.g. \"2019a\".","type":"string"}},"type":"object"},"UAISpec":{"description":"Azure user assigned identity.","properties":{"name":{"title":"Naming convention: Between 3 and 128 characters and use Letters, numbers, underscores, and hyphens. Start with letters and numbers.\nhttps://azure.github.io/PSRule.Rules.Azure/en/rules/Azure.Identity.UserAssignedName/","type":"string"}},"required":["name"],"type":"object"},"Unspecified":{"type":"object"},"UpdateClusterMetadata":{"description":"Resource describing an in-progress UpdateCluster Operation.","properties":{"update_type":{"items":{"$ref":"#/components/schemas/UpdateClusterType"},"title":"Update operation types, based on the properties modified in the cluster","type":"array"}},"title":"UpdateClusterMetadata","type":"object"},"UpdateClusterOperation":{"description":"UpdateClusterOperation is the response of the update cluster rpc.","properties":{"operation":{"$ref":"#/components/schemas/v1.Operation"}},"type":"object"},"UpdateClusterResponse":{"description":"UpdateClusterResponse is the resposne of UpdateCluster. It is provided by\nthe Operation returned by UpdateCluster once the Operation is done.","properties":{"cluster":{"$ref":"#/components/schemas/Cluster"}},"type":"object"},"UpdateClusterType":{"enum":["UPDATE_CLUSTER_TYPE_CUSTOMER_CONFIG"],"type":"string"},"UpdateOrganizationResponse":{"properties":{"organization":{"$ref":"#/components/schemas/Organization"}},"type":"object"},"UpdateResourceGroupBody":{"properties":{"resource_group":{"properties":{"name":{"description":"The unique name of the resource group.","example":"development","type":"string"}},"title":"ResourceGroupUpdate represents a Redpanda resource group update input","type":"object"}},"required":["name"],"title":"UpdateResourceGroupRequest is the request of UpdateResourceGroup","type":"object"},"UpdateResourceGroupResponse":{"properties":{"resource_group":{"$ref":"#/components/schemas/ResourceGroup"}},"title":"UpdateResourceGroupResponse is the response of UpdateResourceGroup","type":"object"},"UpdateServiceAccountBody":{"properties":{"service_account":{"$ref":"#/components/schemas/ServiceAccountUpdate"},"update_mask":{"type":"string"}},"title":"UpdateServiceAccountRequest is the request of UpdateServiceAccount","type":"object"},"UpdateServiceAccountResponse":{"properties":{"service_account":{"$ref":"#/components/schemas/ServiceAccount"}},"type":"object"},"UpdateUserInviteBody":{"properties":{"update_mask":{"type":"string"},"user_invite":{"$ref":"#/components/schemas/UserInviteUpdate"}},"title":"UpdateUserInviteRequest is the request of UpdateUserInvite","type":"object"},"UpdateUserInviteResponse":{"properties":{"user_invite":{"$ref":"#/components/schemas/UserInvite"}},"type":"object"},"User":{"properties":{"created_at":{"format":"date-time","type":"string"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"picture_url":{"type":"string"}},"type":"object"},"UserAssignedIdentities":{"description":"Azure user assigned identities used by Redpanda cluster. All identities shall be in iam_resource_group.","properties":{"agent_user_assigned_identity":{"$ref":"#/components/schemas/UAISpec"},"aks_user_assigned_identity":{"$ref":"#/components/schemas/UAISpec"},"cert_manager_assigned_identity":{"$ref":"#/components/schemas/UAISpec"},"external_dns_assigned_identity":{"$ref":"#/components/schemas/UAISpec"},"kafka_connect_assigned_identity":{"$ref":"#/components/schemas/UAISpec"},"redpanda_cluster_assigned_identity":{"$ref":"#/components/schemas/UAISpec"},"redpanda_connect_api_assigned_identity":{"$ref":"#/components/schemas/UAISpec"},"redpanda_connect_assigned_identity":{"$ref":"#/components/schemas/UAISpec"},"redpanda_console_assigned_identity":{"$ref":"#/components/schemas/UAISpec"},"redpanda_operator_assigned_identity":{"$ref":"#/components/schemas/UAISpec"}},"required":["agent_user_assigned_identity","aks_user_assigned_identity","redpanda_cluster_assigned_identity","cert_manager_assigned_identity","external_dns_assigned_identity","redpanda_console_assigned_identity","kafka_connect_assigned_identity","redpanda_connect_assigned_identity","redpanda_connect_api_assigned_identity","redpanda_operator_assigned_identity"],"title":"User Assigned Identities","type":"object"},"UserInvite":{"properties":{"created_at":{"format":"date-time","type":"string"},"email":{"type":"string"},"expires_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"invite_url":{"type":"string"},"role_bindings":{"items":{"$ref":"#/components/schemas/UserInvite.RoleBinding"},"type":"array"}},"type":"object"},"UserInvite.RoleBinding":{"properties":{"role_name":{"type":"string"},"scope":{"$ref":"#/components/schemas/Scope"}},"type":"object"},"UserInviteCreate":{"properties":{"email":{"type":"string"},"role_bindings":{"items":{"$ref":"#/components/schemas/UserInvite.RoleBinding"},"type":"array"}},"type":"object"},"UserInviteUpdate":{"properties":{"expires_at":{"format":"date-time","type":"string"},"role_bindings":{"items":{"$ref":"#/components/schemas/UserInvite.RoleBinding"},"type":"array"}},"type":"object"},"VPCEndpointConnection":{"properties":{"connection_id":{"description":"Connection ID of VPC endpoint connected to Redpanda AWS PrivateLink Endpoint Service.","example":"vpce-con-00b9cba3360fe4aec","type":"string"},"created_at":{"description":"VPC endpoint creation timestamp.","format":"date-time","type":"string"},"dns_entries":{"description":"The list of DNS entries associated with VPC endpoint.","items":{"$ref":"#/components/schemas/DNSEntry"},"type":"array"},"id":{"description":"The ID of VPC endpoint.","type":"string"},"load_balancer_arns":{"description":"List of load balancer ARNs.","items":{"type":"string"},"type":"array"},"owner":{"description":"The owner of VPC endpoint.","type":"string"},"state":{"description":"The state of VPC endpoint connected to Redpanda AWS PrivateLink Endpoint Service.","example":"pendingAcceptance | pending | available | deleting | deleted | rejected | failed","type":"string"}},"type":"object"},"Vnet":{"description":"Azure VNET.","properties":{"name":{"title":"The name of Azure VNET.\nNaming convention: Between 2 and 64 characters. Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. End alphanumeric or underscore.\nhttps://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules","type":"string"},"resource_group":{"$ref":"#/components/schemas/CustomerManagedAzureResourceGroupSpec"}},"required":["name","resource_group"],"type":"object"},"rpc.Status":{"description":"Describes errors","properties":{"code":{"description":"RPC status code, as described [here](https://github.com/googleapis/googleapis/blob/b4c238feaa1097c53798ed77035bbfeb7fc72e96/google/rpc/code.proto#L32).","enum":["OK","CANCELLED","UNKNOWN","INVALID_ARGUMENT","DEADLINE_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","UNAUTHENTICATED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","UNIMPLEMENTED","INTERNAL","UNAVAILABLE","DATA_LOSS"],"format":"int32","type":"string"},"details":{"description":"A list of messages that carries the error details.","items":{"description":"Details of the error.","oneOf":[{"allOf":[{"properties":{"@type":{"description":"Fully qualified protobuf type name of the underlying response, prefixed with `type.googleapis.com/`.","enum":["type.googleapis.com/google.rpc.BadRequest"],"type":"string"}}},{"$ref":"#/components/schemas/BadRequest"}]},{"allOf":[{"properties":{"@type":{"description":"Fully qualified protobuf type name of the underlying response, prefixed with `type.googleapis.com/`.","enum":["type.googleapis.com/google.rpc.ErrorInfo"],"type":"string"}}},{"$ref":"#/components/schemas/ErrorInfo"}]},{"allOf":[{"properties":{"@type":{"description":"Fully qualified protobuf type name of the underlying response, prefixed with `type.googleapis.com/`.","enum":["type.googleapis.com/google.rpc.QuotaFailure"],"type":"string"}}},{"$ref":"#/components/schemas/QuotaFailure"}]},{"allOf":[{"properties":{"@type":{"description":"Fully qualified protobuf type name of the underlying response, prefixed with `type.googleapis.com/`.","enum":["type.googleapis.com/google.rpc.Help"],"type":"string"}}},{"$ref":"#/components/schemas/Help"}]}]},"type":"array"},"message":{"description":"Detailed error message. No compatibility guarantees are given for the text contained in this message.","type":"string"}},"type":"object"},"v1.CustomerManagedResources":{"description":"The cloud resources created by user.","properties":{"aws":{"$ref":"#/components/schemas/v1.CustomerManagedResources.AWS"},"azure":{"$ref":"#/components/schemas/v1.CustomerManagedResources.Azure"},"gcp":{"$ref":"#/components/schemas/v1.CustomerManagedResources.GCP"}},"type":"object"},"v1.CustomerManagedResources.AWS":{"description":"AWS resources created and managed by user, and required to deploy the Redpanda cluster.","properties":{"agent_instance_profile":{"$ref":"#/components/schemas/AWSInstanceProfile"},"cloud_storage_bucket":{"$ref":"#/components/schemas/CustomerManagedAWSCloudStorageBucket"},"cluster_security_group":{"$ref":"#/components/schemas/AWSSecurityGroup"},"connectors_node_group_instance_profile":{"$ref":"#/components/schemas/AWSInstanceProfile"},"connectors_security_group":{"$ref":"#/components/schemas/AWSSecurityGroup"},"k8s_cluster_role":{"$ref":"#/components/schemas/AWS.Role"},"node_security_group":{"$ref":"#/components/schemas/AWSSecurityGroup"},"permissions_boundary_policy":{"$ref":"#/components/schemas/Policy"},"redpanda_agent_security_group":{"$ref":"#/components/schemas/AWSSecurityGroup"},"redpanda_connect_node_group_instance_profile":{"$ref":"#/components/schemas/AWSInstanceProfile"},"redpanda_connect_security_group":{"$ref":"#/components/schemas/AWSSecurityGroup"},"redpanda_node_group_instance_profile":{"$ref":"#/components/schemas/AWSInstanceProfile"},"redpanda_node_group_security_group":{"$ref":"#/components/schemas/AWSSecurityGroup"},"utility_node_group_instance_profile":{"$ref":"#/components/schemas/AWSInstanceProfile"},"utility_security_group":{"$ref":"#/components/schemas/AWSSecurityGroup"}},"required":["agent_instance_profile","connectors_node_group_instance_profile","utility_node_group_instance_profile","redpanda_node_group_instance_profile","k8s_cluster_role","redpanda_agent_security_group","connectors_security_group","redpanda_node_group_security_group","utility_security_group","cluster_security_group","node_security_group","cloud_storage_bucket","permissions_boundary_policy"],"title":"AWS Customer-Managed Resources","type":"object"},"v1.CustomerManagedResources.Azure":{"description":"Azure resources created and managed by user, and required to deploy the Redpanda cluster.","properties":{"cidrs":{"$ref":"#/components/schemas/CIDR"},"key_vaults":{"$ref":"#/components/schemas/KeyVaults"},"resource_groups":{"$ref":"#/components/schemas/ResourceGroups"},"security_groups":{"$ref":"#/components/schemas/SecurityGroups"},"tiered_cloud_storage":{"$ref":"#/components/schemas/CustomerManagedAzureBucketSpec"},"user_assigned_identities":{"$ref":"#/components/schemas/UserAssignedIdentities"}},"required":["resource_groups","user_assigned_identities","tiered_cloud_storage","key_vaults","security_groups","cidrs"],"title":"Azure Customer-Managed Resoures","type":"object"},"v1.CustomerManagedResources.GCP":{"description":"GCP resources created and managed by user, and required to deploy the Redpanda cluster. See [Create a BYOVPC Cluster on GCP](https://docs.redpanda.com/redpanda-cloud/get-started/cluster-types/byoc/gcp/vpc-byo-gcp/).","properties":{"agent_service_account":{"$ref":"#/components/schemas/GCPServiceAccount"},"connector_service_account":{"$ref":"#/components/schemas/GCPServiceAccount"},"console_service_account":{"$ref":"#/components/schemas/GCPServiceAccount"},"gke_service_account":{"$ref":"#/components/schemas/GCPServiceAccount"},"psc_nat_subnet_name":{"description":"NAT subnet name if GCP Private Service Connect (a.k.a Private Link) is enabled.\nIf it is used for PSC v1, use psc_v2_nat_subnet_name to set NAT subnet name for PSC v2.","type":"string"},"psc_v2_nat_subnet_name":{"description":"NAT subnet name for PSC v2 if GCP Private Service Connect (a.k.a Private Link) is enabled and\npsc_nat_subnet_name is used for PSC v1.","type":"string"},"redpanda_cluster_service_account":{"$ref":"#/components/schemas/GCPServiceAccount"},"redpanda_connect_api_service_account":{"$ref":"#/components/schemas/GCPServiceAccount"},"redpanda_connect_service_account":{"$ref":"#/components/schemas/GCPServiceAccount"},"redpanda_operator_service_account":{"$ref":"#/components/schemas/GCPServiceAccount"},"subnet":{"$ref":"#/components/schemas/GCP.Subnet"},"tiered_storage_bucket":{"$ref":"#/components/schemas/CustomerManagedGoogleCloudStorageBucket"}},"required":["subnet","agent_service_account","console_service_account","connector_service_account","redpanda_cluster_service_account","gke_service_account","tiered_storage_bucket","redpanda_connect_api_service_account","redpanda_connect_service_account"],"title":"GCP Customer-Managed Resoures","type":"object"},"v1.Operation":{"description":"Operation describes a long running operation","properties":{"error":{"$ref":"#/components/schemas/rpc.Status"},"finished_at":{"description":"Timestamp when the operation has finished.","format":"date-time","type":"string"},"id":{"description":"ID of the operation.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/OperationMetadata"},"resource_id":{"nullable":true,"title":"ID of the associated resource","type":"string"},"response":{"$ref":"#/components/schemas/OperationResponse"},"started_at":{"description":"Timestamp when the operation has started.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/Operation.State"},"type":{"$ref":"#/components/schemas/Operation.Type"}},"readOnly":true,"title":"Operation","type":"object"},"v1.RoleBinding":{"properties":{"account_id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"role_name":{"type":"string"},"scope":{"$ref":"#/components/schemas/Scope"},"updated_at":{"format":"date-time","type":"string"}},"type":"object"}},"securitySchemes":{"auth0":{"description":"The Cloud APIs use OAuth 2.0 for authentication.\n\n**For API Explorer (browser):** Authentication is handled automatically. Click \"Get token\" on any endpoint to authenticate with your Redpanda Cloud account and include a bearer token for requests made in API Explorer.\n\n**For programmatic access (CLI, SDKs, scripts):** You must create a service account in the Redpanda Cloud UI and use the OAuth 2.0 client credentials flow to obtain an access token. See the Authentication topic for detailed instructions.\n\nThe same access token can be used for both Control Plane and Data Plane API requests for as long as the token is valid (one hour).","flows":{"implicit":{"authorizationUrl":"https://auth.prd.cloud.redpanda.com/oauth/authorize","scopes":{},"x-client-id":"dQjapNIAHhF7EQqQToRla3yEII9sUSap"}},"type":"oauth2"}}},"info":{"description":"The Redpanda Cloud Control Plane API allows programmatic management of Redpanda Cloud resources including clusters, networks, and resource groups.","title":"Redpanda Cloud Control Plane API","version":"v1","x-feedbackLink":{"label":"Share feedback","url":"https://github.com/redpanda-data/cloud-docs/issues/new?template=01_doc_request.yml"}},"openapi":"3.0.3","paths":{"/v1/clusters":{"get":{"description":"List Redpanda clusters. The `filter.` query string parameters find matching clusters that meet all specified conditions. Note: This endpoint does not return `dataplane_api.url`. Use the Get Cluster endpoint to retrieve a cluster's Data Plane API URL.","operationId":"ClusterService_ListClusters","parameters":[{"description":"Resource group ID.","in":"query","name":"filter.resource_group_id","schema":{"type":"string"}},{"description":"Name of cluster.","in":"query","name":"filter.name_contains","schema":{"type":"string"}},{"description":"Cloud provider region.","in":"query","name":"filter.region","schema":{"type":"string"}},{"description":"Cloud provider.","in":"query","name":"filter.cloud_provider","schema":{"enum":["CLOUD_PROVIDER_AWS","CLOUD_PROVIDER_GCP","CLOUD_PROVIDER_AZURE"],"type":"string"}},{"description":"Network ID.","in":"query","name":"filter.network_id","schema":{"type":"string"}},{"description":"Limit the paginated response to a number of items.","in":"query","name":"page_size","schema":{"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"Value of the `next_page_token` field returned by the previous response. If not provided, the system assumes the first page is requested.","in":"query","name":"page_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"clusters":[{"api_gateway_access":"NETWORK_ACCESS_MODE_PUBLIC","cloud_provider":"CLOUD_PROVIDER_GCP","cloud_provider_tags":{},"cloud_storage":null,"cluster_configuration":null,"connection_type":"CONNECTION_TYPE_PUBLIC","created_at":"2023-01-01T00:00:00Z","current_redpanda_version":"","customer_managed_resources":null,"dataplane_api":null,"desired_redpanda_version":"","http_proxy":{"all_urls":null,"mtls":{"ca_certificates_pem":[],"enabled":false,"principal_mapping_rules":[]},"sasl":null,"url":"https://pandaproxy-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com:9092"},"id":"cjd3r21c4vs870t0ku30","kafka_api":{"all_seed_brokers":null,"mtls":null,"sasl":null,"seed_brokers":["seed-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com:9092"]},"kafka_connect":null,"maintenance_window_config":null,"name":"my-new-cluster","nat_gateways":[],"network_id":"cjb69k1c4vs45df9bee0","prometheus":{"url":"https://console-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics"},"read_replica_cluster_ids":[],"redpanda_console":{"url":"https://console-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com/api"},"redpanda_node_count":0,"region":"us-west1","resource_group_id":"6c09e47b-f426-4ec7-a7b4-8048caf8ae47","schema_registry":{"all_urls":null,"mtls":null,"sasl":null,"url":"schema-registry-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com:9092"},"state":"STATE_READY","state_description":null,"throughput_tier":"tier-1-gcp-um4g","type":"TYPE_DEDICATED","updated_at":"2023-01-01T00:00:00Z","zones":["us-west1-a","us-west1-b","us-west1-c"]}],"next_page_token":"some-opaque-string"},"schema":{"$ref":"#/components/schemas/ListClustersResponse"}}},"description":"OK"},"500":{"content":{"application/json":{"example":{"code":"INTERNAL","details":[],"message":"Internal Server Error"},"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."}},"summary":"List clusters","tags":["Clusters"]},"post":{"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).","operationId":"ClusterService_CreateCluster","requestBody":{"content":{"application/json":{"example":{"cloud_provider":"CLOUD_PROVIDER_GCP","connection_type":"CONNECTION_TYPE_PUBLIC","name":"my-new-cluster","network_id":"cjb69k1c4vs45df9bee0","region":"us-west1","resource_group_id":"6c09e47b-f426-4ec7-a7b4-8048caf8ae47","throughput_tier":"tier-1-gcp-um4g","type":"TYPE_DEDICATED","zones":["us-west1-a","us-west1-b","us-west1-c"]},"schema":{"$ref":"#/components/schemas/CreateClusterRequest"}}},"description":"CreateClusterRequest is the request of CreateCluster.","required":true,"x-originalParamName":"body"},"responses":{"202":{"content":{"application/json":{"example":{"operation":{"finished_at":null,"id":"cjb5uh9c4vs1td8emmcg","metadata":{"@type":"type.googleapis.com/redpanda.api.controlplane.v1.CreateClusterMetadata","cluster_id":"cjb5vehc4vs19qc11pjg"},"resource_id":"cjb5vehc4vs19qc11pjg","started_at":null,"state":"STATE_IN_PROGRESS","type":"TYPE_CREATE_CLUSTER"}},"schema":{"$ref":"#/components/schemas/CreateClusterOperation"}}},"description":"Accepted"},"400":{"content":{"application/json":{"examples":{"Bad Request":{"description":"404","value":{"code":"INVALID_ARGUMENT","message":"Invalid Request"}},"Invalid Cluster Type":{"description":"Invalid Cluster Type","summary":"Invalid Cluster Type","value":{"code":"INVALID_ARGUMENT","message":"Invalid Request"}}},"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Bad Request"},"409":{"content":{"application/json":{"examples":{"Conflict":{"description":"Conflict","summary":"Conflict","value":{"code":"ALREADY_EXISTS","message":"Cluster with given name already exists"}}},"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Conflict"},"500":{"content":{"application/json":{"examples":{"Internal Server Error":{"description":"Internal Server Error","summary":"Internal Server Error","value":{"code":"INTERNAL","message":"Internal Server Error"}}},"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."}},"summary":"Create cluster","tags":["Clusters"]}},"/v1/clusters/{cluster.id}":{"patch":{"description":"Update a Redpanda cluster.","operationId":"ClusterService_UpdateCluster","parameters":[{"description":"ID of the cluster.","in":"path","name":"cluster.id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"schema_registry":{"mtls":{"ca_certificates_pem":["-----BEGIN CERTIFICATE-----\nMII........\n-----END CERTIFICATE-----"],"enabled":true}}},"schema":{"description":"Resource describing an Update Cluster.","properties":{"api_gateway_access":{"$ref":"#/components/schemas/NetworkAccessMode"},"aws_private_link":{"$ref":"#/components/schemas/AWSPrivateLinkSpec"},"azure_private_link":{"$ref":"#/components/schemas/AzurePrivateLinkSpec"},"cloud_provider_tags":{"additionalProperties":{"type":"string"},"description":"Tags that are placed on Cloud resources.\nIf the cloud provider is GCP and the name of a tag has the prefix \"gcp.network-tag.\", the tag\nis a network tag that will be added to the Redpanda cluster GKE nodes. Otherwise, the tag\nis a normal tag.\nFor example, if the name of a tag is \"gcp.network-tag.network-tag-foo\", the network tag named\n\"network-tag-foo\" will be added to the Redpanda cluster GKE nodes.\nNote: The value of a network tag will be ignored.\nSee the official [GCP VPC](https://cloud.google.com/vpc/docs/add-remove-network-tags) for more details on network tags.","type":"object"},"cloud_storage":{"$ref":"#/components/schemas/ClusterUpdate.CloudStorage"},"cluster_configuration":{"$ref":"#/components/schemas/ClusterUpdate.ClusterConfiguration"},"customer_managed_resources":{"$ref":"#/components/schemas/CustomerManagedResourcesUpdate"},"gcp_private_service_connect":{"$ref":"#/components/schemas/GCPPrivateServiceConnectSpec"},"http_proxy":{"$ref":"#/components/schemas/HTTPProxySpec"},"kafka_api":{"$ref":"#/components/schemas/KafkaAPISpec"},"kafka_connect":{"$ref":"#/components/schemas/KafkaConnect"},"maintenance_window_config":{"$ref":"#/components/schemas/MaintenanceWindowConfig"},"name":{"description":"Unique name of the cluster.","example":"development-cluster","type":"string"},"read_replica_cluster_ids":{"description":"IDs of clusters which may create read-only topics from this cluster.","items":{"type":"string"},"type":"array"},"redpanda_node_count":{"format":"int32","type":"integer"},"schema_registry":{"$ref":"#/components/schemas/SchemaRegistrySpec"},"throughput_tier":{"type":"string"}},"required":["cluster"],"title":"ClusterUpdate","type":"object"}}},"description":"ClusterUpdate\n\nResource describing an Update Cluster.","required":true,"x-originalParamName":"cluster"},"responses":{"202":{"content":{"application/json":{"example":{"operation":{"finished_at":null,"id":"cjd5159c4vs6rgpkevsg","metadata":{"@type":"type.googleapis.com/redpanda.api.controlplane.v1.UpdateClusterMetadata","update_type":[]},"resource_id":"cjd3r21c4vs870t0ku30","started_at":null,"state":"STATE_IN_PROGRESS","type":"TYPE_UPDATE_CLUSTER"}},"schema":{"$ref":"#/components/schemas/ClusterUpdate"}}},"description":"Accepted"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."}},"summary":"Update cluster","tags":["Clusters"]}},"/v1/clusters/{id}":{"delete":{"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}`.","operationId":"ClusterService_DeleteCluster","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"202":{"content":{"application/json":{"example":{"operation":{"finished_at":null,"id":"cjd4vu1c4vs5ugb02itg","metadata":{"@type":"type.googleapis.com/redpanda.api.controlplane.v1.DeleteClusterMetadata","required_action":""},"resource_id":"cjd3r21c4vs870t0ku30","started_at":null,"state":"STATE_IN_PROGRESS","type":"TYPE_DELETE_CLUSTER"}},"schema":{"$ref":"#/components/schemas/DeleteClusterOperation"}}},"description":"Accepted"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."}},"summary":"Delete cluster","tags":["Clusters"]},"get":{"description":"Get information about a Redpanda cluster.","operationId":"ClusterService_GetCluster","parameters":[{"example":"cjd3r21c4vs870t0ku30","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"cluster":{"api_gateway_access":"NETWORK_ACCESS_MODE_PUBLIC","cloud_provider":"CLOUD_PROVIDER_GCP","cloud_provider_tags":{},"cloud_storage":null,"cluster_configuration":null,"connection_type":"CONNECTION_TYPE_PUBLIC","created_at":"2023-01-01T00:00:00Z","current_redpanda_version":"","customer_managed_resources":null,"dataplane_api":null,"desired_redpanda_version":"","http_proxy":{"all_urls":null,"mtls":{"ca_certificates_pem":[],"enabled":false,"principal_mapping_rules":[]},"sasl":null,"url":"https://pandaproxy-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com:9092"},"id":"cjd3r21c4vs870t0ku30","kafka_api":{"all_seed_brokers":null,"mtls":null,"sasl":null,"seed_brokers":["seed-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com:9092"]},"kafka_connect":null,"maintenance_window_config":null,"name":"my-new-cluster","nat_gateways":[],"network_id":"cjb69k1c4vs45df9bee0","prometheus":{"url":"https://console-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics"},"read_replica_cluster_ids":[],"redpanda_console":{"url":"https://console-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com/api"},"redpanda_node_count":0,"region":"us-west1","resource_group_id":"6c09e47b-f426-4ec7-a7b4-8048caf8ae47","schema_registry":{"all_urls":null,"mtls":null,"sasl":null,"url":"schema-registry-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com:9092"},"state":"STATE_READY","state_description":null,"throughput_tier":"tier-1-gcp-um4g","type":"TYPE_DEDICATED","updated_at":"2023-01-01T00:00:00Z","zones":["us-west1-a","us-west1-b","us-west1-c"]}},"schema":{"$ref":"#/components/schemas/GetClusterResponse"}}},"description":"OK"},"404":{"content":{"application/json":{"example":{"code":"NOT_FOUND","details":[],"message":"Cluster not found"},"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."}},"summary":"Get cluster","tags":["Clusters"]}},"/v1/networks":{"get":{"description":"List Redpanda networks.","operationId":"NetworkService_ListNetworks","parameters":[{"description":"Resource group ID.","in":"query","name":"filter.resource_group_id","schema":{"type":"string"}},{"description":"Name of network.","in":"query","name":"filter.name_contains","schema":{"type":"string"}},{"description":"Name of cloud provider region.","in":"query","name":"filter.region","schema":{"type":"string"}},{"description":"Cloud provider.","in":"query","name":"filter.cloud_provider","schema":{"enum":["CLOUD_PROVIDER_AWS","CLOUD_PROVIDER_GCP","CLOUD_PROVIDER_AZURE"],"type":"string"}},{"description":"Limit the paginated response to a number of items.","in":"query","name":"page_size","schema":{"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"Value of the `next_page_token` field returned by the previous response. If not provided, the system assumes the first page is requested.","in":"query","name":"page_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"networks":[{"cidr_block":"10.0.0.0/20","cloud_provider":"CLOUD_PROVIDER_GCP","cluster_type":"TYPE_DEDICATED","created_at":"2023-01-01T00:00:00Z","customer_managed_resources":null,"id":"cjd533pc4vs8pjdkrrv0","name":"my-network","region":"us-west1","resource_group_id":"6c09e47b-f426-4ec7-a7b4-8048caf8ae47","state":"STATE_READY","updated_at":"2023-01-01T00:00:00Z","zones":[]}],"next_page_token":"some-opaque-string"},"schema":{"$ref":"#/components/schemas/ListNetworksResponse"}}},"description":"OK"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."}},"summary":"List networks","tags":["Networks"]},"post":{"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}`.","operationId":"NetworkService_CreateNetwork","requestBody":{"content":{"application/json":{"example":{"cidr_block":"10.0.0.0/20","cloud_provider":"CLOUD_PROVIDER_GCP","cluster_type":"TYPE_DEDICATED","name":"my-network","region":"us-west1","resource_group_id":"6c09e47b-f426-4ec7-a7b4-8048caf8ae47"},"schema":{"$ref":"#/components/schemas/CreateNetworkRequest"}}},"description":"CreateNetworkRequest is the request of CreateNetwork.","required":true,"x-originalParamName":"body"},"responses":{"202":{"content":{"application/json":{"example":{"operation":{"finished_at":null,"id":"cjd55r9c4vsao59ucoqg","metadata":{"@type":"type.googleapis.com/redpanda.api.controlplane.v1.CreateNetworkMetadata","network_id":"cjd533pc4vs8pjdkrrv0"},"resource_id":"cjd533pc4vs8pjdkrrv0","started_at":null,"state":"STATE_IN_PROGRESS","type":"TYPE_CREATE_NETWORK"}},"schema":{"$ref":"#/components/schemas/CreateNetworkOperation"}}},"description":"Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Bad Request"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Conflict"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."}},"summary":"Create network","tags":["Networks"]}},"/v1/networks/{id}":{"delete":{"description":"Delete a Redpanda network.","operationId":"NetworkService_DeleteNetwork","parameters":[{"description":"Network ID.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"202":{"content":{"application/json":{"example":{"operation":{"finished_at":null,"id":"cjd58g1c4vscdqkcvbqg","metadata":{"@type":"type.googleapis.com/redpanda.api.controlplane.v1.DeleteNetworkMetadata"},"resource_id":"cjd533pc4vs8pjdkrrv0","started_at":null,"state":"STATE_IN_PROGRESS","type":"TYPE_DELETE_NETWORK"}},"schema":{"$ref":"#/components/schemas/DeleteNetworkOperation"}}},"description":"Delete request accepted"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."}},"summary":"Delete network","tags":["Networks"]},"get":{"description":"Get information about a Redpanda network.","operationId":"NetworkService_GetNetwork","parameters":[{"description":"Network ID.","example":"cjd533pc4vs8pjdkrrv0","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"network":{"cidr_block":"10.0.0.0/20","cloud_provider":"CLOUD_PROVIDER_GCP","cluster_type":"TYPE_DEDICATED","created_at":"2023-01-01T00:00:00Z","customer_managed_resources":null,"id":"cjd533pc4vs8pjdkrrv0","name":"my-network","region":"us-west1","resource_group_id":"6c09e47b-f426-4ec7-a7b4-8048caf8ae47","state":"STATE_READY","updated_at":"2023-01-01T00:00:00Z","zones":[]}},"schema":{"$ref":"#/components/schemas/GetNetworkResponse"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."}},"summary":"Get network","tags":["Networks"]}},"/v1/operations":{"get":{"description":"List operations. This is a generic endpoint and can be used to list any type of operation.","operationId":"OperationService_ListOperations","parameters":[{"in":"query","name":"filter.type_in","schema":{"items":{"enum":["TYPE_CREATE_CLUSTER","TYPE_UPDATE_CLUSTER","TYPE_DELETE_CLUSTER","TYPE_CREATE_NETWORK","TYPE_DELETE_NETWORK","TYPE_CREATE_SERVERLESS_CLUSTER","TYPE_DELETE_SERVERLESS_CLUSTER","TYPE_CREATE_CLUSTER_WITH_DEPENDENCIES","TYPE_DELETE_CLUSTER_WITH_DEPENDENCIES","TYPE_CREATE_SERVERLESS_PRIVATE_LINK","TYPE_UPDATE_SERVERLESS_PRIVATE_LINK","TYPE_DELETE_SERVERLESS_PRIVATE_LINK"],"type":"string"},"type":"array"}},{"in":"query","name":"filter.state","schema":{"enum":["STATE_IN_PROGRESS","STATE_COMPLETED","STATE_FAILED"],"type":"string"}},{"in":"query","name":"filter.resource_id","schema":{"type":"string"}},{"description":"Limit the number of operations returned per page, the page is capped to 100 operations.","in":"query","name":"page_size","schema":{"format":"int32","type":"integer"}},{"description":"Value of the next_page_token field returned by the previous response. If\nnot provided, the system assumes the first page is requested.","in":"query","name":"page_token","schema":{"type":"string"}},{"in":"query","name":"read_mask","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOperationsResponse"}}},"description":"OK"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"List operations","tags":["Operations"]}},"/v1/operations/{id}":{"get":{"description":"Get information about a long-running operation. This is a generic endpoint and can be used to retrieve any type of operation.","operationId":"OperationService_GetOperation","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"CreateCluster done":{"description":"Example of an operation response of a Cluster creation that is done","summary":"Create Cluster Operation","value":{"operation":{"finished_at":null,"id":"cjb6cjpc4vs0b0spksbg","metadata":{"@type":"type.googleapis.com/redpanda.api.controlplane.v1.CreateClusterMetadata","cluster_id":"cjb69h1c4vs42pca89s0"},"resource_id":"cjb69h1c4vs42pca89s0","response":{"@type":"type.googleapis.com/redpanda.api.controlplane.v1.CreateClusterResponse","cluster":{"api_gateway_access":"NETWORK_ACCESS_MODE_UNSPECIFIED","cloud_provider":"CLOUD_PROVIDER_GCP","cloud_provider_tags":{},"cloud_storage":null,"cluster_configuration":null,"connection_type":"CONNECTION_TYPE_PUBLIC","created_at":"2023-01-01T00:00:00Z","current_redpanda_version":"","customer_managed_resources":null,"dataplane_api":null,"desired_redpanda_version":"","http_proxy":{"all_urls":null,"mtls":{"ca_certificates_pem":[],"enabled":false,"principal_mapping_rules":[]},"sasl":null,"url":"https://pandaproxy-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com:9092"},"id":"cjb69h1c4vs42pca89s0","kafka_api":{"all_seed_brokers":null,"mtls":null,"sasl":null,"seed_brokers":["seed-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com:9092"]},"kafka_connect":null,"maintenance_window_config":null,"name":"my-new-cluster","nat_gateways":[],"network_id":"cjb69k1c4vs45df9bee0","prometheus":{"url":"https://console-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics"},"read_replica_cluster_ids":[],"redpanda_console":{"url":"https://console-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com/api"},"redpanda_node_count":0,"region":"us-west1","resource_group_id":"6c09e47b-f426-4ec7-a7b4-8048caf8ae47","schema_registry":{"all_urls":null,"mtls":null,"sasl":null,"url":"schema-registry-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com:9092"},"state":"STATE_READY","state_description":null,"throughput_tier":"tier-1","type":"TYPE_DEDICATED","updated_at":"2023-01-01T00:00:00Z","zones":["us-west1-a","us-west1-b","us-west1-c"]}},"started_at":null,"state":"STATE_COMPLETED","type":"TYPE_CREATE_CLUSTER"}}},"CreateNetwork done":{"description":"Example of an operation response of a Network creation that is done","summary":"CreateNetwork Operation","value":{"operation":{"finished_at":null,"id":"cjb6cg9c4vs08hd3poo0","metadata":{"@type":"type.googleapis.com/redpanda.api.controlplane.v1.CreateNetworkMetadata","network_id":"cjb6capc4vs0m91gh3kg"},"resource_id":"cjb6capc4vs0m91gh3kg","response":{"@type":"type.googleapis.com/redpanda.api.controlplane.v1.CreateNetworkResponse","network":{"cidr_block":"10.0.0.0/20","cloud_provider":"CLOUD_PROVIDER_GCP","cluster_type":"TYPE_DEDICATED","created_at":"2023-01-01T00:00:00Z","customer_managed_resources":null,"id":"cjb6capc4vs0m91gh3kg","name":"my-new-cluster","region":"us-central1","resource_group_id":"dbc1ccee-93e8-4859-a1ae-3bcfc4ef0ded","state":"STATE_READY","updated_at":"2023-01-01T00:00:00Z","zones":[]}},"started_at":null,"state":"STATE_COMPLETED","type":"TYPE_CREATE_NETWORK"}}},"DeleteCluster done":{"description":"Example of an operation response of a cluster deletion that is done","summary":"Delete Cluster Operation","value":{"operation":{"finished_at":null,"id":"cjd5tfpc4vsfi6jbjve0","metadata":{"@type":"type.googleapis.com/redpanda.api.controlplane.v1.DeleteClusterMetadata","required_action":""},"resource_id":"cjb69h1c4vs42pca89s0","started_at":null,"state":"STATE_COMPLETED","type":"TYPE_DELETE_CLUSTER"}}},"DeleteNetwork done":{"description":"Example of an operation response of a Network deletion that is done","summary":"Delete Network Operation","value":{"operation":{"finished_at":null,"id":"cjd5tdpc4vsfvm2tav1g","metadata":{"@type":"type.googleapis.com/redpanda.api.controlplane.v1.DeleteNetworkMetadata"},"resource_id":"cjb6capc4vs0m91gh3kg","started_at":null,"state":"STATE_COMPLETED","type":"TYPE_DELETE_NETWORK"}}},"Update done":{"description":"Example of an operation response of a Cluster update that is done","summary":"Update Cluster Operation","value":{"operation":{"finished_at":null,"id":"cjd5tppc4vsf9o7lhcj0","metadata":{"@type":"type.googleapis.com/redpanda.api.controlplane.v1.UpdateClusterMetadata","update_type":[]},"resource_id":"cjb69h1c4vs42pca89s0","response":{"@type":"type.googleapis.com/redpanda.api.controlplane.v1.CreateClusterResponse","cluster":{"api_gateway_access":"NETWORK_ACCESS_MODE_UNSPECIFIED","cloud_provider":"CLOUD_PROVIDER_GCP","cloud_provider_tags":{},"cloud_storage":null,"cluster_configuration":null,"connection_type":"CONNECTION_TYPE_PUBLIC","created_at":"2023-01-01T00:00:00Z","current_redpanda_version":"","customer_managed_resources":null,"dataplane_api":null,"desired_redpanda_version":"","http_proxy":{"all_urls":null,"mtls":{"ca_certificates_pem":[],"enabled":false,"principal_mapping_rules":[]},"sasl":null,"url":"https://pandaproxy-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com:9092"},"id":"cjb69h1c4vs42pca89s0","kafka_api":{"all_seed_brokers":null,"mtls":null,"sasl":null,"seed_brokers":["seed-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com:9092"]},"kafka_connect":null,"maintenance_window_config":null,"name":"my-new-cluster","nat_gateways":[],"network_id":"cjb69k1c4vs45df9bee0","prometheus":{"url":"https://console-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics"},"read_replica_cluster_ids":[],"redpanda_console":{"url":"https://console-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com/api"},"redpanda_node_count":0,"region":"us-west1","resource_group_id":"6c09e47b-f426-4ec7-a7b4-8048caf8ae47","schema_registry":{"all_urls":null,"mtls":null,"sasl":null,"url":"schema-registry-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com:9092"},"state":"STATE_READY","state_description":null,"throughput_tier":"tier-1","type":"TYPE_DEDICATED","updated_at":"2023-01-01T00:00:00Z","zones":["us-west1-a","us-west1-b","us-west1-c"]}},"started_at":null,"state":"STATE_COMPLETED","type":"TYPE_UPDATE_CLUSTER"}}}},"schema":{"$ref":"#/components/schemas/GetOperationResponse"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Get operation","tags":["Operations"]}},"/v1/organizations/available":{"get":{"description":"Get a list of available organizations for the user.","operationId":"OrganizationService_ListAvailableOrganizations","parameters":[{"in":"query","name":"page_size","schema":{"format":"int32","type":"integer"}},{"description":"Value of the next_page_token field returned by the previous response. If not provided, the system assumes the first page is requested.","in":"query","name":"page_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAvailableOrganizationsResponse"}}},"description":"OK"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"List available organizations for the user","tags":["Organization"]}},"/v1/organizations/current":{"get":{"description":"Get information about the current organization.","operationId":"OrganizationService_GetCurrentOrganization","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCurrentOrganizationResponse"}}},"description":"OK"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Get current organization","tags":["Organization"]},"patch":{"description":"Update properties of the current organization.","operationId":"OrganizationService_UpdateOrganization","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationUpdate"}}},"required":true,"x-originalParamName":"organization"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrganizationResponse"}}},"description":"OK"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Update organization","tags":["Organization"]}},"/v1/regions/{cloud_provider}":{"get":{"description":"List available regions on the different cloud providers.","operationId":"RegionService_ListRegions","parameters":[{"in":"path","name":"cloud_provider","required":true,"schema":{"enum":["CLOUD_PROVIDER_AWS","CLOUD_PROVIDER_GCP","CLOUD_PROVIDER_AZURE"],"type":"string"}},{"in":"query","name":"filter.cluster_type","schema":{"enum":["TYPE_DEDICATED","TYPE_BYOC"],"type":"string"}},{"description":"Limit the paginated response to a number of items.","in":"query","name":"page_size","schema":{"format":"int32","type":"integer"}},{"description":"Value of the `next_page_token` field returned by the previous response. If not provided, the system assumes the first page is requested.","in":"query","name":"page_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRegionsResponse"}}},"description":"OK"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"List Redpanda regions","tags":["Regions"]}},"/v1/regions/{cloud_provider}/{name}":{"get":{"description":"Get information about a Redpanda region.","operationId":"RegionService_GetRegion","parameters":[{"in":"path","name":"cloud_provider","required":true,"schema":{"enum":["CLOUD_PROVIDER_AWS","CLOUD_PROVIDER_GCP","CLOUD_PROVIDER_AZURE"],"type":"string"}},{"in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRegionResponse"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Get region by name","tags":["Regions"]}},"/v1/resource-groups":{"get":{"description":"List Redpanda resource groups. The `filter.` query string parameter finds resource groups that match the provided name.","operationId":"ResourceGroupService_ListResourceGroups","parameters":[{"description":"Name of resource group. Partial match.","in":"query","name":"filter.name_contains","schema":{"type":"string"}},{"in":"query","name":"page_size","schema":{"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"in":"query","name":"page_token","schema":{"type":"string"}},{"in":"query","name":"read_mask","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_page_token":"some-opaque-string","resource_groups":[{"created_at":"2023-08-25T00:00:00Z","id":"897e76ad-64d5-4314-9d81-7383fa14100d","name":"my-new-namespace","updated_at":null}]},"schema":{"$ref":"#/components/schemas/ListResourceGroupsResponse"}}},"description":"OK"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Reach out to support."}},"summary":"List resource groups","tags":["Resource Groups"]},"post":{"description":"Create a Redpanda resource group.","operationId":"ResourceGroupService_CreateResourceGroup","requestBody":{"content":{"application/json":{"example":{"name":"my-new-namespace"},"schema":{"$ref":"#/components/schemas/CreateResourceGroupRequest"}}},"description":"CreateResourceGroupRequest is the request of CreateResourceGroup.","required":true,"x-originalParamName":"body"},"responses":{"201":{"content":{"application/json":{"example":{"resource_group":{"created_at":"2023-08-25T00:00:00Z","id":"897e76ad-64d5-4314-9d81-7383fa14100d","name":"my-new-namespace","updated_at":null}},"schema":{"$ref":"#/components/schemas/CreateResourceGroupResponse"}}},"description":"Resource Group Created"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Reach out to support."}},"summary":"Create resource group","tags":["Resource Groups"]}},"/v1/resource-groups/{id}":{"delete":{"description":"Delete the specified Redpanda resource group.","operationId":"ResourceGroupService_DeleteResourceGroup","parameters":[{"description":"ID of resource group to delete.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"content":{"application/json":{"example":{},"schema":{}}},"description":"Resource group deleted successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"}},"summary":"Delete resource group","tags":["Resource Groups"]},"get":{"description":"Get information about a specific Redpanda resource group.","operationId":"ResourceGroupService_GetResourceGroup","parameters":[{"description":"ID of resource group.","example":"897e76ad-64d5-4314-9d81-7383fa14100d","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"query","name":"read_mask","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"resource_group":{"created_at":"2023-08-25T00:00:00Z","id":"897e76ad-64d5-4314-9d81-7383fa14100d","name":"my-new-namespace","updated_at":null}},"schema":{"$ref":"#/components/schemas/GetResourceGroupResponse"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Reach out to support."}},"summary":"Get resource group","tags":["Resource Groups"]}},"/v1/resource-groups/{resource_group.id}":{"patch":{"description":"Update a Redpanda resource group.","operationId":"ResourceGroupService_UpdateResourceGroup","parameters":[{"description":"ID of the resource group. The ID should be valid and the resource group\nshould exist within the organization.","example":"897e76ad-64d5-4314-9d81-7383fa14100d","in":"path","name":"resource_group.id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"name":"my-new-name"},"schema":{"$ref":"#/components/schemas/UpdateResourceGroupBody"}}},"required":true,"x-originalParamName":"body"},"responses":{"200":{"content":{"application/json":{"example":{"resource_group":{"created_at":"2023-01-01T00:00:00Z","id":"897e76ad-64d5-4314-9d81-7383fa14100d","name":"my-new-name","updated_at":"2023-08-25T00:00:00Z"}},"schema":{"$ref":"#/components/schemas/UpdateResourceGroupResponse"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Reach out to support."}},"summary":"Update resource group","tags":["Resource Groups"]}},"/v1/role-bindings":{"get":{"description":"List role assignments to organization users.","operationId":"RoleBindingService_ListRoleBindings","parameters":[{"in":"query","name":"filter.role_name","schema":{"type":"string"}},{"in":"query","name":"filter.account","schema":{"type":"string"}},{"in":"query","name":"filter.scope.resource_type","schema":{"enum":["SCOPE_RESOURCE_TYPE_RESOURCE_GROUP","SCOPE_RESOURCE_TYPE_NETWORK","SCOPE_RESOURCE_TYPE_CLUSTER","SCOPE_RESOURCE_TYPE_SERVERLESS_CLUSTER","SCOPE_RESOURCE_TYPE_NETWORK_PEERING","SCOPE_RESOURCE_TYPE_ORGANIZATION"],"type":"string"}},{"in":"query","name":"filter.scope.resource_id","schema":{"type":"string"}},{"in":"query","name":"filter.account_ids","schema":{"items":{"type":"string"},"type":"array"}},{"in":"query","name":"page_size","schema":{"format":"int32","type":"integer"}},{"in":"query","name":"page_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRoleBindingsResponse"}}},"description":"OK"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"List role bindings","tags":["Control Plane Role Bindings"]},"post":{"description":"Create a Redpanda Cloud role binding.","operationId":"RoleBindingService_CreateRoleBinding","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleBindingRequest"}}},"description":"CreateRoleBindingRequest is the request of CreateRoleBinding.","required":true,"x-originalParamName":"body"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleBindingResponse"}}},"description":"RoleBinding Created"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Create role binding","tags":["Control Plane Role Bindings"]}},"/v1/role-bindings/{id}":{"delete":{"description":"Delete Redpanda Cloud role binding.","operationId":"RoleBindingService_DeleteRoleBinding","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"content":{"application/json":{"schema":{}}},"description":"RoleBinding was deleted successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Delete role binding","tags":["Control Plane Role Bindings"]},"get":{"description":"Get Redpanda role binding.","operationId":"RoleBindingService_GetRoleBinding","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRoleBindingResponse"}}},"description":"Ok"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Get role binding","tags":["Control Plane Role Bindings"]}},"/v1/serverless/clusters":{"get":{"description":"List Redpanda Serverless clusters. The `filter.` query string parameters find matching clusters that meet all specified conditions.","operationId":"ServerlessClusterService_ListServerlessClusters","parameters":[{"in":"query","name":"read_mask","schema":{"type":"string"}},{"description":"States of Serverless cluster.\n\n - STATE_PLACING: Serverless cluster is in the process of being placed on a cell with sufficient resources in the data plane.\n - STATE_CREATING: Serverless cluster is in the process of having its control plane state created.\n - STATE_READY: Serverless cluster is in execution and accepting external requests.\n - STATE_DELETING: Serverless cluster is in the process of having its control plane state removed. Resources dedicated to the cluster in the data plane will be released.\n - STATE_FAILED: Serverless cluster was unable to enter the ready state from either the creating or placing states.\n - STATE_SUSPENDED: Serverless cluster is in execution but blocks all external requests.","in":"query","name":"filter.state_in","schema":{"items":{"enum":["STATE_PLACING","STATE_CREATING","STATE_READY","STATE_DELETING","STATE_FAILED","STATE_SUSPENDED"],"type":"string"},"type":"array"}},{"description":"Resource group ID of Serverless cluster.","in":"query","name":"filter.resource_group_id","schema":{"type":"string"}},{"description":"Name of cluster. Partial match.","in":"query","name":"filter.name_contains","schema":{"type":"string"}},{"description":"Region in which Serverless cluster is hosted","in":"query","name":"filter.serverless_region","schema":{"type":"string"}},{"description":"Limit the paginated response to a number of items.","in":"query","name":"page_size","schema":{"format":"int32","type":"integer"}},{"description":"Value of the next_page_token field returned by the previous response. If not provided, the system assumes the first page is requested.","in":"query","name":"page_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListServerlessClustersResponse"}}},"description":"OK"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"List Serverless clusters","tags":["Serverless Clusters"]},"post":{"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}`.","operationId":"ServerlessClusterService_CreateServerlessCluster","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateServerlessClusterRequest"}}},"description":"CreateServerlessClusterRequest is the request of CreateServerlessCluster.","required":true,"x-originalParamName":"body"},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateServerlessClusterOperation"}}},"description":"Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Bad Request"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Conflict"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Create Serverless cluster","tags":["Serverless Clusters"]}},"/v1/serverless/clusters/{id}":{"delete":{"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}`.","operationId":"ServerlessClusterService_DeleteServerlessCluster","parameters":[{"description":"ID of Serverless cluster.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteServerlessClusterOperation"}}},"description":"Accepted"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Delete Serverless cluster","tags":["Serverless Clusters"]},"get":{"description":"Get Redpanda Serverless cluster.","operationId":"ServerlessClusterService_GetServerlessCluster","parameters":[{"description":"ID of Serverless cluster.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"query","name":"read_mask","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerlessCluster"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Get Serverless cluster","tags":["Serverless Clusters"]}},"/v1/serverless/region":{"get":{"description":"Get Redpanda Serverless region.","operationId":"ServerlessRegionService_GetServerlessRegion","parameters":[{"description":"Cloud provider where Serverless region is hosted.","in":"query","name":"cloud_provider","schema":{"enum":["CLOUD_PROVIDER_AWS","CLOUD_PROVIDER_GCP","CLOUD_PROVIDER_AZURE"],"type":"string"}},{"description":"Display name of the Serverless region","in":"query","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetServerlessRegionResponse"}}},"description":"OK"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Get Serverless region","tags":["Serverless Regions"]}},"/v1/serverless/regions":{"get":{"description":"List Redpanda Serverless regions.","operationId":"ServerlessRegionService_ListServerlessRegions","parameters":[{"description":"Cloud provider where Serverless region is hosted.","in":"query","name":"cloud_provider","required":true,"schema":{"enum":["CLOUD_PROVIDER_AWS","CLOUD_PROVIDER_GCP","CLOUD_PROVIDER_AZURE"],"type":"string"}},{"description":"Only select regions with placement enabled.","in":"query","name":"filter.placement_enabled_only","schema":{"type":"boolean"}},{"description":"Limit the paginated response to a number of items.","in":"query","name":"page_size","schema":{"format":"int32","type":"integer"}},{"description":"Value of the `next_page_token` field returned by the previous response. If not provided, the system assumes the first page is requested.","in":"query","name":"page_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListServerlessRegionsResponse"}}},"description":"OK"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Please reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"List Serverless regions","tags":["Serverless Regions"]}},"/v1/service-accounts":{"get":{"description":"List service accounts in your organization.","operationId":"ServiceAccountService_ListServiceAccounts","parameters":[{"in":"query","name":"filter.name","schema":{"type":"string"}},{"in":"query","name":"page_size","schema":{"format":"int32","type":"integer"}},{"in":"query","name":"page_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListServiceAccountsResponse"}}},"description":"OK"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"List service accounts","tags":["Control Plane Service Accounts"]},"post":{"description":"Create a Redpanda Cloud ServiceAccount.","operationId":"ServiceAccountService_CreateServiceAccount","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateServiceAccountRequest"}}},"description":"CreateServiceAccountRequest is the request of CreateServiceAccount.","required":true,"x-originalParamName":"body"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateServiceAccountResponse"}}},"description":"ServiceAccount Created"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Create service account","tags":["Control Plane Service Accounts"]}},"/v1/service-accounts/{id}":{"delete":{"description":"Delete a service account.","operationId":"ServiceAccountService_DeleteServiceAccount","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"content":{"application/json":{"schema":{}}},"description":"ServiceAccount was deleted successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Delete service account","tags":["Control Plane Service Accounts"]},"get":{"description":"Get service account details.","operationId":"ServiceAccountService_GetServiceAccount","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetServiceAccountResponse"}}},"description":"Ok"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Get service account","tags":["Control Plane Service Accounts"]},"patch":{"description":"Update a Redpanda Cloud service account.","operationId":"ServiceAccountService_UpdateServiceAccount","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateServiceAccountBody"}}},"required":true,"x-originalParamName":"body"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateServiceAccountResponse"}}},"description":"Ok"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Update service account","tags":["Control Plane Service Accounts"]}},"/v1/service-accounts/{id}/credentials":{"get":{"description":"Get Redpanda service account credentials.","operationId":"ServiceAccountService_GetServiceAccountCredentials","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetServiceAccountCredentialsResponse"}}},"description":"Ok"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Get service account credentials","tags":["Control Plane Service Accounts"]}},"/v1/service-accounts/{id}/rotate-secret":{"get":{"description":"Rotates the service account's secret and returns the updated service account along with the secret.","operationId":"ServiceAccountService_RotateServiceAccountSecret","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RotateServiceAccountSecretResponse"}}},"description":"Ok"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Rotate service account secret","tags":["Control Plane Service Accounts"]}},"/v1/user-invites":{"get":{"description":"List user invites to your Redpanda Cloud organization.","operationId":"UserInviteService_ListUserInvites","parameters":[{"in":"query","name":"page_size","schema":{"format":"int32","type":"integer"}},{"in":"query","name":"page_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUserInvitesResponse"}}},"description":"OK"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"List user invites","tags":["User Invites"]},"post":{"description":"Create a Redpanda Cloud user invite.","operationId":"UserInviteService_CreateUserInvite","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserInviteRequest"}}},"required":true,"x-originalParamName":"body"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserInviteResponse"}}},"description":"UserInvite Created"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Create user invite","tags":["User Invites"]}},"/v1/user-invites/{id}":{"delete":{"description":"Delete Redpanda Cloud User from the organization.","operationId":"UserInviteService_DeleteUserInvite","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"content":{"application/json":{"schema":{}}},"description":"User was deleted from the organization successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Delete User from the organization","tags":["User Invites"]},"get":{"description":"Get Redpanda user invite.","operationId":"UserInviteService_GetUserInvite","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserInviteResponse"}}},"description":"Ok"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Get user invite","tags":["User Invites"]},"patch":{"description":"Update a Redpanda Cloud user invite.","operationId":"UserInviteService_UpdateUserInvite","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserInviteBody"}}},"required":true,"x-originalParamName":"body"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserInviteResponse"}}},"description":"Ok"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Update user invite","tags":["User Invites"]}},"/v1/users":{"get":{"description":"List Redpanda Cloud Users.","operationId":"UserService_ListUsers","parameters":[{"in":"query","name":"page_size","schema":{"format":"int32","type":"integer"}},{"in":"query","name":"page_token","schema":{"type":"string"}},{"in":"query","name":"read_mask","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUsersResponse"}}},"description":"OK"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"List users","tags":["Control Plane Users"]}},"/v1/users/{id}":{"delete":{"description":"Delete Redpanda Cloud user from the organization.","operationId":"UserService_DeleteUser","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"content":{"application/json":{"schema":{}}},"description":"User was deleted from the organization successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Delete user","tags":["Control Plane Users"]},"get":{"description":"Get Redpanda Cloud user.","operationId":"UserService_GetUser","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"query","name":"read_mask","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserResponse"}}},"description":"Ok"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"Internal Server Error. Reach out to support."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpc.Status"}}},"description":"An unexpected error response."}},"summary":"Get user","tags":["Control Plane Users"]}}},"security":[{"auth0":[]}],"servers":[{"description":"Control Plane API","url":"https://api.redpanda.com"}],"tags":[{"description":"Check the state of long-running operations.","name":"Operations"},{"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/).","name":"Clusters"},{"description":"Manage Redpanda Cloud networks.","name":"Networks"},{"description":"Get information about available Redpanda regions.","name":"Regions"},{"description":"Manage Redpanda Cloud resource groups.","name":"Resource Groups"},{"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/).","name":"Serverless Clusters"},{"description":"Manage Redpanda Serverless Private Links. For detailed steps and information, see [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/).","name":"Serverless Private Links"},{"description":"See available Redpanda Serverless regions.","name":"Serverless Regions"},{"description":"See information about the organization the current user belongs to.","name":"Organization"},{"description":"Manage role bindings for your cloud organization users.","name":"Control Plane Role Bindings"},{"description":"Manage Redpanda Cloud service accounts.","name":"Control Plane Service Accounts"},{"description":"Manage Redpanda Cloud organization users.","name":"Control Plane Users"},{"description":"Manage user invites for your organization.","name":"User Invites"}],"x-topics":[{"title":"Quickstart","content":{"$ref":"../x-topics/quickstart.md"}},{"title":"Cloud API Overview","content":{"$ref":"../../shared/x-topics/cloud-api-overview.md"}},{"title":"Authentication","content":{"$ref":"../../shared/x-topics/cloud-about-authentication.md"}},{"title":"Regions and Usage Tiers","content":{"$ref":"../x-topics/cloud-regions.md"}},{"title":"Long-running Operations","content":{"$ref":"../x-topics/long-running-operations.md"}},{"title":"Error and Status Codes","content":{"$ref":"../x-topics/error-and-status-codes.md"}},{"title":"Deprecation Policy","content":{"$ref":"../../shared/x-topics/cloud-api-deprecation-policy.md"}}]}