VMs

Create VM

post

Create a new virtual machine

Authorizations

Authorizationx-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

VM Create Request v2

vmTypeIdinteger · int32Required

Machine model type ID

regionstring · min: 1Required

Region code

Example: us-east-1

namestring · min: 1Required

VM nickname

isSpotbooleanRequired

Spot instance flag: true=spot, false=on-demand

Responses

200

OK

*/*

messagestringOptional

message

codeinteger · int32Optional

code

dataanyOptional

data

400

Bad Request

*/*

500

Internal Server Error

*/*

10000

VM created successfully

*/*

10001

Invalid request parameters

*/*

post

/v2/vms

HTTPcURLJavaScriptPython

POST /v2/vms HTTP/1.1
Host: api.yottalabs.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "vmTypeId": 1,
  "region": "us-east-1",
  "name": "text",
  "isSpot": true,
  "volumeMountPaths": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "message": "text",
  "code": 1,
  "data": null
}

Update VM

patch

Update an existing VM (partial update)

Authorizations

Authorizationx-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idinteger · int64Required

Body

application/json

VM Update Request v2

namestring · min: 1 · max: 255Optional

VM nickname

Responses

200

OK

*/*

messagestringOptional

message

codeinteger · int32Optional

code

dataanyOptional

data

400

Bad Request

*/*

500

Internal Server Error

*/*

10000

VM updated

*/*

11000

VM not found

*/*

patch

/v2/vms/{id}

HTTPcURLJavaScriptPython

PATCH /v2/vms/{id} HTTP/1.1
Host: api.yottalabs.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "message": "text",
  "code": 1,
  "data": null
}

Terminate VM

delete

Terminate a virtual machine

Authorizations

Authorizationx-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idinteger · int64Required

Responses

200

OK

*/*

messagestringOptional

message

codeinteger · int32Optional

code

dataanyOptional

data

400

Bad Request

*/*

500

Internal Server Error

*/*

10000

VM terminated

*/*

11000

VM not found

*/*

11001

VM status invalid

*/*

11002

No terminate permissions

*/*

12001

Resource status invalid

*/*

delete

/v2/vms/{id}

HTTPcURLJavaScriptPython

DELETE /v2/vms/{id} HTTP/1.1
Host: api.yottalabs.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "text",
  "code": 1,
  "data": null
}

List VMs

get

Get all VMs for your organization with pagination

Authorizations

Authorizationx-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageinteger · int64Optional

Page number (1-based)

Default: 1

sizeinteger · int64Optional

Page size

Default: 10

statusstringOptional

Filter by status

Responses

200

Success, returns paginated list of VMs

*/*

messagestringOptional

message

codeinteger · int32Optional

code

400

Bad Request

*/*

500

Internal Server Error

*/*

10000

Success

*/*

get

/v2/vms

HTTPcURLJavaScriptPython

GET /v2/vms HTTP/1.1
Host: api.yottalabs.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "text",
  "code": 1,
  "data": {
    "items": [
      {
        "id": 1,
        "orgId": "text",
        "name": "text",
        "gpuDisplayName": "text",
        "ipAddress": "text",
        "domainName": "text",
        "cpuCores": 1,
        "memoryInGb": "text",
        "gpuCount": 1,
        "gpuMemoryInGb": "text",
        "region": "text",
        "storageInGb": "text",
        "notebookUrl": "text",
        "sshTemplate": "text",
        "status": "INITIALIZING",
        "createdAt": 1,
        "terminatedAt": 1,
        "updatedAt": 1,
        "osInfo": "text",
        "gpuType": "text",
        "isSpot": true
      }
    ],
    "page": 1,
    "size": 1,
    "total": 1,
    "pages": 1
  }
}

Get VM

get

Get details of a specific virtual machine

Authorizations

Authorizationx-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idinteger · int64Required

Responses

200

OK

*/*

messagestringOptional

message

codeinteger · int32Optional

code

dataanyOptional

data

400

Bad Request

*/*

500

Internal Server Error

*/*

10000

VM found

*/*

11000

VM not found

*/*

get

/v2/vms/{id}

HTTPcURLJavaScriptPython

GET /v2/vms/{id} HTTP/1.1
Host: api.yottalabs.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "text",
  "code": 1,
  "data": null
}

Get VM Types

get

Get all available VM types (GPU models) and their regional availability

Authorizations

Authorizationx-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Success, returns list of GPU types with regional availability

*/*

messagestringOptional

message

codeinteger · int32Optional

code

400

Bad Request

*/*

404

Not Found

*/*

500

Internal Server Error

*/*

10000

Success

*/*

get

/v2/vms/types

HTTPcURLJavaScriptPython

GET /v2/vms/types HTTP/1.1
Host: api.yottalabs.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "text",
  "code": 1,
  "data": [
    {
      "gpuType": "text",
      "regions": [
        {
          "region": "text",
          "types": [
            {
              "vmTypeId": 1,
              "gpuCount": 1,
              "pricePerHour": "text",
              "supportSpot": true,
              "spotPricePerHour": "text",
              "currency": "USD",
              "displayName": "text",
              "cpuCores": 1,
              "memoryInGb": "text",
              "gpuMemoryInGb": "text",
              "gpuTotalMemoryInGb": "text",
              "storageType": "text",
              "storageCapacityInGb": "text",
              "osName": "text",
              "osVersion": "text",
              "supportOnDemand": true,
              "ondemandAvailable": true,
              "spotAvailable": true
            }
          ]
        }
      ]
    }
  ]
}