Machines
Update Metadata (set/remove multiple keys)
Update multiple metadata keys at once. Keys that are not in the request are left untouched. Null values and empty strings remove keys.
- If
machine_versionis provided and no longer matches the current machine version, returns 412 Precondition Failed.
PATCH
/
v1
/
apps
/
{app_name}
/
machines
/
{machine_id}
/
metadata
Update Metadata (set/remove multiple keys)
curl --request PATCH \
--url https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/metadata \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"machine_version": "<string>",
"metadata": {},
"updated_at": "<string>"
}
'import requests
url = "https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/metadata"
payload = {
"machine_version": "<string>",
"metadata": {},
"updated_at": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({machine_version: '<string>', metadata: {}, updated_at: '<string>'})
};
fetch('https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/metadata', 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://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/metadata",
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([
'machine_version' => '<string>',
'metadata' => [
],
'updated_at' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/metadata"
payload := strings.NewReader("{\n \"machine_version\": \"<string>\",\n \"metadata\": {},\n \"updated_at\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/metadata")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"machine_version\": \"<string>\",\n \"metadata\": {},\n \"updated_at\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/metadata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"machine_version\": \"<string>\",\n \"metadata\": {},\n \"updated_at\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyThis response has no body data.{
"details": {},
"error": "<string>",
"status": "unknown"
}{
"details": {},
"error": "<string>",
"status": "unknown"
}Authorizations
A Fly API token with access to the requested organization or resource. Send it as Authorization: Bearer <Fly API token>.
Body
application/json
Update metadata request
Response
No Content
⌘I
Update Metadata (set/remove multiple keys)
curl --request PATCH \
--url https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/metadata \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"machine_version": "<string>",
"metadata": {},
"updated_at": "<string>"
}
'import requests
url = "https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/metadata"
payload = {
"machine_version": "<string>",
"metadata": {},
"updated_at": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({machine_version: '<string>', metadata: {}, updated_at: '<string>'})
};
fetch('https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/metadata', 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://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/metadata",
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([
'machine_version' => '<string>',
'metadata' => [
],
'updated_at' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/metadata"
payload := strings.NewReader("{\n \"machine_version\": \"<string>\",\n \"metadata\": {},\n \"updated_at\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/metadata")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"machine_version\": \"<string>\",\n \"metadata\": {},\n \"updated_at\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.machines.dev/v1/apps/{app_name}/machines/{machine_id}/metadata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"machine_version\": \"<string>\",\n \"metadata\": {},\n \"updated_at\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyThis response has no body data.{
"details": {},
"error": "<string>",
"status": "unknown"
}{
"details": {},
"error": "<string>",
"status": "unknown"
}