Create machine

curl --request POST \
  --url https://api.omnara.com/v1/orgs/{orgID}/machines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "description": "<string>",
  "cwd": "<string>",
  "env": {},
  "secret_env": {},
  "metadata": {}
}
'

import requests

url = "https://api.omnara.com/v1/orgs/{orgID}/machines"

payload = {
    "display_name": "<string>",
    "description": "<string>",
    "cwd": "<string>",
    "env": {},
    "secret_env": {},
    "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({
    display_name: '<string>',
    description: '<string>',
    cwd: '<string>',
    env: {},
    secret_env: {},
    metadata: {}
  })
};

fetch('https://api.omnara.com/v1/orgs/{orgID}/machines', 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}/machines",
  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([
    'display_name' => '<string>',
    'description' => '<string>',
    'cwd' => '<string>',
    'env' => [
        
    ],
    'secret_env' => [
        
    ],
    '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}/machines"

	payload := strings.NewReader("{\n  \"display_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"env\": {},\n  \"secret_env\": {},\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}/machines")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"display_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"env\": {},\n  \"secret_env\": {},\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"display_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"env\": {},\n  \"secret_env\": {},\n  \"metadata\": {}\n}"

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

{
  "id": "<string>",
  "org_id": "<string>",
  "source_kind": "byo",
  "display_name": "<string>",
  "description": "<string>",
  "provider": "<string>",
  "lifecycle_state": "provisioning",
  "connection_state": "online",
  "last_observed_at": "2023-11-07T05:31:56Z",
  "cwd": "<string>",
  "env": {},
  "secret_env": {},
  "lifecycle_reason_code": "<string>",
  "lifecycle_reason_message": "<string>",
  "next_reconcile_after": "2023-11-07T05:31:56Z",
  "provision_attempts": 123,
  "delete_attempts": 123,
  "metadata": {},
  "deleted_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "machine_pool_id": "<string>",
  "connection_state_reason": "<string>",
  "failure_report": {
    "stage": "startup_script",
    "output_tail": "<string>",
    "output_truncated": true,
    "reported_at": "2023-11-07T05:31:56Z",
    "exit_status": 123,
    "daemon_version": "<string>",
    "target_version": "<string>"
  }
}

{
  "id": "<string>",
  "org_id": "<string>",
  "source_kind": "byo",
  "display_name": "<string>",
  "description": "<string>",
  "provider": "<string>",
  "lifecycle_state": "provisioning",
  "connection_state": "online",
  "last_observed_at": "2023-11-07T05:31:56Z",
  "cwd": "<string>",
  "env": {},
  "secret_env": {},
  "lifecycle_reason_code": "<string>",
  "lifecycle_reason_message": "<string>",
  "next_reconcile_after": "2023-11-07T05:31:56Z",
  "provision_attempts": 123,
  "delete_attempts": 123,
  "metadata": {},
  "deleted_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "machine_pool_id": "<string>",
  "connection_state_reason": "<string>",
  "failure_report": {
    "stage": "startup_script",
    "output_tail": "<string>",
    "output_truncated": true,
    "reported_at": "2023-11-07T05:31:56Z",
    "exit_status": 123,
    "daemon_version": "<string>",
    "target_version": "<string>"
  }
}

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

machines

Create machine

curl --request POST \
  --url https://api.omnara.com/v1/orgs/{orgID}/machines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "description": "<string>",
  "cwd": "<string>",
  "env": {},
  "secret_env": {},
  "metadata": {}
}
'

import requests

url = "https://api.omnara.com/v1/orgs/{orgID}/machines"

payload = {
    "display_name": "<string>",
    "description": "<string>",
    "cwd": "<string>",
    "env": {},
    "secret_env": {},
    "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({
    display_name: '<string>',
    description: '<string>',
    cwd: '<string>',
    env: {},
    secret_env: {},
    metadata: {}
  })
};

