cyberwave.rest.CloudNodeApi
All URIs are relative to http://localhost| Method | HTTP request | Description |
|---|---|---|
| src_app_api_cloud_nodes_create_instance | POST /api/v1/cloud-node | Create Instance |
| src_app_api_cloud_nodes_get_instance_logs | GET /api/v1/cloud-node/instances/{instance_uuid}/logs | Get Instance Logs |
| src_app_api_cloud_nodes_get_instance_metadata | GET /api/v1/cloud-node/instances/{instance_uuid}/metadata | Get Instance Metadata |
| src_app_api_cloud_nodes_get_instance_status | GET /api/v1/cloud-node/instances/{instance_uuid}/status | Get Instance Status |
| src_app_api_cloud_nodes_list_instances | GET /api/v1/cloud-node/instances | List Instances |
| src_app_api_cloud_nodes_mark_instance_failed | POST /api/v1/cloud-node/{uuid}/failed | Mark Instance Failed |
| src_app_api_cloud_nodes_mark_instance_terminated | POST /api/v1/cloud-node/{uuid}/terminated | Mark Instance Terminated |
| src_app_api_cloud_nodes_record_heartbeat | POST /api/v1/cloud-node/{uuid}/heartbeat | Record Heartbeat |
| src_app_api_cloud_nodes_register_gpu_instance | POST /api/v1/cloud-node/{uuid}/register | Register Gpu Instance |
| src_app_api_cloud_nodes_save_cloud_node_instance_log | POST /api/v1/cloud-node/{uuid}/log | Save Cloud Node Instance Log |
src_app_api_cloud_nodes_create_instance
CloudNodeInstanceSchema src_app_api_cloud_nodes_create_instance(cloud_node_instance_create_request)Create Instance Create a new Cloud Node instance. The backend is the owner of the UUID and slug:
- If slug is provided, it must be unique within the workspace
- If slug is not provided, an auto-generated slug will be created
Example
- Api Key Authentication (CustomTokenAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| cloud_node_instance_create_request | CloudNodeInstanceCreateRequest |
Return type
CloudNodeInstanceSchemaAuthorization
CustomTokenAuthenticationHTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
src_app_api_cloud_nodes_get_instance_logs
CloudNodeInstanceLogsResponse src_app_api_cloud_nodes_get_instance_logs(instance_uuid, log_type=log_type, limit=limit)Get Instance Logs Retrieve logs for a Cloud Node (GPU) instance. Returns log metadata and the combined content of the most recent log entries, limited to the last N lines (default 100). Args: instance_uuid: UUID of the Cloud Node instance log_type: Optional filter by log type (“stdout”, “stderr”, “system”, “app”) limit: Maximum number of lines to return (default 100, max 1000)
Example
- Api Key Authentication (CustomTokenAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| instance_uuid | str | ||
| log_type | str | [optional] | |
| limit | int | [optional] [default to 100] |
Return type
CloudNodeInstanceLogsResponseAuthorization
CustomTokenAuthenticationHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
src_app_api_cloud_nodes_get_instance_metadata
Dict[str, object] src_app_api_cloud_nodes_get_instance_metadata(instance_uuid)Get Instance Metadata Get the metadata for a Cloud Node instance. Used by Cloud Node services to self-configure at startup by fetching their instance-specific configuration (weights URLs, twin UUIDs, etc.) without needing every field passed as environment variables. Authentication: Requires CYBERWAVE_API_KEY (admin token or instance-specific token)
Example
- Api Key Authentication (CustomTokenAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| instance_uuid | str |
Return type
Dict[str, object]Authorization
CustomTokenAuthenticationHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
src_app_api_cloud_nodes_get_instance_status
CloudNodeInstanceStatusResponse src_app_api_cloud_nodes_get_instance_status(instance_uuid)Get Instance Status Get the current status of a Cloud Node (GPU) instance. Used by Cloud Node (GPU) services to check their registration status and by monitoring systems to verify instance health.
Example
- Api Key Authentication (CustomTokenAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| instance_uuid | str |
Return type
CloudNodeInstanceStatusResponseAuthorization
CustomTokenAuthenticationHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
src_app_api_cloud_nodes_list_instances
List[CloudNodeInstanceSchema] src_app_api_cloud_nodes_list_instances(profile_slug=profile_slug, status=status, workspace_slug=workspace_slug)List Instances List Cloud Node instances for a workspace. Optionally filter by profile_slug or status. If workspace_slug is provided, uses that workspace; otherwise uses the user’s default.
Example
- Api Key Authentication (CustomTokenAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| profile_slug | str | [optional] | |
| status | str | [optional] | |
| workspace_slug | str | [optional] |
Return type
List[CloudNodeInstanceSchema]Authorization
CustomTokenAuthenticationHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
src_app_api_cloud_nodes_mark_instance_failed
CloudNodeFailedResponse src_app_api_cloud_nodes_mark_instance_failed(uuid, cloud_node_failed_request)Mark Instance Failed Mark a Cloud Node (GPU) instance as failed. Called by the GitHub Actions workflow when provisioning fails or the instance crashes unexpectedly. Any associated workloads will be re-queued.
Example
- Api Key Authentication (CustomTokenAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| uuid | str | ||
| cloud_node_failed_request | CloudNodeFailedRequest |
Return type
CloudNodeFailedResponseAuthorization
CustomTokenAuthenticationHTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
src_app_api_cloud_nodes_mark_instance_terminated
CloudNodeTerminatedResponse src_app_api_cloud_nodes_mark_instance_terminated(uuid, cloud_node_terminated_request)Mark Instance Terminated Mark a Cloud Node (GPU) instance as terminated. Called by the package (cyberwave-cloud-node) once a termination is triggered OR by the GitHub Actions workflow after Terraform has successfully (when used by us)
Example
- Api Key Authentication (CustomTokenAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| uuid | str | ||
| cloud_node_terminated_request | CloudNodeTerminatedRequest |
Return type
CloudNodeTerminatedResponseAuthorization
CustomTokenAuthenticationHTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
src_app_api_cloud_nodes_record_heartbeat
CloudeNodeHeartbeatResponse src_app_api_cloud_nodes_record_heartbeat(uuid)Record Heartbeat Record a heartbeat from a Cloud Node (GPU) instance. Called periodically by the Cloud Node (GPU) service to signal it is alive and healthy. Missing heartbeats will cause the instance to be marked as stale and terminated.
Example
- Api Key Authentication (CustomTokenAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| uuid | str |
Return type
CloudeNodeHeartbeatResponseAuthorization
CustomTokenAuthenticationHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
src_app_api_cloud_nodes_register_gpu_instance
CloudeNodeInstanceRegisterResponse src_app_api_cloud_nodes_register_gpu_instance(uuid, cloud_node_instance_register_request)Register Gpu Instance Register a Cloud Node (GPU) instance after it has booted and is ready to serve. Called by the Cloud Node (GPU) service once its dependencies (e.g. CUDA, etc) are available and the service is listening. This endpoint only registers an existing instance. The instance must have been created via the create endpoint first. The profile_slug can be updated during registration to reflect the actual running profile.
Example
- Api Key Authentication (CustomTokenAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| uuid | str | ||
| cloud_node_instance_register_request | CloudNodeInstanceRegisterRequest |
Return type
CloudeNodeInstanceRegisterResponseAuthorization
CustomTokenAuthenticationHTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
src_app_api_cloud_nodes_save_cloud_node_instance_log
CloudNodeLogResponse src_app_api_cloud_nodes_save_cloud_node_instance_log(uuid, cloud_node_log_request)Save Cloud Node Instance Log Save a log entry for a Cloud Node (GPU) instance. Logs are stored asynchronously in GCS with metadata in the database. This allows Cloud Node instances to stream logs without blocking.
Example
- Api Key Authentication (CustomTokenAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| uuid | str | ||
| cloud_node_log_request | CloudNodeLogRequest |
Return type
CloudNodeLogResponseAuthorization
CustomTokenAuthenticationHTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |