> ## Documentation Index > Fetch the complete documentation index at: https://otoyinc.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Node Details ## OpenAPI ````yaml https://api.dispersed.com/openapi.json get /v1/nodes/{node_uuid} openapi: 3.1.0 info: title: Dispersed API version: 1.0.0 servers: - url: https://api.dispersed.com security: [] paths: /v1/nodes/{node_uuid}: get: tags: - Nodes summary: Node Details parameters: - schema: type: string required: true name: node_uuid in: path responses: '200': description: Node details content: application/json: schema: $ref: '#/components/schemas/NodeResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: NodeResponse: type: object properties: _id: type: - string - 'null' uuid: type: - string - 'null' name: type: string last_seen_at: type: - string - 'null' format: date-time status: type: string enum: - AVAILABLE - ASSIGNED - PREPARING - WORKING - STOPPING - OFFLINE - DELETED - RESOURCE_BUSY - OUTDATED_CLIENT latest_hardware_event: type: - object - 'null' properties: uuid: type: - string - 'null' timestamp_ms: type: integer metadata: type: object properties: cpu: type: object properties: average: type: number cores: type: array items: type: number additionalProperties: {} gpu: type: object properties: average: type: number gpus: type: array items: type: object properties: load: type: number name: type: string vram: type: object properties: free: type: - number - 'null' total: type: - number - 'null' required: - gpus additionalProperties: {} ram: type: object properties: free: type: - number - 'null' total: type: - number - 'null' additionalProperties: {} storage: anyOf: - type: object properties: hard_drives: type: array items: type: object properties: free_capacity: type: - number - 'null' model: type: string name: type: string total_capacity: type: - number - 'null' additionalProperties: {} - type: object properties: capacity_bytes_free: type: number capacity_bytes_total: type: number device_id: type: string quota: type: number quota_used: type: number additionalProperties: {} additionalProperties: {} node: type: - string - 'null' node_hardware: type: - string - 'null' account: type: - string - 'null' object: type: string enum: - node_hardware_event created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time required: - timestamp_ms - object - created_at - updated_at current_hardware: $ref: '#/components/schemas/NodeHardwareResponse' current_software: $ref: '#/components/schemas/NodeSoftwareResponse' ipv4_address: type: - string - 'null' format: ip ipv6_address: type: - string - 'null' format: ip mac_address: type: - string - 'null' operator_account: anyOf: - type: object properties: uuid: type: - string - 'null' email: type: string format: email last_login: type: - string - 'null' format: date-time consumer_profile: allOf: - $ref: '#/components/schemas/ConsumerProfileResponse' - type: - object - 'null' operator_profile: $ref: '#/components/schemas/OperatorProfileResponse' user_profile: $ref: '#/components/schemas/UserProfileResponse' object: type: string enum: - account created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time deleted_at: type: - string - 'null' format: date-time required: - email - object - created_at - updated_at - type: - string - 'null' - type: 'null' operator_account_uuid: type: - string - 'null' reputation: type: number minimum: 0 maximum: 100 suspended_at: type: - string - 'null' format: date-time current_suspension: $ref: '#/components/schemas/NodeSuspensionResponse' object: type: string enum: - node created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time deleted_at: type: - string - 'null' format: date-time cpus: type: array items: type: object properties: name: type: string num_cores: type: number required: - name - num_cores deprecated: true description: >- **DEPRECATED:** This field is deprecated and will be removed in a future version. Use `current_hardware` instead. gpus: type: array items: type: object properties: name: type: string vram_gb_available: type: number vram_gb_max: type: number required: - name - vram_gb_available - vram_gb_max deprecated: true description: >- **DEPRECATED:** This field is deprecated and will be removed in a future version. Use `current_hardware` instead. hard_drives: type: array items: type: object properties: available_capacity_gb: type: number max_capacity_gb: type: number name: type: string required: - available_capacity_gb - max_capacity_gb - name deprecated: true description: >- **DEPRECATED:** This field is deprecated and will be removed in a future version. Use `current_hardware` instead. operating_system: type: - object - 'null' properties: brand: type: - string - 'null' name: type: - string - 'null' version: type: - string - 'null' deprecated: true description: >- **DEPRECATED:** This field is deprecated and will be removed in a future version. Use `current_software` instead. rams: type: array items: type: object properties: memory_gb_available: type: number memory_gb_max: type: number required: - memory_gb_available - memory_gb_max deprecated: true description: >- **DEPRECATED:** This field is deprecated and will be removed in a future version. Use `current_hardware` instead. ramTotal: type: number deprecated: true description: >- **DEPRECATED:** This field is deprecated and will be removed in a future version. Use `current_hardware` instead. required: - name - status - reputation - object - created_at - updated_at - cpus - gpus - hard_drives - rams - ramTotal ErrorResponse: type: object properties: error: $ref: '#/components/schemas/Error' required: - error NodeHardwareResponse: type: - object - 'null' properties: uuid: type: - string - 'null' node: type: - string - 'null' node_uuid: type: - string - 'null' cpus: type: array items: type: object properties: architecture: type: - string - 'null' base_clock_mhz: type: - number - 'null' chipset: type: - string - 'null' device_id: type: - string - 'null' description: >- Unique identifier for the CPU, if available. For example: `/proc/cpuinfo` features: type: array items: type: string default: [] name: type: string num_cores: type: number num_threads_per_core: type: - number - 'null' required: - name - num_cores description: List of CPUs available on the machine. gpus: type: array items: type: object properties: base_clock_mhz: type: - number - 'null' device_id: type: - string - 'null' description: >- Unique identifier for the GPU, if available. For example: `nvidia-smi` or `/sys/class/drm/card0*` gpu_registry_uuid: type: - string - 'null' name: type: string vram_bytes_total: type: - number - 'null' required: - name - vram_bytes_total description: List of GPUs available on the machine. memory: type: object properties: base_clock_mhz: type: - number - 'null' device_id: type: - string - 'null' description: >- Unique identifier for the memory, if available. For example: `dmidecode` ram_bytes_total: type: - number - 'null' required: - ram_bytes_total description: Memory details of the machine, including RAM and base clock. storage: type: object properties: capacity_bytes_free: type: - number - 'null' capacity_bytes_total: type: - number - 'null' device_id: type: - string - 'null' description: >- Unique identifier for storage block device, if available. For example: `lsblk -f` required: - capacity_bytes_free - capacity_bytes_total description: Storage details of the machine, including total and free space. machine_id: type: - string - 'null' description: >- A unique identifier for the machine, if available. For example: `/etc/machine-id` or `/var/lib/dbus/machine-id` on Linux, `MachineGuid` on Windows, `IOPlatformUUID` on macOS. checksum_sha256: type: - string - 'null' _id: type: - string - 'null' operating_system: type: object properties: architecture: type: - string - 'null' brand: type: - string - 'null' name: type: - string - 'null' version: type: - string - 'null' deprecated: true description: >- This field is deprecated and will be removed in a future version. Use `node.current_software.operating_system` instead. schema_version: type: number object: type: string enum: - node_hardware created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time required: - cpus - gpus - memory - storage - operating_system - schema_version - object - created_at - updated_at NodeSoftwareResponse: type: - object - 'null' properties: uuid: type: - string - 'null' description: Unique identifier for this software record. node: type: - string - 'null' description: Internal reference to the parent Node document. node_uuid: type: - string - 'null' description: UUID of the node this software belongs to. capabilities: type: array items: oneOf: - $ref: '#/components/schemas/CapabilityContainerRuntime' - $ref: '#/components/schemas/CapabilityGpuDriver' - $ref: '#/components/schemas/CapabilityNodeClient' - $ref: '#/components/schemas/CapabilityOperatingSystem' discriminator: propertyName: type mapping: container_runtime: $ref: '#/components/schemas/CapabilityContainerRuntime' gpu_driver: $ref: '#/components/schemas/CapabilityGpuDriver' node_client: $ref: '#/components/schemas/CapabilityNodeClient' operating_system: $ref: '#/components/schemas/CapabilityOperatingSystem' description: >- A software capability installed on the node. Discriminated by `type`. Each type should appear at most once in the capabilities array. default: [] description: >- Installed software capabilities reported by the node. Each capability has a uniform `{ type, name, version }` base. At most one entry per `type` + `name` combination. cached_image_tags: type: array items: type: string default: [] description: >- Docker image tags currently cached on the node (e.g. pulled and ready to run). Used by the scheduler to prefer nodes that can start a job without pulling the image first. example: - ubuntu:22.04 - pytorch/pytorch:latest schema_version: type: number description: Internal schema version for migration tracking. object: type: string enum: - node_software created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time docker: type: object properties: images: type: array items: type: object properties: name: type: string size_bytes: type: - number - 'null' tags: type: array items: type: string default: [] required: - name - size_bytes default: [] version: type: - string - 'null' default: images: [] version: null deprecated: true description: >- Deprecated. Use `capabilities` with `type: "container_runtime"` instead. Derived from capabilities for backward compatibility. nvidia_driver: type: object properties: version: type: - string - 'null' default: version: null deprecated: true description: >- Deprecated. Use `capabilities` with `type: "gpu_driver"` instead. Derived from capabilities for backward compatibility. operating_system: type: object properties: architecture: type: - string - 'null' enum: - aarch64 - amd64 - arm64 - armv6l - armv7l - i386 - i686 - x86_64 - null brand: type: string name: type: string version: type: string default: architecture: null brand: '' name: '' version: '' required: - brand - name - version deprecated: true description: >- Deprecated. Use `capabilities` with `type: "operating_system"` instead. Derived from capabilities for backward compatibility. zernet_client: type: object properties: version: type: - string - 'null' default: version: null deprecated: true description: >- Deprecated. Use `capabilities` with `type: "node_client"` instead. Derived from capabilities for backward compatibility. required: - schema_version - object - created_at - updated_at ConsumerProfileResponse: type: object properties: uuid: type: - string - 'null' account_uuid: type: - string - 'null' is_active: type: boolean is_compute_billing_enabled: type: boolean render_user_id: type: - string - 'null' allowed_region_codes: type: array items: $ref: '#/components/schemas/RegionCode' default: [] object: type: string enum: - consumer_profile created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time deleted_at: type: - string - 'null' format: date-time required: - is_active - is_compute_billing_enabled - object - created_at - updated_at OperatorProfileResponse: type: - object - 'null' properties: uuid: type: - string - 'null' account_uuid: type: - string - 'null' is_active: type: boolean wallet_address: type: - string - 'null' object: type: string enum: - operator_profile created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time deleted_at: type: - string - 'null' format: date-time required: - is_active - object - created_at - updated_at UserProfileResponse: type: - object - 'null' properties: uuid: type: - string - 'null' account_uuid: type: - string - 'null' name: type: string given_name: type: string family_name: type: string middle_name: type: string preferred_username: type: string email_verified: type: boolean oauth_provider: type: - string - 'null' oauth_subject: type: - string - 'null' object: type: string enum: - user_profile created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time required: - email_verified - object - created_at - updated_at NodeSuspensionResponse: type: - object - 'null' properties: uuid: type: - string - 'null' node_uuid: type: - string - 'null' started_at: type: - string - 'null' format: date-time ended_at: type: - string - 'null' format: date-time reason_code: type: string enum: - ABUSE - MISCONFIGURATION - OTHER - POLICY_VIOLATION - REPEATED_FAILURES reason: type: string follow_up: type: string suspended_by_account_uuid: type: - string - 'null' unsuspended_by_account_uuid: type: - string - 'null' object: type: string enum: - node_suspension created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time required: - started_at - reason_code - reason - follow_up - object - created_at - updated_at Error: type: object properties: code: type: string details: type: array items: type: object properties: code: type: string expected: type: string input: type: string keys: type: array items: type: string message: type: string path: type: array items: anyOf: - type: string - type: number required: - message - path default: [] message: type: string status: type: number timestamp: type: string required: - code - message - status - timestamp CapabilityContainerRuntime: type: object properties: type: type: string enum: - container_runtime name: type: string description: Container runtime name (normalized to lowercase). example: docker version: type: string description: Installed container runtime version (SemVer). example: 28.3.2 required: - type - name - version CapabilityGpuDriver: type: object properties: type: type: string enum: - gpu_driver name: type: string description: GPU driver vendor (normalized to lowercase). example: nvidia version: type: string description: Installed GPU driver version. example: 535.129.03 required: - type - name - version CapabilityNodeClient: type: object properties: type: type: string enum: - node_client name: type: string description: Node client software name (normalized to lowercase). example: zernet_client version: type: string description: >- Installed node client version (SemVer). Used for version compliance checks against NetworkNodePolicy requirements. example: 1.8.0 required: - type - name - version CapabilityOperatingSystem: type: object properties: type: type: string enum: - operating_system name: type: string description: OS distribution name (normalized to lowercase). example: ubuntu version: type: string description: OS distribution version. example: '22.04' family: type: string description: OS kernel family (normalized to lowercase). example: linux architecture: type: string description: CPU architecture. example: x86_64 required: - type - name - version RegionCode: type: - string - 'null' enum: - ca-central-1 - ca-west-1 - mx-central-1 - sa-east-1 - us-east-1 - us-east-2 - us-west-1 - us-west-2 - eu-central-1 - eu-central-2 - eu-north-1 - eu-south-1 - eu-south-2 - eu-west-1 - eu-west-2 - eu-west-3 - ap-east-1 - ap-east-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-south-1 - ap-south-2 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ap-southeast-5 - ap-southeast-6 - ap-southeast-7 - cn-north-1 - cn-northwest-1 - af-south-1 - il-central-1 - me-central-1 - me-south-1 - null default: null description: Coarse geographic-network region identifier (AWS-style naming). example: us-west-2 ````