RespawnHost API

Welcome to the RespawnHost API documentation. This API allows you to programmatically manage your game servers, backups, files, databases, and more.

Getting Started

1. Create an Account — Sign up at respawnhost.com
2. Generate an API Key — Navigate to your account dashboard and create an API key with the required scopes
3. Make Your First Request — Use the examples below or explore the interactive API Reference

Base URL

https://respawnhost.com/api/v1

Official TypeScript SDK

We provide an official TypeScript SDK for easy integration with your Node.js, Bun, or Deno projects.

# npm
npm install @respawnhost/sdk

# yarn
yarn add @respawnhost/sdk

# pnpm
pnpm add @respawnhost/sdk

# bun
bun add @respawnhost/sdk

Quick Example

import { RespawnHostClient, ServersService, PowerState } from '@respawnhost/sdk';

const client = new RespawnHostClient({
  apiKey: 'your-api-key'
});

const servers = new ServersService(client);

// List all your servers
const { data: serverList } = await servers.list();
console.log(`You have ${serverList.length} servers`);

// Start a server
await servers.setPowerState('server-uuid', { power_state: PowerState.START });

SDK Features

• 🎯 Full TypeScript Support — Complete type definitions for all API endpoints
• 🚀 Modern Async/Await — Clean, promise-based API
• 🛡️ Type-Safe Error Handling — Typed error classes for different HTTP status codes
• 📦 Zero Runtime Dependencies — Uses native fetch API
• 🎮 Complete API Coverage — All RespawnHost API endpoints supported

For full SDK documentation, visit the npm package page.

Quick Links

• Authentication — API key setup and scopes
• Examples — Common use cases and SDK examples
• API Reference — Interactive documentation with all endpoints

Interactive API Reference

For a complete list of endpoints with request/response schemas, visit the API Reference. You can test endpoints directly in your browser.