{ "components": { "schemas": { "CatalogPlan": { "additionalProperties": false, "properties": { "name": { "example": "Starter", "type": "string" }, "orderLink": { "example": "https://example.com/order", "type": "string" }, "price": { "example": 9.99, "type": "number" }, "ram": { "example": 4, "type": "number" }, "soldOut": { "example": false, "type": "boolean" }, "storage": { "example": 50, "type": "integer" } }, "required": [ "ram", "storage", "price", "name", "orderLink", "soldOut" ], "type": "object" }, "ContentArticle": { "additionalProperties": false, "properties": { "author": { "example": "Hamza", "type": "string" }, "body": { "example": "Markdown body", "type": "string" }, "category": { "example": "Company News", "type": "string" }, "cover": { "example": "/media/company/HEO_Systems_Banner.jpg", "type": "string" }, "date": { "example": "2025-12-10", "type": "string" }, "description": { "example": "We are excited to announce the launch...", "type": "string" }, "html": { "example": "\u003cp\u003eRendered HTML\u003c/p\u003e", "type": "string" }, "path": { "example": "/blog/company-news/welcome-to-heo-systems-blog", "type": "string" }, "readTime": { "example": "1 min read", "type": "string" }, "title": { "example": "Welcome to the New HEO Systems Blog", "type": "string" } }, "required": [ "title", "description", "path", "category", "date", "author", "readTime", "cover", "body", "html" ], "type": "object" }, "ContentItem": { "additionalProperties": false, "properties": { "author": { "example": "Hamza", "type": "string" }, "category": { "example": "Company News", "type": "string" }, "cover": { "example": "/media/company/HEO_Systems_Banner.jpg", "type": "string" }, "date": { "example": "2025-12-10", "type": "string" }, "description": { "example": "We are excited to announce the launch...", "type": "string" }, "path": { "example": "/blog/company-news/welcome-to-heo-systems-blog", "type": "string" }, "readTime": { "example": "1 min read", "type": "string" }, "title": { "example": "Welcome to the New HEO Systems Blog", "type": "string" } }, "required": [ "title", "description", "path", "category", "date", "author", "readTime", "cover" ], "type": "object" }, "DomainPricing": { "additionalProperties": false, "properties": { "currency": { "example": "EUR", "type": "string" }, "period": { "example": "year", "type": "string" }, "register": { "example": 12.99, "type": "number" }, "renew": { "example": 12.99, "type": "number" }, "term": { "example": 1, "type": "integer" }, "transfer": { "example": 12.99, "type": "number" } }, "required": [ "currency", "term", "period", "register", "renew", "transfer" ], "type": "object" }, "DomainSearchResponse": { "additionalProperties": false, "properties": { "available": { "example": true, "type": "boolean" }, "domain": { "example": "example.com", "type": "string" }, "order_url": { "example": "https://clients.heo-systems.com/order?domain=example.com", "type": "string" }, "pricing": { "$ref": "#/components/schemas/DomainPricing" }, "success": { "example": true, "type": "boolean" }, "tld": { "example": ".com", "type": "string" } }, "required": [ "success", "domain", "tld", "available", "pricing" ], "type": "object" }, "DomainTLD": { "additionalProperties": false, "properties": { "order_url": { "example": "https://clients.heo-systems.com/order?tld=com", "type": "string" }, "pricing": { "$ref": "#/components/schemas/DomainPricing" }, "tld": { "example": ".com", "type": "string" } }, "required": [ "tld", "pricing" ], "type": "object" }, "DomainTLDListResponse": { "additionalProperties": false, "properties": { "success": { "example": true, "type": "boolean" }, "tlds": { "items": { "$ref": "#/components/schemas/DomainTLD" }, "type": "array" } }, "required": [ "success", "tlds" ], "type": "object" }, "ErrorResponse": { "additionalProperties": false, "properties": { "error": { "example": "insufficient_scope", "type": "string" }, "message": { "example": "This API key only has read scope", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "required": [ "success", "error", "message" ], "type": "object" }, "ForceRequest": { "additionalProperties": false, "properties": { "force": { "example": true, "type": "boolean" } }, "required": [ "force" ], "type": "object" }, "GameCatalog": { "additionalProperties": false, "properties": { "name": { "example": "Minecraft", "type": "string" }, "plans": { "items": { "$ref": "#/components/schemas/CatalogPlan" }, "type": "array" }, "soldOut": { "example": false, "type": "boolean" }, "soldOutMessage": { "example": "", "type": "string" } }, "required": [ "name", "soldOut", "soldOutMessage", "plans" ], "type": "object" }, "GameConsoleCommandRequest": { "additionalProperties": false, "properties": { "command": { "example": "say hello", "type": "string" } }, "required": [ "command" ], "type": "object" }, "GameConsoleCommandResponse": { "additionalProperties": false, "properties": { "server_id": { "example": "srv_123", "type": "string" }, "status": { "example": "sent", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "required": [ "success", "server_id", "status" ], "type": "object" }, "GameConsoleWebsocketResponse": { "additionalProperties": false, "properties": { "server_id": { "example": "srv_123", "type": "string" }, "success": { "example": true, "type": "boolean" }, "websocket": { "additionalProperties": false, "properties": { "socket_url": { "example": "wss://console.example.com/api/servers/srv_123/ws", "type": "string" }, "token": { "example": "websocket-token", "type": "string" } }, "required": [ "socket_url", "token" ], "type": "object" } }, "required": [ "success", "server_id", "websocket" ], "type": "object" }, "GameLatestLogResponse": { "additionalProperties": false, "properties": { "content": { "example": "[12:00:00] Server started", "type": "string" }, "empty": { "example": false, "type": "boolean" }, "server_id": { "example": "srv_123", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "required": [ "success", "server_id", "empty", "content" ], "type": "object" }, "GamePowerResponse": { "additionalProperties": false, "properties": { "action": { "enum": [ "start", "stop", "restart", "kill" ], "example": "start", "type": "string" }, "message": { "example": "Start action sent", "type": "string" }, "server_id": { "example": "srv_123", "type": "string" }, "status": { "example": "requested", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "required": [ "success", "action", "server_id", "status", "message" ], "type": "object" }, "HealthResponse": { "additionalProperties": false, "properties": { "status": { "example": "healthy", "type": "string" }, "version": { "example": "dev-rolling", "type": "string" } }, "required": [ "status", "version" ], "type": "object" }, "InfoResponse": { "additionalProperties": false, "properties": { "version": { "example": "dev-rolling", "type": "string" } }, "required": [ "version" ], "type": "object" }, "KBFeedbackRequest": { "additionalProperties": false, "properties": { "helpful": { "example": true, "type": "boolean" }, "slug": { "example": "/knowledgebase/getting-started/how-to-access-your-new-server", "type": "string" }, "title": { "example": "Getting started", "type": "string" } }, "required": [ "helpful" ], "type": "object" }, "PlanCatalogResponse": { "additionalProperties": false, "properties": { "games": { "additionalProperties": { "$ref": "#/components/schemas/GameCatalog" }, "type": "object" }, "services": { "additionalProperties": { "$ref": "#/components/schemas/ServiceCatalog" }, "type": "object" } }, "required": [ "services", "games" ], "type": "object" }, "ServiceCatalog": { "additionalProperties": false, "properties": { "name": { "example": "Web Hosting", "type": "string" }, "plans": { "items": { "$ref": "#/components/schemas/CatalogPlan" }, "type": "array" }, "soldOut": { "example": false, "type": "boolean" }, "soldOutMessage": { "example": "", "type": "string" } }, "required": [ "name", "soldOut", "soldOutMessage", "plans" ], "type": "object" }, "StatusErrorResponse": { "additionalProperties": false, "properties": { "status": { "example": "error", "type": "string" } }, "required": [ "status" ], "type": "object" }, "StatusResponse": { "additionalProperties": false, "properties": { "disrupted": { "items": { "type": "string" }, "type": "array" }, "maintenance": { "items": { "type": "string" }, "type": "array" }, "status": { "enum": [ "up", "maintenance", "disrupted" ], "example": "up", "type": "string" } }, "required": [ "status" ], "type": "object" }, "SuccessResponse": { "additionalProperties": false, "properties": { "success": { "example": true, "type": "boolean" } }, "required": [ "success" ], "type": "object" }, "VPSPowerResponse": { "additionalProperties": false, "properties": { "action": { "enum": [ "start", "stop", "reset" ], "example": "start", "type": "string" }, "message": { "example": "Start action sent", "type": "string" }, "status": { "example": "requested", "type": "string" }, "success": { "example": true, "type": "boolean" }, "vps_id": { "example": "vps_123", "type": "string" } }, "required": [ "success", "action", "vps_id", "status", "message" ], "type": "object" } }, "securitySchemes": { "apiKeyAuth": { "bearerFormat": "API_KEY", "description": "Customer API key for scoped hosting control endpoints. Send as `Authorization: Bearer `.", "scheme": "bearer", "type": "http" } } }, "info": { "description": "Public API for HEO Systems status, content, product catalog, feedback, and customer-scoped hosting controls.", "title": "HEO Systems API", "version": "1.0.0" }, "openapi": "3.1.0", "paths": { "/health": { "get": { "description": "Returns a lightweight process health response.", "operationId": "getHealth", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" } } }, "description": "API process is healthy." }, "405": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Method is not allowed." } }, "summary": "Get health status", "tags": [ "Monitoring" ] } }, "/v1/blog/article": { "get": { "description": "Returns one published blog article by path.", "operationId": "getBlogArticle", "parameters": [ { "description": "Published article path.", "in": "query", "name": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentArticle" } } }, "description": "Blog article." }, "400": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "The path query parameter is missing." }, "404": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Article was not found." }, "405": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Method is not allowed." }, "500": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Content could not be loaded." } }, "summary": "Get blog article", "tags": [ "Content" ] } }, "/v1/blog/list": { "get": { "description": "Returns published blog article metadata.", "operationId": "listBlogArticles", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ContentItem" }, "type": "array" } } }, "description": "Blog article metadata list." }, "405": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Method is not allowed." }, "500": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Content could not be loaded." } }, "summary": "List blog articles", "tags": [ "Content" ] } }, "/v1/domains/search": { "get": { "description": "Returns availability and customer-facing EUR pricing for one full domain.", "operationId": "searchDomain", "parameters": [ { "description": "Full domain name, for example example.com.", "in": "query", "name": "domain", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainSearchResponse" } } }, "description": "Domain availability and pricing." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Domain query is invalid." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "TLD is not available in the public catalog." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Method is not allowed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Domain pricing is unavailable." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Domain data could not be loaded." } }, "summary": "Search domain availability", "tags": [ "Domains" ] } }, "/v1/domains/tlds": { "get": { "description": "Returns active TLDs with 1-year EUR register, renew, and transfer pricing.", "operationId": "listDomainTLDs", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainTLDListResponse" } } }, "description": "Active TLD pricing list." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Method is not allowed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Domain pricing is unavailable." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "TLD data could not be loaded." } }, "summary": "List domain TLD prices", "tags": [ "Domains" ] } }, "/v1/heo-status.js": { "get": { "description": "Returns the embeddable browser status widget script.", "operationId": "getStatusWidgetScript", "responses": { "200": { "content": { "application/javascript": { "schema": { "type": "string" } } }, "description": "Status widget JavaScript." } }, "summary": "Get status widget script", "tags": [ "Embed" ] } }, "/v1/hosting/cloud/vps-custom/{id}/reset": { "post": { "description": "Sends a reset action to a customer-scoped VPS. The request must include force=true.", "operationId": "resetVPSCustom", "parameters": [ { "description": "VPS ID.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Required confirmation flag. Set to true.", "in": "query", "name": "force", "required": true, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForceRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VPSPowerResponse" } } }, "description": "Power action was requested." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Confirmation is required or request validation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is missing or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API key lacks access or scope." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Endpoint or action was not found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Method is not allowed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API could not load the scoped server." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The power action could not be completed." } }, "security": [ { "apiKeyAuth": [] } ], "summary": "Reset VPS", "tags": [ "Hosting" ] } }, "/v1/hosting/cloud/vps-custom/{id}/start": { "post": { "description": "Sends a start action to a customer-scoped VPS.", "operationId": "startVPSCustom", "parameters": [ { "description": "VPS ID.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VPSPowerResponse" } } }, "description": "Power action was requested." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Confirmation is required or request validation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is missing or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API key lacks access or scope." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Endpoint or action was not found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Method is not allowed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API could not load the scoped server." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The power action could not be completed." } }, "security": [ { "apiKeyAuth": [] } ], "summary": "Start VPS", "tags": [ "Hosting" ] } }, "/v1/hosting/cloud/vps-custom/{id}/stop": { "post": { "description": "Sends a stop action to a customer-scoped VPS.", "operationId": "stopVPSCustom", "parameters": [ { "description": "VPS ID.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VPSPowerResponse" } } }, "description": "Power action was requested." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Confirmation is required or request validation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is missing or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API key lacks access or scope." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Endpoint or action was not found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Method is not allowed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API could not load the scoped server." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The power action could not be completed." } }, "security": [ { "apiKeyAuth": [] } ], "summary": "Stop VPS", "tags": [ "Hosting" ] } }, "/v1/hosting/game/console/{server_id}/command": { "post": { "description": "Sends a console command to a customer-scoped game server.", "operationId": "sendGameConsoleCommand", "parameters": [ { "description": "Game server ID.", "in": "path", "name": "server_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GameConsoleCommandRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GameConsoleCommandResponse" } } }, "description": "Command was sent." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request JSON or command is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is missing or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API key lacks access or scope." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Method is not allowed." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The console command could not be completed." } }, "security": [ { "apiKeyAuth": [] } ], "summary": "Send game console command", "tags": [ "Hosting" ] } }, "/v1/hosting/game/console/{server_id}/websocket": { "get": { "description": "Returns websocket connection details for a customer-scoped game server.", "operationId": "getGameConsoleWebsocket", "parameters": [ { "description": "Game server ID.", "in": "path", "name": "server_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GameConsoleWebsocketResponse" } } }, "description": "Websocket connection details." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is missing or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API key lacks access or scope." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Method is not allowed." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The websocket connection could not be prepared." } }, "security": [ { "apiKeyAuth": [] } ], "summary": "Open game console websocket", "tags": [ "Hosting" ] } }, "/v1/hosting/game/logs/{server_id}/latest": { "get": { "description": "Returns the latest game log content for a customer-scoped game server.", "operationId": "getLatestGameLog", "parameters": [ { "description": "Game server ID.", "in": "path", "name": "server_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GameLatestLogResponse" } } }, "description": "Latest game log." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is missing or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API key lacks access or scope." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Method is not allowed." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The latest game log could not be loaded." } }, "security": [ { "apiKeyAuth": [] } ], "summary": "Get latest game log", "tags": [ "Hosting" ] } }, "/v1/hosting/game/power/{server_id}/kill": { "post": { "description": "Sends a kill action to a customer-scoped game server. The request must include force=true.", "operationId": "killGameServer", "parameters": [ { "description": "Game server ID.", "in": "path", "name": "server_id", "required": true, "schema": { "type": "string" } }, { "description": "Required confirmation flag. Set to true.", "in": "query", "name": "force", "required": true, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForceRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GamePowerResponse" } } }, "description": "Power action was requested." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Confirmation is required or request validation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is missing or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API key lacks access or scope." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Endpoint or action was not found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Method is not allowed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API could not load the scoped server." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The power action could not be completed." } }, "security": [ { "apiKeyAuth": [] } ], "summary": "Kill game server", "tags": [ "Hosting" ] } }, "/v1/hosting/game/power/{server_id}/restart": { "post": { "description": "Sends a restart action to a customer-scoped game server.", "operationId": "restartGameServer", "parameters": [ { "description": "Game server ID.", "in": "path", "name": "server_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GamePowerResponse" } } }, "description": "Power action was requested." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Confirmation is required or request validation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is missing or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API key lacks access or scope." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Endpoint or action was not found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Method is not allowed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API could not load the scoped server." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The power action could not be completed." } }, "security": [ { "apiKeyAuth": [] } ], "summary": "Restart game server", "tags": [ "Hosting" ] } }, "/v1/hosting/game/power/{server_id}/start": { "post": { "description": "Sends a start action to a customer-scoped game server.", "operationId": "startGameServer", "parameters": [ { "description": "Game server ID.", "in": "path", "name": "server_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GamePowerResponse" } } }, "description": "Power action was requested." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Confirmation is required or request validation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is missing or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API key lacks access or scope." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Endpoint or action was not found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Method is not allowed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API could not load the scoped server." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The power action could not be completed." } }, "security": [ { "apiKeyAuth": [] } ], "summary": "Start game server", "tags": [ "Hosting" ] } }, "/v1/hosting/game/power/{server_id}/stop": { "post": { "description": "Sends a stop action to a customer-scoped game server.", "operationId": "stopGameServer", "parameters": [ { "description": "Game server ID.", "in": "path", "name": "server_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GamePowerResponse" } } }, "description": "Power action was requested." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Confirmation is required or request validation failed." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is missing or invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API key lacks access or scope." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Endpoint or action was not found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Method is not allowed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API could not load the scoped server." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The power action could not be completed." } }, "security": [ { "apiKeyAuth": [] } ], "summary": "Stop game server", "tags": [ "Hosting" ] } }, "/v1/info": { "get": { "description": "Returns the running API version.", "operationId": "getAPIInfo", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InfoResponse" } } }, "description": "API version metadata." }, "405": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Method is not allowed." } }, "summary": "Get API version", "tags": [ "API" ] } }, "/v1/kb/article": { "get": { "description": "Returns one published knowledge base article by path.", "operationId": "getKnowledgeBaseArticle", "parameters": [ { "description": "Published article path.", "in": "query", "name": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentArticle" } } }, "description": "Knowledge base article." }, "400": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "The path query parameter is missing." }, "404": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Article was not found." }, "405": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Method is not allowed." }, "500": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Content could not be loaded." } }, "summary": "Get knowledge base article", "tags": [ "Content" ] } }, "/v1/kb/feedback": { "post": { "description": "Records reader feedback for a knowledge base article.", "operationId": "createKnowledgeBaseFeedback", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KBFeedbackRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Feedback was accepted." }, "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Feedback was queued for processing." }, "400": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Request JSON is invalid." }, "405": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Method is not allowed." }, "415": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Content type must be application/json." }, "429": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Rate limit exceeded." }, "500": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Feedback could not be processed." }, "502": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Feedback delivery failed temporarily." } }, "summary": "Create knowledge base feedback", "tags": [ "Feedback" ] } }, "/v1/kb/list": { "get": { "description": "Returns published knowledge base article metadata.", "operationId": "listKnowledgeBaseArticles", "parameters": [ { "description": "Optional category slug filter.", "in": "query", "name": "category", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ContentItem" }, "type": "array" } } }, "description": "Knowledge base article metadata list." }, "405": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Method is not allowed." }, "500": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Knowledge base content could not be loaded." } }, "summary": "List knowledge base articles", "tags": [ "Content" ] } }, "/v1/openapi.json": { "get": { "description": "Returns this OpenAPI document.", "operationId": "getOpenAPISpec", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OpenAPI document." }, "405": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Method is not allowed." } }, "summary": "Get OpenAPI spec", "tags": [ "API" ] } }, "/v1/plans": { "get": { "description": "Returns public hosting plan metadata.", "operationId": "listPlans", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanCatalogResponse" } } }, "description": "Plan catalog." }, "405": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Method is not allowed." } }, "summary": "List plan catalog", "tags": [ "Product" ] } }, "/v1/status": { "get": { "description": "Returns a public service health snapshot.", "operationId": "getStatus", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse" } } }, "description": "Service status snapshot." }, "405": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Method is not allowed." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusErrorResponse" } } }, "description": "Service status is unavailable." } }, "summary": "Get public service status", "tags": [ "Monitoring" ] } } }, "servers": [ { "description": "Production", "url": "https://api.heo-systems.net" } ], "tags": [ { "description": "Health and service status endpoints.", "name": "Monitoring" }, { "description": "Plan catalog endpoints.", "name": "Product" }, { "description": "Public domain availability and pricing endpoints.", "name": "Domains" }, { "description": "Blog and knowledge base endpoints.", "name": "Content" }, { "description": "Knowledge base feedback intake.", "name": "Feedback" }, { "description": "Embeddable browser assets.", "name": "Embed" }, { "description": "Customer-scoped hosting control endpoints.", "name": "Hosting" }, { "description": "API metadata and machine-readable reference.", "name": "API" } ] }