Sign in
Clusters (cmk/v2)

Update a Cluster

General Availability

Make a request to update a cluster.

patch/cmk/v2/clusters/{id}

Path parameters

idstring required

The unique identifier for the cluster.

Request body

api_version'cmk/v2'

APIVersion defines the schema version of this representation of a resource.

kind'Cluster'

Kind defines the object this REST resource represents.

idstring

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

Example request

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/cmk/v2/clusters/lkc-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "spec": {
    "display_name": "ProdKafkaCluster",
    "availability": "SINGLE_ZONE",
    "cloud": "GCP",
    "region": "us-east4",
    "config": {
      "max_ecku": 2
    },
    "kafka_bootstrap_endpoint": "lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092",
    "http_endpoint": "https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud",
    "api_endpoint": "https://pkac-00000.us-west-2.aws.confluent.cloud",
    "endpoints": {
      "ap1pni123": {
        "kafka_bootstrap_endpoint": "lkc-s1232-00000.us-central1.gcp.private.confluent.cloud:9092",
        "http_endpoint": "https://lkc-s1232.us-central1.gcp.private.confluent.cloud:443",
        "connection_type": "PRIVATE_NETWORK_INTERFACE"
      },
      "ap2platt67890": {
        "kafka_bootstrap_endpoint": "lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092",
        "http_endpoint": "https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud",
        "connection_type": "PRIVATE_LINK"
      }
    },
    "environment": {
      "id": "env-00000"
    }
  },
  "status": {
    "phase": "PROVISIONED",
    "cku": 2
  }
}

Response

Cluster.

api_version'cmk/v2' required

APIVersion defines the schema version of this representation of a resource.

kind'Cluster' required

Kind defines the object this REST resource represents.

idstring required

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/cmk/v2/clusters/lkc-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "spec": {
    "display_name": "ProdKafkaCluster",
    "availability": "SINGLE_ZONE",
    "cloud": "GCP",
    "region": "us-east4",
    "config": {
      "max_ecku": 2
    },
    "kafka_bootstrap_endpoint": "lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092",
    "http_endpoint": "https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud",
    "api_endpoint": "https://pkac-00000.us-west-2.aws.confluent.cloud",
    "endpoints": {
      "ap1pni123": {
        "kafka_bootstrap_endpoint": "lkc-s1232-00000.us-central1.gcp.private.confluent.cloud:9092",
        "http_endpoint": "https://lkc-s1232.us-central1.gcp.private.confluent.cloud:443",
        "connection_type": "PRIVATE_NETWORK_INTERFACE"
      },
      "ap2platt67890": {
        "kafka_bootstrap_endpoint": "lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092",
        "http_endpoint": "https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud",
        "connection_type": "PRIVATE_LINK"
      }
    },
    "environment": {
      "id": "env-00000",
      "related": "https://api.confluent.cloud/v2/environments/env-00000",
      "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
    },
    "network": {
      "id": "n-00000",
      "related": "https://api.confluent.cloud/networking/v1/networks/n-00000",
      "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000"
    },
    "byok": {
      "id": "cck-00000",
      "related": "https://api.confluent.cloud/byok/v1/keys/cck-00000",
      "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/key=cck-00000"
    }
  },
  "status": {
    "phase": "PROVISIONED",
    "cku": 2
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.