Overview
The Start Cluster endpoint allows you to start previously stopped GPU clusters, optionally updating configuration settings during startup. This enables cost-effective cluster management by stopping clusters when not in use and quickly resuming work when needed.Endpoint
Path Parameters
Parameter | Type | Required | Description |
---|---|---|---|
cluster_id | string | Yes | Unique cluster identifier |
Request Body
Parameter | Type | Required | Description |
---|---|---|---|
wait_for_ready | boolean | No | Wait for cluster to be fully ready before returning (default: false) |
timeout_minutes | integer | No | Maximum wait time in minutes (default: 10, max: 30) |
update_configuration | object | No | Configuration updates to apply during startup |
restore_from_snapshot | string | No | Snapshot ID to restore from |
environment_updates | object | No | Environment variable updates |
port_mapping_updates | array | No | Port mapping changes |
auto_terminate_updates | object | No | Auto-termination setting updates |
Configuration Updates
Request Examples
Response Schema
Startup Progress Tracking
Whenwait_for_ready
is false, you can poll the cluster status to track startup progress:
Use Cases
Development Workflow
Start development clusters when team members begin work.Training Job Resumption
Resume training jobs from checkpoints with updated configurations.Scheduled Cluster Activation
Start clusters on a schedule for batch processing jobs.Error Handling
Security Considerations
- State Validation: Ensure clusters are in the correct state before starting
- Configuration Updates: Validate configuration changes don’t compromise security
- Resource Limits: Monitor resource allocation to prevent quota violations
- Access Control: Verify permissions for configuration updates
Best Practices
- Startup Monitoring: Always monitor startup progress for production clusters
- Configuration Validation: Test configuration updates in development first
- Cost Management: Set appropriate auto-termination limits
- Resource Planning: Consider resource availability during peak hours
- Backup Strategy: Use snapshots before major configuration changes
- Error Handling: Implement proper error handling and retry logic
Authorizations
API key authentication. Use 'Bearer YOUR_API_KEY' format.
Path Parameters
Response
200 - application/json
Cluster start initiated
The response is of type object
.