Register Machine
curl --request POST \
--url https://api.getgranite.ai/api/driver/machines/register \
--header 'Content-Type: application/json' \
--data '
{
"client_machine_id": "<string>",
"machine_name": "<string>",
"hostname": "<string>",
"os_platform": "<string>",
"os_version": "<string>",
"arch": "<string>",
"app_version": "<string>",
"driver_version": "<string>",
"tauri_version": "<string>",
"executor_active": true,
"metadata": {}
}
'import requests
url = "https://api.getgranite.ai/api/driver/machines/register"
payload = {
"client_machine_id": "<string>",
"machine_name": "<string>",
"hostname": "<string>",
"os_platform": "<string>",
"os_version": "<string>",
"arch": "<string>",
"app_version": "<string>",
"driver_version": "<string>",
"tauri_version": "<string>",
"executor_active": True,
"metadata": {}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
client_machine_id: '<string>',
machine_name: '<string>',
hostname: '<string>',
os_platform: '<string>',
os_version: '<string>',
arch: '<string>',
app_version: '<string>',
driver_version: '<string>',
tauri_version: '<string>',
executor_active: true,
metadata: {}
})
};
fetch('https://api.getgranite.ai/api/driver/machines/register', 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.getgranite.ai/api/driver/machines/register",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'client_machine_id' => '<string>',
'machine_name' => '<string>',
'hostname' => '<string>',
'os_platform' => '<string>',
'os_version' => '<string>',
'arch' => '<string>',
'app_version' => '<string>',
'driver_version' => '<string>',
'tauri_version' => '<string>',
'executor_active' => true,
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"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.getgranite.ai/api/driver/machines/register"
payload := strings.NewReader("{\n \"client_machine_id\": \"<string>\",\n \"machine_name\": \"<string>\",\n \"hostname\": \"<string>\",\n \"os_platform\": \"<string>\",\n \"os_version\": \"<string>\",\n \"arch\": \"<string>\",\n \"app_version\": \"<string>\",\n \"driver_version\": \"<string>\",\n \"tauri_version\": \"<string>\",\n \"executor_active\": true,\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://api.getgranite.ai/api/driver/machines/register")
.header("Content-Type", "application/json")
.body("{\n \"client_machine_id\": \"<string>\",\n \"machine_name\": \"<string>\",\n \"hostname\": \"<string>\",\n \"os_platform\": \"<string>\",\n \"os_version\": \"<string>\",\n \"arch\": \"<string>\",\n \"app_version\": \"<string>\",\n \"driver_version\": \"<string>\",\n \"tauri_version\": \"<string>\",\n \"executor_active\": true,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getgranite.ai/api/driver/machines/register")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"client_machine_id\": \"<string>\",\n \"machine_name\": \"<string>\",\n \"hostname\": \"<string>\",\n \"os_platform\": \"<string>\",\n \"os_version\": \"<string>\",\n \"arch\": \"<string>\",\n \"app_version\": \"<string>\",\n \"driver_version\": \"<string>\",\n \"tauri_version\": \"<string>\",\n \"executor_active\": true,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"machine": {
"driver_machine_id": "<string>",
"client_machine_id": "<string>",
"vm_api_key_id": "<string>",
"key_label": "<string>",
"last_seen_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"is_active": true,
"machine_name": "<string>",
"hostname": "<string>",
"os_platform": "<string>",
"os_version": "<string>",
"arch": "<string>",
"app_version": "<string>",
"driver_version": "<string>",
"tauri_version": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Driver
Register
POST
/
api
/
driver
/
machines
/
register
Register Machine
curl --request POST \
--url https://api.getgranite.ai/api/driver/machines/register \
--header 'Content-Type: application/json' \
--data '
{
"client_machine_id": "<string>",
"machine_name": "<string>",
"hostname": "<string>",
"os_platform": "<string>",
"os_version": "<string>",
"arch": "<string>",
"app_version": "<string>",
"driver_version": "<string>",
"tauri_version": "<string>",
"executor_active": true,
"metadata": {}
}
'import requests
url = "https://api.getgranite.ai/api/driver/machines/register"
payload = {
"client_machine_id": "<string>",
"machine_name": "<string>",
"hostname": "<string>",
"os_platform": "<string>",
"os_version": "<string>",
"arch": "<string>",
"app_version": "<string>",
"driver_version": "<string>",
"tauri_version": "<string>",
"executor_active": True,
"metadata": {}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
client_machine_id: '<string>',
machine_name: '<string>',
hostname: '<string>',
os_platform: '<string>',
os_version: '<string>',
arch: '<string>',
app_version: '<string>',
driver_version: '<string>',
tauri_version: '<string>',
executor_active: true,
metadata: {}
})
};
fetch('https://api.getgranite.ai/api/driver/machines/register', 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.getgranite.ai/api/driver/machines/register",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'client_machine_id' => '<string>',
'machine_name' => '<string>',
'hostname' => '<string>',
'os_platform' => '<string>',
'os_version' => '<string>',
'arch' => '<string>',
'app_version' => '<string>',
'driver_version' => '<string>',
'tauri_version' => '<string>',
'executor_active' => true,
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"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.getgranite.ai/api/driver/machines/register"
payload := strings.NewReader("{\n \"client_machine_id\": \"<string>\",\n \"machine_name\": \"<string>\",\n \"hostname\": \"<string>\",\n \"os_platform\": \"<string>\",\n \"os_version\": \"<string>\",\n \"arch\": \"<string>\",\n \"app_version\": \"<string>\",\n \"driver_version\": \"<string>\",\n \"tauri_version\": \"<string>\",\n \"executor_active\": true,\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://api.getgranite.ai/api/driver/machines/register")
.header("Content-Type", "application/json")
.body("{\n \"client_machine_id\": \"<string>\",\n \"machine_name\": \"<string>\",\n \"hostname\": \"<string>\",\n \"os_platform\": \"<string>\",\n \"os_version\": \"<string>\",\n \"arch\": \"<string>\",\n \"app_version\": \"<string>\",\n \"driver_version\": \"<string>\",\n \"tauri_version\": \"<string>\",\n \"executor_active\": true,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getgranite.ai/api/driver/machines/register")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"client_machine_id\": \"<string>\",\n \"machine_name\": \"<string>\",\n \"hostname\": \"<string>\",\n \"os_platform\": \"<string>\",\n \"os_version\": \"<string>\",\n \"arch\": \"<string>\",\n \"app_version\": \"<string>\",\n \"driver_version\": \"<string>\",\n \"tauri_version\": \"<string>\",\n \"executor_active\": true,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"machine": {
"driver_machine_id": "<string>",
"client_machine_id": "<string>",
"vm_api_key_id": "<string>",
"key_label": "<string>",
"last_seen_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"is_active": true,
"machine_name": "<string>",
"hostname": "<string>",
"os_platform": "<string>",
"os_version": "<string>",
"arch": "<string>",
"app_version": "<string>",
"driver_version": "<string>",
"tauri_version": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Headers
Body
application/json
Payload emitted by the driver when registering or heartbeating.
Stable identifier stored on the VM
Friendly machine label
Machine hostname
Operating system platform
Operating system version
CPU architecture
Driver UI version
Executor version
Tauri runtime version
Whether the executor is currently accepting commands
Additional metadata about the machine
Response
Successful Response
Response returned after registering or updating a machine.
Stored machine metadata
Show child attributes
Show child attributes
⌘I