Skip to main content
Resume a paused sandbox to continue execution from where it was paused. The sandbox will transition from paused to running status.

Endpoint

POST /v1/sandboxes/:id/resume

Request

Headers

Authorization: Bearer $HOPX_API_KEY

Path Parameters

ParameterTypeDescription
idstringSandbox ID to resume

Example Request

curl -X POST https://api.hopx.dev/v1/sandboxes/sandbox_abc123xyz/resume \
  -H "Authorization: Bearer $HOPX_API_KEY"

Response

Success (200 OK)

{
  "id": "sandbox_abc123xyz",
  "status": "running",
  "request_id": "req_abc123"
}

Response Fields

FieldTypeDescription
idstringSandbox ID
statusstringNew status (running)
request_idstringRequest ID for debugging

Status Codes

CodeDescription
200Sandbox resumed successfully
401Authentication required
404Sandbox not found

Errors

Sandbox Not Found (404)

{
  "error": "Sandbox not found",
  "code": "RESOURCE_NOT_FOUND",
  "request_id": "req_abc123"
}
Cause: The sandbox ID doesn’t exist or belongs to another organization. Fix: Verify the sandbox ID is correct. List your sandboxes using GET /v1/sandboxes to find valid IDs.

Important Notes

  • Execution continues - All paused processes resume from where they were paused
  • State preserved - Memory state and files remain intact
  • VM Agent API - VM Agent API endpoints become available again

Use Cases

Resume After Pausing

# Pause a sandbox
curl -X POST https://api.hopx.dev/v1/sandboxes/sandbox_abc123xyz/pause \
  -H "Authorization: Bearer $HOPX_API_KEY"

# ... later, resume it ...
curl -X POST https://api.hopx.dev/v1/sandboxes/sandbox_abc123xyz/resume \
  -H "Authorization: Bearer $HOPX_API_KEY"

Resume All Paused Sandboxes

#!/bin/bash
# Get all paused sandboxes
PAUSED=$(curl -s "https://api.hopx.dev/v1/sandboxes?status=paused" \
  -H "Authorization: Bearer $HOPX_API_KEY" | \
  jq -r '.data[].id')

# Resume each one
for ID in $PAUSED; do
  curl -X POST "https://api.hopx.dev/v1/sandboxes/$ID/resume" \
    -H "Authorization: Bearer $HOPX_API_KEY"
  echo "Resumed $ID"
done

Next Steps


Resume a paused sandbox to continue execution from where it was paused. The sandbox will transition from paused to running status.

Endpoint

POST /v1/sandboxes/:id/resume

Request

Headers

Authorization: Bearer $HOPX_API_KEY

Path Parameters

ParameterTypeDescription
idstringSandbox ID to resume

Example Request

curl -X POST https://api.hopx.dev/v1/sandboxes/sandbox_abc123xyz/resume \
  -H "Authorization: Bearer $HOPX_API_KEY"

Response

Success (200 OK)

{
  "id": "sandbox_abc123xyz",
  "status": "running",
  "request_id": "req_abc123"
}

Response Fields

FieldTypeDescription
idstringSandbox ID
statusstringNew status (running)
request_idstringRequest ID for debugging

Status Codes

CodeDescription
200Sandbox resumed successfully
401Authentication required
404Sandbox not found

Errors

Sandbox Not Found (404)

{
  "error": "Sandbox not found",
  "code": "RESOURCE_NOT_FOUND",
  "request_id": "req_abc123"
}
Cause: The sandbox ID doesn’t exist or belongs to another organization. Fix: Verify the sandbox ID is correct. List your sandboxes using GET /v1/sandboxes to find valid IDs.

Important Notes

  • Execution continues - All paused processes resume from where they were paused
  • State preserved - Memory state and files remain intact
  • VM Agent API - VM Agent API endpoints become available again

Use Cases

Resume After Pausing

# Pause a sandbox
curl -X POST https://api.hopx.dev/v1/sandboxes/sandbox_abc123xyz/pause \
  -H "Authorization: Bearer $HOPX_API_KEY"

# ... later, resume it ...
curl -X POST https://api.hopx.dev/v1/sandboxes/sandbox_abc123xyz/resume \
  -H "Authorization: Bearer $HOPX_API_KEY"

Resume All Paused Sandboxes

#!/bin/bash
# Get all paused sandboxes
PAUSED=$(curl -s "https://api.hopx.dev/v1/sandboxes?status=paused" \
  -H "Authorization: Bearer $HOPX_API_KEY" | \
  jq -r '.data[].id')

# Resume each one
for ID in $PAUSED; do
  curl -X POST "https://api.hopx.dev/v1/sandboxes/$ID/resume" \
    -H "Authorization: Bearer $HOPX_API_KEY"
  echo "Resumed $ID"
done

Next Steps