NetworkService

platform.v1.NetworkService

RPCs

`CreateSshKey`

SSH keys

Request: CreateSshKeyRequest
Response: CreateSshKeyResponse
REST mapping: POST /v1/ssh-keys

`ImportSshKey`

Request: ImportSshKeyRequest
Response: SshKey
REST mapping: POST /v1/ssh-keys:import

`ListSshKeys`

Request: ListSshKeysRequest
Response: ListSshKeysResponse
REST mapping: GET /v1/ssh-keys

`GetSshKey`

Request: GetSshKeyRequest
Response: SshKey
REST mapping: GET /v1/ssh-keys/{id}

`DeleteSshKey`

Request: DeleteSshKeyRequest
Response: Operation
REST mapping: DELETE /v1/ssh-keys/{id}

`CreateFirewall`

Firewalls (security groups)

Request: CreateFirewallRequest
Response: Operation
REST mapping: POST /v1/firewalls

`ListFirewalls`

Request: ListFirewallsRequest
Response: ListFirewallsResponse
REST mapping: GET /v1/firewalls

`GetFirewall`

Request: GetFirewallRequest
Response: Firewall
REST mapping: GET /v1/firewalls/{id}

`UpdateFirewallRules`

Request: UpdateFirewallRulesRequest
Response: Operation
REST mapping: POST /v1/firewalls/{id}:rules

`DeleteFirewall`

Request: DeleteFirewallRequest
Response: Operation
REST mapping: DELETE /v1/firewalls/{id}

`AttachFirewall`

Request: AttachFirewallRequest
Response: Operation
REST mapping: POST /v1/firewalls/{id}:attach

`DetachFirewall`

Request: DetachFirewallRequest
Response: Operation
REST mapping: POST /v1/firewalls/{id}:detach

`AllocateFloatingIp`

Floating IPs

Request: AllocateFloatingIpRequest
Response: Operation
REST mapping: POST /v1/floating-ips

`ListFloatingIps`

Request: ListFloatingIpsRequest
Response: ListFloatingIpsResponse
REST mapping: GET /v1/floating-ips

`GetFloatingIp`

Request: GetFloatingIpRequest
Response: FloatingIp
REST mapping: GET /v1/floating-ips/{id}

`AssociateFloatingIp`

Request: AssociateFloatingIpRequest
Response: Operation
REST mapping: POST /v1/floating-ips/{id}:associate

`DisassociateFloatingIp`

Request: DisassociateFloatingIpRequest
Response: Operation
REST mapping: POST /v1/floating-ips/{id}:disassociate

`ReleaseFloatingIp`

Request: ReleaseFloatingIpRequest
Response: Operation
REST mapping: DELETE /v1/floating-ips/{id}

`UpdateReverseDns`

Request: UpdateReverseDnsRequest
Response: Operation
REST mapping: POST /v1/floating-ips/{id}:reverse-dns

Messages

`AllocateFloatingIpRequest`

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

`AssociateFloatingIpRequest`

Field	Type	#	Notes
`id`	`string`	1
`instance_id`	`string`	2

`AttachFirewallRequest`

Field	Type	#	Notes
`id`	`string`	1
`instance_id`	`string`	2

`CreateFirewallRequest`

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

`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.

`DeleteFirewallRequest`

Field	Type	#	Notes
`id`	`string`	1

`DeleteSshKeyRequest`

Field	Type	#	Notes
`id`	`string`	1

`DetachFirewallRequest`

Field	Type	#	Notes
`id`	`string`	1
`instance_id`	`string`	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

`GetFirewallRequest`

Field	Type	#	Notes
`id`	`string`	1

`GetFloatingIpRequest`

Field	Type	#	Notes
`id`	`string`	1

`GetSshKeyRequest`

Field	Type	#	Notes
`id`	`string`	1

`ImportSshKeyRequest`

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

Field	Type	#	Notes
`name`	`string`	1
`public_key`	`string`	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

`ListSshKeysRequest`

Field	Type	#	Notes
`page`	`PageRequest`	1

`ListSshKeysResponse`

Field	Type	#	Notes
`keys`	`SshKey`	1
`meta`	`ListMeta`	2

`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

`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

`UpdateFirewallRulesRequest`

Field	Type	#	Notes
`id`	`string`	1
`rules`	`FirewallRule`	2

`UpdateReverseDnsRequest`

Field	Type	#	Notes
`id`	`string`	1
`reverse_dns`	`string`	2