Virtual Machines

Create Instance

Endpoint: POST /openapi/v1/vms/create

Description: Creates and starts a new virtual machine (VM) instance.

Request Body Example:

{
  "vmTypeId": 10086,
  "region": "sg",
  "nickName": "my-first-vm",
  "isSpot": 0
}

Request Parameters:

Name	Type	Required	Description
vmTypeId	string	Yes	Model/Specification ID (Defines hardware config).
region	string	Yes	Region code (The geographic location for deployment).
nickName	string	Yes	Nickname for the instance for easy identification.
isSpot	number	Yes	Billing mode: 0 for On-Demand, 1 for Spot instance.

Successfule Reponse Example:

{
    "message": "success",
    "code": 10000,
    "data": {
        "id": "399527225789387495",
        "orgId": "295310909206171648",
        "nickname": "test",
        "gpuDisplayName": "1x RTX A6000 [Low RAM] (48GB) - MassedCompute (6C/24G/256G)",
        "ipAddress": "216.81.248.18",
        "domainName": "instance-2008745331524636672.yottadeos.com",
        "cpuCores": 6,
        "memoryInGb": "24",
        "gpuCount": 1,
        "gpuMemoryInGb": "48",
        "region": "mc-us-central-3",
        "storageInGb": "256",
        "notebookUrl": "http://instance-2008745331524636672.yottadeos.com:8888/lab?token=30a268ec-dc60-4a6c-94fe-bde619997544",
        "sshTemplate": "ssh -i <your-private-key> [email protected]",
        "status": "Terminated",
        "createdAt": "1767757113485",
        "terminatedAt": "1767758190693",
        "updatedAt": "1767780000000",
        "osInfo": "Ubuntu 22.04 LTS",
        "gpuType": "RTX A6000",
        "isSpot": 0
    }
}

HTTP Status Code	Business Code	Meaning	Description	Data Structure
200	10000	Request Success	Creation successful	ResultString
400	-	Bad Request	Parameter error	ResultObject
500	-	Server Error	Internal error	ResultObject

Response

Name	Type	Description
message	string	Success: "success" Failure: Refer to [Response Codes].
code	string	Success: 10000 Failure: Refer to [Response Codes].
data	OpenapiVmsDetailResponse	See the definition below for VMS details.

Get Instance Details

Endpoint: GET /openapi/v1/vms/{vmId}

Path Parameter: vmId Instance ID

Request Example:

GET /openapi/v1/vms/399527225789387495

Description: Retrieves detailed information for a specific instance by its ID.

Successfule Reponse Example:

{
    "message": "success",
    "code": 10000,
    "data": {
        "id": "399527225789387495",
        "orgId": "295310909206171648",
        "nickname": "test",
        "gpuDisplayName": "1x RTX A6000 [Low RAM] (48GB) - MassedCompute (6C/24G/256G)",
        "ipAddress": "216.81.248.18",
        "domainName": "instance-2008745331524636672.yottadeos.com",
        "cpuCores": 6,
        "memoryInGb": "24",
        "gpuCount": 1,
        "gpuMemoryInGb": "48",
        "region": "mc-us-central-3",
        "storageInGb": "256",
        "notebookUrl": "http://instance-2008745331524636672.yottadeos.com:8888/lab?token=30a268ec-dc60-4a6c-94fe-bde619997544",
        "sshTemplate": "ssh -i <your-private-key> [email protected]",
        "status": "Terminated",
        "createdAt": "1767757113485",
        "terminatedAt": "1767758190693",
        "updatedAt": "1767780000000",
        "osInfo": "Ubuntu 22.04 LTS",
        "gpuType": "RTX A6000",
        "isSpot": 0
    }
}

HTTP Status Code	Business Code	Meaning	Description	Data Structure
200	10000	Request Success	Creation successful	ResultString
400	-	Bad Request	Parameter error	ResultObject
500	-	Server Error	Internal error	ResultObject

Response

Name	Type	Description
message	string	Success: "success" Failure: Refer to [Response Codes].
code	string	Success: 10000 Failure: Refer to [Response Codes].
data	OpenapiVmsDetailResponse	See the definition below for VMS details.

List Organization Instances

Endpoint: POST /openapi/v1/vms/list

Description: Paginated query of instance lists under the current user's organization.

Request Example:

• Find all

{
  "search": {},
  "pageNumber": 1,
  "pageSize": 1
}

• Filter by status

{
  "search": {
    "status": "RUNNING"
  },
  "pageNumber": 1,
  "pageSize": 2
}

