Bare metal

Explore this section for detailed information on endpoints related to the management and operation of bare metal servers within our cloud software API environment.

Get detailed information about a specific metal host

get

Query parameters

IdstringRequired

Unique identifier for a resource within the cluster

ClusterstringRequired

The cluster you're operating on

Example: Hou1

Responses

200

Success

text/plainapplication/jsontext/json

idstring · nullableOptional

The bare metal id, unique identifier

Example: denvrbm-128

clusterstring · nullableOptional

The cluster where the bare metal host is allocated

Example: Msc1

tenancyNamestring · nullableOptional

Name of the tenant where the node has been allocated

Example: denvr

nodeTypestring · nullableOptional

The specific host node type

Example: NVIDIA_H100_SXM5_80GB

imagestring · nullableOptional

The image used to provision the host

Example: jammy-server-cloudimg-amd64

privateIpstring · nullableOptional

private IP address of the host

Example: admin

publicIpstring · nullableOptional

public IP address of the host

Example: 123.45.67.89

provisionedHostnamestring · nullableOptional

host name provisioned by the system

operationalStatusstring · nullableOptional

operational status of the host

Example: OK

poweredOnbooleanOptional

true if the host is powered on

provisioningStatestring · nullableOptional

provisioning status of the host

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

get

/api/v1/servers/metal/GetHost

HTTPcURLJavaScriptPython

GET /api/v1/servers/metal/GetHost?Id=text&Cluster=Hou1 HTTP/1.1
Accept: */*

{
  "id": "denvrbm-128",
  "cluster": "Msc1",
  "tenancyName": "denvr",
  "nodeType": "NVIDIA_H100_SXM5_80GB",
  "image": "jammy-server-cloudimg-amd64",
  "privateIp": "admin",
  "publicIp": "123.45.67.89",
  "provisionedHostname": "text",
  "operationalStatus": "OK",
  "poweredOn": true,
  "provisioningState": "text"
}

Get a list of bare metal hosts in a cluster

get

Query parameters

ClusterstringOptionalExample: Hou1

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

get

/api/v1/servers/metal/GetHosts

HTTPcURLJavaScriptPython

GET /api/v1/servers/metal/GetHosts HTTP/1.1
Accept: */*

{
  "items": [
    {
      "id": "denvrbm-128",
      "cluster": "Msc1",
      "tenancyName": "denvr",
      "nodeType": "NVIDIA_H100_SXM5_80GB",
      "image": "jammy-server-cloudimg-amd64",
      "privateIp": "admin",
      "publicIp": "123.45.67.89",
      "provisionedHostname": "text",
      "operationalStatus": "OK",
      "poweredOn": true,
      "provisioningState": "text"
    }
  ]
}

Reboot the bare metal host

post

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

idstring · min: 1Required

Unique identifier for a resource within the cluster

clusterstring · min: 1Required

The cluster you're operating on

Example: Hou1

Responses

200

Success

text/plainapplication/jsontext/json

idstring · nullableOptional

The bare metal id, unique identifier

Example: denvrbm-128

clusterstring · nullableOptional

The cluster where the bare metal host is allocated

Example: Msc1

tenancyNamestring · nullableOptional

Name of the tenant where the node has been allocated

Example: denvr

nodeTypestring · nullableOptional

The specific host node type

Example: NVIDIA_H100_SXM5_80GB

imagestring · nullableOptional

The image used to provision the host

Example: jammy-server-cloudimg-amd64

privateIpstring · nullableOptional

private IP address of the host

Example: admin

publicIpstring · nullableOptional

public IP address of the host

Example: 123.45.67.89

provisionedHostnamestring · nullableOptional

host name provisioned by the system

operationalStatusstring · nullableOptional

operational status of the host

Example: OK

poweredOnbooleanOptional

true if the host is powered on

provisioningStatestring · nullableOptional

provisioning status of the host

400

Bad Request

401

Unauthorized

403

Forbidden

422

Client Error

500

Server Error

post

/api/v1/servers/metal/RebootHost

HTTPcURLJavaScriptPython

POST /api/v1/servers/metal/RebootHost HTTP/1.1
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 30

{
  "id": "text",
  "cluster": "Hou1"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "id": "denvrbm-128",
  "cluster": "Msc1",
  "tenancyName": "denvr",
  "nodeType": "NVIDIA_H100_SXM5_80GB",
  "image": "jammy-server-cloudimg-amd64",
  "privateIp": "admin",
  "publicIp": "123.45.67.89",
  "provisionedHostname": "text",
  "operationalStatus": "OK",
  "poweredOn": true,
  "provisioningState": "text"
}

Reprovision the bare metal host

post

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

imageUrlstring · nullableOptional

The URL to the image to use for the host

Example: https://cloud-images.ubuntu.com/jammy/current/jammy-server-cloudimg-amd64.img

imageChecksumstring · nullableOptional

The checksum url of the image to use for the host

Example: https://cloud-images.ubuntu.com/jammy/current/MD5SUMS

cloudInitBase64string · nullableOptional

Base64 encoded cloud-init data yaml file to use for the host

Example: SGVsbG8sIFdvcmxkIQ==

idstring · min: 1Required

Unique identifier for a resource within the cluster

clusterstring · min: 1Required

The cluster you're operating on

Example: Hou1

Responses

200

Success

text/plainapplication/jsontext/json

idstring · nullableOptional

The bare metal id, unique identifier

Example: denvrbm-128

clusterstring · nullableOptional

The cluster where the bare metal host is allocated

Example: Msc1

tenancyNamestring · nullableOptional

Name of the tenant where the node has been allocated

Example: denvr

nodeTypestring · nullableOptional

The specific host node type

Example: NVIDIA_H100_SXM5_80GB

imagestring · nullableOptional

The image used to provision the host

Example: jammy-server-cloudimg-amd64

privateIpstring · nullableOptional

private IP address of the host

Example: admin

publicIpstring · nullableOptional

public IP address of the host

Example: 123.45.67.89

provisionedHostnamestring · nullableOptional

host name provisioned by the system

operationalStatusstring · nullableOptional

operational status of the host

Example: OK

poweredOnbooleanOptional

true if the host is powered on

provisioningStatestring · nullableOptional

provisioning status of the host

400

Bad Request

401

Unauthorized

403

Forbidden

422

Client Error

500

Server Error

post

/api/v1/servers/metal/ReprovisionHost

HTTPcURLJavaScriptPython

POST /api/v1/servers/metal/ReprovisionHost HTTP/1.1
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 234

{
  "imageUrl": "https://cloud-images.ubuntu.com/jammy/current/jammy-server-cloudimg-amd64.img",
  "imageChecksum": "https://cloud-images.ubuntu.com/jammy/current/MD5SUMS",
  "cloudInitBase64": "SGVsbG8sIFdvcmxkIQ==",
  "id": "text",
  "cluster": "Hou1"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "id": "denvrbm-128",
  "cluster": "Msc1",
  "tenancyName": "denvr",
  "nodeType": "NVIDIA_H100_SXM5_80GB",
  "image": "jammy-server-cloudimg-amd64",
  "privateIp": "admin",
  "publicIp": "123.45.67.89",
  "provisionedHostname": "text",
  "operationalStatus": "OK",
  "poweredOn": true,
  "provisioningState": "text"
}