Skip to main content

​
API Reference

The Waterfall API allows you to programmatically manage your servers and account.
The API is currently in development. Documentation will be expanded as endpoints become available.

​
Authentication

All API requests require authentication using an API key.

​
Getting Your API Key

  1. Go to Account Settings > API Keys
  2. Click Create API Key
  3. Give your key a descriptive name
  4. Copy and securely store your key
API keys provide full access to your account. Never share them or commit them to version control.

​
Using Your API Key

Include your API key in the Authorization header: 
curl -X GET "https://api.waterfallhost.com/v1/servers" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Base URL

All API requests should be made to: 
https://api.waterfallhost.com/v1

​
Response Format

All responses are returned in JSON format: 
{
  "success": true,
  "data": {
    // Response data here
  }
}

​
Error Responses

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  }
}

​
Rate Limiting

API requests are limited to:
  • 100 requests per minute for standard accounts
  • 500 requests per minute for business accounts
Rate limit headers are included in all responses: 
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640000000