API Reference

backup.proto

Service responsible for coordinating environment backups

BackupCreateRequest

Create a backup for an environment

Field	Type	Label	Description
Environment	string		Name of the environment
MySQL	BackupCreateRequestMySQL		MySQL configuration

BackupCreateRequestMySQL

MySQL configuration when creating a backup for an environment

Field	Type	Label	Description
Policies	string	repeated	Policies to apply

BackupCreateResponse

Response containing information to get the status of a backup

Field	Type	Label	Description
ID	string		Backup identifier

BackupGetRequest

Get the current status of a backup

Field	Type	Label	Description
ID	string		Backup identifier

BackupGetResponse

Response containing the current status of the backup

Field	Type	Label	Description
Backup	BackupStatus		Backup status information

BackupListRequest

Request a list of backups for an environment

Field	Type	Label	Description
Environment	string		Environment name

BackupListResponse

A list of backups for an environment

Field	Type	Label	Description
List	BackupStatus	repeated	List of backup information

BackupStatus

Response containing the current status of the backup

Field	Type	Label	Description
Name	string		Name of the backup
phase	BackupStatus.Phase		Current phase the backup is in
StartTime	string		When the backup started
CompletionTime	string		When the backup completed
Duration	string		How long the backup took to execute
Databases	string	repeated	Databases backed up
Volumes	string	repeated	Volumes backed up

BackupStatus.Phase

Name	Number	Description
InProgress	0	Default value
Completed	1	The backup completed
Failed	2	The backup failed
Unknown	3	Backup status is unknown

backup

Method Name	Request Type	Response Type	Description
Create	BackupCreateRequest	BackupCreateResponse
Get	BackupGetRequest	BackupGetResponse
List	BackupListRequest	BackupListResponse

Top

config.proto

Service responsible for coordinating environment config

Config

Configuration object assigned to an environment

Field	Type	Label	Description
Key	string		Name of the config
Value	string		Value of the config
Secret	bool		If the config is a secret eg. API key
Type	ConfigType		Type of config

ConfigDeleteRequest

Request a config is deleted

Field	Type	Label	Description
Name	string		Name of the environment
Key	string		Name of the config

ConfigDeleteResponse

Response containing the config delete result

ConfigGetRequest

Request a single config for an environment

Field	Type	Label	Description
Name	string		Name of the environment
Key	string		Name of the config
ShowSecret	bool		If the secret value should be shown

ConfigGetResponse

Config for an environment

Field	Type	Label	Description
Config	Config		Config returned

ConfigListRequest

Request a list of all config for an environment

Field	Type	Label	Description
Name	string		Name of the environment
FilterType	ConfigType		Filter by config type
ShowSecrets	bool		If secret values should be shown

ConfigListResponse

List all config for an environment

Field	Type	Label	Description
List	Config	repeated	List of configs

ConfigSetRequest

Set config for an environment

Field	Type	Label	Description
Name	string		Name of the config
Config	Config		Config details to be set

ConfigSetResponse

Response containing the config set result

ConfigType

Name	Number	Description
None	0	Default config type
System	1	Config provided by the Skpr hosting platform
User	2	A user provided config
Overridden	3	A user provided config that overrides a system config

config

Method Name	Request Type	Response Type	Description
List	ConfigListRequest	ConfigListResponse
Get	ConfigGetRequest	ConfigGetResponse
Set	ConfigSetRequest	ConfigSetResponse
Delete	ConfigDeleteRequest	ConfigDeleteResponse

Top

cron.proto

Service responsible for coordinating environment cron

CronDetail

Cron details associated with an environmnt

Field	Type	Label	Description
Name	string		Name of the cron task
Schedule	string		How often to execute the cron task
Command	string		Command to execute
Suspended	bool		If the cron task is suspended
LastScheduleTime	string		Last time the cron was executed
LastSuccessfulTime	string		Last tim the cron was successful

CronJobDetail

Information about a cron task

