API reference
This page lists the packages of the Kibotos API that applications call: kibotos.ctrl.v1 for Workspaces and their data, kibotos.operator.v1 for operating the deployment, and kibotos.enrollment.v1 for obtaining an identity. Each service has a page, generated from the proto file and the comments in it, that lists its methods together with the request and response of each.
Every method is a Connect RPC at the path shown in its section, called on the endpoint its service names. The node data plane also serves two HTTP endpoints, listed at the end. For how to authenticate and call them, see API overview.
| Package | Services | Messages and enums several services use |
|---|---|---|
kibotos.ctrl.v1 | 15 | kibotos.ctrl.v1 types |
kibotos.operator.v1 | 7 | kibotos.operator.v1 types |
kibotos.enrollment.v1 | 1 | — |
kibotos.ctrl.v1
| Service | Endpoint | Description |
|---|---|---|
ServerInfoService | ctrl API | ServerInfoService exposes the source revision this endpoint was built from and the capabilities it serves, so a client can check them before it starts a business operation. |
TemplateService | ctrl API | TemplateService exposes the deployment catalog without revealing private delivery or materialization details. |
WorkspaceService | ctrl API | WorkspaceService owns the Native Workspace lifecycle and stable identity. |
VolumeService | ctrl API | VolumeService owns the Native logical Volume lifecycle. |
ExposureService | ctrl API | ExposureService turns one HTTP port inside a guest into a stable public hostname. |
EgressService | ctrl API | EgressService owns caller-owned egress endpoints. |
ResolverService | ctrl API | ResolverService owns caller-chosen DNS upstreams. |
TransferService | ctrl API | TransferService owns Workspace transfer intent and provider-neutral artifact metadata. |
WorkspaceObservationService | ctrl API | WorkspaceObservationService reports deletion cleanup without exposing execution or host implementation identities. |
WorkspaceMetricsService | ctrl API | WorkspaceMetricsService reads a Workspace's resource readings back from the deployment's metrics store. |
DataPlaneSessionService | ctrl API | DataPlaneSessionService issues short-lived credentials for one available workspace. |
ServiceConnectionService | Node data plane | ServiceConnectionService transports raw bytes to one precisely authorized guest service. |
FilesystemService | Node data plane | FilesystemService performs metadata operations on the Workspace filesystem: stat, listing, directory creation, move, removal, and directory watching. |
ProcessService | Node data plane | ProcessService owns reconnectable pipe and PTY processes. |
DesktopService | Node data plane | DesktopService captures the Workspace desktop and delivers pointer and keyboard input to it. |
kibotos.operator.v1
| Service | Endpoint | Description |
|---|---|---|
ArtifactPublicationService | ctrl API | ArtifactPublicationService is an Operator-only, single-kind artifact publication API. |
TemplateLifecycleService | ctrl API | TemplateLifecycleService is an Operator-only admission surface. |
TemplateCatalogService | ctrl API | TemplateCatalogService is the Operator-only Template catalog admission surface: it answers which revisions a Template may be created from and which one it defaults to, and it carries the three named catalog changes. |
NodeRegistrationService | ctrl API | NodeRegistrationService is the Operator-only view and desired-state surface for nodes admitted to this control plane. |
PlatformCatalogService | ctrl API | PlatformCatalogService is the Operator-only Platform catalog surface: it answers what has been registered, which revision each PlatformKey currently defaults to, and it carries the three named catalog changes. |
ArtifactRetentionService | ctrl API | ArtifactRetentionService is the Operator-only reclamation surface for the artifact store. |
EnrollmentGrantService | ctrl API | EnrollmentGrantService lets an authenticated Operator create one-time enrollment grants for other Operators or for exact node IDs, and revoke a principal. |
kibotos.enrollment.v1
| Service | Endpoint | Description |
|---|---|---|
EnrollmentService | Operator API and node API | EnrollmentService is mounted on both the Operator API and the node API. |
HTTP endpoints
Besides its Connect services, the node data plane serves these endpoints at the endpoint of a data-plane session.
| Endpoint | Description |
|---|---|
/v1/files | Reads and writes the content of one file in the guest. |
/v1/service | Connects to one TCP loopback port or Unix stream socket in the guest over a WebSocket. |
kibo version
Show client and server version information. This page lists the usage, examples, and flags of kibo version, generated from the kibo source code.
ServerInfoService
This page lists the methods of ServerInfoService in kibotos.ctrl.v1 with the messages and enums each one uses, generated from ctrl.proto and its comments. Those that several services use are on kibotos.ctrl.v1 types.