API schemas: B

BackupFeatureView

OpenAPI stand-in for backup feature names advertised by /v1/backup/info.

Values: "allocation-context", "dirty-bitmap-context", "fleecing", "quiesce"

BackupPointDiskView

One disk of a backup point.

Name	Type	Required	Description
`capacityBytes`	`integer` (int64)	yes	Capacity in bytes.
`changeId`	`string` or `null`		Change id the backup was taken at (for incremental backups), when known.
`deviceKey`	`integer` (int32)	yes	Device key of the disk in the virtual machine.

BackupPointView

A backup kept in the repository.

Name	Type	Required	Description
`consistency`	`string`	yes	`CRASH_CONSISTENT`: what the repository can promise (the manifest does not say whether the guest was quiesced).
`diskDetails`	array of `BackupPointDiskView`	yes	The disks.
`disks`	`integer`	yes	Number of disks.
`id`	`string`	yes	Id of the backup point (the id of the backup session that made it).
`kind`	`string`	yes	`full`: the repository keeps whole disk images.
`sessionId`	`string` or `null`		The backup session that made it.
`sizeBytes`	`integer` (int64)	yes	Size of the backup in the repository, in bytes.
`takenAt`	`string`	yes	When the backup completed (RFC 3339).
`verified`	`boolean` or `null`		Result of the last restore verification of this point, when one ran.
`vmId`	`string`	yes	Instance uuid of the virtual machine.
`vmName`	`string`	yes	Name of the virtual machine, when it still exists.
`vmRef`	`string` or `null`		Inventory id of the virtual machine (`vm-N`), when it still exists.

BackupRepositoryView

The backup repository.

Name	Type	Required	Description
`configured`	`boolean`	yes	A repository is configured (`[backup] verify_repository` of the controller).
`points`	`integer`	yes	Backup points kept.

BackupScheduleRequest

Body of POST /v1/backup/schedules and PUT /v1/backup/schedules/{id}.

Name	Type	Required	Description
`enabled`	`boolean`		Runs when true.
`frequency`	`string`	yes	`daily` or `weekly`.
`fullEvery`	`integer` (int32)		A full transfer every n points (default 7).
`hour`	`integer` (int32)	yes	Hour, UTC.
`minute`	`integer` (int32)		Minute.
`name`	`string`	yes	Name.
`quiesce`	`QuiesceModeView`		Quiescing.
`retention`	`integer` (int32)		Points kept per virtual machine (default 14; 0: all).
`scope`	`string`	yes	Inventory id of the folder, datacenter, cluster, resource pool, host or virtual machine.
`weekdays`	array of `integer` (int32)		Weekdays, 0 is Sunday (weekly only).

BackupScheduleView

A backup schedule.

Name	Type	Required	Description
`enabled`	`boolean`	yes	Runs when true.
`frequency`	`string`	yes	`daily` or `weekly`.
`fullEvery`	`integer` (int32)	yes	A full transfer every n points (1: every point is full).
`hour`	`integer` (int32)	yes	Hour, UTC.
`id`	`string`	yes	Id (`bkschedule-N`).
`lastResult`	`string` or `null`		`success` or `failure` of the last finished run.
`lastRunAt`	`string` or `null`		Start of the last run.
`minute`	`integer` (int32)	yes	Minute.
`name`	`string`	yes	Name.
`nextRunAt`	`string` or `null`		Next run.
`quiesce`	`QuiesceModeView`	yes	Quiescing.
`retention`	`integer` (int32)	yes	Points kept per virtual machine (0: all).
`scope`	`string`	yes	Folder, datacenter, cluster, resource pool, host or virtual machine it covers.
`scopeName`	`string` or `null`		Name of the scope.
`weekdays`	array of `integer` (int32)	yes	Weekdays, 0 is Sunday (weekly only).

BackupSessionView

OpenAPI stand-in for BackupSession.

Name	Type	Required	Description
`cleanupPending`	`boolean`		Host-side cleanup is pending retry.
`consistency`	`ConsistencyView` or `null`
`createdAt`	`string` (date-time)	yes	Creation time (RFC 3339 UTC).
`deadline`	`string` (date-time)	yes	Session expires at this time unless kept alive (RFC 3339 UTC).
`disks`	array of `DiskBackupView`	yes	Disks in the session.
`fleecing`	`boolean`	yes	Whether fleecing was requested.
`id`	`string` (uuid)	yes	Session id.
`owner`	`string`	yes	Principal that started the session.
`pointId`	`string` or `null`		Agent-side identifier of the backup point.
`quiesce`	`QuiesceModeView`	yes	Requested quiescing.
`reason`	`string` or `null`		Message key for `ABORTED` or `EXPIRED`, if any.
`state`	`SessionStateView`	yes	Current state.
`ttlSeconds`	`integer` (int64)	yes	Lifetime granted by each keepalive, in seconds.
`updatedAt`	`string` (date-time)	yes	Last state change or keepalive (RFC 3339 UTC).
`vmId`	`string` (uuid)	yes	VM instance UUID.

