diff --git a/docs.json b/docs.json
index 2b076f2..10cd1ce 100644
--- a/docs.json
+++ b/docs.json
@@ -215,7 +215,13 @@
"pages": [
"/phala-cloud/phala-cloud-cli/deploy",
"/phala-cloud/phala-cloud-cli/instance-types",
- "/phala-cloud/phala-cloud-cli/nodes",
+ {
+ "group": "nodes",
+ "pages": [
+ "/phala-cloud/phala-cloud-cli/nodes",
+ "/phala-cloud/phala-cloud-cli/nodes/list"
+ ]
+ },
"/phala-cloud/phala-cloud-cli/os-images"
]
},
@@ -223,11 +229,63 @@
"group": "Manage",
"pages": [
"/phala-cloud/phala-cloud-cli/apps",
- "/phala-cloud/phala-cloud-cli/cvms",
- "/phala-cloud/phala-cloud-cli/envs",
+ {
+ "group": "instances",
+ "pages": [
+ "/phala-cloud/phala-cloud-cli/instances",
+ "/phala-cloud/phala-cloud-cli/instances/ls",
+ "/phala-cloud/phala-cloud-cli/instances/add",
+ "/phala-cloud/phala-cloud-cli/instances/rm"
+ ]
+ },
+ {
+ "group": "cvms",
+ "pages": [
+ "/phala-cloud/phala-cloud-cli/cvms",
+ "/phala-cloud/phala-cloud-cli/cvms/attestation",
+ "/phala-cloud/phala-cloud-cli/cvms/create",
+ "/phala-cloud/phala-cloud-cli/cvms/delete",
+ "/phala-cloud/phala-cloud-cli/cvms/device-allowlist",
+ "/phala-cloud/phala-cloud-cli/cvms/get",
+ "/phala-cloud/phala-cloud-cli/cvms/list",
+ "/phala-cloud/phala-cloud-cli/cvms/list-nodes",
+ "/phala-cloud/phala-cloud-cli/cvms/logs",
+ "/phala-cloud/phala-cloud-cli/cvms/replicate",
+ "/phala-cloud/phala-cloud-cli/cvms/resize",
+ "/phala-cloud/phala-cloud-cli/cvms/restart",
+ "/phala-cloud/phala-cloud-cli/cvms/serial-logs",
+ "/phala-cloud/phala-cloud-cli/cvms/start",
+ "/phala-cloud/phala-cloud-cli/cvms/stop",
+ "/phala-cloud/phala-cloud-cli/cvms/upgrade"
+ ]
+ },
+ {
+ "group": "envs",
+ "pages": [
+ "/phala-cloud/phala-cloud-cli/envs",
+ "/phala-cloud/phala-cloud-cli/envs/encrypt",
+ "/phala-cloud/phala-cloud-cli/envs/update"
+ ]
+ },
"/phala-cloud/phala-cloud-cli/link",
- "/phala-cloud/phala-cloud-cli/simulator",
- "/phala-cloud/phala-cloud-cli/ssh-keys"
+ {
+ "group": "simulator",
+ "pages": [
+ "/phala-cloud/phala-cloud-cli/simulator",
+ "/phala-cloud/phala-cloud-cli/simulator/start",
+ "/phala-cloud/phala-cloud-cli/simulator/stop"
+ ]
+ },
+ {
+ "group": "ssh-keys",
+ "pages": [
+ "/phala-cloud/phala-cloud-cli/ssh-keys",
+ "/phala-cloud/phala-cloud-cli/ssh-keys/list",
+ "/phala-cloud/phala-cloud-cli/ssh-keys/add",
+ "/phala-cloud/phala-cloud-cli/ssh-keys/remove",
+ "/phala-cloud/phala-cloud-cli/ssh-keys/import-github"
+ ]
+ }
]
},
{
@@ -245,7 +303,15 @@
"pages": [
"/phala-cloud/phala-cloud-cli/login",
"/phala-cloud/phala-cloud-cli/logout",
- "/phala-cloud/phala-cloud-cli/profiles",
+ {
+ "group": "profiles",
+ "pages": [
+ "/phala-cloud/phala-cloud-cli/profiles",
+ "/phala-cloud/phala-cloud-cli/profiles/use",
+ "/phala-cloud/phala-cloud-cli/profiles/rename",
+ "/phala-cloud/phala-cloud-cli/profiles/delete"
+ ]
+ },
"/phala-cloud/phala-cloud-cli/status",
"/phala-cloud/phala-cloud-cli/switch",
"/phala-cloud/phala-cloud-cli/whoami"
@@ -254,19 +320,70 @@
{
"group": "Advanced",
"pages": [
- "/phala-cloud/phala-cloud-cli/allow-devices",
+ {
+ "group": "allow-devices",
+ "pages": [
+ "/phala-cloud/phala-cloud-cli/allow-devices",
+ "/phala-cloud/phala-cloud-cli/allow-devices/list",
+ "/phala-cloud/phala-cloud-cli/allow-devices/add",
+ "/phala-cloud/phala-cloud-cli/allow-devices/remove",
+ "/phala-cloud/phala-cloud-cli/allow-devices/allow-any",
+ "/phala-cloud/phala-cloud-cli/allow-devices/disallow-any",
+ "/phala-cloud/phala-cloud-cli/allow-devices/toggle-allow-any"
+ ]
+ },
"/phala-cloud/phala-cloud-cli/api",
"/phala-cloud/phala-cloud-cli/completion",
- "/phala-cloud/phala-cloud-cli/kms",
- "/phala-cloud/phala-cloud-cli/self"
+ {
+ "group": "kms",
+ "pages": [
+ "/phala-cloud/phala-cloud-cli/kms",
+ "/phala-cloud/phala-cloud-cli/kms/list",
+ "/phala-cloud/phala-cloud-cli/kms/ethereum",
+ "/phala-cloud/phala-cloud-cli/kms/base"
+ ]
+ },
+ {
+ "group": "self",
+ "pages": [
+ "/phala-cloud/phala-cloud-cli/self",
+ "/phala-cloud/phala-cloud-cli/self/update"
+ ]
+ }
]
},
{
"group": "Deprecated",
"pages": [
- "/phala-cloud/phala-cloud-cli/auth",
- "/phala-cloud/phala-cloud-cli/config",
- "/phala-cloud/phala-cloud-cli/docker"
+ {
+ "group": "auth",
+ "pages": [
+ "/phala-cloud/phala-cloud-cli/auth",
+ "/phala-cloud/phala-cloud-cli/auth/login",
+ "/phala-cloud/phala-cloud-cli/auth/logout",
+ "/phala-cloud/phala-cloud-cli/auth/status"
+ ]
+ },
+ {
+ "group": "config",
+ "pages": [
+ "/phala-cloud/phala-cloud-cli/config",
+ "/phala-cloud/phala-cloud-cli/config/get",
+ "/phala-cloud/phala-cloud-cli/config/list",
+ "/phala-cloud/phala-cloud-cli/config/set"
+ ]
+ },
+ {
+ "group": "docker",
+ "pages": [
+ "/phala-cloud/phala-cloud-cli/docker",
+ "/phala-cloud/phala-cloud-cli/docker/login",
+ "/phala-cloud/phala-cloud-cli/docker/build",
+ "/phala-cloud/phala-cloud-cli/docker/push",
+ "/phala-cloud/phala-cloud-cli/docker/generate",
+ "/phala-cloud/phala-cloud-cli/docker/run"
+ ]
+ }
]
}
]
@@ -397,6 +514,7 @@
"/phala-cloud/references/overview",
{
"group": "Phala Cloud API",
+ "openapi": "openapi.json",
"pages": [
"/phala-cloud/phala-cloud-api/overview",
"/phala-cloud/phala-cloud-api/attestations",
@@ -408,12 +526,16 @@
"GET /api/v1/apps/filter-options",
"GET /api/v1/apps/{app_id}",
"GET /api/v1/apps/{app_id}/attestations",
+ "GET /api/v1/apps/{app_id}/attestations/tcb-evaluation",
"GET /api/v1/apps/{app_id}/cvms",
"POST /api/v1/apps/{app_id}/cvms/is-allowed",
"POST /api/v1/apps/{app_id}/cvms/{vm_uuid}/replicas",
+ "POST /api/v1/apps/{app_id}/instances",
"GET /api/v1/apps/{app_id}/device-allowlist",
- "GET /api/v1/apps/{app_id}/events",
"POST /api/v1/apps/{app_id}/is-allowed",
+ "GET /api/v1/apps/{app_id}/kms-info",
+ "GET /api/v1/apps/{app_id}/pending-updates",
+ "GET /api/v1/apps/{app_id}/pending-updates/{vm_uuid}/{compose_hash}/preview",
"GET /api/v1/apps/{app_id}/revisions",
"GET /api/v1/apps/{app_id}/revisions/{revision_id}",
"POST /api/v1/apps/{app_id}/revisions/{revision_id}/redeploy",
@@ -431,8 +553,6 @@
"POST /api/v1/cvms/batch-stop",
"POST /api/v1/cvms/eliza",
"POST /api/v1/cvms/provision/eliza",
- "POST /api/v1/cvms/from_cvm_configuration",
- "POST /api/v1/cvms/pubkey/from_cvm_configuration",
"PATCH /api/v1/cvms/instance-ids",
"POST /api/v1/status/batch",
"GET /api/v1/cvms/{cvm_id}",
@@ -440,31 +560,33 @@
"PATCH /api/v1/cvms/{cvm_id}",
"GET /api/v1/cvms/{cvm_id}/attestation",
"GET /api/v1/cvms/{cvm_id}/available-os-images",
+ "POST /api/v1/cvms/{cvm_id}/commit-replica",
"GET /api/v1/cvms/{cvm_id}/commit-update",
"POST /api/v1/cvms/{cvm_id}/commit-update",
- "GET /api/v1/cvms/{cvm_id}/compose",
- "PUT /api/v1/cvms/{cvm_id}/compose",
- "PATCH /api/v1/cvms/{cvm_id}/compose",
"GET /api/v1/cvms/{cvm_id}/compose_file",
"PATCH /api/v1/cvms/{cvm_id}/compose_file",
"POST /api/v1/cvms/{cvm_id}/compose_file",
"POST /api/v1/cvms/{cvm_id}/compose_file/provision",
- "GET /api/v1/cvms/{cvm_id}/composition",
"POST /api/v1/cvms/{cvm_id}/customize-domain-diagnose",
"PATCH /api/v1/cvms/{cvm_id}/docker-compose",
"GET /api/v1/cvms/{cvm_id}/docker-compose.yml",
"PATCH /api/v1/cvms/{cvm_id}/envs",
+ "GET /api/v1/cvms/{cvm_id}/firewall-status",
"PATCH /api/v1/cvms/{cvm_id}/instance-id",
"PATCH /api/v1/cvms/{cvm_id}/listed",
"PATCH /api/v1/cvms/{cvm_id}/name",
"GET /api/v1/cvms/{cvm_id}/network",
+ "GET /api/v1/cvms/{cvm_id}/network-config",
+ "PATCH /api/v1/cvms/{cvm_id}/network-config",
"GET /api/v1/cvms/{cvm_id}/operation-status",
"GET /api/v1/cvms/{cvm_id}/operations",
+ "POST /api/v1/cvms/{cvm_id}/operations/cancel",
"PATCH /api/v1/cvms/{cvm_id}/os-image",
+ "GET /api/v1/cvms/{cvm_id}/ports",
+ "PUT /api/v1/cvms/{cvm_id}/ports",
"GET /api/v1/cvms/{cvm_id}/pre-launch-script",
"PATCH /api/v1/cvms/{cvm_id}/pre-launch-script",
"POST /api/v1/cvms/{cvm_id}/replicas",
- "PATCH /api/v1/cvms/{cvm_id}/resources",
"POST /api/v1/cvms/{cvm_id}/restart",
"POST /api/v1/cvms/{cvm_id}/revisions/{revision_id}/redeploy",
"PATCH /api/v1/cvms/{cvm_id}/scheduled-delete",
@@ -473,8 +595,7 @@
"GET /api/v1/cvms/{cvm_id}/state",
"GET /api/v1/cvms/{cvm_id}/stats",
"POST /api/v1/cvms/{cvm_id}/stop",
- "GET /api/v1/cvms/{cvm_id}/user_config",
- "PATCH /api/v1/cvms/{cvm_id}/visibility"
+ "GET /api/v1/cvms/{cvm_id}/user_config"
]
},
{
@@ -491,52 +612,6 @@
"GET /api/v1/attestations/ppids"
]
},
- {
- "group": "Authentication",
- "pages": [
- "POST /api/v1/auth/token",
- "GET /api/v1/auth/authenticated",
- "GET /api/v1/auth/me",
- "POST /api/v1/auth/login",
- "POST /api/v1/auth/logout",
- "POST /api/v1/auth/register",
- "POST /api/v1/auth/forgot-password",
- "PUT /api/v1/auth/reset-password",
- "GET /api/v1/auth/validate-reset-token",
- "POST /api/v1/auth/password",
- "POST /api/v1/auth/change-email",
- "POST /api/v1/auth/request-email-verification",
- "POST /api/v1/auth/verify-email-token",
- "PUT /api/v1/auth/username",
- "GET /api/v1/auth/sessions",
- "DELETE /api/v1/auth/sessions",
- "DELETE /api/v1/auth/sessions/{jti}",
- "POST /api/v1/auth/step-up/verify",
- "GET /api/v1/auth/oauth/google/authorize",
- "GET /api/v1/auth/oauth/google/callback",
- "GET /api/v1/auth/oauth/github/authorize",
- "GET /api/v1/auth/oauth/github/callback",
- "GET /api/v1/auth/decode-link-token",
- "POST /api/v1/auth/verify-and-link-oauth",
- "POST /api/v1/auth/login-with-2fa",
- "POST /api/v1/auth/2fa/setup",
- "POST /api/v1/auth/2fa/confirm",
- "POST /api/v1/auth/2fa/disable",
- "GET /api/v1/auth/2fa/status",
- "POST /api/v1/auth/2fa/verify",
- "POST /api/v1/auth/2fa/verify-and-set-cookie",
- "POST /api/v1/auth/2fa/regenerate-backup-codes"
- ]
- },
- {
- "group": "Tokens",
- "pages": [
- "GET /api/v1/tokens",
- "POST /api/v1/tokens",
- "DELETE /api/v1/tokens/{token_id}",
- "POST /api/v1/tokens/{token_id}/refresh"
- ]
- },
{
"group": "KMS",
"pages": [
@@ -566,77 +641,19 @@
]
},
{
- "group": "GPUs",
- "pages": [
- "GET /api/v1/gpus/reserved",
- "POST /api/v1/gpus/switch-mode"
- ]
- },
- {
- "group": "Workspace",
- "pages": [
- "GET /api/v1/workspaces",
- "POST /api/v1/workspaces/check-slug",
- "GET /api/v1/workspaces/{team_slug}",
- "GET /api/v1/workspaces/{team_slug}/nodes",
- "GET /api/v1/workspaces/{team_slug}/quotas",
- "POST /api/v1/workspaces/{workspace_slug}/invitations",
- "GET /api/v1/workspaces/{workspace_slug}/invitations",
- "POST /api/v1/workspaces/{workspace_slug}/invitations/shareable",
- "DELETE /api/v1/workspaces/{workspace_slug}/invitations/{invitation_id}",
- "POST /api/v1/workspaces/{workspace_slug}/leave",
- "GET /api/v1/workspaces/{workspace_slug}/members",
- "DELETE /api/v1/workspaces/{workspace_slug}/members/{user_id}",
- "PATCH /api/v1/workspaces/{workspace_slug}/members/{user_id}"
- ]
- },
- {
- "group": "Billing",
- "pages": [
- "GET /api/v1/billing",
- "GET /api/v1/billing/balance",
- "GET /api/v1/billing/billing_items",
- "GET /api/v1/billing/billing_items/{cvm_id}",
- "GET /api/v1/billing/settings",
- "PATCH /api/v1/billing/settings",
- "GET /api/v1/billing/invoices",
- "GET /api/v1/billing/invoices/{invoice_id}",
- "GET /api/v1/billing/invoices/{invoice_id}/items",
- "POST /api/v1/billing/invoices/{invoice_id}/pay",
- "GET /api/v1/credits",
- "POST /api/v1/credits/redeem",
- "GET /api/v1/credits/transactions",
- "GET /api/v1/card",
- "DELETE /api/v1/card/{payment_method_id}",
- "POST /api/v1/charge",
- "GET /api/v1/debt",
- "POST /api/v1/debt/settlement",
- "GET /api/v1/orders",
- "POST /api/v1/setup-billing/create-intent",
- "POST /api/v1/setup-billing/save-intent",
- "GET /api/v1/setup-billing/check"
- ]
- },
- {
- "group": "Profiles",
- "pages": [
- "GET /api/v1/profiles/me",
- "PUT /api/v1/profiles/me",
- "PUT /api/v1/profiles/me/avatar",
- "DELETE /api/v1/profiles/me/avatar",
- "GET /api/v1/profiles/{entity_type}/{entity_id}",
- "PUT /api/v1/profiles/{entity_type}/{entity_id}",
- "DELETE /api/v1/profiles/{entity_type}/{entity_id}",
- "PUT /api/v1/profiles/{entity_type}/{entity_id}/avatar",
- "DELETE /api/v1/profiles/{entity_type}/{entity_id}/avatar"
- ]
- },
- {
- "group": "Usage",
+ "group": "Webhooks",
"pages": [
- "GET /api/v1/usage/current",
- "GET /api/v1/usage/data",
- "GET /api/v1/usage/export"
+ "GET /api/v1/workspace/webhooks",
+ "POST /api/v1/workspace/webhooks",
+ "GET /api/v1/workspace/webhooks/{webhook_id}",
+ "PUT /api/v1/workspace/webhooks/{webhook_id}",
+ "DELETE /api/v1/workspace/webhooks/{webhook_id}",
+ "POST /api/v1/workspace/webhooks/{webhook_id}/reveal-secret",
+ "POST /api/v1/workspace/webhooks/{webhook_id}/rotate-secret",
+ "POST /api/v1/workspace/webhooks/{webhook_id}/test",
+ "GET /api/v1/workspace/webhooks/{webhook_id}/deliveries",
+ "POST /api/v1/workspace/webhooks/{webhook_id}/deliveries/{event_id}/resend",
+ "GET /api/v1/workspace/webhooks/{webhook_id}/stats"
]
}
]
@@ -790,7 +807,6 @@
}
]
},
- "openapi": "openapi.json",
"redirects": [
{
"destination": "/phala-cloud/key-management/deploying-with-onchain-kms",
diff --git a/openapi.json b/openapi.json
index 1c0733c..7d56d87 100644
--- a/openapi.json
+++ b/openapi.json
@@ -4,103 +4,44 @@
"title": "Phala Cloud API",
"version": "0.1.0"
},
+ "servers": [
+ {
+ "url": "https://cloud-api.phala.com"
+ }
+ ],
"paths": {
- "/api/v1/auth/oauth/google/authorize": {
- "get": {
+ "/api/v1/cvms/provision/eliza": {
+ "post": {
"tags": [
- "Authentication"
- ],
- "summary": "Start Google OAuth",
- "description": "Redirects user to Google authorization page. Supports login, registration, and account linking modes.",
- "operationId": "google_oauth_authorize_api_v1_auth_oauth_google_authorize_get",
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
+ "CVMs"
],
- "parameters": [
- {
- "name": "returnUrl",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Returnurl"
- }
- },
- {
- "name": "invite",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Invite"
- }
- },
- {
- "name": "mode",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Mode"
+ "summary": "Provision Eliza app",
+ "description": "Validates Eliza configuration and caches it for 14 days. Returns compose_hash and KMS info for on-chain registration.",
+ "operationId": "handle_provision_cvm_for_eliza_api_v1_cvms_provision_eliza_post",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ProvisionElizaRequest"
+ }
}
},
- {
- "name": "site_key",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Site Key"
- }
- }
- ],
+ "required": true
+ },
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "Provision data with compose_hash for creation",
"content": {
"application/json": {
"schema": {}
}
}
},
- "307": {
- "description": "Redirect to Google authorization URL"
+ "400": {
+ "description": "Invalid configuration"
},
- "501": {
- "description": "Google OAuth not configured on server"
+ "401": {
+ "description": "Authentication required"
},
"422": {
"description": "Validation Error",
@@ -115,55 +56,82 @@
}
}
},
- "/api/v1/auth/oauth/google/callback": {
- "get": {
+ "/api/v1/cvms/provision": {
+ "post": {
"tags": [
- "Authentication"
+ "CVMs"
],
- "summary": "Handle Google OAuth callback",
- "description": "Processes Google authorization response. Creates session cookie on success or redirects with error parameter on failure.",
- "operationId": "google_oauth_callback_api_v1_auth_oauth_google_callback_get",
- "parameters": [
- {
- "name": "code",
- "in": "query",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Code"
+ "summary": "Provision DStack app",
+ "description": "Validates Docker Compose configuration and caches it for 14 days. Returns compose_hash and KMS info for on-chain registration before creation.",
+ "operationId": "handle_provision_cvm_api_v1_cvms_provision_post",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ProvisionDstackAppRequestV2"
+ }
}
},
- {
- "name": "state",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "State"
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Provision data with compose_hash for creation",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
}
+ },
+ "400": {
+ "description": "Invalid Docker Compose configuration"
+ },
+ "401": {
+ "description": "Authentication required"
+ },
+ "422": {
+ "description": "Validation error"
}
+ }
+ }
+ },
+ "/api/v1/cvms/workload": {
+ "post": {
+ "tags": [
+ "CVMs"
],
+ "summary": "Create GPU workload CVM",
+ "description": "Creates a CVM for GPU workloads. Node is auto-selected from available GPU nodes.",
+ "operationId": "handle_create_cvm_for_workload_api_v1_cvms_workload_post",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateWorkloadTappRequest"
+ }
+ }
+ },
+ "required": true
+ },
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "Created CVM record",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/VM"
+ }
}
}
},
- "307": {
- "description": "Redirect to dashboard on success, login/register/settings page on error"
- },
"400": {
- "description": "Invalid state parameter or token exchange failed"
+ "description": "Creation failed"
+ },
+ "401": {
+ "description": "Authentication required"
+ },
+ "409": {
+ "description": "CVM name already exists in workspace"
},
"422": {
"description": "Validation Error",
@@ -175,17 +143,64 @@
}
}
}
- }
+ },
+ "security": [
+ {
+ "OAuth2AuthorizationCodeBearer": []
+ },
+ {
+ "APIKeyHeader": []
+ }
+ ]
}
},
- "/api/v1/auth/oauth/github/authorize": {
+ "/api/v1/cvms": {
+ "post": {
+ "tags": [
+ "CVMs"
+ ],
+ "summary": "Create CVM from provision",
+ "description": "Creates a CVM using cached provision data from /cvms/provision. Requires compose_hash from the provision response.",
+ "operationId": "handle_create_cvm_from_povision_api_v1_cvms_post",
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateTappRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Created CVM record with teepod info",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/VM"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid payload or provision data expired"
+ },
+ "401": {
+ "description": "Authentication required"
+ },
+ "422": {
+ "description": "Provision data not found"
+ }
+ }
+ },
"get": {
"tags": [
- "Authentication"
+ "CVMs"
],
- "summary": "Start GitHub OAuth",
- "description": "Redirects user to GitHub authorization page. Supports login, registration, and account linking modes.",
- "operationId": "github_oauth_authorize_api_v1_auth_oauth_github_authorize_get",
+ "summary": "List CVMs",
+ "description": "Returns CVMs in current workspace. Admins can filter by user_id or teepod_id.",
+ "operationId": "handle_list_cvms_api_v1_cvms_get",
"security": [
{
"OAuth2AuthorizationCodeBearer": []
@@ -196,84 +211,80 @@
],
"parameters": [
{
- "name": "returnUrl",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Returnurl"
- }
- },
- {
- "name": "invite",
+ "name": "user_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
+ "const": "0",
"type": "string"
},
{
- "type": "null"
- }
- ],
- "title": "Invite"
- }
- },
- {
- "name": "mode",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
+ "type": "string",
+ "format": "hashid",
+ "description": "A hashed identifier that maps to an internal database ID",
+ "pattern": "^usr_.+",
+ "title": "HashedId[users]",
+ "examples": [
+ "usr_0123abcd"
+ ]
},
{
"type": "null"
}
],
- "title": "Mode"
- }
+ "description": "Filter by owner (admin only). Use '0' for unassigned.",
+ "title": "User Id"
+ },
+ "description": "Filter by owner (admin only). Use '0' for unassigned."
},
{
- "name": "site_key",
+ "name": "teepod_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
- "type": "string"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Site Key"
- }
+ "description": "Filter by node ID (admin only)",
+ "title": "Teepod Id"
+ },
+ "description": "Filter by node ID (admin only)"
}
],
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "List of CVM summaries",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "anyOf": [
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/HostedCvm"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/teehouse__api__routes__cvms__v20260121__schemas__CVMInfo"
+ }
+ }
+ ],
+ "title": "Response Handle List Cvms Api V1 Cvms Get"
+ }
}
}
},
- "307": {
- "description": "Redirect to GitHub authorization URL"
- },
- "501": {
- "description": "GitHub OAuth not configured on server"
+ "401": {
+ "description": "Authentication required"
},
"422": {
"description": "Validation Error",
@@ -288,65 +299,67 @@
}
}
},
- "/api/v1/auth/oauth/github/callback": {
- "get": {
+ "/api/v1/cvms/eliza": {
+ "post": {
"tags": [
- "Authentication"
+ "CVMs"
],
- "summary": "Handle GitHub OAuth callback",
- "description": "Processes GitHub authorization response. Creates session cookie on success or redirects with error parameter on failure.",
- "operationId": "github_oauth_callback_api_v1_auth_oauth_github_callback_get",
- "parameters": [
- {
- "name": "code",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Code"
+ "summary": "Create Eliza from provision",
+ "description": "Creates an Eliza CVM using cached provision data from /cvms/provision/eliza. Requires compose_hash from the provision response.",
+ "operationId": "handle_create_eliza_from_provision_api_v1_cvms_eliza_post",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateTappRequest"
+ }
}
},
- {
- "name": "state",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Created Eliza CVM record",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/VM"
}
- ],
- "title": "State"
+ }
}
},
+ "400": {
+ "description": "Invalid payload"
+ },
+ "401": {
+ "description": "Authentication required"
+ },
+ "422": {
+ "description": "Provision data not found or expired"
+ }
+ }
+ }
+ },
+ "/api/v1/cvms/{cvm_id}/compose_file": {
+ "get": {
+ "tags": [
+ "CVMs"
+ ],
+ "summary": "Get raw compose file",
+ "description": "Returns the complete compose file as JSON or raw text based on query param.",
+ "operationId": "get_cvm_compose_file_api_v1_cvms__cvm_id__compose_file_get",
+ "parameters": [
{
- "name": "error",
- "in": "query",
- "required": false,
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
"schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Error"
+ "type": "string",
+ "title": "Cvm Id"
}
},
{
- "name": "error_description",
+ "name": "raw",
"in": "query",
"required": false,
"schema": {
@@ -358,24 +371,30 @@
"type": "null"
}
],
- "title": "Error Description"
+ "title": "Raw"
}
}
],
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "Compose file content",
"content": {
"application/json": {
"schema": {}
}
}
},
- "307": {
- "description": "Redirect to dashboard on success, login/register/settings page on error"
+ "401": {
+ "description": "Authentication required"
},
- "400": {
- "description": "Invalid state parameter or token exchange failed"
+ "403": {
+ "description": "CVM not in workspace"
+ },
+ "404": {
+ "description": "CVM not found"
+ },
+ "500": {
+ "description": "Failed to retrieve compose file"
},
"422": {
"description": "Validation Error",
@@ -388,91 +407,38 @@
}
}
}
- }
- },
- "/api/v1/auth/me": {
- "get": {
+ },
+ "patch": {
"tags": [
- "Authentication"
+ "CVMs"
],
- "summary": "Get current user",
- "description": "Return detailed info for the authenticated user including workspace and credits.",
- "operationId": "read_users_me_api_v1_auth_me_get",
- "responses": {
- "200": {
- "description": "User profile with workspace and credits",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "User is disabled"
- }
- },
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
+ "summary": "Trigger compose file update",
+ "description": "Applies a provisioned compose file update. Requires compose_hash from provision endpoint. Restarts the CVM with new configuration.",
+ "operationId": "trigger_cvm_compose_file_update_api_v1_cvms__cvm_id__compose_file_patch",
+ "parameters": [
{
- "APIKeyHeader": []
- }
- ]
- }
- },
- "/api/v1/auth/authenticated": {
- "get": {
- "tags": [
- "Authentication"
- ],
- "summary": "Check authentication",
- "description": "Return authentication status and user info if authenticated.",
- "operationId": "authenticated_api_v1_auth_authenticated_get",
- "responses": {
- "200": {
- "description": "Authentication status with user info if authenticated",
- "content": {
- "application/json": {
- "schema": {}
- }
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
}
}
- },
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ]
- }
- },
- "/api/v1/auth/register": {
- "post": {
- "tags": [
- "Authentication"
],
- "summary": "Register new user",
- "description": "Create a new account with email verification. Requires invite code if configured.",
- "operationId": "register_user_api_v1_auth_register_post",
"requestBody": {
+ "required": true,
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/RegisterPayload"
+ "$ref": "#/components/schemas/Body_trigger_cvm_compose_file_update_api_v1_cvms__cvm_id__compose_file_patch"
}
}
- },
- "required": true
+ }
},
"responses": {
- "200": {
- "description": "User created or verification email sent",
+ "202": {
+ "description": "Update initiated",
"content": {
"application/json": {
"schema": {}
@@ -480,7 +446,19 @@
}
},
"400": {
- "description": "Invalid input, email already exists, or rate limited"
+ "description": "Provision not found or invalid CVM"
+ },
+ "401": {
+ "description": "Authentication required"
+ },
+ "403": {
+ "description": "CVM not in workspace"
+ },
+ "404": {
+ "description": "CVM not found"
+ },
+ "503": {
+ "description": "Node under maintenance"
},
"422": {
"description": "Validation Error",
@@ -493,132 +471,203 @@
}
}
}
- }
- },
- "/api/v1/auth/token": {
+ },
"post": {
"tags": [
- "Authentication"
+ "CVMs"
+ ],
+ "summary": "Submit compose file update",
+ "description": "Submit complete compose file with hash verification. Use when you have pre-computed compose_hash and want to skip provision step.",
+ "operationId": "submit_cvm_compose_file_update_api_v1_cvms__cvm_id__compose_file_post",
+ "parameters": [
+ {
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
+ }
+ }
],
- "summary": "Get access token",
- "description": "OAuth2 password grant. Returns JWT token. Pass TOTP code in client_id field if 2FA enabled.",
- "operationId": "login_for_access_token_api_v1_auth_token_post",
"requestBody": {
+ "required": true,
"content": {
- "application/x-www-form-urlencoded": {
+ "application/json": {
"schema": {
- "$ref": "#/components/schemas/Body_login_for_access_token_api_v1_auth_token_post"
+ "$ref": "#/components/schemas/ComposeFileUpdateRequest",
+ "description": "Complete compose file with hash"
}
}
- },
- "required": true
+ }
},
"responses": {
- "200": {
- "description": "Access token issued",
+ "202": {
+ "description": "Update initiated",
"content": {
"application/json": {
"schema": {}
}
}
},
+ "400": {
+ "description": "Invalid CVM or hash mismatch"
+ },
"401": {
- "description": "Invalid credentials, email not verified, or invalid 2FA"
+ "description": "Authentication required"
},
- "500": {
- "description": "Internal authentication error"
+ "403": {
+ "description": "CVM not in workspace"
+ },
+ "404": {
+ "description": "CVM not found"
},
"422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
+ "description": "Invalid Docker Compose syntax"
+ },
+ "503": {
+ "description": "Node under maintenance"
}
}
}
},
- "/api/v1/auth/login": {
+ "/api/v1/cvms/{cvm_id}/compose_file/provision": {
"post": {
"tags": [
- "Authentication"
+ "CVMs"
+ ],
+ "summary": "Provision compose file update",
+ "description": "Validates new compose file and returns compose_hash for on-chain registration. Cache expires after 14 days.",
+ "operationId": "provision_for_cvm_compose_file_update_api_v1_cvms__cvm_id__compose_file_provision_post",
+ "parameters": [
+ {
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
+ }
+ }
],
- "summary": "Login with cookie",
- "description": "Authenticate and set session cookie. Pass TOTP code in client_id field if 2FA enabled.",
- "operationId": "login_with_cookie_api_v1_auth_login_post",
"requestBody": {
+ "required": true,
"content": {
- "application/x-www-form-urlencoded": {
+ "application/json": {
"schema": {
- "$ref": "#/components/schemas/Body_login_with_cookie_api_v1_auth_login_post"
+ "$ref": "#/components/schemas/ProvisionComposeFileUpdateRequest",
+ "description": "Updated compose configuration"
}
}
- },
- "required": true
+ }
},
"responses": {
"200": {
- "description": "Login successful, cookie set",
+ "description": "Provision response with compose_hash and KMS info",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/ComposeFileProvisionResponse"
+ }
}
}
},
+ "400": {
+ "description": "Empty Docker Compose file or invalid CVM"
+ },
"401": {
- "description": "Invalid credentials or email not verified"
+ "description": "Authentication required"
},
- "500": {
- "description": "Session creation failed"
+ "403": {
+ "description": "CVM not in workspace"
+ },
+ "404": {
+ "description": "CVM not found"
},
"422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
+ "description": "Invalid Docker Compose syntax"
}
}
}
},
- "/api/v1/auth/login-with-2fa": {
+ "/api/v1/cvms/{cvm_id}/replicas": {
"post": {
"tags": [
- "Authentication"
+ "CVMs"
+ ],
+ "summary": "Replicate CVM",
+ "description": "Create a replica of the CVM on a target node. If request body is omitted, it replicates to the source node and reuses existing env.",
+ "operationId": "handle_replicate_cvm_api_v1_cvms__cvm_id__replicas_post",
+ "parameters": [
+ {
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
+ }
+ },
+ {
+ "name": "X-Prepare-Only",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "X-Prepare-Only"
+ }
+ }
],
- "summary": "Login with explicit 2FA",
- "description": "Authenticate with explicit TOTP code field. Preferred over /login for 2FA users.",
- "operationId": "login_with_2fa_api_v1_auth_login_with_2fa_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/LoginRequest"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/ReplicateRequest"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Request"
}
}
- },
- "required": true
+ }
},
"responses": {
"200": {
- "description": "Login successful, cookie set",
+ "description": "Replica CVM created",
"content": {
"application/json": {
"schema": {}
}
}
},
+ "400": {
+ "description": "Invalid target node, image mismatch, or invalid encrypted_env"
+ },
"401": {
- "description": "Invalid credentials or email not verified"
+ "description": "Not authenticated"
+ },
+ "403": {
+ "description": "CVM not in workspace"
+ },
+ "404": {
+ "description": "CVM or target node not found"
+ },
+ "465": {
+ "description": "KMS allowlist rejection (contract-owned KMS)"
},
"500": {
- "description": "Session creation failed"
+ "description": "Replication failed"
},
"422": {
"description": "Validation Error",
@@ -633,61 +682,136 @@
}
}
},
- "/api/v1/auth/logout": {
- "post": {
+ "/api/v1/cvms/{cvm_id}/operations": {
+ "get": {
"tags": [
- "Authentication"
+ "CVMs"
],
- "summary": "Logout",
- "description": "Revoke the current session and clear authentication cookies.",
- "operationId": "logout_api_v1_auth_logout_post",
- "responses": {
- "200": {
- "description": "Logged out successfully",
- "content": {
- "application/json": {
- "schema": {}
- }
+ "summary": "List CVM operations",
+ "description": "Returns operation records grouped by correlation_id. Only includes events with correlation_id (new format since 2024-01). Error messages are sanitized for non-admin users.",
+ "operationId": "get_cvm_operations_api_v1_cvms__cvm_id__operations_get",
+ "parameters": [
+ {
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
}
- }
- },
- "security": [
+ },
{
- "OAuth2AuthorizationCodeBearer": []
+ "name": "cursor",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Opaque cursor from previous response",
+ "title": "Cursor"
+ },
+ "description": "Opaque cursor from previous response"
},
{
- "APIKeyHeader": []
+ "name": "limit",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "maximum": 500,
+ "minimum": 1,
+ "description": "Page size",
+ "default": 50,
+ "title": "Limit"
+ },
+ "description": "Page size"
+ },
+ {
+ "name": "start_time",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Include operations started after this UTC time",
+ "title": "Start Time"
+ },
+ "description": "Include operations started after this UTC time"
+ },
+ {
+ "name": "end_time",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Include operations started before this UTC time",
+ "title": "End Time"
+ },
+ "description": "Include operations started before this UTC time"
+ },
+ {
+ "name": "operation_types",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Filter by operation types (e.g. compose_update, power_on)",
+ "title": "Operation Types"
+ },
+ "description": "Filter by operation types (e.g. compose_update, power_on)"
}
- ]
- }
- },
- "/api/v1/auth/forgot-password": {
- "post": {
- "tags": [
- "Authentication"
],
- "summary": "Request password reset",
- "description": "Send password reset email if account exists. Response is identical whether account exists or not.",
- "operationId": "forgot_password_api_v1_auth_forgot_password_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PasswordResetRequest"
- }
- }
- },
- "required": true
- },
"responses": {
"200": {
- "description": "Reset email sent (if account exists)",
+ "description": "Paginated operation records",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/PaginatedCvmOperationsResponse"
+ }
}
}
},
+ "401": {
+ "description": "Authentication required"
+ },
+ "403": {
+ "description": "CVM not in workspace"
+ },
+ "404": {
+ "description": "CVM not found"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -701,40 +825,47 @@
}
}
},
- "/api/v1/auth/validate-reset-token": {
- "get": {
+ "/api/v1/cvms/{cvm_id}/operations/cancel": {
+ "post": {
"tags": [
- "Authentication"
+ "CVMs"
],
- "summary": "Validate reset token",
- "description": "Check if a password reset token is valid and not expired.",
- "operationId": "validate_reset_token_api_v1_auth_validate_reset_token_get",
+ "summary": "Cancel in-progress CVM operation",
+ "description": "Cancel the current in-progress operation for a CVM. Revokes the Celery task and clears the operation lock.",
+ "operationId": "cancel_cvm_operation_api_v1_cvms__cvm_id__operations_cancel_post",
"parameters": [
{
- "name": "token",
- "in": "query",
+ "name": "cvm_id",
+ "in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "Token"
+ "title": "Cvm Id"
}
}
],
"responses": {
"200": {
- "description": "Token is valid",
+ "description": "Operation cancelled or no operation to cancel",
"content": {
"application/json": {
"schema": {
- "type": "object",
- "additionalProperties": true,
- "title": "Response Validate Reset Token Api V1 Auth Validate Reset Token Get"
+ "$ref": "#/components/schemas/CancelOperationRequest"
}
}
}
},
- "400": {
- "description": "Invalid or expired token"
+ "401": {
+ "description": "Authentication required"
+ },
+ "403": {
+ "description": "CVM not in workspace"
+ },
+ "404": {
+ "description": "CVM not found"
+ },
+ "409": {
+ "description": "Cannot cancel this operation type"
},
"422": {
"description": "Validation Error",
@@ -749,39 +880,45 @@
}
}
},
- "/api/v1/auth/reset-password": {
- "put": {
+ "/api/v1/cvms/{cvm_id}/docker-compose.yml": {
+ "get": {
"tags": [
- "Authentication"
+ "CVMs"
],
- "summary": "Reset password with token",
- "description": "Set a new password using the reset token from email.",
- "operationId": "handle_reset_password_with_token_api_v1_auth_reset_password_put",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ResetPasswordWithToken"
- }
+ "summary": "Get Docker Compose file",
+ "description": "Returns the raw Docker Compose YAML content from the CVM configuration.",
+ "operationId": "handle_get_cvm_docker_compose_api_v1_cvms__cvm_id__docker_compose_yml_get",
+ "parameters": [
+ {
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
}
- },
- "required": true
- },
+ }
+ ],
"responses": {
"200": {
- "description": "Password reset successfully",
+ "description": "Docker Compose YAML content",
"content": {
"application/json": {
"schema": {
- "additionalProperties": true,
- "type": "object",
- "title": "Response Handle Reset Password With Token Api V1 Auth Reset Password Put"
+ "type": "string",
+ "title": "Response Handle Get Cvm Docker Compose Api V1 Cvms Cvm Id Docker Compose Yml Get"
}
}
}
},
- "400": {
- "description": "Invalid token, expired, or weak password"
+ "401": {
+ "description": "Authentication required"
+ },
+ "403": {
+ "description": "CVM not in workspace"
+ },
+ "404": {
+ "description": "CVM not found"
},
"422": {
"description": "Validation Error",
@@ -796,40 +933,45 @@
}
}
},
- "/api/v1/auth/password": {
- "post": {
+ "/api/v1/cvms/{cvm_id}/pre-launch-script": {
+ "get": {
"tags": [
- "Authentication"
+ "CVMs"
],
- "summary": "Update password",
- "description": "Change password. Requires TOTP code (if 2FA enabled) or current password. Sends notification email.",
- "operationId": "handle_update_password_api_v1_auth_password_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/UpdatePasswordRequest"
- }
+ "summary": "Get pre-launch script",
+ "description": "Returns the shell script that runs before containers start.",
+ "operationId": "handle_get_cvm_prelaunch_script_api_v1_cvms__cvm_id__pre_launch_script_get",
+ "parameters": [
+ {
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
}
- },
- "required": true
- },
+ }
+ ],
"responses": {
"200": {
- "description": "Password updated",
+ "description": "Pre-launch shell script content",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/User"
+ "type": "string",
+ "title": "Response Handle Get Cvm Prelaunch Script Api V1 Cvms Cvm Id Pre Launch Script Get"
}
}
}
},
- "400": {
- "description": "TOTP code required or invalid, or password validation failed"
- },
"401": {
- "description": "Not authenticated or current password incorrect"
+ "description": "Authentication required"
+ },
+ "403": {
+ "description": "CVM not in workspace"
+ },
+ "404": {
+ "description": "CVM not found"
},
"422": {
"description": "Validation Error",
@@ -841,38 +983,74 @@
}
}
}
- },
- "security": [
+ }
+ },
+ "patch": {
+ "tags": [
+ "CVMs"
+ ],
+ "summary": "Update pre-launch script",
+ "description": "Replaces the pre-launch script and restarts the CVM. For contract-owned KMS, requires two-phase flow with on-chain hash registration.",
+ "operationId": "update_cvm_pre_launch_script_api_v1_cvms__cvm_id__pre_launch_script_patch",
+ "parameters": [
{
- "OAuth2AuthorizationCodeBearer": []
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
+ }
},
{
- "APIKeyHeader": []
+ "name": "X-Compose-Hash",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Compose hash from Phase 1 response",
+ "title": "X-Compose-Hash"
+ },
+ "description": "Compose hash from Phase 1 response"
+ },
+ {
+ "name": "X-Transaction-Hash",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Transaction hash proving on-chain registration",
+ "title": "X-Transaction-Hash"
+ },
+ "description": "Transaction hash proving on-chain registration"
}
- ]
- }
- },
- "/api/v1/auth/username": {
- "put": {
- "tags": [
- "Authentication"
],
- "summary": "Update username",
- "description": "Change username. Requires TOTP code (if 2FA enabled) or current password. Revokes all other sessions.",
- "operationId": "handle_update_username_api_v1_auth_username_put",
"requestBody": {
"content": {
- "application/json": {
+ "multipart/form-data": {
"schema": {
- "$ref": "#/components/schemas/UpdateUsernameRequest"
+ "$ref": "#/components/schemas/Body_update_cvm_pre_launch_script_api_v1_cvms__cvm_id__pre_launch_script_patch"
}
}
- },
- "required": true
+ }
},
"responses": {
- "200": {
- "description": "Username updated",
+ "202": {
+ "description": "Update initiated, track via correlation_id",
"content": {
"application/json": {
"schema": {}
@@ -880,10 +1058,34 @@
}
},
"400": {
- "description": "TOTP required, invalid TOTP, or username validation failed"
+ "description": "Invalid content type or empty body"
},
"401": {
- "description": "Not authenticated or current password incorrect"
+ "description": "Authentication required"
+ },
+ "403": {
+ "description": "CVM not in workspace"
+ },
+ "404": {
+ "description": "CVM not found"
+ },
+ "409": {
+ "description": "Another operation in progress"
+ },
+ "465": {
+ "description": "Compose hash registration required (Phase 1)"
+ },
+ "466": {
+ "description": "Compose hash invalid or expired"
+ },
+ "467": {
+ "description": "Transaction verification failed"
+ },
+ "468": {
+ "description": "Compose hash not allowed on-chain"
+ },
+ "500": {
+ "description": "KMS configuration or RPC error"
},
"422": {
"description": "Validation Error",
@@ -895,49 +1097,51 @@
}
}
}
- },
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ]
+ }
}
},
- "/api/v1/auth/request-email-verification": {
- "post": {
+ "/api/v1/cvms/{cvm_id}/available-os-images": {
+ "get": {
"tags": [
- "Authentication"
+ "CVMs"
],
- "summary": "Request email verification",
- "description": "Send or resend verification email. Can also be used to change email address.",
- "operationId": "api_request_email_verification_api_v1_auth_request_email_verification_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/WrappedEmailVerificationRequest"
- }
+ "summary": "List available OS images",
+ "description": "Returns OS images this CVM can upgrade to, filtered by node availability, KMS allowlist, dev/prod upgrade rules, and GPU compatibility.",
+ "operationId": "get_available_os_images_api_v1_cvms__cvm_id__available_os_images_get",
+ "parameters": [
+ {
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
}
- },
- "required": true
- },
+ }
+ ],
"responses": {
"200": {
- "description": "Verification email sent",
+ "description": "OS images grouped by version (newest first)",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/teehouse__api__routes__cvms__patch_compose_file__AvailableOSImage"
+ },
+ "title": "Response Get Available Os Images Api V1 Cvms Cvm Id Available Os Images Get"
+ }
}
}
},
- "400": {
- "description": "No email provided or send failed"
- },
"401": {
- "description": "Not authenticated"
+ "description": "Authentication required"
+ },
+ "403": {
+ "description": "CVM not in workspace"
+ },
+ "404": {
+ "description": "CVM not found"
},
"422": {
"description": "Validation Error",
@@ -949,38 +1153,41 @@
}
}
}
- },
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ]
+ }
}
},
- "/api/v1/auth/change-email": {
- "post": {
+ "/api/v1/cvms/{cvm_id}/os-image": {
+ "patch": {
"tags": [
- "Authentication"
+ "CVMs"
+ ],
+ "summary": "Update OS image",
+ "description": "Upgrades the CVM to a different OS image. Shuts down, updates, and restarts. Takes several minutes. Track progress via correlation_id.",
+ "operationId": "update_cvm_os_image_api_v1_cvms__cvm_id__os_image_patch",
+ "parameters": [
+ {
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
+ }
+ }
],
- "summary": "Change email address",
- "description": "Initiate email change. Requires verification (password or 2FA). Sends verification to new address.",
- "operationId": "api_change_email_api_v1_auth_change_email_post",
"requestBody": {
+ "required": true,
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/WrappedChangeEmailRequest"
+ "$ref": "#/components/schemas/Body_update_cvm_os_image_api_v1_cvms__cvm_id__os_image_patch"
}
}
- },
- "required": true
+ }
},
"responses": {
- "200": {
- "description": "Verification email sent to new address",
+ "202": {
+ "description": "Upgrade initiated, returns correlation_id",
"content": {
"application/json": {
"schema": {}
@@ -988,10 +1195,19 @@
}
},
"400": {
- "description": "Email send failed or invalid"
+ "description": "OS image not available for this CVM"
},
"401": {
- "description": "Not authenticated or verification failed"
+ "description": "Authentication required"
+ },
+ "403": {
+ "description": "CVM not in workspace"
+ },
+ "404": {
+ "description": "CVM not found"
+ },
+ "409": {
+ "description": "Another operation in progress"
},
"422": {
"description": "Validation Error",
@@ -1003,52 +1219,73 @@
}
}
}
- },
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ]
+ }
}
},
- "/api/v1/auth/verify-email-token": {
- "post": {
+ "/api/v1/cvms/{cvm_id}/envs": {
+ "patch": {
"tags": [
- "Authentication"
+ "CVMs"
+ ],
+ "summary": "Update environment variables",
+ "description": "Updates encrypted environment variables. If env_keys changes for contract-owned KMS, requires two-phase flow with on-chain hash registration.",
+ "operationId": "update_cvm_envs_api_v1_cvms__cvm_id__envs_patch",
+ "parameters": [
+ {
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
+ }
+ }
],
- "summary": "Verify email token",
- "description": "Complete email verification using token from email link.",
- "operationId": "api_verify_email_token_api_v1_auth_verify_email_token_post",
"requestBody": {
+ "required": true,
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Body_api_verify_email_token_api_v1_auth_verify_email_token_post"
+ "$ref": "#/components/schemas/Body_update_cvm_envs_api_v1_cvms__cvm_id__envs_patch"
}
}
- },
- "required": true
+ }
},
"responses": {
- "200": {
- "description": "Email verified",
+ "202": {
+ "description": "Update initiated, returns correlation_id and allowed_envs_changed flag",
"content": {
"application/json": {
- "schema": {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object",
- "title": "Response Api Verify Email Token Api V1 Auth Verify Email Token Post"
- }
+ "schema": {}
}
}
},
- "400": {
- "description": "Invalid token, expired, or site key invalid"
+ "401": {
+ "description": "Authentication required"
+ },
+ "403": {
+ "description": "CVM not in workspace"
+ },
+ "404": {
+ "description": "CVM not found"
+ },
+ "409": {
+ "description": "Another operation in progress"
+ },
+ "465": {
+ "description": "Compose hash registration required (env_keys changed, Phase 1)"
+ },
+ "466": {
+ "description": "Compose hash invalid or expired"
+ },
+ "467": {
+ "description": "Transaction verification failed"
+ },
+ "468": {
+ "description": "Compose hash not allowed on-chain"
+ },
+ "500": {
+ "description": "KMS configuration or RPC error"
},
"422": {
"description": "Validation Error",
@@ -1063,60 +1300,73 @@
}
}
},
- "/api/v1/auth/2fa/status": {
- "get": {
+ "/api/v1/cvms/{cvm_id}/docker-compose": {
+ "patch": {
"tags": [
- "Authentication"
+ "CVMs"
],
- "summary": "Get 2FA status",
- "description": "Return 2FA configuration status including enabled flag and backup codes count.",
- "operationId": "get_2fa_status_endpoint_api_v1_auth_2fa_status_get",
- "responses": {
- "200": {
- "description": "2FA status",
- "content": {
- "application/json": {
- "schema": {}
- }
+ "summary": "Update Docker Compose file",
+ "description": "Replaces the docker-compose.yml and restarts the CVM. For contract-owned KMS, requires two-phase flow with on-chain hash registration.",
+ "operationId": "update_cvm_docker_compose_api_v1_cvms__cvm_id__docker_compose_patch",
+ "parameters": [
+ {
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
}
},
- "400": {
- "description": "Status check failed"
- },
- "401": {
- "description": "Not authenticated"
- }
- },
- "security": [
{
- "OAuth2AuthorizationCodeBearer": []
+ "name": "X-Compose-Hash",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Compose hash from Phase 1 response",
+ "title": "X-Compose-Hash"
+ },
+ "description": "Compose hash from Phase 1 response"
},
{
- "APIKeyHeader": []
+ "name": "X-Transaction-Hash",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Transaction hash proving on-chain registration",
+ "title": "X-Transaction-Hash"
+ },
+ "description": "Transaction hash proving on-chain registration"
}
- ]
- }
- },
- "/api/v1/auth/2fa/setup": {
- "post": {
- "tags": [
- "Authentication"
],
- "summary": "Initialize 2FA setup",
- "description": "Generate TOTP secret and QR code. Secret is only shown once. Call /2fa/confirm to activate.",
- "operationId": "setup_2fa_endpoint_api_v1_auth_2fa_setup_post",
"requestBody": {
"content": {
- "application/json": {
+ "multipart/form-data": {
"schema": {
- "$ref": "#/components/schemas/Body_setup_2fa_endpoint_api_v1_auth_2fa_setup_post"
+ "$ref": "#/components/schemas/Body_update_cvm_docker_compose_api_v1_cvms__cvm_id__docker_compose_patch"
}
}
}
},
"responses": {
- "200": {
- "description": "Secret and QR code for authenticator app",
+ "202": {
+ "description": "Update initiated, track via correlation_id",
"content": {
"application/json": {
"schema": {}
@@ -1124,10 +1374,34 @@
}
},
"400": {
- "description": "2FA already enabled"
+ "description": "Invalid content type or empty body"
},
"401": {
- "description": "Not authenticated"
+ "description": "Authentication required"
+ },
+ "403": {
+ "description": "CVM not in workspace"
+ },
+ "404": {
+ "description": "CVM not found"
+ },
+ "409": {
+ "description": "Another operation in progress"
+ },
+ "465": {
+ "description": "Compose hash registration required (Phase 1)"
+ },
+ "466": {
+ "description": "Compose hash invalid or expired"
+ },
+ "467": {
+ "description": "Transaction verification failed"
+ },
+ "468": {
+ "description": "Compose hash not allowed on-chain"
+ },
+ "500": {
+ "description": "KMS configuration or RPC error"
},
"422": {
"description": "Validation Error",
@@ -1139,50 +1413,79 @@
}
}
}
- },
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ]
+ }
}
},
- "/api/v1/auth/2fa/confirm": {
+ "/api/v1/cvms/{cvm_id}/revisions/{revision_id}/redeploy": {
"post": {
"tags": [
- "Authentication"
+ "CVMs"
],
- "summary": "Confirm 2FA setup",
- "description": "Activate 2FA by verifying a TOTP code from authenticator app. Returns backup codes.",
- "operationId": "confirm_2fa_setup_endpoint_api_v1_auth_2fa_confirm_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/TwoFactorSetupRequest"
- }
+ "summary": "Redeploy CVM from a specific revision",
+ "description": "Switch/rollback a CVM to a specified app revision (compose_hash).",
+ "operationId": "redeploy_cvm_revision_api_v1_cvms__cvm_id__revisions__revision_id__redeploy_post",
+ "parameters": [
+ {
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
}
},
- "required": true
- },
+ {
+ "name": "revision_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Revision Id"
+ }
+ },
+ {
+ "name": "transaction_hash",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Optional transaction hash proving on-chain compose hash registration",
+ "title": "Transaction Hash"
+ },
+ "description": "Optional transaction hash proving on-chain compose hash registration"
+ }
+ ],
"responses": {
- "200": {
- "description": "2FA enabled with backup codes",
+ "202": {
+ "description": "Activation initiated",
"content": {
"application/json": {
"schema": {}
}
}
},
- "400": {
- "description": "Invalid code or no pending setup"
- },
"401": {
"description": "Not authenticated"
},
+ "403": {
+ "description": "No workspace access"
+ },
+ "404": {
+ "description": "CVM or revision not found"
+ },
+ "409": {
+ "description": "Another operation is in progress"
+ },
+ "465": {
+ "description": "Compose hash registration required (contract-owned KMS)"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -1193,30 +1496,22 @@
}
}
}
- },
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ]
+ }
}
},
- "/api/v1/auth/2fa/disable": {
- "post": {
+ "/api/v1/cvms/instance-ids": {
+ "patch": {
"tags": [
- "Authentication"
+ "CVMs"
],
- "summary": "Disable 2FA",
- "description": "Turn off 2FA. Requires valid TOTP code or backup code.",
- "operationId": "disable_2fa_endpoint_api_v1_auth_2fa_disable_post",
+ "summary": "Batch refresh CVM instance IDs",
+ "description": "Resolves and persists missing instance_id values. Admin can pass cross-workspace CVM IDs.",
+ "operationId": "handle_batch_refresh_cvm_instance_ids_api_v1_cvms_instance_ids_patch",
"requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TwoFactorDisableRequest"
+ "$ref": "#/components/schemas/BatchInstanceIdRefreshRequest"
}
}
},
@@ -1224,19 +1519,15 @@
},
"responses": {
"200": {
- "description": "2FA disabled",
+ "description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/BatchInstanceIdRefreshResponse"
+ }
}
}
},
- "400": {
- "description": "Invalid verification code"
- },
- "401": {
- "description": "Not authenticated"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -1247,7 +1538,17 @@
}
}
}
- },
+ }
+ }
+ },
+ "/api/v1/cvms/paginated": {
+ "get": {
+ "tags": [
+ "CVMs"
+ ],
+ "summary": "List CVMs (paginated)",
+ "description": "Returns paginated CVMs in current workspace with total count.",
+ "operationId": "handle_list_cvms_paginated_api_v1_cvms_paginated_get",
"security": [
{
"OAuth2AuthorizationCodeBearer": []
@@ -1255,41 +1556,104 @@
{
"APIKeyHeader": []
}
- ]
- }
- },
- "/api/v1/auth/2fa/regenerate-backup-codes": {
- "post": {
- "tags": [
- "Authentication"
],
- "summary": "Regenerate backup codes",
- "description": "Generate new backup codes. Invalidates previous codes. Requires valid TOTP code.",
- "operationId": "regenerate_backup_codes_endpoint_api_v1_auth_2fa_regenerate_backup_codes_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/TwoFactorRegenerateRequest"
- }
- }
+ "parameters": [
+ {
+ "name": "user_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "const": "0",
+ "type": "string"
+ },
+ {
+ "type": "string",
+ "format": "hashid",
+ "description": "A hashed identifier that maps to an internal database ID",
+ "pattern": "^usr_.+",
+ "title": "HashedId[users]",
+ "examples": [
+ "usr_0123abcd"
+ ]
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Filter by owner (admin only). Use '0' for unassigned.",
+ "title": "User Id"
+ },
+ "description": "Filter by owner (admin only). Use '0' for unassigned."
},
- "required": true
- },
+ {
+ "name": "teepod_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Filter by node ID (admin only)",
+ "title": "Teepod Id"
+ },
+ "description": "Filter by node ID (admin only)"
+ },
+ {
+ "name": "page",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "description": "Page number (1-indexed)",
+ "default": 1,
+ "title": "Page"
+ },
+ "description": "Page number (1-indexed)"
+ },
+ {
+ "name": "page_size",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "maximum": 100,
+ "minimum": 1,
+ "description": "Items per page (max 100)",
+ "default": 30,
+ "title": "Page Size"
+ },
+ "description": "Items per page (max 100)"
+ }
+ ],
"responses": {
"200": {
- "description": "New backup codes",
+ "description": "Paginated CVM list with total count",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/PaginatedHostedCvms"
+ },
+ {
+ "$ref": "#/components/schemas/PaginatedCvmInfos"
+ }
+ ],
+ "title": "Response Handle List Cvms Paginated Api V1 Cvms Paginated Get"
+ }
}
}
},
- "400": {
- "description": "Invalid verification code or 2FA not enabled"
- },
"401": {
- "description": "Not authenticated"
+ "description": "Authentication required"
},
"422": {
"description": "Validation Error",
@@ -1301,50 +1665,52 @@
}
}
}
- },
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ]
+ }
}
},
- "/api/v1/auth/2fa/verify": {
- "post": {
+ "/api/v1/cvms/{cvm_id}/instance-id": {
+ "patch": {
"tags": [
- "Authentication"
+ "CVMs"
+ ],
+ "summary": "Refresh CVM instance ID",
+ "description": "Resolve and persist instance_id for a CVM. Default behavior only backfills missing values.",
+ "operationId": "handle_refresh_cvm_instance_id_api_v1_cvms__cvm_id__instance_id_patch",
+ "parameters": [
+ {
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
+ }
+ }
],
- "summary": "Verify 2FA code",
- "description": "Verify a TOTP or backup code. Sets step-up cookie on success.",
- "operationId": "verify_2fa_endpoint_api_v1_auth_2fa_verify_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TwoFactorVerificationRequest"
+ "$ref": "#/components/schemas/InstanceIdRefreshRequest",
+ "default": {
+ "overwrite": false,
+ "dry_run": false
+ }
}
}
- },
- "required": true
+ }
},
"responses": {
"200": {
- "description": "Code valid, step-up cookie set",
+ "description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/InstanceIdRefreshResult"
+ }
}
}
},
- "400": {
- "description": "Invalid code"
- },
- "401": {
- "description": "Not authenticated"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -1355,7 +1721,17 @@
}
}
}
- },
+ }
+ }
+ },
+ "/api/v1/cvms/{cvm_id}": {
+ "get": {
+ "tags": [
+ "CVMs"
+ ],
+ "summary": "Get CVM details",
+ "description": "Returns full CVM details including status, network info, and KMS configuration.",
+ "operationId": "handle_get_cvm_api_v1_cvms__cvm_id__get",
"security": [
{
"OAuth2AuthorizationCodeBearer": []
@@ -1363,95 +1739,45 @@
{
"APIKeyHeader": []
}
- ]
- }
- },
- "/api/v1/auth/2fa/verify-and-set-cookie": {
- "post": {
- "tags": [
- "Authentication"
],
- "summary": "Verify 2FA and set cookie",
- "description": "Verify TOTP code and set step-up cookie for subsequent sensitive operations.",
- "operationId": "verify_2fa_and_set_cookie_api_v1_auth_2fa_verify_and_set_cookie_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/TwoFactorPageVerifyRequest"
- }
+ "parameters": [
+ {
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
}
- },
- "required": true
- },
+ }
+ ],
"responses": {
"200": {
- "description": "2FA verified, step-up cookie set",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Invalid code"
- },
- "401": {
- "description": "Not authenticated"
- },
- "422": {
- "description": "Validation Error",
+ "description": "CVM details",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/teehouse__api__routes__cvms__management__CvmBasicInfo"
+ },
+ {
+ "$ref": "#/components/schemas/CVMInfoDetail"
+ }
+ ],
+ "title": "Response Handle Get Cvm Api V1 Cvms Cvm Id Get"
}
}
}
- }
- },
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ]
- }
- },
- "/api/v1/auth/step-up/verify": {
- "post": {
- "tags": [
- "Authentication"
- ],
- "summary": "Step-up verification",
- "description": "Verify password or TOTP to get step-up cookie. Required for sensitive operations.",
- "operationId": "verify_step_up_and_set_cookie_api_v1_auth_step_up_verify_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/StepUpVerifyRequest"
- }
- }
},
- "required": true
- },
- "responses": {
- "200": {
- "description": "Verification passed, step-up cookie set",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
+ "401": {
+ "description": "Authentication required"
},
- "400": {
- "description": "Neither password nor TOTP provided, or code invalid"
+ "403": {
+ "description": "CVM not in workspace"
},
- "401": {
- "description": "Not authenticated or password incorrect"
+ "404": {
+ "description": "CVM not found"
},
"422": {
"description": "Validation Error",
@@ -1463,67 +1789,38 @@
}
}
}
- },
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ]
- }
- },
- "/api/v1/auth/sessions": {
- "get": {
+ }
+ },
+ "delete": {
"tags": [
- "Authentication"
- ],
- "summary": "List active sessions",
- "description": "Return all active sessions for the current user with device info.",
- "operationId": "get_active_sessions_api_v1_auth_sessions_get",
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
+ "CVMs"
],
+ "summary": "Delete CVM",
+ "description": "Stops and permanently deletes CVM. Data is not recoverable.",
+ "operationId": "handle_remove_cvm_api_v1_cvms__cvm_id__delete",
"parameters": [
{
- "name": "site_key",
- "in": "query",
- "required": false,
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
"schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Site Key"
+ "type": "string",
+ "title": "Cvm Id"
}
}
],
"responses": {
- "200": {
- "description": "List of sessions",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/SessionsListResponse"
- }
- }
- }
+ "204": {
+ "description": "Deletion initiated"
},
"401": {
- "description": "Not authenticated"
+ "description": "Authentication required"
},
- "500": {
- "description": "Session query failed"
+ "403": {
+ "description": "CVM not in workspace"
+ },
+ "404": {
+ "description": "CVM not found"
},
"422": {
"description": "Validation Error",
@@ -1537,25 +1834,26 @@
}
}
},
- "delete": {
+ "patch": {
"tags": [
- "Authentication"
+ "CVMs"
],
- "summary": "Revoke all sessions",
- "description": "Revoke all sessions. By default keeps current session. Requires 2FA step-up.",
- "operationId": "revoke_all_sessions_api_v1_auth_sessions_delete",
- "security": [
+ "summary": "Update CVM",
+ "description": "Unified PATCH endpoint for CVM updates. Only fields present in the request body are applied. Handles resource resize, compose configuration, visibility, environment, and OS image updates. For contract-owned KMS, compose-hash-affecting changes require two-phase flow with on-chain hash registration.",
+ "operationId": "update_cvm_endpoint_api_v1_cvms__cvm_id__patch",
+ "parameters": [
{
- "OAuth2AuthorizationCodeBearer": []
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
+ }
},
{
- "APIKeyHeader": []
- }
- ],
- "parameters": [
- {
- "name": "site_key",
- "in": "query",
+ "name": "X-Compose-Hash",
+ "in": "header",
"required": false,
"schema": {
"anyOf": [
@@ -1566,80 +1864,32 @@
"type": "null"
}
],
- "title": "Site Key"
- }
+ "description": "Compose hash from Phase 1 response (Phase 2 only)",
+ "title": "X-Compose-Hash"
+ },
+ "description": "Compose hash from Phase 1 response (Phase 2 only)"
},
{
- "name": "revoke_current",
- "in": "query",
+ "name": "X-Transaction-Hash",
+ "in": "header",
"required": false,
"schema": {
- "type": "boolean",
- "default": false,
- "title": "Revoke Current"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Sessions revoked",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "401": {
- "description": "Not authenticated"
- },
- "428": {
- "description": "2FA step-up required"
- },
- "500": {
- "description": "Revocation failed"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
}
- }
- }
- }
- }
- }
- },
- "/api/v1/auth/sessions/{jti}": {
- "delete": {
- "tags": [
- "Authentication"
- ],
- "summary": "Revoke session",
- "description": "Revoke a specific session by JTI. Requires 2FA step-up verification.",
- "operationId": "revoke_session_endpoint_api_v1_auth_sessions__jti__delete",
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ],
- "parameters": [
- {
- "name": "jti",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Jti"
- }
+ ],
+ "description": "Transaction hash proving on-chain registration (Phase 2 only)",
+ "title": "X-Transaction-Hash"
+ },
+ "description": "Transaction hash proving on-chain registration (Phase 2 only)"
},
{
- "name": "site_key",
- "in": "query",
+ "name": "X-Prepare-Only",
+ "in": "header",
"required": false,
"schema": {
"anyOf": [
@@ -1650,30 +1900,57 @@
"type": "null"
}
],
- "title": "Site Key"
- }
+ "description": "When 'true', generate a commit token for multisig workflows instead of expecting immediate on-chain registration",
+ "title": "X-Prepare-Only"
+ },
+ "description": "When 'true', generate a commit token for multisig workflows instead of expecting immediate on-chain registration"
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateCvmRequest"
+ }
+ }
+ }
+ },
"responses": {
- "200": {
- "description": "Session revoked",
+ "202": {
+ "description": "Update initiated, track via correlation_id",
"content": {
"application/json": {
"schema": {}
}
}
},
+ "400": {
+ "description": "Invalid request or terms violation"
+ },
"401": {
- "description": "Not authenticated"
+ "description": "Authentication required"
+ },
+ "403": {
+ "description": "CVM not in workspace or GPU rental managed"
},
"404": {
- "description": "Session not found"
+ "description": "CVM not found"
},
- "428": {
- "description": "2FA step-up required"
+ "409": {
+ "description": "Another operation in progress"
},
- "500": {
- "description": "Revocation failed"
+ "465": {
+ "description": "Compose hash registration required (Phase 1)"
+ },
+ "466": {
+ "description": "Compose hash invalid or expired"
+ },
+ "467": {
+ "description": "Transaction verification failed"
+ },
+ "468": {
+ "description": "Compose hash not allowed on-chain"
},
"422": {
"description": "Validation Error",
@@ -1688,52 +1965,44 @@
}
}
},
- "/api/v1/auth/decode-link-token": {
+ "/api/v1/cvms/{cvm_id}/stats": {
"get": {
"tags": [
- "Authentication"
+ "CVMs"
],
- "summary": "Decode OAuth link token",
- "description": "Extract provider and email from OAuth link token for UI display.",
- "operationId": "decode_link_token_api_v1_auth_decode_link_token_get",
+ "summary": "Get CVM system stats",
+ "description": "Returns live system metrics (CPU, memory, disk) from the running CVM.",
+ "operationId": "handle_get_cvm_stats_api_v1_cvms__cvm_id__stats_get",
"parameters": [
{
- "name": "token",
- "in": "query",
+ "name": "cvm_id",
+ "in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "Token"
- }
- },
- {
- "name": "site_key",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Site Key"
+ "title": "Cvm Id"
}
}
],
"responses": {
"200": {
- "description": "Token data (provider, email, name, avatar_url)",
+ "description": "System stats (may be partial if CVM offline)",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/CvmSystemInfo"
+ }
}
}
},
- "400": {
- "description": "Invalid or expired token"
+ "401": {
+ "description": "Authentication required"
+ },
+ "403": {
+ "description": "CVM not in workspace"
+ },
+ "404": {
+ "description": "CVM not found"
},
"422": {
"description": "Validation Error",
@@ -1748,44 +2017,44 @@
}
}
},
- "/api/v1/auth/verify-and-link-oauth": {
- "post": {
+ "/api/v1/cvms/{cvm_id}/attestation": {
+ "get": {
"tags": [
- "Authentication"
+ "CVMs"
],
- "summary": "Link OAuth account",
- "description": "Verify password/2FA and link OAuth account. Used when OAuth email matches existing user.",
- "operationId": "verify_and_link_oauth_api_v1_auth_verify_and_link_oauth_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/VerifyAndLinkOAuthRequest"
- }
+ "summary": "Get CVM attestation",
+ "description": "Returns TEE attestation data including TCB info and app certificates.",
+ "operationId": "handle_get_cvm_attestation_api_v1_cvms__cvm_id__attestation_get",
+ "parameters": [
+ {
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
}
- },
- "required": true
- },
+ }
+ ],
"responses": {
"200": {
- "description": "Account linked and logged in, or requires_2fa flag",
+ "description": "Attestation report (may have error if CVM offline)",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/CvmAttestation"
+ }
}
}
},
- "400": {
- "description": "Invalid token, password required, or link failed"
- },
"401": {
- "description": "Invalid password or 2FA code"
+ "description": "Authentication required"
},
- "404": {
- "description": "User not found"
+ "403": {
+ "description": "CVM not in workspace"
},
- "423": {
- "description": "Account is disabled"
+ "404": {
+ "description": "CVM not found"
},
"422": {
"description": "Validation Error",
@@ -1800,34 +2069,45 @@
}
}
},
- "/api/v1/cvms/pubkey/from_cvm_configuration": {
- "post": {
+ "/api/v1/cvms/{cvm_id}/network": {
+ "get": {
"tags": [
"CVMs"
],
- "summary": "Get pubkey from config (legacy)",
- "description": "Deprecated. Returns app_id and encryption pubkey from VM configuration.",
- "operationId": "handle_get_pubkey_from_cvm_configuration_api_v1_cvms_pubkey_from_cvm_configuration_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/VMCreateWithTeepod",
- "description": "The Compose Manifest"
- }
+ "summary": "Get CVM network info",
+ "description": "Returns network status including internal IP, handshake time, and public URLs.",
+ "operationId": "handle_get_cvm_network_info_api_v1_cvms__cvm_id__network_get",
+ "parameters": [
+ {
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
}
- },
- "required": true
- },
+ }
+ ],
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "Network info (may have error if offline)",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/CvmNetwork"
+ }
}
}
},
+ "401": {
+ "description": "Authentication required"
+ },
+ "403": {
+ "description": "Access denied"
+ },
+ "404": {
+ "description": "CVM not found"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -1838,40 +2118,31 @@
}
}
}
- },
- "deprecated": true,
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ]
+ }
}
},
- "/api/v1/cvms/from_cvm_configuration": {
+ "/api/v1/cvms/{cvm_id}/start": {
"post": {
"tags": [
"CVMs"
],
- "summary": "Create CVM from config (legacy)",
- "description": "Deprecated. Creates CVM from raw VM configuration payload.",
- "operationId": "handle_create_cvm_with_vm_config_api_v1_cvms_from_cvm_configuration_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/VMCreateWithTeepod",
- "description": "The Compose Manifest"
- }
+ "summary": "Start CVM",
+ "description": "Powers on a stopped CVM. GPU allocation happens during start.",
+ "operationId": "handle_start_cvm_api_v1_cvms__cvm_id__start_post",
+ "parameters": [
+ {
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
}
- },
- "required": true
- },
+ }
+ ],
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "CVM record with starting status",
"content": {
"application/json": {
"schema": {
@@ -1880,6 +2151,24 @@
}
}
},
+ "401": {
+ "description": "Authentication required"
+ },
+ "403": {
+ "description": "CVM not in workspace"
+ },
+ "404": {
+ "description": "CVM not found"
+ },
+ "400": {
+ "description": "Insufficient balance"
+ },
+ "409": {
+ "description": "Another operation in progress"
+ },
+ "500": {
+ "description": "GPU allocation failed"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -1890,51 +2179,51 @@
}
}
}
- },
- "deprecated": true,
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ]
+ }
}
},
- "/api/v1/cvms/provision/eliza": {
+ "/api/v1/cvms/{cvm_id}/shutdown": {
"post": {
"tags": [
"CVMs"
],
- "summary": "Provision Eliza app",
- "description": "Validates Eliza configuration and caches it for 7 days. Returns compose_hash and KMS info for on-chain registration.",
- "operationId": "handle_provision_cvm_for_eliza_api_v1_cvms_provision_eliza_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ProvisionElizaRequest"
- }
+ "summary": "Shutdown CVM",
+ "description": "Gracefully shuts down CVM (SIGTERM then SIGKILL after timeout). Triggers billing.",
+ "operationId": "handle_shutdown_cvm_api_v1_cvms__cvm_id__shutdown_post",
+ "parameters": [
+ {
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
}
- },
- "required": true
- },
+ }
+ ],
"responses": {
"200": {
- "description": "Provision data with compose_hash for creation",
+ "description": "CVM record with shutting_down status",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/VM"
+ }
}
}
},
- "400": {
- "description": "Invalid configuration"
- },
"401": {
"description": "Authentication required"
},
+ "403": {
+ "description": "CVM managed by on-demand GPU rental"
+ },
+ "404": {
+ "description": "CVM not found"
+ },
+ "409": {
+ "description": "Another operation in progress"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -1948,549 +2237,14 @@
}
}
},
- "/api/v1/cvms/provision": {
+ "/api/v1/cvms/{cvm_id}/stop": {
"post": {
"tags": [
"CVMs"
],
- "summary": "Provision DStack app",
- "description": "Validates Docker Compose configuration and caches it for 7 days. Returns compose_hash and KMS info for on-chain registration before creation.",
- "operationId": "handle_provision_cvm_api_v1_cvms_provision_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ProvisionDstackAppRequestV2"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Provision data with compose_hash for creation",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Invalid Docker Compose configuration"
- },
- "401": {
- "description": "Authentication required"
- },
- "422": {
- "description": "Validation error"
- }
- }
- }
- },
- "/api/v1/cvms/workload": {
- "post": {
- "tags": [
- "CVMs"
- ],
- "summary": "Create GPU workload CVM",
- "description": "Creates a CVM for GPU workloads. Node is auto-selected from available GPU nodes.",
- "operationId": "handle_create_cvm_for_workload_api_v1_cvms_workload_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CreateWorkloadTappRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Created CVM record",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/VM"
- }
- }
- }
- },
- "400": {
- "description": "Creation failed"
- },
- "401": {
- "description": "Authentication required"
- },
- "409": {
- "description": "CVM name already exists in workspace"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- },
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ]
- }
- },
- "/api/v1/cvms": {
- "post": {
- "tags": [
- "CVMs"
- ],
- "summary": "Create CVM from provision",
- "description": "Creates a CVM using cached provision data from /cvms/provision. Requires compose_hash from the provision response.",
- "operationId": "handle_create_cvm_from_povision_api_v1_cvms_post",
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CreateTappRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Created CVM record with teepod info",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/VM"
- }
- }
- }
- },
- "400": {
- "description": "Invalid payload or provision data expired"
- },
- "401": {
- "description": "Authentication required"
- },
- "422": {
- "description": "Provision data not found"
- }
- }
- },
- "get": {
- "tags": [
- "CVMs"
- ],
- "summary": "List CVMs",
- "description": "Returns CVMs in current workspace. Admins can filter by user_id or teepod_id.",
- "operationId": "handle_list_cvms_api_v1_cvms_get",
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ],
- "parameters": [
- {
- "name": "user_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "const": "0",
- "type": "string"
- },
- {
- "type": "string",
- "format": "hashid",
- "description": "A hashed identifier that maps to an internal database ID",
- "pattern": "^usr_.+",
- "title": "HashedId[users]",
- "examples": [
- "usr_0123abcd"
- ]
- },
- {
- "type": "null"
- }
- ],
- "description": "Filter by owner (admin only). Use '0' for unassigned.",
- "title": "User Id"
- },
- "description": "Filter by owner (admin only). Use '0' for unassigned."
- },
- {
- "name": "teepod_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "description": "Filter by node ID (admin only)",
- "title": "Teepod Id"
- },
- "description": "Filter by node ID (admin only)"
- }
- ],
- "responses": {
- "200": {
- "description": "List of CVM summaries",
- "content": {
- "application/json": {
- "schema": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/HostedCvm"
- }
- },
- {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/teehouse__api__routes__cvms__v20260121__schemas__CVMInfo"
- }
- }
- ],
- "title": "Response Handle List Cvms Api V1 Cvms Get"
- }
- }
- }
- },
- "401": {
- "description": "Authentication required"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/eliza": {
- "post": {
- "tags": [
- "CVMs"
- ],
- "summary": "Create Eliza from provision",
- "description": "Creates an Eliza CVM using cached provision data from /cvms/provision/eliza. Requires compose_hash from the provision response.",
- "operationId": "handle_create_eliza_from_provision_api_v1_cvms_eliza_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CreateTappRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Created Eliza CVM record",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/VM"
- }
- }
- }
- },
- "400": {
- "description": "Invalid payload"
- },
- "401": {
- "description": "Authentication required"
- },
- "422": {
- "description": "Provision data not found or expired"
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/compose_file": {
- "get": {
- "tags": [
- "CVMs"
- ],
- "summary": "Get raw compose file",
- "description": "Returns the complete compose file as JSON or raw text based on query param.",
- "operationId": "get_cvm_compose_file_api_v1_cvms__cvm_id__compose_file_get",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- },
- {
- "name": "raw",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Raw"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Compose file content",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "500": {
- "description": "Failed to retrieve compose file"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- },
- "patch": {
- "tags": [
- "CVMs"
- ],
- "summary": "Trigger compose file update",
- "description": "Applies a provisioned compose file update. Requires compose_hash from provision endpoint. Restarts the CVM with new configuration.",
- "operationId": "trigger_cvm_compose_file_update_api_v1_cvms__cvm_id__compose_file_patch",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Body_trigger_cvm_compose_file_update_api_v1_cvms__cvm_id__compose_file_patch"
- }
- }
- }
- },
- "responses": {
- "202": {
- "description": "Update initiated",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Provision not found or invalid CVM"
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "503": {
- "description": "Node under maintenance"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- },
- "post": {
- "tags": [
- "CVMs"
- ],
- "summary": "Submit compose file update",
- "description": "Submit complete compose file with hash verification. Use when you have pre-computed compose_hash and want to skip provision step.",
- "operationId": "submit_cvm_compose_file_update_api_v1_cvms__cvm_id__compose_file_post",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ComposeFileUpdateRequest",
- "description": "Complete compose file with hash"
- }
- }
- }
- },
- "responses": {
- "202": {
- "description": "Update initiated",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Invalid CVM or hash mismatch"
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "422": {
- "description": "Invalid Docker Compose syntax"
- },
- "503": {
- "description": "Node under maintenance"
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/compose_file/provision": {
- "post": {
- "tags": [
- "CVMs"
- ],
- "summary": "Provision compose file update",
- "description": "Validates new compose file and returns compose_hash for on-chain registration. Cache expires after 7 days.",
- "operationId": "provision_for_cvm_compose_file_update_api_v1_cvms__cvm_id__compose_file_provision_post",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ProvisionComposeFileUpdateRequest",
- "description": "Updated compose configuration"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Provision response with compose_hash and KMS info",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ComposeFileProvisionResponse"
- }
- }
- }
- },
- "400": {
- "description": "Empty Docker Compose file or invalid CVM"
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "422": {
- "description": "Invalid Docker Compose syntax"
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/compose": {
- "get": {
- "tags": [
- "CVMs"
- ],
- "summary": "Get compose with metadata (legacy)",
- "description": "Deprecated. Returns compose file with env pubkey and salt.",
- "operationId": "handle_get_cvm_compose_api_v1_cvms__cvm_id__compose_get",
- "deprecated": true,
+ "summary": "Force stop CVM",
+ "description": "Immediately stops CVM (like pulling power). Cancels any in-progress operation. Triggers billing.",
+ "operationId": "handle_stop_cvm_api_v1_cvms__cvm_id__stop_post",
"parameters": [
{
"name": "cvm_id",
@@ -2499,3379 +2253,28 @@
"schema": {
"type": "string",
"title": "Cvm Id"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CvmComposeFile"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- },
- "put": {
- "tags": [
- "CVMs"
- ],
- "summary": "Replace compose file (legacy)",
- "description": "Deprecated. Replaces entire compose configuration and restarts CVM.",
- "operationId": "handle_update_cvm_compose_api_v1_cvms__cvm_id__compose_put",
- "deprecated": true,
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CvmUpgradePayload",
- "description": "Complete upgrade payload"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "202": {
- "description": "Update initiated"
- },
- "400": {
- "description": "Empty Docker Compose or terms violation"
- },
- "422": {
- "description": "Invalid Docker Compose syntax"
- },
- "503": {
- "description": "Node under maintenance"
- }
- }
- },
- "patch": {
- "tags": [
- "CVMs"
- ],
- "summary": "Patch compose file (deprecated, use PATCH /cvms/{cvm_id})",
- "description": "Deprecated. Use PATCH /cvms/{cvm_id} instead. Partially updates compose file fields (docker_compose_file, pre_launch_script, env) without replacing unchanged parts.",
- "operationId": "handle_patch_cvm_compose_api_v1_cvms__cvm_id__compose_patch",
- "deprecated": true,
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ComposeFilePatchRequest",
- "description": "Fields to update"
- }
- }
- }
- },
- "responses": {
- "202": {
- "description": "Update initiated",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Empty Docker Compose or terms violation"
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "422": {
- "description": "Invalid Docker Compose syntax"
- },
- "500": {
- "description": "Failed to get current compose"
- },
- "503": {
- "description": "Node under maintenance or offline"
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/replicas": {
- "post": {
- "tags": [
- "CVMs"
- ],
- "summary": "Replicate CVM",
- "description": "Create a replica of the CVM on a target node. If request body is omitted, it replicates to the source node and reuses existing env.",
- "operationId": "handle_replicate_cvm_api_v1_cvms__cvm_id__replicas_post",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/teehouse__api__routes__cvms__deployment__ReplicateRequest"
- },
- {
- "type": "null"
- }
- ],
- "title": "Request"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Replica CVM created",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Invalid target node, image mismatch, or invalid encrypted_env"
- },
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM or target node not found"
- },
- "465": {
- "description": "KMS allowlist rejection (contract-owned KMS)"
- },
- "500": {
- "description": "Replication failed"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/operations": {
- "get": {
- "tags": [
- "CVMs"
- ],
- "summary": "List CVM operations",
- "description": "Returns operation records grouped by correlation_id. Only includes events with correlation_id (new format since 2024-01). Error messages are sanitized for non-admin users.",
- "operationId": "get_cvm_operations_api_v1_cvms__cvm_id__operations_get",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- },
- {
- "name": "cursor",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Opaque cursor from previous response",
- "title": "Cursor"
- },
- "description": "Opaque cursor from previous response"
- },
- {
- "name": "limit",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "maximum": 500,
- "minimum": 1,
- "description": "Page size",
- "default": 50,
- "title": "Limit"
- },
- "description": "Page size"
- },
- {
- "name": "start_time",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "date-time"
- },
- {
- "type": "null"
- }
- ],
- "description": "Include operations started after this UTC time",
- "title": "Start Time"
- },
- "description": "Include operations started after this UTC time"
- },
- {
- "name": "end_time",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "date-time"
- },
- {
- "type": "null"
- }
- ],
- "description": "Include operations started before this UTC time",
- "title": "End Time"
- },
- "description": "Include operations started before this UTC time"
- },
- {
- "name": "operation_types",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
- "description": "Filter by operation types (e.g. compose_update, power_on)",
- "title": "Operation Types"
- },
- "description": "Filter by operation types (e.g. compose_update, power_on)"
- }
- ],
- "responses": {
- "200": {
- "description": "Paginated operation records",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PaginatedCvmOperationsResponse"
- }
- }
- }
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/docker-compose.yml": {
- "get": {
- "tags": [
- "CVMs"
- ],
- "summary": "Get Docker Compose file",
- "description": "Returns the raw Docker Compose YAML content from the CVM configuration.",
- "operationId": "handle_get_cvm_docker_compose_api_v1_cvms__cvm_id__docker_compose_yml_get",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Docker Compose YAML content",
- "content": {
- "application/json": {
- "schema": {
- "type": "string",
- "title": "Response Handle Get Cvm Docker Compose Api V1 Cvms Cvm Id Docker Compose Yml Get"
- }
- }
- }
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/pre-launch-script": {
- "get": {
- "tags": [
- "CVMs"
- ],
- "summary": "Get pre-launch script",
- "description": "Returns the shell script that runs before containers start.",
- "operationId": "handle_get_cvm_prelaunch_script_api_v1_cvms__cvm_id__pre_launch_script_get",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Pre-launch shell script content",
- "content": {
- "application/json": {
- "schema": {
- "type": "string",
- "title": "Response Handle Get Cvm Prelaunch Script Api V1 Cvms Cvm Id Pre Launch Script Get"
- }
- }
- }
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- },
- "patch": {
- "tags": [
- "CVMs"
- ],
- "summary": "Update pre-launch script",
- "description": "Replaces the pre-launch script and restarts the CVM. For contract-owned KMS, requires two-phase flow with on-chain hash registration.",
- "operationId": "update_cvm_pre_launch_script_api_v1_cvms__cvm_id__pre_launch_script_patch",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- },
- {
- "name": "X-Compose-Hash",
- "in": "header",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Compose hash from Phase 1 response",
- "title": "X-Compose-Hash"
- },
- "description": "Compose hash from Phase 1 response"
- },
- {
- "name": "X-Transaction-Hash",
- "in": "header",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Transaction hash proving on-chain registration",
- "title": "X-Transaction-Hash"
- },
- "description": "Transaction hash proving on-chain registration"
- }
- ],
- "requestBody": {
- "content": {
- "multipart/form-data": {
- "schema": {
- "$ref": "#/components/schemas/Body_update_cvm_pre_launch_script_api_v1_cvms__cvm_id__pre_launch_script_patch"
- }
- }
- }
- },
- "responses": {
- "202": {
- "description": "Update initiated, track via correlation_id",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Invalid content type or empty body"
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "409": {
- "description": "Another operation in progress"
- },
- "465": {
- "description": "Compose hash registration required (Phase 1)"
- },
- "466": {
- "description": "Compose hash invalid or expired"
- },
- "467": {
- "description": "Transaction verification failed"
- },
- "468": {
- "description": "Compose hash not allowed on-chain"
- },
- "500": {
- "description": "KMS configuration or RPC error"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/available-os-images": {
- "get": {
- "tags": [
- "CVMs"
- ],
- "summary": "List available OS images",
- "description": "Returns OS images this CVM can upgrade to, filtered by node availability, KMS allowlist, dev/prod upgrade rules, and GPU compatibility.",
- "operationId": "get_available_os_images_api_v1_cvms__cvm_id__available_os_images_get",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OS images grouped by version (newest first)",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/teehouse__api__routes__cvms__patch_compose_file__AvailableOSImage"
- },
- "title": "Response Get Available Os Images Api V1 Cvms Cvm Id Available Os Images Get"
- }
- }
- }
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/os-image": {
- "patch": {
- "tags": [
- "CVMs"
- ],
- "summary": "Update OS image",
- "description": "Upgrades the CVM to a different OS image. Shuts down, updates, and restarts. Takes several minutes. Track progress via correlation_id.",
- "operationId": "update_cvm_os_image_api_v1_cvms__cvm_id__os_image_patch",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Body_update_cvm_os_image_api_v1_cvms__cvm_id__os_image_patch"
- }
- }
- }
- },
- "responses": {
- "202": {
- "description": "Upgrade initiated, returns correlation_id",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "OS image not available for this CVM"
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "409": {
- "description": "Another operation in progress"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/envs": {
- "patch": {
- "tags": [
- "CVMs"
- ],
- "summary": "Update environment variables",
- "description": "Updates encrypted environment variables. If env_keys changes for contract-owned KMS, requires two-phase flow with on-chain hash registration.",
- "operationId": "update_cvm_envs_api_v1_cvms__cvm_id__envs_patch",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Body_update_cvm_envs_api_v1_cvms__cvm_id__envs_patch"
- }
- }
- }
- },
- "responses": {
- "202": {
- "description": "Update initiated, returns correlation_id and allowed_envs_changed flag",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "409": {
- "description": "Another operation in progress"
- },
- "465": {
- "description": "Compose hash registration required (env_keys changed, Phase 1)"
- },
- "466": {
- "description": "Compose hash invalid or expired"
- },
- "467": {
- "description": "Transaction verification failed"
- },
- "468": {
- "description": "Compose hash not allowed on-chain"
- },
- "500": {
- "description": "KMS configuration or RPC error"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/docker-compose": {
- "patch": {
- "tags": [
- "CVMs"
- ],
- "summary": "Update Docker Compose file",
- "description": "Replaces the docker-compose.yml and restarts the CVM. For contract-owned KMS, requires two-phase flow with on-chain hash registration.",
- "operationId": "update_cvm_docker_compose_api_v1_cvms__cvm_id__docker_compose_patch",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- },
- {
- "name": "X-Compose-Hash",
- "in": "header",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Compose hash from Phase 1 response",
- "title": "X-Compose-Hash"
- },
- "description": "Compose hash from Phase 1 response"
- },
- {
- "name": "X-Transaction-Hash",
- "in": "header",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Transaction hash proving on-chain registration",
- "title": "X-Transaction-Hash"
- },
- "description": "Transaction hash proving on-chain registration"
- }
- ],
- "requestBody": {
- "content": {
- "multipart/form-data": {
- "schema": {
- "$ref": "#/components/schemas/Body_update_cvm_docker_compose_api_v1_cvms__cvm_id__docker_compose_patch"
- }
- }
- }
- },
- "responses": {
- "202": {
- "description": "Update initiated, track via correlation_id",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Invalid content type or empty body"
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "409": {
- "description": "Another operation in progress"
- },
- "465": {
- "description": "Compose hash registration required (Phase 1)"
- },
- "466": {
- "description": "Compose hash invalid or expired"
- },
- "467": {
- "description": "Transaction verification failed"
- },
- "468": {
- "description": "Compose hash not allowed on-chain"
- },
- "500": {
- "description": "KMS configuration or RPC error"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/revisions/{revision_id}/redeploy": {
- "post": {
- "tags": [
- "CVMs"
- ],
- "summary": "Redeploy CVM from a specific revision",
- "description": "Switch/rollback a CVM to a specified app revision (compose_hash).",
- "operationId": "redeploy_cvm_revision_api_v1_cvms__cvm_id__revisions__revision_id__redeploy_post",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- },
- {
- "name": "revision_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Revision Id"
- }
- },
- {
- "name": "transaction_hash",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Optional transaction hash proving on-chain compose hash registration",
- "title": "Transaction Hash"
- },
- "description": "Optional transaction hash proving on-chain compose hash registration"
- }
- ],
- "responses": {
- "202": {
- "description": "Activation initiated",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "No workspace access"
- },
- "404": {
- "description": "CVM or revision not found"
- },
- "409": {
- "description": "Another operation is in progress"
- },
- "465": {
- "description": "Compose hash registration required (contract-owned KMS)"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/instance-ids": {
- "patch": {
- "tags": [
- "CVMs"
- ],
- "summary": "Batch refresh CVM instance IDs",
- "description": "Resolves and persists missing instance_id values. Admin can pass cross-workspace CVM IDs.",
- "operationId": "handle_batch_refresh_cvm_instance_ids_api_v1_cvms_instance_ids_patch",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BatchInstanceIdRefreshRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BatchInstanceIdRefreshResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/paginated": {
- "get": {
- "tags": [
- "CVMs"
- ],
- "summary": "List CVMs (paginated)",
- "description": "Returns paginated CVMs in current workspace with total count.",
- "operationId": "handle_list_cvms_paginated_api_v1_cvms_paginated_get",
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ],
- "parameters": [
- {
- "name": "user_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "const": "0",
- "type": "string"
- },
- {
- "type": "string",
- "format": "hashid",
- "description": "A hashed identifier that maps to an internal database ID",
- "pattern": "^usr_.+",
- "title": "HashedId[users]",
- "examples": [
- "usr_0123abcd"
- ]
- },
- {
- "type": "null"
- }
- ],
- "description": "Filter by owner (admin only). Use '0' for unassigned.",
- "title": "User Id"
- },
- "description": "Filter by owner (admin only). Use '0' for unassigned."
- },
- {
- "name": "teepod_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "description": "Filter by node ID (admin only)",
- "title": "Teepod Id"
- },
- "description": "Filter by node ID (admin only)"
- },
- {
- "name": "page",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "minimum": 1,
- "description": "Page number (1-indexed)",
- "default": 1,
- "title": "Page"
- },
- "description": "Page number (1-indexed)"
- },
- {
- "name": "page_size",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "maximum": 100,
- "minimum": 1,
- "description": "Items per page (max 100)",
- "default": 30,
- "title": "Page Size"
- },
- "description": "Items per page (max 100)"
- }
- ],
- "responses": {
- "200": {
- "description": "Paginated CVM list with total count",
- "content": {
- "application/json": {
- "schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/PaginatedHostedCvms"
- },
- {
- "$ref": "#/components/schemas/PaginatedCvmInfos"
- }
- ],
- "title": "Response Handle List Cvms Paginated Api V1 Cvms Paginated Get"
- }
- }
- }
- },
- "401": {
- "description": "Authentication required"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/instance-id": {
- "patch": {
- "tags": [
- "CVMs"
- ],
- "summary": "Refresh CVM instance ID",
- "description": "Resolve and persist instance_id for a CVM. Default behavior only backfills missing values.",
- "operationId": "handle_refresh_cvm_instance_id_api_v1_cvms__cvm_id__instance_id_patch",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/InstanceIdRefreshRequest",
- "default": {
- "overwrite": false,
- "dry_run": false
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/InstanceIdRefreshResult"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}": {
- "get": {
- "tags": [
- "CVMs"
- ],
- "summary": "Get CVM details",
- "description": "Returns full CVM details including status, network info, and KMS configuration.",
- "operationId": "handle_get_cvm_api_v1_cvms__cvm_id__get",
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ],
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "CVM details",
- "content": {
- "application/json": {
- "schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/teehouse__api__routes__cvms__management__CvmBasicInfo"
- },
- {
- "$ref": "#/components/schemas/CVMInfoDetail"
- }
- ],
- "title": "Response Handle Get Cvm Api V1 Cvms Cvm Id Get"
- }
- }
- }
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- },
- "delete": {
- "tags": [
- "CVMs"
- ],
- "summary": "Delete CVM",
- "description": "Stops and permanently deletes CVM. Data is not recoverable.",
- "operationId": "handle_remove_cvm_api_v1_cvms__cvm_id__delete",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Deletion initiated"
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- },
- "patch": {
- "tags": [
- "CVMs"
- ],
- "summary": "Update CVM",
- "description": "Unified PATCH endpoint for CVM updates. Only fields present in the request body are applied. Handles resource resize, compose configuration, visibility, environment, and OS image updates. For contract-owned KMS, compose-hash-affecting changes require two-phase flow with on-chain hash registration.",
- "operationId": "update_cvm_endpoint_api_v1_cvms__cvm_id__patch",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- },
- {
- "name": "X-Compose-Hash",
- "in": "header",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Compose hash from Phase 1 response (Phase 2 only)",
- "title": "X-Compose-Hash"
- },
- "description": "Compose hash from Phase 1 response (Phase 2 only)"
- },
- {
- "name": "X-Transaction-Hash",
- "in": "header",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Transaction hash proving on-chain registration (Phase 2 only)",
- "title": "X-Transaction-Hash"
- },
- "description": "Transaction hash proving on-chain registration (Phase 2 only)"
- },
- {
- "name": "X-Prepare-Only",
- "in": "header",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "When 'true', generate a commit token for multisig workflows instead of expecting immediate on-chain registration",
- "title": "X-Prepare-Only"
- },
- "description": "When 'true', generate a commit token for multisig workflows instead of expecting immediate on-chain registration"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/UpdateCvmRequest"
- }
- }
- }
- },
- "responses": {
- "202": {
- "description": "Update initiated, track via correlation_id",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Invalid request or terms violation"
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace or GPU rental managed"
- },
- "404": {
- "description": "CVM not found"
- },
- "409": {
- "description": "Another operation in progress"
- },
- "465": {
- "description": "Compose hash registration required (Phase 1)"
- },
- "466": {
- "description": "Compose hash invalid or expired"
- },
- "467": {
- "description": "Transaction verification failed"
- },
- "468": {
- "description": "Compose hash not allowed on-chain"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/visibility": {
- "patch": {
- "tags": [
- "CVMs"
- ],
- "summary": "Update visibility settings (deprecated, use PATCH /cvms/{cvm_id})",
- "description": "Deprecated. Use PATCH /cvms/{cvm_id} instead. Sets public_sysinfo and public_logs flags. Restarts CVM to apply.",
- "operationId": "handle_update_cvm_visibility_api_v1_cvms__cvm_id__visibility_patch",
- "deprecated": true,
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Body_handle_update_cvm_visibility_api_v1_cvms__cvm_id__visibility_patch"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Updated CVM record",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/VM"
- }
- }
- }
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "409": {
- "description": "Another operation in progress"
- },
- "500": {
- "description": "Failed to get VM info"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/stats": {
- "get": {
- "tags": [
- "CVMs"
- ],
- "summary": "Get CVM system stats",
- "description": "Returns live system metrics (CPU, memory, disk) from the running CVM.",
- "operationId": "handle_get_cvm_stats_api_v1_cvms__cvm_id__stats_get",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "System stats (may be partial if CVM offline)",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CvmSystemInfo"
- }
- }
- }
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/composition": {
- "get": {
- "tags": [
- "CVMs"
- ],
- "summary": "Get CVM composition (deprecated)",
- "description": "Deprecated. Returns container composition and runtime config.",
- "operationId": "handle_get_cvm_composition_api_v1_cvms__cvm_id__composition_get",
- "deprecated": true,
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CvmComposition"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/attestation": {
- "get": {
- "tags": [
- "CVMs"
- ],
- "summary": "Get CVM attestation",
- "description": "Returns TEE attestation data including TCB info and app certificates.",
- "operationId": "handle_get_cvm_attestation_api_v1_cvms__cvm_id__attestation_get",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Attestation report (may have error if CVM offline)",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CvmAttestation"
- }
- }
- }
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/network": {
- "get": {
- "tags": [
- "CVMs"
- ],
- "summary": "Get CVM network info",
- "description": "Returns network status including internal IP, handshake time, and public URLs.",
- "operationId": "handle_get_cvm_network_info_api_v1_cvms__cvm_id__network_get",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Network info (may have error if offline)",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CvmNetwork"
- }
- }
- }
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "Access denied"
- },
- "404": {
- "description": "CVM not found"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/start": {
- "post": {
- "tags": [
- "CVMs"
- ],
- "summary": "Start CVM",
- "description": "Powers on a stopped CVM. GPU allocation happens during start.",
- "operationId": "handle_start_cvm_api_v1_cvms__cvm_id__start_post",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "CVM record with starting status",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/VM"
- }
- }
- }
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "400": {
- "description": "Insufficient balance"
- },
- "409": {
- "description": "Another operation in progress"
- },
- "500": {
- "description": "GPU allocation failed"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/shutdown": {
- "post": {
- "tags": [
- "CVMs"
- ],
- "summary": "Shutdown CVM",
- "description": "Gracefully shuts down CVM (SIGTERM then SIGKILL after timeout). Triggers billing.",
- "operationId": "handle_shutdown_cvm_api_v1_cvms__cvm_id__shutdown_post",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "CVM record with shutting_down status",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/VM"
- }
- }
- }
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM managed by on-demand GPU rental"
- },
- "404": {
- "description": "CVM not found"
- },
- "409": {
- "description": "Another operation in progress"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/stop": {
- "post": {
- "tags": [
- "CVMs"
- ],
- "summary": "Force stop CVM",
- "description": "Immediately stops CVM (like pulling power). Cancels any in-progress operation. Triggers billing.",
- "operationId": "handle_stop_cvm_api_v1_cvms__cvm_id__stop_post",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "CVM record with stopping status",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/VM"
- }
- }
- }
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM managed by on-demand GPU rental"
- },
- "404": {
- "description": "CVM not found"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/restart": {
- "post": {
- "tags": [
- "CVMs"
- ],
- "summary": "Restart CVM",
- "description": "Stops and starts CVM. Use force=true to skip graceful shutdown.",
- "operationId": "handle_restart_cvm_api_v1_cvms__cvm_id__restart_post",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Body_handle_restart_cvm_api_v1_cvms__cvm_id__restart_post"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "CVM record with restarting status",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/VM"
- }
- }
- }
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "400": {
- "description": "Insufficient balance"
- },
- "409": {
- "description": "Another operation in progress"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/operation-status": {
- "get": {
- "tags": [
- "CVMs"
- ],
- "summary": "Get operation status",
- "description": "Returns current in-progress operation details including Celery task status.",
- "operationId": "get_operation_status_api_v1_cvms__cvm_id__operation_status_get",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Operation status (idle if none in progress)",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM not in workspace"
- },
- "404": {
- "description": "CVM not found"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/resources": {
- "patch": {
- "tags": [
- "CVMs"
- ],
- "summary": "Resize CVM resources (deprecated, use PATCH /cvms/{cvm_id})",
- "description": "Deprecated. Use PATCH /cvms/{cvm_id} instead. Changes vCPU, memory, or disk size. Restarts CVM to apply. Triggers billing for new rate.",
- "operationId": "handle_resize_cvm_api_v1_cvms__cvm_id__resources_patch",
- "deprecated": true,
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CvmResizePayload"
- }
- }
- }
- },
- "responses": {
- "202": {
- "description": "Resize initiated",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "401": {
- "description": "Authentication required"
- },
- "403": {
- "description": "CVM managed by on-demand GPU rental"
- },
- "404": {
- "description": "CVM not found"
- },
- "409": {
- "description": "Another operation in progress"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/name": {
- "patch": {
- "tags": [
- "CVMs"
- ],
- "summary": "Handle Update Cvm Name",
- "description": "Update CVM name with RFC 1123 validation and availability check",
- "operationId": "handle_update_cvm_name_api_v1_cvms__cvm_id__name_patch",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Body_handle_update_cvm_name_api_v1_cvms__cvm_id__name_patch"
- }
- }
- }
- },
- "responses": {
- "204": {
- "description": "Successful Response"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/listed": {
- "patch": {
- "tags": [
- "CVMs"
- ],
- "summary": "Handle Update Cvm Listed",
- "operationId": "handle_update_cvm_listed_api_v1_cvms__cvm_id__listed_patch",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Body_handle_update_cvm_listed_api_v1_cvms__cvm_id__listed_patch"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/VM"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/scheduled-delete": {
- "patch": {
- "tags": [
- "CVMs"
- ],
- "summary": "Handle Update Cvm Scheduled Delete",
- "description": "Update CVM scheduled delete time",
- "operationId": "handle_update_cvm_scheduled_delete_api_v1_cvms__cvm_id__scheduled_delete_patch",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Body_handle_update_cvm_scheduled_delete_api_v1_cvms__cvm_id__scheduled_delete_patch"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/VM"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/batch-stop": {
- "post": {
- "tags": [
- "CVMs"
- ],
- "summary": "Batch stop CVMs",
- "description": "Force stop multiple CVMs at once. Non-admin users can only stop CVMs in their current workspace. Admin users can stop any CVM. Max 50 per request.",
- "operationId": "handle_batch_stop_cvms_api_v1_cvms_batch_stop_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BatchStopRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Batch stop summary",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BatchStopResponse"
- }
- }
- }
- },
- "401": {
- "description": "Authentication required"
- },
- "400": {
- "description": "Invalid request (e.g. too many CVMs)"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/status/batch": {
- "post": {
- "tags": [
- "CVMs"
- ],
- "summary": "Handle Batch Cvm Status",
- "description": "Batch query CVM real-time status.\n\nGroups by teepod and queries in parallel, returns status updates with\ncomplete async operation information.",
- "operationId": "handle_batch_cvm_status_api_v1_status_batch_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BatchStatusRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "additionalProperties": {
- "$ref": "#/components/schemas/CvmStatus"
- },
- "type": "object",
- "title": "Response Handle Batch Cvm Status Api V1 Status Batch Post"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- },
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ]
- }
- },
- "/api/v1/cvms/{cvm_id}/state": {
- "get": {
- "tags": [
- "CVMs"
- ],
- "summary": "Handle Get Cvm State",
- "description": "Get CVM state. Supports two modes:\n\n1. Immediate mode (no target): Returns current state immediately\n2. SSE mode (with target): Streams state updates until status matches target or timeout\n\nExample:\n GET /cvms/{cvm_id}/state - Returns current state\n GET /cvms/{cvm_id}/state?target=running - Streams until status becomes 'running'\n\nSSE connection limit: 5 concurrent connections per user",
- "operationId": "handle_get_cvm_state_api_v1_cvms__cvm_id__state_get",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- },
- {
- "name": "target",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Target status to wait for. If specified, returns SSE stream.",
- "title": "Target"
- },
- "description": "Target status to wait for. If specified, returns SSE stream."
- },
- {
- "name": "interval",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "maximum": 30,
- "minimum": 5,
- "description": "Polling interval in seconds (5-30)",
- "default": 5,
- "title": "Interval"
- },
- "description": "Polling interval in seconds (5-30)"
- },
- {
- "name": "timeout",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "maximum": 600,
- "minimum": 10,
- "description": "Maximum wait time in seconds (10-600)",
- "default": 300,
- "title": "Timeout"
- },
- "description": "Maximum wait time in seconds (10-600)"
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/commit-update": {
- "get": {
- "tags": [
- "CVMs"
- ],
- "summary": "Get commit token info (no auth required)",
- "description": "Read-only lookup of commit token metadata for the confirm-update page.",
- "operationId": "get_commit_update_info_api_v1_cvms__cvm_id__commit_update_get",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- },
- {
- "name": "token",
- "in": "query",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Token"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- },
- "post": {
- "tags": [
- "CVMs"
- ],
- "summary": "Commit CVM update (token-based, no auth required)",
- "description": "Completes a two-phase CVM update using a one-time commit token. The token was generated during a prepare-only PATCH request. No workspace authentication is required — the commit token is the credential.",
- "operationId": "commit_cvm_update_api_v1_cvms__cvm_id__commit_update_post",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- },
- {
- "name": "token",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Commit token (alternative to body.token)",
- "title": "Token"
- },
- "description": "Commit token (alternative to body.token)"
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CommitUpdateRequest",
- "default": {
- "token": "",
- "compose_hash": "",
- "transaction_hash": ""
- }
- }
- }
- }
- },
- "responses": {
- "202": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/customize-domain-diagnose": {
- "post": {
- "tags": [
- "CVMs"
- ],
- "summary": "Diagnose custom domain DNS",
- "description": "Verify DNS records for custom domain configuration. Checks CNAME pointing to CVM, TXT records for app verification, and CAA records.",
- "operationId": "diagnose_custom_domains_api_v1_cvms__cvm_id__customize_domain_diagnose_post",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DiagnoseDomainsRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DiagnosisResponse"
- }
- }
- }
- },
- "400": {
- "description": "Invalid request or multiple CVMs with same name"
- },
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "No access to this CVM"
- },
- "404": {
- "description": "CVM not found"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/cvms/{cvm_id}/user_config": {
- "get": {
- "tags": [
- "CVMs"
- ],
- "summary": "Get CVM user config",
- "description": "Returns the user_config stored in Teepod for this CVM, including injected SSH keys.",
- "operationId": "get_cvm_user_config_api_v1_cvms__cvm_id__user_config_get",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "User config retrieved",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CvmUserConfig"
- }
- }
- }
- },
- "400": {
- "description": "Invalid CVM identifier format, or multiple CVMs share the same name"
- },
- "401": {
- "description": "Not authenticated"
- },
- "404": {
- "description": "CVM not found or not accessible in this workspace"
- },
- "502": {
- "description": "Teepod returned an error or invalid user_config JSON"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/kms": {
- "get": {
- "tags": [
- "KMS"
- ],
- "summary": "List KMS instances",
- "description": "Query available KMS instances with pagination. Filter by onchain status to find instances with blockchain integration.",
- "operationId": "list_kms_api_v1_kms_get",
- "parameters": [
- {
- "name": "page",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "minimum": 1,
- "description": "Page number (1-indexed)",
- "default": 1,
- "title": "Page"
- },
- "description": "Page number (1-indexed)"
- },
- {
- "name": "page_size",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "maximum": 100,
- "minimum": 1,
- "description": "Items per page (1-100)",
- "default": 20,
- "title": "Page Size"
- },
- "description": "Items per page (1-100)"
- },
- {
- "name": "is_onchain",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "description": "Filter: true=onchain only, false=offchain only, omit=all",
- "title": "Is Onchain"
- },
- "description": "Filter: true=onchain only, false=offchain only, omit=all"
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/KmsListResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/kms/{kms_id}": {
- "get": {
- "tags": [
- "KMS"
- ],
- "summary": "Get KMS details",
- "description": "Retrieve KMS instance details by hashed ID or slug.",
- "operationId": "get_kms_info_api_v1_kms__kms_id__get",
- "parameters": [
- {
- "name": "kms_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "description": "KMS ID (hashed) or slug",
- "title": "Kms Id"
- },
- "description": "KMS ID (hashed) or slug"
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/KMSInfo"
- }
- }
- }
- },
- "404": {
- "description": "KMS not found"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/kms/{kms_id}/pubkey/{app_id}": {
- "get": {
- "tags": [
- "KMS"
- ],
- "summary": "Get app encryption pubkey",
- "description": "Retrieve the public key for encrypting environment variables before deployment.",
- "operationId": "get_app_env_encrypt_pubkey_api_v1_kms__kms_id__pubkey__app_id__get",
- "parameters": [
- {
- "name": "app_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "description": "40-character hex string, with or without 0x prefix",
- "title": "App Id"
- },
- "description": "40-character hex string, with or without 0x prefix"
- },
- {
- "name": "kms_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "description": "KMS ID (hashed) or slug",
- "title": "Kms Id"
- },
- "description": "KMS ID (hashed) or slug"
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Invalid app ID format"
- },
- "404": {
- "description": "KMS not found"
- },
- "500": {
- "description": "KMS connection or internal error"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/kms/phala/next_app_id": {
- "get": {
- "tags": [
- "KMS"
- ],
- "summary": "Predict next app IDs",
- "description": "Predict the next N app IDs that will be assigned to the team's wallet. Maximum 20 predictions allowed.",
- "operationId": "get_next_app_id_api_v1_kms_phala_next_app_id_get",
- "parameters": [
- {
- "name": "counts",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "maximum": 20,
- "minimum": 1,
- "description": "Number of app IDs to predict (1-20)",
- "default": 1,
- "title": "Counts"
- },
- "description": "Number of app IDs to predict (1-20)"
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "No workspace access"
- },
- "404": {
- "description": "Workspace not found"
- },
- "500": {
- "description": "Team has no wallet or prediction failed"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/kms/{kms_id}/info": {
- "get": {
- "tags": [
- "KMS"
- ],
- "summary": "Inspect KMS instance",
- "description": "Real-time inspection of a KMS instance. Queries KMS RPC, guest agent, associated Teepod VMMs, and on-chain contract data with cross-validation.",
- "operationId": "inspect_kms_api_v1_kms__kms_id__info_get",
- "parameters": [
- {
- "name": "kms_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Kms Id"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/KmsInspectResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/kms/on-chain/{chain}": {
- "get": {
- "tags": [
- "KMS"
- ],
- "summary": "Get on-chain KMS details by chain",
- "description": "Returns KMS contracts on the specified chain with device and OS image whitelist status.",
- "operationId": "get_kms_onchain_detail_api_v1_kms_on_chain__chain__get",
- "parameters": [
- {
- "name": "chain",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Chain"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/OnChainKmsResponse"
- }
- }
- }
- },
- "400": {
- "description": "Unsupported chain name"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/apps": {
- "get": {
- "tags": [
- "Apps"
- ],
- "summary": "List apps",
- "description": "Returns paginated app list with filtering. Response schema varies by API version.",
- "operationId": "list_dstack_apps_api_v1_apps_get",
- "parameters": [
- {
- "name": "page",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "minimum": 1,
- "description": "Page number (1-indexed)",
- "default": 1,
- "title": "Page"
- },
- "description": "Page number (1-indexed)"
- },
- {
- "name": "page_size",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "maximum": 100,
- "minimum": 1,
- "description": "Items per page",
- "default": 20,
- "title": "Page Size"
- },
- "description": "Items per page"
- },
- {
- "name": "search",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Search name, app_id, vm_uuid, instance_id",
- "title": "Search"
- },
- "description": "Search name, app_id, vm_uuid, instance_id"
- },
- {
- "name": "status",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
- "description": "CVM status filter",
- "title": "Status"
- },
- "description": "CVM status filter"
- },
- {
- "name": "listed",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "description": "Listed status filter",
- "title": "Listed"
- },
- "description": "Listed status filter"
- },
- {
- "name": "base_image",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "OS image name filter",
- "title": "Base Image"
- },
- "description": "OS image name filter"
- },
- {
- "name": "instance_type",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Instance type filter",
- "title": "Instance Type"
- },
- "description": "Instance type filter"
- },
- {
- "name": "kms_slug",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "KMS slug filter",
- "title": "Kms Slug"
- },
- "description": "KMS slug filter"
- },
- {
- "name": "kms_type",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "KMS type filter",
- "title": "Kms Type"
- },
- "description": "KMS type filter"
- },
- {
- "name": "node",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Node name filter (matches teepod or node name)",
- "title": "Node"
- },
- "description": "Node name filter (matches teepod or node name)"
- },
- {
- "name": "region",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Region identifier filter",
- "title": "Region"
- },
- "description": "Region identifier filter"
- }
- ],
- "responses": {
- "200": {
- "description": "Paginated app list",
- "content": {
- "application/json": {
- "schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/teehouse__api__routes__apps__v20251028__schemas__DstackAppListResponse"
- },
- {
- "$ref": "#/components/schemas/teehouse__api__routes__apps__v20260121__schemas__DstackAppListResponse"
- }
- ],
- "title": "Response List Dstack Apps Api V1 Apps Get"
- }
- }
- }
- },
- "401": {
- "description": "Not authenticated"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/apps/filter-options": {
- "get": {
- "tags": [
- "Apps"
- ],
- "summary": "Get app filter options",
- "description": "Returns distinct values for each filterable field based on user's apps.",
- "operationId": "get_filter_options_api_v1_apps_filter_options_get",
- "responses": {
- "200": {
- "description": "Available filter values",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/FilterOptionsResponse"
- }
- }
- }
- },
- "401": {
- "description": "Not authenticated"
- }
- }
- }
- },
- "/api/v1/apps/{app_id}": {
- "get": {
- "tags": [
- "Apps"
- ],
- "summary": "Get app details",
- "description": "Returns app metadata and current CVM configuration. Response schema varies by API version.",
- "operationId": "get_dstack_app_api_v1_apps__app_id__get",
- "parameters": [
- {
- "name": "app_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "description": "Hex app identifier",
- "title": "App Id"
- },
- "description": "Hex app identifier"
- }
- ],
- "responses": {
- "200": {
- "description": "App details with CVM info",
- "content": {
- "application/json": {
- "schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/teehouse__api__routes__apps__v20251028__schemas__DstackAppFullResponse"
- },
- {
- "$ref": "#/components/schemas/DstackAppMinimalResponse"
- },
- {
- "$ref": "#/components/schemas/teehouse__api__routes__apps__v20260121__schemas__DstackAppFullResponse"
- },
- {
- "$ref": "#/components/schemas/DstackAppMinimalResponse"
- }
- ],
- "title": "Response Get Dstack App Api V1 Apps App Id Get"
- }
- }
- }
- },
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "No workspace access"
- },
- "404": {
- "description": "App not found"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/apps/{app_id}/cvms": {
- "get": {
- "tags": [
- "Apps"
- ],
- "summary": "List app CVMs",
- "description": "Returns CVM instances for an app. Admins see all instances; users see only their own.",
- "operationId": "handle_get_app_cvms_api_v1_apps__app_id__cvms_get",
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ],
- "parameters": [
- {
- "name": "app_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "description": "Hex app identifier",
- "title": "App Id"
- },
- "description": "Hex app identifier"
+ }
}
],
"responses": {
"200": {
- "description": "List of CVM instances",
+ "description": "CVM record with stopping status",
"content": {
"application/json": {
"schema": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/HostedCvm"
- }
- },
- {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/teehouse__api__routes__cvms__v20260121__schemas__CVMInfo"
- }
- }
- ],
- "title": "Response Handle Get App Cvms Api V1 Apps App Id Cvms Get"
+ "$ref": "#/components/schemas/VM"
}
}
}
},
"401": {
- "description": "Not authenticated"
+ "description": "Authentication required"
},
"403": {
- "description": "No workspace access"
+ "description": "CVM managed by on-demand GPU rental"
},
"404": {
- "description": "App not found"
+ "description": "CVM not found"
},
"422": {
"description": "Validation Error",
@@ -5886,58 +2289,37 @@
}
}
},
- "/api/v1/apps/{app_id}/cvms/{vm_uuid}/replicas": {
+ "/api/v1/cvms/{cvm_id}/restart": {
"post": {
"tags": [
- "Apps"
+ "CVMs"
],
- "summary": "Create CVM replica",
- "description": "Clones a CVM to a target node. Uses source node if target not specified.",
- "operationId": "handle_replicate_cvm_api_v1_apps__app_id__cvms__vm_uuid__replicas_post",
+ "summary": "Restart CVM",
+ "description": "Stops and starts CVM. Use force=true to skip graceful shutdown.",
+ "operationId": "handle_restart_cvm_api_v1_cvms__cvm_id__restart_post",
"parameters": [
{
- "name": "app_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "description": "Hex app identifier",
- "title": "App Id"
- },
- "description": "Hex app identifier"
- },
- {
- "name": "vm_uuid",
+ "name": "cvm_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Source CVM UUID",
- "title": "Vm Uuid"
- },
- "description": "Source CVM UUID"
+ "title": "Cvm Id"
+ }
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/teehouse__api__routes__apps__schemas__ReplicateRequest"
- },
- {
- "type": "null"
- }
- ],
- "title": "Request"
+ "$ref": "#/components/schemas/Body_handle_restart_cvm_api_v1_cvms__cvm_id__restart_post"
}
}
}
},
"responses": {
"200": {
- "description": "Replica CVM created",
+ "description": "CVM record with restarting status",
"content": {
"application/json": {
"schema": {
@@ -5946,20 +2328,20 @@
}
}
},
- "400": {
- "description": "App ID mismatch, no OS image, or invalid target node"
- },
"401": {
- "description": "Not authenticated"
+ "description": "Authentication required"
},
"403": {
- "description": "No workspace access"
+ "description": "CVM not in workspace"
},
"404": {
- "description": "CVM or target node not found"
+ "description": "CVM not found"
},
- "500": {
- "description": "Replication failed"
+ "400": {
+ "description": "Insufficient balance"
+ },
+ "409": {
+ "description": "Another operation in progress"
},
"422": {
"description": "Validation Error",
@@ -5974,43 +2356,42 @@
}
}
},
- "/api/v1/apps/{app_id}/device-allowlist": {
+ "/api/v1/cvms/{cvm_id}/operation-status": {
"get": {
"tags": [
- "Apps"
+ "CVMs"
],
- "summary": "Get device allowlist status",
- "description": "Returns the device_id allowlist status for an app's CVMs. For on-chain KMS apps, queries the blockchain in real-time to check which devices are registered in the app contract.",
- "operationId": "get_device_allowlist_api_v1_apps__app_id__device_allowlist_get",
+ "summary": "Get operation status",
+ "description": "Returns current in-progress operation details including Celery task status.",
+ "operationId": "get_operation_status_api_v1_cvms__cvm_id__operation_status_get",
"parameters": [
{
- "name": "app_id",
+ "name": "cvm_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Hex app identifier",
- "title": "App Id"
- },
- "description": "Hex app identifier"
+ "title": "Cvm Id"
+ }
}
],
"responses": {
"200": {
- "description": "Device allowlist status",
+ "description": "Operation status (idle if none in progress)",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/DeviceAllowlistResponse"
- }
+ "schema": {}
}
}
},
"401": {
- "description": "Not authenticated"
+ "description": "Authentication required"
+ },
+ "403": {
+ "description": "CVM not in workspace"
},
"404": {
- "description": "App not found or not on-chain KMS"
+ "description": "CVM not found"
},
"422": {
"description": "Validation Error",
@@ -6025,38 +2406,38 @@
}
}
},
- "/api/v1/apps/{app_id}/attestations": {
- "get": {
+ "/api/v1/cvms/{cvm_id}/name": {
+ "patch": {
"tags": [
- "Apps"
+ "CVMs"
],
- "summary": "Get app attestation data",
- "description": "Returns TEE attestation quotes, event logs, and KMS configuration for running CVMs.",
- "operationId": "handle_get_app_attestation_api_v1_apps__app_id__attestations_get",
+ "summary": "Handle Update Cvm Name",
+ "description": "Update CVM name with RFC 1123 validation and availability check",
+ "operationId": "handle_update_cvm_name_api_v1_cvms__cvm_id__name_patch",
"parameters": [
{
- "name": "app_id",
+ "name": "cvm_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Hex app identifier",
- "title": "App Id"
- },
- "description": "Hex app identifier"
+ "title": "Cvm Id"
+ }
}
],
- "responses": {
- "200": {
- "description": "Attestation data with KMS info and instance quotes",
- "content": {
- "application/json": {
- "schema": {}
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_handle_update_cvm_name_api_v1_cvms__cvm_id__name_patch"
}
}
- },
- "404": {
- "description": "App not found"
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Successful Response"
},
"422": {
"description": "Validation Error",
@@ -6071,74 +2452,45 @@
}
}
},
- "/api/v1/apps/{app_id}/revisions": {
- "get": {
+ "/api/v1/cvms/{cvm_id}/listed": {
+ "patch": {
"tags": [
- "Apps"
+ "CVMs"
],
- "summary": "List app revisions",
- "description": "Returns deployment history with compose hashes, operation types, and user refs.",
- "operationId": "get_app_revisions_api_v1_apps__app_id__revisions_get",
+ "summary": "Handle Update Cvm Listed",
+ "operationId": "handle_update_cvm_listed_api_v1_cvms__cvm_id__listed_patch",
"parameters": [
{
- "name": "app_id",
+ "name": "cvm_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Hex app identifier",
- "title": "App Id"
- },
- "description": "Hex app identifier"
- },
- {
- "name": "page",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "minimum": 1,
- "description": "Page number (1-indexed)",
- "default": 1,
- "title": "Page"
- },
- "description": "Page number (1-indexed)"
- },
- {
- "name": "page_size",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "maximum": 1000,
- "minimum": 1,
- "description": "Items per page",
- "default": 50,
- "title": "Page Size"
- },
- "description": "Items per page"
+ "title": "Cvm Id"
+ }
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_handle_update_cvm_listed_api_v1_cvms__cvm_id__listed_patch"
+ }
+ }
+ }
+ },
"responses": {
"200": {
- "description": "Paginated revision list",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/AppRevisionsResponse"
+ "$ref": "#/components/schemas/VM"
}
}
}
},
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "No workspace access"
- },
- "404": {
- "description": "App not found"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -6152,68 +2504,45 @@
}
}
},
- "/api/v1/apps/{app_id}/revisions/{revision_id}": {
- "get": {
+ "/api/v1/cvms/{cvm_id}/scheduled-delete": {
+ "patch": {
"tags": [
- "Apps"
+ "CVMs"
],
- "summary": "Get revision detail",
- "description": "Returns full revision data including compose file, encrypted env, and user config.",
- "operationId": "get_app_revision_detail_api_v1_apps__app_id__revisions__revision_id__get",
+ "summary": "Handle Update Cvm Scheduled Delete",
+ "description": "Update CVM scheduled delete time",
+ "operationId": "handle_update_cvm_scheduled_delete_api_v1_cvms__cvm_id__scheduled_delete_patch",
"parameters": [
{
- "name": "app_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "description": "Hex app identifier",
- "title": "App Id"
- },
- "description": "Hex app identifier"
- },
- {
- "name": "revision_id",
+ "name": "cvm_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "Revision Id"
+ "title": "Cvm Id"
}
- },
- {
- "name": "raw_compose_file",
- "in": "query",
- "required": false,
- "schema": {
- "type": "boolean",
- "description": "Return compose_file as string instead of dict",
- "default": false,
- "title": "Raw Compose File"
- },
- "description": "Return compose_file as string instead of dict"
}
],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_handle_update_cvm_scheduled_delete_api_v1_cvms__cvm_id__scheduled_delete_patch"
+ }
+ }
+ }
+ },
"responses": {
"200": {
- "description": "Revision detail with compose file",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/AppRevisionDetailResponse"
+ "$ref": "#/components/schemas/VM"
}
}
}
},
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "No workspace access"
- },
- "404": {
- "description": "App or revision not found"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -6227,96 +2556,87 @@
}
}
},
- "/api/v1/apps/{app_id}/revisions/{revision_id}/redeploy": {
+ "/api/v1/cvms/batch-stop": {
"post": {
"tags": [
- "Apps"
+ "CVMs"
],
- "summary": "Redeploy app from a specific revision",
- "description": "Redeploy a CVM to a specific revision. If the app has exactly one CVM, it will be redeployed by default. If the app has multiple CVMs, you must specify target vm_uuids in request body. This schedules async CVM update task(s).",
- "operationId": "redeploy_app_revision_api_v1_apps__app_id__revisions__revision_id__redeploy_post",
- "parameters": [
- {
- "name": "app_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "description": "Hex app identifier",
- "title": "App Id"
- },
- "description": "Hex app identifier"
+ "summary": "Batch stop CVMs",
+ "description": "Force stop multiple CVMs at once. Non-admin users can only stop CVMs in their current workspace. Admin users can stop any CVM. Max 50 per request.",
+ "operationId": "handle_batch_stop_cvms_api_v1_cvms_batch_stop_post",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BatchStopRequest"
+ }
+ }
},
- {
- "name": "revision_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Revision Id"
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Batch stop summary",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BatchStopResponse"
+ }
+ }
}
},
- {
- "name": "transaction_hash",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
+ "401": {
+ "description": "Authentication required"
+ },
+ "400": {
+ "description": "Invalid request (e.g. too many CVMs)"
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
}
- ],
- "description": "Optional transaction hash proving on-chain compose hash registration",
- "title": "Transaction Hash"
- },
- "description": "Optional transaction hash proving on-chain compose hash registration"
+ }
+ }
}
+ }
+ }
+ },
+ "/api/v1/status/batch": {
+ "post": {
+ "tags": [
+ "CVMs"
],
+ "summary": "Handle Batch Cvm Status",
+ "description": "Batch query CVM real-time status.\n\nGroups by teepod and queries in parallel, returns status updates with\ncomplete async operation information.",
+ "operationId": "handle_batch_cvm_status_api_v1_status_batch_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/RedeployRevisionRequest"
- },
- {
- "type": "null"
- }
- ],
- "description": "Optional target CVM selection. If the app has multiple CVMs, you must specify vm_uuids.",
- "title": "Payload"
+ "$ref": "#/components/schemas/BatchStatusRequest"
}
}
- }
+ },
+ "required": true
},
"responses": {
- "202": {
- "description": "Activation initiated",
+ "200": {
+ "description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "additionalProperties": {
+ "$ref": "#/components/schemas/CvmStatus"
+ },
+ "type": "object",
+ "title": "Response Handle Batch Cvm Status Api V1 Status Batch Post"
+ }
}
}
},
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "No workspace access"
- },
- "404": {
- "description": "App or revision not found"
- },
- "409": {
- "description": "Another operation is in progress"
- },
- "465": {
- "description": "Compose hash registration required (contract-owned KMS)"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -6327,100 +2647,37 @@
}
}
}
- }
+ },
+ "security": [
+ {
+ "OAuth2AuthorizationCodeBearer": []
+ },
+ {
+ "APIKeyHeader": []
+ }
+ ]
}
},
- "/api/v1/apps/{app_id}/events": {
+ "/api/v1/cvms/{cvm_id}/state": {
"get": {
"tags": [
- "Apps"
+ "CVMs"
],
- "summary": "Get app events",
- "description": "**DEPRECATED**: Returns instance lifecycle events from ClickHouse. Will be removed.",
- "operationId": "get_app_events_api_v1_apps__app_id__events_get",
- "deprecated": true,
+ "summary": "Handle Get Cvm State",
+ "description": "Get CVM state. Supports two modes:\n\n1. Immediate mode (no target): Returns current state immediately\n2. SSE mode (with target): Streams state updates until status matches target or timeout\n\nExample:\n GET /cvms/{cvm_id}/state - Returns current state\n GET /cvms/{cvm_id}/state?target=running - Streams until status becomes 'running'\n\nSSE connection limit: 5 concurrent connections per user",
+ "operationId": "handle_get_cvm_state_api_v1_cvms__cvm_id__state_get",
"parameters": [
{
- "name": "app_id",
+ "name": "cvm_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Hex app identifier",
- "title": "App Id"
- },
- "description": "Hex app identifier"
- },
- {
- "name": "limit",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "maximum": 1000,
- "minimum": 1,
- "description": "Max events to return",
- "default": 100,
- "title": "Limit"
- },
- "description": "Max events to return"
- },
- {
- "name": "event_type",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Filter by event type",
- "title": "Event Type"
- },
- "description": "Filter by event type"
- },
- {
- "name": "instance_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Filter by instance UUID",
- "title": "Instance Id"
- },
- "description": "Filter by instance UUID"
- },
- {
- "name": "operation_type",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Filter by operation type",
- "title": "Operation Type"
- },
- "description": "Filter by operation type"
+ "title": "Cvm Id"
+ }
},
{
- "name": "start_date",
+ "name": "target",
"in": "query",
"required": false,
"schema": {
@@ -6432,50 +2689,49 @@
"type": "null"
}
],
- "description": "Start date (ISO 8601)",
- "title": "Start Date"
+ "description": "Target status to wait for. If specified, returns SSE stream.",
+ "title": "Target"
},
- "description": "Start date (ISO 8601)"
+ "description": "Target status to wait for. If specified, returns SSE stream."
},
{
- "name": "end_date",
+ "name": "interval",
"in": "query",
"required": false,
"schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "End date (ISO 8601)",
- "title": "End Date"
+ "type": "integer",
+ "maximum": 30,
+ "minimum": 5,
+ "description": "Polling interval in seconds (5-30)",
+ "default": 5,
+ "title": "Interval"
},
- "description": "End date (ISO 8601)"
+ "description": "Polling interval in seconds (5-30)"
+ },
+ {
+ "name": "timeout",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "maximum": 600,
+ "minimum": 10,
+ "description": "Maximum wait time in seconds (10-600)",
+ "default": 300,
+ "title": "Timeout"
+ },
+ "description": "Maximum wait time in seconds (10-600)"
}
],
"responses": {
"200": {
- "description": "Event list",
+ "description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/AppEventsResponse"
- }
+ "schema": {}
}
}
},
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "No workspace access"
- },
- "404": {
- "description": "App not found"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -6489,120 +2745,103 @@
}
}
},
- "/api/v1/apps/{app_id}/usage": {
+ "/api/v1/cvms/{cvm_id}/network-config": {
"get": {
"tags": [
- "Apps"
+ "CVMs",
+ "cvms-network-config"
],
- "summary": "Get app metered usage",
- "description": "Returns billing usage records from ClickHouse. Defaults to 7-day window if dates not specified.",
- "operationId": "get_app_usage_api_v1_apps__app_id__usage_get",
+ "summary": "Get network configuration",
+ "description": "Returns real-time KMS URLs, Gateway URLs, and port mappings from VMM.",
+ "operationId": "handle_get_network_config_api_v1_cvms__cvm_id__network_config_get",
"parameters": [
{
- "name": "app_id",
+ "name": "cvm_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Hex app identifier",
- "title": "App Id"
- },
- "description": "Hex app identifier"
- },
- {
- "name": "start_date",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2024-01-01T00:00:00Z"
- ]
- },
- {
- "type": "null"
+ "title": "Cvm Id"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Network configuration",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NetworkConfigResponse"
}
- ],
- "description": "Start date (ISO 8601)",
- "title": "Start Date"
- },
- "description": "Start date (ISO 8601)"
+ }
+ }
},
- {
- "name": "end_date",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2024-01-01T00:00:00Z"
- ]
- },
- {
- "type": "null"
- }
- ],
- "description": "End date (ISO 8601)",
- "title": "End Date"
- },
- "description": "End date (ISO 8601)"
+ "404": {
+ "description": "CVM not found"
},
- {
- "name": "limit",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "maximum": 5000,
- "minimum": 1,
- "description": "Max records to return",
- "default": 500,
- "title": "Limit"
- },
- "description": "Max records to return"
+ "500": {
+ "description": "Failed to query VMM"
},
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "CVMs",
+ "cvms-network-config"
+ ],
+ "summary": "Update KMS/Gateway URLs",
+ "description": "Update KMS and/or Gateway URLs for this CVM. Requires VMM >= 0.5.7.",
+ "operationId": "handle_update_network_config_api_v1_cvms__cvm_id__network_config_patch",
+ "parameters": [
{
- "name": "offset",
- "in": "query",
- "required": false,
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "integer",
- "minimum": 0,
- "description": "Records to skip",
- "default": 0,
- "title": "Offset"
- },
- "description": "Records to skip"
+ "type": "string",
+ "title": "Cvm Id"
+ }
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateNetworkConfigRequest"
+ }
+ }
+ }
+ },
"responses": {
"200": {
- "description": "Usage records with cost breakdown",
+ "description": "Updated network configuration",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/AppUsageResponse"
+ "$ref": "#/components/schemas/NetworkConfigResponse"
}
}
}
},
"400": {
- "description": "end_date before start_date"
- },
- "401": {
- "description": "Not authenticated"
+ "description": "VMM too old or invalid request"
},
"403": {
- "description": "No workspace access"
+ "description": "Feature not enabled for this workspace"
},
"404": {
- "description": "App not found"
+ "description": "CVM not found"
},
"422": {
"description": "Validation Error",
@@ -6617,21 +2856,72 @@
}
}
},
- "/api/v1/apps/{app_id}/is-allowed": {
- "post": {
+ "/api/v1/cvms/{cvm_id}/ports": {
+ "get": {
"tags": [
- "Apps"
+ "CVMs",
+ "cvms-network-config"
],
- "summary": "Check if app deployment is allowed on-chain",
- "operationId": "handle_app_is_allowed_api_v1_apps__app_id__is_allowed_post",
+ "summary": "Get port mappings",
+ "description": "Returns persisted port mappings for this CVM.",
+ "operationId": "handle_get_port_mappings_api_v1_cvms__cvm_id__ports_get",
"parameters": [
{
- "name": "app_id",
+ "name": "cvm_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "App Id"
+ "title": "Cvm Id"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Port mappings",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PortMappingResponse"
+ },
+ "title": "Response Handle Get Port Mappings Api V1 Cvms Cvm Id Ports Get"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "CVM not found"
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "CVMs",
+ "cvms-network-config"
+ ],
+ "summary": "Set port mappings",
+ "description": "Bulk-replace all port mappings for this CVM. Writes to DB and applies to VMM.",
+ "operationId": "handle_set_port_mappings_api_v1_cvms__cvm_id__ports_put",
+ "parameters": [
+ {
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
}
}
],
@@ -6640,22 +2930,38 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/AppIsAllowedRequest"
+ "$ref": "#/components/schemas/UpdatePortMappingsRequest"
}
}
}
},
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "Updated port mappings",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/AppIsAllowedResponse"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PortMappingResponse"
+ },
+ "title": "Response Handle Set Port Mappings Api V1 Cvms Cvm Id Ports Put"
}
}
}
},
+ "400": {
+ "description": "Invalid request"
+ },
+ "403": {
+ "description": "Feature not enabled for this workspace"
+ },
+ "409": {
+ "description": "Port conflict during concurrent updates"
+ },
+ "404": {
+ "description": "CVM not found"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -6669,21 +2975,23 @@
}
}
},
- "/api/v1/apps/{app_id}/cvms/is-allowed": {
- "post": {
+ "/api/v1/cvms/{cvm_id}/firewall-status": {
+ "get": {
"tags": [
- "Apps"
+ "CVMs",
+ "cvms-network-config"
],
- "summary": "Batch check on-chain deployment allowance for all CVMs under an app",
- "operationId": "handle_app_cvms_is_allowed_api_v1_apps__app_id__cvms_is_allowed_post",
+ "summary": "Get firewall availability for this CVM's node",
+ "description": "Checks teescope capabilities.firewall on the node hosting this CVM.",
+ "operationId": "handle_get_firewall_status_api_v1_cvms__cvm_id__firewall_status_get",
"parameters": [
{
- "name": "app_id",
+ "name": "cvm_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "App Id"
+ "title": "Cvm Id"
}
}
],
@@ -6693,7 +3001,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/AppCvmsBatchIsAllowedResponse"
+ "$ref": "#/components/schemas/FirewallStatusResponse"
}
}
}
@@ -6711,23 +3019,31 @@
}
}
},
- "/api/v1/tokens": {
+ "/api/v1/cvms/{cvm_id}/commit-update": {
"get": {
"tags": [
- "Tokens"
+ "CVMs"
],
- "summary": "List API tokens",
- "description": "Return tokens for the current workspace. Set all_workspaces=true to include tokens from all workspaces the user owns.",
- "operationId": "list_tokens_api_v1_tokens_get",
+ "summary": "Get commit token info (no auth required)",
+ "description": "Read-only lookup of commit token metadata for the confirm-update page.",
+ "operationId": "get_commit_update_info_api_v1_cvms__cvm_id__commit_update_get",
"parameters": [
{
- "name": "all_workspaces",
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
+ }
+ },
+ {
+ "name": "token",
"in": "query",
- "required": false,
+ "required": true,
"schema": {
- "type": "boolean",
- "default": false,
- "title": "All Workspaces"
+ "type": "string",
+ "title": "Token"
}
}
],
@@ -6736,25 +3052,10 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ApiToken"
- },
- "title": "Response List Tokens Api V1 Tokens Get"
- }
+ "schema": {}
}
}
},
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "No workspace access"
- },
- "500": {
- "description": "Token retrieval failed"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -6769,44 +3070,63 @@
},
"post": {
"tags": [
- "Tokens"
+ "CVMs"
+ ],
+ "summary": "Commit CVM update (token-based, no auth required)",
+ "description": "Completes a two-phase CVM update using a one-time commit token. The token was generated during a prepare-only PATCH request. No workspace authentication is required — the commit token is the credential.",
+ "operationId": "commit_cvm_update_api_v1_cvms__cvm_id__commit_update_post",
+ "parameters": [
+ {
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
+ }
+ },
+ {
+ "name": "token",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Commit token (alternative to body.token)",
+ "title": "Token"
+ },
+ "description": "Commit token (alternative to body.token)"
+ }
],
- "summary": "Create API token",
- "description": "Create a new API token scoped to the current workspace. The raw token value is only returned once.",
- "operationId": "create_token_api_v1_tokens_post",
"requestBody": {
- "required": true,
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ApiTokenCreate"
+ "$ref": "#/components/schemas/CommitUpdateRequest",
+ "default": {
+ "token": "",
+ "compose_hash": "",
+ "transaction_hash": ""
+ }
}
}
}
},
"responses": {
- "200": {
+ "202": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/ApiToken"
- }
+ "schema": {}
}
}
},
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "No workspace access"
- },
- "404": {
- "description": "Token not found after creation"
- },
- "500": {
- "description": "Failed to load workspace or user"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -6820,40 +3140,65 @@
}
}
},
- "/api/v1/tokens/{token_id}": {
- "delete": {
+ "/api/v1/cvms/{cvm_id}/commit-replica": {
+ "post": {
"tags": [
- "Tokens"
+ "CVMs"
],
- "summary": "Revoke API token",
- "description": "Permanently revoke a token owned by the current user. Cannot be undone.",
- "operationId": "revoke_token_api_v1_tokens__token_id__delete",
+ "summary": "Commit CVM replica (token-based, no auth required)",
+ "description": "Completes a two-phase CVM replication using a one-time commit token. The token was generated during a prepare-only or hash-required replica request.",
+ "operationId": "commit_cvm_replica_api_v1_cvms__cvm_id__commit_replica_post",
"parameters": [
{
- "name": "token_id",
+ "name": "cvm_id",
"in": "path",
"required": true,
"schema": {
- "type": "integer",
- "title": "Token Id"
+ "type": "string",
+ "title": "Cvm Id"
}
+ },
+ {
+ "name": "token",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Commit token (alternative to body.token)",
+ "title": "Token"
+ },
+ "description": "Commit token (alternative to body.token)"
}
],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CommitUpdateRequest",
+ "default": {
+ "token": "",
+ "compose_hash": "",
+ "transaction_hash": ""
+ }
+ }
+ }
+ }
+ },
"responses": {
- "204": {
- "description": "Successful Response"
- },
- "400": {
- "description": "Token already revoked"
- },
- "401": {
- "description": "Not authenticated"
- },
- "404": {
- "description": "Token not found or no access"
- },
- "500": {
- "description": "Revocation failed"
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
},
"422": {
"description": "Validation Error",
@@ -6868,22 +3213,22 @@
}
}
},
- "/api/v1/tokens/{token_id}/refresh": {
+ "/api/v1/cvms/{cvm_id}/customize-domain-diagnose": {
"post": {
"tags": [
- "Tokens"
+ "CVMs"
],
- "summary": "Refresh API token",
- "description": "Extend expiration or upgrade to the latest API version. Does not regenerate the token secret.",
- "operationId": "refresh_token_api_v1_tokens__token_id__refresh_post",
+ "summary": "Diagnose custom domain DNS",
+ "description": "Verify DNS records for custom domain configuration. Checks CNAME pointing to CVM, TXT records for app verification, and CAA records.",
+ "operationId": "diagnose_custom_domains_api_v1_cvms__cvm_id__customize_domain_diagnose_post",
"parameters": [
{
- "name": "token_id",
+ "name": "cvm_id",
"in": "path",
"required": true,
"schema": {
- "type": "integer",
- "title": "Token Id"
+ "type": "string",
+ "title": "Cvm Id"
}
}
],
@@ -6892,7 +3237,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ApiTokenRefresh"
+ "$ref": "#/components/schemas/DiagnoseDomainsRequest"
}
}
}
@@ -6903,19 +3248,22 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ApiToken"
+ "$ref": "#/components/schemas/DiagnosisResponse"
}
}
}
},
+ "400": {
+ "description": "Invalid request or multiple CVMs with same name"
+ },
"401": {
"description": "Not authenticated"
},
- "404": {
- "description": "Token not found, inactive, or no access"
+ "403": {
+ "description": "No access to this CVM"
},
- "500": {
- "description": "Refresh failed"
+ "404": {
+ "description": "CVM not found"
},
"422": {
"description": "Validation Error",
@@ -6930,39 +3278,47 @@
}
}
},
- "/api/v1/charge": {
- "post": {
+ "/api/v1/cvms/{cvm_id}/user_config": {
+ "get": {
"tags": [
- "Billing"
+ "CVMs"
],
- "summary": "Create payment charge",
- "description": "Creates a payment order with the specified provider (Coinbase, Square, Stripe, or Mock). For Stripe with saved card, attempts direct charge before falling back to checkout session. Returns hosted_url for redirect-based flows or status for direct charges.",
- "operationId": "create_charge_api_v1_charge_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ChargeRequest",
- "description": "Payment amount, provider, and optional code/invoice_id"
- }
+ "summary": "Get CVM user config",
+ "description": "Returns the user_config stored in Teepod for this CVM, including injected SSH keys.",
+ "operationId": "get_cvm_user_config_api_v1_cvms__cvm_id__user_config_get",
+ "parameters": [
+ {
+ "name": "cvm_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Cvm Id"
}
- },
- "required": true
- },
+ }
+ ],
"responses": {
"200": {
- "description": "Charge created with provider-specific response",
+ "description": "User config retrieved",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/CvmUserConfig"
+ }
}
}
},
"400": {
- "description": "Team has no credit, Square disabled, or unsupported provider"
+ "description": "Invalid CVM identifier format, or multiple CVMs share the same name"
},
- "500": {
- "description": "Payment provider API error"
+ "401": {
+ "description": "Not authenticated"
+ },
+ "404": {
+ "description": "CVM not found or not accessible in this workspace"
+ },
+ "502": {
+ "description": "Teepod returned an error or invalid user_config JSON"
},
"422": {
"description": "Validation Error",
@@ -6977,35 +3333,30 @@
}
}
},
- "/api/v1/orders": {
+ "/api/v1/kms": {
"get": {
"tags": [
- "Billing"
+ "KMS"
],
- "summary": "List payment orders",
- "description": "Returns paginated orders with cursor-based pagination. Excludes 'created' status by default. Admins can query by user_id.",
- "operationId": "handle_list_orders_api_v1_orders_get",
+ "summary": "List KMS instances",
+ "description": "Query available KMS instances with pagination. Filter by onchain status to find instances with blockchain integration.",
+ "operationId": "list_kms_api_v1_kms_get",
"parameters": [
{
- "name": "cursor",
+ "name": "page",
"in": "query",
"required": false,
"schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Hashid-encoded cursor from previous response",
- "title": "Cursor"
+ "type": "integer",
+ "minimum": 1,
+ "description": "Page number (1-indexed)",
+ "default": 1,
+ "title": "Page"
},
- "description": "Hashid-encoded cursor from previous response"
+ "description": "Page number (1-indexed)"
},
{
- "name": "limit",
+ "name": "page_size",
"in": "query",
"required": false,
"schema": {
@@ -7014,89 +3365,40 @@
"minimum": 1,
"description": "Items per page (1-100)",
"default": 20,
- "title": "Limit"
+ "title": "Page Size"
},
"description": "Items per page (1-100)"
},
{
- "name": "provider",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/PaymentProvider"
- },
- {
- "type": "null"
- }
- ],
- "description": "Filter: coinbase, square, stripe, mock",
- "title": "Provider"
- },
- "description": "Filter: coinbase, square, stripe, mock"
- },
- {
- "name": "status",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/OrderStatus"
- },
- {
- "type": "null"
- }
- ],
- "description": "Filter: created, submitted, pending, purchased, finalized, failed",
- "title": "Status"
- },
- "description": "Filter: created, submitted, pending, purchased, finalized, failed"
- },
- {
- "name": "user_id",
+ "name": "is_onchain",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
- "type": "string",
- "format": "hashid",
- "description": "A hashed identifier that maps to an internal database ID",
- "pattern": "^usr_.+",
- "title": "HashedId[users]",
- "examples": [
- "usr_0123abcd"
- ]
+ "type": "boolean"
},
{
"type": "null"
}
],
- "description": "Target user ID (admin only)",
- "title": "User Id"
+ "description": "Filter: true=onchain only, false=offchain only, omit=all",
+ "title": "Is Onchain"
},
- "description": "Target user ID (admin only)"
+ "description": "Filter: true=onchain only, false=offchain only, omit=all"
}
],
"responses": {
"200": {
- "description": "Paginated orders with has_more and next_cursor",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/OrdersListResponse"
+ "$ref": "#/components/schemas/KmsListResponse"
}
}
}
},
- "400": {
- "description": "Invalid cursor format"
- },
- "403": {
- "description": "Non-admin tried to query another user's orders"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -7110,104 +3412,103 @@
}
}
},
- "/api/v1/debt": {
+ "/api/v1/kms/{kms_id}": {
"get": {
"tags": [
- "Billing"
+ "KMS"
],
- "summary": "Get outstanding debt",
- "description": "Returns the total overdue payment amount for the current workspace. Zero if no debt exists.",
- "operationId": "handle_get_debt_api_v1_debt_get",
- "responses": {
- "200": {
- "description": "Debt amount (Money type, quantized)",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
+ "summary": "Get KMS details",
+ "description": "Retrieve KMS instance details by hashed ID or slug.",
+ "operationId": "get_kms_info_api_v1_kms__kms_id__get",
+ "parameters": [
+ {
+ "name": "kms_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "KMS ID (hashed) or slug",
+ "title": "Kms Id"
+ },
+ "description": "KMS ID (hashed) or slug"
}
- }
- }
- },
- "/api/v1/debt/settlement": {
- "post": {
- "tags": [
- "Billing"
],
- "summary": "Settle outstanding debt",
- "description": "Pays off outstanding debt using available credit balance. Deducts from granted_balance first, then balance.",
- "operationId": "handle_debt_settlement_api_v1_debt_settlement_post",
"responses": {
- "202": {
- "description": "Debt settled with breakdown of amounts used",
+ "200": {
+ "description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/KMSInfo"
+ }
}
}
},
- "400": {
- "description": "No debt to settle, insufficient balance, or credit account missing"
+ "404": {
+ "description": "KMS not found"
},
- "500": {
- "description": "Unexpected settlement state"
- }
- }
- }
- },
- "/api/v1/card": {
- "get": {
- "tags": [
- "Billing"
- ],
- "summary": "Get saved card info",
- "description": "Returns the last4, brand, and payment_method_id of the user's verified card. Includes a Stripe billing portal URL for card management.",
- "operationId": "get_card_info_api_v1_card_get",
- "responses": {
- "200": {
- "description": "Card info with found=true, or found=false if no verified card",
+ "422": {
+ "description": "Validation Error",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
}
}
}
}
}
},
- "/api/v1/card/{payment_method_id}": {
- "delete": {
+ "/api/v1/kms/{kms_id}/pubkey/{app_id}": {
+ "get": {
"tags": [
- "Billing"
+ "KMS"
],
- "summary": "Remove saved card",
- "description": "Detaches the payment method from Stripe, marks verification as failed, clears default payment method, and downgrades team tier to LEVEL_1.",
- "operationId": "remove_card_api_v1_card__payment_method_id__delete",
+ "summary": "Get app encryption pubkey",
+ "description": "Retrieve the public key for encrypting environment variables before deployment.",
+ "operationId": "get_app_env_encrypt_pubkey_api_v1_kms__kms_id__pubkey__app_id__get",
"parameters": [
{
- "name": "payment_method_id",
+ "name": "app_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "40-character hex string, with or without 0x prefix",
+ "title": "App Id"
+ },
+ "description": "40-character hex string, with or without 0x prefix"
+ },
+ {
+ "name": "kms_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Stripe payment method ID (pm_...)",
- "title": "Payment Method Id"
+ "description": "KMS ID (hashed) or slug",
+ "title": "Kms Id"
},
- "description": "Stripe payment method ID (pm_...)"
+ "description": "KMS ID (hashed) or slug"
}
],
"responses": {
"200": {
- "description": "Card removed successfully",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
+ "400": {
+ "description": "Invalid app ID format"
+ },
"404": {
- "description": "Card not found or not owned by user"
+ "description": "KMS not found"
+ },
+ "500": {
+ "description": "KMS connection or internal error"
},
"422": {
"description": "Validation Error",
@@ -7222,135 +3523,94 @@
}
}
},
- "/api/v1/credits": {
+ "/api/v1/kms/phala/next_app_id": {
"get": {
"tags": [
- "Billing"
+ "KMS"
+ ],
+ "summary": "Predict next app IDs",
+ "description": "Predict the next N app IDs that will be assigned to the team's wallet. Maximum 20 predictions allowed.",
+ "operationId": "get_next_app_id_api_v1_kms_phala_next_app_id_get",
+ "parameters": [
+ {
+ "name": "counts",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "maximum": 20,
+ "minimum": 1,
+ "description": "Number of app IDs to predict (1-20)",
+ "default": 1,
+ "title": "Counts"
+ },
+ "description": "Number of app IDs to predict (1-20)"
+ }
],
- "summary": "Get credit balance",
- "description": "Returns the user's credit account with balance, granted_balance, and Stripe customer ID.",
- "operationId": "get_credits_api_v1_credits_get",
"responses": {
"200": {
- "description": "Credit account details",
+ "description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/teehouse__models__schemas__credits__Credit"
- }
+ "schema": {}
}
}
},
+ "401": {
+ "description": "Not authenticated"
+ },
+ "403": {
+ "description": "No workspace access"
+ },
"404": {
- "description": "User has no credit account"
- }
- }
- }
- },
- "/api/v1/billing/balance": {
- "get": {
- "tags": [
- "Billing"
- ],
- "summary": "Get workspace billing balance",
- "description": "Returns the current workspace's credit balance, granted balance, outstanding debt, and tier.",
- "operationId": "get_billing_balance_api_v1_billing_balance_get",
- "responses": {
- "200": {
- "description": "Workspace billing balance",
+ "description": "Workspace not found"
+ },
+ "500": {
+ "description": "Team has no wallet or prediction failed"
+ },
+ "422": {
+ "description": "Validation Error",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BillingBalanceResponse"
+ "$ref": "#/components/schemas/HTTPValidationError"
}
}
}
- },
- "404": {
- "description": "Workspace has no credit account"
}
}
}
},
- "/api/v1/credits/transactions": {
+ "/api/v1/kms/{kms_id}/info": {
"get": {
"tags": [
- "Billing"
+ "KMS"
],
- "summary": "List credit transactions",
- "description": "Returns paginated credit transactions with filtering by type and paid status. Includes total_amount sum for filtered results.",
- "operationId": "handle_list_transactions_api_v1_credits_transactions_get",
+ "summary": "Inspect KMS instance",
+ "description": "Real-time inspection of a KMS instance. Queries KMS RPC, guest agent, associated Teepod VMMs, and on-chain contract data with cross-validation.",
+ "operationId": "inspect_kms_api_v1_kms__kms_id__info_get",
"parameters": [
{
- "name": "page",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "minimum": 1,
- "default": 1,
- "title": "Page"
- }
- },
- {
- "name": "page_size",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "maximum": 100,
- "minimum": 1,
- "default": 30,
- "title": "Page Size"
- }
- },
- {
- "name": "type",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Type"
- }
- },
- {
- "name": "has_paid",
- "in": "query",
- "required": false,
+ "name": "kms_id",
+ "in": "path",
+ "required": true,
"schema": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Has Paid"
+ "type": "string",
+ "title": "Kms Id"
}
}
],
"responses": {
"200": {
- "description": "Paginated transactions with total_amount",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/teehouse__api__routes__billing__credits__PaginatedCreditTransactions"
+ "$ref": "#/components/schemas/KmsInspectResponse"
}
}
}
},
- "404": {
- "description": "User has no credit account"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -7364,85 +3624,38 @@
}
}
},
- "/api/v1/credits/redeem": {
- "post": {
+ "/api/v1/kms/on-chain/{chain}": {
+ "get": {
"tags": [
- "Billing"
+ "KMS"
],
- "summary": "Redeem promotion code",
- "description": "Applies a promotion code to add credits to the account. Admins can specify target_user_id or target_team_id to redeem for others.",
- "operationId": "handle_redeem_promotion_code_api_v1_credits_redeem_post",
+ "summary": "Get on-chain KMS details by chain",
+ "description": "Returns KMS contracts on the specified chain with device and OS image whitelist status.",
+ "operationId": "get_kms_onchain_detail_api_v1_kms_on_chain__chain__get",
"parameters": [
{
- "name": "code",
- "in": "query",
+ "name": "chain",
+ "in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Promotion code string",
- "title": "Code"
- },
- "description": "Promotion code string"
- },
- {
- "name": "target_user_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "description": "Target user ID (admin only)",
- "title": "Target User Id"
- },
- "description": "Target user ID (admin only)"
- },
- {
- "name": "target_team_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "description": "Target team ID (admin only)",
- "title": "Target Team Id"
- },
- "description": "Target team ID (admin only)"
+ "title": "Chain"
+ }
}
],
"responses": {
"200": {
- "description": "Updated credit account after redemption",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/teehouse__models__schemas__credits__Credit"
+ "$ref": "#/components/schemas/OnChainKmsResponse"
}
}
}
},
"400": {
- "description": "Invalid code, expired, max uses reached, or user limit reached"
- },
- "403": {
- "description": "Non-admin tried to redeem for another user/team"
- },
- "404": {
- "description": "Target user or team not found"
- },
- "500": {
- "description": "Unexpected error during redemption"
+ "description": "Unsupported chain name"
},
"422": {
"description": "Validation Error",
@@ -7457,18 +3670,44 @@
}
}
},
- "/api/v1/billing": {
+ "/api/v1/apps": {
"get": {
"tags": [
- "Billing",
- "Usage"
+ "Apps"
],
- "summary": "Get billing summary",
- "description": "Returns monthly total, 7-day total, daily usage breakdown, and per-instance spending. Filter by CVM identifier or use admin access to view other users.",
- "operationId": "handle_get_billing_summary_api_v1_billing_get",
+ "summary": "List apps",
+ "description": "Returns paginated app list with filtering. Response schema varies by API version.",
+ "operationId": "list_dstack_apps_api_v1_apps_get",
"parameters": [
{
- "name": "identifier",
+ "name": "page",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "description": "Page number (1-indexed)",
+ "default": 1,
+ "title": "Page"
+ },
+ "description": "Page number (1-indexed)"
+ },
+ {
+ "name": "page_size",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "maximum": 100,
+ "minimum": 1,
+ "description": "Items per page",
+ "default": 20,
+ "title": "Page Size"
+ },
+ "description": "Items per page"
+ },
+ {
+ "name": "search",
"in": "query",
"required": false,
"schema": {
@@ -7480,214 +3719,88 @@
"type": "null"
}
],
- "description": "CVM identifier to filter by (app_id or vm_uuid)",
- "title": "Identifier"
+ "description": "Search name, app_id, vm_uuid, instance_id",
+ "title": "Search"
},
- "description": "CVM identifier to filter by (app_id or vm_uuid)"
+ "description": "Search name, app_id, vm_uuid, instance_id"
},
{
- "name": "user_id",
+ "name": "status",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
- "type": "string",
- "format": "hashid",
- "description": "A hashed identifier that maps to an internal database ID",
- "pattern": "^usr_.+",
- "title": "HashedId[users]",
- "examples": [
- "usr_0123abcd"
- ]
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
},
{
"type": "null"
}
],
- "description": "Target user ID (admin only)",
- "title": "User Id"
+ "description": "CVM status filter",
+ "title": "Status"
},
- "description": "Target user ID (admin only)"
- }
- ],
- "responses": {
- "200": {
- "description": "Billing summary with totals and breakdowns",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/teehouse__api__routes__billing__usage__BillingSummaryResponse"
- }
- }
- }
- },
- "403": {
- "description": "Admin-only: non-admin tried to view another user's billing"
- },
- "404": {
- "description": "Admin-only: specified user not found"
+ "description": "CVM status filter"
},
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/billing/billing_items": {
- "get": {
- "tags": [
- "Billing",
- "Usage"
- ],
- "summary": "List billing items",
- "description": "Returns hourly billing records with per-event details. Supports cursor pagination. Admins can query by team_id or user_id.",
- "operationId": "handle_list_billing_items_api_v1_billing_billing_items_get",
- "parameters": [
{
- "name": "cursor",
+ "name": "listed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
- "type": "string"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "description": "Hashid-encoded cursor from previous response",
- "title": "Cursor"
- },
- "description": "Hashid-encoded cursor from previous response"
- },
- {
- "name": "limit",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "maximum": 500,
- "minimum": 1,
- "description": "Items per page (1-500)",
- "default": 50,
- "title": "Limit"
+ "description": "Listed status filter",
+ "title": "Listed"
},
- "description": "Items per page (1-500)"
+ "description": "Listed status filter"
},
{
- "name": "team_id",
+ "name": "base_image",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
- "type": "string",
- "format": "hashid",
- "description": "A hashed identifier that maps to an internal database ID",
- "pattern": "^wks_.+",
- "title": "HashedId[teams]",
- "examples": [
- "wks_0123abcd"
- ]
+ "type": "string"
},
{
"type": "null"
}
],
- "description": "Target team ID (admin only)",
- "title": "Team Id"
+ "description": "OS image name filter",
+ "title": "Base Image"
},
- "description": "Target team ID (admin only)"
+ "description": "OS image name filter"
},
{
- "name": "user_id",
+ "name": "instance_type",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
- "type": "string",
- "format": "hashid",
- "description": "A hashed identifier that maps to an internal database ID",
- "pattern": "^usr_.+",
- "title": "HashedId[users]",
- "examples": [
- "usr_0123abcd"
- ]
+ "type": "string"
},
{
"type": "null"
}
],
- "description": "Target user ID (admin only)",
- "title": "User Id"
+ "description": "Instance type filter",
+ "title": "Instance Type"
},
- "description": "Target user ID (admin only)"
- }
- ],
- "responses": {
- "200": {
- "description": "Paginated billing items with next_cursor and total",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PaginatedBillingItemsResponse"
- }
- }
- }
- },
- "400": {
- "description": "Invalid cursor format"
- },
- "403": {
- "description": "Admin-only: non-admin tried to query other team/user"
- },
- "404": {
- "description": "Admin-only: specified team or user not found"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/billing/billing_items/{cvm_id}": {
- "get": {
- "tags": [
- "Billing",
- "Usage"
- ],
- "summary": "List billing items by instance",
- "description": "Returns hourly billing records for a specific CVM. Supports cursor pagination.",
- "operationId": "handle_list_billing_items_by_instance_api_v1_billing_billing_items__cvm_id__get",
- "parameters": [
- {
- "name": "cvm_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Cvm Id"
- }
+ "description": "Instance type filter"
},
{
- "name": "cursor",
+ "name": "kms_slug",
"in": "query",
"required": false,
"schema": {
@@ -7699,94 +3812,49 @@
"type": "null"
}
],
- "description": "Hashid-encoded cursor from previous response",
- "title": "Cursor"
+ "description": "KMS slug filter",
+ "title": "Kms Slug"
},
- "description": "Hashid-encoded cursor from previous response"
+ "description": "KMS slug filter"
},
{
- "name": "limit",
+ "name": "kms_type",
"in": "query",
"required": false,
"schema": {
- "type": "integer",
- "maximum": 500,
- "minimum": 1,
- "description": "Items per page (1-500)",
- "default": 50,
- "title": "Limit"
- },
- "description": "Items per page (1-500)"
- }
- ],
- "responses": {
- "200": {
- "description": "Paginated billing items for the instance",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PaginatedBillingItemsResponse"
- }
- }
- }
- },
- "400": {
- "description": "Invalid cursor format"
- },
- "404": {
- "description": "CVM not found or not accessible"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
}
- }
- }
- }
- }
- }
- },
- "/api/v1/billing/invoices": {
- "get": {
- "tags": [
- "Billing"
- ],
- "summary": "List invoices",
- "description": "Returns paginated visible invoices for the current workspace, sorted by creation date (newest first). Filter by status: open, paid, uncollectible.",
- "operationId": "list_invoices_api_v1_billing_invoices_get",
- "parameters": [
- {
- "name": "skip",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "minimum": 0,
- "description": "Number of items to skip",
- "default": 0,
- "title": "Skip"
+ ],
+ "description": "KMS type filter",
+ "title": "Kms Type"
},
- "description": "Number of items to skip"
+ "description": "KMS type filter"
},
{
- "name": "limit",
+ "name": "node",
"in": "query",
"required": false,
"schema": {
- "type": "integer",
- "maximum": 100,
- "minimum": 1,
- "description": "Items per page (1-100)",
- "default": 20,
- "title": "Limit"
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Node name filter (matches teepod or node name)",
+ "title": "Node"
},
- "description": "Items per page (1-100)"
+ "description": "Node name filter (matches teepod or node name)"
},
{
- "name": "status",
+ "name": "region",
"in": "query",
"required": false,
"schema": {
@@ -7798,23 +3866,34 @@
"type": "null"
}
],
- "description": "Filter: open, paid, uncollectible",
- "title": "Status"
+ "description": "Region identifier filter",
+ "title": "Region"
},
- "description": "Filter: open, paid, uncollectible"
+ "description": "Region identifier filter"
}
],
"responses": {
"200": {
- "description": "Paginated invoice list with total count",
+ "description": "Paginated app list",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/InvoiceListResponse"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/teehouse__api__routes__apps__v20251028__schemas__DstackAppListResponse"
+ },
+ {
+ "$ref": "#/components/schemas/teehouse__api__routes__apps__v20260121__schemas__DstackAppListResponse"
+ }
+ ],
+ "title": "Response List Dstack Apps Api V1 Apps Get"
}
}
}
},
+ "401": {
+ "description": "Not authenticated"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -7828,104 +3907,85 @@
}
}
},
- "/api/v1/billing/invoices/{invoice_id}": {
+ "/api/v1/apps/filter-options": {
"get": {
"tags": [
- "Billing"
- ],
- "summary": "Get invoice details",
- "description": "Returns full invoice details including team balance and payment URLs. User must be a workspace member.",
- "operationId": "get_invoice_api_v1_billing_invoices__invoice_id__get",
- "parameters": [
- {
- "name": "invoice_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "description": "Invoice ID (integer or hashid)",
- "title": "Invoice Id"
- },
- "description": "Invoice ID (integer or hashid)"
- }
+ "Apps"
],
+ "summary": "Get app filter options",
+ "description": "Returns distinct values for each filterable field based on user's apps.",
+ "operationId": "get_filter_options_api_v1_apps_filter_options_get",
"responses": {
"200": {
- "description": "Invoice details with payment options",
+ "description": "Available filter values",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/InvoiceDetailResponse"
+ "$ref": "#/components/schemas/FilterOptionsResponse"
}
}
}
},
- "400": {
- "description": "Invalid invoice ID format"
- },
- "403": {
- "description": "User is not a member of the invoice's workspace"
- },
- "404": {
- "description": "Invoice not found"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
+ "401": {
+ "description": "Not authenticated"
}
}
}
},
- "/api/v1/billing/invoices/{invoice_id}/items": {
+ "/api/v1/apps/{app_id}": {
"get": {
"tags": [
- "Billing"
+ "Apps"
],
- "summary": "Get invoice line items",
- "description": "Returns line items for an invoice with instance name, type, region, and cost. User must be a workspace member.",
- "operationId": "get_invoice_items_api_v1_billing_invoices__invoice_id__items_get",
+ "summary": "Get app details",
+ "description": "Returns app metadata and current CVM configuration. Response schema varies by API version.",
+ "operationId": "get_dstack_app_api_v1_apps__app_id__get",
"parameters": [
{
- "name": "invoice_id",
+ "name": "app_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Invoice ID (integer or hashid)",
- "title": "Invoice Id"
+ "description": "Hex app identifier",
+ "title": "App Id"
},
- "description": "Invoice ID (integer or hashid)"
+ "description": "Hex app identifier"
}
],
"responses": {
"200": {
- "description": "List of invoice items",
+ "description": "App details with CVM info",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/InvoiceItemResponse"
- },
- "title": "Response Get Invoice Items Api V1 Billing Invoices Invoice Id Items Get"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/teehouse__api__routes__apps__v20251028__schemas__DstackAppFullResponse"
+ },
+ {
+ "$ref": "#/components/schemas/DstackAppMinimalResponse"
+ },
+ {
+ "$ref": "#/components/schemas/teehouse__api__routes__apps__v20260121__schemas__DstackAppFullResponse"
+ },
+ {
+ "$ref": "#/components/schemas/DstackAppMinimalResponse"
+ }
+ ],
+ "title": "Response Get Dstack App Api V1 Apps App Id Get"
}
}
}
},
- "400": {
- "description": "Invalid invoice ID format"
+ "401": {
+ "description": "Not authenticated"
},
"403": {
- "description": "User is not a member of the invoice's workspace"
+ "description": "No workspace access"
},
"404": {
- "description": "Invoice not found"
+ "description": "App not found"
},
"422": {
"description": "Validation Error",
@@ -7940,190 +4000,68 @@
}
}
},
- "/api/v1/billing/invoices/{invoice_id}/pay": {
- "post": {
+ "/api/v1/apps/{app_id}/cvms": {
+ "get": {
"tags": [
- "Billing"
+ "Apps"
+ ],
+ "summary": "List app CVMs",
+ "description": "Returns CVM instances for an app. Admins see all instances; users see only their own.",
+ "operationId": "handle_get_app_cvms_api_v1_apps__app_id__cvms_get",
+ "security": [
+ {
+ "OAuth2AuthorizationCodeBearer": []
+ },
+ {
+ "APIKeyHeader": []
+ }
],
- "summary": "Pay invoice with credits",
- "description": "Pays an open invoice using credit balance. Deducts from granted_balance first, then balance. Only credit_balance payment method is supported.",
- "operationId": "pay_invoice_api_v1_billing_invoices__invoice_id__pay_post",
"parameters": [
{
- "name": "invoice_id",
+ "name": "app_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Invoice ID (integer or hashid)",
- "title": "Invoice Id"
+ "description": "Hex app identifier",
+ "title": "App Id"
},
- "description": "Invoice ID (integer or hashid)"
+ "description": "Hex app identifier"
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PayInvoiceRequest"
- }
- }
- }
- },
"responses": {
"200": {
- "description": "Payment succeeded with breakdown of used balances",
+ "description": "List of CVM instances",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PayInvoiceResponse"
+ "anyOf": [
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/HostedCvm"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/teehouse__api__routes__cvms__v20260121__schemas__CVMInfo"
+ }
+ }
+ ],
+ "title": "Response Handle Get App Cvms Api V1 Apps App Id Cvms Get"
}
}
}
},
- "400": {
- "description": "Invalid invoice ID, unsupported payment method, or invoice not open"
- },
- "402": {
- "description": "Insufficient credit balance to pay the invoice"
+ "401": {
+ "description": "Not authenticated"
},
"403": {
- "description": "User is not a member of the invoice's workspace"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/billing/settings": {
- "get": {
- "tags": [
- "Billing"
- ],
- "summary": "Get billing settings",
- "description": "Returns the workspace billing email and Stripe customer email for consistency check.",
- "operationId": "get_billing_settings_api_v1_billing_settings_get",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BillingSettingsResponse"
- }
- }
- }
- }
- }
- },
- "patch": {
- "tags": [
- "Billing"
- ],
- "summary": "Update billing settings",
- "description": "Update the workspace billing email. Syncs to Stripe customer if linked. Requires OWNER or ADMIN role.",
- "operationId": "update_billing_settings_api_v1_billing_settings_patch",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/UpdateBillingSettingsRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BillingSettingsResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/setup-billing/create-intent": {
- "post": {
- "tags": [
- "Billing"
- ],
- "summary": "Create card verification intent",
- "description": "Creates a Stripe PaymentIntent for a $1 card verification charge. The charge is refunded after verification completes.",
- "operationId": "handle_create_payment_intent_api_v1_setup_billing_create_intent_post",
- "responses": {
- "200": {
- "description": "Returns client_secret and order_id for frontend completion",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Team has no credit account"
- },
- "500": {
- "description": "Failed to create Stripe customer or customer ID missing"
- }
- }
- }
- },
- "/api/v1/setup-billing/save-intent": {
- "post": {
- "tags": [
- "Billing"
- ],
- "summary": "Complete card verification",
- "description": "Verifies the payment method, stores card fingerprint, upgrades team tier to LEVEL_2, and sets the card as default payment method. Triggers refund on failure.",
- "operationId": "handle_save_intent_api_v1_setup_billing_save_intent_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Body_handle_save_intent_api_v1_setup_billing_save_intent_post"
- }
- }
- },
- "required": true
- },
- "responses": {
- "202": {
- "description": "Verification completed, tier upgraded",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Team has no credit, payment incomplete, or duplicate card"
+ "description": "No workspace access"
},
"404": {
- "description": "Verification order not found"
+ "description": "App not found"
},
"422": {
"description": "Validation Error",
@@ -8138,217 +4076,96 @@
}
}
},
- "/api/v1/setup-billing/check": {
- "get": {
+ "/api/v1/apps/{app_id}/cvms/{vm_uuid}/replicas": {
+ "post": {
"tags": [
- "Billing"
+ "Apps"
],
- "summary": "Check verification order status",
- "description": "Returns whether the setup billing order has been verified. Frontend polls this after payment completion.",
- "operationId": "handle_check_setup_billing_api_v1_setup_billing_check_get",
+ "summary": "Create CVM replica",
+ "description": "Clones a CVM to a target node. Uses source node if target not specified.",
+ "operationId": "handle_replicate_cvm_api_v1_apps__app_id__cvms__vm_uuid__replicas_post",
"parameters": [
{
- "name": "order_id",
- "in": "query",
+ "name": "app_id",
+ "in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Hashid-encoded order ID from create-intent response",
- "title": "Order Id"
+ "description": "Hex app identifier",
+ "title": "App Id"
},
- "description": "Hashid-encoded order ID from create-intent response"
- }
- ],
- "responses": {
- "200": {
- "description": "Returns verified boolean and optional message",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Invalid or malformed order ID"
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/instance-types": {
- "get": {
- "tags": [
- "Instance Types"
- ],
- "summary": "List instance type families",
- "description": "Public endpoint. Returns all families with their public instance types grouped.",
- "operationId": "list_all_families_api_v1_instance_types_get",
- "responses": {
- "200": {
- "description": "Families with instance types",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AllFamiliesResponse"
- }
- }
- }
+ "description": "Hex app identifier"
},
- "500": {
- "description": "Database error"
- }
- }
- }
- },
- "/api/v1/instance-types/{family}": {
- "get": {
- "tags": [
- "Instance Types"
- ],
- "summary": "List family instance types",
- "description": "Public endpoint. Returns all public instance types for a specific family.",
- "operationId": "list_family_instance_types_api_v1_instance_types__family__get",
- "parameters": [
{
- "name": "family",
+ "name": "vm_uuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Family name (cpu, gpu)",
- "title": "Family"
+ "description": "Source CVM UUID",
+ "title": "Vm Uuid"
},
- "description": "Family name (cpu, gpu)"
- }
- ],
- "responses": {
- "200": {
- "description": "Instance types for family",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/FamilyInstanceTypesResponse"
- }
- }
- }
- },
- "404": {
- "description": "Family not found or empty"
- },
- "500": {
- "description": "Database error"
+ "description": "Source CVM UUID"
},
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
+ {
+ "name": "X-Prepare-Only",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
}
- }
+ ],
+ "title": "X-Prepare-Only"
}
}
- }
- }
- },
- "/api/v1/attestations/verify": {
- "post": {
- "tags": [
- "Attestations"
],
- "summary": "Verify TEE quote",
- "description": "Accepts quote as file upload, form hex, or JSON hex. 0x prefix handled automatically.",
- "operationId": "handle_upload_and_verify_api_v1_attestations_verify_post",
"requestBody": {
"content": {
- "multipart/form-data": {
+ "application/json": {
"schema": {
- "$ref": "#/components/schemas/Body_handle_upload_and_verify_api_v1_attestations_verify_post"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/ReplicateRequest"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Request"
}
}
}
},
"responses": {
"200": {
- "description": "Quote verified",
+ "description": "Replica CVM created",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/VerificationResponse"
+ "$ref": "#/components/schemas/VM"
}
}
}
},
"400": {
- "description": "Invalid quote format or verification failed"
+ "description": "App ID mismatch, no OS image, or invalid target node"
},
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/attestations/recent": {
- "get": {
- "tags": [
- "Attestations"
- ],
- "summary": "List recent quotes",
- "description": "Public endpoint. Returns recently uploaded quotes ordered by timestamp.",
- "operationId": "handle_list_recent_api_v1_attestations_recent_get",
- "parameters": [
- {
- "name": "skip",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "minimum": 0,
- "description": "Offset for pagination",
- "default": 0,
- "title": "Skip"
- },
- "description": "Offset for pagination"
+ "401": {
+ "description": "Not authenticated"
},
- {
- "name": "limit",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "maximum": 100,
- "minimum": 1,
- "description": "Max results",
- "default": 20,
- "title": "Limit"
- },
- "description": "Max results"
- }
- ],
- "responses": {
- "200": {
- "description": "List of recent quotes",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
+ "403": {
+ "description": "No workspace access"
+ },
+ "404": {
+ "description": "CVM or target node not found"
+ },
+ "500": {
+ "description": "Replication failed"
},
"422": {
"description": "Validation Error",
@@ -8363,38 +4180,64 @@
}
}
},
- "/api/v1/attestations/view/{checksum}": {
- "get": {
+ "/api/v1/apps/{app_id}/instances": {
+ "post": {
"tags": [
- "Attestations"
+ "Apps"
],
- "summary": "View quote details",
- "description": "Public endpoint. Returns parsed quote data with verification status.",
- "operationId": "handle_view_api_v1_attestations_view__checksum__get",
+ "summary": "Create a new instance under an existing app",
+ "description": "Deploy a new CVM instance under an existing app, optionally with a new Docker Compose file. For on-chain KMS apps, this uses a two-phase flow: the first request returns HTTP 465 with a commit token; after registering the compose hash on-chain, the second request commits with the token and transaction hash.",
+ "operationId": "handle_create_app_instance_api_v1_apps__app_id__instances_post",
"parameters": [
{
- "name": "checksum",
+ "name": "app_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Quote SHA256 checksum",
- "title": "Checksum"
+ "description": "Hex app identifier",
+ "title": "App Id"
},
- "description": "Quote SHA256 checksum"
+ "description": "Hex app identifier"
}
],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateAppInstanceRequest"
+ }
+ }
+ }
+ },
"responses": {
"200": {
- "description": "Quote details",
+ "description": "Instance created",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/VM"
+ }
}
}
},
+ "400": {
+ "description": "Invalid compose, no template instance, or app mismatch"
+ },
+ "401": {
+ "description": "Not authenticated"
+ },
+ "403": {
+ "description": "No workspace access"
+ },
"404": {
- "description": "Quote not found"
+ "description": "App or target node not found"
+ },
+ "465": {
+ "description": "On-chain compose hash registration required (two-phase flow)"
+ },
+ "500": {
+ "description": "Instance creation failed"
},
"422": {
"description": "Validation Error",
@@ -8409,41 +4252,43 @@
}
}
},
- "/api/v1/attestations/collateral/{checksum}": {
+ "/api/v1/apps/{app_id}/device-allowlist": {
"get": {
"tags": [
- "Attestations"
+ "Apps"
],
- "summary": "Get quote collateral",
- "description": "Returns TCB collateral data for quote verification. Cached for 24 hours.",
- "operationId": "get_collateral_api_v1_attestations_collateral__checksum__get",
+ "summary": "Get device allowlist status",
+ "description": "Returns the device_id allowlist status for an app's CVMs. For on-chain KMS apps, queries the blockchain in real-time to check which devices are registered in the app contract.",
+ "operationId": "get_device_allowlist_api_v1_apps__app_id__device_allowlist_get",
"parameters": [
{
- "name": "checksum",
+ "name": "app_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Quote SHA256 checksum",
- "title": "Checksum"
+ "description": "Hex app identifier",
+ "title": "App Id"
},
- "description": "Quote SHA256 checksum"
+ "description": "Hex app identifier"
}
],
"responses": {
"200": {
- "description": "Collateral data",
+ "description": "Device allowlist status",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/DeviceAllowlistResponse"
+ }
}
}
},
- "400": {
- "description": "Bad quote data"
+ "401": {
+ "description": "Not authenticated"
},
"404": {
- "description": "Quote not found"
+ "description": "App not found or not on-chain KMS"
},
"422": {
"description": "Validation Error",
@@ -8458,39 +4303,38 @@
}
}
},
- "/api/v1/attestations/raw/{checksum}": {
+ "/api/v1/apps/{app_id}/attestations": {
"get": {
"tags": [
- "Attestations"
+ "Apps"
],
- "summary": "Download raw quote",
- "description": "Returns raw quote bytes as binary file attachment.",
- "operationId": "handle_get_raw_api_v1_attestations_raw__checksum__get",
+ "summary": "Get app attestation data",
+ "description": "Returns TEE attestation quotes, event logs, and KMS configuration for running CVMs.",
+ "operationId": "handle_get_app_attestation_api_v1_apps__app_id__attestations_get",
"parameters": [
{
- "name": "checksum",
+ "name": "app_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Quote SHA256 checksum",
- "title": "Checksum"
+ "description": "Hex app identifier",
+ "title": "App Id"
},
- "description": "Quote SHA256 checksum"
+ "description": "Hex app identifier"
}
],
"responses": {
"200": {
- "description": "Binary quote file",
+ "description": "Attestation data with KMS info and instance quotes",
"content": {
"application/json": {
"schema": {}
- },
- "application/octet-stream": {}
+ }
}
},
"404": {
- "description": "Quote not found"
+ "description": "App not found"
},
"422": {
"description": "Validation Error",
@@ -8503,38 +4347,42 @@
}
}
}
- },
- "head": {
+ }
+ },
+ "/api/v1/apps/{app_id}/attestations/tcb-evaluation": {
+ "get": {
"tags": [
- "Attestations"
+ "Apps"
],
- "summary": "Check raw quote exists",
- "description": "Returns headers without body. Use to check existence and get Content-Length.",
- "operationId": "handle_check_raw_file_api_v1_attestations_raw__checksum__head",
+ "summary": "Run app TCB evaluation",
+ "description": "Runs a live Intel PCS early collateral evaluation for each running CVM without using Redis collateral cache.",
+ "operationId": "handle_get_app_tcb_evaluation_api_v1_apps__app_id__attestations_tcb_evaluation_get",
"parameters": [
{
- "name": "checksum",
+ "name": "app_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Quote SHA256 checksum",
- "title": "Checksum"
+ "description": "Hex app identifier",
+ "title": "App Id"
},
- "description": "Quote SHA256 checksum"
+ "description": "Hex app identifier"
}
],
"responses": {
"200": {
- "description": "Quote exists",
+ "description": "TCB evaluation results for running instances",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/TcbEvaluationResponse"
+ }
}
}
},
"404": {
- "description": "Quote not found"
+ "description": "App not found"
},
"422": {
"description": "Validation Error",
@@ -8549,135 +4397,148 @@
}
}
},
- "/api/v1/attestations/ppids": {
- "get": {
- "tags": [
- "Attestations"
- ],
- "summary": "List node PPIDs",
- "description": "Public endpoint. Returns PPID list from nodes table (excluding deleted).",
- "operationId": "handle_list_ppids_api_v1_attestations_ppids_get",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- }
- }
- }
- },
- "/api/v1/attestations/device_ids": {
+ "/api/v1/apps/{app_id}/revisions": {
"get": {
"tags": [
- "Attestations"
+ "Apps"
],
- "summary": "List node device IDs",
- "description": "Public endpoint. Returns device_id list from nodes table (excluding deleted).",
- "operationId": "handle_list_device_ids_api_v1_attestations_device_ids_get",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
+ "summary": "List app revisions",
+ "description": "Returns deployment history with compose hashes, operation types, and user refs.",
+ "operationId": "get_app_revisions_api_v1_apps__app_id__revisions_get",
+ "parameters": [
+ {
+ "name": "app_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "Hex app identifier",
+ "title": "App Id"
+ },
+ "description": "Hex app identifier"
+ },
+ {
+ "name": "page",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "description": "Page number (1-indexed)",
+ "default": 1,
+ "title": "Page"
+ },
+ "description": "Page number (1-indexed)"
+ },
+ {
+ "name": "page_size",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "maximum": 1000,
+ "minimum": 1,
+ "description": "Items per page",
+ "default": 50,
+ "title": "Page Size"
+ },
+ "description": "Items per page"
}
- }
- }
- },
- "/api/v1/attestations/nodes": {
- "get": {
- "tags": [
- "Attestations"
],
- "summary": "List nodes",
- "description": "Public endpoint. Returns NodeRef list derived from nodes table (excluding deleted).",
- "operationId": "handle_list_nodes_api_v1_attestations_nodes_get",
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "Paginated revision list",
"content": {
"application/json": {
"schema": {
- "items": {
- "$ref": "#/components/schemas/NodeRef"
- },
- "type": "array",
- "title": "Response Handle List Nodes Api V1 Attestations Nodes Get"
+ "$ref": "#/components/schemas/AppRevisionsResponse"
}
}
}
- }
- }
- }
- },
- "/api/v1/workspaces": {
- "get": {
- "tags": [
- "Workspace"
- ],
- "summary": "List user workspaces",
- "description": "Returns all workspaces the authenticated user has access to, with their role in each.",
- "operationId": "list_user_workspaces_api_v1_workspaces_get",
- "responses": {
- "200": {
- "description": "List of workspaces with user roles",
+ },
+ "401": {
+ "description": "Not authenticated"
+ },
+ "403": {
+ "description": "No workspace access"
+ },
+ "404": {
+ "description": "App not found"
+ },
+ "422": {
+ "description": "Validation Error",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/WorkspacesListResponse"
+ "$ref": "#/components/schemas/HTTPValidationError"
}
}
}
- },
- "401": {
- "description": "Authentication required"
}
}
}
},
- "/api/v1/workspaces/{team_slug}": {
+ "/api/v1/apps/{app_id}/revisions/{revision_id}": {
"get": {
"tags": [
- "Workspace"
+ "Apps"
],
- "summary": "Get workspace by slug",
- "description": "Returns workspace details if user has access.",
- "operationId": "get_workspace_info_api_v1_workspaces__team_slug__get",
+ "summary": "Get revision detail",
+ "description": "Returns full revision data including compose file, encrypted env, and user config.",
+ "operationId": "get_app_revision_detail_api_v1_apps__app_id__revisions__revision_id__get",
"parameters": [
{
- "name": "team_slug",
+ "name": "app_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "Hex app identifier",
+ "title": "App Id"
+ },
+ "description": "Hex app identifier"
+ },
+ {
+ "name": "revision_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "Team Slug"
+ "title": "Revision Id"
}
+ },
+ {
+ "name": "raw_compose_file",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "description": "Return compose_file as string instead of dict",
+ "default": false,
+ "title": "Raw Compose File"
+ },
+ "description": "Return compose_file as string instead of dict"
}
],
"responses": {
"200": {
- "description": "Workspace details",
+ "description": "Revision detail with compose file",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/WorkspaceResponse"
+ "$ref": "#/components/schemas/AppRevisionDetailResponse"
}
}
}
},
"401": {
- "description": "Authentication required"
+ "description": "Not authenticated"
},
"403": {
- "description": "User not a member of workspace"
+ "description": "No workspace access"
},
"404": {
- "description": "Workspace not found"
+ "description": "App or revision not found"
},
"422": {
"description": "Validation Error",
@@ -8692,59 +4553,96 @@
}
}
},
- "/api/v1/workspaces/{team_slug}/nodes": {
- "get": {
+ "/api/v1/apps/{app_id}/revisions/{revision_id}/redeploy": {
+ "post": {
"tags": [
- "Workspace"
+ "Apps"
],
- "summary": "List workspace nodes",
- "description": "Returns nodes (backed by teepods) accessible to this workspace: reserved nodes first, then public nodes.",
- "operationId": "list_workspace_nodes_api_v1_workspaces__team_slug__nodes_get",
+ "summary": "Redeploy app from a specific revision",
+ "description": "Redeploy a CVM to a specific revision. If the app has exactly one CVM, it will be redeployed by default. If the app has multiple CVMs, you must specify target vm_uuids in request body. This schedules async CVM update task(s).",
+ "operationId": "redeploy_app_revision_api_v1_apps__app_id__revisions__revision_id__redeploy_post",
"parameters": [
{
- "name": "team_slug",
+ "name": "app_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "Team Slug"
- }
+ "description": "Hex app identifier",
+ "title": "App Id"
+ },
+ "description": "Hex app identifier"
},
{
- "name": "page",
- "in": "query",
- "required": false,
+ "name": "revision_id",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "integer",
- "minimum": 1,
- "default": 1,
- "title": "Page"
+ "type": "string",
+ "title": "Revision Id"
}
},
{
- "name": "page_size",
+ "name": "transaction_hash",
"in": "query",
"required": false,
"schema": {
- "type": "integer",
- "maximum": 100,
- "minimum": 1,
- "default": 30,
- "title": "Page Size"
- }
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Optional transaction hash proving on-chain compose hash registration",
+ "title": "Transaction Hash"
+ },
+ "description": "Optional transaction hash proving on-chain compose hash registration"
}
],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/RedeployRevisionRequest"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Optional target CVM selection. If the app has multiple CVMs, you must specify vm_uuids.",
+ "title": "Payload"
+ }
+ }
+ }
+ },
"responses": {
- "200": {
- "description": "Successful Response",
+ "202": {
+ "description": "Activation initiated",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/PaginatedWorkspaceNodesResponse"
- }
+ "schema": {}
}
}
},
+ "401": {
+ "description": "Not authenticated"
+ },
+ "403": {
+ "description": "No workspace access"
+ },
+ "404": {
+ "description": "App or revision not found"
+ },
+ "409": {
+ "description": "Another operation is in progress"
+ },
+ "465": {
+ "description": "Compose hash registration required (contract-owned KMS)"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -8758,36 +4656,121 @@
}
}
},
- "/api/v1/workspaces/{team_slug}/quotas": {
+ "/api/v1/apps/{app_id}/usage": {
"get": {
"tags": [
- "Workspace"
+ "Apps"
],
- "summary": "Get workspace quotas",
- "description": "Returns tier quota limit/remaining and reserved GPU availability (reserved pool only).",
- "operationId": "get_workspace_quotas_api_v1_workspaces__team_slug__quotas_get",
+ "summary": "Get app metered usage",
+ "description": "Returns billing usage records from ClickHouse. Defaults to 7-day window if dates not specified.",
+ "operationId": "get_app_usage_api_v1_apps__app_id__usage_get",
"parameters": [
{
- "name": "team_slug",
+ "name": "app_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "Team Slug"
- }
+ "description": "Hex app identifier",
+ "title": "App Id"
+ },
+ "description": "Hex app identifier"
+ },
+ {
+ "name": "start_date",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time",
+ "examples": [
+ "2024-01-01T00:00:00Z"
+ ]
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Start date (ISO 8601)",
+ "title": "Start Date"
+ },
+ "description": "Start date (ISO 8601)"
+ },
+ {
+ "name": "end_date",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time",
+ "examples": [
+ "2024-01-01T00:00:00Z"
+ ]
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "End date (ISO 8601)",
+ "title": "End Date"
+ },
+ "description": "End date (ISO 8601)"
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "maximum": 5000,
+ "minimum": 1,
+ "description": "Max records to return",
+ "default": 500,
+ "title": "Limit"
+ },
+ "description": "Max records to return"
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Records to skip",
+ "default": 0,
+ "title": "Offset"
+ },
+ "description": "Records to skip"
}
],
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "Usage records with cost breakdown",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/WorkspaceQuotasResponse"
+ "$ref": "#/components/schemas/AppUsageResponse"
}
}
}
},
+ "400": {
+ "description": "end_date before start_date"
+ },
+ "401": {
+ "description": "Not authenticated"
+ },
+ "403": {
+ "description": "No workspace access"
+ },
+ "404": {
+ "description": "App not found"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -8801,38 +4784,45 @@
}
}
},
- "/api/v1/workspaces/check-slug": {
+ "/api/v1/apps/{app_id}/is-allowed": {
"post": {
"tags": [
- "Workspace"
+ "Apps"
+ ],
+ "summary": "Check if app deployment is allowed on-chain",
+ "operationId": "handle_app_is_allowed_api_v1_apps__app_id__is_allowed_post",
+ "parameters": [
+ {
+ "name": "app_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "App Id"
+ }
+ }
],
- "summary": "Validate workspace slug",
- "description": "Checks slug format and reserved words. Does NOT check uniqueness (that happens at creation).",
- "operationId": "check_workspace_slug_api_v1_workspaces_check_slug_post",
"requestBody": {
+ "required": true,
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CheckSlugRequest"
+ "$ref": "#/components/schemas/AppIsAllowedRequest"
}
}
- },
- "required": true
+ }
},
"responses": {
"200": {
- "description": "Validation result",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CheckSlugResponse"
+ "$ref": "#/components/schemas/AppIsAllowedResponse"
}
}
}
},
- "401": {
- "description": "Authentication required"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -8846,68 +4836,35 @@
}
}
},
- "/api/v1/workspaces/{workspace_slug}/invitations": {
+ "/api/v1/apps/{app_id}/cvms/is-allowed": {
"post": {
"tags": [
- "Workspace"
- ],
- "summary": "Send workspace invitation",
- "description": "OWNER/ADMIN only. Sends email invitation to join workspace.",
- "operationId": "create_workspace_invitation_api_v1_workspaces__workspace_slug__invitations_post",
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
+ "Apps"
],
+ "summary": "Batch check on-chain deployment allowance for all CVMs under an app",
+ "operationId": "handle_app_cvms_is_allowed_api_v1_apps__app_id__cvms_is_allowed_post",
"parameters": [
{
- "name": "workspace_slug",
+ "name": "app_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Workspace slug",
- "title": "Workspace Slug"
- },
- "description": "Workspace slug"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/InvitationCreateRequest"
- }
+ "title": "App Id"
}
}
- },
+ ],
"responses": {
"200": {
- "description": "Invitation created",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/InvitationResponse"
+ "$ref": "#/components/schemas/AppCvmsBatchIsAllowedResponse"
}
}
}
},
- "400": {
- "description": "Invalid role or user already invited"
- },
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "OWNER/ADMIN only"
- },
- "404": {
- "description": "Workspace not found"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -8919,69 +4876,37 @@
}
}
}
- },
+ }
+ },
+ "/api/v1/apps/{app_id}/kms-info": {
"get": {
"tags": [
- "Workspace"
- ],
- "summary": "List pending invitations",
- "description": "OWNER/ADMIN only. Returns paginated list of pending invitations.",
- "operationId": "list_workspace_invitations_api_v1_workspaces__workspace_slug__invitations_get",
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
+ "Apps",
+ "apps-kms-info"
],
+ "summary": "Get app on-chain KMS info",
+ "description": "Returns on-chain KMS metadata for an app: chain, KMS contract, app contract, deployer address, and deployer type detection (EOA, Safe multisig, legacy multisig, ERC-4337, or generic contract).",
+ "operationId": "get_app_kms_info_api_v1_apps__app_id__kms_info_get",
"parameters": [
{
- "name": "workspace_slug",
+ "name": "app_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Workspace slug",
- "title": "Workspace Slug"
- },
- "description": "Workspace slug"
- },
- {
- "name": "page",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "minimum": 1,
- "description": "Page number",
- "default": 1,
- "title": "Page"
- },
- "description": "Page number"
- },
- {
- "name": "page_size",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "maximum": 100,
- "minimum": 1,
- "description": "Items per page",
- "default": 30,
- "title": "Page Size"
+ "description": "Hex app identifier",
+ "title": "App Id"
},
- "description": "Items per page"
+ "description": "Hex app identifier"
}
],
"responses": {
"200": {
- "description": "Pending invitations",
+ "description": "KMS info",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PaginatedInvitations"
+ "$ref": "#/components/schemas/AppKmsInfoResponse"
}
}
}
@@ -8989,14 +4914,8 @@
"401": {
"description": "Not authenticated"
},
- "403": {
- "description": "OWNER/ADMIN only"
- },
"404": {
- "description": "Workspace not found"
- },
- "500": {
- "description": "Database error"
+ "description": "App not found"
},
"422": {
"description": "Validation Error",
@@ -9011,57 +4930,44 @@
}
}
},
- "/api/v1/workspaces/{workspace_slug}/invitations/shareable": {
- "post": {
+ "/api/v1/apps/{app_id}/pending-updates": {
+ "get": {
"tags": [
- "Workspace"
- ],
- "summary": "Create shareable invitation",
- "description": "OWNER/ADMIN only. Creates link anyone can use to join as MEMBER.",
- "operationId": "create_shareable_workspace_invitation_api_v1_workspaces__workspace_slug__invitations_shareable_post",
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
+ "Apps",
+ "apps-pending-updates"
],
+ "summary": "Get pending compose updates",
+ "description": "Returns provisioned compose file updates that have been signed on-chain but not yet applied to CVMs.",
+ "operationId": "get_pending_updates_api_v1_apps__app_id__pending_updates_get",
"parameters": [
{
- "name": "workspace_slug",
+ "name": "app_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Workspace slug",
- "title": "Workspace Slug"
+ "description": "Hex app identifier",
+ "title": "App Id"
},
- "description": "Workspace slug"
+ "description": "Hex app identifier"
}
],
"responses": {
"200": {
- "description": "Shareable link created",
+ "description": "Pending updates list",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ShareableInvitationResponse"
+ "$ref": "#/components/schemas/PendingUpdatesResponse"
}
}
}
},
- "400": {
- "description": "Creation failed"
- },
"401": {
"description": "Not authenticated"
},
- "403": {
- "description": "OWNER/ADMIN only"
- },
"404": {
- "description": "Workspace not found"
+ "description": "App not found"
},
"422": {
"description": "Validation Error",
@@ -9076,70 +4982,66 @@
}
}
},
- "/api/v1/workspaces/{workspace_slug}/invitations/{invitation_id}": {
- "delete": {
+ "/api/v1/apps/{app_id}/pending-updates/{vm_uuid}/{compose_hash}/preview": {
+ "get": {
"tags": [
- "Workspace"
+ "Apps",
+ "apps-pending-updates"
],
- "summary": "Cancel invitation",
- "description": "OWNER/ADMIN only. Cancels a pending invitation.",
- "operationId": "cancel_workspace_invitation_api_v1_workspaces__workspace_slug__invitations__invitation_id__delete",
- "security": [
+ "summary": "Preview a pending compose update",
+ "description": "Returns current and pending docker compose file and pre-launch script for diffing before applying an update.",
+ "operationId": "get_pending_update_preview_api_v1_apps__app_id__pending_updates__vm_uuid___compose_hash__preview_get",
+ "parameters": [
{
- "OAuth2AuthorizationCodeBearer": []
+ "name": "app_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "Hex app identifier",
+ "title": "App Id"
+ },
+ "description": "Hex app identifier"
},
{
- "APIKeyHeader": []
- }
- ],
- "parameters": [
- {
- "name": "workspace_slug",
+ "name": "vm_uuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Workspace slug",
- "title": "Workspace Slug"
+ "description": "VM UUID",
+ "title": "Vm Uuid"
},
- "description": "Workspace slug"
+ "description": "VM UUID"
},
{
- "name": "invitation_id",
+ "name": "compose_hash",
"in": "path",
"required": true,
"schema": {
- "type": "integer",
- "minimum": 1,
- "description": "Invitation ID",
- "title": "Invitation Id"
+ "type": "string",
+ "description": "Compose hash of the pending update",
+ "title": "Compose Hash"
},
- "description": "Invitation ID"
+ "description": "Compose hash of the pending update"
}
],
"responses": {
"200": {
- "description": "Invitation cancelled",
+ "description": "Preview data",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/PendingUpdatePreview"
+ }
}
}
},
- "400": {
- "description": "Cancellation failed"
- },
"401": {
"description": "Not authenticated"
},
- "403": {
- "description": "OWNER/ADMIN only"
- },
"404": {
- "description": "Workspace or invitation not found"
- },
- "500": {
- "description": "Database error"
+ "description": "App or pending update not found"
},
"422": {
"description": "Validation Error",
@@ -9154,81 +5056,68 @@
}
}
},
- "/api/v1/workspaces/{workspace_slug}/members": {
+ "/api/v1/instance-types": {
"get": {
"tags": [
- "Workspace"
+ "Instance Types"
],
- "summary": "List workspace members",
- "description": "All workspace members can view. Returns paginated member list.",
- "operationId": "list_workspace_members_api_v1_workspaces__workspace_slug__members_get",
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
+ "summary": "List instance type families",
+ "description": "Public endpoint. Returns all families with their public instance types grouped.",
+ "operationId": "list_all_families_api_v1_instance_types_get",
+ "responses": {
+ "200": {
+ "description": "Families with instance types",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AllFamiliesResponse"
+ }
+ }
+ }
},
- {
- "APIKeyHeader": []
+ "500": {
+ "description": "Database error"
}
+ }
+ }
+ },
+ "/api/v1/instance-types/{family}": {
+ "get": {
+ "tags": [
+ "Instance Types"
],
+ "summary": "List family instance types",
+ "description": "Public endpoint. Returns all public instance types for a specific family.",
+ "operationId": "list_family_instance_types_api_v1_instance_types__family__get",
"parameters": [
{
- "name": "workspace_slug",
+ "name": "family",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Workspace slug",
- "title": "Workspace Slug"
- },
- "description": "Workspace slug"
- },
- {
- "name": "page",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "minimum": 1,
- "description": "Page number",
- "default": 1,
- "title": "Page"
- },
- "description": "Page number"
- },
- {
- "name": "page_size",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "maximum": 100,
- "minimum": 1,
- "description": "Items per page",
- "default": 30,
- "title": "Page Size"
+ "description": "Family name (cpu, gpu)",
+ "title": "Family"
},
- "description": "Items per page"
+ "description": "Family name (cpu, gpu)"
}
],
"responses": {
"200": {
- "description": "Member list",
+ "description": "Instance types for family",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/teehouse__api__routes__workspace_members__PaginatedTeamMembers"
+ "$ref": "#/components/schemas/FamilyInstanceTypesResponse"
}
}
}
},
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "No workspace access"
- },
"404": {
- "description": "Workspace not found"
+ "description": "Family not found or empty"
+ },
+ "500": {
+ "description": "Database error"
},
"422": {
"description": "Validation Error",
@@ -9243,66 +5132,36 @@
}
}
},
- "/api/v1/workspaces/{workspace_slug}/members/{user_id}": {
- "delete": {
+ "/api/v1/attestations/verify": {
+ "post": {
"tags": [
- "Workspace"
- ],
- "summary": "Remove workspace member",
- "description": "OWNER/ADMIN only. Removes member and revokes their workspace API tokens.",
- "operationId": "remove_workspace_member_api_v1_workspaces__workspace_slug__members__user_id__delete",
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
+ "Attestations"
],
- "parameters": [
- {
- "name": "workspace_slug",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "description": "Workspace slug",
- "title": "Workspace Slug"
- },
- "description": "Workspace slug"
- },
- {
- "name": "user_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "description": "User hashid to remove",
- "title": "User Id"
- },
- "description": "User hashid to remove"
+ "summary": "Verify TEE quote",
+ "description": "Accepts quote as file upload, form hex, or JSON hex. 0x prefix handled automatically.",
+ "operationId": "handle_upload_and_verify_api_v1_attestations_verify_post",
+ "requestBody": {
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_handle_upload_and_verify_api_v1_attestations_verify_post"
+ }
+ }
}
- ],
+ },
"responses": {
"200": {
- "description": "Member removed",
+ "description": "Quote verified",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/VerificationResponse"
+ }
}
}
},
"400": {
- "description": "Cannot remove workspace creator"
- },
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "OWNER/ADMIN only"
- },
- "404": {
- "description": "Workspace or member not found"
+ "description": "Invalid quote format or verification failed"
},
"422": {
"description": "Validation Error",
@@ -9315,77 +5174,54 @@
}
}
}
- },
- "patch": {
+ }
+ },
+ "/api/v1/attestations/recent": {
+ "get": {
"tags": [
- "Workspace"
- ],
- "summary": "Update member role",
- "description": "OWNER only. Changes member role to ADMIN or MEMBER. Cannot change creator.",
- "operationId": "update_member_role_api_v1_workspaces__workspace_slug__members__user_id__patch",
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
+ "Attestations"
],
+ "summary": "List recent quotes",
+ "description": "Public endpoint. Returns recently uploaded quotes ordered by timestamp.",
+ "operationId": "handle_list_recent_api_v1_attestations_recent_get",
"parameters": [
{
- "name": "workspace_slug",
- "in": "path",
- "required": true,
+ "name": "skip",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "description": "Workspace slug",
- "title": "Workspace Slug"
+ "type": "integer",
+ "minimum": 0,
+ "description": "Offset for pagination",
+ "default": 0,
+ "title": "Skip"
},
- "description": "Workspace slug"
+ "description": "Offset for pagination"
},
{
- "name": "user_id",
- "in": "path",
- "required": true,
+ "name": "limit",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "description": "User hashid to update",
- "title": "User Id"
+ "type": "integer",
+ "maximum": 100,
+ "minimum": 1,
+ "description": "Max results",
+ "default": 20,
+ "title": "Limit"
},
- "description": "User hashid to update"
+ "description": "Max results"
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/MemberRoleUpdateRequest"
- }
- }
- }
- },
"responses": {
"200": {
- "description": "Role updated",
+ "description": "List of recent quotes",
"content": {
"application/json": {
"schema": {}
}
}
},
- "400": {
- "description": "Invalid role or cannot modify creator"
- },
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "OWNER only"
- },
- "404": {
- "description": "Workspace or member not found"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -9399,55 +5235,38 @@
}
}
},
- "/api/v1/workspaces/{workspace_slug}/leave": {
- "post": {
+ "/api/v1/attestations/view/{checksum}": {
+ "get": {
"tags": [
- "Workspace"
- ],
- "summary": "Leave workspace",
- "description": "Self-remove from workspace. Revokes your workspace API tokens. Creators cannot leave.",
- "operationId": "leave_workspace_api_v1_workspaces__workspace_slug__leave_post",
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
+ "Attestations"
],
+ "summary": "View quote details",
+ "description": "Public endpoint. Returns parsed quote data with verification status.",
+ "operationId": "handle_view_api_v1_attestations_view__checksum__get",
"parameters": [
{
- "name": "workspace_slug",
+ "name": "checksum",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Workspace slug",
- "title": "Workspace Slug"
+ "description": "Quote SHA256 checksum",
+ "title": "Checksum"
},
- "description": "Workspace slug"
+ "description": "Quote SHA256 checksum"
}
],
"responses": {
"200": {
- "description": "Left workspace",
+ "description": "Quote details",
"content": {
"application/json": {
"schema": {}
}
}
},
- "400": {
- "description": "Creator cannot leave"
- },
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "No workspace access"
- },
"404": {
- "description": "Workspace not found or not a member"
+ "description": "Quote not found"
},
"422": {
"description": "Validation Error",
@@ -9462,67 +5281,41 @@
}
}
},
- "/api/v1/user/ssh-keys": {
+ "/api/v1/attestations/collateral/{checksum}": {
"get": {
"tags": [
- "SSH Keys"
+ "Attestations"
],
- "summary": "List user SSH keys",
- "description": "Returns all SSH keys belonging to the authenticated user.",
- "operationId": "get_user_ssh_keys_api_v1_user_ssh_keys_get",
- "responses": {
- "200": {
- "description": "List of SSH keys",
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/SshKeyResponse"
- },
- "type": "array",
- "title": "Response Get User Ssh Keys Api V1 User Ssh Keys Get"
- }
- }
- }
- },
- "401": {
- "description": "Not authenticated"
+ "summary": "Get quote collateral",
+ "description": "Returns TCB collateral data for quote verification. Cached for 24 hours.",
+ "operationId": "get_collateral_api_v1_attestations_collateral__checksum__get",
+ "parameters": [
+ {
+ "name": "checksum",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "Quote SHA256 checksum",
+ "title": "Checksum"
+ },
+ "description": "Quote SHA256 checksum"
}
- }
- },
- "post": {
- "tags": [
- "SSH Keys"
],
- "summary": "Add SSH key",
- "description": "Validates and stores an SSH public key. Minimum RSA 2048-bit, Ed25519 recommended.",
- "operationId": "create_user_ssh_key_api_v1_user_ssh_keys_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/SshKeyCreateRequest"
- }
- }
- },
- "required": true
- },
"responses": {
- "201": {
- "description": "Key created",
+ "200": {
+ "description": "Collateral data",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/SshKeyResponse"
- }
+ "schema": {}
}
}
},
"400": {
- "description": "Invalid key format or key too weak"
+ "description": "Bad quote data"
},
- "401": {
- "description": "Not authenticated"
+ "404": {
+ "description": "Quote not found"
},
"422": {
"description": "Validation Error",
@@ -9537,39 +5330,39 @@
}
}
},
- "/api/v1/user/ssh-keys/{key_id}": {
- "delete": {
+ "/api/v1/attestations/raw/{checksum}": {
+ "get": {
"tags": [
- "SSH Keys"
+ "Attestations"
],
- "summary": "Delete SSH key",
- "description": "Soft-deletes an SSH key. Key must belong to the authenticated user.",
- "operationId": "delete_user_ssh_key_api_v1_user_ssh_keys__key_id__delete",
+ "summary": "Download raw quote",
+ "description": "Returns raw quote bytes as binary file attachment.",
+ "operationId": "handle_get_raw_api_v1_attestations_raw__checksum__get",
"parameters": [
{
- "name": "key_id",
+ "name": "checksum",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "SSH key hashid",
- "title": "Key Id"
+ "description": "Quote SHA256 checksum",
+ "title": "Checksum"
},
- "description": "SSH key hashid"
+ "description": "Quote SHA256 checksum"
}
],
"responses": {
- "204": {
- "description": "Key deleted"
- },
- "400": {
- "description": "Invalid key ID format"
- },
- "401": {
- "description": "Not authenticated"
+ "200": {
+ "description": "Binary quote file",
+ "content": {
+ "application/json": {
+ "schema": {}
+ },
+ "application/octet-stream": {}
+ }
},
"404": {
- "description": "Key not found"
+ "description": "Quote not found"
},
"422": {
"description": "Validation Error",
@@ -9582,42 +5375,38 @@
}
}
}
- }
- },
- "/api/v1/user/ssh-keys/github-profile": {
- "post": {
+ },
+ "head": {
"tags": [
- "SSH Keys"
+ "Attestations"
+ ],
+ "summary": "Check raw quote exists",
+ "description": "Returns headers without body. Use to check existence and get Content-Length.",
+ "operationId": "handle_check_raw_file_api_v1_attestations_raw__checksum__head",
+ "parameters": [
+ {
+ "name": "checksum",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "Quote SHA256 checksum",
+ "title": "Checksum"
+ },
+ "description": "Quote SHA256 checksum"
+ }
],
- "summary": "Import keys from GitHub profile",
- "description": "Fetches public SSH keys from any GitHub user's profile via the unauthenticated GitHub API. Deduplicates against the user's existing keys by fingerprint.",
- "operationId": "import_github_profile_ssh_keys_api_v1_user_ssh_keys_github_profile_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GithubProfileImportRequest"
- }
- }
- },
- "required": true
- },
"responses": {
"200": {
- "description": "Import completed; check keys_added and errors for per-key results",
+ "description": "Quote exists",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GithubProfileImportResponse"
- }
+ "schema": {}
}
}
},
- "400": {
- "description": "GitHub user not found, API request timed out, or network error"
- },
- "401": {
- "description": "Not authenticated"
+ "404": {
+ "description": "Quote not found"
},
"422": {
"description": "Validation Error",
@@ -9632,170 +5421,123 @@
}
}
},
- "/api/v1/user/ssh-keys/github-sync": {
- "post": {
+ "/api/v1/attestations/ppids": {
+ "get": {
"tags": [
- "SSH Keys"
+ "Attestations"
],
- "summary": "Sync keys from GitHub",
- "description": "Imports SSH keys from linked GitHub account. Adds new keys, updates existing, removes deleted.",
- "operationId": "sync_github_ssh_keys_api_v1_user_ssh_keys_github_sync_post",
+ "summary": "List node PPIDs",
+ "description": "Public endpoint. Returns PPID list from nodes table (excluding deleted).",
+ "operationId": "handle_list_ppids_api_v1_attestations_ppids_get",
"responses": {
"200": {
- "description": "Sync completed",
+ "description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GithubSyncResponse"
- }
+ "schema": {}
}
}
- },
- "400": {
- "description": "GitHub not linked or authorization revoked"
- },
- "401": {
- "description": "Not authenticated"
}
}
}
},
- "/api/v1/profiles/me": {
+ "/api/v1/attestations/device_ids": {
"get": {
"tags": [
- "Profiles"
+ "Attestations"
],
- "summary": "Get current user profile",
- "description": "Returns the authenticated user's profile. Returns null if no profile exists.",
- "operationId": "get_my_profile_api_v1_profiles_me_get",
+ "summary": "List node device IDs",
+ "description": "Public endpoint. Returns device_id list from nodes table (excluding deleted).",
+ "operationId": "handle_list_device_ids_api_v1_attestations_device_ids_get",
"responses": {
"200": {
- "description": "Profile data or null",
+ "description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ProfileGetResponse"
- },
- {
- "type": "null"
- }
- ],
- "title": "Response Get My Profile Api V1 Profiles Me Get"
- }
+ "schema": {}
}
}
- },
- "401": {
- "description": "Not authenticated"
- }
- },
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
}
- ]
- },
- "put": {
+ }
+ }
+ },
+ "/api/v1/attestations/nodes": {
+ "get": {
"tags": [
- "Profiles"
+ "Attestations"
],
- "summary": "Update current user profile",
- "description": "Accepts JSON body. custom_domain rejected for user profiles.",
- "operationId": "update_my_profile_api_v1_profiles_me_put",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ProfileUpdateRequest"
- }
- }
- },
- "required": true
- },
+ "summary": "List nodes",
+ "description": "Public endpoint. Returns NodeRef list derived from nodes table (excluding deleted).",
+ "operationId": "handle_list_nodes_api_v1_attestations_nodes_get",
"responses": {
"200": {
- "description": "Updated profile",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ProfileGetResponse"
+ "items": {
+ "$ref": "#/components/schemas/NodeRef"
+ },
+ "type": "array",
+ "title": "Response Handle List Nodes Api V1 Attestations Nodes Get"
}
}
}
- },
- "400": {
- "description": "custom_domain not allowed for user profiles"
- },
- "401": {
- "description": "Not authenticated"
- },
- "422": {
- "description": "Validation Error",
+ }
+ }
+ }
+ },
+ "/api/v1/workspace/webhooks": {
+ "get": {
+ "tags": [
+ "Webhooks"
+ ],
+ "summary": "List workspace webhooks",
+ "operationId": "list_webhooks_api_v1_workspace_webhooks_get",
+ "responses": {
+ "200": {
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
+ "items": {
+ "$ref": "#/components/schemas/WebhookResponse"
+ },
+ "type": "array",
+ "title": "Response List Webhooks Api V1 Workspace Webhooks Get"
}
}
}
}
- },
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ]
- }
- },
- "/api/v1/profiles/me/avatar": {
- "put": {
+ }
+ },
+ "post": {
"tags": [
- "Profiles"
+ "Webhooks"
],
- "summary": "Upload avatar for current user",
- "description": "Multipart file upload. Avatar max 5MB (jpeg/png/gif/webp).",
- "operationId": "upload_my_avatar_api_v1_profiles_me_avatar_put",
+ "summary": "Create workspace webhook",
+ "operationId": "create_webhook_api_v1_workspace_webhooks_post",
"requestBody": {
"content": {
- "multipart/form-data": {
+ "application/json": {
"schema": {
- "$ref": "#/components/schemas/Body_upload_my_avatar_api_v1_profiles_me_avatar_put"
+ "$ref": "#/components/schemas/WebhookCreateRequest"
}
}
},
"required": true
},
"responses": {
- "200": {
- "description": "Updated profile with new avatar",
+ "201": {
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ProfileGetResponse"
+ "$ref": "#/components/schemas/WebhookResponse"
}
}
}
},
- "400": {
- "description": "Invalid file type"
- },
- "401": {
- "description": "Not authenticated"
- },
- "413": {
- "description": "File exceeds 5MB limit"
- },
- "500": {
- "description": "Avatar upload failed"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -9806,107 +5548,38 @@
}
}
}
- },
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ]
- },
- "delete": {
- "tags": [
- "Profiles"
- ],
- "summary": "Remove avatar for current user",
- "description": "Remove avatar for the authenticated user.",
- "operationId": "delete_my_avatar_api_v1_profiles_me_avatar_delete",
- "responses": {
- "200": {
- "description": "Updated profile with avatar removed",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ProfileGetResponse"
- }
- }
- }
- },
- "401": {
- "description": "Not authenticated"
- }
- },
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
- ]
+ }
}
},
- "/api/v1/profiles/{entity_type}/{entity_id}": {
+ "/api/v1/workspace/webhooks/{webhook_id}": {
"get": {
"tags": [
- "Profiles"
+ "Webhooks"
],
- "summary": "Get entity profile",
- "description": "Public endpoint. Returns profile for any entity type. Accepts hashids (wks_xxx, prj_xxx) or integers.",
- "operationId": "get_profile_api_v1_profiles__entity_type___entity_id__get",
+ "summary": "Get webhook details",
+ "operationId": "get_webhook_api_v1_workspace_webhooks__webhook_id__get",
"parameters": [
{
- "name": "entity_type",
- "in": "path",
- "required": true,
- "schema": {
- "enum": [
- "user",
- "workspace",
- "app"
- ],
- "type": "string",
- "description": "Entity type: user, workspace, or app",
- "title": "Entity Type"
- },
- "description": "Entity type: user, workspace, or app"
- },
- {
- "name": "entity_id",
+ "name": "webhook_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Entity ID (hashid or integer)",
- "title": "Entity Id"
- },
- "description": "Entity ID (hashid or integer)"
+ "title": "Webhook Id"
+ }
}
],
"responses": {
"200": {
- "description": "Profile data or null",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ProfileGetResponse"
- },
- {
- "type": "null"
- }
- ],
- "title": "Response Get Profile Api V1 Profiles Entity Type Entity Id Get"
+ "$ref": "#/components/schemas/WebhookResponse"
}
}
}
},
- "400": {
- "description": "Invalid entity ID format"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -9921,46 +5594,19 @@
},
"put": {
"tags": [
- "Profiles"
- ],
- "summary": "Update entity profile",
- "description": "Accepts JSON body. Requires permission: own profile for users, OWNER/ADMIN for workspaces, any member for apps. custom_domain only for apps.",
- "operationId": "update_profile_api_v1_profiles__entity_type___entity_id__put",
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
+ "Webhooks"
],
+ "summary": "Update webhook",
+ "operationId": "update_webhook_api_v1_workspace_webhooks__webhook_id__put",
"parameters": [
{
- "name": "entity_type",
- "in": "path",
- "required": true,
- "schema": {
- "enum": [
- "user",
- "workspace",
- "app"
- ],
- "type": "string",
- "description": "Entity type: user, workspace, or app",
- "title": "Entity Type"
- },
- "description": "Entity type: user, workspace, or app"
- },
- {
- "name": "entity_id",
+ "name": "webhook_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Entity ID (hashid or integer)",
- "title": "Entity Id"
- },
- "description": "Entity ID (hashid or integer)"
+ "title": "Webhook Id"
+ }
}
],
"requestBody": {
@@ -9968,31 +5614,22 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ProfileUpdateRequest"
+ "$ref": "#/components/schemas/WebhookUpdateRequest"
}
}
}
},
"responses": {
"200": {
- "description": "Updated profile",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ProfileGetResponse"
+ "$ref": "#/components/schemas/WebhookResponse"
}
}
}
},
- "400": {
- "description": "Invalid ID format or custom_domain on wrong entity type"
- },
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "No permission to edit this profile"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -10007,68 +5644,24 @@
},
"delete": {
"tags": [
- "Profiles"
- ],
- "summary": "Delete entity profile",
- "description": "Requires permission: own profile for users, OWNER/ADMIN for workspaces, any member for apps.",
- "operationId": "delete_profile_api_v1_profiles__entity_type___entity_id__delete",
- "security": [
- {
- "OAuth2AuthorizationCodeBearer": []
- },
- {
- "APIKeyHeader": []
- }
+ "Webhooks"
],
+ "summary": "Delete webhook",
+ "operationId": "delete_webhook_api_v1_workspace_webhooks__webhook_id__delete",
"parameters": [
{
- "name": "entity_type",
- "in": "path",
- "required": true,
- "schema": {
- "enum": [
- "user",
- "workspace",
- "app"
- ],
- "type": "string",
- "description": "Entity type: user, workspace, or app",
- "title": "Entity Type"
- },
- "description": "Entity type: user, workspace, or app"
- },
- {
- "name": "entity_id",
+ "name": "webhook_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Entity ID (hashid or integer)",
- "title": "Entity Id"
- },
- "description": "Entity ID (hashid or integer)"
+ "title": "Webhook Id"
+ }
}
],
"responses": {
- "200": {
- "description": "Profile deleted",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Invalid entity ID format"
- },
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "No permission to delete this profile"
- },
- "404": {
- "description": "Profile not found"
+ "204": {
+ "description": "Successful Response"
},
"422": {
"description": "Validation Error",
@@ -10083,14 +5676,13 @@
}
}
},
- "/api/v1/profiles/{entity_type}/{entity_id}/avatar": {
- "put": {
+ "/api/v1/workspace/webhooks/{webhook_id}/reveal-secret": {
+ "post": {
"tags": [
- "Profiles"
+ "Webhooks"
],
- "summary": "Upload avatar for entity",
- "description": "Multipart file upload. Avatar max 5MB (jpeg/png/gif/webp).",
- "operationId": "upload_avatar_api_v1_profiles__entity_type___entity_id__avatar_put",
+ "summary": "Reveal webhook secret (requires 2FA)",
+ "operationId": "reveal_webhook_secret_api_v1_workspace_webhooks__webhook_id__reveal_secret_post",
"security": [
{
"OAuth2AuthorizationCodeBearer": []
@@ -10101,69 +5693,24 @@
],
"parameters": [
{
- "name": "entity_type",
- "in": "path",
- "required": true,
- "schema": {
- "enum": [
- "user",
- "workspace",
- "app"
- ],
- "type": "string",
- "description": "Entity type: user, workspace, or app",
- "title": "Entity Type"
- },
- "description": "Entity type: user, workspace, or app"
- },
- {
- "name": "entity_id",
+ "name": "webhook_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Entity ID (hashid or integer)",
- "title": "Entity Id"
- },
- "description": "Entity ID (hashid or integer)"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "multipart/form-data": {
- "schema": {
- "$ref": "#/components/schemas/Body_upload_avatar_api_v1_profiles__entity_type___entity_id__avatar_put"
- }
+ "title": "Webhook Id"
}
}
- },
+ ],
"responses": {
"200": {
- "description": "Updated profile with new avatar",
+ "description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/ProfileGetResponse"
- }
+ "schema": {}
}
}
},
- "400": {
- "description": "Invalid file type or entity ID"
- },
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "No permission"
- },
- "413": {
- "description": "File exceeds 5MB limit"
- },
- "500": {
- "description": "Avatar upload failed"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -10175,14 +5722,15 @@
}
}
}
- },
- "delete": {
+ }
+ },
+ "/api/v1/workspace/webhooks/{webhook_id}/rotate-secret": {
+ "post": {
"tags": [
- "Profiles"
+ "Webhooks"
],
- "summary": "Remove avatar for entity",
- "description": "Remove avatar for a user, workspace, or app.",
- "operationId": "delete_avatar_api_v1_profiles__entity_type___entity_id__avatar_delete",
+ "summary": "Rotate webhook secret (requires 2FA)",
+ "operationId": "rotate_webhook_secret_api_v1_workspace_webhooks__webhook_id__rotate_secret_post",
"security": [
{
"OAuth2AuthorizationCodeBearer": []
@@ -10193,53 +5741,24 @@
],
"parameters": [
{
- "name": "entity_type",
- "in": "path",
- "required": true,
- "schema": {
- "enum": [
- "user",
- "workspace",
- "app"
- ],
- "type": "string",
- "description": "Entity type: user, workspace, or app",
- "title": "Entity Type"
- },
- "description": "Entity type: user, workspace, or app"
- },
- {
- "name": "entity_id",
+ "name": "webhook_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Entity ID (hashid or integer)",
- "title": "Entity Id"
- },
- "description": "Entity ID (hashid or integer)"
+ "title": "Webhook Id"
+ }
}
],
"responses": {
"200": {
- "description": "Updated profile with avatar removed",
+ "description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/ProfileGetResponse"
- }
+ "schema": {}
}
}
},
- "400": {
- "description": "Invalid entity ID"
- },
- "401": {
- "description": "Not authenticated"
- },
- "403": {
- "description": "No permission"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -10253,115 +5772,99 @@
}
}
},
- "/api/v1/usage/current": {
- "get": {
+ "/api/v1/workspace/webhooks/{webhook_id}/test": {
+ "post": {
"tags": [
- "Usage"
+ "Webhooks"
+ ],
+ "summary": "Send test webhook event",
+ "operationId": "test_webhook_api_v1_workspace_webhooks__webhook_id__test_post",
+ "parameters": [
+ {
+ "name": "webhook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Webhook Id"
+ }
+ }
],
- "summary": "Get current usage status",
- "description": "Returns running CVM count with cost forecast for today and the month.",
- "operationId": "get_current_status_api_v1_usage_current_get",
"responses": {
"200": {
- "description": "Current usage status with forecasts",
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CurrentStatusResponse"
+ "$ref": "#/components/schemas/HTTPValidationError"
}
}
}
- },
- "401": {
- "description": "Authentication required"
}
}
}
},
- "/api/v1/usage/data": {
+ "/api/v1/workspace/webhooks/{webhook_id}/deliveries": {
"get": {
"tags": [
- "Usage"
+ "Webhooks"
],
- "summary": "Get usage data",
- "description": "Returns metered usage for the specified period: core metrics, daily trends, instance type breakdown, and per-CVM details.",
- "operationId": "get_usage_data_api_v1_usage_data_get",
+ "summary": "List webhook deliveries",
+ "operationId": "list_deliveries_api_v1_workspace_webhooks__webhook_id__deliveries_get",
"parameters": [
{
- "name": "range_type",
- "in": "query",
- "required": false,
+ "name": "webhook_id",
+ "in": "path",
+ "required": true,
"schema": {
- "enum": [
- "today",
- "week",
- "month",
- "quarter",
- "custom"
- ],
"type": "string",
- "description": "Time range preset",
- "default": "month",
- "title": "Range Type"
- },
- "description": "Time range preset"
+ "title": "Webhook Id"
+ }
},
{
- "name": "custom_start",
+ "name": "limit",
"in": "query",
"required": false,
"schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "date"
- },
- {
- "type": "null"
- }
- ],
- "description": "Start date for custom range (YYYY-MM-DD)",
- "title": "Custom Start"
- },
- "description": "Start date for custom range (YYYY-MM-DD)"
+ "type": "integer",
+ "default": 50,
+ "title": "Limit"
+ }
},
{
- "name": "custom_end",
+ "name": "offset",
"in": "query",
"required": false,
"schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "date"
- },
- {
- "type": "null"
- }
- ],
- "description": "End date for custom range (YYYY-MM-DD)",
- "title": "Custom End"
- },
- "description": "End date for custom range (YYYY-MM-DD)"
+ "type": "integer",
+ "default": 0,
+ "title": "Offset"
+ }
}
],
"responses": {
"200": {
- "description": "Usage data with metrics and breakdown",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UsageDataResponse"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/WebhookDeliveryResponse"
+ },
+ "title": "Response List Deliveries Api V1 Workspace Webhooks Webhook Id Deliveries Get"
}
}
}
},
- "400": {
- "description": "Invalid range_type or custom date range"
- },
- "401": {
- "description": "Authentication required"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -10375,108 +5878,84 @@
}
}
},
- "/api/v1/usage/export": {
- "get": {
+ "/api/v1/workspace/webhooks/{webhook_id}/deliveries/{event_id}/resend": {
+ "post": {
"tags": [
- "Usage"
+ "Webhooks"
],
- "summary": "Export usage data",
- "description": "Downloads usage report as CSV (zipped), Excel, or PDF file.",
- "operationId": "export_usage_data_api_v1_usage_export_get",
+ "summary": "Resend a webhook delivery",
+ "operationId": "resend_delivery_api_v1_workspace_webhooks__webhook_id__deliveries__event_id__resend_post",
"parameters": [
{
- "name": "format",
- "in": "query",
- "required": false,
+ "name": "webhook_id",
+ "in": "path",
+ "required": true,
"schema": {
- "enum": [
- "csv",
- "xlsx",
- "pdf"
- ],
"type": "string",
- "description": "Export format: csv (zipped), xlsx, or pdf",
- "default": "csv",
- "title": "Format"
- },
- "description": "Export format: csv (zipped), xlsx, or pdf"
+ "title": "Webhook Id"
+ }
},
{
- "name": "range_type",
- "in": "query",
- "required": false,
+ "name": "event_id",
+ "in": "path",
+ "required": true,
"schema": {
- "enum": [
- "today",
- "week",
- "month",
- "quarter",
- "custom"
- ],
"type": "string",
- "description": "Time range preset",
- "default": "month",
- "title": "Range Type"
- },
- "description": "Time range preset"
+ "title": "Event Id"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
},
- {
- "name": "custom_start",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "date"
- },
- {
- "type": "null"
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
}
- ],
- "description": "Start date for custom range (YYYY-MM-DD)",
- "title": "Custom Start"
- },
- "description": "Start date for custom range (YYYY-MM-DD)"
- },
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/workspace/webhooks/{webhook_id}/stats": {
+ "get": {
+ "tags": [
+ "Webhooks"
+ ],
+ "summary": "Get webhook delivery stats",
+ "operationId": "webhook_stats_api_v1_workspace_webhooks__webhook_id__stats_get",
+ "parameters": [
{
- "name": "custom_end",
- "in": "query",
- "required": false,
+ "name": "webhook_id",
+ "in": "path",
+ "required": true,
"schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "date"
- },
- {
- "type": "null"
- }
- ],
- "description": "End date for custom range (YYYY-MM-DD)",
- "title": "Custom End"
- },
- "description": "End date for custom range (YYYY-MM-DD)"
+ "type": "string",
+ "title": "Webhook Id"
+ }
}
],
"responses": {
"200": {
- "description": "File download",
+ "description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
- },
- "application/zip": {},
- "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {},
- "application/pdf": {}
+ "schema": {
+ "$ref": "#/components/schemas/WebhookStatsResponse"
+ }
+ }
}
},
- "400": {
- "description": "Invalid range_type or custom date range"
- },
- "401": {
- "description": "Authentication required"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -10490,77 +5969,162 @@
}
}
},
- "/api/v1/gpus/reserved": {
+ "/api/v1/user/ssh-keys": {
"get": {
"tags": [
- "GPUs"
+ "SSH Keys"
],
- "summary": "List reserved GPUs",
- "description": "Returns all GPUs reserved for the workspace with their current mode and usage status. Queries each node via Teescope for live status.",
- "operationId": "list_reserved_gpus_api_v1_gpus_reserved_get",
+ "summary": "List user SSH keys",
+ "description": "Returns all SSH keys belonging to the authenticated user.",
+ "operationId": "get_user_ssh_keys_api_v1_user_ssh_keys_get",
"responses": {
"200": {
- "description": "List of reserved GPUs with status",
+ "description": "List of SSH keys",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ListReservedGpusResponse"
+ "items": {
+ "$ref": "#/components/schemas/SshKeyResponse"
+ },
+ "type": "array",
+ "title": "Response Get User Ssh Keys Api V1 User Ssh Keys Get"
}
}
}
},
"401": {
- "description": "Authentication required"
+ "description": "Not authenticated"
}
}
- }
- },
- "/api/v1/gpus/switch-mode": {
+ },
"post": {
"tags": [
- "GPUs"
+ "SSH Keys"
],
- "summary": "Switch GPU mode",
- "description": "Changes CC/PPCIe mode for reserved GPUs. All GPUs must be on the same node and idle (no attached VMs or VFIO processes).",
- "operationId": "switch_gpus_mode_api_v1_gpus_switch_mode_post",
+ "summary": "Add SSH key",
+ "description": "Validates and stores an SSH public key. Minimum RSA 2048-bit, Ed25519 recommended.",
+ "operationId": "create_user_ssh_key_api_v1_user_ssh_keys_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/SwitchGpusModeRequest"
+ "$ref": "#/components/schemas/SshKeyCreateRequest"
}
}
},
"required": true
},
"responses": {
- "200": {
- "description": "Mode switch completed",
+ "201": {
+ "description": "Key created",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/SwitchGpusModeResponse"
+ "$ref": "#/components/schemas/SshKeyResponse"
}
}
}
},
"400": {
- "description": "GPUs on different nodes or node missing API endpoint"
+ "description": "Invalid key format or key too weak"
},
"401": {
- "description": "Authentication required"
+ "description": "Not authenticated"
},
- "403": {
- "description": "Workspace has no reserved GPUs or requested GPUs not reserved"
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/user/ssh-keys/{key_id}": {
+ "delete": {
+ "tags": [
+ "SSH Keys"
+ ],
+ "summary": "Delete SSH key",
+ "description": "Soft-deletes an SSH key. Key must belong to the authenticated user.",
+ "operationId": "delete_user_ssh_key_api_v1_user_ssh_keys__key_id__delete",
+ "parameters": [
+ {
+ "name": "key_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "SSH key hashid",
+ "title": "Key Id"
+ },
+ "description": "SSH key hashid"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Key deleted"
+ },
+ "400": {
+ "description": "Invalid key ID format"
+ },
+ "401": {
+ "description": "Not authenticated"
},
"404": {
- "description": "One or more GPU IDs not found"
+ "description": "Key not found"
},
- "409": {
- "description": "GPUs are in use, cannot switch mode"
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/user/ssh-keys/github-profile": {
+ "post": {
+ "tags": [
+ "SSH Keys"
+ ],
+ "summary": "Import keys from GitHub profile",
+ "description": "Fetches public SSH keys from any GitHub user's profile via the unauthenticated GitHub API. Deduplicates against the user's existing keys by fingerprint.",
+ "operationId": "import_github_profile_ssh_keys_api_v1_user_ssh_keys_github_profile_post",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GithubProfileImportRequest"
+ }
+ }
},
- "503": {
- "description": "Node unreachable or mode switch failed"
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Import completed; check keys_added and errors for per-key results",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GithubProfileImportResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "GitHub user not found, API request timed out, or network error"
+ },
+ "401": {
+ "description": "Not authenticated"
},
"422": {
"description": "Validation Error",
@@ -10574,6 +6138,34 @@
}
}
}
+ },
+ "/api/v1/user/ssh-keys/github-sync": {
+ "post": {
+ "tags": [
+ "SSH Keys"
+ ],
+ "summary": "Sync keys from GitHub",
+ "description": "Imports SSH keys from linked GitHub account. Adds new keys, updates existing, removes deleted.",
+ "operationId": "sync_github_ssh_keys_api_v1_user_ssh_keys_github_sync_post",
+ "responses": {
+ "200": {
+ "description": "Sync completed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GithubSyncResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "GitHub not linked or authorization revoked"
+ },
+ "401": {
+ "description": "Not authenticated"
+ }
+ }
+ }
}
},
"components": {
@@ -11173,6 +6765,35 @@
"title": "Instance Id",
"description": "VM UUID (instance_id)"
},
+ "triggered_by": {
+ "type": "integer",
+ "title": "Triggered By",
+ "description": "User ID who triggered the event (0 = system)"
+ },
+ "triggered_by_username": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Triggered By Username",
+ "description": "Username of the triggering user"
+ },
+ "triggered_by_email": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Triggered By Email",
+ "description": "Email of the triggering user"
+ },
"cvm": {
"anyOf": [
{
@@ -11218,7 +6839,8 @@
"event_type",
"status",
"timestamp",
- "instance_id"
+ "instance_id",
+ "triggered_by"
],
"title": "AdminInstanceEventResponse",
"description": "Instance lifecycle event with CVM, user, and team context."
@@ -11280,7 +6902,7 @@
"description": "Last successful ping"
},
"capacity": {
- "$ref": "#/components/schemas/teehouse__api__routes__admin__nodes__TeepodCapacity",
+ "$ref": "#/components/schemas/teehouse__api__routes__admin__nodes__schemas__TeepodCapacity",
"description": "Resource capacity limits"
},
"resource_usage": {
@@ -11301,7 +6923,7 @@
"node_resource_usage": {
"anyOf": [
{
- "$ref": "#/components/schemas/teehouse__api__routes__admin__nodes__NodeResourceUsage"
+ "$ref": "#/components/schemas/teehouse__api__routes__admin__nodes__schemas__NodeResourceUsage"
},
{
"type": "null"
@@ -11817,6 +7439,122 @@
"title": "AllFamiliesResponse",
"description": "All instance type families with their types."
},
+ "AllocationDetail": {
+ "properties": {
+ "cvm_id": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Cvm Id"
+ },
+ "cvm_app_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Cvm App Id"
+ },
+ "cvm_vm_uuid": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Cvm Vm Uuid"
+ },
+ "cvm_status": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Cvm Status"
+ },
+ "node_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Node Name"
+ },
+ "teepod_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Teepod Name"
+ },
+ "gpus": {
+ "items": {
+ "$ref": "#/components/schemas/AllocationGpuDetail"
+ },
+ "type": "array",
+ "title": "Gpus"
+ },
+ "allocated_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Allocated At"
+ }
+ },
+ "type": "object",
+ "title": "AllocationDetail",
+ "description": "CVM allocation detail for an order."
+ },
+ "AllocationGpuDetail": {
+ "properties": {
+ "gpu_id": {
+ "type": "integer",
+ "title": "Gpu Id"
+ },
+ "product_id": {
+ "type": "string",
+ "title": "Product Id"
+ },
+ "slot": {
+ "type": "string",
+ "title": "Slot"
+ }
+ },
+ "type": "object",
+ "required": [
+ "gpu_id",
+ "product_id",
+ "slot"
+ ],
+ "title": "AllocationGpuDetail",
+ "description": "GPU details for an allocation."
+ },
"AllocationHistoryItem": {
"properties": {
"cvm_id": {
@@ -12205,6 +7943,8 @@
"properties": {
"name": {
"type": "string",
+ "maxLength": 100,
+ "minLength": 1,
"title": "Name"
},
"expires_in_days": {
@@ -12605,6 +8345,95 @@
],
"title": "AppIsAllowedResponse"
},
+ "AppKmsInfoResponse": {
+ "properties": {
+ "is_onchain_kms": {
+ "type": "boolean",
+ "title": "Is Onchain Kms",
+ "default": false
+ },
+ "chain_id": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Chain Id"
+ },
+ "kms_contract_address": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Kms Contract Address"
+ },
+ "app_contract_address": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "App Contract Address"
+ },
+ "deployer_address": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Deployer Address"
+ },
+ "deployer_type": {
+ "anyOf": [
+ {
+ "type": "string",
+ "enum": [
+ "eoa",
+ "safe",
+ "legacy_multisig",
+ "erc4337",
+ "contract"
+ ]
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Deployer Type"
+ },
+ "is_contract": {
+ "type": "boolean",
+ "title": "Is Contract",
+ "default": false
+ },
+ "safe_app_url": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Safe App Url"
+ }
+ },
+ "type": "object",
+ "title": "AppKmsInfoResponse"
+ },
"AppRevisionDetailResponse": {
"properties": {
"revision_id": {
@@ -14576,9 +10405,97 @@
}
],
"title": "Stripe Customer Email"
+ },
+ "billing_mode": {
+ "type": "string",
+ "enum": [
+ "prepaid",
+ "prepaid_auto_topup",
+ "post_paid"
+ ],
+ "title": "Billing Mode"
+ },
+ "flag_billing_v2_enabled": {
+ "type": "boolean",
+ "title": "Flag Billing V2 Enabled"
+ },
+ "auto_topup_enabled": {
+ "type": "boolean",
+ "title": "Auto Topup Enabled"
+ },
+ "auto_topup_amount": {
+ "type": "string",
+ "format": "decimal",
+ "title": "Auto Topup Amount",
+ "description": "A monetary value with precise decimal arithmetic",
+ "examples": [
+ "19.99",
+ "123.456000"
+ ]
+ },
+ "auto_topup_threshold": {
+ "type": "string",
+ "format": "decimal",
+ "title": "Auto Topup Threshold",
+ "description": "A monetary value with precise decimal arithmetic",
+ "examples": [
+ "19.99",
+ "123.456000"
+ ]
+ },
+ "post_paid_available": {
+ "type": "boolean",
+ "title": "Post Paid Available"
+ },
+ "post_paid_charge_cap": {
+ "type": "string",
+ "format": "decimal",
+ "title": "Post Paid Charge Cap",
+ "description": "A monetary value with precise decimal arithmetic",
+ "examples": [
+ "19.99",
+ "123.456000"
+ ]
+ },
+ "post_paid_grace_deadline": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Post Paid Grace Deadline"
+ },
+ "has_saved_card": {
+ "type": "boolean",
+ "title": "Has Saved Card"
+ },
+ "outstanding_debt": {
+ "type": "string",
+ "format": "decimal",
+ "title": "Outstanding Debt",
+ "description": "A monetary value with precise decimal arithmetic",
+ "default": "0.000000",
+ "examples": [
+ "19.99",
+ "123.456000"
+ ]
}
},
"type": "object",
+ "required": [
+ "billing_mode",
+ "flag_billing_v2_enabled",
+ "auto_topup_enabled",
+ "auto_topup_amount",
+ "auto_topup_threshold",
+ "post_paid_available",
+ "post_paid_charge_cap",
+ "has_saved_card"
+ ],
"title": "BillingSettingsResponse"
},
"BlacklistRequest": {
@@ -15912,38 +11829,6 @@
],
"title": "CIOTriggerBroadcastResponse"
},
- "CPUQuantity": {
- "properties": {
- "value": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "string"
- },
- {
- "type": "integer"
- }
- ],
- "title": "Value"
- },
- "suffix": {
- "type": "string",
- "enum": [
- "m",
- ""
- ],
- "title": "Suffix",
- "default": ""
- }
- },
- "type": "object",
- "required": [
- "value"
- ],
- "title": "CPUQuantity"
- },
"CVMDetail": {
"properties": {
"cvm_id": {
@@ -16222,6 +12107,11 @@
"type": "string",
"title": "Status"
},
+ "in_progress": {
+ "type": "boolean",
+ "title": "In Progress",
+ "default": false
+ },
"progress": {
"anyOf": [
{
@@ -16268,6 +12158,9 @@
"gateway": {
"$ref": "#/components/schemas/CVMGatewayInfo"
},
+ "logs": {
+ "$ref": "#/components/schemas/CVMLogUrls"
+ },
"services": {
"items": {
"additionalProperties": true,
@@ -16578,6 +12471,56 @@
"type": "object",
"title": "CVMKmsInfo"
},
+ "CVMLogUrls": {
+ "properties": {
+ "serial": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Serial"
+ },
+ "stdout": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Stdout"
+ },
+ "stderr": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Stderr"
+ },
+ "container_log_base": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Container Log Base"
+ }
+ },
+ "type": "object",
+ "title": "CVMLogUrls"
+ },
"CVMOSInfo": {
"properties": {
"name": {
@@ -16889,6 +12832,33 @@
"title": "CaaCheckResult",
"description": "CAA record check result (informational, not required for validation)."
},
+ "CancelOperationRequest": {
+ "properties": {
+ "cancelled": {
+ "type": "boolean",
+ "title": "Cancelled",
+ "description": "Whether an operation was actually cancelled"
+ },
+ "correlation_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Correlation Id",
+ "description": "Correlation ID of the cancelled op"
+ }
+ },
+ "type": "object",
+ "required": [
+ "cancelled"
+ ],
+ "title": "CancelOperationRequest",
+ "description": "Response for cancel operation."
+ },
"CancelOperationResponse": {
"properties": {
"cvm_id": {
@@ -17431,6 +13401,12 @@
],
"title": "Invoice Id",
"description": "Invoice ID for direct invoice payment"
+ },
+ "force_checkout": {
+ "type": "boolean",
+ "title": "Force Checkout",
+ "description": "For Stripe only: skip direct card charge and always create checkout session",
+ "default": false
}
},
"type": "object",
@@ -17772,6 +13748,11 @@
"type": "null"
}
]
+ },
+ "compose_hash_registered": {
+ "type": "boolean",
+ "title": "Compose Hash Registered",
+ "default": false
}
},
"type": "object",
@@ -18170,110 +14151,6 @@
],
"title": "ConnectionListResponse"
},
- "Container": {
- "properties": {
- "name": {
- "type": "string",
- "title": "Name"
- },
- "image": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/ImageSpec"
- }
- ],
- "title": "Image"
- },
- "resources": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ResourceRequirements"
- },
- {
- "type": "null"
- }
- ]
- },
- "ports": {
- "anyOf": [
- {
- "items": {
- "$ref": "#/components/schemas/ContainerPort"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Ports"
- }
- },
- "type": "object",
- "required": [
- "name",
- "image"
- ],
- "title": "Container"
- },
- "ContainerPort": {
- "properties": {
- "containerPort": {
- "type": "integer",
- "maximum": 65535.0,
- "minimum": 1.0,
- "title": "Containerport"
- },
- "name": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Name"
- },
- "hostPort": {
- "anyOf": [
- {
- "type": "integer",
- "maximum": 65535.0,
- "minimum": 1.0
- },
- {
- "type": "null"
- }
- ],
- "title": "Hostport"
- },
- "protocol": {
- "$ref": "#/components/schemas/Protocol",
- "default": "TCP"
- },
- "hostIP": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Hostip"
- }
- },
- "type": "object",
- "required": [
- "containerPort"
- ],
- "title": "ContainerPort",
- "description": "ContainerPort represents a network port in a single container.\nRef: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#containerport-v1-core"
- },
"ContractDeviceOut": {
"properties": {
"device_id": {
@@ -18481,6 +14358,109 @@
"title": "CoreMetrics",
"description": "Core usage metrics."
},
+ "CreateAppInstanceRequest": {
+ "properties": {
+ "teepod_id": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Teepod Id",
+ "description": "Target node ID (deprecated, use node_id)"
+ },
+ "node_id": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Node Id",
+ "description": "Target node ID for the replica"
+ },
+ "encrypted_env": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Encrypted Env",
+ "description": "New encrypted env blob (hex)"
+ },
+ "compose_hash": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Compose Hash",
+ "description": "Explicit compose hash to replicate. Required when the source app has multiple live instances."
+ },
+ "docker_compose_file": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Docker Compose File",
+ "description": "New Docker Compose YAML content"
+ },
+ "pre_launch_script": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Pre Launch Script",
+ "description": "New pre-launch script content"
+ },
+ "token": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Token",
+ "description": "Commit token returned by a prior prepare-only request. When set, this request commits the previously-prepared instance instead of preparing a new one."
+ },
+ "transaction_hash": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Transaction Hash",
+ "description": "On-chain transaction hash proving compose-hash registration. Use 'already-registered' (or omit) when the hash was registered earlier."
+ }
+ },
+ "type": "object",
+ "title": "CreateAppInstanceRequest",
+ "description": "Request model for creating a new instance under an existing app.\n\nInherits node_id, encrypted_env, compose_hash and their validators from ReplicateRequest."
+ },
"CreateConnectionRequest": {
"properties": {
"user_id": {
@@ -20491,6 +16471,24 @@
],
"title": "Boot Error"
},
+ "shutdown_progress": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Shutdown Progress"
+ },
+ "events": {
+ "items": {
+ "$ref": "#/components/schemas/GuestEvent"
+ },
+ "type": "array",
+ "title": "Events"
+ },
"operation_type": {
"anyOf": [
{
@@ -20611,6 +16609,241 @@
],
"title": "CvmSystemInfo"
},
+ "CvmTeescopeEgress": {
+ "properties": {
+ "total_sent_bytes": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Total Sent Bytes",
+ "default": 0
+ },
+ "total_recv_bytes": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Total Recv Bytes",
+ "default": 0
+ },
+ "peak_sent_kbs": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Peak Sent Kbs",
+ "default": 0.0
+ },
+ "peak_recv_kbs": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Peak Recv Kbs",
+ "default": 0.0
+ }
+ },
+ "type": "object",
+ "title": "CvmTeescopeEgress"
+ },
+ "CvmTeescopeInfo": {
+ "properties": {
+ "vm_uuid": {
+ "type": "string",
+ "title": "Vm Uuid"
+ },
+ "qemu": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/CvmTeescopeQemu"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "storage": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/CvmTeescopeStorage"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "egress": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/CvmTeescopeEgress"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "ingress": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/CvmTeescopeIngress"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "type": "object",
+ "required": [
+ "vm_uuid"
+ ],
+ "title": "CvmTeescopeInfo"
+ },
+ "CvmTeescopeIngress": {
+ "properties": {
+ "app_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "App Id"
+ },
+ "total_bytes": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Total Bytes",
+ "default": 0
+ },
+ "connections": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Connections",
+ "default": 0
+ },
+ "snis": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Snis"
+ }
+ },
+ "type": "object",
+ "title": "CvmTeescopeIngress"
+ },
+ "CvmTeescopeQemu": {
+ "properties": {
+ "pid": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Pid"
+ },
+ "uptime": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Uptime",
+ "default": 0
+ },
+ "cpu_usage_perc": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Cpu Usage Perc",
+ "default": 0.0
+ },
+ "cpu_pct_usr": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Cpu Pct Usr",
+ "default": 0.0
+ },
+ "cpu_pct_system": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Cpu Pct System",
+ "default": 0.0
+ },
+ "cpu_pct_guest": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Cpu Pct Guest",
+ "default": 0.0
+ },
+ "cpu_pct_wait": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Cpu Pct Wait",
+ "default": 0.0
+ },
+ "cpu_pct_total": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Cpu Pct Total",
+ "default": 0.0
+ },
+ "cpu_cores": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Cpu Cores",
+ "default": 0
+ },
+ "allocated_mb": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Allocated Mb",
+ "default": 0
+ },
+ "kvm_guest_mem_mb": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Kvm Guest Mem Mb",
+ "default": 0.0
+ },
+ "kvm_mem_usage_perc": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Kvm Mem Usage Perc",
+ "default": 0.0
+ },
+ "io_read_bytes": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Io Read Bytes",
+ "default": 0
+ },
+ "io_write_bytes": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Io Write Bytes",
+ "default": 0
+ },
+ "slots": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Slots"
+ }
+ },
+ "type": "object",
+ "required": [
+ "pid"
+ ],
+ "title": "CvmTeescopeQemu"
+ },
+ "CvmTeescopeStorage": {
+ "properties": {
+ "size_bytes": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Size Bytes",
+ "default": 0
+ },
+ "exists": {
+ "type": "boolean",
+ "title": "Exists",
+ "default": false
+ }
+ },
+ "type": "object",
+ "title": "CvmTeescopeStorage"
+ },
"CvmUpgradePayload": {
"properties": {
"id": {
@@ -20986,6 +17219,119 @@
"title": "DailyUsageItem",
"description": "Daily usage item with compute and disk costs."
},
+ "DecoupleOrderRequest": {
+ "properties": {
+ "reason": {
+ "type": "string",
+ "maxLength": 500,
+ "minLength": 1,
+ "title": "Reason",
+ "description": "Short justification recorded in logs and returned to the caller"
+ },
+ "internal_note": {
+ "anyOf": [
+ {
+ "type": "string",
+ "maxLength": 2000
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Internal Note",
+ "description": "Optional extended audit note, not user-visible"
+ },
+ "target_billing_period": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/BillingPeriod"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Explicit billing period for the detached CVMs. Defaults to HOURLY for regular tiers and SKIP for enterprise tiers."
+ }
+ },
+ "type": "object",
+ "required": [
+ "reason"
+ ],
+ "title": "DecoupleOrderRequest",
+ "description": "Input for decoupling a GPU rental order."
+ },
+ "DecoupleOrderResponse": {
+ "properties": {
+ "order_id": {
+ "type": "string",
+ "format": "hashid",
+ "title": "Order Id",
+ "description": "A hashed identifier that maps to an internal database ID",
+ "examples": [
+ "0123abcd"
+ ]
+ },
+ "status": {
+ "$ref": "#/components/schemas/GpuRentalOrderStatus"
+ },
+ "previous_status": {
+ "$ref": "#/components/schemas/GpuRentalOrderStatus"
+ },
+ "decoupled_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Decoupled At"
+ },
+ "target_billing_period": {
+ "$ref": "#/components/schemas/BillingPeriod"
+ },
+ "affected_cvms": {
+ "items": {
+ "$ref": "#/components/schemas/DecoupledCvmChangeOut"
+ },
+ "type": "array",
+ "title": "Affected Cvms"
+ }
+ },
+ "type": "object",
+ "required": [
+ "order_id",
+ "status",
+ "previous_status",
+ "decoupled_at",
+ "target_billing_period",
+ "affected_cvms"
+ ],
+ "title": "DecoupleOrderResponse"
+ },
+ "DecoupledCvmChangeOut": {
+ "properties": {
+ "cvm_id": {
+ "type": "integer",
+ "title": "Cvm Id"
+ },
+ "previous_billing_period": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/BillingPeriod"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "new_billing_period": {
+ "$ref": "#/components/schemas/BillingPeriod"
+ }
+ },
+ "type": "object",
+ "required": [
+ "cvm_id",
+ "previous_billing_period",
+ "new_billing_period"
+ ],
+ "title": "DecoupledCvmChangeOut"
+ },
"DeviceAllowlistItem": {
"properties": {
"device_id": {
@@ -21393,41 +17739,104 @@
],
"title": "DiskInfo"
},
- "DiskQuantity": {
+ "DisputeOperation": {
"properties": {
- "value": {
+ "cvm_id": {
+ "type": "integer",
+ "title": "Cvm Id"
+ },
+ "cvm_name": {
+ "type": "string",
+ "title": "Cvm Name"
+ },
+ "instance_id": {
+ "type": "string",
+ "title": "Instance Id"
+ },
+ "operation": {
+ "type": "string",
+ "title": "Operation"
+ },
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp"
+ },
+ "triggered_by": {
+ "type": "integer",
+ "title": "Triggered By"
+ },
+ "triggered_by_username": {
"anyOf": [
{
- "type": "number"
+ "type": "string"
},
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Triggered By Username"
+ },
+ "running_duration_hours": {
+ "anyOf": [
{
"type": "string"
+ },
+ {
+ "type": "null"
}
],
- "title": "Value"
+ "title": "Running Duration Hours"
+ }
+ },
+ "type": "object",
+ "required": [
+ "cvm_id",
+ "cvm_name",
+ "instance_id",
+ "operation",
+ "timestamp",
+ "triggered_by"
+ ],
+ "title": "DisputeOperation"
+ },
+ "DisputeTimelineResponse": {
+ "properties": {
+ "team_id": {
+ "type": "integer",
+ "title": "Team Id"
},
- "suffix": {
+ "team_name": {
"type": "string",
- "enum": [
- "Ki",
- "Mi",
- "Gi",
- "Ti",
- "k",
- "m",
- "G",
- "T",
- ""
- ],
- "title": "Suffix",
- "default": ""
+ "title": "Team Name"
+ },
+ "period_start": {
+ "type": "string",
+ "format": "date",
+ "title": "Period Start"
+ },
+ "period_end": {
+ "type": "string",
+ "format": "date",
+ "title": "Period End"
+ },
+ "operations": {
+ "items": {
+ "$ref": "#/components/schemas/DisputeOperation"
+ },
+ "type": "array",
+ "title": "Operations"
}
},
"type": "object",
"required": [
- "value"
+ "team_id",
+ "team_name",
+ "period_start",
+ "period_end",
+ "operations"
],
- "title": "DiskQuantity"
+ "title": "DisputeTimelineResponse"
},
"DnsRecordResult": {
"properties": {
@@ -22612,10 +19021,39 @@
"title": "FinalizeInvoiceResponse",
"description": "Response for finalize invoice operation."
},
+ "FirewallStatusResponse": {
+ "properties": {
+ "available": {
+ "type": "boolean",
+ "title": "Available",
+ "description": "Whether firewall/port-mapping is available"
+ },
+ "reason": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Reason",
+ "description": "Why it is unavailable"
+ }
+ },
+ "type": "object",
+ "required": [
+ "available"
+ ],
+ "title": "FirewallStatusResponse",
+ "description": "Firewall availability for the node hosting a CVM."
+ },
"GithubProfileImportRequest": {
"properties": {
"github_username": {
"type": "string",
+ "maxLength": 39,
+ "minLength": 1,
"title": "Github Username",
"description": "GitHub username to import SSH keys from"
}
@@ -23454,6 +19892,136 @@
"title": "GpuRentalOrderCreateResponse",
"description": "Response payload for GPU rental order creation (minimal info)."
},
+ "GpuRentalOrderHistoryItem": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "pattern": "^gord_.+",
+ "format": "hashid",
+ "title": "HashedId[gpu_rental_orders]",
+ "description": "A hashed identifier that maps to an internal database ID",
+ "examples": [
+ "gord_0123abcd"
+ ]
+ },
+ "status": {
+ "$ref": "#/components/schemas/GpuRentalOrderStatus"
+ },
+ "sku": {
+ "$ref": "#/components/schemas/GpuSkuHistoryResponse"
+ },
+ "quantity": {
+ "type": "integer",
+ "title": "Quantity"
+ },
+ "agreed_hourly_rate": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Agreed Hourly Rate"
+ },
+ "total_spent": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Total Spent"
+ },
+ "created_at": {
+ "type": "string",
+ "title": "Created At"
+ },
+ "activated_at": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Activated At"
+ },
+ "completed_at": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Completed At"
+ },
+ "cancelled_at": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Cancelled At"
+ }
+ },
+ "type": "object",
+ "required": [
+ "id",
+ "status",
+ "sku",
+ "quantity",
+ "created_at"
+ ],
+ "title": "GpuRentalOrderHistoryItem",
+ "description": "User-facing order history item. Does not expose admin-only decouple metadata."
+ },
+ "GpuRentalOrderHistoryResponse": {
+ "properties": {
+ "items": {
+ "items": {
+ "$ref": "#/components/schemas/GpuRentalOrderHistoryItem"
+ },
+ "type": "array",
+ "title": "Items"
+ },
+ "total": {
+ "type": "integer",
+ "title": "Total"
+ },
+ "page": {
+ "type": "integer",
+ "title": "Page"
+ },
+ "page_size": {
+ "type": "integer",
+ "title": "Page Size"
+ },
+ "pages": {
+ "type": "integer",
+ "title": "Pages"
+ }
+ },
+ "type": "object",
+ "required": [
+ "items",
+ "total",
+ "page",
+ "page_size",
+ "pages"
+ ],
+ "title": "GpuRentalOrderHistoryResponse",
+ "description": "Paginated order history response."
+ },
"GpuRentalOrderItem": {
"properties": {
"id": {
@@ -23591,6 +20159,30 @@
],
"title": "Cancelled At"
},
+ "decoupled_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Decoupled At"
+ },
+ "hourly_billing_start_time": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Hourly Billing Start Time"
+ },
"created_at": {
"type": "string",
"format": "date-time",
@@ -23703,6 +20295,73 @@
"type": "integer",
"title": "Allocation Count",
"default": 0
+ },
+ "allocations": {
+ "items": {
+ "$ref": "#/components/schemas/AllocationDetail"
+ },
+ "type": "array",
+ "title": "Allocations"
+ },
+ "decouple_reason": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Decouple Reason"
+ },
+ "decouple_internal_note": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Decouple Internal Note"
+ },
+ "decoupled_by_user_id": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "hashid",
+ "description": "A hashed identifier that maps to an internal database ID",
+ "examples": [
+ "0123abcd"
+ ]
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Decoupled By User Id"
+ },
+ "decoupled_by_email": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Decoupled By Email"
+ },
+ "decoupled_by_username": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Decoupled By Username"
}
},
"type": "object",
@@ -23722,6 +20381,8 @@
"activated_at",
"completed_at",
"cancelled_at",
+ "decoupled_at",
+ "hourly_billing_start_time",
"created_at",
"updated_at"
],
@@ -23820,6 +20481,73 @@
"title": "GpuRentalOrderStatus",
"description": "Lifecycle states for GPU rental orders."
},
+ "GpuRentalOrderSummaryOut": {
+ "properties": {
+ "order_id": {
+ "type": "string",
+ "format": "hashid",
+ "title": "Order Id",
+ "description": "A hashed identifier that maps to an internal database ID",
+ "examples": [
+ "0123abcd"
+ ]
+ },
+ "pricing_plan": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/GpuSkuPricingPlan"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "commitment_days": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Commitment Days"
+ },
+ "financial": {
+ "$ref": "#/components/schemas/OrderFinancialSummaryOut"
+ },
+ "minimum_period": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/OrderMinimumPeriodOut"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "runway": {
+ "$ref": "#/components/schemas/OrderRunwayOut"
+ },
+ "related_transactions": {
+ "items": {
+ "$ref": "#/components/schemas/RelatedTransactionOut"
+ },
+ "type": "array",
+ "title": "Related Transactions"
+ }
+ },
+ "type": "object",
+ "required": [
+ "order_id",
+ "pricing_plan",
+ "commitment_days",
+ "financial",
+ "minimum_period",
+ "runway"
+ ],
+ "title": "GpuRentalOrderSummaryOut"
+ },
"GpuRentalProvisionRequest": {
"properties": {
"sku_id": {
@@ -23916,6 +20644,51 @@
"title": "GpuReservedTeamInfo",
"description": "Team with reserved access to GPU."
},
+ "GpuSkuAllowedTeamCreate": {
+ "properties": {
+ "team_id": {
+ "type": "string",
+ "title": "Team Id",
+ "description": "Team hashed ID (wks_xxx) to grant visibility to"
+ }
+ },
+ "type": "object",
+ "required": [
+ "team_id"
+ ],
+ "title": "GpuSkuAllowedTeamCreate",
+ "description": "Input for adding a team to a GPU SKU visibility allowlist."
+ },
+ "GpuSkuAllowedTeamsOut": {
+ "properties": {
+ "sku_id": {
+ "type": "integer",
+ "title": "Sku Id",
+ "description": "SKU ID"
+ },
+ "allowed_team_ids": {
+ "items": {
+ "type": "string",
+ "pattern": "^wks_.+",
+ "format": "hashid",
+ "title": "HashedId[teams]",
+ "description": "A hashed identifier that maps to an internal database ID",
+ "examples": [
+ "wks_0123abcd"
+ ]
+ },
+ "type": "array",
+ "title": "Allowed Team Ids",
+ "description": "Team IDs with access; empty list means the SKU is public"
+ }
+ },
+ "type": "object",
+ "required": [
+ "sku_id"
+ ],
+ "title": "GpuSkuAllowedTeamsOut",
+ "description": "Allowlist snapshot for a GPU SKU."
+ },
"GpuSkuCreate": {
"properties": {
"sku_code": {
@@ -24041,6 +20814,18 @@
"type": "object",
"title": "Extra Specs"
},
+ "instance_type": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Instance Type",
+ "description": "Instance type ID for CVM provisioning"
+ },
"is_active": {
"type": "boolean",
"title": "Is Active",
@@ -24059,6 +20844,30 @@
],
"title": "GpuSkuCreate"
},
+ "GpuSkuHistoryResponse": {
+ "properties": {
+ "display_name": {
+ "type": "string",
+ "title": "Display Name"
+ },
+ "gpu_count": {
+ "type": "integer",
+ "title": "Gpu Count"
+ },
+ "gpu_model": {
+ "type": "string",
+ "title": "Gpu Model"
+ }
+ },
+ "type": "object",
+ "required": [
+ "display_name",
+ "gpu_count",
+ "gpu_model"
+ ],
+ "title": "GpuSkuHistoryResponse",
+ "description": "Minimal SKU info for order history."
+ },
"GpuSkuOut": {
"properties": {
"id": {
@@ -24184,6 +20993,18 @@
"title": "Extra Specs",
"description": "Additional specifications"
},
+ "instance_type": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Instance Type",
+ "description": "Instance type ID for CVM provisioning"
+ },
"is_active": {
"type": "boolean",
"title": "Is Active",
@@ -24208,6 +21029,21 @@
"type": "array",
"title": "Prices",
"description": "Pricing tiers"
+ },
+ "allowed_team_ids": {
+ "items": {
+ "type": "string",
+ "pattern": "^wks_.+",
+ "format": "hashid",
+ "title": "HashedId[teams]",
+ "description": "A hashed identifier that maps to an internal database ID",
+ "examples": [
+ "wks_0123abcd"
+ ]
+ },
+ "type": "array",
+ "title": "Allowed Team Ids",
+ "description": "Team allowlist. Empty list means the SKU is public; any entry restricts visibility to the listed teams."
}
},
"type": "object",
@@ -24697,6 +21533,17 @@
],
"title": "Extra Specs"
},
+ "instance_type": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Instance Type"
+ },
"is_active": {
"anyOf": [
{
@@ -24946,6 +21793,30 @@
],
"title": "GuestAgentInfo"
},
+ "GuestEvent": {
+ "properties": {
+ "event": {
+ "type": "string",
+ "title": "Event"
+ },
+ "body": {
+ "type": "string",
+ "title": "Body"
+ },
+ "timestamp": {
+ "type": "integer",
+ "title": "Timestamp",
+ "default": 0
+ }
+ },
+ "type": "object",
+ "required": [
+ "event",
+ "body"
+ ],
+ "title": "GuestEvent",
+ "description": "Structured lifecycle event emitted by the guest or runtime. Since VMM v0.5.7."
+ },
"HTTPValidationError": {
"properties": {
"detail": {
@@ -25191,43 +22062,6 @@
"title": "HourlyBillingResponse",
"description": "Hourly billing summary with detailed events."
},
- "ImageSpec": {
- "properties": {
- "registry": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Registry",
- "default": "docker.io"
- },
- "repository": {
- "type": "string",
- "title": "Repository"
- },
- "tag": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Tag",
- "default": "latest"
- }
- },
- "type": "object",
- "required": [
- "repository"
- ],
- "title": "ImageSpec"
- },
"ImportItemsRequest": {
"properties": {
"source": {
@@ -27202,6 +24036,30 @@
],
"title": "Gateway Slug",
"description": "Gateway slug identifier"
+ },
+ "kms_guest_agent_endpoint": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Kms Guest Agent Endpoint",
+ "description": "KMS guest agent endpoint for attestation"
+ },
+ "gateway_guest_agent_endpoint": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Gateway Guest Agent Endpoint",
+ "description": "Gateway guest agent endpoint for attestation"
}
},
"type": "object",
@@ -27388,6 +24246,30 @@
],
"title": "Gateway Slug",
"description": "Update gateway slug identifier"
+ },
+ "kms_guest_agent_endpoint": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Kms Guest Agent Endpoint",
+ "description": "Update KMS guest agent endpoint"
+ },
+ "gateway_guest_agent_endpoint": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Gateway Guest Agent Endpoint",
+ "description": "Update gateway guest agent endpoint"
}
},
"type": "object",
@@ -28172,6 +25054,30 @@
"title": "Gateway Slug",
"description": "Gateway slug identifier"
},
+ "kms_guest_agent_endpoint": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Kms Guest Agent Endpoint",
+ "description": "KMS guest agent endpoint for attestation"
+ },
+ "gateway_guest_agent_endpoint": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Gateway Guest Agent Endpoint",
+ "description": "Gateway guest agent endpoint for attestation"
+ },
"created_at": {
"type": "string",
"format": "date-time",
@@ -28502,6 +25408,7 @@
"properties": {
"username": {
"type": "string",
+ "maxLength": 254,
"title": "Username"
},
"password": {
@@ -28965,42 +25872,6 @@
"title": "MemberRoleUpdateRequest",
"description": "Request to change member role."
},
- "MemoryQuantity": {
- "properties": {
- "value": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "string"
- }
- ],
- "title": "Value"
- },
- "suffix": {
- "type": "string",
- "enum": [
- "Ki",
- "Mi",
- "Gi",
- "Ti",
- "k",
- "m",
- "G",
- "T",
- ""
- ],
- "title": "Suffix",
- "default": ""
- }
- },
- "type": "object",
- "required": [
- "value"
- ],
- "title": "MemoryQuantity"
- },
"MeteredUsageResponse": {
"properties": {
"instance_id": {
@@ -29319,64 +26190,67 @@
"title": "MonthlyUsageSummaryItem",
"description": "Monthly usage summary item for reconciliation."
},
- "NearAccountInfo": {
+ "NetworkConfigPortMappingEntry": {
"properties": {
- "id": {
- "type": "string",
- "title": "Id",
- "description": "NEAR account ID (e.g., user.near)"
+ "host_port": {
+ "type": "integer",
+ "maximum": 65535.0,
+ "minimum": 1.0,
+ "title": "Host Port"
},
- "name": {
- "type": "string",
- "title": "Name",
- "description": "Display name for the account"
+ "vm_port": {
+ "type": "integer",
+ "maximum": 65535.0,
+ "minimum": 1.0,
+ "title": "Vm Port"
},
- "email": {
+ "protocol": {
"type": "string",
- "format": "email",
- "title": "Email",
- "description": "Email for account recovery"
+ "pattern": "^(tcp|udp)$",
+ "title": "Protocol",
+ "default": "tcp"
},
- "password": {
+ "host_address": {
"type": "string",
- "maxLength": 128,
- "minLength": 8,
- "title": "Password",
- "description": "Account password"
+ "title": "Host Address",
+ "default": ""
}
},
"type": "object",
"required": [
- "id",
- "name",
- "email",
- "password"
+ "host_port",
+ "vm_port"
],
- "title": "NearAccountInfo",
- "description": "Registration data for a new NEAR user."
+ "title": "NetworkConfigPortMappingEntry",
+ "description": "Single port mapping rule returned from VMM network config."
},
- "NearLoginRequest": {
+ "NetworkConfigResponse": {
"properties": {
- "email": {
- "type": "string",
- "format": "email",
- "title": "Email",
- "description": "Registered email address"
+ "kms_urls": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Kms Urls"
},
- "password": {
- "type": "string",
- "maxLength": 128,
- "title": "Password",
- "description": "Account password"
+ "gateway_urls": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Gateway Urls"
+ },
+ "ports": {
+ "items": {
+ "$ref": "#/components/schemas/NetworkConfigPortMappingEntry"
+ },
+ "type": "array",
+ "title": "Ports"
}
},
"type": "object",
- "required": [
- "email",
- "password"
- ],
- "title": "NearLoginRequest",
- "description": "Login credentials for NEAR users."
+ "title": "NetworkConfigResponse",
+ "description": "Real-time network configuration from VMM."
},
"NodeCreate": {
"properties": {
@@ -29525,6 +26399,238 @@
"title": "NodeCreate",
"description": "Input for creating a physical node."
},
+ "NodeFirewallRuleOut": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "Id",
+ "description": "Firewall rule ID"
+ },
+ "protocol": {
+ "type": "string",
+ "title": "Protocol",
+ "description": "Protocol (tcp/udp/tcp+udp)"
+ },
+ "port_from": {
+ "type": "integer",
+ "title": "Port From",
+ "description": "Start port"
+ },
+ "port_to": {
+ "type": "integer",
+ "title": "Port To",
+ "description": "End port"
+ },
+ "comment": {
+ "type": "string",
+ "title": "Comment",
+ "description": "Rule comment"
+ },
+ "created_at": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Created At",
+ "description": "Rule creation time"
+ },
+ "cvm_id": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Cvm Id",
+ "description": "Parsed CVM ID from comment"
+ },
+ "cvm_host_port": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Cvm Host Port",
+ "description": "Parsed host port from comment metadata"
+ },
+ "cvm_vm_port": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Cvm Vm Port",
+ "description": "VM-side port from DB mapping"
+ },
+ "cvm_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Cvm Name",
+ "description": "CVM display name"
+ },
+ "cvm_uuid": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Cvm Uuid",
+ "description": "CVM UUID for admin link"
+ },
+ "workspace_slug": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Workspace Slug",
+ "description": "Workspace slug for admin link"
+ },
+ "workspace_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Workspace Name",
+ "description": "Workspace display name"
+ }
+ },
+ "type": "object",
+ "required": [
+ "id",
+ "protocol",
+ "port_from",
+ "port_to",
+ "comment"
+ ],
+ "title": "NodeFirewallRuleOut",
+ "description": "Single firewall rule on a node with parsed CVM association."
+ },
+ "NodeFirewallRulesResponse": {
+ "properties": {
+ "node_name": {
+ "type": "string",
+ "title": "Node Name",
+ "description": "Node name"
+ },
+ "rules": {
+ "items": {
+ "$ref": "#/components/schemas/NodeFirewallRuleOut"
+ },
+ "type": "array",
+ "title": "Rules",
+ "description": "Firewall rules"
+ }
+ },
+ "type": "object",
+ "required": [
+ "node_name"
+ ],
+ "title": "NodeFirewallRulesResponse",
+ "description": "Node firewall rules list response."
+ },
+ "NodeNetworkDeviceOut": {
+ "properties": {
+ "device": {
+ "type": "string",
+ "title": "Device",
+ "description": "Network device name"
+ },
+ "monitored_processes": {
+ "type": "integer",
+ "title": "Monitored Processes",
+ "description": "Number of monitored QEMU processes"
+ },
+ "total_sent_bytes": {
+ "type": "integer",
+ "title": "Total Sent Bytes",
+ "description": "Total sent bytes"
+ },
+ "total_recv_bytes": {
+ "type": "integer",
+ "title": "Total Recv Bytes",
+ "description": "Total received bytes"
+ },
+ "sent_kbs_current": {
+ "type": "number",
+ "title": "Sent Kbs Current",
+ "description": "Current send throughput in KB/s"
+ },
+ "recv_kbs_current": {
+ "type": "number",
+ "title": "Recv Kbs Current",
+ "description": "Current receive throughput in KB/s"
+ }
+ },
+ "type": "object",
+ "required": [
+ "device",
+ "monitored_processes",
+ "total_sent_bytes",
+ "total_recv_bytes",
+ "sent_kbs_current",
+ "recv_kbs_current"
+ ],
+ "title": "NodeNetworkDeviceOut",
+ "description": "Single host network device stat."
+ },
+ "NodeNetworkDevicesResponse": {
+ "properties": {
+ "node_name": {
+ "type": "string",
+ "title": "Node Name",
+ "description": "Node name"
+ },
+ "total_monitored_processes": {
+ "type": "integer",
+ "title": "Total Monitored Processes",
+ "description": "Total monitored QEMU processes"
+ },
+ "devices": {
+ "items": {
+ "$ref": "#/components/schemas/NodeNetworkDeviceOut"
+ },
+ "type": "array",
+ "title": "Devices",
+ "description": "Per-device stats"
+ }
+ },
+ "type": "object",
+ "required": [
+ "node_name",
+ "total_monitored_processes"
+ ],
+ "title": "NodeNetworkDevicesResponse",
+ "description": "Host network devices stats for a node."
+ },
"NodeOut": {
"properties": {
"id": {
@@ -29723,6 +26829,39 @@
],
"title": "NodeOutagesResponse"
},
+ "NodeProvider": {
+ "properties": {
+ "proof_of_cloud": {
+ "type": "boolean",
+ "title": "Proof Of Cloud",
+ "description": "Quote from a trusted cloud TEE"
+ },
+ "provider": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Provider",
+ "description": "Provider label (e.g. 'phala', 'scrt')"
+ },
+ "ppid": {
+ "type": "string",
+ "title": "Ppid",
+ "description": "Platform Provisioning ID"
+ }
+ },
+ "type": "object",
+ "required": [
+ "proof_of_cloud",
+ "ppid"
+ ],
+ "title": "NodeProvider",
+ "description": "TEE node provider info."
+ },
"NodeRef": {
"properties": {
"object_type": {
@@ -29732,19 +26871,346 @@
"description": "Fixed value 'node'",
"default": "node"
},
- "id": {
+ "id": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Id",
+ "description": "Teepod numeric ID"
+ },
+ "node_id": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Node Id",
+ "description": "Physical node numeric ID"
+ },
+ "name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Name",
+ "description": "Node display name"
+ },
+ "region": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Region",
+ "description": "Region identifier"
+ },
+ "device_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Device Id",
+ "description": "Device ID"
+ },
+ "ppid": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Ppid",
+ "description": "PPID"
+ },
+ "status": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/TeepodStatus"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Node status"
+ },
+ "version": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Version",
+ "description": "Teepod version"
+ }
+ },
+ "type": "object",
+ "title": "NodeRef",
+ "description": "Minimal node/teepod reference for embedding in responses."
+ },
+ "NodeResourceLimits": {
+ "properties": {
+ "max_cvm_slots": {
+ "type": "integer",
+ "title": "Max Cvm Slots",
+ "description": "Maximum TDX keyids (from nodes.tdx_keyids)"
+ },
+ "max_allocable_vcpu": {
+ "type": "integer",
+ "title": "Max Allocable Vcpu",
+ "description": "Maximum allocable vCPUs"
+ },
+ "max_allocable_memory_mb": {
+ "type": "integer",
+ "title": "Max Allocable Memory Mb",
+ "description": "Maximum allocable memory in MB"
+ },
+ "max_allocable_disk_gb": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Max Allocable Disk Gb",
+ "description": "Maximum disk capacity in GB"
+ }
+ },
+ "type": "object",
+ "required": [
+ "max_cvm_slots",
+ "max_allocable_vcpu",
+ "max_allocable_memory_mb",
+ "max_allocable_disk_gb"
+ ],
+ "title": "NodeResourceLimits",
+ "description": "Node hardware capacity limits."
+ },
+ "NodeSNITrafficItem": {
+ "properties": {
+ "sni": {
+ "type": "string",
+ "title": "Sni"
+ },
+ "total_bytes": {
+ "type": "integer",
+ "title": "Total Bytes",
+ "default": 0
+ },
+ "connections": {
+ "type": "integer",
+ "title": "Connections",
+ "default": 0
+ },
+ "zero_bytes": {
+ "type": "integer",
+ "title": "Zero Bytes",
+ "default": 0
+ }
+ },
+ "type": "object",
+ "required": [
+ "sni"
+ ],
+ "title": "NodeSNITrafficItem",
+ "description": "Traffic stats for a single SNI."
+ },
+ "NodeStorageInfo": {
+ "properties": {
+ "mount_point": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Mount Point"
+ },
+ "filesystem": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Filesystem"
+ },
+ "size_kb": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Size Kb"
+ },
+ "used_kb": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Used Kb"
+ },
+ "avail_kb": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Avail Kb"
+ },
+ "use_percentage": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Use Percentage"
+ }
+ },
+ "type": "object",
+ "title": "NodeStorageInfo",
+ "description": "Filesystem storage stats."
+ },
+ "NodeStorageListResponse": {
+ "properties": {
+ "node_name": {
+ "type": "string",
+ "title": "Node Name",
+ "description": "Node name"
+ },
+ "available": {
+ "type": "boolean",
+ "title": "Available",
+ "default": true
+ },
+ "items": {
+ "items": {
+ "$ref": "#/components/schemas/NodeStorageVMItem"
+ },
+ "type": "array",
+ "title": "Items"
+ }
+ },
+ "type": "object",
+ "required": [
+ "node_name"
+ ],
+ "title": "NodeStorageListResponse",
+ "description": "Per-VM storage list for a node, sorted by size desc."
+ },
+ "NodeStorageVMItem": {
+ "properties": {
+ "vm_uuid": {
+ "type": "string",
+ "title": "Vm Uuid"
+ },
+ "size_bytes": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Size Bytes",
+ "default": 0
+ },
+ "exists": {
+ "type": "boolean",
+ "title": "Exists",
+ "default": false
+ }
+ },
+ "type": "object",
+ "required": [
+ "vm_uuid"
+ ],
+ "title": "NodeStorageVMItem",
+ "description": "Storage usage for a single VM from agent."
+ },
+ "NodeSystemInfoResponse": {
+ "properties": {
+ "node_name": {
+ "type": "string",
+ "title": "Node Name",
+ "description": "Node name"
+ },
+ "available": {
+ "type": "boolean",
+ "title": "Available",
+ "description": "Whether agent returned system info"
+ },
+ "unavailable_reason": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Unavailable Reason"
+ },
+ "qemu_path": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Qemu Path"
+ },
+ "qemu_version": {
"anyOf": [
{
- "type": "integer"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Id",
- "description": "Teepod numeric ID"
+ "title": "Qemu Version"
},
- "name": {
+ "qemu_package": {
"anyOf": [
{
"type": "string"
@@ -29753,10 +27219,9 @@
"type": "null"
}
],
- "title": "Name",
- "description": "Node display name"
+ "title": "Qemu Package"
},
- "region": {
+ "cpu_model": {
"anyOf": [
{
"type": "string"
@@ -29765,10 +27230,9 @@
"type": "null"
}
],
- "title": "Region",
- "description": "Region identifier"
+ "title": "Cpu Model"
},
- "device_id": {
+ "lscpu_model_name": {
"anyOf": [
{
"type": "string"
@@ -29777,10 +27241,9 @@
"type": "null"
}
],
- "title": "Device Id",
- "description": "Device ID"
+ "title": "Lscpu Model Name"
},
- "ppid": {
+ "cpu_microcode_version": {
"anyOf": [
{
"type": "string"
@@ -29789,21 +27252,94 @@
"type": "null"
}
],
- "title": "Ppid",
- "description": "PPID"
+ "title": "Cpu Microcode Version"
},
- "status": {
+ "cpu_count": {
"anyOf": [
{
- "$ref": "#/components/schemas/TeepodStatus"
+ "type": "integer"
},
{
"type": "null"
}
],
- "description": "Node status"
+ "title": "Cpu Count"
},
- "version": {
+ "memory_gib": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Memory Gib",
+ "description": "Total memory in GiB"
+ },
+ "data_dir_tib": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Data Dir Tib",
+ "description": "Data dir size in TiB"
+ },
+ "storage": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/NodeStorageInfo"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Filesystem storage stats"
+ },
+ "mk_tme_max_keys": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Mk Tme Max Keys"
+ },
+ "num_tdx_keyids": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Num Tdx Keyids"
+ }
+ },
+ "type": "object",
+ "required": [
+ "node_name",
+ "available"
+ ],
+ "title": "NodeSystemInfoResponse",
+ "description": "System info from node agent including MKTME and storage."
+ },
+ "NodeTeescopeCapabilities": {
+ "properties": {
+ "firewall": {
+ "type": "boolean",
+ "title": "Firewall",
+ "description": "Whether firewall management is supported",
+ "default": false
+ },
+ "netd_version": {
"anyOf": [
{
"type": "string"
@@ -29812,53 +27348,104 @@
"type": "null"
}
],
- "title": "Version",
- "description": "Teepod version"
+ "title": "Netd Version",
+ "description": "teescope-netd version"
}
},
"type": "object",
- "title": "NodeRef",
- "description": "Minimal node/teepod reference for embedding in responses."
+ "title": "NodeTeescopeCapabilities"
},
- "NodeResourceLimits": {
+ "NodeTeescopeInfoResponse": {
"properties": {
- "max_cvm_slots": {
- "type": "integer",
- "title": "Max Cvm Slots",
- "description": "Maximum TDX keyids (from nodes.tdx_keyids)"
+ "node_name": {
+ "type": "string",
+ "title": "Node Name",
+ "description": "Node name"
},
- "max_allocable_vcpu": {
- "type": "integer",
- "title": "Max Allocable Vcpu",
- "description": "Maximum allocable vCPUs"
+ "api_endpoint": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Api Endpoint",
+ "description": "Teescope API endpoint URL"
},
- "max_allocable_memory_mb": {
- "type": "integer",
- "title": "Max Allocable Memory Mb",
- "description": "Maximum allocable memory in MB"
+ "version": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Version",
+ "description": "Teescope agent version"
},
- "max_allocable_disk_gb": {
+ "capabilities": {
+ "$ref": "#/components/schemas/NodeTeescopeCapabilities"
+ },
+ "available": {
+ "type": "boolean",
+ "title": "Available",
+ "description": "Whether teescope is reachable"
+ },
+ "unavailable_reason": {
"anyOf": [
{
- "type": "integer"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Max Allocable Disk Gb",
- "description": "Maximum disk capacity in GB"
+ "title": "Unavailable Reason",
+ "description": "Why teescope is unavailable"
}
},
"type": "object",
"required": [
- "max_cvm_slots",
- "max_allocable_vcpu",
- "max_allocable_memory_mb",
- "max_allocable_disk_gb"
+ "node_name",
+ "available"
],
- "title": "NodeResourceLimits",
- "description": "Node hardware capacity limits."
+ "title": "NodeTeescopeInfoResponse",
+ "description": "Teescope agent info for a node."
+ },
+ "NodeTopSNIsResponse": {
+ "properties": {
+ "node_name": {
+ "type": "string",
+ "title": "Node Name",
+ "description": "Node name"
+ },
+ "available": {
+ "type": "boolean",
+ "title": "Available",
+ "default": true
+ },
+ "snis": {
+ "items": {
+ "$ref": "#/components/schemas/NodeSNITrafficItem"
+ },
+ "type": "array",
+ "title": "Snis"
+ },
+ "total_count": {
+ "type": "integer",
+ "title": "Total Count",
+ "default": 0
+ }
+ },
+ "type": "object",
+ "required": [
+ "node_name"
+ ],
+ "title": "NodeTopSNIsResponse",
+ "description": "Top SNIs by traffic for a node."
},
"NodeUpdate": {
"properties": {
@@ -30017,6 +27604,453 @@
"title": "NodeUpdate",
"description": "Input for updating a physical node."
},
+ "NodeVMEgressInfo": {
+ "properties": {
+ "total_sent_bytes": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Total Sent Bytes",
+ "default": 0
+ },
+ "total_recv_bytes": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Total Recv Bytes",
+ "default": 0
+ },
+ "peak_sent_kbs": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Peak Sent Kbs",
+ "default": 0.0
+ },
+ "peak_recv_kbs": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Peak Recv Kbs",
+ "default": 0.0
+ },
+ "total_sent_kbs_avg_5m": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Total Sent Kbs Avg 5M",
+ "default": 0.0
+ },
+ "total_recv_kbs_avg_5m": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Total Recv Kbs Avg 5M",
+ "default": 0.0
+ }
+ },
+ "type": "object",
+ "title": "NodeVMEgressInfo",
+ "description": "Egress traffic stats for a VM."
+ },
+ "NodeVMIngressInfo": {
+ "properties": {
+ "app_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "App Id"
+ },
+ "total_bytes": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Total Bytes",
+ "default": 0
+ },
+ "connections": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Connections",
+ "default": 0
+ },
+ "zero_bytes": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Zero Bytes",
+ "default": 0
+ },
+ "snis": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Snis"
+ }
+ },
+ "type": "object",
+ "title": "NodeVMIngressInfo",
+ "description": "Ingress traffic stats for a VM (via HAProxy SNI)."
+ },
+ "NodeVMItem": {
+ "properties": {
+ "vm_uuid": {
+ "type": "string",
+ "title": "Vm Uuid"
+ },
+ "cvm_id": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Cvm Id"
+ },
+ "name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Name",
+ "description": "CVM display name"
+ },
+ "app_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "App Id",
+ "description": "CVM app ID"
+ },
+ "status": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Status",
+ "description": "CVM status from DB"
+ },
+ "project_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Name"
+ },
+ "workspace_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Workspace Name"
+ },
+ "workspace_slug": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Workspace Slug"
+ },
+ "instance_type": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Instance Type"
+ },
+ "disk_size": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Disk Size",
+ "description": "Allocated disk in GB from DB"
+ },
+ "created_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Created At"
+ },
+ "qemu": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/NodeVMQemuInfo"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "storage": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/NodeVMStorageInfo"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "egress": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/NodeVMEgressInfo"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "ingress": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/NodeVMIngressInfo"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "type": "object",
+ "required": [
+ "vm_uuid"
+ ],
+ "title": "NodeVMItem",
+ "description": "Combined VM info: DB metadata + live agent data."
+ },
+ "NodeVMQemuInfo": {
+ "properties": {
+ "pid": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Pid"
+ },
+ "uptime": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Uptime",
+ "description": "Process uptime in seconds",
+ "default": 0
+ },
+ "cpu_usage_perc": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Cpu Usage Perc",
+ "description": "CPU% relative to allocated cores",
+ "default": 0.0
+ },
+ "cpu_pct_usr": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Cpu Pct Usr",
+ "description": "pidstat %usr, 100 == one core",
+ "default": 0.0
+ },
+ "cpu_pct_system": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Cpu Pct System",
+ "description": "pidstat %system, 100 == one core",
+ "default": 0.0
+ },
+ "cpu_pct_guest": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Cpu Pct Guest",
+ "description": "pidstat %guest, 100 == one core",
+ "default": 0.0
+ },
+ "cpu_pct_wait": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Cpu Pct Wait",
+ "description": "pidstat %wait, 100 == one core",
+ "default": 0.0
+ },
+ "cpu_pct_total": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Cpu Pct Total",
+ "description": "pidstat %CPU = usr+system+guest",
+ "default": 0.0
+ },
+ "cpu_cores": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Cpu Cores",
+ "description": "Allocated CPU cores",
+ "default": 0
+ },
+ "allocated_mb": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Allocated Mb",
+ "description": "Allocated memory in MB",
+ "default": 0
+ },
+ "kvm_guest_mem_mb": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Kvm Guest Mem Mb",
+ "description": "KVM guest memory in MB",
+ "default": 0.0
+ },
+ "kvm_mem_usage_perc": {
+ "type": "number",
+ "minimum": 0.0,
+ "title": "Kvm Mem Usage Perc",
+ "description": "KVM memory usage %",
+ "default": 0.0
+ },
+ "kvm_hugepage_ratio": {
+ "type": "number",
+ "maximum": 1.0,
+ "minimum": 0.0,
+ "title": "Kvm Hugepage Ratio",
+ "description": "Hugepage ratio",
+ "default": 0.0
+ },
+ "oom_score": {
+ "type": "integer",
+ "title": "Oom Score",
+ "description": "OOM score (0-1000)",
+ "default": 0
+ },
+ "io_read_bytes": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Io Read Bytes",
+ "default": 0
+ },
+ "io_write_bytes": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Io Write Bytes",
+ "default": 0
+ },
+ "slots": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Slots",
+ "description": "GPU PCI slots"
+ }
+ },
+ "type": "object",
+ "required": [
+ "pid"
+ ],
+ "title": "NodeVMQemuInfo",
+ "description": "QEMU process resource usage for a VM."
+ },
+ "NodeVMStorageInfo": {
+ "properties": {
+ "size_bytes": {
+ "type": "integer",
+ "minimum": 0.0,
+ "title": "Size Bytes",
+ "default": 0
+ },
+ "exists": {
+ "type": "boolean",
+ "title": "Exists",
+ "default": false
+ }
+ },
+ "type": "object",
+ "title": "NodeVMStorageInfo",
+ "description": "Storage usage for a VM data directory."
+ },
+ "NodeVMsResponse": {
+ "properties": {
+ "node_name": {
+ "type": "string",
+ "title": "Node Name",
+ "description": "Node name"
+ },
+ "available": {
+ "type": "boolean",
+ "title": "Available",
+ "default": true
+ },
+ "vms": {
+ "items": {
+ "$ref": "#/components/schemas/NodeVMItem"
+ },
+ "type": "array",
+ "title": "Vms"
+ },
+ "total": {
+ "type": "integer",
+ "title": "Total",
+ "description": "Total matching VMs",
+ "default": 0
+ },
+ "page": {
+ "type": "integer",
+ "title": "Page",
+ "default": 1
+ },
+ "page_size": {
+ "type": "integer",
+ "title": "Page Size",
+ "default": 50
+ },
+ "pages": {
+ "type": "integer",
+ "title": "Pages",
+ "default": 0
+ }
+ },
+ "type": "object",
+ "required": [
+ "node_name"
+ ],
+ "title": "NodeVMsResponse",
+ "description": "Combined VM data for a node."
+ },
"OSImageCreate": {
"properties": {
"name": {
@@ -30749,6 +28783,119 @@
"title": "OperationEventDetail",
"description": "Single atomic event within an operation."
},
+ "OrderFinancialSummaryOut": {
+ "properties": {
+ "prepaid_amount": {
+ "type": "string",
+ "title": "Prepaid Amount"
+ },
+ "prepaid_breakdown": {
+ "items": {
+ "$ref": "#/components/schemas/PrepaidBreakdownOut"
+ },
+ "type": "array",
+ "title": "Prepaid Breakdown"
+ },
+ "prepaid_hours": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Prepaid Hours"
+ },
+ "hourly_rate": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Hourly Rate"
+ },
+ "activated_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Activated At"
+ },
+ "used_hours": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Used Hours"
+ }
+ },
+ "type": "object",
+ "required": [
+ "prepaid_amount",
+ "prepaid_breakdown",
+ "prepaid_hours",
+ "hourly_rate",
+ "activated_at",
+ "used_hours"
+ ],
+ "title": "OrderFinancialSummaryOut"
+ },
+ "OrderMinimumPeriodOut": {
+ "properties": {
+ "total_hours": {
+ "type": "integer",
+ "title": "Total Hours"
+ },
+ "ends_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Ends At"
+ },
+ "in_minimum_period": {
+ "type": "boolean",
+ "title": "In Minimum Period"
+ },
+ "hours_remaining": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Hours Remaining"
+ }
+ },
+ "type": "object",
+ "required": [
+ "total_hours",
+ "ends_at",
+ "in_minimum_period",
+ "hours_remaining"
+ ],
+ "title": "OrderMinimumPeriodOut"
+ },
"OrderResponse": {
"properties": {
"id": {
@@ -30854,6 +29001,54 @@
"title": "OrderResponse",
"description": "Single order in the orders list response."
},
+ "OrderRunwayOut": {
+ "properties": {
+ "unmetered": {
+ "type": "boolean",
+ "title": "Unmetered"
+ },
+ "team_credit_balance": {
+ "type": "string",
+ "title": "Team Credit Balance"
+ },
+ "estimated_runway_hours": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Estimated Runway Hours"
+ },
+ "estimated_exhaust_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Estimated Exhaust At"
+ },
+ "assumption_note": {
+ "type": "string",
+ "title": "Assumption Note"
+ }
+ },
+ "type": "object",
+ "required": [
+ "unmetered",
+ "team_credit_balance",
+ "estimated_runway_hours",
+ "estimated_exhaust_at",
+ "assumption_note"
+ ],
+ "title": "OrderRunwayOut"
+ },
"OrderStatus": {
"type": "string",
"enum": [
@@ -31426,6 +29621,14 @@
"type": "integer",
"title": "Total",
"description": "Total orders matching filters"
+ },
+ "status_counts": {
+ "additionalProperties": {
+ "$ref": "#/components/schemas/StatusCount"
+ },
+ "type": "object",
+ "title": "Status Counts",
+ "description": "Order count and total GPU quantity per status"
}
},
"type": "object",
@@ -32196,6 +30399,104 @@
],
"title": "PaymentProvider"
},
+ "PendingUpdateItem": {
+ "properties": {
+ "vm_uuid": {
+ "type": "string",
+ "title": "Vm Uuid"
+ },
+ "compose_hash": {
+ "type": "string",
+ "title": "Compose Hash"
+ },
+ "on_chain": {
+ "type": "boolean",
+ "title": "On Chain"
+ },
+ "instance_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Instance Name"
+ }
+ },
+ "type": "object",
+ "required": [
+ "vm_uuid",
+ "compose_hash",
+ "on_chain"
+ ],
+ "title": "PendingUpdateItem"
+ },
+ "PendingUpdatePreview": {
+ "properties": {
+ "current_docker_compose": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Current Docker Compose"
+ },
+ "pending_docker_compose": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Pending Docker Compose"
+ },
+ "current_pre_launch_script": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Current Pre Launch Script"
+ },
+ "pending_pre_launch_script": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Pending Pre Launch Script"
+ }
+ },
+ "type": "object",
+ "title": "PendingUpdatePreview"
+ },
+ "PendingUpdatesResponse": {
+ "properties": {
+ "items": {
+ "items": {
+ "$ref": "#/components/schemas/PendingUpdateItem"
+ },
+ "type": "array",
+ "title": "Items",
+ "default": []
+ }
+ },
+ "type": "object",
+ "title": "PendingUpdatesResponse"
+ },
"PeriodInfo": {
"properties": {
"start_date": {
@@ -32365,6 +30666,96 @@
],
"title": "PortMapping"
},
+ "PortMappingEntry": {
+ "properties": {
+ "vm_port": {
+ "type": "integer",
+ "maximum": 65535.0,
+ "minimum": 1.0,
+ "title": "Vm Port"
+ },
+ "protocol": {
+ "type": "string",
+ "pattern": "^(tcp|udp)$",
+ "title": "Protocol",
+ "default": "tcp"
+ }
+ },
+ "type": "object",
+ "required": [
+ "vm_port"
+ ],
+ "title": "PortMappingEntry",
+ "description": "Single requested port mapping rule."
+ },
+ "PortMappingResponse": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "pattern": "^pm_.+",
+ "format": "hashid",
+ "title": "HashedId[cvm_port_mappings]",
+ "description": "A hashed identifier that maps to an internal database ID",
+ "examples": [
+ "pm_0123abcd"
+ ]
+ },
+ "host_port": {
+ "type": "integer",
+ "title": "Host Port"
+ },
+ "vm_port": {
+ "type": "integer",
+ "title": "Vm Port"
+ },
+ "protocol": {
+ "type": "string",
+ "title": "Protocol"
+ },
+ "host_address": {
+ "type": "string",
+ "title": "Host Address"
+ }
+ },
+ "type": "object",
+ "required": [
+ "id",
+ "host_port",
+ "vm_port",
+ "protocol",
+ "host_address"
+ ],
+ "title": "PortMappingResponse",
+ "description": "Port mapping with server-assigned ID."
+ },
+ "PrepaidBreakdownOut": {
+ "properties": {
+ "transaction_id": {
+ "type": "string",
+ "title": "Transaction Id"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type"
+ },
+ "amount": {
+ "type": "string",
+ "title": "Amount"
+ },
+ "source": {
+ "type": "string",
+ "title": "Source"
+ }
+ },
+ "type": "object",
+ "required": [
+ "transaction_id",
+ "type",
+ "amount",
+ "source"
+ ],
+ "title": "PrepaidBreakdownOut"
+ },
"ProfileGetResponse": {
"properties": {
"display_name": {
@@ -32446,7 +30837,8 @@
"custom_domain": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "maxLength": 253
},
{
"type": "null"
@@ -32875,15 +31267,6 @@
"title": "PromotionRedemptionsResponse",
"description": "Response for promotion redemptions list."
},
- "Protocol": {
- "type": "string",
- "enum": [
- "TCP",
- "UDP",
- "SCTP"
- ],
- "title": "Protocol"
- },
"ProvisionComposeFileUpdateRequest": {
"properties": {
"allowed_envs": {
@@ -33357,6 +31740,18 @@
],
"title": "Image",
"description": "The image to use for the a16z/eliza. If not provided, it will use the latest image."
+ },
+ "kms_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Kms Id",
+ "description": "The KMS ID to use."
}
},
"type": "object",
@@ -34306,6 +32701,184 @@
],
"title": "RedpillConnectionStatus"
},
+ "RefreshAttestationVerifiedItem": {
+ "properties": {
+ "checksum": {
+ "type": "string",
+ "title": "Checksum"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "would_process",
+ "updated",
+ "unchanged",
+ "failed",
+ "not_found"
+ ],
+ "title": "Status"
+ },
+ "verified": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Verified"
+ },
+ "verified_at": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Verified At"
+ },
+ "reason": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Reason"
+ }
+ },
+ "type": "object",
+ "required": [
+ "checksum",
+ "status"
+ ],
+ "title": "RefreshAttestationVerifiedItem"
+ },
+ "RefreshAttestationVerifiedRequest": {
+ "properties": {
+ "mode": {
+ "type": "string",
+ "enum": [
+ "estimate",
+ "execute"
+ ],
+ "title": "Mode",
+ "description": "Preview affected rows or execute the refresh mutation.",
+ "default": "estimate"
+ },
+ "since": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Since",
+ "description": "Refresh quotes created at or after this timestamp."
+ },
+ "checksums": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Checksums",
+ "description": "Refresh one or more exact quote checksums."
+ },
+ "batch_size": {
+ "type": "integer",
+ "maximum": 500.0,
+ "minimum": 1.0,
+ "title": "Batch Size",
+ "description": "Rows to process per batch.",
+ "default": 100
+ },
+ "limit": {
+ "anyOf": [
+ {
+ "type": "integer",
+ "maximum": 10000.0,
+ "minimum": 1.0
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Limit",
+ "description": "Optional cap on matched rows after filtering."
+ }
+ },
+ "type": "object",
+ "title": "RefreshAttestationVerifiedRequest"
+ },
+ "RefreshAttestationVerifiedResponse": {
+ "properties": {
+ "mode": {
+ "type": "string",
+ "enum": [
+ "estimate",
+ "execute"
+ ],
+ "title": "Mode"
+ },
+ "matched": {
+ "type": "integer",
+ "title": "Matched",
+ "description": "Rows found in ClickHouse for the requested target."
+ },
+ "processed": {
+ "type": "integer",
+ "title": "Processed",
+ "description": "Rows that were inspected in this request."
+ },
+ "updated": {
+ "type": "integer",
+ "title": "Updated",
+ "description": "Rows whose verified boolean changed after refresh."
+ },
+ "unchanged": {
+ "type": "integer",
+ "title": "Unchanged",
+ "description": "Rows refreshed with the same verified boolean."
+ },
+ "failed": {
+ "type": "integer",
+ "title": "Failed",
+ "description": "Rows that failed re-verification."
+ },
+ "items": {
+ "items": {
+ "$ref": "#/components/schemas/RefreshAttestationVerifiedItem"
+ },
+ "type": "array",
+ "title": "Items"
+ }
+ },
+ "type": "object",
+ "required": [
+ "mode",
+ "matched",
+ "processed",
+ "updated",
+ "unchanged",
+ "failed"
+ ],
+ "title": "RefreshAttestationVerifiedResponse"
+ },
"RegisterPayload": {
"properties": {
"username": {
@@ -34319,12 +32892,14 @@
},
"password": {
"type": "string",
+ "maxLength": 128,
"title": "Password"
},
"invite_code": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "maxLength": 100
},
{
"type": "null"
@@ -34335,7 +32910,8 @@
"site_key": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "maxLength": 200
},
{
"type": "null"
@@ -34379,6 +32955,102 @@
"title": "RegisterRequest",
"description": "Shim registration request with DCAP proof."
},
+ "RelatedTransactionOut": {
+ "properties": {
+ "transaction_id": {
+ "type": "string",
+ "title": "Transaction Id"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type"
+ },
+ "amount": {
+ "type": "string",
+ "title": "Amount"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created At"
+ },
+ "description": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Description"
+ }
+ },
+ "type": "object",
+ "required": [
+ "transaction_id",
+ "type",
+ "amount",
+ "created_at",
+ "description"
+ ],
+ "title": "RelatedTransactionOut"
+ },
+ "ReplicateRequest": {
+ "properties": {
+ "teepod_id": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Teepod Id",
+ "description": "Target node ID (deprecated, use node_id)"
+ },
+ "node_id": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Node Id",
+ "description": "Target node ID for the replica"
+ },
+ "encrypted_env": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Encrypted Env",
+ "description": "New encrypted env blob (hex)"
+ },
+ "compose_hash": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Compose Hash",
+ "description": "Explicit compose hash to replicate. Required when the source app has multiple live instances."
+ }
+ },
+ "type": "object",
+ "title": "ReplicateRequest",
+ "description": "Request model for CVM replication."
+ },
"ReservedGpuItem": {
"properties": {
"id": {
@@ -34601,70 +33273,6 @@
"title": "ResourceMetrics",
"description": "Resource metrics for CPU, memory, and disk."
},
- "ResourceRequirements": {
- "properties": {
- "requests": {
- "additionalProperties": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/CPUQuantity"
- },
- {
- "$ref": "#/components/schemas/MemoryQuantity"
- },
- {
- "$ref": "#/components/schemas/DiskQuantity"
- }
- ]
- },
- "propertyNames": {
- "enum": [
- "cpu",
- "memory",
- "ephemeral-storage",
- "storage"
- ]
- },
- "type": "object",
- "title": "Requests",
- "default": {}
- },
- "limits": {
- "additionalProperties": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/CPUQuantity"
- },
- {
- "$ref": "#/components/schemas/MemoryQuantity"
- },
- {
- "$ref": "#/components/schemas/DiskQuantity"
- }
- ]
- },
- "propertyNames": {
- "enum": [
- "cpu",
- "memory",
- "ephemeral-storage",
- "storage"
- ]
- },
- "type": "object",
- "title": "Limits",
- "default": {}
- }
- },
- "type": "object",
- "title": "ResourceRequirements"
- },
"ResourceSummaryResponse": {
"properties": {
"running_cvms": {
@@ -35474,49 +34082,6 @@
"title": "ShutdownDeleteAllCvmsResponse",
"description": "Summary of shutdown+delete operation."
},
- "Spec": {
- "properties": {
- "container": {
- "$ref": "#/components/schemas/Container"
- },
- "base_image": {
- "type": "string",
- "title": "Base Image",
- "default": ""
- },
- "app_id": {
- "type": "string",
- "title": "App Id",
- "default": ""
- },
- "app_env_encrypt_pubkey": {
- "type": "string",
- "title": "App Env Encrypt Pubkey",
- "default": ""
- },
- "encrypted_env": {
- "type": "string",
- "title": "Encrypted Env",
- "default": ""
- },
- "salt": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Salt"
- }
- },
- "type": "object",
- "required": [
- "container"
- ],
- "title": "Spec"
- },
"SpendingComparisonResponse": {
"properties": {
"this_month": {
@@ -35631,6 +34196,58 @@
"19.99",
"123.456000"
]
+ },
+ "settled_debt_amount": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "decimal",
+ "description": "A monetary value with precise decimal arithmetic",
+ "examples": [
+ "19.99",
+ "123.456000"
+ ]
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Settled Debt Amount"
+ },
+ "remaining_debt": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "decimal",
+ "description": "A monetary value with precise decimal arithmetic",
+ "examples": [
+ "19.99",
+ "123.456000"
+ ]
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Remaining Debt"
+ },
+ "settlement_transaction_id": {
+ "anyOf": [
+ {
+ "type": "string",
+ "pattern": "^crt_.+",
+ "format": "hashid",
+ "title": "HashedId[credit_transactions]",
+ "description": "A hashed identifier that maps to an internal database ID",
+ "examples": [
+ "crt_0123abcd"
+ ]
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Settlement Transaction Id"
}
},
"type": "object",
@@ -35647,6 +34264,8 @@
"properties": {
"name": {
"type": "string",
+ "maxLength": 100,
+ "minLength": 1,
"title": "Name",
"description": "Human-readable name for the key"
},
@@ -35865,6 +34484,23 @@
],
"title": "StatusConnectionItem"
},
+ "StatusCount": {
+ "properties": {
+ "count": {
+ "type": "integer",
+ "title": "Count",
+ "default": 0
+ },
+ "total_gpus": {
+ "type": "integer",
+ "title": "Total Gpus",
+ "default": 0
+ }
+ },
+ "type": "object",
+ "title": "StatusCount",
+ "description": "Count and GPU total for a given status."
+ },
"StatusResponse": {
"properties": {
"total_connections": {
@@ -36154,7 +34790,7 @@
},
"gpus": {
"items": {
- "$ref": "#/components/schemas/teehouse__api__routes__admin__nodes__GpuModeInfoOut"
+ "$ref": "#/components/schemas/teehouse__api__routes__admin__nodes__schemas__GpuModeInfoOut"
},
"type": "array",
"title": "Gpus",
@@ -36174,7 +34810,7 @@
},
"busy_gpus": {
"items": {
- "$ref": "#/components/schemas/teehouse__api__routes__admin__nodes__BusyGpuInfoOut"
+ "$ref": "#/components/schemas/teehouse__api__routes__admin__nodes__schemas__BusyGpuInfoOut"
},
"type": "array",
"title": "Busy Gpus",
@@ -36710,6 +35346,156 @@
"title": "TaskInfo",
"description": "Celery task details."
},
+ "TcbEvaluationInstance": {
+ "properties": {
+ "vm_uuid": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Vm Uuid"
+ },
+ "name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Name"
+ },
+ "instance_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Instance Id"
+ },
+ "status": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Status"
+ },
+ "image_version": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Image Version"
+ },
+ "ppid": {
+ "type": "string",
+ "title": "Ppid",
+ "default": ""
+ },
+ "device_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Device Id"
+ },
+ "evaluation_update": {
+ "type": "string",
+ "const": "early",
+ "title": "Evaluation Update",
+ "default": "early"
+ },
+ "evaluation_ok": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Evaluation Ok"
+ },
+ "evaluation_status": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Evaluation Status"
+ },
+ "error": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Error"
+ }
+ },
+ "type": "object",
+ "required": [
+ "vm_uuid",
+ "name",
+ "instance_id",
+ "status",
+ "image_version"
+ ],
+ "title": "TcbEvaluationInstance"
+ },
+ "TcbEvaluationResponse": {
+ "properties": {
+ "app_id": {
+ "type": "string",
+ "title": "App Id"
+ },
+ "update": {
+ "type": "string",
+ "const": "early",
+ "title": "Update",
+ "default": "early"
+ },
+ "instances": {
+ "items": {
+ "$ref": "#/components/schemas/TcbEvaluationInstance"
+ },
+ "type": "array",
+ "title": "Instances"
+ }
+ },
+ "type": "object",
+ "required": [
+ "app_id",
+ "instances"
+ ],
+ "title": "TcbEvaluationResponse"
+ },
"TcbInfo": {
"properties": {
"mrtd": {
@@ -37035,253 +35821,358 @@
],
"title": "Redpill Connection Id"
},
- "created_at": {
- "type": "string",
- "format": "date-time",
- "title": "Created At"
- },
- "profile": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ProfileGetResponse"
- },
- {
- "type": "null"
- }
- ]
- },
- "members_preview": {
- "items": {
- "$ref": "#/components/schemas/MemberPreview"
- },
- "type": "array",
- "title": "Members Preview"
- },
- "dstack_apps_preview": {
- "items": {
- "$ref": "#/components/schemas/DstackAppPreview"
- },
- "type": "array",
- "title": "Dstack Apps Preview"
- },
- "cvms_preview": {
- "items": {
- "$ref": "#/components/schemas/CVMPreview"
- },
- "type": "array",
- "title": "Cvms Preview"
- }
- },
- "type": "object",
- "required": [
- "id",
- "row_id",
- "name",
- "slug",
- "tier",
- "billing_status",
- "billing_email",
- "hosted_wallet_address",
- "creator",
- "members_count",
- "dstack_apps_count",
- "running_cvms_count",
- "total_cvms_count",
- "teepods_count",
- "balance",
- "granted_balance",
- "outstanding_amount",
- "unpaid_transactions_count",
- "is_post_paid",
- "stripe_customer_id",
- "created_at",
- "members_preview",
- "dstack_apps_preview",
- "cvms_preview"
- ],
- "title": "TeamDetail",
- "description": "Comprehensive team information for detail view."
- },
- "TeamInfo": {
- "properties": {
- "id": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Id",
- "description": "Team database ID"
- },
- "name": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Name",
- "description": "Team display name"
- }
- },
- "type": "object",
- "title": "TeamInfo",
- "description": "Team metadata for billing records."
- },
- "TeamListItem": {
- "properties": {
- "id": {
- "type": "string",
- "pattern": "^wks_.+",
- "format": "hashid",
- "title": "HashedId[teams]",
- "description": "A hashed identifier that maps to an internal database ID",
- "examples": [
- "wks_0123abcd"
- ]
- },
- "row_id": {
- "type": "integer",
- "title": "Row Id"
- },
- "name": {
- "type": "string",
- "title": "Name"
- },
- "slug": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Slug"
- },
- "tier": {
- "type": "string",
- "title": "Tier"
- },
- "billing_status": {
- "type": "string",
- "enum": [
- "active",
- "abandoned",
- "suspended"
- ],
- "title": "Billing Status"
- },
- "creator": {
- "$ref": "#/components/schemas/CreatorInfo"
- },
- "members_count": {
- "type": "integer",
- "title": "Members Count"
- },
- "dstack_apps_count": {
- "type": "integer",
- "title": "Dstack Apps Count"
- },
- "running_cvms_count": {
- "type": "integer",
- "title": "Running Cvms Count"
- },
- "total_cvms_count": {
- "type": "integer",
- "title": "Total Cvms Count"
- },
- "teepods_count": {
- "type": "integer",
- "title": "Teepods Count"
- },
- "balance": {
- "type": "string",
- "format": "decimal",
- "title": "Balance",
- "description": "A monetary value with precise decimal arithmetic",
- "examples": [
- "19.99",
- "123.456000"
- ]
- },
- "granted_balance": {
- "type": "string",
- "format": "decimal",
- "title": "Granted Balance",
- "description": "A monetary value with precise decimal arithmetic",
- "examples": [
- "19.99",
- "123.456000"
- ]
- },
- "outstanding_amount": {
- "type": "string",
- "format": "decimal",
- "title": "Outstanding Amount",
- "description": "A monetary value with precise decimal arithmetic",
- "examples": [
- "19.99",
- "123.456000"
- ]
- },
- "ledger_balance": {
- "type": "string",
- "format": "decimal",
- "title": "Ledger Balance",
- "description": "A monetary value with precise decimal arithmetic",
- "examples": [
- "19.99",
- "123.456000"
- ]
- },
- "is_post_paid": {
- "type": "boolean",
- "title": "Is Post Paid"
- },
- "stripe_customer_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Stripe Customer Id"
- },
- "has_redpill": {
+ "flag_network_config_enabled": {
+ "type": "boolean",
+ "title": "Flag Network Config Enabled",
+ "default": false
+ },
+ "flag_billing_v2_enabled": {
+ "type": "boolean",
+ "title": "Flag Billing V2 Enabled",
+ "default": false
+ },
+ "billing_mode": {
+ "type": "string",
+ "title": "Billing Mode",
+ "default": "prepaid"
+ },
+ "auto_topup_enabled": {
+ "type": "boolean",
+ "title": "Auto Topup Enabled",
+ "default": false
+ },
+ "auto_topup_amount": {
+ "type": "string",
+ "format": "decimal",
+ "title": "Auto Topup Amount",
+ "description": "A monetary value with precise decimal arithmetic",
+ "default": "0.000000",
+ "examples": [
+ "19.99",
+ "123.456000"
+ ]
+ },
+ "auto_topup_threshold": {
+ "type": "string",
+ "format": "decimal",
+ "title": "Auto Topup Threshold",
+ "description": "A monetary value with precise decimal arithmetic",
+ "default": "0.000000",
+ "examples": [
+ "19.99",
+ "123.456000"
+ ]
+ },
+ "auto_topup_daily_spend": {
+ "type": "string",
+ "format": "decimal",
+ "title": "Auto Topup Daily Spend",
+ "description": "A monetary value with precise decimal arithmetic",
+ "default": "0.000000",
+ "examples": [
+ "19.99",
+ "123.456000"
+ ]
+ },
+ "auto_topup_daily_spend_date": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Auto Topup Daily Spend Date"
+ },
+ "last_auto_topup_failed_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Last Auto Topup Failed At"
+ },
+ "post_paid_charge_cap": {
+ "type": "string",
+ "format": "decimal",
+ "title": "Post Paid Charge Cap",
+ "description": "A monetary value with precise decimal arithmetic",
+ "default": "0.000000",
+ "examples": [
+ "19.99",
+ "123.456000"
+ ]
+ },
+ "post_paid_grace_deadline": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Post Paid Grace Deadline"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created At"
+ },
+ "profile": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/ProfileGetResponse"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "members_preview": {
+ "items": {
+ "$ref": "#/components/schemas/MemberPreview"
+ },
+ "type": "array",
+ "title": "Members Preview"
+ },
+ "dstack_apps_preview": {
+ "items": {
+ "$ref": "#/components/schemas/DstackAppPreview"
+ },
+ "type": "array",
+ "title": "Dstack Apps Preview"
+ },
+ "cvms_preview": {
+ "items": {
+ "$ref": "#/components/schemas/CVMPreview"
+ },
+ "type": "array",
+ "title": "Cvms Preview"
+ }
+ },
+ "type": "object",
+ "required": [
+ "id",
+ "row_id",
+ "name",
+ "slug",
+ "tier",
+ "billing_status",
+ "billing_email",
+ "hosted_wallet_address",
+ "creator",
+ "members_count",
+ "dstack_apps_count",
+ "running_cvms_count",
+ "total_cvms_count",
+ "teepods_count",
+ "balance",
+ "granted_balance",
+ "outstanding_amount",
+ "unpaid_transactions_count",
+ "is_post_paid",
+ "stripe_customer_id",
+ "created_at",
+ "members_preview",
+ "dstack_apps_preview",
+ "cvms_preview"
+ ],
+ "title": "TeamDetail",
+ "description": "Comprehensive team information for detail view."
+ },
+ "TeamInfo": {
+ "properties": {
+ "id": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Id",
+ "description": "Team database ID"
+ },
+ "name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Name",
+ "description": "Team display name"
+ }
+ },
+ "type": "object",
+ "title": "TeamInfo",
+ "description": "Team metadata for billing records."
+ },
+ "TeamListItem": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "pattern": "^wks_.+",
+ "format": "hashid",
+ "title": "HashedId[teams]",
+ "description": "A hashed identifier that maps to an internal database ID",
+ "examples": [
+ "wks_0123abcd"
+ ]
+ },
+ "row_id": {
+ "type": "integer",
+ "title": "Row Id"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name"
+ },
+ "slug": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Slug"
+ },
+ "tier": {
+ "type": "string",
+ "title": "Tier"
+ },
+ "billing_status": {
+ "type": "string",
+ "enum": [
+ "active",
+ "abandoned",
+ "suspended"
+ ],
+ "title": "Billing Status"
+ },
+ "creator": {
+ "$ref": "#/components/schemas/CreatorInfo"
+ },
+ "members_count": {
+ "type": "integer",
+ "title": "Members Count"
+ },
+ "dstack_apps_count": {
+ "type": "integer",
+ "title": "Dstack Apps Count"
+ },
+ "running_cvms_count": {
+ "type": "integer",
+ "title": "Running Cvms Count"
+ },
+ "total_cvms_count": {
+ "type": "integer",
+ "title": "Total Cvms Count"
+ },
+ "teepods_count": {
+ "type": "integer",
+ "title": "Teepods Count"
+ },
+ "balance": {
+ "type": "string",
+ "format": "decimal",
+ "title": "Balance",
+ "description": "A monetary value with precise decimal arithmetic",
+ "examples": [
+ "19.99",
+ "123.456000"
+ ]
+ },
+ "granted_balance": {
+ "type": "string",
+ "format": "decimal",
+ "title": "Granted Balance",
+ "description": "A monetary value with precise decimal arithmetic",
+ "examples": [
+ "19.99",
+ "123.456000"
+ ]
+ },
+ "outstanding_amount": {
+ "type": "string",
+ "format": "decimal",
+ "title": "Outstanding Amount",
+ "description": "A monetary value with precise decimal arithmetic",
+ "examples": [
+ "19.99",
+ "123.456000"
+ ]
+ },
+ "ledger_balance": {
+ "type": "string",
+ "format": "decimal",
+ "title": "Ledger Balance",
+ "description": "A monetary value with precise decimal arithmetic",
+ "examples": [
+ "19.99",
+ "123.456000"
+ ]
+ },
+ "is_post_paid": {
+ "type": "boolean",
+ "title": "Is Post Paid"
+ },
+ "stripe_customer_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Stripe Customer Id"
+ },
+ "has_redpill": {
+ "type": "boolean",
+ "title": "Has Redpill",
+ "default": false
+ },
+ "redpill_post_paid": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Redpill Post Paid"
+ },
+ "redpill_connection_id": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Redpill Connection Id"
+ },
+ "flag_network_config_enabled": {
"type": "boolean",
- "title": "Has Redpill",
+ "title": "Flag Network Config Enabled",
"default": false
},
- "redpill_post_paid": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Redpill Post Paid"
- },
- "redpill_connection_id": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Redpill Connection Id"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -38989,6 +37880,38 @@
"title": "TeepodWithStats",
"description": "Teepod with CVM counts for capacity planning."
},
+ "TeescopeBatchRequest": {
+ "properties": {
+ "vm_uuids": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "maxItems": 200,
+ "title": "Vm Uuids",
+ "description": "VM UUIDs to query (max 200)"
+ }
+ },
+ "type": "object",
+ "required": [
+ "vm_uuids"
+ ],
+ "title": "TeescopeBatchRequest"
+ },
+ "TeescopeBatchResponse": {
+ "properties": {
+ "items": {
+ "additionalProperties": {
+ "$ref": "#/components/schemas/CvmTeescopeInfo"
+ },
+ "type": "object",
+ "title": "Items",
+ "description": "Teescope data keyed by vm_uuid"
+ }
+ },
+ "type": "object",
+ "title": "TeescopeBatchResponse"
+ },
"TelegramConfigResponse": {
"properties": {
"chat_id": {
@@ -39120,33 +38043,6 @@
"title": "ToggleMaintenanceResponse",
"description": "Response after toggling maintenance mode."
},
- "TokenResponse": {
- "properties": {
- "access_token": {
- "type": "string",
- "title": "Access Token",
- "description": "JWT access token"
- },
- "token_type": {
- "type": "string",
- "title": "Token Type",
- "description": "Token type, always 'bearer'"
- },
- "expires_in": {
- "type": "integer",
- "title": "Expires In",
- "description": "Token lifetime in seconds"
- }
- },
- "type": "object",
- "required": [
- "access_token",
- "token_type",
- "expires_in"
- ],
- "title": "TokenResponse",
- "description": "JWT token response."
- },
"TopupRequest": {
"properties": {
"amount": {
@@ -39457,6 +38353,53 @@
"title": "UpdateAttestationDataRequest",
"description": "Request to update node attestation data."
},
+ "UpdateAutoTopupRequest": {
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "title": "Enabled"
+ },
+ "amount": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "decimal",
+ "description": "A monetary value with precise decimal arithmetic",
+ "examples": [
+ "19.99",
+ "123.456000"
+ ]
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Amount"
+ },
+ "threshold": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "decimal",
+ "description": "A monetary value with precise decimal arithmetic",
+ "examples": [
+ "19.99",
+ "123.456000"
+ ]
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Threshold"
+ }
+ },
+ "type": "object",
+ "required": [
+ "enabled"
+ ],
+ "title": "UpdateAutoTopupRequest"
+ },
"UpdateBillingSettingsRequest": {
"properties": {
"billing_email": {
@@ -39517,6 +38460,19 @@
],
"title": "UpdateBillingStatusResponse"
},
+ "UpdateBillingV2Request": {
+ "properties": {
+ "flag_billing_v2_enabled": {
+ "type": "boolean",
+ "title": "Flag Billing V2 Enabled"
+ }
+ },
+ "type": "object",
+ "required": [
+ "flag_billing_v2_enabled"
+ ],
+ "title": "UpdateBillingV2Request"
+ },
"UpdateConnectionRequest": {
"properties": {
"credits_line": {
@@ -40237,6 +39193,47 @@
"title": "UpdateMemberRoleRequest",
"description": "Request to update a member's role."
},
+ "UpdateNetworkConfigRequest": {
+ "properties": {
+ "kms_urls": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Kms Urls"
+ },
+ "gateway_urls": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Gateway Urls"
+ },
+ "restart": {
+ "type": "boolean",
+ "title": "Restart",
+ "description": "Restart the CVM after applying changes to reload configuration.",
+ "default": false
+ }
+ },
+ "type": "object",
+ "title": "UpdateNetworkConfigRequest",
+ "description": "Partial update for KMS/Gateway URLs. Only set fields are applied."
+ },
"UpdatePasswordRequest": {
"properties": {
"password": {
@@ -40297,6 +39294,55 @@
"title": "UpdatePaymentModeRequest",
"description": "Request model for updating payment mode."
},
+ "UpdatePortMappingsRequest": {
+ "properties": {
+ "ports": {
+ "items": {
+ "$ref": "#/components/schemas/PortMappingEntry"
+ },
+ "type": "array",
+ "title": "Ports"
+ }
+ },
+ "type": "object",
+ "required": [
+ "ports"
+ ],
+ "title": "UpdatePortMappingsRequest",
+ "description": "Bulk-replace all port mappings for a CVM."
+ },
+ "UpdatePostPaidCapRequest": {
+ "properties": {
+ "charge_cap": {
+ "type": "string",
+ "format": "decimal",
+ "title": "Charge Cap",
+ "description": "A monetary value with precise decimal arithmetic",
+ "examples": [
+ "19.99",
+ "123.456000"
+ ]
+ }
+ },
+ "type": "object",
+ "required": [
+ "charge_cap"
+ ],
+ "title": "UpdatePostPaidCapRequest"
+ },
+ "UpdatePostPaidRequest": {
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "title": "Enabled"
+ }
+ },
+ "type": "object",
+ "required": [
+ "enabled"
+ ],
+ "title": "UpdatePostPaidRequest"
+ },
"UpdateRegionRequest": {
"properties": {
"region_identifier": {
@@ -41371,6 +40417,18 @@
"title": "Uploaded At",
"description": "ISO8601 upload timestamp"
},
+ "verified_at": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Verified At",
+ "description": "ISO8601 timestamp when verified was computed"
+ },
"quote_collateral": {
"anyOf": [
{
@@ -41381,6 +40439,17 @@
}
],
"description": "TCB collateral data"
+ },
+ "node_provider": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/NodeProvider"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Node provider info"
}
},
"type": "object",
@@ -41678,6 +40747,13 @@
}
],
"title": "Image Version"
+ },
+ "events": {
+ "items": {
+ "$ref": "#/components/schemas/GuestEvent"
+ },
+ "type": "array",
+ "title": "Events"
}
},
"type": "object",
@@ -41819,7 +40895,8 @@
"name": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "maxLength": 100
},
{
"type": "null"
@@ -42067,7 +41144,8 @@
"name": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "maxLength": 100
},
{
"type": "null"
@@ -42303,6 +41381,20 @@
],
"title": "WorkspaceReservedGpuQuota"
},
+ "WorkspaceResolveResponse": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "Id",
+ "description": "Canonical workspace hash ID (wks_xxx)"
+ }
+ },
+ "type": "object",
+ "required": [
+ "id"
+ ],
+ "title": "WorkspaceResolveResponse"
+ },
"WorkspaceResponse": {
"properties": {
"id": {
@@ -42864,7 +41956,7 @@
],
"title": "PaginatedInvoices"
},
- "teehouse__api__routes__admin__nodes__BusyGpuInfoOut": {
+ "teehouse__api__routes__admin__nodes__schemas__BusyGpuInfoOut": {
"properties": {
"slot": {
"type": "string",
@@ -42899,7 +41991,7 @@
"title": "BusyGpuInfoOut",
"description": "GPU that blocked mode switch due to active usage."
},
- "teehouse__api__routes__admin__nodes__GpuModeInfoOut": {
+ "teehouse__api__routes__admin__nodes__schemas__GpuModeInfoOut": {
"properties": {
"slot": {
"type": "string",
@@ -42926,7 +42018,7 @@
"title": "GpuModeInfoOut",
"description": "GPU mode state after switch."
},
- "teehouse__api__routes__admin__nodes__NodeResourceUsage": {
+ "teehouse__api__routes__admin__nodes__schemas__NodeResourceUsage": {
"properties": {
"used_vcpu": {
"type": "number",
@@ -43021,7 +42113,7 @@
"title": "NodeResourceUsage",
"description": "Node resource utilization statistics."
},
- "teehouse__api__routes__admin__nodes__TeepodCapacity": {
+ "teehouse__api__routes__admin__nodes__schemas__TeepodCapacity": {
"properties": {
"max_cvm_number": {
"anyOf": [
@@ -43595,49 +42687,6 @@
"title": "InstanceEventResponse",
"description": "CVM instance lifecycle event."
},
- "teehouse__api__routes__apps__schemas__ReplicateRequest": {
- "properties": {
- "teepod_id": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Teepod Id",
- "description": "Target node ID (deprecated, use node_id)"
- },
- "node_id": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Node Id",
- "description": "Target node ID for replica"
- },
- "encrypted_env": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Encrypted Env",
- "description": "Hex-encoded encrypted environment"
- }
- },
- "type": "object",
- "title": "ReplicateRequest",
- "description": "CVM replication request parameters."
- },
"teehouse__api__routes__apps__v20251028__schemas__CvmBasicInfo": {
"properties": {
"vm_uuid": {
@@ -44297,49 +43346,6 @@
"title": "DailyUsageResponse",
"description": "Daily usage summary with per-instance breakdown."
},
- "teehouse__api__routes__cvms__deployment__ReplicateRequest": {
- "properties": {
- "teepod_id": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Teepod Id",
- "description": "Target node ID (deprecated, use node_id)"
- },
- "node_id": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Node Id",
- "description": "Target node ID for the replica"
- },
- "encrypted_env": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Encrypted Env",
- "description": "New encrypted env blob (hex)"
- }
- },
- "type": "object",
- "title": "ReplicateRequest",
- "description": "Request model for CVM replication (currently disabled)."
- },
"teehouse__api__routes__cvms__management__CvmBasicInfo": {
"properties": {
"id": {
@@ -45018,6 +44024,11 @@
"type": "string",
"title": "Status"
},
+ "in_progress": {
+ "type": "boolean",
+ "title": "In Progress",
+ "default": false
+ },
"progress": {
"anyOf": [
{
@@ -45064,6 +44075,9 @@
"gateway": {
"$ref": "#/components/schemas/CVMGatewayInfo"
},
+ "logs": {
+ "$ref": "#/components/schemas/CVMLogUrls"
+ },
"services": {
"items": {
"additionalProperties": true,
@@ -45647,96 +44661,33 @@
}
},
"tags": [
- {
- "name": "Authentication",
- "description": "User authentication, session management, and authorization for Phala Cloud",
- "x-mint": {
- "href": "https://cloud.phala.network/api-reference/authentication"
- }
- },
{
"name": "CVMs",
- "description": "Confidential Virtual Machine (CVM) lifecycle management on Phala Network",
- "x-mint": {
- "href": "https://cloud.phala.network/api-reference/cvms"
- }
+ "description": "Confidential Virtual Machine (CVM) lifecycle management on Phala Network"
},
{
"name": "Apps",
- "description": "App template management and CVM deployment from app blueprints",
- "x-mint": {
- "href": "https://cloud.phala.network/api-reference/apps"
- }
+ "description": "App template management and CVM deployment from app blueprints"
},
{
- "name": "Workspace",
- "description": "Workspace settings, members, and configuration",
- "x-mint": {
- "href": "https://cloud.phala.network/api-reference/workspace"
- }
- },
- {
- "name": "Billing",
- "description": "Subscription plans, payment methods, invoices, and credits",
- "x-mint": {
- "href": "https://cloud.phala.network/api-reference/billing"
- }
+ "name": "Webhooks",
+ "description": "Manage webhook endpoints and monitor delivery history"
},
{
"name": "SSH Keys",
- "description": "SSH public key management for CVM access",
- "x-mint": {
- "href": "https://cloud.phala.network/api-reference/ssh-keys"
- }
+ "description": "SSH public key management for CVM access"
},
{
"name": "KMS",
- "description": "Key Management Service — key derivation, on-chain anchoring, and inspection",
- "x-mint": {
- "href": "https://cloud.phala.network/api-reference/kms"
- }
+ "description": "Key Management Service — key derivation, on-chain anchoring, and inspection"
},
{
"name": "Instance Types",
- "description": "Available hardware configurations for CVM deployment",
- "x-mint": {
- "href": "https://cloud.phala.network/api-reference/instance-types"
- }
+ "description": "Available hardware configurations for CVM deployment"
},
{
"name": "Attestations",
- "description": "Remote attestation and TEE verification endpoints",
- "x-mint": {
- "href": "https://cloud.phala.network/api-reference/attestations"
- }
- },
- {
- "name": "Usage",
- "description": "Resource usage analytics and consumption metrics",
- "x-mint": {
- "href": "https://cloud.phala.network/api-reference/usage"
- }
- },
- {
- "name": "Profiles",
- "description": "User profile management",
- "x-mint": {
- "href": "https://cloud.phala.network/api-reference/profiles"
- }
- },
- {
- "name": "Tokens",
- "description": "API token lifecycle management",
- "x-mint": {
- "href": "https://cloud.phala.network/api-reference/tokens"
- }
- },
- {
- "name": "GPUs",
- "description": "GPU availability and specifications",
- "x-mint": {
- "href": "https://cloud.phala.network/api-reference/gpus"
- }
+ "description": "Remote attestation and TEE verification endpoints"
}
]
}
diff --git a/phala-cloud/phala-cloud-cli/allow-devices.mdx b/phala-cloud/phala-cloud-cli/allow-devices.mdx
index 3122eac..9274ae0 100644
--- a/phala-cloud/phala-cloud-cli/allow-devices.mdx
+++ b/phala-cloud/phala-cloud-cli/allow-devices.mdx
@@ -1,25 +1,26 @@
---
title: "allow-devices"
description: "Manage on-chain device allowlist for an app contract"
+hidden: true
---
This command is marked as unstable and may change in future releases.
-## Command: `phala allow-devices`
+### Command: `phala allow-devices`
-### Syntax
+#### Syntax
```
phala allow-devices [options]
```
-### Description
+#### Description
Manage on-chain device allowlist for an app contract
-### Global Options
+#### Global Options
| Option | Description |
| ------ | ----------- |
@@ -32,6 +33,13 @@ Manage on-chain device allowlist for an app contract
| `--profile PROFILE` | Temporarily use a different auth profile for this command |
| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+#### Examples
+
+* Display help:
+
+```bash
+phala allow-devices --help
+```
### Subcommands
| Command | Description |
@@ -43,10 +51,3 @@ Manage on-chain device allowlist for an app contract
| `disallow-any` | Disable allow-any-device on the contract. Equivalent to `allow-any --disable`. |
| `toggle-allow-any` | Toggle allow-any-device on the contract (or force via --enable/--disable) |
-### Examples
-
-* Display help:
-
-```bash
-phala allow-devices --help
-```
diff --git a/phala-cloud/phala-cloud-cli/allow-devices/add.mdx b/phala-cloud/phala-cloud-cli/allow-devices/add.mdx
new file mode 100644
index 0000000..ed8eed7
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/allow-devices/add.mdx
@@ -0,0 +1,68 @@
+---
+title: "allow-devices add"
+description: "Add devices to the on-chain allowlist"
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala allow-devices add`
+
+### Syntax
+
+```
+phala allow-devices add [options] []
+```
+
+### Description
+
+Add devices to the on-chain allowlist
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `` | CVM or app identifier (UUID, app_id, instance_id, or name) |
+| `?` | Device ID (bytes32 hex) or node name. Node names are resolved to device IDs from available nodes. |
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `--wait` | Wait for on-chain state to reflect the change via RPC polling |
+
+### Advanced Options
+
+| Option | Description |
+| ------ | ----------- |
+| `--private-key ` | Private key for signing on-chain transactions (or set PRIVATE_KEY env var) |
+| `--rpc-url ` | RPC URL for on-chain KMS transactions (or set ETH_RPC_URL env var) |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `-i, --interactive` | Enable interactive mode |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Add device to allowlist
+
+```bash
+phala allow-devices add app_abc123 0xaabb... --private-key 0x...
+```
+
+* Interactive multi-select from available nodes
+
+```bash
+phala allow-devices add app_abc123 -i --private-key 0x...
+```
+
diff --git a/phala-cloud/phala-cloud-cli/allow-devices/allow-any.mdx b/phala-cloud/phala-cloud-cli/allow-devices/allow-any.mdx
new file mode 100644
index 0000000..ba5b86f
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/allow-devices/allow-any.mdx
@@ -0,0 +1,69 @@
+---
+title: "allow-devices allow-any"
+description: "Set the allow-any-device flag on the contract. Requires --enable or --disable."
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala allow-devices allow-any`
+
+### Syntax
+
+```
+phala allow-devices allow-any [options]
+```
+
+### Description
+
+Set the allow-any-device flag on the contract. Requires --enable or --disable.
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `` | CVM or app identifier (UUID, app_id, instance_id, or name) |
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `--enable` | Enable allow-any-device |
+| `--disable` | Disable allow-any-device |
+| `--wait` | Wait for on-chain state to reflect the change via RPC polling |
+
+### Advanced Options
+
+| Option | Description |
+| ------ | ----------- |
+| `--private-key ` | Private key for signing on-chain transactions (or set PRIVATE_KEY env var) |
+| `--rpc-url ` | RPC URL for on-chain KMS transactions (or set ETH_RPC_URL env var) |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Enable allow-any-device
+
+```bash
+phala allow-devices allow-any app_abc123 --enable --private-key 0x...
+```
+
+* Disable allow-any-device
+
+```bash
+phala allow-devices allow-any app_abc123 --disable --private-key 0x...
+```
+
diff --git a/phala-cloud/phala-cloud-cli/allow-devices/disallow-any.mdx b/phala-cloud/phala-cloud-cli/allow-devices/disallow-any.mdx
new file mode 100644
index 0000000..f751d71
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/allow-devices/disallow-any.mdx
@@ -0,0 +1,61 @@
+---
+title: "allow-devices disallow-any"
+description: "Disable allow-any-device on the contract. Equivalent to `allow-any --disable`."
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala allow-devices disallow-any`
+
+### Syntax
+
+```
+phala allow-devices disallow-any [options]
+```
+
+### Description
+
+Disable allow-any-device on the contract. Equivalent to `allow-any --disable`.
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `` | CVM or app identifier (UUID, app_id, instance_id, or name) |
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `--wait` | Wait for on-chain state to reflect the change via RPC polling |
+
+### Advanced Options
+
+| Option | Description |
+| ------ | ----------- |
+| `--private-key ` | Private key for signing on-chain transactions (or set PRIVATE_KEY env var) |
+| `--rpc-url ` | RPC URL for on-chain KMS transactions (or set ETH_RPC_URL env var) |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Disable allow-any-device
+
+```bash
+phala allow-devices disallow-any app_abc123 --private-key 0x...
+```
+
diff --git a/phala-cloud/phala-cloud-cli/allow-devices/list.mdx b/phala-cloud/phala-cloud-cli/allow-devices/list.mdx
new file mode 100644
index 0000000..6e088d1
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/allow-devices/list.mdx
@@ -0,0 +1,54 @@
+---
+title: "allow-devices list"
+description: "List allowed devices from the on-chain contract"
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala allow-devices list`
+
+### Syntax
+
+```
+phala allow-devices list [options]
+```
+
+### Description
+
+List allowed devices from the on-chain contract
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `` | CVM or app identifier (UUID, app_id, instance_id, or name) |
+
+### Advanced Options
+
+| Option | Description |
+| ------ | ----------- |
+| `--rpc-url ` | RPC URL for on-chain KMS transactions (or set ETH_RPC_URL env var) |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* List devices on-chain
+
+```bash
+phala allow-devices list app_abc123
+```
+
diff --git a/phala-cloud/phala-cloud-cli/allow-devices/remove.mdx b/phala-cloud/phala-cloud-cli/allow-devices/remove.mdx
new file mode 100644
index 0000000..25d058c
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/allow-devices/remove.mdx
@@ -0,0 +1,68 @@
+---
+title: "allow-devices remove"
+description: "Remove devices from the on-chain allowlist"
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala allow-devices remove`
+
+### Syntax
+
+```
+phala allow-devices remove [options] []
+```
+
+### Description
+
+Remove devices from the on-chain allowlist
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `` | CVM or app identifier (UUID, app_id, instance_id, or name) |
+| `?` | Device ID (bytes32 hex) or node name. Node names are resolved to device IDs from available nodes. |
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `--wait` | Wait for on-chain state to reflect the change via RPC polling |
+
+### Advanced Options
+
+| Option | Description |
+| ------ | ----------- |
+| `--private-key ` | Private key for signing on-chain transactions (or set PRIVATE_KEY env var) |
+| `--rpc-url ` | RPC URL for on-chain KMS transactions (or set ETH_RPC_URL env var) |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `-i, --interactive` | Enable interactive mode |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Remove device from allowlist
+
+```bash
+phala allow-devices remove app_abc123 0xaabb... --private-key 0x...
+```
+
+* Interactive multi-select from allowed devices
+
+```bash
+phala allow-devices remove app_abc123 -i --private-key 0x...
+```
+
diff --git a/phala-cloud/phala-cloud-cli/allow-devices/toggle-allow-any.mdx b/phala-cloud/phala-cloud-cli/allow-devices/toggle-allow-any.mdx
new file mode 100644
index 0000000..af55be9
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/allow-devices/toggle-allow-any.mdx
@@ -0,0 +1,69 @@
+---
+title: "allow-devices toggle-allow-any"
+description: "Toggle allow-any-device on the contract (or force via --enable/--disable)"
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala allow-devices toggle-allow-any`
+
+### Syntax
+
+```
+phala allow-devices toggle-allow-any [options]
+```
+
+### Description
+
+Toggle allow-any-device on the contract (or force via --enable/--disable)
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `` | CVM or app identifier (UUID, app_id, instance_id, or name) |
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `--enable` | Force enable allow-any-device |
+| `--disable` | Force disable allow-any-device |
+| `--wait` | Wait for on-chain state to reflect the change via RPC polling |
+
+### Advanced Options
+
+| Option | Description |
+| ------ | ----------- |
+| `--private-key ` | Private key for signing on-chain transactions (or set PRIVATE_KEY env var) |
+| `--rpc-url ` | RPC URL for on-chain KMS transactions (or set ETH_RPC_URL env var) |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Toggle based on current state
+
+```bash
+phala allow-devices toggle-allow-any app_abc123 --private-key 0x...
+```
+
+* Force enable
+
+```bash
+phala allow-devices toggle-allow-any app_abc123 --enable --private-key 0x...
+```
+
diff --git a/phala-cloud/phala-cloud-cli/api.mdx b/phala-cloud/phala-cloud-cli/api.mdx
index 7ab496b..a9e5388 100644
--- a/phala-cloud/phala-cloud-cli/api.mdx
+++ b/phala-cloud/phala-cloud-cli/api.mdx
@@ -7,25 +7,25 @@ description: "Make an authenticated HTTP request to Phala Cloud API."
This command is marked as unstable and may change in future releases.
-## Command: `phala api`
+### Command: `phala api`
-### Syntax
+#### Syntax
```
phala api [options]
```
-### Description
+#### Description
Make an authenticated HTTP request to Phala Cloud API.
-### Arguments
+#### Arguments
| Argument | Description |
| -------- | ----------- |
| `` | API endpoint path |
-### Options
+#### Options
| Option | Description |
| ------ | ----------- |
@@ -39,7 +39,7 @@ Make an authenticated HTTP request to Phala Cloud API.
| `-q, --jq ` | Filter output with jq expression |
| `--silent` | Don't print response body |
-### Global Options
+#### Global Options
| Option | Description |
| ------ | ----------- |
@@ -51,7 +51,7 @@ Make an authenticated HTTP request to Phala Cloud API.
| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
-### Examples
+#### Examples
* List CVMs
diff --git a/phala-cloud/phala-cloud-cli/apps.mdx b/phala-cloud/phala-cloud-cli/apps.mdx
index 97e918a..7ea12b3 100644
--- a/phala-cloud/phala-cloud-cli/apps.mdx
+++ b/phala-cloud/phala-cloud-cli/apps.mdx
@@ -7,19 +7,19 @@ description: "List dstack apps"
This command is marked as unstable and may change in future releases.
-## Command: `phala apps`
+### Command: `phala apps`
-### Syntax
+#### Syntax
```
phala apps [options]
```
-### Description
+#### Description
List dstack apps
-### Options
+#### Options
| Option | Description |
| ------ | ----------- |
@@ -34,7 +34,7 @@ List dstack apps
| `--node ` | Filter by node name |
| `--region ` | Filter by region identifier |
-### Global Options
+#### Global Options
| Option | Description |
| ------ | ----------- |
@@ -47,7 +47,7 @@ List dstack apps
| `--profile PROFILE` | Temporarily use a different auth profile for this command |
| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
-### Examples
+#### Examples
* List apps
diff --git a/phala-cloud/phala-cloud-cli/auth.mdx b/phala-cloud/phala-cloud-cli/auth.mdx
index c0f6dcb..23817cd 100644
--- a/phala-cloud/phala-cloud-cli/auth.mdx
+++ b/phala-cloud/phala-cloud-cli/auth.mdx
@@ -1,25 +1,26 @@
---
title: "auth (Deprecated)"
description: "Authenticate with Phala Cloud"
+hidden: true
---
This command is deprecated. Use `phala login`, `phala logout`, and `phala status` instead.
-## Command: `phala auth`
+### Command: `phala auth`
-### Syntax
+#### Syntax
```
phala auth [options]
```
-### Description
+#### Description
Authenticate with Phala Cloud
-### Global Options
+#### Global Options
| Option | Description |
| ------ | ----------- |
@@ -32,6 +33,13 @@ Authenticate with Phala Cloud
| `--profile PROFILE` | Temporarily use a different auth profile for this command |
| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+#### Examples
+
+* Display help:
+
+```bash
+phala auth --help
+```
### Deprecated Subcommands
| Command | Description |
@@ -40,10 +48,3 @@ Authenticate with Phala Cloud
| `logout` | Remove stored API key (use 'phala logout' instead) |
| `status` | Check auth status (use 'phala status' instead) |
-### Examples
-
-* Display help:
-
-```bash
-phala auth --help
-```
diff --git a/phala-cloud/phala-cloud-cli/auth/login.mdx b/phala-cloud/phala-cloud-cli/auth/login.mdx
new file mode 100644
index 0000000..9a0656d
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/auth/login.mdx
@@ -0,0 +1,53 @@
+---
+title: "auth login (Deprecated)"
+description: "Authenticate with Phala Cloud (use 'phala login' instead)"
+---
+
+
+This command is deprecated. See the newer alternatives.
+
+
+## Command: `phala auth login`
+
+### Syntax
+
+```
+phala auth login [options] []
+```
+
+### Description
+
+Authenticate with Phala Cloud (use 'phala login' instead)
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `?` | API key (triggers device flow if omitted) |
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `--manual` | Enter API key manually |
+| `--no-open` | Skip browser launch |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Display help:
+
+```bash
+phala auth login --help
+```
diff --git a/phala-cloud/phala-cloud-cli/auth/logout.mdx b/phala-cloud/phala-cloud-cli/auth/logout.mdx
new file mode 100644
index 0000000..a3f79e5
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/auth/logout.mdx
@@ -0,0 +1,41 @@
+---
+title: "auth logout (Deprecated)"
+description: "Remove stored API key (use 'phala logout' instead)"
+---
+
+
+This command is deprecated. See the newer alternatives.
+
+
+## Command: `phala auth logout`
+
+### Syntax
+
+```
+phala auth logout
+```
+
+### Description
+
+Remove stored API key (use 'phala logout' instead)
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Display help:
+
+```bash
+phala auth logout --help
+```
diff --git a/phala-cloud/phala-cloud-cli/auth/status.mdx b/phala-cloud/phala-cloud-cli/auth/status.mdx
new file mode 100644
index 0000000..048fbc7
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/auth/status.mdx
@@ -0,0 +1,47 @@
+---
+title: "auth status (Deprecated)"
+description: "Check auth status (use 'phala status' instead)"
+---
+
+
+This command is deprecated. See the newer alternatives.
+
+
+## Command: `phala auth status`
+
+### Syntax
+
+```
+phala auth status [options]
+```
+
+### Description
+
+Check auth status (use 'phala status' instead)
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-d, --debug` | Enable debug output |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Display help:
+
+```bash
+phala auth status --help
+```
diff --git a/phala-cloud/phala-cloud-cli/changelog.mdx b/phala-cloud/phala-cloud-cli/changelog.mdx
index 5c3d34b..cbc66b2 100644
--- a/phala-cloud/phala-cloud-cli/changelog.mdx
+++ b/phala-cloud/phala-cloud-cli/changelog.mdx
@@ -3,6 +3,26 @@ title: Changelog
description: Release history for the Phala Cloud CLI
---
+## [1.1.18](https://github.com/Phala-Network/phala-cloud/compare/cli-v1.1.17...cli-v1.1.18) (2026-04-17)
+
+### feat
+
+* **cli:** add instances rm command with multi-UUID support ([0f78fc6](https://github.com/Phala-Network/phala-cloud/commit/0f78fc63116b65368830a13df387df50d819b87d))
+* **cli:** move apps instances to top-level instances command, add instances ls ([67046a1](https://github.com/Phala-Network/phala-cloud/commit/67046a18644c3e84a022c0bf66d67fbb5964081a))
+* **sdk,cli:** add POST /apps/{app_id}/instances support ([80498ab](https://github.com/Phala-Network/phala-cloud/commit/80498ab02f56610a21cbbc807b92d878304a1eb2))
+
+### fix
+
+* **cli:** include live status in instances ls --json output ([06b0360](https://github.com/Phala-Network/phala-cloud/commit/06b0360ed7d28779d61335facf51666f27fc2892))
+* **cli:** polish instances/link UX and add commit-token routing ([4ab23c5](https://github.com/Phala-Network/phala-cloud/commit/4ab23c52f51abd73f13de2a28213f8f1ba36b20c))
+* **cli:** poll both deviceAllowed and composeHashAllowed before commit ([755a256](https://github.com/Phala-Network/phala-cloud/commit/755a256e47e38c82d3566fedf30b53d7a278500f))
+* **cli:** poll on-chain state before commit after registering compose hash ([2fb4094](https://github.com/Phala-Network/phala-cloud/commit/2fb409430f06a3bc530d0e5841fb4be567f0a936))
+* **cli:** preserve all existing fields when backfilling app_id in link ([1108cc7](https://github.com/Phala-Network/phala-cloud/commit/1108cc7415fb300595381d516c4535b4900ae21b))
+* **cli:** reject unknown subcommand paths for leaf commands ([397b92b](https://github.com/Phala-Network/phala-cloud/commit/397b92b9e0ccf3c2073a13f9a753901fe8bb4ec6))
+* **cli:** resolve profile by workspace slug fallback and use actual profile key in link ([a06748b](https://github.com/Phala-Network/phala-cloud/commit/a06748ba58f2874b90dcb3bdd363b1b6e8408028))
+* **cli:** skip CVM fetch in instances add when no env-file provided ([98bb666](https://github.com/Phala-Network/phala-cloud/commit/98bb6668700b4ca9f4b6e812a85424a36eadd719))
+* **cli:** write workspace slug as profile key, not workspace name ([e707e84](https://github.com/Phala-Network/phala-cloud/commit/e707e846b62023f3b5436785f346748d6c56dddd))
+
## [1.1.16](https://github.com/Phala-Network/phala-cloud/compare/cli-v1.1.15...cli-v1.1.16) (2026-04-10)
### fix
diff --git a/phala-cloud/phala-cloud-cli/config.mdx b/phala-cloud/phala-cloud-cli/config.mdx
index bb357b2..5bfac77 100644
--- a/phala-cloud/phala-cloud-cli/config.mdx
+++ b/phala-cloud/phala-cloud-cli/config.mdx
@@ -1,25 +1,26 @@
---
title: "config (Deprecated)"
description: "Manage local CLI state"
+hidden: true
---
This command is deprecated. See the newer alternatives.
-## Command: `phala config`
+### Command: `phala config`
-### Syntax
+#### Syntax
```
phala config [options]
```
-### Description
+#### Description
Manage local CLI state
-### Global Options
+#### Global Options
| Option | Description |
| ------ | ----------- |
@@ -32,6 +33,13 @@ Manage local CLI state
| `--profile PROFILE` | Temporarily use a different auth profile for this command |
| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+#### Examples
+
+* Display help:
+
+```bash
+phala config --help
+```
### Subcommands
| Command | Description |
@@ -40,10 +48,3 @@ Manage local CLI state
| `list` | List config values |
| `set` | Set a configuration value |
-### Examples
-
-* Display help:
-
-```bash
-phala config --help
-```
diff --git a/phala-cloud/phala-cloud-cli/config/get.mdx b/phala-cloud/phala-cloud-cli/config/get.mdx
new file mode 100644
index 0000000..06fb727
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/config/get.mdx
@@ -0,0 +1,43 @@
+---
+title: "config get"
+description: "Get a configuration value"
+---
+
+## Command: `phala config get`
+
+### Syntax
+
+```
+phala config get
+```
+
+### Description
+
+Get a configuration value
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `` | Configuration key |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Display help:
+
+```bash
+phala config get --help
+```
diff --git a/phala-cloud/phala-cloud-cli/config/list.mdx b/phala-cloud/phala-cloud-cli/config/list.mdx
new file mode 100644
index 0000000..ae23889
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/config/list.mdx
@@ -0,0 +1,37 @@
+---
+title: "config list"
+description: "List config values"
+---
+
+## Command: `phala config list`
+
+### Syntax
+
+```
+phala config list [options]
+```
+
+### Description
+
+List config values
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Display help:
+
+```bash
+phala config list --help
+```
diff --git a/phala-cloud/phala-cloud-cli/config/set.mdx b/phala-cloud/phala-cloud-cli/config/set.mdx
new file mode 100644
index 0000000..fa5b636
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/config/set.mdx
@@ -0,0 +1,44 @@
+---
+title: "config set"
+description: "Set a configuration value"
+---
+
+## Command: `phala config set`
+
+### Syntax
+
+```
+phala config set
+```
+
+### Description
+
+Set a configuration value
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `` | Configuration key |
+| `` | Configuration value |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Display help:
+
+```bash
+phala config set --help
+```
diff --git a/phala-cloud/phala-cloud-cli/cp.mdx b/phala-cloud/phala-cloud-cli/cp.mdx
index a4a8ab1..632f7b2 100644
--- a/phala-cloud/phala-cloud-cli/cp.mdx
+++ b/phala-cloud/phala-cloud-cli/cp.mdx
@@ -7,26 +7,26 @@ description: "Copy files to/from a CVM via SCP"
This command is marked as unstable and may change in future releases.
-## Command: `phala cp`
+### Command: `phala cp`
-### Syntax
+#### Syntax
```
phala cp [options]
```
-### Description
+#### Description
Copy files to/from a CVM via SCP
-### Arguments
+#### Arguments
| Argument | Description |
| -------- | ----------- |
| `` | Source path (local or cvm-name:path, use :path for phala.toml cvm_id) |
| `` | Destination path (local or cvm-name:path, use :path for phala.toml cvm_id) |
-### Options
+#### Options
| Option | Description |
| ------ | ----------- |
@@ -37,7 +37,7 @@ Copy files to/from a CVM via SCP
| `-v, --verbose` | Show verbose SCP details |
| `--dry-run` | Print SCP command without executing |
-### Global Options
+#### Global Options
| Option | Description |
| ------ | ----------- |
@@ -50,7 +50,7 @@ Copy files to/from a CVM via SCP
| `--profile PROFILE` | Temporarily use a different auth profile for this command |
| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
-### Examples
+#### Examples
* Upload from phala.toml
diff --git a/phala-cloud/phala-cloud-cli/cvms.mdx b/phala-cloud/phala-cloud-cli/cvms.mdx
index d31e9c3..799687e 100644
--- a/phala-cloud/phala-cloud-cli/cvms.mdx
+++ b/phala-cloud/phala-cloud-cli/cvms.mdx
@@ -1,25 +1,26 @@
---
title: "cvms"
description: "Manage CVMs"
+hidden: true
---
This command is marked as unstable and may change in future releases.
-## Command: `phala cvms`
+### Command: `phala cvms`
-### Syntax
+#### Syntax
```
phala cvms [options]
```
-### Description
+#### Description
Manage CVMs
-### Global Options
+#### Global Options
| Option | Description |
| ------ | ----------- |
@@ -32,6 +33,13 @@ Manage CVMs
| `--profile PROFILE` | Temporarily use a different auth profile for this command |
| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+#### Examples
+
+* Display help:
+
+```bash
+phala cvms --help
+```
### Subcommands
| Command | Description |
@@ -57,10 +65,3 @@ Manage CVMs
| `serial-logs` | Fetch VM serial console logs from a CVM |
| `upgrade` | Upgrade a CVM to a new version (use "phala deploy" instead) |
-### Examples
-
-* Display help:
-
-```bash
-phala cvms --help
-```
diff --git a/phala-cloud/phala-cloud-cli/cvms/attestation.mdx b/phala-cloud/phala-cloud-cli/cvms/attestation.mdx
new file mode 100644
index 0000000..8d92e1e
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/cvms/attestation.mdx
@@ -0,0 +1,54 @@
+---
+title: "cvms attestation"
+description: "Get CVM attestation"
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala cvms attestation`
+
+### Syntax
+
+```
+phala cvms attestation [options] []
+```
+
+### Description
+
+Get CVM attestation
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `?` | CVM identifier (UUID, app_id, instance_id, or name) |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `-i, --interactive` | Enable interactive mode |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Show attestation summary
+
+```bash
+phala cvms attestation
+```
+
+* Output full attestation JSON
+
+```bash
+phala cvms attestation --json
+```
+
diff --git a/phala-cloud/phala-cloud-cli/cvms/create.mdx b/phala-cloud/phala-cloud-cli/cvms/create.mdx
new file mode 100644
index 0000000..bc203f8
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/cvms/create.mdx
@@ -0,0 +1,63 @@
+---
+title: "cvms create (Deprecated)"
+description: "Create a new CVM (use \"phala deploy\" instead)"
+---
+
+
+This command is deprecated. See the newer alternatives.
+
+
+## Command: `phala cvms create`
+
+### Syntax
+
+```
+phala cvms create [options]
+```
+
+### Description
+
+Create a new CVM (use "phala deploy" instead)
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-n, --name ` | Name of the CVM |
+| `-c, --compose ` | Path to Docker Compose file |
+| `--vcpu ` | Virtual CPUs (default: 1) |
+| `--memory ` | Memory in MB (default: 2048) |
+| `--disk-size ` | Disk size in GB (default: 40) |
+| `--teepod-id ` | TEEPod ID (auto-selected if omitted) |
+| `--image ` | dstack image version (uses default if omitted) |
+| `-e, --env-file ` | Path to environment file |
+| `--skip-env` | Skip env var prompt |
+| `--debug` | Enable debug output |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Create a CVM interactively
+
+```bash
+phala cvms create
+```
+
+* Create using predefined values
+
+```bash
+phala cvms create --name demo --compose ./docker-compose.yml
+```
+
diff --git a/phala-cloud/phala-cloud-cli/cvms/delete.mdx b/phala-cloud/phala-cloud-cli/cvms/delete.mdx
new file mode 100644
index 0000000..73555e9
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/cvms/delete.mdx
@@ -0,0 +1,73 @@
+---
+title: "cvms delete"
+description: "Delete a CVM"
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala cvms delete`
+
+### Syntax
+
+```
+phala cvms delete [options] []
+```
+
+### Description
+
+Delete a CVM
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `?` | CVM identifier (UUID, app_id, instance_id, or name) |
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-f, --force` | Skip confirmation prompt |
+| `-y, --yes` | Alias for --force (skip confirmation prompt) |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `-i, --interactive` | Enable interactive mode |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Delete a CVM interactively
+
+```bash
+phala cvms delete
+```
+
+* Delete CVM by app_id
+
+```bash
+phala cvms delete app_123 --force
+```
+
+* Delete CVM by UUID
+
+```bash
+phala cvms delete 550e8400-e29b-41d4-a716-446655440000 -f
+```
+
+* Delete CVM by name
+
+```bash
+phala cvms delete my-app --yes
+```
+
diff --git a/phala-cloud/phala-cloud-cli/cvms/device-allowlist.mdx b/phala-cloud/phala-cloud-cli/cvms/device-allowlist.mdx
new file mode 100644
index 0000000..78bf96a
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/cvms/device-allowlist.mdx
@@ -0,0 +1,48 @@
+---
+title: "cvms device-allowlist"
+description: "Show device allowlist status for a CVM's app"
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala cvms device-allowlist`
+
+### Syntax
+
+```
+phala cvms device-allowlist [options] []
+```
+
+### Description
+
+Show device allowlist status for a CVM's app
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `?` | CVM identifier (UUID, app_id, instance_id, or name) |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `-i, --interactive` | Enable interactive mode |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Check device allowlist
+
+```bash
+phala cvms device-allowlist app_abc123
+```
+
diff --git a/phala-cloud/phala-cloud-cli/cvms/get.mdx b/phala-cloud/phala-cloud-cli/cvms/get.mdx
new file mode 100644
index 0000000..3183a10
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/cvms/get.mdx
@@ -0,0 +1,66 @@
+---
+title: "cvms get"
+description: "Get details of a CVM"
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala cvms get`
+
+### Syntax
+
+```
+phala cvms get [options] []
+```
+
+### Description
+
+Get details of a CVM
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `?` | CVM identifier (UUID, app_id, instance_id, or name) |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `-i, --interactive` | Enable interactive mode |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Get CVM interactively
+
+```bash
+phala cvms get
+```
+
+* By app_id
+
+```bash
+phala cvms get app_abc123
+```
+
+* By UUID
+
+```bash
+phala cvms get 550e8400-e29b-41d4-a716-446655440000
+```
+
+* By name
+
+```bash
+phala cvms get my-app
+```
+
diff --git a/phala-cloud/phala-cloud-cli/cvms/list-nodes.mdx b/phala-cloud/phala-cloud-cli/cvms/list-nodes.mdx
new file mode 100644
index 0000000..7c5d1e8
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/cvms/list-nodes.mdx
@@ -0,0 +1,41 @@
+---
+title: "cvms list-nodes"
+description: "List worker nodes"
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala cvms list-nodes`
+
+### Syntax
+
+```
+phala cvms list-nodes
+```
+
+### Description
+
+List worker nodes
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Display help:
+
+```bash
+phala cvms list-nodes --help
+```
diff --git a/phala-cloud/phala-cloud-cli/cvms/list.mdx b/phala-cloud/phala-cloud-cli/cvms/list.mdx
new file mode 100644
index 0000000..633c5a3
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/cvms/list.mdx
@@ -0,0 +1,81 @@
+---
+title: "cvms list"
+description: "List CVMs"
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala cvms list`
+
+### Syntax
+
+```
+phala cvms list [options]
+```
+
+### Description
+
+List CVMs
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `--page ` | Page number (1-based) |
+| `--page-size ` | Number of items per page |
+| `--search ` | Search by name, app_id, vm_uuid, or instance_id |
+| `--status ` | Filter by CVM status (can be specified multiple times) |
+| `--listed, --no-listed` | Filter by listed status |
+| `--base-image ` | Filter by base image name |
+| `--instance-type ` | Filter by instance type |
+| `--kms-type ` | Filter by KMS type |
+| `--node ` | Filter by node name |
+| `--region ` | Filter by region identifier |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* List CVMs
+
+```bash
+phala cvms ls
+```
+
+* Second page
+
+```bash
+phala cvms ls --page 2
+```
+
+* Search by name
+
+```bash
+phala cvms ls --search my-cvm
+```
+
+* Filter by status
+
+```bash
+phala cvms ls --status running
+```
+
+* Output as JSON
+
+```bash
+phala cvms ls --json
+```
+
diff --git a/phala-cloud/phala-cloud-cli/cvms/logs.mdx b/phala-cloud/phala-cloud-cli/cvms/logs.mdx
new file mode 100644
index 0000000..20af145
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/cvms/logs.mdx
@@ -0,0 +1,81 @@
+---
+title: "cvms logs (Deprecated)"
+description: "Fetch container logs from a CVM"
+---
+
+
+This command is deprecated. See the newer alternatives.
+
+
+## Command: `phala cvms logs`
+
+### Syntax
+
+```
+phala cvms logs [options] []
+```
+
+### Description
+
+Fetch container logs from a CVM
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `?` | CVM identifier (UUID, app_id, instance_id, or name) |
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-n, --tail ` | Lines from end |
+| `-f, --follow` | Stream logs in real-time |
+| `-t, --timestamps` | Show timestamps |
+| `-c, --container ` | Container name or ID (defaults to first) |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `-i, --interactive` | Enable interactive mode |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Show container logs from a CVM
+
+```bash
+phala cvms logs app_abc123
+```
+
+* Show last 100 lines of logs
+
+```bash
+phala cvms logs app_abc123 --tail 100
+```
+
+* Follow logs in real-time
+
+```bash
+phala cvms logs app_abc123 --follow
+```
+
+* Show logs from a specific container
+
+```bash
+phala cvms logs app_abc123 --container my-service
+```
+
+* Show logs with timestamps
+
+```bash
+phala cvms logs app_abc123 --timestamps
+```
+
diff --git a/phala-cloud/phala-cloud-cli/cvms/replicate.mdx b/phala-cloud/phala-cloud-cli/cvms/replicate.mdx
new file mode 100644
index 0000000..29ac9ec
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/cvms/replicate.mdx
@@ -0,0 +1,79 @@
+---
+title: "cvms replicate"
+description: "Create a replica of an existing CVM"
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala cvms replicate`
+
+### Syntax
+
+```
+phala cvms replicate [options] []
+```
+
+### Description
+
+Create a replica of an existing CVM
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `?` | CVM identifier (UUID, app_id, instance_id, or name) |
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `--node-id , --teepod-id ` | Target node ID for the replica. |
+| `--compose-hash ` | Compose hash to replicate. Required when the source app has multiple live instances. |
+| `-e, --env-file ` | Path to environment file. |
+
+### Advanced Options
+
+| Option | Description |
+| ------ | ----------- |
+| `--private-key ` | Private key for signing on-chain transactions (or set PRIVATE_KEY env var) |
+| `--rpc-url ` | RPC URL for on-chain KMS transactions (or set ETH_RPC_URL env var) |
+| `--prepare-only` | Prepare the replica and generate a commit token. Skips all on-chain operations. |
+| `--commit` | Commit a previously prepared replica using a commit token. Requires --token, --compose-hash, and --transaction-hash. |
+| `--token ` | Commit token from a prepare-only replica request. |
+| `--transaction-hash ` | Transaction hash proving on-chain compose hash registration. Pass `already-registered` to skip the proof and rely on state-only verification. |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `-i, --interactive` | Enable interactive mode |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Replicate a CVM
+
+```bash
+phala cvms replicate 1234 --node-id 5
+```
+
+* Prepare a replica for multisig approval
+
+```bash
+phala cvms replicate 1234 --node-id 5 --compose-hash --prepare-only
+```
+
+* Commit a prepared replica
+
+```bash
+phala cvms replicate 1234 --commit --token --compose-hash --transaction-hash
+```
+
diff --git a/phala-cloud/phala-cloud-cli/cvms/resize.mdx b/phala-cloud/phala-cloud-cli/cvms/resize.mdx
new file mode 100644
index 0000000..248e200
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/cvms/resize.mdx
@@ -0,0 +1,64 @@
+---
+title: "cvms resize"
+description: "Resize resources for a CVM"
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala cvms resize`
+
+### Syntax
+
+```
+phala cvms resize [options] []
+```
+
+### Description
+
+Resize resources for a CVM
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `?` | CVM identifier (UUID, app_id, instance_id, or name) |
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-v, --vcpu ` | Virtual CPUs |
+| `-m, --memory ` | Memory in MB |
+| `-d, --disk-size ` | Disk size in GB |
+| `-r, --allow-restart ` | Allow CVM restart |
+| `-y, --yes` | Skip confirmation |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `--version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `--json` | Output in JSON format |
+| `-i, --interactive` | Enable interactive mode |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Resize CVM interactively
+
+```bash
+phala cvms resize
+```
+
+* Resize without confirmation
+
+```bash
+phala cvms resize app_123 --vcpu 4 --memory 4096 --disk-size 120 --yes
+```
+
diff --git a/phala-cloud/phala-cloud-cli/cvms/restart.mdx b/phala-cloud/phala-cloud-cli/cvms/restart.mdx
new file mode 100644
index 0000000..aeccd8d
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/cvms/restart.mdx
@@ -0,0 +1,56 @@
+---
+title: "cvms restart"
+description: "Restart a CVM"
+---
+
+## Command: `phala cvms restart`
+
+### Syntax
+
+```
+phala cvms restart [options] []
+```
+
+### Description
+
+Restart a CVM
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `?` | CVM identifier (UUID, app_id, instance_id, or name) |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `-i, --interactive` | Enable interactive mode |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* By app_id
+
+```bash
+phala cvms restart app_123
+```
+
+* By UUID
+
+```bash
+phala cvms restart 550e8400-e29b-41d4-a716-446655440000
+```
+
+* By name
+
+```bash
+phala cvms restart my-app
+```
+
diff --git a/phala-cloud/phala-cloud-cli/cvms/serial-logs.mdx b/phala-cloud/phala-cloud-cli/cvms/serial-logs.mdx
new file mode 100644
index 0000000..7ed6976
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/cvms/serial-logs.mdx
@@ -0,0 +1,74 @@
+---
+title: "cvms serial-logs (Deprecated)"
+description: "Fetch VM serial console logs from a CVM"
+---
+
+
+This command is deprecated. See the newer alternatives.
+
+
+## Command: `phala cvms serial-logs`
+
+### Syntax
+
+```
+phala cvms serial-logs [options] []
+```
+
+### Description
+
+Fetch VM serial console logs from a CVM
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `?` | CVM identifier (UUID, app_id, instance_id, or name) |
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-n, --tail ` | Lines from end |
+| `-f, --follow` | Stream logs in real-time |
+| `-t, --timestamps` | Show timestamps |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `-i, --interactive` | Enable interactive mode |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Show VM serial logs
+
+```bash
+phala cvms serial-logs app_abc123
+```
+
+* Show last 100 lines of serial logs
+
+```bash
+phala cvms serial-logs app_abc123 --tail 100
+```
+
+* Follow serial logs in real-time
+
+```bash
+phala cvms serial-logs app_abc123 --follow
+```
+
+* Show serial logs with timestamps
+
+```bash
+phala cvms serial-logs app_abc123 --timestamps
+```
+
diff --git a/phala-cloud/phala-cloud-cli/cvms/start.mdx b/phala-cloud/phala-cloud-cli/cvms/start.mdx
new file mode 100644
index 0000000..ffec120
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/cvms/start.mdx
@@ -0,0 +1,56 @@
+---
+title: "cvms start"
+description: "Start a stopped CVM"
+---
+
+## Command: `phala cvms start`
+
+### Syntax
+
+```
+phala cvms start [options] []
+```
+
+### Description
+
+Start a stopped CVM
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `?` | CVM identifier (UUID, app_id, instance_id, or name) |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `-i, --interactive` | Enable interactive mode |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Start CVM by app_id
+
+```bash
+phala cvms start app_123
+```
+
+* Start CVM by UUID
+
+```bash
+phala cvms start 550e8400-e29b-41d4-a716-446655440000
+```
+
+* Start CVM by name
+
+```bash
+phala cvms start my-app
+```
+
diff --git a/phala-cloud/phala-cloud-cli/cvms/stop.mdx b/phala-cloud/phala-cloud-cli/cvms/stop.mdx
new file mode 100644
index 0000000..92be432
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/cvms/stop.mdx
@@ -0,0 +1,56 @@
+---
+title: "cvms stop"
+description: "Stop a running CVM"
+---
+
+## Command: `phala cvms stop`
+
+### Syntax
+
+```
+phala cvms stop [options] []
+```
+
+### Description
+
+Stop a running CVM
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `?` | CVM identifier (UUID, app_id, instance_id, or name) |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `-i, --interactive` | Enable interactive mode |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Stop CVM by app_id
+
+```bash
+phala cvms stop app_123
+```
+
+* Stop CVM by UUID
+
+```bash
+phala cvms stop 550e8400-e29b-41d4-a716-446655440000
+```
+
+* Stop CVM by name
+
+```bash
+phala cvms stop my-app
+```
+
diff --git a/phala-cloud/phala-cloud-cli/cvms/upgrade.mdx b/phala-cloud/phala-cloud-cli/cvms/upgrade.mdx
new file mode 100644
index 0000000..650434c
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/cvms/upgrade.mdx
@@ -0,0 +1,62 @@
+---
+title: "cvms upgrade (Deprecated)"
+description: "Upgrade a CVM to a new version (use \"phala deploy\" instead)"
+---
+
+
+This command is deprecated. See the newer alternatives.
+
+
+## Command: `phala cvms upgrade`
+
+### Syntax
+
+```
+phala cvms upgrade [options] []
+```
+
+### Description
+
+Upgrade a CVM to a new version (use "phala deploy" instead)
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `?` | CVM identifier (UUID, app_id, instance_id, or name) |
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-c, --compose ` | Path to Docker Compose file |
+| `-e, --env-file ` | Path to environment file |
+| `--debug` | Enable debug output |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `-i, --interactive` | Enable interactive mode |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Upgrade a CVM interactively
+
+```bash
+phala cvms upgrade
+```
+
+* Upgrade using a compose file
+
+```bash
+phala cvms upgrade app_123 --compose ./docker-compose.yml
+```
+
diff --git a/phala-cloud/phala-cloud-cli/deploy.mdx b/phala-cloud/phala-cloud-cli/deploy.mdx
index b16a0f5..e7927e8 100644
--- a/phala-cloud/phala-cloud-cli/deploy.mdx
+++ b/phala-cloud/phala-cloud-cli/deploy.mdx
@@ -3,19 +3,19 @@ title: "deploy"
description: "Deploy new CVM or update existing one"
---
-## Command: `phala deploy`
+### Command: `phala deploy`
-### Syntax
+#### Syntax
```
phala deploy [options]
```
-### Description
+#### Description
Deploy new CVM or update existing one
-### Options
+#### Options
| Option | Description |
| ------ | ----------- |
@@ -32,7 +32,7 @@ Deploy new CVM or update existing one
| `--public-sysinfo, --no-public-sysinfo` | Make CVM system info publicly accessible (default: true) |
| `--listed, --no-listed` | List CVM on the public Trust Center (default: false) |
-### Advanced Options
+#### Advanced Options
| Option | Description |
| ------ | ----------- |
@@ -52,7 +52,7 @@ Deploy new CVM or update existing one
| `--compose-hash ` | Compose hash from a prepare-only update. Optional in --commit mode when the token can provide it. |
| `--transaction-hash ` | Transaction hash proving on-chain compose hash registration. Pass `already-registered` to skip the proof and rely on state-only verification. |
-### Deprecated Options
+#### Deprecated Options
| Option | Description |
| ------ | ----------- |
@@ -62,7 +62,7 @@ Deploy new CVM or update existing one
| `--env-file ` | Use -e instead |
| `--kms-id ` | Use --kms instead |
-### Global Options
+#### Global Options
| Option | Description |
| ------ | ----------- |
@@ -75,7 +75,7 @@ Deploy new CVM or update existing one
| `--profile PROFILE` | Temporarily use a different auth profile for this command |
| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
-### Examples
+#### Examples
* Deploy new CVM
diff --git a/phala-cloud/phala-cloud-cli/docker.mdx b/phala-cloud/phala-cloud-cli/docker.mdx
index 6eebd42..bba092d 100644
--- a/phala-cloud/phala-cloud-cli/docker.mdx
+++ b/phala-cloud/phala-cloud-cli/docker.mdx
@@ -1,25 +1,26 @@
---
title: "docker (Deprecated)"
description: "Docker Hub login and image management"
+hidden: true
---
This command is deprecated. See the newer alternatives.
-## Command: `phala docker`
+### Command: `phala docker`
-### Syntax
+#### Syntax
```
phala docker [options]
```
-### Description
+#### Description
Docker Hub login and image management
-### Global Options
+#### Global Options
| Option | Description |
| ------ | ----------- |
@@ -32,6 +33,13 @@ Docker Hub login and image management
| `--profile PROFILE` | Temporarily use a different auth profile for this command |
| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+#### Examples
+
+* Display help:
+
+```bash
+phala docker --help
+```
### Subcommands
| Command | Description |
@@ -42,10 +50,3 @@ Docker Hub login and image management
| `generate` | Generate a Docker Compose file |
| `run` | Run a Docker Compose setup |
-### Examples
-
-* Display help:
-
-```bash
-phala docker --help
-```
diff --git a/phala-cloud/phala-cloud-cli/docker/build.mdx b/phala-cloud/phala-cloud-cli/docker/build.mdx
new file mode 100644
index 0000000..7971af1
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/docker/build.mdx
@@ -0,0 +1,56 @@
+---
+title: "docker build"
+description: "Build a Docker image"
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala docker build`
+
+### Syntax
+
+```
+phala docker build [options]
+```
+
+### Description
+
+Build a Docker image
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-i, --image ` | Image name |
+| `-t, --tag ` | Image tag |
+| `-f, --file ` | Path to Dockerfile |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Build docker image with prompts
+
+```bash
+phala docker build
+```
+
+* Build docker image with options
+
+```bash
+phala docker build --image myapp --tag latest
+```
+
diff --git a/phala-cloud/phala-cloud-cli/docker/generate.mdx b/phala-cloud/phala-cloud-cli/docker/generate.mdx
new file mode 100644
index 0000000..a90c12a
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/docker/generate.mdx
@@ -0,0 +1,50 @@
+---
+title: "docker generate"
+description: "Generate a Docker Compose file"
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala docker generate`
+
+### Syntax
+
+```
+phala docker generate [options]
+```
+
+### Description
+
+Generate a Docker Compose file
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-i, --image ` | Docker image name (e.g. phala/phala-cloud) |
+| `-e, --env-file ` | Path to env file |
+| `-o, --output ` | Output path for docker-compose.yml |
+| `--template ` | Template for docker-compose.yml |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Display help:
+
+```bash
+phala docker generate --help
+```
diff --git a/phala-cloud/phala-cloud-cli/docker/login.mdx b/phala-cloud/phala-cloud-cli/docker/login.mdx
new file mode 100644
index 0000000..b237705
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/docker/login.mdx
@@ -0,0 +1,49 @@
+---
+title: "docker login"
+description: "Login to Docker Hub"
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala docker login`
+
+### Syntax
+
+```
+phala docker login [options]
+```
+
+### Description
+
+Login to Docker Hub
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-u, --username ` | Docker Hub username |
+| `-p, --password ` | Docker Hub password |
+| `-r, --registry ` | Docker registry URL |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Display help:
+
+```bash
+phala docker login --help
+```
diff --git a/phala-cloud/phala-cloud-cli/docker/push.mdx b/phala-cloud/phala-cloud-cli/docker/push.mdx
new file mode 100644
index 0000000..35fbae8
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/docker/push.mdx
@@ -0,0 +1,47 @@
+---
+title: "docker push"
+description: "Push a Docker image to Docker Hub"
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala docker push`
+
+### Syntax
+
+```
+phala docker push [options]
+```
+
+### Description
+
+Push a Docker image to Docker Hub
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-i, --image ` | Full image name (e.g. username/image:tag) |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Display help:
+
+```bash
+phala docker push --help
+```
diff --git a/phala-cloud/phala-cloud-cli/docker/run.mdx b/phala-cloud/phala-cloud-cli/docker/run.mdx
new file mode 100644
index 0000000..d0d7ae4
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/docker/run.mdx
@@ -0,0 +1,49 @@
+---
+title: "docker run"
+description: "Run a Docker Compose setup"
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala docker run`
+
+### Syntax
+
+```
+phala docker run [options]
+```
+
+### Description
+
+Run a Docker Compose setup
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-c, --compose ` | Path to docker-compose.yml file |
+| `-e, --env-file ` | Path to environment variables file |
+| `--skip-env` | Skip env file prompt |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Display help:
+
+```bash
+phala docker run --help
+```
diff --git a/phala-cloud/phala-cloud-cli/envs.mdx b/phala-cloud/phala-cloud-cli/envs.mdx
index f923b09..8d2f3da 100644
--- a/phala-cloud/phala-cloud-cli/envs.mdx
+++ b/phala-cloud/phala-cloud-cli/envs.mdx
@@ -1,21 +1,22 @@
---
title: "envs"
description: "Encrypt and update CVM sealed environment variables"
+hidden: true
---
-## Command: `phala envs`
+### Command: `phala envs`
-### Syntax
+#### Syntax
```
phala envs [options]
```
-### Description
+#### Description
Encrypt and update CVM sealed environment variables
-### Global Options
+#### Global Options
| Option | Description |
| ------ | ----------- |
@@ -28,6 +29,13 @@ Encrypt and update CVM sealed environment variables
| `--profile PROFILE` | Temporarily use a different auth profile for this command |
| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+#### Examples
+
+* Display help:
+
+```bash
+phala envs --help
+```
### Subcommands
| Command | Description |
@@ -35,10 +43,3 @@ Encrypt and update CVM sealed environment variables
| `encrypt` | Encrypt environment variables for a CVM (sealed, only readable inside TEE) |
| `update` | Encrypt and push sealed environment variables to a CVM (only readable inside TEE) |
-### Examples
-
-* Display help:
-
-```bash
-phala envs --help
-```
diff --git a/phala-cloud/phala-cloud-cli/envs/encrypt.mdx b/phala-cloud/phala-cloud-cli/envs/encrypt.mdx
new file mode 100644
index 0000000..e0c6971
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/envs/encrypt.mdx
@@ -0,0 +1,75 @@
+---
+title: "envs encrypt"
+description: "Encrypt environment variables for a CVM (sealed, only readable inside TEE)"
+---
+
+## Command: `phala envs encrypt`
+
+### Syntax
+
+```
+phala envs encrypt [options] []
+```
+
+### Description
+
+Encrypt environment variables for a CVM (sealed, only readable inside TEE)
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `?` | CVM identifier (UUID, app_id, instance_id, or name) |
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-e, --env ` | Environment variable (KEY=VALUE) or env file path (repeatable) |
+| `-n, --no-newline` | Do not print trailing newline (useful for piping) |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `-i, --interactive` | Enable interactive mode |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Encrypt inline variables
+
+```bash
+phala envs encrypt app_abc123 -e SECRET=value -e API_KEY=xxx
+```
+
+* Encrypt from env file
+
+```bash
+phala envs encrypt app_abc123 -e .env
+```
+
+* Encrypt with CVM from phala.toml
+
+```bash
+phala envs encrypt -e .env.production
+```
+
+* Pipe to file for later use
+
+```bash
+phala envs encrypt app_abc123 -e .env > encrypted.hex
+```
+
+* Pipe without trailing newline
+
+```bash
+phala envs encrypt app_abc123 -n -e .env | some-tool
+```
+
diff --git a/phala-cloud/phala-cloud-cli/envs/update.mdx b/phala-cloud/phala-cloud-cli/envs/update.mdx
new file mode 100644
index 0000000..523718f
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/envs/update.mdx
@@ -0,0 +1,82 @@
+---
+title: "envs update"
+description: "Encrypt and push sealed environment variables to a CVM (only readable inside TEE)"
+---
+
+## Command: `phala envs update`
+
+### Syntax
+
+```
+phala envs update [options] []
+```
+
+### Description
+
+Encrypt and push sealed environment variables to a CVM (only readable inside TEE)
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `?` | CVM identifier (UUID, app_id, instance_id, or name) |
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-e, --env ` | Environment variable (KEY=VALUE) or env file path (repeatable) |
+| `--encrypted-env ` | Pre-encrypted environment variables as hex string (from 'phala envs encrypt') |
+
+### Advanced Options
+
+| Option | Description |
+| ------ | ----------- |
+| `--private-key ` | Private key for signing on-chain transactions (or set PRIVATE_KEY env var) |
+| `--rpc-url ` | RPC URL for on-chain KMS transactions (or set ETH_RPC_URL env var) |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `-i, --interactive` | Enable interactive mode |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Update with inline variables
+
+```bash
+phala envs update app_abc123 -e SECRET=newvalue -e API_KEY=xxx
+```
+
+* Update from env file
+
+```bash
+phala envs update app_abc123 -e .env.production
+```
+
+* Update with CVM from phala.toml
+
+```bash
+phala envs update -e .env
+```
+
+* Update with pre-encrypted hex (from 'phala envs encrypt')
+
+```bash
+phala envs update app_abc123 --encrypted-env $(phala envs encrypt app_abc123 -e .env)
+```
+
+* Update with on-chain KMS
+
+```bash
+phala envs update app_abc123 -e .env --private-key
+```
+
diff --git a/phala-cloud/phala-cloud-cli/instance-types.mdx b/phala-cloud/phala-cloud-cli/instance-types.mdx
index 45e284a..d59277b 100644
--- a/phala-cloud/phala-cloud-cli/instance-types.mdx
+++ b/phala-cloud/phala-cloud-cli/instance-types.mdx
@@ -7,25 +7,25 @@ description: "List available instance types"
This command is marked as unstable and may change in future releases.
-## Command: `phala instance-types`
+### Command: `phala instance-types`
-### Syntax
+#### Syntax
```
phala instance-types [options] []
```
-### Description
+#### Description
List available instance types
-### Arguments
+#### Arguments
| Argument | Description |
| -------- | ----------- |
| `?` | Instance type family (cpu, gpu) |
-### Global Options
+#### Global Options
| Option | Description |
| ------ | ----------- |
@@ -38,7 +38,7 @@ List available instance types
| `--profile PROFILE` | Temporarily use a different auth profile for this command |
| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
-### Examples
+#### Examples
* List all instance type families
diff --git a/phala-cloud/phala-cloud-cli/instances.mdx b/phala-cloud/phala-cloud-cli/instances.mdx
new file mode 100644
index 0000000..88d8758
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/instances.mdx
@@ -0,0 +1,50 @@
+---
+title: "instances"
+description: "Manage app instances"
+hidden: true
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+### Command: `phala instances`
+
+#### Syntax
+
+```
+phala instances [options]
+```
+
+#### Description
+
+Manage app instances
+
+#### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+#### Examples
+
+* Display help:
+
+```bash
+phala instances --help
+```
+### Subcommands
+
+| Command | Description |
+| ------- | ----------- |
+| `ls` | List instances of an app |
+| `add` | Create a new instance under an existing app |
+| `rm` | Delete one or more app instances by VM UUID |
+
diff --git a/phala-cloud/phala-cloud-cli/instances/add.mdx b/phala-cloud/phala-cloud-cli/instances/add.mdx
new file mode 100644
index 0000000..071f88f
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/instances/add.mdx
@@ -0,0 +1,82 @@
+---
+title: "instances add"
+description: "Create a new instance under an existing app"
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala instances add`
+
+### Syntax
+
+```
+phala instances add [options]
+```
+
+### Description
+
+Create a new instance under an existing app
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `--app-id ` | App ID (hex identifier). Defaults to app_id in phala.toml. |
+| `--node-id , --teepod-id ` | Target node ID for the new instance. |
+| `-c, --compose-file ` | Path to Docker Compose file. |
+| `--pre-launch-script ` | Path to pre-launch script file. |
+| `-e, --env-file ` | Path to environment file. |
+| `--compose-hash ` | Compose hash to use (existing revision). |
+
+### Advanced Options
+
+| Option | Description |
+| ------ | ----------- |
+| `--private-key ` | Private key for signing on-chain transactions (or set PRIVATE_KEY env var) |
+| `--rpc-url ` | RPC URL for on-chain KMS transactions (or set ETH_RPC_URL env var) |
+| `--prepare-only` | Prepare the instance and generate a commit token. Skips all on-chain operations. |
+| `--commit` | Commit a previously prepared instance using a commit token. Requires --token, --compose-hash, and --transaction-hash. |
+| `--token ` | Commit token from a prepare-only request. |
+| `--transaction-hash ` | Transaction hash proving on-chain compose hash registration. Pass `already-registered` to skip the proof and rely on state-only verification. |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `-i, --interactive` | Enable interactive mode |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Add instance with existing compose
+
+```bash
+phala instances add --app-id --node-id 5
+```
+
+* Add instance with new Docker Compose
+
+```bash
+phala instances add --app-id --node-id 5 --compose-file docker-compose.yml
+```
+
+* Prepare for multisig approval
+
+```bash
+phala instances add --app-id --node-id 5 --compose-file docker-compose.yml --prepare-only
+```
+
+* Commit a prepared instance
+
+```bash
+phala instances add --app-id --commit --token --compose-hash --transaction-hash
+```
+
diff --git a/phala-cloud/phala-cloud-cli/instances/ls.mdx b/phala-cloud/phala-cloud-cli/instances/ls.mdx
new file mode 100644
index 0000000..655adca
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/instances/ls.mdx
@@ -0,0 +1,60 @@
+---
+title: "instances ls"
+description: "List instances of an app"
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala instances ls`
+
+### Syntax
+
+```
+phala instances ls [options]
+```
+
+### Description
+
+List instances of an app
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `--app-id ` | App ID (hex identifier). Defaults to app_id in phala.toml. |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* List instances for app in phala.toml
+
+```bash
+phala instances ls
+```
+
+* List instances for a specific app
+
+```bash
+phala instances ls --app-id
+```
+
+* Output as JSON
+
+```bash
+phala instances ls --app-id --json
+```
+
diff --git a/phala-cloud/phala-cloud-cli/instances/rm.mdx b/phala-cloud/phala-cloud-cli/instances/rm.mdx
new file mode 100644
index 0000000..be93d41
--- /dev/null
+++ b/phala-cloud/phala-cloud-cli/instances/rm.mdx
@@ -0,0 +1,67 @@
+---
+title: "instances rm"
+description: "Delete one or more app instances by VM UUID"
+---
+
+
+This command is marked as unstable and may change in future releases.
+
+
+## Command: `phala instances rm`
+
+### Syntax
+
+```
+phala instances rm [options] ...
+```
+
+### Description
+
+Delete one or more app instances by VM UUID
+
+### Arguments
+
+| Argument | Description |
+| -------- | ----------- |
+| `` | VM UUID(s) of the instances to delete |
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-f, --force` | Skip confirmation prompt |
+| `-y, --yes` | Alias for --force (skip confirmation prompt) |
+
+### Global Options
+
+| Option | Description |
+| ------ | ----------- |
+| `-h, --help` | Show help information for the current command |
+| `-v, --version` | Show CLI version |
+| `--api-token TOKEN, --api-key TOKEN` | API token for authenticating with Phala Cloud |
+| `-j, --json, --no-json` | Output in JSON format |
+| `--interactive` | Enable interactive mode for commands that support it |
+| `--cvm-id ` | CVM identifier (UUID, app_id, instance_id, or name) |
+| `--profile PROFILE` | Temporarily use a different auth profile for this command |
+| `--api-version ` | API version to use (e.g. 2025-10-28, 2026-01-21) |
+
+### Examples
+
+* Delete a single instance
+
+```bash
+phala instances rm 550e8400-e29b-41d4-a716-446655440000
+```
+
+* Delete multiple instances
+
+```bash
+phala instances rm 550e8400-e29b-41d4-a716-446655440000 661f9511-f30c-52e5-b827-557766551111
+```
+
+* Delete without confirmation
+
+```bash
+phala instances rm 550e8400-e29b-41d4-a716-446655440000 --force
+```
+
diff --git a/phala-cloud/phala-cloud-cli/kms.mdx b/phala-cloud/phala-cloud-cli/kms.mdx
index b917edc..0e9dde0 100644
--- a/phala-cloud/phala-cloud-cli/kms.mdx
+++ b/phala-cloud/phala-cloud-cli/kms.mdx
@@ -1,25 +1,26 @@
---
title: "kms"
description: "Manage on-chain KMS contracts"
+hidden: true
---