API

Table of Contents

• billing.proto

  • BillingSubscriptionProto

  • CancelSubscriptionRequest

  • CancelSubscriptionResponse

  • CreateCheckoutSessionRequest

  • CreateCheckoutSessionResponse

  • GetSubscriptionRequest

  • GetSubscriptionResponse

  • ListSubscriptionsRequest

  • ListSubscriptionsResponse

  • BillingService

• compute.proto

  • CloneInstanceRequest

  • CreateInstanceRequest

  • CreateInstanceResponse

  • CreateZoneRequest

  • CreateZoneResponse

  • DeleteInstanceRequest

  • DeleteInstanceResponse

  • DetachHypervisorRequest

  • DetachHypervisorResponse

  • Hypervisor

  • Instance

  • InstanceConfig

  • ListHypervisorsRequest

  • ListHypervisorsResponse

  • ListInstancesRequest

  • ListInstancesResponse

  • ListZonesRequest

  • ListZonesResponse

  • RegisterHypervisorRequest

  • RegisterHypervisorResponse

  • StartInstanceRequest

  • StartInstanceResponse

  • StopInstanceRequest

  • StopInstanceResponse

  • UpdateInstanceRequest

  • UpdateInstanceResponse

  • Zone

  • InstanceStatus

  • Hypervisors

  • Instances

  • Zones

• iam.proto

  • AnswerInvitationRequest

  • AnswerInvitationResponse

  • CreateInvitationRequest

  • CreateInvitationResponse

  • GetCurrentUserRequest

  • GetCurrentUserResponse

  • Invitation

  • ListInvitationsRequest

  • ListInvitationsResponse

  • InvitationState

  • Invitations

  • Profile

• kubernetes.proto

  • AttachClusterLabelRequest

  • AttachClusterLabelResponse

  • CreateClusterRequest

  • CreateClusterResponse

  • CreateLabelRequest

  • CreateLabelResponse

  • DeleteClusterRequest

  • DeleteClusterResponse

  • DeleteLabelRequest

  • DeleteLabelResponse

  • DetachClusterLabelRequest

  • DetachClusterLabelResponse

  • GetClusterRequest

  • GetClusterResponse

  • KubernetesClusterProto

  • KubernetesLabelProto

  • ListClustersRequest

  • ListClustersResponse

  • ListLabelsRequest

  • ListLabelsResponse

  • ListServicesReferencingLabelRequest

  • ListServicesReferencingLabelResponse

  • ManagedServiceRefProto

  • UpdateClusterRequest

  • UpdateClusterResponse

  • KubernetesClusters

• managed.proto

  • ConnectionInfoField

  • CreateInstanceRequest

  • CreateInstanceResponse

  • DeleteInstanceRequest

  • DeleteInstanceResponse

  • GetInstanceConnectionInfoRequest

  • GetInstanceConnectionInfoResponse

  • GetInstanceRequest

  • GetInstanceResponse

  • GetServiceRequest

  • GetServiceResponse

  • ListInstancesRequest

  • ListInstancesResponse

  • ListPlansRequest

  • ListPlansResponse

  • ListServicesRequest

  • ListServicesResponse

  • ListVersionsRequest

  • ListVersionsResponse

  • ManagedServiceInstanceProto

  • ManagedServicePlanEntitlementProto

  • ManagedServicePlanProto

  • ManagedServiceProto

  • ManagedServiceVersionProto

  • RegisterVersionRequest

  • RegisterVersionResponse

  • SyncPlanEntry

  • SyncPlansRequest

  • SyncPlansResponse

  • UpgradeInstanceRequest

  • UpgradeInstanceResponse

  • ManagedServices

• resourcemanager.proto

  • CreateOrganizationRequest

  • CreateOrganizationResponse

  • CreateProjectRequest

  • CreateProjectResponse

  • ListOrganizationsRequest

  • ListOrganizationsResponse

  • ListProjectsRequest

  • ListProjectsResponse

  • Organization

  • Project

  • Organizations

  • Projects

• workflow.proto

  • GetStatusRequest

  • GetStatusResponse

  • Initiator

  • NextRequest

  • NextResponse

  • ScheduleRequest

  • ScheduleResponse

  • UnlockRequest

  • UnlockResponse

  • WorkflowExecution

  • ExecutionStatus

  • WorkflowEngine

