Bare metal

Explore this section for comprehensive information on endpoints related to the deployment, management, and operation of Bare Metal within our cloud software API environment.

Get a list of metal hosts

GET/api/v1/servers/metal/GetHosts

Query parameters

Response

200400401403500

Success

Body

text/plainapplication/jsontext/json

idnullable string

clusternullable string

hostTypenullable string

usernamenullable string

tenancyNamenullable string

gpuTypenullable string

gpusinteger (int32)

vcpusinteger (int32)

vcpuTypenullable string

memoryinteger (int32)

ipnullable string

privateIpnullable string

imageIdnullable string

imagenullable string

storageinteger (int32)

storageClassnullable string

vpcIdnullable string

reservationnullable string

reservationExpirynullable string

statusnullable string

Request

JavaScriptCurl

const response = await fetch('/api/v1/servers/metal/GetHosts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "cluster": "text",
  "hostType": "text",
  "username": "text",
  "tenancyName": "text",
  "gpuType": "text",
  "vcpuType": "text",
  "ip": "text",
  "privateIp": "text",
  "imageId": "text",
  "image": "text",
  "storageClass": "text",
  "vpcId": "text",
  "reservation": "text",
  "reservationExpiry": "text",
  "status": "text"
}

Get detailed information about a specific metal host

GET/api/v1/servers/metal/GetHost

Query parameters

Response

200400401403500

Success

Body

text/plainapplication/jsontext/json

idnullable string

clusternullable string

hostTypenullable string

usernamenullable string

tenancyNamenullable string

gpuTypenullable string

gpusinteger (int32)

vcpusinteger (int32)

vcpuTypenullable string

memoryinteger (int32)

ipnullable string

privateIpnullable string

imageIdnullable string

imagenullable string

storageinteger (int32)

storageClassnullable string

vpcIdnullable string

reservationnullable string

reservationExpirynullable string

statusnullable string

Request

JavaScriptCurl

const response = await fetch('/api/v1/servers/metal/GetHost', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "cluster": "text",
  "hostType": "text",
  "username": "text",
  "tenancyName": "text",
  "gpuType": "text",
  "vcpuType": "text",
  "ip": "text",
  "privateIp": "text",
  "imageId": "text",
  "image": "text",
  "storageClass": "text",
  "vpcId": "text",
  "reservation": "text",
  "reservationExpiry": "text",
  "status": "text"
}

Add metal host to VPC

POST/api/v1/servers/metal/AddHostVpc

Body

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

id*string

cluster*string

vpcId*string

Response

202400401403500

Accepted

Body

text/plainapplication/jsontext/json

idnullable string

clusternullable string

hostTypenullable string

usernamenullable string

tenancyNamenullable string

gpuTypenullable string

gpusinteger (int32)

vcpusinteger (int32)

vcpuTypenullable string

memoryinteger (int32)

ipnullable string

privateIpnullable string

imageIdnullable string

imagenullable string

storageinteger (int32)

storageClassnullable string

vpcIdnullable string

reservationnullable string

reservationExpirynullable string

statusnullable string

Request

JavaScriptCurl

const response = await fetch('/api/v1/servers/metal/AddHostVpc', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({
      "cluster": "text",
      "id": "text",
      "vpcId": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "cluster": "text",
  "hostType": "text",
  "username": "text",
  "tenancyName": "text",
  "gpuType": "text",
  "vcpuType": "text",
  "ip": "text",
  "privateIp": "text",
  "imageId": "text",
  "image": "text",
  "storageClass": "text",
  "vpcId": "text",
  "reservation": "text",
  "reservationExpiry": "text",
  "status": "text"
}

Remove metal host from VPC

POST/api/v1/servers/metal/RemoveHostVpc

Body

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

id*string

cluster*string

vpcId*string

Response

202400401403500

Accepted

Body

text/plainapplication/jsontext/json

idnullable string

clusternullable string

hostTypenullable string

usernamenullable string

tenancyNamenullable string

gpuTypenullable string

gpusinteger (int32)

vcpusinteger (int32)

vcpuTypenullable string

memoryinteger (int32)

ipnullable string

privateIpnullable string

imageIdnullable string

imagenullable string

storageinteger (int32)

storageClassnullable string

vpcIdnullable string

reservationnullable string

reservationExpirynullable string

statusnullable string

Request

JavaScriptCurl

const response = await fetch('/api/v1/servers/metal/RemoveHostVpc', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({
      "cluster": "text",
      "id": "text",
      "vpcId": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "cluster": "text",
  "hostType": "text",
  "username": "text",
  "tenancyName": "text",
  "gpuType": "text",
  "vcpuType": "text",
  "ip": "text",
  "privateIp": "text",
  "imageId": "text",
  "image": "text",
  "storageClass": "text",
  "vpcId": "text",
  "reservation": "text",
  "reservationExpiry": "text",
  "status": "text"
}

Reboot the metal host

POST/api/v1/servers/metal/RebootHost

Body

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

id*string

cluster*string

Response

202400401403500

Accepted

Body

text/plainapplication/jsontext/json

idnullable string

clusternullable string

hostTypenullable string

usernamenullable string

tenancyNamenullable string

gpuTypenullable string

gpusinteger (int32)

vcpusinteger (int32)

vcpuTypenullable string

memoryinteger (int32)

ipnullable string

privateIpnullable string

imageIdnullable string

imagenullable string

storageinteger (int32)

storageClassnullable string

vpcIdnullable string

reservationnullable string

reservationExpirynullable string

statusnullable string

Request

JavaScriptCurl

const response = await fetch('/api/v1/servers/metal/RebootHost', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({
      "cluster": "text",
      "id": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "cluster": "text",
  "hostType": "text",
  "username": "text",
  "tenancyName": "text",
  "gpuType": "text",
  "vcpuType": "text",
  "ip": "text",
  "privateIp": "text",
  "imageId": "text",
  "image": "text",
  "storageClass": "text",
  "vpcId": "text",
  "reservation": "text",
  "reservationExpiry": "text",
  "status": "text"
}