Field	Type	Label	Description
Name	string		Name of cron task
phase	CronJobDetail.Phase		Phase that the cron is in
StartTime	string		Time the cron job was started
Duration	string		How long the cron job took to execute

CronJobListRequest

Request a list of cron jobs for an environment

Field	Type	Label	Description
Environment	string		Name of the environment

CronJobListResponse

List of cron jobs for an environment

Field	Type	Label	Description
List	CronJobDetail	repeated	List of cron jobs

CronListRequest

Request a list of config for an environment

Field	Type	Label	Description
Environment	string		Name of the environment

CronListResponse

Cron detail for an environment

Field	Type	Label	Description
List	CronDetail	repeated	List of cron information

CronResumeRequest

Request that cron tasks be resumed

Field	Type	Label	Description
Environment	string		Name of the environment

CronResumeResponse

Response if the cron resume was successful

CronSuspendRequest

Request that cron is suspended for an environment

Field	Type	Label	Description
Environment	string		Name of the environment

CronSuspendResponse

Response if the cron suspend was successful

CronJobDetail.Phase

Name	Number	Description
Pending	0	Default phase. Waiting to be executed.
Running	1	Job is running
Succeeded	2	Job has completed
Failed	3	Job has failed

cron

Method Name	Request Type	Response Type	Description
Suspend	CronSuspendRequest	CronSuspendResponse
Resume	CronResumeRequest	CronResumeResponse
List	CronListRequest	CronListResponse
JobList	CronJobListRequest	CronJobListResponse

Top

daemon.proto

Service responsible for coordinating environment daemons

DaemonDetail

Details about a daemon

Field	Type	Label	Description
Name	string		Name of the deamon
Command	string		Command executed to start the daemon
Suspended	bool		If the daemon is suspended

DaemonListRequest

Request a list of daemons for an environment

Field	Type	Label	Description
Environment	string		Name of the environment

DaemonListResponse

Daemon list of an environment

Field	Type	Label	Description
List	DaemonDetail	repeated	List of daemon details

DaemonResumeRequest

Request daemons are resumed for an environment

Field	Type	Label	Description
Environment	string		Name of the environment

DaemonResumeResponse

Response if resume request was sucessful

DaemonSuspendRequest

Request to suspend daemons for an environment

Field	Type	Label	Description
Environment	string		Environment name

DaemonSuspendResponse

Response if the suspend request was susccessful

daemon

Method Name	Request Type	Response Type	Description
Suspend	DaemonSuspendRequest	DaemonSuspendResponse
Resume	DaemonResumeRequest	DaemonResumeResponse
List	DaemonListRequest	DaemonListResponse

Top

environment.proto

Service responsible for coordinating environments

Cache

Environment cache configuration

Field	Type	Label	Description
Policy	string		Cache policy assigned to an environment

Cron

Environment cron configuration

Field	Type	Label	Description
Name	string		Cron task name
Command	string		Cron task command
Schedule	string		How often the cron is executed

Daemon

Environment daemon configuration

Field	Type	Label	Description
Name	string		Name of the daemon
Command	string		Command that runs the daemon

Environment

Environment configuration

Field	Type	Label	Description
Name	string		Name of the environment
type	Environment.Type		Type of environment
Production	bool		If this is a production environment
Insecure	bool		DEPRECIATED: If the environment is insecure (no read only filesystem)
Version	string		Version associated with an environment
Size	string		Size of the environment
Ingress	Ingress		Ingress configuration for routing
Image	Image		Image respository information
Cron	Cron	repeated	Cron configuration for an environment
MySQL	MySQL	repeated	MySQL configuration for an environment
SMTP	SMTP		SMTP configuration for an environment
Backup	ScheduledBackup		How often the backup is scheduled
Solr	Solr	repeated	Solr configuration for an environment
Token	string		Token assigned to an environment
Phase	string		Phase the environment is in eg. Deploying
Link	Link	repeated	Linked to other environments
Volume	Volume	repeated	Volumes associated with this environment
Dashboard	EnvironmentDashboard		Link to dashboard
Daemon	Daemon	repeated	Daemon configuration for an environment

