ClusterListResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nutanix/main/json-schema/nutanix-cluster-list-response-schema.json",
  "title": "ClusterListResponse",
  "description": "Response for listing clusters.",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/nutanix-clusters-api-openapi.yml#/components/schemas/ClusterListResponse",
  "type": "object",
  "properties": {
    "api_version": {
      "type": "string"
    },
    "metadata": {
      "$ref": "#/$defs/ListMetadata"
    },
    "entities": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ClusterIntentResponse"
      }
    }
  },
  "$defs": {
    "ClusterIntentResponse": {
      "type": "object",
      "description": "Response containing cluster intent status and spec.",
      "properties": {
        "status": {
          "type": "object",
          "description": "The current status of the cluster."
        },
        "spec": {
          "type": "object",
          "description": "The cluster specification."
        },
        "metadata": {
          "$ref": "#/$defs/EntityMetadata"
        }
      }
    },
    "EntityMetadata": {
      "type": "object",
      "description": "Metadata for an entity.",
      "properties": {
        "kind": {
          "type": "string",
          "description": "The kind of entity."
        },
        "uuid": {
          "type": "string",
          "format": "uuid",
          "description": "The UUID of the entity."
        },
        "spec_version": {
          "type": "integer",
          "description": "Version number of the spec."
        },
        "categories": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Categories assigned to the entity as key-value pairs."
        },
        "owner_reference": {
          "$ref": "#/$defs/Reference"
        },
        "project_reference": {
          "$ref": "#/$defs/Reference"
        }
      }
    },
    "ListMetadata": {
      "type": "object",
      "description": "Request body for list operations supporting server-side filtering, sorting, and pagination.",
      "properties": {
        "kind": {
          "type": "string",
          "description": "The entity kind to list."
        },
        "offset": {
          "type": "integer",
          "description": "Offset from the start of the entity list.",
          "minimum": 0
        },
        "length": {
          "type": "integer",
          "description": "The number of records to retrieve.",
          "minimum": 1,
          "maximum": 500
        },
        "filter": {
          "type": "string",
          "description": "The filter criteria in FIQL format."
        },
        "sort_order": {
          "type": "string",
          "description": "The sort order.",
          "enum": [
            "ASCENDING",
            "DESCENDING"
          ]
        },
        "sort_attribute": {
          "type": "string",
          "description": "The attribute to sort results by."
        }
      }
    },
    "Reference": {
      "type": "object",
      "description": "A reference to another entity.",
      "required": [
        "kind",
        "uuid"
      ],
      "properties": {
        "kind": {
          "type": "string",
          "description": "The kind of entity being referenced."
        },
        "uuid": {
          "type": "string",
          "format": "uuid",
          "description": "The UUID of the referenced entity."
        },
        "name": {
          "type": "string",
          "description": "The name of the referenced entity."
        }
      }
    }
  }
}