{"id":7758,"date":"2026-08-20T16:54:26","date_gmt":"2026-08-20T10:54:26","guid":{"rendered":"https:\/\/betterdocs.shahrear.msf.bd\/index.php\/docs\/non-knowledgebase\/uncategorized\/hell0-boys-introduction\/"},"modified":"2026-08-20T16:54:26","modified_gmt":"2026-08-20T10:54:26","password":"","slug":"hell0-boys-introduction","status":"publish","type":"docs","link":"https:\/\/betterdocs.shahrear.msf.bd\/index.php\/docs\/hell0-boys-docs\/hell0-boys\/hell0-boys-introduction\/","title":{"rendered":"Introduction"},"content":{"rendered":"\n

xCloud Public API<\/h2>\n\n

A self-service REST API for all xCloud customers. Use this API to programmatically\nmanage your servers, sites, databases, backups, cron jobs, and more \u2014 directly from\nyour own scripts, CI\/CD pipelines, or integrations.<\/p>\n\n

Authentication<\/h2>\n\n

All API requests (except GET \/health<\/code>) require a Sanctum Personal Access Token<\/strong>\npassed as a Bearer token in the Authorization<\/code> header.<\/p>\n\n

Creating a Token<\/h3>\n\n
    \n
  1. Log in to app.xcloud.host<\/a><\/li>\n
  2. Navigate to Account \u2192 API Tokens<\/strong> (\/user\/api-tokens<\/code>)<\/li>\n
  3. Click Create New Token<\/strong><\/li>\n
  4. Select the required scopes for your use case<\/li>\n
  5. Copy the token \u2014 it is shown only once<\/strong><\/li>\n<\/ol>\n\n

    Available Scopes<\/h3>\n\n\n\n\n\n\n\n\n\n\n
    Scope<\/th>\nAccess<\/th>\n<\/tr>\n<\/thead>\n
    read:servers<\/code><\/td>\nList and view servers, databases, cron jobs, PHP versions, monitoring, sudo users<\/td>\n<\/tr>\n
    write:servers<\/code><\/td>\nReboot servers, create WordPress sites, manage sudo users<\/td>\n<\/tr>\n
    read:sites<\/code><\/td>\nList and view sites, backups, SSL, domain, git, deployment logs, SSH config<\/td>\n<\/tr>\n
    write:sites<\/code><\/td>\nTrigger backups, rescue sites, purge cache, update SSH\/SFTP config<\/td>\n<\/tr>\n
    *<\/code><\/td>\nFull access to all endpoints<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n

    Required Headers<\/h3>\n\n
    Authorization: Bearer <your-token>\nAccept: application\/json\nContent-Type: application\/json<\/code><\/pre>\n\n
    Response Format<\/h2>\n\n
    All responses follow a consistent envelope:<\/p>\n\n
    {\n  \"success\": true,\n  \"message\": \"Operation completed successfully.\",\n  \"data\": { ... }\n}<\/code><\/pre>\n\n
    For paginated lists, data<\/code> contains:<\/p>\n\n
    {\n  \"data\": [ ... ],\n  \"meta\": {\n    \"current_page\": 1,\n    \"last_page\": 5,\n    \"per_page\": 15,\n    \"total\": 72\n  }\n}<\/code><\/pre>\n\n
    HTTP Status Codes<\/h2>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Code<\/th>\nMeaning<\/th>\n<\/tr>\n<\/thead>\n
    200 OK<\/code><\/td>\nRequest successful<\/td>\n<\/tr>\n
    202 Accepted<\/code><\/td>\nAsync operation queued (e.g. reboot, backup)<\/td>\n<\/tr>\n
    400 Bad Request<\/code><\/td>\nValidation error \u2014 check errors<\/code> in response body<\/td>\n<\/tr>\n
    401 Unauthorized<\/code><\/td>\nMissing or invalid token<\/td>\n<\/tr>\n
    403 Forbidden<\/code><\/td>\nToken lacks the required scope<\/td>\n<\/tr>\n
    404 Not Found<\/code><\/td>\nResource not found or not accessible to your team<\/td>\n<\/tr>\n
    422 Unprocessable Entity<\/code><\/td>\nBusiness logic validation failure<\/td>\n<\/tr>\n
    429 Too Many Requests<\/code><\/td>\nRate limit exceeded<\/td>\n<\/tr>\n
    500 Internal Server Error<\/code><\/td>\nServer error \u2014 contact support<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n
    Rate Limits<\/h2>\n\n\n\n\n\n\n\n
    Type<\/th>\nLimit<\/th>\n<\/tr>\n<\/thead>\n
    Authenticated requests<\/td>\n60 requests \/ minute<\/strong><\/td>\n<\/tr>\n
    Unauthenticated requests<\/td>\n10 requests \/ minute<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n
    Rate limit headers are included in every response:<\/p>\n\n
    X-RateLimit-Limit: 60\nX-RateLimit-Remaining: 58\nX-RateLimit-Reset: 1710000060<\/code><\/pre>\n\n
    When you exceed the limit, the API returns 429 Too Many Requests<\/code> with a\nRetry-After<\/code> header indicating how many seconds to wait.<\/p>\n\n
    Base URLs<\/h2>\n\n
    URL<\/th>Description<\/th><\/tr><\/thead>
    https:\/\/app.xcloud.host\/api\/v1<\/code><\/td>Production<\/td><\/tr><\/tbody><\/table><\/figure>\n\n
    Authentication<\/h2>\n\n
    Scheme<\/th>Type<\/th>Details<\/th><\/tr><\/thead>
    bearerAuth<\/code><\/td>http<\/td>HTTP bearer authentication<\/td><\/tr><\/tbody><\/table><\/figure>\n\n
    API Details<\/h2>\n\n
    Version<\/td>1.0.0<\/td><\/tr>
    Contact<\/td>xCloud Support \u2014 https:\/\/xcloud.host\/support<\/a><\/td><\/tr>
    License<\/td>Proprietary<\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"
    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 \u2014 directly from your…<\/p>\n","protected":false},"author":8,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"_eb_attr":"","footnotes":""},"doc_category":[929],"glossaries":[],"doc_tag":[],"knowledge_base":[928],"class_list":["post-7758","docs","type-docs","status-publish","hentry","doc_category-hell0-boys","knowledge_base-hell0-boys-docs"],"year_month":"2026-09","word_count":327,"total_views":"2","reactions":{"happy":"0","normal":"0","sad":"0"},"author_info":{"name":"muammar-shahrear-famous","author_nicename":"muammar-shahrear-famous","author_url":"https:\/\/betterdocs.shahrear.msf.bd\/index.php\/author\/muammar-shahrear-famous\/"},"doc_category_info":[{"term_name":"hell0 boys","term_url":"https:\/\/betterdocs.shahrear.msf.bd\/index.php\/docs\/hell0-boys-docs\/hell0-boys\/"}],"doc_tag_info":[],"knowledge_base_info":[{"term_name":"hell0 boys","term_url":"https:\/\/betterdocs.shahrear.msf.bd\/index.php\/docs\/hell0-boys-docs\/","term_slug":"hell0-boys-docs"}],"knowledge_base_slug":["hell0-boys-docs"],"_links":{"self":[{"href":"https:\/\/betterdocs.shahrear.msf.bd\/index.php\/wp-json\/wp\/v2\/docs\/7758","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/betterdocs.shahrear.msf.bd\/index.php\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/betterdocs.shahrear.msf.bd\/index.php\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/betterdocs.shahrear.msf.bd\/index.php\/wp-json\/wp\/v2\/users\/8"}],"replies":[{"embeddable":true,"href":"https:\/\/betterdocs.shahrear.msf.bd\/index.php\/wp-json\/wp\/v2\/comments?post=7758"}],"version-history":[{"count":0,"href":"https:\/\/betterdocs.shahrear.msf.bd\/index.php\/wp-json\/wp\/v2\/docs\/7758\/revisions"}],"wp:attachment":[{"href":"https:\/\/betterdocs.shahrear.msf.bd\/index.php\/wp-json\/wp\/v2\/media?parent=7758"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/betterdocs.shahrear.msf.bd\/index.php\/wp-json\/wp\/v2\/doc_category?post=7758"},{"taxonomy":"glossaries","embeddable":true,"href":"https:\/\/betterdocs.shahrear.msf.bd\/index.php\/wp-json\/wp\/v2\/glossaries?post=7758"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/betterdocs.shahrear.msf.bd\/index.php\/wp-json\/wp\/v2\/doc_tag?post=7758"},{"taxonomy":"knowledge_base","embeddable":true,"href":"https:\/\/betterdocs.shahrear.msf.bd\/index.php\/wp-json\/wp\/v2\/knowledge_base?post=7758"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}