Skip to main content
GET
Get a list of active bare metal rentals

Authorizations

Authorization
string
header
required

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

Response

Successful response

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,
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
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.

status
enum<string>
default:Unknown
required
Available options:
Failed,
Pending,
Rebooting,
Running,
Terminating,
Terminated,
Unknown
instances
object[]