Update project machine pool grant

curl --request PATCH \
  --url https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/machine-pool-grants/{poolGrantID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --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": {}
}
'

import requests

url = "https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/machine-pool-grants/{poolGrantID}"

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": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', '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: {}
  })
};

fetch('https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/machine-pool-grants/{poolGrantID}', 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}/projects/{projectID}/machine-pool-grants/{poolGrantID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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' => [
        
    ]
  ]),
  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}/projects/{projectID}/machine-pool-grants/{poolGrantID}"

	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}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/machine-pool-grants/{poolGrantID}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\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}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/machine-pool-grants/{poolGrantID}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\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}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "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"
}

PATCH

orgs

{orgID}

projects

{projectID}

machine-pool-grants

{poolGrantID}

Update project machine pool grant

curl --request PATCH \
  --url https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/machine-pool-grants/{poolGrantID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --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": {}
}
'

import requests

url = "https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/machine-pool-grants/{poolGrantID}"

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": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', '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: {}
  })
};

fetch('https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/machine-pool-grants/{poolGrantID}', 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}/projects/{projectID}/machine-pool-grants/{poolGrantID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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' => [
        
    ]
  ]),
  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}/projects/{projectID}/machine-pool-grants/{poolGrantID}"

	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}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/machine-pool-grants/{poolGrantID}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\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}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/machine-pool-grants/{poolGrantID}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\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}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "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}$

projectID

string

required

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

poolGrantID

string

required

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

Body

application/json

Update a project machine pool grant. Omitted fields keep their current values. Null clears an override so the grant follows the machine pool again. Overlay objects and metadata are replaced whole when present; send an empty object to clear them.

description

string

default_machine_cpu

integer<int32> | null

Required range: 1 <= x <= 2147483647

default_machine_memory_mb

integer<int32> | null

Required range: 1 <= x <= 2147483647

default_machine_env_overlay

object

Show child attributes

default_machine_secret_env_overlay

object

Show child attributes

default_machine_provider_options_overlay

object

default_cwd

string

max_total_machines

integer<int32> | null

Required range: 0 <= x <= 2147483647

max_total_cpu

integer<int32> | null

Required range: 0 <= x <= 2147483647

max_total_memory_mb

integer<int32> | null

Required range: 0 <= x <= 2147483647

min_machine_cpu

integer<int32> | null

Required range: 0 <= x <= 2147483647

min_machine_memory_mb

integer<int32> | null

Required range: 0 <= x <= 2147483647

max_machine_cpu

integer<int32> | null

Required range: 1 <= x <= 2147483647

max_machine_memory_mb

integer<int32> | null

Required range: 1 <= x <= 2147483647

delete_after_idle_minutes

Idle minutes before deleting a machine created through this grant. Use 0 to disable for this grant; null restores inheritance from the pool; omitted leaves it unchanged. Values from 1 through 4 are invalid.

Required range: 0 <= x <= 2147483647

metadata

object

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

Show child attributes

Response

Project machine pool grant updated.

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.

Show child attributes

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.

Show child attributes

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.

Show child attributes

created_at

string<date-time>

required

updated_at

string<date-time>

required

API reference

Endpoints

Update project machine pool grant

Authorizations

Path Parameters

Body

Response