fetch('https://api.omnara.com/v1/orgs/{orgID}/machines', 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}/machines",
  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([
    'display_name' => '<string>',
    'description' => '<string>',
    'cwd' => '<string>',
    'env' => [
        
    ],
    'secret_env' => [
        
    ],
    '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}/machines"

	payload := strings.NewReader("{\n  \"display_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"env\": {},\n  \"secret_env\": {},\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}/machines")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"display_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"env\": {},\n  \"secret_env\": {},\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"display_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"env\": {},\n  \"secret_env\": {},\n  \"metadata\": {}\n}"

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

{
  "id": "<string>",
  "org_id": "<string>",
  "source_kind": "byo",
  "display_name": "<string>",
  "description": "<string>",
  "provider": "<string>",
  "lifecycle_state": "provisioning",
  "connection_state": "online",
  "last_observed_at": "2023-11-07T05:31:56Z",
  "cwd": "<string>",
  "env": {},
  "secret_env": {},
  "lifecycle_reason_code": "<string>",
  "lifecycle_reason_message": "<string>",
  "next_reconcile_after": "2023-11-07T05:31:56Z",
  "provision_attempts": 123,
  "delete_attempts": 123,
  "metadata": {},
  "deleted_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "machine_pool_id": "<string>",
  "connection_state_reason": "<string>",
  "failure_report": {
    "stage": "startup_script",
    "output_tail": "<string>",
    "output_truncated": true,
    "reported_at": "2023-11-07T05:31:56Z",
    "exit_status": 123,
    "daemon_version": "<string>",
    "target_version": "<string>"
  }
}

{
  "id": "<string>",
  "org_id": "<string>",
  "source_kind": "byo",
  "display_name": "<string>",
  "description": "<string>",
  "provider": "<string>",
  "lifecycle_state": "provisioning",
  "connection_state": "online",
  "last_observed_at": "2023-11-07T05:31:56Z",
  "cwd": "<string>",
  "env": {},
  "secret_env": {},
  "lifecycle_reason_code": "<string>",
  "lifecycle_reason_message": "<string>",
  "next_reconcile_after": "2023-11-07T05:31:56Z",
  "provision_attempts": 123,
  "delete_attempts": 123,
  "metadata": {},
  "deleted_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "machine_pool_id": "<string>",
  "connection_state_reason": "<string>",
  "failure_report": {
    "stage": "startup_script",
    "output_tail": "<string>",
    "output_truncated": true,
    "reported_at": "2023-11-07T05:31:56Z",
    "exit_status": 123,
    "daemon_version": "<string>",
    "target_version": "<string>"
  }
}

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

Headers

Idempotency-Key

string

Idempotency key for replay-safe mutating requests.

Required string length: 1 - 255

Path Parameters

orgID

string

required

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

Body

application/json

display_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

description

string

cwd

string

env

object

Show child attributes

secret_env

object

Show child attributes

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

string

required

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

org_id

string

required

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

source_kind

enum<string>

required

Available options:

byo,

pool

display_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

description

string

required

provider

string

required

lifecycle_state

enum<string>

required

Available options:

provisioning,

provision_failed,

active,

deleting,

delete_failed,

deleted

connection_state

enum<string>

required

Available options:

online,

asleep,

offline

last_observed_at

string<date-time> | null

required

cwd

string

required

env

object

required

Show child attributes

secret_env

object

required

Show child attributes

lifecycle_reason_code

string

required

lifecycle_reason_message

string

required

next_reconcile_after

string<date-time> | null

required

provision_attempts

integer<int32>

required

delete_attempts

integer<int32>

required

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

deleted_at

string<date-time> | null

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

machine_pool_id

string | null

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

connection_state_reason

string

failure_report

object

The machine's most recent daemon-reported failure. A single slot, overwritten by newer reports and cleared when the daemon recovers.

Show child attributes

API reference

Endpoints

Create machine

Authorizations

Headers

Path Parameters

Body

Response