Reference

Each tool takes a JSON object and returns JSON. This is the default customer-API surface; admin and drain tools are not listed.

Tool	Input	Output	Notes
platform_v1_CatalogService_ListRegions	ListRegionsRequest	ListRegionsResponse
platform_v1_CatalogService_ListInstanceTypes	ListInstanceTypesRequest	ListInstanceTypesResponse
platform_v1_CatalogService_ListImages	ListImagesRequest	ListImagesResponse
platform_v1_CatalogService_ListOfferings	ListOfferingsRequest	ListOfferingsResponse
platform_v1_ComputeService_CreateInstance	CreateInstanceRequest	Operation
platform_v1_ComputeService_GetInstance	GetInstanceRequest	Instance
platform_v1_ComputeService_ListInstances	ListInstancesRequest	ListInstancesResponse
platform_v1_ComputeService_StartInstance	InstanceActionRequest	Operation
platform_v1_ComputeService_StopInstance	InstanceActionRequest	Operation
platform_v1_ComputeService_RebootInstance	InstanceActionRequest	Operation
platform_v1_ComputeService_DeleteInstance	InstanceActionRequest	Operation
platform_v1_ComputeService_ResizeInstance	ResizeInstanceRequest	Operation
platform_v1_ComputeService_SuspendInstance	InstanceActionRequest	Operation
platform_v1_ComputeService_ResumeInstance	InstanceActionRequest	Operation
platform_v1_ComputeService_UpdateInstance	UpdateInstanceRequest	Operation
platform_v1_ComputeService_GetSystemLog	GetSystemLogRequest	GetSystemLogResponse
platform_v1_IamService_ListOrganizations	ListOrganizationsRequest	ListOrganizationsResponse
platform_v1_IamService_ListApps	ListAppsRequest	ListAppsResponse
platform_v1_IamService_GetApp	GetAppRequest	App
platform_v1_IamService_CreateApp	CreateAppRequest	CreateAppResponse
platform_v1_IamService_UpdateApp	UpdateAppRequest	App
platform_v1_IamService_DeleteApp	DeleteAppRequest	DeleteAppResponse	DeleteApp is refused while the app holds resources or other apps.
platform_v1_IamService_MoveResources	MoveResourcesRequest	MoveResourcesResponse
platform_v1_IamService_ListRoles	ListRolesRequest	ListRolesResponse
platform_v1_IamService_ListMembers	ListMembersRequest	ListMembersResponse
platform_v1_IamService_CheckPermission	CheckPermissionRequest	CheckPermissionResponse
platform_v1_ImageService_CreateImageFromInstance	CreateImageFromInstanceRequest	Operation
platform_v1_ImageService_ListImages	ImagesListRequest	ImagesListResponse
platform_v1_ImageService_GetImage	GetImageRequest	Image
platform_v1_ImageService_DeleteImage	DeleteImageRequest	Operation
platform_v1_ImageService_UpdateImage	UpdateImageRequest	Image
platform_v1_NetworkService_CreateSshKey	CreateSshKeyRequest	CreateSshKeyResponse	SSH keys
platform_v1_NetworkService_ImportSshKey	ImportSshKeyRequest	SshKey
platform_v1_NetworkService_ListSshKeys	ListSshKeysRequest	ListSshKeysResponse
platform_v1_NetworkService_GetSshKey	GetSshKeyRequest	SshKey
platform_v1_NetworkService_DeleteSshKey	DeleteSshKeyRequest	Operation
platform_v1_NetworkService_CreateFirewall	CreateFirewallRequest	Operation	Firewalls (security groups)
platform_v1_NetworkService_ListFirewalls	ListFirewallsRequest	ListFirewallsResponse
platform_v1_NetworkService_GetFirewall	GetFirewallRequest	Firewall
platform_v1_NetworkService_UpdateFirewallRules	UpdateFirewallRulesRequest	Operation
platform_v1_NetworkService_DeleteFirewall	DeleteFirewallRequest	Operation
platform_v1_NetworkService_AttachFirewall	AttachFirewallRequest	Operation
platform_v1_NetworkService_DetachFirewall	DetachFirewallRequest	Operation
platform_v1_NetworkService_AllocateFloatingIp	AllocateFloatingIpRequest	Operation	Floating IPs
platform_v1_NetworkService_ListFloatingIps	ListFloatingIpsRequest	ListFloatingIpsResponse
platform_v1_NetworkService_GetFloatingIp	GetFloatingIpRequest	FloatingIp
platform_v1_NetworkService_AssociateFloatingIp	AssociateFloatingIpRequest	Operation
platform_v1_NetworkService_DisassociateFloatingIp	DisassociateFloatingIpRequest	Operation
platform_v1_NetworkService_ReleaseFloatingIp	ReleaseFloatingIpRequest	Operation
platform_v1_NetworkService_UpdateReverseDns	UpdateReverseDnsRequest	Operation
platform_v1_OperationService_GetOperation	GetOperationRequest	Operation
platform_v1_OperationService_ListOperations	ListOperationsRequest	ListOperationsResponse
platform_v1_StorageService_CreateVolume	CreateVolumeRequest	Operation
platform_v1_StorageService_GetVolume	GetVolumeRequest	Volume
platform_v1_StorageService_ListVolumes	ListVolumesRequest	ListVolumesResponse
platform_v1_StorageService_AttachVolume	AttachVolumeRequest	Operation
platform_v1_StorageService_DetachVolume	DetachVolumeRequest	Operation
platform_v1_StorageService_ModifyVolume	ModifyVolumeRequest	Operation
platform_v1_StorageService_DeleteVolume	DeleteVolumeRequest	Operation
platform_v1_StorageService_CreateSnapshot	CreateSnapshotRequest	Operation
platform_v1_StorageService_ListSnapshots	ListSnapshotsRequest	ListSnapshotsResponse
platform_v1_StorageService_GetSnapshot	GetSnapshotRequest	Snapshot
platform_v1_StorageService_DeleteSnapshot	DeleteSnapshotRequest	Operation
platform_v1_StorageService_RestoreVolumeFromSnapshot	RestoreVolumeFromSnapshotRequest	Operation
platform_v1_StorageService_CreateVolumeFromSnapshot	CreateVolumeFromSnapshotRequest	Operation
platform_v1_StorageService_CreateBackupPolicy	CreateBackupPolicyRequest	BackupPolicy	---- Phase 6: volume backup policies (schedule + retention) ----
platform_v1_StorageService_ListBackupPolicies	ListBackupPoliciesRequest	ListBackupPoliciesResponse
platform_v1_StorageService_GetBackupPolicy	GetBackupPolicyRequest	BackupPolicy
platform_v1_StorageService_UpdateBackupPolicy	UpdateBackupPolicyRequest	BackupPolicy
platform_v1_StorageService_DeleteBackupPolicy	DeleteBackupPolicyRequest	BackupPolicy
platform_v1_StorageService_RunBackupPolicy	RunBackupPolicyRequest	Operation
healthz	(none)	ok	Check that the API is up.