Name	Type	Required	Description
search	object	Yes	Query condition structure (e.g., status).
pageNumber	string	Yes	Page number.
pageSize	string	Yes	Items per page.
status	string	No	status of the instance

Successfule Response Request

{
    "message": "success",
    "code": 10000,
    "data": {
        "records": [
            {
                "id": "404365352188121967",
                "orgId": "295310909206171648",
                "nickname": "11111",
                "gpuDisplayName": "1x RTX PRO 6000 Blackwell",
                "ipAddress": "154.54.100.213",
                "domainName": "instance-2013583794795188224.yottadeos.com",
                "cpuCores": 16,
                "memoryInGb": "144",
                "gpuCount": 1,
                "gpuMemoryInGb": "96",
                "region": "mc-us-east-1",
                "storageInGb": "725",
                "notebookUrl": "http://instance-2013583794795188224.yottadeos.com:8888/lab?token=ca764c4d-313e-4acb-99dd-9bc2725f5eca",
                "sshTemplate": "ssh -i <your-private-key> [email protected]",
                "status": "Terminated",
                "createdAt": "1768910612706",
                "terminatedAt": "1768926137360",
                "updatedAt": "1768926137360",
                "osInfo": "Ubuntu 22.04 LTS",
                "gpuType": "RTX PRO 6000",
                "isSpot": 0
            }
        ],
        "pageNumber": "1",
        "pageSize": "1",
        "totalPage": "178",
        "totalRow": "178"
    }
}

OpenapiYottaPageResponse

Name	Type	Description
pageNumber	number	Page number
pageSize	number	Page size
totalPage	number	Total pages
totalRow	number	Total records
records	OpenapiVmsDetailResponse[],Details seen definition below	VMS Details

HTTP Status Code	Business Code	Meaning	Description	Data Structure
200	10000	Request Success	Creation successful	string
400	-	Bad Request	Parameter error	object
500	-	Server Error	Internal error	object

Response

Name	Type	Description
message	string	Success: "success" Failure: Refer to [Response Codes].
code	string	Success: 10000 Failure: Refer to [Response Codes].
data	OpenapiYottaPageResponse

Terminate Instance

Endpoint: DELETE /openapi/v1/vms/{vmId}/terminate

Description: Terminates (releases) a specified instance.

Path Parameter: vmId Instance ID

Request Example: DELETE /openapi/v1/vms/43264375788654/terminate

Successfule Response Request:

{
  "message": "success",
  "code": 10000,
  "data": true
}

HTTP Status Code	Business Code	Meaning	Description	Data Structure
200	10000	Request Success	Creation successful	ResultString
400	-	Bad Request	Parameter error	ResultObject
500	-	Server Error	Internal error	ResultObject

Get Available VM Types

Endpoint: GET /openapi/v1/vms/type

Description:Get the currently available VM types.

Request Example: GET /openapi/v1/vms/type

Successful Response Example:

{
    "message": "success",
    "code": 10000,
    "data": [
        {
            "gpuType": "RTX PRO 6000",
            "regions": [
                {
                    "region": "mc-us-east-1",
                    "types": [
                        {
                            "vmTypeId": 158,
                            "gpuCount": 8,
                            "pricePerHour": "10.472",
                            "supportSpot": 0,
                            "currency": "USD",
                            "displayName": "8x RTX PRO 6000 Blackwell",
                            "cpuCores": 120,
                            "memoryInGb": "1536",
                            "gpuMemoryInGb": "96",
                            "gpuTotalMemoryInGb": "768",
                            "storageType": "ssd",
                            "storageCapacityInGb": "5800",
                            "osName": "Ubuntu",
                            "osVersion": "22.04 LTS",
                            "supportOnDemand": 1,
                            "ondemandAvailable": 0,
                            "spotAvailable": 0
                        },
                        {
                            "vmTypeId": 157,
                            "gpuCount": 4,
                            "pricePerHour": "5.236",
                            "supportSpot": 0,
                            "currency": "USD",
                            "displayName": "4x RTX PRO 6000 Blackwell",
                            "cpuCores": 60,
                            "memoryInGb": "576",
                            "gpuMemoryInGb": "96",
                            "gpuTotalMemoryInGb": "384",
                            "storageType": "ssd",
                            "storageCapacityInGb": "2900",
                            "osName": "Ubuntu",
                            "osVersion": "22.04 LTS",
                            "supportOnDemand": 1,
                            "ondemandAvailable": 1,
                            "spotAvailable": 0
                        },
                        {
                            "vmTypeId": 156,
                            "gpuCount": 2,
                            "pricePerHour": "2.618",
                            "supportSpot": 0,
                            "currency": "USD",
                            "displayName": "2x RTX PRO 6000 Blackwell",
                            "cpuCores": 30,
                            "memoryInGb": "288",
                            "gpuMemoryInGb": "96",
                            "gpuTotalMemoryInGb": "192",
                            "storageType": "ssd",
                            "storageCapacityInGb": "1450",
                            "osName": "Ubuntu",
                            "osVersion": "22.04 LTS",
                            "supportOnDemand": 1,
                            "ondemandAvailable": 1,
                            "spotAvailable": 0
                        },
                        {
                            "vmTypeId": 155,
                            "gpuCount": 1,
                            "pricePerHour": "1.309",
                            "supportSpot": 0,
                            "currency": "USD",
                            "displayName": "1x RTX PRO 6000 Blackwell",
                            "cpuCores": 16,
                            "memoryInGb": "144",
                            "gpuMemoryInGb": "96",
                            "gpuTotalMemoryInGb": "96",
                            "storageType": "ssd",
                            "storageCapacityInGb": "725",
                            "osName": "Ubuntu",
                            "osVersion": "22.04 LTS",
                            "supportOnDemand": 1,
                            "ondemandAvailable": 1,
                            "spotAvailable": 0
                        }
                    ]
                }
            ]
        }
    ]
}