• infrastructure.proto

  • Datacenter

  • ListDatacentersRequest

  • ListDatacentersResponse

  • ListZeroTrustNetworkTypesRequest

  • ListZeroTrustNetworkTypesResponse

  • ListZeroTrustNetworksRequest

  • ListZeroTrustNetworksResponse

  • ZeroTrustNetwork

  • ZeroTrustNetworkType

  • Datacenters

  • ZeroTrustNetworkTypes

  • ZeroTrustNetworks

• Scalar Value Types

billing.proto

BillingSubscriptionProto

Field	Type	Label	Description
id	string
customer_id	string
stripe_subscription_id	string	optional
plan_id	string
instance_id	string	optional
status	string
billing_period	string
current_period_start	google.protobuf.Timestamp	optional
current_period_end	google.protobuf.Timestamp	optional
canceled_at	google.protobuf.Timestamp	optional
created_at	google.protobuf.Timestamp

CancelSubscriptionRequest

CancelSubscription

Field	Type	Label	Description
subscription_id	string

CancelSubscriptionResponse

CreateCheckoutSessionRequest

CreateCheckoutSession

Field	Type	Label	Description
project_slug	string
organization_slug	string
service_slug	string
version_id	string
plan_id	string
billing_period	string		"monthly" or "yearly"
user_values	string	optional
secret_values	string	optional

CreateCheckoutSessionResponse

Field	Type	Label	Description
subscription_id	string
checkout_url	string

GetSubscriptionRequest

GetSubscription

Field	Type	Label	Description
subscription_id	string

GetSubscriptionResponse

Field	Type	Label	Description
subscription	BillingSubscriptionProto

ListSubscriptionsRequest

ListSubscriptions

Field	Type	Label	Description
organization_slug	string

ListSubscriptionsResponse

Field	Type	Label	Description
subscriptions	BillingSubscriptionProto	repeated

BillingService

Billing and subscription management for managed services. Handles Stripe checkout sessions, subscription lifecycle, and payment status.

Method Name	Request Type	Response Type	Description
CreateCheckoutSession	CreateCheckoutSessionRequest	CreateCheckoutSessionResponse	Creates a Stripe Checkout Session for subscribing to a managed service plan.
GetSubscription	GetSubscriptionRequest	GetSubscriptionResponse	Returns a single subscription by ID.
ListSubscriptions	ListSubscriptionsRequest	ListSubscriptionsResponse	Lists all subscriptions for an organization.
CancelSubscription	CancelSubscriptionRequest	CancelSubscriptionResponse	Cancels an active subscription.

compute.proto

CloneInstanceRequest

CloneInstanceRequest defines the parameters needed to clone an existing instance.

Field	Type	Label	Description
id	string		The id of the instance to clone.
name	string	optional	Optional name for the cloned instance. If not provided, the clone inherits the name of the source instance.

CreateInstanceRequest

CreateInstanceRequest defines the parameters needed to provision a new instance.

Field	Type	Label	Description
image	string		Base image identifier to use for the instance
cpu_cores	uint32		Number of CPU cores to allocate to the instance
disk_bytes	uint64		Amount of disk in bytes to allocate to the instance
memory_bytes	uint64		Amount of memory in bytes to allocate to the instance
name	string		User-defined name for the instance
snippet	string		The snippet to use to bootstrap the instance
project_slug	string		The slug of the project the instance belongs to

CreateInstanceResponse

CreateInstanceResponse contains the result of a create instance operation.

Field	Type	Label	Description
instance	Instance		The created instance.

CreateZoneRequest

CreateZoneRequest contains the new zone information.

Field	Type	Label	Description
name	string		User-defined name for the instance

CreateZoneResponse

CreateZoneResponse contains the created zone information.

Field	Type	Label	Description
zone	Zone		The created zone.

DeleteInstanceRequest

DeleteInstanceRequest defines the parameters needed to delete an existing instance.

Field	Type	Label	Description
id	string		The id of the instance to clone.

DeleteInstanceResponse

DeleteInstanceResponse contains the result of a DeleteInstance operation.

DetachHypervisorRequest

DetachHypervisorRequest contains the necessary information to detach a hypervisor.

Field	Type	Label	Description
id	string		Id of the hypervisor

DetachHypervisorResponse

DetachHypervisorResponse contains the result of a DetachHypervisor operation.

Hypervisor

Hypervisor represents a virtualization platform that can host instances.

Field	Type	Label	Description
id	string		Id of the hypervisor
storage_name	string		Name of the storage to use for instances
url	string		URL endpoint of the hypervisor API
zone_id	string		Id of the zone the hypervisor belongs to
organization_slug	string		Slug of the organization the hypervisor belongs to

