Talk to us

api/v1/common.proto

Enums

AdminRole

Name Number Description
ADMIN_ROLE_UNSPECIFIED 0
ADMIN_ROLE_EDITOR 1
ADMIN_ROLE_VIEWER 2

Chargeable

Name Number Description
CHARGEABLE_UNSPECIFIED 0
CHARGEABLE_TRUE 1
CHARGEABLE_FALSE 2

OAuthProvider

Name Number Description
O_AUTH_PROVIDER_UNSPECIFIED 0
O_AUTH_PROVIDER_GITHUB 1
O_AUTH_PROVIDER_AZURE 2

ProjectRole

Name Number Description
PROJECT_ROLE_UNSPECIFIED 0
PROJECT_ROLE_OWNER 1
PROJECT_ROLE_EDITOR 2
PROJECT_ROLE_VIEWER 3

Role

Name Number Description
ROLE_UNSPECIFIED 0
ROLE_MEMBER 1
ROLE_MAINTAINER 2
ROLE_ADMIN 3
ROLE_OWNER 4

TenantRole

Name Number Description
TENANT_ROLE_UNSPECIFIED 0
TENANT_ROLE_OWNER 1
TENANT_ROLE_EDITOR 2
TENANT_ROLE_VIEWER 3

Visibility

Name Number Description
VISIBILITY_UNSPECIFIED 0
VISIBILITY_PUBLIC 1 VISIBILITY_PUBLIC specifies that this service is accessible without authentication
VISIBILITY_PRIVATE 2 VISIBILITY_PRIVATE makes this service blocked

Extensions

admin_roles

Extension Type Base Number
admin_roles AdminRole MethodOptions 51002
chargeable Chargeable MethodOptions 51004
project_roles ProjectRole MethodOptions 51001
tenant_roles TenantRole MethodOptions 51000
visibility Visibility MethodOptions 51003

chargeable

Extension Type Base Number
admin_roles AdminRole MethodOptions 51002
chargeable Chargeable MethodOptions 51004
project_roles ProjectRole MethodOptions 51001
tenant_roles TenantRole MethodOptions 51000
visibility Visibility MethodOptions 51003

project_roles

Extension Type Base Number
admin_roles AdminRole MethodOptions 51002
chargeable Chargeable MethodOptions 51004
project_roles ProjectRole MethodOptions 51001
tenant_roles TenantRole MethodOptions 51000
visibility Visibility MethodOptions 51003

tenant_roles

Extension Type Base Number
admin_roles AdminRole MethodOptions 51002
chargeable Chargeable MethodOptions 51004
project_roles ProjectRole MethodOptions 51001
tenant_roles TenantRole MethodOptions 51000
visibility Visibility MethodOptions 51003

visibility

Extension Type Base Number
admin_roles AdminRole MethodOptions 51002
chargeable Chargeable MethodOptions 51004
project_roles ProjectRole MethodOptions 51001
tenant_roles TenantRole MethodOptions 51000
visibility Visibility MethodOptions 51003

Messages

Paging

Field Type Label
page uint64 optional
count uint64 optional

api/v1/payment.proto

Messages

Address

Field Type Label
line1 string
line2 string
postal_code string
city string
state string
country string

Card

Field Type Label
brand string
country string
exp_month int64
exp_year int64
last_4 string

Coupon

Field Type Label
id string
name string
amount_off int64
currency string
duration_in_month int64
created_at google.protobuf.Timestamp
redeem_by google.protobuf.Timestamp
times_redeemed int64
max_redemptions int64

Invoice

Field Type Label
id string
pdf_download_url string
period_start google.protobuf.Timestamp
period_end google.protobuf.Timestamp

PaymentCustomer

Field Type Label
login string
name string optional
customer_id string optional
payment_method_id string
subscription_id string
email string optional
card Card optional
prices Price repeated
address Address
coupon Coupon optional
vat string optional
phone_number string optional

PaymentServiceCheckAdmittedRequest

Field Type Label
login string

PaymentServiceCheckAdmittedResponse

Field Type Label
admitted bool
requested bool

PaymentServiceCheckIfCustomerExistsRequest

Field Type Label
login string

PaymentServiceCheckIfCustomerExistsResponse

