curl --request PATCH \
--url https://rest.compute.cudo.org/v1/projects/{projectId}/machines/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"dataCenterId": "<string>",
"machineTypeId": "<string>",
"os": "<string>",
"commitmentTerm": "COMMITMENT_TERM_NONE",
"customSshKeys": [
"<string>"
],
"powerState": "MACHINE_POWER_STATE_UNSPECIFIED",
"priceHr": {
"value": "<string>"
},
"sshKeySource": "SSH_KEY_SOURCE_UNKNOWN",
"startScript": "<string>",
"state": "STATE_UNSPECIFIED",
"userData": "<string>"
}
'import requests
url = "https://rest.compute.cudo.org/v1/projects/{projectId}/machines/{id}"
payload = {
"dataCenterId": "<string>",
"machineTypeId": "<string>",
"os": "<string>",
"commitmentTerm": "COMMITMENT_TERM_NONE",
"customSshKeys": ["<string>"],
"powerState": "MACHINE_POWER_STATE_UNSPECIFIED",
"priceHr": { "value": "<string>" },
"sshKeySource": "SSH_KEY_SOURCE_UNKNOWN",
"startScript": "<string>",
"state": "STATE_UNSPECIFIED",
"userData": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dataCenterId: '<string>',
machineTypeId: '<string>',
os: '<string>',
commitmentTerm: 'COMMITMENT_TERM_NONE',
customSshKeys: ['<string>'],
powerState: 'MACHINE_POWER_STATE_UNSPECIFIED',
priceHr: {value: '<string>'},
sshKeySource: 'SSH_KEY_SOURCE_UNKNOWN',
startScript: '<string>',
state: 'STATE_UNSPECIFIED',
userData: '<string>'
})
};
fetch('https://rest.compute.cudo.org/v1/projects/{projectId}/machines/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://rest.compute.cudo.org/v1/projects/{projectId}/machines/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'dataCenterId' => '<string>',
'machineTypeId' => '<string>',
'os' => '<string>',
'commitmentTerm' => 'COMMITMENT_TERM_NONE',
'customSshKeys' => [
'<string>'
],
'powerState' => 'MACHINE_POWER_STATE_UNSPECIFIED',
'priceHr' => [
'value' => '<string>'
],
'sshKeySource' => 'SSH_KEY_SOURCE_UNKNOWN',
'startScript' => '<string>',
'state' => 'STATE_UNSPECIFIED',
'userData' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://rest.compute.cudo.org/v1/projects/{projectId}/machines/{id}"
payload := strings.NewReader("{\n \"dataCenterId\": \"<string>\",\n \"machineTypeId\": \"<string>\",\n \"os\": \"<string>\",\n \"commitmentTerm\": \"COMMITMENT_TERM_NONE\",\n \"customSshKeys\": [\n \"<string>\"\n ],\n \"powerState\": \"MACHINE_POWER_STATE_UNSPECIFIED\",\n \"priceHr\": {\n \"value\": \"<string>\"\n },\n \"sshKeySource\": \"SSH_KEY_SOURCE_UNKNOWN\",\n \"startScript\": \"<string>\",\n \"state\": \"STATE_UNSPECIFIED\",\n \"userData\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://rest.compute.cudo.org/v1/projects/{projectId}/machines/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dataCenterId\": \"<string>\",\n \"machineTypeId\": \"<string>\",\n \"os\": \"<string>\",\n \"commitmentTerm\": \"COMMITMENT_TERM_NONE\",\n \"customSshKeys\": [\n \"<string>\"\n ],\n \"powerState\": \"MACHINE_POWER_STATE_UNSPECIFIED\",\n \"priceHr\": {\n \"value\": \"<string>\"\n },\n \"sshKeySource\": \"SSH_KEY_SOURCE_UNKNOWN\",\n \"startScript\": \"<string>\",\n \"state\": \"STATE_UNSPECIFIED\",\n \"userData\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.compute.cudo.org/v1/projects/{projectId}/machines/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dataCenterId\": \"<string>\",\n \"machineTypeId\": \"<string>\",\n \"os\": \"<string>\",\n \"commitmentTerm\": \"COMMITMENT_TERM_NONE\",\n \"customSshKeys\": [\n \"<string>\"\n ],\n \"powerState\": \"MACHINE_POWER_STATE_UNSPECIFIED\",\n \"priceHr\": {\n \"value\": \"<string>\"\n },\n \"sshKeySource\": \"SSH_KEY_SOURCE_UNKNOWN\",\n \"startScript\": \"<string>\",\n \"state\": \"STATE_UNSPECIFIED\",\n \"userData\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"dataCenterId": "<string>",
"id": "<string>",
"machineTypeId": "<string>",
"os": "<string>",
"projectId": "<string>",
"architecture": "<string>",
"commitmentTerm": "COMMITMENT_TERM_NONE",
"cpuCores": 123,
"cpuModel": "<string>",
"cpuSpeedMhz": 123,
"createBy": "<string>",
"createTime": "2023-11-07T05:31:56Z",
"customSshKeys": [
"<string>"
],
"diskSizeGib": 123,
"disks": 123,
"externalIpAddresses": [
"<string>"
],
"gpuModelId": "<string>",
"gpus": 123,
"hostname": "<string>",
"memoryGib": 123,
"powerState": "MACHINE_POWER_STATE_UNSPECIFIED",
"priceHr": {
"value": "<string>"
},
"sshKeySource": "SSH_KEY_SOURCE_UNKNOWN",
"startScript": "<string>",
"state": "STATE_UNSPECIFIED",
"userData": "<string>"
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}Update a machine
Updates a bare-metal machine.
curl --request PATCH \
--url https://rest.compute.cudo.org/v1/projects/{projectId}/machines/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"dataCenterId": "<string>",
"machineTypeId": "<string>",
"os": "<string>",
"commitmentTerm": "COMMITMENT_TERM_NONE",
"customSshKeys": [
"<string>"
],
"powerState": "MACHINE_POWER_STATE_UNSPECIFIED",
"priceHr": {
"value": "<string>"
},
"sshKeySource": "SSH_KEY_SOURCE_UNKNOWN",
"startScript": "<string>",
"state": "STATE_UNSPECIFIED",
"userData": "<string>"
}
'import requests
url = "https://rest.compute.cudo.org/v1/projects/{projectId}/machines/{id}"
payload = {
"dataCenterId": "<string>",
"machineTypeId": "<string>",
"os": "<string>",
"commitmentTerm": "COMMITMENT_TERM_NONE",
"customSshKeys": ["<string>"],
"powerState": "MACHINE_POWER_STATE_UNSPECIFIED",
"priceHr": { "value": "<string>" },
"sshKeySource": "SSH_KEY_SOURCE_UNKNOWN",
"startScript": "<string>",
"state": "STATE_UNSPECIFIED",
"userData": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dataCenterId: '<string>',
machineTypeId: '<string>',
os: '<string>',
commitmentTerm: 'COMMITMENT_TERM_NONE',
customSshKeys: ['<string>'],
powerState: 'MACHINE_POWER_STATE_UNSPECIFIED',
priceHr: {value: '<string>'},
sshKeySource: 'SSH_KEY_SOURCE_UNKNOWN',
startScript: '<string>',
state: 'STATE_UNSPECIFIED',
userData: '<string>'
})
};
fetch('https://rest.compute.cudo.org/v1/projects/{projectId}/machines/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://rest.compute.cudo.org/v1/projects/{projectId}/machines/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'dataCenterId' => '<string>',
'machineTypeId' => '<string>',
'os' => '<string>',
'commitmentTerm' => 'COMMITMENT_TERM_NONE',
'customSshKeys' => [
'<string>'
],
'powerState' => 'MACHINE_POWER_STATE_UNSPECIFIED',
'priceHr' => [
'value' => '<string>'
],
'sshKeySource' => 'SSH_KEY_SOURCE_UNKNOWN',
'startScript' => '<string>',
'state' => 'STATE_UNSPECIFIED',
'userData' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://rest.compute.cudo.org/v1/projects/{projectId}/machines/{id}"
payload := strings.NewReader("{\n \"dataCenterId\": \"<string>\",\n \"machineTypeId\": \"<string>\",\n \"os\": \"<string>\",\n \"commitmentTerm\": \"COMMITMENT_TERM_NONE\",\n \"customSshKeys\": [\n \"<string>\"\n ],\n \"powerState\": \"MACHINE_POWER_STATE_UNSPECIFIED\",\n \"priceHr\": {\n \"value\": \"<string>\"\n },\n \"sshKeySource\": \"SSH_KEY_SOURCE_UNKNOWN\",\n \"startScript\": \"<string>\",\n \"state\": \"STATE_UNSPECIFIED\",\n \"userData\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://rest.compute.cudo.org/v1/projects/{projectId}/machines/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dataCenterId\": \"<string>\",\n \"machineTypeId\": \"<string>\",\n \"os\": \"<string>\",\n \"commitmentTerm\": \"COMMITMENT_TERM_NONE\",\n \"customSshKeys\": [\n \"<string>\"\n ],\n \"powerState\": \"MACHINE_POWER_STATE_UNSPECIFIED\",\n \"priceHr\": {\n \"value\": \"<string>\"\n },\n \"sshKeySource\": \"SSH_KEY_SOURCE_UNKNOWN\",\n \"startScript\": \"<string>\",\n \"state\": \"STATE_UNSPECIFIED\",\n \"userData\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.compute.cudo.org/v1/projects/{projectId}/machines/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dataCenterId\": \"<string>\",\n \"machineTypeId\": \"<string>\",\n \"os\": \"<string>\",\n \"commitmentTerm\": \"COMMITMENT_TERM_NONE\",\n \"customSshKeys\": [\n \"<string>\"\n ],\n \"powerState\": \"MACHINE_POWER_STATE_UNSPECIFIED\",\n \"priceHr\": {\n \"value\": \"<string>\"\n },\n \"sshKeySource\": \"SSH_KEY_SOURCE_UNKNOWN\",\n \"startScript\": \"<string>\",\n \"state\": \"STATE_UNSPECIFIED\",\n \"userData\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"dataCenterId": "<string>",
"id": "<string>",
"machineTypeId": "<string>",
"os": "<string>",
"projectId": "<string>",
"architecture": "<string>",
"commitmentTerm": "COMMITMENT_TERM_NONE",
"cpuCores": 123,
"cpuModel": "<string>",
"cpuSpeedMhz": 123,
"createBy": "<string>",
"createTime": "2023-11-07T05:31:56Z",
"customSshKeys": [
"<string>"
],
"diskSizeGib": 123,
"disks": 123,
"externalIpAddresses": [
"<string>"
],
"gpuModelId": "<string>",
"gpus": 123,
"hostname": "<string>",
"memoryGib": 123,
"powerState": "MACHINE_POWER_STATE_UNSPECIFIED",
"priceHr": {
"value": "<string>"
},
"sshKeySource": "SSH_KEY_SOURCE_UNKNOWN",
"startScript": "<string>",
"state": "STATE_UNSPECIFIED",
"userData": "<string>"
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}Authorizations
API key authentication. API keys should be passed using the format Bearer API_KEY.
Body
Update machine params
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 MACHINE_POWER_STATE_UNSPECIFIED, ON, OFF, POWERING_ON, POWERING_OFF, REBOOTING A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.
Show child attributes
Show child attributes
SSH_KEY_SOURCE_UNKNOWN, SSH_KEY_SOURCE_PROJECT, SSH_KEY_SOURCE_USER, SSH_KEY_SOURCE_NONE STATE_UNSPECIFIED, CREATING, ACTIVE, DEPLOYING, DELETING, FAILED, UPDATING DEPRECATED: use startScript to run a script on boot, and sshKeySource or customSshKeys to set authorized ssh keys
Response
A successful response.
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 MACHINE_POWER_STATE_UNSPECIFIED, ON, OFF, POWERING_ON, POWERING_OFF, REBOOTING A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.
Show child attributes
Show child attributes
SSH_KEY_SOURCE_UNKNOWN, SSH_KEY_SOURCE_PROJECT, SSH_KEY_SOURCE_USER, SSH_KEY_SOURCE_NONE STATE_UNSPECIFIED, CREATING, ACTIVE, DEPLOYING, DELETING, FAILED, UPDATING DEPRECATED: use startScript to run a script on boot, and sshKeySource or customSshKeys to set authorized ssh keys