---
title: Introduction
description: "xCloud Public API A self-service REST API for all xCloud customers. Use this API to programmatically manage your servers, sites, databases, backups, cron jobs, and more — directly from your…"
url: "https://betterdocs.shahrear.msf.bd/index.php/docs/hell0-boys-docs/hell0-boys/hell0-boys-introduction/"
updated: "2026-08-20"
category: hell0 boys
---

# Introduction

## xCloud Public [API](https://betterdocs.shahrear.msf.bd/encyclopedia/api/)

A self-service REST [API](https://betterdocs.shahrear.msf.bd/encyclopedia/api/) for all xCloud customers. Use this [API](https://betterdocs.shahrear.msf.bd/encyclopedia/api/) to programmatically manage your servers, sites, databases, backups, cron jobs, and more — directly from your own scripts, CI/[CD](https://betterdocs.shahrear.msf.bd/encyclopedia/cd/) pipelines, or integrations.

## Authentication

All [API](https://betterdocs.shahrear.msf.bd/encyclopedia/api/) requests (except `GET /health`) require a **Sanctum Personal Access Token** passed as a Bearer token in the `Authorization` header.

### Creating a Token

1. Log in to [app.xcloud.host](https://app.xcloud.host)
2. Navigate to **Account → [API](https://betterdocs.shahrear.msf.bd/encyclopedia/api/) Tokens** (`/user/API-tokens`)
3. Click **Create [New](https://betterdocs.shahrear.msf.bd/encyclopedia/new/) Token**
4. Select the required scopes for your use case
5. Copy the token — **it is shown only once**

### Available Scopes

| Scope | Access |
| --- | --- |
| `read:servers` | List and view servers, databases, cron jobs, PHP versions, monitoring, sudo users |
| `write:servers` | Reboot servers, create WordPress sites, manage sudo users |
| `read:sites` | List and view sites, backups, SSL, domain, git, deployment logs, SSH config |
| `write:sites` | Trigger backups, rescue sites, purge cache, update SSH/SFTP config |
| `*` | Full access to all endpoints |

### Required Headers

```http
Authorization: Bearer <your-token>
Accept: application/json
Content-Type: application/json
```

## Response Format

All responses follow a consistent envelope:

```json
{
  "success": true,
  "message": "Operation completed successfully.",
  "data": { ... }
}
```

For paginated lists, `data` contains:

```json
{
  "data": [ ... ],
  "meta": {
    "current_page": 1,
    "last_page": 5,
    "per_page": 15,
    "total": 72
  }
}
```

## HTTP Status Codes

| Code | Meaning |
| --- | --- |
| `200 OK` | Request successful |
| `202 Accepted` | Async operation queued (e.g. reboot, backup) |
| `400 Bad Request` | Validation error — check `errors` in response body |
| `401 Unauthorized` | Missing or invalid token |
| `403 Forbidden` | Token lacks the required scope |
| `404 Not Found` | Resource not found or not accessible to your [Team](https://betterdocs.shahrear.msf.bd/encyclopedia/team/) |
| `422 Unprocessable Entity` | Business logic validation failure |
| `429 Too Many Requests` | Rate limit exceeded |
| `500 Internal Server Error` | [Server](https://betterdocs.shahrear.msf.bd/encyclopedia/server/) error — contact support |

## Rate Limits

| Type | Limit |
| --- | --- |
| Authenticated requests | **60 requests / minute** |
| Unauthenticated requests | **10 requests / minute** |

Rate limit headers are included in every response:

```http
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1710000060
```

When you exceed the limit, the [API](https://betterdocs.shahrear.msf.bd/encyclopedia/api/) returns `429 Too Many Requests` with a `Retry-After` header indicating [How](https://betterdocs.shahrear.msf.bd/encyclopedia/how/) many seconds to wait.

## Base URLs

| URL | Description |
| --- | --- |
| `https://app.xcloud.host/API/v1` | Production |

## Authentication

| Scheme | Type | Details |
| --- | --- | --- |
| `bearerAuth` | http | HTTP bearer authentication |

## [API](https://betterdocs.shahrear.msf.bd/encyclopedia/api/) Details

| Version | [1](https://betterdocs.shahrear.msf.bd/encyclopedia/1/).0.0 |
| --- | --- |
| Contact | xCloud Support — [https://xcloud.host/support](https://xcloud.host/support) |
| License | Proprietary |