Field Type Label
customer PaymentCustomer
exists bool

PaymentServiceCreateOrUpdateCustomerRequest

Field Type Label
login string
customer PaymentCustomer
accepted_terms_and_conditions bool

PaymentServiceCreateOrUpdateCustomerResponse

Field Type Label
customer PaymentCustomer

PaymentServiceDeletePaymentMethodRequest

Field Type Label
login string

PaymentServiceDeletePaymentMethodResponse

Field Type Label
there are no fields

PaymentServiceGetCustomerRequest

Field Type Label
login string
customer_id string

PaymentServiceGetCustomerResponse

Field Type Label
customer PaymentCustomer

PaymentServiceGetCustomerWithLoginRequest

Field Type Label
login string

PaymentServiceGetCustomerWithLoginResponse

Field Type Label
customer PaymentCustomer

PaymentServiceGetDefaultPricesRequest

Field Type Label
there are no fields

PaymentServiceGetDefaultPricesResponse

Field Type Label
prices Price repeated

PaymentServiceGetInvoicesRequest

Field Type Label
login string
customer_id string

PaymentServiceGetInvoicesResponse

Field Type Label
invoices Invoice repeated

PaymentServiceGetSubscriptionUsageRequest

Field Type Label
login string

PaymentServiceGetSubscriptionUsageResponse

Field Type Label
subscription_usage_items SubscriptionUsageItem repeated

PaymentServiceHasChargeableResourcesRequest

Field Type Label
login string

PaymentServiceHasChargeableResourcesResponse

Field Type Label
has_resources bool

PaymentServiceHasPaymentMethodRequest

Field Type Label
login string
project string

PaymentServiceHasPaymentMethodResponse

Field Type Label
exists bool

PaymentServiceRequestAdmissionRequest

Field Type Label
login string
customer PaymentCustomer
accepted_terms_and_conditions bool
email_consent bool

PaymentServiceRequestAdmissionResponse

Field Type Label
there are no fields

Price

Field Type Label
name string
unit_amount_decimal double
currency string
unit_label string

SubscriptionUsageItem

Field Type Label
subscription_item_id string
subscription_item_name string
total_usage int64
period_start google.protobuf.Timestamp
period_end google.protobuf.Timestamp

Services

PaymentService

Method CreateOrUpdateCustomer

Request Type PaymentServiceCreateOrUpdateCustomerRequest

Response Type PaymentServiceCreateOrUpdateCustomerResponse

Description

This Language is not supported

Method GetCustomer

Request Type PaymentServiceGetCustomerRequest

Response Type PaymentServiceGetCustomerResponse

Description

This Language is not supported

Method GetCustomerWithLogin

Request Type PaymentServiceGetCustomerWithLoginRequest

Response Type PaymentServiceGetCustomerWithLoginResponse

Description

This Language is not supported

Method CheckIfCustomerExists

Request Type PaymentServiceCheckIfCustomerExistsRequest

Response Type PaymentServiceCheckIfCustomerExistsResponse

Description

This Language is not supported

Method HasPaymentMethod

Request Type PaymentServiceHasPaymentMethodRequest

Response Type PaymentServiceHasPaymentMethodResponse

Description

This Language is not supported

Method DeletePaymentMethod

Request Type PaymentServiceDeletePaymentMethodRequest

Response Type PaymentServiceDeletePaymentMethodResponse

Description

This Language is not supported

Method GetSubscriptionUsage

Request Type PaymentServiceGetSubscriptionUsageRequest

Response Type PaymentServiceGetSubscriptionUsageResponse

Description

This Language is not supported

Method GetInvoices

Request Type PaymentServiceGetInvoicesRequest

Response Type PaymentServiceGetInvoicesResponse

Description

This Language is not supported

Method GetDefaultPrices

Request Type PaymentServiceGetDefaultPricesRequest

Response Type PaymentServiceGetDefaultPricesResponse

Description

This Language is not supported

Method CheckAdmitted

Request Type PaymentServiceCheckAdmittedRequest

Response Type PaymentServiceCheckAdmittedResponse

Description

This Language is not supported

Method RequestAdmission

Request Type PaymentServiceRequestAdmissionRequest

