Documentation

Control Panel V3 API Documentation

Welcome to the Control Panel V3 API documentation! This API allows you to programmatically manage all aspects of your web hosting account.

Getting Started

To get started with the Control Panel V3 API, you'll need:

1. API Access Token - Generate this from the hosting Control Panel > Account Profile
2. API Base URL - https://panel.s801.sureserver.com/api/v1
3. HTTP Client - Any tool that can make HTTP requests (curl, Postman, etc.)

Authentication

Important: This is a JSON API. All requests that send data (POST) must include the Content-Type: application/json header, and request bodies must be valid JSON.

The API supports two authentication schemes and every request must use one of them:

1. API Key – generate from Control Panel → Account Profile and send it in the x-api-key header. The API key does not expire unless manually revoked.
2. Bearer Token – call POST /auth with your Control Panel credentials to obtain an api_token, then send it in the Authorization: Bearer <token> header (expires after 10 days). See more in the Authentication section.

Example using an API key:

Code
curl --request GET \
  --url https://panel.s801.sureserver.com/api/v1/account \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <your_api_key>'

Example using a bearer token:

Code
curl --request GET \
  --url https://panel.s801.sureserver.com/api/v1/account \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <api_token>'

Note: For consistency, most request examples in this documentation use the x-api-key header, but every endpoint will work equally well with the bearer-token approach shown above.

Example POST request with JSON body:

Code
curl --request POST \
  --url https://panel.s801.sureserver.com/api/v1/domains \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <your_api_key>' \
  --data '{
    "domain": "example.com",
    "document_root": "public_html/example"
  }'

Postman Collection

For quick testing and exploration of the API, we provide a comprehensive Postman collection that includes all available endpoints with pre-configured request examples.

Download the collection: cp_user_api.postman_collection.json

How to Use

1. Import into Postman - Download the JSON file and import it into Postman (File → Import)
2. Configure Environment - Set up your environment variables:
   • base_url - Your API base URL (e.g., https://panel.s801.sureserver.com/api/v1)
   • api_token - Your personal API token from the Control Panel
3. Start Testing - Browse through the organized folders and execute requests

The collection includes all API endpoints organized by section, with example requests and proper authentication headers pre-configured.

API Sections

The API is organized into the following sections:

• Account - Manage account information, contacts, IPs, and plan usage
• Backup - Create and manage backups
• Cache - Manage caching settings
• Crons - Schedule and manage cron jobs
• Databases - Create and manage MySQL databases
• DNS - Manage DNS zones and records
• Domains - Manage domains and virtual hosts
• Files - File manager operations (upload, download, edit)
• FTP - Manage FTP accounts
• Mail - Manage email accounts and settings
• Mail Lists - Manage mailing lists
• PHP - Configure PHP settings and versions
• Protect - Directory password protection and IP blocking
• Redirects - Manage URL redirects
• SSH - Manage SSH access
• SSL - Manage SSL certificates
• Subdomains - Create and manage subdomains
• Subusers - Manage subuser accounts and permissions
• Tasks - View and manage background tasks
• Web Apps - Install and manage web applications
• WordPress - WordPress-specific management

Response Format

All API responses follow a consistent format:

Code
{
  "status": true,
  "data": { ... },
  "errors": {}
}

• status - Boolean indicating success or failure
• data - Response data (varies by endpoint)
• message - Human-readable message
• errors - Object containing any validation or error messages

Error Handling

When an error occurs, the response will include:

Code
{
  "status": false,
  "data": null,
  "message": "An error occurred",
  "errors": {
    "field_name": "Error message for this field",
    "__": "General error message"
  }
}

Rate Limiting

API requests are rate-limited to prevent abuse. Check the response headers for rate limit information:

• X-RateLimit-Limit - Maximum requests per time window
• X-RateLimit-Remaining - Remaining requests in current window
• X-RateLimit-Reset - Time when the rate limit resets

Support

For questions or issues with the API:

• Check the detailed documentation for each endpoint
• Review the code examples provided
• Contact support if you need assistance

Next Steps

Explore the API sections in the navigation menu to see all available endpoints and their documentation.