Payload shapes
Generated file. Do not edit by hand. Regenerate from the repo root with
CGO_ENABLED=0 go run scripts/gen-response-models-md.go.
Part of the API response model reference: field tables
for every named struct a response model references, straight from
the Go definitions. ? marks optional fields (omitempty or
pointer). Nested named types are listed by name only. Follow the
source link for their definitions.
AddResponse
Section titled “AddResponse”Source: modules/storage/storageapi/types.go
| Field | Type |
|---|---|
id | string |
name | string |
provider_type | string |
path | string |
managed | bool |
quota_support | bool |
snapshot_support | bool |
connection_name | string? |
AppDetailResponse
Section titled “AppDetailResponse”Source: modules/app/detail.go
| Field | Type |
|---|---|
name | string |
version | string |
description | string? |
category | string? |
homepage | string? |
icon | string? |
tags | []string? |
source | string? |
vapps | []VappInfo? |
plugs | []string? |
sockets | []string? |
vars | []VarDecl? |
AppResponse
Section titled “AppResponse”Source: modules/app/types.go
| Field | Type |
|---|---|
id | int |
name | string |
version | string |
category | string? |
description | string? |
homepage | string? |
icon | string? |
source | string? |
tags | []string? |
parent_app | string? |
vapp | bool |
repo_id | int |
repo_name | string? |
AppSearchResponse
Section titled “AppSearchResponse”Source: modules/search/types.go
| Field | Type |
|---|---|
data | []App |
next_cursor | string? |
has_more | bool |
total_count | int? |
AppUpload
Section titled “AppUpload”Source: modules/app/app_upload.go
| Field | Type |
|---|---|
digest | string |
AppsResponse
Section titled “AppsResponse”Source: modules/user/types.go
| Field | Type |
|---|---|
user | string |
tenant | string |
platform_admin | bool |
data | []DeploymentApp |
total_count | int |
AsyncOperationResponse (modules/app)
Section titled “AsyncOperationResponse (modules/app)”Source: modules/app/types.go
| Field | Type |
|---|---|
operation_id | string |
message | string |
warnings | []string? |
AsyncOperationResponse (modules/stack)
Section titled “AsyncOperationResponse (modules/stack)”Source: modules/stack/types.go
| Field | Type |
|---|---|
operation_id | string |
message | string |
AuditListResponse
Section titled “AuditListResponse”Source: modules/audit/types.go
| Field | Type |
|---|---|
data | []AuditRecord |
next_cursor | string? |
has_more | bool |
total_count | int |
AuditRecord
Section titled “AuditRecord”Source: modules/audit/types.go
| Field | Type |
|---|---|
id | string |
code | string |
message | string |
payload | map[string]any |
tenant_name | string? |
stack_name | string? |
environment | string? |
actor | string |
trace_id | string? |
created_at | Time |
AuditVerifyResponse
Section titled “AuditVerifyResponse”Source: modules/audit/types.go
| Field | Type |
|---|---|
total | int |
valid | bool |
tampered | []string |
BackupInfo
Section titled “BackupInfo”Source: modules/backup/types.go
| Field | Type |
|---|---|
orphan | OrphanFacts? |
id | string |
name | string |
tenant_name | string |
stack_name | string |
environment | string |
status | string |
size | int64? |
apparent_size | int64? |
timestamp | Time |
completed_at | Time? |
duration_seconds | float64? |
error | string? |
consistency_id | string? |
degraded | []string? |
point_in_time | string? |
data_scope | string? |
databases | []string? |
database_dumps | []BackupDatabaseInfo? |
composition | []CompositionRef? |
encryption | string? |
location | string? |
stack_stop_seconds | float64? |
node_id | string? |
node | string? |
repository_gone | string? |
restored_at | Time? |
verified_at | Time? |
verify_status | string? |
verify_tier | string? |
verify_summary | string? |
BackupListResponse
Section titled “BackupListResponse”Source: modules/backup/types.go
| Field | Type |
|---|---|
backups | []BackupInfo |
total_count | int |
has_more | bool |
BackupManifest
Section titled “BackupManifest”Source: modules/backup/types.go
| Field | Type |
|---|---|
id | string |
name | string? |
timestamp | Time |
version | string? |
tenant | string |
stack | string |
environment | string |
node | string? |
app | string? |
app_version | string? |
runtime | string? |
deployment | string |
fingerprint | string? |
consistency | string? |
point_in_time | string? |
stack_stop_seconds | float64? |
source_mtimes | bool? |
labels | map[string]string? |
variables | map[string]any? |
integrations | []IntegrationRecord? |
composition | []CompositionRef? |
database_dumps | []ConsumerDatabaseDump? |
port_mappings | []map[string]any? |
host_mappings | []map[string]any? |
profiles | []string? |
groups | map[string][]Member? |
ordinals | []OrdinalCapture? |
placement | ManifestPlacement? |
secrets | VaultSecretsBundle? |
deployment_config | map[string]any? |
derived_from | string? |
derived_root | string? |
derived_edits | []DerivedEdit? |
record | StackRecord? |
archives | []BackupArchiveInfo? |
app_files_archive | string? |
deployment_archive | string? |
host_bind_skips | []HostBindSkip? |
named_volume_skips | []NamedVolumeSkip? |
declared_data_subjects | []string? |
restore_jobs | []RestoreJob? |
checksum | string? |
signature | string? |
total_size_bytes | int64? |
apparent_bytes | int64? |
sealed_archive | string? |
member_index | string? |
pre_job_results | []map[string]any? |
post_job_results | []map[string]any? |
degraded | []string? |
converter_losses | []ConverterLoss? |
data_scope | string? |
data | BackupDataInfo |
BackupResult
Section titled “BackupResult”Source: modules/backup/types.go
| Field | Type |
|---|---|
backup_id | string |
name | string? |
snapshot_id | string |
size_bytes | int64? |
created_at | Time? |
group_path | string? |
consistency_id | string? |
members | []GroupMemberBackup? |
warning | BackupWarning? |
BackupScheduleListResponse
Section titled “BackupScheduleListResponse”Source: modules/backup/types.go
| Field | Type |
|---|---|
data | []ScheduleInfo |
total_count | int |
refused | []ScheduleInfo? |
verify_sweep | string? |
verify_sweep_unknown | string? |
BackupScheduleResponse
Section titled “BackupScheduleResponse”Source: modules/backup/types.go
| Field | Type |
|---|---|
schedule | string? |
all_connected | bool |
with_dependants | bool |
next_run | Time? |
next_run_unknown | string? |
refusal | string? |
BackupScheduleRunResponse
Section titled “BackupScheduleRunResponse”Source: modules/backup/types.go
| Field | Type |
|---|---|
scope | string |
fired | bool |
operation_id | string |
attached | bool? |
BackupSyncResponse
Section titled “BackupSyncResponse”Source: modules/backup/types.go
| Field | Type |
|---|---|
synced_count | int |
skipped_foreign_tenant | int? |
foreign_tenants | []string? |
duration_ms | int |
BlockAddResult
Section titled “BlockAddResult”Source: modules/cluster/block.go
| Field | Type |
|---|---|
block | string |
added | bool |
blocks | []BlockRow |
nodes | []BlockNodeRow? |
BlockList
Section titled “BlockList”Source: modules/cluster/block.go
| Field | Type |
|---|---|
blocks | []BlockRow |
nodes | []BlockNodeRow? |
BrandInfo
Section titled “BrandInfo”Source: modules/branding/store.go
| Field | Type |
|---|---|
name | string |
files | []string |
hash | string |
BrowseCommitResult
Section titled “BrowseCommitResult”Source: modules/backup/mount/browse.go
| Field | Type |
|---|---|
backup_id | string |
derived_from | string |
source_intact | bool |
detail | string |
BrowseFile
Section titled “BrowseFile”Source: modules/backup/mount/browse.go
| Field | Type |
|---|---|
path | string |
size | int64 |
encoding | string |
content | string? |
content_base64 | string? |
truncated | bool? |
editable | bool |
not_editable_reason | string? |
BrowseSession
Section titled “BrowseSession”Source: modules/backup/mount/browse.go
| Field | Type |
|---|---|
session_id | string |
backup_id | string |
tenant_name | string |
stack_name | string |
environment | string |
writable | bool |
read_only_reason | string? |
read_mode | string? |
copy_reason | string? |
CancelJobRunResponse
Section titled “CancelJobRunResponse”Source: modules/job/types.go
| Field | Type |
|---|---|
job_run_id | int64 |
cancelled | bool |
CancelTaskMessage
Section titled “CancelTaskMessage”Source: modules/task/router.go
| Field | Type |
|---|---|
id | string |
cancelled | bool |
CephFSDisableResponse
Section titled “CephFSDisableResponse”Source: modules/storage/storageapi/types.go
| Field | Type |
|---|---|
success | bool |
error | string? |
CephFSEnableResponse
Section titled “CephFSEnableResponse”Source: modules/storage/storageapi/types.go
| Field | Type |
|---|---|
success | bool |
nodes | []map[string]any? |
error | string? |
CephFSHealthResponse
Section titled “CephFSHealthResponse”Source: modules/storage/storageapi/types.go
| Field | Type |
|---|---|
enabled | bool |
healthy | bool |
status | string |
monitors | int |
osds | int |
osds_up | int |
mds_active | int |
total_bytes | int64 |
used_bytes | int64 |
available_bytes | int64 |
cephfs_enabled | bool |
cephfs_name | string? |
osd_list | []OSDInfo? |
errors | []string? |
CephFSJoinResponse
Section titled “CephFSJoinResponse”Source: modules/storage/storageapi/types.go
| Field | Type |
|---|---|
success | bool |
osd_id | int? |
device | string? |
node_id | string? |
error | string? |
CephFSLeaveResponse
Section titled “CephFSLeaveResponse”Source: modules/storage/storageapi/types.go
| Field | Type |
|---|---|
success | bool |
osd_id | int? |
error | string? |
CephFSStatusResponse
Section titled “CephFSStatusResponse”Source: modules/storage/storageapi/types.go
| Field | Type |
|---|---|
enabled | bool |
status | string |
nodes | []map[string]any? |
error | string? |
CertDeliveryMessage
Section titled “CertDeliveryMessage”Source: modules/app/cert_delivery_route.go
| Field | Type |
|---|---|
local_traefik_replica | bool |
entries | []CertDeliveryEntry |
unanswered | []CertDeliveryUnanswered? |
CertEdgeMessage
Section titled “CertEdgeMessage”Source: modules/app/cert_edge.go
| Field | Type |
|---|---|
local_traefik_replica | bool |
entries | []CertEdgeEntry |
CertsListMessage
Section titled “CertsListMessage”Source: modules/cluster/certs_router.go
| Field | Type |
|---|---|
nodes | []CertsListNode |
CertsRotateMessage
Section titled “CertsRotateMessage”Source: modules/cluster/certs_router.go
| Field | Type |
|---|---|
success | bool |
rotated_type | string |
message | string? |
nodes | []CertsRotateNode |
CertsRotateNowMessage
Section titled “CertsRotateNowMessage”Source: modules/cluster/certs_router.go
| Field | Type |
|---|---|
success | bool |
message | string? |
CloneResult
Section titled “CloneResult”Source: modules/clone/types.go
| Field | Type |
|---|---|
success | bool |
source_scope | ScopeInfo |
target_scope | ScopeInfo |
stacks_cloned | []StackRenameInfo |
backup_ids | []string |
warnings | []string |
ClusterHostChange
Section titled “ClusterHostChange”Source: modules/app/cluster_host_change.go
| Field | Type |
|---|---|
old | string? |
new | string |
changed | bool |
previous_recorded | bool? |
retire_at | string? |
bootstrap_rewritten | bool? |
ClusterHostShowMessage
Section titled “ClusterHostShowMessage”Source: modules/app/cluster_host_router.go
| Field | Type |
|---|---|
host | string |
previous | string? |
retire_at | string? |
in_grace | bool? |
ClusterStatus
Section titled “ClusterStatus”Source: modules/cluster/types.go
| Field | Type |
|---|---|
cluster_name | string |
total_nodes | int |
healthy_nodes | int |
degraded_nodes | int |
unreachable_nodes | int |
restarting_nodes | int? |
cordoned_nodes | int? |
voters | int |
required_voters | int |
leader_id | string? |
leader_name | string? |
quorum_healthy | bool |
background_work_node | string? |
expected_voters | int? |
raft_voters | int? |
voter_deficit | bool? |
voter_surplus | bool? |
reachable_voters | int? |
no_fault_tolerance | bool? |
control_plane_members | int? |
control_plane_healthy | int? |
control_plane_voters | int? |
control_plane_voter_target | int? |
voters_in_control_plane | []string? |
voters_outside_control_plane | []string? |
verified_node_states | int? |
stale_node_states | int? |
engine | EngineSummary? |
engine_unread | string? |
suffrage_change | SuffrageChangeStatus? |
leader_work | LeaderWorkStatus? |
leader_work_unread | string? |
left_cluster | string? |
ColdStartStatusResponse
Section titled “ColdStartStatusResponse”Source: modules/vault/coldstart.go
| Field | Type |
|---|---|
declared | bool |
node_id | string? |
node_name | string? |
planted_at | string? |
local_holds_drop_in | bool |
local_node_id | string? |
CompileResponse
Section titled “CompileResponse”Source: modules/catalog/compile.go
| Field | Type |
|---|---|
installs | []InstallInvocation |
ConfigListResponse
Section titled “ConfigListResponse”Source: modules/config/types.go
| Field | Type |
|---|---|
data | []ConfigEntry |
total_count | int |
hidden | HiddenRows |
notes | []string? |
ConfigResponse
Section titled “ConfigResponse”Source: modules/config/types.go
| Field | Type |
|---|---|
value | any |
found | bool |
warning | string? |
source | string? |
scope | string? |
notes | []string? |
ConfigSetResponse
Section titled “ConfigSetResponse”Source: modules/config/types.go
| Field | Type |
|---|---|
success | bool |
warning | string? |
activation | string? |
notes | []string? |
ConfigUnsetResponse
Section titled “ConfigUnsetResponse”Source: modules/config/types.go
| Field | Type |
|---|---|
removed | bool |
ConsoleGateResponse
Section titled “ConsoleGateResponse”Source: modules/console/gate.go
| Field | Type |
|---|---|
allowed | bool |
state | string |
feature | string |
verb | string? |
settings | bool? |
ConsolePublicConfigResponse
Section titled “ConsolePublicConfigResponse”Source: modules/console/config_route.go
| Field | Type |
|---|---|
values | map[string]string |
ConsoleReachResponse
Section titled “ConsoleReachResponse”Source: modules/console/reach.go
| Field | Type |
|---|---|
known | bool |
unreachable | []ReachRef |
ConsoleTenantResponse
Section titled “ConsoleTenantResponse”Source: modules/user/console_tenant.go
| Field | Type |
|---|---|
version | int |
tenant | string |
ConstraintListResult
Section titled “ConstraintListResult”Source: modules/fence/fenceapi/types.go
| Field | Type |
|---|---|
constraints | []ConstraintView |
CoordinateResponse
Section titled “CoordinateResponse”Source: modules/app/deployment_coordinates.go
| Field | Type |
|---|---|
name | string |
CordonMessage
Section titled “CordonMessage”Source: modules/cluster/cordon_router.go
| Field | Type |
|---|---|
success | bool |
node_id | string |
node | string |
availability | string? |
runtime | string? |
note | string? |
CreateGroupResult
Section titled “CreateGroupResult”Source: modules/backup/actions.go
| Field | Type |
|---|---|
consistency_id | string |
backup_ids | []string |
CreateResponse
Section titled “CreateResponse”Source: modules/user/types.go
| Field | Type |
|---|---|
tenant | string |
username | string |
created | bool |
CronListResponse
Section titled “CronListResponse”Source: modules/cron/types.go
| Field | Type |
|---|---|
data | []CronEntry |
total_count | int |
DeleteOutcome
Section titled “DeleteOutcome”Source: modules/dns/service.go
| Field | Type |
|---|---|
deleted | bool |
skipped | bool? |
reason | string? |
DeleteResponse (modules/storage/storageapi)
Section titled “DeleteResponse (modules/storage/storageapi)”Source: modules/storage/storageapi/types.go
| Field | Type |
|---|---|
deleted | bool |
DeleteResponse (modules/user)
Section titled “DeleteResponse (modules/user)”Source: modules/user/types.go
| Field | Type |
|---|---|
tenant | string |
username | string |
deleted | bool |
DeploymentsMessage
Section titled “DeploymentsMessage”Source: modules/node/deployments_router.go
| Field | Type |
|---|---|
deployments | []DeploymentSummary |
DerivedVerification
Section titled “DerivedVerification”Source: modules/backup/mount/verify.go
| Field | Type |
|---|---|
backup_id | string |
stamped | bool |
verified | bool |
recorded | string? |
recomputed | string? |
derived_from | string? |
root | string? |
files | int |
bytes | int64 |
detail | string? |
DrainMessage
Section titled “DrainMessage”Source: modules/cluster/lifecycle_router.go
| Field | Type |
|---|---|
success | bool |
node_id | string |
node | string |
state | string? |
migrated | []DrainMigrationEnvelope? |
stopped | []string? |
failed | []DrainMigrationEnvelope? |
migrated_count | int |
stopped_count | int? |
failed_count | int? |
duration_ms | int64 |
reason | string? |
note | string? |
DrainPlan
Section titled “DrainPlan”Source: modules/cluster/drain_plan.go
| Field | Type |
|---|---|
node_id | string |
node | string |
rows | []DrainPlanRow |
movable | int |
blocked | int |
refusals | []string? |
notes | []string? |
EffectiveAppsResponse
Section titled “EffectiveAppsResponse”Source: modules/user/types.go
| Field | Type |
|---|---|
version | int |
user | string |
name | string? |
email | string? |
account_url | string? |
tenant | string |
tenants | []string? |
platform_admin | bool |
apps | []EffectiveApp |
total_count | int |
EnsureNetworkResponse
Section titled “EnsureNetworkResponse”Source: modules/network/types.go
| Field | Type |
|---|---|
network_name | string |
created | bool |
driver | string |
EscrowReceipt
Section titled “EscrowReceipt”Source: modules/vault/escrow.go
| Field | Type |
|---|---|
what | string |
where | string |
note | string? |
generation | string |
recorded_at | string |
recorded_by | string? |
actor | string? |
EscrowStatus
Section titled “EscrowStatus”Source: modules/vault/escrow.go
| Field | Type |
|---|---|
keys | []EscrowKeyState |
ExplainDoc
Section titled “ExplainDoc”Source: modules/fence/fenceapi/types.go
| Field | Type |
|---|---|
deployment | ExplainDeployment |
status | ExplainStatus |
replicas | []ExplainReplica |
eligible | ExplainEligible |
move_group | any |
pending | []ExplainPending |
failover | ExplainFailover |
relocation | ExplainRelocation |
history | []any |
enforced | bool |
not_enforced | []string |
ExportListRow
Section titled “ExportListRow”Source: modules/export/router.go
| Field | Type |
|---|---|
name | string |
size_bytes | int64 |
created_at | Time |
FileStat
Section titled “FileStat”Source: modules/backup/types.go
| Field | Type |
|---|---|
path | string |
type | FileType |
size | int64 |
mode | uint32 |
mtime | int64 |
uid | uint32? |
gid | uint32? |
nlink | uint32? |
symlink_target | string? |
FinishForwardResult
Section titled “FinishForwardResult”Source: modules/clone/move_finish_forward.go
| Field | Type |
|---|---|
operation_id | string |
kind | string |
torn_down | []string? |
already_torn_down | []string? |
warnings | []string? |
success | bool |
FlowExplanation
Section titled “FlowExplanation”Source: modules/fabric/explain.go
| Field | Type |
|---|---|
from | ExplainEndpoint |
to | ExplainEndpoint |
proto | string? |
port | int? |
verdict | string |
because | string |
hint | string? |
steps | []ExplainStepView? |
grants | []ExplainGrantView? |
applied | ExplainApplied? |
FollowDoc
Section titled “FollowDoc”Source: modules/fence/fenceapi/types.go
| Field | Type |
|---|---|
deployment | string |
node | string |
nodes | []FollowNode |
ForceLeaderMessage
Section titled “ForceLeaderMessage”Source: modules/cluster/lifecycle_router.go
| Field | Type |
|---|---|
success | bool |
operation | string? |
node_id | string |
removed_nodes | []string? |
warnings | []string? |
note | string? |
ForgetMessage
Section titled “ForgetMessage”Source: modules/cluster/lifecycle_router.go
| Field | Type |
|---|---|
success | bool |
node | string |
node_id | string |
mesh_address_reclaimed | string? |
coldstart_note | string? |
ForwardAuthDecision (modules/auth)
Section titled “ForwardAuthDecision (modules/auth)”Source: modules/auth/types.go
| Field | Type |
|---|---|
allow | bool |
reason | string? |
host | string? |
tenant | string? |
stack | string? |
user | string? |
user_tenant | string? |
required_role | string? |
ForwardAuthDecision (modules/forward)
Section titled “ForwardAuthDecision (modules/forward)”Source: modules/forward/types.go
| Field | Type |
|---|---|
allow | bool |
reason | string |
host | string? |
tenant | string? |
stack | string? |
user | string? |
required_role | string? |
user_tenant | string? |
FreezeGetResponse
Section titled “FreezeGetResponse”Source: modules/health/types.go
| Field | Type |
|---|---|
automatic_moves | FreezeState? |
GateResponse
Section titled “GateResponse”Source: modules/mcp/gate.go
| Field | Type |
|---|---|
allowed | bool |
state | string |
GrantResponse
Section titled “GrantResponse”Source: modules/user/types.go
| Field | Type |
|---|---|
tenant | string |
username | string |
role | string |
granted | bool |
Source: core/depgraph/depgraph.go
| Field | Type |
|---|---|
deployments | []Deployment |
integrations | []Integration |
GroupManifest
Section titled “GroupManifest”Source: modules/backup/types.go
| Field | Type |
|---|---|
version | string? |
consistency_id | string? |
created_at | Time |
stacks | []string? |
manifests | []BackupManifest? |
GroupRestoreResult
Section titled “GroupRestoreResult”Source: modules/backup/actions.go
| Field | Type |
|---|---|
consistency_id | string |
dry_run | bool? |
stacks | []RollbackStackResult |
safety_backups | []GroupSafetyBackup? |
HealthResponse (modules/node)
Section titled “HealthResponse (modules/node)”Source: modules/node/types.go
| Field | Type |
|---|---|
node | string |
status | string |
health_status | string |
reason | string? |
checked_at | Time? |
checks | HealthChecks |
resources | Resources? |
HealthResponse (modules/leader)
Section titled “HealthResponse (modules/leader)”Source: modules/leader/router.go
| Field | Type |
|---|---|
nodes | []NodeObservation |
HostListResponse
Section titled “HostListResponse”Source: modules/network/types.go
| Field | Type |
|---|---|
data | []HostMapping |
total_count | int |
IdentityProvider
Section titled “IdentityProvider”Source: modules/auth/identity_provider.go
| Field | Type |
|---|---|
tenant | string |
alias | string |
display_name | string |
issuer | string |
client_id | string |
authentication | string |
signing_alg | string |
client_secret_ref | string |
sync_mode | string |
first_login | string |
enabled | bool |
IdentityProviderIdentity
Section titled “IdentityProviderIdentity”Source: modules/auth/identity_provider.go
| Field | Type |
|---|---|
tenant | string |
alias | string |
ImagePruneMessage
Section titled “ImagePruneMessage”Source: modules/cluster/image_prune_router.go
| Field | Type |
|---|---|
dry_run | bool |
nodes | []NodeImagePrune |
InflightReply
Section titled “InflightReply”Source: modules/node/inflight_router.go
| Field | Type |
|---|---|
operations | []Operation |
IngressCatMessage
Section titled “IngressCatMessage”Source: modules/app/ingress_show.go
| Field | Type |
|---|---|
dynamic_dir | string |
files | []IngressFile |
IngressLsMessage
Section titled “IngressLsMessage”Source: modules/app/ingress_show.go
| Field | Type |
|---|---|
dynamic_dir | string |
routers | []IngressRouterRow |
IntegrationProvision
Section titled “IntegrationProvision”Source: modules/app/integration_provision.go
| Field | Type |
|---|---|
tenant | string |
stack | string |
environment | string |
plug | string |
provider | string |
from | string? |
values | map[string]string? |
IntegrationStateRow
Section titled “IntegrationStateRow”Source: modules/app/types.go
| Field | Type |
|---|---|
id | int |
provider_stack_name | string |
provider_socket | string |
consumer_stack_name | string |
consumer_plug | string |
status | string |
waiting | string? |
consumer_tenant_name | string? |
consumer_environment | string? |
provider_tenant_name | string? |
provider_environment | string? |
provider_connection | string? |
InterruptedOperation
Section titled “InterruptedOperation”Source: modules/clone/move_finish_forward.go
| Field | Type |
|---|---|
operation_id | string |
kind | string |
disposition | string |
stack | string |
target | string? |
phase | string? |
step | string? |
started_at | string? |
updated_at | string? |
attempts | int? |
needs_operator | bool? |
already_torn_down | []string? |
last_error | string? |
remedy | string |
Inventory
Section titled “Inventory”Source: modules/dns/inventory.go
| Field | Type |
|---|---|
records | []InventoryRecord |
zone_errors | []string? |
resolvers | []InventoryResolver? |
private_planes | []InventoryPlane? |
JobDefinition
Section titled “JobDefinition”Source: modules/job/types.go
| Field | Type |
|---|---|
name | string |
context | Context |
command | any? |
timeout | int? |
on_failure | OnFailure? |
service | string? |
image | string? |
entrypoint | any? |
networks | []string? |
volumes | []string? |
labels | map[string]string? |
container_name | string? |
group | string? |
url | string? |
method | string? |
headers | map[string]string? |
body | any? |
insecure | bool? |
max_retries | int? |
retry_interval | int? |
query | string? |
variables | map[string]any? |
operation_name | string? |
steps | []map[string]any? |
script | string? |
browser | string? |
headless | bool? |
base_url | string? |
where | string? |
prefer | string? |
after | []string? |
before | []string? |
user | string? |
working_dir | string? |
environment | map[string]string? |
read_only | bool? |
sensitive_output | bool? |
JobListResponse
Section titled “JobListResponse”Source: modules/job/types.go
| Field | Type |
|---|---|
data | []JobResponse |
stack_name | string |
environment | string |
JobRunDetailResponse
Section titled “JobRunDetailResponse”Source: modules/job/types.go
| Field | Type |
|---|---|
id | int64 |
created_at | Time |
started_at | Time? |
completed_at | Time? |
job_name | string |
stack_name | string |
environment | string |
tenant_name | string |
status | JobRunStatus |
exit_code | int? |
error_message | string? |
elapsed_seconds | float64? |
task_id | string? |
container | string? |
stdout | string? |
stderr | string? |
output_withheld | string? |
JobRunListResponse
Section titled “JobRunListResponse”Source: modules/job/types.go
| Field | Type |
|---|---|
data | []JobRunResponse |
next_cursor | string? |
has_more | bool |
total_count | int |
JobRunTaskResponse
Section titled “JobRunTaskResponse”Source: modules/job/types.go
| Field | Type |
|---|---|
task_id | string |
job_run_id | int64 |
operation_id | string |
KeyListResponse
Section titled “KeyListResponse”Source: modules/backup/router_keys.go
| Field | Type |
|---|---|
keys | []ResticKey |
KeyRotateResult
Section titled “KeyRotateResult”Source: modules/backup/keyrotate.go
| Field | Type |
|---|---|
repos | []RepoKeyRotation |
mirrors | []MirrorKeyRotation? |
generated | bool |
stored_in | string |
LDAPBind
Section titled “LDAPBind”Source: modules/auth/ldap_bind.go
| Field | Type |
|---|---|
tenant | string |
name | string |
state | LDAPBindState |
dn | string |
password | string? |
base_dn | string |
users_dn | string |
groups_dn | string |
LDAPBindDeleteResponse
Section titled “LDAPBindDeleteResponse”Source: modules/auth/ldap_bind.go
| Field | Type |
|---|---|
tenant | string |
name | string |
LDAPBindInfo
Section titled “LDAPBindInfo”Source: modules/auth/ldap_bind.go
| Field | Type |
|---|---|
tenant | string |
name | string |
LabelDetail
Section titled “LabelDetail”Source: modules/fence/fenceapi/types.go
| Field | Type |
|---|---|
id | string |
kind | string |
name | string |
origin | string |
description | string |
reserved | bool |
granted_tenants | []string? |
backup_repo | string |
members | []MemberView |
ready | int |
rule_count | int |
deployment_count | int |
created_at | Time |
warnings | []string |
rules | []ConstraintView |
deployments | []ShapedDeployment |
LabelIndexResponse
Section titled “LabelIndexResponse”Source: modules/fence/fenceapi/types.go
| Field | Type |
|---|---|
labels | []LabelView |
warnings | []string |
LabelListResponse
Section titled “LabelListResponse”Source: modules/fence/fenceapi/types.go
| Field | Type |
|---|---|
nodes | []NodeLabels |
LabelSetResponse
Section titled “LabelSetResponse”Source: modules/fence/fenceapi/types.go
| Field | Type |
|---|---|
node | string |
added | []string |
removed | []string |
unchanged | []string |
warnings | []string |
labels | map[string][]string |
dry_run | bool? |
LastPrune
Section titled “LastPrune”Source: modules/events/types.go
| Field | Type |
|---|---|
at | Time |
aged | int64 |
capped | int64 |
stuck_pending | int64 |
total | int64 |
LauncherGateResponse
Section titled “LauncherGateResponse”Source: modules/launcher/gate.go
| Field | Type |
|---|---|
allowed | bool |
state | string |
LauncherLayoutAck
Section titled “LauncherLayoutAck”Source: modules/user/layout.go
| Field | Type |
|---|---|
version | int |
rev | int64 |
LauncherLayoutResponse
Section titled “LauncherLayoutResponse”Source: modules/user/layout.go
| Field | Type |
|---|---|
version | int |
rev | int64 |
layout | RawMessage? |
LeaveLifecycleMessage
Section titled “LeaveLifecycleMessage”Source: modules/cluster/lifecycle_router.go
| Field | Type |
|---|---|
state_archive | string? |
success | bool |
node_id | string |
node_name | string? |
moved | []string? |
warnings | []string? |
errors | []string? |
LinkResponse
Section titled “LinkResponse”Source: modules/storage/storageapi/types.go
| Field | Type |
|---|---|
linked | bool |
ListResponse (modules/app)
Section titled “ListResponse (modules/app)”Source: modules/app/types.go
| Field | Type |
|---|---|
data | []CoordinateResponse |
next_cursor | string? |
has_more | bool |
total_count | int |
ListResponse (modules/catalog)
Section titled “ListResponse (modules/catalog)”Source: modules/catalog/types.go
| Field | Type |
|---|---|
applications | []Application |
sources | []Source |
ListResponse (modules/node)
Section titled “ListResponse (modules/node)”Source: modules/node/types.go
| Field | Type |
|---|---|
data | []Response |
next_cursor | string? |
has_more | bool |
total_count | int64 |
ListResponse (modules/storage/storageapi)
Section titled “ListResponse (modules/storage/storageapi)”Source: modules/storage/storageapi/types.go
| Field | Type |
|---|---|
providers | []ProviderInfo |
ListResponse (modules/user)
Section titled “ListResponse (modules/user)”Source: modules/user/types.go
| Field | Type |
|---|---|
tenant | string |
data | []KeycloakUser |
total_count | int |
Listing
Section titled “Listing”Source: modules/adapter/listing.go
| Field | Type |
|---|---|
adapters | []ListingRow |
LogoutResponse
Section titled “LogoutResponse”Source: modules/user/types.go
| Field | Type |
|---|---|
tenant | string |
username | string |
logged_out | bool |
LogsMessage
Section titled “LogsMessage”Source: modules/cluster/admin_router.go
| Field | Type |
|---|---|
service | string |
node | string? |
lines | []string |
LogsResponse
Section titled “LogsResponse”Source: modules/logs/types.go
| Field | Type |
|---|---|
stack_name | string |
environment | string |
service | string? |
logs | string |
lines | int |
MaintenanceMessage
Section titled “MaintenanceMessage”Source: modules/cluster/maintenance_router.go
| Field | Type |
|---|---|
success | bool |
node_id | string |
node | string |
availability | string? |
expected_back_at | Time? |
note | string? |
MeshDiagnose
Section titled “MeshDiagnose”Source: modules/cluster/mesh_seam.go
| Field | Type |
|---|---|
nodes | []MeshDiagnoseNode |
MeshStatus
Section titled “MeshStatus”Source: modules/cluster/mesh_seam.go
| Field | Type |
|---|---|
rotations | []Rotation |
enabled | bool |
nodes | []MeshStatusNode |
MirrorResult
Section titled “MirrorResult”Source: modules/backup/mirror.go
| Field | Type |
|---|---|
skipped | string? |
repos | []MirrorRepoResult? |
MountListResponse (modules/backup)
Section titled “MountListResponse (modules/backup)”Source: modules/backup/router_mounts.go
| Field | Type |
|---|---|
mounts | []MountSubprocHandle |
total | int |
MountListResponse (modules/backup/mount)
Section titled “MountListResponse (modules/backup/mount)”Source: modules/backup/mount/router.go
| Field | Type |
|---|---|
sessions | []MountSession |
MountSession
Section titled “MountSession”Source: modules/backup/types.go
| Field | Type |
|---|---|
id | string |
backend_type | MountBackendType |
source_type | MountSourceType |
source | string |
writable | bool |
created_at | Time |
last_access | Time |
overlay_dir | string? |
ttl_seconds | int |
tenant_name | string |
stack_name | string? |
environment | string |
pinned_subscriptions | int |
local_path | string? |
MountSubprocHandle
Section titled “MountSubprocHandle”Source: modules/backup/state.go
| Field | Type |
|---|---|
id | string |
backup_id | string |
restic_snapshot_id | string? |
repo_url | string? |
mount_path | string |
pid | int |
node_id | string? |
tenant_name | string? |
started_at | Time |
status | string |
MoveResult
Section titled “MoveResult”Source: modules/clone/types.go
| Field | Type |
|---|---|
success | bool |
source_scope | ScopeInfo |
target_scope | ScopeInfo |
stacks_moved | []StackRenameInfo |
backup_ids | []string |
used_fast_path | bool |
warnings | []string |
strategy | string? |
volumes | []RelocationVolume? |
NFSDisableResponse
Section titled “NFSDisableResponse”Source: modules/storage/storageapi/types.go
| Field | Type |
|---|---|
success | bool |
error | string? |
NFSEnableResponse
Section titled “NFSEnableResponse”Source: modules/storage/storageapi/types.go
| Field | Type |
|---|---|
success | bool |
server_node | string? |
export_path | string? |
nodes | []map[string]any? |
error | string? |
NFSJoinResponse
Section titled “NFSJoinResponse”Source: modules/storage/storageapi/types.go
| Field | Type |
|---|---|
success | bool |
server_node | string? |
nodes | []map[string]any? |
error | string? |
NFSLeaveResponse
Section titled “NFSLeaveResponse”Source: modules/storage/storageapi/types.go
| Field | Type |
|---|---|
success | bool |
server_node | string? |
nodes | []map[string]any? |
error | string? |
NFSStatusResponse
Section titled “NFSStatusResponse”Source: modules/storage/storageapi/types.go
| Field | Type |
|---|---|
enabled | bool |
status | string |
export_path | string? |
server_node | string? |
nodes | []map[string]any? |
error | string? |
Source: modules/network/types.go
| Field | Type |
|---|---|
name | string? |
ip | string |
source | string |
NoRefConfig
Section titled “NoRefConfig”Source: modules/supportbundle/render.go
| Field | Type |
|---|---|
tenant | string |
stack | string |
environment | string |
compose | string |
manifest | RawMessage? |
missing | []string? |
warning | string? |
NodeMetrics
Section titled “NodeMetrics”Source: modules/telemetry/node.go
| Field | Type |
|---|---|
node | string |
hostname | string? |
window | string |
windows | []string |
store | bool |
cpu | []Point |
memory | []Point |
disk | []Point |
network_rx | []Point |
network_tx | []Point |
empty | bool |
reason | string? |
NodePreflight
Section titled “NodePreflight”Source: modules/cluster/drain_preflight.go
| Field | Type |
|---|---|
action | string |
node | string |
node_id | string? |
class | string |
consequences | []string? |
unknown | []string? |
lines | []string? |
voter | bool |
voter_slot | int? |
voter_target | int? |
voters_before | int? |
voters_after | int? |
fault_tolerance_before | int? |
fault_tolerance_after | int? |
expected_voters_after | int? |
voter_deficit | bool? |
runtime | string? |
availability | string? |
deployments | int |
per_node | int? |
runtime_peers | []string? |
blocking | []string? |
moves | []string? |
stops | []string? |
NodeStatusMessage
Section titled “NodeStatusMessage”Source: modules/cluster/nodes_router.go
| Field | Type |
|---|---|
node_id | string |
hostname | string? |
cluster_state | string? |
availability | string? |
is_leader | bool |
runtime | string? |
clusterfs_revision | uint64? |
clusterfs_age | string? |
boot_gate | NodeBootGate? |
NodeUpdateMessage
Section titled “NodeUpdateMessage”Source: modules/cluster/node_update_router.go
| Field | Type |
|---|---|
success | bool |
node | string |
node_id | string |
public_address | string? |
location | string? |
cloud | string? |
reserve | string? |
hypervisor | string? |
store | string? |
updated | []string? |
sidecar_updated | bool? |
NodesMessage
Section titled “NodesMessage”Source: modules/cluster/nodes_router.go
| Field | Type |
|---|---|
nodes | []NodeListRow |
OIDCClient
Section titled “OIDCClient”Source: modules/auth/oidc_client.go
| Field | Type |
|---|---|
tenant | string |
client_id | string |
redirect_uris | []string |
web_origins | []string |
authentication | string |
jwks_url | string |
signing_alg | string |
standard_flow_only | bool |
OIDCClientCreated
Section titled “OIDCClientCreated”Source: modules/auth/oidc_client.go
| Field | Type |
|---|---|
tenant | string |
client_id | string |
redirect_uris | []string |
web_origins | []string |
authentication | string |
jwks_url | string |
signing_alg | string |
standard_flow_only | bool |
secret | string? |
OIDCClientIdentity
Section titled “OIDCClientIdentity”Source: modules/auth/oidc_client.go
| Field | Type |
|---|---|
tenant | string |
client_id | string |
OIDCRealmResponse
Section titled “OIDCRealmResponse”Source: modules/auth/types.go
| Field | Type |
|---|---|
realm | string? |
issuer | string? |
client_id | string? |
client_secret | string? |
client_secret_previous | string? |
cookie_domain | string? |
error | string? |
OperationCancelResponse
Section titled “OperationCancelResponse”Source: modules/backup/operation_cancel.go
| Field | Type |
|---|---|
operation_id | string |
kind | string |
tenant_name | string |
stack_name | string |
status | string |
cancelled | bool |
message | string |
OperationListMessage
Section titled “OperationListMessage”Source: modules/app/operation_claim.go
| Field | Type |
|---|---|
operations | []OperationClaim |
OperationState
Section titled “OperationState”Source: core/operations/store.go
| Field | Type |
|---|---|
operation_id | string |
operation_type | OperationKind |
status | OperationStatus |
tenant_name | string |
stack_name | string? |
created_at | Time |
completed_at | Time? |
result | map[string]any? |
error_code | string? |
error_message | string? |
hint | string? |
OriginProbeReport
Section titled “OriginProbeReport”Source: modules/doctor/commands/origin_probe.go
| Field | Type |
|---|---|
stack | string |
tenant | string? |
environment | string? |
service | string? |
path | string |
mode | string |
probe_hosts | []string |
findings | []OriginFindingRow? |
inconclusive | bool? |
reason | string? |
declared_holes | []string? |
OrphanPage
Section titled “OrphanPage”Source: modules/backup/orphan.go
| Field | Type |
|---|---|
orphans | []OrphanInfo |
repos | []IndexRepoInfo |
total_count | int |
has_more | bool |
PingMessage
Section titled “PingMessage”Source: modules/cluster/admin_router.go
| Field | Type |
|---|---|
nodes | []PingNode |
PlugRow
Section titled “PlugRow”Source: modules/app/types.go
| Field | Type |
|---|---|
stack | string |
plug | string |
socket | string |
connected_to | string? |
PodRestartResponse
Section titled “PodRestartResponse”Source: modules/stack/types.go
| Field | Type |
|---|---|
success | bool |
error | string? |
PoolLsResponse
Section titled “PoolLsResponse”Source: modules/storage/storageapi/pools.go
| Field | Type |
|---|---|
pools | []PoolCapacity |
unread | []string? |
PortListResponse
Section titled “PortListResponse”Source: modules/network/types.go
| Field | Type |
|---|---|
data | []PortMapping |
total_count | int |
PreStopReply
Section titled “PreStopReply”Source: modules/node/prestop_router.go
| Field | Type |
|---|---|
steps | []Result |
Pressure
Section titled “Pressure”Source: modules/events/types.go
| Field | Type |
|---|---|
rows | int64 |
max_rows | int64? |
percent_full | float64? |
row_cap | string |
retention_days | int |
oldest_age_days | int? |
prune_in_days | int? |
pending_broadcast | int64 |
stuck_pending | int64 |
broadcast_grace_days | int |
dropped | int64 |
last_prune | LastPrune? |
last_trim | LastTrim? |
can_prune | bool |
severity | string |
ProviderInfo
Section titled “ProviderInfo”Source: modules/storage/storageapi/types.go
| Field | Type |
|---|---|
id | string |
name | string |
provider_type | string |
path | string |
managed | bool |
filesystem | string? |
quota_support | bool |
snapshot_support | bool |
quota_method | string? |
snapshot_method | string? |
nodes | []string? |
node_names | []string? |
config | map[string]string? |
PruneResult
Section titled “PruneResult”Source: modules/backup/types.go
| Field | Type |
|---|---|
removed_packs | int |
removed_blobs | int |
removed_bytes | int64 |
remaining_packs | int |
remaining_blobs | int |
remaining_bytes | int64 |
unread | string? |
PurgeResult
Section titled “PurgeResult”Source: modules/purge/types.go
| Field | Type |
|---|---|
cutoff | Time |
dry_run | bool |
include_audit | bool |
batch_size | int |
event | PurgeEventScope |
audit | PurgeAuditScope |
QuotaLimits
Section titled “QuotaLimits”Source: modules/quota/types.go
| Field | Type |
|---|---|
cpu_millicores | int64? |
memory_bytes | int64? |
disk_bytes | int64? |
max_deployments | int64? |
max_environments | int64? |
max_apps | int64? |
max_vdeployments | int64? |
QuotaStatusResponse
Section titled “QuotaStatusResponse”Source: modules/quota/types.go
| Field | Type |
|---|---|
tenant_name | string |
environment | string? |
deployment_name | string? |
scope_name | string |
quota | QuotaLimits? |
cpu_millicores_used | int64 |
memory_bytes_used | int64 |
disk_bytes_used | int64 |
deployment_count | int64 |
environment_count | int64 |
app_count | int64 |
vdeployment_count | int64 |
cpu_millicores_available | int64? |
memory_bytes_available | int64? |
disk_bytes_available | int64? |
deployments_available | int64? |
environments_available | int64? |
apps_available | int64? |
vdeployments_available | int64? |
cpu_percent_used | float64? |
memory_percent_used | float64? |
disk_percent_used | float64? |
disk_measured_at | Time? |
RealmRoleDeleteResponse
Section titled “RealmRoleDeleteResponse”Source: modules/user/types.go
| Field | Type |
|---|---|
tenant | string |
name | string |
deleted | bool |
RealmRoleListResponse
Section titled “RealmRoleListResponse”Source: modules/user/types.go
| Field | Type |
|---|---|
tenant | string |
data | []RealmRole |
total_count | int |
RealmRoleResponse
Section titled “RealmRoleResponse”Source: modules/user/types.go
| Field | Type |
|---|---|
tenant | string |
name | string |
description | string |
default | bool |
created | bool |
RealmSettingsResponse
Section titled “RealmSettingsResponse”Source: modules/user/types.go
| Field | Type |
|---|---|
tenant | string |
display_name | string |
registration | bool |
reset_password | bool |
verify_email | bool |
mail | RealmMail |
ReapReport
Section titled “ReapReport”Source: modules/dns/reap.go
| Field | Type |
|---|---|
applied | bool |
forced | bool? |
released | bool? |
owner | string |
zones | int |
inline | int? |
owned | int |
kept | int |
pinned | int |
predecessor | int? |
adopted | int? |
unadopted | []string? |
candidates | []ReapCandidate |
audited | bool? |
claims | []OwnedClaim? |
foreign_hosts | []string? |
unclaimed_hosts | []string? |
zone_errors | []string? |
RebalanceMessage
Section titled “RebalanceMessage”Source: modules/cluster/rebalance_router.go
| Field | Type |
|---|---|
success | bool |
applied | bool |
plan | Plan |
moved | []Move? |
failed | Failure? |
not_run | []Move? |
ReclaimResult
Section titled “ReclaimResult”Source: modules/clone/reclaim.go
| Field | Type |
|---|---|
trees | []ReclaimedTree |
bytes_freed | int64 |
files_freed | int |
scanned | int |
Record
Section titled “Record”Source: modules/dns/dnsapi/types.go
| Field | Type |
|---|---|
name | string |
type | RecordType |
content | string |
ttl | int |
proxied | bool |
zone_id | string |
record_id | string? |
RecoverPlan
Section titled “RecoverPlan”Source: modules/backup/recover.go
| Field | Type |
|---|---|
consistency_id | string? |
stacks | []PlanStack |
integrations | []PlanIntegration |
total_size_bytes | int64 |
warnings | []string? |
environment | string |
node | string? |
node_name | string? |
node_reason | string? |
RegistrationReply
Section titled “RegistrationReply”Source: modules/portal/route.go
| Field | Type |
|---|---|
registered | bool |
portal_url | string? |
cluster_uid | string? |
registered_at | string? |
nodes_left_drained | []string? |
nodes_left_cordoned | []string? |
RejectReason
Section titled “RejectReason”Source: modules/adapter/types.go
| Field | Type |
|---|---|
code | string |
detail | string |
RelocateResult
Section titled “RelocateResult”Source: modules/backup/relocate.go
| Field | Type |
|---|---|
from | string |
to | string |
configured_repo | string |
dry_run | bool |
rows | int |
cache_rows | int |
snapshots | int |
target_snapshots | int |
rewritten | int |
cache_rewritten | int |
skipped | int? |
missing | int? |
missing_rows | int? |
missing_cache_rows | int? |
RelocationResult
Section titled “RelocationResult”Source: modules/clone/relocate.go
| Field | Type |
|---|---|
plan | RelocationPlan |
moved | bool |
warnings | []string? |
RenameRollBackResult
Section titled “RenameRollBackResult”Source: modules/clone/rename_rollback.go
| Field | Type |
|---|---|
operation_id | string |
stack | string |
from | string |
warnings | []string? |
success | bool |
RenameUserResponse
Section titled “RenameUserResponse”Source: modules/user/types.go
| Field | Type |
|---|---|
tenant | string |
username | string |
renamed | bool |
RepairMessage
Section titled “RepairMessage”Source: modules/cluster/admin_router.go
| Field | Type |
|---|---|
issues_found | int |
issues_fixed | int |
nodes_removed | int |
raft_state_after | string? |
actions | []RepairAction |
ReplantResult
Section titled “ReplantResult”Source: modules/vault/coldstart.go
| Field | Type |
|---|---|
from | ColdStartDeclaration? |
to | ColdStartDeclaration |
uproot_warning | string? |
RepoListResponse
Section titled “RepoListResponse”Source: modules/repo/types.go
| Field | Type |
|---|---|
data | []RepoResponse |
next_cursor | string? |
has_more | bool |
total_count | int64 |
RepoResponse
Section titled “RepoResponse”Source: modules/repo/types.go
| Field | Type |
|---|---|
id | int64 |
name | string |
url | string |
priority | int64 |
tenant_name | string |
environment | string |
app_count | int64? |
synced_at | Time? |
sync_interval | string? |
adapter | string? |
created_at | Time |
updated_at | Time |
sync_error | string? |
RepointPlan
Section titled “RepointPlan”Source: modules/app/repoint.go
| Field | Type |
|---|---|
stack | string |
tenant | string |
environment | string |
from | RepointSource |
to | RepointSource |
changes | []Change? |
surface | SurfaceDelta |
identical | bool |
var_override_keys | []string? |
preserved_var_keys | []string? |
applied | bool |
rendered | bool |
back | bool? |
ResetPasswordResponse
Section titled “ResetPasswordResponse”Source: modules/user/types.go
| Field | Type |
|---|---|
tenant | string |
username | string |
reset | bool |
Response
Section titled “Response”Source: modules/node/types.go
| Field | Type |
|---|---|
id | string |
created_at | Time? |
updated_at | Time? |
hostname | string? |
role | string? |
tenant_name | string? |
labels | Labels? |
resources | Resources? |
runtime | string |
architecture | string? |
os | string? |
build | string? |
internal_address | string? |
underlay_address | string? |
public_address | string? |
location | string? |
cloud | string? |
raft_address | string? |
is_voter | bool |
health_status | string? |
health_checked_at | Time? |
availability | string |
default_store | string? |
RestoreFromFileCheck
Section titled “RestoreFromFileCheck”Source: modules/backup/restore_file_check.go
| Field | Type |
|---|---|
file | string |
RestoreResultLocal
Section titled “RestoreResultLocal”Source: modules/backup/actions.go
| Field | Type |
|---|---|
backup_id | string |
stack_name | string |
snapshot_id | string |
target_path | string |
mount_map | map[string]string? |
volumes_restored | int? |
rollback_id | string? |
RetentionApplyResponse
Section titled “RetentionApplyResponse”Source: modules/retention/types.go
| Field | Type |
|---|---|
deleted_count | int |
bytes_freed | int64 |
RetentionPolicyResponse
Section titled “RetentionPolicyResponse”Source: modules/retention/types.go
| Field | Type |
|---|---|
daily | int |
weekly | int |
monthly | int |
yearly | int |
RetentionPreviewResponse
Section titled “RetentionPreviewResponse”Source: modules/retention/types.go
| Field | Type |
|---|---|
policy | RetentionPolicy |
to_delete_count | int |
to_keep_count | int |
keep_by_category | map[string]int |
bytes_to_free | int64 |
to_delete_details | []map[string]any |
RevokeResponse
Section titled “RevokeResponse”Source: modules/user/types.go
| Field | Type |
|---|---|
tenant | string |
username | string |
role | string |
revoked | bool |
RmMessage
Section titled “RmMessage”Source: modules/cluster/admin_router.go
| Field | Type |
|---|---|
node | string |
node_id | string |
self_removal | bool |
mesh_address_reclaimed | string? |
voters_before | int? |
voters_after | int? |
expected_voters | int? |
voter_deficit | bool? |
stood_down | bool? |
stand_down_error | string? |
coldstart_note | string? |
promoted_node | string? |
rebalance_steps | []string? |
RollbackResult
Section titled “RollbackResult”Source: modules/backup/types.go
| Field | Type |
|---|---|
success | bool |
target_backup_id | string |
target_backup_age | string? |
stacks | []string? |
pre_rollback_backup_id | string? |
stacks_rolled_back | []RollbackStackResult? |
warnings | []string? |
RotateResult
Section titled “RotateResult”Source: modules/vault/rotate.go
| Field | Type |
|---|---|
rotated | int |
rekeyed_peers | []string? |
failed_peers | []string? |
drop_in_path | string? |
drop_in_was_stale | bool? |
node_locked | bool? |
Routes
Section titled “Routes”Source: modules/vip/view.go
| Field | Type |
|---|---|
node | KernelState |
revision | uint64 |
services | []RoutedService |
RunResult
Section titled “RunResult”Source: modules/containerbroker/service.go
| Field | Type |
|---|---|
truncated | bool |
exit_code | int64 |
output | string |
handle | string |
status | string |
ScheduleListResponse
Section titled “ScheduleListResponse”Source: modules/schedule/types.go
| Field | Type |
|---|---|
data | []ScheduleResponse |
total_count | int |
ScheduleResponse
Section titled “ScheduleResponse”Source: modules/schedule/types.go
| Field | Type |
|---|---|
id | string |
tenant_name | string |
stack_name | string |
environment | string |
job_name | string |
cron | string |
enabled | bool |
source | string |
last_run_at | Time? |
next_run_at | Time? |
created_at | Time |
warning | string? |
ScheduleSyncResponse
Section titled “ScheduleSyncResponse”Source: modules/schedule/types.go
| Field | Type |
|---|---|
added | int |
updated | int |
removed | int |
SecretExistsResponse
Section titled “SecretExistsResponse”Source: modules/vault/types.go
| Field | Type |
|---|---|
exists | bool |
scope | Scope? |
SecretListResponse
Section titled “SecretListResponse”Source: modules/vault/types.go
| Field | Type |
|---|---|
data | []SecretResponse |
total_count | int |
has_more | bool |
SecretResponse
Section titled “SecretResponse”Source: modules/vault/types.go
| Field | Type |
|---|---|
id | int64 |
key | string |
scope | Scope |
tenant_name | string? |
stack_name | string? |
environment | string? |
created_at | Time? |
updated_at | Time? |
SecretValueResponse
Section titled “SecretValueResponse”Source: modules/vault/types.go
| Field | Type |
|---|---|
id | int64 |
key | string |
scope | Scope |
tenant_name | string? |
stack_name | string? |
environment | string? |
created_at | Time? |
updated_at | Time? |
value | string |
SelectorDetail
Section titled “SelectorDetail”Source: modules/fence/fenceapi/types.go
| Field | Type |
|---|---|
name | string |
scope | string |
tenant_name | string |
expr | string |
reason | string |
set_by | string |
created_at | Time |
updated_at | Time |
nodes | []string |
used_by | []string |
SelectorListResult
Section titled “SelectorListResult”Source: modules/fence/fenceapi/types.go
| Field | Type |
|---|---|
selectors | []SelectorView |
SelectorView
Section titled “SelectorView”Source: modules/fence/fenceapi/types.go
| Field | Type |
|---|---|
name | string |
scope | string |
tenant_name | string |
expr | string |
reason | string |
set_by | string |
created_at | Time |
updated_at | Time |
ServiceClientDeleteResponse
Section titled “ServiceClientDeleteResponse”Source: modules/auth/service_client_router.go
| Field | Type |
|---|---|
client_id | string |
realm | string |
ServiceClientInfo
Section titled “ServiceClientInfo”Source: modules/auth/keycloak_service_client.go
| Field | Type |
|---|---|
client_id | string |
token_lifespan | int |
ServiceClientResponse
Section titled “ServiceClientResponse”Source: modules/auth/service_client_router.go
| Field | Type |
|---|---|
client_id | string |
realm | string |
state | string |
secret | string? |
token_lifespan | int |
scope | string? |
sealed_key | string? |
sealed_scope | string? |
SignInTenant
Section titled “SignInTenant”Source: modules/tenant/sign_in.go
| Field | Type |
|---|---|
name | string |
Snapshot
Section titled “Snapshot”Source: modules/capabilities/types.go
| Field | Type |
|---|---|
version | int |
product | string? |
transport | string |
system_apps | map[string]string |
features | map[string]bool |
user | UserSlice |
SnapshotCapability
Section titled “SnapshotCapability”Source: modules/backup/snapshots.go
| Field | Type |
|---|---|
snapshot_type | SnapshotType |
instant | bool |
path | string |
source_identifier | string? |
details | map[string]any? |
SnapshotCreateResponse
Section titled “SnapshotCreateResponse”Source: modules/health/db_snapshot.go
| Field | Type |
|---|---|
snapshot | SnapshotFile |
pruned | int |
SnapshotListResponse
Section titled “SnapshotListResponse”Source: modules/health/db_snapshot.go
| Field | Type |
|---|---|
node | string? |
snapshots | []SnapshotFile |
SocketRow
Section titled “SocketRow”Source: modules/app/types.go
| Field | Type |
|---|---|
stack | string |
socket | string |
type | string |
connected | []string |
StackConfigResponse
Section titled “StackConfigResponse”Source: modules/stack/types.go
| Field | Type |
|---|---|
name | string |
environment | string |
config | map[string]any |
redaction | string? |
StackDryRunResponse
Section titled “StackDryRunResponse”Source: modules/stack/types.go
| Field | Type |
|---|---|
stack_name | string |
environment | string |
tenant_name | string |
exists | bool |
compose_yaml | string |
deployment_dir | string |
redaction | string? |
StackExecResponse
Section titled “StackExecResponse”Source: modules/stack/types.go
| Field | Type |
|---|---|
exit_code | int |
stdout | string |
stderr | string |
stdout_b64 | []byte |
stderr_b64 | []byte |
StackInspectResponse
Section titled “StackInspectResponse”Source: modules/stack/types.go
| Field | Type |
|---|---|
name | string |
app | string? |
version | string? |
environment | string |
status | string |
node | string? |
original_compose | InspectFileEntry? |
rendered_compose | InspectFileEntry? |
vars_yaml | InspectFileEntry? |
backup_yaml | InspectFileEntry? |
original_sockets | []InspectFileEntry? |
original_plugs | []InspectFileEntry? |
rendered_integrations | InspectFileEntry? |
original_jobs | []InspectFileEntry? |
rendered_jobs | []InspectFileEntry? |
stack_record | InspectFileEntry? |
backup_manifest | InspectFileEntry? |
placement | StackPlacement? |
composed_config | map[string]any? |
containers | []StackContainerView? |
health_rollup | string? |
warnings | []string? |
created_at | Time? |
updated_at | Time? |
status_changed_at | Time? |
redaction | string? |
StackLogsResponse
Section titled “StackLogsResponse”Source: modules/stack/types.go
| Field | Type |
|---|---|
logs | string |
StackMetrics
Section titled “StackMetrics”Source: modules/telemetry/types.go
| Field | Type |
|---|---|
stack | string |
tenant | string |
environment | string |
window | string |
windows | []string? |
series | []ServiceSeries |
empty | bool |
reason | string? |
StackResponse
Section titled “StackResponse”Source: modules/app/types.go
| Field | Type |
|---|---|
id | int |
stack_name | string |
app_name | string |
app_identity | string |
app_version | string? |
package_source | string? |
repo_name | string? |
app_digest | string? |
app_package | PackageDrift? |
integration_effects | []IntegrationEffect? |
tenant_name | string |
environment | string |
labels | map[string]string? |
node | string |
nodes | []string? |
stale_nodes | []string? |
proxied_addresses | []ProxiedAddress? |
status | DeploymentStatus |
status_reason | string? |
first_install_failed | bool? |
unreachable | []UnreachableWire? |
failover | []FailoverWire? |
moving | []MovingWire? |
status_unobservable | bool? |
desired | string |
status_changed_at | Time? |
queued_at | Time? |
runtime | Runtime |
addon | string? |
addon_version | string? |
disk_bytes | int64? |
services | []ServiceState? |
groups | []GroupStatus? |
resource_overrides | map[string]any? |
scale_overrides | map[string]string? |
access | string? |
exposure | string? |
effective_access | string? |
effective_exposure | string? |
quotas | DeploymentQuotas? |
installed_by | string? |
error_message | string? |
created_at | Time |
updated_at | Time |
lease_expires_at | string? |
protected | bool? |
pending_operation_id | string? |
vapps | []StackVapp? |
launcher_placed | bool? |
has_host | bool? |
parent_stack | string? |
vapp_instance | string? |
belongs_to | string? |
StackServicesResponse
Section titled “StackServicesResponse”Source: modules/app/router.go
| Field | Type |
|---|---|
services | map[string][]int |
StackUsageResponse
Section titled “StackUsageResponse”Source: modules/app/stack_usage.go
| Field | Type |
|---|---|
deployments | []DeploymentUsage |
Source: modules/operation/types.go
| Field | Type |
|---|---|
operation_id | string |
operation_type | string |
tenant_name | string? |
stack_name | string? |
status | Status |
created_at | float64 |
completed_at | float64? |
result | map[string]any? |
error_code | string? |
error_message | string? |
Status (modules/fabric)
Section titled “Status (modules/fabric)”Source: modules/fabric/status.go
| Field | Type |
|---|---|
mode | string |
block | string? |
ranges | []RangeView? |
cidr | string? |
listen_port | int? |
local_node_id | string? |
node_chunks | []string? |
device | DeviceStatus |
allocations | []AllocationView? |
pins | []Pin? |
crossing_guard | CrossingStatus? |
warnings | []string? |
Status (modules/leader)
Section titled “Status (modules/leader)”Source: modules/leader/types.go
| Field | Type |
|---|---|
is_leader | bool |
leader_node_id | string? |
last_transition_at | Time? |
observed_at | Time |
Status (modules/portal)
Section titled “Status (modules/portal)”Source: modules/portal/route.go
| Field | Type |
|---|---|
registered | bool |
released | bool |
portal_url | string? |
cluster_uid | string? |
agent_public | string? |
registered_at | string? |
registered_by | string? |
last_sync_at | string? |
floor_seconds | int? |
channel_state | string |
channel_error | string? |
store_grants | []string |
accepted_kinds | []string |
trust_rooted | bool |
idp_alias | string? |
federation | string? |
provision | string? |
recent_dispatches | []LedgerRecord? |
limits | Limits? |
usage | Usage? |
StatusGetResponse
Section titled “StatusGetResponse”Source: modules/health/types.go
| Field | Type |
|---|---|
replicas | []ReplicaStatus? |
groups | []GroupStanding? |
service_selectors | []ServiceSelectorStatus? |
published | []PublishedPort? |
published_age | string? |
nodes | []NodeMetricsResponse |
nodes_observed_by | string? |
deployments | []DeploymentHealthResponse |
last_poll | Time? |
unobserved_nodes | []UnobservedNode? |
membership_checked | bool? |
unobserved | []UnobservedDeployment? |
inventory_checked | bool? |
stack_resolution | StackResolution? |
automatic_moves | FreezeState? |
not_redundant | []SharedMembers? |
StatusInfo
Section titled “StatusInfo”Source: modules/license/service.go
| Field | Type |
|---|---|
state | string |
type | string? |
holder | string? |
account | string? |
domains | []string? |
estate_domain | string? |
registration | string? |
entitlements | map[string]any? |
features | []string? |
issued_at | Time? |
expires_at | Time? |
trial_ends_at | Time? |
watermarked | bool |
license_id | string? |
verified_key | string? |
source | string? |
dns_record | string? |
dns_note | string? |
auto_check_enabled | bool |
offline_by_policy | bool? |
last_checked_at | Time? |
next_check_after | Time? |
renewal_window_opens_at | Time? |
broker_configured | bool |
last_check_ok | bool? |
last_check_ok_at | Time? |
last_check_reached | bool? |
last_check_detail | string? |
check_failures | int? |
asks_ride_leader | bool? |
files | []FileStatus? |
baseline_limits | map[string]int64? |
effective_limits | map[string]int64? |
overage_applied | bool? |
overage_note | string? |
usage | map[string]int64? |
usage_sampled_at | Time? |
usage_cores_degraded | bool? |
term_peak | map[string]int64? |
term_started_at | Time? |
over_baseline_keys | []string? |
locked | bool? |
lock_reason | string? |
grace_ends_at | Time? |
over_cap_keys | []string? |
capacity_gate | CapacityGateAudit? |
StoreSweepReport
Section titled “StoreSweepReport”Source: modules/backup/store_retirement.go
| Field | Type |
|---|---|
root | string |
dry_run | bool |
archives | int |
imported | int |
importable | int |
already_sealed | int |
needs_repair_consent | int |
refused | int |
debris_files | int |
imported_bytes | int64 |
importable_bytes | int64 |
already_sealed_bytes | int64 |
needs_repair_consent_bytes | int64 |
refused_bytes | int64 |
debris_bytes | int64 |
reclaimable_bytes | int64 |
entries | []StoreSweepEntry |
evidence | string |
SyncProgress
Section titled “SyncProgress”Source: modules/repo/progress.go
| Field | Type |
|---|---|
phase | string |
pages | int? |
apps | int? |
apps_done | int? |
SystemKeycloakAdminPasswordResetResult
Section titled “SystemKeycloakAdminPasswordResetResult”Source: modules/app/keycloak_admin_password.go
| Field | Type |
|---|---|
password | string? |
generated | bool |
redeployed | bool |
SystemOpenObserveAdminPasswordResetResult
Section titled “SystemOpenObserveAdminPasswordResetResult”Source: modules/app/openobserve_admin_password.go
| Field | Type |
|---|---|
password | string? |
generated | bool |
redeployed | bool |
SystemPlanResponse
Section titled “SystemPlanResponse”Source: modules/app/system_plan.go
| Field | Type |
|---|---|
apps | []string |
already_initialized | bool |
skipped | []SystemAppSkip? |
edge_added | string? |
TakeoverOutcome
Section titled “TakeoverOutcome”Source: modules/dns/takeover.go
| Field | Type |
|---|---|
host | string |
taken | bool |
state | string |
previous_owner | string? |
previous_generation | string? |
owner | string |
Target
Section titled “Target”Source: pkg/scanreport/report.go
| Field | Type |
|---|---|
name | string |
app | string? |
version | string? |
tenant | string? |
environment | string? |
stack | string? |
images | []Image |
warnings | []string? |
advisory | Advisory? |
TaskDetail
Section titled “TaskDetail”Source: modules/task/types.go
| Field | Type |
|---|---|
id | string |
name | string |
status | string |
trigger | string |
node | string? |
created_at | Time |
started_at | Time? |
completed_at | Time? |
attempts | int |
max_attempts | int |
max_runtime_seconds | int? |
event | string? |
error_message | string? |
kwargs | string? |
TaskListResponse (modules/repo)
Section titled “TaskListResponse (modules/repo)”Source: modules/repo/types.go
| Field | Type |
|---|---|
task_ids | []string |
TaskListResponse (modules/task)
Section titled “TaskListResponse (modules/task)”Source: modules/task/types.go
| Field | Type |
|---|---|
data | []TaskEntry |
total_count | int |
has_more | bool |
TaskResponse
Section titled “TaskResponse”Source: modules/repo/types.go
| Field | Type |
|---|---|
task_id | string |
TenantInfoResponse
Section titled “TenantInfoResponse”Source: modules/tenant/types.go
| Field | Type |
|---|---|
name | string |
active | bool |
deployments_total | int |
deployments_running | int |
deployments_stopped | int |
data_dir | string |
config_dir | string |
TenantListResponse
Section titled “TenantListResponse”Source: modules/tenant/types.go
| Field | Type |
|---|---|
data | []TenantResponse |
total_count | int |
has_more | bool |
TenantResponse
Section titled “TenantResponse”Source: modules/tenant/types.go
| Field | Type |
|---|---|
name | string |
deployment_count | int |
active | bool |
data_dir | string? |
config_dir | string? |
admin_username | string? |
admin_password | string? |
provisioning_warning | string? |
TokenMessage
Section titled “TokenMessage”Source: modules/cluster/token_router.go
| Field | Type |
|---|---|
token | string |
expires_at | string |
UnlinkResponse
Section titled “UnlinkResponse”Source: modules/storage/storageapi/types.go
| Field | Type |
|---|---|
unlinked | bool |
UpdatePlan
Section titled “UpdatePlan”Source: modules/app/update_plan.go
| Field | Type |
|---|---|
tenant_name | string |
stack_name | string |
environment | string |
changes | []PlanChange |
replicas | []PlanReplica? |
outages | []PlanOutage? |
integration_effects | []IntegrationEffect? |
UpdateRollbackResult
Section titled “UpdateRollbackResult”Source: modules/app/update_rollback.go
| Field | Type |
|---|---|
plan | UpdateRollbackPlan |
rolled_back | bool |
rollout | string? |
UpdatesResponse
Section titled “UpdatesResponse”Source: modules/catalog/updates.go
| Field | Type |
|---|---|
updates | []UpdateCandidate |
sources | []Source |
UsageResponse
Section titled “UsageResponse”Source: modules/quota/types.go
| Field | Type |
|---|---|
id | int64 |
tenant_name | string |
environment | string? |
deployment_name | string? |
scope_name | string |
cpu_millicores | int64 |
memory_bytes | int64 |
disk_bytes | int64 |
deployment_count | int64 |
environment_count | int64 |
app_count | int64 |
vdeployment_count | int64 |
created_at | Time |
updated_at | Time |
disk_measured_at | Time? |
UserGroupCreateResponse
Section titled “UserGroupCreateResponse”Source: modules/user/types.go
| Field | Type |
|---|---|
tenant | string |
name | string |
created | bool |
UserGroupDeleteResponse
Section titled “UserGroupDeleteResponse”Source: modules/user/types.go
| Field | Type |
|---|---|
tenant | string |
name | string |
deleted | bool |
UserGroupListResponse
Section titled “UserGroupListResponse”Source: modules/user/types.go
| Field | Type |
|---|---|
tenant | string |
data | []UserGroup |
total_count | int |
UserJoinResponse
Section titled “UserJoinResponse”Source: modules/user/types.go
| Field | Type |
|---|---|
tenant | string |
username | string |
group | string |
joined | bool |
UserLeaveResponse
Section titled “UserLeaveResponse”Source: modules/user/types.go
| Field | Type |
|---|---|
tenant | string |
username | string |
group | string |
left | bool |
VaultStatusResponse
Section titled “VaultStatusResponse”Source: modules/vault/types.go
| Field | Type |
|---|---|
initialized | bool |
locked | bool |
VaultUnlockResponse
Section titled “VaultUnlockResponse”Source: modules/vault/types.go
| Field | Type |
|---|---|
message | string |
initialized | bool |
VerifyReport
Section titled “VerifyReport”Source: modules/backup/verify_contents.go
| Field | Type |
|---|---|
backup_id | string |
snapshot_id | string? |
manifest_read | bool |
contents | ArchiveContents? |
deep | bool |
reading | DeepReading? |
local_archive | bool? |
local_evidence | string? |
container | ContainerAudit? |
warnings | []string? |
VolumeFileListing
Section titled “VolumeFileListing”Source: modules/backup/volume_files.go
| Field | Type |
|---|---|
tenant | string |
stack | string |
environment | string |
volume | string |
path | string |
node | string? |
node_name | string? |
entries | []VolumeFileEntry |
total | int |
offset | int |
next | int? |
truncated | bool? |
VolumeFilesRmResult
Section titled “VolumeFilesRmResult”Source: modules/backup/router_volume_files.go
| Field | Type |
|---|---|
path | string |
removed | bool |
node | string? |
node_name | string? |
VolumeFilesVolumesResult
Section titled “VolumeFilesVolumesResult”Source: modules/backup/router_volume_files.go
| Field | Type |
|---|---|
volumes | []VolumeFilesVolume |
VolumeFilesWriteResult
Section titled “VolumeFilesWriteResult”Source: modules/backup/router_volume_files.go
| Field | Type |
|---|---|
entry | VolumeFileEntry |
node | string? |
node_name | string? |
VolumeMountHandle
Section titled “VolumeMountHandle”Source: modules/backup/state.go
| Field | Type |
|---|---|
id | string |
kind | VolumeMountKind |
mount_path | string |
node_id | string? |
container_id | string? |
volume_name | string? |
tenant_name | string? |
stack_name | string? |
environment | string? |
source | string? |
read_only | bool |
owner | string? |
managed | bool |
started_at | Time |
ttl_seconds | int64? |
expires_at | Time |
expires_in_seconds | int64 |
status | string |
attached_node | string? |
detached | bool? |
VolumeMountListResponse
Section titled “VolumeMountListResponse”Source: modules/backup/router_volumes.go
| Field | Type |
|---|---|
mounts | []VolumeMountHandle |
total | int |
WorkerListResponse
Section titled “WorkerListResponse”Source: modules/task/types.go
| Field | Type |
|---|---|
data | []WorkerEntry |
total_count | int |
has_more | bool |
conditionCatalogResponse
Section titled “conditionCatalogResponse”Source: modules/condition/router.go
| Field | Type |
|---|---|
conditions | []conditionCatalogEntry |
conditionsResponse
Section titled “conditionsResponse”Source: modules/condition/router.go
| Field | Type |
|---|---|
evaluated_at | Time |
duration_ns | Duration |
conditions | []Condition |
checks | []ConditionCheck |
summary | Tally |
node | string? |
age_seconds | float64 |
stale | bool |
deleteResponse
Section titled “deleteResponse”Source: modules/branding/router.go
| Field | Type |
|---|---|
name | string |
removed | bool |
docListEnvelope
Section titled “docListEnvelope”Source: modules/quota/router.go
| Field | Type |
|---|---|
data | any |
has_more | bool |
total_count | int |
emitResponse
Section titled “emitResponse”Source: modules/notification/router.go
| Field | Type |
|---|---|
code | string |
rules | []emitOutcome |
exportResponse
Section titled “exportResponse”Source: modules/vault/router.go
| Field | Type |
|---|---|
bundle | string |
format | string |
bytes | int |
importResponse
Section titled “importResponse”Source: modules/vault/router.go
| Field | Type |
|---|---|
imported | int |
updated | int |
skipped | int |
keys | []string? |
leaseResponse
Section titled “leaseResponse”Source: modules/app/lease_router.go
| Field | Type |
|---|---|
has_lease | bool |
expires_at | string? |
listResponse
Section titled “listResponse”Source: modules/doctor/router.go
| Field | Type |
|---|---|
diagnoses | []listEntry |
meshClientEnrolMessage
Section titled “meshClientEnrolMessage”Source: modules/cluster/mesh_client_router.go
| Field | Type |
|---|---|
name | string |
address | string |
address_block | string |
generation | int |
current | string |
peers | []meshClientPeer |
meshClientListMessage
Section titled “meshClientListMessage”Source: modules/cluster/mesh_client_router.go
| Field | Type |
|---|---|
clients | []meshClientRow |
meshClientRevokeMessage
Section titled “meshClientRevokeMessage”Source: modules/cluster/mesh_client_router.go
| Field | Type |
|---|---|
name | string |
revoked | bool |
protectResponse
Section titled “protectResponse”Source: modules/app/protected_router.go
| Field | Type |
|---|---|
protected | bool |
ruleListResponse
Section titled “ruleListResponse”Source: modules/notification/router.go
| Field | Type |
|---|---|
data | []ruleRow |
total_count | int |
runAsyncResponse
Section titled “runAsyncResponse”Source: modules/doctor/router.go
| Field | Type |
|---|---|
operation_id | string |
status | string |
message | string |
runResponse
Section titled “runResponse”Source: modules/doctor/router.go
| Field | Type |
|---|---|
checks | []DiagnosisResult |
summary | Summary |
fix | bool |
fix_destructive | []string? |
testResponse
Section titled “testResponse”Source: modules/notification/router.go
| Field | Type |
|---|---|
rule | string |
url | string |
attempts | int |
status_code | int |
volumeAssertLeaseLostResponse
Section titled “volumeAssertLeaseLostResponse”Source: modules/storage/router.go
| Field | Type |
|---|---|
node | string |
asserted_by | string |
asserted_at | string |
expires_at | string |
episode | string |
reason | string |
meaning | string |
volumeLsResponse
Section titled “volumeLsResponse”Source: modules/storage/router.go
| Field | Type |
|---|---|
volumes | []VolumeView |
volumeRebindResponse
Section titled “volumeRebindResponse”Source: modules/storage/router.go
| Field | Type |
|---|---|
rebound | bool |
volumeRestoreSnapshotResponse
Section titled “volumeRestoreSnapshotResponse”Source: modules/storage/router.go
| Field | Type |
|---|---|
handle | string |
restored | bool |
volumeRmResponse
Section titled “volumeRmResponse”Source: modules/storage/router.go
| Field | Type |
|---|---|
removed | bool |
volumeSnapshotResponse
Section titled “volumeSnapshotResponse”Source: modules/storage/router.go
| Field | Type |
|---|---|
snapshot | string |