LogoLogo
  • Voltage Park
    • Introduction
    • Quickstart
  • Products
    • On Demand
    • Long-Term Compute
  • On Demand
    • Getting Started
    • Dashboard
    • Deploy GPUs
      • Virtual Machines (VMs)
      • Bare Metal
    • My Instances
      • Jupyter Notebook
    • Kubernetes
    • API
  • Organization
    • Account
    • Billing
  • Support
    • Support
    • Troubleshooting
      • Ubuntu Server Crash Troubleshooting Guide
      • Common Log Files for Troubleshooting
      • Options for Mounting VAST NFS Shares
      • InfiniBand Basic Setup
      • Local Storage (Configuring an LVM Volume on Voltage Park On-Demand Bare Metal Servers)
    • FAQs
  • Legal
    • Terms of Service
    • Compute Services Agreement
    • Privacy Policy
Powered by GitBook
On this page
  1. On Demand

API

Here are our current API endpoints for our Voltage Park On Demand API.

Overview

Our Voltage Park On Demand API allows developers to deploy, manage, and monitor virtual machines (VMs) and bare metal instances.

Authentication

This API uses Bearer Token Authentication to authorize requests. Every request must include a valid API token in the Authorization header.

Example:

Authorization: Bearer YOUR_API_KEY

Since self-service API key generation is currently not available, API keys must be requested from our support team.

How to Obtain an API Key

  1. Contact our support team by emailing support@voltagepark.com.

  2. Provide the following details in your request:

    1. The email address associated with your Voltage Park On Demand account.

    2. Your Organization ID, which can be located on your Account page.

  3. Our team will acknowledge your request and provide an API Key with the proper permissions.

Keep your API key secure! Treat it like a password and NEVER expose it in public repositories.

Endpoints

Locations and HostNodes

Virtual Machines

Bare Metal

Billing

Cloud-init

PreviousKubernetesNextAccount

Last updated 1 month ago

List of available locations and available HostNodes

get

/locations/

Authorizations
Query parameters
limitinteger · min: 1 · max: 15 · default: 3
offsetinteger · default: 0
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/api/v1/locations/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
422
{
  "has_previous": true,
  "has_next": true,
  "total_result_count": 1,
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "city": "text",
      "region": "text",
      "country": "text",
      "hostnodes": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "location_id": "123e4567-e89b-12d3-a456-426614174000",
          "pricing": {
            "per_vcpu_hr": "0.000030",
            "per_gb_ram_hr": "0.000001",
            "per_gb_storage_hr": "0.000001",
            "per_gpu_hr": {
              "h100-sxm5-80gb": "3.500000"
            }
          },
          "available_ports": [
            1
          ],
          "available_resources": {
            "ram_gb": 960,
            "storage_gb": 14000,
            "vcpu_count": 208,
            "gpus": {
              "h100-sxm5-80gb": {
                "count": 8
              }
            }
          }
        }
      ]
    }
  ]
}

Successful Response

Details for a given location by ID

get

/locations/{location_id}

Authorizations
Path parameters
location_idstring · uuidrequired
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/api/v1/locations/{location_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
422
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "city": "text",
  "region": "text",
  "country": "text",
  "hostnodes": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "location_id": "123e4567-e89b-12d3-a456-426614174000",
      "pricing": {
        "per_vcpu_hr": "0.000030",
        "per_gb_ram_hr": "0.000001",
        "per_gb_storage_hr": "0.000001",
        "per_gpu_hr": {
          "h100-sxm5-80gb": "3.500000"
        }
      },
      "available_ports": [
        1
      ],
      "available_resources": {
        "ram_gb": 960,
        "storage_gb": 14000,
        "vcpu_count": 208,
        "gpus": {
          "h100-sxm5-80gb": {
            "count": 8
          }
        }
      }
    }
  ]
}

Successful Response

Details and available resources for a given HostNode

get

/hostnodes/{hostnode_id}

