API Documentation

Quick reference

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": ["The email field is required."]
    }
  }
}

Example — provision a hosting account

curl -X POST https://api.hostscheap.com/v1/hosting \
  -H "Authorization: Bearer $HCL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_id": "uuid-here",
    "sku_id": "shared-hosting-starter",
    "domain": "example.com",
    "billing_cycle": "1_year"
  }'

$client = new GuzzleHttp\Client();
$response = $client->post('https://api.hostscheap.com/v1/hosting', [
  'headers' => [
    'Authorization' => 'Bearer ' . $apiKey,
  ],
  'json' => [
    'customer_id'   => 'uuid-here',
    'sku_id'        => 'shared-hosting-starter',
    'domain'        => 'example.com',
    'billing_cycle' => '1_year',
  ],
]);

Rate limits

Every 2xx carries the IETF-draft RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset headers (the legacy X-RateLimit-* set is also sent). Breaching a limit returns HTTP 429 with a Retry-After header (seconds). Honour it: wait, then retry with exponential backoff. To retry money-moving POSTs safely, send an Idempotency-Key so the platform collapses replays into one operation. Per-endpoint sub-limits (and tighter auth limits on login/signup/2FA) apply on top of the global ceiling above.

🛠 OpenAPI 3.1 auto-generation coming

Per File 57 line 173, the canonical OpenAPI spec at https://api.hostscheap.com/v1/openapi.json will be auto-generated from Laravel routes and embedded here via Scalar for interactive try-it-out with your API key. Until then, the hand-written reference above covers all current endpoints.