Create machine pool

curl --request POST \
  --url https://api.omnara.com/v1/orgs/{orgID}/machine-pools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "provider": "unikraft",
  "default_machine_cpu": 1073741824,
  "default_machine_memory_mb": 1073741824,
  "default_machine_provider_options": {},
  "provider_auth_secret_id": "<string>",
  "max_total_machines": 1073741823,
  "max_total_cpu": 1073741823,
  "max_total_memory_mb": 1073741823,
  "max_machine_cpu": 1073741824,
  "max_machine_memory_mb": 1073741824,
  "description": "<string>",
  "default_machine_env": {},
  "default_machine_secret_env": {},
  "default_cwd": "<string>",
  "provider_config": {},
  "runtime_protection_enabled": false,
  "min_machine_cpu": 1073741823,
  "min_machine_memory_mb": 1073741823,
  "delete_after_idle_minutes": 1073741826,
  "metadata": {}
}
'

import requests

url = "https://api.omnara.com/v1/orgs/{orgID}/machine-pools"

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

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

print(response.text)

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

fetch('https://api.omnara.com/v1/orgs/{orgID}/machine-pools', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.omnara.com/v1/orgs/{orgID}/machine-pools",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'provider' => 'unikraft',
    'default_machine_cpu' => 1073741824,
    'default_machine_memory_mb' => 1073741824,
    'default_machine_provider_options' => [
        
    ],
    'provider_auth_secret_id' => '<string>',
    'max_total_machines' => 1073741823,
    'max_total_cpu' => 1073741823,
    'max_total_memory_mb' => 1073741823,
    'max_machine_cpu' => 1073741824,
    'max_machine_memory_mb' => 1073741824,
    'description' => '<string>',
    'default_machine_env' => [
        
    ],
    'default_machine_secret_env' => [
        
    ],
    'default_cwd' => '<string>',
    'provider_config' => [
        
    ],
    'runtime_protection_enabled' => false,
    'min_machine_cpu' => 1073741823,
    'min_machine_memory_mb' => 1073741823,
    'delete_after_idle_minutes' => 1073741826,
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.omnara.com/v1/orgs/{orgID}/machine-pools"

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

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

}

HttpResponse<String> response = Unirest.post("https://api.omnara.com/v1/orgs/{orgID}/machine-pools")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"provider\": \"unikraft\",\n  \"default_machine_cpu\": 1073741824,\n  \"default_machine_memory_mb\": 1073741824,\n  \"default_machine_provider_options\": {},\n  \"provider_auth_secret_id\": \"<string>\",\n  \"max_total_machines\": 1073741823,\n  \"max_total_cpu\": 1073741823,\n  \"max_total_memory_mb\": 1073741823,\n  \"max_machine_cpu\": 1073741824,\n  \"max_machine_memory_mb\": 1073741824,\n  \"description\": \"<string>\",\n  \"default_machine_env\": {},\n  \"default_machine_secret_env\": {},\n  \"default_cwd\": \"<string>\",\n  \"provider_config\": {},\n  \"runtime_protection_enabled\": false,\n  \"min_machine_cpu\": 1073741823,\n  \"min_machine_memory_mb\": 1073741823,\n  \"delete_after_idle_minutes\": 1073741826,\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.omnara.com/v1/orgs/{orgID}/machine-pools")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"provider\": \"unikraft\",\n  \"default_machine_cpu\": 1073741824,\n  \"default_machine_memory_mb\": 1073741824,\n  \"default_machine_provider_options\": {},\n  \"provider_auth_secret_id\": \"<string>\",\n  \"max_total_machines\": 1073741823,\n  \"max_total_cpu\": 1073741823,\n  \"max_total_memory_mb\": 1073741823,\n  \"max_machine_cpu\": 1073741824,\n  \"max_machine_memory_mb\": 1073741824,\n  \"description\": \"<string>\",\n  \"default_machine_env\": {},\n  \"default_machine_secret_env\": {},\n  \"default_cwd\": \"<string>\",\n  \"provider_config\": {},\n  \"runtime_protection_enabled\": false,\n  \"min_machine_cpu\": 1073741823,\n  \"min_machine_memory_mb\": 1073741823,\n  \"delete_after_idle_minutes\": 1073741826,\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_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,
  "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
  }
}

{
  "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,
  "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": "invalid_request"
}

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

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

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

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

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

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

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

POST

orgs

{orgID}

machine-pools

Create machine pool

curl --request POST \
  --url https://api.omnara.com/v1/orgs/{orgID}/machine-pools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "provider": "unikraft",
  "default_machine_cpu": 1073741824,
  "default_machine_memory_mb": 1073741824,
  "default_machine_provider_options": {},
  "provider_auth_secret_id": "<string>",
  "max_total_machines": 1073741823,
  "max_total_cpu": 1073741823,
  "max_total_memory_mb": 1073741823,
  "max_machine_cpu": 1073741824,
  "max_machine_memory_mb": 1073741824,
  "description": "<string>",
  "default_machine_env": {},
  "default_machine_secret_env": {},
  "default_cwd": "<string>",
  "provider_config": {},
  "runtime_protection_enabled": false,
  "min_machine_cpu": 1073741823,
  "min_machine_memory_mb": 1073741823,
  "delete_after_idle_minutes": 1073741826,
  "metadata": {}
}
'

