Approve a headless installation - Reason Machines Documentation

Approve a headless installation

curl --request POST \
  --url https://api.reasonmachines.ai/v3/organizations/{orgId}/devices/enrollment-tickets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "install_id": "<string>",
  "code_challenge": "<string>",
  "roots": [
    {
      "path_fingerprint": "<string>",
      "permissions": {
        "read": true,
        "write": true,
        "execute": true,
        "discover_environment": true,
        "expose_mcp": false
      },
      "execution_mode": "confined"
    }
  ],
  "ttl_seconds": 61
}
'

import requests

url = "https://api.reasonmachines.ai/v3/organizations/{orgId}/devices/enrollment-tickets"

payload = {
    "install_id": "<string>",
    "code_challenge": "<string>",
    "roots": [
        {
            "path_fingerprint": "<string>",
            "permissions": {
                "read": True,
                "write": True,
                "execute": True,
                "discover_environment": True,
                "expose_mcp": False
            },
            "execution_mode": "confined"
        }
    ],
    "ttl_seconds": 61
}
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({
    install_id: '<string>',
    code_challenge: '<string>',
    roots: [
      {
        path_fingerprint: '<string>',
        permissions: {
          read: true,
          write: true,
          execute: true,
          discover_environment: true,
          expose_mcp: false
        },
        execution_mode: 'confined'
      }
    ],
    ttl_seconds: 61
  })
};

fetch('https://api.reasonmachines.ai/v3/organizations/{orgId}/devices/enrollment-tickets', 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.reasonmachines.ai/v3/organizations/{orgId}/devices/enrollment-tickets",
  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([
    'install_id' => '<string>',
    'code_challenge' => '<string>',
    'roots' => [
        [
                'path_fingerprint' => '<string>',
                'permissions' => [
                                'read' => true,
                                'write' => true,
                                'execute' => true,
                                'discover_environment' => true,
                                'expose_mcp' => false
                ],
                'execution_mode' => 'confined'
        ]
    ],
    'ttl_seconds' => 61
  ]),
  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.reasonmachines.ai/v3/organizations/{orgId}/devices/enrollment-tickets"

	payload := strings.NewReader("{\n  \"install_id\": \"<string>\",\n  \"code_challenge\": \"<string>\",\n  \"roots\": [\n    {\n      \"path_fingerprint\": \"<string>\",\n      \"permissions\": {\n        \"read\": true,\n        \"write\": true,\n        \"execute\": true,\n        \"discover_environment\": true,\n        \"expose_mcp\": false\n      },\n      \"execution_mode\": \"confined\"\n    }\n  ],\n  \"ttl_seconds\": 61\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.reasonmachines.ai/v3/organizations/{orgId}/devices/enrollment-tickets")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"install_id\": \"<string>\",\n  \"code_challenge\": \"<string>\",\n  \"roots\": [\n    {\n      \"path_fingerprint\": \"<string>\",\n      \"permissions\": {\n        \"read\": true,\n        \"write\": true,\n        \"execute\": true,\n        \"discover_environment\": true,\n        \"expose_mcp\": false\n      },\n      \"execution_mode\": \"confined\"\n    }\n  ],\n  \"ttl_seconds\": 61\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.reasonmachines.ai/v3/organizations/{orgId}/devices/enrollment-tickets")

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  \"install_id\": \"<string>\",\n  \"code_challenge\": \"<string>\",\n  \"roots\": [\n    {\n      \"path_fingerprint\": \"<string>\",\n      \"permissions\": {\n        \"read\": true,\n        \"write\": true,\n        \"execute\": true,\n        \"discover_environment\": true,\n        \"expose_mcp\": false\n      },\n      \"execution_mode\": \"confined\"\n    }\n  ],\n  \"ttl_seconds\": 61\n}"

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

{
  "enrollment_ticket": "<string>",
  "expires_at": "<string>",
  "device_kind": "headless",
  "lifecycle": "persistent",
  "device_expires_at": "<string>"
}

POST

/

v3

/

organizations

/

{orgId}

/

devices

/

enrollment-tickets

Approve a headless installation

curl --request POST \
  --url https://api.reasonmachines.ai/v3/organizations/{orgId}/devices/enrollment-tickets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "install_id": "<string>",
  "code_challenge": "<string>",
  "roots": [
    {
      "path_fingerprint": "<string>",
      "permissions": {
        "read": true,
        "write": true,
        "execute": true,
        "discover_environment": true,
        "expose_mcp": false
      },
      "execution_mode": "confined"
    }
  ],
  "ttl_seconds": 61
}
'

import requests

url = "https://api.reasonmachines.ai/v3/organizations/{orgId}/devices/enrollment-tickets"

