Skip to content

API Reference

Kiteploy uses ConnectRPC for its API. All services are accessible via HTTP/2 and gRPC.

Base URL

https://api.kiteploy.com

Authentication

Include your API key in the Authorization header:

curl -H "Authorization: Bearer kp_live_xxxxxxxxxxxx" \
  https://api.kiteploy.com/workspace.v1.WorkspaceService/ListWorkspaces

Services

Service Endpoint
Auth /auth.v1.AuthService
Workspaces /workspace.v1.WorkspaceService
Containers /container.v1.ContainerService
Projects /project.v1.ProjectService
VMs /vm.v1.VMService
Databases /database.v1.DatabaseService
Networks /network.v1.NetworkService
Domains /routing.v1.RoutingService

Example: List Workspaces

curl -X POST \
  -H "Authorization: Bearer $KITE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  https://api.kiteploy.com/workspace.v1.WorkspaceService/ListWorkspaces

const response = await fetch(
  'https://api.kiteploy.com/workspace.v1.WorkspaceService/ListWorkspaces',
  {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${apiKey}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({}),
  }
);
const data = await response.json();

import requests

response = requests.post(
    "https://api.kiteploy.com/workspace.v1.WorkspaceService/ListWorkspaces",
    headers={"Authorization": f"Bearer {api_key}"},
    json={},
)
data = response.json()

WebSocket Events

Real-time events are available via WebSocket:

wss://api.kiteploy.com/ws/workspaces

Event types: WorkspaceCreated, WorkspaceStarted, WorkspaceStopped, WorkspaceDeleted, ExecutionCompleted, ExecutionFailed.