Skip to main content
API docs by Redocly

Massed Compute VM API (1.0.0)

Download OpenAPI specification:Download

API documentation for our direct on-demand offering

If you are a marketplace looking to leverage our GPU inventory please contact us at techadmin@massedcompute.com

Authentication

Authentication of every endpoint provided requres a API token. We leverage Bearer token authentication on our endpoints.

Header Value
Authorization Bearer {{api_token}}

If you would like to use the API, please contact us at techadmin@massedcompute.com to request a token.

Retrieve a list of avaialable GPU configurations.

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

Responses

Response samples

Content type
application/json
{
  • "gpu_inventory": {
    }
}

Retrieve list of available images.

An Image is a preconfigured operating system and software stack.

Responses

Response samples

Content type
application/json
{
  • "images": [
    ]
}

Instances

Retrieve list of all running instances.

An instance is a virtual machine that is currently running.

Responses

Response samples

Content type
application/json
{
  • "runningInstances": [
    ]
}

Retrieve single running instances.

An instance is a virtual machine that is currently running.

Responses

Response samples

Content type
application/json
{
  • "runningInstance": {
    }
}

Deploy new instances.

Request Body schema: application/json
required
imageId
integer

The ID of the image to deploy

productName
required
string

The product name of the GPU instance you want to deploy. Example = 'gpu_1x_l40'

regionName
required
string

Set value equal to 'any'

instanceName
string

The name of the instance you want to deploy

coupon
string

The coupon code you want to apply to the instance

command
string

The command you want to run on startup

sshKeys
Array of strings

The SSH key you want to use to connect to the instance

Responses

Request samples

Content type
application/json
{
  • "imageId": 0,
  • "productName": "string",
  • "regionName": "string",
  • "instanceName": "string",
  • "coupon": "string",
  • "command": "string",
  • "sshKeys": [
    ]
}

Response samples

Content type
application/json
{
  • "response": "8b52a46b-uuid-4fde-xxxx-6d13226908f7"
}

Restart an instances.

Request Body schema: application/json
required
instanceUuids
required
Array of strings

The ID or IDs of instances to restart

Responses

Request samples

Content type
application/json
{
  • "instanceUuids": [
    ]
}

Response samples

Content type
application/json
{
  • "response": [
    ]
}

Terminate an instances.

Termination completely removes the instance from the system and destroys all data.

Request Body schema: application/json
required
instanceUuids
required
Array of strings

The ID or IDs of instances to restart

Responses

Request samples

Content type
application/json
{
  • "instanceUuids": [
    ]
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Coupon

Retrieve information about a coupon.

A coupon is a discount code that can be applied to an instance when deployed.

Request Body schema: application/json
required
coupon
string

The coupon code you want to retrieve information about

Responses

Request samples

Content type
application/json
{
  • "coupon": "string"
}

Response samples

Content type
application/json
{
  • "coupon": {
    }
}

Retrieve products that a coupon is valid for.

A coupon is a discount code that can be applied to an instance when deployed.

Request Body schema: application/json
required
coupon
string

The coupon code you want to retrieve information about

Responses

Request samples

Content type
application/json
{
  • "coupon": "string"
}

Response samples

Content type
application/json
{
  • "couponValidation": {
    }
}

Account

Validate an API token.

An API token is required to access the API.

Responses

Response samples

Content type
application/json
{
  • "message": "Valid Token"
}

Retrieve billing information.

Billing information for the account.

Responses

Response samples

Content type
application/json
{
  • "billingMethod": "creditcard",
  • "rechargeThresholdCents": 1000,
  • "rechargeThreshold": 10,
  • "rechargeAmountCents": 2000,
  • "rechargeAmount": 20
}