EnvironmentCreateRequest

Create an environment

Field	Type	Label	Description
Environment	Environment		Environment configuration
Wait	bool		If this request should wait for the environment to be ready

EnvironmentCreateResponse

Response if the environment was created

Field	Type	Label	Description
Message	string		Message provided about the environment

EnvironmentDashboard

Environment dashboard configuration

Field	Type	Label	Description
URL	string		Link to dashboard

EnvironmentDeleteRequest

Delete the environment

Field	Type	Label	Description
Name	string		Name of the environment

EnvironmentDeleteResponse

Response if the environment was deleted

Field	Type	Label	Description
Status	string		Current status

EnvironmentGetRequest

Request the latest environment status

Field	Type	Label	Description
Name	string		Name of the environment

EnvironmentGetResponse

Latest environment status

Field	Type	Label	Description
Environment	Environment		Environment status

EnvironmentListRequest

Request a list of environment

EnvironmentListResponse

Returns a list of environments

Field	Type	Label	Description
Environments	Environment	repeated	List of environments

EnvironmentUpdateRequest

Update the environment

Field	Type	Label	Description
Environment	Environment		Environment configuration
Wait	bool		If this request should wait

EnvironmentUpdateResponse

Returns a message if the environment update was successful

Field	Type	Label	Description
Message	string		Message if the environment was update was successful

EnvironmentValidateFinding

Finding when validating an environment

Field	Type	Label	Description
Group	string		Group this finding relates to
type	EnvironmentValidateFinding.Type		Type of finding
Message	string		Message associated with finding

EnvironmentValidateRequest

Validate an environment

Field	Type	Label	Description
Environment	Environment		Environment configuration

EnvironmentValidateResponse

Findings when validating an environment

Field	Type	Label	Description
Findings	EnvironmentValidateFinding	repeated	Findings when validating an environment

ErrorPage

Error page configuration for an environment

Field	Type	Label	Description
Path	string		Path to error page
Cache	int64		How long to cache for

ErrorPages

List of error page configuration

Field	Type	Label	Description
Client	ErrorPage		Client error pages
Server	ErrorPage		Server error pages

Image

Image repository details

Field	Type	Label	Description
Repository	string		Repository details eg. Application/MySQL

Ingress

Ingress configuration associated with an environment

Field	Type	Label	Description
Domain	string		Domain environment should respond to
Routes	string	repeated	Routes associated with an environment
Headers	string	repeated	Depreciated.
Cookies	string	repeated	Depreciated.
Certificate	string		Certificate associated with an environment
ErrorPages	ErrorPages		Error pages configuration
Proxy	Proxy	repeated	Proxy configuration associated with an environment
mode	Ingress.Mode		The mode this CDN is configured for
LoadBalancer	string		Load balancer configuration
Cache	Cache		Cache configuration

Link

Link environment to other environment

Field	Type	Label	Description
Name	string		Name of the link
Project	string		Name of the project to link to
Environment	string		Environment name

MySQL

MySQL configuration

Field	Type	Label	Description
Name	string		Name of the database
Sanitize	MySQLImageSanitize		Sanitization configuration for MySQL
Image	MySQLImage		Image configuration for MySQL

MySQLImage

MySQL image configuration for an environment

Field	Type	Label	Description
Schedule	string		How often to build a MySQL image
Sanitize	MySQLSanitize		Sanitization rules for image building
Suspend	bool		If the MySQL image building is suspended

MySQLImageSanitize

MySQL sanitization rules

Field	Type	Label	Description
Backup	SanitizationPolicy		Rules applied to a backup
Image	SanitizationPolicy		Rules applied to an image

MySQLSanitize

MySQL image sanitization rules

Field	Type	Label	Description
Rewrite	MySQLSanitizeRewrite	repeated	Rewrite table data
NoData	string	repeated	Export tables with no data
Ignore	string	repeated	Ingore tables
Where	MySQLSanitizeWhere	repeated	Update table data

MySQLSanitizeRewrite

Database sanitize rewrite configuration

