Default package

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc AbortRelease (AbortBlockReleaseRequest, google.protobuf.Empty)

  coreapi.proto:202

  message AbortBlockReleaseRequest

  coreapi.proto:136

  • string blockName = 1

  • string releaseId = 2

  • string envId = 3

• rpc CheckCustomDomainName (CustomDomainNameRequest, CheckCustomDomainNameResponse)

  coreapi.proto:221

  message CheckCustomDomainNameResponse

  coreapi.proto:118

  • bool isCNAMEOK = 1

  • string CNAMEWanted = 2

  • string CNAMEFound = 3

  • bool isCertificateReady = 4

• rpc CreateBlock (CreateBlockRequest, BlockUpdateResponse)

  coreapi.proto:192

  message CreateBlockRequest

  coreapi.proto:25

  • string envId = 1

  • string name = 2

  • optional RunConfig runConfig = 3

  • optional BuildConfig buildConfig = 4

• rpc CreateCustomDomainName (CustomDomainNameRequest, google.protobuf.Empty)

  coreapi.proto:219

• rpc CreateEnvironment (CreateEnvironmentRequest, Environment)

  coreapi.proto:188

  message CreateEnvironmentRequest

  coreapi.proto:12

  • string name = 1

• rpc DeleteBlock (DeleteBlockRequest, google.protobuf.Empty)

  coreapi.proto:198

  message DeleteBlockRequest

  coreapi.proto:55

  • string envId = 1

  • string name = 2

• rpc DeleteCustomDomainName (CustomDomainNameRequest, google.protobuf.Empty)

  coreapi.proto:220

• rpc DeleteEnvironment (DeleteEnvironmentRequest, google.protobuf.Empty)

  coreapi.proto:190

  message DeleteEnvironmentRequest

  coreapi.proto:21

  • string id = 1

• rpc DeployBlockUpdate (DeployBlockRequest, BlockUpdateResponse)

  coreapi.proto:193

  message DeployBlockRequest

  coreapi.proto:32

  • string envId = 1

  • string name = 2

  • optional RunConfig runConfig = 3

  • optional BuildConfig buildConfig = 4

  • string baseReleaseId = 5

• rpc DisablePublicURL (DisablePublicURLRequest, google.protobuf.Empty)

  coreapi.proto:224

  message DisablePublicURLRequest

  coreapi.proto:131

  • string blockName = 1

  • string envId = 2

• rpc EnablePublicURL (EnablePublicURLRequest, google.protobuf.Empty)

  coreapi.proto:223

  message EnablePublicURLRequest

  coreapi.proto:125

  • string blockName = 1

  • string envId = 2

  • string releaseId = 3

• rpc GenReleaseConfigFromKintoFile (GenReleaseConfigFromKintoFileRepoRequest, ReleaseConfig)

  coreapi.proto:206

  message GenReleaseConfigFromKintoFileRepoRequest

  coreapi.proto:166

  • Block.Type blockType = 1

  • string org = 2

  • string repo = 3

  • string branch = 4

  • string envId = 5

  • string githubUserToken = 6

  message ReleaseConfig

  models.proto:307

  • optional BuildConfig buildConfig = 1

  • optional RunConfig runConfig = 2

• rpc GetBlock (BlockQueryRequest, Block)

  coreapi.proto:197

• rpc GetBlocks (BlockQueryRequest, Blocks)

  coreapi.proto:196

  message Blocks

  models.proto:41

  • repeated Block items = 1

• rpc GetEnvironment (EnvironmentQueryRequest, Environment)

  coreapi.proto:186

• rpc GetEnvironments (google.protobuf.Empty, Environments)

  coreapi.proto:187

  message Environments

  models.proto:12

  • repeated Environment items = 1

• rpc GetKintoConfiguration (google.protobuf.Empty, KintoConfiguration)

  coreapi.proto:217

  message KintoConfiguration

  models.proto:272

  • repeated Language languages = 1

  • optional MemoryOptions memoryOptions = 2

  • optional CPUOptions cpuOptions = 3

  • optional TimeoutOptions timeoutOptions = 4

  • optional AutoScalingOptions autoScalingOptions = 5

  • optional TimeoutOptions jobTimeoutOptions = 6

• rpc KillBlockInstance (KillBlockInstanceRequest, google.protobuf.Empty)

  coreapi.proto:201

  message KillBlockInstanceRequest

  coreapi.proto:99

  • string id = 1

  • string envId = 2

• rpc PromoteRelease (PromoteReleaseRequest, google.protobuf.Empty)

  coreapi.proto:204

  message PromoteReleaseRequest

  coreapi.proto:158

  • string envId = 1

  • string blockName = 2

  • string tag = 3

  • string releaseId = 4

  • string targetEnvId = 5

