Massed Compute Virtual Machine API

https://vm-docs.massedcompute.com/api/v1
Admin
Massed Compute VM API provides on-demand GPU virtual machine rental with endpoints for managing...
Tokens:5,231
Snippets:16
Trust Score:8.8
Update:6 months ago
Show doc for...
Tokens:
Raw
### GET /instance

Source: https://vm-docs.massedcompute.com/api/v1

Retrieve a list of all currently running instances (virtual machines).

```APIDOC
## GET /instance

### Description
Retrieve a list of all running instances. An instance is a virtual machine that is currently running.

### Method
GET

### Endpoint
https://vm.massedcompute.com/api/v1/instance

### Parameters

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **runningInstances** (array) - A list of running instances.
  - **uuid** (string) - The unique identifier for the instance.
  - **name** (string) - The name of the instance.
  - **ip** (string) - The IP address of the instance.
  - **username** (string) - The username for accessing the instance.
  - **password** (integer) - The password for accessing the instance.
  - **status** (string) - The current status of the instance (e.g., 'rented').
  - **os_booted** (integer) - Indicates if the OS has booted (1 for yes, 0 for no).
  - **command_startup** (string) - Any startup commands.
  - **created** (string) - The timestamp when the instance was created.
  - **active** (integer) - Indicates if the instance is active (1 for yes, 0 for no).
  - **image** (object) - Information about the VM image used.
    - **id** (integer) - The ID of the image.
    - **name** (string) - The name of the image.
    - **description** (string) - A description of the image.
  - **product** (object) - Information about the product/VM configuration.
    - **name** (string) - The name of the product.
    - **description** (string) - A description of the product.
    - **gpu_count** (integer) - The number of GPUs.
    - **vcpu** (integer) - The number of vCPUs.
    - **ram** (integer) - The amount of RAM in GB.
    - **storage** (integer) - The amount of storage in GB.
    - **price_hr** (number) - The price per hour.
    - **final_price_hr** (number) - The final price per hour.

#### Response Example
```json
{
  "runningInstances": [
    {
      "uuid": "8b52a46b-a892-4fde-925c-6d13226908f7",
      "name": "Halloween Test",
      "ip": "1.1.1.1",
      "username": "Ubuntu",
      "password": 123456,
      "status": "rented",
      "os_booted": 1,
      "command_startup": "",
      "created": "2024-08-07T16:41:43.000Z",
      "active": 1,
      "image": {
        "id": 7,
        "name": "Art",
        "description": "AI-powered tools specifically designed for artists and creatives, providing you with the ability to easily incorporate AI-generated content into your work. By harnessing the power of these advanced technologies, you can take your art to new heights and explore uncharted territories in the creative world. Leverage the full potential of AI and transform your artistic process today."
      },
      "product": {
        "name": "gpu_1x_l40",
        "description": "1x L40",
        "gpu_count": 1,
        "vcpu": 26,
        "ram": 128,
        "storage": 625,
        "price_hr": 0.99,
        "final_price_hr": 0
      }
    }
  ]
}
```
```

--------------------------------

### GET /gpu-inventory

Source: https://vm-docs.massedcompute.com/api/v1

Retrieve a comprehensive list of all available GPU types, configurations, and inventory.

