---
updatedAt: 2025-11-10T23:54:17.000Z
agentTools:
  projectIndex: https://orka.readme.io/llms.txt
---

# List nodes

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "An API Server that serves as an efficient gateway for managing VMs, Nodes, Images, and more within Orka clusters.",
    "title": "Orka API Server",
    "contact": {},
    "version": "3.5.0"
  },
  "paths": {
    "/api/v1/namespaces/{namespace}/nodes": {
      "get": {
        "security": [
          {
            "BearerTokenAuth": []
          }
        ],
        "tags": [
          "Nodes"
        ],
        "summary": "List nodes",
        "operationId": "listNodes",
        "parameters": [
          {
            "description": "namespace",
            "name": "namespace",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/api.ItemsResponse-v1_OrkaNodeResponseModel"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "BearerTokenAuth": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "api.ItemsResponse-v1_OrkaNodeResponseModel": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/v1.OrkaNodeResponseModel"
            }
          }
        }
      },
      "macstadium_com_orka-operator_api_v1.NodePhase": {
        "type": "string",
        "enum": [
          "READY",
          "NOT READY"
        ],
        "x-enum-varnames": [
          "NodeReady",
          "NodeNotReady"
        ]
      },
      "v1.NodeType": {
        "type": "string",
        "enum": [
          "FOUNDATION",
          "SERVICE",
          "WORKER",
          "SANDBOX"
        ],
        "x-enum-varnames": [
          "Foundation",
          "Service",
          "Worker",
          "Sandbox"
        ]
      },
      "v1.OrkaImageState": {
        "type": "string",
        "enum": [
          "Ready",
          "Caching",
          "Failed"
        ],
        "x-enum-varnames": [
          "OrkaImageStateReady",
          "OrkaImageStateCaching",
          "OrkaImageStateFailed"
        ]
      },
      "v1.OrkaImageStatus": {
        "type": "object",
        "properties": {
          "errorMessage": {
            "description": "The error message if the image status is FAILED",
            "type": "string"
          },
          "names": {
            "description": "Names by which this image is known.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "size": {
            "description": "The virtual size of the image file in bytes",
            "type": "integer"
          },
          "spaceUsed": {
            "description": "The amount of storage the image file actually consumes in bytes",
            "type": "integer"
          },
          "status": {
            "description": "The status of the image. One of Ready, Caching, Failed",
            "allOf": [
              {
                "$ref": "#/components/schemas/v1.OrkaImageState"
              }
            ]
          }
        }
      },
      "v1.OrkaNodeResponseModel": {
        "type": "object",
        "properties": {
          "allocatableCpu": {
            "description": "The complete amount of CPU cores on the node when no VirtualMachineInstances are deployed",
            "type": "integer"
          },
          "allocatableGpu": {
            "description": "The complete amount of GPU cores on the node when no VirtualMachineInstances are deployed",
            "type": "integer"
          },
          "allocatableMemory": {
            "description": "The complete amount of memory (in GiB) on the node when no VirtualMachineInstances are deployed",
            "type": "string"
          },
          "architecture": {
            "type": "string"
          },
          "availableCpu": {
            "description": "The amount of available CPU on the node",
            "type": "integer"
          },
          "availableGpu": {
            "description": "The amount of available GPU on the node",
            "type": "integer"
          },
          "availableMemory": {
            "description": "The amount of available Memory on the node",
            "type": "string"
          },
          "containerRuntimeVersion": {
            "description": "The version Container Runtime",
            "type": "string"
          },
          "images": {
            "description": "The list of cached images on the OrkaNode",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/v1.OrkaImageStatus"
            }
          },
          "kubeletVersion": {
            "description": "The version of the kubelet",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "namespace": {
            "type": "string"
          },
          "nodeIP": {
            "description": "The IP of the OrkaNode",
            "type": "string"
          },
          "nodeType": {
            "description": "The type of the OrkaNode. One of FOUNDATION, SERVICE, WORKER, SANDBOX",
            "allOf": [
              {
                "$ref": "#/components/schemas/v1.NodeType"
              }
            ]
          },
          "orkaTags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "osVersion": {
            "description": "The MacOS Version",
            "type": "string"
          },
          "phase": {
            "description": "The status of the OrkaNode. One of READY, NOT READY",
            "allOf": [
              {
                "$ref": "#/components/schemas/macstadium_com_orka-operator_api_v1.NodePhase"
              }
            ]
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```