Inputs and outputs

AllocateFloatingIpRequest

Field	Type	#	Notes
name	string	1
region	string	2
type	string	3	ipv4 | ipv6 (default ipv4)

App

App groups a tenant’s resources. Apps nest; a view of an app includes the apps below it, and a role held on an app applies to them as well.

Field	Type	#	Notes
id	string	1	app_… (proj_… for apps created as projects)
org	string	2
name	string	3
parent_id	string	4	empty for a top-level app
description	string	5
template_id	string	6	the template the app was created from, if any

AssociateFloatingIpRequest

Field	Type	#	Notes
id	string	1
instance_id	string	2

AttachFirewallRequest

Field	Type	#	Notes
id	string	1
instance_id	string	2

AttachVolumeRequest

AttachVolumeRequest performs the “Switch Volume” operation.

Field	Type	#	Notes
id	string	1
instance_id	string	2

BackupPolicy

BackupPolicy schedules retained snapshots of a volume (Phase 6). A backup is just a snapshot with origin=backup; the policy owns cadence + retention.

Field	Type	#	Notes
id	string	1	bpol_…
name	string	2
app	string	3
org	string	4
source_volume	string	5	volume id to back up
provider	string	6
schedule	string	7	hourly | daily | weekly | “@every <dur>”
retention_keep	int32	8	keep N most recent backups (0 = unlimited)
retention_days	int32	9	expire backups older than N days (0 = no expiry)
enabled	bool	10