```APIDOC
## GET /gpu-inventory

### Description
Retrieve a comprehensive list of all available GPU types, configurations, and inventory.

### Method
GET

### Endpoint
https://vm.massedcompute.com/api/v1/gpu-inventory

### Parameters

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **gpu_inventory** (object) - A dictionary where keys are properties of the GPU configuration.
  - **instance_type** (object) - Details about the instance type.
    - **name** (string) - The name of the instance type.
    - **description** (string) - A description of the instance type.
    - **price_cents_per_hour** (integer) - The price in cents per hour.
    - **specs** (object) - Specifications of the instance.
      - **vcpu_count** (integer) - Number of vCPUs.
      - **memory_gib** (integer) - Memory in GiB.
      - **storage_gb** (integer) - Storage in GB.
  - **regions_with_capacity_available** (array) - List of regions with available capacity.
    - **name** (string) - The name of the region.
    - **description** (string) - A description of the region.
  - **capacity_available** (integer) - The amount of capacity available.

#### Response Example
```json
{
  "gpu_inventory": {
    "property1": {
      "instance_type": {
        "name": "string",
        "description": "string",
        "price_cents_per_hour": 0,
        "specs": {
          "vcpu_count": 0,
          "memory_gib": 0,
          "storage_gb": 0
        }
      },
      "regions_with_capacity_available": [
        {
          "name": "string",
          "description": "string"
        }
      ],
      "capacity_available": 0
    },
    "property2": {
      "instance_type": {
        "name": "string",
        "description": "string",
        "price_cents_per_hour": 0,
        "specs": {
          "vcpu_count": 0,
          "memory_gib": 0,
          "storage_gb": 0
        }
      },
      "regions_with_capacity_available": [
        {
          "name": "string",
          "description": "string"
        }
      ],
      "capacity_available": 0
    }
  }
}
```
```

--------------------------------

### GET /images

Source: https://vm-docs.massedcompute.com/api/v1

Retrieve a list of available images, which are preconfigured operating systems and software stacks.

```APIDOC
## GET /images

### Description
Retrieve a list of available images. An Image is a preconfigured operating system and software stack.

### Method
GET

### Endpoint
https://vm.massedcompute.com/api/v1/images

### Parameters

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **images** (array) - A list of available VM images.
  - **vm_image_id** (integer) - The unique identifier for the VM image.
  - **vm_image_name** (string) - The name of the VM image.
  - **vm_image_description** (string) - A description of the VM image.

#### Response Example
```json
{
  "images": [
    {
      "vm_image_id": 0,
      "vm_image_name": "string",
      "vm_image_description": "string"
    }
  ]
}
```
```

--------------------------------

### GET /instance/{uuid}

Source: https://vm-docs.massedcompute.com/api/v1

Retrieve details for a single running instance using its UUID.

```APIDOC
## GET /instance/{uuid}

### Description
Retrieve a single running instance. An instance is a virtual machine that is currently running.

### Method
GET

### Endpoint
https://vm.massedcompute.com/api/v1/instance/{uuid}

### Parameters

#### Path Parameters
- **uuid** (string) - Required - The unique identifier of the instance to retrieve.

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **runningInstance** (object) - Details of the specified running instance.
  - **uuid** (string) - The unique identifier for the instance.
  - **name** (string) - The name of the instance.
  - **ip** (string) - The IP address of the instance.
  - **username** (string) - The username for accessing the instance.
  - **password** (integer) - The password for accessing the instance.
  - **status** (string) - The current status of the instance (e.g., 'rented').
  - **os_booted** (integer) - Indicates if the OS has booted (1 for yes, 0 for no).
  - **command_startup** (string) - Any startup commands.
  - **created** (string) - The timestamp when the instance was created.
  - **active** (integer) - Indicates if the instance is active (1 for yes, 0 for no).
  - **image** (object) - Information about the VM image used.
    - **id** (integer) - The ID of the image.
    - **name** (string) - The name of the image.
    - **description** (string) - A description of the image.
  - **product** (object) - Information about the product/VM configuration.
    - **name** (string) - The name of the product.
    - **description** (string) - A description of the product.
    - **gpu_count** (integer) - The number of GPUs.
    - **vcpu** (integer) - The number of vCPUs.
    - **ram** (integer) - The amount of RAM in GB.
    - **storage** (integer) - The amount of storage in GB.
    - **price_hr** (string) - The price per hour.
    - **final_price_hr** (string) - The final price per hour.

#### Response Example
```json
{
  "runningInstance": {
    "uuid": "8b52a46b-a892-4fde-925c-6d13226908f7",
    "name": "Halloween Test",
    "ip": "1.1.1.1",
    "username": "Ubuntu",
    "password": 123456,
    "status": "rented",
    "os_booted": 1,
    "command_startup": "",
    "created": "2024-08-07T16:41:43.000Z",
    "active": 1,
    "image": {
      "id": 7,
      "name": "Art",
      "description": "AI-powered tools specifically designed for artists and creatives, providing you with the ability to easily incorporate AI-generated content into your work. By harnessing the power of these advanced technologies, you can take your art to new heights and explore uncharted territories in the creative world. Leverage the full potential of AI and transform your artistic process today."
    },
    "product": {
      "name": "gpu_1x_l40",
      "description": "1x L40",
      "gpu_count": 1,
      "vcpu": 26,
      "ram": 128,
      "storage": 625,
      "price_hr": "0.990000",
      "final_price_hr": "0.000000"
    }
  }
}
```
```

