API

Appearance

Virtual Machine Instances ​

Comprehensive API operations for provisioning and managing virtual machine resources and their associated functionalities within the Rich platform ecosystem.

Instance Object Specification ​

API responses for virtual machine endpoints include a standardized instance object containing detailed resource specifications and operational parameters.

Object Attributes ​

id string ​

Unique instance identifier

name string ​

Instance designation

status string ​

Current operational state. Possible values:

  • creating: Instance initialization
  • running: Active operation
  • deleting: Termination in progress
  • starting: Boot sequence initiated
  • stopping: Shutdown sequence initiated
  • stopped: Power state inactive
  • rebooting: System restart in progress

login object ​

Authentication and access configuration parameters

json
{
    "_id": "676cf147e39574b1e3149831",
    "ssh_key": {
        "name": "sshkey"
    },
    "password": "password",
    "username": "username"
}

flavor object ​

Hardware resource allocation specifications

json
{
    "name": "1 x RTX4090",
    "cpu": 16, // CPU cores
    "ram": 32, // Memory in GB
    "disk": 250, // Storage in GB
    "gpu": "RTX4090",
    "gpu_count": 1
}

fixed_ip string ​

Static network address assignment

image object ​

Operating system configuration details

json
{
    "name": "Ubuntu-22.04"
}

region object ​

Geographical deployment location

json
{
    "name": "DALLAS"
}

started_time date-time ​

Instance initialization timestamp