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 [e-mail].

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

List of available locations and available HostNodes

get

Authorizations

apiTokenAuthstorefrontBearerAuthlegacySessionAuth

Query parameters

limitinteger · min: 1 · max: 15 · default: 3optional

offsetinteger · default: 0optional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/locations/' \
  --header 'x-api-token: YOUR_API_KEY'

200

422

200

{
  "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",
          "available_resources": {
            "gpus": {
              "h100-sxm5-80gb": {
                "count": 8
              }
            },
            "ram_gb": 960,
            "storage_gb": 14000,
            "vcpu_count": 208
          },
          "pricing": {
            "per_gpu_hr": {
              "h100-sxm5-80gb": "3.500000"
            },
            "per_vcpu_hr": "0.000030",
            "per_gb_ram_hr": "0.000001",
            "per_gb_storage_hr": "0.000001"
          },
          "available_ports": [
            1
          ]
        }
      ]
    }
  ],
  "total_result_count": 1,
  "has_previous": true,
  "has_next": true
}

Successful Response

Details for a given location by ID

get

Authorizations

apiTokenAuthstorefrontBearerAuthlegacySessionAuth

Path parameters

location_idstring · uuidrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/locations/{location_id}' \
  --header 'x-api-token: YOUR_API_KEY'

200

422

200

{
  "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",
      "available_resources": {
        "gpus": {
          "h100-sxm5-80gb": {
            "count": 8
          }
        },
        "ram_gb": 960,
        "storage_gb": 14000,
        "vcpu_count": 208
      },
      "pricing": {
        "per_gpu_hr": {
          "h100-sxm5-80gb": "3.500000"
        },
        "per_vcpu_hr": "0.000030",
        "per_gb_ram_hr": "0.000001",
        "per_gb_storage_hr": "0.000001"
      },
      "available_ports": [
        1
      ]
    }
  ]
}

Successful Response

Details and available resources for a given HostNode

get

Authorizations

apiTokenAuthstorefrontBearerAuthlegacySessionAuth

Path parameters

hostnode_idstring · uuidrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/hostnodes/{hostnode_id}' \
  --header 'x-api-token: YOUR_API_KEY'

200

404

422

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "location_id": "123e4567-e89b-12d3-a456-426614174000",
  "available_resources": {
    "gpus": {
      "h100-sxm5-80gb": {
        "count": 8
      }
    },
    "ram_gb": 960,
    "storage_gb": 14000,
    "vcpu_count": 208
  },
  "pricing": {
    "per_gpu_hr": {
      "h100-sxm5-80gb": "3.500000"
    },
    "per_vcpu_hr": "0.000030",
    "per_gb_ram_hr": "0.000001",
    "per_gb_storage_hr": "0.000001"
  },
  "available_ports": [
    1
  ]
}

Successful Response

Convert a preconfigured virtual machine to a new virtual machine

post

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.

Authorizations

apiTokenAuthstorefrontBearerAuthlegacySessionAuth

Body

config_idstring · uuidrequired

namestringrequired

Example: My Instant Virtual Machine

passwordany ofoptional

Example: super_secret_instant_vm_password

organization_ssh_keysone of · default: {"mode":"none"}optional

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

ssh_keysstring[] · default: [[]]optional

Example: ["ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDAKOgHv82A6Oi7AWLvBC9N..."]

cloud_initany ofoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/virtual-machines/instant' \
  --header 'x-api-token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "config_id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "My Instant Virtual Machine",
    "password": "super_secret_instant_vm_password",
    "organization_ssh_keys": {
      "mode": "selective",
      "ssh_key_ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "ssh_keys": [
      "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDAKOgHv82A6Oi7AWLvBC9N..."
    ],
    "cloud_init": {
      "packages": [
        "text"
      ],
      "write_files": [
        {
          "encoding": "text",
          "content": "text",
          "owner": "text",
          "path": "text",
          "permissions": "text"
        }
      ],
      "runcmd": [
        "text"
      ]
    }
  }'

201

400

422

201

{
  "vm_id": "123e4567-e89b-12d3-a456-426614174000"
}

Successful Response

List of owned, unterminated virtual machines

get

Authorizations

apiTokenAuthstorefrontBearerAuthlegacySessionAuth

Query parameters

limitinteger · min: 1 · max: 100 · default: 10optional

offsetinteger · default: 0optional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/virtual-machines/' \
  --header 'x-api-token: YOUR_API_KEY'

200

422

