Get a Specific Host

get https://{serverURL}/api/servers/{id}

This endpoint retrieves a specific host.

Responses

Response body

object

server

object

id

int64

uuid

string

externalId

string | null

internalId

string | null

externalUniqueId

string | null

name

string

externalName

string

hostname

string

parentServer

object

accountId

int64

account

object

owner

object | null

zone

object

plan

object

computeServerType

object

visibility

string

description

string | null

zoneId

int64

siteId

int64

resourcePoolId

int64 | null

folderId

int64 | null

sshHost

string | null

sshPort

int64

externalIp

string | null

internalIp

string | null

volumeId

string | null

platform

string | null

platformVersion

string | null

sshUsername

string | null

sshPassword

string | null

sshPasswordHash

string | null

sshKeyPair

object | null

osDevice

string

osType

string

dataDevice

string

lvmEnabled

boolean

apiKey

string

softwareRaid

boolean

dateCreated

date-time

lastUpdated

date-time

stats

object

status

string

statusMessage

string | null

errorMessage

string | null

statusDate

date-time | null

statusPercent

string | null

statusEta

string | null

powerState

string

agentInstalled

boolean

lastAgentUpdate

string | null

agentVersion

string | null

maxCores

int64

coresPerSocket

int64 | null

maxMemory

int64

maxStorage

int64

maxCpu

int64 | null

maxGpus

int64 | null

manageInternalFirewall

boolean

enableLogs

boolean

hourlyCost

number

hourlyPrice

number

sourceImage

object | null

serverOs

object | null

volumes

array of objects

volumes

object

id

int64

name

string

controllerId

int64 | null

controllerMountPoint

string | null

resizeable

boolean

planResizable

boolean

rootVolume

boolean

unitNumber

string | null

typeId

int64

configurableIOPS

boolean

datastoreId

int64 | null

maxStorage

int64

displayOrder

int64

maxIOPS

string | null

uuid

string

uniqueId

string | null

externalId

string | null

internalId

string | null

controllers

array of objects

controllers

object

id

int64

name

string

type

object

maxDevices

int64

reservedUnitNumber

int64

interfaces

array of objects

interfaces

object

id

int64

refType

string | null

refId

string | null

name

string

internalId

string | null

externalId

string | null

uniqueId

string | null

publicIpAddress

string | null

publicIpv6Address

string | null

ipAddress

string

ipv6Address

string | null

ipSubnet

string | null

ipv6Subnet

string | null

description

string | null

dhcp

boolean

active

boolean

poolAssigned

boolean

primaryInterface

boolean

network

object

subnet

string | null

networkGroup

string | null

networkPosition

string | null

networkPool

object | null

networkDomain

string | null

type

object | null

ipMode

string | null

macAddress

string | null

labels

array of objects | null

labels

object

tags

array of objects | null

tags

object

enabled

boolean

tagCompliant

string | null

containers

array of int64s

containers

config

object

guestConsolePreferred

boolean

guestConsoleType

string | null

guestConsoleUsername

string | null

guestConsolePassword

string | null

guestConsolePasswordHash

string | null

guestConsolePort

string | null

stats

object

Has additional fields

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://changeme/api/servers/id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json