Lume HTTP API Reference

curl "http://localhost:7777/lume/vms"

import requests

response = requests.get("http://localhost:7777/lume/vms")
print(response.json())

const response = await fetch(`http://localhost:7777/lume/vms`);
const data = await response.json();

curl "http://localhost:7777/lume/vms/{name}"

import requests

response = requests.get("http://localhost:7777/lume/vms/{name}")
print(response.json())

const response = await fetch(`http://localhost:7777/lume/vms/${name}`);
const data = await response.json();

curl -X POST "http://localhost:7777/lume/vms" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "my-vm",
  "os": "macOS",
  "cpu": 4,
  "memory": "8GB",
  "diskSize": "50GB",
  "display": "1024x768"
}'

import requests

data = {
    "name": "my-vm",
    "os": "macOS",
    "cpu": 4,
    "memory": "8GB",
    "diskSize": "50GB",
    "display": "1024x768",
}

response = requests.post("http://localhost:7777/lume/vms", json=data)
print(response.json())

const response = await fetch(`http://localhost:7777/lume/vms`, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    name: "my-vm",
    os: "macOS",
    cpu: 4,
    memory: "8GB",
    diskSize: "50GB",
    display: "1024x768",
  }),
});
const data = await response.json();

curl -X DELETE "http://localhost:7777/lume/vms/{name}"

import requests

response = requests.delete("http://localhost:7777/lume/vms/{name}")
print(response.json())

const response = await fetch(`http://localhost:7777/lume/vms/${name}`, {
  method: "DELETE",
});
const data = await response.json();

curl -X POST "http://localhost:7777/lume/vms/clone" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "my-vm",
  "newName": "example"
}'

import requests

data = {
    "name": "my-vm",
    "newName": "example",
}

response = requests.post("http://localhost:7777/lume/vms/clone", json=data)
print(response.json())

const response = await fetch(`http://localhost:7777/lume/vms/clone`, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    name: "my-vm",
    newName: "example",
  }),
});
const data = await response.json();

curl -X PATCH "http://localhost:7777/lume/vms/{name}" \
  -H "Content-Type: application/json" \
  -d '{}'

import requests

data = {
}

response = requests.patch("http://localhost:7777/lume/vms/{name}", json=data)
print(response.json())

const response = await fetch(`http://localhost:7777/lume/vms/${name}`, {
  method: "PATCH",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
  }),
});
const data = await response.json();

curl -X POST "http://localhost:7777/lume/vms/{name}/run" \
  -H "Content-Type: application/json" \
  -d '{}'

import requests

data = {
}

response = requests.post("http://localhost:7777/lume/vms/{name}/run", json=data)
print(response.json())

const response = await fetch(`http://localhost:7777/lume/vms/${name}/run`, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
  }),
});
const data = await response.json();

curl -X POST "http://localhost:7777/lume/vms/{name}/stop" \
  -H "Content-Type: application/json" \
  -d '{}'

import requests

data = {
}

response = requests.post("http://localhost:7777/lume/vms/{name}/stop", json=data)
print(response.json())

const response = await fetch(`http://localhost:7777/lume/vms/${name}/stop`, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
  }),
});
const data = await response.json();

curl "http://localhost:7777/lume/images"

import requests

response = requests.get("http://localhost:7777/lume/images")
print(response.json())

const response = await fetch(`http://localhost:7777/lume/images`);
const data = await response.json();

curl "http://localhost:7777/lume/ipsw"

import requests

response = requests.get("http://localhost:7777/lume/ipsw")
print(response.json())

const response = await fetch(`http://localhost:7777/lume/ipsw`);
const data = await response.json();

curl -X POST "http://localhost:7777/lume/pull" \
  -H "Content-Type: application/json" \
  -d '{
  "image": "macos-sequoia-vanilla:latest"
}'

import requests

data = {
    "image": "macos-sequoia-vanilla:latest",
}

response = requests.post("http://localhost:7777/lume/pull", json=data)
print(response.json())

const response = await fetch(`http://localhost:7777/lume/pull`, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    image: "macos-sequoia-vanilla:latest",
  }),
});
const data = await response.json();

curl -X POST "http://localhost:7777/lume/vms/push" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "my-vm",
  "imageName": "example",
  "tags": [
    "latest"
  ]
}'

import requests

data = {
    "name": "my-vm",
    "imageName": "example",
    "tags": ["latest"],
}

response = requests.post("http://localhost:7777/lume/vms/push", json=data)
print(response.json())

const response = await fetch(`http://localhost:7777/lume/vms/push`, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    name: "my-vm",
    imageName: "example",
    tags: ["latest"],
  }),
});
const data = await response.json();

curl -X POST "http://localhost:7777/lume/prune"

import requests

response = requests.post("http://localhost:7777/lume/prune")
print(response.json())

const response = await fetch(`http://localhost:7777/lume/prune`);
const data = await response.json();

curl "http://localhost:7777/lume/config"

import requests

response = requests.get("http://localhost:7777/lume/config")
print(response.json())

const response = await fetch(`http://localhost:7777/lume/config`);
const data = await response.json();

curl -X POST "http://localhost:7777/lume/config" \
  -H "Content-Type: application/json" \
  -d '{}'

import requests

data = {
}

response = requests.post("http://localhost:7777/lume/config", json=data)
print(response.json())

const response = await fetch(`http://localhost:7777/lume/config`, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
  }),
});
const data = await response.json();

curl "http://localhost:7777/lume/config/locations"

import requests

response = requests.get("http://localhost:7777/lume/config/locations")
print(response.json())

const response = await fetch(`http://localhost:7777/lume/config/locations`);
const data = await response.json();

curl -X POST "http://localhost:7777/lume/config/locations" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "my-vm",
  "path": "/path/to/storage"
}'

import requests

data = {
    "name": "my-vm",
    "path": "/path/to/storage",
}

response = requests.post("http://localhost:7777/lume/config/locations", json=data)
print(response.json())

const response = await fetch(`http://localhost:7777/lume/config/locations`, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    name: "my-vm",
    path: "/path/to/storage",
  }),
});
const data = await response.json();

curl -X DELETE "http://localhost:7777/lume/config/locations/{name}"

import requests

response = requests.delete("http://localhost:7777/lume/config/locations/{name}")
print(response.json())

const response = await fetch(`http://localhost:7777/lume/config/locations/${name}`, {
  method: "DELETE",
});
const data = await response.json();

curl -X POST "http://localhost:7777/lume/config/locations/default/{name}"

import requests

response = requests.post("http://localhost:7777/lume/config/locations/default/{name}")
print(response.json())

const response = await fetch(`http://localhost:7777/lume/config/locations/default/${name}`);
const data = await response.json();

curl "http://localhost:7777/lume/logs"

import requests

response = requests.get("http://localhost:7777/lume/logs")
print(response.json())

const response = await fetch(`http://localhost:7777/lume/logs`);
const data = await response.json();