200

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "hostnode_id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "ondem",
      "status": "Running",
      "name": "text",
      "resources": {
        "gpus": {
          "h100-sxm5-80gb": {
            "count": 1
          }
        },
        "vcpu_count": 4,
        "ram_gb": 16,
        "storage_gb": 40
      },
      "operating_system": "Ubuntu 20.04 LTS",
      "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",
      "port_forwards": [
        {
          "internal_port": 22,
          "external_port": 20040
        }
      ],
      "timestamp_creation": "2025-04-03T02:18:24.275Z"
    }
  ],
  "total_result_count": 1,
  "has_previous": true,
  "has_next": true
}

Successful Response

Details for a specific unterminated virtual machine

get

Authorizations

apiTokenAuthstorefrontBearerAuthlegacySessionAuth

Path parameters

virtual_machine_idstring · uuidrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/virtual-machines/{virtual_machine_id}' \
  --header 'x-api-token: YOUR_API_KEY'

200

404

422

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "hostnode_id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "ondem",
  "status": "Running",
  "name": "text",
  "resources": {
    "gpus": {
      "h100-sxm5-80gb": {
        "count": 1
      }
    },
    "vcpu_count": 4,
    "ram_gb": 16,
    "storage_gb": 40
  },
  "operating_system": "Ubuntu 20.04 LTS",
  "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",
  "port_forwards": [
    {
      "internal_port": 22,
      "external_port": 20040
    }
  ],
  "timestamp_creation": "2025-04-03T02:18:24.275Z"
}

Successful Response

Terminate an existing virtual machine

delete

Authorizations

apiTokenAuthstorefrontBearerAuthlegacySessionAuth

Path parameters

virtual_machine_idstring · uuidrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v1/virtual-machines/{virtual_machine_id}' \
  --header 'x-api-token: YOUR_API_KEY'

202

400

422

202

No body

Successful Response

Start or stop a virtual machine

put

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

Authorizations

apiTokenAuthstorefrontBearerAuthlegacySessionAuth

Path parameters

virtual_machine_idstring · uuidrequired

Body

statusstring · enumrequired

Available options:

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v1/virtual-machines/{virtual_machine_id}/power-status' \
  --header 'x-api-token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "started"
  }'

200

422

200

{
  "status": "started"
}

Successful Response

List of available baremetal locations

get

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/bare-metal/locations'

200

200

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "gpu_count_ethernet": 8,
      "gpu_price_ethernet": 2.5,
      "gpu_count_infiniband": 8,
      "gpu_price_infiniband": 2.5,
      "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
      }
    }
  ],
  "total_result_count": 1,
  "has_previous": true,
  "has_next": true
}

Successful Response

Provision a new bare-metal server rental

post

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

Authorizations

apiTokenAuthstorefrontBearerAuthlegacySessionAuth

Body

location_idstring · uuidrequired

Example: a3111bd4-550a-47d0-838a-0a52bff2ae3f

gpu_countintegerrequired

namestringrequired

Example: My Baremetal Rental

organization_ssh_keysone of · default: {"mode":"none"}optional

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

ssh_keysstring[] · default: []optional

Extra SSH keys which will be added to this deploy only. To use SSH keys registered with your organization, see the organization_ssh_keys field.

Example: ["ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDAKOgHv82A6Oi7AWLvBC9N..."]

network_typestring · enumrequired

Machine networking: 3.2 Tbps Infiniband or 100 Gbps Ethernet

Example: infiniband

Available options:

sub_orderany ofoptional

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.

Example: 12345

storage_idany ofoptional

If a storage volume is specified, the machine will be deployed with the storage volume attached.

cloudinit_scriptany ofoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/bare-metal/' \
  --header 'x-api-token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "location_id": "a3111bd4-550a-47d0-838a-0a52bff2ae3f",
    "gpu_count": 1,
    "name": "My Baremetal Rental",
    "organization_ssh_keys": {
      "mode": "selective",
      "ssh_key_ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "ssh_keys": [
      "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDAKOgHv82A6Oi7AWLvBC9N..."
    ],
    "network_type": "infiniband",
    "sub_order": "12345",
    "storage_id": "123e4567-e89b-12d3-a456-426614174000",
    "cloudinit_script": {
      "packages": [
        "text"
      ],
      "write_files": [
        {
          "encoding": "text",
          "content": "text",
          "owner": "text",
          "path": "text",
          "permissions": "text"
        }
      ],
      "runcmd": [
        "text"
      ]
    }
  }'

201

400

422

201

{
  "rental_id": "123e4567-e89b-12d3-a456-426614174000",
  "warning": "text"
}

Successful Response

List of owned, unterminated baremetal machines

get

Authorizations

apiTokenAuthstorefrontBearerAuthlegacySessionAuth

Query parameters

limitany of · default: 20optional

offsetinteger · default: 0optional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/bare-metal/' \
  --header 'x-api-token: YOUR_API_KEY'

200

422