CheckPermissionRequest

CheckPermission powers the “test this permission” simulator in the IAM UI.

Field	Type	#	Notes
principal	string	1
permission	string	2
scope	string	3

CheckPermissionResponse

Field	Type	#	Notes
allowed	bool	1
reason	string	2

CreateAppRequest

Field	Type	#	Notes
org	string	1	the tenant; defaults to the caller’s
name	string	2
parent_id	string	3	empty for a top-level app
description	string	4
attach_ids	string	5	existing resources to move into the new app
template_id	string	6	launch the template’s items into the app

CreateAppResponse

Field	Type	#	Notes
app	App	1
operations	Operation	2	One operation per template item. A failed item leaves the others running.

CreateBackupPolicyRequest

Field	Type	#	Notes
name	string	1
source_volume_id	string	2
schedule	string	3
retention_keep	int32	4
retention_days	int32	5
enabled	bool	6

CreateFirewallRequest

Field	Type	#	Notes
name	string	1
description	string	2
rules	FirewallRule	3

CreateImageFromInstanceRequest

CreateImageFromInstance captures a source instance into a launchable MACHINE image (AWS “create image”; never “AMI”).

Field	Type	#	Notes
instance_id	string	1
name	string	2
description	string	3

CreateInstanceRequest

Field	Type	#	Notes
instance	Instance	1

CreateSnapshotRequest

Field	Type	#	Notes
source_volume_id	string	1
source_instance_id	string	2
description	string	3
name	string	4

CreateSshKeyRequest

CreateSshKeyRequest generates a new key pair server-side and returns the private key exactly once in CreateSshKeyResponse.

Field	Type	#	Notes
name	string	1
type	string	2	rsa | ed25519 (default ed25519)

CreateSshKeyResponse

Field	Type	#	Notes
key	SshKey	1
private_key	string	2	private_key is returned only for platform-generated keys, only once.

CreateVolumeFromSnapshotRequest

Field	Type	#	Notes
id	string	1	snapshot id
name	string	2	new volume name

CreateVolumeRequest

Field	Type	#	Notes
volume	Volume	1

DeleteAppRequest

Field	Type	#	Notes
id	string	1

DeleteAppResponse

No fields.

DeleteBackupPolicyRequest

Field	Type	#	Notes
id	string	1

DeleteFirewallRequest

Field	Type	#	Notes
id	string	1

DeleteImageRequest

Field	Type	#	Notes
id	string	1

DeleteSnapshotRequest

Field	Type	#	Notes
id	string	1

DeleteSshKeyRequest

Field	Type	#	Notes
id	string	1

DeleteVolumeRequest

Field	Type	#	Notes
id	string	1

DetachFirewallRequest

Field	Type	#	Notes
id	string	1
instance_id	string	2

DetachVolumeRequest

Field	Type	#	Notes
id	string	1
force	bool	2

DisassociateFloatingIpRequest

Field	Type	#	Notes
id	string	1

Firewall

Field	Type	#	Notes
id	string	1	fw_…
name	string	2
description	string	3
app	string	4
org	string	5
region	string	6
is_default	bool	7
rules	FirewallRule	8

FloatingIp

---- Floating / Elastic IPs ----

Field	Type	#	Notes
id	string	1	fip_…
name	string	2
app	string	3
org	string	4
region	string	5
address	string	6
type	string	7	ipv4 | ipv6
attached_to	string	8	instance id, empty if unassociated
reverse_dns	string	9

GetAppRequest

Field	Type	#	Notes
id	string	1

GetBackupPolicyRequest

Field	Type	#	Notes
id	string	1

GetFirewallRequest

Field	Type	#	Notes
id	string	1

GetFloatingIpRequest

Field	Type	#	Notes
id	string	1

