Skip to content

Search is only available in production builds. Try building and previewing the site to test it out locally.

ComputeService

platform.v1.ComputeService

ComputeService manages the lifecycle of compute instances. Every mutating RPC returns an Operation (HTTP 202-style async).

  • Request: CreateInstanceRequest
  • Response: Operation
  • REST mapping: POST /v1/instances
  • Request: GetInstanceRequest
  • Response: Instance
  • REST mapping: GET /v1/instances/{id}
  • Request: ListInstancesRequest
  • Response: ListInstancesResponse
  • REST mapping: GET /v1/instances
  • Request: InstanceActionRequest
  • Response: Operation
  • REST mapping: POST /v1/instances/{id}:start
  • Request: InstanceActionRequest
  • Response: Operation
  • REST mapping: POST /v1/instances/{id}:stop
  • Request: InstanceActionRequest
  • Response: Operation
  • REST mapping: POST /v1/instances/{id}:reboot
  • Request: InstanceActionRequest
  • Response: Operation
  • REST mapping: DELETE /v1/instances/{id}
  • Request: ResizeInstanceRequest
  • Response: Operation
  • REST mapping: POST /v1/instances/{id}:resize
  • Request: InstanceActionRequest
  • Response: Operation
  • REST mapping: POST /v1/instances/{id}:suspend
  • Request: InstanceActionRequest
  • Response: Operation
  • REST mapping: POST /v1/instances/{id}:resume
  • Request: UpdateInstanceRequest
  • Response: Operation
  • REST mapping: PATCH /v1/instances/{id}
  • Request: GetSystemLogRequest
  • Response: GetSystemLogResponse
  • REST mapping: GET /v1/instances/{id}/log
FieldType#Notes
instanceInstance1
FieldType#Notes
idstring1
FieldType#Notes
idstring1
FieldType#Notes
contentstring1

Instance is a provider-agnostic compute instance. Note: the backing provider (docker/hetzner/netcup) is deliberately NOT exposed in this message.

FieldType#Notes
idstring1inst_…
namestring2
appstring3
orgstring4
regionstring5
instance_typestring6normalized flavor, e.g. “c1.small”
imagestring7normalized image, e.g. “ubuntu-24.04”
stateResourceState8
private_ipstring10
public_ipstring11
user_datastring14Phase 1 additions.
deletion_protectionbool15block accidental delete/terminate
architecturestring16x86_64 | arm64 (best-effort)
platformstring17ubuntu | debian | …
key_pairstring18
root_devicestring19
tenancystring20default | dedicated (mocked)
public_dnsstring21
private_dnsstring22
vpcstring23
subnetstring24
availability_zonestring25
ssh_keysstring26Phase 4: SSH key ids to inject and firewall/security-group ids to attach at launch. On read, security_groups reflects the attached firewalls.
security_groupsstring27
FieldType#Notes
idstring1
FieldType#Notes
pagePageRequest1
FieldType#Notes
instancesInstance1
metaListMeta2

Operation is returned by every mutating RPC. Clients poll GetOperation or subscribe to the SSE stream to observe progress.

FieldType#Notes
idstring1opaque, type-prefixed: op_…
actionstring2permission string, e.g. compute.instance.create
resource_idstring3
resource_typestring4e.g. compute.instance
stateOperationState5
messagestring6
progressint3270..100
appstring8
FieldType#Notes
idstring1
instance_typestring2
FieldType#Notes
idstring1
namestring2
user_datastring4
deletion_protectionbool5