Skip to main content
GET
Get project machine pool grant

Authorizations

Authorization
string
header
required

An opaque Omnara personal or organization bearer token.

Path Parameters

orgID
string
required
Pattern: ^org_[a-z2-7]{26}$
projectID
string
required
Pattern: ^proj_[a-z2-7]{26}$
poolGrantID
string
required
Pattern: ^pmpg_[a-z2-7]{26}$

Response

Project machine pool grant.

id
string
required
Pattern: ^pmpg_[a-z2-7]{26}$
org_id
string
required
Pattern: ^org_[a-z2-7]{26}$
project_id
string
required
Pattern: ^proj_[a-z2-7]{26}$
machine_pool_id
string
required
Pattern: ^mpo_[a-z2-7]{26}$
description
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_overlay
object
required

Env overlay merged over the pool's default_machine_env for machines materialized through this grant; a null entry removes the key.

default_machine_secret_env_overlay
object
required

Secret env overlay merged over the pool's default_machine_secret_env for machines materialized through this grant; a null entry removes the key.

default_machine_provider_options_overlay
object
required
default_cwd
string
required
max_total_machines
integer<int32> | null
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
required

Idle minutes before deleting a machine created through this grant. Zero disables deletion for this grant; null inherits the pool default.

Required range: 0 <= 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.

created_at
string<date-time>
required
updated_at
string<date-time>
required