API schemas: T

Tag

A tag. Its parent record is its category; attachments are stored on the tag so that listing tags of an object is one lookup through attached_to.

Name	Type	Required	Description
`attached_to`	array of `string`		Objects this tag is attached to.
`description`	`string`		Description.
`name`	`string`	yes	Display name.

TagCategory

A tag category.

Name	Type	Required	Description
`associable_kinds`	array of `string`		Kinds the tags may be attached to (empty = any inventory kind).
`cardinality`	`Cardinality`		Cardinality.
`description`	`string`		Description.
`name`	`string`	yes	Display name.
`provider_managed`	`boolean`		Tags of this category are attached by the provider only, and only they count in the tag criteria of provider firewall groups (`docs/network/DFW-HOSTBRIDGE.md` §5). Tenant users cannot attach or detach them.

TagCategoryBody

Body of PUT /v1/firewall/tag-categories/{id}.

Name	Type	Required	Description
`providerManaged`	`boolean`	yes	Provider-managed.

TagCategoryView

A tag category and whether it is provider-managed.

Name	Type	Required	Description
`id`	`string`	yes	`category-N`.
`name`	`string`	yes	Name.
`providerManaged`	`boolean`	yes	Only the provider attaches its tags; provider groups evaluate only such categories.

TagObjectsRequest

Body of POST /v1/tags/{id}/attach and POST /v1/tags/{id}/detach.

Name	Type	Required	Description
`objectIds`	array of `string`	yes	Inventory object ids (at most 1000). Every object is checked before any change is made: one refusal leaves all objects as they were.

TagView

A tag: category name and value.

Name	Type	Required	Description
`category`	`string`	yes	Category name.
`value`	`string`	yes	Tag name.

TaggedObjectView

An object a tag is attached to.

Name	Type	Required	Description
`id`	`string`	yes	Object id.
`kind`	`string`	yes	Kind (`virtual_machine`, `host`, ...).
`name`	`string`	yes	Name.

TaskRef

Reference to a task created by a long-running operation.

Name	Type	Required	Description
`taskId`	`string`	yes	The task id to poll.

TaskResultView

Success payload of a completed task. Shape depends on the operation: power → PowerResultView; reconfigure → ReconfigureResultView; create/clone/AddHost/CreateSnapshot → CreatedObjectResultView; revert snapshot → SnapshotKeyResultView; remove snapshots → RemovedSnapshotsResultView; rename → RenameResultView; enter/exit maintenance → MaintenanceModeResultView; customize → CustomizeResultView; migrate/relocate → MigrateResultView. Destroy and similar operations leave result null.

One of: PowerResultView, ReconfigureResultView, CreatedObjectResultView, SnapshotKeyResultView, RemovedSnapshotsResultView, RenameResultView, MaintenanceModeResultView, CustomizeResultView, MigrateResultView

TaskStateView

Task state.

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

TaskView

A task.

Name	Type	Required	Description
`args`	`object`	yes	Message arguments.
`attempt`	`integer` (int32)	yes	Attempts so far.
`cancelRequested`	`boolean`	yes	Cancellation requested.
`chainId`	`string`	yes	Correlation id grouping tasks and events of one action.
`completedAt`	`string` or `null`		Completed at.
`descriptionId`	`string`	yes	Operation id in vSphere style (`VirtualMachine.powerOn`).
`error`	`ErrorBody` or `null`
`id`	`string`	yes	Task id (`task-N`).
`initiator`	`string`	yes	Submitting user.
`messageId`	`string`	yes	Localisable message key (`task.virtual_machine.power_on`).
`progress`	`integer` (int32)	yes	Progress 0..=100.
`queuedAt`	`string`	yes	Queued at.
`result`	`TaskResultView` or `null`
`retryable`	`boolean`	yes	Whether the failure is retryable.
`startedAt`	`string` or `null`		Started at.
`state`	`TaskStateView`	yes	State.
`targetId`	`string` or `null`		Target object id.
`targetName`	`string`	yes	Target name at submission.
`targetType`	`string` or `null`		Target short type.

