TypeScript models

Generated from eve-iac OpenAPI/semantics. Do not edit manually.

Every public OpenAPI component schema plus generated query types.

Model Kind
LooseObject object
ValidateData object
BulkResult object
SuccessEnvelope object
ErrorEnvelope object
LoginRequest object
LogoutRequest object
ProjectPayload object
AuthoringPayload object
ConsolePayload object
ConsoleTarget object
HealthData object
LoginData object
StatusOkData object
SessionData object
CapabilitiesData object
ProjectModeCaps object
LifecycleCaps object
Template object
TemplateDetail object
TemplateImage object
TemplateAttribute object
TemplatesData object
TemplateImagesData object
TemplateAttributesData object
NetworkType object
NetworkTypesData object
Icon object
IconsData object
Iface object
LinkCompletionsData object
InterfacesPreviewData object
ImportData object
DeployData object
PlanSummary object
PlanAction object
PlanData object
ReconcileData object
DestroyData object
ProjectStatusData object
InspectionData object
OpenData object
ConsoleRecord object
ConsolesData object
ConsoleExecData object
ConsoleExecManyData object
ConsoleAttachData object
ListTemplatesQuery object
CompleteLinkInterfacesRequest ref
PreviewInterfacesRequest ref
ValidateProjectRequest ref
ImportProjectRequest object
DeployProjectRequest ref
PlanProjectRequest ref
ReconcileProjectRequest ref
DestroyProjectRequest ref
GetProjectStatusRequest ref
InspectProjectRequest ref
OpenProjectRequest ref
ListProjectConsolesRequest ref
ExecProjectRequest object
ExecConsoleRequest ref
ExecConsoleManyRequest ref
AttachConsoleRequest ref

Direction is "to_eve" | "from_eve". ProjectPayload.direction on the wire is still a free string.

LooseObject

Type: Record<string, unknown>

ValidateData

Field TypeScript type Required Semantics
status string yes

Used by: validateProject

BulkResult

Field TypeScript type Required Semantics
requested number yes
started number yes
already_running number yes
already_starting number yes
stopped number yes
already_stopped number yes
wiped number yes
failed number yes
invalid number yes

Used by: execProject

SuccessEnvelope

Field TypeScript type Required Semantics
ok boolean yes
data unknown no
error string no
code string no

ErrorEnvelope

Field TypeScript type Required Semantics
ok boolean yes
error string no
code string no
data unknown no

LoginRequest

Field TypeScript type Required Semantics
username string yes
password string yes

Used by: login

LogoutRequest

Type: Record<string, unknown>

Used by: logout

ProjectPayload

decodeProject body. Unknown fields are ignored. dir/out non-empty are rejected. Do not treat omitted optional fields as serialized defaults.

Field TypeScript type Required Semantics
lab string no
yaml string no
files Record no
state unknown no
source unknown no
manifest string no
prune boolean no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe boolean no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action string no
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id number no
stopmode number no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh boolean no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace boolean no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir string no Rejected when non-empty.
out string no Rejected when non-empty.

Used by: validateProject, importProject, deployProject, planProject, reconcileProject, destroyProject, getProjectStatus, inspectProject, openProject, listProjectConsoles, execProject

AuthoringPayload

Field TypeScript type Required Semantics
dir string no Rejected when non-empty.
yaml string no
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
template string no
attributes Record no
excludeUsed boolean no
eth_format string no

Used by: completeLinkInterfaces, previewInterfaces

ConsolePayload

Field TypeScript type Required Semantics
lab string no
yaml string no
files Record no
state unknown no
manifest string no
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
command string no
timeout_ms number no
targets Array<ConsoleTarget> no
dir string no Rejected when non-empty.
out string no Rejected when non-empty.

Used by: execConsole, execConsoleMany, attachConsole

ConsoleTarget

Field TypeScript type Required Semantics
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
command string no

HealthData

Field TypeScript type Required Semantics
status string no
tls boolean no
version string no

Used by: getHealth

LoginData

Field TypeScript type Required Semantics
token string no
username string no

Used by: login

StatusOkData

Field TypeScript type Required Semantics
status string no

Used by: logout

SessionData

Field TypeScript type Required Semantics
username string no

Used by: getSession

CapabilitiesData

Field TypeScript type Required Semantics
eveReachable boolean no
eveBaseUrl string no
features Record no
projectModes RecordProjectModeCaps> no

Used by: getCapabilities

ProjectModeCaps

Field TypeScript type Required Semantics
inspect boolean no
open boolean no
console boolean no
lifecycle LifecycleCaps no
topology_mutation boolean no
reconcile boolean no
destroy boolean no
presentation_restore boolean no
source_mutation boolean no

LifecycleCaps

Field TypeScript type Required Semantics
start boolean no
stop boolean no
wipe boolean no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)

Template

Field TypeScript type Required Semantics
id string no
description string no
type string no
provisioned boolean no
configSupported boolean no

TemplateDetail

Field TypeScript type Required Semantics
id string no
description string no
type string no
provisioned boolean no
configSupported boolean no
images Array<TemplateImage> no
default string no
attributes Array<TemplateAttribute> no

Used by: getTemplate

TemplateImage

Field TypeScript type Required Semantics
id string no
available boolean no

TemplateAttribute

Field TypeScript type Required Semantics
name string no
label string no
kind string no
group string no
values Array no

TemplatesData

Field TypeScript type Required Semantics
templates Array<Template> no

Used by: listTemplates

TemplateImagesData

Field TypeScript type Required Semantics
template string no
type string no
provisioned boolean no
default string no
images Array<TemplateImage> no

Used by: listTemplateImages

TemplateAttributesData

Field TypeScript type Required Semantics
template string no
type string no
attributes Array<TemplateAttribute> no

Used by: listTemplateAttributes

NetworkType

Field TypeScript type Required Semantics
id string no
label string no
icon string no
supported boolean no

NetworkTypesData

Field TypeScript type Required Semantics
types Array<NetworkType> no
natOnly boolean no

Used by: listNetworkTypes

Icon

Field TypeScript type Required Semantics
id string no
label string no

IconsData

Field TypeScript type Required Semantics
icons Array<Icon> no

Used by: listIcons

Iface

Field TypeScript type Required Semantics
id number no
name string no
type string no
used boolean no

LinkCompletionsData

Field TypeScript type Required Semantics
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
items Array<Iface> no

Used by: completeLinkInterfaces

InterfacesPreviewData

Field TypeScript type Required Semantics
items Array<Iface> no

Used by: previewInterfaces

ImportData

Field TypeScript type Required Semantics
name string no
yaml string no
files Record no
mode string no
source_lab string no
managed_lab string no
lab string no
state unknown no
source unknown no

Used by: importProject

DeployData

Field TypeScript type Required Semantics
lab string no
nodes number no
links number no
state unknown no
unsupported Array no

Used by: deployProject

PlanSummary

Field TypeScript type Required Semantics
creates number no
updates number no
deletes number no
blocked number no

PlanAction

Field TypeScript type Required Semantics
op string no
kind string no
key string no
side string no
direction string no omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
type string no
applicable boolean no
prune boolean no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve

PlanData

Field TypeScript type Required Semantics
lab string no
exists boolean no
summary PlanSummary no
operations Array<PlanAction> no
actions Array<PlanAction> no
applicable boolean no
blocked Array<PlanAction> no
text string no
plan_identity string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
locked boolean no
lock number no
direction string no omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
unsupported Array no

Used by: planProject

ReconcileData

Field TypeScript type Required Semantics
lab string no
applied number no
skippedPrune number no
fullDeploy boolean no
applicable boolean no
summary PlanSummary no
operations Array<PlanAction> no
blocked Array<PlanAction> no
direction string no omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
state unknown no
yaml string no
files Record no
source unknown no
manifest string no

Used by: reconcileProject

DestroyData

Field TypeScript type Required Semantics
lab string no

Used by: destroyProject

ProjectStatusData

Field TypeScript type Required Semantics
mode string no
source_lab string null no
managed_lab string null no
runtime_lab string null no
capabilities ProjectModeCaps no
locked boolean no
lock number no

Used by: getProjectStatus

InspectionData

Field TypeScript type Required Semantics
observation boolean no
desired_state boolean no
mode string no
source_lab unknown no
managed_lab unknown no
runtime_lab string no
capabilities ProjectModeCaps no
cached boolean no

Used by: inspectProject

OpenData

Field TypeScript type Required Semantics
url string no
ttl number no
lab string no

Used by: openProject

ConsoleRecord

Field TypeScript type Required Semantics
id number no
key string no
name string no
template string no
console string no
status number no
url string no

ConsolesData

Field TypeScript type Required Semantics
lab string no
html5 boolean no
consoles Array<ConsoleRecord> no

Used by: listProjectConsoles

ConsoleExecData

Field TypeScript type Required Semantics
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
name string no
console_type string no
command string no
output string no
duration_ms number no

Used by: execConsole

ConsoleExecManyData

Field TypeScript type Required Semantics
results Array<ConsoleExecData & ({
ok?: boolean;
code?: string;
error?: string;
} & Record)> no

Used by: execConsoleMany

ConsoleAttachData

Field TypeScript type Required Semantics
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
name string no
console_type string no
stream string no
transport "eve-telnet" no

Used by: attachConsole

ListTemplatesQuery

Generated query object. Omit the whole argument to send no query string.

Field TypeScript type Required Semantics
provisioned string no Only the string true filters to provisioned templates. Omitted means all.

Used by: listTemplates

CompleteLinkInterfacesRequest

Request body alias of AuthoringPayload. Same wire shape.

Alias of AuthoringPayload.

Field TypeScript type Required Semantics
dir string no Rejected when non-empty.
yaml string no
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
template string no
attributes Record no
excludeUsed boolean no
eth_format string no

PreviewInterfacesRequest

Request body alias of AuthoringPayload. Same wire shape.

Alias of AuthoringPayload.