Instance

Instance contains detailed information about a virtual machine instance.

Field	Type	Label	Description
id	string		Unique identifier for the instance
status	InstanceStatus		Current operational status of the instance
max_cpu_cores	uint32		Maximum CPU cores available to the instance (max 99)
cpu_usage_percent	float		Current CPU utilization as a percentage (0.0-100.0)
max_memory_bytes	uint64		Maximum memory available to the instance (in bytes, max 64GB)
memory_usage_bytes	uint64		Current memory utilization (in bytes, cannot exceed max_memory_bytes)
max_disk_bytes	uint64		Maximum disk available to the instance (in bytes, max 64GB)
disk_usage_bytes	uint64		Current disk utilization (in bytes, cannot exceed max_disk_bytes)
name	string		Human-readable name, defined on the instance
ip_v4	string		The IP v4 address of the instance
hypervisor_id	string		Unique identifier for the instance hypervisor
project_slug	string		Slug of the project this instance belongs to
zero_trust_network_id	string	optional	Unique identifier for the instance zero trust network
created_at	google.protobuf.Timestamp		Creation time of the instance
updated_at	google.protobuf.Timestamp		Time of the instance last change

InstanceConfig

InstanceConfig contains basic configuration information for a virtual machine instance.

Field	Type	Label	Description
id	string		Unique identifier for the instance configuration
name	string		Display name of the instance configuration

ListHypervisorsRequest

ListHypervisorsRequest is an empty message for listing hypervisors.

ListHypervisorsResponse

ListHypervisorsResponse contains a collection of hypervisor information.

Field	Type	Label	Description
hypervisors	Hypervisor	repeated	List of hypervisor details

ListInstancesRequest

ListInstancesRequest is an empty message for listing instances.

ListInstancesResponse

ListInstancesResponse contains a collection of instance information.

Field	Type	Label	Description
instances	Instance	repeated	List of instance details

ListZonesRequest

ListZonesRequest is an empty message for listing zones.

ListZonesResponse

ListZonesResponse contains a collection of zone information.

Field	Type	Label	Description
zones	Zone	repeated	List of zone details

RegisterHypervisorRequest

RegisterHypervisorRequest contains the necessary information to register a hypervisor.

Field	Type	Label	Description
authorization_token	string		Authorization token for secure API access
storage_name	string		Name of the storage to use for instances
url	string		URL endpoint of the hypervisor API
zone_id	string		Id of the zone this hypervisor belongs to
organization_slug	string		Slug of the organization this hypervisor belongs to

RegisterHypervisorResponse

RegisterHypervisorResponse contains the result of a register hypervisor operation.

Field	Type	Label	Description
hypervisor	Hypervisor		The registered hypervisor.

StartInstanceRequest

StartInstanceRequest identifies which instance to start.

Field	Type	Label	Description
id	string		Unique identifier of the instance to start

StartInstanceResponse

StartInstanceResponse contains the result of a start instance operation.

StopInstanceRequest

StopInstanceRequest identifies which instance to stop.

Field	Type	Label	Description
id	string		Unique identifier of the instance to stop

StopInstanceResponse

StopInstanceResponse contains the result of a stop instance operation.

UpdateInstanceRequest

UpdateInstanceRequest defines the parameters to update an existing instance.

Field	Type	Label	Description
id	string		Unique identifier of the instance to update
name	string	optional	Optional new name for the instance
project_slug	string	optional	Optional new project slug to move the instance to

UpdateInstanceResponse

UpdateInstanceResponse contains the result of an update instance operation.

Field	Type	Label	Description
instance	Instance		The updated instance.

Zone

Zone represents a zone.

Field	Type	Label	Description
id	string		Id of the zone
name	string		Name of the zone.

InstanceStatus

InstanceStatus represents the possible states of a virtual machine instance.

Name	Number	Description
UNDEFINED_INSTANCE_STATUS	0	Instance status is undefined
RUNNING	1	Instance is active and operational
STOPPED	2	Instance is inactive
STOPPING	3	Instance is in the process of stopping
PROVISIONING	4	Instance is in the process of starting/provisioning
STAGING	5	Instance is in the staging phase before running
SUSPENDED	6	Instance is suspended (memory state preserved)
SUSPENDING	7	Instance is in the process of suspending
TERMINATED	8	Instance is permanently terminated
DEPROVISIONING	9	Instance is in the process of being deprovisioned
REPAIRING	10	Instance is being repaired

