v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB

Clusters

Update Cluster

Updates an existing cluster.

In order to access this endpoint, the provided API key must have at least one of the following roles:

Organization Owner
Project Owner
Project Manager

To learn more, see Organization, Project, and Database Access Overview.

put/v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}

Headers

If-Matchstring

Example:12

A precondition header that specifies the entity tag of a resource.

Request body

namestring required

The new name of the cluster (up to 256 characters).

descriptionstring required

The new cluster description (up to 1024 characters).

Example request

{
  "name": "My-New-Cluster",
  "description": "The extended description of my new cluster.",
  "support": {
    "plan": "basic",
    "timezone": "ET"
  },
  "serviceGroups": [
    {
      "node": {
        "compute": {
          "cpu": 4,
          "ram": 16
        },
        "disk": {
          "type": "gp3",
          "storage": 50,
          "iops": 3000
        }
      },
      "numOfNodes": 3,
      "services": [
        "data"
      ]
    }
  ]
}

Response

Successfully submitted request to update cluster.