Field	Type	Label	Description
Name	string		Name of the table
Tables	MySQLSanitizeRewriteTable	repeated	How to rewrite

MySQLSanitizeRewriteTable

Database sanitize rewrite configuration

Field	Type	Label	Description
Name	string		Name of the table
Value	string		Value to rewrite

MySQLSanitizeRewriteTableSanitizationRewrite

Database sanitize rewrite configuration

Field	Type	Label	Description
Name	string		Name of the table
Value	string		Value to rewrite

MySQLSanitizeWhere

Database sanitize where configuration

Field	Type	Label	Description
Name	string		Name of the table
Value	string		Value to rewrite

Proxy

Proxy configuration

Field	Type	Label	Description
ID	string		Identifier of the proxy
Path	string		Path to proxy
Origin	string		Origin to connect to
Headers	string	repeated	Depreciated.
Cookies	string	repeated	Depreciated.
Cache	Cache		Cache configuration
Target	ProxyTarget		Internal project target

ProxyTarget

Proxy target configuration

Field	Type	Label	Description
Project	ProxyTargetProject		Name of the project
External	ProxyTargetExternal		If the target is external

ProxyTargetExternal

Proxy target external configuration

Field	Type	Label	Description
Domain	string		Domain to connect to

ProxyTargetProject

Proxy target project configuration

Field	Type	Label	Description
Name	string		Name of the project
Environment	string		Name of the environment

SMTP

SMTP environment configuration

Field	Type	Label	Description
Address	string		Address to send FROM

SanitizationPolicy

Sanitization policy configuration

Field	Type	Label	Description
Policy	string		Policy name
Rules	SanitizationRules		Rules to apply
Policies	string	repeated	Policies to apply

SanitizationRewrite

Database sanitize rewrite configuration

Field	Type	Label	Description
Name	string		Name of the table
Tables	SanitizationRewriteItem	repeated	How to rewrite

SanitizationRewriteItem

Database sanitize rewrite configuration

Field	Type	Label	Description
Name	string		Name of the table
Value	string		Value to rewrite

SanitizationRules

Ingress configuration associated with an environment

Field	Type	Label	Description
Rewrite	SanitizationRewrite	repeated	Rewrite table data
NoData	string	repeated	Export tables with no data
Ignore	string	repeated	Ingore tables
Where	SanitizationWhere	repeated	Update table data

SanitizationWhere

Database sanitize where configuration

Field	Type	Label	Description
Name	string		Name of the table
Value	string		Value to rewrite

ScheduleBackupVolume

Backup volume configuration

Field	Type	Label	Description
Name	string		Name of the volume
Exclude	bool		Exclude rules for backup
Paths	ScheduleBackupVolumePaths		Volume path configuration

ScheduleBackupVolumePaths

Backup volume configuration

Field	Type	Label	Description
Include	string	repeated	Include these paths
Exclude	string	repeated	Exclude these paths

ScheduledBackup

Environment backup schedule

Field	Type	Label	Description
Schedule	string		How often to backup
Volume	ScheduleBackupVolume	repeated	Volumes to backup
Suspend	bool		If backups as suspended

Solr

Solr configuration

Field	Type	Label	Description
Name	string		Name of the Solr instance
Version	string		Version of the Solr instance

Volume

Volume configuration

Field	Type	Label	Description
Name	string		Name of the volume
Backup	VolumeBackup		Backup configuration

VolumeBackup

Volume backup configuration

Field	Type	Label	Description
Skip	bool		Skip this volume from backups
Sanitize	VolumeBackupSanitize		Sanitize this volume

VolumeBackupSanitize

Volume backup sanitization configuration

Field	Type	Label	Description
Policies	string	repeated	Policies associated with backing up this volume
Rules	VolumeBackupSanitizeRules		Rules associated with backing up this volume

VolumeBackupSanitizeRules

Volume backup sanitization configuration

Field	Type	Label	Description
Exclude	string	repeated	Excluded paths from backup

Environment.Type