• rpc RollbackBlock (RollbackBlockRequest, BlockUpdateResponse)

  coreapi.proto:195

  message RollbackBlockRequest

  coreapi.proto:104

  • string name = 1

  • string envId = 2

  • string releaseId = 3

• rpc StartTeleport (TeleportRequest, stream TeleportResponse)

  coreapi.proto:226

  message TeleportRequest

  coreapi.proto:142

  • string envId = 1

  • string blockName = 2

  message TeleportResponse

  coreapi.proto:147

  • optional TeleportServiceData data = 1

• rpc SuspendBlock (SuspendBlockRequest, BlockUpdateResponse)

  coreapi.proto:199

  message SuspendBlockRequest

  coreapi.proto:45

  • string envId = 1

  • string name = 2

• rpc SyncTime (SyncTimeRequest, SyncTimeResponse)

  coreapi.proto:228

  message SyncTimeRequest

  coreapi.proto:175

  • int64 sendTimeMs = 1

  message SyncTimeResponse

  coreapi.proto:179

  • int64 clientTimestampMs = 1

  • int64 serverTimestampMs = 2

• rpc TagRelease (TagReleaseRequest, google.protobuf.Empty)

  coreapi.proto:203

  message TagReleaseRequest

  coreapi.proto:151

  • string blockName = 1

  • string releaseId = 2

  • string envId = 3

  • string tag = 4

• rpc TriggerDeploy (TriggerDeployRequest, BlockUpdateResponse)

  coreapi.proto:194

  message TriggerDeployRequest

  coreapi.proto:40

  • string envId = 1

  • string name = 2

• rpc UpdateBuildCommitSha (UpdateBuildCommitShaRequest, google.protobuf.Empty)

  coreapi.proto:210

  message UpdateBuildCommitShaRequest

  coreapi.proto:92

  • string blockName = 1

  • string envId = 2

  • string releaseId = 3

  • string commitSha = 4

• rpc UpdateBuildStatus (UpdateBuildStatusRequest, UpdateBuildStatusResponse)

  coreapi.proto:209

  message UpdateBuildStatusRequest

  coreapi.proto:76

  • string blockName = 1

  • string envId = 2

  • string releaseId = 3

  • optional BuildStatus status = 5

  message UpdateBuildStatusResponse

  coreapi.proto:88

  • string id = 1

• rpc UpdateEnvironment (UpdateEnvironmentRequest, Environment)

  coreapi.proto:189

  message UpdateEnvironmentRequest

  coreapi.proto:16

  • string id = 1

  • string name = 2

• rpc WatchBlocksHealthStatuses (EnvironmentQueryRequest, stream BlockStatuses)

  coreapi.proto:211

  message BlockStatuses

  models.proto:198

  • repeated BlockStatus blockStatuses = 1

• rpc WatchBlocksMetrics (BlockQueryRequest, stream BlocksMetrics)

  coreapi.proto:213

  message BlocksMetrics

  models.proto:241

  • map<string, BlockMetrics> blocks = 1

• rpc WatchBuildLogs (WatchBuildLogsRequest, stream Logs)

  coreapi.proto:208

  message WatchBuildLogsRequest

  coreapi.proto:65

  • string releaseId = 1

  • string blockName = 2

  • string envId = 3

• rpc WatchConsoleLogs (WatchConsoleLogsRequest, stream ConsoleLog)

  coreapi.proto:215

  message WatchConsoleLogsRequest

  coreapi.proto:71

  • string blockName = 1

  • string envId = 2

  message ConsoleLog

  models.proto:178

  • string instanceName = 1

  • bytes data = 2

• rpc WatchJobsStatus (BlockQueryRequest, stream JobStatus)

  coreapi.proto:212

  message JobStatus

  models.proto:285

  • string instanceName = 1

  • JobStatus.State state = 2

  • int64 startTimestamp = 3

  • int64 endTimestamp = 4

• rpc WatchReleasesStatus (BlockQueryRequest, stream ReleasesStatus)

  coreapi.proto:200

  message ReleasesStatus

  models.proto:152

  • string blockName = 1

  • string envId = 2

  • map<string, Status> releases = 3

• rpc AbortRelease (AbortReleaseRequest, google.protobuf.Empty)

  workflowapi.proto:59

  message AbortReleaseRequest

  workflowapi.proto:48

  • string buildId = 1

    TODO: Rename to workflow id one day

  • string envId = 2

• rpc BuildAndDeployRelease (BuildAndDeployRequest, WorkflowResponse)

  workflowapi.proto:54

  message BuildAndDeployRequest

  workflowapi.proto:12

  • optional BuildConfig buildConfig = 1

  • string blockName = 2

  • string releaseId = 3

  • string namespace = 4

  • bool isStaticBuild = 5