Hypervisors

Hypervisors service provides operations to manage hypervisors.

Method Name	Request Type	Response Type	Description
List	ListHypervisorsRequest	ListHypervisorsResponse	List retrieves information about all registered hypervisors.
Register	RegisterHypervisorRequest	RegisterHypervisorResponse	Register adds a new hypervisor to the system.
Detach	DetachHypervisorRequest	DetachHypervisorResponse	Detach removes a hypervisor from the system.

Instances

Instances service provides operations to manage instances.

Method Name	Request Type	Response Type	Description
List	ListInstancesRequest	ListInstancesResponse	ListInstances retrieves information about all available instances.
Clone	CloneInstanceRequest	Instance	CloneInstance provisions a new instance based on a given existing instance.
Create	CreateInstanceRequest	CreateInstanceResponse	CreateInstance provisions a new instance based on the specified configuration.
Delete	DeleteInstanceRequest	DeleteInstanceResponse	DeleteInstance deletes a given instance.
Start	StartInstanceRequest	StartInstanceResponse	StartInstance initiates a specific instance identified by its unique ID.
Stop	StopInstanceRequest	StopInstanceResponse	StopInstance halts a specific instance identified by its unique ID.
Update	UpdateInstanceRequest	UpdateInstanceResponse	Update modifies an existing instance's properties.

Zones

Hypervisors service provides operations to manage zones.

Method Name	Request Type	Response Type	Description
List	ListZonesRequest	ListZonesResponse	List retrieves information about all registered zones.
Create	CreateZoneRequest	CreateZoneResponse	Create adds a new zone.

iam.proto

AnswerInvitationRequest

Field	Type	Label	Description
invitation_id	string
accept	bool

AnswerInvitationResponse

Field	Type	Label	Description
invitation	Invitation

CreateInvitationRequest

Field	Type	Label	Description
organization_slug	string
email	string

CreateInvitationResponse

Field	Type	Label	Description
invitation	Invitation

GetCurrentUserRequest

GetCurrentUserResponse

Field	Type	Label	Description
id	string
email	string
is_admin	bool

Invitation

Field	Type	Label	Description
id	string
organization_slug	string
user_id	string
state	InvitationState
created_at	google.protobuf.Timestamp
answered_at	google.protobuf.Timestamp

ListInvitationsRequest

ListInvitationsResponse

Field	Type	Label	Description
invitations	Invitation	repeated

InvitationState

Name	Number	Description
INVITATION_STATE_UNSPECIFIED	0
PENDING	1
ACCEPTED	2
DECLINED	3
EXPIRED	4

Invitations

Method Name	Request Type	Response Type	Description
List	ListInvitationsRequest	ListInvitationsResponse
Create	CreateInvitationRequest	CreateInvitationResponse
Answer	AnswerInvitationRequest	AnswerInvitationResponse

Profile

Exposes the authenticated caller's own identity. GetCurrentUser is the single authoritative source for the frontend's platform-admin status: it reflects the control plane database (users.is_admin) rather than an OIDC token claim.

Method Name	Request Type	Response Type	Description
GetCurrentUser	GetCurrentUserRequest	GetCurrentUserResponse

kubernetes.proto

AttachClusterLabelRequest

AttachClusterLabel

Field	Type	Label	Description
cluster_id	string
label_id	string

AttachClusterLabelResponse

CreateClusterRequest

CreateCluster

Field	Type	Label	Description
name	string
description	string	optional
kubeconfig	string		Full kubeconfig YAML granting access to the cluster API server.
label_ids	string	repeated	IDs of existing user-managed labels to attach to the cluster at creation. Validated before the reachability check: an unknown or system label rejects the whole request and no cluster is created.

CreateClusterResponse

Field	Type	Label	Description
cluster	KubernetesClusterProto

CreateLabelRequest

CreateLabel

Field	Type	Label	Description
key	string		Max 49 chars, charset [a-zA-Z0-9-], case-insensitive.
value	string		Max 49 chars, charset [a-zA-Z0-9-], case-insensitive.

CreateLabelResponse

Field	Type	Label	Description
label	KubernetesLabelProto

DeleteClusterRequest

DeleteCluster

Field	Type	Label	Description
cluster_id	string

DeleteClusterResponse

DeleteLabelRequest

DeleteLabel

Field	Type	Label	Description
label_id	string

DeleteLabelResponse

DetachClusterLabelRequest

DetachClusterLabel

Field	Type	Label	Description
cluster_id	string
label_id	string