Field TypeScript type Required Semantics
dir string no Rejected when non-empty.
yaml string no
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
template string no
attributes Record no
excludeUsed boolean no
eth_format string no

ValidateProjectRequest

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field TypeScript type Required Semantics
lab string no
yaml string no
files Record no
state unknown no
source unknown no
manifest string no
prune boolean no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe boolean no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action string no
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id number no
stopmode number no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh boolean no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace boolean no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir string no Rejected when non-empty.
out string no Rejected when non-empty.

ImportProjectRequest

Request body for importProject.

Field TypeScript type Required Semantics
lab string yes
yaml string no
files Record no
state unknown no
source unknown no
manifest string no
prune boolean no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe boolean no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action string no
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id number no
stopmode number no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh boolean no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace boolean no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir string no Rejected when non-empty.
out string no Rejected when non-empty.

Used by: importProject

DeployProjectRequest

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field TypeScript type Required Semantics
lab string no
yaml string no
files Record no
state unknown no
source unknown no
manifest string no
prune boolean no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe boolean no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action string no
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id number no
stopmode number no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh boolean no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace boolean no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir string no Rejected when non-empty.
out string no Rejected when non-empty.

PlanProjectRequest

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field TypeScript type Required Semantics
lab string no
yaml string no
files Record no
state unknown no
source unknown no
manifest string no
prune boolean no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe boolean no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action string no
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id number no
stopmode number no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh boolean no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace boolean no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir string no Rejected when non-empty.
out string no Rejected when non-empty.

ReconcileProjectRequest

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field TypeScript type Required Semantics
lab string no
yaml string no
files Record no
state unknown no
source unknown no
manifest string no
prune boolean no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe boolean no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action string no
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id number no
stopmode number no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh boolean no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace boolean no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir string no Rejected when non-empty.
out string no Rejected when non-empty.

DestroyProjectRequest

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field TypeScript type Required Semantics
lab string no
yaml string no
files Record no
state unknown no
source unknown no
manifest string no
prune boolean no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe boolean no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action string no
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id number no
stopmode number no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh boolean no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace boolean no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir string no Rejected when non-empty.
out string no Rejected when non-empty.

GetProjectStatusRequest

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field TypeScript type Required Semantics
lab string no
yaml string no
files Record no
state unknown no
source unknown no
manifest string no
prune boolean no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe boolean no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action string no
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id number no
stopmode number no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh boolean no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace boolean no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir string no Rejected when non-empty.
out string no Rejected when non-empty.

InspectProjectRequest

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field TypeScript type Required Semantics
lab string no
yaml string no
files Record no
state unknown no
source unknown no
manifest string no
prune boolean no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe boolean no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action string no
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id number no
stopmode number no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh boolean no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace boolean no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir string no Rejected when non-empty.
out string no Rejected when non-empty.

OpenProjectRequest

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field TypeScript type Required Semantics
lab string no
yaml string no
files Record no
state unknown no
source unknown no
manifest string no
prune boolean no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe boolean no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action string no
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id number no
stopmode number no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh boolean no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace boolean no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir string no Rejected when non-empty.
out string no Rejected when non-empty.

ListProjectConsolesRequest

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field TypeScript type Required Semantics
lab string no
yaml string no
files Record no
state unknown no
source unknown no
manifest string no
prune boolean no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe boolean no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action string no
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id number no
stopmode number no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh boolean no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace boolean no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir string no Rejected when non-empty.
out string no Rejected when non-empty.

ExecProjectRequest

Request body for execProject.

Field TypeScript type Required Semantics
lab string no
yaml string no
files Record no
state unknown no
source unknown no
manifest string no
prune boolean no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe boolean no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action string yes
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id number no
stopmode number no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh boolean no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace boolean no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir string no Rejected when non-empty.
out string no Rejected when non-empty.

Used by: execProject

ExecConsoleRequest

Request body alias of ConsolePayload. Same wire shape.

Alias of ConsolePayload.

Field TypeScript type Required Semantics
lab string no
yaml string no
files Record no
state unknown no
manifest string no
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
command string no
timeout_ms number no
targets Array<ConsoleTarget> no
dir string no Rejected when non-empty.
out string no Rejected when non-empty.

ExecConsoleManyRequest

Request body alias of ConsolePayload. Same wire shape.

Alias of ConsolePayload.

Field TypeScript type Required Semantics
lab string no
yaml string no
files Record no
state unknown no
manifest string no
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
command string no
timeout_ms number no
targets Array<ConsoleTarget> no
dir string no Rejected when non-empty.
out string no Rejected when non-empty.

AttachConsoleRequest

Request body alias of ConsolePayload. Same wire shape.

Alias of ConsolePayload.

Field TypeScript type Required Semantics
lab string no
yaml string no
files Record no
state unknown no
manifest string no
node string no omitted: all nodes. empty string: all nodes. named: that IaC node key
command string no
timeout_ms number no
targets Array<ConsoleTarget> no
dir string no Rejected when non-empty.
out string no Rejected when non-empty.