AGH RuntimeAPI Reference
Settings
AGH Settings HTTP endpoints.
- Audience
- Operators running durable agent work
- Focus
- API Reference guidance shaped for scanability, day-two clarity, and operator context.
Trigger a daemon restart using the persisted relaunch helper flow
POST
/api/settings/actions/restartResponse Body
application/json
application/json
application/json
curl -X POST "https://loading/api/settings/actions/restart"{
"active_session_count": 0,
"operation_id": "string",
"status": "pending",
"status_url": "string"
}{
"error": "string"
}{
"error": "string"
}Empty
Get the persisted status for one daemon restart operation
GET
/api/settings/actions/restart/{operation_id}Path Parameters
operation_id*string
Restart operation id
Response Body
application/json
application/json
application/json
curl -X GET "https://loading/api/settings/actions/restart/string"{
"active_session_count": 0,
"completed_at": "2019-08-24T14:15:22Z",
"failure_reason": "string",
"new_pid": 0,
"old_pid": 0,
"old_socket_path": "string",
"old_started_at": "2019-08-24T14:15:22Z",
"operation_id": "string",
"started_at": "2019-08-24T14:15:22Z",
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z"
}{
"error": "string"
}{
"error": "string"
}Empty
Read the automation settings section
GET
/api/settings/automationResponse Body
application/json
application/json
curl -X GET "https://loading/api/settings/automation"{
"available_scopes": [
"global"
],
"config": {
"default_fire_limit": {
"max": 0,
"window": "string"
},
"enabled": true,
"max_concurrent_jobs": 0,
"timezone": "string"
},
"links": [
{
"label": "string",
"path": "string"
}
],
"runtime": {
"available": true,
"job_enabled": 0,
"job_total": 0,
"last_synced_at": "2019-08-24T14:15:22Z",
"next_fire": "2019-08-24T14:15:22Z",
"running": true,
"scheduler_running": true,
"trigger_enabled": 0,
"trigger_total": 0
},
"scope": "global",
"section": "general",
"workspace_id": "string"
}{
"error": "string"
}Empty
Update the automation settings section
PATCH
/api/settings/automationRequest Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://loading/api/settings/automation" \ -H "Content-Type: application/json" \ -d '{ "config": { "default_fire_limit": { "max": 0, "window": "string" }, "enabled": true, "max_concurrent_jobs": 0, "timezone": "string" } }'{
"applied": true,
"behavior": "applied_now",
"restart_required": true,
"restart_scope": "string",
"scope": "global",
"section": "general",
"warnings": [
"string"
],
"workspace_id": "string",
"write_target": "global-config"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}Empty
Read the general settings section
GET
/api/settings/generalResponse Body
application/json
application/json
curl -X GET "https://loading/api/settings/general"{
"actions": {
"restart": {
"available": true,
"behavior": "applied_now",
"name": "string"
}
},
"available_scopes": [
"global"
],
"config": {
"daemon": {
"socket": "string"
},
"defaults": {
"agent": "string",
"provider": "string",
"sandbox": "string"
},
"http": {
"host": "string",
"port": 0
},
"limits": {
"max_concurrent_agents": 0,
"max_sessions": 0
},
"permissions": {
"mode": "deny-all"
},
"session_timeout": "string"
},
"config_paths": {
"daemon_info": "string",
"global_config": "string",
"global_mcp_sidecar": "string",
"home_dir": "string",
"log_file": "string"
},
"runtime": {
"active_agents": 0,
"active_sessions": 0,
"available": true,
"http_host": "string",
"http_port": 0,
"pid": 0,
"socket": "string",
"started_at": "2019-08-24T14:15:22Z",
"status": "string",
"total_sessions": 0,
"uptime_seconds": 0,
"version": "string"
},
"scope": "global",
"section": "general",
"workspace_id": "string"
}{
"error": "string"
}Empty
Update the general settings section
PATCH
/api/settings/generalRequest Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://loading/api/settings/general" \ -H "Content-Type: application/json" \ -d '{ "config": { "daemon": { "socket": "string" }, "defaults": { "agent": "string" }, "http": { "host": "string", "port": 0 }, "limits": { "max_concurrent_agents": 0, "max_sessions": 0 }, "permissions": { "mode": "deny-all" }, "session_timeout": "string" } }'{
"applied": true,
"behavior": "applied_now",
"restart_required": true,
"restart_scope": "string",
"scope": "global",
"section": "general",
"warnings": [
"string"
],
"workspace_id": "string",
"write_target": "global-config"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}Empty
List settings-backed hook declarations
GET
/api/settings/hooksResponse Body
application/json
application/json
curl -X GET "https://loading/api/settings/hooks"{
"available_scopes": [
"global"
],
"collection": "providers",
"hooks": [
{
"declaration": {
"args": [
"string"
],
"command": "string",
"env": {
"property1": "string",
"property2": "string"
},
"event": "session.pre_create",
"executor_kind": "native",
"matcher": {
"acp_event_type": "string",
"agent_name": "string",
"agent_type": "string",
"autonomy": {
"child_session_id": "string",
"coordination_channel_id": "string",
"coordinator_session_id": "string",
"parent_session_id": "string",
"release_reason": "string",
"root_session_id": "string",
"run_id": "string",
"spawn_role": "string",
"task_id": "string",
"workflow_id": "string"
},
"compaction_reason": "string",
"compaction_strategy": "string",
"decision_class": "string",
"input_class": "string",
"message_delta_type": "string",
"message_role": "string",
"sandbox_backend": "string",
"sandbox_id": "string",
"sandbox_profile": "string",
"session_type": "string",
"sync_direction": "string",
"tool_id": "string",
"tool_name": "string",
"tool_read_only": true,
"turn_id": "string",
"workspace_id": "string",
"workspace_root": "string"
},
"metadata": {
"property1": "string",
"property2": "string"
},
"mode": "sync",
"name": "string",
"priority": 0,
"required": true,
"secret_env": {
"property1": "string",
"property2": "string"
},
"timeout": "string"
},
"name": "string",
"source_metadata": {
"available_targets": [
"global-config"
],
"effective_source": {
"kind": "builtin-provider",
"scope": "global",
"workspace_id": "string"
},
"shadowed_sources": [
{
"kind": "builtin-provider",
"scope": "global",
"workspace_id": "string"
}
]
}
}
],
"scope": "global",
"workspace_id": "string"
}{
"error": "string"
}Empty
Read the hooks and extensions settings section
GET
/api/settings/hooks-extensionsResponse Body
application/json
application/json
curl -X GET "https://loading/api/settings/hooks-extensions"{
"available_scopes": [
"global"
],
"config": {
"marketplace": {
"base_url": "string",
"registry": "string"
},
"resources": {
"allowed_kinds": [
"string"
],
"max_scope": "global",
"operator_write_rate_limit": {
"queue": 0,
"requests": 0,
"window": "string"
},
"snapshot_rate_limit": {
"queue": 0,
"requests": 0,
"window": "string"
}
}
},
"hooks": [
{
"declaration": {
"args": [
"string"
],
"command": "string",
"env": {
"property1": "string",
"property2": "string"
},
"event": "session.pre_create",
"executor_kind": "native",
"matcher": {
"acp_event_type": "string",
"agent_name": "string",
"agent_type": "string",
"autonomy": {
"child_session_id": "string",
"coordination_channel_id": "string",
"coordinator_session_id": "string",
"parent_session_id": "string",
"release_reason": "string",
"root_session_id": "string",
"run_id": "string",
"spawn_role": "string",
"task_id": "string",
"workflow_id": "string"
},
"compaction_reason": "string",
"compaction_strategy": "string",
"decision_class": "string",
"input_class": "string",
"message_delta_type": "string",
"message_role": "string",
"sandbox_backend": "string",
"sandbox_id": "string",
"sandbox_profile": "string",
"session_type": "string",
"sync_direction": "string",
"tool_id": "string",
"tool_name": "string",
"tool_read_only": true,
"turn_id": "string",
"workspace_id": "string",
"workspace_root": "string"
},
"metadata": {
"property1": "string",
"property2": "string"
},
"mode": "sync",
"name": "string",
"priority": 0,
"required": true,
"secret_env": {
"property1": "string",
"property2": "string"
},
"timeout": "string"
},
"name": "string",
"source_metadata": {
"available_targets": [
"global-config"
],
"effective_source": {
"kind": "builtin-provider",
"scope": "global",
"workspace_id": "string"
},
"shadowed_sources": [
{
"kind": "builtin-provider",
"scope": "global",
"workspace_id": "string"
}
]
}
}
],
"installed": [
{
"enabled": true,
"health": "string",
"health_message": "string",
"last_error": "string",
"missing_env": [
"string"
],
"name": "string",
"requires_env": [
"string"
],
"state": "string",
"version": "string"
}
],
"scope": "global",
"section": "general",
"transport_parity": {
"extensions_http": true,
"extensions_uds": true,
"known": true,
"settings_http": true,
"settings_uds": true
},
"workspace_id": "string"
}{
"error": "string"
}Empty
Update the hooks and extensions settings section
PATCH
/api/settings/hooks-extensionsRequest Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://loading/api/settings/hooks-extensions" \ -H "Content-Type: application/json" \ -d '{ "config": { "marketplace": { "registry": "string" }, "resources": { "operator_write_rate_limit": { "queue": 0, "requests": 0, "window": "string" }, "snapshot_rate_limit": { "queue": 0, "requests": 0, "window": "string" } } } }'{
"applied": true,
"behavior": "applied_now",
"restart_required": true,
"restart_scope": "string",
"scope": "global",
"section": "general",
"warnings": [
"string"
],
"workspace_id": "string",
"write_target": "global-config"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}Empty
Delete one settings-backed hook declaration
DELETE
/api/settings/hooks/{name}Path Parameters
name*string
Hook name
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "https://loading/api/settings/hooks/string"{
"applied": true,
"behavior": "applied_now",
"restart_required": true,
"restart_scope": "string",
"scope": "global",
"section": "general",
"warnings": [
"string"
],
"workspace_id": "string",
"write_target": "global-config"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}Empty
Create or replace one settings-backed hook declaration
PUT
/api/settings/hooks/{name}Path Parameters
name*string
Hook name
Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://loading/api/settings/hooks/string" \ -H "Content-Type: application/json" \ -d '{ "declaration": { "event": "session.pre_create", "matcher": {}, "name": "string" } }'{
"applied": true,
"behavior": "applied_now",
"restart_required": true,
"restart_scope": "string",
"scope": "global",
"section": "general",
"warnings": [
"string"
],
"workspace_id": "string",
"write_target": "global-config"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}Empty
List settings-backed MCP servers
GET
/api/settings/mcp-serversQuery Parameters
scope?string
Select the settings scope
Value in
"global" | "workspace"workspace_id?string
Select the workspace id for workspace scope
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://loading/api/settings/mcp-servers"{
"available_scopes": [
"global"
],
"collection": "providers",
"mcp_servers": [
{
"args": [
"string"
],
"auth": {
"authorization_url": "string",
"client_id": "string",
"client_secret_ref": "string",
"issuer_url": "string",
"metadata_url": "string",
"revocation_url": "string",
"scopes": [
"string"
],
"token_url": "string",
"type": "string"
},
"auth_status": {
"auth_type": "string",
"authorization_url": "string",
"client_id": "string",
"diagnostic": "string",
"expires_at": "2019-08-24T14:15:22Z",
"issuer": "string",
"refreshable": true,
"remote_url": "string",
"revocation_url": "string",
"scopes": [
"string"
],
"server_name": "string",
"status": "string",
"token_present": true,
"updated_at": "2019-08-24T14:15:22Z"
},
"command": "string",
"env": {
"property1": "string",
"property2": "string"
},
"name": "string",
"scope": "global",
"secret_env": {
"property1": "string",
"property2": "string"
},
"source_metadata": {
"available_targets": [
"global-config"
],
"effective_source": {
"kind": "builtin-provider",
"scope": "global",
"workspace_id": "string"
},
"shadowed_sources": [
{
"kind": "builtin-provider",
"scope": "global",
"workspace_id": "string"
}
]
},
"transport": "string",
"url": "string",
"workspace_id": "string"
}
],
"scope": "global",
"workspace_id": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}Empty
Delete one settings-backed MCP server
DELETE
/api/settings/mcp-servers/{name}Path Parameters
name*string
MCP server name
Query Parameters
scope?string
Select the settings scope
Value in
"global" | "workspace"workspace_id?string
Select the workspace id for workspace scope
target?string
Select the persistence target
Value in
"auto" | "config" | "sidecar"Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://loading/api/settings/mcp-servers/string"{
"applied": true,
"behavior": "applied_now",
"restart_required": true,
"restart_scope": "string",
"scope": "global",
"section": "general",
"warnings": [
"string"
],
"workspace_id": "string",
"write_target": "global-config"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}Empty
Create or replace one settings-backed MCP server
PUT
/api/settings/mcp-servers/{name}Path Parameters
name*string
MCP server name
Query Parameters
scope?string
Select the settings scope
Value in
"global" | "workspace"workspace_id?string
Select the workspace id for workspace scope
target?string
Select the persistence target
Value in
"auto" | "config" | "sidecar"Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://loading/api/settings/mcp-servers/string" \ -H "Content-Type: application/json" \ -d '{ "server": { "name": "string" } }'{
"applied": true,
"behavior": "applied_now",
"restart_required": true,
"restart_scope": "string",
"scope": "global",
"section": "general",
"warnings": [
"string"
],
"workspace_id": "string",
"write_target": "global-config"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}Empty
Read the memory settings section
GET
/api/settings/memoryResponse Body
application/json
application/json
curl -X GET "https://loading/api/settings/memory"{
"actions": {
"consolidate": {
"available": true,
"behavior": "applied_now",
"name": "string"
}
},
"available_scopes": [
"global"
],
"config": {
"dream": {
"agent": "string",
"check_interval": "string",
"enabled": true,
"min_hours": 0.1,
"min_sessions": 0
},
"enabled": true,
"global_dir": "string"
},
"health": {
"available": true,
"dream_enabled": true,
"file_count": 0,
"last_consolidated_at": "2019-08-24T14:15:22Z"
},
"scope": "global",
"section": "general",
"workspace_id": "string"
}{
"error": "string"
}Empty
Update the memory settings section
PATCH
/api/settings/memoryRequest Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://loading/api/settings/memory" \ -H "Content-Type: application/json" \ -d '{ "config": { "dream": { "agent": "string", "check_interval": "string", "enabled": true, "min_hours": 0.1, "min_sessions": 0 }, "enabled": true } }'{
"applied": true,
"behavior": "applied_now",
"restart_required": true,
"restart_scope": "string",
"scope": "global",
"section": "general",
"warnings": [
"string"
],
"workspace_id": "string",
"write_target": "global-config"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}Empty
Read the network settings section
GET
/api/settings/networkResponse Body
application/json
application/json
curl -X GET "https://loading/api/settings/network"{
"available_scopes": [
"global"
],
"config": {
"default_channel": "string",
"enabled": true,
"greet_interval": 0,
"max_payload": 0,
"max_queue_depth": 0,
"max_replay_age": 0,
"port": 0
},
"links": [
{
"label": "string",
"path": "string"
}
],
"runtime": {
"available": true,
"channels": 0,
"delivery_workers": 0,
"enabled": true,
"listener_host": "string",
"listener_port": 0,
"local_peers": 0,
"queued_messages": 0,
"queued_sessions": 0,
"remote_peers": 0,
"status": "string"
},
"scope": "global",
"section": "general",
"workspace_id": "string"
}{
"error": "string"
}Empty
Update the network settings section
PATCH
/api/settings/networkRequest Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://loading/api/settings/network" \ -H "Content-Type: application/json" \ -d '{ "config": { "default_channel": "string", "enabled": true, "greet_interval": 0, "max_payload": 0, "max_queue_depth": 0, "max_replay_age": 0, "port": 0 } }'{
"applied": true,
"behavior": "applied_now",
"restart_required": true,
"restart_scope": "string",
"scope": "global",
"section": "general",
"warnings": [
"string"
],
"workspace_id": "string",
"write_target": "global-config"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}Empty
Read the observability settings section
GET
/api/settings/observabilityResponse Body
application/json
application/json
curl -X GET "https://loading/api/settings/observability"{
"available_scopes": [
"global"
],
"config": {
"enabled": true,
"max_global_bytes": 0,
"retention_days": 0,
"transcripts": {
"enabled": true,
"max_bytes_per_session": 0,
"segment_bytes": 0
}
},
"log_tail": {
"available": true,
"stream_url": "string",
"transport": "sse"
},
"runtime": {
"active_agents": 0,
"active_sessions": 0,
"available": true,
"global_db_size_bytes": 0,
"session_db_size_bytes": 0,
"status": "string",
"uptime_seconds": 0
},
"scope": "global",
"section": "general",
"workspace_id": "string"
}{
"error": "string"
}Empty
Update the observability settings section
PATCH
/api/settings/observabilityRequest Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://loading/api/settings/observability" \ -H "Content-Type: application/json" \ -d '{ "config": { "enabled": true, "max_global_bytes": 0, "retention_days": 0, "transcripts": { "enabled": true, "max_bytes_per_session": 0, "segment_bytes": 0 } } }'{
"applied": true,
"behavior": "applied_now",
"restart_required": true,
"restart_scope": "string",
"scope": "global",
"section": "general",
"warnings": [
"string"
],
"workspace_id": "string",
"write_target": "global-config"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}Empty
Stream daemon log output for the observability settings screen
GET
/api/settings/observability/log-tailResponse Body
application/json
curl -X GET "https://loading/api/settings/observability/log-tail"Empty
{
"error": "string"
}Empty
List settings-backed providers
GET
/api/settings/providersResponse Body
application/json
application/json
curl -X GET "https://loading/api/settings/providers"{
"available_scopes": [
"global"
],
"collection": "providers",
"providers": [
{
"command_available": true,
"credentials": [
{
"kind": "string",
"name": "string",
"present": true,
"required": true,
"secret_ref": "string",
"source": "string",
"target_env": "string"
}
],
"default": true,
"fallback": {
"settings": {
"base_url": "string",
"command": "string",
"credential_slots": [
{
"kind": "string",
"name": "string",
"required": true,
"secret_ref": "string",
"target_env": "string"
}
],
"default_model": "string",
"display_name": "string",
"harness": "string",
"runtime_provider": "string",
"transport": "string"
},
"source": {
"kind": "builtin-provider",
"scope": "global",
"workspace_id": "string"
}
},
"name": "string",
"settings": {
"base_url": "string",
"command": "string",
"credential_slots": [
{
"kind": "string",
"name": "string",
"required": true,
"secret_ref": "string",
"target_env": "string"
}
],
"default_model": "string",
"display_name": "string",
"harness": "string",
"runtime_provider": "string",
"transport": "string"
},
"source_metadata": {
"available_targets": [
"global-config"
],
"effective_source": {
"kind": "builtin-provider",
"scope": "global",
"workspace_id": "string"
},
"shadowed_sources": [
{
"kind": "builtin-provider",
"scope": "global",
"workspace_id": "string"
}
]
}
}
],
"scope": "global",
"workspace_id": "string"
}{
"error": "string"
}Empty
Read one settings-backed provider
GET
/api/settings/providers/{name}Path Parameters
name*string
Provider name
Response Body
application/json
application/json
application/json
curl -X GET "https://loading/api/settings/providers/string"{
"provider": {
"command_available": true,
"credentials": [
{
"kind": "string",
"name": "string",
"present": true,
"required": true,
"secret_ref": "string",
"source": "string",
"target_env": "string"
}
],
"default": true,
"fallback": {
"settings": {
"base_url": "string",
"command": "string",
"credential_slots": [
{
"kind": "string",
"name": "string",
"required": true,
"secret_ref": "string",
"target_env": "string"
}
],
"default_model": "string",
"display_name": "string",
"harness": "string",
"runtime_provider": "string",
"transport": "string"
},
"source": {
"kind": "builtin-provider",
"scope": "global",
"workspace_id": "string"
}
},
"name": "string",
"settings": {
"base_url": "string",
"command": "string",
"credential_slots": [
{
"kind": "string",
"name": "string",
"required": true,
"secret_ref": "string",
"target_env": "string"
}
],
"default_model": "string",
"display_name": "string",
"harness": "string",
"runtime_provider": "string",
"transport": "string"
},
"source_metadata": {
"available_targets": [
"global-config"
],
"effective_source": {
"kind": "builtin-provider",
"scope": "global",
"workspace_id": "string"
},
"shadowed_sources": [
{
"kind": "builtin-provider",
"scope": "global",
"workspace_id": "string"
}
]
}
}
}{
"error": "string"
}{
"error": "string"
}Empty
Delete one settings-backed provider overlay
DELETE
/api/settings/providers/{name}Path Parameters
name*string
Provider name
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "https://loading/api/settings/providers/string"{
"applied": true,
"behavior": "applied_now",
"restart_required": true,
"restart_scope": "string",
"scope": "global",
"section": "general",
"warnings": [
"string"
],
"workspace_id": "string",
"write_target": "global-config"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}Empty
Create or replace one settings-backed provider overlay
PUT
/api/settings/providers/{name}Path Parameters
name*string
Provider name
Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://loading/api/settings/providers/string" \ -H "Content-Type: application/json" \ -d '{ "settings": {} }'{
"applied": true,
"behavior": "applied_now",
"restart_required": true,
"restart_scope": "string",
"scope": "global",
"section": "general",
"warnings": [
"string"
],
"workspace_id": "string",
"write_target": "global-config"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}Empty
List settings-backed execution sandboxes
GET
/api/settings/sandboxesResponse Body
application/json
application/json
curl -X GET "https://loading/api/settings/sandboxes"{
"available_scopes": [
"global"
],
"collection": "providers",
"sandboxes": [
{
"name": "string",
"profile": {
"backend": "string",
"daytona": {
"api_url": "string",
"auto_archive": "string",
"auto_stop": "string",
"class": "string",
"image": "string",
"snapshot": "string",
"target": "string"
},
"env": {
"property1": "string",
"property2": "string"
},
"network": {
"allow_list": [
"string"
],
"allow_outbound": true,
"allow_public_ingress": true,
"deny_list": [
"string"
],
"required": true
},
"persistence": "string",
"runtime_root": "string",
"secret_env": {
"property1": "string",
"property2": "string"
},
"sync_mode": "string"
},
"source_metadata": {
"available_targets": [
"global-config"
],
"effective_source": {
"kind": "builtin-provider",
"scope": "global",
"workspace_id": "string"
},
"shadowed_sources": [
{
"kind": "builtin-provider",
"scope": "global",
"workspace_id": "string"
}
]
},
"workspace_usage_count": 0
}
],
"scope": "global",
"workspace_id": "string"
}{
"error": "string"
}Empty
Read one settings-backed execution sandbox
GET
/api/settings/sandboxes/{name}Path Parameters
name*string
Sandbox name
Response Body
application/json
application/json
application/json
curl -X GET "https://loading/api/settings/sandboxes/string"{
"sandbox": {
"name": "string",
"profile": {
"backend": "string",
"daytona": {
"api_url": "string",
"auto_archive": "string",
"auto_stop": "string",
"class": "string",
"image": "string",
"snapshot": "string",
"target": "string"
},
"env": {
"property1": "string",
"property2": "string"
},
"network": {
"allow_list": [
"string"
],
"allow_outbound": true,
"allow_public_ingress": true,
"deny_list": [
"string"
],
"required": true
},
"persistence": "string",
"runtime_root": "string",
"secret_env": {
"property1": "string",
"property2": "string"
},
"sync_mode": "string"
},
"source_metadata": {
"available_targets": [
"global-config"
],
"effective_source": {
"kind": "builtin-provider",
"scope": "global",
"workspace_id": "string"
},
"shadowed_sources": [
{
"kind": "builtin-provider",
"scope": "global",
"workspace_id": "string"
}
]
},
"workspace_usage_count": 0
}
}{
"error": "string"
}{
"error": "string"
}Empty
Delete one settings-backed execution sandbox overlay
DELETE
/api/settings/sandboxes/{name}Path Parameters
name*string
Sandbox name
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "https://loading/api/settings/sandboxes/string"{
"applied": true,
"behavior": "applied_now",
"restart_required": true,
"restart_scope": "string",
"scope": "global",
"section": "general",
"warnings": [
"string"
],
"workspace_id": "string",
"write_target": "global-config"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}Empty
Create or replace one settings-backed execution sandbox
PUT
/api/settings/sandboxes/{name}Path Parameters
name*string
Sandbox name
Request Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://loading/api/settings/sandboxes/string" \ -H "Content-Type: application/json" \ -d '{ "profile": { "backend": "string" } }'{
"applied": true,
"behavior": "applied_now",
"restart_required": true,
"restart_scope": "string",
"scope": "global",
"section": "general",
"warnings": [
"string"
],
"workspace_id": "string",
"write_target": "global-config"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}Empty
Read the skills settings section
GET
/api/settings/skillsResponse Body
application/json
application/json
curl -X GET "https://loading/api/settings/skills"{
"available_scopes": [
"global"
],
"config": {
"allowed_marketplace_hooks": [
"string"
],
"allowed_marketplace_mcp": [
"string"
],
"disabled_skills": [
"string"
],
"enabled": true,
"marketplace": {
"base_url": "string",
"registry": "string"
},
"poll_interval": "string"
},
"disabled_count": 0,
"discovered_count": 0,
"links": [
{
"label": "string",
"path": "string"
}
],
"runtime_available": true,
"scope": "global",
"section": "general",
"workspace_id": "string"
}{
"error": "string"
}Empty
Update the skills settings section
PATCH
/api/settings/skillsRequest Body
application/json
JSON request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://loading/api/settings/skills" \ -H "Content-Type: application/json" \ -d '{ "config": { "enabled": true, "marketplace": { "registry": "string" }, "poll_interval": "string" } }'{
"applied": true,
"behavior": "applied_now",
"restart_required": true,
"restart_scope": "string",
"scope": "global",
"section": "general",
"warnings": [
"string"
],
"workspace_id": "string",
"write_target": "global-config"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}Empty