GetImageRequest

Field	Type	#	Notes
id	string	1

GetInstanceRequest

Field	Type	#	Notes
id	string	1

GetOperationRequest

Field	Type	#	Notes
id	string	1

GetSnapshotRequest

Field	Type	#	Notes
id	string	1

GetSshKeyRequest

Field	Type	#	Notes
id	string	1

GetSystemLogRequest

Field	Type	#	Notes
id	string	1

GetSystemLogResponse

Field	Type	#	Notes
content	string	1

GetVolumeRequest

Field	Type	#	Notes
id	string	1

Image

Field	Type	#	Notes
id	string	1	ubuntu-24.04 (SYSTEM) or img_… (MACHINE)
name	string	2
os	string	3
version	string	4
type	ImageType	5	Phase 2 unified-image fields (populated for MACHINE images; SYSTEM images leave provider-scoped fields empty).
description	string	6
app	string	7
org	string	8
region	string	9
provider	string	10
status	string	11	pending | available | failed
visibility	string	12	private | public
platform	string	13	linux | windows
architecture	string	14	x86_64 | arm64
root_device_type	string	15
source_instance	string	16
created_at	string	18
updated_at	string	19
machine_image_id	string	20	platform machine image this custom image was captured from

ImagesListRequest

ImagesListRequest filters by type; IMAGE_TYPE_UNSPECIFIED returns all.

Field	Type	#	Notes
type	ImageType	1

ImagesListResponse

Field	Type	#	Notes
images	Image	1

ImportSshKeyRequest

ImportSshKeyRequest registers an existing public key (no private key stored).

Field	Type	#	Notes
name	string	1
public_key	string	2

Instance

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

Field	Type	#	Notes
id	string	1	inst_…
name	string	2
app	string	3
org	string	4
region	string	5
instance_type	string	6	normalized flavor, e.g. “c1.small”
image	string	7	normalized image, e.g. “ubuntu-24.04”
state	ResourceState	8
private_ip	string	10
public_ip	string	11
user_data	string	14	Phase 1 additions.
deletion_protection	bool	15	block accidental delete/terminate
architecture	string	16	x86_64 | arm64 (best-effort)
platform	string	17	ubuntu | debian | …
key_pair	string	18
root_device	string	19
tenancy	string	20	default | dedicated (mocked)
public_dns	string	21
private_dns	string	22
vpc	string	23
subnet	string	24
availability_zone	string	25
ssh_keys	string	26	Phase 4: SSH key ids to inject and firewall/security-group ids to attach at launch. On read, security_groups reflects the attached firewalls.
security_groups	string	27

InstanceActionRequest

Field	Type	#	Notes
id	string	1

ListAppsRequest

Field	Type	#	Notes
org	string	1

ListAppsResponse

Field	Type	#	Notes
apps	App	1

ListBackupPoliciesRequest

Field	Type	#	Notes
page	PageRequest	1

ListBackupPoliciesResponse

Field	Type	#	Notes
policies	BackupPolicy	1
meta	ListMeta	2

ListFirewallsRequest

Field	Type	#	Notes
page	PageRequest	1

ListFirewallsResponse

Field	Type	#	Notes
firewalls	Firewall	1
meta	ListMeta	2

ListFloatingIpsRequest

Field	Type	#	Notes
page	PageRequest	1

ListFloatingIpsResponse

Field	Type	#	Notes
ips	FloatingIp	1
meta	ListMeta	2

ListImagesRequest

No fields.

ListImagesResponse

Field	Type	#	Notes
images	Image	1

ListInstanceTypesRequest

Field	Type	#	Notes
region_id	string	1	optional query; empty = p5 global active list

ListInstanceTypesResponse

Field	Type	#	Notes
instance_types	InstanceType	1

ListInstancesRequest

Field	Type	#	Notes
page	PageRequest	1

ListInstancesResponse

Field	Type	#	Notes
instances	Instance	1
meta	ListMeta	2

ListMembersRequest

Field	Type	#	Notes
scope	string	1

ListMembersResponse

Field	Type	#	Notes
members	Member	1