DetachClusterLabelResponse

GetClusterRequest

GetCluster

Field	Type	Label	Description
cluster_id	string

GetClusterResponse

Field	Type	Label	Description
cluster	KubernetesClusterProto

KubernetesClusterProto

Non-sensitive view of a cluster. Never exposes the kubeconfig or any encrypted material.

Field	Type	Label	Description
id	string
name	string
description	string	optional
api_server_url	string
ca_fingerprint	string	optional
kubernetes_version	string	optional	Kubernetes semver version reported by GET /version (e.g. "v1.32.2").
platform	string	optional	OS/arch pair reported by the API server (e.g. "linux/amd64").
health_status	string
last_health_check_at	google.protobuf.Timestamp
created_at	google.protobuf.Timestamp
updated_at	google.protobuf.Timestamp
labels	KubernetesLabelProto	repeated	Labels attached to the cluster, ordered by key then value.

KubernetesLabelProto

A cluster label: a reusable key/value pair (e.g. availability=ft) attached to clusters and matched against managed-service deploy targets. Labels with system = true are owned by the control plane and read-only via the API.

Field	Type	Label	Description
id	string
key	string
value	string
system	bool
created_at	google.protobuf.Timestamp
updated_at	google.protobuf.Timestamp

ListClustersRequest

ListClusters

ListClustersResponse

Field	Type	Label	Description
clusters	KubernetesClusterProto	repeated

ListLabelsRequest

ListLabels

ListLabelsResponse

Field	Type	Label	Description
labels	KubernetesLabelProto	repeated

ListServicesReferencingLabelRequest

ListServicesReferencingLabel

Field	Type	Label	Description
label_id	string

ListServicesReferencingLabelResponse

Field	Type	Label	Description
services	ManagedServiceRefProto	repeated	Active services whose deploy_target requires the label, ordered by name.

ManagedServiceRefProto

Minimal reference to a managed service impacted by a label removal.

Field	Type	Label	Description
id	string
slug	string
name	string

UpdateClusterRequest

UpdateCluster

Field	Type	Label	Description
cluster_id	string
name	string
description	string	optional
kubeconfig	string	optional	When set, replaces the stored kubeconfig and triggers a reachability check.

UpdateClusterResponse

Field	Type	Label	Description
cluster	KubernetesClusterProto

KubernetesClusters

Platform-admin registry of Kubernetes clusters.

All RPCs are restricted to platform administrators. Each cluster carries an encrypted-at-rest kubeconfig; before a cluster is created or its kubeconfig changed, the control plane performs a synchronous reachability check against the cluster API server. The kubeconfig and its ciphertext are never returned.

Method Name	Request Type	Response Type	Description
ListClusters	ListClustersRequest	ListClustersResponse	Lists every registered cluster (admin only).
GetCluster	GetClusterRequest	GetClusterResponse	Returns a single cluster by id (admin only).
CreateCluster	CreateClusterRequest	CreateClusterResponse	Registers a cluster after verifying it is reachable (admin only).
UpdateCluster	UpdateClusterRequest	UpdateClusterResponse	Updates a cluster, re-checking reachability when a new kubeconfig is sent (admin only).
DeleteCluster	DeleteClusterRequest	DeleteClusterResponse	Deletes a cluster (admin only).
ListLabels	ListLabelsRequest	ListLabelsResponse	Lists every cluster label (admin only).
CreateLabel	CreateLabelRequest	CreateLabelResponse	Creates a user-managed label (admin only). Labels flagged system are owned by the control plane and cannot be created through the API.
DeleteLabel	DeleteLabelRequest	DeleteLabelResponse	Deletes a user-managed label and its attachments (admin only).
AttachClusterLabel	AttachClusterLabelRequest	AttachClusterLabelResponse	Attaches a user-managed label to a cluster (admin only, idempotent).
DetachClusterLabel	DetachClusterLabelRequest	DetachClusterLabelResponse	Detaches a user-managed label from a cluster (admin only, idempotent).
ListServicesReferencingLabel	ListServicesReferencingLabelRequest	ListServicesReferencingLabelResponse	Lists the active managed services whose deploy_target references the label's key/value pair (admin only). Detaching or deleting such a label is allowed but may leave those services without an eligible cluster for future deployments; callers surface this list to the operator before confirming the removal.

managed.proto

ConnectionInfoField

A single field in the connection info response.

Field	Type	Label	Description
key	string
label	string
value	string
display	string		Display hint: "text", "password", or "copy".
order	int32