HTTP Status Code	Business Code	Meaning	Description	Data Structure
200	10000	Request Success	Creation successful	string
400	-	Bad Request	Parameter error	object
500	-	Server Error	Internal error	object

OpenapiVmsResponse

Name	Type	Description
gpuType	string	GPU model group key
regions	array	List of regions (OpenapiVmsRegionsResponse)

---

OpenapiVmsRegionsResponse

Name	Type	Description
region	string	Region code
types	array	List of VM types in this region (OpenapiVmsTypesResponse)

---

OpenapiVmsTypesResponse

Name	Type	Description
vmTypeId	number	VM type ID
displayName	string	Display name
cpuCores	number	Number of CPU cores
memoryInGb	number	Memory capacity in GB
gpuCount	number	Number of GPUs
gpuMemoryInGb	number	Memory per GPU in GB
gpuTotalMemoryInGb	number	Total GPU memory in GB
storageType	string	Storage type
storageCapacityInGb	number	Storage capacity in GB
osName	string	OS information
osVersion	string	OS version
pricePerHour	string	On-demand price
supportOnDemand	number	Supports on-demand: 0 = No, 1 = Yes
supportSpot	number	Supports spot: 0 = No, 1 = Yes
spotPricePerHour	string	Spot price
currency	string	Currency
ondemandAvailable	number	Supports on-demand for current GPU type: 0 = No, 1 = Yes
spotAvailable	number	Supports spot for current GPU type: 0 = No, 1 = Yes

---

Data Structure Description

OpenapiVmsDetailResponse

Name	Type	Description
id	string	Instance primary key
orgId	string	Organization ID
nickname	string	Instance nickname
gpuDisplayName	string	GPU display name
ipAddress	string	Instance public IP address
domainName	string	Instance access domain name
cpuCores	number	Number of CPU cores
memoryInGb	number	Memory capacity
gpuCount	number	Number of GPUs
gpuMemoryInGb	number	Memory size per GPU
region	string	Region identifier
storageInGb	number	Instance disk capacity
notebookUrl	string	Jupyter Notebook access URL
sshTemplate	string	SSH connection command template
status	string	Instance status code (InstanceStatusEnum)
createdAt	string	Creation time
terminatedAt	string	Termination time
updatedAt	string	Last updated time
osInfo	string	OS information
gpuType	string	GPU type
isSpot	string	Supports spot

---

InstanceStatusEnum

Enum Name	Possible Values	Description
INITIALIZING	0	Instance is being created or started, resources are not ready yet
RUNNING	1	Instance is ready, accessible and in use
STOPPING	2	Instance is being stopped
STOPPED	3	Instance is stopped, but resources are retained and can be restarted
TERMINATING	4	Instance is being destroyed, resources are about to be released
TERMINATED	5	Instance is completely destroyed, cannot be restored
FAILED	6	An irrecoverable error occurred during instance creation or operation

---

Response Codes

Code	Message	Description
10000	success	Request was successful
10001	parameter error	Invalid parameter
10001	Status %s is invalid	Invalid status
10001	model %s type invalid	Invalid model type
10001	region %s invalid	Invalid region
10001	region and model type not match or region not available	Unsupported region
10001	this model type does not support spot instance	Spot is not supported
10001	this model type does not support on-demand instance	On-demand is not supported