Authorizations
Path parameters
hostnode_idstring · uuidrequired
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/api/v1/hostnodes/{hostnode_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
404
422
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "location_id": "123e4567-e89b-12d3-a456-426614174000",
  "pricing": {
    "per_vcpu_hr": "0.000030",
    "per_gb_ram_hr": "0.000001",
    "per_gb_storage_hr": "0.000001",
    "per_gpu_hr": {
      "h100-sxm5-80gb": "3.500000"
    }
  },
  "available_ports": [
    1
  ],
  "available_resources": {
    "ram_gb": 960,
    "storage_gb": 14000,
    "vcpu_count": 208,
    "gpus": {
      "h100-sxm5-80gb": {
        "count": 8
      }
    }
  }
}

Successful Response

List of owned, unterminated virtual machines

get

/virtual-machines/

Authorizations
Query parameters
limitinteger · min: 1 · max: 100 · default: 10
offsetinteger · default: 0
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/api/v1/virtual-machines/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
422
{
  "has_previous": true,
  "has_next": true,
  "total_result_count": 1,
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "hostnode_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "resources": {
        "vcpu_count": 4,
        "ram_gb": 16,
        "storage_gb": 40,
        "gpus": {
          "h100-sxm5-80gb": {
            "count": 1
          }
        }
      },
      "pricing": {
        "gpus_per_hr": "text",
        "vcpus_per_hr": "text",
        "ram_per_hr": "text",
        "storage_per_hr": "text",
        "total_associated_per_hr": "text",
        "total_disassociated_per_hr": "text"
      },
      "public_ip": "text",
      "timestamp_creation": "2025-02-28T07:22:20.679Z",
      "type": "ondem",
      "status": "Running",
      "operating_system": "Ubuntu 20.04 LTS",
      "port_forwards": [
        {
          "internal_port": 22,
          "external_port": 20040
        }
      ]
    }
  ]
}

Successful Response

Details for a specific unterminated virtual machine

get

/virtual-machines/{virtual_machine_id}

Authorizations
Path parameters
virtual_machine_idstring · uuidrequired
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/api/v1/virtual-machines/{virtual_machine_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
404
422
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "hostnode_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "resources": {
    "vcpu_count": 4,
    "ram_gb": 16,
    "storage_gb": 40,
    "gpus": {
      "h100-sxm5-80gb": {
        "count": 1
      }
    }
  },
  "pricing": {
    "gpus_per_hr": "text",
    "vcpus_per_hr": "text",
    "ram_per_hr": "text",
    "storage_per_hr": "text",
    "total_associated_per_hr": "text",
    "total_disassociated_per_hr": "text"
  },
  "public_ip": "text",
  "timestamp_creation": "2025-02-28T07:22:20.679Z",
  "type": "ondem",
  "status": "Running",
  "operating_system": "Ubuntu 20.04 LTS",
  "port_forwards": [
    {
      "internal_port": 22,
      "external_port": 20040
    }
  ]
}

Successful Response

Convert a preconfigured virtual machine to a new virtual machine

Convert a instant vm so it may be used by a customer. Run custom cloud init scripts if provided. This route requires an authorization check.

post

/virtual-machines/instant

Authorizations
Body
config_idstring · uuidrequired
namestringrequired
ssh_keysstring[] · default:
passwordany of
cloud_initany of
organization_ssh_keysone of · default: [object Object]

Configuration for organization-associated SSH keys. Can select all, none, or select keys by ID.

Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/api/v1/virtual-machines/instant' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "config_id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "My Instant Virtual Machine",
    "ssh_keys": [
      "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDAKOgHv82A6Oi7AWLvBC9N..."
    ],
    "password": "super_secret_instant_vm_password",
    "cloud_init": {
      "packages": [],
      "write_files": [],
      "runcmd": []
    },
    "organization_ssh_keys": {
      "mode": "none"
    }
  }'
201
400
422
{
  "vm_id": "123e4567-e89b-12d3-a456-426614174000"
}

