Update a machine

curl --request POST \
  --url https://api.staging.bma.beeos.ai/v1/machines/{machine_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "cwd": "<string>",
  "env": {},
  "secret_env": {}
}
'

import requests

url = "https://api.staging.bma.beeos.ai/v1/machines/{machine_id}"

payload = {
    "cwd": "<string>",
    "env": {},
    "secret_env": {}
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({cwd: '<string>', env: {}, secret_env: {}})
};

fetch('https://api.staging.bma.beeos.ai/v1/machines/{machine_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.staging.bma.beeos.ai/v1/machines/{machine_id}"

	payload := strings.NewReader("{\n  \"cwd\": \"<string>\",\n  \"env\": {},\n  \"secret_env\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<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))

}

{
  "type": "machine",
  "id": "<string>",
  "org_id": "<string>",
  "source_kind": "byo",
  "machine_pool_id": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "provider": "<string>",
  "lifecycle_state": "provisioning",
  "connection_state": "online",
  "connection_state_reason": "<string>",
  "power_state": "running",
  "last_observed_at": "2023-11-07T05:31:56Z",
  "cwd": "<string>",
  "env": {},
  "secret_env": {},
  "lifecycle_reason_code": "<string>",
  "lifecycle_reason_message": "<string>",
  "failure_report": {
    "stage": "startup_script",
    "output_tail": "<string>",
    "output_truncated": true,
    "reported_at": "2023-11-07T05:31:56Z",
    "exit_status": 123,
    "daemon_version": "<string>",
    "target_version": "<string>"
  },
  "next_reconcile_after": "2023-11-07T05:31:56Z",
  "provision_attempts": 123,
  "delete_attempts": 123,
  "metadata": {},
  "deleted_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "kind": "persistent",
  "machine_pool_name": "<string>",
  "cpu": 2,
  "memory_mb": 2,
  "agent_id": "<string>",
  "capabilities": {
    "type": "machine_capabilities",
    "machine_id": "<string>",
    "terminal": {
      "supported": true,
      "reason": "<string>"
    },
    "session_files": {
      "declared": true
    },
    "desktop": {
      "supported": true,
      "webrtc": true,
      "rfb": true,
      "reason": "<string>"
    },
    "permissions": {
      "terminal": true,
      "desktop_watch": true,
      "desktop_control": true
    },
    "protocol_versions": {
      "terminal": 123,
      "desktop": 123
    }
  },
  "token": "<string>",
  "token_record": {
    "id": "<string>",
    "org_id": "<string>",
    "machine_id": "<string>",
    "name": "<string>",
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "last_used_at": "2023-11-07T05:31:56Z",
    "revoked_at": "2023-11-07T05:31:56Z",
    "revoke_reason": "<string>"
  },
  "project_grants": [
    {
      "id": "<string>",
      "org_id": "<string>",
      "project_id": "<string>",
      "machine_id": "<string>",
      "source_kind": "explicit",
      "description": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "project_machine_pool_grant_id": "<string>"
    }
  ]
}

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "<string>",
    "code": "<string>"
  },
  "request_id": "<string>"
}

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "<string>",
    "code": "<string>"
  },
  "request_id": "<string>"
}

POST

machines

{machine_id}

Update a machine

curl --request POST \
  --url https://api.staging.bma.beeos.ai/v1/machines/{machine_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "cwd": "<string>",
  "env": {},
  "secret_env": {}
}
'

import requests

url = "https://api.staging.bma.beeos.ai/v1/machines/{machine_id}"

payload = {
    "cwd": "<string>",
    "env": {},
    "secret_env": {}
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({cwd: '<string>', env: {}, secret_env: {}})
};

