{ "openapi": "3.1.1", "info": { "title": "ozProtect network HTTP source reference", "version": "2026-10-28", "description": "Public user-facing source reference. Only explicitly permitted operations are published; service, maintenance and private interfaces are excluded. Unknown schemas stay unconstrained. Source checks do not replace authorization or establish runtime availability." }, "servers": [ { "url": "/", "description": "Select the actual assigned service origin; this is not a deployment URL." } ], "paths": { "/methods/account.genNetToken": { "get": { "operationId": "network_get__methods_account_genNetToken", "tags": [ "account" ], "summary": "account.genNetToken", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "client_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "key", "in": "query", "required": true, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "project", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/account/Account.js", "line": 22 }, "x-source-checks": [ "HasServerAccess", "VerifyAuthToken" ], "x-observed-required-input": [ "client_id", "key", "project", "server" ], "x-observed-errors": [ "access_denied", "another_project", "dedicated_project_mismatch", "incorrect_data", "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_account_genNetToken", "tags": [ "account" ], "summary": "account.genNetToken", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "client_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "key", "in": "query", "required": false, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "project", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/account/Account.js", "line": 22 }, "x-source-checks": [ "HasServerAccess", "VerifyAuthToken" ], "x-observed-required-input": [ "client_id", "key", "project", "server" ], "x-observed-errors": [ "access_denied", "another_project", "dedicated_project_mismatch", "incorrect_data", "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "client_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "key": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "project": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "client_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "key": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "project": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/account.steamLink": { "get": { "operationId": "network_get__methods_account_steamLink", "tags": [ "account" ], "summary": "account.steamLink", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "steam_assoc_handle", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_claimed_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_id", "in": "query", "required": true, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "steam_identity", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_ns", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_op_endpoint", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_response_nonce", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_return_to", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_sig", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_signed", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/account/Account.js", "line": 42 }, "x-source-checks": [ "VerifyAuthToken" ], "x-observed-required-input": [ "steam_id", "steam_sig", "steam_signed" ], "x-observed-errors": [ "database_error", "incorrect_data", "registration_failed", "steam_already_linked", "steam_not_authed", "token_invalid", "user_blocked", "user_deleted", "user_not_registered" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_account_steamLink", "tags": [ "account" ], "summary": "account.steamLink", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "steam_assoc_handle", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_claimed_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_id", "in": "query", "required": false, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "steam_identity", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_ns", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_op_endpoint", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_response_nonce", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_return_to", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_sig", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_signed", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/account/Account.js", "line": 42 }, "x-source-checks": [ "VerifyAuthToken" ], "x-observed-required-input": [ "steam_id", "steam_sig", "steam_signed" ], "x-observed-errors": [ "database_error", "incorrect_data", "registration_failed", "steam_already_linked", "steam_not_authed", "token_invalid", "user_blocked", "user_deleted", "user_not_registered" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "steam_assoc_handle": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_claimed_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_id": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "steam_identity": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_ns": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_op_endpoint": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_response_nonce": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_return_to": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_sig": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_signed": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "steam_assoc_handle": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_claimed_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_id": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "steam_identity": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_ns": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_op_endpoint": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_response_nonce": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_return_to": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_sig": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_signed": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/ban.uploadProofs": { "get": { "operationId": "network_get__methods_ban_uploadProofs", "tags": [ "ban" ], "summary": "ban.uploadProofs", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "ban_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "check_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "note", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "source", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/ban/Ban.js", "line": 8 }, "x-source-checks": [ "HasServerAccess", "VerifyAuthToken" ], "x-observed-required-input": [ "ban_id", "server_id" ], "x-observed-errors": [ "access_denied", "incorrect_data", "no_data", "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_ban_uploadProofs", "tags": [ "ban" ], "summary": "ban.uploadProofs", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "ban_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "check_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "note", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "source", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/ban/Ban.js", "line": 8 }, "x-source-checks": [ "HasServerAccess", "VerifyAuthToken" ], "x-observed-required-input": [ "ban_id", "server_id" ], "x-observed-errors": [ "access_denied", "incorrect_data", "no_data", "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ban_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "check_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "note": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "source": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ban_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "check_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "note": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "source": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "multipart/form-data": { "schema": { "type": "object", "properties": { "ban_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "check_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "note": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "source": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true }, "files": { "type": "array", "items": { "type": "string", "format": "binary" } } }, "additionalProperties": true } } } } } }, "/methods/billing.claimProjectBonus": { "get": { "operationId": "network_get__methods_billing_claimProjectBonus", "tags": [ "billing" ], "summary": "billing.claimProjectBonus", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/billing/Billing.js", "line": 228 }, "x-source-checks": [ "HasProjectAccess", "VerifyAuthToken", "VerifyProjectStaff" ], "x-observed-required-input": [], "x-observed-errors": [ "no_data" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_billing_claimProjectBonus", "tags": [ "billing" ], "summary": "billing.claimProjectBonus", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/billing/Billing.js", "line": 228 }, "x-source-checks": [ "HasProjectAccess", "VerifyAuthToken", "VerifyProjectStaff" ], "x-observed-required-input": [], "x-observed-errors": [ "no_data" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/billing.createTopUp": { "get": { "operationId": "network_get__methods_billing_createTopUp", "tags": [ "billing" ], "summary": "billing.createTopUp", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "amount", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "email", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "locale", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "payload", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "promo_code", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "provider", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "topup_project", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/billing/Billing.js", "line": 238 }, "x-source-checks": [ "VerifyAuthToken", "VerifyBonusOwner" ], "x-observed-required-input": [], "x-observed-errors": [ "billing_invalid_amount", "no_data" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_billing_createTopUp", "tags": [ "billing" ], "summary": "billing.createTopUp", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "amount", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "email", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "locale", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "payload", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "promo_code", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "provider", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "topup_project", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/billing/Billing.js", "line": 238 }, "x-source-checks": [ "VerifyAuthToken", "VerifyBonusOwner" ], "x-observed-required-input": [], "x-observed-errors": [ "billing_invalid_amount", "no_data" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "email": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "locale": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "payload": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "promo_code": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "provider": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "topup_project": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "amount": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "email": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "locale": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "payload": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "promo_code": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "provider": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "topup_project": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/billing.get": { "get": { "operationId": "network_get__methods_billing_get", "tags": [ "billing" ], "summary": "billing.get", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/billing/Billing.js", "line": 171 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [], "x-observed-errors": [], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_billing_get", "tags": [ "billing" ], "summary": "billing.get", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/billing/Billing.js", "line": 171 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [], "x-observed-errors": [], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/billing.getMethods": { "get": { "operationId": "network_get__methods_billing_getMethods", "tags": [ "billing" ], "summary": "billing.getMethods", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation.", "parameters": [], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/billing/Billing.js", "line": 168 }, "x-source-checks": [], "x-observed-required-input": [], "x-observed-errors": [], "x-feature-keys": [], "x-internal": false }, "post": { "operationId": "network_post__methods_billing_getMethods", "tags": [ "billing" ], "summary": "billing.getMethods", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation.", "parameters": [], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/billing/Billing.js", "line": 168 }, "x-source-checks": [], "x-observed-required-input": [], "x-observed-errors": [], "x-feature-keys": [], "x-internal": false, "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } } } } } }, "/methods/billing.getPanelData": { "get": { "operationId": "network_get__methods_billing_getPanelData", "tags": [ "billing" ], "summary": "billing.getPanelData", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "page", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/billing/Billing.js", "line": 177 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [], "x-observed-errors": [], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_billing_getPanelData", "tags": [ "billing" ], "summary": "billing.getPanelData", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "page", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/billing/Billing.js", "line": 177 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [], "x-observed-errors": [], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "page": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "limit": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "page": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/billing.getPlans": { "get": { "operationId": "network_get__methods_billing_getPlans", "tags": [ "billing" ], "summary": "billing.getPlans", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/billing/Billing.js", "line": 74 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [], "x-observed-errors": [], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_billing_getPlans", "tags": [ "billing" ], "summary": "billing.getPlans", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/billing/Billing.js", "line": 74 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [], "x-observed-errors": [], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/billing.getTransactions": { "get": { "operationId": "network_get__methods_billing_getTransactions", "tags": [ "billing" ], "summary": "billing.getTransactions", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "page", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/billing/Billing.js", "line": 205 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [], "x-observed-errors": [], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_billing_getTransactions", "tags": [ "billing" ], "summary": "billing.getTransactions", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "page", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/billing/Billing.js", "line": 205 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [], "x-observed-errors": [], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "page": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "limit": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "page": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/billing.licenseRenew": { "get": { "operationId": "network_get__methods_billing_licenseRenew", "tags": [ "billing" ], "summary": "billing.licenseRenew", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/billing/Billing.js", "line": 98 }, "x-source-checks": [ "VerifyAuthToken" ], "x-observed-required-input": [], "x-observed-errors": [ "access_denied", "incorrect_data", "insufficient_funds", "license_renew_error", "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_billing_licenseRenew", "tags": [ "billing" ], "summary": "billing.licenseRenew", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/billing/Billing.js", "line": 98 }, "x-source-checks": [ "VerifyAuthToken" ], "x-observed-required-input": [], "x-observed-errors": [ "access_denied", "incorrect_data", "insufficient_funds", "license_renew_error", "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/billing.licenseSet": { "get": { "operationId": "network_get__methods_billing_licenseSet", "tags": [ "billing" ], "summary": "billing.licenseSet", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "anticheat", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "checker", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "license", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "servers", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/billing/Billing.js", "line": 121 }, "x-source-checks": [ "VerifyAuthToken" ], "x-observed-required-input": [ "anticheat", "checker", "license", "servers" ], "x-observed-errors": [ "access_denied", "incorrect_data", "insufficient_funds", "license_update_error", "plan_degrade_locked", "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_billing_licenseSet", "tags": [ "billing" ], "summary": "billing.licenseSet", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "anticheat", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "checker", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "license", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "servers", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/billing/Billing.js", "line": 121 }, "x-source-checks": [ "VerifyAuthToken" ], "x-observed-required-input": [ "anticheat", "checker", "license", "servers" ], "x-observed-errors": [ "access_denied", "incorrect_data", "insufficient_funds", "license_update_error", "plan_degrade_locked", "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "anticheat": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "checker": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "license": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "servers": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "anticheat": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "checker": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "license": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "servers": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/billing.topUp": { "get": { "operationId": "network_get__methods_billing_topUp", "tags": [ "billing" ], "summary": "billing.topUp", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "amount", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "reason", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/billing/Billing.js", "line": 214 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [], "x-observed-errors": [ "billing_invalid_amount", "no_data" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_billing_topUp", "tags": [ "billing" ], "summary": "billing.topUp", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "amount", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "reason", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/billing/Billing.js", "line": 214 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [], "x-observed-errors": [ "billing_invalid_amount", "no_data" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "reason": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "amount": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "reason": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/bonus.activate": { "get": { "operationId": "network_get__methods_bonus_activate", "tags": [ "bonus" ], "summary": "bonus.activate", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "code", "in": "query", "required": false, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/bonus/Bonus.js", "line": 7 }, "x-source-checks": [ "VerifyAuthToken" ], "x-observed-required-input": [], "x-observed-errors": [ "incorrect_data", "no_data", "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_bonus_activate", "tags": [ "bonus" ], "summary": "bonus.activate", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "code", "in": "query", "required": false, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/bonus/Bonus.js", "line": 7 }, "x-source-checks": [ "VerifyAuthToken" ], "x-observed-required-input": [], "x-observed-errors": [ "incorrect_data", "no_data", "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/bonus.getMy": { "get": { "operationId": "network_get__methods_bonus_getMy", "tags": [ "bonus" ], "summary": "bonus.getMy", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "page", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/bonus/Bonus.js", "line": 24 }, "x-source-checks": [ "VerifyAuthToken" ], "x-observed-required-input": [], "x-observed-errors": [ "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_bonus_getMy", "tags": [ "bonus" ], "summary": "bonus.getMy", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "page", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/bonus/Bonus.js", "line": 24 }, "x-source-checks": [ "VerifyAuthToken" ], "x-observed-required-input": [], "x-observed-errors": [ "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "page": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "limit": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "page": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/checker.getConfig": { "get": { "operationId": "network_get__methods_checker_getConfig", "tags": [ "checker" ], "summary": "checker.getConfig", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "client_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "client_secret", "in": "query", "required": true, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "code", "in": "query", "required": true, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "steamid", "in": "query", "required": true, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/checker/Checker.js", "line": 14 }, "x-source-checks": [ "VerifyAuthToken" ], "x-observed-required-input": [ "client_id", "client_secret", "code", "steamid" ], "x-observed-errors": [ "access_denied", "another_project", "incorrect_data", "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_checker_getConfig", "tags": [ "checker" ], "summary": "checker.getConfig", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "client_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "client_secret", "in": "query", "required": false, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "steamid", "in": "query", "required": false, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/checker/Checker.js", "line": 14 }, "x-source-checks": [ "VerifyAuthToken" ], "x-observed-required-input": [ "client_id", "client_secret", "code", "steamid" ], "x-observed-errors": [ "access_denied", "another_project", "incorrect_data", "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "client_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "client_secret": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "code": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "steamid": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "client_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "client_secret": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "code": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "steamid": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/front.getCounters": { "get": { "operationId": "network_get__methods_front_getCounters", "tags": [ "front" ], "summary": "front.getCounters", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation.", "parameters": [], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/front/Front.js", "line": 92 }, "x-source-checks": [], "x-observed-required-input": [], "x-observed-errors": [], "x-feature-keys": [], "x-internal": false }, "post": { "operationId": "network_post__methods_front_getCounters", "tags": [ "front" ], "summary": "front.getCounters", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation.", "parameters": [], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/front/Front.js", "line": 92 }, "x-source-checks": [], "x-observed-required-input": [], "x-observed-errors": [], "x-feature-keys": [], "x-internal": false, "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } } } } } }, "/methods/front.getLanding": { "get": { "operationId": "network_get__methods_front_getLanding", "tags": [ "front" ], "summary": "front.getLanding", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation.", "parameters": [], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/front/Front.js", "line": 96 }, "x-source-checks": [], "x-observed-required-input": [], "x-observed-errors": [], "x-feature-keys": [], "x-internal": false }, "post": { "operationId": "network_post__methods_front_getLanding", "tags": [ "front" ], "summary": "front.getLanding", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation.", "parameters": [], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/front/Front.js", "line": 96 }, "x-source-checks": [], "x-observed-required-input": [], "x-observed-errors": [], "x-feature-keys": [], "x-internal": false, "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } } } } } }, "/methods/front.getLicenses": { "get": { "operationId": "network_get__methods_front_getLicenses", "tags": [ "front" ], "summary": "front.getLicenses", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation.", "parameters": [], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/front/Front.js", "line": 84 }, "x-source-checks": [], "x-observed-required-input": [], "x-observed-errors": [], "x-feature-keys": [], "x-internal": false }, "post": { "operationId": "network_post__methods_front_getLicenses", "tags": [ "front" ], "summary": "front.getLicenses", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation.", "parameters": [], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/front/Front.js", "line": 84 }, "x-source-checks": [], "x-observed-required-input": [], "x-observed-errors": [], "x-feature-keys": [], "x-internal": false, "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } } } } } }, "/methods/front.getSockets": { "get": { "operationId": "network_get__methods_front_getSockets", "tags": [ "front" ], "summary": "front.getSockets", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation.", "parameters": [], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/front/Front.js", "line": 88 }, "x-source-checks": [], "x-observed-required-input": [], "x-observed-errors": [], "x-feature-keys": [], "x-internal": false }, "post": { "operationId": "network_post__methods_front_getSockets", "tags": [ "front" ], "summary": "front.getSockets", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation.", "parameters": [], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/front/Front.js", "line": 88 }, "x-source-checks": [], "x-observed-required-input": [], "x-observed-errors": [], "x-feature-keys": [], "x-internal": false, "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } } } } } }, "/methods/meta.getLicenses": { "get": { "operationId": "network_get__methods_meta_getLicenses", "tags": [ "meta" ], "summary": "meta.getLicenses", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation.", "parameters": [], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/meta/Meta.js", "line": 10 }, "x-source-checks": [], "x-observed-required-input": [], "x-observed-errors": [], "x-feature-keys": [], "x-internal": false }, "post": { "operationId": "network_post__methods_meta_getLicenses", "tags": [ "meta" ], "summary": "meta.getLicenses", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation.", "parameters": [], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/meta/Meta.js", "line": 10 }, "x-source-checks": [], "x-observed-required-input": [], "x-observed-errors": [], "x-feature-keys": [], "x-internal": false, "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } } } } } }, "/methods/project.checkName": { "get": { "operationId": "network_get__methods_project_checkName", "tags": [ "project" ], "summary": "project.checkName", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 91 }, "x-source-checks": [ "VerifyAuthToken" ], "x-observed-required-input": [ "name" ], "x-observed-errors": [ "incorrect_data", "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_project_checkName", "tags": [ "project" ], "summary": "project.checkName", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 91 }, "x-source-checks": [ "VerifyAuthToken" ], "x-observed-required-input": [ "name" ], "x-observed-errors": [ "incorrect_data", "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/project.closeServer": { "get": { "operationId": "network_get__methods_project_closeServer", "tags": [ "project" ], "summary": "project.closeServer", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 303 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "project_id", "server_id" ], "x-observed-errors": [ "dedicated_project_mismatch", "incorrect_data", "no_data", "server_not_belong_project" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_project_closeServer", "tags": [ "project" ], "summary": "project.closeServer", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 303 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "project_id", "server_id" ], "x-observed-errors": [ "dedicated_project_mismatch", "incorrect_data", "no_data", "server_not_belong_project" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/project.create": { "get": { "operationId": "network_get__methods_project_create", "tags": [ "project" ], "summary": "project.create", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "color", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "company", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "desc", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "game", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "henable", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "hook", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "ico", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "ip", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "max", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "name", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "overlay", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "pdesc", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "pirate", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "port", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "qport", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "rates", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_color", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_desc", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "site", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "tags", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 130 }, "x-source-checks": [ "VerifyAuthToken" ], "x-observed-required-input": [ "game", "name" ], "x-observed-errors": [ "incorrect_data", "no_data", "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_project_create", "tags": [ "project" ], "summary": "project.create", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "color", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "company", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "desc", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "game", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "henable", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "hook", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "ico", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "ip", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "max", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "name", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "overlay", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "pdesc", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "pirate", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "port", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "qport", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "rates", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_color", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_desc", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "site", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "tags", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 130 }, "x-source-checks": [ "VerifyAuthToken" ], "x-observed-required-input": [ "game", "name" ], "x-observed-errors": [ "incorrect_data", "no_data", "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "color": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "company": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "desc": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "game": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "henable": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "hook": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "ico": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "ip": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "max": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "name": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "overlay": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "pdesc": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "pirate": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "port": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "qport": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "rates": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_color": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_desc": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "site": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "tags": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "color": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "company": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "desc": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "game": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "henable": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "hook": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "ico": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "ip": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "max": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "name": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "overlay": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "pdesc": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "pirate": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "port": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "qport": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "rates": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_color": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_desc": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "site": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "tags": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/project.createServer": { "get": { "operationId": "network_get__methods_project_createServer", "tags": [ "project" ], "summary": "project.createServer", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "color", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "desc", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "game", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "henable", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "hook", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "ico", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "ip", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "max", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "name", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "overlay", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "pirate", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "port", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "project_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "qport", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "rates", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "tags", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 176 }, "x-source-checks": [ "HasParam", "HasServerIdentityParams", "RequireProjectFeature", "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "project_id" ], "x-observed-errors": [ "incorrect_data", "no_data", "token_invalid" ], "x-feature-keys": [ "server.identity" ], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_project_createServer", "tags": [ "project" ], "summary": "project.createServer", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "color", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "desc", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "game", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "henable", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "hook", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "ico", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "ip", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "max", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "name", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "overlay", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "pirate", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "port", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "qport", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "rates", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "tags", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 176 }, "x-source-checks": [ "HasParam", "HasServerIdentityParams", "RequireProjectFeature", "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "project_id" ], "x-observed-errors": [ "incorrect_data", "no_data", "token_invalid" ], "x-feature-keys": [ "server.identity" ], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "color": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "desc": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "game": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "henable": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "hook": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "ico": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "ip": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "max": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "name": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "overlay": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "pirate": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "port": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "qport": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "rates": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "tags": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "color": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "desc": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "game": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "henable": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "hook": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "ico": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "ip": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "max": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "name": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "overlay": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "pirate": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "port": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "qport": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "rates": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "tags": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/project.downloadConfig": { "get": { "operationId": "network_get__methods_project_downloadConfig", "tags": [ "project" ], "summary": "project.downloadConfig", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "app_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "dev_api", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "project_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "security_key", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "service_key", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 399 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "project_id", "server_id" ], "x-observed-errors": [ "dedicated_project_mismatch", "game_not_supported", "incorrect_data", "server_not_belong_project" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_project_downloadConfig", "tags": [ "project" ], "summary": "project.downloadConfig", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "app_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "dev_api", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "security_key", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "service_key", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 399 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "project_id", "server_id" ], "x-observed-errors": [ "dedicated_project_mismatch", "game_not_supported", "incorrect_data", "server_not_belong_project" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "app_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "dev_api": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "security_key": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "service_key": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "app_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "dev_api": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "security_key": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "service_key": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/project.get": { "get": { "operationId": "network_get__methods_project_get", "tags": [ "project" ], "summary": "project.get", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 523 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "project_id" ], "x-observed-errors": [ "incorrect_data" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_project_get", "tags": [ "project" ], "summary": "project.get", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 523 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "project_id" ], "x-observed-errors": [ "incorrect_data" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/project.getConfig": { "get": { "operationId": "network_get__methods_project_getConfig", "tags": [ "project" ], "summary": "project.getConfig", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 322 }, "x-source-checks": [ "RequireProjectFeature", "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "project_id", "server_id" ], "x-observed-errors": [ "incorrect_data", "server_not_belong_project" ], "x-feature-keys": [ "panel.dashboard" ], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_project_getConfig", "tags": [ "project" ], "summary": "project.getConfig", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 322 }, "x-source-checks": [ "RequireProjectFeature", "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "project_id", "server_id" ], "x-observed-errors": [ "incorrect_data", "server_not_belong_project" ], "x-feature-keys": [ "panel.dashboard" ], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/project.getMine": { "get": { "operationId": "network_get__methods_project_getMine", "tags": [ "project" ], "summary": "project.getMine", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 450 }, "x-source-checks": [ "VerifyAuthToken" ], "x-observed-required-input": [], "x-observed-errors": [ "incorrect_data", "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_project_getMine", "tags": [ "project" ], "summary": "project.getMine", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 450 }, "x-source-checks": [ "VerifyAuthToken" ], "x-observed-required-input": [], "x-observed-errors": [ "incorrect_data", "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/project.getServersRuntime": { "get": { "operationId": "network_get__methods_project_getServersRuntime", "tags": [ "project" ], "summary": "project.getServersRuntime", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 118 }, "x-source-checks": [ "RequireProjectFeature", "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "project_id" ], "x-observed-errors": [ "dedicated_project_mismatch", "incorrect_data" ], "x-feature-keys": [ "panel.dashboard" ], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_project_getServersRuntime", "tags": [ "project" ], "summary": "project.getServersRuntime", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 118 }, "x-source-checks": [ "RequireProjectFeature", "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "project_id" ], "x-observed-errors": [ "dedicated_project_mismatch", "incorrect_data" ], "x-feature-keys": [ "panel.dashboard" ], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/project.getStats": { "get": { "operationId": "network_get__methods_project_getStats", "tags": [ "project" ], "summary": "project.getStats", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 554 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "project_id", "server_id" ], "x-observed-errors": [ "incorrect_data", "server_not_belong_project" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_project_getStats", "tags": [ "project" ], "summary": "project.getStats", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 554 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "project_id", "server_id" ], "x-observed-errors": [ "incorrect_data", "server_not_belong_project" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/project.openServer": { "get": { "operationId": "network_get__methods_project_openServer", "tags": [ "project" ], "summary": "project.openServer", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 284 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "project_id", "server_id" ], "x-observed-errors": [ "dedicated_project_mismatch", "incorrect_data", "no_data", "server_not_belong_project" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_project_openServer", "tags": [ "project" ], "summary": "project.openServer", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 284 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "project_id", "server_id" ], "x-observed-errors": [ "dedicated_project_mismatch", "incorrect_data", "no_data", "server_not_belong_project" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/project.setConfig": { "get": { "operationId": "network_get__methods_project_setConfig", "tags": [ "project" ], "summary": "project.setConfig", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "Action", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "AutoAfkKick", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "AutoAfkKickTime", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "AutoBanDisconnected", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "AutoBanReason", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "AutomaticBan", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "CallBackMethod", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "Cmd_Callback", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "Cmd_Question", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "Cmd_Report", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "D_Callback", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "D_CallbackHook", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "D_Enabled", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "D_Notify", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "D_NotifyHook", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "D_Report", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "D_ReportHook", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "EnableDebug", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "EnableSync", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_BackgroundColor", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_ChatColor", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_ChatColorTag", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_Font", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_FontSize", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_MenuBackgroundColor", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_MenuButtonColor", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_MenuTextColor", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_MenuTitleColor", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_ServerName", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_TextColor", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_CountryList", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_DirtyNick", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_DirtyNickData", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_GameBanned", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_KickCountry", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_KickVPN", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_NewAccount", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_PirateBans", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_SmallHours", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_SteamClosed", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_UnnecessaryBans", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_UnreliableBans", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_VACBanned", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "PackageUpdate", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "R_Enabled", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "R_SendSiteReports", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "ServerBroadcast", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "ServerName", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "TimeBanHours", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "project_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 336 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "project_id", "server_id" ], "x-observed-errors": [ "incorrect_data", "no_data", "server_not_belong_project" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_project_setConfig", "tags": [ "project" ], "summary": "project.setConfig", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "Action", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "AutoAfkKick", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "AutoAfkKickTime", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "AutoBanDisconnected", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "AutoBanReason", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "AutomaticBan", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "CallBackMethod", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "Cmd_Callback", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "Cmd_Question", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "Cmd_Report", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "D_Callback", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "D_CallbackHook", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "D_Enabled", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "D_Notify", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "D_NotifyHook", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "D_Report", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "D_ReportHook", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "EnableDebug", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "EnableSync", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_BackgroundColor", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_ChatColor", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_ChatColorTag", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_Font", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_FontSize", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_MenuBackgroundColor", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_MenuButtonColor", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_MenuTextColor", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_MenuTitleColor", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_ServerName", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "G_TextColor", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_CountryList", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_DirtyNick", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_DirtyNickData", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_GameBanned", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_KickCountry", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_KickVPN", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_NewAccount", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_PirateBans", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_SmallHours", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_SteamClosed", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_UnnecessaryBans", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_UnreliableBans", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "P_VACBanned", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "PackageUpdate", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "R_Enabled", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "R_SendSiteReports", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "ServerBroadcast", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "ServerName", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "TimeBanHours", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 336 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "project_id", "server_id" ], "x-observed-errors": [ "incorrect_data", "no_data", "server_not_belong_project" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Action": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "AutoAfkKick": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "AutoAfkKickTime": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "AutoBanDisconnected": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "AutoBanReason": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "AutomaticBan": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "CallBackMethod": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "Cmd_Callback": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "Cmd_Question": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "Cmd_Report": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "D_Callback": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "D_CallbackHook": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "D_Enabled": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "D_Notify": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "D_NotifyHook": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "D_Report": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "D_ReportHook": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "EnableDebug": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "EnableSync": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_BackgroundColor": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_ChatColor": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_ChatColorTag": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_Font": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_FontSize": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_MenuBackgroundColor": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_MenuButtonColor": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_MenuTextColor": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_MenuTitleColor": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_ServerName": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_TextColor": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_CountryList": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_DirtyNick": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_DirtyNickData": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_GameBanned": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_KickCountry": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_KickVPN": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_NewAccount": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_PirateBans": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_SmallHours": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_SteamClosed": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_UnnecessaryBans": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_UnreliableBans": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_VACBanned": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "PackageUpdate": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "R_Enabled": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "R_SendSiteReports": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "ServerBroadcast": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "ServerName": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "TimeBanHours": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Action": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "AutoAfkKick": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "AutoAfkKickTime": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "AutoBanDisconnected": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "AutoBanReason": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "AutomaticBan": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "CallBackMethod": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "Cmd_Callback": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "Cmd_Question": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "Cmd_Report": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "D_Callback": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "D_CallbackHook": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "D_Enabled": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "D_Notify": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "D_NotifyHook": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "D_Report": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "D_ReportHook": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "EnableDebug": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "EnableSync": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_BackgroundColor": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_ChatColor": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_ChatColorTag": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_Font": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_FontSize": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_MenuBackgroundColor": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_MenuButtonColor": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_MenuTextColor": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_MenuTitleColor": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_ServerName": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "G_TextColor": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_CountryList": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_DirtyNick": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_DirtyNickData": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_GameBanned": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_KickCountry": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_KickVPN": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_NewAccount": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_PirateBans": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_SmallHours": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_SteamClosed": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_UnnecessaryBans": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_UnreliableBans": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "P_VACBanned": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "PackageUpdate": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "R_Enabled": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "R_SendSiteReports": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "ServerBroadcast": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "ServerName": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "TimeBanHours": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/project.update": { "get": { "operationId": "network_get__methods_project_update", "tags": [ "project" ], "summary": "project.update", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "company", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "desc", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "hideinfo", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "ico", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "name", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "overlay", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "pdesc", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "project_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "site", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 215 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "name", "project_id" ], "x-observed-errors": [ "incorrect_data", "no_data" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_project_update", "tags": [ "project" ], "summary": "project.update", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "company", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "desc", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "hideinfo", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "ico", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "name", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "overlay", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "pdesc", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "site", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 215 }, "x-source-checks": [ "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "name", "project_id" ], "x-observed-errors": [ "incorrect_data", "no_data" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "company": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "desc": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "hideinfo": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "ico": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "name": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "overlay": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "pdesc": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "site": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "company": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "desc": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "hideinfo": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "ico": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "name": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "overlay": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "pdesc": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "site": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/project.updateServer": { "get": { "operationId": "network_get__methods_project_updateServer", "tags": [ "project" ], "summary": "project.updateServer", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "closed", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "color", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "desc", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "game", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "henable", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "hook", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "ico", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "ip", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "max", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "name", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "overlay", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "pirate", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "port", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "project_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "qport", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "rates", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "tags", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 238 }, "x-source-checks": [ "HasParam", "HasServerIdentityParams", "RequireProjectFeature", "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "project_id", "server_id" ], "x-observed-errors": [ "dedicated_project_mismatch", "incorrect_data", "no_data", "server_not_belong_project" ], "x-feature-keys": [ "server.identity" ], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_project_updateServer", "tags": [ "project" ], "summary": "project.updateServer", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "closed", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "color", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "desc", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "game", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "henable", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "hook", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "ico", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "ip", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "max", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "name", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "overlay", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "pirate", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "port", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "qport", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "rates", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "tags", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/project/Project.js", "line": 238 }, "x-source-checks": [ "HasParam", "HasServerIdentityParams", "RequireProjectFeature", "VerifyAuthToken", "VerifyProjectOwner" ], "x-observed-required-input": [ "project_id", "server_id" ], "x-observed-errors": [ "dedicated_project_mismatch", "incorrect_data", "no_data", "server_not_belong_project" ], "x-feature-keys": [ "server.identity" ], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "closed": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "color": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "desc": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "game": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "henable": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "hook": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "ico": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "ip": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "max": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "name": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "overlay": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "pirate": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "port": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "qport": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "rates": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "tags": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "closed": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "color": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "desc": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "game": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "henable": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "hook": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "ico": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "ip": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "max": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "name": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "overlay": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "pirate": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "port": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "qport": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "rates": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "tags": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/server.getConfig": { "get": { "operationId": "network_get__methods_server_getConfig", "tags": [ "server" ], "summary": "server.getConfig", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/server/Server.js", "line": 22 }, "x-source-checks": [ "HasServerAccess", "RequireProjectFeature", "VerifyAuthToken" ], "x-observed-required-input": [ "project_id", "server_id" ], "x-observed-errors": [ "access_denied", "another_project", "dedicated_project_mismatch", "incorrect_data", "token_invalid" ], "x-feature-keys": [ "panel.dashboard" ], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_server_getConfig", "tags": [ "server" ], "summary": "server.getConfig", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "server_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/server/Server.js", "line": 22 }, "x-source-checks": [ "HasServerAccess", "RequireProjectFeature", "VerifyAuthToken" ], "x-observed-required-input": [ "project_id", "server_id" ], "x-observed-errors": [ "access_denied", "another_project", "dedicated_project_mismatch", "incorrect_data", "token_invalid" ], "x-feature-keys": [ "panel.dashboard" ], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "project_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/server.getGameServerInfo": { "get": { "operationId": "network_get__methods_server_getGameServerInfo", "tags": [ "server" ], "summary": "server.getGameServerInfo", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation.", "parameters": [ { "name": "game_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "ip", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "port", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "qport", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/server/Server.js", "line": 10 }, "x-source-checks": [], "x-observed-required-input": [ "game_id", "ip", "port", "qport" ], "x-observed-errors": [ "incorrect_data" ], "x-feature-keys": [], "x-internal": false }, "post": { "operationId": "network_post__methods_server_getGameServerInfo", "tags": [ "server" ], "summary": "server.getGameServerInfo", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation.", "parameters": [ { "name": "game_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "ip", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "port", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "qport", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/server/Server.js", "line": 10 }, "x-source-checks": [], "x-observed-required-input": [ "game_id", "ip", "port", "qport" ], "x-observed-errors": [ "incorrect_data" ], "x-feature-keys": [], "x-internal": false, "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "game_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "ip": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "port": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "qport": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "game_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "ip": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "port": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "qport": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, "additionalProperties": true } } } } } }, "/methods/staff.addAdmin": { "get": { "operationId": "network_get__methods_staff_addAdmin", "tags": [ "staff" ], "summary": "staff.addAdmin", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "server_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_id", "in": "query", "required": true, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/staff/Staff.js", "line": 19 }, "x-source-checks": [ "RequireProjectFeature", "VerifyAuthToken" ], "x-observed-required-input": [ "server_id", "steam_id" ], "x-observed-errors": [ "incorrect_data", "no_data", "token_invalid" ], "x-feature-keys": [ "staff.access" ], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_staff_addAdmin", "tags": [ "staff" ], "summary": "staff.addAdmin", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "server_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_id", "in": "query", "required": false, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/staff/Staff.js", "line": 19 }, "x-source-checks": [ "RequireProjectFeature", "VerifyAuthToken" ], "x-observed-required-input": [ "server_id", "steam_id" ], "x-observed-errors": [ "incorrect_data", "no_data", "token_invalid" ], "x-feature-keys": [ "staff.access" ], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_id": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_id": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/staff.addModer": { "get": { "operationId": "network_get__methods_staff_addModer", "tags": [ "staff" ], "summary": "staff.addModer", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "server_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_id", "in": "query", "required": true, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/staff/Staff.js", "line": 43 }, "x-source-checks": [ "RequireProjectFeature", "VerifyAuthToken" ], "x-observed-required-input": [ "server_id", "steam_id" ], "x-observed-errors": [ "incorrect_data", "no_data", "token_invalid" ], "x-feature-keys": [ "staff.access" ], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_staff_addModer", "tags": [ "staff" ], "summary": "staff.addModer", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "server_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_id", "in": "query", "required": false, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/staff/Staff.js", "line": 43 }, "x-source-checks": [ "RequireProjectFeature", "VerifyAuthToken" ], "x-observed-required-input": [ "server_id", "steam_id" ], "x-observed-errors": [ "incorrect_data", "no_data", "token_invalid" ], "x-feature-keys": [ "staff.access" ], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_id": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_id": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/staff.get": { "get": { "operationId": "network_get__methods_staff_get", "tags": [ "staff" ], "summary": "staff.get", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "server_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/staff/Staff.js", "line": 7 }, "x-source-checks": [ "HasServerAccess", "RequireProjectFeature", "VerifyAuthToken" ], "x-observed-required-input": [ "server_id" ], "x-observed-errors": [ "access_denied", "incorrect_data", "token_invalid" ], "x-feature-keys": [ "staff.access" ], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_staff_get", "tags": [ "staff" ], "summary": "staff.get", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "server_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/staff/Staff.js", "line": 7 }, "x-source-checks": [ "HasServerAccess", "RequireProjectFeature", "VerifyAuthToken" ], "x-observed-required-input": [ "server_id" ], "x-observed-errors": [ "access_denied", "incorrect_data", "token_invalid" ], "x-feature-keys": [ "staff.access" ], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/staff.removeAdmin": { "get": { "operationId": "network_get__methods_staff_removeAdmin", "tags": [ "staff" ], "summary": "staff.removeAdmin", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "server_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_id", "in": "query", "required": true, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/staff/Staff.js", "line": 31 }, "x-source-checks": [ "RequireProjectFeature", "VerifyAuthToken" ], "x-observed-required-input": [ "server_id", "steam_id" ], "x-observed-errors": [ "incorrect_data", "no_data", "token_invalid" ], "x-feature-keys": [ "staff.access" ], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_staff_removeAdmin", "tags": [ "staff" ], "summary": "staff.removeAdmin", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "server_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_id", "in": "query", "required": false, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/staff/Staff.js", "line": 31 }, "x-source-checks": [ "RequireProjectFeature", "VerifyAuthToken" ], "x-observed-required-input": [ "server_id", "steam_id" ], "x-observed-errors": [ "incorrect_data", "no_data", "token_invalid" ], "x-feature-keys": [ "staff.access" ], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_id": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_id": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/staff.removeModer": { "get": { "operationId": "network_get__methods_staff_removeModer", "tags": [ "staff" ], "summary": "staff.removeModer", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "server_id", "in": "query", "required": true, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_id", "in": "query", "required": true, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/staff/Staff.js", "line": 55 }, "x-source-checks": [ "RequireProjectFeature", "VerifyAuthToken" ], "x-observed-required-input": [ "server_id", "steam_id" ], "x-observed-errors": [ "incorrect_data", "no_data", "token_invalid" ], "x-feature-keys": [ "staff.access" ], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_staff_removeModer", "tags": [ "staff" ], "summary": "staff.removeModer", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "server_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_id", "in": "query", "required": false, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/staff/Staff.js", "line": 55 }, "x-source-checks": [ "RequireProjectFeature", "VerifyAuthToken" ], "x-observed-required-input": [ "server_id", "steam_id" ], "x-observed-errors": [ "incorrect_data", "no_data", "token_invalid" ], "x-feature-keys": [ "staff.access" ], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_id": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "server_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_id": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } }, "/methods/user.get": { "get": { "operationId": "network_get__methods_user_get", "tags": [ "user" ], "summary": "user.get", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "ext", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "game_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_id", "in": "query", "required": true, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "x", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/user/User.js", "line": 17 }, "x-source-checks": [ "VerifyAuthToken" ], "x-observed-required-input": [ "steam_id" ], "x-observed-errors": [ "incorrect_data", "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ] }, "post": { "operationId": "network_post__methods_user_get", "tags": [ "user" ], "summary": "user.get", "description": "Registered RPC handler. The response payload is method-specific. Parameters may also be read in delegated code; this inventory does not claim exhaustive validation. Personal Network auth accepts a verified SSO RS256 account-scope Bearer token; legacy access_token remains a compatibility alternative, including POST body.", "parameters": [ { "name": "ext", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "game_id", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "steam_id", "in": "query", "required": false, "schema": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." } }, { "name": "x", "in": "query", "required": false, "schema": { "description": "Read by source. No type is asserted without an explicit reviewed schema." } }, { "name": "access_token", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Application success or application error; inspect status, not only HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Success" }, { "$ref": "#/components/schemas/Error" } ] } } } }, "default": { "description": "Transport, middleware or proxy error. SecureChannel routes can use encrypted responses." } }, "x-source": { "repository": "ozl.ozprotect.node", "file": "api/user/User.js", "line": 17 }, "x-source-checks": [ "VerifyAuthToken" ], "x-observed-required-input": [ "steam_id" ], "x-observed-errors": [ "incorrect_data", "token_invalid" ], "x-feature-keys": [], "x-internal": false, "security": [ { "Bearer": [] }, { "AccessToken": [] } ], "requestBody": { "required": false, "description": "Body overrides matching query fields. x-observed-required-input identifies required input across both locations. Nested/raw payload schemas remain open.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ext": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "game_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_id": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "x": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ext": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "game_id": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "steam_id": { "type": "string", "description": "String input; preserve identifier precision and credential encoding." }, "x": { "description": "Read by source. No type is asserted without an explicit reviewed schema." }, "access_token": { "type": "string", "writeOnly": true } }, "additionalProperties": true } } } } } } }, "components": { "schemas": { "Success": { "type": "object", "required": [ "status", "response" ], "properties": { "status": { "const": "success" }, "response": {}, "info": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, "Error": { "type": "object", "required": [ "status", "error" ], "properties": { "status": { "const": "error" }, "error": { "type": "object", "properties": { "name": { "type": "string" }, "message": { "type": "string" } }, "required": [ "name", "message" ], "additionalProperties": true } }, "additionalProperties": true } }, "securitySchemes": { "AccessToken": { "type": "apiKey", "in": "query", "name": "access_token", "description": "Legacy access_token request field. POST may carry it in the body instead; this is not an HTTP Bearer token." }, "Bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Only routes explicitly using JWT authentication." } } }, "x-source-snapshot": { "repository": "ozl.ozprotect.node", "commit": "0a212fd383e661a2bd70fdb3970db226a5d743eb", "ref": "working-tree", "dirty": false } }