TcpEvidence

Host-side TCP checks from the quarantine probe netns.

Name	Type	Required	Description
`address`	`string` or `null`		Address that was probed (the leased address).
`ports`	array of `TcpPortEvidence`		Per-port results (empty when no TCP check was requested).

TcpPortEvidence

One TCP port checked from the quarantine probe.

Name	Type	Required	Description
`elapsedMs`	`integer` (int64)	yes	Wall time of the attempt.
`error`	`string` or `null`		Short error when `ok` is false.
`ok`	`boolean`	yes	Whether the connect succeeded.
`port`	`integer` (int32)	yes	Port number.

TemplateBody

Body of PUT /v1/firewall/templates/{id} (a provider template).

Name	Type	Required	Description
`description`	`string`		What it opens.
`note`	`string` or `null`		What to know before applying it.
`rules`	array of `TemplateRuleBody`	yes	The rules (1 to 50).

TemplateRuleBody

One rule of a provider template: allow, direction in.

Name	Type	Required	Description
`from`	array of `string`		Sources allowed (addresses or prefixes; empty: any).
`ipVersion`	`IpVersionView`		IP families (default `any`).
`name`	`string`		Rule name (default: the template id).
`services`	array of `ServiceEntryView`	yes	Services: entries of the native form; `named` names a built-in or provider service.

TemplateView

A rule template (§6.6): rules added to the VM's own policy, direction in.

Name	Type	Required	Description
`builtin`	`boolean`		Built in (read-only); the provider's own templates are not.
`description`	`string`	yes	What it opens.
`id`	`string`	yes	`ssh-only`, `web`, `mail-server`.
`note`	`string` or `null`		What to know before applying it.
`rules`	array of `RuleBody`	yes	The rules it adds.
`version`	`integer` (int64) or `null`		Record version of a provider template (for `If-Match`).

TenantNetworkUsage

Network usage of one tenant in one period (for GET /v1/tenants/{t}/usage).

Name	Type	Required	Description
`addresses`	array of `ServerAddressUsage`	yes	Public addresses per server.
`traffic`	`TrafficReport`	yes	Traffic per server and the tenant total.

TenantTraffic

Traffic of one tenant in a period.

