Cluster Response List

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/outscale/json-schema/outscale-cluster-response-list-schema.json",
  "title": "Cluster Response List",
  "x-generated": "2026-10-28",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/outscale-oks-openapi.yml#/components/schemas/ClusterResponseList",
  "properties": {
    "ResponseContext": {
      "$ref": "#/$defs/clusters__cluster_schema__ResponseContext"
    },
    "Pagination": {
      "$ref": "#/$defs/Pagination"
    },
    "Clusters": {
      "items": {
        "$ref": "#/$defs/Cluster"
      },
      "type": "array",
      "title": "Clusters",
      "description": "List of clusters retrieved from the API"
    }
  },
  "type": "object",
  "required": [
    "ResponseContext",
    "Pagination",
    "Clusters"
  ],
  "$defs": {
    "AdmissionFlags": {
      "properties": {
        "disable_admission_plugins": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Disable Admission Plugins",
          "description": "List of Kubernetes admission plugins that are disabled",
          "default": []
        },
        "enable_admission_plugins": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Enable Admission Plugins",
          "description": "List of Kubernetes admission plugins that are enabled",
          "default": []
        },
        "applied_admission_plugins": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Applied Admission Plugins",
          "description": "List of admission plugins currently applied to the cluster",
          "default": [
            "CertificateApproval",
            "CertificateSigning",
            "CertificateSubjectRestriction",
            "ClusterTrustBundleAttest",
            "DefaultIngressClass",
            "DefaultStorageClass",
            "DefaultTolerationSeconds",
            "LimitRanger",
            "MutatingAdmissionWebhook",
            "NamespaceLifecycle",
            "PersistentVolumeClaimResize",
            "PodSecurity",
            "Priority",
            "ResourceQuota",
            "RuntimeClass",
            "ServiceAccount",
            "StorageObjectInUseProtection",
            "TaintNodesByCondition",
            "ValidatingAdmissionPolicy",
            "ValidatingAdmissionWebhook"
          ]
        }
      },
      "type": "object",
      "title": "AdmissionFlags"
    },
    "AuthStrategy": {
      "properties": {
        "oidc": {
          "allOf": [
            {
              "$ref": "#/$defs/OpenIdConnectConfig"
            }
          ],
          "title": "OpenID Connect Authentication",
          "description": "Configuration for authenticating to the cluster using OpenID Connect (OIDC)."
        }
      },
      "type": "object",
      "required": [
        "oidc"
      ],
      "title": "AuthStrategy"
    },
    "AutoMaintenances": {
      "properties": {
        "minor_upgrade_maintenance": {
          "allOf": [
            {
              "$ref": "#/$defs/MaintenanceWindow"
            }
          ],
          "title": "Minor Upgrade Maintenance",
          "description": "Maintenance window configuration for minor Kubernetes upgrades"
        },
        "patch_upgrade_maintenance": {
          "allOf": [
            {
              "$ref": "#/$defs/MaintenanceWindow"
            }
          ],
          "title": "Patch Upgrade Maintenance",
          "description": "Maintenance window configuration for patch Kubernetes upgrades"
        }
      },
      "type": "object",
      "required": [
        "minor_upgrade_maintenance",
        "patch_upgrade_maintenance"
      ],
      "title": "AutoMaintenances"
    },
    "Cluster": {
      "properties": {
        "project_id": {
          "type": "string",
          "title": "Project ID",
          "description": "Unique identifier of the project this cluster belongs to"
        },
        "id": {
          "type": "string",
          "title": "Cluster ID",
          "description": "Unique UUID of the cluster"
        },
        "name": {
          "type": "string",
          "title": "Cluster Name",
          "description": "Unique cluster name per project"
        },
        "description": {
          "type": "string",
          "title": "Description",
          "description": "Optional description of the cluster",
          "default": ""
        },
        "cp_multi_az": {
          "type": "boolean",
          "title": "Control Plane Multi-AZ",
          "description": "Flag indicating if multi-availability zone is enabled for the control plane"
        },
        "cp_subregions": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Control Plane Subregions",
          "description": "Subregions where control plane components are deployed"
        },
        "version": {
          "type": "string",
          "title": "Kubernetes Version",
          "description": "Version of Kubernetes deployed in the cluster"
        },
        "expected_version": {
          "type": [
            "string",
            "null"
          ]
        },
        "cni": {
          "type": "string",
          "title": "CNI",
          "description": "Container Network Interface used in the cluster"
        },
        "admin_lbu": {
          "type": "boolean",
          "title": "Admin LBU",
          "description": "Flag indicating if admin load balancer is enabled for cluster management"
        },
        "admission_flags": {
          "allOf": [
            {
              "$ref": "#/$defs/AdmissionFlags"
            }
          ],
          "title": "Admission Flags",
          "description": "Configuration for Kubernetes admission controllers"
        },
        "cidr_pods": {
          "type": "string",
          "title": "Pods CIDR",
          "description": "CIDR block for Kubernetes pods network"
        },
        "cidr_service": {
          "type": "string",
          "title": "Service CIDR",
          "description": "CIDR block for Kubernetes services network"
        },
        "cluster_dns": {
          "type": "string",
          "title": "Cluster DNS",
          "description": "IP address for cluster DNS service"
        },
        "tags": {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object",
          "title": "Tags",
          "description": "Key-value pairs for cluster metadata"
        },
        "auto_maintenances": {
          "allOf": [
            {
              "$ref": "#/$defs/AutoMaintenances"
            }
          ],
          "nullable": true
        },
        "maintenance_window": {
          "allOf": [
            {
              "$ref": "#/$defs/Maintenance"
            }
          ],
          "nullable": true
        },
        "control_planes": {
          "type": "string",
          "title": "Control Planes",
          "description": "Type of control plane deployment for the cluster"
        },
        "expected_control_planes": {
          "type": [
            "string",
            "null"
          ]
        },
        "admin_whitelist": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Admin Whitelist",
          "description": "List of CIDR blocks or IP addresses allowed to access the Kubernetes API"
        },
        "statuses": {
          "allOf": [
            {
              "$ref": "#/$defs/Statuses"
            }
          ],
          "description": "Current status information about the cluster"
        },
        "disable_api_termination": {
          "type": "boolean",
          "title": "Disable API Termination",
          "description": "Flag to prevent accidental cluster deletion",
          "default": false
        },
        "auth": {
          "allOf": [
            {
              "$ref": "#/$defs/AuthStrategy"
            }
          ],
          "nullable": true
        }
      },
      "type": "object",
      "required": [
        "project_id",
        "id",
        "name",
        "cp_multi_az",
        "cp_subregions",
        "version",
        "cni",
        "admin_lbu",
        "admission_flags",
        "cidr_pods",
        "cidr_service",
        "cluster_dns",
        "tags",
        "control_planes",
        "admin_whitelist",
        "statuses"
      ],
      "title": "Cluster"
    },
    "Cursor": {
      "properties": {
        "next_cursor": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object",
      "title": "Cursor"
    },
    "Maintenance": {
      "properties": {
        "duration_hours": {
          "type": "integer",
          "maximum": 23.0,
          "minimum": 0.0,
          "title": "Duration Hours",
          "description": "Duration of the maintenance window in hours"
        },
        "start_hour": {
          "type": "integer",
          "maximum": 23.0,
          "minimum": 0.0,
          "title": "Start Hour",
          "description": "Hour of the day when maintenance window starts (0-23)"
        },
        "week_day": {
          "type": "string",
          "enum": [
            "Mon",
            "Tue",
            "Wed",
            "Thu",
            "Fri",
            "Sat",
            "Sun",
            "string"
          ],
          "title": "Week Day",
          "description": "Day of the week for the maintenance window"
        },
        "tz": {
          "type": "string",
          "title": "Timezone",
          "description": "Timezone for the maintenance window",
          "default": "UTC"
        }
      },
      "type": "object",
      "required": [
        "duration_hours",
        "start_hour",
        "week_day"
      ],
      "title": "Maintenance"
    },
    "MaintenanceWindow": {
      "properties": {
        "enabled": {
          "type": "boolean",
          "title": "Enabled",
          "description": "Flag to enable or disable the maintenance window",
          "default": true
        },
        "duration_hours": {
          "type": "integer",
          "maximum": 23.0,
          "minimum": 0.0,
          "title": "Duration Hours",
          "description": "Duration of the maintenance window in hours",
          "default": 0
        },
        "start_hour": {
          "type": "integer",
          "maximum": 23.0,
          "minimum": 0.0,
          "title": "Start Hour",
          "description": "Hour of the day when maintenance window starts (0-23)",
          "default": 12
        },
        "week_day": {
          "type": "string",
          "enum": [
            "Mon",
            "Tue",
            "Wed",
            "Thu",
            "Fri",
            "Sat",
            "Sun",
            "string"
          ],
          "title": "Week Day",
          "description": "Day of the week for the maintenance window",
          "default": "Tue"
        },
        "tz": {
          "type": "string",
          "title": "Timezone",
          "description": "Timezone for the maintenance window",
          "default": "UTC"
        }
      },
      "type": "object",
      "title": "MaintenanceWindow"
    },
    "Offset": {
      "properties": {
        "page": {
          "type": [
            "integer",
            "null"
          ]
        },
        "limit": {
          "type": [
            "integer",
            "null"
          ]
        },
        "total": {
          "type": [
            "integer",
            "null"
          ]
        }
      },
      "type": "object",
      "title": "Offset"
    },
    "OpenIdConnectConfig": {
      "properties": {
        "issuer-url": {
          "type": "string",
          "title": "OIDC Issuer URL",
          "description": "The URL of the provider that allows the API server to discover public signing keys."
        },
        "client-id": {
          "type": "string",
          "title": "OIDC Client ID",
          "description": "The client id that all tokens must be issued for."
        },
        "username-claim": {
          "type": [
            "string",
            "null"
          ]
        },
        "username-prefix": {
          "type": [
            "string",
            "null"
          ]
        },
        "groups-claim": {
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "groups-prefix": {
          "type": [
            "string",
            "null"
          ]
        },
        "required-claim": {
          "additionalProperties": {
            "type": "string"
          },
          "type": [
            "object",
            "null"
          ]
        }
      },
      "type": "object",
      "required": [
        "issuer-url",
        "client-id"
      ],
      "title": "OpenIdConnectConfig"
    },
    "Pagination": {
      "properties": {
        "cursor": {
          "allOf": [
            {
              "$ref": "#/$defs/Cursor"
            }
          ],
          "nullable": true
        },
        "offset": {
          "allOf": [
            {
              "$ref": "#/$defs/Offset"
            }
          ],
          "nullable": true
        }
      },
      "type": "object",
      "title": "Pagination"
    },
    "Statuses": {
      "properties": {
        "created_at": {
          "type": "string",
          "format": "date-time",
          "title": "Created At",
          "description": "Timestamp when the cluster was created"
        },
        "deleted_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updated_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "status": {
          "type": [
            "string",
            "null"
          ]
        },
        "available_upgrade": {
          "type": "string",
          "title": "Available Upgrade",
          "description": "Available Kubernetes version for upgrade if any",
          "default": ""
        }
      },
      "type": "object",
      "required": [
        "created_at"
      ],
      "title": "Statuses"
    },
    "clusters__cluster_schema__ResponseContext": {
      "properties": {
        "RequestId": {
          "type": "string",
          "title": "Request ID",
          "description": "Unique identifier for the API request"
        }
      },
      "type": "object",
      "required": [
        "RequestId"
      ],
      "title": "ResponseContext"
    }
  }
}