{ "consumes": [ "application/json" ], "definitions": { "ControlPlaneAddServerModBody": { "properties": { "name": { "type": "string" }, "projectId": { "type": "string" }, "source": { "type": "string" }, "versionSpec": { "type": "string" } }, "type": "object" }, "ControlPlaneAddServerPortBody": { "properties": { "containerPort": { "format": "int32", "type": "integer" }, "label": { "type": "string" }, "proto": { "title": "\"tcp\" | \"udp\"", "type": "string" } }, "type": "object" }, "ControlPlaneCopyPathBody": { "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "type": "object" }, "ControlPlaneCreateCheckoutLinkBody": { "description": "CreateCheckoutLink (ADR-0034): funds the CALLER's own wallet via Paddle hosted-checkout.", "properties": { "amountUsd": { "format": "int32", "type": "integer" } }, "type": "object" }, "ControlPlaneCreateScheduleBody": { "properties": { "command": { "type": "string" }, "cronExpr": { "type": "string" }, "kind": { "type": "string" } }, "type": "object" }, "ControlPlaneCreateServerDatabaseBody": { "type": "object" }, "ControlPlaneCreateServerFromTemplateBody": { "properties": { "name": { "type": "string" }, "overrides": { "$ref": "#/definitions/v1TemplateOverrides" } }, "type": "object" }, "ControlPlaneDeleteScheduleBody": { "properties": { "scheduleId": { "type": "string" } }, "type": "object" }, "ControlPlaneDeleteServerWorldBody": { "properties": { "name": { "type": "string" } }, "type": "object" }, "ControlPlaneDisableSftpBody": { "type": "object" }, "ControlPlaneDropServerDatabaseBody": { "type": "object" }, "ControlPlaneEnableSftpBody": { "type": "object" }, "ControlPlaneKickPlayerBody": { "properties": { "name": { "type": "string" }, "reason": { "type": "string" } }, "type": "object" }, "ControlPlaneRemoveServerModBody": { "properties": { "projectId": { "type": "string" }, "source": { "type": "string" } }, "type": "object" }, "ControlPlaneRemoveServerPortBody": { "properties": { "slot": { "format": "int32", "type": "integer" } }, "type": "object" }, "ControlPlaneRenamePathBody": { "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "type": "object" }, "ControlPlaneResetServerWorldBody": { "type": "object" }, "ControlPlaneRestartServerBody": { "type": "object" }, "ControlPlaneRetryInstallBody": { "title": "Install retry", "type": "object" }, "ControlPlaneRotateServerDatabasePasswordBody": { "type": "object" }, "ControlPlaneRotateSftpPasswordBody": { "type": "object" }, "ControlPlaneRunScheduleNowBody": { "properties": { "scheduleId": { "type": "string" } }, "type": "object" }, "ControlPlaneSetActiveWorldBody": { "properties": { "name": { "type": "string" } }, "type": "object" }, "ControlPlaneSetBanEntryBody": { "properties": { "banned": { "type": "boolean" }, "name": { "type": "string" }, "reason": { "type": "string" } }, "type": "object" }, "ControlPlaneSetIpBanEntryBody": { "properties": { "banned": { "type": "boolean" }, "ip": { "type": "string" }, "reason": { "type": "string" } }, "type": "object" }, "ControlPlaneSetOpEntryBody": { "properties": { "name": { "type": "string" }, "op": { "type": "boolean" } }, "type": "object" }, "ControlPlaneSetPublicStatusBody": { "properties": { "enabled": { "type": "boolean" }, "showAddress": { "type": "boolean" } }, "type": "object" }, "ControlPlaneSetScheduleEnabledBody": { "properties": { "enabled": { "type": "boolean" }, "scheduleId": { "type": "string" } }, "type": "object" }, "ControlPlaneSetServerAlertWebhookBody": { "properties": { "url": { "type": "string" } }, "type": "object" }, "ControlPlaneSetServerMotdBody": { "properties": { "motd": { "type": "string" } }, "type": "object" }, "ControlPlaneSetServerPropertiesBody": { "properties": { "idleTimeoutMinutes": { "format": "int32", "type": "integer" }, "properties": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" }, "ControlPlaneSetWhitelistEnforcedBody": { "properties": { "enforced": { "type": "boolean" } }, "type": "object" }, "ControlPlaneSetWhitelistEntryBody": { "properties": { "allowed": { "type": "boolean" }, "name": { "type": "string" } }, "type": "object" }, "ControlPlaneStartServerBody": { "type": "object" }, "ControlPlaneStopServerBody": { "type": "object" }, "ControlPlaneUpdateServerVersionBody": { "description": "Core/version change for a stopped server; applied by provision.EnsureCurrent on next start.", "properties": { "type": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "controlplaneV1FileEntry": { "properties": { "isDir": { "type": "boolean" }, "name": { "type": "string" }, "size": { "format": "int64", "type": "string" } }, "title": "File messages", "type": "object" }, "controlplaneV1ReadFileResponse": { "properties": { "content": { "format": "byte", "type": "string" }, "truncated": { "type": "boolean" } }, "type": "object" }, "protobufAny": { "additionalProperties": {}, "properties": { "@type": { "type": "string" } }, "type": "object" }, "rpcStatus": { "properties": { "code": { "format": "int32", "type": "integer" }, "details": { "items": { "$ref": "#/definitions/protobufAny", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "type": "object" }, "v1AccountLimits": { "properties": { "maxRamMb": { "format": "int32", "type": "integer" } }, "type": "object" }, "v1AddServerModResponse": { "type": "object" }, "v1AuditEntry": { "properties": { "accountId": { "type": "string" }, "action": { "type": "string" }, "createdAt": { "type": "string" }, "detail": { "type": "string" }, "userId": { "type": "string" } }, "title": "Audit log messages (Ф7)", "type": "object" }, "v1Backup": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "serverId": { "type": "string" }, "sizeBytes": { "format": "int64", "type": "string" } }, "title": "Backup messages", "type": "object" }, "v1BanEntry": { "properties": { "created": { "type": "string" }, "expires": { "type": "string" }, "name": { "type": "string" }, "reason": { "type": "string" }, "source": { "type": "string" }, "uuid": { "type": "string" } }, "type": "object" }, "v1CapacityResponse": { "properties": { "activeServers": { "format": "int32", "type": "integer" }, "coresUsable": { "format": "double", "type": "number" }, "coresUsed": { "format": "double", "type": "number" }, "cpuTiers": { "items": { "$ref": "#/definitions/v1CpuTier", "type": "object" }, "title": "RAM→cpus table for per-tier create/start gating", "type": "array" }, "cpusPerServer": { "format": "double", "type": "number" }, "diskFreeMb": { "format": "int64", "title": "free disk (MB) on dataRoot; 0 if probe failed", "type": "string" }, "diskTotalMb": { "format": "int64", "title": "total disk (MB) on dataRoot; 0 if probe failed", "type": "string" }, "maxServersPerAccount": { "format": "int32", "title": "per-account server cap (ADR-0020); \u003c=0 = unlimited", "type": "integer" }, "ramUsableMb": { "format": "int64", "type": "string" }, "ramUsedMb": { "format": "int64", "type": "string" } }, "type": "object" }, "v1ControlPlaneCreateBackupBody": { "type": "object" }, "v1ControlPlaneDeleteBackupBody": { "type": "object" }, "v1ControlPlaneDeleteFileBody": { "properties": { "path": { "type": "string" } }, "type": "object" }, "v1ControlPlaneMkdirBody": { "properties": { "path": { "type": "string" } }, "type": "object" }, "v1ControlPlaneRestoreBackupBody": { "type": "object" }, "v1ControlPlaneRunCommandBody": { "properties": { "command": { "type": "string" } }, "title": "Console messages", "type": "object" }, "v1ControlPlaneWriteFileBody": { "properties": { "content": { "format": "byte", "type": "string" }, "path": { "type": "string" } }, "type": "object" }, "v1CopyPathResponse": { "properties": { "copied": { "format": "int64", "type": "string" } }, "type": "object" }, "v1CpuTier": { "properties": { "cpus": { "format": "double", "type": "number" }, "ramMb": { "format": "int64", "type": "string" } }, "type": "object" }, "v1CreateCheckoutLinkResponse": { "properties": { "checkoutUrl": { "type": "string" } }, "type": "object" }, "v1CreateServerRequest": { "properties": { "accountId": { "type": "string" }, "addr": { "type": "string" }, "container": { "type": "string" }, "hostname": { "type": "string" }, "id": { "type": "string" }, "modpackPlatform": { "type": "string" }, "modpackRef": { "type": "string" }, "modpackVersion": { "type": "string" }, "motd": { "type": "string" }, "name": { "title": "human-readable label; slug becomes the hostname localpart when a node public_host is assigned", "type": "string" }, "plan": { "title": "\"metered\" (default) | \"flat\"", "type": "string" }, "properties": { "additionalProperties": { "type": "string" }, "title": "server.properties subset (e.g. level-type, generator-settings)", "type": "object" }, "ramMb": { "format": "int32", "type": "integer" }, "region": { "title": "target region (default \"na\"); must map to an active node", "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "v1DeleteBackupResponse": { "type": "object" }, "v1DeleteFileResponse": { "type": "object" }, "v1DeleteServerResponse": { "type": "object" }, "v1GetServerLogsResponse": { "properties": { "containerMissing": { "type": "boolean" }, "cursor": { "type": "string" }, "lines": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "v1IpBanEntry": { "properties": { "created": { "type": "string" }, "expires": { "type": "string" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "source": { "type": "string" } }, "type": "object" }, "v1LedgerEntry": { "properties": { "accountId": { "type": "string" }, "amountMicros": { "format": "int64", "type": "string" }, "id": { "format": "int64", "type": "string" }, "kind": { "type": "string" }, "note": { "type": "string" }, "serverId": { "type": "string" }, "ts": { "format": "date-time", "type": "string" } }, "type": "object" }, "v1ListBackupsResponse": { "properties": { "backups": { "items": { "$ref": "#/definitions/v1Backup", "type": "object" }, "type": "array" } }, "type": "object" }, "v1ListFilesResponse": { "properties": { "entries": { "items": { "$ref": "#/definitions/controlplaneV1FileEntry", "type": "object" }, "type": "array" } }, "type": "object" }, "v1ListLedgerResponse": { "properties": { "entries": { "items": { "$ref": "#/definitions/v1LedgerEntry", "type": "object" }, "type": "array" } }, "type": "object" }, "v1ListMinecraftVersionsResponse": { "properties": { "latest": { "title": "latest.release", "type": "string" }, "versions": { "items": { "type": "string" }, "title": "newest-first", "type": "array" } }, "type": "object" }, "v1ListRegionsResponse": { "properties": { "regions": { "items": { "$ref": "#/definitions/v1RegionInfo", "type": "object" }, "type": "array" } }, "type": "object" }, "v1ListServerModsResponse": { "properties": { "mods": { "items": { "$ref": "#/definitions/v1ServerMod", "type": "object" }, "type": "array" } }, "type": "object" }, "v1ListServersResponse": { "properties": { "servers": { "items": { "$ref": "#/definitions/v1Server", "type": "object" }, "type": "array" } }, "type": "object" }, "v1ListTemplatesResponse": { "properties": { "templates": { "items": { "$ref": "#/definitions/v1Template", "type": "object" }, "type": "array" } }, "type": "object" }, "v1MetricSample": { "properties": { "cpuPercent": { "format": "double", "title": "-1 = unknown", "type": "number" }, "memLimitMb": { "format": "double", "title": "0 = no container reading", "type": "number" }, "memUsedMb": { "format": "double", "type": "number" }, "mspt": { "format": "double", "type": "number" }, "players": { "format": "int32", "type": "integer" }, "tps": { "format": "double", "type": "number" }, "ts": { "format": "date-time", "type": "string" } }, "title": "Metrics messages", "type": "object" }, "v1MkdirResponse": { "type": "object" }, "v1OpEntry": { "properties": { "bypassesPlayerLimit": { "type": "boolean" }, "level": { "format": "int32", "type": "integer" }, "name": { "type": "string" }, "uuid": { "type": "string" } }, "type": "object" }, "v1PlayerLists": { "properties": { "banned": { "items": { "$ref": "#/definitions/v1BanEntry", "type": "object" }, "type": "array" }, "bannedIps": { "items": { "$ref": "#/definitions/v1IpBanEntry", "type": "object" }, "type": "array" }, "online": { "items": { "type": "string" }, "type": "array" }, "ops": { "items": { "$ref": "#/definitions/v1OpEntry", "type": "object" }, "type": "array" }, "running": { "type": "boolean" }, "whitelist": { "items": { "$ref": "#/definitions/v1WhitelistEntry", "type": "object" }, "type": "array" }, "whitelistEnforced": { "type": "boolean" } }, "type": "object" }, "v1PortMapping": { "properties": { "containerPort": { "format": "int32", "title": "port inside the container (e.g. 19132)", "type": "integer" }, "hostPort": { "format": "int32", "title": "derived host port (display only)", "type": "integer" }, "label": { "type": "string" }, "proto": { "title": "\"tcp\" | \"udp\"", "type": "string" }, "slot": { "format": "int32", "type": "integer" } }, "type": "object" }, "v1RegionInfo": { "properties": { "available": { "title": "has a reachable active node", "type": "boolean" }, "capacity": { "$ref": "#/definitions/v1CapacityResponse", "title": "per-region capacity (zero-value if unavailable)" }, "label": { "type": "string" }, "region": { "type": "string" } }, "type": "object" }, "v1RemoveServerModResponse": { "type": "object" }, "v1RenamePathResponse": { "type": "object" }, "v1RestoreBackupResponse": { "type": "object" }, "v1RunCommandResponse": { "properties": { "output": { "type": "string" } }, "type": "object" }, "v1Schedule": { "properties": { "command": { "type": "string" }, "createdAt": { "type": "string" }, "cronExpr": { "type": "string" }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "kind": { "type": "string" }, "lastError": { "type": "string" }, "lastRunAt": { "type": "string" }, "lastStatus": { "type": "string" }, "nextRunAt": { "type": "string" }, "serverId": { "type": "string" } }, "title": "Scheduled-task messages (Ф3)", "type": "object" }, "v1ScheduleList": { "properties": { "schedules": { "items": { "$ref": "#/definitions/v1Schedule", "type": "object" }, "type": "array" } }, "type": "object" }, "v1Server": { "properties": { "accountId": { "type": "string" }, "addr": { "type": "string" }, "alertWebhookUrl": { "description": "Discord webhook for TPS alerts; empty = alerts off.", "type": "string" }, "bakedAt": { "description": "First successful boot completed (ADR-0018); unset = world still preparing.", "format": "date-time", "type": "string" }, "container": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "diskQuotaEffectiveMb": { "format": "int64", "type": "string" }, "diskQuotaOverrideMb": { "format": "int64", "type": "string" }, "diskUsageKnown": { "type": "boolean" }, "diskUsageMb": { "description": "Disk usage/quota (per-server-disk-quota). disk_usage_known distinguishes\n\"never measured\" (false → panel shows \"—\") from a real 0. effective is the\napplied cap (override\u003e0 ? override : per-tier/global). override_mb is the raw\nadmin override (0 = none), for the admin control.", "format": "int64", "type": "string" }, "hostname": { "type": "string" }, "id": { "type": "string" }, "idleTimeoutMinutes": { "description": "Per-server idle timeout in minutes; 0 = use the node's global default.", "format": "int32", "type": "integer" }, "installError": { "type": "string" }, "installErrorCode": { "title": "diag over install_error (unify)", "type": "string" }, "installErrorSuggestion": { "type": "string" }, "installErrorSummary": { "type": "string" }, "lastActiveAt": { "format": "date-time", "type": "string" }, "modpackPlatform": { "type": "string" }, "modpackRef": { "type": "string" }, "modpackVersion": { "type": "string" }, "motd": { "description": "In-game description (MOTD); shown by the sleeping ping responder and the\nrunning container (applies on next start). Empty = default.", "type": "string" }, "nodeLabel": { "description": "Human-readable node label (e.g. \"North America (Canada)\").", "type": "string" }, "plan": { "description": "Billing plan: \"metered\" (default) | \"flat\".", "type": "string" }, "ports": { "items": { "$ref": "#/definitions/v1PortMapping", "type": "object" }, "type": "array" }, "properties": { "additionalProperties": { "type": "string" }, "description": "Editable server.properties subset (see internal/serverprops); applies on\nnext start via EnsureCurrent. Empty = all defaults.", "type": "object" }, "publicShowAddress": { "type": "boolean" }, "publicSlug": { "title": "\"\" = unset", "type": "string" }, "publicStatusEnabled": { "type": "boolean" }, "quotaExceeded": { "description": "Disk-quota tripped (ADR-0020): server stopped + start/bake gated until freed.", "type": "boolean" }, "ramMb": { "format": "int32", "type": "integer" }, "region": { "description": "Region this server lives in (e.g. \"na\", \"eu\").", "type": "string" }, "sftpEnabled": { "description": "SFTP subsystem enabled; credentials set on last EnableSftp/RotateSftpPassword.", "type": "boolean" }, "startError": { "title": "raw last start-failure tail; \"\" when none", "type": "string" }, "startErrorCode": { "title": "diag code (e.g. missing_dependency, unknown)", "type": "string" }, "startErrorSuggestion": { "title": "friendly fix", "type": "string" }, "startErrorSummary": { "title": "friendly cause (Title — Detail)", "type": "string" }, "startupPercent": { "format": "int32", "type": "integer" }, "startupPhase": { "description": "Live boot progress (populated only while state == \"starting\"):\nstartup_phase ∈ {starting, loading_mods, generating_world, ready};\nstartup_percent is the world-gen percent (0 otherwise, 100 when ready).", "type": "string" }, "state": { "type": "string" }, "type": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "v1ServerAuditList": { "properties": { "entries": { "items": { "$ref": "#/definitions/v1AuditEntry", "type": "object" }, "type": "array" } }, "type": "object" }, "v1ServerDatabase": { "properties": { "dbName": { "type": "string" }, "dbPassword": { "type": "string" }, "dbUser": { "type": "string" }, "host": { "type": "string" }, "port": { "format": "int32", "type": "integer" }, "present": { "type": "boolean" }, "serverId": { "type": "string" } }, "title": "MySQL database messages (Ф4)", "type": "object" }, "v1ServerMetrics": { "properties": { "cpuPercent": { "format": "double", "title": "-1 = unknown", "type": "number" }, "live": { "title": "RCON tick stats fresh", "type": "boolean" }, "memLimitMb": { "format": "double", "title": "0 = no container reading → hide resource tiles", "type": "number" }, "memUsedMb": { "format": "double", "type": "number" }, "mspt": { "format": "double", "type": "number" }, "players": { "format": "int32", "type": "integer" }, "series": { "items": { "$ref": "#/definitions/v1MetricSample", "type": "object" }, "type": "array" }, "tps": { "format": "double", "type": "number" } }, "type": "object" }, "v1ServerMod": { "properties": { "name": { "type": "string" }, "projectId": { "type": "string" }, "source": { "type": "string" }, "versionSpec": { "type": "string" } }, "title": "Managed mods/plugins", "type": "object" }, "v1ServerWorld": { "properties": { "active": { "type": "boolean" }, "name": { "type": "string" } }, "title": "World management messages (Ф6)", "type": "object" }, "v1ServerWorldList": { "properties": { "worlds": { "items": { "$ref": "#/definitions/v1ServerWorld", "type": "object" }, "type": "array" } }, "type": "object" }, "v1SftpCredential": { "properties": { "host": { "type": "string" }, "password": { "type": "string" }, "port": { "format": "int32", "type": "integer" }, "username": { "type": "string" } }, "type": "object" }, "v1Template": { "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "modpack": { "$ref": "#/definitions/v1TemplateModpack" }, "motd": { "type": "string" }, "name": { "type": "string" }, "plan": { "type": "string" }, "properties": { "additionalProperties": { "type": "string" }, "type": "object" }, "ramMb": { "format": "int32", "type": "integer" }, "serverType": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "v1TemplateModpack": { "properties": { "platform": { "type": "string" }, "ref": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "v1TemplateOverrides": { "properties": { "plan": { "type": "string" }, "ramMb": { "format": "int32", "type": "integer" }, "region": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "v1Wallet": { "properties": { "accountId": { "type": "string" }, "balanceMicros": { "format": "int64", "type": "string" } }, "title": "Billing messages", "type": "object" }, "v1WhitelistEntry": { "properties": { "name": { "type": "string" }, "uuid": { "type": "string" } }, "title": "Player-management messages", "type": "object" }, "v1WhoAmIResponse": { "properties": { "accountId": { "type": "string" }, "email": { "type": "string" }, "emailVerified": { "type": "boolean" } }, "type": "object" }, "v1WriteFileResponse": { "type": "object" } }, "info": { "title": "cluster/v1/cluster.proto", "version": "version not set" }, "paths": { "/v1/accounts/{accountId}/checkout-link": { "post": { "operationId": "ControlPlane_CreateCheckoutLink", "parameters": [ { "description": "used in URL path only; RPC enforces caller must match", "in": "path", "name": "accountId", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneCreateCheckoutLinkBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1CreateCheckoutLinkResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "billing:read" } }, "/v1/accounts/{accountId}/ledger": { "get": { "operationId": "ControlPlane_ListLedger", "parameters": [ { "in": "path", "name": "accountId", "required": true, "type": "string" }, { "format": "int32", "in": "query", "name": "limit", "required": false, "type": "integer" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListLedgerResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "billing:read" } }, "/v1/accounts/{accountId}/limits": { "get": { "operationId": "ControlPlane_GetAccountLimits", "parameters": [ { "in": "path", "name": "accountId", "required": true, "type": "string" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1AccountLimits" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:read" } }, "/v1/accounts/{accountId}/wallet": { "get": { "operationId": "ControlPlane_GetWallet", "parameters": [ { "in": "path", "name": "accountId", "required": true, "type": "string" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Wallet" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "billing:read" } }, "/v1/capacity": { "get": { "operationId": "ControlPlane_GetCapacity", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1CapacityResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:read" } }, "/v1/minecraft/versions": { "get": { "operationId": "ControlPlane_ListMinecraftVersions", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListMinecraftVersionsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:read" } }, "/v1/regions": { "get": { "operationId": "ControlPlane_ListRegions", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListRegionsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:read" } }, "/v1/servers": { "get": { "operationId": "ControlPlane_ListServers", "parameters": [ { "in": "query", "name": "accountId", "required": false, "type": "string" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListServersResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:read" }, "post": { "operationId": "ControlPlane_CreateServer", "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/v1CreateServerRequest" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Server" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}": { "delete": { "operationId": "ControlPlane_DeleteServer", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1DeleteServerResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" }, "get": { "operationId": "ControlPlane_GetServer", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Server" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:read" } }, "/v1/servers/{id}/audit": { "get": { "operationId": "ControlPlane_ListServerAudit", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "format": "int32", "in": "query", "name": "limit", "required": false, "type": "integer" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ServerAuditList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "summary": "Audit log (Ф7)", "tags": [ "ControlPlane" ], "x-required-scope": "servers:read" } }, "/v1/servers/{id}/backups": { "get": { "operationId": "ControlPlane_ListBackups", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListBackupsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "backups" }, "post": { "operationId": "ControlPlane_CreateBackup", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/v1ControlPlaneCreateBackupBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Backup" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "backups" } }, "/v1/servers/{id}/backups/{backupId}:delete": { "post": { "operationId": "ControlPlane_DeleteBackup", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "path", "name": "backupId", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/v1ControlPlaneDeleteBackupBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1DeleteBackupResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "backups" } }, "/v1/servers/{id}/backups/{backupId}:restore": { "post": { "operationId": "ControlPlane_RestoreBackup", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "path", "name": "backupId", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/v1ControlPlaneRestoreBackupBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1RestoreBackupResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "backups" } }, "/v1/servers/{id}/database": { "get": { "operationId": "ControlPlane_GetServerDatabase", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ServerDatabase" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}/file": { "get": { "operationId": "ControlPlane_ReadFile", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "query", "name": "path", "required": false, "type": "string" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/controlplaneV1ReadFileResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "files:read" }, "post": { "operationId": "ControlPlane_WriteFile", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/v1ControlPlaneWriteFileBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1WriteFileResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "files:write" } }, "/v1/servers/{id}/file:copy": { "post": { "operationId": "ControlPlane_CopyPath", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneCopyPathBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1CopyPathResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "files:write" } }, "/v1/servers/{id}/file:delete": { "post": { "operationId": "ControlPlane_DeleteFile", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/v1ControlPlaneDeleteFileBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1DeleteFileResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "files:write" } }, "/v1/servers/{id}/file:mkdir": { "post": { "operationId": "ControlPlane_Mkdir", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/v1ControlPlaneMkdirBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1MkdirResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "files:write" } }, "/v1/servers/{id}/file:rename": { "post": { "operationId": "ControlPlane_RenamePath", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneRenamePathBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1RenamePathResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "files:write" } }, "/v1/servers/{id}/files": { "get": { "operationId": "ControlPlane_ListFiles", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "query", "name": "path", "required": false, "type": "string" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListFilesResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "files:read" } }, "/v1/servers/{id}/logs": { "get": { "operationId": "ControlPlane_GetServerLogs", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "query", "name": "cursor", "required": false, "type": "string" }, { "format": "int32", "in": "query", "name": "tail", "required": false, "type": "integer" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1GetServerLogsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:read" } }, "/v1/servers/{id}/metrics": { "get": { "operationId": "ControlPlane_GetServerMetrics", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ServerMetrics" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:read" } }, "/v1/servers/{id}/mods": { "get": { "operationId": "ControlPlane_ListServerMods", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListServerModsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:read" }, "post": { "operationId": "ControlPlane_AddServerMod", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneAddServerModBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1AddServerModResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}/mods:remove": { "post": { "operationId": "ControlPlane_RemoveServerMod", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneRemoveServerModBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1RemoveServerModResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}/players": { "get": { "operationId": "ControlPlane_GetServerPlayers", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1PlayerLists" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:read" } }, "/v1/servers/{id}/schedules": { "get": { "operationId": "ControlPlane_ListServerSchedules", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ScheduleList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "summary": "Scheduled tasks (Ф3)", "tags": [ "ControlPlane" ], "x-required-scope": "servers:read" }, "post": { "operationId": "ControlPlane_CreateSchedule", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneCreateScheduleBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Schedule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}/worlds": { "get": { "operationId": "ControlPlane_ListServerWorlds", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ServerWorldList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "summary": "World management (Ф6)", "tags": [ "ControlPlane" ], "x-required-scope": "servers:read" } }, "/v1/servers/{id}:add-port": { "post": { "operationId": "ControlPlane_AddServerPort", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneAddServerPortBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Server" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:command": { "post": { "operationId": "ControlPlane_RunCommand", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/v1ControlPlaneRunCommandBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1RunCommandResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "console" } }, "/v1/servers/{id}:create-database": { "post": { "operationId": "ControlPlane_CreateServerDatabase", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneCreateServerDatabaseBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ServerDatabase" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:delete-schedule": { "post": { "operationId": "ControlPlane_DeleteSchedule", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneDeleteScheduleBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ScheduleList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:delete-world": { "post": { "operationId": "ControlPlane_DeleteServerWorld", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneDeleteServerWorldBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ServerWorldList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:disable-sftp": { "post": { "operationId": "ControlPlane_DisableSftp", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneDisableSftpBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Server" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "files:write" } }, "/v1/servers/{id}:drop-database": { "post": { "operationId": "ControlPlane_DropServerDatabase", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneDropServerDatabaseBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ServerDatabase" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:enable-sftp": { "post": { "operationId": "ControlPlane_EnableSftp", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneEnableSftpBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1SftpCredential" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "files:write" } }, "/v1/servers/{id}:kick-player": { "post": { "operationId": "ControlPlane_KickPlayer", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneKickPlayerBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1PlayerLists" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:remove-port": { "post": { "operationId": "ControlPlane_RemoveServerPort", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneRemoveServerPortBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Server" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:reset-world": { "post": { "operationId": "ControlPlane_ResetServerWorld", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneResetServerWorldBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Server" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:restart": { "post": { "operationId": "ControlPlane_RestartServer", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneRestartServerBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Server" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:retry-install": { "post": { "operationId": "ControlPlane_RetryInstall", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneRetryInstallBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Server" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:rotate-database-password": { "post": { "operationId": "ControlPlane_RotateServerDatabasePassword", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneRotateServerDatabasePasswordBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ServerDatabase" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:rotate-sftp-password": { "post": { "operationId": "ControlPlane_RotateSftpPassword", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneRotateSftpPasswordBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1SftpCredential" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "files:write" } }, "/v1/servers/{id}:run-schedule-now": { "post": { "operationId": "ControlPlane_RunScheduleNow", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneRunScheduleNowBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Schedule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:set-active-world": { "post": { "operationId": "ControlPlane_SetActiveWorld", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneSetActiveWorldBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Server" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:set-alert-webhook": { "post": { "operationId": "ControlPlane_SetServerAlertWebhook", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneSetServerAlertWebhookBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Server" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:set-ban-entry": { "post": { "operationId": "ControlPlane_SetBanEntry", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneSetBanEntryBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1PlayerLists" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:set-ip-ban-entry": { "post": { "operationId": "ControlPlane_SetIpBanEntry", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneSetIpBanEntryBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1PlayerLists" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:set-motd": { "post": { "operationId": "ControlPlane_SetServerMotd", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneSetServerMotdBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Server" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:set-op-entry": { "post": { "operationId": "ControlPlane_SetOpEntry", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneSetOpEntryBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1PlayerLists" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:set-properties": { "post": { "operationId": "ControlPlane_SetServerProperties", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneSetServerPropertiesBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Server" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:set-public-status": { "post": { "operationId": "ControlPlane_SetPublicStatus", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneSetPublicStatusBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Server" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:set-schedule-enabled": { "post": { "operationId": "ControlPlane_SetScheduleEnabled", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneSetScheduleEnabledBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Schedule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:set-version": { "post": { "operationId": "ControlPlane_UpdateServerVersion", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneUpdateServerVersionBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Server" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:set-whitelist-enforced": { "post": { "operationId": "ControlPlane_SetWhitelistEnforced", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneSetWhitelistEnforcedBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1PlayerLists" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:set-whitelist-entry": { "post": { "operationId": "ControlPlane_SetWhitelistEntry", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneSetWhitelistEntryBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1PlayerLists" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:start": { "post": { "operationId": "ControlPlane_StartServer", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneStartServerBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Server" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/servers/{id}:stop": { "post": { "operationId": "ControlPlane_StopServer", "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneStopServerBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Server" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/templates": { "get": { "operationId": "ControlPlane_ListTemplates", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListTemplatesResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "summary": "Templates — curated server templates (dev-platform)", "tags": [ "ControlPlane" ], "x-required-scope": "servers:read" } }, "/v1/templates/{templateId}:create": { "post": { "operationId": "ControlPlane_CreateServerFromTemplate", "parameters": [ { "in": "path", "name": "templateId", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ControlPlaneCreateServerFromTemplateBody" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Server" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ControlPlane" ], "x-required-scope": "servers:write" } }, "/v1/whoami": { "get": { "operationId": "ControlPlane_WhoAmI", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1WhoAmIResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "security": [ { "ApiKeyAuth": [] } ], "summary": "WhoAmI — any valid key may call this; returns the key's bound account + email.", "tags": [ "ControlPlane" ] } } }, "produces": [ "application/json" ], "securityDefinitions": { "ApiKeyAuth": { "description": "Your per-account ttk_ API key. Send it in the x-api-key header: `x-api-key: ttk_\u003ckey\u003e`.", "in": "header", "name": "x-api-key", "type": "apiKey" } }, "swagger": "2.0", "tags": [ { "name": "NodeService" }, { "name": "EdgeService" }, { "name": "ControlService" }, { "name": "ControlPlane" } ] }