Name	Number	Description
None	0	Default environment type
Drupal	1	Environment is Drupal

EnvironmentValidateFinding.Type

Name	Number	Description
Violation	0	If this finding is a violation
Warning	1	If this finding is a warning

Ingress.Mode

Name	Number	Description
Default	0	Standard routing configuration
External	1	If the environment has an external CDN

environment

Method Name	Request Type	Response Type	Description
Delete	EnvironmentDeleteRequest	EnvironmentDeleteResponse
Get	EnvironmentGetRequest	EnvironmentGetResponse
List	EnvironmentListRequest	EnvironmentListResponse
Create	EnvironmentCreateRequest	EnvironmentCreateResponse stream
Update	EnvironmentUpdateRequest	EnvironmentUpdateResponse stream
Validate	EnvironmentValidateRequest	EnvironmentValidateResponse

Top

login.proto

Service responsible for logging into the Skpr platform

LoginGetProviderInfoRequest

Request login information for a cluster

LoginGetProviderInfoResponse

Returns login information

Field	Type	Label	Description
Cognito	LoginProviderInfoCognito		Cognito configuration

LoginProviderInfoCognito

Environment cache configuration

Field	Type	Label	Description
Region	string		Region which Congito resides
ClientID	string		Client ID for Congito
IdentityPoolID	string		Pool ID for Congito
IdentityProviderID	string		Provider ID for Congito
Issuer	string		Issuer for Congito
AuthURL	string		URL for auth
TokenURL	string		URL for token
LogoutURL	string		URL for logout

login

Method Name	Request Type	Response Type	Description
GetProviderInfo	LoginGetProviderInfoRequest	LoginGetProviderInfoResponse

Top

logs.proto

Service responsible for querying environment logs

LogListStreamsRequest

List streams for an environment

Field	Type	Label	Description
Environment	string		Name of the environment

LogListStreamsResponse

Returns a list of streams

Field	Type	Label	Description
Streams	string	repeated	Streams available for an environment
Default	string		Default stream

LogTailRequest

Start a log tailing stream

Field	Type	Label	Description
Environment	string		Name of the environment
Stream	string		Stream from an environment

LogTailResponse

Streamed message response

Field	Type	Label	Description
Message	string		Streamed message response

logs

Method Name	Request Type	Response Type	Description
Tail	LogTailRequest	LogTailResponse stream
ListStreams	LogListStreamsRequest	LogListStreamsResponse

Top

mysql.proto

Service responsible for coordinating environment MySQL

ImageCreateRequest

Create a MySQL database image

Field	Type	Label	Description
Environment	string		Environment name
Database	string		Database to create an image for
Policies	string	repeated	Policies to apply
Tag	string		Tags to apply

ImageCreateResponse

Response of image build

Field	Type	Label	Description
Images	ImageStatus	repeated	Images associated with build

ImageGetRepositoryRequest

Get repository information for environment.

Field	Type	Label	Description
Environment	string		Name of environment

ImageGetRepositoryResponse

Repository information for environment.

Field	Type	Label	Description
Repository	string

ImageGetRequest

Get MySQL image details

Field	Type	Label	Description
ID	string		ID of the image

ImageGetResponse

MySQL database image information

Field	Type	Label	Description
Mysql	ImageStatus		MySQL information

ImageListRequest

List of images for an environment

Field	Type	Label	Description
Environment	string		Name of environment

ImageListResponse

Images for an environment

Field	Type	Label	Description
List	ImageStatus	repeated	List of images

ImageStatus

Image information

Field	Type	Label	Description
ID	string		ID of the database image
phase	ImageStatus.Phase		Phase the database build is in
StartTime	string		When the database image build started
CompletionTime	string		When the database image build completed
Duration	string		How long the database image build took
Tags	string	repeated	Tags to applied to the database image

MysqlBackupCreateRequest

Create a MySQL backup

Field	Type	Label	Description
Environment	string		Environment name
DatabaseName	string		Database name

MysqlBackupCreateResponse

Returns details of MySQL backup

