v1

latestOpenAPI 3.0.02026-07-26258182277.4 KB

Bare Metal Devices

Get all devices

get/bare-metal-devices/

Headers

X-Fieldsstring mask

An optional fields mask

Response

Devices found successfuly

appNamestring

If device was deployed with as an application, this is the name of the application used.

customIPXEScriptContentsstring

Contents of custom iPXE used to provision device

customIPXEScriptURLstring

URL of custom iPXE script used to provision device

deviceIdinteger

The unique ID of the device.

hostnamestring

The user specified hostname for the device. Note: If the hostname is changed in the portal or on the device itself this value may not reflect the actual hostname on the device.

locationNamestring

A facility code. For example NYC1.

orderIdinteger

The unique ID of the order for this device.

osNamestring

The name of the operating system currently installed on this device. Note: If you manually reload your own OS over IPMI this value may not reflect the OS currently on your device.

periodstring

This device's service's billing period.

powerStatusstring

ON|OFF

primaryIpstring

The first assigned public IP for accessing this device.

productIdinteger

The unique ID of the product associated with this device.

productNamestring

The name of the product associated with this device.

publicSshKeyIdinteger

scriptstring

The post-install/cloud-init script used during this device's last provisioning.

serviceIdinteger

The unique ID of the service associated with this device.

tagsstring[]

User specified values.

vlanIdinteger

Example response

[
  {
    "period": "hourly"
  }
]