200

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "creation_timestamp": "2022-01-01T00:00:00Z",
      "status": "Running",
      "power_status": "Running",
      "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",
      "network_type": "infiniband",
      "username": "text",
      "node_networking": [
        {
          "public_ip": "68.25.82.82",
          "private_ip": "192.168.0.1"
        }
      ],
      "sub_order": "text",
      "storage_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "total_result_count": 1,
  "has_previous": true,
  "has_next": true
}

Successful Response

Start or stop the nodes in a baremetal rental

put

Authorizations

apiTokenAuthstorefrontBearerAuthlegacySessionAuth

Path parameters

baremetal_rental_idstring · uuidrequired

Body

statusstring · enumrequired

Available options:

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v1/bare-metal/{baremetal_rental_id}/power-status' \
  --header 'x-api-token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "started"
  }'

200

422

200

No body

Successful Response

Terminate a bare-metal rental

delete

Authorizations

apiTokenAuthstorefrontBearerAuthlegacySessionAuth

Path parameters

baremetal_rental_idstring · uuidrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v1/bare-metal/{baremetal_rental_id}' \
  --header 'x-api-token: YOUR_API_KEY'

202

400

422

202

No body

Successful Response

Modify baremetal rental name

patch

Authorizations

apiTokenAuthstorefrontBearerAuthlegacySessionAuth

Path parameters

baremetal_rental_idstring · uuidrequired

Body

namestringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/api/v1/bare-metal/{baremetal_rental_id}' \
  --header 'x-api-token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text"
  }'

200

400

422

200

{
  "name": "text"
}

Successful Response

Reboot specific nodes in a baremetal rental.

post

Reboot nodes in a baremetal rental, by providing a list of their public ips. This will cause the status of your rental to become Pending.

Authorizations

apiTokenAuthstorefrontBearerAuthlegacySessionAuth

Path parameters

baremetal_rental_idstring · uuidrequired

Body

public_ipsstring[]required

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/bare-metal/{baremetal_rental_id}/reboot' \
  --header 'x-api-token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "public_ips": [
      "text"
    ]
  }'

201

400

422

201

No body

Successful Response

Current rate for active rentals

get

Authorizations

apiTokenAuthstorefrontBearerAuthlegacySessionAuth

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/billing/hourly-rate' \
  --header 'x-api-token: YOUR_API_KEY'

200

200

{
  "rate_hourly": "2.500000"
}

Successful Response

Historical organization billing log

get

Authorizations

apiTokenAuthstorefrontBearerAuthlegacySessionAuth

Query parameters

limitinteger · min: 1 · default: 30optional

offsetinteger · default: 0optional

typesany ofoptional

Types of transactions to filter by.

earliestany ofoptional

Example: 2024-10-01

latestany ofoptional

Example: 2024-10-26

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/billing/transactions' \
  --header 'x-api-token: YOUR_API_KEY'

200

422

200

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "total_amount": "text",
      "timestamp_creation": "2025-04-03T02:18:24.275Z",
      "timestamp_completion": "2025-04-03T02:18:24.275Z",
      "details": {
        "type": "charge",
        "linked_instance": {
          "type": "virtual_machine_instance",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "virtual_machine_id": "123e4567-e89b-12d3-a456-426614174000",
          "timestamp_creation": "2025-04-03T02:18:24.275Z",
          "timestamp_deletion": "2025-04-03T02:18:24.275Z"
        }
      },
      "period_amount": "text"
    }
  ],
  "total_result_count": 1,
  "has_previous": true,
  "has_next": true
}

Successful Response

Monthly billing log

get

Authorizations

apiTokenAuthstorefrontBearerAuthlegacySessionAuth

Path parameters

yearintegerrequired

Example: 2024

monthintegerrequired

Example: 10

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/billing/reports/{year}/{month}/transactions' \
  --header 'x-api-token: YOUR_API_KEY'

200

422

200

{
  "transactions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "total_amount": "text",
      "timestamp_creation": "2025-04-03T02:18:24.275Z",
      "timestamp_completion": "2025-04-03T02:18:24.275Z",
      "details": {
        "type": "charge",
        "linked_instance": {
          "type": "virtual_machine_instance",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "virtual_machine_id": "123e4567-e89b-12d3-a456-426614174000",
          "timestamp_creation": "2025-04-03T02:18:24.275Z",
          "timestamp_deletion": "2025-04-03T02:18:24.275Z"
        }
      },
      "period_amount": "text"
    }
  ],
  "balance_at_period_start": "text",
  "balance_delta_in_period": "text",
  "balance_at_period_end": "text"
}

Successful Response

validate a cloud init script

post

Body

typestring · enumrequired

Available options:

contentany ofrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/validate/cloudinit' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "instant-vm",
    "content": "text"
  }'

200

422

200

{
  "error": true,
  "message": "text"
}

Successful Response