Grant a project the use of a pool
curl --request POST \
--url https://api.staging.bma.beeos.ai/v1/machine_pools/{pool_id}/grants \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"description": "<string>",
"default_machine_cpu": 1073741824,
"default_machine_memory_mb": 1073741824,
"default_machine_env_overlay": {},
"default_machine_secret_env_overlay": {},
"default_machine_provider_options_overlay": {},
"default_cwd": "<string>",
"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": 0,
"metadata": {},
"project_id": "<string>"
}
'import requests
url = "https://api.staging.bma.beeos.ai/v1/machine_pools/{pool_id}/grants"
payload = {
"description": "<string>",
"default_machine_cpu": 1073741824,
"default_machine_memory_mb": 1073741824,
"default_machine_env_overlay": {},
"default_machine_secret_env_overlay": {},
"default_machine_provider_options_overlay": {},
"default_cwd": "<string>",
"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": 0,
"metadata": {},
"project_id": "<string>"
}
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({
description: '<string>',
default_machine_cpu: 1073741824,
default_machine_memory_mb: 1073741824,
default_machine_env_overlay: {},
default_machine_secret_env_overlay: {},
default_machine_provider_options_overlay: {},
default_cwd: '<string>',
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: 0,
metadata: {},
project_id: '<string>'
})
};
fetch('https://api.staging.bma.beeos.ai/v1/machine_pools/{pool_id}/grants', 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/machine_pools/{pool_id}/grants"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"default_machine_cpu\": 1073741824,\n \"default_machine_memory_mb\": 1073741824,\n \"default_machine_env_overlay\": {},\n \"default_machine_secret_env_overlay\": {},\n \"default_machine_provider_options_overlay\": {},\n \"default_cwd\": \"<string>\",\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\": 0,\n \"metadata\": {},\n \"project_id\": \"<string>\"\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_pool_grant",
"id": "<string>",
"org_id": "<string>",
"project_id": "<string>",
"machine_pool_id": "<string>",
"description": "<string>",
"default_machine_cpu": 1073741824,
"default_machine_memory_mb": 1073741824,
"default_machine_env_overlay": {},
"default_machine_secret_env_overlay": {},
"default_machine_provider_options_overlay": {},
"default_cwd": "<string>",
"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": 0,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"machine_pool": {
"type": "machine_pool",
"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
}
}
}{
"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>"
}Machine pools
Grant a project the use of a pool
The body may carry project_id; otherwise the project header selects it. machine_pool_id comes from the path.
POST
/
machine_pools
/
{pool_id}
/
grants
Grant a project the use of a pool
curl --request POST \
--url https://api.staging.bma.beeos.ai/v1/machine_pools/{pool_id}/grants \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"description": "<string>",
"default_machine_cpu": 1073741824,
"default_machine_memory_mb": 1073741824,
"default_machine_env_overlay": {},
"default_machine_secret_env_overlay": {},
"default_machine_provider_options_overlay": {},
"default_cwd": "<string>",
"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": 0,
"metadata": {},
"project_id": "<string>"
}
'import requests
url = "https://api.staging.bma.beeos.ai/v1/machine_pools/{pool_id}/grants"
payload = {
"description": "<string>",
"default_machine_cpu": 1073741824,
"default_machine_memory_mb": 1073741824,
"default_machine_env_overlay": {},
"default_machine_secret_env_overlay": {},
"default_machine_provider_options_overlay": {},
"default_cwd": "<string>",
"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": 0,
"metadata": {},
"project_id": "<string>"
}
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({
description: '<string>',
default_machine_cpu: 1073741824,
default_machine_memory_mb: 1073741824,
default_machine_env_overlay: {},
default_machine_secret_env_overlay: {},
default_machine_provider_options_overlay: {},
default_cwd: '<string>',
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: 0,
metadata: {},
project_id: '<string>'
})
};
fetch('https://api.staging.bma.beeos.ai/v1/machine_pools/{pool_id}/grants', 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/machine_pools/{pool_id}/grants"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"default_machine_cpu\": 1073741824,\n \"default_machine_memory_mb\": 1073741824,\n \"default_machine_env_overlay\": {},\n \"default_machine_secret_env_overlay\": {},\n \"default_machine_provider_options_overlay\": {},\n \"default_cwd\": \"<string>\",\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\": 0,\n \"metadata\": {},\n \"project_id\": \"<string>\"\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_pool_grant",
"id": "<string>",
"org_id": "<string>",
"project_id": "<string>",
"machine_pool_id": "<string>",
"description": "<string>",
"default_machine_cpu": 1073741824,
"default_machine_memory_mb": 1073741824,
"default_machine_env_overlay": {},
"default_machine_secret_env_overlay": {},
"default_machine_provider_options_overlay": {},
"default_cwd": "<string>",
"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": 0,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"machine_pool": {
"type": "machine_pool",
"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
}
}
}{
"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
apiKeybearer
Headers
Project scope. Required when the API key can access more than one project (alias: anthropic-workspace-id).
Replays the first result of a create; the same key with another body is 409.
Required string length:
1 - 255Path Parameters
Body
application/json
The grant body; the pool is the path and the project is project_id, the x-bma-project-id header or the default.
Optional note about this grant.
Default CPU count for machines this project creates from the pool, overriding the pool's default.
Required range:
1 <= x <= 2147483647Default memory in MB for machines this project creates from the pool, overriding the pool's default.
Required range:
1 <= x <= 2147483647Env overlay merged over the pool's default_machine_env for machines materialized through this grant; a null entry removes the key.
Show child attributes
Show child attributes
Secret env overlay merged over the pool's default_machine_secret_env for machines materialized through this grant; a null entry removes the key.
Show child attributes
Show child attributes
Provider-specific options layered over the pool's provider options for this project's machines.
Default working directory for processes on this project's machines from the pool.
Maximum number of live machines this project can have from the pool.
Required range:
0 <= x <= 2147483647Maximum total CPU across this project's live machines from the pool.
Required range:
0 <= x <= 2147483647Maximum total memory in MB across this project's live machines from the pool.
Required range:
0 <= x <= 2147483647Smallest CPU count one of this project's machines can request.
Required range:
0 <= x <= 2147483647Smallest memory in MB one of this project's machines can request.
Required range:
0 <= x <= 2147483647Largest CPU count one of this project's machines can request.
Required range:
1 <= x <= 2147483647Largest memory in MB one of this project's machines can request.
Required range:
1 <= x <= 2147483647Idle minutes before deleting a machine created through this grant. Use 0 to disable for this grant; omit to inherit the pool default. Values from 1 through 4 are invalid.
Required range:
0 <= x <= 2147483647Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
Show child attributes
Show child attributes
Response
Success.
Allowed value:
"machine_pool_grant"Pattern:
^pmpg_[a-z2-7]{26}$Pattern:
^org_[a-z2-7]{26}$Project ID (proj_...).
Pattern:
^proj_[a-z2-7]{26}$Machine pool ID (mpo_...).
Pattern:
^mpo_[a-z2-7]{26}$Required range:
1 <= x <= 2147483647Required range:
1 <= x <= 2147483647Env overlay merged over the pool's default_machine_env for machines materialized through this grant; a null entry removes the key.
Show child attributes
Show child attributes
Secret env overlay merged over the pool's default_machine_secret_env for machines materialized through this grant; a null entry removes the key.
Show child attributes
Show child attributes
Required range:
0 <= x <= 2147483647Required range:
0 <= x <= 2147483647Required range:
0 <= x <= 2147483647Required range:
0 <= x <= 2147483647Required range:
0 <= x <= 2147483647Required range:
1 <= x <= 2147483647Required range:
1 <= x <= 2147483647Idle minutes before deleting a machine created through this grant. Zero disables deletion for this grant; null inherits the pool default.
Required range:
0 <= x <= 2147483647Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
Show child attributes
Show child attributes
Present on list items.
Show child attributes
Show child attributes