--------------------------------

### POST /api/v1/instance/launch

Source: https://vm-docs.massedcompute.com/api/v1

Deploys new virtual machine instances with specified configurations. Supports setting image ID, product name, region, instance name, coupon, startup command, and SSH keys.

```APIDOC
## POST /api/v1/instance/launch

### Description
Deploys new virtual machine instances with specified configurations. Supports setting image ID, product name, region, instance name, coupon, startup command, and SSH keys.

### Method
POST

### Endpoint
https://vm.massedcompute.com/api/v1/instance/launch

### Parameters
#### Request Body
- **imageId** (integer) - Required - The ID of the image to deploy.
- **productName** (string) - Required - The product name of the GPU instance you want to deploy. Example = 'gpu_1x_l40'.
- **regionName** (string) - Required - Set value equal to 'any'.
- **instanceName** (string) - Optional - The name of the instance you want to deploy.
- **coupon** (string) - Optional - The coupon code you want to apply to the instance.
- **command** (string) - Optional - The command you want to run on startup.
- **sshKeys** (Array of strings) - Optional - The SSH key you want to use to connect to the instance.

### Request Example
```json
{
  "imageId": 0,
  "productName": "string",
  "regionName": "string",
  "instanceName": "string",
  "coupon": "string",
  "command": "string",
  "sshKeys": [
    "string"
  ]
}
```

### Response
#### Success Response (202)
- **response** (string) - Success deploying instance. Example: "8b52a46b-uuid-4fde-xxxx-6d13226908f7"

#### Response Example
```json
{
  "response": "8b52a46b-uuid-4fde-xxxx-6d13226908f7"
}
```
```

--------------------------------

### Launch New Instance

Source: https://vm-docs.massedcompute.com/api/v1

Deploys a new GPU instance by specifying the image ID, product name, and optional configuration like startup commands and SSH keys.

```json
{
  "imageId": 0,
  "productName": "string",
  "regionName": "string",
  "instanceName": "string",
  "coupon": "string",
  "command": "string",
  "sshKeys": ["string"]
}
```

--------------------------------

### POST /api/v1/instance/restart

Source: https://vm-docs.massedcompute.com/api/v1

Restarts one or more specified virtual machine instances.

```APIDOC
## POST /api/v1/instance/restart

### Description
Restarts one or more specified virtual machine instances.

### Method
POST

### Endpoint
https://vm.massedcompute.com/api/v1/instance/restart

### Parameters
#### Request Body
- **instanceUuids** (Array of strings) - Required - The ID or IDs of instances to restart.

### Request Example
```json
{
  "instanceUuids": [
    "string"
  ]
}
```

### Response
#### Success Response (202)
- **response** (Array of objects) - Success restarting instance. Contains details of the restarted instances.

#### Response Example
```json
{
  "response": [
    {
      "id": "2c56cd01-5f0b-4bc2-bb72-3c8e486505e2",
      "name": "test api deploy1",
      "ip": "1.1.1.1",
      "status": "booting",
      "ssh_key_names": [
        "string"
      ],
      "file_system_names": [
        "string"
      ],
      "region": {
        "name": "us-central-3",
        "description": "Des Moines, IA"
      },
      "instance_type": {
        "name": "gpu_1x_a6000",
        "description": "1x RTX A6000",
        "price_cents_per_hour": 0,
        "specs": {
          "vcpus": 6,
          "memory_gib": 48,
          "storage_gb": 256
        }
      },
      "jupyter_token": "string",
      "jupyter_url": "string"
    }
  ]
}
```
```