Response Type PaymentServiceRequestAdmissionResponse

Description

This Language is not supported

Method HasChargeableResources

Request Type PaymentServiceHasChargeableResourcesRequest

Response Type PaymentServiceHasChargeableResourcesResponse

Description

This Language is not supported

api/v1/volume.proto

Messages

Snapshot

Field Type Label
uuid string
name string
description string
project string
partition string
storage_class string
size uint64
usage uint64
state string
source_volume_uuid string
source_volume_name string
replica_count uint32
primary_node_uuid string
retention google.protobuf.Duration
statistics SnapshotStatistics
created_at google.protobuf.Timestamp
updated_at google.protobuf.Timestamp
deleted_at google.protobuf.Timestamp

SnapshotServiceDeleteRequest

Field Type Label
uuid string
project string

SnapshotServiceDeleteResponse

Field Type Label
snapshot Snapshot

SnapshotServiceGetRequest

Field Type Label
uuid string
project string

SnapshotServiceGetResponse

Field Type Label
snapshot Snapshot

SnapshotServiceListRequest

Field Type Label
uuid string optional
project string
partition string optional
name string optional

SnapshotServiceListResponse

Field Type Label
snapshots Snapshot repeated

SnapshotStatistics

Field Type Label
physical_capacity uint64
physical_owned_capacity uint64
physical_owned_memory uint64
physical_memory uint64
user_written uint64

Volume

Types

Field Type Label
uuid string
name string
project string
partition string
storage_class string
size uint64
usage uint64
state string
attached_to string repeated
source_snapshot_uuid string
source_snapshot_name string
volume_handle string
node_ips string repeated
rebuild_progress string
primary_node_uuid string
qos_policy_uuid string
qos_policy_name string
replica_count uint32
protection_state string
logical_used_storage uint64
statistics VolumeStatistics
created_at google.protobuf.Timestamp
updated_at google.protobuf.Timestamp
deleted_at google.protobuf.Timestamp

VolumeServiceDeleteRequest

Field Type Label
uuid string
project string

VolumeServiceDeleteResponse

Field Type Label
volume Volume

VolumeServiceGetRequest

Requests

Field Type Label
uuid string
project string

VolumeServiceGetResponse

Responses

Field Type Label
volume Volume

VolumeServiceListRequest

Field Type Label
uuid string optional
project string
partition string optional
name string optional

VolumeServiceListResponse

Field Type Label
volumes Volume repeated

VolumeStatistics

Field Type Label
logical_used_storage uint64
physical_used_storage uint64
compression_ratio double
total_compression_ratio double
physical_capacity uint64
physical_owned_capacity uint64
physical_owned_memory uint64
physical_memory uint64
user_written uint64
unrecoverable_data_integrity_errors uint32
recoverable_data_integrity_errors uint32

Services

SnapshotService

Method Get

Request Type SnapshotServiceGetRequest

Response Type SnapshotServiceGetResponse

Description

This Language is not supported

Method List

Request Type SnapshotServiceListRequest

Response Type SnapshotServiceListResponse

Description

This Language is not supported

Method Delete

Request Type SnapshotServiceDeleteRequest

Response Type SnapshotServiceDeleteResponse

Description

This Language is not supported

VolumeService

Method Get

Request Type VolumeServiceGetRequest

Response Type VolumeServiceGetResponse

Description

This Language is not supported

Method List

Request Type VolumeServiceListRequest

Response Type VolumeServiceListResponse

Description

This Language is not supported

Method Delete

Request Type VolumeServiceDeleteRequest

Response Type VolumeServiceDeleteResponse

Description

This Language is not supported

api/v1/tenant.proto

Messages

PaymentDetails

Field Type Label
customer_id string
payment_method_id string
subscription_id string
coupons Coupon repeated
vat string

PaymentDetailsUpdate

Field Type Label
customer_id string optional
payment_method_id string optional
subscription_id string optional
vat string optional

Tenant

Tenant

Field Type Label
login string
name string
email string
avatar_url string
oauth_provider OAuthProvider
payment_details PaymentDetails
admitted bool
phone_number string
terms_and_conditions TermsAndConditions
email_consent bool
created_at google.protobuf.Timestamp
updated_at google.protobuf.Timestamp
deleted_at google.protobuf.Timestamp

