Machine Pools

Create machine pool

Changed on
post/orgs/{orgID}/machine-pools

Request

  • Base URL: https://api.omnara.com/v1
  • URL: https://api.omnara.com/v1/orgs/{orgID}/machine-pools
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-omnara_session and API key in header X-Omnara-Csrf

Request body

CreateMachinePoolRequest required(unresolved $ref)

Response

Existing machine pool returned.

idstring required
org_idstring required
namestring required

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

management_kind'tenant' | 'cluster' 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.

descriptionstring required
providerstring required
default_machine_cpuinteger nullable required
default_machine_memory_mbinteger nullable required
default_machine_envobject required

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.

default_machine_secret_envobject 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.

default_machine_provider_optionsobject required
default_cwdstring required
provider_auth_secret_idstring
provider_configobject required
runtime_protection_enabledboolean required

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

max_total_machinesinteger required
max_total_cpuinteger nullable required
max_total_memory_mbinteger nullable required
min_machine_cpuinteger nullable required
min_machine_memory_mbinteger nullable required
max_machine_cpuinteger nullable required
max_machine_memory_mbinteger nullable required
delete_after_idle_minutesinteger nullable required

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

metadataMetadata required

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

created_atstring date-time required
updated_atstring date-time required

Changes

    • info

      added the new createos enum value to the request property //

    • info

      added the new boxd enum value to the request property //