diff --git a/cloud-controlplane/cloud-controlplane.yaml b/cloud-controlplane/cloud-controlplane.yaml index 7c29b45..5e9ad1e 100644 --- a/cloud-controlplane/cloud-controlplane.yaml +++ b/cloud-controlplane/cloud-controlplane.yaml @@ -315,12 +315,6 @@ components: id: description: ID of the cluster. ID is an output from the Create Cluster endpoint and cannot be set by the caller. type: string - internet_gateways: - description: InternetGateway information of the cluster. - items: - type: string - readOnly: true - type: array kafka_api: $ref: '#/components/schemas/Cluster.KafkaAPI' kafka_connect: @@ -331,6 +325,12 @@ components: description: Unique name of the cluster. example: development-cluster type: string + nat_gateways: + description: Nat gateway information of the cluster. + items: + type: string + readOnly: true + type: array network_id: description: Network ID where cluster is placed. example: cjcuq79c4vs94fcufc2g @@ -572,7 +572,7 @@ components: 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/).' + description: '[Throughput tier](https://docs.redpanda.com/api/cloud-controlplane-api/#api-description) 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' @@ -1441,7 +1441,7 @@ components: $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. + 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/pandaproxy-rest) for more information. properties: mtls: $ref: '#/components/schemas/MTLSSpec' @@ -2096,6 +2096,8 @@ components: id: title: internal id of the organization type: string + mfa_enforced: + type: boolean name: title: display name of the organization type: string @@ -2103,6 +2105,11 @@ components: 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: @@ -2428,7 +2435,7 @@ components: 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. + 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/pandaproxy-schema-registry) for more information. properties: mtls: $ref: '#/components/schemas/MTLSSpec' @@ -2791,6 +2798,11 @@ components: enum: - UPDATE_CLUSTER_TYPE_CUSTOMER_CONFIG type: string + UpdateOrganizationResponse: + properties: + organization: + $ref: '#/components/schemas/Organization' + type: object UpdateResourceGroupBody: properties: resource_group: @@ -3232,7 +3244,11 @@ components: x-client-id: dQjapNIAHhF7EQqQToRla3yEII9sUSap type: oauth2 info: - description: 'Use the Control Plane API to manage resources in your Redpanda Cloud organization such as clusters and networks.' + description: |- +

Regions

Tiers define the sizing of a cluster and provide tested and guaranteed workload configurations for throughput, logical partitions, and connections. Availability depends on the region and the cluster type (BYOC, Dedicated). See Dedicated tiers and BYOC tiers for further details.

GCP

+
RegionZonesThroughput Tiers
europe-west9europe-west9-a,europe-west9-b,europe-west9-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
europe-southwest1europe-southwest1-a,europe-southwest1-b,europe-southwest1-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
southamerica-west1southamerica-west1-btier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
asia-east1asia-east1-a,asia-east1-b,asia-east1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
asia-northeast1asia-northeast1-a,asia-northeast1-b,asia-northeast1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
asia-south1asia-south1-a,asia-south1-b,asia-south1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
asia-southeast1asia-southeast1-a,asia-southeast1-b,asia-southeast1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
australia-southeast1australia-southeast1-a,australia-southeast1-b,australia-southeast1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
europe-west1europe-west1-b,europe-west1-c,europe-west1-dtier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
europe-west2europe-west2-a,europe-west2-b,europe-west2-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
europe-west3europe-west3-a,europe-west3-b,europe-west3-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: Dedicated, BYOC
tier-7-gcp-v2-x86: Dedicated, BYOC
tier-8-gcp-v2-x86: Dedicated, BYOC
tier-9-gcp-v2-x86: Dedicated, BYOC
europe-west4europe-west4-a,europe-west4-b,europe-west4-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
northamerica-northeast1northamerica-northeast1-a,northamerica-northeast1-b,northamerica-northeast1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
southamerica-east1southamerica-east1-b,southamerica-east1-c,southamerica-east1-atier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-central1us-central1-a,us-central1-b,us-central1-c,us-central1-ftier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-east1us-east1-b,us-east1-c,us-east1-dtier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-east4us-east4-a,us-east4-b,us-east4-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-west1us-west1-a,us-west1-b,us-west1-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-west2us-west2-a,us-west2-b,us-west2-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC

AWS

+
RegionZonesThroughput Tiers
ap-southeast-3apse3-az1,apse3-az2,apse3-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
eu-north-1eun1-az1,eun1-az2,eun1-az3tier-1-aws-v3-arm: BYOC
tier-2-aws-v3-arm: BYOC
tier-3-aws-v3-arm: BYOC
tier-4-aws-v3-arm: BYOC
tier-5-aws-v3-arm: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v3-arm: BYOC
eu-south-1eus1-az1,eus1-az2,eus1-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
eu-west-3euw3-az1,euw3-az2,euw3-az3tier-1-aws-v2-arm: Dedicated, BYOC
tier-2-aws-v2-arm: Dedicated, BYOC
tier-3-aws-v2-arm: Dedicated, BYOC
tier-4-aws-v2-arm: Dedicated, BYOC
tier-5-aws-v2-arm: Dedicated, BYOC
tier-6-aws-v2-arm: Dedicated, BYOC
tier-7-aws-v2-arm: Dedicated, BYOC
tier-8-aws-v2-arm: Dedicated, BYOC
tier-9-aws-v2-arm: Dedicated, BYOC
ap-east-1ape1-az1,ape1-az2,ape1-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
ap-northeast-1apne1-az4,apne1-az1,apne1-az2tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
af-south-1afs1-az1,afs1-az2,afs1-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
ap-south-1aps1-az1,aps1-az2,aps1-az3tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
ap-southeast-1apse1-az1,apse1-az2,apse1-az3tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
ap-southeast-2apse2-az1,apse2-az3,apse2-az2tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
ca-central-1cac1-az1,cac1-az2,cac1-az4tier-1-aws-v2-arm: Dedicated, BYOC
tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-arm: Dedicated, BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-arm: Dedicated, BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-arm: Dedicated, BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-arm: Dedicated, BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-arm: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-arm: BYOC
tier-9-aws-v2-x86: BYOC
eu-central-1euc1-az2,euc1-az3,euc1-az1tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
eu-west-1euw1-az1,euw1-az2,euw1-az3tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
eu-west-2euw2-az1,euw2-az2,euw2-az3tier-1-aws-v2-arm: Dedicated, BYOC
tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-arm: Dedicated, BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-arm: Dedicated, BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-arm: Dedicated, BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-arm: Dedicated, BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-arm: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-arm: BYOC
tier-9-aws-v2-x86: BYOC
me-central-1mec1-az1,mec1-az2,mec1-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
sa-east-1sae1-az1,sae1-az2,sae1-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
us-east-1use1-az1,use1-az2,use1-az4,use1-az5,use1-az6tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
us-east-2use2-az1,use2-az2,use2-az3tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
us-west-2usw2-az1,usw2-az2,usw2-az3tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC

AZURE

+
RegionZonesThroughput Tiers
eastuseastus-az1,eastus-az2,eastus-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
uksouthuksouth-az1,uksouth-az2,uksouth-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
norwayeastnorwayeast-az1,norwayeast-az2,norwayeast-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
centraluscentralus-az1,centralus-az2,centralus-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
eastus2eastus2-az1,eastus2-az2,eastus2-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
northeuropenortheurope-az1,northeurope-az2,northeurope-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
westeuropewesteurope-az1,westeurope-az2,westeurope-az3tier-1-azure-v3-x86: BYOC
tier-2-azure-v3-x86: BYOC
tier-3-azure-v3-x86: BYOC
tier-4-azure-v3-x86: BYOC
tier-5-azure-v3-x86: BYOC
westus2westus2-az1,westus2-az2,westus2-az3tier-1-azure-v3-x86: BYOC
tier-2-azure-v3-x86: BYOC
tier-3-azure-v3-x86: BYOC
tier-4-azure-v3-x86: BYOC
tier-5-azure-v3-x86: BYOC
title: Redpanda Cloud Control Plane API version: v1 openapi: 3.0.3 @@ -3309,7 +3325,6 @@ paths: sasl: null url: https://pandaproxy-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com:9092 id: cjd3r21c4vs870t0ku30 - internet_gateways: [] kafka_api: all_seed_brokers: null mtls: null @@ -3319,6 +3334,7 @@ paths: 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 @@ -3356,11 +3372,11 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Please reach out to support. - summary: List clusters + summary: List Clusters tags: - Clusters post: - description: Create a Redpanda cluster. Returns a long-running operation. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information. Call `GET /v1/operations/{id}` to check operation state. Refer to [Regions](https://docs.redpanda.com/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers) for the list of available regions, zones, and tiers combinations for each cloud provider. For BYOC clusters, follow additional steps to [create a BYOC cluster](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-byoc-controlplane-api/#additional-steps-to-create-a-byoc-cluster). + description: Create a Redpanda cluster. Returns a long-running operation. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information. Call `GET /v1/operations/{id}` to check operation state. Refer to [Regions](https://docs.redpanda.com/api/cloud-controlplane-api.html#api-description) 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: @@ -3445,7 +3461,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Please reach out to support. - summary: Create cluster + summary: Create Cluster tags: - Clusters /v1/clusters/{cluster.id}: @@ -3563,7 +3579,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Please reach out to support. - summary: Update cluster + summary: Update Cluster tags: - Clusters /v1/clusters/{id}: @@ -3606,7 +3622,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Please reach out to support. - summary: Delete cluster + summary: Delete Cluster tags: - Clusters get: @@ -3644,7 +3660,6 @@ paths: sasl: null url: https://pandaproxy-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com:9092 id: cjd3r21c4vs870t0ku30 - internet_gateways: [] kafka_api: all_seed_brokers: null mtls: null @@ -3654,6 +3669,7 @@ paths: 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 @@ -3696,7 +3712,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Please reach out to support. - summary: Get cluster + summary: Get Cluster tags: - Clusters /v1/networks: @@ -3769,7 +3785,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Please reach out to support. - summary: List networks + summary: List Networks tags: - Networks post: @@ -3826,7 +3842,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Please reach out to support. - summary: Create network + summary: Create Network tags: - Networks /v1/networks/{id}: @@ -3869,7 +3885,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Please reach out to support. - summary: Delete network + summary: Delete Network tags: - Networks get: @@ -3916,7 +3932,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Please reach out to support. - summary: Get network + summary: Get Network tags: - Networks /v1/operations: @@ -3988,7 +4004,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List operations + summary: List Operations tags: - Operations /v1/operations/{id}: @@ -4039,7 +4055,6 @@ paths: sasl: null url: https://pandaproxy-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com:9092 id: cjb69h1c4vs42pca89s0 - internet_gateways: [] kafka_api: all_seed_brokers: null mtls: null @@ -4049,6 +4064,7 @@ paths: 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 @@ -4164,7 +4180,6 @@ paths: sasl: null url: https://pandaproxy-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com:9092 id: cjb69h1c4vs42pca89s0 - internet_gateways: [] kafka_api: all_seed_brokers: null mtls: null @@ -4174,6 +4189,7 @@ paths: 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 @@ -4221,7 +4237,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get operation + summary: Get Operation tags: - Operations /v1/organizations/available: @@ -4287,6 +4303,38 @@ paths: summary: Get current organization tags: - Organization + patch: + description: Get a list of available organizations for the user. + 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/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/regions/{cloud_provider}: get: description: List available regions on the different cloud providers @@ -4433,7 +4481,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Reach out to support. - summary: List resource groups + summary: List Resource Groups tags: - Resource Groups post: @@ -4468,7 +4516,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Reach out to support. - summary: Create resource group + summary: Create Resource Group tags: - Resource Groups /v1/resource-groups/{id}: @@ -4495,7 +4543,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Not Found - summary: Delete resource group + summary: Delete Resource Group tags: - Resource Groups get: @@ -4538,7 +4586,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Reach out to support. - summary: Get resource group + summary: Get Resource Group tags: - Resource Groups /v1/resource-groups/{resource_group.id}: @@ -4589,7 +4637,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Reach out to support. - summary: Update resource group + summary: Update Resource Group tags: - Resource Groups /v1/role-bindings: @@ -4654,7 +4702,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List role bindings + summary: List Role Bindings tags: - Control Plane Role Bindings post: @@ -4687,7 +4735,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create role binding + summary: Create Role Binding tags: - Control Plane Role Bindings /v1/role-bindings/{id}: @@ -4718,7 +4766,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete role binding + summary: Delete Role Binding tags: - Control Plane Role Bindings get: @@ -4755,7 +4803,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get role binding + summary: Get Role Binding tags: - Control Plane Role Bindings /v1/serverless/clusters: @@ -4834,7 +4882,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Serverless clusters + summary: List Serverless Clusters tags: - Serverless Clusters post: @@ -4879,7 +4927,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create Serverless cluster + summary: Create Serverless Cluster tags: - Serverless Clusters /v1/serverless/clusters/{id}: @@ -4918,7 +4966,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete Serverless cluster + summary: Delete Serverless Cluster tags: - Serverless Clusters get: @@ -4960,7 +5008,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Serverless cluster + summary: Get Serverless Cluster tags: - Serverless Clusters /v1/serverless/region: @@ -5002,7 +5050,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Serverless region + summary: Get ServerlessRegion tags: - Serverless Regions /v1/serverless/regions: @@ -5055,7 +5103,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Serverless regions + summary: List ServerlessRegions tags: - Serverless Regions /v1/service-accounts: @@ -5095,7 +5143,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List service accounts + summary: List Service Accounts tags: - Control Plane Service Accounts post: @@ -5128,7 +5176,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create service account + summary: Create Service Account tags: - Control Plane Service Accounts /v1/service-accounts/{id}: @@ -5159,7 +5207,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete service account + summary: Delete Service Account tags: - Control Plane Service Accounts get: @@ -5196,7 +5244,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get service account + summary: Get Service Account tags: - Control Plane Service Accounts patch: @@ -5240,7 +5288,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update service account + summary: Update Service Account tags: - Control Plane Service Accounts /v1/service-accounts/{id}/credentials: @@ -5278,7 +5326,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get service account credentials + summary: Get Service Account Credentials tags: - Control Plane Service Accounts /v1/service-accounts/{id}/rotate-secret: @@ -5316,7 +5364,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Rotate service account secret + summary: Rotate Service Account Secret tags: - Control Plane Service Accounts /v1/user-invites: @@ -5352,9 +5400,9 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List user invites + summary: List User Invites tags: - - User Invites + - User invites post: description: Create a Redpanda Cloud user invite. operationId: UserInviteService_CreateUserInvite @@ -5384,9 +5432,9 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create user invite + summary: Create User Invite tags: - - User Invites + - User invites /v1/user-invites/{id}: delete: description: Delete Redpanda Cloud User from the organization. @@ -5417,7 +5465,7 @@ paths: description: An unexpected error response. summary: Delete User from the organization tags: - - User Invites + - User invites get: description: Get Redpanda user invite. operationId: UserInviteService_GetUserInvite @@ -5452,9 +5500,9 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get user invite + summary: Get User Invite tags: - - User Invites + - User invites patch: description: Update a Redpanda Cloud user invite. operationId: UserInviteService_UpdateUserInvite @@ -5496,9 +5544,9 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update user invite + summary: Update UserInvite tags: - - User Invites + - User invites /v1/users: get: description: List Redpanda Cloud Users. @@ -5536,7 +5584,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List users + summary: List Users tags: - Control Plane Users /v1/users/{id}: @@ -5567,7 +5615,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete user + summary: Delete User tags: - Control Plane Users get: @@ -5608,7 +5656,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get user + summary: Get User tags: - Control Plane Users security: @@ -5641,4 +5689,4 @@ tags: - description: Manage Redpanda Cloud organization users. name: Control Plane Users - description: Manage user invites for your organization. - name: User Invites + name: User invites diff --git a/cloud-controlplane/x-topics/cloud-regions.md b/cloud-controlplane/x-topics/cloud-regions.md index c9fdf68..b95da15 100644 --- a/cloud-controlplane/x-topics/cloud-regions.md +++ b/cloud-controlplane/x-topics/cloud-regions.md @@ -1,5 +1,900 @@ + + + Usage tiers define the sizing of a cluster and provide tested and guaranteed workload configurations for throughput, logical partitions, and connections. Availability depends on the region and the cluster type (BYOC, Dedicated). See [BYOC tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/byoc-tiers/) and [Dedicated tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/dedicated-tiers/) for further details. -

GCP

RegionZonesThroughput Tiers
europe-west9europe-west9-a,europe-west9-b,europe-west9-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
europe-southwest1europe-southwest1-a,europe-southwest1-b,europe-southwest1-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
southamerica-west1southamerica-west1-btier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
asia-east1asia-east1-a,asia-east1-b,asia-east1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
asia-northeast1asia-northeast1-a,asia-northeast1-b,asia-northeast1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
asia-south1asia-south1-a,asia-south1-b,asia-south1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
asia-southeast1asia-southeast1-a,asia-southeast1-b,asia-southeast1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
australia-southeast1australia-southeast1-a,australia-southeast1-b,australia-southeast1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
europe-west1europe-west1-b,europe-west1-c,europe-west1-dtier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
europe-west2europe-west2-a,europe-west2-b,europe-west2-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
europe-west3europe-west3-a,europe-west3-b,europe-west3-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: Dedicated, BYOC
tier-7-gcp-v2-x86: Dedicated, BYOC
tier-8-gcp-v2-x86: Dedicated, BYOC
tier-9-gcp-v2-x86: Dedicated, BYOC
europe-west4europe-west4-a,europe-west4-b,europe-west4-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
northamerica-northeast1northamerica-northeast1-a,northamerica-northeast1-b,northamerica-northeast1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
southamerica-east1southamerica-east1-b,southamerica-east1-c,southamerica-east1-atier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-central1us-central1-a,us-central1-b,us-central1-c,us-central1-ftier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-east1us-east1-b,us-east1-c,us-east1-dtier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-east4us-east4-a,us-east4-b,us-east4-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-west1us-west1-a,us-west1-b,us-west1-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC

AWS

-
RegionZonesThroughput Tiers
ap-southeast-3apse3-az1,apse3-az2,apse3-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
eu-north-1eun1-az1,eun1-az2,eun1-az3tier-1-aws-v3-arm: BYOC
tier-2-aws-v3-arm: BYOC
tier-3-aws-v3-arm: BYOC
tier-4-aws-v3-arm: BYOC
tier-5-aws-v3-arm: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v3-arm: BYOC
eu-south-1eus1-az1,eus1-az2,eus1-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
eu-west-3euw3-az1,euw3-az2,euw3-az3tier-1-aws-v2-arm: Dedicated, BYOC
tier-2-aws-v2-arm: Dedicated, BYOC
tier-3-aws-v2-arm: Dedicated, BYOC
tier-4-aws-v2-arm: Dedicated, BYOC
tier-5-aws-v2-arm: Dedicated, BYOC
tier-6-aws-v2-arm: Dedicated, BYOC
tier-7-aws-v2-arm: Dedicated, BYOC
tier-8-aws-v2-arm: Dedicated, BYOC
tier-9-aws-v2-arm: Dedicated, BYOC
ap-east-1ape1-az1,ape1-az2,ape1-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
ap-northeast-1apne1-az4,apne1-az1,apne1-az2tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
af-south-1afs1-az1,afs1-az2,afs1-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
ap-south-1aps1-az1,aps1-az2,aps1-az3tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
ap-southeast-1apse1-az1,apse1-az2,apse1-az3tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
ap-southeast-2apse2-az1,apse2-az3,apse2-az2tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
ca-central-1cac1-az1,cac1-az2,cac1-az4tier-1-aws-v2-arm: Dedicated, BYOC
tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-arm: Dedicated, BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-arm: Dedicated, BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-arm: Dedicated, BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-arm: Dedicated, BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-arm: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-arm: BYOC
tier-9-aws-v2-x86: BYOC
eu-central-1euc1-az2,euc1-az3,euc1-az1tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
eu-west-1euw1-az1,euw1-az2,euw1-az3tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
eu-west-2euw2-az1,euw2-az2,euw2-az3tier-1-aws-v2-arm: Dedicated, BYOC
tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-arm: Dedicated, BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-arm: Dedicated, BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-arm: Dedicated, BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-arm: Dedicated, BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-arm: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-arm: BYOC
tier-9-aws-v2-x86: BYOC
me-central-1mec1-az1,mec1-az2,mec1-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
sa-east-1sae1-az1,sae1-az2,sae1-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
us-east-1use1-az2,use1-az4,use1-az5,use1-az6tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
us-east-2use2-az1,use2-az2,use2-az3tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
us-west-2usw2-az1,usw2-az2,usw2-az3tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC

AZURE

-
RegionZonesThroughput Tiers
eastuseastus-az1,eastus-az2,eastus-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
uksouthuksouth-az1,uksouth-az2,uksouth-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
norwayeastnorwayeast-az1,norwayeast-az2,norwayeast-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
centraluscentralus-az1,centralus-az2,centralus-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
eastus2eastus2-az1,eastus2-az2,eastus2-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
northeuropenortheurope-az1,northeurope-az2,northeurope-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
westeuropewesteurope-az1,westeurope-az2,westeurope-az3tier-1-azure-v3-x86: BYOC
tier-2-azure-v3-x86: BYOC
tier-3-azure-v3-x86: BYOC
tier-4-azure-v3-x86: BYOC
tier-5-azure-v3-x86: BYOC
westus2westus2-az1,westus2-az2,westus2-az3tier-1-azure-v3-x86: BYOC
tier-2-azure-v3-x86: BYOC
tier-3-azure-v3-x86: BYOC
tier-4-azure-v3-x86: BYOC
tier-5-azure-v3-x86: BYOC
\ No newline at end of file + +

GCP

+
Regions for GCP +

Table of cloud regions and throughput tiers for GCP. Use the table headers for more information.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
RegionZonesThroughput Tiers
asia-east1asia-east1-a,asia-east1-b,asia-east1-c +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
asia-northeast1asia-northeast1-a,asia-northeast1-b,asia-northeast1-c +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
asia-south1asia-south1-a,asia-south1-b,asia-south1-c +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
asia-southeast1asia-southeast1-a,asia-southeast1-b,asia-southeast1-c +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
australia-southeast1australia-southeast1-a,australia-southeast1-b,australia-southeast1-c +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
europe-southwest1europe-southwest1-a,europe-southwest1-b,europe-southwest1-c +
    +
  • tier-1-gcp-v2-x86: BYOC
  • +
  • tier-2-gcp-v2-x86: BYOC
  • +
  • tier-3-gcp-v2-x86: BYOC
  • +
  • tier-4-gcp-v2-x86: BYOC
  • +
  • tier-5-gcp-v2-x86: BYOC
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
europe-west1europe-west1-b,europe-west1-c,europe-west1-d +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
europe-west2europe-west2-a,europe-west2-b,europe-west2-c +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
europe-west3europe-west3-a,europe-west3-b,europe-west3-c +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-7-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-8-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-9-gcp-v2-x86: BYOC, Dedicated
  • +
+
europe-west4europe-west4-a,europe-west4-b,europe-west4-c +
    +
  • tier-1-gcp-v2-x86: BYOC
  • +
  • tier-2-gcp-v2-x86: BYOC
  • +
  • tier-3-gcp-v2-x86: BYOC
  • +
  • tier-4-gcp-v2-x86: BYOC
  • +
  • tier-5-gcp-v2-x86: BYOC
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
europe-west9europe-west9-a,europe-west9-b,europe-west9-c +
    +
  • tier-1-gcp-v2-x86: BYOC
  • +
  • tier-2-gcp-v2-x86: BYOC
  • +
  • tier-3-gcp-v2-x86: BYOC
  • +
  • tier-4-gcp-v2-x86: BYOC
  • +
  • tier-5-gcp-v2-x86: BYOC
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
northamerica-northeast1northamerica-northeast1-a,northamerica-northeast1-b,northamerica-northeast1-c +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
southamerica-east1southamerica-east1-b,southamerica-east1-c,southamerica-east1-a +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
southamerica-west1southamerica-west1-b +
    +
  • tier-1-gcp-v2-x86: BYOC
  • +
  • tier-2-gcp-v2-x86: BYOC
  • +
  • tier-3-gcp-v2-x86: BYOC
  • +
  • tier-4-gcp-v2-x86: BYOC
  • +
  • tier-5-gcp-v2-x86: BYOC
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
us-central1us-central1-a,us-central1-b,us-central1-c,us-central1-f +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
us-east1us-east1-b,us-east1-c,us-east1-d +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
us-east4us-east4-a,us-east4-b,us-east4-c +
    +
  • tier-1-gcp-v2-x86: BYOC
  • +
  • tier-2-gcp-v2-x86: BYOC
  • +
  • tier-3-gcp-v2-x86: BYOC
  • +
  • tier-4-gcp-v2-x86: BYOC
  • +
  • tier-5-gcp-v2-x86: BYOC
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
us-west1us-west1-a,us-west1-b,us-west1-c +
    +
  • tier-1-gcp-v2-x86: BYOC
  • +
  • tier-2-gcp-v2-x86: BYOC
  • +
  • tier-3-gcp-v2-x86: BYOC
  • +
  • tier-4-gcp-v2-x86: BYOC
  • +
  • tier-5-gcp-v2-x86: BYOC
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
us-west2us-west2-a,us-west2-b,us-west2-c +
    +
  • tier-1-gcp-v2-x86: BYOC
  • +
  • tier-2-gcp-v2-x86: BYOC
  • +
  • tier-3-gcp-v2-x86: BYOC
  • +
  • tier-4-gcp-v2-x86: BYOC
  • +
  • tier-5-gcp-v2-x86: BYOC
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
+ +
+

AWS

+
Regions for AWS +

Table of cloud regions and throughput tiers for AWS. Use the table headers for more information.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
RegionZonesThroughput Tiers
af-south-1afs1-az1,afs1-az2,afs1-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
+
ap-east-1ape1-az1,ape1-az2,ape1-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
+
ap-northeast-1apne1-az4,apne1-az1,apne1-az2 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-1-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v3-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v3-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v3-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v3-arm: BYOC
  • +
+
ap-south-1aps1-az1,aps1-az2,aps1-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-1-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v3-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v3-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v3-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v3-arm: BYOC
  • +
+
ap-southeast-1apse1-az1,apse1-az2,apse1-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-1-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v3-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v3-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v3-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v3-arm: BYOC
  • +
+
ap-southeast-2apse2-az1,apse2-az3,apse2-az2 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-1-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v3-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v3-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v3-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v3-arm: BYOC
  • +
+
ap-southeast-3apse3-az1,apse3-az2,apse3-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
+
ca-central-1cac1-az1,cac1-az2,cac1-az4 +
    +
  • tier-1-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v2-arm: BYOC
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v2-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v2-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v2-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
+
eu-central-1euc1-az2,euc1-az3,euc1-az1 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-1-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v3-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v3-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v3-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v3-arm: BYOC
  • +
+
eu-north-1eun1-az1,eun1-az2,eun1-az3 +
    +
  • tier-1-aws-v3-arm: BYOC
  • +
  • tier-2-aws-v3-arm: BYOC
  • +
  • tier-3-aws-v3-arm: BYOC
  • +
  • tier-4-aws-v3-arm: BYOC
  • +
  • tier-5-aws-v3-arm: BYOC
  • +
  • tier-6-aws-v3-arm: BYOC
  • +
  • tier-7-aws-v3-arm: BYOC
  • +
  • tier-8-aws-v3-arm: BYOC
  • +
  • tier-9-aws-v3-arm: BYOC
  • +
+
eu-south-1eus1-az1,eus1-az2,eus1-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
+
eu-west-1euw1-az1,euw1-az2,euw1-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-1-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v3-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v3-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v3-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v3-arm: BYOC
  • +
+
eu-west-2euw2-az1,euw2-az2,euw2-az3 +
    +
  • tier-1-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v2-arm: BYOC
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v2-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v2-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v2-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
+
eu-west-3euw3-az1,euw3-az2,euw3-az3 +
    +
  • tier-1-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-6-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-7-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-8-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-9-aws-v2-arm: BYOC, Dedicated
  • +
+
me-central-1mec1-az1,mec1-az2,mec1-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
+
sa-east-1sae1-az1,sae1-az2,sae1-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
+
us-east-1use1-az1,use1-az2,use1-az4,use1-az5,use1-az6 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-1-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v3-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v3-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v3-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v3-arm: BYOC
  • +
+
us-east-2use2-az1,use2-az2,use2-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-1-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v3-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v3-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v3-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v3-arm: BYOC
  • +
+
us-west-2usw2-az1,usw2-az2,usw2-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-1-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v3-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v3-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v3-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v3-arm: BYOC
  • +
+
+ +
+

Azure

+
Regions for Azure +

Table of cloud regions and throughput tiers for Azure. Use the table headers for more information.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
RegionZonesThroughput Tiers
centraluscentralus-az1,centralus-az2,centralus-az3 +
    +
  • tier-1-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-2-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-3-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-4-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-5-azure-v3-x86: BYOC, Dedicated
  • +
+
eastuseastus-az1,eastus-az2,eastus-az3 +
    +
  • tier-1-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-2-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-3-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-4-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-5-azure-v3-x86: BYOC, Dedicated
  • +
+
eastus2eastus2-az1,eastus2-az2,eastus2-az3 +
    +
  • tier-1-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-2-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-3-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-4-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-5-azure-v3-x86: BYOC, Dedicated
  • +
+
northeuropenortheurope-az1,northeurope-az2,northeurope-az3 +
    +
  • tier-1-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-2-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-3-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-4-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-5-azure-v3-x86: BYOC, Dedicated
  • +
+
norwayeastnorwayeast-az1,norwayeast-az2,norwayeast-az3 +
    +
  • tier-1-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-2-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-3-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-4-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-5-azure-v3-x86: BYOC, Dedicated
  • +
+
uksouthuksouth-az1,uksouth-az2,uksouth-az3 +
    +
  • tier-1-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-2-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-3-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-4-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-5-azure-v3-x86: BYOC, Dedicated
  • +
+
westeuropewesteurope-az1,westeurope-az2,westeurope-az3 +
    +
  • tier-1-azure-v3-x86: BYOC
  • +
  • tier-2-azure-v3-x86: BYOC
  • +
  • tier-3-azure-v3-x86: BYOC
  • +
  • tier-4-azure-v3-x86: BYOC
  • +
  • tier-5-azure-v3-x86: BYOC
  • +
+
westus2westus2-az1,westus2-az2,westus2-az3 +
    +
  • tier-1-azure-v3-x86: BYOC
  • +
  • tier-2-azure-v3-x86: BYOC
  • +
  • tier-3-azure-v3-x86: BYOC
  • +
  • tier-4-azure-v3-x86: BYOC
  • +
  • tier-5-azure-v3-x86: BYOC
  • +
+
+ +
diff --git a/cloud-dataplane/cloud-dataplane.yaml b/cloud-dataplane/cloud-dataplane.yaml index 6625c14..6e10c74 100644 --- a/cloud-dataplane/cloud-dataplane.yaml +++ b/cloud-dataplane/cloud-dataplane.yaml @@ -84,6 +84,45 @@ components: type: array title: BadRequest type: object + BatchDeleteQuotaRequest: + properties: + deletions: + items: + $ref: '#/components/schemas/QuotaDeletion' + type: array + type: object + BatchDeleteQuotaResponse: + properties: + failed_entities: + items: + $ref: '#/components/schemas/FailedEntity' + type: array + successful_entities: + items: + $ref: '#/components/schemas/SuccessfulEntity' + type: array + type: object + BatchSetQuotaRequest: + properties: + settings: + description: |- + A list of quota settings to apply. Each setting pairs an entity + with the specific values to be set for it. + items: + $ref: '#/components/schemas/QuotaSetting' + type: array + type: object + BatchSetQuotaResponse: + properties: + failed_entities: + items: + $ref: '#/components/schemas/FailedEntity' + type: array + successful_entities: + items: + $ref: '#/components/schemas/SuccessfulEntity' + type: array + type: object Config: properties: name: @@ -132,37 +171,18 @@ components: - CONFIG_TYPE_CLASS - CONFIG_TYPE_PASSWORD type: string - Configuration: + ConfigurationFileSchema: properties: - config_synonyms: - description: |- - If no config value is set at the topic level, it will inherit the value - set at the broker or cluster level. `name` is the corresponding config - key whose value is inherited. `source` indicates whether the inherited - config is default, broker, etc. - items: - $ref: '#/components/schemas/ConfigSynonym' - type: array - documentation: - description: Config documentation. - nullable: true - type: string - name: - description: A topic-level config key (e.g. `segment.bytes`). + config_schema: + description: JSON schema of the configuration components that are allowed for MCP Servers. type: string - read_only: - description: Whether the config is read-only, or is dynamic and can be altered. - type: boolean - sensitive: - description: Whether this is a sensitive config key and value. - type: boolean - source: - $ref: '#/components/schemas/ConfigSource' - type: - $ref: '#/components/schemas/ConfigType' - value: - description: A topic-level config value (e.g. 1073741824). - nullable: true + path_pattern: + description: |- + The glob pattern that matches the configuration file paths. + + Example: "o11y/*.yaml" or "processors/*.yaml" + + Single and double asterisks are supported. type: string type: object ConnectCluster: @@ -173,7 +193,7 @@ components: info: $ref: '#/components/schemas/ConnectCluster.Info' name: - description: Unique name of Connect cluster. For Redpanda Cloud, the value is `redpanda`. + description: Unique name of connect cluster. For Redpanda Cloud, the value is `redpanda`. type: string plugins: items: @@ -383,11 +403,22 @@ components: secret: $ref: '#/components/schemas/Secret' type: object + CreateMCPServerResponse: + properties: + mcp_server: + $ref: '#/components/schemas/MCPServer' + type: object CreatePipelineResponse: properties: pipeline: $ref: '#/components/schemas/Pipeline' type: object + CreateRoleResponse: + description: CreateRoleResponse is the response for CreateRole. + properties: + role: + $ref: '#/components/schemas/Role' + type: object CreateSecretRequest: description: CreateSecretRequest is the request of CreateSecret. properties: @@ -541,10 +572,24 @@ components: DeleteKafkaConnectSecretResponse: description: DeleteKafkaConnectSecretResponse is the response of DeleteKafkaConnectSecret. type: object + DeleteMCPServerResponse: + type: object DeleteMountTaskResponse: type: object DeletePipelineResponse: type: object + DeleteQuotaRequest: + properties: + entity: + $ref: '#/components/schemas/RequestQuotaEntity' + value_type: + $ref: '#/components/schemas/ValueType' + type: object + DeleteQuotaResponse: + type: object + DeleteRoleResponse: + description: DeleteRoleResponse is the response for DeleteRole. + type: object DeleteSecretResponse: description: DeleteSecretResponse is the response of DeleteSecret. type: object @@ -583,6 +628,25 @@ components: - input_topic_name - output_topic_names type: object + Entity: + properties: + entity_name: + type: string + entity_type: + $ref: '#/components/schemas/EntityType' + type: object + EntityType: + description: |- + The type of entity that the quota applies to. + + - ENTITY_TYPE_USER: Not supported in Redpanda + - ENTITY_TYPE_IP: Not supported in Redpanda + enum: + - ENTITY_TYPE_CLIENT_ID + - ENTITY_TYPE_CLIENT_ID_PREFIX + - ENTITY_TYPE_USER + - ENTITY_TYPE_IP + type: string EnvironmentVariable: properties: key: @@ -639,11 +703,12 @@ components: description: |- Additional structured details about this error. - Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in + Keys must match a regular expression of `[a-z][a-zA-Z0-9-_]+` but should + ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than - {"instanceLimit": "100/request"}, should be returned as, - {"instanceLimitPerRequest": "100"}, if the client exceeds the number of + `{"instanceLimit": "100/request"}`, should be returned as, + `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. type: object reason: @@ -656,6 +721,18 @@ components: type: string title: ErrorInfo type: object + FailedEntity: + properties: + entity_name: + type: string + entity_type: + $ref: '#/components/schemas/EntityType' + error_code: + format: int32 + type: integer + error_message: + type: string + type: object FieldViolation: description: A message type used to describe a single bad request field. properties: @@ -702,6 +779,17 @@ components: * `emailAddresses[3].type[2]` for a violation in the second `type` 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 + identifies the proximate cause of the field-level error. It should + uniquely identify the type of the FieldViolation within the scope of the + google.rpc.ErrorInfo.domain. This should be at most 63 + characters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, + which represents UPPER_SNAKE_CASE. + type: string type: object GetConnectClusterResponse: properties: @@ -731,6 +819,19 @@ components: secret: $ref: '#/components/schemas/Secret' type: object + GetMCPServerResponse: + properties: + mcp_server: + $ref: '#/components/schemas/MCPServer' + type: object + GetMCPServerServiceConfigSchemaResponse: + properties: + configuration_files: + description: The configuration schema for the MCP Server. + items: + $ref: '#/components/schemas/ConfigurationFileSchema' + type: array + type: object GetMountTaskResponse: properties: task: @@ -759,6 +860,17 @@ components: pipelines_for_secret: $ref: '#/components/schemas/PipelinesForSecret' type: object + GetRoleResponse: + description: GetRoleResponse is the response to GetRole. + properties: + members: + description: Members assigned to the role. + items: + $ref: '#/components/schemas/RoleMembership' + type: array + role: + $ref: '#/components/schemas/Role' + type: object GetSecretResponse: description: GetSecretResponse is the response of GetSecret. properties: @@ -769,7 +881,7 @@ components: properties: configurations: items: - $ref: '#/components/schemas/Configuration' + $ref: '#/components/schemas/Topic.Configuration' type: array type: object GetTransformResponse: @@ -802,6 +914,43 @@ components: description: The URL of the link. type: string type: object + LintHint: + description: LintHint is a generic linting hint. + properties: + column: + description: Column number of the lint. + format: int32 + type: integer + hint: + description: The hint message. + type: string + line: + description: Line number of the lint. + format: int32 + type: integer + lint_type: + description: Optional lint type or enum. + type: string + type: object + LintPipelineConfigRequest: + properties: + config_yaml: + description: |- + The Redpanda Connect pipeline configuration in YAML format. + See the [Redpanda Connect Configuration](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/about) documentation + for more details. + type: string + required: + - config_yaml + type: object + LintPipelineConfigResponse: + properties: + lint_hints: + description: A list of linting issues. + items: + $ref: '#/components/schemas/LintHint' + type: array + type: object ListACLsRequest.Filter: properties: host: @@ -874,6 +1023,29 @@ components: $ref: '#/components/schemas/Secret' type: array type: object + ListMCPServersRequest.Filter: + properties: + display_name_contains: + description: Any MCP Server that partially match this name will be returned. + type: string + secret_id: + description: Match MCP servers that use this secret ID. + type: string + tags[string]: + additionalProperties: + type: string + description: MCP servers that match all the provided tags will be returned. + type: object + type: object + ListMCPServersResponse: + properties: + mcp_servers: + items: + $ref: '#/components/schemas/MCPServer' + type: array + next_page_token: + type: string + type: object ListMountTasksResponse: properties: tasks: @@ -891,12 +1063,12 @@ components: ListPipelinesRequest.Filter: properties: name_contains: - description: Substring match on pipeline name. Case-sensitive. + description: Any pipelines that partially match this name will be returned. type: string tags[string]: additionalProperties: type: string - description: Filter pipelines that contain all of these key/value pairs. + description: Pipelines that match all the provided tags will be returned. type: object type: object ListPipelinesResponse: @@ -908,6 +1080,74 @@ components: $ref: '#/components/schemas/Pipeline' type: array type: object + ListQuotasRequest.Filter: + properties: + entity_name: + description: Filter by entity name. If unspecified will return all entities for specified entity type. + type: string + entity_type: + $ref: '#/components/schemas/EntityType' + match_default: + description: If true, the entity_name will match the default entity (e.g., default client-id). + type: boolean + type: object + ListQuotasResponse: + properties: + page_token: + description: Token to retrieve the next page of results. If empty, there are no more results. + type: string + quotas: + items: + $ref: '#/components/schemas/QuotaEntry' + type: array + type: object + ListRoleMembersRequest.Filter: + description: Filter options. + properties: + name_contains: + description: Filter results to only members with names which contain the string. + type: string + type: object + ListRoleMembersResponse: + description: ListRoleMembersResponse is the response for ListRoleMembers. + properties: + members: + description: Members assigned to the role. + items: + $ref: '#/components/schemas/RoleMembership' + type: array + next_page_token: + description: Token to retrieve the next page. + type: string + role_name: + description: The role name. + type: string + type: object + ListRolesRequest.Filter: + description: Filter options. + properties: + name_contains: + description: Filter results to only roles with names which contain the string. + type: string + name_prefix: + description: Filter results only roles named with the prefix. + type: string + principal: + description: Return only roles assigned to this principal. + type: string + type: object + ListRolesResponse: + description: ListRolesResponse is the response for ListRoles. + properties: + next_page_token: + description: Token to retrieve the next page. + type: string + roles: + description: The roles in the system. + items: + $ref: '#/components/schemas/Role' + type: array + type: object ListSecretScopesResponse: description: ListSecretScopesResponse is the response of ListSecretScopes. properties: @@ -1020,6 +1260,139 @@ components: description: Username. type: string type: object + LocalizedMessage: + description: |- + Provides a localized error message that is safe to return to the user + which can be attached to an RPC error. + properties: + locale: + title: |- + The locale used following the specification defined at + https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + Examples are: "en-US", "fr-CH", "es-MX" + type: string + message: + description: The localized error message in the above locale. + type: string + type: object + MCPServer: + description: Defines the MCP server resource. + properties: + config_files: + additionalProperties: + $ref: '#/components/schemas/MCPServer.Configuration' + description: The Redpanda Connect MCP server configuration in files. + type: object + description: + description: Optional MCP server description. + type: string + display_name: + description: User-friendly MCP server name. + type: string + id: + description: MCP Server ID. + type: string + resources: + $ref: '#/components/schemas/Resources' + state: + $ref: '#/components/schemas/MCPServer.State' + status: + $ref: '#/components/schemas/MCPServer.Status' + tags: + additionalProperties: + type: string + description: |- + Tags are key-value pairs that can be assigned to a MCP server resource. + They help organize MCP servers and enable filtering when listing them. + type: object + url: + readOnly: true + title: URL to connect to the MCP server + type: string + required: + - id + - display_name + - config_files + type: object + MCPServer.Configuration: + description: A configuration file for the MCP server. + properties: + contents: + description: The contents of the configuration file in YAML format. + type: string + required: + - contents + type: object + MCPServer.State: + description: |- + State of the MCP server. + + - STATE_STARTING: The MCP server is starting. + - STATE_RUNNING: The MCP server is running. + - STATE_STOPPING: The MCP server is in the process of stopping. + - STATE_STOPPED: The MCP server is stopped and in paused state. + - STATE_ERROR: The MCP server encountered an error. + enum: + - STATE_STARTING + - STATE_RUNNING + - STATE_STOPPING + - STATE_STOPPED + - STATE_ERROR + type: string + MCPServer.Status: + description: MCP server status may contain an error message. + properties: + error: + type: string + type: object + MCPServerCreate: + description: MCPServerCreate contains the details for the MCP Server creation request. + properties: + config_files: + additionalProperties: + $ref: '#/components/schemas/MCPServer.Configuration' + description: The Redpanda Connect MCP server configuration in files.. + type: object + description: + description: MCP server description. + type: string + display_name: + description: User-friendly MCP server name. + type: string + resources: + $ref: '#/components/schemas/Resources' + tags: + additionalProperties: + type: string + description: Optional list of tags to attach to a MCP server. + type: object + required: + - display_name + - config_files + type: object + MCPServerUpdate: + properties: + config_files: + additionalProperties: + $ref: '#/components/schemas/MCPServer.Configuration' + description: The Redpanda Connect MCP server configuration in files. + type: object + description: + description: MCP server description. + type: string + display_name: + description: User-friendly MCP servers name. + type: string + resources: + $ref: '#/components/schemas/Resources' + tags: + additionalProperties: + type: string + description: |- + A map of tags to add, update or delete. + If a tag's value is empty, the server interprets that as a deletion. + type: object + type: object MatchingACL: properties: error: @@ -1149,7 +1522,7 @@ components: description: Defines the pipeline resource. properties: config_yaml: - description: The Repanda Connect pipeline configuration in YAML format. See the [Redpanda Connect Configuration](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/about) documentation for more details. + description: The Redpanda Connect pipeline configuration in YAML format. See the [Redpanda Connect Configuration](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/about) documentation for more details. title: |- The pipeline configuration in YAML. See https://docs.redpanda.com/redpanda-connect/configuration/about/ @@ -1178,7 +1551,7 @@ components: type: object url: description: |- - URL to connect to the pipeline, for example, using http_server. + URL to connect to the pipeline, for example, via http_server. May be empty if no http_server is used. type: string required: @@ -1214,7 +1587,7 @@ components: description: PipelineCreate contains the details for the pipeline creation request. properties: config_yaml: - description: The Repanda Connect pipeline configuration in YAML format. See the [Redpanda Connect Configuration](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/about) documentation for more details. + description: The Redpanda Connect pipeline configuration in YAML format. See the [Redpanda Connect Configuration](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/about) documentation for more details. type: string description: description: Pipeline description. @@ -1236,7 +1609,7 @@ components: PipelineUpdate: properties: config_yaml: - description: The Repanda Connect pipeline configuration in YAML format. See the [Redpanda Connect Configuration](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/about) documentation for more details. + description: The Redpanda Connect pipeline configuration in YAML format. See the [Redpanda Connect Configuration](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/about) documentation for more details. type: string description: description: Pipeline description. @@ -1279,6 +1652,34 @@ components: description: The user for whom this ACL applies. type: string type: object + Quota.Value: + properties: + value: + format: double + type: number + value_type: + $ref: '#/components/schemas/ValueType' + type: object + QuotaDeletion: + properties: + entity: + $ref: '#/components/schemas/RequestQuotaEntity' + value_types: + items: + $ref: '#/components/schemas/ValueType' + title: Value that should be deleted for the specified entity + type: array + type: object + QuotaEntry: + description: QuotaEntry represents the quota for a specific entity type. + properties: + entity: + $ref: '#/components/schemas/Entity' + values: + items: + $ref: '#/components/schemas/Quota.Value' + type: array + type: object QuotaFailure: description: |- Describes how a quota check failed. @@ -1305,6 +1706,22 @@ components: A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded. properties: + api_service: + description: |- + The API Service from which the `QuotaFailure.Violation` orginates. In + some cases, Quota issues originate from an API Service other than the one + that was called. In other words, a dependency of the called API Service + could be the cause of the `QuotaFailure`, and this field would have the + dependency API service name. + + For example, if the called API is Kubernetes Engine API + (container.googleapis.com), and a quota violation occurs in the + Kubernetes Engine API itself, this field would be + "container.googleapis.com". On the other hand, if the quota violation + occurs when the Kubernetes Engine API creates VMs in the Compute Engine + API (compute.googleapis.com), this field would be + "compute.googleapis.com". + type: string description: description: |- A description of how the quota check failed. Clients can use this @@ -1315,13 +1732,82 @@ components: For example: "Service disabled" or "Daily Limit for read operations exceeded". type: string - subject: + future_quota_value: description: |- - The subject on which the quota check failed. - For example, "clientip:" or "project:" or "project:". type: string type: object + QuotaSetting: + properties: + entity: + $ref: '#/components/schemas/RequestQuotaEntity' + values: + items: + $ref: '#/components/schemas/RequestQuotaValue' + type: array + type: object ReplicaAssignment: properties: partition_id: @@ -1335,6 +1821,25 @@ components: type: integer type: array type: object + RequestQuotaEntity: + properties: + entity_name: + description: |- + Entity name is the name of the entity type specified. + If left empty, the entity will be treated as a default entity (e.g., all clients). + If entity_type is ENTITY_TYPE_CLIENT_ID_PREFIX, this field must be set. + type: string + entity_type: + $ref: '#/components/schemas/EntityType' + type: object + RequestQuotaValue: + properties: + value: + format: double + type: number + value_type: + $ref: '#/components/schemas/ValueType' + type: object Resource: properties: acls: @@ -1371,6 +1876,8 @@ components: - RESOURCE_TYPE_TRANSACTIONAL_ID - RESOURCE_TYPE_DELEGATION_TOKEN - RESOURCE_TYPE_USER + - RESOURCE_TYPE_REGISTRY + - RESOURCE_TYPE_SUBJECT type: string Resources: properties: @@ -1402,6 +1909,20 @@ components: - memory_shares - cpu_shares type: object + Role: + description: Role defines a role in the system. + properties: + name: + description: The name of the role. + type: string + type: object + RoleMembership: + description: RoleMembership is the role membership. + properties: + principal: + description: The name of the principal assigned to the role. + type: string + type: object SASLMechanism: description: SASL mechanism to use for authentication. enum: @@ -1465,12 +1986,21 @@ components: $ref: '#/components/schemas/AlterTopicPartitionStatus' type: array type: object + SetQuotaRequest: + properties: + entity: + $ref: '#/components/schemas/RequestQuotaEntity' + value: + $ref: '#/components/schemas/RequestQuotaValue' + type: object + SetQuotaResponse: + type: object SetTopicConfigurationsResponse: properties: configurations: description: Topic's complete set of configurations after this update. items: - $ref: '#/components/schemas/Configuration' + $ref: '#/components/schemas/Topic.Configuration' type: array type: object SetTopicPartitionsBody: @@ -1485,16 +2015,33 @@ components: type: object SetTopicPartitionsResponse: type: object + StartMCPServerResponse: + properties: + mcp_server: + $ref: '#/components/schemas/MCPServer' + type: object StartPipelineResponse: properties: pipeline: $ref: '#/components/schemas/Pipeline' type: object + StopMCPServerResponse: + properties: + mcp_server: + $ref: '#/components/schemas/MCPServer' + type: object StopPipelineResponse: properties: pipeline: $ref: '#/components/schemas/Pipeline' type: object + SuccessfulEntity: + properties: + entity_name: + type: string + entity_type: + $ref: '#/components/schemas/EntityType' + type: object TaskInfo: properties: connector: @@ -1521,6 +2068,39 @@ components: description: ID of worker that the task is assigned to. type: string type: object + Topic.Configuration: + properties: + config_synonyms: + description: |- + If no config value is set at the topic level, it will inherit the value + set at the broker or cluster level. `name` is the corresponding config + key whose value is inherited. `source` indicates whether the inherited + config is default, broker, etc. + items: + $ref: '#/components/schemas/ConfigSynonym' + type: array + documentation: + description: Config documentation. + nullable: true + type: string + name: + description: A topic-level config key (e.g. `segment.bytes`). + type: string + read_only: + description: Whether the config is read-only, or is dynamic and can be altered. + type: boolean + sensitive: + description: Whether this is a sensitive config key and value. + type: boolean + source: + $ref: '#/components/schemas/ConfigSource' + type: + $ref: '#/components/schemas/ConfigType' + value: + description: A topic-level config value (e.g. 1073741824). + nullable: true + type: string + type: object TopicLocation: properties: topic_location: @@ -1617,6 +2197,11 @@ components: secret: $ref: '#/components/schemas/Secret' type: object + UpdateMCPServerResponse: + properties: + mcp_server: + $ref: '#/components/schemas/MCPServer' + type: object UpdateMountTaskBody: properties: action: @@ -1631,6 +2216,42 @@ components: pipeline: $ref: '#/components/schemas/Pipeline' type: object + UpdateRoleMembershipBody: + description: UpdateRoleMembershipRequest is the request to UpdateRoleMembership. + properties: + add: + description: Members to assign to the role. + items: + $ref: '#/components/schemas/RoleMembership' + type: array + create: + description: |- + Create the role if it doesn't already exist. + If the role is created in this way, the “add” list will be respected, but the “remove” list will be ignored. + type: boolean + remove: + description: Members to remove from the role. + items: + $ref: '#/components/schemas/RoleMembership' + type: array + type: object + UpdateRoleMembershipResponse: + description: UpdateRoleMembershipResponse is the response for UpdateRoleMembership. + properties: + added: + description: Members assigned to the role. + items: + $ref: '#/components/schemas/RoleMembership' + type: array + removed: + description: Members removed from the role. + items: + $ref: '#/components/schemas/RoleMembership' + type: array + role_name: + description: The role name. + type: string + type: object UpdateSecretBody: description: UpdateSecretRequest is the request of UpdateSecret. properties: @@ -1662,7 +2283,7 @@ components: configurations: description: Topic's complete set of configurations after applying this partial patch. items: - $ref: '#/components/schemas/Configuration' + $ref: '#/components/schemas/Topic.Configuration' type: array type: object UpdateUserRequest.User: @@ -1694,6 +2315,22 @@ components: connector: $ref: '#/components/schemas/ConnectorSpec' type: object + ValueType: + description: |- + The type of value that the quota represents. + + - VALUE_TYPE_PRODUCER_BYTE_RATE: The rate at which producers can send data. + - VALUE_TYPE_CONSUMER_BYTE_RATE: The rate at which consumers can fetch data. + - VALUE_TYPE_CONTROLLER_MUTATION_RATE: The rate at which topic mutation requests can be made. + - VALUE_TYPE_REQUEST_PERCENTAGE: The percentage of the total throughput that can be used by the entity. + + Not supported in Redpanda + enum: + - VALUE_TYPE_PRODUCER_BYTE_RATE + - VALUE_TYPE_CONSUMER_BYTE_RATE + - VALUE_TYPE_CONTROLLER_MUTATION_RATE + - VALUE_TYPE_REQUEST_PERCENTAGE + type: string rpc.Status: description: |- The `Status` type defines a logical error model that is suitable for @@ -1780,7 +2417,6 @@ components: info: title: Redpanda Cloud Data Plane API version: v1 - description: 'Use the Data Plane API to manage topics, ACLs, and connectors within each cluster.' openapi: 3.0.3 paths: /v1/acls: @@ -1803,6 +2439,8 @@ paths: - RESOURCE_TYPE_TRANSACTIONAL_ID - RESOURCE_TYPE_DELEGATION_TOKEN - RESOURCE_TYPE_USER + - RESOURCE_TYPE_REGISTRY + - RESOURCE_TYPE_SUBJECT type: string - description: The name of the resource this ACL targets. in: query @@ -1913,6 +2551,8 @@ paths: - RESOURCE_TYPE_TRANSACTIONAL_ID - RESOURCE_TYPE_DELEGATION_TOKEN - RESOURCE_TYPE_USER + - RESOURCE_TYPE_REGISTRY + - RESOURCE_TYPE_SUBJECT type: string - description: The name of the resource this ACL targets. in: query @@ -2360,7 +3000,7 @@ paths: - Cloud Storage /v1/kafka-connect/clusters: get: - description: List Connect clusters available in Console. + description: List connect clusters available for being consumed by the console's kafka-connect service. operationId: KafkaConnectService_ListConnectClusters responses: "200": @@ -2387,7 +3027,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Connect clusters + summary: List connect clusters tags: - Kafka Connect /v1/kafka-connect/clusters/{cluster_name}: @@ -2395,7 +3035,7 @@ paths: description: Get information about an available Kafka Connect cluster. operationId: KafkaConnectService_GetConnectCluster parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -2406,7 +3046,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetConnectClusterResponse' + $ref: '#/components/schemas/ConnectCluster' description: OK "401": content: @@ -2432,7 +3072,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Connect cluster + summary: Get connect cluster tags: - Kafka Connect /v1/kafka-connect/clusters/{cluster_name}/connectors: @@ -2507,7 +3147,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateConnectorResponse' + $ref: '#/components/schemas/ConnectorSpec' description: Created "401": content: @@ -2595,7 +3235,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetConnectorResponse' + $ref: '#/components/schemas/ConnectorSpec' description: OK "401": content: @@ -2636,12 +3276,6 @@ paths: schema: type: string responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/GetConnectorConfigResponse' - description: OK "401": content: application/json: @@ -2696,7 +3330,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpsertConnectorResponse' + $ref: '#/components/schemas/ConnectorSpec' description: Updated "201": content: @@ -2730,7 +3364,7 @@ paths: description: Pause the connector and its tasks, which stops messages from processing until the connector is resumed. This call is asynchronous and may take some time to process. operationId: KafkaConnectService_PauseConnector parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -2774,7 +3408,7 @@ paths: description: Triggers a connector restart. You must specify whether or not tasks are also restarted, and whether only failed connectors are restarted. operationId: KafkaConnectService_RestartConnector parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -2825,7 +3459,7 @@ paths: description: Resume a paused connector and its tasks, and resumes message processing. This call is asynchronous and may take some time to process. If the connector was not paused, this operation does not do anything. operationId: KafkaConnectService_ResumeConnector parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -2869,7 +3503,7 @@ paths: description: Gets the current status of the connector, including the state for each of its tasks, error information, etc. operationId: KafkaConnectService_GetConnectorStatus parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -2886,7 +3520,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetConnectorStatusResponse' + $ref: '#/components/schemas/ConnectorStatus' description: OK "401": content: @@ -2914,7 +3548,7 @@ paths: description: Stops a connector, but does not delete it. All tasks for the connector are shut down completely. This call is asynchronous and may take some time to process. operationId: KafkaConnectService_StopConnector parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -2958,7 +3592,7 @@ paths: description: Returns a list of connector topic names. If the connector is inactive, this call returns an empty list. operationId: KafkaConnectService_ListConnectorTopics parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3003,7 +3637,7 @@ paths: description: Resets the set of topic names that the connector is using. operationId: KafkaConnectService_ResetConnectorTopics parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3047,7 +3681,7 @@ paths: description: 'List Kafka Connect cluster secrets. Optional: filter based on secret name and labels.' operationId: SecretService_ListKafkaConnectSecrets parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3091,7 +3725,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListKafkaConnectSecretsResponse' + $ref: '#/components/schemas/ListSecretsResponse' description: OK "401": content: @@ -3111,7 +3745,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Connect cluster secrets + summary: List Connect Cluster Secrets tags: - Secrets post: @@ -3136,7 +3770,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateKafkaConnectSecretResponse' + $ref: '#/components/schemas/GetKafkaConnectSecretResponse' description: Secret created "401": content: @@ -3156,7 +3790,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create Connect cluster secret + summary: Create Connect Cluster Secret tags: - Secrets /v1/kafka-connect/clusters/{cluster_name}/secrets/{id}: @@ -3164,7 +3798,7 @@ paths: description: Delete a Kafka Connect cluster secret. operationId: SecretService_DeleteKafkaConnectSecret parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3206,7 +3840,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete Connect cluster secret + summary: Delete Connect Cluster Secret tags: - Secrets get: @@ -3256,7 +3890,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Connect cluster secret + summary: Get Connect Cluster Secret tags: - Secrets put: @@ -3313,65 +3947,45 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update Connect cluster secret + summary: Update Connect Cluster Secret tags: - Secrets - /v1/redpanda-connect/config-schema: - get: - description: The configuration schema includes available [components and processors](https://docs.redpanda.com/redpanda-cloud/develop/connect/components/about) in this Redpanda Connect instance. - operationId: PipelineService_GetPipelineServiceConfigSchema - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/GetPipelineServiceConfigSchemaResponse' - description: OK - "401": - content: - application/json: - schema: - $ref: '#/components/schemas/rpc.Status' - description: Unauthenticated. - "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: Retrieve the schema for Redpanda Connect pipeline configurations. - tags: - - Redpanda Connect Pipeline - /v1/redpanda-connect/pipelines: + /v1/quotas: get: - description: 'List Redpanda Connect pipelines. Optional: filter based on pipeline name.' - operationId: PipelineService_ListPipelines + description: List client quotas. Use filter parameters to narrow results by entity type and filter criteria. + operationId: QuotaService_ListQuotas parameters: - - description: Substring match on pipeline name. Case-sensitive. + - description: |- + The type of entity to filter by. If unspecified, all entities will be returned. + + - ENTITY_TYPE_USER: Not supported in Redpanda + - ENTITY_TYPE_IP: Not supported in Redpanda in: query - name: filter.name_contains + name: filter.entity_type schema: + enum: + - ENTITY_TYPE_CLIENT_ID + - ENTITY_TYPE_CLIENT_ID_PREFIX + - ENTITY_TYPE_USER + - ENTITY_TYPE_IP type: string - - description: This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18 + - description: Filter by entity name. If unspecified will return all entities for specified entity type. in: query - name: filter.tags[string] + name: filter.entity_name schema: type: string + - description: If true, the entity_name will match the default entity (e.g., default client-id). + in: query + name: filter.match_default + schema: + type: boolean - description: Limit the paginated response to a number of items. Defaults to 100. Use -1 to disable pagination. 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. + - 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: @@ -3381,7 +3995,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListPipelinesResponse' + $ref: '#/components/schemas/ListQuotasResponse' description: OK "401": content: @@ -3401,26 +4015,26 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Redpanda Connect pipelines + summary: List quotas tags: - - Redpanda Connect Pipeline + - Quotas post: - description: Create a new Redpanda Connect pipeline. - operationId: PipelineService_CreatePipeline + description: Create or update client throughput quotas for a single entity. This operation is an upsert. + operationId: QuotaService_SetQuota requestBody: content: application/json: schema: - $ref: '#/components/schemas/PipelineCreate' + $ref: '#/components/schemas/SetQuotaRequest' required: true - x-originalParamName: pipeline + x-originalParamName: body responses: "201": content: application/json: schema: - $ref: '#/components/schemas/CreatePipelineResponse' - description: OK + $ref: '#/components/schemas/SetQuotaResponse' + description: Quota Set "401": content: application/json: @@ -3439,19 +4053,26 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create Redpanda Connect pipeline + summary: Set a quota tags: - - Redpanda Connect Pipeline - /v1/redpanda-connect/pipelines-by-secrets: - get: - description: Get Redpanda Connect pipelines by secrets. - operationId: PipelineService_GetPipelinesBySecrets + - Quotas + /v1/quotas:batchDelete: + post: + description: Delete client quotas for multiple entities and values in a single request. + operationId: QuotaService_BatchDeleteQuota + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchDeleteQuotaRequest' + required: true + x-originalParamName: body responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetPipelinesBySecretsResponse' + $ref: '#/components/schemas/BatchDeleteQuotaResponse' description: OK "401": content: @@ -3471,27 +4092,27 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Redpanda Connect pipelines by secrets + summary: Delete multiple quotas tags: - - Redpanda Connect Pipeline - /v1/redpanda-connect/pipelines-for-secret: - get: - description: Get Redpanda Connect pipelines for a given secret. - operationId: PipelineService_GetPipelinesForSecret - parameters: - - description: Secret ID. - in: query - name: secret_id - required: true - schema: - type: string + - Quotas + /v1/quotas:batchSet: + post: + description: Create or update client throughput quotas for multiple entities in a single request. + operationId: QuotaService_BatchSetQuota + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchSetQuotaRequest' + required: true + x-originalParamName: body responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/GetPipelinesForSecretResponse' - description: OK + $ref: '#/components/schemas/BatchSetQuotaResponse' + description: Quotas Set "401": content: application/json: @@ -3510,38 +4131,33 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Redpanda Connect pipelines for secret + summary: Set multiple quotas tags: - - Redpanda Connect Pipeline - /v1/redpanda-connect/pipelines/{id}: - delete: - description: Delete a Redpanda Connect pipeline. - operationId: PipelineService_DeletePipeline - parameters: - - description: Pipeline ID. - in: path - name: id - required: true - schema: - type: string + - Quotas + /v1/quotas:delete: + post: + description: Delete client quotas for single entity and value. + operationId: QuotaService_DeleteQuota + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteQuotaRequest' + required: true + x-originalParamName: body responses: - "204": + "200": content: application/json: - schema: {} - description: Deleted + schema: + $ref: '#/components/schemas/DeleteQuotaResponse' + description: OK "401": content: application/json: schema: $ref: '#/components/schemas/rpc.Status' description: Unauthenticated. - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/rpc.Status' - description: Not Found "500": content: application/json: @@ -3554,14 +4170,189 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete a Redpanda Connect pipeline + summary: Delete a quota + tags: + - Quotas + /v1/redpanda-connect/config-schema: + get: + description: The configuration schema includes available [components and processors](https://docs.redpanda.com/redpanda-cloud/develop/connect/components/about) in this Redpanda Connect instance. + operationId: PipelineService_GetPipelineServiceConfigSchema + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetPipelineServiceConfigSchemaResponse' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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: Retrieve the schema for Redpanda Connect pipeline configurations. tags: - Redpanda Connect Pipeline + /v1/redpanda-connect/mcp-servers: get: - description: Get a specific Redpanda Connect pipeline. - operationId: PipelineService_GetPipeline + description: 'List Redpanda Connect MCP Servers. Optional: filter based on MCP server name.' + operationId: MCPServerService_ListMCPServers parameters: - - description: Pipeline ID. + - description: Any MCP Server that partially match this name will be returned. + in: query + name: filter.display_name_contains + schema: + type: string + - description: This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18 + in: query + name: filter.tags[string] + schema: + type: string + - description: Match MCP servers that use this secret ID. + in: query + name: filter.secret_id + schema: + type: string + - description: Limit the paginated response to a number of items. Defaults to 100. Use -1 to disable pagination. + 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/ListMCPServersResponse' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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 Redpanda Connect MCP Servers + tags: + - Redpanda Connect MCP servers + post: + description: Create a new Redpanda Connect MCP Server. + operationId: MCPServerService_CreateMCPServer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MCPServerCreate' + required: true + x-originalParamName: mcp_server + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MCPServer' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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 Redpanda Connect MCP Server + tags: + - Redpanda Connect MCP servers + /v1/redpanda-connect/mcp-servers/{id}: + delete: + description: Delete a Redpanda Connect MCP server. + operationId: MCPServerService_DeleteMCPServer + parameters: + - description: MCP Server ID. + in: path + name: id + required: true + schema: + type: string + responses: + "204": + content: + application/json: + schema: {} + description: Deleted + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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: Delete a Redpanda Connect MCP server + tags: + - Redpanda Connect MCP servers + get: + description: Get a specific Redpanda Connect MCP server. + operationId: MCPServerService_GetMCPServer + parameters: + - description: MCP server ID. in: path name: id required: true @@ -3572,7 +4363,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetPipelineResponse' + $ref: '#/components/schemas/MCPServer' description: OK "401": content: @@ -3598,14 +4389,14 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Redpanda Connect pipeline + summary: Get Redpanda Connect MCP server tags: - - Redpanda Connect Pipeline + - Redpanda Connect MCP servers put: - description: Update the [configuration](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/about) of a Redpanda Connect pipeline. - operationId: PipelineService_UpdatePipeline + description: Update the configuration of a Redpanda Connect MCP server. + operationId: MCPServerService_UpdateMCPServer parameters: - - description: Pipeline ID. + - description: MCP Server ID. in: path name: id required: true @@ -3622,15 +4413,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PipelineUpdate' + $ref: '#/components/schemas/MCPServerUpdate' required: true - x-originalParamName: pipeline + x-originalParamName: mcp_server responses: "200": content: application/json: schema: - $ref: '#/components/schemas/UpdatePipelineResponse' + $ref: '#/components/schemas/MCPServer' description: OK "401": content: @@ -3650,15 +4441,15 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update a Redpanda Connect pipeline + summary: Update a Redpanda Connect MCP Server tags: - - Redpanda Connect Pipeline - /v1/redpanda-connect/pipelines/{id}/start: - put: - description: Start a stopped Redpanda Connect pipeline. - operationId: PipelineService_StartPipeline + - Redpanda Connect MCP servers + /v1/redpanda-connect/mcp-servers/{id}:start: + post: + description: Start a stopped Redpanda Connect MCP server. + operationId: MCPServerService_StartMCPServer parameters: - - description: Pipeline ID. + - description: MCP Server ID. in: path name: id required: true @@ -3669,7 +4460,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StartPipelineResponse' + $ref: '#/components/schemas/MCPServer' description: Started "401": content: @@ -3695,15 +4486,15 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Start a Redpanda Connect pipeline + summary: Start a Redpanda Connect MCP server tags: - - Redpanda Connect Pipeline - /v1/redpanda-connect/pipelines/{id}/stop: - put: - description: Stop a running Redpanda Connect pipeline. - operationId: PipelineService_StopPipeline + - Redpanda Connect MCP servers + /v1/redpanda-connect/mcp-servers/{id}:stop: + post: + description: Stop a running Redpanda Connect MCP server. + operationId: MCPServerService_StopMCPServer parameters: - - description: Pipeline ID. + - description: MCP Server ID. in: path name: id required: true @@ -3714,7 +4505,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StopPipelineResponse' + $ref: '#/components/schemas/MCPServer' description: Stopped "401": content: @@ -3740,9 +4531,776 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Stops a Redpanda Connect pipeline + summary: Stops a Redpanda Connect MCP server tags: - - Redpanda Connect Pipeline + - Redpanda Connect MCP servers + /v1/redpanda-connect/mcp-servers:getConfigSchema: + get: + description: The configuration schema includes available components and processors in this Redpanda Connect MCP Server instance. + operationId: MCPServerService_GetMCPServerServiceConfigSchema + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetMCPServerServiceConfigSchemaResponse' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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: Retrieve the schema for Redpanda Connect MCP Servers configurations. + tags: + - Redpanda Connect MCP servers + /v1/redpanda-connect/pipelines: + get: + description: 'List Redpanda Connect pipelines. Optional: filter based on pipeline name.' + operationId: PipelineService_ListPipelines + parameters: + - description: Any pipelines that partially match this name will be returned. + in: query + name: filter.name_contains + schema: + type: string + - description: This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18 + in: query + name: filter.tags[string] + schema: + type: string + - description: Limit the paginated response to a number of items. Defaults to 100. Use -1 to disable pagination. + 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/ListPipelinesResponse' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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 Redpanda Connect pipelines + tags: + - Redpanda Connect Pipeline + post: + description: Create a new Redpanda Connect pipeline. + operationId: PipelineService_CreatePipeline + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PipelineCreate' + required: true + x-originalParamName: pipeline + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/Pipeline' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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 Redpanda Connect pipeline + tags: + - Redpanda Connect Pipeline + /v1/redpanda-connect/pipelines-by-secrets: + get: + description: Get Redpanda Connect pipelines by secrets. + operationId: PipelineService_GetPipelinesBySecrets + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetPipelinesBySecretsResponse' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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 Redpanda Connect pipelines by secrets + tags: + - Redpanda Connect Pipeline + /v1/redpanda-connect/pipelines-for-secret: + get: + description: Get Redpanda Connect pipelines for a given secret. + operationId: PipelineService_GetPipelinesForSecret + parameters: + - description: Secret ID. + in: query + name: secret_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetPipelinesForSecretResponse' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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 Redpanda Connect pipelines for secret + tags: + - Redpanda Connect Pipeline + /v1/redpanda-connect/pipelines/{id}: + delete: + description: Delete a Redpanda Connect pipeline. + operationId: PipelineService_DeletePipeline + parameters: + - description: Pipeline ID. + in: path + name: id + required: true + schema: + type: string + responses: + "204": + content: + application/json: + schema: {} + description: Deleted + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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: Delete a Redpanda Connect pipeline + tags: + - Redpanda Connect Pipeline + get: + description: Get a specific Redpanda Connect pipeline. + operationId: PipelineService_GetPipeline + parameters: + - description: Pipeline ID. + in: path + name: id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Pipeline' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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 Redpanda Connect pipeline + tags: + - Redpanda Connect Pipeline + put: + description: Update the [configuration](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/about) of a Redpanda Connect pipeline. + operationId: PipelineService_UpdatePipeline + parameters: + - description: Pipeline ID. + in: path + name: id + required: true + schema: + type: string + - description: |- + Specifies which fields should be updated. If not provided, + all fields will be updated. + in: query + name: update_mask + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PipelineUpdate' + required: true + x-originalParamName: pipeline + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Pipeline' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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 a Redpanda Connect pipeline + tags: + - Redpanda Connect Pipeline + /v1/redpanda-connect/pipelines/{id}/start: + put: + description: Start a stopped Redpanda Connect pipeline. + operationId: PipelineService_StartPipeline + parameters: + - description: Pipeline ID. + in: path + name: id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Pipeline' + description: Started + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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: Start a Redpanda Connect pipeline + tags: + - Redpanda Connect Pipeline + /v1/redpanda-connect/pipelines/{id}/stop: + put: + description: Stop a running Redpanda Connect pipeline. + operationId: PipelineService_StopPipeline + parameters: + - description: Pipeline ID. + in: path + name: id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Pipeline' + description: Stopped + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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: Stops a Redpanda Connect pipeline + tags: + - Redpanda Connect Pipeline + /v1/redpanda-connect/pipelines:lint-config: + post: + description: Validates a supplied Redpanda Connect pipeline YAML and returns a list of linting hints. If no problems are found, the list is empty. + operationId: PipelineService_LintPipelineConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LintPipelineConfigRequest' + required: true + x-originalParamName: body + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/LintPipelineConfigResponse' + description: Linting finished. See `lint_hints` for details. + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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: Lint a Redpanda Connect pipeline configuration + tags: + - Redpanda Connect Pipeline + /v1/roles: + get: + description: 'List roles. Optional: filter based on role name and principal.' + operationId: SecurityService_ListRoles + parameters: + - description: Filter results only roles named with the prefix. + in: query + name: filter.name_prefix + schema: + type: string + - description: Filter results to only roles with names which contain the string. + in: query + name: filter.name_contains + schema: + type: string + - description: Return only roles assigned to this principal. + in: query + name: filter.principal + schema: + type: string + - description: Page size. + 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/ListRolesResponse' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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 Roles + tags: + - Security + post: + description: Create a role. + operationId: SecurityService_CreateRole + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + description: The role to create. + required: true + x-originalParamName: role + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateRoleResponse' + description: Role created + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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 + tags: + - Security + /v1/roles/{role_name}: + delete: + description: Delete a Role. + operationId: SecurityService_DeleteRole + parameters: + - description: The role name. + in: path + name: role_name + required: true + schema: + type: string + - description: Whether to delete the ACLs bound to the role. + in: query + name: delete_acls + schema: + type: boolean + responses: + "204": + content: + application/json: + schema: {} + description: Role deleted successfully + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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: Delete Role + tags: + - Security + get: + description: Get a role. + operationId: SecurityService_GetRole + parameters: + - description: The role name. + in: path + name: role_name + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetRoleResponse' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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 + tags: + - Security + put: + description: Update a role. + operationId: SecurityService_UpdateRoleMembership + parameters: + - description: The role name. + in: path + name: role_name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateRoleMembershipBody' + required: true + x-originalParamName: body + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateRoleMembershipResponse' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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 Role + tags: + - Security + /v1/roles/{role_name}/members: + get: + description: List members assigned to a role. + operationId: SecurityService_ListRoleMembers + parameters: + - description: The role name. + in: path + name: role_name + required: true + schema: + type: string + - description: Filter results to only members with names which contain the string. + in: query + name: filter.name_contains + schema: + type: string + - description: Page size. + 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/ListRoleMembersResponse' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "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 Members + tags: + - Security /v1/secret-scopes: get: description: List supported secret scopes. @@ -3772,7 +5330,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List secret scopes + summary: List Secret Scopes tags: - Secrets /v1/secrets: @@ -3838,7 +5396,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List secrets + summary: List Secrets tags: - Secrets post: @@ -3877,7 +5435,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create secret + summary: Create Secret tags: - Secrets /v1/secrets/{id}: @@ -3921,7 +5479,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete secret + summary: Delete Secret tags: - Secrets get: @@ -3965,7 +5523,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get secret + summary: Get Secret tags: - Secrets put: @@ -4016,7 +5574,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update secret + summary: Update Secret tags: - Secrets /v1/topics: @@ -4065,7 +5623,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List topics + summary: List Topics tags: - Topics post: @@ -4112,7 +5670,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create topic + summary: Create Topic tags: - Topics /v1/topics-partitions: @@ -4157,7 +5715,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Add topic partitions + summary: Add Topic Partitions tags: - Topics put: @@ -4201,7 +5759,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Set topic partitions + summary: Set Topic Partitions tags: - Topics /v1/topics/{topic_name}: @@ -4245,7 +5803,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete topic + summary: Delete Topic tags: - Topics /v1/topics/{topic_name}/configurations: @@ -4290,7 +5848,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get topic configurations + summary: Get Topic Configurations tags: - Topics patch: @@ -4343,7 +5901,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update topic configuration + summary: Update Topic Configuration tags: - Topics put: @@ -4396,7 +5954,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Set topic configurations + summary: Set Topic Configurations tags: - Topics /v1/topics/{topic_name}/partitions: @@ -4448,7 +6006,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Add topic partitions + summary: Add Topic Partitions tags: - Topics put: @@ -4499,7 +6057,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Set topic partitions + summary: Set Topic Partitions tags: - Topics /v1/transforms: @@ -4575,7 +6133,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List transforms + summary: List Transforms tags: - WASM Transforms put: @@ -4585,7 +6143,7 @@ paths: content: multipart/form-data: schema: - example: '{"name":"redact-orders","input_topic_name":"orders","output_topic_names":["orders-redacted"],"environment_variables":[{"key":"LOGGER_LEVEL","value":"DEBUG"}]}' + example: '{"name":"redact-orders", "input_topic_name":"orders", "output_topic_names":["orders-redacted"], "environment_variables":[{"key":"LOGGER_LEVEL", "value":"DEBUG"}]}' properties: metadata: $ref: '#/components/schemas/DeployTransformRequest' @@ -4603,7 +6161,7 @@ paths: schema: $ref: '#/components/schemas/TransformMetadata' description: Created - summary: Deploy transform + summary: Deploy Transform tags: - WASM Transforms /v1/transforms/{name}: @@ -4650,7 +6208,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete transform + summary: Delete Transform tags: - WASM Transforms get: @@ -4709,7 +6267,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get transform + summary: Get Transform tags: - WASM Transforms /v1/users: @@ -4770,7 +6328,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List users + summary: List Users tags: - Redpanda Users post: @@ -4812,8 +6370,12 @@ paths: field_violations: - description: value length must be at least 3 characters field: user.password + localized_message: null + reason: "" - description: value is required field: user.mechanism + localized_message: null + reason: "" message: provided parameters are invalid schema: $ref: '#/components/schemas/rpc.Status' @@ -4836,7 +6398,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create user + summary: Create User tags: - Redpanda Users /v1/users/{name}: @@ -4889,7 +6451,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete user + summary: Delete User tags: - Redpanda Users /v1/users/{user.name}: @@ -4945,8 +6507,12 @@ paths: field_violations: - description: value length must be at least 3 characters field: user.password + localized_message: null + reason: "" - description: value is required field: user.mechanism + localized_message: null + reason: "" message: provided parameters are invalid schema: $ref: '#/components/schemas/rpc.Status' @@ -4969,21 +6535,21 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update user + summary: Update User tags: - Redpanda Users security: - auth0: [] servers: - description: Data Plane API - url: 'https://{dataplane_api_url}.cloud.redpanda.com' + url: '{dataplane_api_url}' variables: dataplane_api_url: - default: "dataplane_api.url" + default: https://{dataplane_api_url} description: |- Find the Data Plane API base URL of a cluster by calling the Get Cluster endpoint of the Control Plane API. The dataplane_api.url field is returned in the response body.

- Example (Dedicated): "https://api-a4cb21.ck09mi9c4vs17hng9gig.fmc.prd.cloud.redpanda.com"
- Example (BYOC): "https://api-a4cb21.ck09mi9c4vs17hng9gig.byoc.prd.cloud.redpanda.com" + Example (Dedicated): "https://api-a4cb21.ck09mi9c4vs17hng9gig.fmc.prd.cloud.redpanda.com"
+ Example (BYOC): "https://api-a4cb21.ck09mi9c4vs17hng9gig.byoc.prd.cloud.redpanda.com" tags: - description: Manage Redpanda access control lists (ACLs). See [Redpanda Cloud Authorization](https://docs.redpanda.com/redpanda-cloud/security/authorization/cloud-authorization/) for more information. name: Redpanda ACLs @@ -4995,9 +6561,15 @@ tags: name: Kafka Connect - description: Create and manage [Redpanda Connect](https://docs.redpanda.com/redpanda-cloud/develop/connect/about) pipelines and their configurations. name: Redpanda Connect Pipeline + - description: Create and manage Redpanda Connect MCP servers and their configurations. + name: Redpanda Connect MCP servers + - description: Manage client throughput limits. See [Redpanda Client Throughput Limits](https://docs.redpanda.com/current/manage/cluster-maintenance/manage-throughput/#client-throughput-limits) for more information. + name: Quotas - description: Manage [secrets](https://docs.redpanda.com/redpanda-cloud/security/secrets) for Redpanda Cloud. name: Secrets + - description: Manage Redpanda roles. + name: Security - description: Manage Redpanda topics. name: Topics - - description: Manage Redpanda users. To manage access, see the Data Plane [ACL endpoints](https://docs.redpanda.com/api/doc/cloud-dataplane/group/endpoint-redpanda-users). + - description: Manage Redpanda users. To manage access, see the Data Plane [ACL endpoints](https://docs.redpanda.com/api/cloud-dataplane-api/#get-/v1/acls). name: Redpanda Users