Field	Type	Label	Description
ID	string		ID of the backup

MysqlBackupGetRequest

Image information

Field	Type	Label	Description
ID	string		ID of the backup
DatabaseName	string		Name of the database

MysqlBackupGetResponse

Returns MySQL backup details

Field	Type	Label	Description
MysqlBackup	MysqlBackupStatus		MySQL backup details

MysqlBackupStatus

MySQL backup status

Field	Type	Label	Description
Name	string		Name of the backup
phase	MysqlBackupStatus.Phase		Phase the backup
StartTime	string		Start time of the backup
CompletionTime	string		Completion time of the backup
Duration	string		How long the backup took
Database	string		Database that was involved
BackupID	string		ID of the backup

MysqlListRequest

Request a list of MySQL databases

Field	Type	Label	Description
Environment	string		Environment name

MysqlListResponse

Returns a list of databases

Field	Type	Label	Description
List	MysqlBackupStatus	repeated	List of databsaes

MysqlRestoreCreateRequest

Create a restore

Field	Type	Label	Description
Environment	string		Name of the environment
Backup	string		Backup to use for restore
DatabaseName	string		Database name

MysqlRestoreCreateResponse

Returns a restore ID if succesful

Field	Type	Label	Description
ID	string		ID of the restore

MysqlRestoreGetRequest

Request the latest restore information

Field	Type	Label	Description
ID	string		ID of the restore

MysqlRestoreGetResponse

Returns a list of restores

Field	Type	Label	Description
MysqlRestore	MysqlRestoreStatus		Restore information

MysqlRestoreListRequest

Get a list of restores for an environment

Field	Type	Label	Description
Environment	string		Name of the environment

MysqlRestoreListResponse

Returns a list of restores

Field	Type	Label	Description
List	MysqlRestoreStatus	repeated	List of restores

MysqlRestoreStatus

Status of a restore

Field	Type	Label	Description
Name	string		Name of the database
RestoreID	string		ID of the restore
phase	MysqlRestoreStatus.Phase		Phase of the database restore
StartTime	string		Start time of the restore
CompletionTime	string		Completion time of the restore
Duration	string		Duration of the restore
Database	string		Name of the database
BackupID	string		Backup ID used during the restore

ImageStatus.Phase

Name	Number	Description
InProgress	0	Database image build is in progress
Completed	1	Database image build is complete
Failed	2	Database image failed
Unknown	3	Database image is in an unknown state

MysqlBackupStatus.Phase

Name	Number	Description
InProgress	0	Database image build is in progress
Completed	1	Database image build is complete
Failed	2	Database image failed
Unknown	3	Database image is in an unknown state

MysqlRestoreStatus.Phase

Name	Number	Description
InProgress	0	Database restore is in progress
Completed	1	Database restore is complete
Failed	2	Database restore failed
Unknown	3	Database restore is in an unknown state

mysql

Method Name	Request Type	Response Type	Description
ImageCreate	ImageCreateRequest	ImageCreateResponse
ImageGet	ImageGetRequest	ImageGetResponse
ImageList	ImageListRequest	ImageListResponse
ImageGetRepository	ImageGetRepositoryRequest	ImageGetRepositoryResponse
BackupList	MysqlListRequest	MysqlListResponse
BackupCreate	MysqlBackupCreateRequest	MysqlBackupCreateResponse
BackupGet	MysqlBackupGetRequest	MysqlBackupGetResponse
RestoreList	MysqlRestoreListRequest	MysqlRestoreListResponse
RestoreCreate	MysqlRestoreCreateRequest	MysqlRestoreCreateResponse
RestoreGet	MysqlRestoreGetRequest	MysqlRestoreGetResponse

Top

project.proto

Service responsible for coordinating projects

ProjectGetRequest

Get project information

ProjectGetResponse

Returns project information

Field	Type	Label	Description
Namespace	string
Registry	ProjectRegistry

ProjectRegistry

Project registry information

Field	Type	Label	Description
Application	string		Application registry information
MySQL	string		MySQL registry information

project