Name	Type	Required	Description
`billableBytes`	`integer` (int64)	yes	Billable bytes (sum of the VMs' billable bytes).
`inBytes`	`integer` (int64)	yes	Inbound bytes.
`name`	`string`	yes	Tenant name as last seen.
`outBytes`	`integer` (int64)	yes	Outbound bytes.
`tenant`	`string`	yes	Tenant id.
`vms`	`integer` (int32)	yes	VMs with traffic.

TenantUsageView

A tenant's usage in a month (docs/cloud/SELF_SERVICE.md §5).

Name	Type	Required	Description
`from`	`string`	yes	Start (inclusive, UTC).
`month`	`string`	yes	`YYYY-MM`.
`network`	`TenantNetworkUsage` or `null`
`planHours`	array of `PlanHoursView`	yes	Hours per plan over all servers.
`servers`	array of `ServerUsageView`	yes	Per server.
`snapshotGibHours`	`number` (double)	yes	Snapshot GiB-hours over all servers.
`tenant`	`string`	yes	Tenant.
`to`	`string`	yes	End (exclusive; now for the current month).

TenantView

A tenant.

Name	Type	Required	Description
`anchorDay`	`integer` (int32) or `null`		Day of the month the traffic period starts.
`closedAt`	`string` or `null`		Closed at.
`createdAt`	`string`	yes	Created.
`destroyAfter`	`string` or `null`		When a closed tenant's VMs are destroyed.
`destroyed`	`boolean`	yes	Whether that has happened.
`displayName`	`string`	yes	Display name.
`externalRef`	`string`	yes	The portal's account id.
`folders`	array of `string`	yes	VM folders (`group-vN`), one per datacenter.
`id`	`string`	yes	`tenant-N`.
`labels`	`object`	yes	Labels.
`name`	`string`	yes	Short name.
`pools`	array of `string`	yes	Resource pools, one per cluster.
`quota`	`QuotaView`	yes	Limits.
`state`	`string`	yes	`active`, `suspended` or `closed`.
`suspendedAt`	`string` or `null`		Suspended at.
`used`	`QuotaAmounts`	yes	Current use.

ToolsStatus

Guest agent tools state.

Values: "not_installed", "not_running", "running"

TotpCodeRequest

A TOTP code.

Name	Type	Required	Description
`code`	`string`	yes	Six-digit code.

TotpEnrolResponse

POST /v1/auth/totp/enrol response.

Name	Type	Required	Description
`algorithm`	`string`	yes	Algorithm (`SHA1`), digits (6) and period (30 s), for display.
`digits`	`integer` (int32)	yes	Digits.
`otpauthUri`	`string`	yes	`otpauth://totp/Kyvernon:<user>?secret=...&issuer=Kyvernon...` for the QR code.
`period`	`integer` (int32)	yes	Period in seconds.
`secret`	`string`	yes	Base32 seed for manual entry; shown once.

TrafficAction

What happens at 100 % of the limit.

Values: "notify", "throttle"

TrafficDay

One day of a VM's traffic (graph).

Name	Type	Required	Description
`day`	`string`	yes	The day (`YYYY-MM-DD`).
`inBytes`	`integer` (int64)	yes	Inbound bytes.
`outBytes`	`integer` (int64)	yes	Outbound bytes.

TrafficPackage

An extra traffic package for one period.

Name	Type	Required	Description
`addedAt`	`string`	yes	When it was added.
`bytes`	`integer` (int64)	yes	Bytes added to the period's limit.
`periodStart`	`string`	yes	First day of the period it applies to (`YYYY-MM-DD`).
`reference`	`string` or `null`		The caller's reference (order item).

TrafficPolicy

Traffic limit and state of one VM (record name: the VM id).

Mapping to plans: monthly_limit_bytes is the plan's traffic per month, action the plan's action at 100 %, throttle_kbps the plan's (or the site's default) throttle rate. Server create and resize set them from the vm_plan; until plans exist an operator or the portal sets them through PUT /v1/vms/{id}/traffic-policy.

Name	Type	Required	Description
`action`	`TrafficAction`		Action at 100 %.
`anchorDay`	`integer` (int32) or `null`		Anchor day of the period (1 to 28); `None`: the tenant's or the 1st.
`monthlyLimitBytes`	`integer` (int64) or `null`		Bytes per period; `None`: no limit (accounting only).
`name`	`string`	yes	Record name: the VM id (one policy per VM, enforced by the store's unique names).
`packages`	array of `TrafficPackage`		Extra packages.
`smtpUnblocked`	`boolean`		Outgoing SMTP (TCP 25) is allowed for this VM although its pools block it (`PUT /v1/vms/{id}/smtp`; the record is the VM's network policy).
`state`	`TrafficState`		Enforcement state.
`tenant`	`string` or `null`		Tenant (for the events).
`throttleKbps`	`integer` (int64) or `null`		Throttle rate in kbit/s; `None`: the site default.
`vm`	`string`	yes	The VM.

TrafficReport

A traffic report for one period.

Name	Type	Required	Description
`billable`	`Billable`	yes	Billed direction.
`periodEnd`	`string`	yes	Last day of the period (inclusive).
`periodStart`	`string`	yes	First day of the period (`YYYY-MM-DD`).
`tenants`	array of `TenantTraffic`	yes	Per tenant.
`vms`	array of `VmTraffic`	yes	Per VM.

TrafficState

Enforcement state of the current period.

Name	Type	Description
`limitBytes`	`integer` (int64) or `null`	The limit in force at the last check (plan plus packages).
`notified`	array of `integer` (int32)	Thresholds already notified in the period.
`periodStart`	`string` or `null`	First day of the period the state is about.
`throttled`	`boolean`	The VM is throttled.
`usedBytes`	`integer` (int64)	Billable bytes at the last check.