Full API reference for Mags.

job = m.run("echo hello", workspace_id="myproject")
print(job["request_id"])

# Or run and wait for completion:
result = m.run_and_wait("echo hello", workspace_id="myproject")
print(result["status"])  # "completed"

const job = await mags.run('echo hello', { workspaceId: 'myproject' });
console.log(job.requestId);

// Or run and wait:
const result = await mags.runAndWait('echo hello', { workspaceId: 'myproject' });
console.log(result.status); // "completed"

status = m.status("eab1e214-...")
print(status["status"])  # "running"

const status = await mags.status('eab1e214-...');
console.log(status.status); // "running"

logs = m.logs("eab1e214-...")
for log in logs["logs"]:
    print(f"[{log['source']}] {log['message']}")

const logs = await mags.logs('eab1e214-...');
logs.logs.forEach(l => console.log(`[${l.source}] ${l.message}`));

resp = m.list_jobs(page=1, page_size=10)
for job in resp["jobs"]:
    print(job["request_id"], job["status"])

const resp = await mags.list({ page: 1, pageSize: 10 });
resp.jobs.forEach(j => console.log(j.requestId, j.status));

m.stop("myproject")  # accepts name, workspace ID, or request ID

await mags.stop('myproject'); // accepts name, workspace ID, or request ID

mags stop myproject

# SSH access
ssh = m.enable_access(request_id, port=22)
print(f"ssh root@{ssh['ssh_host']} -p {ssh['ssh_port']}")

# HTTP access
access = m.enable_access(request_id, port=8080)
print(access.get("url"))

// SSH access
const ssh = await mags.enableAccess(requestId, 22);
console.log(`ssh root@${ssh.sshHost} -p ${ssh.sshPort}`);

// HTTP access
const access = await mags.enableAccess(requestId, 8080);

# Enable no-sleep on an existing VM
mags set myvm --no-sleep

# Re-enable auto-sleep
mags set myvm --sleep

# Enable no-sleep
m.update_job(request_id, no_sleep=True)

# Set startup command
m.update_job(request_id, startup_command="python3 -m http.server 8080")

await mags.updateJob(requestId, { noSleep: true });

file_id = m.upload_file("script.py")
file_ids = m.upload_files(["script.py", "data.csv"])

const fileId = await mags.uploadFile('script.py');

await mags.sync(requestId);

mags sync myproject

ws = m.list_workspaces()
for w in ws["workspaces"]:
    print(w["workspace_id"], w["job_count"])

const ws = await mags.listWorkspaces();
ws.workspaces.forEach(w => console.log(w.workspaceId));

mags workspace list

mags workspace delete myproject
mags workspace delete myproject --force  # skip confirmation

curl -X DELETE https://api.magpiecloud.com/api/v1/mags-workspaces/myproject \
  -H "Authorization: Bearer $TOKEN"

m.url_alias_create("my-api", "myproject")
aliases = m.url_alias_list()
m.url_alias_delete("my-api")

await mags.urlAliasCreate('my-api', 'myproject');
const aliases = await mags.urlAliasList();
await mags.urlAliasDelete('my-api');

cron = m.cron_create(
    name="nightly-backup",
    cron_expression="0 0 * * *",
    script="tar czf backup.tar.gz /data",
    workspace_id="backups",
)
jobs = m.cron_list()
m.cron_update(cron["id"], enabled=False)
m.cron_delete(cron["id"])

const cron = await mags.cronCreate({
  name: 'nightly-backup',
  cronExpression: '0 0 * * *',
  script: 'tar czf backup.tar.gz /data',
  workspaceId: 'backups',
});
await mags.cronDelete(cron.id);

mags cron add --name "nightly-backup" --schedule "0 0 * * *" -w backups \
  'tar czf backup.tar.gz /data'
mags cron list
mags cron remove <id>