Method Name	Request Type	Response Type	Description
Get	ProjectGetRequest	ProjectGetResponse

Top

purge.proto

Service responsible for coordinating environment purge requests

PurgeCreateRequest

Create a purge request

Field	Type	Label	Description
Environment	string
Paths	string	repeated

PurgeCreateResponse

Returns purge request ID if successful

Field	Type	Label	Description
ID	string		ID of the purge request

PurgeListRequest

List all purge requests

Field	Type	Label	Description
Environment	string		Name of the environment

PurgeListResponse

Returns a list of all purge requests

Field	Type	Label	Description
Requests	RequestSummary	repeated	Lis of requests

RequestSummary

Purge request summary

Field	Type	Label	Description
ID	string		ID of the request
Created	string		When the request was created
Paths	string	repeated	Paths that the request included
Status	string		Status of the request

purge

Method Name	Request Type	Response Type	Description
Create	PurgeCreateRequest	PurgeCreateResponse
List	PurgeListRequest	PurgeListResponse

Top

release.proto

Service responsible for coordinating releases

ReleaseCreateRequest

Create a release

Field	Type	Label	Description
Name	string		Name of the release
Images	ReleaseImage	repeated	Images associated with the release
SignedBy	string		Release signed by

ReleaseCreateResponse

Returns when a release creation is successful

ReleaseImage

Image associated with a release

Field	Type	Label	Description
Name	string		Name of the release image
URI	string		URI of the release image

ReleaseInfoRequest

Get release information

Field	Type	Label	Description
Name	string		Name of the release

ReleaseInfoResponse

Returns release information

Field	Type	Label	Description
Date	string		Date the release was created
Images	ReleaseImage	repeated	Images associated with a release
Environments	string	repeated	Environments associated with a release

ReleaseListItem

Release listed item

Field	Type	Label	Description
Name	string		Name of the release
Date	string		Creation date of the release
Images	ReleaseImage	repeated	Images associated with the release
Environments	string	repeated	Environments associated with the release

ReleaseListRequest

List releases

ReleaseListResponse

Returns a list of releases

Field	Type	Label	Description
Items	ReleaseListItem	repeated	List of releases

ReleaseSignerInfoRequest

Request signer information

ReleaseSignerInfoResponse

Returns signer information

Field	Type	Label	Description
Identifier	string		Identifier for the signer

release

Method Name	Request Type	Response Type	Description
Create	ReleaseCreateRequest	ReleaseCreateResponse
Info	ReleaseInfoRequest	ReleaseInfoResponse
List	ReleaseListRequest	ReleaseListResponse
SignerInfo	ReleaseSignerInfoRequest	ReleaseSignerInfoResponse

Top

restore.proto

Service responsible for coordinating environment restores

RestoreCreateRequest

Create a restore request

Field	Type	Label	Description
Environment	string		Environment name
Backup	string		Backup identifier

RestoreCreateResponse

Returns an ID if the restore creation was successful

Field	Type	Label	Description
ID	string		ID of the restore

RestoreGetRequest

Get the latest information for a restore

Field	Type	Label	Description
ID	string		ID of the restore

RestoreGetResponse

Returns restore information

Field	Type	Label	Description
Restore	RestoreStatus

RestoreListRequest

List restores for an environment

Field	Type	Label	Description
Environment	string		Environment name

RestoreListResponse

Returns a list of restores

Field	Type	Label	Description
List	RestoreStatus	repeated

RestoreStatus

Restore status information

Field	Type	Label	Description
Name	string		Name of the restore
Backup	string		Backup used for the restore
phase	RestoreStatus.Phase		Phase of the restore
StartTime	string		When the restore was started
CompletionTime	string		When the restore was completed
Duration	string		How long the restore took to complete
Databases	string	repeated	Databases associated with the restore
Volumes	string	repeated	Volumes associated with the restore

RestoreStatus.Phase

Name	Number	Description
InProgress	0	Default value
Completed	1	The backup completed
Failed	2	The backup failed
Unknown	3	Backup status is unknown