--------------------------------

### POST /api/v1/instance/terminate

Source: https://vm-docs.massedcompute.com/api/v1

Terminates and completely removes one or more specified virtual machine instances, destroying all associated data.

```APIDOC
## POST /api/v1/instance/terminate

### Description
Terminates and completely removes one or more specified virtual machine instances, destroying all associated data.

### Method
POST

### Endpoint
https://vm.massedcompute.com/api/v1/instance/terminate

### Parameters
#### Request Body
- **instanceUuids** (Array of strings) - Required - The ID or IDs of instances to terminate.

### Request Example
```json
{
  "instanceUuids": [
    "string"
  ]
}
```

### Response
#### Success Response (202)
- **response** (object) - Success terminating instance. Contains details of the terminated instances.

#### Response Example
```json
{
  "response": {
    "data": {
      "terminated_instances": [
        {
          "id": "2c56cd01-5f0b-4bc2-bb72-3c8e486505e2",
          "name": "test api deploy1",
          "ip": "1.1.1.1",
          "status": "terminated",
          "ssh_key_names": [
            "string"
          ],
          "file_system_names": [
            "string"
          ],
          "region": {
            "name": "us-central-3",
            "description": "Des Moines, IA"
          },
          "instance_type": {
            "name": "gpu_1x_a6000",
            "description": "1x RTX A6000"
          },
          "jupyter_token": "",
          "jupyter_url": ""
        }
      ]
    }
  }
}
```
```

--------------------------------

### POST /api/v1/coupon/accepted-products

Source: https://vm-docs.massedcompute.com/api/v1

Retrieves a list of products for which a given coupon is valid.

```APIDOC
## POST /api/v1/coupon/accepted-products

### Description
Retrieves a list of products for which a given coupon is valid. A coupon is a discount code that can be applied to an instance when deployed.

### Method
POST

### Endpoint
https://vm.massedcompute.com/api/v1/coupon/accepted-products

### Parameters
#### Request Body
- **coupon** (string) - Required - The coupon code you want to retrieve information about.

### Request Example
```json
{
  "coupon": "string"
}
```

### Response
#### Success Response (200)
- **response** (object) - Contains a list of products accepted by the coupon. (Note: The exact structure of the response for accepted products was not fully detailed in the provided text, but typically would be an array of product identifiers or objects.)

#### Response Example
```json
{
  "coupon": {
    "code": "TestCoupon",
    "acceptedProducts": [
      "gpu_1x_l40",
      "cpu_4x_standard"
    ]
  }
}
```
```

--------------------------------

### Restart Instances

Source: https://vm-docs.massedcompute.com/api/v1

Restarts one or more existing instances using their unique identifiers.

```json
{
  "instanceUuids": ["string"]
}
```

--------------------------------

### Retrieve Coupon Information

Source: https://vm-docs.massedcompute.com/api/v1

Fetches details for a specific coupon code, including discount percentage and expiration date.

```json
{
  "coupon": "string"
}
```

--------------------------------

### POST /api/v1/coupon/information

Source: https://vm-docs.massedcompute.com/api/v1

Retrieves information about a specific coupon, including its discount percentage and deactivation date.

```APIDOC
## POST /api/v1/coupon/information

### Description
Retrieves information about a specific coupon, including its discount percentage and deactivation date. A coupon is a discount code that can be applied to an instance when deployed.

### Method
POST

### Endpoint
https://vm.massedcompute.com/api/v1/coupon/information

### Parameters
#### Request Body
- **coupon** (string) - Required - The coupon code you want to retrieve information about.

### Request Example
```json
{
  "coupon": "string"
}
```

### Response
#### Success Response (200)
- **coupon** (object) - Contains coupon details including code, discount percentage, and deactivation date.

#### Response Example
```json
{
  "coupon": {
    "code": "TestCoupon",
    "discountPercent": 0.1,
    "deactivationDate": "2024-08-07T16:41:43.000Z"
  }
}
```
```