payload = {
    "install_id": "<string>",
    "code_challenge": "<string>",
    "roots": [
        {
            "path_fingerprint": "<string>",
            "permissions": {
                "read": True,
                "write": True,
                "execute": True,
                "discover_environment": True,
                "expose_mcp": False
            },
            "execution_mode": "confined"
        }
    ],
    "ttl_seconds": 61
}
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({
    install_id: '<string>',
    code_challenge: '<string>',
    roots: [
      {
        path_fingerprint: '<string>',
        permissions: {
          read: true,
          write: true,
          execute: true,
          discover_environment: true,
          expose_mcp: false
        },
        execution_mode: 'confined'
      }
    ],
    ttl_seconds: 61
  })
};

fetch('https://api.reasonmachines.ai/v3/organizations/{orgId}/devices/enrollment-tickets', 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.reasonmachines.ai/v3/organizations/{orgId}/devices/enrollment-tickets",
  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([
    'install_id' => '<string>',
    'code_challenge' => '<string>',
    'roots' => [
        [
                'path_fingerprint' => '<string>',
                'permissions' => [
                                'read' => true,
                                'write' => true,
                                'execute' => true,
                                'discover_environment' => true,
                                'expose_mcp' => false
                ],
                'execution_mode' => 'confined'
        ]
    ],
    'ttl_seconds' => 61
  ]),
  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.reasonmachines.ai/v3/organizations/{orgId}/devices/enrollment-tickets"

	payload := strings.NewReader("{\n  \"install_id\": \"<string>\",\n  \"code_challenge\": \"<string>\",\n  \"roots\": [\n    {\n      \"path_fingerprint\": \"<string>\",\n      \"permissions\": {\n        \"read\": true,\n        \"write\": true,\n        \"execute\": true,\n        \"discover_environment\": true,\n        \"expose_mcp\": false\n      },\n      \"execution_mode\": \"confined\"\n    }\n  ],\n  \"ttl_seconds\": 61\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.reasonmachines.ai/v3/organizations/{orgId}/devices/enrollment-tickets")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"install_id\": \"<string>\",\n  \"code_challenge\": \"<string>\",\n  \"roots\": [\n    {\n      \"path_fingerprint\": \"<string>\",\n      \"permissions\": {\n        \"read\": true,\n        \"write\": true,\n        \"execute\": true,\n        \"discover_environment\": true,\n        \"expose_mcp\": false\n      },\n      \"execution_mode\": \"confined\"\n    }\n  ],\n  \"ttl_seconds\": 61\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.reasonmachines.ai/v3/organizations/{orgId}/devices/enrollment-tickets")

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  \"install_id\": \"<string>\",\n  \"code_challenge\": \"<string>\",\n  \"roots\": [\n    {\n      \"path_fingerprint\": \"<string>\",\n      \"permissions\": {\n        \"read\": true,\n        \"write\": true,\n        \"execute\": true,\n        \"discover_environment\": true,\n        \"expose_mcp\": false\n      },\n      \"execution_mode\": \"confined\"\n    }\n  ],\n  \"ttl_seconds\": 61\n}"

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

{
  "enrollment_ticket": "<string>",
  "expires_at": "<string>",
  "device_kind": "headless",
  "lifecycle": "persistent",
  "device_expires_at": "<string>"
}

Authorizations

Authorization

string

header

required

Your ara_ API key from Settings > Ara API. Keys are capability-scoped: run, mcp:read, mcp:write, secrets:read, secrets:write, sessions:read, sessions:debug, knowledge:read, memory:read, memory:write, skills:read, skills:write, repos:read, repos:write, reviews:read, reviews:write, deployment:read, analytics:read, org:read, org:write, attachments:read, attachments:write, guardrails:read, guardrails:write, automations:read, automations:write, agent_auth:read. mcp:write manages MCP server configuration only; it does not authorize remote MCP-tool execution. sessions:debug is privileged: it expands diagnostic session events only for organization owners/admins.

Path Parameters

orgId

string

required

Organization id or slug. Resolve it with GET /v3/self.

Body

application/json

Single-use P-256/PKCE headless enrollment. Persistent TTL defaults to 30 days (maximum 90 days); ephemeral defaults to 1 hour (maximum 24 hours). Minimum TTL is 60 seconds. Root fingerprints and permissions are the approval ceiling; unknown fields, including device_kind and bound_run_id, are rejected.

install_id

string

required

Required string length: 16 - 160

code_challenge

string

required

Pattern: ^[A-Za-z0-9_-]{43}$

lifecycle

enum<string>

required

Available options:

persistent,

ephemeral

roots

object[]

required

Required array length: 1 - 32 elements

Show child attributes

ttl_seconds

integer

Required range: x >= 60

Response

One-use ticket; redeem on the existing signed Device transport within 120 seconds.

enrollment_ticket

string

required

expires_at

string

required

device_kind

string

required

Allowed value: "headless"

lifecycle

enum<string>

required

Available options:

persistent,

ephemeral

device_expires_at

string

required