ListOfferingsRequest

No fields.

ListOfferingsResponse

Field	Type	#	Notes
offerings	Offering	1

ListOperationsRequest

Field	Type	#	Notes
page	PageRequest	1

ListOperationsResponse

Field	Type	#	Notes
operations	Operation	1
meta	ListMeta	2

ListOrganizationsRequest

No fields.

ListOrganizationsResponse

Field	Type	#	Notes
organizations	Organization	1

ListRegionsRequest

No fields.

ListRegionsResponse

Field	Type	#	Notes
regions	Region	1

ListRolesRequest

No fields.

ListRolesResponse

Field	Type	#	Notes
roles	Role	1

ListSnapshotsRequest

Field	Type	#	Notes
page	PageRequest	1

ListSnapshotsResponse

Field	Type	#	Notes
snapshots	Snapshot	1
meta	ListMeta	2

ListSshKeysRequest

Field	Type	#	Notes
page	PageRequest	1

ListSshKeysResponse

Field	Type	#	Notes
keys	SshKey	1
meta	ListMeta	2

ListVolumesRequest

Field	Type	#	Notes
page	PageRequest	1

ListVolumesResponse

Field	Type	#	Notes
volumes	Volume	1
meta	ListMeta	2

ModifyVolumeRequest

Field	Type	#	Notes
id	string	1
size_gb	int64	2
type	string	3
iops	int32	4
throughput	int32	5

MoveResourcesRequest

Field	Type	#	Notes
app_id	string	1	the destination
resource_ids	string	2

MoveResourcesResponse

Field	Type	#	Notes
moved	string	1

Operation

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

Field	Type	#	Notes
id	string	1	opaque, type-prefixed: op_…
action	string	2	permission string, e.g. compute.instance.create
resource_id	string	3
resource_type	string	4	e.g. compute.instance
state	OperationState	5
message	string	6
progress	int32	7	0..100
app	string	8

ReleaseFloatingIpRequest

Field	Type	#	Notes
id	string	1

ResizeInstanceRequest

Field	Type	#	Notes
id	string	1
instance_type	string	2

RestoreVolumeFromSnapshotRequest

Field	Type	#	Notes
id	string	1

RunBackupPolicyRequest

Field	Type	#	Notes
id	string	1

Snapshot

Snapshot is a disk backup of a volume or instance disk.

Field	Type	#	Notes
id	string	1	snap_…
name	string	2
description	string	3
app	string	4
org	string	5
region	string	6
source_volume	string	7
source_instance	string	8
size_gb	int64	9
status	string	10	pending | available | failed
progress	int32	11
encrypted	bool	12
origin	string	13	manual | backup

SshKey

---- SSH keys (Key Pairs) ----

Field	Type	#	Notes
id	string	1	key_…
name	string	2
app	string	3
org	string	4
public_key	string	5
fingerprint	string	6
type	string	7	rsa | ed25519

UpdateAppRequest

Field	Type	#	Notes
id	string	1
name	string	2
description	string	3
parent_id	string	4	"" moves the app to the top level

UpdateBackupPolicyRequest

Field	Type	#	Notes
id	string	1
name	string	2
schedule	string	3
retention_keep	int32	4
retention_days	int32	5
enabled	bool	6

UpdateFirewallRulesRequest

Field	Type	#	Notes
id	string	1
rules	FirewallRule	2

UpdateImageRequest

Field	Type	#	Notes
id	string	1
description	string	2

UpdateInstanceRequest

Field	Type	#	Notes
id	string	1
name	string	2
user_data	string	4
deletion_protection	bool	5

UpdateReverseDnsRequest

Field	Type	#	Notes
id	string	1
reverse_dns	string	2

Volume

Field	Type	#	Notes
id	string	1	vol_…
name	string	2
app	string	3
org	string	4
region	string	5
size_gb	int64	6
state	ResourceState	7
attached_to	string	8	instance id, empty if detached
type	string	12	Phase 3 EBS-style attributes.
iops	int32	13
throughput	int32	14
source_snapshot	string	15
encrypted	bool	16
availability_zone	string	17