QOqovery
Clusters

Edit a cluster

put/organization/{organizationId}/cluster/{clusterId}

Request

Path parameters

organizationIdstring uuid required

Organization ID

clusterIdstring uuid required

Cluster ID

Request body

namestring required

name is case-insensitive

descriptionstring
regionstring required
cloud_provider'AWS' | 'SCW' | 'GCP' | 'DO' | 'AZURE' | 'OVH' | 'CIVO' | 'HETZNER' | 'ORACLE' | 'IBM' | 'ON_PREMISE' required
min_running_nodesinteger
max_running_nodesinteger
disk_sizeinteger

Unit is in GB. The disk size to be used for the node configuration

instance_typestring

the instance type to be used for this cluster. The list of values can be retrieved via the endpoint /{CloudProvider}/instanceType

kubernetes'MANAGED' | 'SELF_MANAGED' | 'PARTIALLY_MANAGED'
productionboolean

specific flag to indicate that this cluster is a production one

ssh_keysstring[]

Indicate your public ssh_key to remotely connect to your EC2 instance.

Example request

{
  "disk_size": 50,
  "instance_type": "T3A_LARGE",
  "features": [
    {
      "value": {
        "qovery_node_pools": {
          "stable_override": {
            "consolidation": {
              "days": [
                "MONDAY"
              ],
              "start_time": "PT22:30",
              "duration": "PT2H45M"
            }
          },
          "gpu_override": {
            "consolidation": {
              "days": [
                "MONDAY"
              ],
              "start_time": "PT22:30",
              "duration": "PT2H45M"
            }
          }
        }
      }
    }
  ]
}

Response

Edited the cluster

idstring uuid required
created_atstring date-time required
updated_atstring date-time
namestring required

name is case-insensitive

descriptionstring
regionstring required
cloud_provider'AWS' | 'SCW' | 'GCP' | 'DO' | 'AZURE' | 'OVH' | 'CIVO' | 'HETZNER' | 'ORACLE' | 'IBM' | 'ON_PREMISE' required
min_running_nodesinteger
max_running_nodesinteger
disk_sizeinteger

Unit is in GB. The disk size to be used for the node configuration

instance_typestring

the instance type to be used for this cluster. The list of values can be retrieved via the endpoint /{CloudProvider}/instanceType

kubernetes'MANAGED' | 'SELF_MANAGED' | 'PARTIALLY_MANAGED'
cpuinteger

unit is millicores (m). 1000m = 1 cpu

memoryinteger

unit is MB. 1024 MB = 1GB

estimated_cloud_provider_costinteger

This is an estimation of the cost this cluster will represent on your cloud proider bill, based on your current configuration

status'BUILDING' | 'BUILD_ERROR' | 'CANCELED' | 'CANCELING' | 'DELETED' | 'DELETE_ERROR' | 'DELETE_QUEUED' | 'DELETING' | 'DEPLOYED' | 'DEPLOYING' | 'DEPLOYMENT_ERROR' | 'DEPLOYMENT_QUEUED' | 'DRY_RUN' | 'QUEUED' | 'READY' | 'STOPPED' | 'STOPPING' | 'STOP_ERROR' | 'STOP_QUEUED' | 'RESTART_QUEUED' | 'RESTARTING' | 'RESTARTED' | 'RESTART_ERROR' | 'INVALID_CREDENTIALS'
has_accessboolean
versionstring
is_defaultboolean
is_demoboolean

specific flag to indicate that this cluster is a demo one

productionboolean

specific flag to indicate that this cluster is a production one

ssh_keysstring[]

Indicate your public ssh_key to remotely connect to your EC2 instance.

deployment_status'NEVER_DEPLOYED' | 'OUT_OF_DATE' | 'UP_TO_DATE'

Changes

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