--------------------------------

### Authentication

Source: https://vm-docs.massedcompute.com/api/v1

All endpoints require Bearer token authentication. Obtain your API token from API Settings.

```APIDOC
## Authentication

Authentication of every endpoint provided requires an API token. We leverage Bearer token authentication on our endpoints.

| Header          | Value             |
|-----------------|-------------------|
| Authorization   | Bearer {{api_token}} |

To provision an API key, please see our API Settings documentation.
```

--------------------------------

### SSH Keys API

Source: https://vm-docs.massedcompute.com/api/v1

Manages SSH keys associated with the account for secure instance access.

```APIDOC
## GET /api/v1/ssh-keys

### Description
Retrieves all SSH keys associated with the account.

### Method
GET

### Endpoint
https://vm.massedcompute.com/api/v1/ssh-keys

### Response
#### Success Response (200)
- **sshKeys** (array) - A list of SSH key objects.
  - **id** (string) - The unique identifier for the SSH key.
  - **name** (string) - The name of the SSH key.
  - **public_key** (string) - The public key string.

#### Response Example
```json
{
  "sshKeys": [
    {
      "id": "string",
      "name": "string",
      "public_key": "string"
    }
  ]
}
```
```

```APIDOC
## POST /api/v1/ssh-keys

### Description
Adds a new SSH key to the account.

### Method
POST

### Endpoint
https://vm.massedcompute.com/api/v1/ssh-keys

### Parameters
#### Request Body
- **name** (string) - Required - The name of the SSH key.
- **publicKey** (string) - Required - The public key associated with the SSH key.

### Request Example
```json
{
  "name": "string",
  "publicKey": "string"
}
```

### Response
#### Success Response (200)
- **sshKey** (object) - Details of the newly added SSH key.
  - **id** (string) - The unique identifier for the SSH key.
  - **name** (string) - The name of the SSH key.

#### Response Example
```json
{
  "sshKey": {
    "id": "string",
    "name": "string"
  }
}
```
```

```APIDOC
## DELETE /api/v1/ssh-keys/{id}

### Description
Removes an SSH key from the account.

### Method
DELETE

### Endpoint
https://vm.massedcompute.com/api/v1/ssh-keys/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier for the SSH key to be removed.

### Response
#### Success Response (200)
- **result** (object) - An empty object indicating successful removal.

#### Response Example
```json
{
  "result": {}
}
```
```

--------------------------------

### Account Billing API

Source: https://vm-docs.massedcompute.com/api/v1

Retrieves the billing information associated with the user's account.

```APIDOC
## GET /api/v1/account/billing

### Description
Retrieves billing information for the account.

### Method
GET

### Endpoint
https://vm.massedcompute.com/api/v1/account/billing

### Response
#### Success Response (200)
- **billingMethod** (string) - The current billing method (e.g., "creditcard").
- **rechargeThresholdCents** (integer) - The threshold in cents for automatic recharge.
- **rechargeThreshold** (integer) - The threshold amount for automatic recharge.
- **rechargeAmountCents** (integer) - The amount in cents to recharge automatically.
- **rechargeAmount** (integer) - The amount to recharge automatically.

#### Response Example
```json
{
  "billingMethod": "creditcard",
  "rechargeThresholdCents": 1000,
  "rechargeThreshold": 10,
  "rechargeAmountCents": 2000,
  "rechargeAmount": 20
}
```
```

--------------------------------

### Account Authentication API

Source: https://vm-docs.massedcompute.com/api/v1

Validates the provided API token to ensure it is active and authorized for use.

```APIDOC
## POST /api/v1/account/token/validation

### Description
Validates the provided API token.

### Method
POST

### Endpoint
https://vm.massedcompute.com/api/v1/account/token/validation

### Response
#### Success Response (200)
- **message** (string) - Indicates the token is valid.

#### Response Example
```json
{
  "message": "Valid Token"
}
```
```
Tokens:
Raw