Developer Resources

API Documentation

Automate your hosting management with the CyclebreezeHost REST API. Manage services, domains, DNS, SSL, billing, and more programmatically.

Base URLhttps://api.cyclebreezehost.com

Built for Developers

A modern RESTful API with everything you need to integrate CyclebreezeHost into your workflow.

API Key Authentication

Secure Bearer token authentication. Generate and manage API keys from your client area with granular permission controls.

JSON Responses

All endpoints return clean, structured JSON with consistent pagination, error codes, and metadata.

Webhooks

Receive real-time HTTP callbacks for events like service provisioning, domain expiry, invoice generation, and SSL issuance.

Rate Limiting

Fair-use rate limits of 60 requests/minute with clear rate limit headers. Higher limits available for enterprise accounts.

TLS Encryption

All API communication is encrypted over HTTPS. Plain HTTP requests are rejected to ensure data security.

RESTful Design

Standard REST conventions with predictable URLs, HTTP methods, and status codes. Easy to integrate with any language or framework.

Quickstart

Get started in seconds. Here's how to list your hosting services.

Step 1: Get your API key

Log in to your client area, navigate to Account Settings → API Credentials, and generate a new API key. Keep it secure — treat it like a password.

curl -X GET "https://api.cyclebreezehost.com/api/v1/services" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
Example Response — 200 OK
{
  "status": "success",
  "data": {
    "services": [
      {
        "id": 1042,
        "domain": "example.com",
        "plan": "Standard Shared Hosting",
        "status": "active",
        "created_at": "2026-01-15T10:30:00Z",
        "next_due": "2026-04-15"
      }
    ],
    "pagination": {
      "total": 1,
      "page": 1,
      "per_page": 25
    }
  }
}

API Endpoints

Complete reference for all available API endpoints grouped by resource.

Client Management

GET/api/v1/clients
GET/api/v1/clients/{id}
POST/api/v1/clients
PUT/api/v1/clients/{id}

Hosting Services

GET/api/v1/services
GET/api/v1/services/{id}
POST/api/v1/services/{id}/suspend
POST/api/v1/services/{id}/unsuspend
POST/api/v1/services/{id}/upgrade

Domain Management

GET/api/v1/domains
GET/api/v1/domains/{id}
POST/api/v1/domains/register
POST/api/v1/domains/{id}/renew
GET/api/v1/domains/{id}/nameservers
PUT/api/v1/domains/{id}/nameservers

DNS Records

GET/api/v1/dns/{domain}/records
POST/api/v1/dns/{domain}/records
PUT/api/v1/dns/{domain}/records/{id}
DELETE/api/v1/dns/{domain}/records/{id}

SSL Certificates

GET/api/v1/ssl
POST/api/v1/ssl/provision
GET/api/v1/ssl/{id}/status
DELETE/api/v1/ssl/{id}

Billing & Invoices

GET/api/v1/invoices
GET/api/v1/invoices/{id}
POST/api/v1/invoices/{id}/pay
GET/api/v1/billing/balance

Authentication

All API requests require a Bearer token in the Authorization header.

Authorization: Bearer YOUR_API_KEY

Generate API keys in your client area under Account Settings.

Rate Limits

Rate limit information is included in every response header.

Standard limit60 req/min
Enterprise limit300 req/min
Rate limit headerX-RateLimit-Remaining

Error Handling

The API uses standard HTTP status codes. Errors include a JSON body with a descriptive message.

200Success
201Created
400Bad Request
401Unauthorized
404Not Found
429Rate Limited
500Server Error

Start Building with Our API

Sign up for a hosting account to get your API key and start automating.