Skip to main content
GET
/
organization
/
{organizationId}
/
cluster
List organization clusters
curl --request GET \
  --url https://api.qovery.com/organization/{organizationId}/cluster \
  --header 'Authorization: <api-key>'
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "organization": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "name": "<string>",
      "description": "<string>",
      "region": "<string>",
      "cloud_provider": "AWS",
      "min_running_nodes": 1,
      "max_running_nodes": 1,
      "disk_size": 50,
      "instance_type": "T3A_LARGE",
      "kubernetes": "MANAGED",
      "cpu": 10000,
      "memory": 4096,
      "estimated_cloud_provider_cost": 123,
      "status": "BUILDING",
      "has_access": true,
      "version": "<string>",
      "is_default": true,
      "is_demo": true,
      "production": true,
      "ssh_keys": [
        "<string>"
      ],
      "features": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "title": "<string>",
          "description": "<string>",
          "cost_per_month_in_cents": 9900,
          "cost_per_month": 99,
          "currency_code": "USD",
          "is_cloud_provider_paying_feature": true,
          "cloud_provider_feature_documentation": "https://cloud.provider.doc/feature",
          "is_qovery_paying_feature": true,
          "qovery_feature_documentation": "https://qovery.doc/feature",
          "value_type": "BOOLEAN",
          "value_object": {
            "type": "STRING",
            "value": "<string>"
          },
          "is_value_updatable": false,
          "accepted_values": [
            "<string>"
          ]
        }
      ],
      "deployment_status": "NEVER_DEPLOYED",
      "metrics_parameters": {
        "enabled": true,
        "configuration": {
          "kind": "MANAGED_BY_QOVERY"
        }
      },
      "infrastructure_outputs": {
        "kind": "AKS",
        "cluster_name": "<string>",
        "cluster_oidc_issuer": "<string>"
      },
      "infrastructure_charts_parameters": {
        "nginx_parameters": {
          "replica_count": 1,
          "default_ssl_certificate": "<string>",
          "publish_status_address": "<string>",
          "annotation_metal_lb_load_balancer_ips": "<string>",
          "annotation_external_dns_kubernetes_target": "<string>"
        },
        "cert_manager_parameters": {
          "kubernetes_namespace": "<string>"
        },
        "metal_lb_parameters": {
          "ip_address_pools": [
            "<string>"
          ]
        }
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Prefix your token with "Token ". Curl Example: curl https://console.qovery.com/organization -H "Authorization: Token $qovery_token"

Path Parameters

organizationId
string<uuid>
required

Organization ID

Response

List clusters

results
object[]