Skip to main content
POST
Create a virtual machine rental

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
gpuCount
number
required
networkType
enum<string>
default:ethernet
Available options:
infiniband,
ethernet
region
enum<string>
default:us-central-1
Available options:
us-central-1,
us-central-2,
eu-north-2,
eu-west-2,
eu-north-4,
eu-north-5,
us-east-1,
us-east-2,
ca-east-3,
eu-north-6,
eu-north-7,
eu-north-8,
eu-north-9,
ca-west-1,
ca-east-1,
us-central-3,
us-southeast-1,
me-central-1,
ca-east-2,
eu-west-1,
us-southeast-2,
jp-east-1,
us-southeast-3,
eu-west-5,
us-east-3
gpuType
enum<string>
default:h100
Available options:
h100,
h200,
b200,
rtx-6000-pro
label
string
termType
enum<string>
default:on-demand
Available options:
on-demand,
reserved
termPeriodDays
integer

Any whole number of days from 1 to 30 where custom reservation lengths are enabled for your account; otherwise one of the standard terms in options from GET /v2/on-demand/reserve-options.

Required range: 1 <= x <= 30
discountPercentage
number
default:0
convertToOnDemandOnExpiry
boolean
default:true
monitoringEnabled
boolean
monitoringOptOut
boolean

Opt the rental out of Hyperbolic telemetry: the GPU health and system metrics (CPU, memory, root filesystem, network interfaces) Hyperbolic collects from inside the virtual machine to detect hardware faults. No logs, process lists or file contents are collected. Omitted or false leaves collection on. Only standalone virtual machine rentals in supported regions can opt out; elsewhere true gets a 400.

customPorts
integer[]
Maximum array length: 20
Required range: 1 <= x <= 65535
sshPublicKeyId
integer
Required range: -9007199254740991 <= x <= 9007199254740991
sshPublicKeyIds
integer[]
Minimum array length: 1
Required range: -9007199254740991 <= x <= 9007199254740991

Response

Successful response

A GPU rental.

rentalId
string
required
name
string | null
required
label
string | null
required
rentalType
enum<string>
required
Available options:
virtual-machine,
bare-metal
region
enum<string>
required
Available options:
us-central-1,
us-central-2,
eu-north-2,
eu-west-2,
eu-north-4,
eu-north-5,
us-east-1,
us-east-2,
ca-east-3,
eu-north-6,
eu-north-7,
eu-north-8,
eu-north-9,
ca-west-1,
ca-east-1,
us-central-3,
us-southeast-1,
me-central-1,
ca-east-2,
eu-west-1,
us-southeast-2,
jp-east-1,
us-southeast-3,
eu-west-5,
us-east-3,
uk-central-3,
uk-southeast-3,
eu-southwest-3,
eu-southwest-3-1,
eu-west-3,
eu-west-4,
private-cloud
gpuType
enum<string>
required
Available options:
h100,
h200,
b200,
rtx-6000-pro
gpuCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
gpuFormFactor
enum<string>
required
Available options:
sxm5,
sxm6,
pcie
connectionType
enum<string>
required
Available options:
infiniband,
ethernet
ethernetVariant
enum<string> | null
required
Available options:
normal,
rocev2
nodes
object[]
required
sshEndpoints
object[]
required
networkInterfaces
object[]
required
portMappings
object[]
required
supportsPortForwarding
boolean
required
exposedPorts
number[]
required
supportsCustomPorts
boolean
required
supportsMultipleSshKeys
boolean
required
supportsSshKeyUpdates
boolean
required
attachedStorage
object[]
required
supportsAttachedStorage
boolean
required
monitoringEnabled
boolean
required
convertToOnDemandOnExpiry
boolean | null
required
terminationReason
string | null
required
currentTerm
object
required
createdAt
string<date-time>
required
Example:

"2025-01-31T12:00:00.000Z"

updatedAt
string<date-time> | null
required
Example:

"2025-01-31T12:00:00.000Z"

startedAt
string<date-time> | null
required
Example:

"2025-01-31T12:00:00.000Z"

terminatedAt
string<date-time> | null
required
Example:

"2025-01-31T12:00:00.000Z"

userId
string
required
orgId
string | null
required
createdBy
object
required

The user who created a rental.

privateCluster
object | null
required

The topology of a dedicated private cluster.

managedCluster
object | null
required

The managed Kubernetes cluster a rental is a node pool of.