VmListResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nutanix/main/json-schema/nutanix-vm-list-response-schema.json",
  "title": "VmListResponse",
  "description": "Response for listing VMs.",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/nutanix-vms-api-openapi.yml#/components/schemas/VmListResponse",
  "type": "object",
  "properties": {
    "api_version": {
      "type": "string",
      "description": "API version."
    },
    "metadata": {
      "$ref": "#/$defs/ListMetadata"
    },
    "entities": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/VmIntentResponse"
      },
      "description": "List of VM intent responses."
    }
  },
  "$defs": {
    "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."
        }
      }
    },
    "VmIntentResponse": {
      "type": "object",
      "description": "Response containing VM intent status and spec.",
      "properties": {
        "status": {
          "type": "object",
          "description": "The current status of the VM."
        },
        "spec": {
          "$ref": "#/$defs/VmSpec"
        },
        "metadata": {
          "$ref": "#/$defs/EntityMetadata"
        }
      }
    },
    "VmSpec": {
      "type": "object",
      "description": "VM specification describing the desired state.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the VM."
        },
        "description": {
          "type": "string",
          "description": "A description of the VM."
        },
        "resources": {
          "type": "object",
          "description": "VM resource configuration.",
          "properties": {
            "num_sockets": {
              "type": "integer",
              "description": "Number of vCPU sockets.",
              "minimum": 1
            },
            "num_vcpus_per_socket": {
              "type": "integer",
              "description": "Number of vCPUs per socket.",
              "minimum": 1
            },
            "memory_size_mib": {
              "type": "integer",
              "description": "Memory size in MiB.",
              "minimum": 1
            },
            "power_state": {
              "type": "string",
              "description": "The desired power state of the VM.",
              "enum": [
                "ON",
                "OFF"
              ]
            },
            "disk_list": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "device_properties": {
                    "type": "object",
                    "properties": {
                      "device_type": {
                        "type": "string",
                        "enum": [
                          "DISK",
                          "CDROM"
                        ]
                      },
                      "disk_address": {
                        "type": "object",
                        "properties": {
                          "adapter_type": {
                            "type": "string",
                            "enum": [
                              "SCSI",
                              "IDE",
                              "PCI",
                              "SATA",
                              "SPAPR"
                            ]
                          },
                          "device_index": {
                            "type": "integer"
                          }
                        }
                      }
                    }
                  },
                  "disk_size_mib": {
                    "type": "integer",
                    "description": "Size of the disk in MiB."
                  }
                }
              },
              "description": "List of disks attached to the VM."
            },
            "nic_list": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "subnet_reference": {
                    "$ref": "#/$defs/Reference"
                  },
                  "ip_endpoint_list": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "ip": {
                          "type": "string",
                          "description": "IP address."
                        },
                        "type": {
                          "type": "string",
                          "enum": [
                            "ASSIGNED",
                            "LEARNED"
                          ]
                        }
                      }
                    }
                  }
                }
              },
              "description": "List of NICs attached to the VM."
            }
          }
        },
        "cluster_reference": {
          "$ref": "#/$defs/Reference"
        }
      }
    }
  }
}