{ "info": { "name": "Orax API", "description": "Two surfaces under /api/v1:\n\n\u2022 **Public API** \u2014 OAuth2 (Laravel Passport). Register your application at /developers/apps to get a `client_id`, authorize at /oauth/authorize, exchange at /oauth/token; each route needs the matching scope. Throttle 90/min.\n\n\u2022 **Reseller API** (/api/v1/reseller) \u2014 personal API key (Authorization: Bearer rsk_\u2026 or X-Api-Key). Tag services with your own client_ref; no client data stored in Orax. Throttle 60/min.\n\nAdministrative endpoints (/api/v1/admin) are intentionally undocumented here \u2014 they require the `admin` scope and the admin role, so they are not part of the integrator-facing API.\n\nMoney is always USD minor units (usd_cents); other currencies are display-only ({usd_cents, currency, amount, display}). Money-moving POSTs accept an Idempotency-Key header.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "base_url", "value": "https://orax.uz" }, { "key": "token", "value": "" } ], "item": [ { "name": "OAuth 2.0", "description": "Getting a token: the authorization-code flow (PKCE for public clients) and the token exchange.", "item": [ { "name": "Register your application and get a client_id", "request": { "method": "GET", "description": "A page in the Orax cabinet, not an API call. Create an application, declare your redirect URIs, and receive the `client_id` the two calls below need. Public (PKCE) clients are the default; a confidential client's secret is shown once. Mark the application as a **sandbox** to try the flow safely: its tokens read normally and every write is refused with `error: sandbox_read_only`, so nothing is bought by accident while you integrate.", "header": [], "url": { "raw": "{{base_url}}/developers/apps", "host": [ "{{base_url}}" ], "path": [ "developers", "apps" ] } } }, { "name": "Start the authorization-code flow (browser redirect)", "request": { "method": "GET", "description": "Send the user here. They see the Orax consent screen and are redirected back to `redirect_uri` with `?code=\u2026`. Use PKCE (`code_challenge`, `code_challenge_method=S256`) for public clients \u2014 a mobile app or SPA must not ship a client secret.", "header": [], "url": { "raw": "{{base_url}}/oauth/authorize", "host": [ "{{base_url}}" ], "path": [ "oauth", "authorize" ] } } }, { "name": "Exchange a code (or refresh token) for an access token", "request": { "method": "POST", "description": "Access tokens live 15 days, refresh tokens 30. Scopes are granted at authorize time; a token can never gain a scope the user did not approve.", "header": [], "url": { "raw": "{{base_url}}/oauth/token", "host": [ "{{base_url}}" ], "path": [ "oauth", "token" ] } } } ] }, { "name": "Content", "description": "Published data readable without a token.", "item": [ { "name": "Blog posts (?category=guides|comparison|tips|news)", "request": { "method": "GET", "description": "Public \u2014 no token required.", "header": [], "url": { "raw": "{{base_url}}/api/v1/blog", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "blog" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Public \u2014 no token required.", "header": [], "url": { "raw": "{{base_url}}/api/v1/blog", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "blog" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"slug\": \"string\",\n \"title\": \"string\",\n \"category\": null,\n \"url\": \"string\"\n }\n ],\n \"meta\": {\n \"page\": 0,\n \"per_page\": 0,\n \"total\": 0,\n \"last_page\": 0\n }\n}" } ] }, { "name": "Blog", "request": { "method": "GET", "description": "Public \u2014 no token required.", "header": [], "url": { "raw": "{{base_url}}/api/v1/blog/{slug}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "blog", "{slug}" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Public \u2014 no token required.", "header": [], "url": { "raw": "{{base_url}}/api/v1/blog/{slug}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "blog", "{slug}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"slug\": \"string\",\n \"title\": \"string\",\n \"category\": null,\n \"url\": \"string\"\n }\n}" } ] }, { "name": "Display currencies + rate per 1 USD", "request": { "method": "GET", "description": "Public \u2014 no token required.", "header": [], "url": { "raw": "{{base_url}}/api/v1/currencies", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "currencies" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Public \u2014 no token required.", "header": [], "url": { "raw": "{{base_url}}/api/v1/currencies", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "currencies" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"code\": \"string\",\n \"symbol\": \"string\",\n \"decimals\": 0,\n \"rate\": 0\n }\n ],\n \"meta\": {\n \"page\": 0,\n \"per_page\": 0,\n \"total\": 0,\n \"last_page\": 0\n }\n}" } ] }, { "name": "Hosting glossary with short and full definitions", "request": { "method": "GET", "description": "Public \u2014 no token required.", "header": [], "url": { "raw": "{{base_url}}/api/v1/glossary", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "glossary" ] } } }, { "name": "Knowledge-base articles (?category=, ?q=, paginated)", "request": { "method": "GET", "description": "Public \u2014 no token required.", "header": [], "url": { "raw": "{{base_url}}/api/v1/kb", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Public \u2014 no token required.", "header": [], "url": { "raw": "{{base_url}}/api/v1/kb", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"slug\": \"string\",\n \"title\": \"string\",\n \"category\": null,\n \"url\": \"string\"\n }\n ],\n \"meta\": {\n \"page\": 0,\n \"per_page\": 0,\n \"total\": 0,\n \"last_page\": 0\n }\n}" } ] }, { "name": "Kb", "request": { "method": "GET", "description": "Public \u2014 no token required.", "header": [], "url": { "raw": "{{base_url}}/api/v1/kb/{slug}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "{slug}" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Public \u2014 no token required.", "header": [], "url": { "raw": "{{base_url}}/api/v1/kb/{slug}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "{slug}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"slug\": \"string\",\n \"title\": \"string\",\n \"category\": null,\n \"url\": \"string\"\n }\n}" } ] }, { "name": "Approved reviews + aggregate rating in meta", "request": { "method": "GET", "description": "Public \u2014 no token required.", "header": [], "url": { "raw": "{{base_url}}/api/v1/reviews", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reviews" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Public \u2014 no token required.", "header": [], "url": { "raw": "{{base_url}}/api/v1/reviews", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reviews" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"author\": \"string\",\n \"rating\": 0,\n \"body\": \"string\",\n \"created_at\": \"string\"\n }\n ],\n \"meta\": {\n \"page\": 0,\n \"per_page\": 0,\n \"total\": 0,\n \"last_page\": 0\n }\n}" } ] }, { "name": "Platform status: operational flag + incident history", "request": { "method": "GET", "description": "Public \u2014 no token required.", "header": [], "url": { "raw": "{{base_url}}/api/v1/status", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "status" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Public \u2014 no token required.", "header": [], "url": { "raw": "{{base_url}}/api/v1/status", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"operational\": false,\n \"incidents\": [\n {\n \"title\": \"string\",\n \"status\": \"string\",\n \"started_at\": \"string\"\n }\n ]\n }\n}" } ] }, { "name": "Site/bot templates on sale, with live demo URLs", "request": { "method": "GET", "description": "Public \u2014 no token required.", "header": [], "url": { "raw": "{{base_url}}/api/v1/templates", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "templates" ] } } } ] }, { "name": "Catalog", "description": "Products, plans and categories.", "item": [ { "name": "Catalog", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/catalog", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "catalog" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/catalog", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "catalog" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 0,\n \"slug\": \"string\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"data\": {}\n }\n ],\n \"meta\": {\n \"page\": 0,\n \"per_page\": 0,\n \"total\": 0,\n \"last_page\": 0\n }\n}" } ] }, { "name": "Categories", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/categories", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "categories" ] } } } ] }, { "name": "Account", "description": "Profile, display preferences, push devices, loyalty and referrals.", "item": [ { "name": "Current user (locale, display currency, enabled modules)", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/me", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "me" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/me", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "me" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 0,\n \"name\": \"string\",\n \"email\": \"string\",\n \"locale\": \"string\",\n \"display_currency\": \"string\",\n \"modules\": {}\n }\n}" } ] }, { "name": "Update display preferences (locale + currency)", "request": { "method": "PATCH", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/me", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "me" ] }, "body": { "mode": "raw", "raw": "{\n \"locale\": \"string\",\n \"display_currency\": \"string\",\n \"ui_mode\": \"basic\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create devices", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/me/devices", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "me", "devices" ] }, "body": { "mode": "raw", "raw": "{\n \"token\": \"string\",\n \"platform\": \"ios\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete devices", "request": { "method": "DELETE", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/me/devices", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "me", "devices" ] } } }, { "name": "Loyalty tier, next tier and days to it", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/me/loyalty", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "me", "loyalty" ] } } }, { "name": "Referral code, share link and conversion stats", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/me/referral", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "me", "referral" ] } } }, { "name": "Notifications", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 0,\n \"type\": \"string\",\n \"category\": \"string\",\n \"level\": \"string\",\n \"title\": \"string\",\n \"link\": null,\n \"read\": false\n }\n ],\n \"meta\": {\n \"page\": 0,\n \"per_page\": 0,\n \"total\": 0,\n \"last_page\": 0\n }\n}" } ] }, { "name": "Create read", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/read", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", "read" ] }, "body": { "mode": "raw", "raw": "{\n \"id\": 0\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Servers", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/servers", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "servers" ] } } } ] }, { "name": "Services", "description": "Your services, their state, renewal and tariff.", "item": [ { "name": "Services", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 0,\n \"label\": \"string\",\n \"type\": \"string\",\n \"status\": \"string\",\n \"domain\": null,\n \"client_ref\": null,\n \"expires_at\": null,\n \"panel_type\": null,\n \"billing_period\": \"string\",\n \"renewal_price\": 0,\n \"auto_renew\": false,\n \"created_at\": null\n }\n ],\n \"meta\": {\n \"page\": 0,\n \"per_page\": 0,\n \"total\": 0,\n \"last_page\": 0\n }\n}" } ] } ] }, { "name": "Service management", "description": "Everything inside one hosting account: domains, databases, mail, FTP, SSL, cron, DNS, PHP, logs, shell, SSH keys, backups.", "item": [ { "name": "Services", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 0,\n \"label\": \"string\",\n \"type\": \"string\",\n \"status\": \"string\",\n \"domain\": null,\n \"client_ref\": null,\n \"expires_at\": null,\n \"panel_type\": null,\n \"billing_period\": \"string\",\n \"renewal_price\": 0,\n \"auto_renew\": false,\n \"created_at\": null\n }\n}" } ] }, { "name": "Backups", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/backups", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "backups" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/backups", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "backups" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Create backups", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/backups", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "backups" ] } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/backups", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "backups" ] } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Delete backups", "request": { "method": "DELETE", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/backups", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "backups" ] } } }, { "name": "Cron", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/cron", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "cron" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/cron", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "cron" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Create cron", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/cron", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "cron" ] }, "body": { "mode": "raw", "raw": "{\n \"command\": \"string\",\n \"minute\": \"string\",\n \"hour\": \"string\",\n \"day\": \"string\",\n \"month\": \"string\",\n \"weekday\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/cron", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "cron" ] }, "body": { "mode": "raw", "raw": "{\n \"command\": \"string\",\n \"minute\": \"string\",\n \"hour\": \"string\",\n \"day\": \"string\",\n \"month\": \"string\",\n \"weekday\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Delete cron", "request": { "method": "DELETE", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/cron", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "cron" ] } } }, { "name": "Databases", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/databases", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "databases" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/databases", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "databases" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Create databases", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/databases", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "databases" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"db_user\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/databases", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "databases" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"db_user\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Delete databases", "request": { "method": "DELETE", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/databases", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "databases" ] } } }, { "name": "Dns", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/dns", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "dns" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/dns", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "dns" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"zones\": [\n \"string\"\n ],\n \"zone\": null,\n \"records\": [\n {}\n ]\n }\n}" } ] }, { "name": "Create dns", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/dns", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "dns" ] }, "body": { "mode": "raw", "raw": "{\n \"zone\": \"string\",\n \"type\": \"A\",\n \"name\": \"string\",\n \"value\": \"string\",\n \"priority\": 0,\n \"ttl\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/dns", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "dns" ] }, "body": { "mode": "raw", "raw": "{\n \"zone\": \"string\",\n \"type\": \"A\",\n \"name\": \"string\",\n \"value\": \"string\",\n \"priority\": 0,\n \"ttl\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Delete dns", "request": { "method": "DELETE", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/dns", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "dns" ] } } }, { "name": "Domains", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/domains", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "domains" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/domains", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "domains" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Create domains", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/domains", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "domains" ] }, "body": { "mode": "raw", "raw": "{\n \"domain\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/domains", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "domains" ] }, "body": { "mode": "raw", "raw": "{\n \"domain\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Delete domains", "request": { "method": "DELETE", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/domains", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "domains" ] } } }, { "name": "Email domains", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/email-domains", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "email-domains" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/email-domains", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "email-domains" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Create freeze", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/freeze", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "freeze" ] } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/freeze", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "freeze" ] } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Ftp", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ftp", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ftp" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ftp", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ftp" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Create ftp", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ftp", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ftp" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"password\": \"string\",\n \"home\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ftp", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ftp" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"password\": \"string\",\n \"home\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Delete ftp", "request": { "method": "DELETE", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ftp", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ftp" ] } } }, { "name": "Logs", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/logs", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "logs" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/logs", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "logs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Content", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/logs/content", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "logs", "content" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/logs/content", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "logs", "content" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"path\": \"string\",\n \"content\": \"string\"\n }\n}" } ] }, { "name": "Mailboxes", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/mailboxes", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "mailboxes" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/mailboxes", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "mailboxes" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Create mailboxes", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/mailboxes", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "mailboxes" ] }, "body": { "mode": "raw", "raw": "{\n \"domain\": \"string\",\n \"localpart\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/mailboxes", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "mailboxes" ] }, "body": { "mode": "raw", "raw": "{\n \"domain\": \"string\",\n \"localpart\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Delete mailboxes", "request": { "method": "DELETE", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/mailboxes", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "mailboxes" ] } } }, { "name": "Php", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/php", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "php" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/php", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "php" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Create php", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/php", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "php" ] }, "body": { "mode": "raw", "raw": "{\n \"domain\": \"string\",\n \"version\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/php", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "php" ] }, "body": { "mode": "raw", "raw": "{\n \"domain\": \"string\",\n \"version\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Create renew", "request": { "method": "POST", "description": "Renews exactly ONE current billing period from the wallet. NB a VPS/VDS/dedicated left unpaid is terminated ON its expiry day (no suspension grace) and always renews one period at a time.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/renew", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "renew" ] } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "Renews exactly ONE current billing period from the wallet. NB a VPS/VDS/dedicated left unpaid is terminated ON its expiry day (no suspension grace) and always renews one period at a time.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/renew", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "renew" ] } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Shell", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/shell", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "shell" ] } } }, { "name": "Create shell", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/shell", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "shell" ] }, "body": { "mode": "raw", "raw": "{\n \"command\": \"string\",\n \"cwd\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/shell", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "shell" ] }, "body": { "mode": "raw", "raw": "{\n \"command\": \"string\",\n \"cwd\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Ssh keys", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ssh-keys", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ssh-keys" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ssh-keys", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ssh-keys" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Create ssh keys", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ssh-keys", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ssh-keys" ] }, "body": { "mode": "raw", "raw": "{\n \"public_key\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ssh-keys", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ssh-keys" ] }, "body": { "mode": "raw", "raw": "{\n \"public_key\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Delete ssh keys", "request": { "method": "DELETE", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ssh-keys", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ssh-keys" ] } } }, { "name": "Ssl", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ssl", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ssl" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ssl", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ssl" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Create ssl", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ssl", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ssl" ] }, "body": { "mode": "raw", "raw": "{\n \"domain\": \"string\",\n \"type\": \"letsencrypt\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ssl", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ssl" ] }, "body": { "mode": "raw", "raw": "{\n \"domain\": \"string\",\n \"type\": \"letsencrypt\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Delete ssl", "request": { "method": "DELETE", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ssl", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ssl" ] } } }, { "name": "Create tariff", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/tariff", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "tariff" ] }, "body": { "mode": "raw", "raw": "{\n \"plan_id\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/tariff", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "tariff" ] }, "body": { "mode": "raw", "raw": "{\n \"plan_id\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Tariffs", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/tariffs", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "tariffs" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/tariffs", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "tariffs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Create unfreeze", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/unfreeze", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "unfreeze" ] } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/unfreeze", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "unfreeze" ] } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Usage", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/usage", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "usage" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/usage", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "usage" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"disk\": 0,\n \"disk_limit\": 0,\n \"disk_reliable\": false,\n \"traffic\": 0,\n \"traffic_limit\": 0\n }\n}" } ] } ] }, { "name": "Files", "description": "Read and write project files through the panel adapter.", "item": [ { "name": "Files", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/files", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "files" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/files", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "files" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"path\": \"string\",\n \"items\": [\n {\n \"name\": \"string\",\n \"type\": \"file\",\n \"size\": 0,\n \"modified_at\": null\n }\n ]\n }\n}" } ] }, { "name": "Create files", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/files", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "files" ] }, "body": { "mode": "raw", "raw": "{\n \"path\": \"string\",\n \"content\": \"string\",\n \"force\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/files", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "files" ] }, "body": { "mode": "raw", "raw": "{\n \"path\": \"string\",\n \"content\": \"string\",\n \"force\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Delete files", "request": { "method": "DELETE", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/files", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "files" ] } } }, { "name": "Create chmod", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/files/chmod", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "files", "chmod" ] }, "body": { "mode": "raw", "raw": "{\n \"path\": \"string\",\n \"mode\": \"644\",\n \"recursive\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/files/chmod", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "files", "chmod" ] }, "body": { "mode": "raw", "raw": "{\n \"path\": \"string\",\n \"mode\": \"644\",\n \"recursive\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Content", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/files/content", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "files", "content" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/files/content", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "files", "content" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"path\": \"string\",\n \"content\": \"string\"\n }\n}" } ] }, { "name": "Download", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/files/download", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "files", "download" ] } } }, { "name": "Create mkdir", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/files/mkdir", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "files", "mkdir" ] }, "body": { "mode": "raw", "raw": "{\n \"path\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/files/mkdir", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "files", "mkdir" ] }, "body": { "mode": "raw", "raw": "{\n \"path\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Create move", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/files/move", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "files", "move" ] }, "body": { "mode": "raw", "raw": "{\n \"path\": \"string\",\n \"to\": \"string\",\n \"copy\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/files/move", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "files", "move" ] }, "body": { "mode": "raw", "raw": "{\n \"path\": \"string\",\n \"to\": \"string\",\n \"copy\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Create rename", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/files/rename", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "files", "rename" ] }, "body": { "mode": "raw", "raw": "{\n \"path\": \"string\",\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/files/rename", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "files", "rename" ] }, "body": { "mode": "raw", "raw": "{\n \"path\": \"string\",\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Create undo", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/files/undo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "files", "undo" ] }, "body": { "mode": "raw", "raw": "{\n \"id\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/files/undo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "files", "undo" ] }, "body": { "mode": "raw", "raw": "{\n \"id\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Create upload", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/files/upload", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "files", "upload" ] }, "body": { "mode": "raw", "raw": "{\n \"path\": \"string\",\n \"file\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/files/upload", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "files", "upload" ] }, "body": { "mode": "raw", "raw": "{\n \"path\": \"string\",\n \"file\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] } ] }, { "name": "Add-ons", "description": "Extras attached to a service (dedicated IPs). Prices are re-quoted live from the supplier cost book.", "item": [ { "name": "Addons", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/addons", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "addons" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/addons", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "addons" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"owned\": [\n {\n \"id\": 0,\n \"key\": \"string\",\n \"name\": \"string\",\n \"quantity\": 0,\n \"price_cents\": 0,\n \"billing_period\": \"string\",\n \"status\": \"string\",\n \"auto_renew\": false,\n \"value\": null,\n \"expires_at\": null,\n \"delivered_at\": null\n }\n ],\n \"catalog\": [\n {\n \"key\": \"string\",\n \"group\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"price_cents\": 0,\n \"period\": \"string\",\n \"owned\": 0,\n \"max\": 0,\n \"can_buy\": false\n }\n ],\n \"delivery_hours\": 0\n }\n}" } ] }, { "name": "Create addons", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/addons", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "addons" ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"string\",\n \"quantity\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/addons", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "addons" ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"string\",\n \"quantity\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 0,\n \"key\": \"string\",\n \"name\": \"string\",\n \"quantity\": 0,\n \"price_cents\": 0,\n \"billing_period\": \"string\",\n \"status\": \"string\",\n \"auto_renew\": false,\n \"value\": null,\n \"expires_at\": null,\n \"delivered_at\": null\n }\n}" } ] }, { "name": "Delete addons", "request": { "method": "DELETE", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/addons/{addon}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "addons", "{addon}" ] } } } ] }, { "name": "Domains", "description": "TLD price book, WHOIS availability, your registrations and ordering.", "item": [ { "name": "Domains", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/domains", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "domains" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/domains", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "domains" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 0,\n \"domain\": \"string\",\n \"status\": \"string\",\n \"expires_at\": null,\n \"auto_renew\": false,\n \"price\": {\n \"usd_cents\": 0,\n \"currency\": \"string\",\n \"amount\": 0,\n \"display\": \"string\"\n }\n }\n ],\n \"meta\": {\n \"page\": 0,\n \"per_page\": 0,\n \"total\": 0,\n \"last_page\": 0\n }\n}" } ] }, { "name": "Order a domain \u2014 charges the wallet, send Idempotency-Key", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/domains", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "domains" ] }, "body": { "mode": "raw", "raw": "{\n \"domain\": \"string\",\n \"years\": 0,\n \"auto_renew\": false,\n \"nameservers\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/domains", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "domains" ] }, "body": { "mode": "raw", "raw": "{\n \"domain\": \"string\",\n \"years\": 0,\n \"auto_renew\": false,\n \"nameservers\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 0,\n \"domain\": \"string\",\n \"status\": \"string\",\n \"expires_at\": null,\n \"auto_renew\": false,\n \"price\": {\n \"usd_cents\": 0,\n \"currency\": \"string\",\n \"amount\": 0,\n \"display\": \"string\"\n }\n }\n}" } ] }, { "name": "WHOIS availability (true / false / null = unknown)", "request": { "method": "GET", "description": "Public \u2014 no token required.", "header": [], "url": { "raw": "{{base_url}}/api/v1/domains/check", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "domains", "check" ] } } }, { "name": "TLD price book (retail, USD cents)", "request": { "method": "GET", "description": "Public \u2014 no token required.", "header": [], "url": { "raw": "{{base_url}}/api/v1/domains/tlds", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "domains", "tlds" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Public \u2014 no token required.", "header": [], "url": { "raw": "{{base_url}}/api/v1/domains/tlds", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "domains", "tlds" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"tld\": \"uz\",\n \"register\": {\n \"usd_cents\": 0,\n \"currency\": \"string\",\n \"amount\": 0,\n \"display\": \"string\"\n },\n \"renew\": {\n \"usd_cents\": 0,\n \"currency\": \"string\",\n \"amount\": 0,\n \"display\": \"string\"\n }\n }\n ],\n \"meta\": {\n \"page\": 0,\n \"per_page\": 0,\n \"total\": 0,\n \"last_page\": 0\n }\n}" } ] }, { "name": "Domains", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/domains/{domain}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "domains", "{domain}" ] } } } ] }, { "name": "Monitors", "description": "Uptime monitors: create, inspect history, delete.", "item": [ { "name": "Monitors", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/monitors", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "monitors" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/monitors", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "monitors" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 0,\n \"name\": \"string\",\n \"url\": \"string\",\n \"interval\": 0,\n \"is_up\": null,\n \"uptime_30d\": null,\n \"last_checked_at\": null\n }\n ],\n \"meta\": {\n \"page\": 0,\n \"per_page\": 0,\n \"total\": 0,\n \"last_page\": 0\n }\n}" } ] }, { "name": "Create monitors", "request": { "method": "POST", "description": "Max **50 monitors per account** \u2014 the 51st is refused with `422 {error: \"monitor_limit\"}`. Creation is rate-limited (30/min) on top of the global throttle. A private/loopback URL is refused (`422 url_not_public`).", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/monitors", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "monitors" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"url\": \"string\",\n \"interval\": 1,\n \"notify\": false,\n \"public\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "description": "Max **50 monitors per account** \u2014 the 51st is refused with `422 {error: \"monitor_limit\"}`. Creation is rate-limited (30/min) on top of the global throttle. A private/loopback URL is refused (`422 url_not_public`).", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/monitors", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "monitors" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"url\": \"string\",\n \"interval\": 1,\n \"notify\": false,\n \"public\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 0,\n \"name\": \"string\",\n \"url\": \"string\",\n \"interval\": 0,\n \"is_up\": null,\n \"uptime_30d\": null,\n \"last_checked_at\": null\n }\n}" } ] }, { "name": "Monitors", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/monitors/{monitor}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "monitors", "{monitor}" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/monitors/{monitor}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "monitors", "{monitor}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 0,\n \"name\": \"string\",\n \"url\": \"string\",\n \"interval\": 0,\n \"is_up\": null,\n \"uptime_30d\": null,\n \"last_checked_at\": null\n }\n}" } ] }, { "name": "Update monitors", "request": { "method": "PATCH", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/monitors/{monitor}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "monitors", "{monitor}" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"interval\": 1,\n \"notify\": false,\n \"public\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete monitors", "request": { "method": "DELETE", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/monitors/{monitor}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "monitors", "{monitor}" ] } } } ] }, { "name": "Security & SLA", "description": "Security scans, per-service posture, uptime and the SLA compensation assessment.", "item": [ { "name": "Scans", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/security/scans", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "security", "scans" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/security/scans", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "security", "scans" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 0,\n \"url\": \"string\",\n \"service_id\": null,\n \"status\": \"string\",\n \"score\": 0,\n \"grade\": \"string\",\n \"findings\": [\n {\n \"key\": \"string\",\n \"severity\": \"string\",\n \"passed\": false\n }\n ],\n \"scanned_at\": \"string\"\n }\n ],\n \"meta\": {\n \"page\": 0,\n \"per_page\": 0,\n \"total\": 0,\n \"last_page\": 0\n }\n}" } ] }, { "name": "Run a security scan against a URL you own (synchronous)", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/security/scans", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "security", "scans" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"string\",\n \"service_id\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/security/scans", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "security", "scans" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"string\",\n \"service_id\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 0,\n \"url\": \"string\",\n \"service_id\": null,\n \"status\": \"string\",\n \"score\": 0,\n \"grade\": \"string\",\n \"findings\": [\n {\n \"key\": \"string\",\n \"severity\": \"string\",\n \"passed\": false\n }\n ],\n \"scanned_at\": \"string\"\n }\n}" } ] }, { "name": "Composite security score for the service", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/security", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "security" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/security", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "security" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"score\": 0,\n \"grade\": \"string\",\n \"checks\": [\n {\n \"key\": \"string\",\n \"ok\": false,\n \"weight\": 0\n }\n ]\n }\n}" } ] }, { "name": "Monthly uptime, the outages behind it and the SLA compensation assessment", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/uptime", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "uptime" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/uptime", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "uptime" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"month\": \"2026-08\",\n \"uptime\": 99.98,\n \"target\": 99.9,\n \"compensation\": {\n \"usd_cents\": 0,\n \"currency\": \"string\",\n \"amount\": 0,\n \"display\": \"string\"\n },\n \"outages\": [\n {\n \"started_at\": \"string\",\n \"ended_at\": null,\n \"minutes\": 0\n }\n ]\n }\n}" } ] } ] }, { "name": "Orders", "description": "Create, pay and cancel orders.", "item": [ { "name": "Orders", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/orders", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "orders" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/orders", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 0,\n \"number\": \"string\",\n \"status\": \"string\",\n \"total\": {\n \"usd_cents\": 0,\n \"currency\": \"string\",\n \"amount\": 0,\n \"display\": \"string\"\n },\n \"created_at\": \"string\",\n \"items\": [\n {\n \"plan_id\": 0,\n \"name\": \"string\",\n \"quantity\": 0,\n \"price\": null\n }\n ]\n }\n ],\n \"meta\": {\n \"page\": 0,\n \"per_page\": 0,\n \"total\": 0,\n \"last_page\": 0\n }\n}" } ] }, { "name": "Create an order \u2014 send Idempotency-Key", "request": { "method": "POST", "description": "A LICENCE plan (CloudLinux, ISPmanager) requires `config.license_ip` \u2014 the key is bound to that server; missing \u2192 `422 {error: \"license_ip_required\", item: N}`. See the request body for the per-item `config` keys.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/orders", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "orders" ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"plan_id\": 0,\n \"quantity\": 0,\n \"config\": {\n \"domain\": \"string\",\n \"license_ip\": \"203.0.113.10\",\n \"tech_stack\": \"string\",\n \"os\": \"string\",\n \"ip_region\": \"any\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "description": "A LICENCE plan (CloudLinux, ISPmanager) requires `config.license_ip` \u2014 the key is bound to that server; missing \u2192 `422 {error: \"license_ip_required\", item: N}`. See the request body for the per-item `config` keys.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/orders", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "orders" ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"plan_id\": 0,\n \"quantity\": 0,\n \"config\": {\n \"domain\": \"string\",\n \"license_ip\": \"203.0.113.10\",\n \"tech_stack\": \"string\",\n \"os\": \"string\",\n \"ip_region\": \"any\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 0,\n \"number\": \"string\",\n \"status\": \"string\",\n \"total\": {\n \"usd_cents\": 0,\n \"currency\": \"string\",\n \"amount\": 0,\n \"display\": \"string\"\n },\n \"created_at\": \"string\",\n \"items\": [\n {\n \"plan_id\": 0,\n \"name\": \"string\",\n \"quantity\": 0,\n \"price\": {\n \"usd_cents\": null,\n \"currency\": null,\n \"amount\": null,\n \"display\": null\n }\n }\n ]\n }\n}" } ] }, { "name": "Orders", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/orders/{order}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "orders", "{order}" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/orders/{order}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "orders", "{order}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 0,\n \"number\": \"string\",\n \"status\": \"string\",\n \"total\": {\n \"usd_cents\": 0,\n \"currency\": \"string\",\n \"amount\": 0,\n \"display\": \"string\"\n },\n \"created_at\": \"string\",\n \"items\": [\n {\n \"plan_id\": 0,\n \"name\": \"string\",\n \"quantity\": 0,\n \"price\": {\n \"usd_cents\": null,\n \"currency\": null,\n \"amount\": null,\n \"display\": null\n }\n }\n ]\n }\n}" } ] }, { "name": "Create cancel", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/orders/{order}/cancel", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "orders", "{order}", "cancel" ] } } }, { "name": "Pay an order from the wallet", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/orders/{order}/pay", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "orders", "{order}", "pay" ] } } } ] }, { "name": "Wallet", "description": "Balance, transactions, top-ups and available gateways.", "item": [ { "name": "Wallet", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/wallet", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "wallet" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/wallet", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "wallet" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"balance\": {\n \"usd_cents\": 0,\n \"currency\": \"string\",\n \"amount\": 0,\n \"display\": \"string\"\n },\n \"bonus\": {\n \"usd_cents\": 0,\n \"currency\": \"string\",\n \"amount\": 0,\n \"display\": \"string\"\n },\n \"currency\": \"string\"\n }\n}" } ] }, { "name": "Gateways", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/wallet/gateways", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "wallet", "gateways" ] } } }, { "name": "Create topups", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/wallet/topups", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "wallet", "topups" ] }, "body": { "mode": "raw", "raw": "{\n \"gateway\": \"string\",\n \"amount\": 0,\n \"currency\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "AI agent", "description": "Run the AI agent over a project, read conversations, audit and insights.", "item": [ { "name": "Settings", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/ai/settings", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "ai", "settings" ] } } }, { "name": "Update settings", "request": { "method": "PUT", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/ai/settings", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "ai", "settings" ] }, "body": { "mode": "raw", "raw": "{\n \"provider\": \"string\",\n \"model\": \"string\",\n \"api_key\": \"string\",\n \"remove_key\": false,\n \"language\": \"uz\",\n \"mode\": \"string\",\n \"billing_mode\": \"own_key\",\n \"log_watch\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Assistant", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/assistant", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "assistant" ] } } }, { "name": "Create assistant", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/assistant", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "assistant" ] }, "body": { "mode": "raw", "raw": "{\n \"message\": \"string\",\n \"history\": [\n {\n \"role\": \"user\",\n \"text\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create audit", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ai/audit", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ai", "audit" ] } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ai/audit", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ai", "audit" ] } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Conversations", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ai/conversations", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ai", "conversations" ] } } }, { "name": "Conversations", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ai/conversations/{conversation}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ai", "conversations", "{conversation}" ] } } }, { "name": "Delete conversations", "request": { "method": "DELETE", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ai/conversations/{conversation}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ai", "conversations", "{conversation}" ] } } }, { "name": "Insights", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ai/insights", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ai", "insights" ] } } }, { "name": "Create dismiss", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ai/insights/{insight}/dismiss", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ai", "insights", "{insight}", "dismiss" ] } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ai/insights/{insight}/dismiss", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ai", "insights", "{insight}", "dismiss" ] } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] }, { "name": "Create run", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ai/run", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ai", "run" ] }, "body": { "mode": "raw", "raw": "{\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"string\",\n \"tool_calls\": [\n null\n ],\n \"tool_call_id\": \"string\"\n }\n ],\n \"approvals\": {},\n \"path\": \"string\",\n \"attachments\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. A generated password, when there is one, appears here ONCE.", "originalRequest": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/services/{service}/ai/run", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "services", "{service}", "ai", "run" ] }, "body": { "mode": "raw", "raw": "{\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"string\",\n \"tool_calls\": [\n null\n ],\n \"tool_call_id\": \"string\"\n }\n ],\n \"approvals\": {},\n \"path\": \"string\",\n \"attachments\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created. A generated password, when there is one, appears here ONCE.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {}\n}" } ] } ] }, { "name": "MCP", "description": "JSON-RPC 2.0 facade so an external AI agent can manage hosting over the Model Context Protocol.", "item": [ { "name": "JSON-RPC 2.0 endpoint (tools/list, tools/call)", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/mcp", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "mcp" ] }, "body": { "mode": "raw", "raw": "{\n \"jsonrpc\": \"2.0\",\n \"id\": \"string\",\n \"method\": \"tools/list\",\n \"params\": {}\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Embeds", "description": "Public endpoints you embed in a page rather than call from a backend \u2014 no token needed.", "item": [ { "name": "Uptime badge (SVG) for one monitor", "request": { "method": "GET", "description": "Embeddable with a plain ``; no token, no CORS problem. Get the badge token from your monitor in the cabinet. An unknown token renders an \"n/a\" badge rather than a 404, so a revoked badge degrades quietly instead of breaking someone's page.", "header": [], "url": { "raw": "{{base_url}}/badge/{token}", "host": [ "{{base_url}}" ], "path": [ "badge", "{token}" ] } } }, { "name": "Live demo of a marketplace template (HTML)", "request": { "method": "GET", "description": "The template's own index.html, served sandboxed (CSP `sandbox` \u2192 opaque origin). Safe to put in an iframe. Its images are siblings at `/templates/{template}/img/{file}`.", "header": [], "url": { "raw": "{{base_url}}/templates/{template}/preview", "host": [ "{{base_url}}" ], "path": [ "templates", "{template}", "preview" ] } } }, { "name": "This document", "request": { "method": "GET", "description": "", "header": [], "url": { "raw": "{{base_url}}/api/openapi.json", "host": [ "{{base_url}}" ], "path": [ "api", "openapi.json" ] } } }, { "name": "This document, as YAML", "request": { "method": "GET", "description": "", "header": [], "url": { "raw": "{{base_url}}/api/openapi.yaml", "host": [ "{{base_url}}" ], "path": [ "api", "openapi.yaml" ] } } }, { "name": "Postman collection (v2.1) generated from this document", "request": { "method": "GET", "description": "Import and set the `base_url` and `token` collection variables.", "header": [], "url": { "raw": "{{base_url}}/api/postman.json", "host": [ "{{base_url}}" ], "path": [ "api", "postman.json" ] } } } ] }, { "name": "Reseller", "description": "Reseller API key (rsk_\u2026). Separate surface: no OAuth, no Orax-side client records.", "item": [ { "name": "Account", "request": { "method": "GET", "description": "Markup %, wallet balance, wholesale spent, and a cheap `catalog_version` change-token (poll this instead of pulling the whole catalog; refetch /catalog only when it changes).", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Markup %, wallet balance, wholesale spent, and a cheap `catalog_version` change-token (poll this instead of pulling the whole catalog; refetch /catalog only when it changes).", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"markup_percent\": 0,\n \"currency\": \"string\",\n \"wallet\": {\n \"usd_cents\": 0,\n \"currency\": \"string\",\n \"amount\": 0,\n \"display\": \"string\"\n },\n \"wholesale_spent\": {\n \"usd_cents\": 0,\n \"currency\": \"string\",\n \"amount\": 0,\n \"display\": \"string\"\n },\n \"webhook_url\": null,\n \"catalog_version\": \"string\"\n}" } ] }, { "name": "Set webhook", "request": { "method": "POST", "description": "Register (or clear, with an empty url) your webhook endpoint. Returns the signing secret ONCE \u2014 store it. Verify every delivery with hex HMAC-SHA256(raw_body, secret) === header `X-Orax-Signature` (NOT your API key).", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/webhook", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "webhook" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "description": "Register (or clear, with an empty url) your webhook endpoint. Returns the signing secret ONCE \u2014 store it. Verify every delivery with hex HMAC-SHA256(raw_body, secret) === header `X-Orax-Signature` (NOT your API key).", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/webhook", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "webhook" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"webhook_url\": null,\n \"webhook_secret\": \"string\",\n \"signature_header\": \"string\",\n \"signature_algo\": \"string\"\n}" } ] }, { "name": "Send test webhook", "request": { "method": "POST", "description": "Queues a signed `ping` event to your webhook_url so you can verify your receiver. 422 if no webhook is configured.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/webhook/test", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "webhook", "test" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "description": "Queues a signed `ping` event to your webhook_url so you can verify your receiver. 422 if no webhook is configured.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/webhook/test", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "webhook", "test" ] } }, "status": "OK", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"dispatched\": false,\n \"event\": \"string\"\n}" } ] }, { "name": "Catalog", "request": { "method": "GET", "description": "Plans with wholesale (you pay Orax) + retail (your price).", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/catalog", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "catalog" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Plans with wholesale (you pay Orax) + retail (your price).", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/catalog", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "catalog" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"currency\": \"string\",\n \"data\": [\n {\n \"plan_id\": 0,\n \"name\": \"string\",\n \"type\": \"string\",\n \"billing_period\": \"string\",\n \"wholesale\": {\n \"usd_cents\": 0,\n \"currency\": \"string\",\n \"amount\": 0,\n \"display\": \"string\"\n },\n \"retail\": {\n \"usd_cents\": 0,\n \"currency\": \"string\",\n \"amount\": 0,\n \"display\": \"string\"\n }\n }\n ]\n}" } ] }, { "name": "List services", "request": { "method": "GET", "description": "Services you provisioned, optionally filtered by client_ref.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Services you provisioned, optionally filtered by client_ref.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 0,\n \"label\": \"string\",\n \"type\": \"string\",\n \"status\": \"string\",\n \"domain\": null,\n \"client_ref\": null,\n \"expires_at\": null,\n \"panel_type\": null,\n \"billing_period\": \"string\",\n \"renewal_price\": 0,\n \"auto_renew\": false,\n \"created_at\": null\n }\n ]\n}" } ] }, { "name": "Get a service", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 0,\n \"label\": \"string\",\n \"type\": \"string\",\n \"status\": \"string\",\n \"domain\": null,\n \"client_ref\": null,\n \"expires_at\": null,\n \"panel_type\": null,\n \"billing_period\": \"string\",\n \"renewal_price\": 0,\n \"auto_renew\": false,\n \"created_at\": null\n}" } ] }, { "name": "Provision a service", "request": { "method": "POST", "description": "Charges your wallet the wholesale price and provisions the plan, tagged with client_ref. A sandbox key (rsk_test_\u2026) simulates this with no charge. Send a unique `Idempotency-Key` header to make retries safe.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/orders", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "orders" ] }, "body": { "mode": "raw", "raw": "{\n \"plan_id\": 42,\n \"domain\": \"client-site.uz\",\n \"client_ref\": \"client-1024\",\n \"auto_renew\": true,\n \"license_ip\": \"203.0.113.10\",\n \"tech_stack\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "description": "Charges your wallet the wholesale price and provisions the plan, tagged with client_ref. A sandbox key (rsk_test_\u2026) simulates this with no charge. Send a unique `Idempotency-Key` header to make retries safe.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/orders", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "orders" ] }, "body": { "mode": "raw", "raw": "{\n \"plan_id\": 42,\n \"domain\": \"client-site.uz\",\n \"client_ref\": \"client-1024\",\n \"auto_renew\": true,\n \"license_ip\": \"203.0.113.10\",\n \"tech_stack\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"order\": {\n \"number\": \"ORD-10241\",\n \"total_cents\": 250,\n \"status\": \"paid\"\n },\n \"service\": {\n \"id\": 0,\n \"label\": \"string\",\n \"type\": \"string\",\n \"status\": \"string\",\n \"domain\": null,\n \"client_ref\": null,\n \"expires_at\": null,\n \"panel_type\": null,\n \"billing_period\": \"string\",\n \"renewal_price\": 0,\n \"auto_renew\": false,\n \"created_at\": null\n }\n}" } ] }, { "name": "MCP endpoint for an AI agent", "request": { "method": "POST", "description": "JSON-RPC 2.0 over the Model Context Protocol, authenticated with your usual `rsk_\u2026` key \u2014 point an AI client at this URL and it can answer questions about your clients' services in plain language.\n\nMethods: `initialize`, `ping`, `tools/list`, `tools/call`. Tools: `reseller_account` (balance, markup, wholesale spent), `reseller_catalog` (wholesale AND suggested retail at your markup), `reseller_services` (filter by `client_ref`, status, or expiring within N days \u2014 every row says whether the renewal is already covered), `reseller_service` (one service with site reachability and days left on its certificate).\n\n**Read-only by design.** Provisioning, renewal and anything that spends your balance stay on the REST routes above, where a human wrote the integration.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/mcp", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "mcp" ] }, "body": { "mode": "raw", "raw": "{\n \"jsonrpc\": \"2.0\",\n \"id\": 1,\n \"method\": \"tools/list\",\n \"params\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "description": "JSON-RPC 2.0 over the Model Context Protocol, authenticated with your usual `rsk_\u2026` key \u2014 point an AI client at this URL and it can answer questions about your clients' services in plain language.\n\nMethods: `initialize`, `ping`, `tools/list`, `tools/call`. Tools: `reseller_account` (balance, markup, wholesale spent), `reseller_catalog` (wholesale AND suggested retail at your markup), `reseller_services` (filter by `client_ref`, status, or expiring within N days \u2014 every row says whether the renewal is already covered), `reseller_service` (one service with site reachability and days left on its certificate).\n\n**Read-only by design.** Provisioning, renewal and anything that spends your balance stay on the REST routes above, where a human wrote the integration.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/mcp", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "mcp" ] }, "body": { "mode": "raw", "raw": "{\n \"jsonrpc\": \"2.0\",\n \"id\": 1,\n \"method\": \"tools/list\",\n \"params\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"jsonrpc\": \"2.0\",\n \"id\": 1,\n \"result\": {}\n}" } ] }, { "name": "Renew a service", "request": { "method": "POST", "description": "Buys `periods` more of the service's CURRENT billing period and charges your wallet `renewal_price \u00d7 periods`. The tariff and the period never change (to move a client between periods, provision the new plan). Expiry is extended from the service's own `expires_at`, not from now, so renewing early never costs the client the time they already paid for.\n\nPrepaid: a reseller credit limit applies to provisioning, not to renewals. Refusals carry a stable `error` key \u2014 `insufficient_funds` (402), `terminated` / `not_billable` (422), `renew_in_progress` (409, a renewal for this service is already running).", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/renew", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "renew" ] }, "body": { "mode": "raw", "raw": "{\n \"periods\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "description": "Buys `periods` more of the service's CURRENT billing period and charges your wallet `renewal_price \u00d7 periods`. The tariff and the period never change (to move a client between periods, provision the new plan). Expiry is extended from the service's own `expires_at`, not from now, so renewing early never costs the client the time they already paid for.\n\nPrepaid: a reseller credit limit applies to provisioning, not to renewals. Refusals carry a stable `error` key \u2014 `insufficient_funds` (402), `terminated` / `not_billable` (422), `renew_in_progress` (409, a renewal for this service is already running).", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/renew", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "renew" ] }, "body": { "mode": "raw", "raw": "{\n \"periods\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"active\",\n \"periods\": 1,\n \"billing_period\": \"monthly\",\n \"charged\": {\n \"usd_cents\": 0,\n \"currency\": \"string\",\n \"amount\": 0,\n \"display\": \"string\"\n },\n \"expires_at\": \"2026-10-24T09:00:00+00:00\"\n}" } ] }, { "name": "Turn auto-renewal on or off", "request": { "method": "POST", "description": "With auto-renewal ON, Orax charges your wallet by itself as expiry approaches and you never call `renew`. With it OFF (the default for everything provisioned so far), renewal is entirely your move \u2014 a service left unrenewed expires, is suspended, and is terminated 14 days later.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/auto-renew", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "auto-renew" ] }, "body": { "mode": "raw", "raw": "{\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "description": "With auto-renewal ON, Orax charges your wallet by itself as expiry approaches and you never call `renew`. With it OFF (the default for everything provisioned so far), renewal is entirely your move \u2014 a service left unrenewed expires, is suspended, and is terminated 14 days later.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/auto-renew", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "auto-renew" ] }, "body": { "mode": "raw", "raw": "{\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"auto_renew\": true\n}" } ] }, { "name": "Open a one-time panel login link", "request": { "method": "POST", "description": "Mints a short-lived, single-use SSO URL into the service's control panel. Your end-client has no Orax account (the service carries only your `client_ref`), so this is how you hand them the panel from your own cabinet \u2014 302 the browser to `url`, no password exchange. `expires_at` is advisory: open it promptly. Refusals: `service_not_live` (422), `sso_unsupported` (422, the server's panel can't mint sessions), `panel_error` (422/502).", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/panel-session", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "panel-session" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "description": "Mints a short-lived, single-use SSO URL into the service's control panel. Your end-client has no Orax account (the service carries only your `client_ref`), so this is how you hand them the panel from your own cabinet \u2014 302 the browser to `url`, no password exchange. `expires_at` is advisory: open it promptly. Refusals: `service_not_live` (422), `sso_unsupported` (422, the server's panel can't mint sessions), `panel_error` (422/502).", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/panel-session", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "panel-session" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"url\": \"https://c4300.coresuz.ru:1500/ispmgr?func=auth&auth=\u2026\",\n \"expires_at\": \"2026-08-24T09:05:00+00:00\"\n}" } ] }, { "name": "List switchable tariffs", "request": { "method": "GET", "description": "The tariffs this service can switch to \u2014 any plan of the same product type, any billing period, price > 0 \u2014 priced in your currency (`?currency=`). `is_period_change` marks a plan on a different billing period (no charge/refund \u2014 remaining value is converted to time); `is_upgrade` marks a same-period upgrade (prorated charge).", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/tariffs", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "tariffs" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "The tariffs this service can switch to \u2014 any plan of the same product type, any billing period, price > 0 \u2014 priced in your currency (`?currency=`). `is_period_change` marks a plan on a different billing period (no charge/refund \u2014 remaining value is converted to time); `is_upgrade` marks a same-period upgrade (prorated charge).", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/tariffs", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "tariffs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"currency\": \"USD\",\n \"data\": [\n {\n \"plan_id\": 57,\n \"name\": \"Business\",\n \"period\": \"monthly\",\n \"is_period_change\": false,\n \"is_upgrade\": true,\n \"price\": {\n \"usd_cents\": 0,\n \"currency\": \"string\",\n \"amount\": 0,\n \"display\": \"string\"\n }\n }\n ]\n}" } ] }, { "name": "Change tariff", "request": { "method": "POST", "description": "Switches the service to `plan_id` and charges your wallet. Panel-first: if the account currently uses more than the new tariff allows, the change is REJECTED before any charge. On the same billing period the difference is prorated (upgrade charge / downgrade refund, expiry kept); on a different period there is no charge \u2014 remaining prepaid value is converted to time and `expires_at` is recomputed. Only an ACTIVE service qualifies. Refusals carry a stable `error`: `service_not_active` / `invalid_tariff` / `panel_rejected` (422), `insufficient_funds` (402). Send an `Idempotency-Key` header to make retries safe.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/tariff", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "tariff" ] }, "body": { "mode": "raw", "raw": "{\n \"plan_id\": 57\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "description": "Switches the service to `plan_id` and charges your wallet. Panel-first: if the account currently uses more than the new tariff allows, the change is REJECTED before any charge. On the same billing period the difference is prorated (upgrade charge / downgrade refund, expiry kept); on a different period there is no charge \u2014 remaining prepaid value is converted to time and `expires_at` is recomputed. Only an ACTIVE service qualifies. Refusals carry a stable `error`: `service_not_active` / `invalid_tariff` / `panel_rejected` (422), `insufficient_funds` (402). Send an `Idempotency-Key` header to make retries safe.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/tariff", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "tariff" ] }, "body": { "mode": "raw", "raw": "{\n \"plan_id\": 57\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"active\",\n \"plan_id\": 57,\n \"billing_period\": \"monthly\",\n \"charged\": {\n \"usd_cents\": 0,\n \"currency\": \"string\",\n \"amount\": 0,\n \"display\": \"string\"\n },\n \"refunded\": {\n \"usd_cents\": 0,\n \"currency\": \"string\",\n \"amount\": 0,\n \"display\": \"string\"\n },\n \"renewal_price\": {\n \"usd_cents\": 0,\n \"currency\": \"string\",\n \"amount\": 0,\n \"display\": \"string\"\n },\n \"expires_at\": \"2026-09-24T09:00:00+00:00\"\n}" } ] }, { "name": "Suspend", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/suspend", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "suspend" ] } } }, { "name": "Unsuspend", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/unsuspend", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "unsuspend" ] } } }, { "name": "Terminate", "request": { "method": "POST", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/terminate", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "terminate" ] } } }, { "name": "Buy a marketplace template at wholesale onto one of your services", "request": { "method": "POST", "description": "Charges the reseller the author base price (no markup); the author earns base \u2212 commission. The response carries `suggested_retail` (base + your markup %) as a billing hint only \u2014 Orax never bills your client.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/templates/{template}/purchase", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "templates", "{template}", "purchase" ] }, "body": { "mode": "raw", "raw": "{\n \"service_id\": 0\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Disk / traffic / DB / mailbox usage", "request": { "method": "GET", "description": "Disk (`disk`/`disk_limit`) and traffic are in MEGABYTES; databases/mailboxes are counts. The panel `raw` block also carries the plan limits (limit_db, limit_cl_cpu, limit_cl_pmem, \u2026).", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/usage", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "usage" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Disk (`disk`/`disk_limit`) and traffic are in MEGABYTES; databases/mailboxes are counts. The panel `raw` block also carries the plan limits (limit_db, limit_cl_cpu, limit_cl_pmem, \u2026).", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/usage", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "usage" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Web domains", "request": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/domains", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "domains" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/domains", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "domains" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Add a domain", "request": { "method": "POST", "description": "Runs on the real panel. The service must belong to your reseller account. A sandbox key (rsk_test_\u2026) simulates the write.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/domains", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "domains" ] }, "body": { "mode": "raw", "raw": "{\n \"domain\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove a domain", "request": { "method": "DELETE", "description": "Runs on the real panel. The service must belong to your reseller account. A sandbox key (rsk_test_\u2026) simulates the write.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/domains", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "domains" ] }, "body": { "mode": "raw", "raw": "{\n \"domain\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "MySQL databases", "request": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/databases", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "databases" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/databases", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "databases" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Create a database", "request": { "method": "POST", "description": "Runs on the real panel. The service must belong to your reseller account. A sandbox key (rsk_test_\u2026) simulates the write.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/databases", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "databases" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"db_user\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Drop a database", "request": { "method": "DELETE", "description": "Runs on the real panel. The service must belong to your reseller account. A sandbox key (rsk_test_\u2026) simulates the write.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/databases", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "databases" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "FTP accounts", "request": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/ftp", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "ftp" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/ftp", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "ftp" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Create an FTP account", "request": { "method": "POST", "description": "Runs on the real panel. The service must belong to your reseller account. A sandbox key (rsk_test_\u2026) simulates the write.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/ftp", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "ftp" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"password\": \"string\",\n \"home\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete an FTP account", "request": { "method": "DELETE", "description": "Runs on the real panel. The service must belong to your reseller account. A sandbox key (rsk_test_\u2026) simulates the write.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/ftp", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "ftp" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mail domains", "request": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/email-domains", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "email-domains" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/email-domains", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "email-domains" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Mailboxes", "request": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/mailboxes", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "mailboxes" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/mailboxes", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "mailboxes" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Create a mailbox", "request": { "method": "POST", "description": "Runs on the real panel. The service must belong to your reseller account. A sandbox key (rsk_test_\u2026) simulates the write.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/mailboxes", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "mailboxes" ] }, "body": { "mode": "raw", "raw": "{\n \"domain\": \"string\",\n \"localpart\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a mailbox", "request": { "method": "DELETE", "description": "Runs on the real panel. The service must belong to your reseller account. A sandbox key (rsk_test_\u2026) simulates the write.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/mailboxes", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "mailboxes" ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "SSL certificates", "request": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/ssl", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "ssl" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/ssl", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "ssl" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Issue / attach an SSL certificate", "request": { "method": "POST", "description": "Runs on the real panel. The service must belong to your reseller account. A sandbox key (rsk_test_\u2026) simulates the write.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/ssl", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "ssl" ] }, "body": { "mode": "raw", "raw": "{\n \"domain\": \"string\",\n \"type\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove an SSL certificate", "request": { "method": "DELETE", "description": "Runs on the real panel. The service must belong to your reseller account. A sandbox key (rsk_test_\u2026) simulates the write.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/ssl", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "ssl" ] }, "body": { "mode": "raw", "raw": "{\n \"domain\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "DNS records", "request": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/dns", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "dns" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/dns", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "dns" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Add a DNS record", "request": { "method": "POST", "description": "Runs on the real panel. The service must belong to your reseller account. A sandbox key (rsk_test_\u2026) simulates the write.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/dns", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "dns" ] }, "body": { "mode": "raw", "raw": "{\n \"zone\": \"string\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"value\": \"string\",\n \"priority\": 0,\n \"ttl\": 0\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a DNS record", "request": { "method": "DELETE", "description": "Runs on the real panel. The service must belong to your reseller account. A sandbox key (rsk_test_\u2026) simulates the write.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/dns", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "dns" ] }, "body": { "mode": "raw", "raw": "{\n \"zone\": \"string\",\n \"name\": \"string\",\n \"type\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cron jobs", "request": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/cron", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "cron" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/cron", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "cron" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Add a cron job", "request": { "method": "POST", "description": "Runs on the real panel. The service must belong to your reseller account. A sandbox key (rsk_test_\u2026) simulates the write.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/cron", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "cron" ] }, "body": { "mode": "raw", "raw": "{\n \"command\": \"string\",\n \"minute\": \"string\",\n \"hour\": \"string\",\n \"day\": \"string\",\n \"month\": \"string\",\n \"weekday\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a cron job", "request": { "method": "DELETE", "description": "Runs on the real panel. The service must belong to your reseller account. A sandbox key (rsk_test_\u2026) simulates the write.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/cron", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "cron" ] }, "body": { "mode": "raw", "raw": "{\n \"command\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "PHP versions", "request": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/php", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "php" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/php", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "php" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Set the PHP version for a domain", "request": { "method": "POST", "description": "Runs on the real panel. The service must belong to your reseller account. A sandbox key (rsk_test_\u2026) simulates the write.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/php", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "php" ] }, "body": { "mode": "raw", "raw": "{\n \"domain\": \"string\",\n \"version\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Log files", "request": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/logs", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "logs" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/logs", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "logs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Backups", "request": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/backups", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "backups" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "Read-only. The service must belong to your reseller account.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/backups", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "backups" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Create a backup", "request": { "method": "POST", "description": "Runs on the real panel. The service must belong to your reseller account. A sandbox key (rsk_test_\u2026) simulates the write.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/backups", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "backups" ] } } }, { "name": "Delete a backup", "request": { "method": "DELETE", "description": "Runs on the real panel. The service must belong to your reseller account. A sandbox key (rsk_test_\u2026) simulates the write.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/backups", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "backups" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List files", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/files", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "files" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/files", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "files" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Write a file", "request": { "method": "POST", "description": "Sandbox-simulated for rsk_test_ keys. The service must belong to you.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/files", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "files" ] }, "body": { "mode": "raw", "raw": "{\n \"path\": \"string\",\n \"content\": \"string\",\n \"force\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a file", "request": { "method": "DELETE", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/files", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "files" ] }, "body": { "mode": "raw", "raw": "{\n \"path\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Read a file", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/files/content", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "files", "content" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/files/content", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "files", "content" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Undo the last file change", "request": { "method": "POST", "description": "Restores the pre-change snapshot. Sandbox-simulated for rsk_test_ keys.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/files/undo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "files", "undo" ] } } }, { "name": "Read a log file", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/logs/content", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "logs", "content" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/logs/content", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "logs", "content" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Security posture \u2014 score + signals", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/security", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "security" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/security", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "security" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Uptime + SLA evidence (outage ledger)", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/uptime", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "uptime" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/uptime", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "uptime" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Add-ons on this service", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/addons", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "addons" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/addons", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "addons" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Buy an add-on", "request": { "method": "POST", "description": "The service must belong to your reseller account. Sandbox-simulated for rsk_test_ keys.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/addons", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "addons" ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"string\",\n \"quantity\": 0\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "SSH keys", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/ssh-keys", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "ssh-keys" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/ssh-keys", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "ssh-keys" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Add an SSH key", "request": { "method": "POST", "description": "The service must belong to your reseller account. Sandbox-simulated for rsk_test_ keys.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/ssh-keys", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "ssh-keys" ] }, "body": { "mode": "raw", "raw": "{\n \"public_key\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove an SSH key", "request": { "method": "DELETE", "description": "The service must belong to your reseller account. Sandbox-simulated for rsk_test_ keys.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/ssh-keys", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "ssh-keys" ] }, "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Shell availability", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/shell", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "shell" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/shell", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "shell" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Run a shell command", "request": { "method": "POST", "description": "The service must belong to your reseller account. Sandbox-simulated for rsk_test_ keys.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/shell", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "shell" ] }, "body": { "mode": "raw", "raw": "{\n \"command\": \"string\",\n \"cwd\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Download a file \u2014 raw bytes, binary-safe", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/files/download", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "files", "download" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/files/download", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "files", "download" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Your uptime monitors", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/monitors", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "monitors" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/monitors", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "monitors" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Purchasable marketplace templates (wholesale + suggested_retail)", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/templates", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "templates" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/templates", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "templates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Wallet ledger \u2014 newest first, \u2264200: date, type, kind, service_id, amount, balance_after", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/transactions", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "transactions" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/transactions", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "transactions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "One monitor", "request": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/monitors/{monitor}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "monitors", "{monitor}" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "description": "", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/monitors/{monitor}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "monitors", "{monitor}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] }, { "name": "Freeze \u2014 a paid seasonal pause", "request": { "method": "POST", "description": "Sandbox-simulated for rsk_test_ keys. Idempotency-Key honoured.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/freeze", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "freeze" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "description": "Sandbox-simulated for rsk_test_ keys. Idempotency-Key honoured.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/freeze", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "freeze" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\"\n}" } ] }, { "name": "Unfreeze", "request": { "method": "POST", "description": "Sandbox-simulated for rsk_test_ keys. Idempotency-Key honoured.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/unfreeze", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "unfreeze" ] } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "description": "Sandbox-simulated for rsk_test_ keys. Idempotency-Key honoured.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/unfreeze", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "unfreeze" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\"\n}" } ] }, { "name": "Cancel an add-on (runs to expiry, no refund)", "request": { "method": "DELETE", "description": "The service must belong to your reseller account. Sandbox-simulated for rsk_test_ keys.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/addons/{addon}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "addons", "{addon}" ] } } }, { "name": "Rename a file", "request": { "method": "POST", "description": "The service must belong to your reseller account. Sandbox-simulated for rsk_test_ keys.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/files/rename", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "files", "rename" ] }, "body": { "mode": "raw", "raw": "{\n \"path\": \"string\",\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Move / copy a file", "request": { "method": "POST", "description": "The service must belong to your reseller account. Sandbox-simulated for rsk_test_ keys.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/files/move", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "files", "move" ] }, "body": { "mode": "raw", "raw": "{\n \"path\": \"string\",\n \"to\": \"string\",\n \"copy\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create a folder", "request": { "method": "POST", "description": "The service must belong to your reseller account. Sandbox-simulated for rsk_test_ keys.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/files/mkdir", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "files", "mkdir" ] }, "body": { "mode": "raw", "raw": "{\n \"path\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change permissions", "request": { "method": "POST", "description": "The service must belong to your reseller account. Sandbox-simulated for rsk_test_ keys.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/files/chmod", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "files", "chmod" ] }, "body": { "mode": "raw", "raw": "{\n \"path\": \"string\",\n \"mode\": \"644\",\n \"recursive\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Upload a file (text only; binary \u2192 FTP)", "request": { "method": "POST", "description": "The service must belong to your reseller account. Sandbox-simulated for rsk_test_ keys.", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reseller/services/{service}/files/upload", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reseller", "services", "{service}", "files", "upload" ] }, "body": { "mode": "raw", "raw": "{\n \"path\": \"string\",\n \"file\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }