diff --git a/modules/develop/pages/connect/about.adoc b/modules/develop/pages/connect/about.adoc index a0c30765..bab5a7a2 100644 --- a/modules/develop/pages/connect/about.adoc +++ b/modules/develop/pages/connect/about.adoc @@ -1,5 +1,5 @@ = Redpanda Connect in Redpanda Cloud -:tag-pipeline-service: api:ROOT:cloud-dataplane-api.adoc#tag--PipelineService +:tag-pipeline-service: api:ROOT:cloud-dataplane-api.adoc#tag--Redpanda-Connect-Pipeline :description: Learn about Redpanda Connect in Redpanda Cloud and its wide range of connectors. Redpanda Connect in Redpanda Cloud lets you quickly build and deploy streaming data pipelines on your clusters from a fully-integrated UI or using the pass:a,m[xref:{tag-pipeline-service}[Data Plane API\]]. diff --git a/modules/develop/pages/connect/configuration/resource-management.adoc b/modules/develop/pages/connect/configuration/resource-management.adoc index 7ad6a9cd..067bad0b 100644 --- a/modules/develop/pages/connect/configuration/resource-management.adoc +++ b/modules/develop/pages/connect/configuration/resource-management.adoc @@ -135,7 +135,7 @@ Data Plane API:: + -- . xref:manage:api/cloud-api-quickstart.adoc#try-the-cloud-api[Authenticate and get the base URL] for the Data Plane API. -. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#get-/v1alpha2/redpanda-connect/pipelines[`GET /v1alpha2/redpanda-connect/pipelines`], which lists details of all pipelines on your cluster by ID. +. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#get-/v1/redpanda-connect/pipelines[`GET /v1/redpanda-connect/pipelines`], which lists details of all pipelines on your cluster by ID. + * Memory (`memory_shares`) is displayed in megabytes. For example, `1` task is `400M` or 400 MB. * CPU resources (`cpu_shares`) are displayed milliCPU. For example, `1` task is `100m` or 0.1 CPU. @@ -163,8 +163,8 @@ Data Plane API:: You can only update CPU resources using the Data Plane API. For every 0.1 CPU that you allocate, Redpanda Cloud automatically reserves 400 MB of memory for the exclusive use of the pipeline. . xref:manage:api/cloud-api-quickstart.adoc#try-the-cloud-api[Authenticate and get the base URL] for the Data Plane API, if you haven't already. -. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#get-/v1alpha2/redpanda-connect/pipelines/-id-[`GET /v1alpha2/redpanda-connect/pipelines/\{id}`], including the ID of the pipeline you want to update. You'll use the returned values in the next step. -. Now make a request to xref:api:ROOT:cloud-dataplane-api.adoc#put-/v1alpha2/redpanda-connect/pipelines/-id-[`PUT /v1alpha2/redpanda-connect/pipelines/\{id}`], to update the pipeline resources: +. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#get-/v1/redpanda-connect/pipelines/-id-[`GET /v1/redpanda-connect/pipelines/\{id}`], including the ID of the pipeline you want to update. You'll use the returned values in the next step. +. Now make a request to xref:api:ROOT:cloud-dataplane-api.adoc#put-/v1/redpanda-connect/pipelines/-id-[`PUT /v1/redpanda-connect/pipelines/\{id}`], to update the pipeline resources: + * Reuse the values returned by your `GET` request to populate the request body. * Replace the `cpu_shares` value with the resources you want to allocate, and enter any valid value for `memory_shares`. @@ -173,7 +173,7 @@ This example allocates 0.2 CPU or 200 milliCPU to a data pipeline. For `cpu_shar + [,bash,role=“no-placeholders”] ---- -curl -X PUT "https:///v1alpha2/redpanda-connect/pipelines/xxx..." \ +curl -X PUT "https:///v1/redpanda-connect/pipelines/xxx..." \ -H 'accept: application/json'\ -H 'authorization: Bearer xxx...' \ -H "content-type: application/json" \ @@ -188,6 +188,6 @@ curl -X PUT "https:///v1alpha2/redpanda-connect/pipelines/xx ---- + A successful response shows the updated resource allocations with the `cpu_shares` value returned in milliCPU. -. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#get-/v1alpha2/redpanda-connect/pipelines[`GET /v1alpha2/redpanda-connect/pipelines`] to verify your pipeline resource updates. +. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#get-/v1/redpanda-connect/pipelines[`GET /v1/redpanda-connect/pipelines`] to verify your pipeline resource updates. -- ===== \ No newline at end of file diff --git a/modules/develop/pages/connect/configuration/secret-management.adoc b/modules/develop/pages/connect/configuration/secret-management.adoc index dda52b26..dadbf11f 100644 --- a/modules/develop/pages/connect/configuration/secret-management.adoc +++ b/modules/develop/pages/connect/configuration/secret-management.adoc @@ -62,11 +62,11 @@ Data Plane API:: You must use a Base64-encoded secret. . xref:manage:api/cloud-api-quickstart.adoc#try-the-cloud-api[Authenticate and get the base URL] for the Data Plane API. -. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#post-/v1alpha2/secrets[`POST /v1alpha2/secrets`]. +. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#post-/v1/secrets[`POST /v1/secrets`]. + [,bash] ---- -curl -X POST "https:///v1alpha2/secrets" \ +curl -X POST "https:///v1/secrets" \ -H 'accept: application/json'\ -H 'authorization: Bearer '\ -H 'content-type: application/json' \ @@ -127,11 +127,11 @@ Data Plane API:: You must use a Base64-encoded secret. . xref:manage:api/cloud-api-quickstart.adoc#try-the-cloud-api[Authenticate and get the base URL] for the Data Plane API. -. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#put-/v1alpha2/secrets/-id-[`PUT /v1alpha2/secrets/\{id}`]. +. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#put-/v1/secrets/-id-[`PUT /v1/secrets/\{id}`]. + [,bash] ---- -curl -X PUT "https:///v1alpha2/secrets/" \ +curl -X PUT "https:///v1/secrets/" \ -H 'accept: application/json'\ -H 'authorization: Bearer '\ -H 'content-type: application/json' \ @@ -188,11 +188,11 @@ Data Plane API:: -- . xref:manage:api/cloud-api-quickstart.adoc#try-the-cloud-api[Authenticate and get the base URL] for the Data Plane API. -. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#delete-/v1alpha2/secrets/-id-[`DELETE /v1alpha2/secrets/\{id}`]. +. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#delete-/v1/secrets/-id-[`DELETE /v1/secrets/\{id}`]. + [,bash] ---- -curl -X DELETE "https:///v1alpha2/secrets/" \ +curl -X DELETE "https:///v1/secrets/" \ -H 'accept: application/json'\ -H 'authorization: Bearer '\ ---- diff --git a/modules/get-started/pages/cloud-overview.adoc b/modules/get-started/pages/cloud-overview.adoc index 00c1c974..2c59509b 100644 --- a/modules/get-started/pages/cloud-overview.adoc +++ b/modules/get-started/pages/cloud-overview.adoc @@ -1,7 +1,7 @@ = Redpanda Cloud Overview :description: Learn about Redpanda Serverless Standard, Serverless Pro, Dedicated, and Bring Your Own Cloud (BYOC) clusters. :description: Learn about Redpanda Serverless, Dedicated, and Bring Your Own Cloud (BYOC) clusters. -:tag-pipeline-service: api:ROOT:cloud-dataplane-api.adoc#tag--PipelineService +:tag-pipeline-service: api:ROOT:cloud-dataplane-api.adoc#tag--Redpanda-Connect-Pipeline :page-aliases: cloud:dedicated-byoc.adoc, deploy:deployment-option/cloud/dedicated-byoc.adoc, deploy:deployment-option/cloud/cloud-overview.adoc @@ -323,7 +323,6 @@ Features in beta are available for testing and feedback. They are not covered by The following features are currently in beta in Redpanda Cloud: * Redpanda Connect for Serverless -* Cloud API * Redpanda Terraform provider * BYOVPC for AWS and Azure * Remote Read Replicas for AWS and GCP diff --git a/modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc b/modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc index 48476805..39dbe25d 100644 --- a/modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc +++ b/modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc @@ -155,7 +155,7 @@ EOF . Use the Cloud API to create the network and retrieve the network ID: + ```bash -export REDPANDA_NETWORK_ID=$(curl -X POST "https://api.redpanda.com/v1beta2/networks" \ +export REDPANDA_NETWORK_ID=$(curl -X POST "https://api.redpanda.com/v1/networks" \ -H "accept: application/json" \ -H "content-type: application/json" \ -H "authorization: Bearer ${BEARER_TOKEN}" \ @@ -170,7 +170,7 @@ The Create Network request returns a `resource_id`. For example: "operation":{ "id":"cpas8k6r4up5li18auh0", "metadata":{ - "@type":"type.googleapis.com/redpanda.api.controlplane.v1beta2.CreateNetworkMetadata", + "@type":"type.googleapis.com/redpanda.api.controlplane.v1.CreateNetworkMetadata", "network_id":"cpb338gekjj5i1cpj3t0" }, "state":"STATE_IN_PROGRESS", @@ -261,7 +261,7 @@ EOF . Use the Cloud API to deploy the cluster and retrieve its ID: + ```bash -export REDPANDA_ID=$(curl -X POST "https://api.redpanda.com/v1beta2/clusters" \ +export REDPANDA_ID=$(curl -X POST "https://api.redpanda.com/v1/clusters" \ -H "accept: application/json" \ -H "content-type: application/json" \ -H "authorization: Bearer ${BEARER_TOKEN}" \ @@ -276,7 +276,7 @@ The create cluster request returns a `resource_id`, which is required in the nex "operation":{ "id":"cpas8k6r4up5li18auhg", "metadata":{ - "@type":"type.googleapis.com/redpanda.api.controlplane.v1beta2.CreateClusterMetadata", + "@type":"type.googleapis.com/redpanda.api.controlplane.v1.CreateClusterMetadata", "cluster_id":"cpb33c8ekjj5i1cpj3v0" }, "state":"STATE_IN_PROGRESS", @@ -356,7 +356,7 @@ Cluster creation is an example of an operation that can take a longer period of Example using the operation ID returned from your create cluster command: ```bash -curl -X GET "https://api.redpanda.com/v1beta2/operations/${REDPANDA_ID}" \ +curl -X GET "https://api.redpanda.com/v1/operations/${REDPANDA_ID}" \ -H "accept: application/json"\ -H "content-type: application/json" \ -H "authorization: Bearer ${BEARER_TOKEN}" @@ -365,7 +365,7 @@ curl -X GET "https://api.redpanda.com/v1beta2/operations/${REDPANDA_ID}" \ Example retrieving cluster: ```bash -curl -X GET "https://api.redpanda.com/v1beta2/clusters/${REDPANDA_ID}" \ +curl -X GET "https://api.redpanda.com/v1/clusters/${REDPANDA_ID}" \ -H "accept: application/json"\ -H "content-type: application/json" \ -H "authorization: Bearer ${BEARER_TOKEN}" @@ -376,7 +376,7 @@ curl -X GET "https://api.redpanda.com/v1beta2/clusters/${REDPANDA_ID}" \ To delete the cluster, first send a DELETE request to the Cloud API, and retrieve the `resource_id` of the DELETE operation. Then run the `rpk` command to destroy the cluster identified by the `resource_id`. ```bash -export REDPANDA_ID=$(curl -X DELETE "https://api.redpanda.com/v1beta2/clusters/${REDPANDA_ID}" \ +export REDPANDA_ID=$(curl -X DELETE "https://api.redpanda.com/v1/clusters/${REDPANDA_ID}" \ -H "accept: application/json"\ -H "content-type: application/json" \ -H "authorization: Bearer ${BEARER_TOKEN}" | jq -r '.operation.resource_id') diff --git a/modules/get-started/pages/cluster-types/byoc/azure/create-byoc-cluster-azure.adoc b/modules/get-started/pages/cluster-types/byoc/azure/create-byoc-cluster-azure.adoc index 0b11fbdb..3f2a4fd0 100644 --- a/modules/get-started/pages/cluster-types/byoc/azure/create-byoc-cluster-azure.adoc +++ b/modules/get-started/pages/cluster-types/byoc/azure/create-byoc-cluster-azure.adoc @@ -128,11 +128,11 @@ To enable xref:develop:managed-connectors/index.adoc[Kafka Connect] for clusters . Authenticate to the Redpanda Cloud API. Follow the steps in xref:manage:api/cloud-api-authentication.adoc[]. -. Enable Kafka Connect by making a xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1beta2/clusters/-cluster.id-[`PATCH /v1beta2/clusters`] request: +. Enable Kafka Connect by making a xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-[`PATCH /v1/clusters`] request: + [,bash] ---- -curl -X PATCH "https://api.redpanda.com/v1beta2/clusters/" \ +curl -X PATCH "https://api.redpanda.com/v1/clusters/" \ -H 'Accept: application/json' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ diff --git a/modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc b/modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc index 91377da4..779eb11e 100644 --- a/modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc +++ b/modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc @@ -326,7 +326,7 @@ EOF . Use the Cloud API to create the network and retrieve the network ID: + ```bash -export REDPANDA_NETWORK_ID=$(curl -X POST "https://api.redpanda.com/v1beta2/networks" \ +export REDPANDA_NETWORK_ID=$(curl -X POST "https://api.redpanda.com/v1/networks" \ -H "accept: application/json" \ -H "content-type: application/json" \ -H "authorization: Bearer ${BEARER_TOKEN}" \ @@ -396,7 +396,7 @@ TIP: See the full list of zones and tiers available with each provider in the xr . Make a Cloud API call to create a Redpanda network and get the network ID from the response in JSON `.operation.metadata.network_id`. + ```bash -export REDPANDA_ID=$(curl -X POST "https://api.redpanda.com/v1beta2/clusters" \ +export REDPANDA_ID=$(curl -X POST "https://api.redpanda.com/v1/clusters" \ -H "accept: application/json"\ -H "content-type: application/json" \ -H "authorization: Bearer ${BEARER_TOKEN}" \ @@ -428,7 +428,7 @@ Cluster creation is an example of an operation that can take a longer period of Example using the returned `operation_id`: ```bash -curl -X GET "https://api.redpanda.com/v1beta2/operations/" \ +curl -X GET "https://api.redpanda.com/v1/operations/" \ -H "accept: application/json"\ -H "content-type: application/json" \ -H "authorization: Bearer ${BEARER_TOKEN}" @@ -437,7 +437,7 @@ curl -X GET "https://api.redpanda.com/v1beta2/operations/" \ +curl -X GET "https://api.redpanda.com/v1/clusters/" \ -H "accept: application/json"\ -H "content-type: application/json" \ -H "authorization: Bearer ${BEARER_TOKEN}" @@ -448,7 +448,7 @@ curl -X GET "https://api.redpanda.com/v1beta2/clusters/> that provide more detail about why an operation failed. Example request: ``` -curl https://api.redpanda.com/clusters/v1beta2 | jq +curl https://api.redpanda.com/v1/clusters | jq ``` Example response: diff --git a/modules/manage/pages/api/cloud-api-overview.adoc b/modules/manage/pages/api/cloud-api-overview.adoc index 31793bcc..55e6e19e 100644 --- a/modules/manage/pages/api/cloud-api-overview.adoc +++ b/modules/manage/pages/api/cloud-api-overview.adoc @@ -3,7 +3,6 @@ :page-aliases: deploy:deployment-option/cloud/api/cloud-api-overview.adoc :page-api: cloud :page-api-slot: overview -:page-beta: true The Redpanda Cloud API is a collection of REST APIs that allow you to interact with different parts of Redpanda Cloud. You can call the API endpoints directly, or use tools like Terraform or Python scripts to automate cluster management and manage Redpanda Cloud resources. @@ -45,10 +44,10 @@ When making requests to the Control Plane API endpoints, the request URL is the [,bash] ---- -https://api.redpanda.com/v1beta2/clusters +https://api.redpanda.com/v1/clusters ---- -The current Control Plane API version is *v1beta2*. +The current Control Plane API version is *v1*. === Data Plane APIs URL @@ -56,10 +55,10 @@ The Data Plane API base URL is unique to the individual target cluster. It is di [,bash] ---- -https://api-aeb32d9b.cn20bu40d061nvem7sv0.fmc.prd.cloud.redpanda.com/v1alpha2/users +https://api-aeb32d9b.cn20bu40d061nvem7sv0.fmc.prd.cloud.redpanda.com/v1/users ---- -The current Data Plane API version is *v1alpha2*. +The current Data Plane API version is *v1*. == Pagination diff --git a/modules/manage/pages/api/cloud-api-quickstart.adoc b/modules/manage/pages/api/cloud-api-quickstart.adoc index 2f762506..f63b3330 100644 --- a/modules/manage/pages/api/cloud-api-quickstart.adoc +++ b/modules/manage/pages/api/cloud-api-quickstart.adoc @@ -2,7 +2,6 @@ :description: Learn how to quickly start using the Cloud API to manage clusters and other resources. :page-aliases: deploy:deployment-option/cloud/api/cloud-api-quickstart.adoc :page-api: cloud -:page-beta: true The following steps describe how to authenticate with the Cloud API and create a new Redpanda cluster. For more information on the Cloud API, see the xref:manage:api/cloud-api-overview.adoc[Redpanda Cloud API Overview]. @@ -14,9 +13,9 @@ BYOC or Dedicated:: + -- . In the Redpanda Cloud UI, create a https://cloud.redpanda.com/organization-iam?tab=service-accounts[service account (client)] and use the client ID and secret to request an API token. Use the token to xref:manage:api/cloud-api-authentication.adoc[authenticate to the API]. -. Create a resource group by making a xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1beta2/resource-groups[`POST /v1beta2/resource-groups`] request. -. Create a network by making a xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1beta2/networks[`POST /v1beta2/networks`] request. Note that this operation may be long-running. -. Create a cluster by making a xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1beta2/clusters[`POST /v1beta2/clusters`] request. +. Create a resource group by making a xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/resource-groups[`POST /v1/resource-groups`] request. +. Create a network by making a xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/networks[`POST /v1/networks`] request. Note that this operation may be long-running. +. Create a cluster by making a xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/clusters[`POST /v1/clusters`] request. . For BYOC, run `rpk cloud byoc`, passing the `metadata.cluster_id` from the Create Cluster response as a flag: + AWS: @@ -42,19 +41,19 @@ Serverless:: + -- . In the Redpanda Cloud UI, create a https://cloud.redpanda.com/organization-iam?tab=service-accounts[service account (client)] and use the client ID and secret to request an API token. Use the token to xref:manage:api/cloud-api-authentication.adoc[authenticate to the API]. -. Make a GET request to the `/v1beta2/resource-groups` endpoint to retrieve the default resource group ID. +. Make a GET request to the `/v1/resource-groups` endpoint to retrieve the default resource group ID. + [,bash] ---- -curl -H "Authorization: Bearer " https://api.redpanda.com/v1beta2/resource-groups +curl -H "Authorization: Bearer " https://api.redpanda.com/v1/resource-groups ---- -. Make a GET request to the `/v1beta2/serverless/regions` endpoint to see available regions. +. Make a GET request to the `/v1/serverless/regions` endpoint to see available regions. + [,bash] ---- -curl -H "Authorization: Bearer " 'https://api.redpanda.com/v1beta2/serverless/regions?cloud_provider=CLOUD_PROVIDER_AWS' +curl -H "Authorization: Bearer " 'https://api.redpanda.com/v1/serverless/regions?cloud_provider=CLOUD_PROVIDER_AWS' ---- -. Create a cluster by making a POST request to the `/v1beta2/serverless/clusters` endpoint. +. Create a cluster by making a POST request to the `/v1/serverless/clusters` endpoint. + [,bash] ---- @@ -63,8 +62,8 @@ curl -H 'Content-Type: application/json' \ -d '{ "name": , "resource_group_id": , - "serverless_region": "pro-us-east-1" -}' -X POST https://api.redpanda.com/v1beta2/serverless/clusters + "serverless_region": "us-east-1" +}' -X POST https://api.redpanda.com/v1/serverless/clusters ---- -- ====== diff --git a/modules/manage/pages/api/cloud-byoc-controlplane-api.adoc b/modules/manage/pages/api/cloud-byoc-controlplane-api.adoc index c5f1555d..abf5536b 100644 --- a/modules/manage/pages/api/cloud-byoc-controlplane-api.adoc +++ b/modules/manage/pages/api/cloud-byoc-controlplane-api.adoc @@ -2,7 +2,6 @@ :description: Use the Control Plane API to manage resources in your Redpanda Cloud BYOC environment. :page-aliases: deploy:deployment-option/cloud/api/cloud-controlplane-api.adoc :page-context-links: [{"name": "BYOC", "to": "manage:api/cloud-byoc-controlplane-api.adoc" },{"name": "Dedicated", "to": "manage:api/cloud-dedicated-controlplane-api.adoc" },{"name": "Serverless", "to": "manage:api/cloud-serverless-controlplane-api.adoc" } ] -:page-beta: true :env-byoc: true include::manage:partial$controlplane-api.adoc[] \ No newline at end of file diff --git a/modules/manage/pages/api/cloud-dataplane-api.adoc b/modules/manage/pages/api/cloud-dataplane-api.adoc index c6a775ef..1ec305da 100644 --- a/modules/manage/pages/api/cloud-dataplane-api.adoc +++ b/modules/manage/pages/api/cloud-dataplane-api.adoc @@ -1,7 +1,6 @@ = Use the Data Plane APIs :description: Use the Data Plane APIs to manage your Redpanda Cloud clusters. :page-aliases: deploy:deployment-option/cloud/api/cloud-dataplane-api.adoc -:page-beta: true The Redpanda Cloud API is a collection of REST APIs that allow you to interact with different parts of Redpanda Cloud. The Data Plane APIs enable you to programmatically manage the resources within your clusters, including topics, users, access control lists (ACLs), and connectors. You can call the API endpoints directly, or use tools like Terraform or Python scripts to automate resource management. @@ -16,13 +15,13 @@ The xref:manage:api/cloud-api-overview.adoc#cloud-api-architecture[data plane] c BYOC or Dedicated:: + -- -To retrieve the Data Plane API URL of a cluster, make a request to xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1beta2/clusters/-id-[`GET /v1beta2/clusters/\{id}`]. +To retrieve the Data Plane API URL of a cluster, make a request to xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/clusters/-id-[`GET /v1/clusters/\{id}`]. -- Serverless:: + -- -To retrieve the Data Plane API URL of a cluster, make a request to xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1beta2/serverless/clusters/-id-[`GET /v1beta2/serverless/clusters/\{id}`]. +To retrieve the Data Plane API URL of a cluster, make a request to xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/serverless/clusters/-id-[`GET /v1/serverless/clusters/\{id}`]. -- ====== @@ -43,11 +42,11 @@ The response includes a `dataplane_api.url` value: === Create a user -To create a new user in your Redpanda cluster, make a POST request to the xref:api:ROOT:cloud-dataplane-api.adoc#post-/v1alpha2/users[`/v1alpha2/users`] endpoint, including the SASL mechanism, username, and password in the request body: +To create a new user in your Redpanda cluster, make a POST request to the xref:api:ROOT:cloud-dataplane-api.adoc#post-/v1/users[`/v1/users`] endpoint, including the SASL mechanism, username, and password in the request body: [,bash] ---- -curl -X POST "https:///v1alpha2/users" \ +curl -X POST "https:///v1/users" \ -H "Authorization: Bearer " \ -H "accept: application/json" \ -H "content-type: application/json" \ @@ -70,11 +69,11 @@ The success response returns the newly-created username and SASL mechanism: === Create an ACL -To create a new ACL in your Redpanda cluster, make a xref:api:ROOT:cloud-dataplane-api.adoc#post-/v1alpha2/acls[`POST /v1alpha2/acls`] request. The following example ACL allows all operations on any Redpanda topic for a user with the name `payment-service`. +To create a new ACL in your Redpanda cluster, make a xref:api:ROOT:cloud-dataplane-api.adoc#post-/v1/acls[`POST /v1/acls`] request. The following example ACL allows all operations on any Redpanda topic for a user with the name `payment-service`. [,bash] ---- -curl -X POST "https:///v1alpha2/acls" \ +curl -X POST "https:///v1/acls" \ -H "Authorization: Bearer " \ -H "accept: application/json" \ -H "content-type: application/json" \ @@ -90,11 +89,11 @@ The success response is empty, with a 201 status code. === Create a topic -To create a new Redpanda topic without specifying any further parameters, such as the desired topic-level configuration or partition count, make a POST request to xref:api:ROOT:cloud-dataplane-api.adoc#post-/v1alpha2/topics[`/v1alpha2/topics`] endpoint: +To create a new Redpanda topic without specifying any further parameters, such as the desired topic-level configuration or partition count, make a POST request to xref:api:ROOT:cloud-dataplane-api.adoc#post-/v1/topics[`/v1/topics`] endpoint: [,bash] ---- -curl -X POST "/v1alpha2/topics" \ +curl -X POST "/v1/topics" \ -H "Authorization: Bearer " \ -H "accept: application/json" \ -H "content-type: application/json" \ @@ -109,38 +108,38 @@ NOTE: The Pipeline APIs for Redpanda Connect are supported in BYOC and Serverles ==== Get Redpanda Connect pipeline -To get details of a specific pipeline, make a xref:api:ROOT:cloud-dataplane-api.adoc#get-/v1alpha2/redpanda-connect/pipelines/-id-[`GET /v1alpha2/redpanda-connect/pipelines/\{id}]` request. +To get details of a specific pipeline, make a xref:api:ROOT:cloud-dataplane-api.adoc#get-/v1/redpanda-connect/pipelines/-id-[`GET /v1/redpanda-connect/pipelines/\{id}]` request. [,bash] ---- -curl "https:///v1alpha2/redpanda-connect/pipelines/" +curl "https:///v1/redpanda-connect/pipelines/" ---- ==== Stop a Redpanda Connect pipeline -To stop a running pipeline, make a xref:api:ROOT:cloud-dataplane-api.adoc#put-/v1alpha2/redpanda-connect/pipelines/-id-/stop[`PUT /v1alpha2/redpanda-connect/pipelines/\{id}/stop`] request. +To stop a running pipeline, make a xref:api:ROOT:cloud-dataplane-api.adoc#put-/v1/redpanda-connect/pipelines/-id-/stop[`PUT /v1/redpanda-connect/pipelines/\{id}/stop`] request. [,bash] ---- -curl -X PUT "https:///v1alpha2/redpanda-connect/pipelines//stop" +curl -X PUT "https:///v1/redpanda-connect/pipelines//stop" ---- ==== Start a Redpanda Connect pipeline -To start a previously stopped pipeline, make a xref:api:ROOT:cloud-dataplane-api.adoc#put-/v1alpha2/redpanda-connect/pipelines/-id-/start[`PUT /v1alpha2/redpanda-connect/pipelines/\{id}/start`] request. +To start a previously stopped pipeline, make a xref:api:ROOT:cloud-dataplane-api.adoc#put-/v1/redpanda-connect/pipelines/-id-/start[`PUT /v1/redpanda-connect/pipelines/\{id}/start`] request. [,bash] ---- -curl -X PUT "https:///v1alpha2/redpanda-connect/pipelines//start" +curl -X PUT "https:///v1/redpanda-connect/pipelines//start" ---- ==== Update a Redpanda Connect pipeline -To update a pipeline, make a xref:api:ROOT:cloud-dataplane-api.adoc#put-/v1alpha2/redpanda-connect/pipelines/-id-[`PUT /v1alpha2/redpanda-connect/pipelines/\{id}`] request. You update a pipeline configuration to scale resources, for example the number of CPU cores and amount of memory allocated. +To update a pipeline, make a xref:api:ROOT:cloud-dataplane-api.adoc#put-/v1/redpanda-connect/pipelines/-id-[`PUT /v1/redpanda-connect/pipelines/\{id}`] request. You update a pipeline configuration to scale resources, for example the number of CPU cores and amount of memory allocated. [,bash] ---- -curl -X PUT "https://api.redpanda.com/v1alpha2/redpanda-connect/pipelines/" \ +curl -X PUT "https://api.redpanda.com/v1/redpanda-connect/pipelines/" \ -H 'accept: application/json'\ -H 'content-type: application/json' \ -d '{"resources":{"cpu_shares":"8","memory_shares":"8G"}}' @@ -168,11 +167,11 @@ Kafka Connect cluster secret data must first be in JSON format, and then Base64- echo '{"secret.access.key": ""}' | base64 ``` -. Use the xref:api:ROOT:cloud-dataplane-api.adoc#post-/v1alpha2/kafka-connect/clusters/-cluster_name-/secrets[Secrets API] to create a secret that stores the Base64-encoded secret data: +. Use the xref:api:ROOT:cloud-dataplane-api.adoc#post-/v1/kafka-connect/clusters/-cluster_name-/secrets[Secrets API] to create a secret that stores the Base64-encoded secret data: + [,bash] ---- -curl -X POST "https:///v1alpha2/kafka-connect/clusters/redpanda/secrets" \ +curl -X POST "https:///v1/kafka-connect/clusters/redpanda/secrets" \ -H 'accept: application/json'\ -H 'content-type: application/json' \ -d '{"name":"","secret_data":""}' @@ -182,13 +181,13 @@ The response returns an `id` that you can use to </v1alpha2/kafka-connect/clusters/redpanda/connectors" \ +curl -X POST "/v1/kafka-connect/clusters/redpanda/connectors" \ -H "Authorization: Bearer " \ -H "accept: application/json" \ -H "content-type: application/json" \ @@ -225,11 +224,11 @@ Example success response: ==== Restart a Kafka Connect connector -To restart a connector, make a POST request to the xref:api:ROOT:cloud-dataplane-api.adoc#post-/v1alpha2/kafka-connect/clusters/-cluster_name-/connectors/-name-/restart[`/v1alpha2/kafka-connect/clusters/\{cluster_name}/connectors/\{name}/restart`] endpoint: +To restart a connector, make a POST request to the xref:api:ROOT:cloud-dataplane-api.adoc#post-/v1/kafka-connect/clusters/-cluster_name-/connectors/-name-/restart[`/v1/kafka-connect/clusters/\{cluster_name}/connectors/\{name}/restart`] endpoint: [,bash] ---- -curl -X POST "/v1alpha2/kafka-connect/clusters/redpanda/connectors/my-connector/restart" \ +curl -X POST "/v1/kafka-connect/clusters/redpanda/connectors/my-connector/restart" \ -H "Authorization: Bearer " \ -H "accept: application/json"\ -H "content-type: application/json" \ diff --git a/modules/manage/pages/api/cloud-dedicated-controlplane-api.adoc b/modules/manage/pages/api/cloud-dedicated-controlplane-api.adoc index be5c6fc9..3d751854 100644 --- a/modules/manage/pages/api/cloud-dedicated-controlplane-api.adoc +++ b/modules/manage/pages/api/cloud-dedicated-controlplane-api.adoc @@ -1,7 +1,6 @@ = Use the Control Plane API with Dedicated Cloud :description: Use the Control Plane API to manage resources in your Redpanda Cloud Dedicated environment. :page-context-links: [{"name": "BYOC", "to": "manage:api/cloud-byoc-controlplane-api.adoc" },{"name": "Dedicated", "to": "manage:api/cloud-dedicated-controlplane-api.adoc" },{"name": "Serverless", "to": "manage:api/cloud-serverless-controlplane-api.adoc" } ] -:page-beta: true :page-aliases: deploy:deployment-option/cloud/api/cloud-dedicated-controlplane-api.adoc :env-dedicated: true diff --git a/modules/manage/pages/api/cloud-serverless-controlplane-api.adoc b/modules/manage/pages/api/cloud-serverless-controlplane-api.adoc index 1bdfdd28..28b2af86 100644 --- a/modules/manage/pages/api/cloud-serverless-controlplane-api.adoc +++ b/modules/manage/pages/api/cloud-serverless-controlplane-api.adoc @@ -1,7 +1,6 @@ = Use the Control Plane API with Serverless :description: Use the Control Plane API to manage resources in your Redpanda Serverless environment. :page-context-links: [{"name": "BYOC", "to": "manage:api/cloud-byoc-controlplane-api.adoc" },{"name": "Dedicated", "to": "manage:api/cloud-dedicated-controlplane-api.adoc" },{"name": "Serverless", "to": "manage:api/cloud-serverless-controlplane-api.adoc" } ] -:page-beta: true :env-serverless: true :page-aliases: deploy:deployment-option/cloud/api/cloud-serverless-controlplane-api.adoc diff --git a/modules/manage/pages/api/controlplane/index.adoc b/modules/manage/pages/api/controlplane/index.adoc index affa8667..61bb68dd 100644 --- a/modules/manage/pages/api/controlplane/index.adoc +++ b/modules/manage/pages/api/controlplane/index.adoc @@ -2,4 +2,3 @@ :description: Use the Control Plane API to manage resources in your Redpanda Cloud organization. :page-layout: index :page-aliases: deploy:deployment-option/cloud/api/controlplane/index.adoc -:page-beta: true diff --git a/modules/manage/pages/api/index.adoc b/modules/manage/pages/api/index.adoc index 59d187e8..f01b72d9 100644 --- a/modules/manage/pages/api/index.adoc +++ b/modules/manage/pages/api/index.adoc @@ -1,6 +1,4 @@ = Redpanda Cloud API :description: Use REST APIs to manage Redpanda Cloud resources. :page-layout: index -:page-aliases: deploy:deployment-option/cloud/api/index.adoc -:page-beta: true -//:page-categories: \ No newline at end of file +:page-aliases: deploy:deployment-option/cloud/api/index.adoc \ No newline at end of file diff --git a/modules/manage/partials/controlplane-api.adoc b/modules/manage/partials/controlplane-api.adoc index 4b62bfa5..9b8df290 100644 --- a/modules/manage/partials/controlplane-api.adoc +++ b/modules/manage/partials/controlplane-api.adoc @@ -1,9 +1,12 @@ -:tag-clusters: api:ROOT:cloud-controlplane-api.adoc#tag--ClusterService -:tag-networks: api:ROOT:cloud-controlplane-api.adoc#tag--NetworkService -:tag-operations: api:ROOT:cloud-controlplane-api.adoc#tag--OperationService -:tag-resource-groups: api:ROOT:cloud-controlplane-api.adoc#tag--ResourceGroupService -:tag-serverless-regions: api:ROOT:cloud-controlplane-api.adoc#tag--ServerlessRegionService -:tag-serverless-clusters: api:ROOT:cloud-controlplane-api.adoc#tag--ServerlessClusterService +:tag-clusters: api:ROOT:cloud-controlplane-api.adoc#tag--Clusters +:tag-networks: api:ROOT:cloud-controlplane-api.adoc#tag--Networks +:tag-operations: api:ROOT:cloud-controlplane-api.adoc#tag--Operations +:tag-resource-groups: api:ROOT:cloud-controlplane-api.adoc#tag--Resource-Groups +:tag-serverless-regions: api:ROOT:cloud-controlplane-api.adoc#tag--Serverless-Regions +:tag-serverless-clusters: api:ROOT:cloud-controlplane-api.adoc#tag--Serverless-Clusters +:tag-role-bindings: api:ROOT:cloud-controlplane-api.adoc#tag--Control-Plane-Role-Bindings +:tag-users: api:ROOT:cloud-controlplane-api.adoc#tag--Control-Plane-Users +:tag-service-accounts: api:ROOT:cloud-controlplane-api.adoc#tag--Control-Plane-Service-Accounts The Redpanda Cloud API is a collection of REST APIs that allow you to interact with different parts of Redpanda Cloud. The Control Plane API enables you to programmatically manage your organization's Redpanda infrastructure outside of the Cloud UI. You can call the API endpoints directly, or use tools like Terraform or Python scripts to automate cluster management. @@ -13,25 +16,28 @@ See xref:api:ROOT:cloud-controlplane-api.adoc[Control Plane API] for the full AP The Control Plane API is one central API that allows you to provision clusters, networks, and resource groups. -The Control Plane API consists of the following endpoints: +The Control Plane API consists of the following endpoint groups: ifndef::env-serverless[] -* pass:a,m[xref:{tag-clusters}[ClusterService\]] -* pass:a,m[xref:{tag-networks}[NetworkService\]] +* pass:a,m[xref:{tag-clusters}[Clusters\]] +* pass:a,m[xref:{tag-networks}[Networks\]] endif::[] -* pass:a,m[xref:{tag-operations}[OperationService\]] -* pass:a,m[xref:{tag-resource-groups}[ResourceGroupService\]] +* pass:a,m[xref:{tag-operations}[Operations\]] +* pass:a,m[xref:{tag-resource-groups}[Resource Groups\]] ifdef::env-serverless[] -* pass:a,m[xref:{tag-serverless-clusters}[ServerlessClusterService\]] -* pass:a,m[xref:{tag-serverless-regions}[ServerlessRegionService\]] +* pass:a,m[xref:{tag-serverless-clusters}[Serverless Clusters\]] +* pass:a,m[xref:{tag-serverless-regions}[Serverless Regions\]] endif::[] +* pass:a,m[xref:{tag-role-bindings}[Control Plane Role Bindings\]] +* pass:a,m[xref:{tag-users}[Control Plane Users\]] +* pass:a,m[xref:{tag-service-accounts}[Control Plane Service Accounts\]] // For serverless, show this section at the end of the doc ifndef::env-serverless[] [[lro]] == Long-running operations -Some endpoints do not directly return the resource itself, but instead return an operation. The following is an example response of xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1beta2/clusters[`POST /clusters`]: +Some endpoints do not directly return the resource itself, but instead return an operation. The following is an example response of xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/clusters[`POST /clusters`]: [,bash,role=no-copy] ---- @@ -39,7 +45,7 @@ Some endpoints do not directly return the resource itself, but instead return an "operation": { "id": "cqfc6vdmvio001r4vu4", "metadata": { - "@type": "type.googleapis.com/redpanda.api.controlplane.v1beta2.CreateClusterMetadata", + "@type": "type.googleapis.com/redpanda.api.controlplane.v1.CreateClusterMetadata", "cluster_id": "cqg168balf4e4pm8ptu" }, "state": "STATE_IN_PROGRESS", @@ -54,10 +60,10 @@ The response object represents the long-running operation of creating a cluster. === Check operation state -To check the progress of an operation, make a request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1beta2/operations/-id-[`GET /operations/\{id}`] endpoint using the operation ID as a parameter: +To check the progress of an operation, make a request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/operations/-id-[`GET /operations/\{id}`] endpoint using the operation ID as a parameter: ```bash -curl -H "Authorization: Bearer " https://api.redpanda.com/v1beta2/operations/ +curl -H "Authorization: Bearer " https://api.redpanda.com/v1/operations/ ``` TIP: When using a shell substitution variable for the token, use double quotes to wrap the header value. @@ -77,7 +83,7 @@ To create a new cluster, first create a resource group and network, if you have === Create a resource group -Create a resource group by making a POST request to the xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1beta2/resource-groups[`/v1beta2/resource-groups`] endpoint. Pass a name for your resource group in the request body. +Create a resource group by making a POST request to the xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/resource-groups[`/v1/resource-groups`] endpoint. Pass a name for your resource group in the request body. [,bash] ---- @@ -85,14 +91,14 @@ curl -H 'Content-Type: application/json' \ -H "Authorization: Bearer " \ -d '{ "name": "" -}' -X POST https://api.redpanda.com/v1beta2/resource-groups +}' -X POST https://api.redpanda.com/v1/resource-groups ---- A resource group ID is returned. Pass this ID later when you call the Create Cluster endpoint. === Create a network -Create a network by making a request to xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1beta2/networks[`POST /v1beta2/networks`]. +Create a network by making a request to xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/networks[`POST /v1/networks`]. Choose a xref:networking:cidr-ranges.adoc[CIDR range] that does not overlap with your existing VPCs or your Redpanda network. @@ -106,14 +112,14 @@ curl -d \ "name": "", "resource_group_id": "", "region": "us-west1" -}' -H "Authorization: Bearer " -X POST https://api.redpanda.com/v1beta2/networks +}' -H "Authorization: Bearer " -X POST https://api.redpanda.com/v1/networks ---- This endpoint returns a <>. === Create a new cluster -After the network is created, make a request to the xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1beta2/clusters[`POST /v1beta2/clusters`] with the resource group ID and network ID in the request body. +After the network is created, make a request to the xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/clusters[`POST /v1/clusters`] with the resource group ID and network ID in the request body. [,bash] ---- @@ -132,10 +138,10 @@ curl -d \ "us-west1-b", "us-west1-c" ] - }' -H "Authorization: Bearer " -X POST https://api.redpanda.com/v1beta2/clusters + }' -H "Authorization: Bearer " -X POST https://api.redpanda.com/v1/clusters ---- -The Create Cluster endpoint returns a <>. When the operation completes, you can retrieve cluster details by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1beta2/clusters/-id-[`GET /v1beta2/clusters/\{id}`], and passing the cluster ID as a parameter. +The Create Cluster endpoint returns a <>. When the operation completes, you can retrieve cluster details by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/clusters/-id-[`GET /v1/clusters/\{id}`], and passing the cluster ID as a parameter. ifdef::env-byoc[] ==== Additional steps to create a BYOC cluster @@ -177,15 +183,15 @@ To create a new serverless cluster, you can use the default resource group, or c [NOTE] ==== -This step is optional. Serverless includes a default resource group. To retrieve the default resource group ID, make a GET request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1beta2/resource-groups[`/v1beta2/resource-groups`] endpoint: +This step is optional. Serverless includes a default resource group. To retrieve the default resource group ID, make a GET request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/resource-groups[`/v1/resource-groups`] endpoint: ```bash -curl -H "Authorization: Bearer " https://api.redpanda.com/v1beta2/resource-groups +curl -H "Authorization: Bearer " https://api.redpanda.com/v1/resource-groups ``` ==== -Create a resource group by making a POST request to the xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1beta2/resource-groups[`/v1beta2/resource-groups`] endpoint. Pass a name for your resource group in the request body. +Create a resource group by making a POST request to the xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/resource-groups[`/v1/resource-groups`] endpoint. Pass a name for your resource group in the request body. [,bash] ---- @@ -193,18 +199,18 @@ curl -H 'Content-Type: application/json' \ -H "Authorization: Bearer " \ -d '{ "name": "" -}' -X POST https://api.redpanda.com/v1beta2/resource-groups +}' -X POST https://api.redpanda.com/v1/resource-groups ---- A resource group ID is returned. Pass this ID later when you call the Create Serverless Cluster endpoint. === Choose a region -To see the available regions for Redpanda Serverless, make a GET request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1beta2/serverless/regions[`/v1beta2/serverless/regions`] endpoint. You can specify a cloud provider in your request. Serverless currently only supports AWS. +To see the available regions for Redpanda Serverless, make a GET request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/serverless/regions[`/v1/serverless/regions`] endpoint. You can specify a cloud provider in your request. Serverless currently only supports AWS. [,bash] ---- -curl -H "Authorization: Bearer " 'https://api.redpanda.com/v1beta2/serverless/regions?cloud_provider=CLOUD_PROVIDER_AWS' +curl -H "Authorization: Bearer " 'https://api.redpanda.com/v1/serverless/regions?cloud_provider=CLOUD_PROVIDER_AWS' ---- TIP: When using a shell substitution variable for the token, use double quotes to wrap the header value. @@ -241,7 +247,7 @@ TIP: When using a shell substitution variable for the token, use double quotes t === Create a new serverless cluster -Create a Serverless cluster by making a request to xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1beta2/serverless/clusters[`POST /v1beta2/serverless/clusters`] with the resource group ID and serverless region name in the request body. +Create a Serverless cluster by making a request to xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/serverless/clusters[`POST /v1/serverless/clusters`] with the resource group ID and serverless region name in the request body. [,bash] ---- @@ -251,10 +257,10 @@ curl -H 'Content-Type: application/json' \ "name": , "resource_group_id": , "serverless_region": "pro-us-east-1" -}' -X POST https://api.redpanda.com/v1beta2/serverless/clusters +}' -X POST https://api.redpanda.com/v1/serverless/clusters ---- -The Create Serverless Cluster endpoint returns a <>. When the operation completes, you can retrieve cluster details by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1beta2/serverless/clusters/-id-[`GET /v1beta2/serverless/clusters/\{id}`], and passing the cluster ID as a parameter. +The Create Serverless Cluster endpoint returns a <>. When the operation completes, you can retrieve cluster details by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/serverless/clusters/-id-[`GET /v1/serverless/clusters/\{id}`], and passing the cluster ID as a parameter. endif::[] @@ -262,16 +268,16 @@ endif::[] ifndef::env-serverless[] -To delete a cluster, make a request to the xref:api:ROOT:cloud-controlplane-api.adoc#delete-/v1beta2/clusters/-id-[`DELETE /v1beta2/clusters/\{id}`] endpoint, passing the cluster ID as a parameter. This is a <>. +To delete a cluster, make a request to the xref:api:ROOT:cloud-controlplane-api.adoc#delete-/v1/clusters/-id-[`DELETE /v1/clusters/\{id}`] endpoint, passing the cluster ID as a parameter. This is a <>. ```bash -curl -H "Authorization: Bearer " -X DELETE https://api.redpanda.com/v1beta2/clusters/ +curl -H "Authorization: Bearer " -X DELETE https://api.redpanda.com/v1/clusters/ ``` ifdef::env-byoc[] === Additional steps to delete a BYOC cluster -. Make a request to xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1beta2/clusters/-id-[`GET /v1beta2/clusters/\{id}`] to check the state of the cluster. Wait until the state is `STATE_DELETING_AGENT`. +. Make a request to xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/clusters/-id-[`GET /v1/clusters/\{id}`] to check the state of the cluster. Wait until the state is `STATE_DELETING_AGENT`. . After the state changes to `STATE_DELETING_AGENT`, run `rpk cloud byoc` to destroy the agent. + [tabs] @@ -299,26 +305,26 @@ rpk cloud byoc gcp destroy --redpanda-id= --project-id=>. +To delete a cluster, make a request to the xref:api:ROOT:cloud-controlplane-api.adoc#delete-/v1/serverless/clusters/-id-[`DELETE /v1/serverless/clusters/\{id}`] endpoint, passing the cluster ID as a parameter. This is a <>. ```bash -curl -H "Authorization: Bearer " -X DELETE https://api.redpanda.com/v1beta2/serverless/clusters/ +curl -H "Authorization: Bearer " -X DELETE https://api.redpanda.com/v1/serverless/clusters/ ``` -Optional: When the cluster is deleted, the delete operation’s state changes to `STATE_COMPLETED`. At this point, you may make a DELETE request to the xref:api:ROOT:cloud-controlplane-api.adoc#delete-/v1beta2/resource-groups/-id-[`/v1beta2/resource-groups/\{id}`] endpoint to delete the resource group. +Optional: When the cluster is deleted, the delete operation’s state changes to `STATE_COMPLETED`. At this point, you may make a DELETE request to the xref:api:ROOT:cloud-controlplane-api.adoc#delete-/v1/resource-groups/-id-[`/v1/resource-groups/\{id}`] endpoint to delete the resource group. [[lro-serverless]] == Long-running operations -Some endpoints do not directly return the resource itself, but instead return an operation. The following is an example response of xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1beta2/serverless/clusters[`POST /serverless/clusters`]: +Some endpoints do not directly return the resource itself, but instead return an operation. The following is an example response of xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/serverless/clusters[`POST /serverless/clusters`]: [,bash,role=no-copy] ---- @@ -341,16 +347,94 @@ The response object represents the long-running operation of creating a cluster. === Check operation state -To check the progress of an operation, make a request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1beta2/operations/-id-[`GET /operations/\{id}`] endpoint using the operation ID as a parameter: +To check the progress of an operation, make a request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/operations/-id-[`GET /operations/\{id}`] endpoint using the operation ID as a parameter: ```bash -curl -H "Authorization: Bearer " https://api.redpanda.com/v1beta2/operations/ +curl -H "Authorization: Bearer " https://api.redpanda.com/v1/operations/ ``` The response contains the current state of the operation: `IN_PROGRESS`, `COMPLETED`, or `FAILED`. endif::[] +== Manage RBAC + +You can also use the Control Plane API to manage xref:security:authorization/rbac/rbac.adoc[RBAC configurations]. + +=== List role bindings + +To see role assignments for IAM user and service accounts, make a GET request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/role-bindings[`/v1/role-bindings`] endpoint. + +[,bash] +---- +curl https://api.redpanda.com/v1/role-bindings?filter.role_name=&filter.scope.resource_type=SCOPE_RESOURCE_TYPE_CLUSTER \ + -H "Authorization: Bearer " \ + -H "Content-Type: application/json" +---- + +=== Get role binding + +To see roles assignments for a specific IAM account, make a GET request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/role-bindings/-id-[`/v1/role-bindings/\{id}`] endpoint, passing the role binding ID as a parameter. + +[,bash] +---- +curl "https://api.redpanda.com/v1/role-bindings/ \ + -H "Authorization: Bearer " \ + -H "Content-Type: application/json" +---- + +=== Get user + +To see details of an IAM user account, make a GET request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/users/-id-[`/v1/users/\{id}`] endpoint, passing the user account ID as a parameter. + +[,bash] +---- +curl "https://api.redpanda.com/v1/users/ \ + -H "Authorization: Bearer " \ + -H "Content-Type: application/json" +---- + +=== Create role binding + +To assign a role to an IAM user or service account, make a POST request to the xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/role-bindings[`/v1/role-bindings`] endpoint. Specify the role and scope, which includes the specific resource ID and an optional resource type, in the request body. + +[,bash] +---- +curl -X POST "https://api.redpanda.com/v1/role-bindings" \ + -H "Authorization: Bearer " \ + -H "Content-Type: application/json" \ + -d '{ + "role_name": "", + "account_id": "", + "scope": { + "resource_type": "SCOPE_RESOURCE_TYPE_CLUSTER", + "resource_id": "" + } + }' +---- + +For ``, use one of roles listed in xref:security:authorization/rbac/rbac.adoc#predefined-roles[Predefined roles] (`Reader`, `Writer`, `Admin`). + +=== Create service account + +NOTE: Service accounts are assigned the Admin role for all resources in the organization. + +To create a new service account, make a POST request to the xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/service-accounts[`/v1/service-accounts`] endpoint, with a service account name and optional description in the request body. + +[,bash] +---- +curl -X POST "https://api.redpanda.com/v1/service-accounts" \ + -H "Authorization: Bearer " \ + -H "Content-Type: application/json" \ + -d '{ + "service_account": { + "name": "", + "description": "" + } + }' +---- + + == Next steps - xref:./cloud-dataplane-api.adoc[] diff --git a/modules/networking/pages/aws-privatelink.adoc b/modules/networking/pages/aws-privatelink.adoc index 89fb268b..64104f49 100644 --- a/modules/networking/pages/aws-privatelink.adoc +++ b/modules/networking/pages/aws-privatelink.adoc @@ -39,7 +39,7 @@ Copy and store the resource group ID (UUID) from the URL in the browser. export RESOURCE_GROUP_ID= ---- -. Call xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1beta2/networks[`POST /v1beta2/networks`] to create a network. +. Call xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/networks[`POST /v1/networks`] to create a network. + Make sure to supply your own values in the following example request. Store the network ID (`network_id`) after the network is created to check whether you can proceed to cluster creation. + @@ -67,14 +67,14 @@ EOF` NETWORK_ID=`curl -vv -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AUTH_TOKEN" \ - -d "$NETWORK_POST_BODY" $PUBLIC_API_ENDPOINT/v1beta2/networks | jq .metadata.network_id` + -d "$NETWORK_POST_BODY" $PUBLIC_API_ENDPOINT/v1/networks | jq .metadata.network_id` echo $NETWORK_ID ---- + -Wait for the network to be ready before creating the cluster in the next step. You can check the state of the network creation by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1beta2/networks/-id-[`GET /v1beta2/networks/\{id}`]. You can create the cluster when the state is `STATE_READY`. +Wait for the network to be ready before creating the cluster in the next step. You can check the state of the network creation by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/networks/-id-[`GET /v1/networks/\{id}`]. You can create the cluster when the state is `STATE_READY`. -. Create a new cluster with the endpoint service enabled by calling xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1beta2/clusters[`POST /v1beta2/clusters`]. +. Create a new cluster with the endpoint service enabled by calling xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/clusters[`POST /v1/clusters`]. + In the example below, make sure to set your own values for the following fields: + @@ -111,12 +111,12 @@ EOF` CLUSTER_ID=`curl -vv -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AUTH_TOKEN" \ - -d "$CLUSTER_POST_BODY" $PUBLIC_API_ENDPOINT/v1beta2/clusters | jq -r .operation.metadata.cluster_id` + -d "$CLUSTER_POST_BODY" $PUBLIC_API_ENDPOINT/v1/clusters | jq -r .operation.metadata.cluster_id` echo $CLUSTER_ID ---- + -**BYOC clusters:** Check that the cluster operation is completed by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1beta2/operations/-id-[`GET /v1beta2/operations/\{id}`], and passing the operation ID returned from the Create Cluster call. +**BYOC clusters:** Check that the cluster operation is completed by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/operations/-id-[`GET /v1/operations/\{id}`], and passing the operation ID returned from the Create Cluster call. + When the Create Cluster operation is completed (`STATE_COMPLETED`), run the following `rpk cloud` command to finish setting up your BYOC cluster: + @@ -136,7 +136,7 @@ CAUTION: As soon as PrivateLink is available on your VPC, all communication on e CLUSTER_ID= ---- -. Make a xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1beta2/clusters/-cluster.id-[`PATCH /v1beta2/clusters/{cluster.id}`] request to update the cluster with the Redpanda Private Link Endpoint Service enabled. +. Make a xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-[`PATCH /v1/clusters/{cluster.id}`] request to update the cluster with the Redpanda Private Link Endpoint Service enabled. + In the example below, make sure to set your own value for the following field: + @@ -160,19 +160,19 @@ EOF` curl -vv -X PATCH \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AUTH_TOKEN" \ - -d "$CLUSTER_PATCH_BODY" $PUBLIC_API_ENDPOINT/v1beta2/clusters/$CLUSTER_ID + -d "$CLUSTER_PATCH_BODY" $PUBLIC_API_ENDPOINT/v1/clusters/$CLUSTER_ID ---- -. Before proceeding, check the state of the Update Cluster operation by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1beta2/operations/-id-[`GET /v1beta2/operations/\{id}`], and passing the operation ID returned from Update Cluster call. When the state is `STATE_READY`, proceed to the next step. +. Before proceeding, check the state of the Update Cluster operation by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/operations/-id-[`GET /v1/operations/\{id}`], and passing the operation ID returned from Update Cluster call. When the state is `STATE_READY`, proceed to the next step. -. Check the service state by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1beta2/clusters/-id-[`GET /v1beta2/clusters/\{id}`]. The `service_state` in the `aws_private_link.status` response object must be `Available` for you to <>. +. Check the service state by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/clusters/-id-[`GET /v1/clusters/\{id}`]. The `service_state` in the `aws_private_link.status` response object must be `Available` for you to <>. + [,bash] ---- curl -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AUTH_TOKEN" \ - $PUBLIC_API_ENDPOINT/v1beta2/clusters/$CLUSTER_ID | jq '.cluster.aws_private_link.status | {service_name, service_state}' + $PUBLIC_API_ENDPOINT/v1/clusters/$CLUSTER_ID | jq '.cluster.aws_private_link.status | {service_name, service_state}' ---- == Configure PrivateLink connection to Redpanda Cloud @@ -199,7 +199,7 @@ The service name is required to < ---- -. Call xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1beta2/networks[`POST /v1beta2/networks`] to create a Redpanda Cloud network for the cluster. +. Call xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/networks[`POST /v1/networks`] to create a Redpanda Cloud network for the cluster. + Make sure to supply your own values in the following example request. Store the network ID (`network_id`) after the network is created to check whether you can proceed to cluster creation. + @@ -91,14 +91,14 @@ EOF` NETWORK_ID=`curl -vv -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AUTH_TOKEN" \ - -d "$NETWORK_POST_BODY" $PUBLIC_API_ENDPOINT/v1beta2/networks | jq .metadata.network_id` + -d "$NETWORK_POST_BODY" $PUBLIC_API_ENDPOINT/v1/networks | jq .metadata.network_id` echo $NETWORK_ID ---- + -Wait for the network to be ready before creating the cluster in the next step. Check the state of the network creation by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1beta2/networks/-id-[`GET /v1beta2/networks/\{id}`]. You can create the cluster when the state is `STATE_READY`. +Wait for the network to be ready before creating the cluster in the next step. Check the state of the network creation by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/networks/-id-[`GET /v1/networks/\{id}`]. You can create the cluster when the state is `STATE_READY`. -. Create a new cluster with the Private Link service enabled by calling xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1beta2/clusters[`POST /v1beta2/clusters`]. +. Create a new cluster with the Private Link service enabled by calling xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/clusters[`POST /v1/clusters`]. + In the following example, make sure to set your own values for the following fields: + @@ -133,12 +133,12 @@ EOF` CLUSTER_ID=`curl -vv -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AUTH_TOKEN" \ - -d "$CLUSTER_POST_BODY" $PUBLIC_API_ENDPOINT/v1beta2/clusters | jq -r .operation.metadata.cluster_id` + -d "$CLUSTER_POST_BODY" $PUBLIC_API_ENDPOINT/v1/clusters | jq -r .operation.metadata.cluster_id` echo $CLUSTER_ID ---- -. **BYOC clusters:** Check that the cluster operation is completed by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1beta2/operations/-id-[`GET /v1beta2/operations/\{id}`], and passing the operation ID returned from the Create Cluster call. +. **BYOC clusters:** Check that the cluster operation is completed by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/operations/-id-[`GET /v1/operations/\{id}`], and passing the operation ID returned from the Create Cluster call. + When the Create Cluster operation is completed (`STATE_COMPLETED`), run the following `rpk cloud` command to finish setting up your BYOC cluster with Private Link enabled: + @@ -160,7 +160,7 @@ CAUTION: As soon as Private Link is available on your virtual network, all commu CLUSTER_ID= ---- -. Make a xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1beta2/clusters/-cluster.id-[`PATCH /v1beta2/clusters/{cluster.id}`] request to update the cluster with the service enabled. +. Make a xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-[`PATCH /v1/clusters/{cluster.id}`] request to update the cluster with the service enabled. + [,bash] ---- @@ -177,33 +177,33 @@ EOF` curl -vv -X PATCH \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AUTH_TOKEN" \ - -d "$CLUSTER_PATCH_BODY" $PUBLIC_API_ENDPOINT/v1beta2/clusters/$CLUSTER_ID + -d "$CLUSTER_PATCH_BODY" $PUBLIC_API_ENDPOINT/v1/clusters/$CLUSTER_ID ---- -. Before proceeding, check the state of the Update Cluster operation by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1beta2/operations/-id-[`GET /v1beta2/operations/\{id}`], and passing the operation ID returned from the Update Cluster call. When the state is `STATE_READY`, continue to <>. +. Before proceeding, check the state of the Update Cluster operation by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/operations/-id-[`GET /v1/operations/\{id}`], and passing the operation ID returned from the Update Cluster call. When the state is `STATE_READY`, continue to <>. == Configure Azure Private Link connection to Redpanda Cloud . In the Redpanda Cloud UI, go to https://cloud.redpanda.com/users?tab=users[**Users**^] and create a new user to authenticate the Private Link endpoint connections with the service. You will need the username and password to <> or <> using `rpk` or cURL. -. Call the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1beta2/clusters/-id-[`GET /v1beta2/clusters/\{id}`] endpoint to check the service status and retrieve the service ID, DNS name, and Redpanda Console URL to use. +. Call the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/clusters/-id-[`GET /v1/clusters/\{id}`] endpoint to check the service status and retrieve the service ID, DNS name, and Redpanda Console URL to use. + [,bash] ---- DNS_RECORD=`curl -s -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AUTH_TOKEN" \ - $PUBLIC_API_ENDPOINT/v1beta2/clusters/$CLUSTER_ID | jq -r ".cluster.azure_private_link.status.dns_a_record"` + $PUBLIC_API_ENDPOINT/v1/clusters/$CLUSTER_ID | jq -r ".cluster.azure_private_link.status.dns_a_record"` PRIVATE_SERVICE_ID=`curl -s -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AUTH_TOKEN" \ - $PUBLIC_API_ENDPOINT/v1beta2/clusters/$CLUSTER_ID | jq -r ".cluster.azure_private_link.status.service_id"` + $PUBLIC_API_ENDPOINT/v1/clusters/$CLUSTER_ID | jq -r ".cluster.azure_private_link.status.service_id"` CONSOLE_URL=`curl -s -X GET \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AUTH_TOKEN" \ - $PUBLIC_API_ENDPOINT/v1beta2/clusters/$CLUSTER_ID | jq -r ".cluster.redpanda_console.url"` + $PUBLIC_API_ENDPOINT/v1/clusters/$CLUSTER_ID | jq -r ".cluster.redpanda_console.url"` echo $DNS_RECORD echo $PRIVATE_SERVICE_ID diff --git a/modules/networking/pages/gcp-private-service-connect.adoc b/modules/networking/pages/gcp-private-service-connect.adoc index 3e5390a4..3e8d8553 100644 --- a/modules/networking/pages/gcp-private-service-connect.adoc +++ b/modules/networking/pages/gcp-private-service-connect.adoc @@ -84,7 +84,7 @@ gcloud compute firewall-rules create redpanda-psc \ --allow="tcp:30181,tcp:30282,tcp:30292,tcp:31004,tcp:31082-31101,tcp:31182-31201,tcp:31282-31301,tcp:32092-32111,tcp:32192-32211,tcp:32292-32311" ``` -. Make a request to the xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1beta2/networks[`POST /v1beta2/networks`] endpoint to create a network. +. Make a request to the xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/networks[`POST /v1/networks`] endpoint to create a network. + [,bash] ---- @@ -108,7 +108,7 @@ EOF` curl -vv -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AUTH_TOKEN" \ --d "$network_post_body" $PUBLIC_API_ENDPOINT/v1beta2/networks +-d "$network_post_body" $PUBLIC_API_ENDPOINT/v1/networks ---- + Replace the following placeholder variables for the request body: @@ -129,7 +129,7 @@ Replace the following placeholder variables for the request body: export NETWORK_ID= ---- -. Make a request to the xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1beta2/clusters[`POST /v1beta2/clusters`] endpoint to create a Redpanda Cloud cluster with Private Service Connect enabled. +. Make a request to the xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/clusters[`POST /v1/clusters`] endpoint to create a Redpanda Cloud cluster with Private Service Connect enabled. + [,bash] ---- @@ -172,7 +172,7 @@ EOF` curl -vv -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AUTH_TOKEN" \ --d "$CLUSTER_POST_BODY" $PUBLIC_API_ENDPOINT/v1beta2/clusters +-d "$CLUSTER_POST_BODY" $PUBLIC_API_ENDPOINT/v1/clusters ---- + Replace the following placeholders for the request body. Variables with a `byovpc_` prefix represent xref:get-started:cluster-types/byoc/gcp/vpc-byo-gcp.adoc[customer-managed resources] that should have been created previously: @@ -226,7 +226,7 @@ rpk cloud byoc gcp apply --redpanda-id='$CLUSTER_ID' --project-id='`: The name of the Private Service Connect NAT subnet. Use the fully-qualified name, for example `"projects//regions//subnetworks/"`. -. Make a xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1beta2/clusters/-cluster.id-[`PATCH /v1beta2/clusters/{cluster.id}`] request to update the cluster to enable Private Service Connect. +. Make a xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-[`PATCH /v1/clusters/{cluster.id}`] request to update the cluster to enable Private Service Connect. + [,bash] ---- @@ -266,7 +266,7 @@ EOF` curl -v -X PATCH \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AUTH_TOKEN" \ --d "$CLUSTER_PATCH_BODY" $PUBLIC_API_ENDPOINT/v1beta2/clusters/$CLUSTER_ID +-d "$CLUSTER_PATCH_BODY" $PUBLIC_API_ENDPOINT/v1/clusters/$CLUSTER_ID ---- + Replace the following placeholder: @@ -294,7 +294,7 @@ include::networking:partial$private-links-test-connection.adoc[] == Disable Private Service Connect -Make a xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1beta2/clusters/-cluster.id-[`PATCH /v1beta2/clusters/{cluster.id}`] request to update the cluster to disable Private Service Connect. +Make a xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-[`PATCH /v1/clusters/{cluster.id}`] request to update the cluster to disable Private Service Connect. [,bash] ---- @@ -308,5 +308,5 @@ EOF` curl -v -X PATCH \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AUTH_TOKEN" \ --d "$CLUSTER_PATCH_BODY" $PUBLIC_API_ENDPOINT/v1beta2/clusters/$CLUSTER_ID +-d "$CLUSTER_PATCH_BODY" $PUBLIC_API_ENDPOINT/v1/clusters/$CLUSTER_ID ---- diff --git a/modules/security/pages/cloud-authentication.adoc b/modules/security/pages/cloud-authentication.adoc index 7650db4a..8bcf0560 100644 --- a/modules/security/pages/cloud-authentication.adoc +++ b/modules/security/pages/cloud-authentication.adoc @@ -104,7 +104,7 @@ Redpanda Cloud supports mTLS authentication for the Kafka API. . Create a service account in your organization, if you have not already done so. Go to the https://cloud.redpanda.com/clients[Clients^] page in the Redpanda Cloud UI and click *Add client* to create a service account. Enter a name and description. . Retrieve the client ID and secret by clicking *Copy ID* and *Copy Secret*. . Obtain an access token by making a `POST` request to `\https://auth.prd.cloud.redpanda.com/oauth/token` with the ID and secret in the request body. -. Make a xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1beta2/clusters/-cluster.id-[`PATCH /v1beta2/clusters/{cluster.id}`] request to enable mTLS for the Kafka API on a cluster. +. Make a xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-[`PATCH /v1/clusters/{cluster.id}`] request to enable mTLS for the Kafka API on a cluster. The following code block shows a request for an access token, followed by a request to enable mTLS: @@ -132,7 +132,7 @@ EOF` curl -v -X PATCH \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $AUTH_TOKEN" \ --d "$CLUSTER_PATCH_BODY" https://api.redpanda.com/v1beta2/clusters/` +-d "$CLUSTER_PATCH_BODY" https://api.redpanda.com/v1/clusters/` ---- Make sure to replace the following variables: