Update machine pool

curl --request PUT \
  --url https://api.staging.bma.beeos.ai/api/v1/orgs/{orgID}/machine-pools/{poolID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "default_machine_cpu": 1073741824,
  "default_machine_memory_mb": 1073741824,
  "default_machine_env": {},
  "default_machine_secret_env": {},
  "default_machine_provider_options": {},
  "default_cwd": "<string>",
  "provider_config": {},
  "provider_auth_secret_id": "<string>",
  "runtime_protection_enabled": true,
  "max_total_machines": 1073741823,
  "max_total_cpu": 1073741823,
  "max_total_memory_mb": 1073741823,
  "min_machine_cpu": 1073741823,
  "min_machine_memory_mb": 1073741823,
  "max_machine_cpu": 1073741824,
  "max_machine_memory_mb": 1073741824,
  "delete_after_idle_minutes": 1073741826,
  "pause_after_idle_minutes": 1073741826,
  "archive_after_paused_days": 1825,
  "delete_after_paused_days": 1825,
  "metadata": {}
}
'

import requests

url = "https://api.staging.bma.beeos.ai/api/v1/orgs/{orgID}/machine-pools/{poolID}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "default_machine_cpu": 1073741824,
    "default_machine_memory_mb": 1073741824,
    "default_machine_env": {},
    "default_machine_secret_env": {},
    "default_machine_provider_options": {},
    "default_cwd": "<string>",
    "provider_config": {},
    "provider_auth_secret_id": "<string>",
    "runtime_protection_enabled": True,
    "max_total_machines": 1073741823,
    "max_total_cpu": 1073741823,
    "max_total_memory_mb": 1073741823,
    "min_machine_cpu": 1073741823,
    "min_machine_memory_mb": 1073741823,
    "max_machine_cpu": 1073741824,
    "max_machine_memory_mb": 1073741824,
    "delete_after_idle_minutes": 1073741826,
    "pause_after_idle_minutes": 1073741826,
    "archive_after_paused_days": 1825,
    "delete_after_paused_days": 1825,
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    default_machine_cpu: 1073741824,
    default_machine_memory_mb: 1073741824,
    default_machine_env: {},
    default_machine_secret_env: {},
    default_machine_provider_options: {},
    default_cwd: '<string>',
    provider_config: {},
    provider_auth_secret_id: '<string>',
    runtime_protection_enabled: true,
    max_total_machines: 1073741823,
    max_total_cpu: 1073741823,
    max_total_memory_mb: 1073741823,
    min_machine_cpu: 1073741823,
    min_machine_memory_mb: 1073741823,
    max_machine_cpu: 1073741824,
    max_machine_memory_mb: 1073741824,
    delete_after_idle_minutes: 1073741826,
    pause_after_idle_minutes: 1073741826,
    archive_after_paused_days: 1825,
    delete_after_paused_days: 1825,
    metadata: {}
  })
};

fetch('https://api.staging.bma.beeos.ai/api/v1/orgs/{orgID}/machine-pools/{poolID}', 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/api/v1/orgs/{orgID}/machine-pools/{poolID}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"default_machine_cpu\": 1073741824,\n  \"default_machine_memory_mb\": 1073741824,\n  \"default_machine_env\": {},\n  \"default_machine_secret_env\": {},\n  \"default_machine_provider_options\": {},\n  \"default_cwd\": \"<string>\",\n  \"provider_config\": {},\n  \"provider_auth_secret_id\": \"<string>\",\n  \"runtime_protection_enabled\": true,\n  \"max_total_machines\": 1073741823,\n  \"max_total_cpu\": 1073741823,\n  \"max_total_memory_mb\": 1073741823,\n  \"min_machine_cpu\": 1073741823,\n  \"min_machine_memory_mb\": 1073741823,\n  \"max_machine_cpu\": 1073741824,\n  \"max_machine_memory_mb\": 1073741824,\n  \"delete_after_idle_minutes\": 1073741826,\n  \"pause_after_idle_minutes\": 1073741826,\n  \"archive_after_paused_days\": 1825,\n  \"delete_after_paused_days\": 1825,\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("PUT", 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))

}

{
  "id": "<string>",
  "org_id": "<string>",
  "name": "<string>",
  "management_kind": "tenant",
  "description": "<string>",
  "provider": "<string>",
  "default_machine_cpu": 1073741824,
  "default_machine_memory_mb": 1073741824,
  "default_machine_env": {},
  "default_machine_secret_env": {},
  "default_machine_provider_options": {},
  "default_cwd": "<string>",
  "provider_config": {},
  "runtime_protection_enabled": true,
  "max_total_machines": 1073741823,
  "max_total_cpu": 1073741823,
  "max_total_memory_mb": 1073741823,
  "min_machine_cpu": 1073741823,
  "min_machine_memory_mb": 1073741823,
  "max_machine_cpu": 1073741824,
  "max_machine_memory_mb": 1073741824,
  "delete_after_idle_minutes": 1073741826,
  "pause_after_idle_minutes": 1073741826,
  "archive_after_paused_days": 1825,
  "delete_after_paused_days": 1825,
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "provider_auth_secret_id": "<string>",
  "usage": {
    "machines": 1,
    "cpu": 1,
    "memory_mb": 1
  }
}

{
  "error": "<string>",
  "code": "<string>",
  "current_digest": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>",
      "line": 2,
      "column": 2
    }
  ]
}

{
  "error": "<string>",
  "code": "<string>",
  "current_digest": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>",
      "line": 2,
      "column": 2
    }
  ]
}

{
  "error": "<string>",
  "code": "<string>",
  "current_digest": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>",
      "line": 2,
      "column": 2
    }
  ]
}

{
  "error": "<string>",
  "code": "<string>",
  "current_digest": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>",
      "line": 2,
      "column": 2
    }
  ]
}

{
  "error": "<string>",
  "code": "<string>",
  "current_digest": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>",
      "line": 2,
      "column": 2
    }
  ]
}

{
  "error": "<string>",
  "code": "<string>",
  "current_digest": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>",
      "line": 2,
      "column": 2
    }
  ]
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

PUT

orgs

{orgID}

machine-pools

{poolID}

Update machine pool

curl --request PUT \
  --url https://api.staging.bma.beeos.ai/api/v1/orgs/{orgID}/machine-pools/{poolID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "default_machine_cpu": 1073741824,
  "default_machine_memory_mb": 1073741824,
  "default_machine_env": {},
  "default_machine_secret_env": {},
  "default_machine_provider_options": {},
  "default_cwd": "<string>",
  "provider_config": {},
  "provider_auth_secret_id": "<string>",
  "runtime_protection_enabled": true,
  "max_total_machines": 1073741823,
  "max_total_cpu": 1073741823,
  "max_total_memory_mb": 1073741823,
  "min_machine_cpu": 1073741823,
  "min_machine_memory_mb": 1073741823,
  "max_machine_cpu": 1073741824,
  "max_machine_memory_mb": 1073741824,
  "delete_after_idle_minutes": 1073741826,
  "pause_after_idle_minutes": 1073741826,
  "archive_after_paused_days": 1825,
  "delete_after_paused_days": 1825,
  "metadata": {}
}
'

import requests

url = "https://api.staging.bma.beeos.ai/api/v1/orgs/{orgID}/machine-pools/{poolID}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "default_machine_cpu": 1073741824,
    "default_machine_memory_mb": 1073741824,
    "default_machine_env": {},
    "default_machine_secret_env": {},
    "default_machine_provider_options": {},
    "default_cwd": "<string>",
    "provider_config": {},
    "provider_auth_secret_id": "<string>",
    "runtime_protection_enabled": True,
    "max_total_machines": 1073741823,
    "max_total_cpu": 1073741823,
    "max_total_memory_mb": 1073741823,
    "min_machine_cpu": 1073741823,
    "min_machine_memory_mb": 1073741823,
    "max_machine_cpu": 1073741824,
    "max_machine_memory_mb": 1073741824,
    "delete_after_idle_minutes": 1073741826,
    "pause_after_idle_minutes": 1073741826,
    "archive_after_paused_days": 1825,
    "delete_after_paused_days": 1825,
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    default_machine_cpu: 1073741824,
    default_machine_memory_mb: 1073741824,
    default_machine_env: {},
    default_machine_secret_env: {},
    default_machine_provider_options: {},
    default_cwd: '<string>',
    provider_config: {},
    provider_auth_secret_id: '<string>',
    runtime_protection_enabled: true,
    max_total_machines: 1073741823,
    max_total_cpu: 1073741823,
    max_total_memory_mb: 1073741823,
    min_machine_cpu: 1073741823,
    min_machine_memory_mb: 1073741823,
    max_machine_cpu: 1073741824,
    max_machine_memory_mb: 1073741824,
    delete_after_idle_minutes: 1073741826,
    pause_after_idle_minutes: 1073741826,
    archive_after_paused_days: 1825,
    delete_after_paused_days: 1825,
    metadata: {}
  })
};

fetch('https://api.staging.bma.beeos.ai/api/v1/orgs/{orgID}/machine-pools/{poolID}', 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/api/v1/orgs/{orgID}/machine-pools/{poolID}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"default_machine_cpu\": 1073741824,\n  \"default_machine_memory_mb\": 1073741824,\n  \"default_machine_env\": {},\n  \"default_machine_secret_env\": {},\n  \"default_machine_provider_options\": {},\n  \"default_cwd\": \"<string>\",\n  \"provider_config\": {},\n  \"provider_auth_secret_id\": \"<string>\",\n  \"runtime_protection_enabled\": true,\n  \"max_total_machines\": 1073741823,\n  \"max_total_cpu\": 1073741823,\n  \"max_total_memory_mb\": 1073741823,\n  \"min_machine_cpu\": 1073741823,\n  \"min_machine_memory_mb\": 1073741823,\n  \"max_machine_cpu\": 1073741824,\n  \"max_machine_memory_mb\": 1073741824,\n  \"delete_after_idle_minutes\": 1073741826,\n  \"pause_after_idle_minutes\": 1073741826,\n  \"archive_after_paused_days\": 1825,\n  \"delete_after_paused_days\": 1825,\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("PUT", 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))

}

{
  "id": "<string>",
  "org_id": "<string>",
  "name": "<string>",
  "management_kind": "tenant",
  "description": "<string>",
  "provider": "<string>",
  "default_machine_cpu": 1073741824,
  "default_machine_memory_mb": 1073741824,
  "default_machine_env": {},
  "default_machine_secret_env": {},
  "default_machine_provider_options": {},
  "default_cwd": "<string>",
  "provider_config": {},
  "runtime_protection_enabled": true,
  "max_total_machines": 1073741823,
  "max_total_cpu": 1073741823,
  "max_total_memory_mb": 1073741823,
  "min_machine_cpu": 1073741823,
  "min_machine_memory_mb": 1073741823,
  "max_machine_cpu": 1073741824,
  "max_machine_memory_mb": 1073741824,
  "delete_after_idle_minutes": 1073741826,
  "pause_after_idle_minutes": 1073741826,
  "archive_after_paused_days": 1825,
  "delete_after_paused_days": 1825,
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "provider_auth_secret_id": "<string>",
  "usage": {
    "machines": 1,
    "cpu": 1,
    "memory_mb": 1
  }
}

{
  "error": "<string>",
  "code": "<string>",
  "current_digest": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>",
      "line": 2,
      "column": 2
    }
  ]
}

{
  "error": "<string>",
  "code": "<string>",
  "current_digest": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>",
      "line": 2,
      "column": 2
    }
  ]
}

{
  "error": "<string>",
  "code": "<string>",
  "current_digest": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>",
      "line": 2,
      "column": 2
    }
  ]
}

{
  "error": "<string>",
  "code": "<string>",
  "current_digest": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>",
      "line": 2,
      "column": 2
    }
  ]
}

{
  "error": "<string>",
  "code": "<string>",
  "current_digest": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>",
      "line": 2,
      "column": 2
    }
  ]
}

{
  "error": "<string>",
  "code": "<string>",
  "current_digest": "<string>",
  "issues": [
    {
      "path": "<string>",
      "message": "<string>",
      "line": 2,
      "column": 2
    }
  ]
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

Authorizations

Authorization

string

header

required

An opaque BMA personal or organization bearer token.

Path Parameters

orgID

string

required

Organization ID (org_...).

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

poolID

string

required

Machine pool ID (mpo_...).

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

Body

application/json

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

Optional description of the pool.

default_machine_cpu

integer<int32> | null

Default CPU count for new machines in the pool.

Required range: 1 <= x <= 2147483647

default_machine_memory_mb

integer<int32> | null

Default memory in MB for new machines in the pool.

Required range: 1 <= x <= 2147483647

default_machine_env

object

Default environment for pool machines. A machine's environment, including resolved secret_env values, is applied to the provider machine at provisioning, so the provider_options startup_script and the daemon run with it, and is resolved again for each process at launch.

Show child attributes

default_machine_secret_env

object

Default secret environment for pool machines, mapping env names to generic secret references. References are resolved to secret values wherever the machine environment is applied.

Show child attributes

default_machine_provider_options

object

Provider-specific options applied to new machines in the pool.

default_cwd

string

Default working directory for processes on machines created from the pool after this change.

provider_config

object

Provider-specific settings for the pool.

provider_auth_secret_id

string

Secret ID (sec_...).

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

runtime_protection_enabled

boolean

Whether BMA should delete a pool machine when its provider remains running after its daemon becomes inactive.

max_total_machines

integer<int32>

Deprecated, not enforced: how many machines a pool has no longer blocks new machines. Organization and project quotas over in-use machines (org resource limits max_in_use_pool_machines_per_project and max_in_use_pool_machines_per_org) govern capacity.

Required range: 0 <= x <= 2147483647

max_total_cpu

integer<int32> | null

Deprecated, not enforced: organization and project in-use machine CPU quotas govern capacity.

Required range: 0 <= x <= 2147483647

max_total_memory_mb

integer<int32> | null

Deprecated, not enforced: organization and project in-use machine memory quotas govern capacity.

Required range: 0 <= x <= 2147483647

min_machine_cpu

integer<int32> | null

Smallest CPU count a single machine in the pool can use.

Required range: 0 <= x <= 2147483647

min_machine_memory_mb

integer<int32> | null

Smallest memory in MB a single machine in the pool can use.

Required range: 0 <= x <= 2147483647

max_machine_cpu

integer<int32> | null

Largest CPU count a single machine in the pool can use.

Required range: 1 <= x <= 2147483647

max_machine_memory_mb

integer<int32> | null

Largest memory in MB a single machine in the pool can use.

Required range: 1 <= x <= 2147483647

delete_after_idle_minutes

integer<int32> | null

Idle minutes before deleting a machine from this pool. Null clears the pool default; omitted leaves it unchanged.

Required range: 5 <= x <= 2147483647

pause_after_idle_minutes

integer<int32> | null

Idle minutes before pausing a machine from this pool. Null clears it; omitted leaves it unchanged. Exclusive with delete_after_idle_minutes.

Required range: 5 <= x <= 2147483647

archive_after_paused_days

integer<int32> | null

Days a machine stays paused before it is archived. Null clears it; omitted leaves it unchanged. Requires pause_after_idle_minutes.

Required range: 1 <= x <= 3650

delete_after_paused_days

integer<int32> | null

Delete a paused machine once it is this many days old, counted from the machine's creation. Null clears it; omitted leaves it unchanged. Requires pause_after_idle_minutes; cannot be combined with archive_after_paused_days.

Required range: 1 <= x <= 3650

metadata

object

User-supplied metadata stored on a machine, provided directly or copied from the machine pool that provisions it. A restriction of Metadata that leaves room for one reserved pair - BMA sets observed_platform on the machine to the platform reported by its daemon, so the key is reserved and at most 15 user pairs are accepted.

Show child attributes

Response

Machine pool updated.

string

required

Machine pool ID (mpo_...).

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

org_id

string

required

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

name

string

required

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

Required string length: 1 - 64

management_kind

enum<string>

required

Lifecycle owner. Tenant-managed resources can be changed through tenant APIs. Cluster-managed resources are installed and lifecycle-managed by the control plane; individual APIs may explicitly expose tenant-editable settings.

Available options:

tenant,

cluster

description

string

required

provider

string

required

default_machine_cpu

integer<int32> | null

required

Required range: 1 <= x <= 2147483647

default_machine_memory_mb

integer<int32> | null

required

Required range: 1 <= x <= 2147483647

default_machine_env

object

required

Show child attributes

default_machine_secret_env

object

required

Default secret environment for pool machines, mapping env names to generic secret references. References are resolved to secret values wherever the machine environment is applied.

Show child attributes

default_machine_provider_options

object

required

default_cwd

string

required

provider_config

object

required

runtime_protection_enabled

boolean

required

Whether BMA deletes this pool's machines when the provider remains running after the daemon becomes inactive.

max_total_machines

integer<int32>

required

Required range: 0 <= x <= 2147483647

max_total_cpu

integer<int32> | null

required

Deprecated, not enforced: organization and project in-use machine CPU quotas govern capacity.

Required range: 0 <= x <= 2147483647

max_total_memory_mb

integer<int32> | null

required

Deprecated, not enforced: organization and project in-use machine memory quotas govern capacity.

Required range: 0 <= x <= 2147483647

min_machine_cpu

integer<int32> | null

required

Required range: 0 <= x <= 2147483647

min_machine_memory_mb

integer<int32> | null

required

Required range: 0 <= x <= 2147483647

max_machine_cpu

integer<int32> | null

required

Required range: 1 <= x <= 2147483647

max_machine_memory_mb

integer<int32> | null

required

Required range: 1 <= x <= 2147483647

delete_after_idle_minutes

integer<int32> | null

required

Idle minutes before deleting a machine from this pool, or null when the pool default is unset.

Required range: 5 <= x <= 2147483647

pause_after_idle_minutes

integer<int32> | null

required

Idle minutes before pausing a machine from this pool, or null when the pool does not pause idle machines.

Required range: 5 <= x <= 2147483647

archive_after_paused_days

integer<int32> | null

required

Days a machine stays paused before it is archived, or null when the pool does not archive.

Required range: 1 <= x <= 3650

delete_after_paused_days

integer<int32> | null

required

Age in days, counted from the machine's creation, after which a paused machine is deleted, or null when the pool keeps paused machines.

Required range: 1 <= x <= 3650

metadata

object

required

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

Show child attributes

created_at

string<date-time>

required

updated_at

string<date-time>

required

provider_auth_secret_id

string

Secret ID (sec_...).

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

usage

object

Current quota-consuming usage. Populated when the machine pool is returned by the list or get endpoint.

Show child attributes

API reference

Native REST API

Managed Agents extensions

Update machine pool

Authorizations

Path Parameters

Body

Response