• rpc DeployRelease (DeployRequest, WorkflowResponse)

  workflowapi.proto:55

  message DeployRequest

  workflowapi.proto:20

  • string blockName = 1

  • string releaseId = 2

  • string namespace = 3

• rpc DeployReleaseFromCatalog (DeployCatalogRequest, WorkflowResponse)

  workflowapi.proto:56

  message DeployCatalogRequest

  workflowapi.proto:26

  • string blockName = 1

  • string releaseId = 2

  • string namespace = 3

  • optional Repository repo = 4

• rpc GetWorkflowLogs (WorkflowLogsRequest, Logs)

  workflowapi.proto:61

• rpc SuspendRelease (SuspendRequest, WorkflowResponse)

  workflowapi.proto:58

  message SuspendRequest

  workflowapi.proto:38

  • string blockName = 1

  • string namespace = 2

  • string releaseId = 3

• rpc UndeployRelease (UndeployRequest, WorkflowResponse)

  workflowapi.proto:57

  message UndeployRequest

  workflowapi.proto:33

  • string blockName = 1

  • string namespace = 2

• rpc WatchWorkflowLogs (WorkflowLogsRequest, stream Logs)

  workflowapi.proto:62

Used in: RunConfig

• int32 min = 1

• int32 max = 2

• int32 cpuPercent = 3

Used in: KintoConfiguration

• int32 defaultMinValue = 1

• int32 defaultMaxValue = 2

• repeated int32 values = 3

Used as response type in: KintoCoreService.GetBlock

Used as field type in: Blocks

• string id = 1

• string name = 2

• string envId = 3

• string displayName = 4

• map<string, Release> releases = 5

• repeated string customDomains = 6

• bool isPublicURL = 7

• string parentBlockName = 8

• string parentBlockEnvId = 9

Used in: GenReleaseConfigFromKintoFileRepoRequest, RunConfig

• NOT_SET = 0

• BACKEND_API = 1

• STATIC_SITE = 2

• WEB_APP = 3

• JAMSTACK = 4

• JOB = 5

• CRON_JOB = 6

• WORKER = 7

• CATALOG = 8

• HELM = 9

Used in: BlockMetrics

• string name = 1

• string releaseId = 2

• int64 cpuRequests = 3

• int64 cpuUsage = 4

• int64 memRequests = 5

• int64 memUsage = 6

• int32 restarts = 7

• BlockInstance.State state = 8

Used in: BlockInstance

• NOT_SET = 0

• RUNNING = 1

• COMPLETED = 2

• ERROR = 3

• OOM_KILLED = 4

Used in: BlocksMetrics

• string blockName = 1

• string envId = 2

• map<string, BlockInstance> instances = 3

• map<string, BlockStorage> storages = 5

Used as request type in: KintoCoreService.GetBlock, KintoCoreService.GetBlocks, KintoCoreService.WatchBlocksMetrics, KintoCoreService.WatchJobsStatus, KintoCoreService.WatchReleasesStatus

• string envId = 1

• string name = 2

Used in: BlockStatuses

• string blockName = 1

• string envId = 2

• string releaseId = 3

• BlockStatus.State state = 7

Used in: BlockStatus

• NOT_SET = 0

• HEALTHY = 1

• UNHEALTHY = 2

• SUSPENDED = 3

• SLEEPING = 4

the main difference between mountedCapacityInBytes and capacityInBytes is capacityInBytes will return a neat figure (coz it is the k8s PVC request) while mountedCapacityInBytes will be in bytes format at os level (so it will never be 1GB but sth like 0.98 GB)

Used in: BlockMetrics

• string name = 1

• int64 capacityInBytes = 2

  this is from the k8s PVC

• string usagePercent = 3

• string mountPath = 4

• string instanceId = 5

• int64 mountedUsageInBytes = 6

• int64 mountedCapacityInBytes = 7

  this is from the `df` command result -> not

Used as response type in: KintoCoreService.CreateBlock, KintoCoreService.DeployBlockUpdate, KintoCoreService.RollbackBlock, KintoCoreService.SuspendBlock, KintoCoreService.TriggerDeploy

• string name = 1

• string releaseId = 2

Used in: BuildAndDeployRequest, CreateBlockRequest, DeployBlockRequest, Release, ReleaseConfig

• string id = 1

• string image = 2

• BuildConfig.Language language = 3

• string languageVersion = 4

• string buildCommand = 5

• string runCommand = 6

• string pathToCode = 7

• string pathToStaticOutput = 11

• string dockerfileFileName = 8

• map<string, string> buildArgs = 9

• optional Repository repository = 10

