​

Admin API Documentation

​

Authentication

curl -H "x-admin-code: YOUR_ADMIN_CODE" http://your-server/admin/endpoint

​

Graceful Restart

​

POST /admin/graceful-restart

• x-admin-code (required): Admin authentication code

{
  "success": true,
  "pendingRestart": true,
  "currentPhase": "FIGHTING"
}

• If no duel active (IDLE/ANNOUNCEMENT): Restarts immediately via SIGTERM
• If duel in progress (FIGHTING/RESOLUTION): Waits until RESOLUTION phase completes
• PM2 automatically restarts the server with new code
• No interruption to active duels or streams

curl -X POST http://your-server/admin/graceful-restart \
  -H "x-admin-code: YOUR_ADMIN_CODE"

• Deploy new code without interrupting active duels
• Update server configuration during live streams
• Apply security patches with minimal disruption

​

GET /admin/restart-status

• x-admin-code (required): Admin authentication code

{
  "success": true,
  "pendingRestart": false,
  "currentPhase": "IDLE"
}

• success (boolean): Request succeeded
• pendingRestart (boolean): Whether restart is pending
• currentPhase (string): Current duel phase (IDLE, ANNOUNCEMENT, FIGHTING, RESOLUTION)

curl http://your-server/admin/restart-status \
  -H "x-admin-code: YOUR_ADMIN_CODE"

​

Programmatic API

import { StreamingDuelScheduler } from '@hyperscape/server/systems/StreamingDuelScheduler';

// Request graceful restart
const scheduler = world.getSystem('streamingDuelScheduler') as StreamingDuelScheduler;
scheduler.requestGracefulRestart();

// Check if restart is pending
const isPending = scheduler.isPendingRestart();

​

Error Responses

{
  "error": "Unauthorized",
  "message": "Invalid or missing admin code"
}

{
  "error": "Internal Server Error",
  "message": "Failed to request graceful restart"
}

​

Configuration

# .env or environment variables
ADMIN_CODE=your-secret-admin-code

• Never commit ADMIN_CODE to git
• Use a strong, randomly generated code
• Rotate the code periodically
• Store in GitHub Secrets for CI/CD deployments

​

Related Documentation

• Deployment Process - Vast.ai deployment script
• PM2 Configuration - PM2 process management
• Streaming Status Check - Health monitoring script