CreateInstanceRequest

CreateInstance

Field	Type	Label	Description
project_slug	string
organization_slug	string
service_slug	string
version_id	string
user_values	string	optional	JSON object of user-provided values (non-secret)
secret_values	string	optional	JSON object of secret values (passwords, keys)
plan_id	string		Plan ID (required for new instances)

CreateInstanceResponse

Field	Type	Label	Description
instance	ManagedServiceInstanceProto

DeleteInstanceRequest

DeleteInstance

Field	Type	Label	Description
instance_id	string

DeleteInstanceResponse

GetInstanceConnectionInfoRequest

GetInstanceConnectionInfo

Field	Type	Label	Description
instance_id	string

GetInstanceConnectionInfoResponse

Field	Type	Label	Description
fields	ConnectionInfoField	repeated

GetInstanceRequest

GetInstance

Field	Type	Label	Description
instance_id	string

GetInstanceResponse

Field	Type	Label	Description
instance	ManagedServiceInstanceProto

GetServiceRequest

GetService

Field	Type	Label	Description
slug	string

GetServiceResponse

Field	Type	Label	Description
service	ManagedServiceProto

ListInstancesRequest

ListInstances

Field	Type	Label	Description
project_slug	string

ListInstancesResponse

Field	Type	Label	Description
instances	ManagedServiceInstanceProto	repeated

ListPlansRequest

ListPlans

Field	Type	Label	Description
service_slug	string

ListPlansResponse

Field	Type	Label	Description
plans	ManagedServicePlanProto	repeated

ListServicesRequest

ListServices

ListServicesResponse

Field	Type	Label	Description
services	ManagedServiceProto	repeated

ListVersionsRequest

ListVersions

Field	Type	Label	Description
service_slug	string

ListVersionsResponse

Field	Type	Label	Description
versions	ManagedServiceVersionProto	repeated

ManagedServiceInstanceProto

Instance messages

Field	Type	Label	Description
id	string
service_id	string
version_id	string
project_slug	string
organization_slug	string
namespace	string
release_name	string
user_values	string	optional
status	string
created_at	google.protobuf.Timestamp
plan_id	string	optional

ManagedServicePlanEntitlementProto

Plan entitlement (SLA guarantee displayed on the pricing page).

Field	Type	Label	Description
key	string
label	string
value	string

ManagedServicePlanProto

A pricing tier for a managed service.

Field	Type	Label	Description
id	string
service_id	string
slug	string
name	string
description	string	optional
status	string
highlighted	bool
values_override	string	optional
entitlements	ManagedServicePlanEntitlementProto	repeated
price_monthly_cents	int64	optional
price_yearly_cents	int64	optional
created_at	google.protobuf.Timestamp
stripe_price_id_monthly	string	optional
stripe_price_id_yearly	string	optional
requires_payment	bool

ManagedServiceProto

Field	Type	Label	Description
id	string
slug	string
name	string
description	string	optional
category	string
database_engine	string	optional
icon_url	string	optional
created_at	google.protobuf.Timestamp

ManagedServiceVersionProto

Field	Type	Label	Description
id	string
service_id	string
chart_version	string
app_version	string	optional
oci_reference	string
configurable_values_schema	string	optional
created_at	google.protobuf.Timestamp
ui_schema	string	optional	rjsf UI Schema, published alongside the JSON Schema by the chart CI. Used by the console to render the deployment form. Nullable.
connection_info_schema	string	optional	JSON schema describing how to fetch and display connection info for deployed instances. Defines K8s secret refs and field display metadata.

RegisterVersionRequest

RegisterVersion

Field	Type	Label	Description
service_slug	string
chart_version	string
app_version	string	optional
oci_reference	string
configurable_values_schema	string	optional	JSON Schema of configurable values (validation)
ui_schema	string	optional	rjsf UI Schema (form rendering hints: titles, widgets, order, sections)
connection_info_schema	string	optional	Connection info schema (K8s secret refs + display metadata)

RegisterVersionResponse

Field	Type	Label	Description
version	ManagedServiceVersionProto

SyncPlanEntry

Field	Type	Label	Description
slug	string
name	string
description	string	optional
status	string
highlighted	bool
values_override	string	optional
entitlements	ManagedServicePlanEntitlementProto	repeated
price_monthly_cents	int64	optional
price_yearly_cents	int64	optional
stripe_price_id_monthly	string	optional
stripe_price_id_yearly	string	optional
requires_payment	bool	optional

SyncPlansRequest

SyncPlans

Field	Type	Label	Description
service_slug	string
plans	SyncPlanEntry	repeated

SyncPlansResponse

Field	Type	Label	Description
plans	ManagedServicePlanProto	repeated

UpgradeInstanceRequest

UpgradeInstance

Field	Type	Label	Description
instance_id	string
version_id	string
user_values	string	optional
secret_values	string	optional

UpgradeInstanceResponse

Field	Type	Label	Description
instance	ManagedServiceInstanceProto

ManagedServices

Managed services catalog and version registration. Catalog RPCs are public; RegisterVersion is authenticated via CI service token.

Method Name	Request Type	Response Type	Description
ListServices	ListServicesRequest	ListServicesResponse	Lists all active managed services in the catalog.
GetService	GetServiceRequest	GetServiceResponse	Returns a single managed service by slug.
ListVersions	ListVersionsRequest	ListVersionsResponse	Lists all active versions for a given service.
ListPlans	ListPlansRequest	ListPlansResponse	Lists active plans for a given service.
RegisterVersion	RegisterVersionRequest	RegisterVersionResponse	Registers a new chart version for a service (called by CI after OCI publish).
SyncPlans	SyncPlansRequest	SyncPlansResponse	Syncs (upserts) all plans for a service from the catalogue.yaml (called by CI).
CreateInstance	CreateInstanceRequest	CreateInstanceResponse	Creates a managed service instance and schedules deployment.
ListInstances	ListInstancesRequest	ListInstancesResponse	Lists instances for a given project.
GetInstance	GetInstanceRequest	GetInstanceResponse	Returns a single instance by ID.
UpgradeInstance	UpgradeInstanceRequest	UpgradeInstanceResponse	Upgrades an instance to a new chart version.
DeleteInstance	DeleteInstanceRequest	DeleteInstanceResponse	Deletes an instance and schedules teardown.
GetInstanceConnectionInfo	GetInstanceConnectionInfoRequest	GetInstanceConnectionInfoResponse	Returns connection info (credentials, host, port) for a running instance. Reads K8s secrets live from the hosting cluster using the version's connection_info_schema.

resourcemanager.proto

CreateOrganizationRequest

Field	Type	Label	Description
name	string
parent_slug	string	optional

CreateOrganizationResponse

Field	Type	Label	Description
organization	Organization

CreateProjectRequest

Field	Type	Label	Description
name	string
organization_slug	string

CreateProjectResponse

Field	Type	Label	Description
project	Project

ListOrganizationsRequest

ListOrganizationsResponse

Field	Type	Label	Description
organizations	Organization	repeated

ListProjectsRequest

ListProjectsResponse

Field	Type	Label	Description
projects	Project	repeated

Organization

Field	Type	Label	Description
slug	string
name	string
created_at	google.protobuf.Timestamp
updated_at	google.protobuf.Timestamp

Project

Field	Type	Label	Description
slug	string
name	string
organization_slug	string
created_at	google.protobuf.Timestamp
updated_at	google.protobuf.Timestamp

Organizations

Method Name	Request Type	Response Type	Description
List	ListOrganizationsRequest	ListOrganizationsResponse
Create	CreateOrganizationRequest	CreateOrganizationResponse

Projects

Method Name	Request Type	Response Type	Description
List	ListProjectsRequest	ListProjectsResponse
Create	CreateProjectRequest	CreateProjectResponse

workflow.proto

GetStatusRequest

Field	Type	Label	Description
execution_id	string

GetStatusResponse

Field	Type	Label	Description
status	ExecutionStatus
next_retry_at	google.protobuf.Timestamp

Initiator

Field	Type	Label	Description
user_id	string
workflow_id	string
system	bool

NextRequest

NextResponse

Field	Type	Label	Description
execution	WorkflowExecution	optional

ScheduleRequest

Field	Type	Label	Description
definition	string		JSON-serialized WorkflowDefinitions (dynamic schema)
max_retry	int32
initiated_by	Initiator
schedule_at	google.protobuf.Timestamp	optional

ScheduleResponse

Field	Type	Label	Description
execution	WorkflowExecution

UnlockRequest

Field	Type	Label	Description
execution	WorkflowExecution

UnlockResponse

WorkflowExecution

Field	Type	Label	Description
execution_id	string
initiated_by	Initiator
status	ExecutionStatus
soft_try_count	int32
hard_try_count	int32
max_try_count	int32
next_retry_at	google.protobuf.Timestamp
dependencies	string	repeated
definition	string		JSON-serialized WorkflowDefinitions (dynamic schema)

