gRPC Reference

container.proto

Container

Field	Type	Label	Description
id	uint32
address	fixed32
prefix_length	fixed32
status	string
image	string
createdAt	google.protobuf.Timestamp
startedAt	google.protobuf.Timestamp
subnetwork_id	uint32
entrypoint	string	repeated
cmd	string	repeated
env	string	repeated

ContainerCreationRequest

Field	Type	Label	Description
subnetwork_id	uint32
image	string
entrypoint	string	repeated
cmd	string	repeated
env	string	repeated

ContainerExecInitializationRequest

Field	Type	Label	Description
identification	ContainerIdentificationRequest
console_width	int32
console_height	int32
terminal	string	optional
args	string	repeated

ContainerExecRequest

Field	Type	Label	Description
initialization	ContainerExecInitializationRequest
stdin	bytes

ContainerExecResponse

Field	Type	Label	Description
stdout	bytes
exit_code	int32

ContainerIdentificationRequest

Field	Type	Label	Description
id	uint32

ContainerService

Method Name	Request Type	Response Type	Description
Get	ContainerIdentificationRequest	Container
List	.google.protobuf.Empty	Container stream
Create	ContainerCreationRequest	Container
Delete	ContainerIdentificationRequest	.google.protobuf.Empty
Exec	ContainerExecRequest stream	ContainerExecResponse stream
Start	ContainerIdentificationRequest	Container
Stop	ContainerIdentificationRequest	Container

Top

introspection.proto

IntrospectionResponse

Field	Type	Label	Description
version	string

IntrospectionService

Method Name	Request Type	Response Type	Description
Get	.google.protobuf.Empty	IntrospectionResponse

Top

network.proto

Network

Field	Type	Label	Description
id	uint32
internet_access	bool
createdAt	google.protobuf.Timestamp

NetworkCreationRequest

Field	Type	Label	Description
internet_access	bool

NetworkIdentificationRequest

Field	Type	Label	Description
id	uint32

NetworkUpdateRequest

Field	Type	Label	Description
identification	NetworkIdentificationRequest
update	NetworkCreationRequest

NetworkService

Method Name	Request Type	Response Type	Description
Get	NetworkIdentificationRequest	Network
List	.google.protobuf.Empty	Network stream
Create	NetworkCreationRequest	Network
Update	NetworkUpdateRequest	Network
Delete	NetworkIdentificationRequest	.google.protobuf.Empty

Top

subnetwork.proto

Subnetwork

Field	Type	Label	Description
id	uint32
network_id	uint32
address	fixed32
prefix_length	fixed32
createdAt	google.protobuf.Timestamp

SubnetworkCreationRequest

Field	Type	Label	Description
network_id	uint32
address	fixed32
prefix_length	fixed32

SubnetworkIdentificationRequest

Field	Type	Label	Description
id	uint32

SubnetworkUpdateRequest

Field	Type	Label	Description
identification	SubnetworkIdentificationRequest
update	SubnetworkCreationRequest		TODO: different message for update body, disallow passing different networkId

SubnetworkService

Method Name	Request Type	Response Type	Description
Get	SubnetworkIdentificationRequest	Subnetwork
List	.google.protobuf.Empty	Subnetwork stream
Create	SubnetworkCreationRequest	Subnetwork
Update	SubnetworkUpdateRequest	Subnetwork
Delete	SubnetworkIdentificationRequest	.google.protobuf.Empty

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)