API schemas: S

ScheduledAction

Power action a scheduled task may invoke (M1-CP-03 thin slice).

Values: "power_on", "power_off"

ScheduledRecurrence

Scheduler kind persisted for a scheduled task (M1-CP-03).

One-shot tasks use [ScheduledTask::run_at]. Recurrent variants store their cadence here; missing field deserialises as [ScheduledRecurrence::Once].

One of: object, object, object, object, object, object

ScheduledTaskState

Lifecycle of a scheduled task (maps to TaskInfoState on the wire).

Values: "queued", "running", "success", "error"

ScheduledTaskView

A scheduled power task (native /v1/scheduled-tasks, M1-CP-03).

Name	Type	Required	Description
`action`	`ScheduledAction`	yes	Power action.
`activeTaskId`	`string` or `null`		Active power-task id, if any.
`activeTime`	`string` or `null`		Optional scheduler active time.
`createdBy`	`string`	yes	Creating user.
`description`	`string`	yes	Description.
`enabled`	`boolean`	yes	Enabled.
`entityId`	`string`	yes	Target VM id.
`expireTime`	`string` or `null`		Optional scheduler expire time.
`id`	`string`	yes	Scheduled-task id (`schedule-N`).
`lastError`	`string` or `null`		Last error message when `state` is `error`.
`name`	`string`	yes	Display name.
`nextRunTime`	`string` or `null`		Next run time.
`notification`	`string` or `null`		Optional notification address (SMTP send when `[smtp] enabled`).
`prevRunTime`	`string` or `null`		Previous run time.
`recurrence`	`ScheduledRecurrence`	yes	Scheduler cadence.
`runAt`	`string`	yes	One-shot run time / create-time anchor (RFC 3339).
`state`	`ScheduledTaskState`	yes	Lifecycle state.

SerialLogView

Tail of a VM's serial console log (Kyvernon VMM has no graphical console yet).

Name	Type	Required	Description
`available`	`boolean`	yes	True when a serial log file is configured for the VM.
`bytes`	`integer` (int64)	yes	Bytes returned.
`text`	`string`	yes	Log text (lossy UTF-8). Empty when the file is not there yet.
`totalBytes`	`integer` (int64)	yes	Total size of the log file on the host when read.
`truncated`	`boolean`	yes	True when the file was larger than the returned window.

SeriesView

One series, column-oriented: values[i] was measured over the interval ending at timestamps[i].

Name	Type	Required	Description
`counter`	`string`	yes	Counter name.
`counterId`	`integer` (int32)	yes	Counter id.
`entity`	`string`	yes	Entity id.
`entityName`	`string` or `null`		Entity name.
`instance`	`string`	yes	Instance (`""` = aggregate).
`interval`	`integer` (int32)	yes	Sampling period of the points.
`timestamps`	array of `integer` (int64)	yes	Interval end times, Unix seconds, ascending.
`unit`	`string`	yes	Unit key; percent values are 0..100.
`values`	array of `number` (double)	yes	Values.

ServerAddressBody

Body of POST /v1/vms/{id}/addresses.