import requests

url = "https://api.omnara.com/v1/orgs/{orgID}/machine-pools"

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

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

print(response.text)

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

fetch('https://api.omnara.com/v1/orgs/{orgID}/machine-pools', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.omnara.com/v1/orgs/{orgID}/machine-pools",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'provider' => 'unikraft',
    'default_machine_cpu' => 1073741824,
    'default_machine_memory_mb' => 1073741824,
    'default_machine_provider_options' => [
        
    ],
    'provider_auth_secret_id' => '<string>',
    'max_total_machines' => 1073741823,
    'max_total_cpu' => 1073741823,
    'max_total_memory_mb' => 1073741823,
    'max_machine_cpu' => 1073741824,
    'max_machine_memory_mb' => 1073741824,
    'description' => '<string>',
    'default_machine_env' => [
        
    ],
    'default_machine_secret_env' => [
        
    ],
    'default_cwd' => '<string>',
    'provider_config' => [
        
    ],
    'runtime_protection_enabled' => false,
    'min_machine_cpu' => 1073741823,
    'min_machine_memory_mb' => 1073741823,
    'delete_after_idle_minutes' => 1073741826,
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.omnara.com/v1/orgs/{orgID}/machine-pools"

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

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

}

HttpResponse<String> response = Unirest.post("https://api.omnara.com/v1/orgs/{orgID}/machine-pools")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"provider\": \"unikraft\",\n  \"default_machine_cpu\": 1073741824,\n  \"default_machine_memory_mb\": 1073741824,\n  \"default_machine_provider_options\": {},\n  \"provider_auth_secret_id\": \"<string>\",\n  \"max_total_machines\": 1073741823,\n  \"max_total_cpu\": 1073741823,\n  \"max_total_memory_mb\": 1073741823,\n  \"max_machine_cpu\": 1073741824,\n  \"max_machine_memory_mb\": 1073741824,\n  \"description\": \"<string>\",\n  \"default_machine_env\": {},\n  \"default_machine_secret_env\": {},\n  \"default_cwd\": \"<string>\",\n  \"provider_config\": {},\n  \"runtime_protection_enabled\": false,\n  \"min_machine_cpu\": 1073741823,\n  \"min_machine_memory_mb\": 1073741823,\n  \"delete_after_idle_minutes\": 1073741826,\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.omnara.com/v1/orgs/{orgID}/machine-pools")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"provider\": \"unikraft\",\n  \"default_machine_cpu\": 1073741824,\n  \"default_machine_memory_mb\": 1073741824,\n  \"default_machine_provider_options\": {},\n  \"provider_auth_secret_id\": \"<string>\",\n  \"max_total_machines\": 1073741823,\n  \"max_total_cpu\": 1073741823,\n  \"max_total_memory_mb\": 1073741823,\n  \"max_machine_cpu\": 1073741824,\n  \"max_machine_memory_mb\": 1073741824,\n  \"description\": \"<string>\",\n  \"default_machine_env\": {},\n  \"default_machine_secret_env\": {},\n  \"default_cwd\": \"<string>\",\n  \"provider_config\": {},\n  \"runtime_protection_enabled\": false,\n  \"min_machine_cpu\": 1073741823,\n  \"min_machine_memory_mb\": 1073741823,\n  \"delete_after_idle_minutes\": 1073741826,\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_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,
  "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
  }
}

{
  "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,
  "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": "invalid_request"
}

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

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

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

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

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

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

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

Authorizations

Authorization

string

header

required

An opaque Omnara personal or organization bearer token.

Path Parameters

orgID

string

required

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

Body

application/json

Option 1
Option 2
Option 3

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

provider

enum<string>

required

Available options:

unikraft

Minimum string length: 1

default_machine_cpu

integer<int32>

required

Required range: 1 <= x <= 2147483647

default_machine_memory_mb

integer<int32>

required

Required range: 1 <= x <= 2147483647

default_machine_provider_options

object

required

provider_auth_secret_id

string

required

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

max_total_machines

integer<int32>

required

Required range: 0 <= x <= 2147483647

max_total_cpu

integer<int32>

required

Required range: 0 <= x <= 2147483647

max_total_memory_mb

integer<int32>

required

Required range: 0 <= x <= 2147483647

max_machine_cpu

integer<int32>

required

Required range: 1 <= x <= 2147483647

max_machine_memory_mb

integer<int32>

required

Required range: 1 <= x <= 2147483647

description

string

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_cwd

string

provider_config

object

runtime_protection_enabled

boolean

default:false

Whether Omnara should delete a pool machine when its provider remains running after its daemon becomes inactive. Defaults to false when omitted.

min_machine_cpu

integer<int32>

Required range: 0 <= x <= 2147483647

min_machine_memory_mb

integer<int32>

Required range: 0 <= x <= 2147483647

delete_after_idle_minutes

integer<int32>

Idle minutes before deleting a machine from this pool. Omit to leave the pool default unset; a grant or agent source may still override it.

Required range: 5 <= x <= 2147483647

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 - Omnara 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

Existing machine pool returned.

string

required

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 Omnara 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

Required range: 0 <= x <= 2147483647

max_total_memory_mb

integer<int32> | null

required

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

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

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

usage

object

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

Show child attributes

API reference

Endpoints

Create machine pool

Authorizations

Path Parameters

Body

Response