Successful Response

Start or stop a virtual machine

Stopped virtual machines will, by default, use the same billing as running ones. Disassociating resources, however, will reduce billing to only include storage costs.

put

/virtual-machines/{virtual_machine_id}/power-status

Authorizations
Path parameters
virtual_machine_idstring · uuidrequired
Body
statusstring · enumrequired
Options: started, stopped, stopped_disassociated
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request PUT \
  --url '/api/v1/virtual-machines/{virtual_machine_id}/power-status' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "started"
  }'
200
422
{
  "status": "started"
}

Successful Response

Terminate an existing virtual machine

delete

/virtual-machines/{virtual_machine_id}

Authorizations
Path parameters
virtual_machine_idstring · uuidrequired
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '/api/v1/virtual-machines/{virtual_machine_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
202
400
422
No body

Successful Response

List of owned, unterminated baremetal machines

get

/bare-metal/

Authorizations
Query parameters
limitany of · default: 20
offsetinteger · default: 0
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/api/v1/bare-metal/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
422
{
  "has_previous": true,
  "has_next": true,
  "total_result_count": 1,
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "node_count": 1,
      "specs_per_node": {
        "gpu_model": "h100-sxm5-80gb",
        "gpu_count": 8,
        "cpu_model": "Intel Xeon Platinum 8470",
        "cpu_count": 4,
        "ram_gb": 16,
        "storage_gb": 40
      },
      "rate_hourly": "text",
      "username": "text",
      "creation_timestamp": "2022-01-01T00:00:00Z",
      "status": "Running",
      "power_status": "Running",
      "network_type": "infiniband",
      "node_networking": [
        {
          "public_ip": "68.25.82.82",
          "private_ip": "192.168.0.1"
        }
      ],
      "sub_order": "text",
      "storage_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Successful Response

List of available baremetal locations

get

/bare-metal/locations

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/api/v1/bare-metal/locations'
200
{
  "has_previous": true,
  "has_next": true,
  "total_result_count": 1,
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "specs_per_node": {
        "gpu_model": "h100-sxm5-80gb",
        "gpu_count": 8,
        "cpu_model": "Intel Xeon Platinum 8470",
        "cpu_count": 4,
        "ram_gb": 16,
        "storage_gb": 40
      },
      "gpu_count_ethernet": 8,
      "gpu_price_ethernet": 2.5,
      "gpu_count_infiniband": 8,
      "gpu_price_infiniband": 2.5
    }
  ]
}

Successful Response

Provision a new bare-metal server rental

Deploys a bare-metal instance based on provided baremetal_config specifications and user organization. This route requires an authorization check.

post

/bare-metal/

Authorizations
Body
gpu_countintegerrequired
location_idstring · uuidrequired
namestringrequired
network_typestring · enumrequired

Machine networking: 3.2 Tbps Infiniband or 100 Gbps Ethernet

Options: infiniband, ethernet
ssh_keysstring[] · default:
sub_orderany of

If machines are deployed with a specified sub-order, they will only have network access to other machines in the same sub-order. Not specifying a sub-order will put the machine in either the ethernet or infiniband default suborders for your account.

cloudinit_scriptany of
organization_ssh_keysone of · default: [object Object]

Configuration for organization-associated SSH keys. Can select all, none, or select keys by ID.

Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/api/v1/bare-metal/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "gpu_count": 1,
    "location_id": "a3111bd4-550a-47d0-838a-0a52bff2ae3f",
    "name": "My Baremetal Rental",
    "network_type": "infiniband",
    "ssh_keys": [
      "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDAKOgHv82A6Oi7AWLvBC9N..."
    ],
    "sub_order": "12345",
    "cloudinit_script": {
      "packages": [],
      "write_files": [],
      "runcmd": []
    },
    "organization_ssh_keys": {
      "mode": "none"
    }
  }'