TenantServiceCreateOrUpdateRequest

Field Type Label
tenant Tenant

TenantServiceCreateOrUpdateResponse

Field Type Label
tenant Tenant

TenantServiceCreateRequest

Field Type Label
tenant Tenant

TenantServiceCreateResponse

Field Type Label
tenant Tenant

TenantServiceDeleteRequest

Field Type Label
login string

TenantServiceDeleteResponse

Field Type Label
tenant Tenant

TenantServiceGetRequest

Field Type Label
login string

TenantServiceGetResponse

Responses

Field Type Label
tenant Tenant

TenantServiceUpdateRequest

Field Type Label
login string
name string optional
email string optional
avatar_url string optional
payment_details PaymentDetailsUpdate optional
terms_and_conditions TermsAndConditionsUpdate optional

TenantServiceUpdateResponse

Field Type Label
tenant Tenant

TermsAndConditions

Field Type Label
accepted bool
when google.protobuf.Timestamp

TermsAndConditionsUpdate

Field Type Label
accepted bool optional
when google.protobuf.Timestamp optional

Services

TenantService

Method Create

Request Type TenantServiceCreateRequest

Response Type TenantServiceCreateResponse

Description

This Language is not supported

Method CreateOrUpdate

Request Type TenantServiceCreateOrUpdateRequest

Response Type TenantServiceCreateOrUpdateResponse

Description CreateOrUpdate should only be used from within the application will check if tenant already exists and updates if necessary, otherwise create a new tenant

This Language is not supported

Method Get

Request Type TenantServiceGetRequest

Response Type TenantServiceGetResponse

Description

This Language is not supported

Method Update

Request Type TenantServiceUpdateRequest

Response Type TenantServiceUpdateResponse

Description

This Language is not supported

Method Delete

Request Type TenantServiceDeleteRequest

Response Type TenantServiceDeleteResponse

Description

This Language is not supported

api/v1/assets.proto

Messages

Asset

Types

Field Type Label
region Region
machine_types Asset.MachineTypesEntry repeated
kubernetes Kubernetes repeated

MachineTypesEntry

Field Type Label
key string
value MachineType

AssetDefaults

Field Type Label
machine_type string
kubernetes_version string
worker_min uint32
worker_max uint32
partition string

AssetServiceListRequest

Requests

Field Type Label
there are no fields

AssetServiceListResponse

Responses

Field Type Label
assets AssetServiceListResponse.AssetsEntry repeated

AssetsEntry

Field Type Label
key string
value Asset

Kubernetes

Field Type Label
version string

MachineType

Field Type Label
id string
name string
cpus uint32
memory uint64
storage uint64

Partition

Field Type Label
id string
name string
address string
active bool

Region

Field Type Label
id string
name string
address string
active bool
partitions Region.PartitionsEntry repeated
defaults AssetDefaults

PartitionsEntry

Field Type Label
key string
value Partition

Services

AssetService

Method List

Request Type AssetServiceListRequest

Response Type AssetServiceListResponse

Description

This Language is not supported

api/v1/cluster.proto

Messages

Cluster

Types

Field Type Label
uuid string
name string
project string
partition string
kubernetes KubernetesSpec
workers Worker repeated
maintenance Maintenance
tenant string
created_at google.protobuf.Timestamp
updated_at google.protobuf.Timestamp
deleted_at google.protobuf.Timestamp
status ClusterStatus
purpose string optional

ClusterServiceCreateRequest

Field Type Label
name string
project string
partition string
kubernetes KubernetesSpec
workers Worker repeated
maintenance Maintenance

ClusterServiceCreateResponse

Responses

Field Type Label
cluster Cluster

ClusterServiceDeleteRequest

Field Type Label
uuid string
project string

ClusterServiceDeleteResponse

Field Type Label
cluster Cluster

ClusterServiceGetCredentialsRequest

Field Type Label
uuid string
project string

ClusterServiceGetCredentialsResponse

Field Type Label
kubeconfig string

ClusterServiceGetRequest

Requests

Field Type Label
uuid string
project string

ClusterServiceGetResponse

Field Type Label
cluster Cluster

