{ "paths": { "/api/v1/admin/rust/config/{serverId}/file": { "get": { "tags": [ "Admin · Rust" ], "summary": "One configuration file", "description": "The file’s text, the version a save must present back, and the field list the generated form is drawn from — types, keys, and which values are credentials. A file that is already broken on disk still opens, with the parse error, because the raw tier is the only thing that can fix it.", "parameters": [ { "name": "serverId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "path", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The file and the reading of it" }, "400": { "description": "Not a configuration path" }, "503": { "description": "The sidecar or the game is unreachable" } } }, "post": { "tags": [ "Admin · Rust" ], "summary": "Save a configuration file and reload its plugin", "description": "Send `edits` (the generated form: pointers and literals, type-preserving) or `text` (the raw tier: the whole document). `version` must match what the host holds or the save is refused 409 with the current file. The game backs the file up, writes it, reloads the named plugin, and **restores the old file automatically** if the plugin does not come back — which is answered 200 with `report.rolledBack`, because a rollback is a round trip that worked and an edit that did not.", "parameters": [ { "name": "serverId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "What happened: applied, or rolled back with the reason" }, "400": { "description": "Invalid body, an edit the form may not make, or a locked key" }, "409": { "description": "The file changed on the host since it was read" }, "503": { "description": "The sidecar or the game is unreachable" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "path": { "example": "any" }, "edits": { "example": "any" }, "reload": { "example": "any" }, "version": { "example": "any" }, "text": { "example": "any" } } } } } } } }, "/api/v1/admin/rust/config/{serverId}/files": { "get": { "tags": [ "Admin · Rust" ], "summary": "Every plugin configuration file on one server", "description": "A live recursive walk of the game host’s configuration directory, grouped by the plugin each file probably belongs to, plus every plugin currently loaded. The root comes from the mod framework, so it is `oxide/config` on Oxide and `carbon/configs` on Carbon. Files past the size limit are listed and marked un-editable rather than hidden. The game’s data directory is never walked.", "parameters": [ { "name": "serverId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The configuration tree and the loaded plugins" }, "502": { "description": "Bad Gateway" }, "503": { "description": "The sidecar or the game is unreachable" } } } }, "/api/v1/admin/rust/config/{serverId}/writes": { "get": { "tags": [ "Admin · Rust" ], "summary": "Recent configuration writes", "description": "The audit trail for one server: who changed which field, from what to what, whether the plugin reloaded, and whether the change was rolled back. Refused and unreachable attempts are recorded too — an operator asking why a setting is not what they set needs to see that somebody tried. Values of credential-shaped fields are never stored.", "parameters": [ { "name": "serverId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The recent writes, newest first" }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/admin/rust/permissions": { "get": { "tags": [ "Admin · Rust" ], "summary": "The whole permission model", "description": "Groups with their permissions and members, direct grants, the drift each server reported, the option source of registered permission names, and the sync state of every configured server.", "responses": { "200": { "description": "The authored model and what each game reported", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RustPermissionModel" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/admin/rust/permissions/catalogue": { "get": { "tags": [ "Admin · Rust" ], "summary": "Permission names the servers have registered", "description": "What the loaded plugins on each configured server have registered, cached from the last sync. It is the option source for the authoring form: a permission no server knows cannot be granted, because `GrantUserPermission` silently does nothing for an unregistered name.", "responses": { "200": { "description": "Every registered name, and which servers know it", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RustPermissionCatalogue" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/admin/rust/permissions/drift/{id}/adopt": { "post": { "tags": [ "Admin · Rust" ], "summary": "Adopt a hand edit", "description": "Records a grant or membership somebody made in game as one the site authors, so it stops being reported and starts being maintained. It needs a website account holding that Steam id; without one there is nobody to author it against, and the answer is to revoke it or to ask the player to link.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Adopted" }, "400": { "description": "That kind of drift cannot be adopted" }, "404": { "description": "Not Found" }, "409": { "description": "That Steam account is linked to nobody on this site" }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/admin/rust/permissions/drift/{id}/revoke": { "post": { "tags": [ "Admin · Rust" ], "summary": "Revoke a hand edit", "description": "Queues the removal rather than performing it: a server that is down keeps the instruction until it comes back. This is the only way the site removes something it did not put there — a sync never does it on its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Queued for the next sync" }, "404": { "description": "No such drift" }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/admin/rust/permissions/grants": { "post": { "tags": [ "Admin · Rust" ], "summary": "Grant one permission to one person", "description": "A direct grant, authored against a website user and pushed to every Steam account they have linked. Unlike group membership it reaches a player who has never connected to the server, which is what an entitlement earned on the website has to do.", "responses": { "200": { "description": "They already held it; nothing changed" }, "201": { "description": "Granted" }, "400": { "description": "Invalid body, or a scope naming no configured server" }, "404": { "description": "No account on this site has that name" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "permission": { "example": "any" }, "scope": { "example": "any" }, "note": { "example": "any" } } } } } } } }, "/api/v1/admin/rust/permissions/grants/{id}": { "delete": { "tags": [ "Admin · Rust" ], "summary": "Remove a grant", "description": "The next sync revokes it in every in-scope game. A player who has already used what it allowed keeps what they did with it — the grant is the entitlement, not the consumption.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Removed" }, "404": { "description": "No such grant" }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/admin/rust/permissions/groups/{name}": { "put": { "tags": [ "Admin · Rust" ], "summary": "Create or update a permission group", "description": "Writes the group and the permissions it carries in one request, because they are one idea on the form. `scope` is a server id or `*` for the whole fleet. The group is mirrored into each in-scope game as a real group, so third-party plugins that read group membership see it.", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Saved" }, "400": { "description": "Invalid body, or a scope naming no configured server" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "example": "any" }, "title": { "example": "any" }, "rank": { "example": "any" }, "permissions": { "example": "any" } } } } } } }, "delete": { "tags": [ "Admin · Rust" ], "summary": "Delete a permission group", "description": "Removes the group, its permission list and its membership from the site. The next sync retires the group from every server it had been pushed to — a group the site authored and has withdrawn is removed from the game, unlike one somebody created by hand.", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "404": { "description": "No such group" }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/admin/rust/permissions/groups/{name}/members": { "post": { "tags": [ "Admin · Rust" ], "summary": "Put an account in a group", "description": "Membership is authored against a website user and reaches every Steam account they have linked. A member who has never connected to a server cannot be placed in its store yet — the sync reports them as pending and the membership lands on their first connection.", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Added" }, "400": { "description": "Bad Request" }, "404": { "description": "No such group" } } } }, "/api/v1/admin/rust/permissions/groups/{name}/members/{userId}": { "delete": { "tags": [ "Admin · Rust" ], "summary": "Take an account out of a group", "description": "", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Removed" }, "404": { "description": "No such group, or that account is not in it" }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/admin/rust/permissions/sync": { "post": { "tags": [ "Admin · Rust" ], "summary": "Push the permission set now", "description": "Runs the reconciliation loop’s pass immediately, for one server or for all of them, and answers with what each one reported. The loop does this on its own; the button exists so an operator who has just changed something can see it land, and finds out at once when a server is unreachable.", "responses": { "200": { "description": "The state of every server after the pass", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RustPermissionSyncResult" } } } }, "404": { "description": "No such server" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "req": { "example": "any" } } } } } } } }, "/api/v1/admin/rust/servers": { "get": { "tags": [ "Admin · Rust" ], "summary": "Every configured Rust server", "description": "The operator’s server rows with their sidecar URLs, whether a token is stored, and whether each sidecar was reachable on the last poll. The token itself is never returned.", "responses": { "200": { "description": "The configured servers", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RustAdminServerList" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/admin/rust/servers/{id}": { "put": { "tags": [ "Admin · Rust" ], "summary": "Create or update a Rust server", "description": "Writes one server row. `sidecarToken` is write-only — send it to set or rotate the credential, and omit it or send an empty string to leave the stored one untouched. The id is the slug every URL under the module carries.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Saved" }, "400": { "description": "Invalid body" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "example": "any" }, "sidecarBaseUrl": { "example": "any" }, "sidecarToken": { "example": "any" }, "protocol": { "example": "any" }, "enabled": { "example": "any" }, "sortOrder": { "example": "any" } } } } } } }, "delete": { "tags": [ "Admin · Rust" ], "summary": "Remove a Rust server", "description": "Deletes the server row and the observed state that hangs off it. It does not touch the sidecar or the game host — those are removed with the installer.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/admin/rust/servers/{id}/test": { "post": { "tags": [ "Admin · Rust" ], "summary": "Probe a server’s sidecar", "description": "Calls the sidecar’s health endpoint with the stored credential and reports what came back — whether it answered, whether the bridge plugin is connected to it, and which protocol version it speaks. This is the one route that tells a wrong URL from a wrong token from a mismatched version.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "What the sidecar said", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RustSidecarProbe" } } } }, "404": { "description": "No such server" }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/admin/users/{id}/rust/links": { "get": { "tags": [ "Admin · Users" ], "summary": "A user’s linked Steam accounts and their Rust record (admin only)", "description": "Every Steam account linked to this website user, with the display name the game last saw and, per server, all-time kills / deaths / playtime across every wipe. Fills the admin.users.detail extension slot.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "User id." } ], "responses": { "200": { "description": "Linked accounts", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RustAdminLinkList" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ] } }, "/api/v1/admin/users/{id}/rust/links/{steamId}": { "delete": { "tags": [ "Admin · Users" ], "summary": "Sever a user’s Steam link (admin only)", "description": "Staff release a link on this user’s behalf. It is the counterweight to the site refusing to move a Steam id another account holds: a player who cannot reach that Steam account in game has no other way back. Recorded in the activity log.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "User id." }, { "name": "steamId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The Steam id to release." } ], "responses": { "200": { "description": "Unlinked", "content": { "application/json": { "schema": { "type": "object", "properties": { "unlinked": { "type": "boolean", "example": true } } } } } }, "404": { "description": "Not linked to this user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ] } }, "/api/v1/admin/users/{id}/rust/permissions": { "get": { "tags": [ "Admin · Users" ], "summary": "A user’s Rust privileges (admin only)", "description": "The groups this person is in, the permissions granted to them directly, and the Steam accounts those privileges actually reach. An empty `reaches` means they have linked nothing and hold them on paper only.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "User id." } ], "responses": { "200": { "description": "Their groups and grants", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RustUserPermissions" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ] } }, "/api/v1/admin/users/{id}/rust/permissions/grants": { "post": { "tags": [ "Admin · Users" ], "summary": "Grant a Rust permission to this user (admin only)", "description": "Authored against the website account, so it reaches every Steam id they have linked — now and later. `scope` is a server id or `*` for the fleet. The push happens on the mirror’s next pass.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "User id." } ], "responses": { "200": { "description": "They already held it" }, "201": { "description": "Granted" }, "400": { "description": "Invalid body, or a scope naming no configured server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "permission": { "example": "any" }, "scope": { "example": "any" } } } } } } } }, "/api/v1/admin/users/{id}/rust/permissions/grants/{grantId}": { "delete": { "tags": [ "Admin · Users" ], "summary": "Remove a Rust permission from this user (admin only)", "description": "Scoped to this user as well as to the grant, so a wrong id on the URL removes nothing rather than somebody else’s privilege. The revoke reaches the game on the mirror’s next pass.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "User id." }, { "name": "grantId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The grant to remove." } ], "responses": { "204": { "description": "Removed" }, "404": { "description": "No such grant for this user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ] } }, "/api/v1/player/rust/link": { "post": { "tags": [ "Player · Rust" ], "summary": "Link a Steam account with a one-time code from /link in game", "description": "The player types /link in game, the plugin hands them a six-character code privately, and they enter it here within five minutes. The site asks each configured server in turn until one recognises the code. A Steam account already linked to a different website account is refused rather than moved — the way out is /unlink in game.", "responses": { "200": { "description": "Linked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RustLinkResult" } } } }, "400": { "description": "Unknown or expired code", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "That Steam account is linked to another website account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many link attempts", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error" }, "503": { "description": "A server could not be reached — the code is still good", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RustLinkRequest" } } } } } }, "/api/v1/player/rust/links": { "get": { "tags": [ "Player · Rust" ], "summary": "The Steam accounts the caller has linked", "description": "Every Steam account linked to the signed-in user, newest first. A link is fleet-wide: it is keyed by Steam id, not by server, because a Steam account is one person across every server an operator runs.", "responses": { "200": { "description": "Linked accounts", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RustLinkList" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ] } }, "/api/v1/player/rust/links/{steamId}": { "delete": { "tags": [ "Player · Rust" ], "summary": "Release a Steam account the caller has linked", "description": "Removes the caller’s own link. Scoped to the caller in the statement, so a link belonging to somebody else answers the same 404 as one that does not exist.", "parameters": [ { "name": "steamId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The Steam id to release." } ], "responses": { "200": { "description": "Unlinked", "content": { "application/json": { "schema": { "type": "object", "properties": { "unlinked": { "type": "boolean", "example": true } } } } } }, "404": { "description": "Not linked to the caller", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ] } }, "/api/v1/player/rust/permissions": { "get": { "tags": [ "Player · Rust" ], "summary": "What the site has given the caller in game", "description": "The groups and direct grants the site holds for the signed-in user, each resolved to the servers its scope reaches and marked with whether that server has it yet. Read-only: a grant a player could change would not be a grant. `live` is the pushed ledger rather than the authored row, so an entitlement that has not reached a game reads as waiting — which is also what an offline server, a permission no loaded plugin registered, and an account the store has never seen all look like from here.", "responses": { "200": { "description": "What the caller holds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RustPlayerPermissions" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ] } }, "/api/v1/player/rust/servers": { "get": { "tags": [ "Player · Rust" ], "summary": "The Rust servers, for a signed-in player", "description": "The same servers the public list carries, answered on the authenticated tier. It is the address a signed-in client calls, so that per-player detail can be added here without moving it. Requires a session.", "responses": { "200": { "description": "The server list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RustServerList" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/public/rust/servers": { "get": { "tags": [ "Public · Rust" ], "summary": "Every Rust server this site follows", "description": "The operator’s configured Rust servers and what each one last reported. Answers with `online: false` and `stale: true` rather than failing when a game server or its sidecar is unreachable — the site’s availability does not depend on the game’s.", "responses": { "200": { "description": "The server list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RustServerList" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/public/rust/servers/{id}": { "get": { "tags": [ "Public · Rust" ], "summary": "One Rust server", "description": "The same shape the list answers with, for one server, and a `404` when there is no such server or an operator has disabled it. The detail page needs the difference: every other route under this path answers an empty list for an id that does not exist, because an unknown server genuinely has no events and nobody online.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The server’s slug" } ], "responses": { "200": { "description": "The server" }, "404": { "description": "No such server, or it is disabled" }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/public/rust/servers/{id}/events": { "get": { "tags": [ "Public · Rust" ], "summary": "Recent events on one Rust server", "description": "The killfeed and everything else public that happened on a server, newest first. Narrow with `kind` (comma-separated) and `wipe`. Only publicly classified kinds are ever returned — moderation events, login attempts and anything carrying an IP address are stored but never served here.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The server’s slug" }, { "name": "kind", "in": "query", "required": false, "description": "One kind, or several comma-separated", "schema": { "type": "string" } }, { "name": "wipe", "in": "query", "required": false, "description": "Restrict to one wipe id", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Rows to return, capped at 200", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Recent events, newest first" }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/public/rust/servers/{id}/leaderboard": { "get": { "tags": [ "Public · Rust" ], "summary": "The leaderboard for one Rust server", "description": "Per-wipe when `wipe` is given, all-time otherwise. All-time is the per-wipe rows summed rather than a second set of counters, so a wipe splits a player’s history without ending it.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The server’s slug" }, { "name": "wipe", "in": "query", "required": false, "description": "Restrict to one wipe id", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "kills, deaths, npcKills or playtime", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Rows to return, capped at 200", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "The leaderboard" }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/public/rust/servers/{id}/online": { "get": { "tags": [ "Public · Rust" ], "summary": "Who is on one Rust server right now", "description": "Read from the presence board the bridge re-sends on every connect and every minute, rather than counted from connect and disconnect events — so it is correct even after the website has missed one.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The server’s slug" } ], "responses": { "200": { "description": "Who is online" }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/public/rust/servers/{id}/wipes": { "get": { "tags": [ "Public · Rust" ], "summary": "Every wipe this server has had", "description": "Newest first. A wipe id is derived by the bridge plugin from the save’s creation time and stamped on every frame, so it is the same id the events and the leaderboard are filtered by.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The server’s slug" } ], "responses": { "200": { "description": "The wipes" }, "500": { "description": "Internal Server Error" } } } } }, "tags": [ { "name": "Public · Rust", "description": "The Rust servers this site follows, as each one last reported itself" }, { "name": "Player · Rust", "description": "The Rust surface for a signed-in player" }, { "name": "Admin · Rust", "description": "Configuring the Rust servers and their sidecars" } ], "components": { "schemas": { "RustServerList": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "description": { "type": "string", "example": "Every Rust server this site follows (GET /public/rust/servers)." }, "properties": { "type": "object", "properties": { "servers": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "items": { "$ref": "#/components/schemas/RustServer" } } } } } } }, "RustServer": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "description": { "type": "string", "example": "One Rust server, as it last reported itself." }, "properties": { "type": "object", "properties": { "id": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "main" } } }, "name": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "Main · Vanilla" } } }, "online": { "type": "object", "properties": { "type": { "type": "string", "example": "boolean" }, "example": { "type": "boolean", "example": true } } }, "players": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 42 } } }, "maxPlayers": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 100 } } }, "hostname": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "nullable": { "type": "boolean", "example": true }, "example": { "type": "string", "example": "Runic Gateway · Main" } } }, "level": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "nullable": { "type": "boolean", "example": true }, "example": { "type": "string", "example": "Procedural Map" } } }, "worldSize": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "nullable": { "type": "boolean", "example": true }, "example": { "type": "number", "example": 4000 } } }, "seed": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "nullable": { "type": "boolean", "example": true }, "example": { "type": "number", "example": 1234 } } }, "updatedAt": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "format": { "type": "string", "example": "date-time" }, "nullable": { "type": "boolean", "example": true } } }, "stale": { "type": "object", "properties": { "type": { "type": "string", "example": "boolean" }, "description": { "type": "string", "example": "Has nothing reported in longer than the freshness window? A stale row is reported offline." }, "example": { "type": "boolean", "example": false } } } } } } }, "RustAdminServerList": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "description": { "type": "string", "example": "The configured servers, with their sidecar settings (GET /admin/rust/servers)." }, "properties": { "type": "object", "properties": { "servers": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "items": { "$ref": "#/components/schemas/RustAdminServer" } } } } } } }, "RustAdminServer": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "description": { "type": "string", "example": "One configured server. The sidecar token is never included — `hasToken` reports only whether one is stored." }, "properties": { "type": "object", "properties": { "id": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "main" } } }, "name": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "Main · Vanilla" } } }, "sidecarBaseUrl": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "http://10.0.0.5:8090" } } }, "hasToken": { "type": "object", "properties": { "type": { "type": "string", "example": "boolean" }, "example": { "type": "boolean", "example": true } } }, "protocol": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 1 } } }, "enabled": { "type": "object", "properties": { "type": { "type": "string", "example": "boolean" }, "example": { "type": "boolean", "example": true } } }, "sortOrder": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 0 } } }, "reachable": { "type": "object", "properties": { "type": { "type": "string", "example": "boolean" }, "description": { "type": "string", "example": "Did the sidecar answer on the last poll? Separate from `online`, which is about the game rather than the bridge." }, "example": { "type": "boolean", "example": true } } }, "bootId": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "nullable": { "type": "boolean", "example": true }, "example": { "type": "string", "example": "boot-20260915T194502Z" } } }, "sidecarProtocol": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "nullable": { "type": "boolean", "example": true }, "example": { "type": "number", "example": 1 } } }, "online": { "type": "object", "properties": { "type": { "type": "string", "example": "boolean" }, "example": { "type": "boolean", "example": true } } }, "players": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 42 } } }, "stale": { "type": "object", "properties": { "type": { "type": "string", "example": "boolean" }, "example": { "type": "boolean", "example": false } } } } } } }, "RustLink": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "description": { "type": "string", "example": "One Steam account linked to a website user. Never carries a code." }, "properties": { "type": "object", "properties": { "steamId": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "76561198000000000" } } }, "name": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "nullable": { "type": "boolean", "example": true }, "description": { "type": "string", "example": "What the player was called in game when they linked. A display name only — a Rust name changes on a whim and nothing identifies anybody by it." }, "example": { "type": "string", "example": "Wanderer" } } }, "serverId": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "nullable": { "type": "boolean", "example": true }, "description": { "type": "string", "example": "Which server minted the code. Not part of the identity — a link is fleet-wide — but it is where a support conversation starts." }, "example": { "type": "string", "example": "main" } } }, "linkedAt": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "format": { "type": "string", "example": "date-time" } } } } } } }, "RustLinkList": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "description": { "type": "string", "example": "The Steam accounts one website user holds (GET /player/rust/links)." }, "properties": { "type": "object", "properties": { "links": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "items": { "$ref": "#/components/schemas/RustLink" } } } } } } }, "RustPlayerReach": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "description": { "type": "string", "example": "One server an entitlement’s scope reaches, and whether it is there yet." }, "properties": { "type": "object", "properties": { "id": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "main" } } }, "name": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "Main · Vanilla+" } } }, "live": { "type": "object", "properties": { "type": { "type": "string", "example": "boolean" }, "description": { "type": "string", "example": "True only when a sync confirmed this into that server’s own store. False covers every way it has not arrived — the server is offline, no loaded plugin registered the name, or its store has never seen the account — and the difference between those is an operator’s diagnosis, not a player’s." }, "example": { "type": "boolean", "example": true } } } } } } }, "RustPlayerPermissions": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "description": { "type": "string", "example": "What the site has given the signed-in player in game (GET /player/rust/permissions)." }, "properties": { "type": "object", "properties": { "accounts": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "description": { "type": "string", "example": "How many Steam accounts the caller has linked. Zero is why an entitlement can be authored and reach nobody." }, "example": { "type": "number", "example": 1 } } }, "groups": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "items": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "properties": { "type": "object", "properties": { "name": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "vip" } } }, "title": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "VIP" } } }, "scope": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "description": { "type": "string", "example": "A server id, or `*` for the whole fleet." }, "example": { "type": "string", "example": "*" } } }, "since": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "format": { "type": "string", "example": "date-time" } } }, "permissions": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "items": { "type": "object", "properties": { "type": { "type": "string", "example": "string" } } }, "example": { "type": "array", "example": [ "kits.vip" ], "items": { "type": "string" } } } }, "reach": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "items": { "$ref": "#/components/schemas/RustPlayerReach" } } } } } } } } }, "grants": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "items": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "properties": { "type": "object", "properties": { "permission": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "kits.vip" } } }, "scope": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "*" } } }, "source": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "description": { "type": "string", "example": "Who authored it — `admin` now, an event action later." }, "example": { "type": "string", "example": "admin" } } }, "note": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "nullable": { "type": "boolean", "example": true } } }, "since": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "format": { "type": "string", "example": "date-time" } } }, "reach": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "items": { "$ref": "#/components/schemas/RustPlayerReach" } } } } } } } } } } } } }, "RustLinkRequest": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "required": { "type": "array", "example": [ "code" ], "items": { "type": "string" } }, "properties": { "type": "object", "properties": { "code": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "description": { "type": "string", "example": "The six-character code /link handed the player in game. Good for five minutes, and it works once." }, "example": { "type": "string", "example": "K7M2PQ" } } } } } } }, "RustLinkResult": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "description": { "type": "string", "example": "The result of redeeming a code." }, "properties": { "type": "object", "properties": { "linked": { "type": "object", "properties": { "type": { "type": "string", "example": "boolean" }, "example": { "type": "boolean", "example": true } } }, "link": { "$ref": "#/components/schemas/RustLink" }, "already": { "type": "object", "properties": { "type": { "type": "string", "example": "boolean" }, "description": { "type": "string", "example": "True when this Steam id was already linked to the caller — a second press of the button, not an error." }, "example": { "type": "boolean", "example": false } } } } } } }, "RustAdminLinkList": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "description": { "type": "string", "example": "One user’s Rust identity, for the admin.users.detail panel (GET /admin/users/{id}/rust/links)." }, "properties": { "type": "object", "properties": { "links": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "items": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "properties": { "type": "object", "properties": { "steamId": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "76561198000000000" } } }, "name": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "nullable": { "type": "boolean", "example": true }, "description": { "type": "string", "example": "What the game last saw this player called, falling back to the name recorded at link time." }, "example": { "type": "string", "example": "Wanderer" } } }, "linkedName": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "nullable": { "type": "boolean", "example": true }, "example": { "type": "string", "example": "Wanderer" } } }, "serverId": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "nullable": { "type": "boolean", "example": true }, "example": { "type": "string", "example": "main" } } }, "linkedAt": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "format": { "type": "string", "example": "date-time" } } }, "firstSeen": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "format": { "type": "string", "example": "date-time" }, "nullable": { "type": "boolean", "example": true } } }, "lastSeen": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "format": { "type": "string", "example": "date-time" }, "nullable": { "type": "boolean", "example": true } } }, "servers": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "description": { "type": "string", "example": "All-time totals per server, summed across every wipe." }, "items": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "properties": { "type": "object", "properties": { "serverId": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "main" } } }, "serverName": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "Main · Vanilla" } } }, "kills": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 41 } } }, "deaths": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 37 } } }, "npcKills": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 120 } } }, "structures": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 64 } } }, "playtimeSec": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 43200 } } }, "wipes": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 2 } } }, "lastSeen": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "format": { "type": "string", "example": "date-time" }, "nullable": { "type": "boolean", "example": true } } } } } } } } } } } } } } } } } } }, "RustPermissionModel": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "description": { "type": "string", "example": "The whole permission model (GET /admin/rust/permissions): what the site authors, what each game reported back, and the names a grant may use." }, "properties": { "type": "object", "properties": { "groups": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "description": { "type": "string", "example": "Groups the site authors, mirrored into each in-scope game as a real group." }, "items": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "properties": { "type": "object", "properties": { "name": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "vip" } } }, "title": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "VIP" } } }, "rank": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 10 } } }, "scope": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "description": { "type": "string", "example": "A server id, or `*` for every server." }, "example": { "type": "string", "example": "*" } } }, "permissions": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "items": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "kits.vip" } } } } }, "members": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "items": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "properties": { "type": "object", "properties": { "userId": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 42 } } }, "username": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "wanderer" } } }, "steamId": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "nullable": { "type": "boolean", "example": true }, "description": { "type": "string", "example": "Null when this account has linked no Steam id, in which case the membership reaches nobody yet." }, "example": { "type": "string", "example": "76561198000000000" } } }, "playerName": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "nullable": { "type": "boolean", "example": true }, "example": { "type": "string", "example": "Wanderer" } } } } } } } } } } } } } } }, "grants": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "description": { "type": "string", "example": "Permissions held by one person without a group. Unlike membership, a direct grant reaches a player who has never connected." }, "items": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "properties": { "type": "object", "properties": { "id": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 7 } } }, "userId": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 42 } } }, "username": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "wanderer" } } }, "permission": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "kits.gold" } } }, "scope": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "main" } } }, "source": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "description": { "type": "string", "example": "What authored it — `admin`, `adopted`, or a later phase’s own writer." }, "example": { "type": "string", "example": "admin" } } }, "note": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "nullable": { "type": "boolean", "example": true }, "example": {} } }, "grantedAt": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "format": { "type": "string", "example": "date-time" } } }, "accounts": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "description": { "type": "string", "example": "The Steam accounts this grant reaches. Empty means it reaches nobody yet." }, "items": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "properties": { "type": "object", "properties": { "steamId": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "76561198000000000" } } }, "name": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "nullable": { "type": "boolean", "example": true }, "example": { "type": "string", "example": "Wanderer" } } } } } } } } } } } } } } }, "servers": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "description": { "type": "string", "example": "The state of the mirror, per configured server." }, "items": { "$ref": "#/components/schemas/RustPermissionSyncState" } } }, "drift": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "description": { "type": "string", "example": "What a game holds that the site did not author. Reported, never undone." }, "items": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "properties": { "type": "object", "properties": { "id": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 3 } } }, "serverId": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "main" } } }, "kind": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "description": { "type": "string", "example": "One of `grant`, `member`, `group-permission`." }, "example": { "type": "string", "example": "grant" } } }, "subject": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "description": { "type": "string", "example": "A Steam id, or a group name." }, "example": { "type": "string", "example": "76561198000000000" } } }, "object": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "description": { "type": "string", "example": "A permission name, or a group name." }, "example": { "type": "string", "example": "kits.admin" } } }, "username": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "nullable": { "type": "boolean", "example": true }, "description": { "type": "string", "example": "The website account holding that Steam id, when there is one. Without it the drift cannot be adopted, only revoked." }, "example": { "type": "string", "example": "wanderer" } } }, "firstSeen": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "format": { "type": "string", "example": "date-time" } } } } } } } } }, "catalogue": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "items": { "$ref": "#/components/schemas/RustPermissionCatalogueEntry" } } } } } } }, "RustPermissionSyncState": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "description": { "type": "string", "example": "Whether one server’s store matches what the site authors, and what its last report said." }, "properties": { "type": "object", "properties": { "serverId": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "main" } } }, "state": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "description": { "type": "string", "example": "One of `pending`, `ok`, `failed`." }, "example": { "type": "string", "example": "ok" } } }, "inSync": { "type": "object", "properties": { "type": { "type": "string", "example": "boolean" }, "description": { "type": "string", "example": "True when the last successful push carried the set the site currently authors." }, "example": { "type": "boolean", "example": true } } }, "dirty": { "type": "object", "properties": { "type": { "type": "string", "example": "boolean" }, "example": { "type": "boolean", "example": false } } }, "lastAttemptAt": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "format": { "type": "string", "example": "date-time" }, "nullable": { "type": "boolean", "example": true } } }, "lastOkAt": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "format": { "type": "string", "example": "date-time" }, "nullable": { "type": "boolean", "example": true } } }, "error": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "nullable": { "type": "boolean", "example": true }, "description": { "type": "string", "example": "Why the last attempt failed — a transport word (`timeout`, `no-token`, `protocol-mismatch`) or the game’s own refusal." }, "example": {} } }, "report": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "nullable": { "type": "boolean", "example": true }, "description": { "type": "string", "example": "The plugin’s report from the last successful sync." }, "properties": { "type": "object", "properties": { "applied": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "properties": { "type": "object", "properties": { "grants": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 2 } } }, "revokes": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 0 } } }, "groupsCreated": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 1 } } }, "members": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 3 } } } } } } }, "alreadyCorrect": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 14 } } }, "unresolved": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "description": { "type": "string", "example": "Permission names no loaded plugin on that server has registered. A grant naming one lands nowhere and is not recorded as pushed." }, "items": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "kits.gold" } } } } }, "pending": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "description": { "type": "string", "example": "Memberships waiting on a first connection: the store has no user record to put in a group yet." }, "items": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "76561198000000000:vip" } } } } } } } } } } } } }, "RustPermissionCatalogue": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "description": { "type": "string", "example": "Every permission name the configured servers have registered (GET /admin/rust/permissions/catalogue)." }, "properties": { "type": "object", "properties": { "permissions": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "items": { "$ref": "#/components/schemas/RustPermissionCatalogueEntry" } } } } } } }, "RustPermissionCatalogueEntry": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "description": { "type": "string", "example": "One registered permission name, and which servers know it." }, "properties": { "type": "object", "properties": { "permission": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "kits.vip" } } }, "servers": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "items": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "main" } } } } } } } } }, "RustPermissionSyncResult": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "description": { "type": "string", "example": "What a forced sync produced (POST /admin/rust/permissions/sync)." }, "properties": { "type": "object", "properties": { "servers": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "items": { "$ref": "#/components/schemas/RustPermissionSyncState" } } }, "drift": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "items": { "type": "object", "properties": { "type": { "type": "string", "example": "object" } } } } } } } } }, "RustUserPermissions": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "description": { "type": "string", "example": "One person’s Rust privileges, for the admin.users.detail panel (GET /admin/users/{id}/rust/permissions)." }, "properties": { "type": "object", "properties": { "groups": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "items": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "properties": { "type": "object", "properties": { "name": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "vip" } } }, "title": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "VIP" } } }, "scope": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "*" } } }, "permissions": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "items": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "kits.vip" } } } } } } } } } } }, "grants": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "items": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "properties": { "type": "object", "properties": { "id": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 7 } } }, "permission": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "kits.gold" } } }, "scope": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "main" } } }, "source": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "admin" } } }, "grantedAt": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "format": { "type": "string", "example": "date-time" } } } } } } } } }, "reaches": { "type": "object", "properties": { "type": { "type": "string", "example": "array" }, "description": { "type": "string", "example": "The Steam accounts these privileges reach. Empty means this person has linked nothing and holds them on paper only." }, "items": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "76561198000000000" } } } } } } } } }, "RustSidecarProbe": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "description": { "type": "string", "example": "What a sidecar said when probed (POST /admin/rust/servers/{id}/test)." }, "properties": { "type": "object", "properties": { "ok": { "type": "object", "properties": { "type": { "type": "string", "example": "boolean" }, "example": { "type": "boolean", "example": true } } }, "status": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "description": { "type": "string", "example": "What happened, in one word — this is what tells a wrong URL from a wrong token from a mismatched protocol. One of `ok`, `no-token`, `unauthorized`, `protocol-mismatch`, `timeout`, `transport-error`, or `http-`." }, "example": { "type": "string", "example": "ok" } } }, "sidecar": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "nullable": { "type": "boolean", "example": true }, "description": { "type": "string", "example": "The sidecar’s own health document, or the mismatch detail on a protocol disagreement." }, "properties": { "type": "object", "properties": { "status": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "ok" } } }, "protocol": { "type": "object", "properties": { "type": { "type": "string", "example": "integer" }, "example": { "type": "number", "example": 1 } } }, "plugin_connected": { "type": "object", "properties": { "type": { "type": "string", "example": "boolean" }, "example": { "type": "boolean", "example": true } } }, "database": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "ok" } } }, "uptime": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "example": { "type": "string", "example": "3h 2m" } } }, "last_event": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "format": { "type": "string", "example": "date-time" }, "nullable": { "type": "boolean", "example": true } } } } } } } } } } } } } }