fetch('https://api.staging.bma.beeos.ai/v1/machines/{machine_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.staging.bma.beeos.ai/v1/machines/{machine_id}"

	payload := strings.NewReader("{\n  \"cwd\": \"<string>\",\n  \"env\": {},\n  \"secret_env\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<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))

}

{
  "type": "machine",
  "id": "<string>",
  "org_id": "<string>",
  "source_kind": "byo",
  "machine_pool_id": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "provider": "<string>",
  "lifecycle_state": "provisioning",
  "connection_state": "online",
  "connection_state_reason": "<string>",
  "power_state": "running",
  "last_observed_at": "2023-11-07T05:31:56Z",
  "cwd": "<string>",
  "env": {},
  "secret_env": {},
  "lifecycle_reason_code": "<string>",
  "lifecycle_reason_message": "<string>",
  "failure_report": {
    "stage": "startup_script",
    "output_tail": "<string>",
    "output_truncated": true,
    "reported_at": "2023-11-07T05:31:56Z",
    "exit_status": 123,
    "daemon_version": "<string>",
    "target_version": "<string>"
  },
  "next_reconcile_after": "2023-11-07T05:31:56Z",
  "provision_attempts": 123,
  "delete_attempts": 123,
  "metadata": {},
  "deleted_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "kind": "persistent",
  "machine_pool_name": "<string>",
  "cpu": 2,
  "memory_mb": 2,
  "agent_id": "<string>",
  "capabilities": {
    "type": "machine_capabilities",
    "machine_id": "<string>",
    "terminal": {
      "supported": true,
      "reason": "<string>"
    },
    "session_files": {
      "declared": true
    },
    "desktop": {
      "supported": true,
      "webrtc": true,
      "rfb": true,
      "reason": "<string>"
    },
    "permissions": {
      "terminal": true,
      "desktop_watch": true,
      "desktop_control": true
    },
    "protocol_versions": {
      "terminal": 123,
      "desktop": 123
    }
  },
  "token": "<string>",
  "token_record": {
    "id": "<string>",
    "org_id": "<string>",
    "machine_id": "<string>",
    "name": "<string>",
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "last_used_at": "2023-11-07T05:31:56Z",
    "revoked_at": "2023-11-07T05:31:56Z",
    "revoke_reason": "<string>"
  },
  "project_grants": [
    {
      "id": "<string>",
      "org_id": "<string>",
      "project_id": "<string>",
      "machine_id": "<string>",
      "source_kind": "explicit",
      "description": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "project_machine_pool_grant_id": "<string>"
    }
  ]
}

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "<string>",
    "code": "<string>"
  },
  "request_id": "<string>"
}

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "<string>",
    "code": "<string>"
  },
  "request_id": "<string>"
}

Authorizations

x-api-key

string

header

required

Path Parameters

machine_id

string

required

Body

application/json

cwd

string

Default working directory for processes started on the machine.

env

object

Environment variables set for processes started on the machine.

Show child attributes

secret_env

object

Environment variable names mapped to secret IDs (sec_...) whose values are set for processes started on the machine.

Show child attributes

Response

Success.

An org machine, an agent machine (kind, machine_pool_name, cpu, memory_mb, agent_id) or a connected BYO machine (token); the fields of the other families are absent.

type

string

required

Allowed value: "machine"

string

required

Machine ID (mch_...).

Pattern: ^mch_[a-z2-7]{26}$

org_id

string

Pattern: ^org_[a-z2-7]{26}$

source_kind

enum<string>

Available options:

byo,

pool

machine_pool_id

string | null

Machine pool ID (mpo_...).

Pattern: ^mpo_[a-z2-7]{26}$

display_name

string

Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.

Required string length: 1 - 64

description

string

provider

string

lifecycle_state

enum<string>

Available options:

provisioning,

provision_failed,

active,

deleting,

delete_failed,

deleted

connection_state

enum<string>

Available options:

online,

asleep,

offline

connection_state_reason

string

power_state

enum<string>

Compute state of a pool machine. paused keeps the disk (and memory when the provider supports it) without compute; resuming means a resume or restore is in flight; archived means the machine image is stored durably and is restored on the next access.

Available options:

running,

pausing,

paused,

resuming,

archiving,

archived

last_observed_at

string<date-time> | null

cwd

string

env

object

Show child attributes

secret_env

object

Show child attributes

lifecycle_reason_code

string

lifecycle_reason_message

string

failure_report

object

The machine's most recent daemon-reported failure. A single slot, overwritten by newer reports. Runtime crash reports remain as historical diagnostics; recovery may clear other failure stages.

Show child attributes

next_reconcile_after

string<date-time> | null

provision_attempts

integer<int32>

delete_attempts

integer<int32>

metadata

object

Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.

Show child attributes

deleted_at

string<date-time> | null

created_at

string<date-time>

updated_at

string<date-time>

kind

enum<string>

Persistent machines are kept for a person and never deleted for being idle; ephemeral machines serve turns and are deleted after their idle window.

Available options:

persistent,

ephemeral

machine_pool_name

string

Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.

Required string length: 1 - 64

cpu

integer<int32> | null

The machine shape BMA reports, or null before the provider resolves it.

Required range: x >= 1

memory_mb

integer<int32> | null

The machine shape BMA reports, or null before the provider resolves it.

Required range: x >= 1

agent_id

string

Agent machines only: the id /v1/agents uses .

capabilities

object | null

Single read only; null when the project cannot use the machine.

Show child attributes

token

string

BYO connect only: the one-time machine token.

token_record

object

Show child attributes

project_grants

object[]

Show child attributes

API reference

Managed Agents extensions

Update a machine

Authorizations

Path Parameters

Body

Response