BackupSettingsRequest

Body of PUT /v1/backup/settings (remoteExports is ignored).

Name	Type	Required	Description
`defaultQuiesce`	`QuiesceModeView`	yes	Quiescing of backups that do not say.
`remoteExports`	`boolean` or `null`		Ignored (configuration only).
`repository`	`string`	yes	Repository directory, absolute; empty: none.
`verifyDestroy`	`boolean`	yes	Destroy verification VMs after the verdict.
`verifyNetwork`	`string`		Quarantine network (id or name); empty: none.
`verifyPool`	`string`		Datastore restored disks go to; empty: the first usable one.
`verifySchedule`	`string`		Nightly verification schedule; empty: off.
`verifyTimeoutSeconds`	`integer` (int64)	yes	Timeout of one verification, 30 to 3600 seconds.

BackupSettingsView

Settings of the backup service. Changes are kept in the replicated store and apply on every controller; a field the console never changed shows the [backup] section.

Name	Type	Required	Description
`defaultQuiesce`	`QuiesceModeView`	yes	Quiescing of backups that do not say.
`remoteExports`	`boolean`	yes	Off-host exports (TCP with TLS); set in the configuration, read-only here.
`repository`	`string`	yes	Repository directory (`verify_repository`); empty: none.
`verifyDestroy`	`boolean`	yes	Destroy verification VMs after the verdict.
`verifyNetwork`	`string`	yes	Quarantine network of the nightly verification.
`verifyPool`	`string`	yes	Datastore restored disks go to; empty: the first usable one.
`verifySchedule`	`string`	yes	Nightly verification: `HH:MM` UTC or an interval such as `6h`; empty: off.
`verifyTimeoutSeconds`	`integer` (int64)	yes	Timeout of one verification, seconds.

BeginBackupRequestView

OpenAPI stand-in for BeginBackupRequest (model lives in kyvernon-backup).

Name	Type	Required	Description
`disks`	array of `DiskSelectionView`		Disk selections; empty means every CBT-enabled disk with `*`.
`fallbackToFull`	`boolean`		Fall back to a full backup when a change id is stale.
`fleecing`	`boolean`		Fleecing requested.
`quiesce`	`QuiesceModeView`		Quiesce mode (`NONE` / `PREFERRED` / `REQUIRED`).
`ttlSeconds`	`integer` (int64) or `null`		Session TTL in seconds.
`vmId`	`string` (uuid)	yes	VM instance UUID.

BeginRestoreRequest

Body for begin restore.

Name	Type	Required	Description
`capacity`	`integer` (int64)	yes	Capacity in bytes.
`deviceKey`	`integer` (int32)	yes	Device key the restored disk will use.
`pool`	`string`	yes	Target pool / datastore name (recorded; simulate attaches using an existing datastore).
`thin`	`boolean`		Thin provisioning.
`verify`	`VerifySpec` or `null`
`vmId`	`string` (uuid)	yes	Target VM instance UUID (new or powered-off).

Billable

Which direction is billed.

Values: "out", "in_out", "max"

BootEvidence

What the boot showed.

Name	Type	Required	Description
`firmwareMarkers`	array of `string`	yes	Firmware markers seen.
`osMarkers`	array of `string`	yes	Operating-system markers seen.
`reachedRunning`	`boolean`	yes	The VM's lifecycle state was `running`.
`serialBytes`	`integer` (int64)	yes	Bytes of serial console output seen.
`serialTail`	`string`	yes	The end of the serial console output (bounded).

BridgeKind

OpenAPI schema of [BridgeKind], whose crate has no schema support; bridge_kind_schema_matches_the_model keeps the two equal.

Values: "ovs", "linux"

BypassBody

Body of POST /v1/firewall/bypass.

Name	Type	Required	Description
`durationSeconds`	`integer` (int64) or `null`		How long, seconds (60 to 86,400; default 1,800).
`host`	`string`	yes	Host id (`host-N`).
`reason`	`string`	yes	Why (kept in the policy and the events; 1 to 500 characters).

BypassView

A bypass in force.

Name	Type	Required	Description
`expiresAt`	`string`	yes	End (RFC 3339).
`host`	`string`	yes	Host id.
`id`	`string`	yes	Policy id (`fwpolicy-N`), the id for `DELETE`.
`reason`	`string`	yes	Reason.
`rule`	`integer` (int32)	yes	Rule number.