restore

Method Name	Request Type	Response Type	Description
Create	RestoreCreateRequest	RestoreCreateResponse
Get	RestoreGetRequest	RestoreGetResponse
List	RestoreListRequest	RestoreListResponse

Top

version.proto

Service responsible for version information

VersionGetRequest

Get the cluster version

VersionGetResponse

Returns the cluster version

Field	Type	Label	Description
Version	string		Version number
BuildDate	string		When this version was built

version

Method Name	Request Type	Response Type	Description
Get	VersionGetRequest	VersionGetResponse

Top

volume.proto

Service responsible for coordinating environment volumes

VolumeBackupCreateRequest

Create a volume backup

Field	Type	Label	Description
Environment	string		Environment name
VolumeName	string		Volume name

VolumeBackupCreateResponse

Returns a volume backup ID

Field	Type	Label	Description
ID	string

VolumeBackupGetRequest

Get the latest volume backup information

Field	Type	Label	Description
ID	string		ID of the backup

VolumeBackupGetResponse

Returns the latest backup information

Field	Type	Label	Description
VolumeBackup	VolumeBackupStatus		Backup status

VolumeBackupListRequest

List volumes backups for an environment

Field	Type	Label	Description
Environment	string		Environment name

VolumeBackupListResponse

Returns list of volume backups

Field	Type	Label	Description
List	VolumeBackupStatus	repeated	List of volume backups

VolumeBackupStatus

Backup status information

Field	Type	Label	Description
Name	string		Name of the volume backup
phase	VolumeBackupStatus.Phase		Phase that the volume backup is in
StartTime	string		When the volume backup started
CompletionTime	string		When the volume backup completed
Duration	string		How long the volume backup took to finish
Volume	string		Volumes associated with backup
BackupID	string		ID of the volume backup

VolumeRestoreCreateRequest

Create a volume restore

Field	Type	Label	Description
Environment	string		Environment name
Backup	string		Backup name
VolumeName	string		Volume name

VolumeRestoreCreateResponse

Returns the ID of the created restore

Field	Type	Label	Description
ID	string

VolumeRestoreGetRequest

Get the latest backup information

Field	Type	Label	Description
ID	string		ID of the restore

VolumeRestoreGetResponse

Returns the volume restore status

Field	Type	Label	Description
VolumeRestore	VolumeRestoreStatus		Restore status

VolumeRestoreListRequest

List volume restores for an environment

Field	Type	Label	Description
Environment	string		Environment name

VolumeRestoreListResponse

Returns a list of volume restores

Field	Type	Label	Description
List	VolumeRestoreStatus	repeated	Volume restores

VolumeRestoreStatus

Volume restore status information

Field	Type	Label	Description
Name	string		Name of the restore
RestoreID	string		ID used for volume restore
phase	VolumeRestoreStatus.Phase		Phase that the volume backup is in
StartTime	string		When the volume backup started
CompletionTime	string		When the volume backup completed
Duration	string		How long the volume backup took to finish
VolumeName	string		Name of the volume
BackupID	string		ID of the backup used

VolumeBackupStatus.Phase

Name	Number	Description
InProgress	0	Default value
Completed	1	The backup completed
Failed	2	The backup failed
Unknown	3	Backup status is unknown

VolumeRestoreStatus.Phase

Name	Number	Description
InProgress	0	Default value
Completed	1	The backup completed
Failed	2	The backup failed
Unknown	3	Backup status is unknown

volume

Method Name	Request Type	Response Type	Description
BackupList	VolumeBackupListRequest	VolumeBackupListResponse
RestoreList	VolumeRestoreListRequest	VolumeRestoreListResponse
BackupCreate	VolumeBackupCreateRequest	VolumeBackupCreateResponse
BackupGet	VolumeBackupGetRequest	VolumeBackupGetResponse
RestoreCreate	VolumeRestoreCreateRequest	VolumeRestoreCreateResponse
RestoreGet	VolumeRestoreGetRequest	VolumeRestoreGetResponse

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)