Used in: BuildConfig, Language

• NOT_SET = 0

• DOCKERFILE = 1

• GOLANG = 2

• NODEJS = 3

• PYTHON = 4

• JAVA = 5

• RUBY = 6

• PHP = 7

• RUST = 8

• ELIXIR = 9

Used in: UpdateBuildStatusRequest, UpdateBuildStepRequest

• BuildStatus.State state = 1

• optional google.protobuf.Timestamp startTime = 2

• optional google.protobuf.Timestamp finishTime = 3

Used in: BuildStatus

• NOT_SET = 0

• UNKNOWN = 1

• QUEUED = 2

• WORKING = 3

• SUCCESS = 4

• FAILURE = 5

• INTERNAL_ERROR = 6

• TIMEOUT = 7

• CANCELLED = 8

• EXPIRED = 9

Used in: KintoConfiguration

• float defaultValue = 1

• repeated float values = 2

Used as request type in: KintoCoreService.CheckCustomDomainName, KintoCoreService.CreateCustomDomainName, KintoCoreService.DeleteCustomDomainName

• string envId = 1

• string blockName = 2

• string customDomainName = 3

• string CNAME = 4

• RunConfig.Protocol protocol = 5

Used as response type in: KintoCoreService.CreateEnvironment, KintoCoreService.GetEnvironment, KintoCoreService.UpdateEnvironment

Used as field type in: Environments

• string id = 1

• string name = 2

Used as request type in: KintoCoreService.GetEnvironment, KintoCoreService.WatchBlocksHealthStatuses

• string id = 1

Used in: RunConfig

• string cronPattern = 1

• int32 timeoutInSec = 2

Used in: JobStatus

• NOT_SET = 0

• PENDING = 1

• RUNNING = 2

• COMPLETED = 3

• DELETED = 4

• ERROR = 5

• OOM_KILLED = 6

Used in: KintoConfiguration

• BuildConfig.Language language = 1

• string image = 2

• map<string, string> versionsTags = 3

Used as response type in: KintoCoreService.WatchBuildLogs, WorkflowAPIService.GetWorkflowLogs, WorkflowAPIService.WatchWorkflowLogs

• bytes data = 1

Used in: KintoConfiguration

• int32 defaultValue = 1

• repeated int32 values = 2

Used in: Block

• string id = 1

• optional google.protobuf.Timestamp createdAt = 2

• optional BuildConfig buildConfig = 3

• optional RunConfig runConfig = 4

• optional Status status = 5

• optional google.protobuf.Timestamp startedAt = 6

• optional google.protobuf.Timestamp endedAt = 7

• Release.Type type = 8

• repeated string tags = 9

• string commitSha = 10

Used in: Release

• NOT_SET = 0

• DEPLOY = 1

• UNDEPLOY = 2

• SUSPEND = 3

• ROLLBACK = 4

Used in: BuildConfig, DeployCatalogRequest

• string url = 1

• string accessToken = 2

• string branch = 3

• string githubInstallationId = 4

• string githubUserToken = 5

Used in: RunConfig

• int32 memoryInMB = 1

• float cpuInCore = 2

Used in: CreateBlockRequest, DeployBlockRequest, Release, ReleaseConfig

• Block.Type type = 1

• string port = 2

• optional AutoScaling autoScaling = 3

• map<string, string> envVars = 4

• optional Resources resources = 5

• int32 timeoutInSec = 6

• optional JobSpec jobSpec = 7

• string host = 8

• bool costOptimizationEnabled = 9

• bool sleepModeEnabled = 10

• RunConfig.Protocol protocol = 11

• int32 sleepModeTTLSeconds = 12

Used in: CustomDomainNameRequest, RunConfig

• NOT_SET = 0

• HTTP = 1

• GRPC = 2

Used in: Release, ReleasesStatus

• Status.State state = 2

Used in: Status

• NOT_SET = 0

• FAIL = 1

• SUCCESS = 2

• RUNNING = 3

• PENDING = 4

• ABORTED = 5

• REVIEW_DEPLOY = 6

Used in: TeleportResponse

• string host = 1

• string credentials = 2

Used in: KintoConfiguration

• int32 defaultValue = 1

• repeated int32 values = 2

• string name = 1

• optional BuildStatus status = 2

Used as request type in: WorkflowAPIService.GetWorkflowLogs, WorkflowAPIService.WatchWorkflowLogs

• string buildId = 1

Used as response type in: WorkflowAPIService.BuildAndDeployRelease, WorkflowAPIService.DeployRelease, WorkflowAPIService.DeployReleaseFromCatalog, WorkflowAPIService.SuspendRelease, WorkflowAPIService.UndeployRelease

• string id = 1