Name	Type	Description
`ipv6`	`boolean` or `null`	Also a /64 when the pool has IPv6 (default true).
`pool`	`string` or `null`	Pool (absent: the first pool on the VM's networks with a free address).
`reference`	`string` or `null`	Caller reference.
`tenant`	`string` or `null`	Tenant (quota).

ServerAddressUsage

Public addresses of one server.

Name	Type	Required	Description
`extra`	array of `AddressSince`	yes	The extra addresses with the time they were allocated (for proration).
`extraIpv4`	`integer` (int32)	yes	Extra IPv4 addresses (billed as add-on).
`ipv6Prefixes`	`integer` (int32)	yes	/64 prefixes.
`primaryIpv4`	`integer` (int32)	yes	Primary addresses (one per NIC; part of the plan).
`vm`	`string`	yes	VM id.

ServerAddresses

What server create gets back: the addresses to put in the guest's configuration.

Name	Type	Required	Description
`dnsServers`	array of `string`	yes	DNS servers.
`gateway`	`string` or `null`		IPv4 gateway.
`ipv4`	`string` or `null`		Primary IPv4 address (the NIC's DHCP lease).
`ipv6Address`	`string` or `null`		The suggested IPv6 address (`<block>::1`, the block itself for a /128), configured with `ipv6OnlinkLen`.
`ipv6Gateway`	`string` or `null`		The IPv6 gateway (the router's link-local or on-link address).
`ipv6OnlinkLen`	`integer` (int32) or `null`		Prefix length the guest configures on `ipv6Address` (the segment's on-link prefix, at least 64), so the gateway is on-link with a standard configuration.
`ipv6Prefix`	`string` or `null`		The server's IPv6 block (a /64 by default, a /112 per VPS on a shared /64).
`ipv6PrefixLen`	`integer` (int32) or `null`		Length of the server's block (`ipv6Prefix/ipv6PrefixLen`): what port security allows.
`mac`	`string`	yes	NIC MAC the addresses are bound to.
`pool`	`string` or `null`		The pool.
`prefixLen`	`integer` (int32)	yes	Prefix length of the IPv4 subnet.

ServerPowerRequest

A power action.

Name	Type	Required	Description
`action`	`string`	yes	`on`, `off` (hard), `shutdown` (through the guest, then hard), `reboot` or `reset`.

ServerSnapshotRequest

Request to snapshot a server.

Name	Type	Required	Description
`name`	`string`	yes	Snapshot name (1..=80 characters).

ServerSnapshotView

A snapshot of a server.

Name	Type	Required	Description
`createdAt`	`string`	yes	Taken.
`key`	`integer` (int32)	yes	Key.
`name`	`string`	yes	Name.

ServerTaskView

The answer of a server operation: its task, and a generated password once.

Name	Type	Required	Description
`password`	`string` or `null`		The generated password: shown only in this answer, never stored in clear.
`rebootRequired`	`boolean`		The operation reboots the server (resize).
`serverId`	`string`	yes	The server.
`taskId`	`string`	yes	The task to poll (`GET /v1/tasks/{id}`).

ServerUsageView

One server's usage in a month.

Name	Type	Required	Description
`hostname`	`string`	yes	Host name.
`plans`	array of `PlanHoursView`	yes	Hours per plan (proration over a resize).
`server`	`string`	yes	Server.
`snapshotGibHours`	`number` (double)	yes	Snapshot GiB-hours (provisioned size of the VM's disks per snapshot).
`state`	`string`	yes	State now.
`vm`	`string` or `null`		VM (while it exists).

ServerView

A self-service server.

Name	Type	Required	Description
`addresses`	array of `string`	yes	Public addresses.
`createTask`	`string` or `null`		The create task.
`createdAt`	`string`	yes	Created.
`deletedAt`	`string` or `null`		Deleted.
`error`	`string`		Why the create failed.
`hostname`	`string`	yes	Host name.
`id`	`string`	yes	`server-N`.
`image`	`string`	yes	Image.
`imageName`	`string`	yes	Image name.
`passwordPending`	`boolean`	yes	A new password is applied at the next boot.
`plan`	`string`	yes	Plan.
`planName`	`string`	yes	Plan name.
`powerState`	`string` or `null`		Power state of the VM.
`rescueSince`	`string` or `null`		In rescue mode since.
`snapshots`	array of `ServerSnapshotView`	yes	Snapshots.
`state`	`string`	yes	`creating`, `active`, `rescue`, `deleted` or `failed`.
`tenant`	`string`	yes	Tenant.
`vmId`	`string` or `null`		The VM.

ServiceAccountRequest

Service-account flag.

Name	Type	Required	Description
`serviceAccount`	`boolean`	yes	Whether the account is a service account.

ServiceBody

Create or replace a named service.

Name	Type	Required	Description
`description`	`string`		Description.
`entries`	array of `ServiceEntryView`	yes	Entries (no named services inside).
`name`	`string`	yes	Name.

ServiceEntryView

One service entry: tcp, udp or sctp with destination ports ("443", "1000-1999"; empty: any port), icmp4 or icmp6 with an optional type and code, ip with a protocol number, or named with the id of a named service.

Name	Type	Required	Description
`icmpCode`	`integer` (int32) or `null`		ICMP code (needs a type).
`icmpType`	`integer` (int32) or `null`		ICMP type.
`id`	`string` or `null`		Named service id (`named`).
`number`	`integer` (int32) or `null`		IP protocol number (`ip`).
`ports`	array of `string`		Destination ports or ranges (TCP, UDP, SCTP).
`protocol`	`string`	yes	`tcp`, `udp`, `sctp`, `icmp4`, `icmp6`, `ip` or `named`.
`sourcePorts`	array of `string`		Source ports or ranges (TCP, UDP, SCTP; empty: any).

ServiceView

A named service.

Type: ServiceBody, object

SessionInfoView

A session (administrator view; no token material).

Name	Type	Required	Description
`breakGlass`	`boolean`	yes	Break-glass.
`clientAddress`	`string`	yes	Client address.
`createdAt`	`string`	yes	Created.
`expiresAt`	`string`	yes	Expires.
`id`	`string`	yes	Session id.
`kind`	`string`	yes	`interactive` or `api`.
`lastActive`	`string`	yes	Last activity.
`username`	`string`	yes	Username.

SessionStateView

OpenAPI stand-in for SessionState.

Values: "REQUESTED", "SNAPSHOT_TAKEN", "EXPORTING", "COMPLETED", "ABORTED", "EXPIRED"

SessionView

An issued session.

Name	Type	Required	Description
`expiresAt`	`string`	yes	Hard expiry.
`mfaEnrolmentRequired`	`boolean`	yes	MFA enrolment must be completed before other calls succeed.
`passwordRotationRequired`	`boolean`	yes	The password must be changed before other calls succeed.
`sessionId`	`string`	yes	Session id.
`token`	`string`	yes	Bearer token; shown once.
`user`	`UserView`	yes	User.

SetEnabledRequest

Enable/disable request.

Name	Type	Required	Description
`enabled`	`boolean`	yes	Enabled.

SetPermissionRequest

Set-permission request.

Name	Type	Required	Description
`entityId`	`string`	yes	Entity id.
`principal`	`PrincipalView`	yes	Principal.
`propagate`	`boolean`		Propagate (default true).
`roleId`	`string`	yes	Role id.

SetSoftwareIscsiRequest

Body for PUT /v1/hosts/{id}/iscsi/software.

Name	Type	Required	Description
`enabled`	`boolean`	yes	Enable or disable the software iSCSI initiator.

SettingsView

Domain-wide firewall settings.

Name	Type	Required	Description
`ctLimitPerPort`	`integer` (int32)	yes	Connection-tracking entries per vNIC.
`enforceNew`	`boolean`	yes	vNICs added to VMs from now on start in mode `enforce` (default `false`: mode `off`); existing vNICs are not changed.
`flowLimitPerBridge`	`integer` (int32)	yes	Firewall flows per host bridge.
`logRatePps`	`integer` (int32)	yes	Log rate per host (packets per second, meter `kyv-fw-log`).
`monitorReportDays`	`integer` (int32)	yes	Days a monitor report covers.
`rejectRatePps`	`integer` (int32)	yes	Reject answers per second per bridge (meter `kyv-fw-reject`).
`version`	`integer` (int64)		Record version (ignored in requests).

SeverityView

Event severity.

Values: "info", "warning", "error", "user"

SharesLevel

Shares level for a resource allocation.

Values: "low", "normal", "high", "custom"

ShutdownRequest

Graceful shutdown of a VM (POST /v1/vms/{id}/shutdown).

Name	Type	Required	Description
`idempotencyKey`	`string` or `null`		Idempotency key.
`timeoutSeconds`	`integer` (int64) or `null`		How long the guest gets to shut down before the VM is powered off hard (seconds, 1 to 3600; default 90).

SimulateBody

A packet to evaluate at a vNIC.

Name	Type	Required	Description
`direction`	`string`	yes	`in` (to the vNIC) or `out` (from it).
`icmpCode`	`integer` (int32) or `null`		ICMP code.
`icmpType`	`integer` (int32) or `null`		ICMP type.
`local`	`string` or `null`		The vNIC's own address (default: its first address of the peer's family).
`nic`	`string` or `null`		NIC key (default: the VM's first host-bridge NIC).
`peer`	`string`	yes	The other end's address.
`port`	`integer` (int32) or `null`		Destination port (TCP, UDP).
`protocol`	`string`	yes	`tcp`, `udp`, `icmp4`, `icmp6` or a protocol number.
`state`	`string` or `null`		Connection state: `new` (default), `established`.
`vm`	`string`	yes	VM id.

SimulateView

The verdict of a simulated packet (the vNIC evaluated as if in mode enforce).

Name	Type	Required	Description
`category`	`CategoryView` or `null`
`mode`	`ModeView`	yes	The vNIC's current mode (in `monitor` a drop is forwarded and reported; in `off` nothing is evaluated).
`policy`	`string` or `null`		Policy of that rule.
`rule`	`integer` (int32)	yes	Rule number that decided (0: default, state or system traffic).
`stage`	`string`	yes	`system`, `state`, `rule`, `default` (where the decision was made).
`verdict`	`string`	yes	`allow`, `drop` or `reject`.

SmtpBody

Body of PUT /v1/vms/{id}/smtp.

Name	Type	Required	Description
`reason`	`string` or `null`		Why (stored in the audit event, e.g. the portal's ticket).
`unblocked`	`boolean`	yes	`true`: allow port 25 for this VM in both families; `false`: the pools' setting.

SmtpPolicy

Outgoing SMTP (TCP 25) of the guests of a pool, per address family.

Values: "allowed", "blocked"

SmtpView

SMTP state of one VM.

Name	Type	Required	Description
`ipv4Blocked`	`boolean`	yes	Outgoing SMTP over IPv4 is dropped now.
`ipv6Blocked`	`boolean`	yes	Outgoing SMTP over IPv6 is dropped now.
`unblocked`	`boolean`	yes	The VM is unblocked (its pools' blocks do not apply).
`vm`	`string`	yes	VM id.

SnapshotKeyResultView

TaskView.result of revert-snapshot (the key that is now current).

Name	Type	Required	Description
`snapshot`	`integer` (int32)	yes	Snapshot key.

StartBackupRequest

Body of POST /v1/backup/points.

Name	Type	Required	Description
`full`	`boolean` or `null`		Transfer every allocated area even when change tracking could give an incremental backup.
`quiesce`	`QuiesceModeView` or `null`
`vmId`	`string`	yes	Virtual machine: instance uuid or id (`vm-N`).

SubscriptionView

A webhook subscription (secret never returned).

Name	Type	Required	Description
`deadLetters`	`integer` (int32)	yes	Dead letters currently parked.
`delivered`	`integer` (int64)	yes	Successful deliveries.
`enabled`	`boolean`	yes	Enabled.
`eventTypes`	array of `string`	yes	Event types delivered (empty = all).
`failed`	`integer` (int64)	yes	Failed deliveries (after all attempts).
`id`	`string`	yes	Id.
`labels`	array of `string`	yes	Labels (alarm actions reference them).
`maxAttempts`	`integer` (int32)	yes	Delivery attempts per event.
`name`	`string`	yes	Name.
`tenant`	`string` or `null`		Tenant filter (`tenant-N`): only that tenant's self-service events.
`url`	`string`	yes	Target URL.