ExecutionStatus

Name	Number	Description
EXECUTION_STATUS_UNSPECIFIED	0
EXECUTION_STATUS_PENDING	1
EXECUTION_STATUS_RUNNING	2
EXECUTION_STATUS_WILL_RETRY	3
EXECUTION_STATUS_COMPLETED	4
EXECUTION_STATUS_FAILED	5

WorkflowEngine

Internal service for the workflow worker to poll and update workflow executions. Authenticated via a pre-shared Bearer token in gRPC metadata.

Method Name	Request Type	Response Type	Description
Next	NextRequest	NextResponse	Atomically fetches and locks the next available workflow execution. Returns an empty response if no execution is available.
Schedule	ScheduleRequest	ScheduleResponse	Schedules a new workflow execution (used by the worker to create sub-workflows).
Unlock	UnlockRequest	UnlockResponse	Unlocks a workflow execution after processing, updating its state.
GetStatus	GetStatusRequest	GetStatusResponse	Returns the current status of a workflow execution (used to check dependencies).

infrastructure.proto

Datacenter

Datacenter represents a physical datacenter.

Field	Type	Label	Description
id	string		Unique identifier for the datacenter
name	string		Human-readable name of the datacenter
created_at	google.protobuf.Timestamp		Creation time of the zero trust network
updated_at	google.protobuf.Timestamp		Time of the zero trust network's last update

ListDatacentersRequest

ListDatacenterRequest is an empty message for listing datacenters.

ListDatacentersResponse

ListDatacentersResponse contains a collection of datacenter information.

Field	Type	Label	Description
datacenters	Datacenter	repeated	List of datacenter details

ListZeroTrustNetworkTypesRequest

ListZeroTrustNetworkTypesRequest contains the necessary information to list zero trust network types.

ListZeroTrustNetworkTypesResponse

ListZeroTrustNetworkTypesResponse contains a collection of zero trust network type information.

Field	Type	Label	Description
zero_trust_network_types	ZeroTrustNetworkType	repeated	List of zero trust network type details

ListZeroTrustNetworksRequest

ListZeroTrustNetworksRequest is an empty message for listing zero trust networks.

ListZeroTrustNetworksResponse

ListZeroTrustNetworksResponse contains a collection of zero trust network information.

Field	Type	Label	Description
zero_trust_networks	ZeroTrustNetwork	repeated	List of zero trust network details

ZeroTrustNetwork

ZeroTrustNetwork represents a zero trust network configuration. Zero trust networks enforce strict identity verification and access controls.

Field	Type	Label	Description
id	string		Unique identifier for the zero trust network
name	string		Human-readable name of the zero trust network
organization_slug	string		Slug of the organization this network belongs to
zero_trust_network_type_id	string		ID of the zero trust network type this network is based on
created_at	google.protobuf.Timestamp		Creation time of the zero trust network
updated_at	google.protobuf.Timestamp		Time of the zero trust network's last update

ZeroTrustNetworkType

ZeroTrustNetworkType represents a type or category of zero trust network. Network types define templates or configurations for creating zero trust networks.

Field	Type	Label	Description
id	string		Unique identifier for the zero trust network type
name	string		Human-readable name of the zero trust network type
created_at	google.protobuf.Timestamp		Creation time of the zero trust network type
updated_at	google.protobuf.Timestamp		Time of the zero trust network type's last update

Datacenters

Datacenters service providers operations to manage datacenter resources.

Method Name	Request Type	Response Type	Description
List	ListDatacentersRequest	ListDatacentersResponse	List retrieves information about Human-readable available datacenters. Returns a collection of datacenters.

ZeroTrustNetworkTypes

ZeroTrustNetworkTypes service provides operations to manage zero trust network type definitions. Network types define different categories or configurations of zero trust networks.

Method Name	Request Type	Response Type	Description
List	ListZeroTrustNetworkTypesRequest	ListZeroTrustNetworkTypesResponse	List retrieves information about all available zero trust network types. Returns a collection of zero trust network types.

ZeroTrustNetworks

ZeroTrustNetworks service provides operations to manage zero trust network resources. Zero trust networks implement security models where no user or device is trusted by default.

Method Name	Request Type	Response Type	Description
List	ListZeroTrustNetworksRequest	ListZeroTrustNetworksResponse	List retrieves information about all available zero trust networks. Returns a collection of zero trust networks.

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)