Skip to main content
Retrieve detailed information about a specific sandbox, including status, configuration, and resource usage. 
curl -X GET https://api.gravixlayer.com/v1/agents/sandboxes/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

{
  "sandbox_id": "550e8400-e29b-41d4-a716-446655440000",
  "template": "python-base-v1",
  "status": "running",
  "started_at": "2025-01-27T10:30:00Z",
  "timeout_at": "2025-01-27T11:30:00Z",
  "metadata": {
    "project": "data-analysis",
    "owner": "data-team"
  },
  "cpu_count": 2,
  "memory_mb": 2048
}

​
Response Fields

FieldTypeDescription
sandbox_idstringUnique sandbox identifier
templatestringTemplate name used
statusstringCurrent status
started_atstringCreation timestamp (ISO 8601)
timeout_atstringTimeout timestamp (ISO 8601)
metadataobjectCustom metadata tags
cpu_countintegerAllocated vCPUs
memory_mbintegerAllocated memory in MB

​
Status Values

  • creating - Sandbox is being initialized
  • running - Sandbox is active and ready
  • stopped - Sandbox has been paused
  • failed - Creation or execution failed
  • terminated - Manually terminated
  • timed_out - Exceeded timeout limit

​
Resource Metrics

Get real-time resource usage: 
curl -X GET https://api.gravixlayer.com/v1/agents/sandboxes/550e8400-e29b-41d4-a716-446655440000/metrics \
  -H "Authorization: Bearer YOUR_API_KEY"
Response: 
{
  "timestamp": "2025-10-23T12:35:00Z",
  "cpu_usage": 25.5,
  "memory_usage": 1024.0,
  "memory_total": 2048.0,
  "disk_read": 5242880,
  "disk_write": 2621440,
  "network_rx": 8388608,
  "network_tx": 4194304
}

​
Next Steps

Configure Sandbox

Update sandbox settings and configuration

Terminate Sandbox

Clean up resources when finished

Execute Code

Run code in your sandbox

Read Files

Read files from sandbox filesystem