ClusterServiceListRequest

Field Type Label
project string

ClusterServiceListResponse

Field Type Label
clusters Cluster repeated

ClusterServiceUpdateRequest

Field Type Label
uuid string
project string
kubernetes KubernetesSpec optional
workers WorkerUpdate repeated
maintenance Maintenance optional

ClusterServiceUpdateResponse

Field Type Label
cluster Cluster

ClusterServiceWatchStatusRequest

Field Type Label
uuid string optional
project string

ClusterServiceWatchStatusResponse

Field Type Label
status ClusterStatus

ClusterStatus

Field Type Label
uuid string
progress uint32
state string
type string
api_server_ready string
control_plane_ready string
nodes_ready string
system_components_ready string
last_errors ClusterStatusLastError repeated

ClusterStatusLastError

Field Type Label
description string
task_id string optional
codes string repeated
last_update_time google.protobuf.Timestamp

KubernetesSpec

Field Type Label
version string

Maintenance

Field Type Label
kubernetes_autoupdate bool optional
machineimage_autoupdate bool optional
time_window MaintenanceTimeWindow

MaintenanceTimeWindow

Field Type Label
begin google.protobuf.Timestamp
duration google.protobuf.Duration

Worker

Field Type Label
name string
machine_type string
minsize uint32
maxsize uint32
maxsurge uint32
maxunavailable uint32

WorkerUpdate

Field Type Label
name string
machine_type string optional
minsize uint32 optional
maxsize uint32 optional
maxsurge uint32 optional
maxunavailable uint32 optional

Services

ClusterService

Method Create

Request Type ClusterServiceCreateRequest

Response Type ClusterServiceCreateResponse

Description

This Language is not supported

Method Get

Request Type ClusterServiceGetRequest

Response Type ClusterServiceGetResponse

Description

This Language is not supported

Method List

Request Type ClusterServiceListRequest

Response Type ClusterServiceListResponse

Description

This Language is not supported

Method WatchStatus

Request Type ClusterServiceWatchStatusRequest

Response Type ClusterServiceWatchStatusResponse

Description

This Language is not supported

Method Delete

Request Type ClusterServiceDeleteRequest

Response Type ClusterServiceDeleteResponse

Description

This Language is not supported

Method Update

Request Type ClusterServiceUpdateRequest

Response Type ClusterServiceUpdateResponse

Description

This Language is not supported

Method GetCredentials

Request Type ClusterServiceGetCredentialsRequest

Response Type ClusterServiceGetCredentialsResponse

Description

This Language is not supported

api/v1/health.proto

Enums

Service

Name Number Description
SERVICE_UNSPECIFIED 0
SERVICE_CLUSTER 1
SERVICE_VOLUME 2
SERVICE_MACHINES 3

ServiceStatus

Name Number Description
SERVICE_STATUS_UNSPECIFIED 0
SERVICE_STATUS_DEGRADED 1
SERVICE_STATUS_UNHEALTHY 2
SERVICE_STATUS_HEALTHY 3

Messages

Health

Field Type Label
services HealthStatus repeated

HealthServiceGetRequest

Field Type Label
there are no fields

HealthServiceGetResponse

Field Type Label
health Health

HealthStatus

Field Type Label
name Service
status ServiceStatus
message string
partitions HealthStatus.PartitionsEntry repeated

PartitionsEntry

Field Type Label
key string
value PartitionHealth

PartitionHealth

Field Type Label
status ServiceStatus
message string

Services

HealthService

Method Get

Request Type HealthServiceGetRequest

Response Type HealthServiceGetResponse

Description

This Language is not supported

api/v1/ip.proto

Enums

IPType

Name Number Description
IP_TYPE_UNSPECIFIED 0
IP_TYPE_EPHEMERAL 1
IP_TYPE_STATIC 2

Messages

IP

Types

Field Type Label
uuid string
ip string
name string
description string
network string
project string
type IPType
tags string repeated
created_at google.protobuf.Timestamp
updated_at google.protobuf.Timestamp
deleted_at google.protobuf.Timestamp

IPServiceAllocateRequest

Field Type Label
project string
name string
description string
tags string repeated
static bool

IPServiceAllocateResponse

Field Type Label
ip IP

IPServiceDeleteRequest

Field Type Label
uuid string
project string

IPServiceDeleteResponse

Field Type Label
ip IP

IPServiceGetRequest

Requests

Field Type Label
uuid string
project string

IPServiceGetResponse

Responses

Field Type Label
ip IP

IPServiceListRequest

Field Type Label
project string

IPServiceListResponse

Field Type Label
ips IP repeated

IPServiceStaticResponse

Field Type Label
ip IP

IPServiceUpdateRequest

Field Type Label
project string
ip IP

IPServiceUpdateResponse

Field Type Label
ip IP

Services

IPService

Method Get

Request Type IPServiceGetRequest

Response Type IPServiceGetResponse

Description

This Language is not supported

Method Allocate

Request Type IPServiceAllocateRequest

Response Type IPServiceAllocateResponse

Description

This Language is not supported

Method Update

Request Type IPServiceUpdateRequest

Response Type IPServiceUpdateResponse

Description

This Language is not supported

Method List

Request Type IPServiceListRequest

Response Type IPServiceListResponse

Description

This Language is not supported

Method Delete

Request Type IPServiceDeleteRequest

Response Type IPServiceDeleteResponse

Description

This Language is not supported

api/v1/token.proto

Messages

ProjectPermission

Field Type Label
project string
permissions string repeated

TokenRole

Field Type Label
subject string
role string

TokenServiceCreateRequest

Tokens

Field Type Label
subject string
permissions ProjectPermission repeated
roles TokenRole repeated
expires google.protobuf.Duration

TokenServiceCreateResponse

Field Type Label
token string

Services

TokenService

Method Create

Request Type TokenServiceCreateRequest

Response Type TokenServiceCreateResponse

Description

This Language is not supported

api/v1/user.proto

Messages

Organization

Field Type Label
id string
login string
name string
email string
billing_email string
avatar_url string
role Role
teams Team repeated

Team

Field Type Label
id string
name string
avatar_url string
role Role
project_id string

User

User

Field Type Label
login string
name string
email string
avatar_url string
oauth_provider OAuthProvider
organizations Organization repeated

api/v1/version.proto

Messages

Version

Field Type Label
version string
revision string
git_sha1 string
build_date string

VersionServiceGetRequest

Field Type Label
there are no fields

VersionServiceGetResponse

Field Type Label
version Version

Services

VersionService

Method Get

Request Type VersionServiceGetRequest

Response Type VersionServiceGetResponse

Description

This Language is not supported

status/v1/message.proto

Enums

MessageKind

Name Number Description
MESSAGE_KIND_UNSPECIFIED 0
MESSAGE_KIND_INFO 1
MESSAGE_KIND_INCIDENT 2
MESSAGE_KIND_CHANGE 3
MESSAGE_KIND_RESOLVED 4
MESSAGE_KIND_UPDATE 5

Messages

Message

Field Type Label
id string
text string
kind MessageKind
timestamp google.protobuf.Timestamp
replies ReplyMessage repeated

MessageServiceListRequest

Field Type Label
there are no fields

MessageServiceListResponse

Field Type Label
items Message repeated
pinned_items Message repeated

ReplyMessage

Field Type Label
id string
text string
kind MessageKind
timestamp google.protobuf.Timestamp

Services

MessageService

Method List

Request Type MessageServiceListRequest

Response Type MessageServiceListResponse

Description

This Language is not supported

status/v1/status.proto

Messages

StatusServiceGetRequest

Field Type Label
there are no fields

StatusServiceGetResponse

Field Type Label
health api.v1.Health
overall_status api.v1.ServiceStatus
connection_broken bool
api_version string

Services

StatusService

Method Get

Request Type StatusServiceGetRequest

Response Type StatusServiceGetResponse

Description

This Language is not supported

Scalar Value Types

.proto Type Go Typescript
double float64 number
float float32 number
int32 int32 number
int64 int64 number
uint32 uint32 number
uint64 uint64 number
sint32 int32 number
sint64 int64 number
fixed32 uint32 number
fixed64 uint64 number
sfixed32 int32 number
sfixed64 int64 number
bool bool boolean
string string string
bytes []byte Uint8Array