201
400
422
{
  "rental_id": "123e4567-e89b-12d3-a456-426614174000",
  "warning": "text"
}

Successful Response

Start or stop the nodes in a baremetal rental

put

/bare-metal/{baremetal_rental_id}/power-status

Authorizations
Path parameters
baremetal_rental_idstring · uuidrequired
Body
statusstring · enumrequired
Options: started, stopped
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request PUT \
  --url '/api/v1/bare-metal/{baremetal_rental_id}/power-status' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "started"
  }'
200
422
No body

Successful Response

Terminate a bare-metal rental

delete

/bare-metal/{baremetal_rental_id}

Authorizations
Path parameters
baremetal_rental_idstring · uuidrequired
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '/api/v1/bare-metal/{baremetal_rental_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
202
400
422
No body

Successful Response

Historical organization billing log

get

/billing/transactions

Authorizations
Query parameters
limitinteger · min: 1 · default: 30
offsetinteger · default: 0
earliestany of
Example: 2024-10-01
latestany of
Example: 2024-10-26
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/api/v1/billing/transactions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
422
{
  "has_previous": true,
  "has_next": true,
  "total_result_count": 1,
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "total_amount": "text",
      "timestamp_creation": "2025-02-28T07:22:20.679Z",
      "period_amount": "text",
      "timestamp_completion": "2025-02-28T07:22:20.679Z",
      "details": {
        "linked_instance": {
          "type": "virtual_machine_instance",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "virtual_machine_id": "123e4567-e89b-12d3-a456-426614174000",
          "timestamp_creation": "2025-02-28T07:22:20.679Z",
          "timestamp_deletion": "2025-02-28T07:22:20.679Z"
        },
        "type": "charge"
      }
    }
  ]
}

Successful Response

Monthly billing log

get

/billing/reports/{year}//{month}/transactions

Authorizations
Path parameters
yearintegerrequired
Example: 2024
monthintegerrequired
Example: 10
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/api/v1/billing/reports/{year}/{month}/transactions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
422
{
  "balance_at_period_start": "text",
  "balance_delta_in_period": "text",
  "transactions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "total_amount": "text",
      "timestamp_creation": "2025-02-28T07:22:20.679Z",
      "period_amount": "text",
      "timestamp_completion": "2025-02-28T07:22:20.679Z",
      "details": {
        "linked_instance": {
          "type": "virtual_machine_instance",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "virtual_machine_id": "123e4567-e89b-12d3-a456-426614174000",
          "timestamp_creation": "2025-02-28T07:22:20.679Z",
          "timestamp_deletion": "2025-02-28T07:22:20.679Z"
        },
        "type": "charge"
      }
    }
  ],
  "balance_at_period_end": "text"
}

Successful Response

validate a cloud init script

post

/validate/cloudinit

Body
typestring · enumrequired
Options: instant-vm, vm, baremetal
contentany ofrequired
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/api/v1/validate/cloudinit' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "instant-vm",
    "content": "text"
  }'
200
422
{
  "error": true,
  "message": "text"
}

Successful Response

  • Overview
  • Authentication
  • How to Obtain an API Key
  • Endpoints
  • Locations and HostNodes
  • GETList of available locations and available HostNodes
  • GETDetails for a given location by ID
  • GETDetails and available resources for a given HostNode
  • Virtual Machines
  • GETList of owned, unterminated virtual machines
  • GETDetails for a specific unterminated virtual machine
  • POSTConvert a preconfigured virtual machine to a new virtual machine
  • PUTStart or stop a virtual machine
  • DELETETerminate an existing virtual machine
  • Bare Metal
  • GETList of owned, unterminated baremetal machines
  • GETList of available baremetal locations
  • POSTProvision a new bare-metal server rental
  • PUTStart or stop the nodes in a baremetal rental
  • DELETETerminate a bare-metal rental
  • Billing
  • GETHistorical organization billing log
  • GETMonthly billing log
  • Cloud-init
  • POSTvalidate a cloud init script