Sign in

v1

latestOpenAPI 3.0.32026-07-13122146291.9 KB
Machines

Get a machine

Gets the details of a bare-metal machine.

get/v1/projects/{projectId}/machines/{id}

Path parameters

projectIdstring required
idstring required

Response

A successful response.

architecturestring
commitmentTerm'COMMITMENT_TERM_NONE' | 'COMMITMENT_TERM_1_MONTH' | 'COMMITMENT_TERM_3_MONTHS' | 'COMMITMENT_TERM_6_MONTHS' | 'COMMITMENT_TERM_12_MONTHS' | 'COMMITMENT_TERM_24_MONTHS' | 'COMMITMENT_TERM_36_MONTHS' | 'COMMITMENT_TERM_60_MONTHS'
cpuCoresinteger
cpuModelstring
cpuSpeedMhzinteger
createBystring
createTimestring date-time
customSshKeysstring[]
dataCenterIdstring required
diskSizeGibinteger
disksinteger
externalIpAddressesstring[]
gpuModelIdstring
gpusinteger
hostnamestring
idstring required
machineTypeIdstring required
memoryGibinteger
osstring required
powerState'MACHINE_POWER_STATE_UNSPECIFIED' | 'ON' | 'OFF' | 'POWERING_ON' | 'POWERING_OFF' | 'REBOOTING'
projectIdstring required
sshKeySource'SSH_KEY_SOURCE_UNKNOWN' | 'SSH_KEY_SOURCE_PROJECT' | 'SSH_KEY_SOURCE_USER' | 'SSH_KEY_SOURCE_NONE'
startScriptstring
state'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'DEPLOYING' | 'DELETING' | 'FAILED' | 'UPDATING'
userDatastring

DEPRECATED: use startScript to run a script on boot, and sshKeySource or customSshKeys to set authorized ssh keys